This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilUIHookPluginGUI:

Public Member Functions
	setPluginObject (ilUserInterfaceHookPlugin $a_val)

	getPluginObject ()

	getHTML (string $a_comp, string $a_part, array $a_par=array())

	modifyGUI (string $a_comp, string $a_part, array $a_par=array())

	modifyHTML (string $a_def_html, array $a_resp)

	gotoHook ()
	Goto script hook. More...

	checkGotoHook (string $a_target)
	Goto script hook. More...

Data Fields
const	UNSPECIFIED = ''

const	KEEP = ''

const	REPLACE = 'r'

const	APPEND = 'a'

const	PREPEND = 'p'

Protected Attributes
ilUserInterfaceHookPlugin	$plugin_object = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilUIHookPluginGUI

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

◆ checkGotoHook()

ilUIHookPluginGUI::checkGotoHook ( string $a_target )

Goto script hook.

Deprecated:: Implement a instead.

Will be removed with ILIAS 11. Can be used to interfere with the goto script behaviour

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

                                                    : array
     {
         return array('target' => false);
     }

◆ getHTML()

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

Returns: array array with entries "mode" => modification mode, "html" => your html

Deprecated:

Note this method is deprecated. There are several issues with hacking into already rendered html as provided here:

The generation of html might be performed twice (especially if REPLACE is used).
There is limited access to data used to generate the original html. If needed this data needs to be gathered again.
If an element inside the html needs to be changed, some crude string replace magic is needed.

Modify HTML output of GUI elements. Modifications modes are:

ilUIHookPluginGUI::KEEP (No modification)
ilUIHookPluginGUI::REPLACE (Replace default HTML with your HTML)
ilUIHookPluginGUI::APPEND (Append your HTML to the default HTML)
ilUIHookPluginGUI::PREPEND (Prepend your HTML to the default HTML)

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

      : array {
         return array('mode' => self::KEEP, 'html' => '');
     }

◆ getPluginObject()

ilUIHookPluginGUI::getPluginObject ( )

final

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

References $plugin_object.

                                            : ?ilUserInterfaceHookPlugin
     {
         return $this->plugin_object;
     }

◆ gotoHook()

ilUIHookPluginGUI::gotoHook ( )

Goto script hook.

Can be used to interfere with the goto script behaviour

Deprecated:: Implement a instead. Will be removed with ILIAS 11.

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

                               : void
     {
     }

◆ modifyGUI()

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

Deprecated:: Note this method is deprecated.

User Interface components are migrated towards the UIComponents and Global Screen which do not make use of the mechanism provided here. Make use of the extension possibilities provided by Global Screen and UI Components instead.

In ILIAS 6.0 still working for working for:

$a_comp="components/ILIAS/Ini" ; $a_part="init_style"
$a_comp="" ; $a_part="tabs"
$a_comp="" ; $a_part="sub_tabs"

Allows to modify user interface objects before they generate their output.

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

88 : void {

89 }

◆ modifyHTML()

ilUIHookPluginGUI::modifyHTML	(	string	$a_def_html,
		array	$a_resp
	)

final

Deprecated:: Reason, see getHTML

Modify HTML based on default html and plugin response

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

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

◆ setPluginObject()

ilUIHookPluginGUI::setPluginObject ( ilUserInterfaceHookPlugin $a_val )

final

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

                                                                            : void
     {
         $this->plugin_object = $a_val;
     }

Field Documentation

◆ $plugin_object

ilUserInterfaceHookPlugin ilUIHookPluginGUI::$plugin_object = null

protected

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

Referenced by getPluginObject().

◆ APPEND

const ilUIHookPluginGUI::APPEND = 'a'

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

◆ KEEP

const ilUIHookPluginGUI::KEEP = ''

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

Referenced by ilTemplate\addBlockFile(), ilTemplate\get(), ilCtrl\getTargetUrl(), ilTemplate\loadTemplatefile(), ilDataCollectionGlobalTemplate\printToStdout(), ILIAS\components\UICore\MetaTemplate\PageContentGUI\renderPage(), and ilGlobalTemplate\renderPage().

◆ PREPEND

const ilUIHookPluginGUI::PREPEND = 'p'

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

◆ REPLACE

const ilUIHookPluginGUI::REPLACE = 'r'

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

◆ UNSPECIFIED

const ilUIHookPluginGUI::UNSPECIFIED = ''

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

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

components/ILIAS/UIComponent/classes/class.ilUIHookPluginGUI.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Member Function Documentation

◆ checkGotoHook()

◆ getHTML()

◆ getPluginObject()

◆ gotoHook()

◆ modifyGUI()

◆ modifyHTML()

◆ setPluginObject()

Field Documentation

◆ $plugin_object

◆ APPEND

◆ KEEP

◆ PREPEND

◆ REPLACE

◆ UNSPECIFIED