ilLDAPPlugin Class Reference

Plugin definition. More...

Inheritance diagram for ilLDAPPlugin:

Collaboration diagram for ilLDAPPlugin:

Public Member Functions
	getComponentName ()
	getComponentType ()
	getSlot ()
	getSlotId ()
	slotInit ()
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 ()

Protected Member Functions
	checkValue ($a_user_data, $a_keyword, $a_value)
	Check if user data matches a keyword value combination. More...
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...

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 Attributes inherited from ilPlugin
	$slot
	$active = false
	$iliasmaxversion = ""
	$iliasminversion = ""
	$version = ""
	$lastupdateversion = ""
	$dbversion = 0
	$lang_initialised = false
	$id = ''

Detailed Description

Plugin definition.

Author

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

Version

$Id$

Definition at line 36 of file class.ilLDAPPlugin.php.

Member Function Documentation

checkValue()

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

protected

Check if user data matches a keyword value combination.

Returns

Parameters

object	$a_user_data
object	$a_keyword
object	$a_value

Definition at line 85 of file class.ilLDAPPlugin.php.

References $values.

    {
        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;
    }

getComponentName()

ilLDAPPlugin::getComponentName ( )

final

See also

ilPlugin::getComponentName()

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

    {
        return 'LDAP';
    }

getComponentType()

ilLDAPPlugin::getComponentType ( )

final

See also

ilPlugin::getComponentType()

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

References IL_COMP_SERVICE.

    {
        return IL_COMP_SERVICE;
    }

getSlot()

ilLDAPPlugin::getSlot ( )

final

See also

ilPlugin::getSlot()

Definition at line 58 of file class.ilLDAPPlugin.php.

    {
        return 'LDAPHook';
    }

getSlotId()

ilLDAPPlugin::getSlotId ( )

final

See also

ilPlugin::getSlotId()

Definition at line 66 of file class.ilLDAPPlugin.php.

    {
        return 'ldaphk';
    }

slotInit()

ilLDAPPlugin::slotInit

(

)

See also

ilPlugin::slotInit()

Definition at line 74 of file class.ilLDAPPlugin.php.

    {
    }

---

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

• Services/LDAP/classes/class.ilLDAPPlugin.php