W3cubDocs

/CakePHP 3.8

Class DefaultPasswordHasher

Default password hashing class.

Cake\Auth\AbstractPasswordHasher uses Cake\Core\InstanceConfigTrait
Extended by Cake\Auth\DefaultPasswordHasher

Properties summary

Inherited Properties

Method Summary

  • check() public
    Check hash. Generate hash for user provided password and check against existing hash.
  • hash() public
    Generates password hash.
  • needsRehash() public

    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.

Method Detail

check()source public

check( string $password , string $hashedPassword )

Check hash. Generate hash for user provided password and check against existing hash.

Parameters

string $password
Plain text password to hash.
string $hashedPassword
Existing hashed password.

Returns

boolean
True if hashes match else false.

hash()source public

hash( string $password )

Generates password hash.

Parameters

string $password
Plain text password to hash.

Returns

boolean|string
Password hash or false on failure

Link

https://book.cakephp.org/3.0/en/controllers/components/authentication.html#hashing-passwords

needsRehash()source public

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.

Parameters

string $password
The password to verify

Returns

boolean

Overrides

Cake\Auth\AbstractPasswordHasher::needsRehash()

Methods inherited from Cake\Auth\AbstractPasswordHasher

__construct()source public

__construct( array $config = [] )

Constructor

Parameters

array $config optional []
Array of config.

Methods used from Cake\Core\InstanceConfigTrait

_configDelete()source protected

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key
Key to delete.

Throws

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

_configRead()source protected

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key
Key to read.

Returns

mixed

_configWrite()source protected

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

Writes a config key.

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

config()source public deprecated

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

Gets/Sets the config.

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']);

Deprecated

3.4.0 use setConfig()/getConfig() instead.

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.

configShallow()source 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->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']);

Parameters

string|array $key
The key to set, or a complete array of configs.
mixed|null $value optional null
The value to set.

Returns


$this

getConfig()source public

getConfig( string|null $key = null , mixed $default = null )

Returns the config.

Usage

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');

Parameters

string|null $key optional null
The key to get or null for the whole config.
mixed $default optional null
The return value when the key does not exist.

Returns

mixed
Configuration data at the named key or null if the key does not exist.

setConfig()source public

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

Sets the config.

Usage

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']);

Parameters

string|array $key
The key to 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


$this

Throws

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

Properties detail

$_defaultConfigsource

protected array

Default config for this object.

Options

  • 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.
[
    'hashType' => PASSWORD_DEFAULT,
    'hashOptions' => []
]

© 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/3.8/class-Cake.Auth.DefaultPasswordHasher.html