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

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.
Protected Attributes inherited from ilPlugin
	$lang_initialised = false

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

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 86 of file class.ilLDAPPlugin.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;
        }

ilLDAPPlugin::getComponentName ( )

final

See Also

ilPlugin::getComponentName()

Reimplemented from ilPlugin.

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

    {
                return 'LDAP';
    }

ilLDAPPlugin::getComponentType ( )

final

See Also

ilPlugin::getComponentType()

Reimplemented from ilPlugin.

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

References IL_COMP_SERVICE.

    {
                return IL_COMP_SERVICE;
    }

ilLDAPPlugin::getSlot ( )

final

See Also

ilPlugin::getSlot()

Reimplemented from ilPlugin.

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

    {
        return 'LDAPHook';
    }

ilLDAPPlugin::getSlotId ( )

final

See Also

ilPlugin::getSlotId()

Reimplemented from ilPlugin.

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

    {
        return 'ldaphk';
    }

ilLDAPPlugin::slotInit

(

)

See Also

ilPlugin::slotInit()

Reimplemented from ilPlugin.

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