Spec-Zone.ru › CakePHP 4.2

Класс BaseAuthenticate

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

Абстрактный
Пространство имен: Cake\Auth

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

  • $_config protected
    array

    Конфигурация во время выполнения

  • $_configInitialized protected
    bool

    Указатель, что свойство config уже настроено по умолчанию

  • $_defaultConfig protected
    array

    Конфигурация по умолчанию для этого объекта.

  • $_needsPasswordRehash protected
    bool

    Требуется ли перехеширование пароля пользователя, аутентифицированного этим классом, с использованием другого алгоритма.

  • $_passwordHasher protected
    Cake\Auth\AbstractPasswordHasher|null

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

  • $_registry protected
    Cake\Controller\ComponentRegistry

    Регистр компонентов, используемый для получения дополнительных компонентов.

  • $_tableLocator protected
    Cake\ORM\Locator\LocatorInterface|null

    Экземпляр локатора таблиц

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

  • __construct() public

    Конструктор

  • _configDelete() protected

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

  • _configRead() protected

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

  • _configWrite() protected

    Записывает ключ конфигурации.

  • _findUser() protected

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

  • _query() protected

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

  • authenticate() abstract public

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

  • configShallow() public

    Объединить предоставленную конфигурацию с существующей. В отличие от config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

  • getConfig() public

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

  • getConfigOrFail() public

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

  • getTableLocator() public

    Получить локатор таблиц.

  • getUser() public

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

  • implementedEvents() public

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

  • needsPasswordRehash() public

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

  • passwordHasher() public

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

  • setConfig() public

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

  • setTableLocator() public

    Устанавливает локатор таблиц.

  • unauthenticated() public

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

END_OF_DOCUMENT_MARKER

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

__construct() public 

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

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry

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

array $config optional

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

_configDelete() protected 

_configDelete(string $key): void

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

Параметры

string $key

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

Возвращает

void

Исключения

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

_configRead() protected 

_configRead(string|null $key): mixed

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

Параметры

string|null $key

Ключ для считывания.

Возвращает

mixed

_configWrite() protected 

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Записывает ключ конфигурации.

Параметры

string|array $key

Ключ для записи.

mixed $value

Значение для записи.

bool|string $merge optional

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Исключения

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

_findUser() protected 

_findUser(string $username, string|null $password = null): array|false

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

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

Параметры

string $username

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

string|null $password optional

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

Возвращает

array|false

_query() protected 

_query(string $username): Cake\ORM\Query

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

Параметры

string $username

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

Возвращает

Cake\ORM\Query

authenticate() abstract public 

authenticate(Cake\Http\ServerRequest $request, Cake\Http\Response $response): array|false

Проверить подлинность пользователя на основе информации запроса.

Параметры

Cake\Http\ServerRequest $request

Запрос для получения информации об аутентификации.

Cake\Http\Response $response

Объект ответа, которому можно добавить заголовки.

Возвращает

array|false

configShallow() public 

configShallow(string|array $key, mixed|null $value = null): $this

Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), который выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

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

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

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

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

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

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

Параметры

string|array $key

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

mixed|null $value optional

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

Возвращает

$this

getConfig() public 

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

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

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

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

$this->getConfig();

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

$this->getConfig('key');

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

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

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

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

Параметры

string|null $key optional

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

mixed $default optional

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

Возвращает

mixed

getConfigOrFail() public 

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для этого ключа.

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key

Ключ для получения.

Возвращает

mixed

Исключения

InvalidArgumentException

getTableLocator() public 

getTableLocator(): Cake\ORM\Locator\LocatorInterface

Получает локатор таблицы.

Возвращает

Cake\ORM\Locator\LocatorInterface

getUser() public 

getUser(Cake\Http\ServerRequest $request): array|false

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

Параметры

Cake\Http\ServerRequest $request

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

Возвращает

array|false

implementedEvents() public 

implementedEvents(): array

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

Класс аутентификации может подписываться на следующие события, генерируемые AuthComponent:

  • Auth.afterIdentify - Вызывается после того, как пользователь был идентифицирован с помощью одного из настроенных классов аутентификации. Функция обратного вызова должна иметь сигнатуру, подобную afterIdentify(EventInterface $event, array $user), когда $user является идентифицированной записью пользователя.

  • Auth.logout - Вызывается при вызове AuthComponent::logout(). Функция обратного вызова должна иметь сигнатуру, подобную logout(EventInterface $event, array $user), где $user - пользователь, который собирается выйти из системы.

Возвращает

array

needsPasswordRehash() public 

needsPasswordRehash(): bool

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

Возвращает

bool

passwordHasher() public 

passwordHasher(): Cake\Auth\AbstractPasswordHasher

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

Возвращает

Cake\Auth\AbstractPasswordHasher

Исключения

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

setConfig() public 

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

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

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

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

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

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

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

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

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

Параметры

string|array $key

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

mixed|null $value optional

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

bool $merge optional

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

Возвращает

$this

Исключения

Cake\Core\Exception\CakeException
При попытке установки недопустимого ключа.

setTableLocator() public 

setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this

Устанавливает локатор таблицы.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator

Экземпляр LocatorInterface.

Возвращает

$this

unauthenticated() public 

unauthenticated(Cake\Http\ServerRequest $request, Cake\Http\Response $response): Cake\Http\Response|null|void

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

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

Параметры

Cake\Http\ServerRequest $request

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

Cake\Http\Response $response

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

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

Cake\Http\Response|null|void

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

$_config protected

Конфигурация во время выполнения

Тип

array

$_configInitialized protected

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

Тип

bool

$_defaultConfig protected

Конфигурация по умолчанию для данного объекта.

  • fields Поля, используемые для идентификации пользователя.
  • userModel Псевдоним таблицы пользователей, по умолчанию Users.
  • finder Метод поиска для извлечения записи пользователя. По умолчанию 'all'. Можно задать имя метода поиска как строку или массив, где ключ — имя метода поиска, а значение — массив, передаваемый в Table::find() опции. Пример: ['finderName' => ['some_finder_option' => 'some_value']]
  • passwordHasher Класс хеширования паролей. Может быть строкой, определяющей имя класса, или массивом, содержащим className ключ, а любые другие ключи будут переданы в качестве конфигурации классу. По умолчанию 'Default'.

Тип

array

$_needsPasswordRehash protected

Требуется ли повторное хеширование пароля пользователя, авторизованного этим классом, с использованием другого алгоритма.

Тип

bool

$_passwordHasher protected

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

Тип

Cake\Auth\AbstractPasswordHasher|null

$_registry protected

Регистр компонентов, используемый для получения других компонентов.

Тип

Cake\Controller\ComponentRegistry

$_tableLocator protected

Экземпляр локатора таблиц

Тип

Cake\ORM\Locator\LocatorInterface|null

© 2005–present 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/4.2/class-Cake.Auth.BaseAuthenticate.html

Spec-Zone.ru

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