Класс BaseAuthenticate

__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

authenticatesource абстрактный public

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

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

Параметры

Cake\Network\Request $request

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

Cake\Network\Response $response

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

Возвращает

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

getUsersource public

getUser( Cake\Network\Request $request )

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

Параметры

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

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

булево|строка $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']);

Параметры

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

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

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

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

булево $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