A password hasher that can use multiple different hashes where only one is the preferred one. This is useful when trying to migrate an existing database of users from one password type to another.
array<string, mixed>
Runtime config
bool
Whether the config property has already been configured with defaults
array<string, mixed>
Default config for this object.
arrayCake\Auth\AbstractPasswordHasher>
Holds the list of password hasher objects that will be used
Constructor
Deletes a single config key.
Reads a config key.
Writes a config key.
Verifies that the provided password corresponds to its hashed version
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, with the first hasher present in the list of hashers
Sets the config.
__construct(array<string, mixed> $config = [])
Constructor
array<string, mixed>
$config optional configuration options for this object. Requires the hashers
key to be present in the array with a list of other hashers to be used.
_configDelete(string $key): void
Deletes a single config key.
string
$key Key to delete.
void
Cake\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.
void
Cake\Core\Exception\CakeException
check(string $password, string $hashedPassword): bool
Verifies that the provided password corresponds to its hashed version
This will iterate over all configured hashers until one of them returns true.
string
$password Plain text password to hash.
string
$hashedPassword Existing hashed password.
bool
configShallow(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.
$this
getConfig(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.
mixed
getConfigOrFail(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.
mixed
InvalidArgumentException
hash(string $password): string|false
Generates password hash.
Uses the first password hasher in the list to generate the hash
string
$password Plain text password to hash.
string|false
needsRehash(string $password): bool
Returns true if the password need to be rehashed, with the first hasher present in the list of hashers
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
bool
setConfig(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.
$this
Cake\Core\Exception\CakeException
Runtime config
array<string, mixed>
Whether the config property has already been configured with defaults
bool
Default config for this object.
These are merged with user-provided config when the object is used.
array<string, mixed>
Holds the list of password hasher objects that will be used
arrayCake\Auth\AbstractPasswordHasher>
© 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.FallbackPasswordHasher.html