Authentication plugin. More...

Inheritance diagram for ilAuthPlugin:

Collaboration diagram for ilAuthPlugin:

Public Member Functions
	getComponentName ()

	getComponentType ()

	getSlot ()

	getSlotId ()

	slotInit ()
	Special alot Init, currently nothing to do here. More...

	isExternalAccountNameRequired ($a_auth_id)
	Does your AuthProvider needs "ext_account"? return true, false otherwise. More...

	getProvider (ilAuthCredentials $credentials, $a_auth_mode)

	getAuthName ($a_auth_id)

	getMultipleAuthModeOptions ($a_auth_id)

	isAuthActive ($id)

	getAuthIds ()

Public Member Functions inherited from ilPlugin
	__construct ()

	getComponentType ()
	Get Component Type. More...

	getComponentName ()
	Get Component Name. More...

	getSlot ()
	Get Slot Name. More...

	getSlotId ()
	Get Slot ID. More...

	getPluginName ()
	Get Plugin Name. More...

	getId ()

	getLastUpdateVersion ()
	Get Version of last update. More...

	getVersion ()

	getIliasMinVersion ()

	getIliasMaxVersion ()
	Get Required ILIAS max. More...

	getActive ()

	setDBVersion (int $a_dbversion)

	getDBVersion ()

	writeDBVersion (int $a_dbversion)

	getDirectory ()
	Get Plugin Directory. More...

	includeClass ($a_class_file_name)
	Include (once) a class file. More...

	getPrefix ()
	Get plugin prefix, used for lang vars. More...

	getTablePrefix ()
	Get db table plugin prefix. More...

	updateLanguages ($a_lang_keys=null)

	updateDatabase ()
	Update database. More...

	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)
	gets a ilTemplate instance of a html-file in the plugin /templates More...

	getImagePath (string $a_img)
	Get image path. More...

	getStyleSheetLocation (string $a_css_file)

	addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
	Add template content to placeholder variable. More...

	isActive ()
	Check whether plugin is active. More...

	needsUpdate ()
	Check whether update is needed. More...

	install ()

	activate ()
	Activate. More...

	deactivate ()
	Deactivate. More...

	uninstall ()

	update ()
	Update plugin. More...

	promoteGlobalScreenProvider ()

Public Member Functions inherited from ilAuthDefinition
	getProvider (ilAuthCredentials $credentials, $a_auth_id)
	Get auth provider instance. More...

	getAuthIds ()
	Get authentication id. More...

	getAuthIdByName ($a_auth_name)
	Get the auth id by an auth mode name. More...

	getAuthName ($a_auth_id)
	Get auth name by auth id. More...

	isAuthActive ($a_auth_id)
	Check if auth mode is active. More...

	supportsMultiCheck ($a_auth_id)
	Check whther authentication supports sequenced authentication. More...

	isExternalAccountNameRequired ($a_auth_id)
	Check if an external account name is required for this authentication method Normally this should return true. More...

	isPasswordModificationAllowed ($a_auth_id)
	Check if authentication method allows password modifications. More...

	getLocalPasswordValidationType ($a_auth_id)
	Get local password validation type One of ilAuthUtils::LOCAL_PWV_FULL ilAuthUtils::LOCAL_PWV_NO ilAuthUtils::LOCAL_PWV_USER. More...

	getMultipleAuthModeOptions ($a_auth_id)
	Get an array of options for "multiple auth mode" selection array( AUTH_ID => array( 'txt' => NAME) ) More...

Additional Inherited Members
Static Public Member Functions inherited from ilPlugin
static	_getDirectory (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)
	Get plugin directory. More...

static	getAvailableLangFiles (string $a_lang_directory)
	Get array of all language files in the plugin. More...

static	hasConfigureClass (string $a_slot_dir, array $plugin_data, array $plugin_db_data)
	Has the plugin a configure class? More...

static	getConfigureClassName (array $plugin_data)
	Get plugin configure class name. More...

static	getDBUpdateScriptName (string $a_ctype, string $a_cname, string $a_slot_name, string $a_pname)

static	lookupTxt (string $a_mod_prefix, string $a_pl_id, string $a_lang_var)

