Default password hashing class.
array<string, mixed>Runtime config
boolWhether the config property has already been configured with defaults
array<string, mixed>Default config for this object.
Constructor
Deletes a single config key.
Reads a config key.
Writes a config key.
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 the config.
Returns the config for this specific key.
Generates password hash.
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.
Sets the config.
__construct(array<string, mixed> $config = [])
Constructor
array<string, mixed> $config optional Array of config.
_configDelete(string $key): void
Deletes a single config key.
string $key Key to delete.
voidCake\Core\Exception\CakeException_configRead(string|null $key): mixed
Reads a config key.
string|null $key Key to read.
mixed_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
array<string, mixed>|string $key Key to write to.
mixed $value Value to write.
string|bool $merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
voidCake\Core\Exception\CakeExceptioncheck(string $password, string $hashedPassword): bool
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.
boolconfigShallow(array<string, mixed>|string $key, mixed|null $value = null): $this
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']);
array<string, mixed>|string $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thisgetConfig(string|null $key = null, mixed $default = null): mixed
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.
mixedgetConfigOrFail(string $key): mixed
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.
mixedInvalidArgumentExceptionhash(string $password): string|false
Generates password hash.
string $password Plain text password to hash.
string|falseneedsRehash(string $password): bool
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.
Returns true by default since the only implementation users should rely on is the one provided by default in php 5.5+ or any compatible library
string $password The password to verify
boolsetConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
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']);
array<string, mixed>|string $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.
$thisCake\Core\Exception\CakeExceptionRuntime config
array<string, mixed>Whether the config property has already been configured with defaults
boolDefault 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<string, mixed>
© 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.4/class-Cake.Auth.DefaultPasswordHasher.html