Класс
AuthComponent

Компонент класса управления аутентификацией.

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

Пространство имён: Cake\Controller\Component
Устарело: 4.0.0 Используйте плагины cakephp/authentication и cakephp/authorization вместо этого.
См.: https://github.com/cakephp/authentication
См.: https://github.com/cakephp/authorization
Ссылка: https://book.cakephp.org/4/ru/controllers/components/authentication.html

Константы

string

ALL
```
'all'
```
Константа для 'все'
string

QUERY_STRING_REDIRECT
```
'redirect'
```
Ключ строки запроса, используемый для запоминания перенаправляемой страницы при перенаправлении на вход.

Краткое описание свойств

$Flash public @property

Cake\Controller\Component\FlashComponent
$RequestHandler public @property

Cake\Controller\Component\RequestHandlerComponent
$_authenticateObjects protected

arrayCake\Auth\BaseAuthenticate>

Объекты, которые будут использоваться для проверки аутентификации.
$_authenticationProvider protected

Cake\Auth\BaseAuthenticate|null

Экземпляр поставщика аутентификации, который использовался для успешного входа текущего пользователя после вызова login() в том же запросе.
$_authorizationProvider protected

Cake\Auth\BaseAuthorize|null

Экземпляр поставщика авторизации, который использовался для предоставления доступа текущему пользователю к запрашиваемому URL.
$_authorizeObjects protected

arrayCake\Auth\BaseAuthorize>

Объекты, которые будут использоваться для проверки авторизации.
$_componentMap protected

array<string, array>

Таблица поиска компонентов, используемая для отложенной загрузки объектов компонентов.
$_config protected

array<string, mixed>

Конфигурация во время выполнения
$_configInitialized protected

bool

Инициализирована ли уже конфигурация с параметрами по умолчанию
$_defaultConfig protected

array<string, mixed>

Конфигурация по умолчанию
$_eventClass protected

string

Имя класса по умолчанию для новых объектов событий.
$_eventManager protected

Cake\Event\EventManagerInterface|null

Экземпляр Cake\Event\EventManager, который использует этот объект для передачи внутренних событий.
$_registry protected

Cake\Controller\ComponentRegistry

Класс реестра компонентов, используемый для отложенной загрузки компонентов.
$_storage protected

Cake\Auth\Storage\StorageInterface|null

Объект хранения.
$allowedActions public

array<string>

Действия контроллера, для которых не требуется проверка пользователя.
$components protected

array

Другие компоненты, используемые AuthComponent

Краткое описание методов

__construct() public

Конструктор
__debugInfo() public

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Получатель для объектов аутентификации. Вернёт конкретный объект аутентификации.
getAuthorize() public

Получатель для объектов авторизации. Вернёт конкретный объект авторизации.
getConfig() public

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

Возвращает конфигурацию для данного ключа.
getController() public

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

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

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

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

Инициализация свойств.
isAuthorized() public

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

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

Выход пользователя.
redirectUrl() public

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

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

Возвращает экземпляр Cake\Event\EventManagerInterface для этого объекта.
setUser() public

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

Обратный вызов для события Controller.startup.
storage() public

Получение/установка объекта хранилища записей пользователей.
user() public

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

Подробное описание методов

__construct() public

__construct(Cake\Controller\ComponentRegistry $registry, array<string, mixed> $config = [])

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry: Регистр компонентов, который этот компонент может использовать для ленивой загрузки своих компонентов.
array<string, mixed> $config optional: Массив настроек конфигурации.

__debugInfo() public

__debugInfo(): array<string, mixed>

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

Возвращает

array<string, mixed>

__get() public

__get(string $name): mixed

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

Параметры

string $name: Имя свойства

Возвращает

mixed

__set() public

__set(string $name, mixed $value): void

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

Параметры

string $name: Имя свойства.
mixed $value: Значение для установки.

Возвращает

void

_configDelete() protected

_configDelete(string $key): void

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

Параметры

string $key: Ключ для удаления.

Возвращает

void

Вызывает исключение

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

_configRead() protected

_configRead(string|null $key): mixed

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

Параметры

string|null $key: Ключ для чтения.

Возвращает

mixed

_configWrite() protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

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

Параметры

array<string, mixed>|string $key: Ключ для записи.
mixed $value: Значение для записи.
string|bool $merge optional: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Вызывает исключение

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

_getUrlToRedirectBackTo() protected

_getUrlToRedirectBackTo(): string

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

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

Возвращает

string

_getUser() protected

_getUser(): bool

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

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

Возвращает

bool

_isAllowed() protected

_isAllowed(Cake\Controller\Controller $controller): bool

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

Параметры

Cake\Controller\Controller $controller: Ссылка на объект контроллера, создающего экземпляр