static	langExitsById (string $pluginId, string $langVar)
	Is searched lang var available in plugin lang files. More...

static	_getImagePath (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname, string $a_img)

static	createPluginRecord (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)

static	getPluginRecord (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)

static	getPluginObject (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)

static	lookupStoredData (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)
	Lookup information data in il_plugin. More...

static	getActivePluginsForSlot (string $a_ctype, string $a_cname, string $a_slot_id)

static	getActivePluginIdsForSlot (string $a_ctype, string $a_cname, string $a_slot_id)
	Get All active plugin ids for a slot. More...

static	lookupNameForId (string $a_ctype, string $a_cname, string $a_slot_id, string $a_plugin_id)

static	lookupIdForName (string $a_ctype, string $a_cname, string $a_slot_id, string $a_plugin_name)

static	lookupTypeInformationsForId (string $id)

Protected Member Functions inherited from ilPlugin
	setSlotObject (ilPluginSlot $a_slot)

	getSlotObject ()

	getClassesDirectory ()

	getLanguageDirectory ()

	slotInit ()
	Object initialization done by slot. More...

	init ()
	Object initialization. More...

	afterInstall ()
	After install processing. More...

	beforeActivation ()
	Before activation processing. More...

	afterActivation ()
	After activation processing. More...

	afterDeactivation ()
	After deactivation processing. More...

	beforeUninstall ()

	afterUninstall ()
	This is Plugin-Specific and is triggered after the uninstall command of a plugin. More...

	readEventListening ()
	Read the event listening definitions from the plugin.xml (if file exists) More...

	clearEventListening ()
	Clear the entries of this plugin in the event handling table. More...

	beforeUpdate ()
	Before update processing. More...

	afterUpdate ()
	After update processing. More...

Protected Attributes inherited from ilPlugin
	$slot

	$active = false

	$iliasmaxversion = ""

	$iliasminversion = ""

	$version = ""

	$lastupdateversion = ""

	$dbversion = 0

	$lang_initialised = false

	$id = ''

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 9 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 ( $a_auth_id )

abstract

Parameters

string $a_auth_id

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

Implements ilAuthDefinition.

◆ getComponentName()

ilAuthPlugin::getComponentName ( )

Returns: string Component-name

Reimplemented from ilPlugin.

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

        {
                return 'Authentication';
        }

◆ getComponentType()

ilAuthPlugin::getComponentType ( )

Returns: string

Reimplemented from ilPlugin.

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

        {
                return IL_COMP_SERVICE;
        }

References IL_COMP_SERVICE.

◆ getMultipleAuthModeOptions()

ilAuthPlugin::getMultipleAuthModeOptions ( $a_auth_id )

abstract

Parameters

$a_auth_id

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,
			$a_auth_mode
	)

abstract

Parameters

ilAuthCredentials	$credentials
string	$a_auth_mode

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.

◆ getSlot()

ilAuthPlugin::getSlot ( )

Returns: string Slot-Name

Reimplemented from ilPlugin.

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

        {
                return 'AuthenticationHook';
        }

◆ getSlotId()

ilAuthPlugin::getSlotId ( )

Returns: string Slot-ID

Reimplemented from ilPlugin.

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

        {
                return 'authhk';
        }

◆ isAuthActive()

ilAuthPlugin::isAuthActive ( $id )

abstract

Parameters

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

Returns: bool

Implements ilAuthDefinition.

◆ isExternalAccountNameRequired()

ilAuthPlugin::isExternalAccountNameRequired ( $a_auth_id )

abstract

Does your AuthProvider needs "ext_account"? return true, false otherwise.

Parameters

string $a_auth_id

Returns: bool

Implements ilAuthDefinition.

◆ slotInit()

ilAuthPlugin::slotInit ( )

final

Special alot Init, currently nothing to do here.

Reimplemented from ilPlugin.

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

        {
                //
        }

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

◆ getComponentName()

◆ getComponentType()

◆ getMultipleAuthModeOptions()

◆ getProvider()

◆ getSlot()

◆ getSlotId()

◆ isAuthActive()

◆ isExternalAccountNameRequired()

◆ slotInit()