Класс 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

%%%CODE_BLOCK_4%%?

Конструктор

Параметры

array<string, mixed> $config optional: Массив конфигурации.

_configDelete() protected

%%%CODE_BLOCK_6%%?

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

Параметры

string $key: Ключ для удаления.

Возвращает

%%%CODE_BLOCK_8%%?

Исключения

%%%CODE_BLOCK_9%%?

if attempting to clobber existing config

_configRead() protected

%%%CODE_BLOCK_10%%?

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

Параметры

string|null $key: Ключ для чтения.

Возвращает

%%%CODE_BLOCK_12%%?

_configWrite() protected

%%%CODE_BLOCK_13%%?

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

Параметры

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

Возвращает

%%%CODE_BLOCK_17%%?

Исключения

%%%CODE_BLOCK_18%%?

if attempting to clobber existing config

check() public

%%%CODE_BLOCK_19%%?

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

Параметры

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

Возвращает

%%%CODE_BLOCK_22%%?

configShallow() public

%%%CODE_BLOCK_23%%?

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

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

%%%CODE_BLOCK_25%%?

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

%%%CODE_BLOCK_26%%?

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

%%%CODE_BLOCK_27%%?

Параметры

array<string, mixed>|string $key: Ключ для установки или весь массив конфигураций.
mixed|null $value optional: Значение для установки.

Возвращает

%%%CODE_BLOCK_30%%?

getConfig() public

%%%CODE_BLOCK_31%%?

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

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

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

%%%CODE_BLOCK_32%%?

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

%%%CODE_BLOCK_33%%?

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

%%%CODE_BLOCK_34%%?

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

%%%CODE_BLOCK_35%%?

Параметры

string|null $key optional: Ключ для получения или null для всей конфигурации.
mixed $default optional: Возвращаемое значение, когда ключ не существует.

Возвращает

%%%CODE_BLOCK_38%%?

getConfigOrFail() public

%%%CODE_BLOCK_39%%?

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

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

Параметры

string $key: Ключ для получения.

Возвращает

%%%CODE_BLOCK_41%%?

Исключения

%%%CODE_BLOCK_42%%?

hash() public

%%%CODE_BLOCK_43%%?

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

Параметры

string $password: Пароль в обычном виде для хеширования.

Возвращает

%%%CODE_BLOCK_45%%?

Ссылки

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

needsRehash() public

%%%CODE_BLOCK_46%%?

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

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

Параметры

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

Возвращает

%%%CODE_BLOCK_48%%?

setConfig() public

%%%CODE_BLOCK_49%%?

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

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

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

%%%CODE_BLOCK_50%%?

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

%%%CODE_BLOCK_51%%?

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

%%%CODE_BLOCK_52%%?

Параметры

array<string, mixed>|string $key: Ключ для установки или весь массив конфигураций.
mixed|null $value optional: Значение для установки.
bool $merge optional: Выполнять рекурсивное объединение или перезапись существующей конфигурации, по умолчанию true.

Возвращает

%%%CODE_BLOCK_56%%?

Исключения

%%%CODE_BLOCK_57%%?

When trying to set a key that is invalid.

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

`$_config` protected

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

Тип

%%%CODE_BLOCK_58%%?

`$_configInitialized` protected

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

Тип

%%%CODE_BLOCK_59%%?

`$_defaultConfig` protected

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

Параметры

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

Тип

%%%CODE_BLOCK_65%%?

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

Класс DefaultPasswordHasher

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

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

__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

Параметры

Тип

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected