ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
class.ilUIHookPluginGUI.php
Go to the documentation of this file.
1<?php
2
3/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */
4
13{
14 protected $plugin_object = null;
15
16 const UNSPECIFIED = "";
17 const KEEP = "";
18 const REPLACE = "r";
19 const APPEND = "a";
20 const PREPEND = "p";
21
27 final function setPluginObject($a_val)
28 {
29 $this->plugin_object = $a_val;
30 }
31
37 final function getPluginObject()
38 {
40 }
41
48 function getHTML($a_comp, $a_part, $a_par = array())
49 {
50 return array("mode" => ilUIHookPluginGUI::KEEP, "html" => "");
51 }
52
59 function modifyGUI($a_comp, $a_part, $a_par = array())
60 {
61 }
62
70 final function modifyHTML($a_def_html, $a_resp)
71 {
72 switch ($a_resp["mode"])
73 {
75 $a_def_html = $a_resp["html"];
76 break;
78 $a_def_html.= $a_resp["html"];
79 break;
81 $a_def_html = $a_resp["html"].$a_def_html;
82 break;
83 }
84 return $a_def_html;
85 }
86
92 function gotoHook()
93 {
94 }
95
101 function checkGotoHook()
102 {
103 return array("target" => false);
104 }
105
106}
107?>
User interface hook class.
setPluginObject($a_val)
Set plugin object.
getHTML($a_comp, $a_part, $a_par=array())
Get html for ui area.
gotoHook()
Goto script hook.
getPluginObject()
Get plugin object.
modifyHTML($a_def_html, $a_resp)
Modify HTML based on default html and plugin response.
modifyGUI($a_comp, $a_part, $a_par=array())
Modify user interface, paramters contain classes that can be modified.
checkGotoHook()
Goto script hook.