Spec-Zone.ru › CakePHP 3.1

Класс DefaultPasswordHasher

Класс по умолчанию для хеширования паролей.

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

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

checksource public

check( string $password , string $hashedPassword )

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

Параметры

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

Возвращает

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

hashsource public

hash( string $password )

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

Параметры

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

Возвращает

boolean|string
Хеш пароля или false при ошибке

Ссылка

http://book.cakephp.org/3.0/ru/core-libraries/components/authentication.html#hashing-passwords

needsRehashsource public

needsRehash( string $password )

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

Параметры

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

Возвращает

boolean
bool

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

Cake\Auth\AbstractPasswordHasher::needsRehash()

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

__constructsource public

__construct( array $config [] )

Конструктор

Параметры

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

Используемые методы из Cake\Core\InstanceConfigTrait

_configDeletesource protected

_configDelete( string $key )

Удалить отдельную конфигурационную запись

Параметры

строка $key
Ключ для удаления.

Выбрасывает

Cake\Core\Exception\Exception
если попытка перезаписи существующей конфигурации

_configReadsource protected

_configRead( string|null $key )

Чтение конфигурационной переменной

Параметры

строка|null $key
Ключ для чтения.

Возвращает

mixed
смешанный тип

_configWritesource protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Запись конфигурационной переменной

Параметры

строка|массив $key
Ключ для записи.
смешанный тип $value
Значение для записи.
boolean|строка $merge необязательно false
True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Выбрасывает

Cake\Core\Exception\Exception
если попытка перезаписи существующей конфигурации

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

Параметры

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

Возвращает

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

Выбрасывает

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

configShallowsource public

configShallow( string|array $key , mixed|null $value null )

Объединяет предоставленную конфигурацию с существующей. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

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

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

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

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

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

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

Параметры

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

Возвращает

mixed
Сам объект $this.

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

$_defaultConfigsource

protected массив

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

Параметры

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

Используемые свойства из Cake\Core\InstanceConfigTrait

$_configsource

protected массив

Конфигурация во время выполнения

[]

$_configInitializedsource

protected boolean

Установлена ли конфигурация свойств значениями по умолчанию

false

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Auth.DefaultPasswordHasher.html

Spec-Zone.ru

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