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
User authentication is wrapped for Auth Hooks
Return configuration variable for auth method
Load Auth Method Hook without Access Check
Get internal Auth ID
Return optional Configuration options as Form Definition Array
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
No description
Return Auth Method information as keyed array [name, description, config]
No description
No description
No description
Details
at line 72
final bool
authenticate_user(string $userid, string $password)
User authentication is wrapped for Auth Hooks
at line 118
final protected mixed
getAuthConfig(string $config_var)
Return configuration variable for auth method
at line 50
final static AuthenticationHook
getAuthHook(string $hook_identifier)
Load Auth Method Hook without Access Check
at line 128
final string
getAuthID()
Get internal Auth ID
at line 151
abstract protected array
getConfigurationFDL()
Return optional Configuration options as Form Definition Array
in
BaseHook at line 76
string
getHookDescription()
No description
in
BaseHook at line 55
string
getHookIdentifier()
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
in
BaseHook at line 45
array
getHookInfoValue(bool $key = false)
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
in
BaseHook at line 69
string
getHookInstance()
No description
in
BaseHook at line 62
string
getHookName()
No description
in
BaseHook at line 83
string
getHookTitle()
No description
in
BaseHook at line 88
getObject()
No description
at line 59
int
getSessionTTL()
No description
at line 93
final array
get_module_info()
Return Auth Method information as keyed array [name, description, config]
at line 81
final array
get_user_details()
No description
in
BaseHook at line 97
abstract bool
isAvailable()
Returns true if this hook is available otherwise false.
at line 141
abstract protected UserDetails
login(string $userid, string $password = null)
No description
at line 16
void
setName(mixed $name)
No description