Класс 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–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.AbstractPasswordHasher.html