Abstract parent class for all event hook plugin classes. More...

Inheritance diagram for ilEventHookPlugin:

Collaboration diagram for ilEventHookPlugin:

Public Member Functions
	getComponentType ()
	Get Component Type.
	getComponentName ()
	Get Component Name.
	getSlot ()
	Get Slot Name.
	getSlotId ()
	Get Slot ID.
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.
	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.
	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.

Protected Member Functions
	slotInit ()
	Object initialization done by slot.
Protected Member Functions inherited from ilPlugin
	setSlotObject ($a_slot)
	Set Plugin Slot.
	getSlotObject ()
	Get Plugin Slot.
	getDirectory ()
	Get Plugin Directory.
	getClassesDirectory ()
	Get Plugin's classes Directory.
	getLanguageDirectory ()
	Get Plugin's language Directory.
	init ()
	Object initialization.

Additional Inherited Members
Static Public Member Functions inherited from ilPlugin
static	getAvailableLangFiles ($a_lang_directory)
	Get array of all language files in the plugin.
static	getDBUpdateScriptName ($a_ctype, $a_cname, $a_slot_name, $a_pname)
	Get DB update script filename (full path)
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

Abstract parent class for all event hook plugin classes.

Member Function Documentation

ilEventHookPlugin::getComponentName ( )

final

Get Component Name.

Reimplemented from ilPlugin.

        {
                return "EventHandling";
        }

ilEventHookPlugin::getComponentType ( )

final

Get Component Type.

Reimplemented from ilPlugin.

        {
                return IL_COMP_SERVICE;
        }

ilEventHookPlugin::getSlot ( )

final

Get Slot Name.

Reimplemented from ilPlugin.

        {
                return "EventHook";
        }

ilEventHookPlugin::getSlotId ( )

final

Get Slot ID.

Reimplemented from ilPlugin.

        {
                return "evhk";
        }

ilEventHookPlugin::slotInit ( )

finalprotected

Object initialization done by slot.

Reimplemented from ilPlugin.

        {
                // nothing to do here
        }

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