class.ilUIHookProcessor.php

Go to the documentation of this file.

<?php

class ilUIHookProcessor
{
    private bool $replaced = false;
    protected array $append = [];
    protected array $prepend = [];
    protected string $replace = '';

    public function __construct(
        string $a_comp,
        string $a_part,
        array $a_pars
    ) {
        global $DIC;

        $component_factory = $DIC["component.factory"];

        // user interface hook [uihk]
        foreach ($component_factory->getActivePluginsInSlot("uihk") as $plugin) {
            $gui_class = $plugin->getUIClassInstance();
            $resp = $gui_class->getHTML($a_comp, $a_part, $a_pars);

            $mode = $resp['mode'];
            if ($mode !== ilUIHookPluginGUI::KEEP) {
                $html = $resp['html'];
                switch ($mode) {
                    case ilUIHookPluginGUI::PREPEND:
                        $this->prepend[] = $html;
                        break;

                    case ilUIHookPluginGUI::APPEND:
                        $this->append[] = $html;
                        break;

                    case ilUIHookPluginGUI::REPLACE:
                        if (!$this->replaced) {
                            $this->replace = $html;
                            $this->replaced = true;
                        }
                        break;
                }
            }
        }
    }


    public function replaced(): bool
    {
        return $this->replaced;
    }

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

        return $html;
    }
}