ilPasswordEncoder Interface Reference

Inheritance diagram for ilPasswordEncoder:

Collaboration diagram for ilPasswordEncoder:

Public Member Functions
	encodePassword ($raw, $salt)
	Encodes the raw password.
	isPasswordValid ($encoded, $raw, $salt)
	Checks a raw password against an encoded password.
	getName ()
	Returns a unique name/id of the concrete password encoder.
	requiresSalt ()
	Returns whether or not the encoder requires a salt.

Detailed Description

Definition at line 9 of file interface.ilPasswordEncoder.php.

Member Function Documentation

ilPasswordEncoder::encodePassword	(		$raw,
			$salt
	)

Encodes the raw password.

Parameters

string	$raw	The password to encode
string	$salt	The salt

Returns

string The encoded password

Implemented in ilBcryptPasswordEncoder, and ilMd5PasswordEncoder.

ilPasswordEncoder::getName

(

)

Returns a unique name/id of the concrete password encoder.

Returns

string

Implemented in ilBcryptPasswordEncoder, and ilMd5PasswordEncoder.

ilPasswordEncoder::isPasswordValid	(		$encoded,
			$raw,
			$salt
	)

Checks a raw password against an encoded password.

The raw password has to be injected into the encoder instance before.

Parameters

string	$encoded	An encoded password
string	$raw	A raw password
string	$salt	The salt

Returns

Boolean true if the password is valid, false otherwise

Implemented in ilBcryptPasswordEncoder, and ilMd5PasswordEncoder.

ilPasswordEncoder::requiresSalt

(

)

Returns whether or not the encoder requires a salt.

Returns

boolean

Implemented in ilBcryptPasswordEncoder, and ilMd5PasswordEncoder.

---

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

• Services/Password/interfaces/interface.ilPasswordEncoder.php