Spec-Zone.ru › CakePHP 3.4

Класс WeakPasswordHasher

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

Cake\Auth\AbstractPasswordHasher использует Cake\Core\InstanceConfigTrait
Extended by 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
True, если хеши совпадают, иначе false.

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

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' => null
]

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

Spec-Zone.ru

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