Класс 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 - Значение для записи.
- булево|строка
$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 - Значение для установки.
- булево
$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' => []
] $_hasherssource
protected массив
Список объектов хеширования паролей, которые будут использоваться
[]
© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Auth.FallbackPasswordHasher.html