Spec-Zone.ru › CakePHP 3.2

Класс DefaultPasswordHasher

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

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

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

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

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

  • _config, _configInitialized

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

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

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

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

check()source public

check( string $password , string $hashedPassword )

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

Параметры

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

Возвращаемое значение

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

hash()source public

hash( string $password )

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

Параметры

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

Возвращаемое значение

boolean|string
Хеш пароля или false при ошибке

Ссылка

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

needsRehash()source public

needsRehash( string $password )

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

Параметры

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

Возвращаемое значение

boolean

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

Cake\Auth\AbstractPasswordHasher::needsRehash()

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

__construct()source public

__construct( array $config [] )

Конструктор

Параметры

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

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

_configDelete()source protected

_configDelete( string $key )

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

Параметры

string $key
Ключ для удаления.

Вызывает исключение

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

_configRead()source protected

_configRead( string|null $key )

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

Параметры

string|null $key
Ключ для чтения.

Возвращаемое значение

mixed

_configWrite()source protected

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

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

Параметры

string|array $key
Ключ для записи.
mixed $value
Значение для записи.
boolean|string $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']);

Параметры

string|array|null $key необязательно null
Ключ для получения/установки или полный массив конфигураций.
mixed|null $value необязательно null
Значение для установки.
boolean $merge необязательно true
Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращаемое значение

mixed
Читаемое значение конфигурации или сам объект при операциях записи.

Вызывает исключение

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']);

Параметры

string|array $key
Ключ для установки или полный массив конфигураций.
mixed|null $value необязательно null
Значение для установки.

Возвращаемое значение


$this Объект самого себя.

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

$_defaultConfigsource

protected array

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

Опции

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

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

Spec-Zone.ru

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