PHP Class ZF\Apigility\Admin\Controller\AuthenticationController

Inheritance: extends AbstractAuthenticationController
Show file Open project: zfcampus/zf-apigility-admin

Protected Properties

Property Type Description
$model

Public Methods

Method Description
__construct ( AuthenticationModel $model )
authenticationAction ( )
mappingAction ( ) Mapping action for v2 Since Apigility 1.1

Protected Methods

Method Description
authVersion1 ( Zend\Http\Request $request ) : ZF\ContentNegotiation\ViewModel | ZF\ApiProblem\ApiProblemResponse | Zend\Stdlib\ResponseInterface Manage the authentication API version 1
authVersion2 ( Zend\Http\Request $request ) : ZF\ContentNegotiation\ViewModel | ZF\ApiProblem\ApiProblemResponse | Zend\Http\Response Manage the authentication API version 2
getRouteForEntity ( AuthenticationEntity $entity ) : string Determine the route to use for a given entity
mappingAuthentication ( Zend\Http\Request $request ) : ZF\ContentNegotiation\ViewModel | ZF\ApiProblem\ApiProblemResponse Map the authentication adapter to a module Since Apigility 1.1

Private Methods

Method Description
createAuthenticationAdapter ( array $params ) : ZF\ApiProblem\ApiProblemResponse | Zend\Http\Response Create a new authentication adapter
createAuthenticationMapResult ( string $adapter ) : ZF\ContentNegotiation\ViewModel Create a view model detailing the authentication adapter mapped
createCollection ( mixed $collection ) : ZF\ContentNegotiation\ViewModel Create a collection response
createEntity ( mixed $entity ) : ZF\ContentNegotiation\ViewModel Create and return an entity view model
fetchAuthenticationCollection ( ) : ZF\ContentNegotiation\ViewModel Fetch a collection of authentication adapters
fetchAuthenticationEntity ( string $adapter ) : ZF\ApiProblem\ApiProblemResponse | ZF\ContentNegotiation\ViewModel Fetch an authentication entity
removeAuthenticationAdapter ( string $adapter ) : ZF\ApiProblem\ApiProblemResponse | Zend\Http\Response Remove an existing authentication adapter
removeAuthenticationMap ( string $module, string | integer $version ) : ZF\ApiProblem\ApiProblemResponse | Zend\Stdlib\ResponseInterface Remove the authentication map for a given module/version pair.
updateAuthenticationAdapter ( string $adapter, array $params ) : ZF\ApiProblem\ApiProblemResponse | ZF\ContentNegotiation\ViewModel Update an existing authentication adapter
updateAuthenticationMap ( array $params, string $module, string | integer $version ) : ZF\ContentNegotiation\ViewModel | ZF\ApiProblem\ApiProblemResponse Attempt to save an authentication map.

Method Details

__construct() public method

public __construct ( AuthenticationModel $model )
$model ZF\Apigility\Admin\Model\AuthenticationModel

authVersion1() protected method

Manage the authentication API version 1
protected authVersion1 ( Zend\Http\Request $request ) : ZF\ContentNegotiation\ViewModel | ZF\ApiProblem\ApiProblemResponse | Zend\Stdlib\ResponseInterface
$request Zend\Http\Request
return ZF\ContentNegotiation\ViewModel | ZF\ApiProblem\ApiProblemResponse | Zend\Stdlib\ResponseInterface

authVersion2() protected method

Manage the authentication API version 2
protected authVersion2 ( Zend\Http\Request $request ) : ZF\ContentNegotiation\ViewModel | ZF\ApiProblem\ApiProblemResponse | Zend\Http\Response
$request Zend\Http\Request
return ZF\ContentNegotiation\ViewModel | ZF\ApiProblem\ApiProblemResponse | Zend\Http\Response

authenticationAction() public method

getRouteForEntity() protected method

Determine the route to use for a given entity
protected getRouteForEntity ( AuthenticationEntity $entity ) : string
$entity ZF\Apigility\Admin\Model\AuthenticationEntity
return string

mappingAction() public method

Mapping action for v2 Since Apigility 1.1
public mappingAction ( )

mappingAuthentication() protected method

Map the authentication adapter to a module Since Apigility 1.1
protected mappingAuthentication ( Zend\Http\Request $request ) : ZF\ContentNegotiation\ViewModel | ZF\ApiProblem\ApiProblemResponse
$request Zend\Http\Request
return ZF\ContentNegotiation\ViewModel | ZF\ApiProblem\ApiProblemResponse

Property Details

$model protected property

protected $model