class.ilLMEditorGUI.php

Go to the documentation of this file.

<?php

use ILIAS\LearningModule\Editing\EditingGUIRequest;

class ilLMEditorGUI implements ilCtrlBaseClassInterface
{
    protected \ILIAS\GlobalScreen\ScreenContext\ContextServices $tool_context;
    protected ilCtrl $ctrl;
    protected ilRbacSystem $rbacsystem;
    protected ilNavigationHistory $nav_history;
    protected ilHelpGUI $help;
    protected ilGlobalTemplateInterface $tpl;
    protected ilLanguage $lng;
    protected ilObjectDefinition $objDefinition;
    protected int $ref_id;
    protected ilObjLearningModule $lm_obj;
    protected ilLMTree $tree;
    protected int $obj_id;
    protected int $requested_active_node = 0;
    protected bool $to_page = false;
    protected EditingGUIRequest $request;
    protected \ILIAS\Style\Content\GUIService $content_style_gui;

    public function __construct()
    {
        global $DIC;

        $this->rbacsystem = $DIC->rbac()->system();
        $this->help = $DIC->help();
        $tpl = $DIC->ui()->mainTemplate();
        $lng = $DIC->language();
        $objDefinition = $DIC["objDefinition"];
        $ilCtrl = $DIC->ctrl();
        $rbacsystem = $DIC->rbac()->system();
        $ilNavigationHistory = $DIC["ilNavigationHistory"];

        $lng->loadLanguageModule("content");
        $lng->loadLanguageModule("lm");

        $this->request = $DIC
            ->learningModule()
            ->internal()
            ->gui()
            ->editing()
            ->request();

        $this->ref_id = $this->request->getRefId();
        $this->obj_id = $this->request->getObjId();

        // check write permission
        if (!$rbacsystem->checkAccess("write", $this->ref_id)) {
            throw new ilPermissionException($lng->txt("permission_denied"));
        }

        $this->ctrl = $ilCtrl;
        $this->tool_context = $DIC->globalScreen()->tool()->context();

        $this->ctrl->saveParameter($this, array("ref_id", "transl"));

        // initiate variables
        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->objDefinition = $objDefinition;

        $lm_obj = ilObjectFactory::getInstanceByRefId($this->ref_id);
        $this->lm_obj = $lm_obj;
        $this->tree = new ilLMTree($this->lm_obj->getId());

        $ilNavigationHistory->addItem(
            $this->ref_id,
            "ilias.php?baseClass=ilLMEditorGUI&ref_id=" . $this->ref_id,
            "lm"
        );

        $this->requested_active_node = $this->request->getActiveNode();
        $this->to_page = $this->request->getToPage();

        $this->checkRequestParameters();
        $cs = $DIC->contentStyle();
        $this->content_style_gui = $cs->gui();
    }

    protected function checkRequestParameters(): void
    {
        $forwards_to_role = $this->ctrl->checkCurrentPathForClass("ilobjrolegui");

        if (!$forwards_to_role && $this->obj_id > 0 && ilLMObject::_lookupContObjID($this->obj_id) != $this->lm_obj->getId()) {
            throw new ilException("Object ID does not match learning module.");
        }
        if ($this->requested_active_node > 0 && ilLMObject::_lookupContObjID($this->requested_active_node) != $this->lm_obj->getId()) {
            throw new ilException("Active node does not match learning module.");
        }
    }


    public function executeCommand(): void
    {
        global $DIC;

        $this->tool_context->claim()->repository();

        $cmd = "";

        $loc = $DIC["ilLocator"];
        $loc->addRepositoryItems($this->ref_id);

        if ($this->to_page) {
            $this->ctrl->setParameterByClass("illmpageobjectgui", "obj_id", $this->obj_id);
            $this->ctrl->redirectByClass(array("ilobjlearningmodulegui", "illmpageobjectgui"), "edit");
        }

        $this->showTree();

        $next_class = $this->ctrl->getNextClass($this);

        // show footer
        $show_footer = ($cmd !== "explorer");

        switch ($next_class) {
            case "ilobjlearningmodulegui":
                $this->main_header();
                $lm_gui = new ilObjLearningModuleGUI("", $this->ref_id, true, false);

                $ret = $this->ctrl->forwardCommand($lm_gui);
                if (strcmp($cmd, "explorer") != 0) {
                    $this->displayLocator();
                }
                // (horrible) workaround for preventing template engine
                // from hiding paragraph text that is enclosed
                // in curly brackets (e.g. "{a}", see ilPageObjectGUI::showPage())
                // @todo 6.0
                /*
                $output =  $this->tpl->getSpecial("DEFAULT", true, true, $show_footer,true);
                $output = str_replace("&#123;", "{", $output);
                $output = str_replace("&#125;", "}", $output);
                header('Content-type: text/html; charset=UTF-8');
                echo $output;*/
                $this->tpl->printToStdout();
                break;

            default:
                $this->ctrl->redirectByClass(array("ilobjlearningmodulegui"), "");
                break;
        }
    }

    public function showTree(): void
    {
        $tpl = $this->tpl;

        $this->tool_context->current()->addAdditionalData(ilLMEditGSToolProvider::SHOW_TREE, true);

        $exp = new ilLMEditorExplorerGUI($this, "showTree", $this->lm_obj);
        $exp->handleCommand();
    }

    public function main_header(): void
    {
        $this->tpl->loadStandardTemplate();

        // content style
        $this->content_style_gui->addCss(
            $this->tpl,
            $this->lm_obj->getRefId()
        );

        // syntax style
        $this->tpl->setCurrentBlock("SyntaxStyle");
        $this->tpl->setVariable(
            "LOCATION_SYNTAX_STYLESHEET",
            ilObjStyleSheet::getSyntaxStylePath()
        );
        $this->tpl->parseCurrentBlock();
    }


    public function displayLocator(): void
    {
        $this->tpl->setLocator();
    }
}