Класс AuthComponent

__get()source public

__get( string $name )

Магический аксессор для обратной совместимости для свойства $sessionKey.

Параметры

string $name

Имя свойства

Возвращает

mixed

Переопределяет

Cake\Controller\Component::__get()

__set()source public

__set( string $name , mixed $value )

Магический установщик для обратной совместимости для свойства $sessionKey.

Параметры

string $name

Имя свойства.

mixed $value

Значение для установки.

_getUser()source protected

_getUser( )

Аналогично AuthComponent::user(), но если пользователь не найден в конфигурированном хранилище, вызываются методы getUser() подключенных объектов аутентификации.

Это позволяет корректно работать методам бессостоятельной аутентификации.

Возвращает

boolean
true, если пользователь найден, false, если нет.

_isAllowed()source protected

_isAllowed( Cake\Controller\Controller $controller )

Проверяет, доступен ли текущий action без аутентификации.

Параметры

Cake\Controller\Controller $controller

Ссылка на объект-контроллер, инициализирующий компонент

Возвращает

boolean
True, если action доступен без аутентификации, иначе false

_isLoginAction()source protected

_isLoginAction( Cake\Controller\Controller $controller )

Нормализует конфигурацию loginAction и проверяет, совпадает ли текущий URL запроса с action входа в систему.

Параметры

Cake\Controller\Controller $controller

Ссылка на объект контроллера.

Возвращает

boolean
True, если текущий action является action входа в систему, иначе false.

_setDefaults()source protected

_setDefaults( )

Устанавливает значения по умолчанию для конфигураций.

_unauthenticated()source protected

_unauthenticated( Cake\Controller\Controller $controller )

Обрабатывает попытку доступа без аутентификации. Сначала вызывается метод unauthenticated() последнего аутентификатора в цепочке. Аутентификатор может обработать отправку ответа или перенаправление по необходимости и вернуть true для указания того, что дальнейшие действия не нужны. Если аутентификатор возвращает null, этот метод перенаправляет пользователя на action входа в систему. Если это AJAX-запрос и указана конфигурация ajaxLogin, то рендерится этот элемент, иначе возвращается HTTP-код состояния 403.

Параметры

Cake\Controller\Controller $controller

Ссылка на объект контроллера.

Возвращает

mixed|null

Null, если текущий action является действием входа в систему, иначе объект ответа, возвращённый объектом аутентификации или Controller::redirect().

_unauthorized()source protected

_unauthorized( Cake\Controller\Controller $controller )

Обработка попытки несанкционированного доступа

Параметры

Cake\Controller\Controller $controller

Ссылка на объект контроллера

Возвращает

mixed

Исключения

Cake\Network\Exception\ForbiddenException

allow()source public

allow( string|array|null $actions null )

Принимает список действий в текущем контроллере, для которых не требуется аутентификация, или без параметров для разрешения всех действий.

Вы можете использовать allow с массивом или простой строкой.

$this->Auth->allow('view');
$this->Auth->allow(['edit', 'add']);

или для разрешения всех действий

$this->Auth->allow();

Параметры

string|array|null $actions необязательно null

Имя действия контроллера или массив действий

Ссылка

http://book.cakephp.org/3.0/ru/controllers/components/authentication.html#making-actions-public

authCheck()source public

authCheck( Cake\Event\Event $event )

Основной метод выполнения, обрабатывает начальную проверку аутентификации и перенаправление недопустимых пользователей.

Проверка аутентификации выполняется, когда имя события совпадает с именем, настроенным в конфигурации checkAuthIn.

Параметры

Cake\Event\Event $event

Экземпляр события.

Возвращает

mixed|null

authenticationProvider()source public

authenticationProvider( )

Если вход в систему был вызван во время этого запроса и пользователь успешно прошёл аутентификацию, эта функция вернёт экземпляр объекта аутентификации, который был использован для входа пользователя.

Возвращает

mixed|null

authorizationProvider()source public

authorizationProvider( )

Если для текущего запроса была произведена обработка авторизации, эта функция вернёт экземпляр объекта Authorization, который предоставил пользователю доступ к текущему адресу.

Возвращает

mixed|null

constructAuthenticate()source public

constructAuthenticate( )

Загружает настроенные объекты аутентификации.

Возвращает

array|null
Загруженные объекты авторизации или null при пустом значении authenticate.

Исключения

Cake\Core\Exception\Exception

constructAuthorize()source public

constructAuthorize( )

