1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. Module
  7. \
  8. Hook
  9. \
  10. AuthenticationHook

AuthenticationHook

abstract class AuthenticationHook extends BaseHook implements AuthenticationInterface

Class AuthenticationHook

Constants

HOOK_PREFIX

Properties

Controller $mod

Instance providing the hook

 from  BaseHook
array $_hook_info

Hook Information "id" => "4914" "instance_id" => "api_microsoft" "name" => "oauth_client" "hook" => "webservice.oauth_client" "type" => "object" "registry_name" => "oauth_client" "function_name" => "" "internal" => "no" "dep_mode" => "local" "active" => "yes" "title" => "Basic functions" "description" => "" "options" => ""

 from  BaseHook
protected string $name

Name of authentication method
protected string $description

Short description of authentication method
protected int $ttl

Methods

bool
authenticate_user(string $userid, string $password)

User authentication is wrapped for Auth Hooks

mixed
getAuthConfig(string $config_var)

Return configuration variable for auth method

static null|static
getAuthHook(string $hook_identifier = null)

Load Auth Method Hook without Access Check

string
getAuthID()

Get internal Auth ID

array
getConfigurationFDL()

Return optional Configuration options as Form Definition Array

string
getHookDescription()

No description

from  BaseHook
string
getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

from  BaseHook
array
getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

from  BaseHook
string
getHookInstance()

No description

from  BaseHook
string
getHookName()

No description

from  BaseHook
string
getHookTitle()

No description

from  BaseHook
getObject()

No description

from  BaseHook
mixed
getOption(string $key)

Returns the option with $key set in the config.yml

from  BaseHook
int
getSessionTTL()

No description

array
get_module_info()

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

array
get_user_details()

No description

bool
isAvailable()

Returns true if this hook is available otherwise false.

from  BaseHook
UserDetails|bool
login(string $userid, string $password = null)

No description

void
onBeforeExecute()

Override in your auth method

void
setName(mixed $name)

No description

Details

at line 83
final bool authenticate_user(string $userid, string $password)

User authentication is wrapped for Auth Hooks

Parameters

string $userid

Username as entered by user
string $password

Password as enetered by user

Return Value

bool

Returns true of authentication is valid

Exceptions

AuthenticationException

at line 132
final protected mixed getAuthConfig(string $config_var)

Return configuration variable for auth method

Parameters

string $config_var

Return Value

mixed

at line 51
final static null|static getAuthHook(string $hook_identifier = null)

Load Auth Method Hook without Access Check

Parameters

string $hook_identifier

Return Value

null|static

Exceptions

Exception

at line 142
final string getAuthID()

Get internal Auth ID

Return Value

string

at line 165
abstract protected array getConfigurationFDL()

Return optional Configuration options as Form Definition Array

Return Value

array

[ 'configoption' => [ 'type' => 'radio', 'label' => ("Choose a pill"), 'values' => array('b' => ("Blue"), 'r' => ("Red")) ] ]

in BaseHook at line 76
string getHookDescription()

No description

Return Value

string

in BaseHook at line 55
string getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

Return Value

string

in BaseHook at line 45
array getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

Parameters

bool $key

Return Value

array

in BaseHook at line 69
string getHookInstance()

No description

Return Value

string

in BaseHook at line 62
string getHookName()

No description

Return Value

string

in BaseHook at line 83
string getHookTitle()

No description

Return Value

string

in BaseHook at line 88
getObject()

No description

in BaseHook at line 97
mixed getOption(string $key)

Returns the option with $key set in the config.yml

Parameters

string $key

Return Value

mixed

at line 70
int getSessionTTL()

No description

Return Value

int

Time in seconds until session can/should be considered expired

at line 107
final array get_module_info()

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

Return Value

array

at line 95
final array get_user_details()

No description

Return Value

array

Returns an array containing all user information

in BaseHook at line 117
abstract bool isAvailable()

Returns true if this hook is available otherwise false.

Return Value

bool

at line 155
abstract protected UserDetails|bool login(string $userid, string $password = null)

No description

Parameters

string $userid

Login of the user
string $password

Password entered in form (if applicable)

Return Value

UserDetails|bool

Exceptions

AuthenticationException

at line 172
void onBeforeExecute()

Override in your auth method

Return Value

void

at line 17
void setName(mixed $name)

No description

Parameters

mixed $name

Return Value

void