Класс FormAuthenticate

$this->Auth->authenticate = [
     'Form' => [
         'finder' => ['auth' => ['some_finder_option' => 'some_value']]
     ]
 ]

_checkFields()source protected

_checkFields( Cake\Network\Request $request , array $fields )

Проверяет поля на наличие.

Параметры

Cake\Network\Request $request

Запрос, содержащий информацию для входа.

массив $fields

Поля, которые необходимо проверить.

Возвращает

boolean
False, если поля не заданы. True, если они существуют.

authenticate()source public

authenticate( Cake\Network\Request $request , Cake\Network\Response $response )

Проверяет подлинность пользователя, содержащегося в запросе. Использует config.userModel, и config.fields для поиска данных POST, которые используются для поиска совпадающей записи в config.userModel. Возвращает false, если нет данных POST, отсутствует имя пользователя или пароль, или не выполнены условия области.

Параметры

Cake\Network\Request $request

Запрос, содержащий информацию для входа.

Cake\Network\Response $response

Неиспользуемый объект ответа.

Возвращает

mixed
False при неудачной авторизации. Массив данных пользователя при успешной авторизации.

__construct()source public

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

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry

Регистр компонента, используемый в этом запросе.

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

Массив конфигурации для использования.

_findUser()source protected

_findUser( string $username , string|null $password null )

Найти запись пользователя по имени пользователя и паролю.

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

Параметры

строка $username

Имя пользователя/идентификатор.

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

Пароль. Если не указан, проверка пароля пропускается, и возвращается результат поиска.

Возвращает

boolean|массив
Либо false при ошибке, либо массив данных пользователя.

_query()source protected

_query( string $username )

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

Параметры

строка $username

Имя пользователя/идентификатор.

Возвращает

Cake\ORM\Query

getUser()source public

getUser( Cake\Network\Request $request )

Получить пользователя на основе информации в запросе. В основном используется бессостоятельными системами аутентификации, такими как basic и digest аутентификация.

Параметры

Cake\Network\Request $request

Объект запроса.

Возвращает

mixed
Либо false, либо массив информации о пользователе

implementedEvents()source public

implementedEvents( )

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

Класс аутентификации может подписываться на следующие события, генерируемые компонентом AuthComponent:

• Auth.afterIdentify - Срабатывает после того, как пользователь был идентифицирован с помощью одного из настроенных классов аутентификации. Функция обратного вызова должна иметь сигнатуру типа afterIdentify(Event $event, array $user) при $user - это идентифицированная запись пользователя.

• Auth.logout - Срабатывает при вызове AuthComponent::logout(). Функция обратного вызова должна иметь сигнатуру типа logout(Event $event, array $user) где $user - это пользователь, который будет разлогинен.

Возвращает

массив
Список событий, на которые подписывается этот класс. По умолчанию [].

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

needsPasswordRehash()source public

needsPasswordRehash( )

Возвращает, требуется ли перехеширование пароля, хранящегося в репозитории для вошедшего пользователя, с помощью другого алгоритма

Возвращает

boolean

passwordHasher()source public

passwordHasher( )

Возвращает объект хеширования паролей

Возвращает

Cake\Auth\AbstractPasswordHasher
Экземпляр хешера паролей

Вызывает

RuntimeException

Если класс хеширования паролей не найден или он не расширяет AbstractPasswordHasher

unauthenticated()source public

unauthenticated( Cake\Network\Request $request , Cake\Network\Response $response )

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

• Null - Никаких действий не производится, AuthComponent должен вернуть соответствующий ответ.
• Cake\Network\Response - Объект ответа, который заставит AuthComponent просто вернуть этот ответ.

Параметры

Cake\Network\Request $request

Объект запроса.

Cake\Network\Response $response

Объект ответа.

_configDelete()source protected

_configDelete( string $key )

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

Параметры

строка $key

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

Вызывает

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

_configRead()source protected

_configRead( string|null $key )

Считать переменную конфигурации

Параметры

строка|null $key

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

Возвращает

mixed

_configWrite()source protected

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

Записать переменную конфигурации

Параметры

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

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

смешанный $value

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

boolean|строка $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 Объект сам по себе.