Spec-Zone.ru › CakePHP 3.3

Класс DefaultPasswordHasher

Класс по умолчанию для хэширования паролей.

Cake\Auth\AbstractPasswordHasher использует Cake\Core\InstanceConfigTrait
Расширен Cake\Auth\DefaultPasswordHasher
Пространство имён: Cake\Auth
Расположение: Auth/DefaultPasswordHasher.php

Краткое описание свойств

  • $_defaultConfig защищённое
    array
    Конфигурация по умолчанию для этого объекта.

Унаследованные свойства

  • _config, _configInitialized

Краткое описание методов

  • check() public
    Проверка хэша. Генерация хэша для введённого пользователем пароля и проверка его по существующему хэшу.
  • hash() public
    Генерирует хэш пароля.
  • needsRehash() public

    Возвращает true, если пароль необходимо перехэшировать, так как он был создан с помощью алгоритма, отличного от используемого этим классом.

Подробное описание методов

check()исходный код public

check( string $password , string $hashedPassword )

Проверка хэша. Генерация хэша для введённого пользователем пароля и проверка его по существующему хэшу.

Параметры

строка $password
Пароль в текстовом виде для хэширования.
строка $hashedPassword
Существующий хэшированный пароль.

Возвращает

boolean
True, если хэши совпадают, иначе false.

hash()исходный код public

hash( string $password )

Генерирует хэш пароля.

Параметры

строка $password
Пароль в текстовом виде для хэширования.

Возвращает

boolean|строка
Хэш пароля или false в случае ошибки

Ссылка

http://book.cakephp.org/3.0/ru/core-libraries/components/authentication.html#hashing-passwords

needsRehash()исходный код public

needsRehash( string $password )

Возвращает true, если пароль необходимо перехэшировать, так как он был создан с помощью алгоритма, отличного от используемого этим классом.

Параметры

строка $password
Пароль для проверки

Возвращает

boolean

Переопределяет

Cake\Auth\AbstractPasswordHasher::needsRehash()

Методы, унаследованные от Cake\Auth\AbstractPasswordHasher

__construct()исходный код public

__construct( array $config [] )

Конструктор

Параметры

массив $config необязательно []
Массив конфигурации.

Методы, используемые из Cake\Core\InstanceConfigTrait

_configDelete()исходный код защищённое

_configDelete( string $key )

Удаление одного ключа конфигурации

Параметры

строка $key
Ключ для удаления.

Выбрасывает

Cake\Core\Exception\Exception
при попытке перезаписи существующей конфигурации

_configRead()исходный код защищённое

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

строка|null $key
Ключ для чтения.

Возвращает

смешанный

_configWrite()исходный код защищённое

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Запись переменной конфигурации

Параметры

строка|массив $key
Ключ для записи.
смешанный $value
Значение для записи.
boolean|строка $merge необязательно false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Выбрасывает

Cake\Core\Exception\Exception
при попытке перезаписи существующей конфигурации

config()исходный код 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()исходный код 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 Объект.

Подробное описание свойств

$_defaultConfigисходный код

защищённое массив

Конфигурация по умолчанию для этого объекта.

Параметры

  • hashType - Алгоритм хэширования для использования. Допустимые значения — те, которые поддерживает $algo аргумент password_hash(). По умолчанию PASSWORD_DEFAULT
  • hashOptions - Ассоциативный массив параметров. Обратитесь к руководству PHP для получения информации о поддерживаемых параметрах для каждого типа хэша. По умолчанию пустой массив.
[
    'hashType' => PASSWORD_DEFAULT,
    'hashOptions' => []
]

© 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.DefaultPasswordHasher.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API