PHP Класс CakeDC\Users\Auth\ApiKeyAuthenticate

Наследование: extends Cake\Auth\BaseAuthenticate

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$types

Защищенные свойства (Protected)

Свойство	Тип	Описание
$_defaultConfig

Открытые методы

Метод	Описание
authenticate ( Cake\Network\Request $request, Response $response ) : mixed	Authenticate callback Reads the API Key based on configuration and login the user
getUser ( Cake\Network\Request $request ) : mixed	Stateless Authentication System http://book.cakephp.org/3.0/en/controllers/components/authentication.html#creating-stateless-authentication-systems
header ( Cake\Network\Request $request ) : string	Get the api key from the header
querystring ( Cake\Network\Request $request ) : string	Get the api key from the querystring

Описание методов

authenticate() публичный Метод

Authenticate callback Reads the API Key based on configuration and login the user

public authenticate ( Cake\Network\Request $request, Response $response ) : mixed
$request	Cake\Network\Request	Cake request object.
$response	Cake\Network\Response	Cake response object.
Результат	mixed

getUser() публичный Метод

Config: $this->Auth->config('storage', 'Memory'); $this->Auth->config('unauthorizedRedirect', 'false'); $this->Auth->config('checkAuthIn', 'Controller.initialize'); $this->Auth->config('loginAction', false);

public getUser ( Cake\Network\Request $request ) : mixed
$request	Cake\Network\Request	Cake request object.
Результат	mixed

header() публичный Метод

Get the api key from the header

public header ( Cake\Network\Request $request ) : string
$request	Cake\Network\Request	request
Результат	string	api key

querystring() публичный Метод

Get the api key from the querystring

public querystring ( Cake\Network\Request $request ) : string
$request	Cake\Network\Request	request
Результат	string	api key

Описание свойств

$_defaultConfig защищенное свойство

protected $_defaultConfig

$types публичное свойство

public $types