__constructsource public

__construct( array $config [] )

Constructor

Parameters

array $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

Overrides

Cake\Auth\AbstractPasswordHasher::__construct()

checksource public

check( string $password , string $hashedPassword )

Verifies that the provided password corresponds to its hashed version

This will iterate over all configured hashers until one of them returns true.

Parameters

string $password

Plain text password to hash.

string $hashedPassword

Existing hashed password.

Returns

boolean
True if hashes match else false.

hashsource public

hash( string $password )

Generates password hash.

Uses the first password hasher in the list to generate the hash

Parameters

string $password

Plain text password to hash.

Returns

string
Password hash

needsRehashsource public

needsRehash( string $password )

Returns true if the password need to be rehashed, with the first hasher present in the list of hashers

Parameters

string $password

The password to verify

Returns

boolean
bool

Overrides

Cake\Auth\AbstractPasswordHasher::needsRehash()

_configDeletesource protected

_configDelete( string $key )

Delete a single config key

Parameters

string $key

Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configReadsource protected

_configRead( string|null $key )

Read a config variable

Parameters

string|null $key

Key to read.

Returns

mixed
mixed

_configWritesource protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Write a config variable

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

boolean|string $merge optional false

True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

configsource public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Usage

Reading the whole config:

$this->config();

Reading a specific value:

$this->config('key');

Reading a nested value:

$this->config('some.nested.key');

Setting a specific value:

$this->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);

Parameters

string|array|null $key optional null

The key to get/set, or a complete array of configs.

mixed|null $value optional null

The value to set.

boolean $merge optional true

Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed
Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallowsource public

configShallow( string|array $key , mixed|null $value null )

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->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional null

The value to set.

Returns

mixed
$this The object itself.

[
    'hashers' => []
]

[]

[]

false