Docs For Class Authenticator

Description

Abstract class to represent an authentication source

abstract:

Located in /classes/Authenticator.php (line 48)

Direct descendents

Class	Description
AuthenticatorLocalUser	Internal wifidog user database authentication source
AuthenticatorRadius	Internal wifidog user database authentication source

Variable Summary

mixed $mNetwork

Method Summary

Authenticator __construct (mixed $network_id)

void acctStart (mixed $conn_id)

void acctStop (mixed $conn_id)

void acctUpdate (mixed $conn_id, mixed $incoming, mixed $outgoing)

void getNetwork ()

void isRegistrationPermitted ()

void login ()

void logout ([mixed $conn_id = null])

Variables

mixed $mNetwork (line 50)

access: private

Methods

Constructor __construct (line 52)

Authenticator __construct (mixed $network_id)

Redefined in descendants as:

AuthenticatorLocalUser::__construct()
AuthenticatorRadius::__construct() : AuthenticatorRadius constructor

acctStart (line 129)

Start accounting traffic for the user

$conn_id: The connection id for the connection to work on

void acctStart (mixed $conn_id)

Redefined in descendants as:

AuthenticatorLocalUser::acctStart() : Start accounting traffic for the user
AuthenticatorRadius::acctStart() : Start accounting traffic for the user

acctStop (line 177)

Final update and stop accounting

$conn_id: The connection id (the token id) for the connection to work on

void acctStop (mixed $conn_id)

Redefined in descendants as:

AuthenticatorLocalUser::acctStop() : Final update and stop accounting
AuthenticatorRadius::acctStop() : Final update and stop accounting

acctUpdate (line 166)

Update traffic counters

$conn_id: The connection id for the connection to work on

void acctUpdate (mixed $conn_id, mixed $incoming, mixed $outgoing)

Redefined in descendants as:

AuthenticatorLocalUser::acctUpdate() : Update traffic counters
AuthenticatorRadius::acctUpdate() : Update traffic counters

getNetwork (line 57)

access: public

void getNetwork ()

isRegistrationPermitted (line 188)

Property method that tells if the class allows registration

void isRegistrationPermitted ()

Redefined in descendants as:

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

login (line 63)

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

void login ()

Redefined in descendants as:

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

logout (line 73)

Logs out the user $conn_id: The connection id for the connection to work on. Optionnal.

If it is not present, the behaviour depends if the network supports multiple logins. If it does not, all connections associated with the current user will be destroyed. If it does, only the connections tied to the current node will be destroyed

void logout ([mixed $conn_id = null])