1. interface
  2. XELOS
  3. \
  4. Framework
  5. \
  6. Core
  7. \
  8. Authentication
  9. \
  10. AuthenticationInterface

AuthenticationInterface

interface AuthenticationInterface

Methods

bool
authenticate_user(string $userid, string $password)

No description

int
getSessionTTL()

Return TTL Time for Session

array
get_module_info()

Return Auth Method information as keyed array [name, description, config]

array
get_user_details()

No description

void
onBeforeExecute()

Function will be called before module/page execution within view controller Please note that this will affect every request (API, file requests, internal AJAX requests) You should avoid

Details

at line 14
bool authenticate_user(string $userid, string $password)

No description

Parameters

string $userid

Username as entered by user
string $password

Password as enetered by user

Return Value

bool

Returns true of authentication is valid

at line 32
int getSessionTTL()

Return TTL Time for Session

Return Value

int

Time in seconds until session can/should be considered expired

at line 26
array get_module_info()

Return Auth Method information as keyed array [name, description, config]

Return Value

array

at line 20
array get_user_details()

No description

Return Value

array

Returns an array containing all user information

at line 41
void onBeforeExecute()

Function will be called before module/page execution within view controller Please note that this will affect every request (API, file requests, internal AJAX requests) You should avoid

Return Value

void