Helper class for passwords that use another password hash underneath it and encrypts that hash with a configured secret. More...

Inheritance diagram for EncryptedPassword:

Collaboration diagram for EncryptedPassword:

Public Member Functions
	crypt ($password)

	update ()
	Updates the underlying hash by encrypting it with the newest secret. More...

Public Member Functions inherited from ParameterizedPassword
	needsUpdate ()

	toString ()

Public Member Functions inherited from Password
	__construct (PasswordFactory $factory, array $config, $hash=null)
	Construct the Password object using a string hash. More...

	crypt ($password)
	Hash a password and store the result in this object. More...

	equals ($other)
	Compare one Password object to this object. More...

	getType ()
	Get the type name of the password. More...

	needsUpdate ()
	Determine if the hash needs to be updated. More...

	toString ()
	Convert this hash to a string that can be stored in the database. More...

Protected Member Functions
	getDefaultParams ()

	getDelimiter ()

Protected Member Functions inherited from ParameterizedPassword
	getDefaultParams ()
	Return an ordered array of default parameters for this password hash. More...

	getDelimiter ()
	Returns the delimiter for the parameters inside the hash. More...

	parseHash ($hash)

Protected Member Functions inherited from Password
	parseHash ($hash)
	Perform any parsing necessary on the hash to see if the hash is valid and/or to perform logic for seeing if the hash needs updating. More...

Additional Inherited Members
Protected Attributes inherited from ParameterizedPassword
array	$args = []
	Extra arguments that were found in the hash. More...

array	$params = []
	Named parameters that have default values for this password type. More...

Protected Attributes inherited from Password
array	$config
	Array of configuration variables injected from the constructor. More...

PasswordFactory	$factory
	Factory that created the object. More...

string	$hash
	String representation of the hash without the type. More...

Detailed Description

Helper class for passwords that use another password hash underneath it and encrypts that hash with a configured secret.

Definition at line 29 of file EncryptedPassword.php.

Member Function Documentation

EncryptedPassword::crypt ( $password )

Definition at line 41 of file EncryptedPassword.php.

EncryptedPassword::getDefaultParams ( )

protected

Definition at line 34 of file EncryptedPassword.php.

Referenced by update().

EncryptedPassword::getDelimiter ( )

protected

Definition at line 30 of file EncryptedPassword.php.

EncryptedPassword::update ( )

Updates the underlying hash by encrypting it with the newest secret.

Exceptions

MWException If the configuration is not valid

Definition at line 67 of file EncryptedPassword.php.

The documentation for this class was generated from the following file: