Authentication plugin. 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)
	@deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More...

	getStyleSheetLocation (string $a_css_file)
	@deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More...

	addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
	@deprecate 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
	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...

Additional Inherited Members
Protected Member Functions inherited from ilPlugin
	init ()
	Object initialization. More...

	getPluginInfo ()

	getComponentInfo ()

	getPluginSlotInfo ()

	afterInstall ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the install method in your subclass instead. More...

	beforeUninstall ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...

	afterUninstall ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...

	beforeActivation ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...

	afterActivation ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...

	afterDeactivation ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...

	updateDatabase ()

	beforeUpdate ()
	@deprecate If you cannot get rid of the requirement to use this, adjust the update method in your subclass instead. More...

	afterUpdate ()

	getLanguageHandler ()

	buildLanguageHandler ()

	readEventListening ()

	clearEventListening ()

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

Authentication plugin.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 26 of file class.ilAuthPlugin.php.

Member Function Documentation

◆ getAuthIds()

ilAuthPlugin::getAuthIds ( )

abstract

Returns: array IDs of your Auth-Modes and Sub-Modes.

Implements ilAuthDefinition.

◆ getAuthName()

ilAuthPlugin::getAuthName ( int $a_auth_id )

abstract

Returns: string Text-Representation of your Auth-mode.

Implements ilAuthDefinition.

◆ getMultipleAuthModeOptions()

ilAuthPlugin::getMultipleAuthModeOptions ( int $a_auth_id )

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()

ilAuthPlugin::getProvider	(	ilAuthCredentials	$credentials,
		string	$a_auth_id
	)

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()

ilAuthPlugin::isAuthActive ( int $a_auth_id )

abstract

Parameters

int $id (can be your Mode or – if you have any – a Sub-mode.

Implements ilAuthDefinition.

◆ isExternalAccountNameRequired()

ilAuthPlugin::isExternalAccountNameRequired ( int $a_auth_id )

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAuthIds()

◆ getAuthName()

◆ getMultipleAuthModeOptions()

◆ getProvider()

◆ isAuthActive()

◆ isExternalAccountNameRequired()