diff --git a/src/OAuth2/ClientAssertionType/HttpBasic.php b/src/OAuth2/ClientAssertionType/HttpBasic.php index 0d800717..63605d67 100644 --- a/src/OAuth2/ClientAssertionType/HttpBasic.php +++ b/src/OAuth2/ClientAssertionType/HttpBasic.php @@ -21,12 +21,12 @@ class HttpBasic implements ClientAssertionTypeInterface /** * Config array $config should look as follows: - * @code + * * $config = array( * 'allow_credentials_in_request_body' => true, // whether to look for credentials in the POST body in addition to the Authorize HTTP Header * 'allow_public_clients' => true // if true, "public clients" (clients without a secret) may be authenticated * ); - * @endcode + * * * @param ClientCredentialsInterface $storage Storage * @param array $config Configuration options for the server @@ -101,12 +101,12 @@ public function getClientId() * @param RequestInterface $request * @param ResponseInterface $response * @return array|null A list containing the client identifier and password, for example: - * @code + * * return array( * "client_id" => CLIENT_ID, // REQUIRED the client id * "client_secret" => CLIENT_SECRET, // OPTIONAL the client secret (may be omitted for public clients) * ); - * @endcode + * * * @see http://tools.ietf.org/html/rfc6749#section-2.3.1 * diff --git a/src/OAuth2/Controller/AuthorizeController.php b/src/OAuth2/Controller/AuthorizeController.php index 181f884a..ac447d38 100644 --- a/src/OAuth2/Controller/AuthorizeController.php +++ b/src/OAuth2/Controller/AuthorizeController.php @@ -69,14 +69,14 @@ class AuthorizeController implements AuthorizeControllerInterface * keys are "code" and "token" * @param array $config OPTIONAL Configuration options for the server: * @param ScopeInterface $scopeUtil OPTIONAL Instance of OAuth2\ScopeInterface to validate the requested scope - * @code + * * $config = array( * 'allow_implicit' => false, // if the controller should allow the "implicit" grant type * 'enforce_state' => true // if the controller should require the "state" parameter * 'require_exact_redirect_uri' => true, // if the controller should require an exact match on the "redirect_uri" parameter * 'redirect_status_code' => 302, // HTTP status code to use for redirect responses * ); - * @endcode + * */ public function __construct(ClientInterface $clientStorage, array $responseTypes = array(), array $config = array(), ?ScopeInterface $scopeUtil = null) { diff --git a/src/OAuth2/Controller/AuthorizeControllerInterface.php b/src/OAuth2/Controller/AuthorizeControllerInterface.php index f758f976..29a40266 100644 --- a/src/OAuth2/Controller/AuthorizeControllerInterface.php +++ b/src/OAuth2/Controller/AuthorizeControllerInterface.php @@ -11,7 +11,7 @@ * authorization directly, this controller ensures the request is valid, but * requires the application to determine the value of $is_authorized * - * @code + * * $user_id = $this->somehowDetermineUserId(); * $is_authorized = $this->somehowDetermineUserAuthorization(); * $response = new OAuth2\Response(); @@ -22,7 +22,7 @@ * $user_id * ); * $response->send(); - * @endcode + * */ interface AuthorizeControllerInterface { diff --git a/src/OAuth2/Controller/ResourceControllerInterface.php b/src/OAuth2/Controller/ResourceControllerInterface.php index 0e847ca6..3f897692 100644 --- a/src/OAuth2/Controller/ResourceControllerInterface.php +++ b/src/OAuth2/Controller/ResourceControllerInterface.php @@ -10,13 +10,13 @@ * call verifyResourceRequest in order to determine if the request * contains a valid token. * - * @code + * * if (!$resourceController->verifyResourceRequest(OAuth2\Request::createFromGlobals(), $response = new OAuth2\Response())) { * $response->send(); // authorization failed * die(); * } * return json_encode($resource); // valid token! Send the stuff! - * @endcode + * */ interface ResourceControllerInterface { diff --git a/src/OAuth2/Controller/TokenControllerInterface.php b/src/OAuth2/Controller/TokenControllerInterface.php index 2f83ce4b..f4e53f7c 100644 --- a/src/OAuth2/Controller/TokenControllerInterface.php +++ b/src/OAuth2/Controller/TokenControllerInterface.php @@ -10,10 +10,10 @@ * it is called to handle all grant types the application supports. * It also validates the client's credentials * - * @code + * * $tokenController->handleTokenRequest(OAuth2\Request::createFromGlobals(), $response = new OAuth2\Response()); * $response->send(); - * @endcode + * */ interface TokenControllerInterface { diff --git a/src/OAuth2/GrantType/RefreshToken.php b/src/OAuth2/GrantType/RefreshToken.php index 75c611f1..89ea2c6e 100644 --- a/src/OAuth2/GrantType/RefreshToken.php +++ b/src/OAuth2/GrantType/RefreshToken.php @@ -30,12 +30,12 @@ class RefreshToken implements GrantTypeInterface /** * @param RefreshTokenInterface $storage - REQUIRED Storage class for retrieving refresh token information * @param array $config - OPTIONAL Configuration options for the server - * @code + * * $config = array( * 'always_issue_new_refresh_token' => true, // whether to issue a new refresh token upon successful token request * 'unset_refresh_token_after_use' => true // whether to unset the refresh token after after using * ); - * @endcode + * */ public function __construct(RefreshTokenInterface $storage, $config = array()) { diff --git a/src/OAuth2/OpenID/Controller/UserInfoControllerInterface.php b/src/OAuth2/OpenID/Controller/UserInfoControllerInterface.php index 88e9228d..74415236 100644 --- a/src/OAuth2/OpenID/Controller/UserInfoControllerInterface.php +++ b/src/OAuth2/OpenID/Controller/UserInfoControllerInterface.php @@ -9,14 +9,14 @@ * This controller is called when the user claims for OpenID Connect's * UserInfo endpoint should be returned. * - * @code + * * $response = new OAuth2\Response(); * $userInfoController->handleUserInfoRequest( * OAuth2\Request::createFromGlobals(), * $response * ); * $response->send(); - * @endcode + * */ interface UserInfoControllerInterface { diff --git a/src/OAuth2/ResponseType/AccessToken.php b/src/OAuth2/ResponseType/AccessToken.php index 8b5aec14..46803096 100644 --- a/src/OAuth2/ResponseType/AccessToken.php +++ b/src/OAuth2/ResponseType/AccessToken.php @@ -30,13 +30,13 @@ class AccessToken implements AccessTokenInterface * @param AccessTokenStorageInterface $tokenStorage - REQUIRED Storage class for saving access token information * @param RefreshTokenInterface $refreshStorage - OPTIONAL Storage class for saving refresh token information * @param array $config - OPTIONAL Configuration options for the server - * @code + * * $config = array( * 'token_type' => 'bearer', // token type identifier * 'access_lifetime' => 3600, // time before access token expires * 'refresh_token_lifetime' => 1209600, // time before refresh token expires * ); - * @endcode + * */ public function __construct(AccessTokenStorageInterface $tokenStorage, ?RefreshTokenInterface $refreshStorage = null, array $config = array()) { diff --git a/src/OAuth2/Storage/AccessTokenInterface.php b/src/OAuth2/Storage/AccessTokenInterface.php index 22428f2c..07a318e9 100644 --- a/src/OAuth2/Storage/AccessTokenInterface.php +++ b/src/OAuth2/Storage/AccessTokenInterface.php @@ -18,7 +18,7 @@ interface AccessTokenInterface * @param string $oauth_token - oauth_token to be check with. * * @return array|null - An associative array as below, and return NULL if the supplied oauth_token is invalid: - * @code + * * array( * 'expires' => $expires, // Stored expiration in unix timestamp. * 'client_id' => $client_id, // (optional) Stored client identifier. @@ -26,7 +26,7 @@ interface AccessTokenInterface * 'scope' => $scope, // (optional) Stored scope values in space-separated string. * 'id_token' => $id_token // (optional) Stored id_token (if "use_openid_connect" is true). * ); - * @endcode + * * * @ingroup oauth2_section_7 */ diff --git a/src/OAuth2/Storage/AuthorizationCodeInterface.php b/src/OAuth2/Storage/AuthorizationCodeInterface.php index 2dbc138a..9da23d40 100644 --- a/src/OAuth2/Storage/AuthorizationCodeInterface.php +++ b/src/OAuth2/Storage/AuthorizationCodeInterface.php @@ -32,7 +32,7 @@ interface AuthorizationCodeInterface * * @return * An associative array as below, and NULL if the code is invalid - * @code + * * return array( * "client_id" => CLIENT_ID, // REQUIRED Stored client identifier * "user_id" => USER_ID, // REQUIRED Stored user identifier @@ -40,7 +40,7 @@ interface AuthorizationCodeInterface * "redirect_uri" => REDIRECT_URI, // REQUIRED Stored redirect URI * "scope" => SCOPE, // OPTIONAL Stored scope values in space-separated string * ); - * @endcode + * * * @see http://tools.ietf.org/html/rfc6749#section-4.1 * diff --git a/src/OAuth2/Storage/ClientCredentialsInterface.php b/src/OAuth2/Storage/ClientCredentialsInterface.php index 3318c696..22b65e2d 100644 --- a/src/OAuth2/Storage/ClientCredentialsInterface.php +++ b/src/OAuth2/Storage/ClientCredentialsInterface.php @@ -21,7 +21,6 @@ interface ClientCredentialsInterface extends ClientInterface * * @return * TRUE if the client credentials are valid, and MUST return FALSE if it isn't. - * @endcode * * @see http://tools.ietf.org/html/rfc6749#section-3.1 * @@ -38,7 +37,6 @@ public function checkClientCredentials($client_id, $client_secret = null); * * @return * TRUE if the client is public, and FALSE if it isn't. - * @endcode * * @see http://tools.ietf.org/html/rfc6749#section-2.3 * @see https://github.com/bshaffer/oauth2-server-php/issues/257 diff --git a/src/OAuth2/Storage/UserCredentialsInterface.php b/src/OAuth2/Storage/UserCredentialsInterface.php index f550579e..c03ab99a 100644 --- a/src/OAuth2/Storage/UserCredentialsInterface.php +++ b/src/OAuth2/Storage/UserCredentialsInterface.php @@ -41,12 +41,12 @@ public function checkUserCredentials($username, $password); * @return array|false - the associated "user_id" and optional "scope" values * This function MUST return FALSE if the requested user does not exist or is * invalid. "scope" is a space-separated list of restricted scopes. - * @code + * * return array( * "user_id" => USER_ID, // REQUIRED user_id to be stored with the authorization code or access token * "scope" => SCOPE // OPTIONAL space-separated list of restricted scopes * ); - * @endcode + * */ public function getUserDetails($username); }