Spec-Zone.ru › CakePHP 3.1

Класс AbstractPasswordHasher

Абстрактный класс для хэширования паролей

Cake\Auth\AbstractPasswordHasher использует Cake\Core\InstanceConfigTrait

Непосредственные подклассы

Cake\Auth\DefaultPasswordHasher, Cake\Auth\FallbackPasswordHasher, Cake\Auth\WeakPasswordHasher
Абстрактный
Пространство имён: Cake\Auth
Расположен по адресу Auth/AbstractPasswordHasher.php

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

__constructsource public

__construct( array $config [] )

Конструктор

Параметры

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

checksource abstract public

check( string|array $password , string $hashedPassword )

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

Параметры

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

Возвращает

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

hashsource abstract public

hash( string|array $password )

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

Параметры

строка|массив $password
Полевой текст пароля для хэширования или массив данных, необходимых для генерации хэша пароля.

Возвращает

string
Хэш пароля

needsRehashsource public

needsRehash( string $password )

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

По умолчанию возвращает true, так как единственная реализация, на которую пользователи должны полагаться, предоставляется по умолчанию в php 5.5+ или любой совместимой библиотеке.

Параметры

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

Возвращает

boolean
bool

Методы, используемые из 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
Значение для записи.
булево|строка $merge необязательный false
Истинно для рекурсивного слияния, 'shallow' для простого слияния, ложно для перезаписи, по умолчанию ложно.

Исключения

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
Значение для установки.
булево $merge необязательный 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 массив

Конфигурация по умолчанию

Эти значения объединяются с предоставленной пользователем конфигурацией при использовании объекта.

[]

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

$_configsource

protected массив

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

[]

$_configInitializedsource

protected булево

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

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.AbstractPasswordHasher.html

Spec-Zone.ru

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