Inheritance diagram for ilPasswordEncoder:
Collaboration diagram for ilPasswordEncoder:
Public Member Functions | |
| encodePassword ($raw, $salt) | |
| Encodes the raw password. More... | |
| isPasswordValid ($encoded, $raw, $salt) | |
| Checks a raw password against an encoded password. More... | |
| getName () | |
| Returns a unique name/id of the concrete password encoder. More... | |
| requiresSalt () | |
| Returns whether or not the encoder requires a salt. More... | |
| requiresReencoding ($encoded) | |
| Returns whether or not the a encoded password needs to be re-encoded. More... | |
| isSupportedByRuntime () | |
| Returns whether or not the encoder is supported by the runtime (PHP, HHVM, ...) More... | |
Detailed Description
Definition at line 9 of file interface.ilPasswordEncoder.php.
Member Function Documentation
◆ encodePassword()
| 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, ilBcryptPhpPasswordEncoder, and ilMd5PasswordEncoder.
◆ getName()
| ilPasswordEncoder::getName | ( | ) |
Returns a unique name/id of the concrete password encoder.
- Returns
- string
Implemented in ilBcryptPasswordEncoder, ilBcryptPhpPasswordEncoder, and ilMd5PasswordEncoder.
◆ isPasswordValid()
| 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, ilBcryptPhpPasswordEncoder, and ilMd5PasswordEncoder.
◆ isSupportedByRuntime()
| ilPasswordEncoder::isSupportedByRuntime | ( | ) |
Returns whether or not the encoder is supported by the runtime (PHP, HHVM, ...)
- Returns
- boolean
Implemented in ilBasePasswordEncoder, and ilBcryptPhpPasswordEncoder.
◆ requiresReencoding()
| ilPasswordEncoder::requiresReencoding | ( | $encoded | ) |
Returns whether or not the a encoded password needs to be re-encoded.
- Parameters
-
$encoded string
- Returns
- boolean
Implemented in ilBasePasswordEncoder, ilBcryptPasswordEncoder, and ilBcryptPhpPasswordEncoder.
◆ requiresSalt()
| ilPasswordEncoder::requiresSalt | ( | ) |
Returns whether or not the encoder requires a salt.
- Returns
- boolean
Implemented in ilBasePasswordEncoder, and ilBcryptPasswordEncoder.
The documentation for this interface was generated from the following file:
- Services/Password/interfaces/interface.ilPasswordEncoder.php