Возвращает

bool

_isLoginAction() protected

_isLoginAction(Cake\Controller\Controller $controller): bool

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

Параметры

Cake\Controller\Controller $controller: Ссылка на объект контроллера.

Возвращает

bool

_loginActionRedirectUrl() protected

_loginActionRedirectUrl(): array|string

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

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

Возвращает

array|string

_setDefaults() protected

_setDefaults(): void

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

Возвращает

void

_unauthenticated() protected

_unauthenticated(Cake\Controller\Controller $controller): Cake\Http\Response|null

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

Параметры

Cake\Controller\Controller $controller: Ссылка на объект контроллера.

Возвращает

Cake\Http\Response|null

Вызывает исключение

Cake\Core\Exception\CakeException

_unauthorized() protected

_unauthorized(Cake\Controller\Controller $controller): Cake\Http\Response|null

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

Параметры

Cake\Controller\Controller $controller: Ссылка на объект контроллера

Возвращает

Cake\Http\Response|null

Вызывает исключение

Cake\Http\Exception\ForbiddenException

allow() public

allow(array<string>|string|null $actions = null): void

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

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

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

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

$this->Auth->allow();

Параметры

array<string>|string|null $actions optional: Имя действия контроллера или массив действий

Возвращает

void

Ссылки

https://book.cakephp.org/4/en/controllers/components/authentication.html#making-actions-public

authCheck() public

authCheck(Cake\Event\EventInterface $event): Cake\Http\Response|null

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

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

Параметры

Cake\Event\EventInterface $event: Экземпляр события.

Возвращает

Cake\Http\Response|null

Вызывает исключение

ReflectionException

authenticationProvider() public

authenticationProvider(): Cake\Auth\BaseAuthenticate|null

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

Возвращает

Cake\Auth\BaseAuthenticate|null

authorizationProvider() public

authorizationProvider(): Cake\Auth\BaseAuthorize|null

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

Возвращает

Cake\Auth\BaseAuthorize|null

configShallow() public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

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

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

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

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

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

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

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

Параметры

array<string, mixed>|string $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.

Возвращает

$this

constructAuthenticate() public

constructAuthenticate(): array<string, object>|null

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

Возвращает

array<string, object>|null

Выбрасывает

Cake\Core\Exception\CakeException

constructAuthorize() public

constructAuthorize(): array|null

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

Возвращает

array|null

Выбрасывает

Cake\Core\Exception\CakeException

deny() public

deny(array<string>|string|null $actions = null): void

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

Можно использовать deny с массивом или простой строкой.

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

или

$this->Auth->deny();

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

Параметры

array<string>|string|null $actions optional: Имя действия контроллера или массив действий

Возвращает

void

См. также

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

Ссылки

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

dispatchEvent() public

dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventInterface

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

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

Параметры

string $name: Имя события.
array|null $data optional: Любое значение, которое вы хотите передать вместе с этим событием; его могут прочитать слушатели.
object|null $subject optional: Объект, к которому относится это событие ($this по умолчанию).

Возвращает

Cake\Event\EventInterface

flash() public

flash(string|false $message): void

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

Параметры

string|false $message: Сообщение для установки. Ложь для пропуска.

Возвращает

void

getAuthenticate() public

getAuthenticate(string $alias): Cake\Auth\BaseAuthenticate|null

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

Параметры

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

Возвращает

Cake\Auth\BaseAuthenticate|null

getAuthorize() public

getAuthorize(string $alias): Cake\Auth\BaseAuthorize|null

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

Параметры

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

Возвращает

Cake\Auth\BaseAuthorize|null

getConfig() public

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

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

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

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

$this->getConfig();

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

$this->getConfig('key');

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

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

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

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

Параметры

string|null $key optional: Ключ для получения или null для всей конфигурации.
mixed $default optional: Возвращаемое значение, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

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

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Выбрасывает

InvalidArgumentException

getController() public

getController(): Cake\Controller\Controller

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

Возвращает

Cake\Controller\Controller

getEventManager() public

getEventManager(): Cake\Event\EventManagerInterface

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

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

Возвращает

Cake\Event\EventManagerInterface

identify() public

identify(): array|false

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

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

Возвращает

array|false

implementedEvents() public

implementedEvents(): array<string, mixed>

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

Использует соглашения для сопоставления событий контроллера со стандартными именами методов обратного вызова компонента. Определяя один из методов обратного вызова, предполагается, что компонент заинтересован в соответствующем событии.

Переопределите этот метод, если вам нужно добавить слушателей событий, не следующих соглашениям. Или если вы хотите, чтобы компоненты реагировали на нестандартные события.

Возвращает

array<string, mixed>

initialize() public

initialize(array<string, mixed> $config): void

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

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

