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 ($a_target)
	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

(

$a_target

)

Goto script hook.

Can be used to interfere with the goto script behaviour

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

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

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.

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

References KEEP.

getPluginObject()

ilUIHookPluginGUI::getPluginObject ( )

final

Get plugin object.

Returns

object plugin object

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

    {
        return $this->plugin_object;
    }

References $plugin_object.

gotoHook()

ilUIHookPluginGUI::gotoHook

(

)

Goto script hook.

Can be used to interfere with the goto script behaviour

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

    {
    }

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.

    {
    }

modifyHTML()

ilUIHookPluginGUI::modifyHTML (   $a_def_html,   $a_resp  )

final

Modify HTML based on default html and plugin response.

Parameters

string	default html
string	resonse from plugin

Returns

string modified html

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

    {
        switch ($a_resp["mode"]) {
            case ilUIHookPluginGUI::REPLACE:
                $a_def_html = $a_resp["html"];
                break;
            case ilUIHookPluginGUI::APPEND:
                $a_def_html .= $a_resp["html"];
                break;
            case ilUIHookPluginGUI::PREPEND:
                $a_def_html = $a_resp["html"] . $a_def_html;
                break;
        }
        return $a_def_html;
    }

References APPEND, PREPEND, and REPLACE.

setPluginObject()

ilUIHookPluginGUI::setPluginObject (   $a_val )

final

Set plugin object.

Parameters

object

plugin object

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

    {
        $this->plugin_object = $a_val;
    }

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

const ilUIHookPluginGUI::KEEP = ""

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

Referenced by ilUIHookProcessor\__construct(), ilTemplate\addBlockFile(), ilTemplate\get(), ilContainerGUI\getAsynchItemListObject(), getHTML(), ilTemplate\loadTemplatefile(), ilCtrl\redirectToURL(), and ilTemplate\show().

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:

• Services/UIComponent/classes/class.ilUIHookPluginGUI.php