Spec-Zone.ru › CakePHP 3.3

Класс AbstractPasswordHasher

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

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

Прямые подклассы

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

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

  • $_defaultConfig protected
    array
    Конфигурация по умолчанию

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

  • _config, _configInitialized

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

  • __construct() public
    Конструктор
  • check() abstract public

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

  • hash() abstract public
    Генерирует хеш пароля.
  • needsRehash() public

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

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

__construct()source public

__construct( array $config [] )

Конструктор

Параметры

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

check()source abstract public

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

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

Параметры

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

Возвращает

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

hash()source abstract public

hash( string|array $password )

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

Параметры

строка|массив $password

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

Возвращает

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

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

Параметры

строка|массив|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->config('key', $value);

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

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

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

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

Параметры

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

Возвращает


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

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

$_defaultConfigsource

protected массив

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

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

[]

© 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.3/class-Cake.Auth.AbstractPasswordHasher.html

Spec-Zone.ru

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