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. More... | |
| getComponentName () | |
| Get Component Name. More... | |
| getSlot () | |
| Get Slot Name. More... | |
| getSlotId () | |
| Get Slot ID. More... | |
| handleEvent ($a_component, $a_event, $a_parameter) | |
| Handle the event. More... | |
| 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 () | |
| Get Id. More... | |
| getLastUpdateVersion () | |
| Get Version of last update. More... | |
| getVersion () | |
| Get Current Version (from plugin.php file). More... | |
| getIliasMinVersion () | |
| Get Required ILIAS min. More... | |
| getIliasMaxVersion () | |
| Get Required ILIAS max. More... | |
| getActive () | |
| Get Active. More... | |
| setDBVersion ($a_dbversion) | |
| Set DB Version. More... | |
| getDBVersion () | |
| Get DB Version. More... | |
| writeDBVersion ($a_dbversion) | |
| Write DB version to database. More... | |
| 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 ($a_var) | |
| Get Language Variable (prefix will be prepended automatically) More... | |
| getTemplate ($a_template, $a_par1=true, $a_par2=true) | |
| Get template from plugin. More... | |
| getImagePath ($a_img) | |
| Get image path. More... | |
| getStyleSheetLocation ($a_css_file) | |
| Get css file location. More... | |
| 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 () | |
| Install. More... | |
| activate () | |
| Activate. More... | |
| deactivate () | |
| Deactivate. More... | |
| uninstall () | |
| update () | |
| Update plugin. More... | |
Protected Member Functions | |
| slotInit () | |
| Object initialization done by slot. More... | |
| Protected Member Functions inherited from ilPlugin | |
| setSlotObject ($a_slot) | |
| Set Plugin Slot. More... | |
| getSlotObject () | |
| Get Plugin Slot. More... | |
| getClassesDirectory () | |
| Get Plugin's classes Directory. More... | |
| getLanguageDirectory () | |
| Get Plugin's language Directory. More... | |
| 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 () | |
| 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 ($a_ctype, $a_cname, $a_slot_id, $a_pname) |
| Get plugin directory. More... | |
| static | getAvailableLangFiles ($a_lang_directory) |
| Get array of all language files in the plugin. More... | |
| static | hasConfigureClass ($a_slot_dir, $a_name) |
| Has the plugin a configure class? More... | |
| static | getConfigureClassName ($a_name) |
| Get plugin configure class name. More... | |
| static | getDBUpdateScriptName ($a_ctype, $a_cname, $a_slot_name, $a_pname) |
| Get DB update script filename (full path) More... | |
| static | lookupTxt ($a_mod_prefix, $a_pl_id, $a_lang_var) |
| Lookup language text. More... | |
| static | langExitsById ($pluginId, $langVar) |
| Is searched lang var available in plugin lang files. More... | |
| static | _getImagePath ( $a_ctype, $a_cname, $a_slot_id, $a_pname, $a_img) |
| Get image path. More... | |
| static | createPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname) |
| static | getPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname) |
| Get record from il_plugin table. More... | |
| static | getPluginObject ($a_ctype, $a_cname, $a_slot_id, $a_pname) |
| Get plugin object. More... | |
| static | lookupStoredData ($a_ctype, $a_cname, $a_slot_id, $a_pname) |
| Lookup information data in il_plugin. More... | |
| static | getActivePluginsForSlot ($a_ctype, $a_cname, $a_slot_id) |
| Get all active plugin names for a slot. More... | |
| static | getActivePluginIdsForSlot ($a_ctype, $a_cname, $a_slot_id) |
| Get All active plugin ids for a slot. More... | |
| static | lookupNameForId ($a_ctype, $a_cname, $a_slot_id, $a_plugin_id) |
| Lookup name for id. More... | |
| static | lookupIdForName ($a_ctype, $a_cname, $a_slot_id, $a_plugin_name) |
| Lookup id for name. More... | |
| Protected Attributes inherited from ilPlugin | |
| $lang_initialised = false | |
| $id = '' | |
Detailed Description
Abstract parent class for all event hook plugin classes.
- Version
- $Id$
Definition at line 34 of file class.ilEventHookPlugin.php.
Member Function Documentation
◆ getComponentName()
|
final |
Get Component Name.
- Returns
- string Component Name
Definition at line 51 of file class.ilEventHookPlugin.php.
◆ getComponentType()
|
final |
Get Component Type.
- Returns
- string Component Type
Definition at line 41 of file class.ilEventHookPlugin.php.
References IL_COMP_SERVICE.
◆ getSlot()
|
final |
◆ getSlotId()
|
final |
◆ handleEvent()
|
abstract |
Handle the event.
- Parameters
-
string component, e.g. "Services/User" event event, e.g. "afterUpdate" array array of event specific parameters
Referenced by slotInit().
Here is the caller graph for this function:
◆ slotInit()
|
finalprotected |
Object initialization done by slot.
Definition at line 79 of file class.ilEventHookPlugin.php.
References handleEvent().
Here is the call graph for this function:
The documentation for this class was generated from the following file:
- Services/EventHandling/classes/class.ilEventHookPlugin.php
