PHP Class ZF\OAuth2\Controller\AuthController

Inheritance: extends Zend\Mvc\Controller\AbstractActionController
ファイルを表示 Open project: zfcampus/zf-oauth2 Class Usage Examples

Protected Properties

Property Type Description
$apiProblemErrorResponse boolean
$server OAuth2\Server
$serverFactory Factory for generating an OAuth2Server instance.
$userIdProvider ZF\OAuth2\Provider\UserId\UserIdProviderInterface

Public Methods

Method Description
__construct ( callable $serverFactory, ZF\OAuth2\Provider\UserId\UserIdProviderInterface $userIdProvider ) Constructor
authorizeAction ( ) Authorize action (/oauth/authorize)
isApiProblemErrorResponse ( ) : boolean Should the controller return ApiProblemResponse?
receiveCodeAction ( ) Receive code action prints the code/token access
resourceAction ( ) Test resource (/oauth/resource)
revokeAction ( ) Token Revoke (/oauth/revoke)
setApiProblemErrorResponse ( boolean $apiProblemErrorResponse ) Indicate whether ApiProblemResponse or oauth2 errors should be returned.
tokenAction ( ) Token Action (/oauth)

Protected Methods

Method Description
getApiProblemResponse ( OAuth2\Response $response ) : ZF\ApiProblem\ApiProblemResponse Map OAuth2Response to ApiProblemResponse
getErrorResponse ( OAuth2\Response $response ) : ZF\ApiProblem\ApiProblemResponse | Zend\Stdlib\ResponseInterface
getOAuth2Request ( ) : OAuth2\Request Create an OAuth2 request based on the ZF2 request object

Private Methods

Method Description
getOAuth2Server ( string $type ) : OAuth2\Server Retrieve the OAuth2\Server instance.
setHttpResponse ( OAuth2\Response $response ) : Zend\Http\Response Convert the OAuth2 response to a \Zend\Http\Response

Method Details

__construct() public method

Constructor
public __construct ( callable $serverFactory, ZF\OAuth2\Provider\UserId\UserIdProviderInterface $userIdProvider )
$serverFactory callable
$userIdProvider ZF\OAuth2\Provider\UserId\UserIdProviderInterface

authorizeAction() public method

Authorize action (/oauth/authorize)
public authorizeAction ( )

getApiProblemResponse() protected method

Map OAuth2Response to ApiProblemResponse
protected getApiProblemResponse ( OAuth2\Response $response ) : ZF\ApiProblem\ApiProblemResponse
$response OAuth2\Response
return ZF\ApiProblem\ApiProblemResponse

getErrorResponse() protected method

protected getErrorResponse ( OAuth2\Response $response ) : ZF\ApiProblem\ApiProblemResponse | Zend\Stdlib\ResponseInterface
$response OAuth2\Response
return ZF\ApiProblem\ApiProblemResponse | Zend\Stdlib\ResponseInterface

getOAuth2Request() protected method

Marshals: - query string - body parameters, via content negotiation - "server", specifically the request method and content type - raw content - headers This ensures that JSON requests providing credentials for OAuth2 verification/validation can be processed.
protected getOAuth2Request ( ) : OAuth2\Request
return OAuth2\Request

isApiProblemErrorResponse() public method

Should the controller return ApiProblemResponse?
public isApiProblemErrorResponse ( ) : boolean
return boolean

receiveCodeAction() public method

Receive code action prints the code/token access
public receiveCodeAction ( )

resourceAction() public method

Test resource (/oauth/resource)
public resourceAction ( )

revokeAction() public method

Token Revoke (/oauth/revoke)
public revokeAction ( )

setApiProblemErrorResponse() public method

Boolean true indicates ApiProblemResponse should be returned (the default), while false indicates oauth2 errors (per the oauth2 spec) should be returned.
public setApiProblemErrorResponse ( boolean $apiProblemErrorResponse )
$apiProblemErrorResponse boolean

tokenAction() public method

Token Action (/oauth)
public tokenAction ( )

Property Details

$apiProblemErrorResponse protected_oe property

protected bool $apiProblemErrorResponse
return boolean

$server protected_oe property

protected Server,OAuth2 $server
return OAuth2\Server

$serverFactory protected_oe property

Factory for generating an OAuth2Server instance.
protected $serverFactory

$userIdProvider protected_oe property

protected UserIdProviderInterface,ZF\OAuth2\Provider\UserId $userIdProvider
return ZF\OAuth2\Provider\UserId\UserIdProviderInterface