class.ilPluginConfigGUI.php

Go to the documentation of this file.

<?php

abstract class ilPluginConfigGUI
{
    protected ?ilPlugin $plugin_object = null;

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

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

    public function executeCommand(): void
    {
        global $DIC;
        $ilCtrl = $DIC->ctrl();
        $ilTabs = $DIC->tabs();
        $lng = $DIC->language();
        $tpl = $DIC['tpl'];
        $request_wrapper = $DIC->http()->wrapper()->query();
        $string_trafo = $DIC["refinery"]->kindlyTo()->string();

        $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "ctype", $request_wrapper->retrieve("ctype", $string_trafo));
        $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "cname", $request_wrapper->retrieve("cname", $string_trafo));
        $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "slot_id", $request_wrapper->retrieve("slot_id", $string_trafo));
        $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "plugin_id", $request_wrapper->retrieve("plugin_id", $string_trafo));
        $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "pname", $request_wrapper->retrieve("pname", $string_trafo));

        $tpl->setTitle($lng->txt("cmps_plugin") . ": " . $request_wrapper->retrieve("pname", $string_trafo));
        $tpl->setDescription("");

        $ilTabs->clearTargets();

        if ($request_wrapper->retrieve("plugin_id", $string_trafo)) {
            $ilTabs->setBackTarget(
                $lng->txt("cmps_plugin"),
                $ilCtrl->getLinkTargetByClass("ilobjcomponentsettingsgui", "showPlugin")
            );
        } else {
            $ilTabs->setBackTarget(
                $lng->txt("cmps_plugins"),
                $ilCtrl->getLinkTargetByClass("ilobjcomponentsettingsgui", "listPlugins")
            );
        }

        $this->addTabs($ilTabs);

        $next_class = $ilCtrl->getNextClass();
        if ($next_class && $this->performNextClass($next_class)) {
            return;
        }
        $this->performCommand($ilCtrl->getCmd("configure"));
    }

    abstract public function performCommand(string $cmd): void;

    protected function performNextClass(string $next_class): bool
    {
        return false;
    }

    protected function addTabs(ilTabsGUI $tabs): void
    {
    }
}