Класс FallbackPasswordHasher
Хэшер паролей, который может использовать несколько разных хэшей, где только один является предпочтительным. Это полезно при попытке мигрировать существующую базу данных пользователей из одного типа паролей в другой.
- Cake\Auth\AbstractPasswordHasher использует Cake\Core\InstanceConfigTrait
-
Cake\Auth\FallbackPasswordHasher
Краткое описание свойств
-
$_defaultConfigprotectedЗначение конфигурации по умолчанию для этого объекта.array -
$_hashersprotectedСписок объектов хэширования паролей, которые будут использоватьсяarray
Унаследованные свойства
Краткое описание методов
- __construct() publicКонструктор
- check() publicПроверка, соответствует ли предоставленный пароль его хэшированной версии
- hash() publicГенерирует хэш пароля.
- needsRehash() public
Возвращает true, если пароль нужно перехэшировать, используя первый хэшер в списке хэшеров
Подробное описание методов
__construct()source public
__construct( array $config = [] )
Конструктор
Параметры
- массив
$configнеобязательно [] параметры конфигурации для этого объекта. Требуется наличие ключа
hashersв массиве со списком других хэшеров, которые будут использоваться
Переопределяет
Cake\Auth\AbstractPasswordHasher::__construct() check()source public
check( string $password , string $hashedPassword )
Проверка, соответствует ли предоставленный пароль его хэшированной версии
Это будет повторять все настроенные хэширующие объекты, пока один из них не вернёт true.
Параметры
- строка
$password - Обычный текст пароля для хэширования.
- строка
$hashedPassword - Существующий хэшированный пароль.
Возвращает
booleanTrue, если хэши совпадают, иначе false.
hash()source public
hash( string $password )
Генерирует хэш пароля.
Использует первый хэшер паролей в списке для генерации хэша
Параметры
- строка
$password - Обычный текст пароля для хэширования.
Возвращает
строкаХэш пароля
needsRehash()source public
needsRehash( string $password )
Возвращает true, если пароль нужно перехэшировать, используя первый хэшер в списке хэшеров
Параметры
- строка
$password - Пароль для проверки
Возвращает
booleanПереопределяет
Cake\Auth\AbstractPasswordHasher::needsRehash() Методы, используемые из Cake\Core\InstanceConfigTrait
_configDelete()source protected
_configDelete( string $key )
Удаляет один ключ конфигурации.
Параметры
- строка
$key - Ключ для удаления.
Исключения
Cake\Core\Exception\Exceptionесли попытка перезаписать существующую конфигурацию
_configRead()source protected
_configRead( string|null $key )
Чтение ключа конфигурации.
Параметры
- строка|null
$key - Ключ для чтения.
Возвращает
смешанный_configWrite()source protected
_configWrite( string|array $key , mixed $value , boolean|string $merge = false )
Запись ключа конфигурации.
Параметры
- строка|массив
$key - Ключ для записи.
- смешанный
$value - Значение для записи.
- boolean|строка
$mergeнеобязательно false True для рекурсивного объединения, 'shallow' для простого объединения, false для перезаписи, по умолчанию false.
Исключения
Cake\Core\Exception\Exceptionесли попытка перезаписи существующей конфигурации
config()source public deprecated
config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )
Получает/устанавливает конфигурацию.
Использование
Чтение всей конфигурации:
$this->config();
Чтение определённого значения:
$this->config('key'); Чтение вложенного значения:
$this->config('some.nested.key'); Установка определённого значения:
$this->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Устаревший
3.4.0 используйте setConfig()/getConfig() вместо этого.Параметры
- строка|массив|null
$keyнеобязательно null - Ключ для получения/установки или весь массив конфигураций.
- смешанный|null
$valueнеобязательно null - Значение для установки.
- boolean
$mergeнеобязательно true - Рекурсивное объединение или перезапись существующей конфигурации, по умолчанию true.
Возвращает
смешанныйЗначение конфигурации, которое читается, или сам объект при операциях записи.
Исключения
Cake\Core\Exception\ExceptionПри попытке установить некорректный ключ.
configShallow()source public
configShallow( string|array $key , mixed|null $value = null )
Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
Установка определённого значения:
$this->configShallow('key', $value); Установка вложенного значения:
$this->configShallow('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->configShallow(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или весь массив конфигураций.
- смешанный|null
$valueнеобязательно null - Значение для установки.
Возвращает
$this
getConfig()source public
getConfig( string|null $key = null , mixed $default = null )
Возвращает конфигурацию.
Использование
Чтение всей конфигурации:
$this->getConfig();
Чтение определённого значения:
$this->getConfig('key'); Чтение вложенного значения:
$this->getConfig('some.nested.key'); Чтение со значением по умолчанию:
$this->getConfig('some-key', 'default-value'); Параметры
- строка|null
$keyнеобязательно null - Ключ для получения или null для всей конфигурации.
- смешанный
$defaultнеобязательно null - Возвращаемое значение, когда ключ не существует.
Возвращает
смешанныйДанные конфигурации по указанному ключу или null, если ключ не существует.
setConfig()source public
setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )
Устанавливает конфигурацию.
Использование
Установка определённого значения:
$this->setConfig('key', $value); Установка вложенного значения:
$this->setConfig('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->setConfig(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или весь массив конфигураций.
- смешанный|null
$valueнеобязательно null - Значение для установки.
- boolean
$mergeнеобязательно true - Рекурсивное объединение или перезапись существующей конфигурации, по умолчанию true.
Возвращает
$this
Исключения
Cake\Core\Exception\ExceptionПри попытке установить некорректный ключ.
Подробное описание свойств
$_hasherssource
protected array
Список объектов хеширования паролей, которые будут использоваться
[]
© 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/3.8/class-Cake.Auth.FallbackPasswordHasher.html