Plugin definition. More...

Inheritance diagram for ilShibbolethAuthenticationPlugin:

Collaboration diagram for ilShibbolethAuthenticationPlugin:

Public Member Functions
	getComponentType ()
	Get Component Type.
	getComponentName ()
	Get Component Name.
	getSlot ()
	Get Slot Name.
	getSlotId ()
	Get Slot Id.
	beforeLogin (ilObjUser $user)
	afterLogin (ilObjUser $user)
	beforeCreateUser (ilObjUser $user)
	afterCreateUser (ilObjUser $user)
	beforeLogout (ilObjUser $user)
	afterLogout (ilObjUser $user)
	beforeUpdateUser (ilObjUser $user)
	afterUpdateUser (ilObjUser $user)
Public Member Functions inherited from ilPlugin
	__construct ()
	Constructor.
	getPluginName ()
	Get Plugin Name.
	getId ()
	Get Id.
	getLastUpdateVersion ()
	Get Version of last update.
	getVersion ()
	Get Current Version (from plugin.php file).
	getIliasMinVersion ()
	Get Required ILIAS min.
	getIliasMaxVersion ()
	Get Required ILIAS max.
	getActive ()
	Get Active.
	setDBVersion ($a_dbversion)
	Set DB Version.
	getDBVersion ()
	Get DB Version.
	writeDBVersion ($a_dbversion)
	Write DB version to database.
	getDirectory ()
	Get Plugin Directory.
	includeClass ($a_class_file_name)
	Include (once) a class file.
	getPrefix ()
	Get plugin prefix, used for lang vars.
	getTablePrefix ()
	Get db table plugin prefix.
	updateLanguages ()
	Update all languages.
	updateDatabase ()
	Update database.
	loadLanguageModule ()
	Load language module for plugin.
	txt ($a_var)
	Get Language Variable (prefix will be prepended automatically)
	getTemplate ($a_template, $a_par1=true, $a_par2=true)
	Get template from plugin.
	getImagePath ($a_img)
	Get image path.
	getStyleSheetLocation ($a_css_file)
	Get css file location.
	addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
	Add template content to placeholder variable.
	isActive ()
	Check whether plugin is active.
	needsUpdate ()
	Check whether update is needed.
	activate ()
	Activate.
	deactivate ()
	Deactivate.
	update ()
	Update plugin.
	lookupNameForId ($a_ctype, $a_cname, $a_slot_id, $a_plugin_id)
	Lookup name for id.
	lookupIdForName ($a_ctype, $a_cname, $a_slot_id, $a_plugin_name)
	Lookup id for name.

Protected Member Functions
	slotInit ()
	Object initialization done by slot.
	checkValue ($a_user_data, $a_keyword, $a_value)
Protected Member Functions inherited from ilPlugin
	setSlotObject ($a_slot)
	Set Plugin Slot.
	getSlotObject ()
	Get Plugin Slot.
	getClassesDirectory ()
	Get Plugin's classes Directory.
	getLanguageDirectory ()
	Get Plugin's language Directory.
	init ()
	Object initialization.
	beforeActivation ()
	Before activation processing.
	afterActivation ()
	After activation processing.
	afterDeactivation ()
	After deactivation processing.
	beforeUpdate ()
	Before update processing.
	afterUpdate ()
	After update processing.

Protected Attributes
	$active_plugins = array()
Protected Attributes inherited from ilPlugin
	$lang_initialised = false

Additional Inherited Members
Static Public Member Functions inherited from ilPlugin
static	_getDirectory ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get plugin directory.
static	getAvailableLangFiles ($a_lang_directory)
	Get array of all language files in the plugin.
static	hasConfigureClass ($a_slot_dir, $a_name)
	Has the plugin a configure class?
static	getConfigureClassName ($a_name)
	Get plugin configure class name.
static	getDBUpdateScriptName ($a_ctype, $a_cname, $a_slot_name, $a_pname)
	Get DB update script filename (full path)
static	lookupTxt ($a_mod_prefix, $a_pl_id, $a_lang_var)
	Lookup language text.
static	_getImagePath ($a_ctype, $a_cname, $a_slot_id, $a_pname, $a_img)
	Get image path.
static	createPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Create plugin record, if not existing.
static	getPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get record from il_plugin table.
static	getPluginObject ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get plugin object.
static	lookupStoredData ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Lookup information data in il_plugin.
static	getActivePluginsForSlot ($a_ctype, $a_cname, $a_slot_id)
	Get all active plugins for a slot.

Detailed Description

Plugin definition.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

Definition at line 37 of file class.ilShibbolethAuthenticationPlugin.php.

Member Function Documentation

