phpDocumentor
Back to top  

Core authentication method.

package XenForo_Authentication

 Methods

Authenticate against the given password

authenticate(integer $userId, string $password) : bool

see \global\XenForo_Authentication_Abstract::authenticate()

Parameters

$userId

integer

The user ID we're trying to authenticate as. This may not be needed, but can be used to "upgrade" auth schemes.

$password

string

Password (plain text)

Returns

boolTrue if the authentication is successful

Factory method to get the named authentication module.

create(string $class) : \XenForo_Authentication_Abstract
Inherited

The class must exist or be autoloadable or an exception will be thrown.

inherited_from \XenForo_Authentication_Abstract::create()

Parameters

$class

string

Class to load

Returns

\XenForo_Authentication_Abstract

Factory method to create the default authentication handler.

createDefault() : \XenForo_Authentication_Abstract
Inherited

inherited_from \XenForo_Authentication_Abstract::createDefault()

Returns

\XenForo_Authentication_Abstract

Generate new authentication data

generate(string $password) : false | string

see \global\XenForo_Authentication_Abstract::generate()

Parameters

$password

string

Password (plain text)

Returns

falsestringThe result will be stored in a binary result

Generates an arbtirary length salt

generateSalt($length) : string
Inherited

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

string

Binary data from the database

Perform the hashing based on the function set

_createHash($data) : string

Parameters

$data

string

Returns

stringThe new hashed string

_newPassword() 

_newPassword($password, $salt) 

Parameters

$password

$salt

Setup the hash function

_setupHash() 

 Properties

 

Password info for this authentication object

$_data : array

 

Hash function to use for generating salts and passwords

$_hashFunc : string

 Constants

 

Default Salt Length

DEFAULT_SALT_LENGTH : integer
Inherited

inherited_from \XenForo_Authentication_Abstract::DEFAULT_SALT_LENGTH