\OAuth2\OpenID\ResponseTypeAuthorizationCode

Summary

Methods
Properties
Constants
__construct()
getAuthorizeResponse()
createAuthorizationCode()
enforceRedirect()
No public properties found
No constants found
generateAuthorizationCode()
$storage
$config
N/A
No private methods found
No private properties found
N/A

Properties

$storage

$storage : 

Type

$config

$config : 

Type

Methods

getAuthorizeResponse()

getAuthorizeResponse(  $params, null  $user_id = null) : array

Parameters

$params
null $user_id

Returns

array

createAuthorizationCode()

createAuthorizationCode(mixed  $client_id, mixed  $user_id, string  $redirect_uri, string  $scope = null, string  $id_token = null) : string

Handle the creation of the authorization code.

Parameters

mixed $client_id
  • Client identifier related to the authorization code
mixed $user_id
  • User ID associated with the authorization code
string $redirect_uri
  • An absolute URI to which the authorization server will redirect the user-agent to when the end-user authorization step is completed.
string $scope
  • OPTIONAL Scopes to be stored in space-separated string.
string $id_token
  • OPTIONAL The OpenID Connect id_token.

Returns

string

enforceRedirect()

enforceRedirect() : TRUE

Returns

TRUE —

if the grant type requires a redirect_uri, FALSE if not

generateAuthorizationCode()

generateAuthorizationCode() : \OAuth2\ResponseType\An

Generates an unique auth code.

Implementing classes may want to override this function to implement other auth code generation schemes.

Returns

\OAuth2\ResponseType\An —

unique auth code.