ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
class.ilEventHookPlugin.php
Go to the documentation of this file.
1 <?php
2 /*
3  +-----------------------------------------------------------------------------+
4  | ILIAS open source |
5  +-----------------------------------------------------------------------------+
6  | Copyright (c) 1998-2008 ILIAS open source, University of Cologne |
7  | |
8  | This program is free software; you can redistribute it and/or |
9  | modify it under the terms of the GNU General Public License |
10  | as published by the Free Software Foundation; either version 2 |
11  | of the License, or (at your option) any later version. |
12  | |
13  | This program is distributed in the hope that it will be useful, |
14  | but WITHOUT ANY WARRANTY; without even the implied warranty of |
15  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16  | GNU General Public License for more details. |
17  | |
18  | You should have received a copy of the GNU General Public License |
19  | along with this program; if not, write to the Free Software |
20  | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
21  +-----------------------------------------------------------------------------+
22 */
23 
24 include_once("./Services/Component/classes/class.ilPlugin.php");
25 
34 abstract class ilEventHookPlugin extends ilPlugin
35 {
41  final public function getComponentType()
42  {
43  return IL_COMP_SERVICE;
44  }
45 
51  final public function getComponentName()
52  {
53  return "EventHandling";
54  }
55 
61  final public function getSlot()
62  {
63  return "EventHook";
64  }
65 
71  final public function getSlotId()
72  {
73  return "evhk";
74  }
75 
79  final protected function slotInit()
80  {
81  // nothing to do here
82  }
83 
91  abstract public function handleEvent($a_component, $a_event, $a_parameter);
92 }
getComponentName()
Get Component Name.
handleEvent($a_component, $a_event, $a_parameter)
Handle the event.
getComponentType()
Get Component Type.
slotInit()
Object initialization done by slot.
Abstract parent class for all event hook plugin classes.
const IL_COMP_SERVICE