Параметры

array<string, mixed> $config: Данные конфигурации.

Возвращает

void

isAuthorized() public

isAuthorized(ArrayAccess|array|null $user = null, Cake\Http\ServerRequest|null $request = null): bool

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

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

Параметры

ArrayAccess|array|null $user optional: Пользователь, авторизация которого должна быть проверена. Если пусто, будет использован пользователь, извлеченный из хранилища.
Cake\Http\ServerRequest|null $request optional: Запрос, для которого необходимо выполнить аутентификацию. Если пусто, будет использован текущий запрос.

Возвращает

bool

log() public

log(string $message, string|int $level = LogLevel::ERROR, array|string $context = []): bool

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

Параметры

string $message: Сообщение журнала.
string|int $level optional: Уровень ошибки.
array|string $context optional: Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

bool

logout() public

logout(): string

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

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

Возвращает

string

Ссылки

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

redirectUrl() public

redirectUrl(array|string|null $url = null): string

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

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

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

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

Параметры

array|string|null $url необязательно: Необязательный URL для записи в качестве URL перенаправления при входе.

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

string

setConfig() public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

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

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

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

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

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

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

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

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

Параметры

array<string, mixed>|string $key: Ключ для установки или полный массив конфигураций.
mixed|null $value необязательно: Значение для установки.
bool $merge необязательно: Включает ли рекурсивное объединение или перезапись существующей конфигурации; по умолчанию true.

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

$this

Исключения

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

setEventManager() public

setEventManager(Cake\Event\EventManagerInterface $eventManager): $this

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

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

Параметры

Cake\Event\EventManagerInterface $eventManager: устанавливаемый eventManager

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

$this

setUser() public

setUser(ArrayAccess|array $user): void

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

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

Параметры

ArrayAccess|array $user: Данные пользователя.

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

void

Ссылки

https://book.cakephp.org/4/en/controllers/components/authentication.html#identifying-users-and-logging-them-in

startup() public

startup(Cake\Event\EventInterface $event): Cake\Http\Response|null

Обратный вызов для события Controller.startup.

Параметры

Cake\Event\EventInterface $event: Экземпляр события.

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

Cake\Http\Response|null

storage() public

storage(Cake\Auth\Storage\StorageInterface|null $storage = null): Cake\Auth\Storage\StorageInterface|null

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

Параметры

Cake\Auth\Storage\StorageInterface|null $storage необязательно: Устанавливает предоставленный объект в качестве хранилища или, если null, возвращает настроенный объект хранилища.

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

Cake\Auth\Storage\StorageInterface|null

user() public

user(string|null $key = null): mixed|null

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

Параметры

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

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

mixed|null

Ссылки

https://book.cakephp.org/4/en/controllers/components/authentication.html#accessing-the-logged-in-user

Подробное описание свойств

`$Flash` public @property

Тип

Cake\Controller\Component\FlashComponent

`$RequestHandler` public @property

Тип

Cake\Controller\Component\RequestHandlerComponent

`$_authenticateObjects` protected

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

Тип

arrayCake\Auth\BaseAuthenticate>

`$_authenticationProvider` protected

Экземпляр поставщика аутентификации, который был использован для успешного входа текущего пользователя после вызова login() в том же запросе.

Тип

Cake\Auth\BaseAuthenticate|null

`$_authorizationProvider` protected

Экземпляр поставщика авторизации, который был использован для предоставления доступа текущему пользователю к запрашиваемому URL.

Тип

Cake\Auth\BaseAuthorize|null

`$_authorizeObjects` protected

Объекты, которые будут использоваться для проверок авторизации.

Тип

arrayCake\Auth\BaseAuthorize>

`$_componentMap` protected

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

Тип

array<string, array>

`$_config` protected

Конфигурация выполнения

Тип

array<string, mixed>

`$_configInitialized` protected

Указание того, была ли конфигурация уже настроена по умолчанию

Тип

bool

`$_defaultConfig` protected

Конфигурация по умолчанию

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

$this->Auth->setConfig('authenticate', [
     'Form' => [
        'userModel' => 'Users.Users'
     ]
  ]);

Используя имя класса без «Authenticate» в качестве ключа, вы можете передать массив конфигураций для каждого объекта аутентификации. Кроме того, вы можете определить конфигурацию, которая должна быть установлена для всех объектов аутентификации, используя ключ «all»:

$this->Auth->setConfig('authenticate', [
      AuthComponent::ALL => [
         'userModel' => 'Users.Users',
         'scope' => ['Users.active' => 1]
     ],
    'Form',
    'Basic'
  ]);

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

$this->Auth->setConfig('authorize', [
     'Crud' => [
         'actionPath' => 'controllers/'
     ]
  ]);