Загружает настроенные объекты авторизации.

Возвращает

array|null
Загруженные объекты авторизации, или null при пустом значении authorize.

Исключения

Cake\Core\Exception\Exception

deny()source public

deny( string|array|null $actions null )

Удаляет элементы из списка разрешённых/не требующих аутентификации действий.

Вы можете использовать deny с массивом или простой строкой.

$this->Auth->deny('view');
$this->Auth->deny(['edit', 'add']);

или

$this->Auth->deny();

чтобы удалить все элементы из разрешённого списка

Параметры

string|array|null $actions необязательно null

Имя действия контроллера или массив действий

См. также

\Cake\Controller\Component\AuthComponent::allow()

Ссылка

http://book.cakephp.org/3.0/ru/controllers/components/authentication.html#making-actions-require-authorization

flash()source public

flash( string $message )

Устанавливает сообщение flash. Использует компонент Flash со значениями из конфигурации flash.

Параметры

string $message

Сообщение для установки.

getAuthenticate()source public

getAuthenticate( string $alias )

Получатель объектов аутентификации. Вернёт конкретный объект аутентификации.

Параметры

string $alias

Псевдоним для объекта аутентификации

Возвращает

mixed|null

getAuthorize()source public

getAuthorize( string $alias )

Получатель объектов авторизации. Вернёт конкретный объект авторизации.

Параметры

string $alias

Псевдоним для объекта авторизации

Возвращает

mixed|null

identify()source public

identify( )

Используйте настроенные адаптеры аутентификации и попробуйте идентифицировать пользователя по данным авторизации, содержащимся в $request.

Вызывает событие Auth.afterIdentify , на которое могут реагировать классы аутентификации.

Возвращает

array|boolean
Данные записи пользователя или false, если пользователя не удалось идентифицировать.

implementedEvents()source public

implementedEvents( )

Поддерживаемые этим компонентом события.

Возвращает

array

Переопределяет

Cake\Controller\Component::implementedEvents()

initialize()source public

initialize( array $config )

Инициализировать свойства.

Параметры

array $config

Данные конфигурации.

Переопределяет

Cake\Controller\Component::initialize()

isAuthorized()source public

isAuthorized( array|ArrayAccess|null $user null , Cake\Network\Request $request null )

Проверить, авторизован ли предоставленный пользователь для запроса.

Использует настроенные адаптеры авторизации, чтобы проверить, авторизован ли пользователь. Каждый адаптер проверяется последовательно. Если любой из них возвращает true, то пользователь авторизован для запроса.

Параметры

array|ArrayAccess|null $user необязательно null

Пользователь, авторизацию которого нужно проверить. Если пусто, используется пользователь, извлеченный из хранилища.

Cake\Network\Request $request необязательно null

Запрос для проверки аутентификации. Если пусто, используется текущий запрос.

Возвращает

boolean
True, если $user авторизован, иначе false

logout()source public

logout( )

Выйти из системы.

Возвращает действие выхода для перенаправления. Вызывает событие Auth.logout, которое могут обрабатывать классы аутентификации для выполнения пользовательской логики выхода.

Возвращает

string
Нормализованная конфигурация logoutRedirect

Ссылка

http://book.cakephp.org/3.0/ru/controllers/components/authentication.html#logging-users-out

redirectUrl()source public

redirectUrl( string|array|null $url null )

Получить URL, на который должен быть перенаправлен пользователь после входа.

Передайте URL, чтобы установить пункт назначения, на который должен быть перенаправлен пользователь после входа.

Если параметр не передан, получает URL перенаправления аутентификации. Возвращаемый URL соответствует следующим правилам:

• Возвращает нормализованный URL перенаправления из хранилища, если он есть и для того же домена, на котором работает текущее приложение.
• Если из хранилища не возвращается URL и существует конфигурация loginRedirect, возвращается значение loginRedirect.
• Если сессии нет и нет loginRedirect, возвращается /.

Параметры

string|array|null $url необязательно null

Необязательный URL для записи в качестве URL перенаправления при входе.

Возвращает

string
URL перенаправления

setUser()source public

setUser( array|ArrayAccess $user )

Установить предоставленные данные пользователя в хранилище как данные вошедшего пользователя.

Класс хранилища настраивается с использованием ключа конфигурации storage или передачей экземпляра в AuthComponent::storage().

Параметры

array|ArrayAccess $user

Данные пользователя.

Ссылка

http://book.cakephp.org/3.0/ru/controllers/components/authentication.html#identifying-users-and-logging-them-in

