Spec-Zone.ru › CakePHP 3.7

Класс FallbackPasswordHasher

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

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

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

  • $_defaultConfig protected
    array
    Значение по умолчанию для этого объекта.
  • $_hashers protected
    array
    Список объектов хэшеров паролей, которые будут использоваться.

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

  • _config, _configInitialized

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

  • __construct() public
    Конструктор
  • check() public
    Проверяет, соответствует ли введённый пароль его хешированному варианту
  • hash() public
    Генерирует хеш пароля.
  • needsRehash() public

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

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

__construct()source public

__construct( array $config = [] )

Конструктор

Параметры

массив $config необязательно []

Параметры конфигурации для этого объекта. Требуется наличие ключа hashers в массиве со списком других хэшеров, которые необходимо использовать

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

Cake\Auth\AbstractPasswordHasher::__construct()

check()source public

check( string $password , string $hashedPassword )

Проверяет, соответствует ли введённый пароль его хешированному варианту

Это будет итерация по всем настроенным хэшерам, пока один из них не вернёт true.

Параметры

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

Возвращает

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

hash()source public

hash( string $password )

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

Использует первый хэшер паролей в списке для генерации хеша.

Параметры

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

Возвращает

строка
Хеш пароля

needsRehash()source public

needsRehash( string $password )

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

Параметры

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

Возвращает

boolean

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

Cake\Auth\AbstractPasswordHasher::needsRehash()

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

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

[
    'hashers' => []
]

$_hasherssource

protected array

Список объектов хэширования паролей, которые будут использоваться

[]

© 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.7/class-Cake.Auth.FallbackPasswordHasher.html

Spec-Zone.ru

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