Класс 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
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']);
Параметры
- строка|массив|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->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или полный массив конфигураций.
- смешанный|null
$valueнеобязательно null - Значение для установки.
Возвращает
$this Объект сам по себе.
Подробное описание свойств
$_defaultConfigsource
protected массив
Значения конфигурации по умолчанию для этого объекта.
[
'hashers' => []
]
© 2005–2017 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.3/class-Cake.Auth.FallbackPasswordHasher.html