class.ilUIHookPluginGUI.php

Go to the documentation of this file.

<?php

class ilUIHookPluginGUI
{
    protected ?ilUserInterfaceHookPlugin $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(ilUserInterfaceHookPlugin $a_val): void
    {
        $this->plugin_object = $a_val;
    }

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


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


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


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


    public function gotoHook(): void
    {
    }


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