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;
    public const UNSPECIFIED = '';
    public const KEEP = '';
    public const REPLACE = 'r';
    public const APPEND = 'a';
    public const PREPEND = 'p';


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


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


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


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


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


    public function gotoHook()
    {
    }


    public function checkGotoHook($a_target)
    {
        return array('target' => false);
    }
}