Spec-Zone.ru › CakePHP 3.5

Класс 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
Истинно, если хеши совпадают, иначе ложно.

hash()source public

hash( string $password )

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

Параметры

строка $password
Обычный текст пароля для хеширования.

Возвращает

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

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

needsRehash()source public

needsRehash( string $password )

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

Возвращает истинно по умолчанию, так как единственная реализация, на которой должны полагаться пользователи, — это реализация, предоставляемая по умолчанию в 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

Истинно для рекурсивной слияния, 'shallow' для простого слияния, ложно для перезаписи, по умолчанию ложно.

Выбрасывает

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

Возвращает

смешанный
Значение конфигурации для чтения или сам объект при операциях записи.

Выбрасывает

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

Возвращает


$this

Выбрасывает

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

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

$_defaultConfigsource

protected массив

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

[
    'hashType' => null
]

© 2005–2018 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.5/class-Cake.Auth.WeakPasswordHasher.html

Spec-Zone.ru

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