Spec-Zone.ru › CakePHP 3.8

Класс WeakPasswordHasher

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

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

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

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

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

  • _config, _configInitialized

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

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

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

__construct()source public

__construct( array $config = [] )

Конструктор

Параметры

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

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

Cake\Auth\AbstractPasswordHasher::__construct()

check()source public

check( string $password , string $hashedPassword )

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

Параметры

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

Возвращает

boolean
Истина, если хэши совпадают, иначе ложь.

hash()source public

hash( string $password )

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

Параметры

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

Возвращает

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

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

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 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
Возвращаемое значение, если ключ не существует.

Возвращает

смешанный тип
Данные конфигурации по указанному ключу или 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' => null
]

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

Spec-Zone.ru

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