Класс FormAuthenticate

Адаптер аутентификации для компонента AuthComponent. Предоставляет возможность аутентификации с использованием данных POST. Может быть использован, настроив AuthComponent для его использования через настройку AuthComponent::$authenticate.

$this->Auth->authenticate = array(
    'Form' => array(
        'scope' => array('User.active' => 1)
    )
)

При настройке FormAuthenticate вы можете передать настройки, указывающие, какие поля, модель и дополнительные условия используются. Дополнительная информация в FormAuthenticate::$settings.

BaseAuthenticate реализует CakeEventListener

FormAuthenticate

Прямые подклассы

BlowfishAuthenticate

Пакет: Cake\Controller\Component\Auth
С версии: 2.0
См.: AuthComponent::$authenticate
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Controller/Component/Auth/FormAuthenticate.php

Унаследованные свойства

_Collection, _passwordHasher, settings

Краткое описание методов

_checkFields() protected
Проверяет наличие полей.
authenticate() public

Аутентифицирует личность, содержащуюся в запросе. Будет использовать settings.userModel, и settings.fields для поиска данных POST, которые используются для поиска совпадающей записи в settings.userModel. Вернет false, если нет данных POST, отсутствует имя пользователя или пароль, или не выполнены условия области видимости.

Подробное описание методов

_checkFields()source protected

_checkFields( CakeRequest $request , string $model , array $fields )

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

Параметры

CakeRequest $request: Запрос, содержащий информацию для входа.
строка $model: Модель, используемая для проверки входа.
массив $fields: Поля, подлежащие проверке.

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

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

authenticate()source public

authenticate( CakeRequest $request , CakeResponse $response )

Аутентифицирует личность, содержащуюся в запросе. Будет использовать settings.userModel, и settings.fields для поиска данных POST, которые используются для поиска совпадающей записи в settings.userModel. Вернет false, если нет данных POST, отсутствует имя пользователя или пароль, или не выполнены условия области видимости.

Параметры

CakeRequest $request: Запрос, содержащий информацию для входа.
CakeResponse $response: Неиспользуемый объект ответа.

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

mixed
False при неудачной попытке входа. Массив данных пользователя при успехе.

Методы, унаследованные от BaseAuthenticate

__construct()source public

__construct( ComponentCollection $collection , array $settings )

Конструктор

Параметры

ComponentCollection $collection: Коллекция компонентов, используемая в этом запросе.
массив $settings: Массив настроек для использования.

_findUser()source protected

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

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

Параметр $username может быть (строкой) именем пользователя или массивом, содержащим условия для Model::find('first'). Если параметр $password не указан, поле пароля будет присутствовать в возвращаемом массиве.

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

Параметры

строка|массив $username: Имя пользователя/идентификатор или массив условий поиска.
строка $password дополнительно null: Пароль, используемый только если параметр $username является строкой.

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

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

_password()source protected

_password( string $password )

Хеширование простого текста пароля для соответствия хешированному/шифрованному паролю в источнике данных.

Устарело

3.0.0 С версии 2.4. Используйте класс PasswordHasher вместо этого.

Параметры

строка $password: Пароль в простом тексте.

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

строка
Хешированная форма пароля.

getUser()source public

getUser( CakeRequest $request )

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

Параметры

CakeRequest $request: Объект запроса.

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

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

implementedEvents()source public

implementedEvents( )

Реализованные события

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

массив
событий => обратных вызовов.

Реализация

CakeEventListener::implementedEvents()

logout()source public

logout( array $user )

Позволяет подключиться к AuthComponent::logout() и реализовать специализированное поведение при выходе.

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

Параметры

массив $user: Данные пользователя, который собирается выйти.

passwordHasher()source public

passwordHasher( )

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

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

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

Исключения

CakeException

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

unauthenticated()source public

unauthenticated( CakeRequest $request , CakeResponse $response )

Обработка неудачной попытки входа.

Параметры

CakeRequest $request: Объект запроса.
CakeResponse $response: Объект ответа.

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

mixed

True, чтобы указать, что неудачный запрос без аутентификации был обработан, и больше действий со стороны AuthComponent не требуется, или void (по умолчанию).

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-FormAuthenticate.html