class.ilPageContentGUI.php

Go to the documentation of this file.

<?php

use ILIAS\COPage\PC\EditGUIRequest;
use ILIAS\COPage\Editor\EditSessionRepository;

use ILIAS\Style;

class ilPageContentGUI
{
    protected EditSessionRepository $edit_repo;
    protected string $pc_id = "";
    protected array $chars;
    protected ?ilObjStyleSheet $style = null;
    public ?ilPageContent $content_obj;
    public ilGlobalTemplateInterface $tpl;
    public ilLanguage $lng;
    public ilCtrl $ctrl;
    public ilPageObject $pg_obj;
    public string $hier_id = "";
    public php4DOMDocument $dom;
    public $updated;
    public string $target_script = "";
    public string $return_location = "";
    public ?ilPageConfig $page_config = null;
    protected ilLogger $log;
    protected int $styleid = 0;
    protected EditGUIRequest $request;
    protected string $sub_command = "";
    protected int $requested_ref_id = 0;

    public static string $style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;";

    // common bb buttons (special ones are iln and wln)
    protected static array $common_bb_buttons = array(
        "str" => "Strong", "emp" => "Emph", "imp" => "Important",
        "sup" => "Sup", "sub" => "Sub",
        "com" => "Comment",
        "quot" => "Quotation", "acc" => "Accent", "code" => "Code", "tex" => "Tex",
        "fn" => "Footnote", "xln" => "ExternalLink"
        );
    protected Style\Content\CharacteristicManager $char_manager;

    public function __construct(
        ilPageObject $a_pg_obj,
        ?ilPageContent $a_content_obj,
        string $a_hier_id = "",
        string $a_pc_id = "0"
    ) {
        global $DIC;

        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();

        $this->log = ilLoggerFactory::getLogger('copg');

        $this->tpl = $DIC->ui()->mainTemplate();
        $this->lng = $lng;
        $this->pg_obj = $a_pg_obj;
        $this->ctrl = $ilCtrl;
        $this->content_obj = $a_content_obj;
        $service = $DIC->copage()->internal();
        $this->request = $service
            ->gui()
            ->pc()
            ->editRequest();
        $this->edit_repo = $service
            ->repo()
            ->edit();
        $this->sub_command = $this->request->getSubCmd();
        $this->requested_ref_id = $this->request->getRefId();

        if ($a_hier_id !== "0") {
            $this->hier_id = $a_hier_id;
            $this->pc_id = $a_pc_id;
            //echo "-".$this->pc_id."-";
            $this->dom = $a_pg_obj->getDom();
        }
    }

    public function setContentObject(ilPageContent $a_val): void
    {
        $this->content_obj = $a_val;
    }

    public function getContentObject(): ?ilPageContent
    {
        return $this->content_obj;
    }

    public function setPage(ilPageObject $a_val): void
    {
        $this->pg_obj = $a_val;
    }

    public function getPage(): ilPageObject
    {
        return $this->pg_obj;
    }

    public function setPageConfig(ilPageConfig $a_val): void
    {
        $this->page_config = $a_val;
    }

    public function getPageConfig(): ilPageConfig
    {
        return $this->page_config;
    }

    public static function _getCommonBBButtons(): array
    {
        return self::$common_bb_buttons;
    }

    public function setStyleId(int $a_styleid): void
    {
        $this->styleid = $a_styleid;
    }

    public function getStyleId(): int
    {
        return $this->styleid;
    }

    public function getStyle(): ?ilObjStyleSheet
    {
        if ((!is_object($this->style) || $this->getStyleId() != $this->style->getId()) && $this->getStyleId() > 0) {
            if (ilObject::_lookupType($this->getStyleId()) == "sty") {
                $this->style = new ilObjStyleSheet($this->getStyleId());
            }
        }
        return $this->style;
    }

    public function getCharacteristicsOfCurrentStyle(array $a_type): void
    {
        global $DIC;
        $service = $DIC->contentStyle()->internal();
        $access_manager = $service->domain()->access(
            $this->requested_ref_id,
            $DIC->user()->getId()
        );

        if ($this->getStyleId() > 0 &&
            ilObject::_lookupType($this->getStyleId()) == "sty") {
            $char_manager = $service->domain()->characteristic(
                $this->getStyleId(),
                $access_manager
            );

            if (!is_array($a_type)) {
                $a_type = array($a_type);
            }
            $chars = $char_manager->getByTypes($a_type, false, false);
            $new_chars = array();
            foreach ($chars as $char) {
                if (($this->chars[$char->getCharacteristic()] ?? "") != "") {   // keep lang vars for standard chars
                    $title = $char_manager->getPresentationTitle(
                        $char->getType(),
                        $char->getCharacteristic()
                    );
                    if ($title == "") {
                        $title = $this->chars[$char->getCharacteristic()];
                    }
                    $new_chars[$char->getCharacteristic()] = $title;
                } else {
                    $new_chars[$char->getCharacteristic()] = $char_manager->getPresentationTitle(
                        $char->getType(),
                        $char->getCharacteristic()
                    );
                }
            }
            $this->setCharacteristics($new_chars);
        }
    }

