UI interface hook processor. More...

Collaboration diagram for ilUIHookProcessor:

Public Member Functions
	__construct ($a_comp, $a_part, $a_pars)
	Constructor. More...

	replaced ()
	Should HTML be replaced completely? More...

	getHTML ($html)
	Get HTML. More...

Data Fields
	$append = array()

	$prepend = array()

	$replace = ""

Protected Attributes
	$plugin_admin

Detailed Description

UI interface hook processor.

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.ilUIHookProcessor.php.

Constructor & Destructor Documentation

◆ __construct()

ilUIHookProcessor::__construct	(	$a_comp,
		$a_part,
		$a_pars
	)

Constructor.

Parameters

return

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

    {
        global $DIC;
 
        $this->plugin_admin = $DIC["ilPluginAdmin"];
        $ilPluginAdmin = $DIC["ilPluginAdmin"];
        
        include_once("./Services/UIComponent/classes/class.ilUIHookPluginGUI.php");
        
        // user interface hook [uihk]
        $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "UIComponent", "uihk");
        $this->replaced = false;
        foreach ($pl_names as $pl) {
            $ui_plugin = ilPluginAdmin::getPluginObject(IL_COMP_SERVICE, "UIComponent", "uihk", $pl);
            $gui_class = $ui_plugin->getUIClassInstance();
            $resp = $gui_class->getHTML($a_comp, $a_part, $a_pars);
 
            if ($resp["mode"] != ilUIHookPluginGUI::KEEP) {
                switch ($resp["mode"]) {
                    case ilUIHookPluginGUI::PREPEND:
                        $this->prepend[] = $resp["html"];
                        break;
                        
                    case ilUIHookPluginGUI::APPEND:
                        $this->append[] = $resp["html"];
                        break;
                        
                    case ilUIHookPluginGUI::REPLACE:
                        if (!$this->replaced) {
                            $this->replace = $resp["html"];
                            $this->replaced = true;
                        }
                        break;
                }
            }
        }
    }

References $DIC, ilUIHookPluginGUI\APPEND, ilPluginAdmin\getPluginObject(), IL_COMP_SERVICE, ilUIHookPluginGUI\KEEP, ilUIHookPluginGUI\PREPEND, ilUIHookPluginGUI\REPLACE, and replaced().

Here is the call graph for this function:

Member Function Documentation

◆ getHTML()

ilUIHookProcessor::getHTML ( $html )

Get HTML.

Parameters

string $html html

Returns: string html

Definition at line 83 of file class.ilUIHookProcessor.php.

    {
        if ($this->replaced) {
            $html = $this->replace;
        }
        foreach ($this->append as $a) {
            $html .= $a;
        }
        foreach ($this->prepend as $p) {
            $html = $p . $html;
        }
        return $html;
    }

References $html, $replace, and replaced().

Here is the call graph for this function:

◆ replaced()

ilUIHookProcessor::replaced ( )

Should HTML be replaced completely?

Returns

Definition at line 72 of file class.ilUIHookProcessor.php.

    {
        return $this->replaced;
    }

Referenced by __construct(), and getHTML().

Here is the caller graph for this function:

Field Documentation

◆ $append

ilUIHookProcessor::$append = array()

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

◆ $plugin_admin

ilUIHookProcessor::$plugin_admin

protected

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

◆ $prepend

ilUIHookProcessor::$prepend = array()

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

◆ $replace

ilUIHookProcessor::$replace = ""

Definition at line 21 of file class.ilUIHookProcessor.php.

Referenced by getHTML().

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

Services/UIComponent/classes/class.ilUIHookProcessor.php

Public Member Functions

Data Fields

Protected Attributes