Класс AuthComponent

__get()source public

__get( string $name )

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

Параметры

строка $name

Имя свойства

Возвращает

mixed

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

Cake\Controller\Component::__get()

__set()source public

__set( string $name , mixed $value )

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

Параметры

строка $name

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

смешанное $value

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

_getUrlToRedirectBackTo()source protected

_getUrlToRedirectBackTo( )

Возвращает URL для перенаправления обратно или / если это невозможно.

Этот метод учитывает referrer, если тип запроса не GET.

Возвращает

строка

_getUser()source protected

_getUser( )

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

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

Возвращает

логическое
true Если пользователь найден, false если нет.

_isAllowed()source protected

_isAllowed( Cake\Controller\Controller $controller )

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

Параметры

Cake\Controller\Controller $controller

Ссылка на объект экземпляра контроллера

Возвращает

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

_isLoginAction()source protected

_isLoginAction( Cake\Controller\Controller $controller )

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

Параметры

Cake\Controller\Controller $controller

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

Возвращает

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

_loginActionRedirectUrl()source protected

_loginActionRedirectUrl( )

Возвращает URL действия входа в систему для перенаправления.

Включает строку запроса перенаправления, если применимо.

Возвращает

массив|строка

_setDefaults()source protected

_setDefaults( )

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

_unauthenticated()source protected

_unauthenticated( Cake\Controller\Controller $controller )

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

Параметры

Cake\Controller\Controller $controller

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

Возвращает

Cake\Http\Response|null

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

Выбрасывает

Cake\Core\Exception\Exception

_unauthorized()source protected

_unauthorized( Cake\Controller\Controller $controller )

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

Параметры

Cake\Controller\Controller $controller

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

Возвращает

Cake\Http\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

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

Ссылка

https://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\Http\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()

Ссылка

https://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 )

Геттер для объектов authenticate. Возвращает конкретный объект authenticate.

Параметры

string $alias

Псевдоним объекта authenticate

Возвращает

Cake\Auth\BaseAuthenticate|null

getAuthorize()source public

getAuthorize( string $alias )

Геттер для объектов authorize. Возвращает конкретный объект authorize.

Параметры

string $alias

Псевдоним объекта authorize

Возвращает

Cake\Auth\BaseAuthorize|null

identify()source public

identify( )

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

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

Возвращает

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\Http\ServerRequest $request null )

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

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

Параметры

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

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

Cake\Http\ServerRequest $request необязательно null

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

Возвращает

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

logout()source public

logout( )

Выход пользователя из системы.

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

Возвращает

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

Ссылка

https://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 перенаправления при входе.

Возвращает

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

setUser()source public

setUser( array|ArrayAccess $user )

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

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

Параметры

массив|ArrayAccess $user

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

Ссылка

https://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\Http\Response|null

storage()source public

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

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

Параметры

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

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

Возвращает

Cake\Auth\Storage\StorageInterface|Cake\Core\InstanceConfigTrait|null

user()source public

user( string|null $key null )

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

Параметры

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

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

Возвращает

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

Ссылка

https://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( )

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

Возвращает

массив

getController()source public

getController( )

Получить контроллер, к которому привязан этот компонент.

Возвращает

Cake\Controller\Controller
Привязанный контроллер.

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 для этого объекта.

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

Устаревшее

3.5.0 Используйте getEventManager()/setEventManager() вместо этого.

Параметры

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

устанавливаемый eventManager

Возвращает

Cake\Event\EventManager

getEventManager()source public

getEventManager( )

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

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

Возвращает

Cake\Event\EventManager

setEventManager()source public

setEventManager( Cake\Event\EventManager $eventManager )

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

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

Параметры

Cake\Event\EventManager $eventManager

устанавливаемый eventManager

Возвращает

$this

_configDelete()source protected

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

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

_configRead()source protected

_configRead( string|null $key )

Считывает ключ конфигурации.

Параметры

строка|null $key

Ключ для считывания.

Возвращает

смешанный тип

_configWrite()source protected

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

Записывает ключ конфигурации.

Параметры

строка|массив $key

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

смешанный тип $value

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

логическое значение|строка $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']);

Устарело

3.4.0 использовать setConfig()/getConfig() вместо этого.

Параметры

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

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

смешанный тип|null $value необязательно null

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

логическое значение $merge необязательно true

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

Возвращает

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

Исключения

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

configShallow()source public

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

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

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

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

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

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

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

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

Параметры

строка|массив $key

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

смешанный тип|null $value необязательно null

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

Возвращает

$this

getConfig()source public

getConfig( string|null $key null , mixed $default null )

Возвращает конфигурацию.

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

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

$this->getConfig();

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

$this->getConfig('key');

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

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

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

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

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

смешанный тип $default необязательно null

Возвращаемое значение, если ключ не существует.

Возвращает

смешанный тип
Значение конфигурации для чтения.

setConfig()source public

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

Устанавливает конфигурацию.

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

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

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

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

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

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

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

Параметры

строка|массив $key

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

смешанный тип|null $value необязательно null

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

логическое значение $merge необязательно true

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

Возвращает

$this

Исключения

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

log()source public

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

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

Параметры

смешанный тип $msg

Сообщение для записи в журнал.

целое число|строка $level необязательно LogLevel::ERROR

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

строка|массив $context необязательно []

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

Возвращает

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

[]

[]

[
    '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']