This commit is contained in:
Romain Neutron
2012-05-23 00:01:29 +02:00
parent 41e56ed86b
commit 4afa21d419
346 changed files with 2234 additions and 3759 deletions

View File

@@ -78,8 +78,8 @@ class API_OAuth2_Account
/**
* Constructor
*
* @param appbox $appbox
* @param int $account_id
* @param appbox $appbox
* @param int $account_id
* @return API_OAuth2_Account
*/
public function __construct(appbox &$appbox, $account_id)
@@ -144,7 +144,7 @@ class API_OAuth2_Account
/**
*
* @param boolean $boolean
* @param boolean $boolean
* @return API_OAuth2_Account
*/
public function set_revoked($boolean)
@@ -177,7 +177,7 @@ class API_OAuth2_Account
/**
*
* @return API_OAuth2_Token
* @return API_OAuth2_Token
*/
public function get_token()
{
@@ -230,9 +230,9 @@ class API_OAuth2_Account
/**
*
* @param appbox $appbox
* @param User_Adapter $user
* @param API_OAuth2_Application $application
* @param appbox $appbox
* @param User_Adapter $user
* @param API_OAuth2_Application $application
* @return API_OAuth2_Account
*/
public static function create(appbox &$appbox, User_Adapter $user, API_OAuth2_Application $application)
@@ -261,9 +261,9 @@ class API_OAuth2_Account
/**
*
* @param appbox $appbox
* @param API_OAuth2_Application $application
* @param User_Adapter $user
* @param appbox $appbox
* @param API_OAuth2_Application $application
* @param User_Adapter $user
* @return API_OAuth2_Account
*/
public static function load_with_user(appbox &$appbox, API_OAuth2_Application $application, User_Adapter $user)

View File

@@ -83,7 +83,7 @@ class API_OAuth2_Adapter extends OAuth2
/**
*
* @param appbox $appbox
* @param appbox $appbox
* @return API_OAuth2_Adapter
*/
public function __construct(appbox $appbox)
@@ -115,7 +115,7 @@ class API_OAuth2_Adapter extends OAuth2
/**
*
* @param array $params
* @param array $params
* @return API_OAuth2_Adapter
*/
public function setParams(array $params)
@@ -170,8 +170,8 @@ class API_OAuth2_Adapter extends OAuth2
/**
*
* @param string $secret
* @param string $nonce
* @param string $secret
* @param string $nonce
* @return string
*/
protected static function crypt_secret($secret, $nonce)
@@ -185,8 +185,8 @@ class API_OAuth2_Adapter extends OAuth2
*
* Implements OAuth2::checkClientCredentials().
*
* @param string $client_id
* @param string $client_secret
* @param string $client_id
* @param string $client_secret
* @return boolean
*/
protected function checkClientCredentials($client_id, $client_secret = NULL)
@@ -212,7 +212,7 @@ class API_OAuth2_Adapter extends OAuth2
*
* Implements OAuth2::getRedirectUri().
*
* @param string $client_id
* @param string $client_id
* @return string
*/
protected function getRedirectUri($client_id)
@@ -226,7 +226,7 @@ class API_OAuth2_Adapter extends OAuth2
*
* Implements OAuth2::getAccessToken().
*
* @param string $oauth_token
* @param string $oauth_token
* @return array
*/
protected function getAccessToken($oauth_token)
@@ -258,10 +258,10 @@ class API_OAuth2_Adapter extends OAuth2
/**
*
* @param type $oauth_token
* @param type $account_id
* @param type $expires
* @param string $scope
* @param type $oauth_token
* @param type $account_id
* @param type $expires
* @param string $scope
* @return API_OAuth2_Adapter
*/
protected function setAccessToken($oauth_token, $account_id, $expires, $scope = NULL)
@@ -326,11 +326,11 @@ class API_OAuth2_Adapter extends OAuth2
*
* Overrides OAuth2::setAuthCode().
*
* @param string $code
* @param int $account_id
* @param string $redirect_uri
* @param string $expires
* @param string $scope
* @param string $code
* @param int $account_id
* @param string $redirect_uri
* @param string $expires
* @param string $scope
* @return API_OAuth2_Adapter
*/
protected function setAuthCode($code, $account_id, $redirect_uri, $expires, $scope = NULL)
@@ -386,7 +386,7 @@ class API_OAuth2_Adapter extends OAuth2
/**
*
* @param Symfony\Component\HttpFoundation\Request $request
* @param Symfony\Component\HttpFoundation\Request $request
* @return array
*/
public function getAuthorizationRequestParameters(Symfony\Component\HttpFoundation\Request $request)
@@ -477,8 +477,7 @@ class API_OAuth2_Adapter extends OAuth2
), $redirect_uri);
if ($compare !== 0)
$this->errorDoRedirectUriCallback($input["redirect_uri"], OAUTH2_ERROR_REDIRECT_URI_MISMATCH, NULL, NULL, $input["state"]);
}
elseif ($redirect_uri) {
} elseif ($redirect_uri) {
/**
* They did not provide a uri from input, so use the stored one
*/
@@ -524,7 +523,7 @@ class API_OAuth2_Adapter extends OAuth2
/**
*
* @param usr_id $usr_id
* @param usr_id $usr_id
* @return API_OAuth2_Account
*/
public function updateAccount($usr_id)
@@ -544,7 +543,7 @@ class API_OAuth2_Adapter extends OAuth2
/**
*
* @param int $usr_id
* @param int $usr_id
* @return API_OAuth2_Account
*/
private function createAccount($usr_id)
@@ -556,8 +555,8 @@ class API_OAuth2_Adapter extends OAuth2
/**
*
* @param <type> $is_authorized
* @param array $params
* @param <type> $is_authorized
* @param array $params
* @return string
*/
public function finishNativeClientAuthorization($is_authorized, $params = array())
@@ -587,7 +586,7 @@ class API_OAuth2_Adapter extends OAuth2
/**
*
* @param <type> $redirect_uri
* @param <type> $redirect_uri
* @return <type>
*/
public function isNativeApp($redirect_uri)

View File

@@ -126,8 +126,8 @@ class API_OAuth2_Application
/**
*
* @param appbox $appbox
* @param int $application_id
* @param appbox $appbox
* @param int $application_id
* @return API_OAuth2_Application
*/
public function __construct(appbox &$appbox, $application_id)
@@ -202,7 +202,7 @@ class API_OAuth2_Application
/**
*
* @param string $type
* @param string $type
* @return API_OAuth2_Application
*/
public function set_type($type)
@@ -241,7 +241,7 @@ class API_OAuth2_Application
/**
*
* @param string $name
* @param string $name
* @return API_OAuth2_Application
*/
public function set_name($name)
@@ -274,7 +274,7 @@ class API_OAuth2_Application
/**
*
* @param string $description
* @param string $description
* @return API_OAuth2_Application
*/
public function set_description($description)
@@ -308,7 +308,7 @@ class API_OAuth2_Application
/**
*
* @param string $website
* @param string $website
* @return API_OAuth2_Application
*/
public function set_website($website)
@@ -342,7 +342,7 @@ class API_OAuth2_Application
/**
*
* @param boolean $activated
* @param boolean $activated
* @return API_OAuth2_Application
*/
public function set_activated($activated)
@@ -376,7 +376,7 @@ class API_OAuth2_Application
/**
*
* @param boolean $grant
* @param boolean $grant
* @return API_OAuth2_Application
*/
public function set_grant_password($grant)
@@ -428,7 +428,7 @@ class API_OAuth2_Application
/**
*
* @param int $client_id
* @param int $client_id
* @return API_OAuth2_Application
*/
public function set_client_id($client_id)
@@ -462,7 +462,7 @@ class API_OAuth2_Application
/**
*
* @param string $client_secret
* @param string $client_secret
* @return API_OAuth2_Application
*/
public function set_client_secret($client_secret)
@@ -496,7 +496,7 @@ class API_OAuth2_Application
/**
*
* @param string $redirect_uri
* @param string $redirect_uri
* @return API_OAuth2_Application
*/
public function set_redirect_uri($redirect_uri)
@@ -520,7 +520,7 @@ class API_OAuth2_Application
/**
*
* @param User_Adapter $user
* @param User_Adapter $user
* @return API_OAuth2_Account
*/
public function get_user_account(user_adapter $user)
@@ -589,9 +589,9 @@ class API_OAuth2_Application
/**
*
* @param appbox $appbox
* @param User_Adapter $user
* @param type $name
* @param appbox $appbox
* @param User_Adapter $user
* @param type $name
* @return API_OAuth2_Application
*/
public static function create(appbox &$appbox, User_Adapter $user = null, $name)
@@ -637,8 +637,8 @@ class API_OAuth2_Application
/**
*
* @param appbox $appbox
* @param type $client_id
* @param appbox $appbox
* @param type $client_id
* @return API_OAuth2_Application
*/
public static function load_from_client_id(appbox &$appbox, $client_id)
@@ -659,8 +659,8 @@ class API_OAuth2_Application
/**
*
* @param appbox $appbox
* @param User_Adapter $user
* @param appbox $appbox
* @param User_Adapter $user
* @return array
*/
public static function load_dev_app_by_user(appbox &$appbox, User_Adapter $user)
@@ -684,8 +684,8 @@ class API_OAuth2_Application
/**
*
* @param appbox $appbox
* @param user_adapter $user
* @param appbox $appbox
* @param user_adapter $user
* @return API_OAuth2_Application
*/
public static function load_app_by_user(appbox $appbox, user_adapter $user)

View File

@@ -133,8 +133,8 @@ class API_OAuth2_AuthCode
/**
*
* @param appbox $appbox
* @param API_OAuth2_Account $account
* @param appbox $appbox
* @param API_OAuth2_Account $account
* @return array
*/
public static function load_codes_by_account(appbox &$appbox, API_OAuth2_Account $account)
@@ -160,10 +160,10 @@ class API_OAuth2_AuthCode
/**
*
* @param appbox $appbox
* @param API_OAuth2_Account $account
* @param type $code
* @param int $expires
* @param appbox $appbox
* @param API_OAuth2_Account $account
* @param type $code
* @param int $expires
* @return API_OAuth2_AuthCode
*/
public static function create(appbox &$appbox, API_OAuth2_Account $account, $code, $expires)

View File

@@ -54,11 +54,11 @@ class API_OAuth2_Exception_Exception extends Exception implements API_OAuth2_Exc
/**
*
* @param int $http_code
* @param string $error
* @param string $error_description
* @param string $scope
* @param string $error_uri
* @param int $http_code
* @param string $error
* @param string $error_description
* @param string $scope
* @param string $error_uri
* @return API_OAuth2_Exception_Exception
*/
public function __construct($http_code, $error, $error_description = null, $scope = null, $error_uri = null)
@@ -83,7 +83,7 @@ class API_OAuth2_Exception_Exception extends Exception implements API_OAuth2_Exc
/**
*
* @param int $http_code
* @param int $http_code
* @return API_OAuth2_Exception_Exception
*/
public function setHttp_code($http_code)
@@ -104,7 +104,7 @@ class API_OAuth2_Exception_Exception extends Exception implements API_OAuth2_Exc
/**
*
* @param string $scope
* @param string $scope
* @return API_OAuth2_Exception_Exception
*/
public function setError($error)
@@ -125,7 +125,7 @@ class API_OAuth2_Exception_Exception extends Exception implements API_OAuth2_Exc
/**
*
* @param string $scope
* @param string $scope
* @return API_OAuth2_Exception_Exception
*/
public function setError_description($error_description)
@@ -146,7 +146,7 @@ class API_OAuth2_Exception_Exception extends Exception implements API_OAuth2_Exc
/**
*
* @param string $scope
* @param string $scope
* @return API_OAuth2_Exception_Exception
*/
public function setError_uri($error_uri)
@@ -167,7 +167,7 @@ class API_OAuth2_Exception_Exception extends Exception implements API_OAuth2_Exc
/**
*
* @param string $scope
* @param string $scope
* @return API_OAuth2_Exception_Exception
*/
public function setScope($scope)

View File

@@ -42,11 +42,11 @@ class API_OAuth2_Exception_Redirect extends API_OAuth2_Exception_Exception
/**
*
* @param string $redirect_uri
* @param string $error
* @param string $error_description
* @param string $state
* @param string $error_uri
* @param string $redirect_uri
* @param string $error
* @param string $error_description
* @param string $state
* @param string $error_uri
* @return API_OAuth2_Exception_Redirect
*/
public function __construct($redirect_uri, $error, $error_description = null, $state = null, $error_uri = null)
@@ -69,7 +69,7 @@ class API_OAuth2_Exception_Redirect extends API_OAuth2_Exception_Exception
/**
*
* @param string $redirect_uri
* @param string $redirect_uri
* @return API_OAuth2_Exception_Redirect
*/
public function setState($state)
@@ -90,7 +90,7 @@ class API_OAuth2_Exception_Redirect extends API_OAuth2_Exception_Exception
/**
*
* @param string $redirect_uri
* @param string $redirect_uri
* @return API_OAuth2_Exception_Redirect
*/
public function setRedirect_uri($redirect_uri)

View File

@@ -36,9 +36,9 @@ class API_OAuth2_Exception_Redirect_AccessDenied extends API_OAuth2_Exception_Re
/**
*
* @param string $redirect_uri
* @param string $state
* @param string $error_uri
* @param string $redirect_uri
* @param string $state
* @param string $error_uri
* @return API_OAuth2_Exception_Redirect_AccessDenied
*/
public function __construct($redirect_uri, $state = null, $error_uri = null)

View File

@@ -36,9 +36,9 @@ class API_OAuth2_Exception_Redirect_InvalidClient extends API_OAuth2_Exception_R
/**
*
* @param string $redirect_uri
* @param string $state
* @param string $error_uri
* @param string $redirect_uri
* @param string $state
* @param string $error_uri
* @return API_OAuth2_Exception_Redirect_InvalidClient
*/
public function __construct($redirect_uri, $state = null, $error_uri = null)

View File

@@ -36,9 +36,9 @@ class API_OAuth2_Exception_Redirect_InvalidRequest extends API_OAuth2_Exception_
/**
*
* @param string $redirect_uri
* @param string $state
* @param string $error_uri
* @param string $redirect_uri
* @param string $state
* @param string $error_uri
* @return API_OAuth2_Exception_Redirect_InvalidRequest
*/
public function __construct($redirect_uri, $state = null, $error_uri = null)

View File

@@ -42,10 +42,10 @@ class API_OAuth2_Exception_Redirect_InvalidScope extends API_OAuth2_Exception_Re
/**
*
* @param string $redirect_uri
* @param string $scope
* @param string $state
* @param string $error_uri
* @param string $redirect_uri
* @param string $scope
* @param string $state
* @param string $error_uri
* @return API_OAuth2_Exception_Redirect_InvalidScope
*/
public function __construct($redirect_uri, $scope, $state = null, $error_uri = null)
@@ -67,7 +67,7 @@ class API_OAuth2_Exception_Redirect_InvalidScope extends API_OAuth2_Exception_Re
/**
*
* @param string $scope
* @param string $scope
* @return API_OAuth2_Exception_Redirect_InvalidScope
*/
public function setScope($scope)

View File

@@ -36,9 +36,9 @@ class API_OAuth2_Exception_Redirect_ServerError extends API_OAuth2_Exception_Red
/**
*
* @param string $redirect_uri
* @param string $state
* @param string $error_uri
* @param string $redirect_uri
* @param string $state
* @param string $error_uri
* @return API_OAuth2_Exception_Redirect_ServerError
*/
public function __construct($redirect_uri, $state = null, $error_uri = null)

View File

@@ -36,9 +36,9 @@ class API_OAuth2_Exception_Redirect_Unauthorized extends API_OAuth2_Exception_Re
/**
*
* @param string $redirect_uri
* @param string $state
* @param string $error_uri
* @param string $redirect_uri
* @param string $state
* @param string $error_uri
* @return API_OAuth2_Exception_Redirect_Unauthorized
*/
public function __construct($redirect_uri, $state = null, $error_uri = null)

View File

@@ -36,9 +36,9 @@ class API_OAuth2_Exception_Redirect_UnauthorizedClient extends API_OAuth2_Except
/**
*
* @param string $redirect_uri
* @param string $state
* @param string $error_uri
* @param string $redirect_uri
* @param string $state
* @param string $error_uri
* @return API_OAuth2_Exception_Redirect_UnauthorizedClient
*/
public function __construct($redirect_uri, $state = null, $error_uri = null)

View File

@@ -42,10 +42,10 @@ class API_OAuth2_Exception_Redirect_UnsupportedResponseType extends API_OAuth2_E
/**
*
* @param string $redirect_uri
* @param string $method
* @param string $state
* @param string $error_uri
* @param string $redirect_uri
* @param string $method
* @param string $state
* @param string $error_uri
* @return API_OAuth2_Exception_Redirect_UnsupportedResponseType
*/
public function __construct($redirect_uri, $method, $state = null, $error_uri = null)
@@ -67,7 +67,7 @@ class API_OAuth2_Exception_Redirect_UnsupportedResponseType extends API_OAuth2_E
/**
*
* @param string $method
* @param string $method
* @return API_OAuth2_Exception_Redirect_UnsupportedResponseType
*/
public function setMethod($method)

View File

@@ -36,12 +36,12 @@ class API_OAuth2_Exception_WWWAuthenticate extends API_OAuth2_Exception_Exceptio
/**
*
* @param int $http_code
* @param string $realm
* @param string $error
* @param string $error_description
* @param string $error_uri
* @param string $scope
* @param int $http_code
* @param string $realm
* @param string $error
* @param string $error_description
* @param string $error_uri
* @param string $scope
* @return API_OAuth2_Exception_WWWAuthenticate
*/
public function __construct($http_code, $realm, $error, $error_description = null, $error_uri = null, $scope = null)
@@ -65,7 +65,7 @@ class API_OAuth2_Exception_WWWAuthenticate extends API_OAuth2_Exception_Exceptio
/**
*
* @param string $realm
* @param string $realm
* @return API_OAuth2_Exception_WWWAuthenticate
*/
public function setRealm($realm)

View File

@@ -36,9 +36,9 @@ class API_OAuth2_Exception_WWWAuthenticate_ExpiredToken extends API_OAuth2_Excep
/**
*
* @param string $realm
* @param string $scope
* @param string $error_uri
* @param string $realm
* @param string $scope
* @param string $error_uri
* @return API_OAuth2_Exception_WWWAuthenticate_ExpiredToken
*/
public function __construct($realm, $scope = null, $error_uri = null)

View File

@@ -36,9 +36,9 @@ class API_OAuth2_Exception_WWWAuthenticate_InsufficientScope extends API_OAuth2_
/**
*
* @param string $realm
* @param string $scope
* @param string $error_uri
* @param string $realm
* @param string $scope
* @param string $error_uri
* @return API_OAuth2_Exception_WWWAuthenticate_InsufficientScope
*/
public function __construct($realm, $scope = null, $error_uri = null)

View File

@@ -36,9 +36,9 @@ class API_OAuth2_Exception_WWWAuthenticate_InvalidClient extends API_OAuth2_Exce
/**
*
* @param string $realm
* @param string $scope
* @param string $error_uri
* @param string $realm
* @param string $scope
* @param string $error_uri
* @return API_OAuth2_Exception_WWWAuthenticate_InvalidClient
*/
public function __construct($realm, $scope = null, $error_uri = null)

View File

@@ -36,9 +36,9 @@ class API_OAuth2_Exception_WWWAuthenticate_InvalidRequest extends API_OAuth2_Exc
/**
*
* @param string $realm
* @param string $scope
* @param string $error_uri
* @param string $realm
* @param string $scope
* @param string $error_uri
* @return API_OAuth2_Exception_WWWAuthenticate_InvalidRequest
*/
public function __construct($realm, $scope = null, $error_uri = null)

View File

@@ -36,9 +36,9 @@ class API_OAuth2_Exception_WWWAuthenticate_InvalidToken extends API_OAuth2_Excep
/**
*
* @param string $realm
* @param string $scope
* @param string $error_uri
* @param string $realm
* @param string $scope
* @param string $error_uri
* @return API_OAuth2_Exception_WWWAuthenticate_InvalidToken
*/
public function __construct($realm, $scope = null, $error_uri = null)

View File

@@ -30,11 +30,11 @@ class API_OAuth2_Exception_WWWAuthenticate_Type_BadRequest extends API_OAuth2_Ex
/**
*
* @param string $realm
* @param string $error
* @param string $error_description
* @param string $error_uri
* @param string $scope
* @param string $realm
* @param string $error
* @param string $error_description
* @param string $error_uri
* @param string $scope
* @return API_OAuth2_Exception_WWWAuthenticate_Type_BadRequest
*/
public function __construct($realm, $error, $error_description = null, $error_uri = null, $scope = null)

View File

@@ -25,11 +25,11 @@ class API_OAuth2_Exception_WWWAuthenticate_Type_Forbidden extends API_OAuth2_Exc
/**
*
* @param string $realm
* @param string $error
* @param string $error_description
* @param string $error_uri
* @param string $scope
* @param string $realm
* @param string $error
* @param string $error_description
* @param string $error_uri
* @param string $scope
* @return API_OAuth2_Exception_WWWAuthenticate_Type_Forbidden
*/
public function __construct($realm, $error, $error_description = null, $error_uri = null, $scope = null)

View File

@@ -30,11 +30,11 @@ class API_OAuth2_Exception_WWWAuthenticate_Type_Unauthorized extends API_OAuth2_
/**
*
* @param string $realm
* @param string $error
* @param string $error_description
* @param string $error_uri
* @param string $scope
* @param string $realm
* @param string $error
* @param string $error_description
* @param string $error_uri
* @param string $scope
* @return API_OAuth2_Exception_WWWAuthenticate_Type_Unauthorized
*/
public function __construct($realm, $error, $error_description = null, $error_uri = null, $scope = null)

View File

@@ -60,7 +60,7 @@ class API_OAuth2_Form_DevAppDesktop
/**
*
* @param Request $request
* @param Request $request
* @return API_OAuth2_Form_DevApp
*/
public function __construct(Request $request)
@@ -139,10 +139,10 @@ class API_OAuth2_Form_DevAppDesktop
/**
*
* @param ClassMetadata $metadata
* @param ClassMetadata $metadata
* @return API_OAuth2_Form_DevApp
*/
static public function loadValidatorMetadata(ClassMetadata $metadata)
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$blank = array('message' => _('Cette valeur ne peut être vide'));
$url = array('message' => _('Url non valide'));

View File

@@ -56,7 +56,7 @@ class API_OAuth2_Form_DevAppInternet
/**
*
* @param Request $request
* @param Request $request
* @return API_OAuth2_Form_DevApp
*/
public function __construct(Request $request)
@@ -142,10 +142,10 @@ class API_OAuth2_Form_DevAppInternet
/**
*
* @param ClassMetadata $metadata
* @param ClassMetadata $metadata
* @return API_OAuth2_Form_DevApp
*/
static public function loadValidatorMetadata(ClassMetadata $metadata)
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$blank = array('message' => _('Cette valeur ne peut être vide'));
$url = array('message' => _('Url non valide'));

View File

@@ -93,8 +93,8 @@ class API_OAuth2_RefreshToken
/**
*
* @param appbox $appbox
* @param API_OAuth2_Account $account
* @param appbox $appbox
* @param API_OAuth2_Account $account
* @return array
*/
public static function load_by_account(appbox &$appbox, API_OAuth2_Account $account)
@@ -118,11 +118,11 @@ class API_OAuth2_RefreshToken
/**
*
* @param appbox $appbox
* @param API_OAuth2_Account $account
* @param int $expires
* @param type $refresh_token
* @param type $scope
* @param appbox $appbox
* @param API_OAuth2_Account $account
* @param int $expires
* @param type $refresh_token
* @param type $scope
* @return API_OAuth2_RefreshToken
*/
public static function create(appbox &$appbox, API_OAuth2_Account $account, $expires, $refresh_token, $scope)

View File

@@ -59,8 +59,8 @@ class API_OAuth2_Token
/**
*
* @param appbox $appbox
* @param API_OAuth2_Account $account
* @param appbox $appbox
* @param API_OAuth2_Account $account
* @return API_OAuth2_Token
*/
public function __construct(appbox &$appbox, API_OAuth2_Account &$account)
@@ -99,7 +99,7 @@ class API_OAuth2_Token
/**
*
* @param string $oauth_token
* @param string $oauth_token
* @return API_OAuth2_Token
*/
public function set_value($oauth_token)
@@ -132,7 +132,7 @@ class API_OAuth2_Token
/**
*
* @param int $session_id
* @param int $session_id
* @return API_OAuth2_Token
*/
public function set_session_id($session_id)
@@ -165,7 +165,7 @@ class API_OAuth2_Token
/**
*
* @param int $expires
* @param int $expires
* @return API_OAuth2_Token
*/
public function set_expires($expires)
@@ -266,8 +266,8 @@ class API_OAuth2_Token
/**
*
* @param appbox $appbox
* @param type $oauth_token
* @param appbox $appbox
* @param type $oauth_token
* @return API_OAuth2_Token
*/
public static function load_by_oauth_token(appbox &$appbox, $oauth_token)
@@ -293,9 +293,9 @@ class API_OAuth2_Token
/**
*
* @param appbox $appbox
* @param API_OAuth2_Account $account
* @param string $scope
* @param appbox $appbox
* @param API_OAuth2_Account $account
* @param string $scope
* @return API_OAuth2_Token
*/
public static function create(appbox &$appbox, API_OAuth2_Account &$account, $scope = null)

View File

@@ -6,7 +6,6 @@
*/
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
class API_V1_Log
{
@@ -83,8 +82,8 @@ class API_V1_Log
/**
*
* @param appbox $appbox
* @param Request $request
* @param appbox $appbox
* @param Request $request
* @param API_OAuth2_Account $account
*/
public function __construct(appbox &$appbox, $log_id)

View File

@@ -43,8 +43,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* API constructor
*
* @param string $auth_token Authentification Token
* @param appbox $appbox Appbox object
* @param string $auth_token Authentification Token
* @param appbox $appbox Appbox object
* @return API_V1_adapter
*/
public function __construct($auth_token, appbox &$appbox, Alchemy\Phrasea\Core $core)
@@ -57,8 +57,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve http status error code according to the message
* @param Request $request
* @param string $error
* @param Request $request
* @param string $error
* @return API_V1_result `
*/
public function get_error_message(Request $request, $error, $message)
@@ -71,8 +71,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve http status error message according to the http status error code
* @param Request $request
* @param int $code
* @param Request $request
* @param int $code
* @return API_V1_result
*/
public function get_error_code(Request $request, $code)
@@ -96,7 +96,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Get a list of phraseanet tasks
*
* @param \Silex\Application $app The API silex application
* @param \Silex\Application $app The API silex application
* @return \API_V1_result
*/
public function get_task_list(Application $app)
@@ -126,8 +126,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Get informations about an identified task
*
* @param \Silex\Application $app The API silex application
* @param type $task_id
* @param \Silex\Application $app The API silex application
* @param type $task_id
* @return \API_V1_result
*/
public function get_task(Application $app, $taskId)
@@ -162,8 +162,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Start a specified task
*
* @param \Silex\Application $app The API silex application
* @param type $task_id The task id
* @param \Silex\Application $app The API silex application
* @param type $task_id The task id
* @return \API_V1_result
*/
public function start_task(Application $app, $taskId)
@@ -194,8 +194,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Stop a specified task
*
* @param \Silex\Application $app The API silex application
* @param type $task_id The task id
* @param \Silex\Application $app The API silex application
* @param type $task_id The task id
* @return \API_V1_result
*/
public function stop_task(Application $app, $taskId)
@@ -228,8 +228,8 @@ class API_V1_adapter extends API_V1_Abstract
* - name
* - autostart
*
* @param \Silex\Application $app Silex application
* @param type $task_id the task id
* @param \Silex\Application $app Silex application
* @param type $task_id the task id
* @return \API_V1_result
* @throws \Exception_InvalidArgument
*/
@@ -280,7 +280,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Get Information the cache system used by the instance
*
* @param \Silex\Application $app the silex application
* @param \Silex\Application $app the silex application
* @return array
*/
protected function get_cache_info(Application $app)
@@ -314,7 +314,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Provide information about phraseanet configuration
*
* @param \Silex\Application $app the silex application
* @param \Silex\Application $app the silex application
* @return array
*/
protected function get_config_info(Application $app)
@@ -339,7 +339,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Provide phraseanet global values
* @param \Silex\Application $app the silex application
* @param \Silex\Application $app the silex application
* @return array
*/
protected function get_gv_info(Application $app)
@@ -511,7 +511,7 @@ class API_V1_adapter extends API_V1_Abstract
* - global values informations
* - configuration informations
*
* @param \Silex\Application $app the silex application
* @param \Silex\Application $app the silex application
* @return \API_V1_result
*/
public function get_phraseanet_monitor(Application $app)
@@ -530,8 +530,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Get an API_V1_result containing the databoxes
*
* @param Request $request
* @param string $response_type
* @param Request $request
* @param string $response_type
* @return API_V1_result
*/
public function get_databoxes(Request $request)
@@ -546,9 +546,9 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Get an API_V1_result containing the collections of a databox
*
* @param Request $request
* @param int $databox_id
* @param string $response_type
* @param Request $request
* @param int $databox_id
* @param string $response_type
* @return API_V1_result
*/
public function get_databox_collections(Request $request, $databox_id)
@@ -569,9 +569,9 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Get an API_V1_result containing the status of a databox
*
* @param Request $request
* @param int $databox_id
* @param string $response_type
* @param Request $request
* @param int $databox_id
* @param string $response_type
* @return API_V1_result
*/
public function get_databox_status(Request $request, $databox_id)
@@ -593,9 +593,9 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Get an API_V1_result containing the metadatas of a databox
*
* @param Request $request
* @param int $databox_id
* @param string $response_type
* @param Request $request
* @param int $databox_id
* @param string $response_type
* @return API_V1_result
*/
public function get_databox_metadatas(Request $request, $databox_id)
@@ -618,9 +618,9 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Get an API_V1_result containing the terms of use of a databox
*
* @param Request $request
* @param int $databox_id
* @param string $response_type
* @param Request $request
* @param int $databox_id
* @param string $response_type
* @return API_V1_result
*/
public function get_databox_terms(Request $request, $databox_id)
@@ -792,9 +792,9 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Get an API_V1_result containing the results of a records search
*
* @param Request $request
* @param int $databox_id
* @param string $response_type
* @param Request $request
* @param int $databox_id
* @param string $response_type
* @return API_V1_result
*/
public function search_records(Request $request)
@@ -924,10 +924,10 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Get an API_V1_result containing the baskets where the record is in
*
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param string $response_type
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param string $response_type
* @return API_V1_result
*/
public function get_record_related(Request $request, $databox_id, $record_id)
@@ -952,10 +952,10 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Get an API_V1_result containing the record metadatas
*
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param string $response_type
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param string $response_type
* @return API_V1_result
*/
public function get_record_metadatas(Request $request, $databox_id, $record_id)
@@ -976,10 +976,10 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Get an API_V1_result containing the record status
*
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param string $response_type
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param string $response_type
* @return API_V1_result
*/
public function get_record_status(Request $request, $databox_id, $record_id)
@@ -1006,10 +1006,10 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Get an API_V1_result containing the record embed files
*
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param string $response_type
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param string $response_type
* @return API_V1_result
*/
public function get_record_embed(Request $request, $databox_id, $record_id)
@@ -1106,9 +1106,9 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Move a record to another collection
*
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @return API_V1_result
*/
public function set_record_collection(Request $request, $databox_id, $record_id)
@@ -1132,9 +1132,9 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Return detailed informations about one record
*
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @return API_V1_result
*/
public function get_record(Request $request, $databox_id, $record_id)
@@ -1157,8 +1157,8 @@ class API_V1_adapter extends API_V1_Abstract
* @todo
*
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param int $databox_id
* @param int $record_id
*/
public function add_record_tobasket(Request $request, $databox_id, $record_id)
{
@@ -1168,7 +1168,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Return the baskets list of the authenticated user
*
* @param Request $request
* @param Request $request
* @return API_V1_result
*/
public function search_baskets(Request $request)
@@ -1185,7 +1185,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Return a baskets list
*
* @param int $usr_id
* @param int $usr_id
* @return array
*/
protected function list_baskets($usr_id)
@@ -1207,7 +1207,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Create a new basket
*
* @param Request $request
* @param Request $request
* @return API_V1_result
*/
public function create_basket(Request $request)
@@ -1240,8 +1240,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Delete a basket
*
* @param Request $request
* @param int $basket_id
* @param Request $request
* @param int $basket_id
* @return array
*/
public function delete_basket(Request $request, $basket_id)
@@ -1264,8 +1264,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve a basket
*
* @param Request $request
* @param int $basket_id
* @param Request $request
* @param int $basket_id
* @return API_V1_result
*/
public function get_basket(Request $request, $basket_id)
@@ -1293,7 +1293,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve elements of one basket
*
* @param \Entities\Basket $Basket
* @param \Entities\Basket $Basket
* @return type
*/
protected function list_basket_content(\Entities\Basket $Basket)
@@ -1312,7 +1312,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve detailled informations about a basket element
*
* @param \Entities\BasketElement $basket_element
* @param \Entities\BasketElement $basket_element
* @return type
*/
protected function list_basket_element(\Entities\BasketElement $basket_element)
@@ -1357,8 +1357,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Change the name of one basket
*
* @param Request $request
* @param int $basket_id
* @param Request $request
* @param int $basket_id
* @return API_V1_result
*/
public function set_basket_title(Request $request, $basket_id)
@@ -1393,8 +1393,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Change the description of one basket
*
* @param Request $request
* @param type $basket_id
* @param Request $request
* @param type $basket_id
* @return API_V1_result
*/
public function set_basket_description(Request $request, $basket_id)
@@ -1429,8 +1429,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* List all avalaible feeds
*
* @param Request $request
* @param User_Adapter $user
* @param Request $request
* @param User_Adapter $user
* @return API_V1_result
*/
public function search_publications(Request $request, User_Adapter &$user)
@@ -1453,7 +1453,7 @@ class API_V1_adapter extends API_V1_Abstract
* @todo
*
* @param Request $request
* @param int $publication_id
* @param int $publication_id
*/
public function remove_publications(Request $request, $publication_id)
{
@@ -1463,9 +1463,9 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve one feed
*
* @param Request $request
* @param int $publication_id
* @param User_Adapter $user
* @param Request $request
* @param int $publication_id
* @param User_Adapter $user
* @return API_V1_result
*/
public function get_publication(Request $request, $publication_id, User_Adapter &$user)
@@ -1494,8 +1494,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve detailled informations about one feed
*
* @param Feed_Adapter $feed
* @param type $user
* @param Feed_Adapter $feed
* @param type $user
* @return array
*/
protected function list_publication(Feed_Adapter $feed, $user)
@@ -1516,9 +1516,9 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve all entries of one feed
*
* @param Feed_Adapter $feed
* @param int $offset_start
* @param int $how_many
* @param Feed_Adapter $feed
* @param int $offset_start
* @param int $how_many
* @return array
*/
protected function list_publications_entries(Feed_Adapter $feed, $offset_start = 0, $how_many = 5)
@@ -1540,7 +1540,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve detailled information about one feed entry
*
* @param Feed_Entry_Adapter $entry
* @param Feed_Entry_Adapter $entry
* @return array
*/
protected function list_publication_entry(Feed_Entry_Adapter $entry)
@@ -1564,7 +1564,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve detailled informations about one feed entry item
*
* @param Feed_Entry_Item $item
* @param Feed_Entry_Item $item
* @return array
*/
protected function list_publication_entry_item(Feed_Entry_Item $item)
@@ -1589,7 +1589,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* @todo
* @param Request $request
* @param int $usr_id
* @param int $usr_id
*/
public function get_user_acces(Request $request, $usr_id)
{
@@ -1608,7 +1608,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* @retrieve detailled informations about one suddef
*
* @param media_subdef $media
* @param media_subdef $media
* @return array
*/
protected function list_embedable_media(media_subdef &$media, registryInterface &$registry)
@@ -1633,8 +1633,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve detailled information about one permalink
*
* @param media_Permalink_Adapter $permalink
* @param registryInterface $registry
* @param media_Permalink_Adapter $permalink
* @param registryInterface $registry
* @return type
*/
protected function list_permalink(media_Permalink_Adapter &$permalink, registryInterface &$registry)
@@ -1653,8 +1653,8 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve detailled information about one status
*
* @param databox $databox
* @param string $status
* @param databox $databox
* @param string $status
* @return array
*/
protected function list_record_status(databox $databox, $status)
@@ -1671,7 +1671,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* List all field about a specified caption
*
* @param caption_record $caption
* @param caption_record $caption
* @return array
*/
protected function list_record_caption(caption_record $caption)
@@ -1689,7 +1689,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve information about a caption field
*
* @param caption_field $field
* @param caption_field $field
* @return array
*/
protected function list_record_caption_field(caption_Field_Value $value, caption_field $field)
@@ -1698,6 +1698,7 @@ class API_V1_adapter extends API_V1_Abstract
* @todo ajouter une option pour avoir les values serialisées
* dans un cas multi
*/
return array(
'meta_id' => $value->getId(),
'meta_structure_id' => $field->get_meta_struct_id(),
@@ -1709,7 +1710,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retirve information about one basket
*
* @param \Entities\Basket $basket
* @param \Entities\Basket $basket
* @return array
*/
protected function list_basket(\Entities\Basket $basket)
@@ -1765,7 +1766,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve detailled informations about one record
*
* @param record_adapter $record
* @param record_adapter $record
* @return array
*/
protected function list_record(record_adapter $record)
@@ -1807,7 +1808,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve CGU's for the specified databox
*
* @param databox $databox
* @param databox $databox
* @return array
*/
protected function list_databox_terms(databox $databox)
@@ -1822,7 +1823,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve detailled informations about one databox
* @param databox $databox
* @param databox $databox
* @return array
*/
protected function list_databox(databox $databox)
@@ -1839,7 +1840,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* List all available collections for a specified databox
*
* @param databox $databox
* @param databox $databox
* @return array
*/
protected function list_databox_collections(databox $databox)
@@ -1856,7 +1857,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve detailled informations about one collection
*
* @param collection $collection
* @param collection $collection
* @return array
*/
protected function list_collection(collection $collection)
@@ -1874,7 +1875,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retrieve informations for a list of status
*
* @param array $status
* @param array $status
* @return array
*/
protected function list_databox_status(array $status)
@@ -1898,7 +1899,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* List all metadatas field using a databox meta structure
*
* @param databox_descriptionStructure $meta_struct
* @param databox_descriptionStructure $meta_struct
* @return array
*/
protected function list_databox_metadatas_fields(databox_descriptionStructure $meta_struct)
@@ -1914,7 +1915,7 @@ class API_V1_adapter extends API_V1_Abstract
/**
* Retirve informations about one databox metadata field
*
* @param databox_field $databox_field
* @param databox_field $databox_field
* @return array
*/
protected function list_databox_metadata_field_properties(databox_field $databox_field)

View File

@@ -97,9 +97,9 @@ class API_V1_result
/**
* API v1 Result constructor
*
* @param Request $request
* @param API_V1_adapter $api
* @param string $response_type One of the API_V1_result 'FORMAT_*' constants
* @param Request $request
* @param API_V1_adapter $api
* @param string $response_type One of the API_V1_result 'FORMAT_*' constants
* @return API_V1_result
*/
public function __construct(Request $request, API_V1_adapter $api)
@@ -147,7 +147,7 @@ class API_V1_result
* If no datas provided (aka empty array), a stdClass if set,
* so the serialized datas will be objects
*
* @param array $datas
* @param array $datas
* @return API_V1_result
*/
public function set_datas(array $datas)
@@ -237,7 +237,7 @@ class API_V1_result
* Set the API_V1_result http_code, error_type, error_message and error_details
* with the appropriate datas
*
* @param string $const
* @param string $const
* @return API_V1_result
*/
public function set_error_message($const, $message)
@@ -287,7 +287,7 @@ class API_V1_result
* Set the API_V1_result http_code, error_message and error_details
* with the appropriate datas
*
* @param string $const
* @param string $const
* @return API_V1_result
*/
public function set_error_code($code)