Класс FallbackPasswordHasher

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

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

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

$_config protected

array

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

bool

Указывает, была ли свойство config уже настроена с параметрами по умолчанию
$_defaultConfig protected

array

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

Cake\Auth\AbstractPasswordHasher[]

Содержит список объектов хэширования паролей, которые будут использоваться

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

__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 $config = [])

Конструктор

Параметры

array $config optional: Параметры конфигурации для этого объекта. Требуется, чтобы ключ hashers был присутствующим в массиве со списком других хэшераторов, которые нужно использовать.

_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
при попытке перезаписи существующей конфигурации

check() public

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

Проверяет, соответствует ли предоставленный пароль его хэшированной версии

Этот метод будет перебирать все настроенные хэшераторы, пока один из них не вернет true.

Параметры

string $password: Простой текст пароля для хэширования.
string $hashedPassword: Существующий хэшированный пароль.

Возвращает

bool

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

hash() public

hash(string $password): string|false

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

Использует первый хэшератор в списке для генерации хэша.

Параметры

string $password: Простой текст пароля для хэширования.

Возвращает

string|false

needsRehash() public

needsRehash(string $password): bool

Возвращает true, если пароль нужно перехэшировать, используя первый хэшератор в списке хэшераторов.

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

Параметры

string $password: Пароль для проверки.

Возвращает

bool

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
При попытке установить недопустимый ключ.

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

`$_config` protected

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

Тип

array

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

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

Эти значения объединяются с предоставленной пользователем конфигурацией при использовании объекта.

Тип

array

`$_hashers` protected

Хранит список объектов хэширования паролей, которые будут использоваться

Тип

Cake\Auth\AbstractPasswordHasher[]

© 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.FallbackPasswordHasher.html

Класс FallbackPasswordHasher

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

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

__construct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

check() public

configShallow() public

getConfig() public

getConfigOrFail() public

hash() public

needsRehash() public

setConfig() public

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

__construct() public

Параметры

_configDelete() protected

Параметры

Возвращает

Исключения

_configRead() protected

Параметры

Возвращает

_configWrite() protected

Параметры

Возвращает

Исключения

check() public

Параметры

Возвращает

configShallow() public

Параметры

Возвращает

getConfig() public

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

Параметры

Возвращает

getConfigOrFail() public

Параметры

Возвращает

Исключения

hash() public

Параметры

Возвращает

needsRehash() public

Параметры

Возвращает

setConfig() public

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

Параметры

Возвращает

Исключения

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

$_config protected

Тип

$_configInitialized protected

Тип

$_defaultConfig protected

Тип

$_hashers protected

Тип

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected

`$_hashers` protected