Spec-Zone.ru › CakePHP 4.4

Класс DefaultPasswordHasher

Класс по умолчанию для хэширования паролей.

Пространство имен: Cake\Auth

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

  • $_config protected
    array<string, mixed>

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

  • $_configInitialized protected
    bool

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

  • $_defaultConfig protected
    array<string, mixed>

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

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

  • __construct() public

    Конструктор

  • _configDelete() protected

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

  • _configRead() protected

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

  • _configWrite() protected

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

  • check() public

    Проверка хэша. Генерирует хэш для предоставленного пользователем пароля и сравнивает его с существующим хэшем.

  • configShallow() public

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

  • getConfig() public

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

  • getConfigOrFail() public

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

  • hash() public

    Генерирует хэш пароля.

  • needsRehash() public

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

  • setConfig() public

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

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

__construct() public 

__construct(array<string, mixed> $config = [])

Конструктор

Параметры

array<string, mixed> $config необязательный

Массив конфигурации.

_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(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

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

Параметры

array<string, mixed>|string $key

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

mixed $value

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

string|bool $merge необязательный

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

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

void

Исключения

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

check() public 

check(string $password, string $hashedPassword): bool

Проверка хэша. Генерирует хэш для предоставленного пользователем пароля и сравнивает его с существующим хэшем.

Параметры

string $password

Пароль в виде обычного текста для хэширования.

string $hashedPassword

Существующий хэшированный пароль.

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

bool

configShallow() public 

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

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

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

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

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

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

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

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

Параметры

array<string, mixed>|string $key

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

mixed|null $value необязательный

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

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

$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 необязательный

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

mixed $default необязательный

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

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

mixed

getConfigOrFail() public 

getConfigOrFail(string $key): mixed

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

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

Параметры

string $key

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

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

mixed

Исключения

InvalidArgumentException

hash() public 

hash(string $password): string|false

Генерирует хэш пароля.

Параметры

string $password

Пароль в виде обычного текста для хэширования.

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

string|false

Ссылки

https://book.cakephp.org/4/en/controllers/components/authentication.html#hashing-passwords

needsRehash() public 

needsRehash(string $password): bool

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

По умолчанию возвращает true, так как единственная реализация, на которой пользователи должны полагаться, — это реализация, поставляемая по умолчанию в php 5.5+ или любой совместимой библиотеке

Параметры

string $password

Пароль для проверки

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

bool

setConfig() public 

setConfig(array<string, mixed>|string $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']);

Параметры

array<string, mixed>|string $key

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

mixed|null $value необязательный

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

bool $merge необязательный

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

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

$this

Исключения

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

Детали свойства

$_config protected

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

Тип

array<string, mixed>

$_configInitialized protected

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

Тип

bool

$_defaultConfig protected

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

Параметры

  • hashType - Алгоритм хэширования, который нужно использовать. Допустимые значения соответствуют тем, которые поддерживает параметр $algo функции password_hash(). По умолчанию PASSWORD_DEFAULT
  • hashOptions - Ассоциативный массив параметров. Обратитесь к руководству PHP для получения информации о поддерживаемых параметрах для каждого типа хэширования. По умолчанию пустой массив.

Тип

array<string, mixed>

© 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.4/class-Cake.Auth.DefaultPasswordHasher.html

Spec-Zone.ru

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