phpBB 3 authentication method.
Methods
Authenticate against the given password
authenticate(integer $userId, string $password) : bool
Parameters
$userId
integerThe user ID we're trying to authenticate as. This may not be needed, but can be used to "upgrade" auth schemes.
$password
stringPassword (plain text)
Returns
boolTrue if the authentication is successful
Factory method to get the named authentication module.
create(string $class) : \XenForo_Authentication_Abstract
InheritedStatic
The class must exist or be autoloadable
or an exception will be thrown.
| inherited_from |
\XenForo_Authentication_Abstract::create() |
Parameters
$class
stringClass to load
Returns
Factory method to create the default authentication handler.
createDefault() : \XenForo_Authentication_Abstract
InheritedStatic
| inherited_from |
\XenForo_Authentication_Abstract::createDefault() |
Returns
Generate new authentication data
generate(string $password) : false | string
Parameters
$password
stringPassword (plain text)
Returns
falsestringThe result will be stored in a binary result
Generates an arbtirary length salt
generateSalt($length) : string
InheritedStatic
| inherited_from |
\XenForo_Authentication_Abstract::generateSalt() |
Parameters
$length
Returns
string
Returns the name of the authentication class being used.
getClassName() : string
Inherited
| inherited_from |
\XenForo_Authentication_Abstract::getClassName() |
Returns
string
Returns true if the auth method provides a password.
hasPassword() : boolean
Inherited
A user can switch away
from this auth by requesting a password be emailed to him/her. An example of
this situation is FB registrations.
| inherited_from |
\XenForo_Authentication_Abstract::hasPassword() |
Returns
boolean
Initialize data for the authentication object.
setData(string $data)
Parameters
$data
stringBinary data from the database
Properties
Constants
Default Salt Length
DEFAULT_SALT_LENGTH : integer
Inherited
| inherited_from |
\XenForo_Authentication_Abstract::DEFAULT_SALT_LENGTH |