phpDocumentor » \XenForo_Authentication

This is a wrapper to maintain backwards compatibility.

Use XenForo_Authentication_Core directly.

package	XenForo_Authentication

Methods

Authenticate against the given password

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

Inherited

see	\global\XenForo_Authentication_Abstract::authenticate()
inherited_from	\XenForo_Authentication_Core::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()
inherited_from	\XenForo_Authentication_Core::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()
inherited_from	\XenForo_Authentication_Core::createDefault()

Returns

\XenForo_Authentication_Abstract

Generate new authentication data

generate(string $password) : false | string

Inherited

see	\global\XenForo_Authentication_Abstract::generate()
inherited_from	\XenForo_Authentication_Core::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()
inherited_from	\XenForo_Authentication_Core::generateSalt()

Parameters

$length

Returns

string

Returns the name of the authentication class being used.

getClassName() : string

Inherited

inherited_from	\XenForo_Authentication_Abstract::getClassName()
inherited_from	\XenForo_Authentication_Core::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()
inherited_from	\XenForo_Authentication_Core::hasPassword()

Returns

boolean

Initialize data for the authentication object.

setData(string $data)

Inherited

inherited_from	\XenForo_Authentication_Core::setData()

Parameters

$data

string

Binary data from the database

Perform the hashing based on the function set

_createHash($data) : string

Inherited

inherited_from	\XenForo_Authentication_Core::_createHash()

Parameters

$data

string

Returns

stringThe new hashed string

_newPassword()

_newPassword($password, $salt)

Inherited

inherited_from	\XenForo_Authentication_Core::_newPassword()

Parameters

$password

$salt

Setup the hash function

_setupHash()

Inherited

inherited_from	\XenForo_Authentication_Core::_setupHash()

Properties

Password info for this authentication object

$_data : array

Inherited

inherited_from	\XenForo_Authentication_Core::$$_data

Hash function to use for generating salts and passwords

$_hashFunc : string

Inherited

inherited_from	\XenForo_Authentication_Core::$$_hashFunc

Constants

Default Salt Length

DEFAULT_SALT_LENGTH : integer

Inherited

inherited_from	\XenForo_Authentication_Abstract::DEFAULT_SALT_LENGTH
inherited_from	\XenForo_Authentication_Core::DEFAULT_SALT_LENGTH