Docs For Class AuthenticatorLocalUser

Description

Internal wifidog user database authentication source

Located in /classes/AuthenticatorLocalUser.php (line 49)

Authenticator
   |
   --AuthenticatorLocalUser

Direct descendents

Class	Description
AuthenticatorLocalUserNoSignup	Internal wifidog user database authentication source, with signup disabled

Method Summary

AuthenticatorLocalUser __construct (mixed $account_orgin)

void acctStart (mixed $conn_id, [mixed &$errmsg = null])

void acctStop (mixed $conn_id, [mixed &$errmsg = null])

void acctUpdate (mixed $conn_id, mixed $incoming, mixed $outgoing, [mixed &$errmsg = null])

boolean isLocalUserAccountOrigin ($account_origin $account_origin)

void isRegistrationPermitted ()

void login (username: $username, password: $password, [mixed &$errmsg = null])

Variables

Inherited Variables

Inherited from Authenticator

Authenticator::$mNetwork

Methods

Constructor __construct (line 52)

AuthenticatorLocalUser __construct (mixed $account_orgin)

Redefinition of:

Authenticator::__construct()

acctStart (line 119)

Start accounting traffic for the user

void acctStart (mixed $conn_id, [mixed &$errmsg = null])

Redefinition of:

Authenticator::acctStart(): Start accounting traffic for the user

acctStop (line 134)

Final update and stop accounting

void acctStop (mixed $conn_id, [mixed &$errmsg = null])

Redefinition of:

Authenticator::acctStop(): Final update and stop accounting

acctUpdate (line 126)

Update traffic counters

void acctUpdate (mixed $conn_id, mixed $incoming, mixed $outgoing, [mixed &$errmsg = null])

Redefinition of:

Authenticator::acctUpdate(): Update traffic counters

isLocalUserAccountOrigin (line 63)

Callback function used to discriminate Local User account origins

return: : true if the parameter refers to a Local User account origin
static:
access: private

boolean isLocalUserAccountOrigin ($account_origin $account_origin)

$account_origin $account_origin: : array

isRegistrationPermitted (line 143)

The basic AuthenticatorLocalUser allows user signup

void isRegistrationPermitted ()

Redefinition of:

Authenticator::isRegistrationPermitted(): Property method that tells if the class allows registration

Redefined in descendants as:

AuthenticatorLocalUserNoSignup::isRegistrationPermitted() : The basic AuthenticatorLocalUser allows user signup

login (line 73)

Attempts to login a user against the authentication source. If successfull, returns a User object

void login (username: $username, password: $password, [mixed &$errmsg = null])

username: $username: A valid identifying token for the source. Not necessarily unique. For local user, bots username and email are valid.
password: $password: Clear text password.

Redefinition of:

Authenticator::login(): Attempts to login a user against the authentication source. If successfull, returns a User object

Inherited Methods

Inherited From Authenticator

Authenticator::__construct()
Authenticator::acctStart()
Authenticator::acctStop()
Authenticator::acctUpdate()
Authenticator::getNetwork()
Authenticator::isRegistrationPermitted()
Authenticator::login()
Authenticator::logout()