Spec-Zone.ru › CakePHP 3.6

Класс 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 )

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

Параметры

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

Возвращает

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

hash()source public

hash( string $password )

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

Параметры

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

Возвращает

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

Ссылка

https://book.cakephp.org/3.0/ru/controllers/components/authentication.html#hashing-passwords

needsRehash()source public

needsRehash( string $password )

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

Параметры

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

Возвращает

boolean

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

Cake\Auth\AbstractPasswordHasher::needsRehash()

Наследованные методы из Cake\Auth\AbstractPasswordHasher

__construct()source public

__construct( array $config = [] )

Конструктор

Параметры

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

Используемые методы из 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 deprecated

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

Устарело

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

строка|массив|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->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

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

Возвращает


$this

getConfig()source public

getConfig( string|null $key = null , mixed $default = null )

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

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

Возвращает

смешанный тип
Значение конфигурации.

setConfig()source public

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

Устанавливает конфигурацию.

Использование

Установка определенного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

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

Возвращает


$this

Исключения

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

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

$_defaultConfigsource

protected массив

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

Параметры

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

© 2005–present 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.6/class-Cake.Auth.DefaultPasswordHasher.html

Spec-Zone.ru

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