Spec-Zone.ru › CakePHP 2.7

Класс BaseAuthenticate

Базовый класс аутентификации с общими методами и свойствами.

BaseAuthenticate реализует CakeEventListener

Непосредственные известные подклассы

BasicAuthenticate, FormAuthenticate

Косвенные известные подклассы

BlowfishAuthenticate, DigestAuthenticate
Абстрактный
Пакет: Cake\Controller\Component\Auth
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположен по адресу Cake/Controller/Component/Auth/BaseAuthenticate.php

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

__constructисходный код public

__construct( ComponentCollection $collection , array $settings )

Конструктор

Параметры

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

_findUserисходный код protected

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

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

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

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

Параметры

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

Возвращает

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

_passwordисходный код protected

_password( string $password )

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

Устарело

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

Параметры

строка $password
Простой текст пароля.

Возвращает

string
Хэшированная форма пароля.

authenticateисходный код абстрактный public

authenticate( CakeRequest $request , CakeResponse $response )

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

Параметры

CakeRequest $request
Запрос для получения информации об аутентификации.
CakeResponse $response
Объект ответа, которому можно добавить заголовки.

Возвращает

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

getUserисходный код public

getUser( CakeRequest $request )

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

Параметры

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

Возвращает

mixed
В случае неудачи — ложь, иначе — массив информации о пользователе

implementedEventsисходный код public

implementedEvents( )

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

Возвращает

array
список событий => коллбеков.

Реализация

CakeEventListener::implementedEvents()

logoutисходный код public

logout( array $user )

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

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

Параметры

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

passwordHasherисходный код public

passwordHasher( )

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

Возвращает

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

Выбрасывает

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

unauthenticatedисходный код public

unauthenticated( CakeRequest $request , CakeResponse $response )

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

Параметры

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

Возвращает

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

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

$_Collectionисходный код

protected ComponentCollection

Коллекция компонентов, используемая для получения других компонентов.

$_passwordHasherисходный код

protected AbstractPasswordHasher

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

$settingsисходный код

public массив

Настройки для этого объекта.

  • fields Поля для идентификации пользователя.
  • userModel Имя модели пользователя, по умолчанию User.
  • userFields Массив полей для извлечения из модели User, null — для извлечения всех. По умолчанию null.
  • scope Дополнительные условия для поиска и аутентификации пользователей, например array('User.is_active' => 1).
  • recursive Значение рекурсивного ключа, передаваемого в find(). По умолчанию 0.
  • contain Дополнительные модели для хранения в сессии.
  • passwordHasher Класс хэширования паролей. Может быть строкой, указывающей имя класса, или массивом, содержащим ключ className , а другие ключи будут переданы как настройки классу. По умолчанию 'Simple'.
array(
    'fields' => array(
        'username' => 'username',
        'password' => 'password'
    ),
    'userModel' => 'User',
    'userFields' => null,
    'scope' => array(),
    'recursive' => 0,
    'contain' => null,
    'passwordHasher' => 'Simple'
)

© 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.7/class-BaseAuthenticate.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API