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

SamlAuthentication

class SamlAuthentication extends BaseAuthentication

Properties

protected $ttl
$user_details
protected $config_id
protected $auth_title

Methods

__construct()

No description

bool
authenticate_user(string $login, string $password)

Authenticate User

static string
convertFromOldSyntax($auth_method)

Convert xauth_method_name to MethodAuthentication

from  BaseAuthentication
static BaseAuthentication|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()

Get User Details

bool
isAvailable()

Check wether SAML Auth should be used for the current request or not

static void
logout()

No description

Details

at line 16
__construct()

No description

at line 35
bool authenticate_user(string $login, string $password)

Authenticate User

Parameters

string $login
string $password

Password as enetered by user

Return Value

bool

Returns true of authentication is valid

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

Convert xauth_method_name to MethodAuthentication

Parameters

$auth_method

Return Value

string

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

Get Auth Method

Parameters

string $auth_method

Core Auth Method (XELOS Core)

Return Value

BaseAuthentication|null

in BaseAuthentication at line 15
int getSessionTTL()

No description

Return Value

int

Time in seconds until session can/should be considered expired

at line 256
array get_module_info()

No description

Return Value

array

Exceptions

Exception

at line 197
array get_user_details()

Get User Details

Return Value

array

Returns an array containing all user information

at line 124
bool isAvailable()

Check wether SAML Auth should be used for the current request or not

Return Value

bool

true if SAML should be used and is available

at line 215
static void logout()

No description

Return Value

void