Класс FormAuthenticate

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

_checkFields()исходный код защищённый

_checkFields( Cake\Http\ServerRequest $request , array $fields )

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

Параметры

Cake\Http\ServerRequest $request

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

массив $fields

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

Возвращает

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

authenticate()исходный код общедоступный

authenticate( Cake\Http\ServerRequest $request , Cake\Http\Response $response )

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

Параметры

Cake\Http\ServerRequest $request

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

Cake\Http\Response $response

Объект ответа (не используется).

Возвращает

смешанное
False при ошибке входа. Массив данных пользователя при успехе.

__construct()исходный код общедоступный

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

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry

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

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

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

_findUser()исходный код защищённый

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

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

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

Параметры

строка $username

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

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

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

Возвращает

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

_query()исходный код защищённый

_query( string $username )

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

Параметры

строка $username

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

Возвращает

Cake\ORM\Query

getUser()исходный код общедоступный

getUser( Cake\Http\ServerRequest $request )

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

Параметры

Cake\Http\ServerRequest $request

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

Возвращает

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

implementedEvents()исходный код общедоступный

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()исходный код общедоступный

needsPasswordRehash( )

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

Возвращает

boolean

passwordHasher()исходный код общедоступный

passwordHasher( )

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

Возвращает

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

Исключения

RuntimeException

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

unauthenticated()исходный код общедоступный

unauthenticated( Cake\Http\ServerRequest $request , Cake\Http\Response $response )

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

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

Параметры

Cake\Http\ServerRequest $request

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

Cake\Http\Response $response

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

_configDelete()исходный код защищённый

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

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

_configRead()исходный код защищённый

_configRead( string|null $key )

Читает ключ конфигурации.

Параметры

строка|null $key

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

Возвращает

смешанное

_configWrite()исходный код защищённый

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

Устарело

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

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->configShallow('key', $value);

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

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

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

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

Параметры

string|array $key

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

mixed|null $value необязательно null

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

Возвращает

$this

getConfig()source public

getConfig( string|null $key null , mixed $default null )

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определённого значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key необязательно null

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

mixed $default необязательно null

Возвращаемое значение, если ключ не существует.

Возвращает

mixed
Значение считанной конфигурации.

setConfig()source public

setConfig( string|array $key , mixed|null $value null , boolean $merge true )

Устанавливает конфигурацию.

Использование

Установка определённого значения:

$this->setConfig('key', $value);

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

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

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

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

Параметры

string|array $key

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

mixed|null $value необязательно null

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

boolean $merge необязательно true

Рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

$this

Исключения

Cake\Core\Exception\Exception
При попытке установить некорректный ключ.