Default password hashing class.
array
Runtime config
bool
Whether the config property has already been configured with defaults
array
Default config for this object.
Check hash. Generate hash for user provided password and check against existing hash.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Returns true if the password need to be rehashed, due to the password being created with anything else than the passwords generated by this class.
__construct(array $config)
Constructor
array
$config optional Array of config.
_configDelete(string $key)
Deletes a single config key.
string
$key Key to delete.
Cake\Core\Exception\Exception
_configRead(?string $key)
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
string|array
$key Key to write to.
mixed
$value Value to write.
bool|string
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception
check(string $password, string $hashedPassword)
Check hash. Generate hash for user provided password and check against existing hash.
string
$password Plain text password to hash.
string
$hashedPassword Existing hashed password.
bool
True if hashes match else false.
configShallow(mixed $key, mixed $value)
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);
Setting a nested value:
$this->configShallow('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
getConfig(?string $key, mixed $default)
Returns the config.
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key');
Reading a nested value:
$this->getConfig('some.nested.key');
Reading with default value:
$this->getConfig('some-key', 'default-value');
string|null
$key optional The key to get or null for the whole config.
mixed
$default optional The return value when the key does not exist.
mixed
Configuration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
Configuration data at the named key
InvalidArgumentException
hash(string $password)
Generates password hash.
string
$password Plain text password to hash.
string|false
Password hash or false on failure
needsRehash(string $password)
Returns true if the password need to be rehashed, due to the password being created with anything else than the passwords generated by this class.
string
$password The password to verify
bool
setConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
Setting a specific value:
$this->setConfig('key', $value);
Setting a nested value:
$this->setConfig('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
bool
$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$this
Cake\Core\Exception\Exception
Runtime config
array
Whether the config property has already been configured with defaults
bool
Default config for this object.
hashType
- Hashing algo to use. Valid values are those supported by $algo
argument of password_hash()
. Defaults to PASSWORD_DEFAULT
hashOptions
- Associative array of options. Check the PHP manual for supported options for each hash type. Defaults to empty array.array
© 2005–present 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/4.1/class-Cake.Auth.DefaultPasswordHasher.html