Spec-Zone.ru › CakePHP 3.2

Класс 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–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.2/class-Cake.Auth.AbstractPasswordHasher.html

Spec-Zone.ru

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