ilEventHookPlugin Class Reference

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.
	handleEvent ($a_component, $a_event, $a_parameter)
	Handle the event.
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.
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

Abstract parent class for all event hook plugin classes.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 34 of file class.ilEventHookPlugin.php.

Member Function Documentation

ilEventHookPlugin::getComponentName ( )

final

Get Component Name.

Returns

string Component Name

Reimplemented from ilPlugin.

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

        {
                return "EventHandling";
        }

ilEventHookPlugin::getComponentType ( )

final

Get Component Type.

Returns

string Component Type

Reimplemented from ilPlugin.

Definition at line 41 of file class.ilEventHookPlugin.php.

References IL_COMP_SERVICE.

        {
                return IL_COMP_SERVICE;
        }

ilEventHookPlugin::getSlot ( )

final

Get Slot Name.

Returns

string Slot Name

Reimplemented from ilPlugin.

Definition at line 61 of file class.ilEventHookPlugin.php.

        {
                return "EventHook";
        }

ilEventHookPlugin::getSlotId ( )

final

Get Slot ID.

Returns

string Slot Id

Reimplemented from ilPlugin.

Definition at line 71 of file class.ilEventHookPlugin.php.

        {
                return "evhk";
        }

ilEventHookPlugin::handleEvent (   $a_component,   $a_event,   $a_parameter  )

abstract

Handle the event.

Parameters

string	component, e.g. "Services/User"
event	event, e.g. "afterUpdate"
array	array of event specific parameters

ilEventHookPlugin::slotInit ( )

finalprotected

Object initialization done by slot.

Reimplemented from ilPlugin.

Definition at line 79 of file class.ilEventHookPlugin.php.

        {
                // nothing to do here
        }

---

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

• Services/EventHandling/classes/class.ilEventHookPlugin.php