    public function setCharacteristics(array $a_chars): void
    {
        $this->chars = $a_chars;
    }

    public function getCharacteristics(): array
    {
        return $this->chars ?? [];
    }

    public function getHierId(): string
    {
        return $this->hier_id;
    }

    public function setHierId(string $a_hier_id): void
    {
        $this->hier_id = $a_hier_id;
    }

    // delete content element
    public function delete(): void
    {
        $updated = $this->pg_obj->deleteContent($this->hier_id);
        if ($updated !== true) {
            $this->edit_repo->setPageError($updated);
        } else {
            $this->edit_repo->clearPageError();
        }
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

    public function moveAfter(): void
    {
        $target = $this->request->getStringArray("target");
        // check if a target is selected
        if (count($target) == 0) {
            throw new ilCOPagePCEditException(
                $this->lng->txt("no_checkbox")
            );
        }

        // check if only one target is selected
        if (count($target) > 1) {
            throw new ilCOPagePCEditException(
                $this->lng->txt("only_one_target")
            );
        }

        $a_hid = explode(":", $target[0]);
        //echo "-".$a_hid[0]."-".$a_hid[1]."-";

        // check if target is within source
        if ($this->hier_id == substr($a_hid[0], 0, strlen($this->hier_id))) {
            throw new ilCOPagePCEditException($this->lng->txt("cont_target_within_source"));
        }

        // check whether target is allowed
        $curr_node = $this->pg_obj->getContentNode($a_hid[0], $a_hid[1]);
        if (is_object($curr_node) && $curr_node->node_name() == "FileItem") {
            throw new ilCOPagePCEditException($this->lng->txt("cont_operation_not_allowed"));
        }

        // strip "c" "r" of table ids from hierarchical id
        $first_hier_character = substr($a_hid[0], 0, 1);
        if ($first_hier_character == "c" ||
            $first_hier_character == "r" ||
            $first_hier_character == "i") {
            $a_hid[0] = substr($a_hid[0], 1);
        }

        // move
        $updated = $this->pg_obj->moveContentAfter(
            $this->hier_id,
            $a_hid[0],
            $this->content_obj->getPCId(),
            $a_hid[1]
        );
        if ($updated !== true) {
            $this->edit_repo->setPageError($updated);
        } else {
            $this->edit_repo->clearPageError();
        }
        $this->log->debug("return to parent jump" . $this->hier_id);
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

    public function moveBefore(): void
    {
        $target = $this->request->getStringArray("target");
        // check if a target is selected
        if (count($target) == 0) {
            throw new ilCOPagePCEditException($this->lng->txt("no_checkbox"));
        }

        // check if target is within source
        if (count($target) > 1) {
            throw new ilCOPagePCEditException($this->lng->txt("only_one_target"));
        }

        $a_hid = explode(":", $target[0]);

        // check if target is within source
        if ($this->hier_id == substr($a_hid[0], 0, strlen($this->hier_id))) {
            throw new ilCOPagePCEditException($this->lng->txt("cont_target_within_source"));
        }

        // check whether target is allowed
        $curr_node = $this->pg_obj->getContentNode($a_hid[0], $a_hid[1]);
        if (is_object($curr_node) && $curr_node->node_name() == "FileItem") {
            throw new ilCOPagePCEditException($this->lng->txt("cont_operation_not_allowed"));
        }

        // strip "c" "r" of table ids from hierarchical id
        $first_hier_character = substr($a_hid[0], 0, 1);
        if ($first_hier_character == "c" ||
            $first_hier_character == "r" ||
            $first_hier_character == "i") {
            $a_hid[0] = substr($a_hid[0], 1);
        }

        // move
        $updated = $this->pg_obj->moveContentBefore(
            $this->hier_id,
            $a_hid[0],
            $this->content_obj->getPCId(),
            $a_hid[1]
        );
        if ($updated !== true) {
            $this->edit_repo->setPageError($updated);
        } else {
            $this->edit_repo->clearPageError();
        }
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }


    public function splitPage(): void
    {
        if ($this->pg_obj->getParentType() != "lm") {
            throw new ilCOPagePCEditException("Split method called for wrong parent type (" .
                $this->pg_obj->getParentType() . ")");
        } else {
            $lm_page = ilLMPageObject::_splitPage(
                $this->pg_obj->getId(),
                $this->pg_obj->getParentType(),
                $this->hier_id
            );

            // jump to new page
            $this->ctrl->setParameterByClass("illmpageobjectgui", "obj_id", $lm_page->getId());
            $this->ctrl->redirectByClass("illmpageobjectgui", "edit");
        }

        $this->ctrl->returnToParent($this, "jump" . ($this->hier_id - 1));
    }

    public function splitPageNext(): void
    {
        if ($this->pg_obj->getParentType() != "lm") {
            throw new ilCOPagePCEditException("Split method called for wrong parent type (" .
            $this->pg_obj->getParentType() . ")");
        } else {
            $succ_id = ilLMPageObject::_splitPageNext(
                $this->pg_obj->getId(),
                $this->pg_obj->getParentType(),
                $this->hier_id
            );

            // jump to successor page
            if ($succ_id > 0) {
                $this->ctrl->setParameterByClass("illmpageobjectgui", "obj_id", $succ_id);
                $this->ctrl->redirectByClass("illmpageobjectgui", "edit");
            }
        }
        $this->ctrl->returnToParent($this, "jump" . ($this->hier_id - 1));
    }

    public function displayValidationError(): void
    {
        if (is_array($this->updated)) {
            $error_str = "<b>Error(s):</b><br>";
            foreach ($this->updated as $error) {
                $err_mess = implode(" - ", $error);
                if (!is_int(strpos($err_mess, ":0:"))) {
                    $error_str .= htmlentities($err_mess) . "<br />";
                }
            }
            $this->tpl->setOnScreenMessage('failure', $error_str);
        } elseif ($this->updated != "" && $this->updated !== true) {
            $this->tpl->setOnScreenMessage('failure', "<b>Error(s):</b><br />" .
                $this->updated);
        }
    }

    public function cancelCreate(): void
    {
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

    public function cancelUpdate(): void
    {
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

    public function cancel(): void
    {
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

    public function deactivate(): void
    {
        $obj = &$this->content_obj;

        if ($obj->isEnabled()) {
            $obj->disable();
        } else {
            $obj->enable();
        }
        $this->updateAndReturn();
    }

    public function cut(): void
    {
        $updated = $this->pg_obj->cutContents(array($this->hier_id . ":" . $this->pc_id));
        if ($updated !== true) {
            $this->edit_repo->setPageError($updated);
        } else {
            $this->edit_repo->clearPageError();
        }

        $this->log->debug("return to parent jump" . $this->hier_id);
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

    public function copy(): void
    {
        $this->pg_obj->copyContents(array($this->hier_id . ":" . $this->pc_id));
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }


    public function getTemplateOptions(string $a_type = ""): array
    {
        $style = $this->getStyle();

        if (is_object($style)) {
            $ts = $style->getTemplates($a_type);
            $options = array();
            foreach ($ts as $t) {
                $options["t:" . $t["id"] . ":" . $t["name"]] = $t["name"];
            }
            return $options;
        }
        return array();
    }

    protected function redirectToParent(string $hier_id = ""): void
    {
        $ilCtrl = $this->ctrl;
        if ($hier_id == "") {
            $hier_id = $this->hier_id;
        }
        $pcid = $this->pg_obj->getPCIdForHierId($hier_id);
        $ilCtrl->returnToParent($this, "add" . $pcid);
    }

    protected function getParentReturn(string $hier_id = ""): string
    {
        if ($hier_id == "") {
            $hier_id = $this->hier_id;
        }
        $ilCtrl = $this->ctrl;
        $pcid = $this->pg_obj->getPCIdForHierId($hier_id);
        return $ilCtrl->getParentReturn($this) . "#add" . $pcid;
    }

    protected function updateAndReturn(): void
    {
        $up = $this->pg_obj->update();
        if ($up === true) {
            $this->edit_repo->clearPageError();
        } else {
            $this->edit_repo->setPageError($this->pg_obj->update());
        }
        $this->redirectToParent();
    }

    protected function setCurrentTextLang(string $lang_key): void
    {
        $this->edit_repo->setTextLang($this->requested_ref_id, $lang_key);
    }

    protected function getCurrentTextLang(): string
    {
        return $this->edit_repo->getTextLang($this->requested_ref_id);
    }
}