startup()source public

startup( Cake\Event\Event $event )

Обработчик события Controller.startup.

Параметры

Cake\Event\Event $event

Экземпляр события.

Возвращает

Cake\Network\Response|null

storage()source public

storage( Cake\Auth\Storage\StorageInterface $storage null )

Получить/установить объект хранения записей пользователей.

Параметры

Cake\Auth\Storage\StorageInterface $storage необязательно null

Устанавливает предоставленный объект как хранилище или, если null, возвращает настроенный объект хранилища.

Возвращает

Cake\Auth\Storage\StorageInterface|null

user()source public

user( string|null $key null )

Получить текущего пользователя из хранилища.

Параметры

string|null $key необязательно null

Поле для извлечения. Оставьте null, чтобы получить всю запись пользователя.

Возвращает

mixed|null
Либо запись пользователя, либо null, если пользователь не вошел в систему, или извлеченное поле, если ключ указан.

Ссылка

http://book.cakephp.org/3.0/ru/controllers/components/authentication.html#accessing-the-logged-in-user

__construct()source public

__construct( Cake\Controller\ComponentRegistry $registry , array $config [] )

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry

КомпонентRegistry, который может использовать этот компонент для ленивой загрузки своих компонентов

array $config необязательно []

Массив настроек конфигурации.

__debugInfo()source public

__debugInfo( )

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

array

dispatchEvent()source public

dispatchEvent( string $name , array|null $data null , object|null $subject null )

Обёртка для создания и отправки событий.

Возвращает отправленное событие.

Параметры

string $name

Имя события.

array|null $data необязательно null

Любое значение, которое вы хотите передать с этим событием, чтобы слушатели могли его прочитать.

object|null $subject необязательно null

Объект, к которому относится это событие ($this по умолчанию).

Возвращает

Cake\Event\Event

eventManager()source public

eventManager( Cake\Event\EventManager $eventManager null )

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.

Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов событий объекта, или создавать свои собственные события и вызывать их по желанию.

Параметры

Cake\Event\EventManager $eventManager необязательно null

eventManager для установки

Возвращает

Cake\Event\EventManager

_configDelete()source protected

_configDelete( string $key )

Удалить один ключ конфигурации

Параметры

string $key

Ключ для удаления.

Вызывает

Cake\Core\Exception\Exception
если пытаетесь перезаписать существующую конфигурацию

_configRead()source protected

_configRead( string|null $key )

Чтение значения конфигурации

Параметры

string|null $key

Ключ для чтения.

Возвращаемое значение

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Запись значения конфигурации

Параметры

string|array $key

Ключ для записи.

mixed $value

Значение для записи.

boolean|string $merge необязательно false

Истинное значение для рекурсивного слияния, 'shallow' для простого слияния, ложное значение для перезаписи, по умолчанию ложно.

Исключения

Cake\Core\Exception\Exception
при попытке перезаписи существующей конфигурации

config()source public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Использование

Чтение всей конфигурации:

$this->config();

Чтение определенного значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

string|array|null $key необязательно null

Ключ для получения/установки или полный массив конфигурации.

mixed|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Выполнять ли рекурсивное слияние или перезапись существующей конфигурации, по умолчанию истинно.

Возвращаемое значение

mixed
Значение конфигурации, которое читается, или сам объект при операциях записи.

Исключения

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

configShallow()source public

configShallow( string|array $key , mixed|null $value null )

Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

Ключ для установки или полный массив конфигурации.

mixed|null $value необязательно null

Значение для установки.

Возвращаемое значение

$this Объект сам по себе.

log()source public

log( mixed $msg , integer|string $level LogLevel::ERROR , string|array $context [] )

Удобный метод для записи сообщения в журнал. См. Log::write() для получения дополнительной информации о записи в журналы.

Параметры

mixed $msg

Сообщение журнала.

integer|string $level необязательно LogLevel::ERROR

Уровень ошибки.

string|array $context необязательно []

Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращаемое значение

boolean
Успешность записи в журнал.

[]

[]

[
    'authenticate' => null,
    'authorize' => null,
    'ajaxLogin' => null,
    'flash' => null,
    'loginAction' => null,
    'loginRedirect' => null,
    'logoutRedirect' => null,
    'authError' => null,
    'unauthorizedRedirect' => true,
    'storage' => 'Session',
    'checkAuthIn' => 'Controller.startup'
]

[]

['RequestHandler', 'Flash']