Используя имя класса без «Authorize» в качестве ключа, вы можете передать массив конфигураций для каждого объекта авторизации. Кроме того, вы можете определить конфигурацию, которая должна быть установлена для всех объектов авторизации, используя ключ AuthComponent::ALL:

$this->Auth->setConfig('authorize', [
     AuthComponent::ALL => [
         'actionPath' => 'controllers/'
     ],
     'Crud',
     'CustomAuth'
  ]);

flash — Настройки, используемые, когда Auth нужно выполнить сообщение всплывающей подсказки с помощью FlashComponent::set(). Доступны следующие ключи:
key — Домен сообщений, используемый для всплывающих подсказок, создаваемых этим компонентом, по умолчанию «auth».
- element — Элемент всплывающей подсказки, по умолчанию «default».
- params — Массив дополнительных параметров, по умолчанию ['class' => 'error']
loginAction — URL (определён как строка или массив) до действия контроллера, обрабатывающего вход в систему. По умолчанию /users/login.
loginRedirect — Обычно, если пользователь перенаправляется на страницу loginAction, местоположение, с которого он был перенаправлен, сохраняется в сессии, чтобы он мог быть перенаправлен обратно после успешного входа в систему. Если это значение сессии не установлено, метод redirectUrl() вернёт URL, указанный в loginRedirect.
logoutRedirect — Действие по умолчанию для перенаправления после выхода пользователя из системы. Хотя AuthComponent не обрабатывает перенаправление после выхода, URL перенаправления будет возвращён из AuthComponent::logout(). По умолчанию loginAction.
authError — Ошибка, отображаемая, когда пользователь пытается получить доступ к объекту или действию, к которому у него нет доступа.
unauthorizedRedirect — Управляет обработкой несанкционированного доступа.
Для значения по умолчанию true неавторизованный пользователь перенаправляется на URL-адрес ссылки или $loginRedirect или '/'.
- Если задано строкой или массивом, это значение используется в качестве URL для перенаправления.
- Если задано false, выбрасывается исключение ForbiddenException вместо перенаправления.
storage — Класс хранения, используемый для сохранения записи пользователя. При использовании бессостоятельного аутентификатора вы должны установить это на «Memory». По умолчанию «Session».
checkAuthIn — Имя события, для которого должны выполняться начальные проверки аутентификации. По умолчанию «Controller.startup». Вы можете установить его на «Controller.initialize», если хотите выполнить проверку до выполнения метода beforeFilter() контроллера.

Тип

array<string, mixed>

`$_eventClass` protected

Имя класса по умолчанию для новых объектов событий.

Тип

string

`$_eventManager` protected

Экземпляр Cake\Event\EventManager, используемый этим объектом для отправки внутренних событий.

Тип

Cake\Event\EventManagerInterface|null

`$_registry` protected

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

Тип

Cake\Controller\ComponentRegistry

`$_storage` protected

Объект хранилища.

Тип

Cake\Auth\Storage\StorageInterface|null

`$allowedActions` public

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

Тип

array<string>

`$components` protected

Другие компоненты, используемые AuthComponent

Тип

array

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.3/class-Cake.Controller.Component.AuthComponent.html

Класс AuthComponent

Константы

Краткое описание свойств

Краткое описание методов

__construct() public

__debugInfo() public

__get() public

__set() public

_configDelete() protected

_configRead() protected

_configWrite() protected

_getUrlToRedirectBackTo() protected

_getUser() protected

_isAllowed() protected

_isLoginAction() protected

_loginActionRedirectUrl() protected

_setDefaults() protected

_unauthenticated() protected

_unauthorized() protected

allow() public

authCheck() public

authenticationProvider() public

authorizationProvider() public

configShallow() public

constructAuthenticate() public

constructAuthorize() public

deny() public

dispatchEvent() public

flash() public

getAuthenticate() public

getAuthorize() public

getConfig() public

getConfigOrFail() public

getController() public

getEventManager() public

identify() public

implementedEvents() public

initialize() public

isAuthorized() public

log() public

logout() public

redirectUrl() public

setConfig() public

setEventManager() public

setUser() public

startup() public

storage() public

user() public

Подробное описание методов

__construct() public

Параметры

__debugInfo() public

Возвращает

__get() public

Параметры

Возвращает

__set() public

Параметры

Возвращает

_configDelete() protected

Параметры

Возвращает

Вызывает исключение

_configRead() protected

Параметры

Возвращает

_configWrite() protected

Параметры

Возвращает

Вызывает исключение

_getUrlToRedirectBackTo() protected

Возвращает

_getUser() protected

Возвращает

_isAllowed() protected

Параметры

Возвращает

_isLoginAction() protected

Параметры

Возвращает

Класс
AuthComponent