Класс 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 )

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

Параметры

Cake\Controller\Controller $controller

Ссылка на объект-контроллер, который создал данный объект

Возвращает

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

_isLoginAction()source protected

_isLoginAction( Cake\Controller\Controller $controller )

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

Параметры

Cake\Controller\Controller $controller

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

Возвращает

boolean
True, если текущая операция - операция входа в систему, иначе false.

_setDefaults()source protected

_setDefaults( )

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

_unauthenticated()source protected

_unauthenticated( Cake\Controller\Controller $controller )

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

Параметры

Cake\Controller\Controller $controller

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

Возвращает

Cake\Network\Response|null

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

_unauthorized()source protected

_unauthorized( Cake\Controller\Controller $controller )

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

Параметры

Cake\Controller\Controller $controller

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

Возвращает

Cake\Network\Response

Вызывает

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 optional 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

Объект события.

Возвращает

Cake\Network\Response|null

authenticationProvider()source public

authenticationProvider( )

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

Возвращает

Cake\Auth\BaseAuthenticate|null

authorizationProvider()source public

authorizationProvider( )

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

Возвращает

Cake\Auth\BaseAuthorize|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 optional 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.

Параметры

string $message

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

getAuthenticate()source public

getAuthenticate( string $alias )

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

Параметры

string $alias

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

Возвращает

Cake\Auth\BaseAuthenticate|null

getAuthorize()source public

getAuthorize( string $alias )

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

Параметры

строка $alias

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

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

Cake\Auth\BaseAuthorize|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 )

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

Параметры

массив $config

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

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

Cake\Controller\Component::initialize()

isAuthorized()source public

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

Проверка авторизации предоставленного пользователя для запроса.

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

Параметры

массив|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, возвращается /.

Параметры

строка|массив|null $url необязательно null

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

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

строка
URL перенаправления

setUser()source public

setUser( array $user )

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

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

Параметры

массив $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 )

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

Параметры

строка|null $key необязательно null

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

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

смешанное|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, которую может использовать этот компонент для ленивой загрузки своих компонентов

массив $config необязательно []

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

__debugInfo()source public

__debugInfo( )

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

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

массив

dispatchEvent()source public

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

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

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

Параметры

строка $name

Имя события.

массив|null $data необязательно null

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

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

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

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

Cake\Event\Event

eventManager()source public

eventManager( Cake\Event\EventManager $eventManager null )

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

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

Параметры

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

менеджер событий для установки

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

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

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

Выбрасывает

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

Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию 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']