Класс 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. (http://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 auth.

Параметры

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–2016 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.
http://api.cakephp.org/2.8/class-FormAuthenticate.html