1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. AuthSaml
  7. \
  8. Hook
  9. \
  10. System
  11. \
  12. SamlAuthentication

SamlAuthentication

class SamlAuthentication extends AuthenticationHook

Constants

HOOK_PREFIX

XELOS_NS_META

XELOS_NS_LOGIN

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 $name
protected string $description

Short description of authentication method

 from  AuthenticationHook
protected $ttl

Methods

bool
authenticate_user(string $userid, string $password)

User authentication is wrapped for Auth Hooks

from  AuthenticationHook
mixed
getAuthConfig(string $config_var)

Return configuration variable for auth method

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

Load Auth Method Hook without Access Check

from  AuthenticationHook
string
getAuthID()

Get internal Auth ID

from  AuthenticationHook
array
getConfigurationFDL()

No description

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

from  AuthenticationHook
array
get_module_info()

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

from  AuthenticationHook
array
get_user_details()

No description

from  AuthenticationHook
bool
isAvailable()

Is hook available at all?

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

Authenticate User

void
logout()

No description

void
onBeforeExecute()

Override in your auth method

from  AuthenticationHook
void
setName(mixed $name)

No description

from  AuthenticationHook

Details

in AuthenticationHook 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

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

Return configuration variable for auth method

Parameters

string $config_var

Return Value

mixed

in AuthenticationHook 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

in AuthenticationHook at line 142
final string getAuthID()

Get internal Auth ID

Return Value

string

at line 323
array getConfigurationFDL()

No description

Return Value

array

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

Exceptions

Exception

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

in AuthenticationHook at line 70
int getSessionTTL()

No description

Return Value

int

Time in seconds until session can/should be considered expired

in AuthenticationHook at line 107
final array get_module_info()

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

Return Value

array

in AuthenticationHook at line 95
final array get_user_details()

No description

Return Value

array

Returns an array containing all user information

at line 198
bool isAvailable()

Is hook available at all?

Return Value

bool

at line 40
UserDetails|bool login(string $login, string $password = null)

Authenticate User

Parameters

string $login
string $password

Password entered in form (if applicable)

Return Value

UserDetails|bool

Exceptions

Error
ValidationError

at line 282
void logout()

No description

Return Value

void

in AuthenticationHook at line 172
void onBeforeExecute()

Override in your auth method

Return Value

void

in AuthenticationHook at line 17
void setName(mixed $name)

No description

Parameters

mixed $name

Return Value

void