Spec-Zone.ru › CakePHP 2.9

Класс BaseAuthenticate

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

BaseAuthenticate реализует CakeEventListener

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

  • BasicAuthenticate
  • FormAuthenticate

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

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

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

  • $_Collection protected
    ComponentCollection
    Коллекция компонентов, используемая для получения дополнительных компонентов.
  • $_passwordHasher protected
    AbstractPasswordHasher
    Экземпляр хэшера паролей.
  • $settings public
    array
    Настройки для этого объекта.

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

  • __construct() public
    Конструктор
  • _findUser() protected
    Поиск записи пользователя с использованием стандартных опций.
  • _password() protected

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

  • authenticate() abstract public
    Аутентификация пользователя на основе информации из запроса.
  • getUser() public

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

  • implementedEvents() public
    Реализованные события
  • logout() public

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

  • passwordHasher() public
    Возвращает объект хэшера паролей
  • unauthenticated() public
    Обработка попытки доступа без аутентификации.

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

__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 не указан, поле password будет присутствовать в возвращаемом массиве.

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

Параметры

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

Возвращает

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

_password()source protected

_password( string $password )

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

Устарело

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

Параметры

строка $password
Пароль в обычном виде.

Возвращает

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

authenticate()source abstract public

authenticate( CakeRequest $request , CakeResponse $response )

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

Параметры

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

Возвращает

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

getUser()source public

getUser( CakeRequest $request )

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

Параметры

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

Возвращает

смешанный тип
В случае неудачи - 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
Объект ответа.

Возвращает

смешанный тип

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


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

$_Collectionsource

protected ComponentCollection

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

$_passwordHashersource

protected AbstractPasswordHasher

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

$settingssource

public array

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

  • 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.
https://api.cakephp.org/2.9/class-BaseAuthenticate.html

Spec-Zone.ru

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