Класс BaseAuthenticate

__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

authenticate()source abstract public

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

Проверить подлинность пользователя на основе информации запроса.

Параметры

Cake\Network\Request $request

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

Cake\Network\Response $response

Объект ответа, которому можно добавить заголовки.

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

смешанное
В случае ошибки возвращается false, в случае успеха — массив данных пользователя.

getUser()source public

getUser( Cake\Network\Request $request )

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

Параметры

Cake\Network\Request $request

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

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

смешанное
В случае ошибки возвращается 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

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

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

смешанное

_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']);

Параметры

строка|массив|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->config('key', $value);

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

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

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

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

Параметры

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

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

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

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

Возвращает

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

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

false