phpBB API Documentation
Interface

phpbb\passwords\driver\driver_interface

interface driver_interface

Methods

bool is_supported()

Check if hash type is supported

bool is_legacy()

Check if hash type is a legacy hash type

string get_prefix()

Returns the hash prefix

bool|string hash(string $password)

Hash the password

bool check(string $password, string $hash, array $user_row = array())

Check the password against the supplied hash

string get_settings_only(string $hash, bool $full = false)

Get only the settings of the specified hash

Details

at line 23
public bool is_supported()

Check if hash type is supported

Return Value

bool True if supported, false if not

at line 30
public bool is_legacy()

Check if hash type is a legacy hash type

Return Value

bool True if it's a legacy hash type, false if not

at line 37
public string get_prefix()

Returns the hash prefix

Return Value

string Hash prefix

at line 47
public bool|string hash(string $password)

Hash the password

Parameters

string $password The password that should be hashed

Return Value

bool|string Password hash or false if something went wrong during hashing

at line 58
public bool check(string $password, string $hash, array $user_row = array())

Check the password against the supplied hash

Parameters

string $password The password to check
string $hash The password hash to check against
array $user_row User's row in users table

Return Value

bool True if password is correct, else false

at line 68
public string get_settings_only(string $hash, bool $full = false)

Get only the settings of the specified hash

Parameters

string $hash Password hash
bool $full Return full settings or only settings related to the salt

Return Value

string String containing the hash settings