Inheritance diagram for ilAuthDefinition:
Collaboration diagram for ilAuthDefinition:
Public Member Functions | |
| getProvider (ilAuthCredentials $credentials, string $a_auth_id) | |
| Get auth provider instance. More... | |
| getAuthIds () | |
| Get authentication id. More... | |
| getAuthIdByName (string $a_auth_name) | |
| Get the auth id by an auth mode name. More... | |
| getAuthName (int $a_auth_id) | |
| Get auth name by auth id. More... | |
| isAuthActive (int $a_auth_id) | |
| Check if auth mode is active. More... | |
| supportsMultiCheck (int $a_auth_id) | |
| Check whther authentication supports sequenced authentication. More... | |
| isExternalAccountNameRequired (int $a_auth_id) | |
| Check if an external account name is required for this authentication method Normally this should return true. More... | |
| isPasswordModificationAllowed (int $a_auth_id) | |
| Check if authentication method allows password modifications. More... | |
| getLocalPasswordValidationType (int $a_auth_id) | |
| Get local password validation type One of ilAuthUtils::LOCAL_PWV_FULL ilAuthUtils::LOCAL_PWV_NO ilAuthUtils::LOCAL_PWV_USER. More... | |
| getMultipleAuthModeOptions (int $a_auth_id) | |
| Get an array of options for "multiple auth mode" selection array( AUTH_ID => array( 'txt' => NAME) ) More... | |
Detailed Description
Definition at line 24 of file interface.ilAuthDefinition.php.
Member Function Documentation
◆ getAuthIdByName()
| ilAuthDefinition::getAuthIdByName | ( | string | $a_auth_name | ) |
Get the auth id by an auth mode name.
the auth mode name is stored for each user in table usr_data -> auth_mode
- See also
- ilAuthUtils::_getAuthMode()
◆ getAuthIds()
| ilAuthDefinition::getAuthIds | ( | ) |
Get authentication id.
For plugins the auth must be greater than 1000 and unique
- See also
- constants like in ilAuthUtils::AUTH_LDAP
- Returns
- int[]
Implemented in ilAuthPlugin.
◆ getAuthName()
| ilAuthDefinition::getAuthName | ( | int | $a_auth_id | ) |
◆ getLocalPasswordValidationType()
| ilAuthDefinition::getLocalPasswordValidationType | ( | int | $a_auth_id | ) |
Get local password validation type One of ilAuthUtils::LOCAL_PWV_FULL ilAuthUtils::LOCAL_PWV_NO ilAuthUtils::LOCAL_PWV_USER.
◆ getMultipleAuthModeOptions()
| ilAuthDefinition::getMultipleAuthModeOptions | ( | int | $a_auth_id | ) |
Get an array of options for "multiple auth mode" selection array( AUTH_ID => array( 'txt' => NAME) )
Implemented in ilAuthPlugin.
◆ getProvider()
| ilAuthDefinition::getProvider | ( | ilAuthCredentials | $credentials, |
| string | $a_auth_id | ||
| ) |
Get auth provider instance.
Implemented in ilAuthPlugin.
◆ isAuthActive()
| ilAuthDefinition::isAuthActive | ( | int | $a_auth_id | ) |
Check if auth mode is active.
Implemented in ilAuthPlugin.
◆ isExternalAccountNameRequired()
| ilAuthDefinition::isExternalAccountNameRequired | ( | int | $a_auth_id | ) |
Check if an external account name is required for this authentication method Normally this should return true.
Implemented in ilAuthPlugin.
◆ isPasswordModificationAllowed()
| ilAuthDefinition::isPasswordModificationAllowed | ( | int | $a_auth_id | ) |
Check if authentication method allows password modifications.
◆ supportsMultiCheck()
| ilAuthDefinition::supportsMultiCheck | ( | int | $a_auth_id | ) |
Check whther authentication supports sequenced authentication.
- See also
- ilAuthContainerMultiple
The documentation for this interface was generated from the following file:
- components/ILIAS/Authentication/interfaces/interface.ilAuthDefinition.php
