ilAuthPlugin Class Reference
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...
Inheritance diagram for ilAuthPlugin:
Collaboration diagram for ilAuthPlugin:
Public Member Functions | |
| isExternalAccountNameRequired (int $a_auth_id) | |
| Does your AuthProvider needs "ext_account"? return true, false otherwise. More... | |
| getProvider (ilAuthCredentials $credentials, string $a_auth_id) | |
| getAuthName (int $a_auth_id) | |
| getMultipleAuthModeOptions (int $a_auth_id) | |
| isAuthActive (int $a_auth_id) | |
| getAuthIds () | |
| Public Member Functions inherited from ilPlugin | |
| getMessage () | |
| __construct (\ilDBInterface $db, \ilComponentRepositoryWrite $component_repository, string $id) | |
| getPluginName () | |
| getId () | |
| getVersion () | |
| Only very little classes seem to care about this: More... | |
| getDirectory () | |
| Only very little classes seem to care about this: More... | |
| isActive () | |
| Only very little classes seem to care about this: More... | |
| needsUpdate () | |
| install () | |
| uninstall () | |
| activate () | |
| This will update (if required) and activate the plugin. More... | |
| deactivate () | |
| update () | |
| loadLanguageModule () | |
| Load language module for plugin. More... | |
| txt (string $a_var) | |
| Get Language Variable (prefix will be prepended automatically) More... | |
| getTemplate (string $a_template, bool $a_par1=true, bool $a_par2=true) | |
| ILIAS is moving towards UI components and plugins are expected to use these components. More... | |
| getStyleSheetLocation (string $a_css_file) | |
| ILIAS is moving towards UI components and plugins are expected to use these components. More... | |
| addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname) | |
| ILIAS is moving towards UI components and plugins are expected to use these components. More... | |
| getGlobalScreenProviderCollection () | |
| exchangeUIRendererAfterInitialization (\ILIAS\DI\Container $dic) | |
| This methods allows to replace the UI Renderer (see src/UI) of ILIAS after initialization by returning a closure returning a custom renderer. More... | |
| exchangeUIFactoryAfterInitialization (string $dic_key, \ILIAS\DI\Container $dic) | |
| This methods allows to replace some factory for UI Components (see src/UI) of ILIAS after initialization by returning a closure returning a custom factory. More... | |
| Public Member Functions inherited from ilAuthDefinition | |
| getAuthIdByName (string $a_auth_name) | |
| Get the auth id by an auth mode name. More... | |
| supportsMultiCheck (int $a_auth_id) | |
| Check whther authentication supports sequenced authentication. 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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from ilPlugin | |
| init () | |
| Object initialization. More... | |
| getPluginInfo () | |
| getComponentInfo () | |
| getPluginSlotInfo () | |
| afterInstall () | |
| If you cannot get rid of the requirement to use this, adjust the install method in your subclass instead. More... | |
| beforeUninstall () | |
| If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More... | |
| afterUninstall () | |
| If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More... | |
| beforeActivation () | |
| If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More... | |
| afterActivation () | |
| If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More... | |
| afterDeactivation () | |
| If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More... | |
| updateDatabase () | |
| beforeUpdate () | |
| If you cannot get rid of the requirement to use this, adjust the update method in your subclass instead. More... | |
| afterUpdate () | |
| getLanguageHandler () | |
| buildLanguageHandler () | |
| Protected Attributes inherited from ilPlugin | |
| ilDBInterface | $db |
| ilComponentRepositoryWrite | $component_repository |
| string | $id |
| ilPluginLanguage | $language_handler = null |
| bool | $lang_initialised = false |
| ProviderCollection | $provider_collection |
| string | $message = '' |
Detailed Description
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.
ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.
If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Authentication plugin
Definition at line 25 of file class.ilAuthPlugin.php.
Member Function Documentation
◆ getAuthIds()
|
abstract |
- Returns
- array IDs of your Auth-Modes and Sub-Modes.
Implements ilAuthDefinition.
◆ getAuthName()
|
abstract |
- Returns
- string Text-Representation of your Auth-mode.
Implements ilAuthDefinition.
◆ getMultipleAuthModeOptions()
|
abstract |
- Returns
- array return an array with all your sub-modes (options) if you have some. The array comes as ['subid1' => 'Name of the Sub-Mode One', ...] you can return an empty array if you have just a "Main"-Mode.
Implements ilAuthDefinition.
◆ getProvider()
|
abstract |
- Returns
- ilAuthProviderInterface Your special instance of ilAuthProviderInterface where all the magic happens. You get the ilAuthCredentials and the user-selected (Sub-)-Mode as well.
Implements ilAuthDefinition.
◆ isAuthActive()
|
abstract |
- Parameters
-
int $id (can be your Mode or – if you have any – a Sub-mode.
Implements ilAuthDefinition.
◆ isExternalAccountNameRequired()
|
abstract |
Does your AuthProvider needs "ext_account"? return true, false otherwise.
- Parameters
-
int $a_auth_id
Implements ilAuthDefinition.
The documentation for this class was generated from the following file:
- Services/Authentication/classes/class.ilAuthPlugin.php
