Класс AbstractPasswordHasher
Абстрактный класс для хеширования паролей
- Cake\Auth\AbstractPasswordHasher использует Cake\Core\InstanceConfigTrait
Прямые подклассы
Краткое описание свойств
-
$_defaultConfigprotectedКонфигурация по умолчаниюarray
Унаследованные свойства
Краткое описание методов
- __construct() publicКонструктор
-
Проверка хеша. Сгенерировать хеш из предоставленного пользователем строки пароля или массива данных и проверить его против существующего хеша.
- Генерирует хеш пароля.
- needsRehash() public
Возвращает true, если пароль необходимо перехешировать, поскольку пароль был создан с использованием чего-либо кроме хешей, сгенерированных этим классом.
Подробное описание методов
__construct()source public
__construct( array $config [] )
Конструктор
Параметры
- массив
$configнеобязательный [] - Массив конфигурации.
check()source abstract public
check( string|array $password , string $hashedPassword )
Проверка хеша. Сгенерировать хеш из предоставленного пользователем строки пароля или массива данных и проверить его против существующего хеша.
Параметры
- строка|массив
$password - Пароль в виде простого текста для хеширования или массив данных.
- строка
$hashedPassword - Существующий хешированный пароль.
Возвращает
booleanTrue, если хеши совпадают, иначе false.
hash()source abstract public
hash( string|array $password )
Генерирует хеш пароля.
Параметры
- строка|массив
$password Пароль в виде простого текста для хеширования или массив данных, необходимый для генерации хеша пароля.
Возвращает
строкаХеш пароля
needsRehash()source public
needsRehash( string $password )
Возвращает true, если пароль необходимо перехешировать, поскольку пароль был создан с использованием чего-либо кроме хешей, сгенерированных этим классом.
По умолчанию возвращает true, так как единственная реализация, на которой должны полагаться пользователи, предоставляется по умолчанию в php 5.5+ или любой совместимой библиотеке
Параметры
- строка
$password - Пароль для проверки
Возвращает
booleanМетоды, используемые из 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 массив
Конфигурация по умолчанию
Они объединяются с предоставленной пользователем конфигурацией при использовании объекта.
[]
© 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.AbstractPasswordHasher.html