ilShibbolethAuthenticationPlugin::afterCreateUser ( ilObjUser $user )

Parameters

ilObjUser $user

Returns: ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

Definition at line 155 of file class.ilShibbolethAuthenticationPlugin.php.

                                                         {
                return $user;
        }

ilShibbolethAuthenticationPlugin::afterLogin ( ilObjUser $user )

Parameters

ilObjUser $user

Returns: ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

Definition at line 135 of file class.ilShibbolethAuthenticationPlugin.php.

                                                    {
                return $user;
        }

ilShibbolethAuthenticationPlugin::afterLogout ( ilObjUser $user )

Parameters

ilObjUser $user

Returns: ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

Definition at line 175 of file class.ilShibbolethAuthenticationPlugin.php.

                                                     {
                return $user;
        }

ilShibbolethAuthenticationPlugin::afterUpdateUser ( ilObjUser $user )

Parameters

ilObjUser $user

Returns: ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

Definition at line 195 of file class.ilShibbolethAuthenticationPlugin.php.

                                                         {
                return $user;
        }

ilShibbolethAuthenticationPlugin::beforeCreateUser ( ilObjUser $user )

Parameters

ilObjUser $user

Returns: ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

Definition at line 145 of file class.ilShibbolethAuthenticationPlugin.php.

                                                          {
                return $user;
        }

ilShibbolethAuthenticationPlugin::beforeLogin ( ilObjUser $user )

Parameters

ilObjUser $user

Returns: ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

Definition at line 125 of file class.ilShibbolethAuthenticationPlugin.php.

                                                     {
                return $user;
        }

ilShibbolethAuthenticationPlugin::beforeLogout ( ilObjUser $user )

Parameters

ilObjUser $user

Returns: ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

Definition at line 165 of file class.ilShibbolethAuthenticationPlugin.php.

                                                      {
                return $user;
        }

ilShibbolethAuthenticationPlugin::beforeUpdateUser ( ilObjUser $user )

Parameters

ilObjUser $user

Returns: ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

Definition at line 185 of file class.ilShibbolethAuthenticationPlugin.php.

                                                          {
                return $user;
        }

ilShibbolethAuthenticationPlugin::checkValue	(	$a_user_data,
		$a_keyword,
		$a_value
	)

protected

Parameters

$a_user_data
$a_keyword
$a_value

Returns: bool

Definition at line 99 of file class.ilShibbolethAuthenticationPlugin.php.

                                                                          {
                if (! $a_user_data[$a_keyword]) {
                        return false;
                }
                if (is_array($a_user_data[$a_keyword])) {
                        foreach ($a_user_data[$a_keyword] as $values) {
                                if (strcasecmp(trim($values), $a_value) == 0) {
                                        return true;
                                }
                        }
                        return false;
                }
                if (strcasecmp(trim($a_user_data[$a_keyword]), trim($a_value)) == 0) {
                        return true;
                }
                return false;
        }

ilShibbolethAuthenticationPlugin::getComponentName ( )

final

Get Component Name.

Returns: string Component Name

Reimplemented from ilPlugin.

Definition at line 60 of file class.ilShibbolethAuthenticationPlugin.php.

                                                 {
                return 'AuthShibboleth';
        }

ilShibbolethAuthenticationPlugin::getComponentType ( )

final

Get Component Type.

Returns: string Component Type

Reimplemented from ilPlugin.

Definition at line 50 of file class.ilShibbolethAuthenticationPlugin.php.

References IL_COMP_SERVICE.

                                                 {
                return IL_COMP_SERVICE;
        }

ilShibbolethAuthenticationPlugin::getSlot ( )

final

Get Slot Name.

Returns: string Slot Name

Reimplemented from ilPlugin.

Definition at line 70 of file class.ilShibbolethAuthenticationPlugin.php.

                                        {
                return 'ShibbolethAuthenticationHook';
        }

ilShibbolethAuthenticationPlugin::getSlotId ( )

final

Get Slot Id.

Returns: string Slot Id

Reimplemented from ilPlugin.

Definition at line 80 of file class.ilShibbolethAuthenticationPlugin.php.

                                          {
                return 'shibhk';
        }

ilShibbolethAuthenticationPlugin::slotInit ( )

finalprotected

Object initialization done by slot.

Reimplemented from ilPlugin.

Definition at line 88 of file class.ilShibbolethAuthenticationPlugin.php.

{

}

Field Documentation

ilShibbolethAuthenticationPlugin::$active_plugins = array()

protected

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

The documentation for this class was generated from the following file:

Services/AuthShibboleth/classes/class.ilShibbolethAuthenticationPlugin.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Field Documentation