Класс AbstractPasswordHasher

Абстрактный класс хеширования паролей

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

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

$_config protected

array<string, mixed>

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

bool

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

array<string, mixed>

Конфигурация по умолчанию

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

__construct() public

Конструктор
_configDelete() protected

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

Читает ключ конфигурации.
_configWrite() protected

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

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

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

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

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

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

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

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

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

__construct() public

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

Конструктор

Параметры

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

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

Параметры

array<string, mixed>|string $key: Ключ для записи.
mixed $value: Значение для записи.
string|bool $merge optional: True для рекурсивного объединения, 'shallow' для простого объединения, false для перезаписи, по умолчанию false.

Возвращает

void

Исключения

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

check() abstract 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 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() abstract 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(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 optional: Значение для установки.
bool $merge optional: Признак рекурсивного объединения или перезаписи существующей конфигурации, по умолчанию true.

Возвращает

$this

Исключения

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

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

`$_config` protected

Текущая конфигурация

Тип

array<string, mixed>

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

Конфигурация по умолчанию

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

Тип

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.AbstractPasswordHasher.html

Класс AbstractPasswordHasher

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

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

__construct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

check() abstract public

configShallow() public

getConfig() public

getConfigOrFail() public

hash() abstract public

needsRehash() public

setConfig() public

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

__construct() public

Параметры

_configDelete() protected

Параметры

Возвращает

Исключения

_configRead() protected

Параметры

Возвращает

_configWrite() protected

Параметры

Возвращает

Исключения

check() abstract public

Параметры

Возвращает

configShallow() public

Параметры

Возвращает

getConfig() public

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

Параметры

Возвращает

getConfigOrFail() public

Параметры

Возвращает

Исключения

hash() abstract public

Параметры

Возвращает

needsRehash() public

Параметры

Возвращает

setConfig() public

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

Параметры

Возвращает

Исключения

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

$_config protected

Тип

$_configInitialized protected

Тип

$_defaultConfig protected

Тип

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected