Класс AbstractPasswordHasher

__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

_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 deprecated

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

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

Является ли слияние рекурсивным или происходит перезапись существующей конфигурации, по умолчанию true.

Возвращает

$this

Исключения

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

[]