1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. Core
  7. \
  8. Authentication
  9. \
  10. Method
  11. \
  12. IpAuthentication

IpAuthentication

class IpAuthentication extends BaseAuthentication

Constants

ID_PREFIX

Properties

protected $ttl
$user_id

Methods

array
addConfigVarsToModuleInfoArray(array $moduleInfo)

Add correct config_var property to module info array

from  BaseAuthentication
bool
authenticate_user(string $user_login, string $password)

No description

static string
convertFromOldSyntax($auth_method)

Convert xauth_method_name to MethodAuthentication

from  BaseAuthentication
mixed
getAuthConfig(string $config_var)

Return configuration variable for auth method

from  BaseAuthentication
static string
getAuthID()

Get internal Auth ID

from  BaseAuthentication
static AuthenticationInterface|null
getAuthMethod(string $auth_method)

Get Auth Method

from  BaseAuthentication
int
getSessionTTL()

No description

from  BaseAuthentication
array
get_module_info()

No description

array
get_user_details()

No description

void
onBeforeExecute()

Override in your auth method

from  BaseAuthentication

Details

in BaseAuthentication at line 78
final protected array addConfigVarsToModuleInfoArray(array $moduleInfo)

Add correct config_var property to module info array

Parameters

array $moduleInfo

Return Value

array

at line 18
bool authenticate_user(string $user_login, string $password)

No description

Parameters

string $user_login
string $password

Password as enetered by user

Return Value

bool

Returns true of authentication is valid

in BaseAuthentication at line 59
final static string convertFromOldSyntax($auth_method)

Convert xauth_method_name to MethodAuthentication

Parameters

$auth_method

Return Value

string

in BaseAuthentication at line 92
final protected mixed getAuthConfig(string $config_var)

Return configuration variable for auth method

Parameters

string $config_var

Return Value

mixed

in BaseAuthentication at line 102
final static string getAuthID()

Get internal Auth ID

Return Value

string

in BaseAuthentication at line 32
final static AuthenticationInterface|null getAuthMethod(string $auth_method)

Get Auth Method

Parameters

string $auth_method

String identifier of Auth Method (XELOS Core or Authentication Hook)

Return Value

AuthenticationInterface|null

in BaseAuthentication at line 21
int getSessionTTL()

No description

Return Value

int

Time in seconds until session can/should be considered expired

at line 63
array get_module_info()

No description

Return Value

array

at line 47
array get_user_details()

No description

Return Value

array

Returns an array containing all user information

Exceptions

Exception

in BaseAuthentication at line 67
void onBeforeExecute()

Override in your auth method

Return Value

void