class.ilUIHookProcessor.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2011 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilUIHookProcessor
{
    protected $plugin_admin;

    public $append = array();
    public $prepend = array();
    public $replace = "";
    
    public function __construct($a_comp, $a_part, $a_pars)
    {
        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;
                }
            }
        }
    }

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