class.ilUIHookPluginGUI.php

Go to the documentation of this file.

<?php

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

class ilUIHookPluginGUI
{
        protected $plugin_object = null;
        
        const UNSPECIFIED = "";
        const KEEP = "";
        const REPLACE = "r";
        const APPEND = "a";
        const PREPEND = "p";

        final function setPluginObject($a_val)
        {
                $this->plugin_object = $a_val;
        }

        final function getPluginObject()
        {
                return $this->plugin_object;
        }

        function getHTML($a_comp, $a_part, $a_par = array())
        {
                return array("mode" => ilUIHookPluginGUI::KEEP, "html" => "");
        }

        function modifyGUI($a_comp, $a_part, $a_par = array())
        {
        }

        final function modifyHTML($a_def_html, $a_resp)
        {
                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;
        }

        function gotoHook()
        {
        }

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

}
?>