Класс FormAuthenticate

$this->Auth->authenticate = [
    'Form' => [
        'scope' => ['Users.active' => 1]
    ]
]

_checkFieldssource protected

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

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

Параметры

Cake\Network\Request $request

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

массив $fields

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

Возвращает

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

authenticatesource 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 при ошибке входа. Массив данных пользователя при успехе.

__constructsource public

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

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry

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

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

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

_findUsersource protected

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

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

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

Параметры

строка $username

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

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

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

Возвращает

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

_querysource protected

_query( string $username )

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

Параметры

строка $username

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

Возвращает

Cake\ORM\Query
\Cake\ORM\Query

getUsersource public

getUser( Cake\Network\Request $request )

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

Параметры

Cake\Network\Request $request

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

Возвращает

mixed
False или массив информации о пользователе

implementedEventssource public

implementedEvents( )

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

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

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

Возвращает

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

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

needsPasswordRehashsource public

needsPasswordRehash( )

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

Возвращает

boolean
bool

passwordHashersource public

passwordHasher( )

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

Возвращает

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

Выбрасывает

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

unauthenticatedsource public

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

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

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

Параметры

Cake\Network\Request $request

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

Cake\Network\Response $response

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

_configDeletesource protected

_configDelete( string $key )

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

Параметры

строка $key

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

Выбрасывает

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

_configReadsource protected

_configRead( string|null $key )

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

Параметры

строка|null $key

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

Возвращает

mixed
смешанное

_configWritesource protected

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

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

Параметры

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

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

смешанное $value

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

boolean|строка $merge необязательно false

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

Выбрасывает

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

configsource 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
При попытке установить некорректный ключ.

configShallowsource 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

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

Возвращает

mixed
$this Сам объект.

[
    'fields' => [
        'username' => 'username',
        'password' => 'password'
    ],
    'userModel' => 'Users',
    'scope' => [],
    'finder' => 'all',
    'contain' => null,
    'passwordHasher' => 'Default'
]

false

[]

false