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

Параметры

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

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

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

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

булево $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']);

Параметры

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

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

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

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

Возвращает

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