ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilUIHookPluginGUI Class Reference

User interface hook class. More...

+ Collaboration diagram for ilUIHookPluginGUI:

Public Member Functions

 setPluginObject ($a_val)
 Set plugin object. More...
 
 getPluginObject ()
 Get plugin object. More...
 
 getHTML ($a_comp, $a_part, $a_par=array())
 Get html for ui area. More...
 
 modifyGUI ($a_comp, $a_part, $a_par=array())
 Modify user interface, paramters contain classes that can be modified. More...
 
 modifyHTML ($a_def_html, $a_resp)
 Modify HTML based on default html and plugin response. More...
 
 gotoHook ()
 Goto script hook. More...
 
 checkGotoHook ()
 Goto script hook. More...
 

Data Fields

const UNSPECIFIED = ""
 
const KEEP = ""
 
const REPLACE = "r"
 
const APPEND = "a"
 
const PREPEND = "p"
 

Protected Attributes

 $plugin_object = null
 

Detailed Description

User interface hook class.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 12 of file class.ilUIHookPluginGUI.php.

Member Function Documentation

◆ checkGotoHook()

ilUIHookPluginGUI::checkGotoHook ( )

Goto script hook.

Can be used to interfere with the goto script behaviour

Definition at line 101 of file class.ilUIHookPluginGUI.php.

102 {
103 return array("target" => false);
104 }

◆ getHTML()

ilUIHookPluginGUI::getHTML (   $a_comp,
  $a_part,
  $a_par = array() 
)

Get html for ui area.

Parameters

return

Definition at line 48 of file class.ilUIHookPluginGUI.php.

49 {
50 return array("mode" => ilUIHookPluginGUI::KEEP, "html" => "");
51 }

References KEEP.

◆ getPluginObject()

ilUIHookPluginGUI::getPluginObject ( )
final

Get plugin object.

Returns
object plugin object

Definition at line 37 of file class.ilUIHookPluginGUI.php.

References $plugin_object.

◆ gotoHook()

ilUIHookPluginGUI::gotoHook ( )

Goto script hook.

Can be used to interfere with the goto script behaviour

Definition at line 92 of file class.ilUIHookPluginGUI.php.

93 {
94 }

◆ modifyGUI()

ilUIHookPluginGUI::modifyGUI (   $a_comp,
  $a_part,
  $a_par = array() 
)

Modify user interface, paramters contain classes that can be modified.

Parameters

return

Definition at line 59 of file class.ilUIHookPluginGUI.php.

60 {
61 }

◆ modifyHTML()

ilUIHookPluginGUI::modifyHTML (   $a_def_html,
  $a_resp 
)
final

Modify HTML based on default html and plugin response.

Parameters
stringdefault html
stringresonse from plugin
Returns
string modified html

Definition at line 70 of file class.ilUIHookPluginGUI.php.

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 }

References APPEND, PREPEND, and REPLACE.

◆ setPluginObject()

ilUIHookPluginGUI::setPluginObject (   $a_val)
final

Set plugin object.

Parameters
objectplugin object

Definition at line 27 of file class.ilUIHookPluginGUI.php.

28 {
29 $this->plugin_object = $a_val;
30 }

Field Documentation

◆ $plugin_object

ilUIHookPluginGUI::$plugin_object = null
protected

Definition at line 14 of file class.ilUIHookPluginGUI.php.

Referenced by getPluginObject().

◆ APPEND

const ilUIHookPluginGUI::APPEND = "a"

Definition at line 19 of file class.ilUIHookPluginGUI.php.

Referenced by ilUIHookProcessor\__construct(), and modifyHTML().

◆ KEEP

◆ PREPEND

const ilUIHookPluginGUI::PREPEND = "p"

Definition at line 20 of file class.ilUIHookPluginGUI.php.

Referenced by ilUIHookProcessor\__construct(), and modifyHTML().

◆ REPLACE

const ilUIHookPluginGUI::REPLACE = "r"

Definition at line 18 of file class.ilUIHookPluginGUI.php.

Referenced by ilUIHookProcessor\__construct(), and modifyHTML().

◆ UNSPECIFIED

const ilUIHookPluginGUI::UNSPECIFIED = ""

Definition at line 16 of file class.ilUIHookPluginGUI.php.


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