class.ilPCTabsGUI.php

Go to the documentation of this file.

<?php

class ilPCTabsGUI extends ilPageContentGUI
{
    protected \ILIAS\COPage\PC\PCDefinition $pc_def;
    protected \ILIAS\COPage\Xsl\XslManager $xsl;
    protected ilPropertyFormGUI $form;
    protected ilDBInterface $db;
    protected ilTabsGUI $tabs;
    protected ilToolbarGUI $toolbar;

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

        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->db = $DIC->database();
        $this->tabs = $DIC->tabs();
        $this->toolbar = $DIC->toolbar();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
        $this->xsl = $DIC->copage()->internal()->domain()->xsl();
        $this->pc_def = $DIC->copage()->internal()->domain()->pc()->definition();
    }

    public function executeCommand(): void
    {
        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);

        // get current command
        $cmd = $this->ctrl->getCmd();

        switch ($next_class) {
            default:
                $this->$cmd();
                break;
        }
    }

    public function insert(
        bool $a_omit_form_init = false
    ): void {
        $tpl = $this->tpl;

        $this->displayValidationError();

        if (!$a_omit_form_init) {
            $this->initForm("create");
        }
        $html = $this->form->getHTML();
        $tpl->setContent($html);
    }

    public function editProperties(bool $init_form = true): void
    {
        $tpl = $this->tpl;

        $this->displayValidationError();
        $this->setTabs();

        if ($init_form) {
            $this->initForm();
            $this->getFormValues();
        }
        $html = $this->form->getHTML();
        $tpl->setContent($html);
    }

    public function initForm(
        string $a_mode = "edit"
    ): void {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        ilAccordionGUI::addCss();

        // edit form
        $this->form = new ilPropertyFormGUI();
        $this->form->setShowTopButtons(false);
        $this->form->setFormAction($ilCtrl->getFormAction($this));
        if ($a_mode != "edit") {
            $this->form->setTitle($lng->txt("cont_ed_insert_tabs"));
        } else {
            $this->form->setTitle($lng->txt("cont_edit_tabs"));
        }


        // type selection
        $radg = new ilRadioGroupInputGUI($lng->txt("cont_type"), "type");
        $radg->setValue(ilPCTabs::ACCORDION_VER);

        // type: vertical accordion
        $op1 = new ilRadioOption($lng->txt("cont_tabs_acc_ver"), ilPCTabs::ACCORDION_VER);
        $templ = $this->getTemplateOptions("vaccordion");
        if (count($templ) > 0) {

            $options = [];
            foreach ($templ as $k => $te) {
                $options[$k] = $te;
            }
            $vchar_prop = new ilSelectInputGUI($this->lng->txt("cont_characteristic"), "vaccord_templ");
            $vchar_prop->setOptions($options);
            $op1->addSubItem($vchar_prop);


        } else {
            $vchar_prop = new ilHiddenInputGUI("vaccord_templ");
            $this->form->addItem($vchar_prop);
        }
        $radg->addOption($op1);

        // type: carousel
        $op3 = new ilRadioOption($lng->txt("cont_tabs_carousel"), ilPCTabs::CAROUSEL);
        $templ = $this->getTemplateOptions("carousel");
        if (count($templ) > 0) {
            $cchar_prop = new ilSelectInputGUI(
                $this->lng->txt("cont_characteristic"),
                "carousel_templ"
            );
            $cchar_prop->setOptions($templ);
            $op3->addSubItem($cchar_prop);
        } else {
            $cchar_prop = new ilHiddenInputGUI("carousel_templ");
            $this->form->addItem($cchar_prop);
        }

        $radg->addOption($op3);
        $this->form->addItem($radg);


        // number of initial tabs
        if ($a_mode == "create") {
            $nr_prop = new ilSelectInputGUI(
                $lng->txt("cont_number_of_tabs"),
                "nr"
            );
            $nrs = array(1 => 1, 2 => 2, 3 => 3, 4 => 4, 5 => 5, 6 => 6,
                7 => 7, 8 => 8, 9 => 9, 10 => 10);
            $nr_prop->setOptions($nrs);
            $this->form->addItem($nr_prop);
        }

        /*
        $ni = new ilNumberInputGUI($this->lng->txt("cont_tab_cont_width"), "content_width");
        $ni->setMaxLength(4);
        $ni->setSize(4);
        $this->form->addItem($ni);

        $ni = new ilNumberInputGUI($this->lng->txt("cont_tab_cont_height"), "content_height");
        $ni->setMaxLength(4);
        $ni->setSize(4);
        $this->form->addItem($ni);*/

        // behaviour
        $options = array(
            "AllClosed" => $lng->txt("cont_all_closed"),
            "FirstOpen" => $lng->txt("cont_first_open"),
            "ForceAllOpen" => $lng->txt("cont_force_all_open"),
            );
        $si = new ilSelectInputGUI($this->lng->txt("cont_behavior"), "vbehavior");
        $si->setOptions($options);
        $op1->addSubItem($si);
        /*
        $si = new ilSelectInputGUI($this->lng->txt("cont_behavior"), "hbehavior");
        $si->setOptions($options);
        $op2->addSubItem($si);*/


        // alignment
        /*
        $align_opts = array("Left" => $lng->txt("cont_left"),
            "Right" => $lng->txt("cont_right"), "Center" => $lng->txt("cont_center"),
            "LeftFloat" => $lng->txt("cont_left_float"),
            "RightFloat" => $lng->txt("cont_right_float"));
        $align = new ilSelectInputGUI($this->lng->txt("cont_align"), "valign");
        $align->setOptions($align_opts);
        $align->setValue("Center");
        //$align->setInfo($lng->txt("cont_tabs_hor_align_info"));
        $op1->addSubItem($align);
        $align = new ilSelectInputGUI($this->lng->txt("cont_align"), "calign");
        $align->setOptions($align_opts);
        $align->setValue("Center");
        $op3->addSubItem($align);*/

        // carousel: time
        $ti = new ilNumberInputGUI($this->lng->txt("cont_auto_time"), "auto_time");
        $ti->setMaxLength(6);
        $ti->setSize(6);
        $ti->setSuffix("ms");
        $ti->setMinValue(100);
        $op3->addSubItem($ti);

        // carousel: random start
        $cb = new ilCheckboxInputGUI($this->lng->txt("cont_rand_start"), "rand_start");
        //$cb->setOptionTitle($this->lng->txt(""));
        //$cb->setInfo($this->lng->txt(""));
        $op3->addSubItem($cb);


        // save/cancel buttons
        if ($a_mode == "create") {
            $this->form->addCommandButton("create", $lng->txt("save"));
            $this->form->addCommandButton("cancelCreate", $lng->txt("cancel"));
        } else {
            $this->form->addCommandButton("update", $lng->txt("save"));
            $this->form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
        }
    }

    public function initCreationForm(): ilPropertyFormGUI
    {
        $this->initForm("create");
        return $this->form;
    }

    public function initEditingForm(): ilPropertyFormGUI
    {
        $this->initForm("edit");
        $this->getFormValues();
        return $this->form;
    }

    public function getFormValues(): void
    {
        $values["type"] = $this->content_obj->getTabType();
        $values["content_width"] = $this->content_obj->getContentWidth();
        $values["content_height"] = $this->content_obj->getContentHeight();
        $values["valign"] = $this->content_obj->getHorizontalAlign();
        $values["calign"] = $this->content_obj->getHorizontalAlign();
        $values["vbehavior"] = $this->content_obj->getBehavior();
        $values["hbehavior"] = $this->content_obj->getBehavior();

        $values["auto_time"] = $this->content_obj->getAutoTime();
        $values["rand_start"] = $this->content_obj->getRandomStart();

        $this->form->setValuesByArray($values);

        if ($values["type"] == ilPCTabs::ACCORDION_VER) {
            $va = $this->form->getItemByPostVar("vaccord_templ");
            $v = "t:" .
                ilObjStyleSheet::_lookupTemplateIdByName($this->getStyleId(), $this->content_obj->getTemplate()) . ":" .
                $this->content_obj->getTemplate();
            $va->setValue($v);
        }
        /*
        if ($values["type"] == ilPCTabs::ACCORDION_HOR) {
            $ha = $this->form->getItemByPostVar("haccord_templ");
            $v = "t:" .
                ilObjStyleSheet::_lookupTemplateIdByName($this->getStyleId(), $this->content_obj->getTemplate()) . ":" .
                $this->content_obj->getTemplate();
            $ha->setValue($v);
        }*/
        if ($values["type"] == ilPCTabs::CAROUSEL) {
            $ca = $this->form->getItemByPostVar("carousel_templ");
            $v = "t:" .
                ilObjStyleSheet::_lookupTemplateIdByName($this->getStyleId(), $this->content_obj->getTemplate()) . ":" .
                $this->content_obj->getTemplate();
            $ca->setValue($v);
        }
    }

    protected function checkWidthHeight(ilPropertyFormGUI $form): bool
    {
        $ok = true;
        if ($form->getInput("type") === ilPCTabs::ACCORDION_HOR) {
            if ($form->getInput("content_width") == "") {
                $form->getItemByPostVar("content_width")
                           ->setAlert($this->lng->txt("cont_hacc_needs_width"));
                $ok = false;
            }
            if ($form->getInput("content_height") == "") {
                $form->getItemByPostVar("content_height")
                           ->setAlert($this->lng->txt("cont_hacc_needs_height"));
                $ok = false;
            }
        }
        return $ok;
    }

    public function create(): void
    {
        $lng = $this->lng;

        $this->initForm("create");
        if ($this->form->checkInput() && $this->checkWidthHeight($this->form)) {
            $this->content_obj = new ilPCTabs($this->getPage());
            $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);

            $this->setPropertiesByForm();

            for ($i = 0; $i < $this->request->getInt("nr"); $i++) {
                $this->content_obj->addTab($lng->txt("cont_new_tab"));
            }

            $this->updated = $this->pg_obj->update();

            if ($this->updated === true) {
                $this->afterCreation();
            } else {
                $this->insert();
            }
        } else {
            $this->form->setValuesByPost();
            $this->insert(true);
        }
    }

    public function afterCreation(): void
    {
        $ilCtrl = $this->ctrl;

        $this->pg_obj->stripHierIDs();
        $this->pg_obj->addHierIDs();
        $ilCtrl->setParameter($this, "hier_id", $this->content_obj->readHierId());
        $ilCtrl->setParameter($this, "pc_id", $this->content_obj->readPCId());
        $this->content_obj->setHierId($this->content_obj->readHierId());
        $this->setHierId($this->content_obj->readHierId());
        $this->content_obj->setPcId($this->content_obj->readPCId());
        $this->edit();
    }

    public function setPropertiesByForm(): void
    {
        $c = $this->content_obj;
        $f = $this->form;

        $c->setTabType($f->getInput("type"));

        $c->setContentWidth((string) $f->getInput("content_width"));
        $c->setContentHeight((string) $f->getInput("content_height"));
        $c->setTemplate("");
        switch ($this->request->getString("type")) {
            case ilPCTabs::ACCORDION_VER:
                $t = explode(":", $f->getInput("vaccord_templ"));
                $c->setTemplate($t[2] ?? "");
                $c->setBehavior($f->getInput("vbehavior"));
                $c->setHorizontalAlign($f->getInput("valign"));
                break;

            case ilPCTabs::ACCORDION_HOR:
                $t = explode(":", $f->getInput("haccord_templ"));
                $c->setTemplate($t[2] ?? "");
                $c->setBehavior($f->getInput("hbehavior"));
                break;

            case ilPCTabs::CAROUSEL:
                $t = explode(":", $f->getInput("carousel_templ"));
                $c->setTemplate($t[2] ?? "");
                $c->setHorizontalAlign($f->getInput("calign"));
                $c->setAutoTime($f->getInput("auto_time"));
                $c->setRandomStart($f->getInput("rand_start"));
                break;
        }
    }

    public function update(): void
    {
        $this->initForm();
        $this->updated = false;
        if ($this->form->checkInput() && $this->checkWidthHeight($this->form)) {
            $this->setPropertiesByForm();
            $this->updated = $this->pg_obj->update();
        } else {
            $this->form->setValuesByPost();
            $this->editProperties(false);
            return;
        }
        if ($this->updated === true) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
            $this->ctrl->redirect($this, "editProperties");
        } else {
            $this->pg_obj->addHierIDs();
            $this->editProperties(false);
        }
    }

    public function edit(): void
    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $ilToolbar = $this->toolbar;
        $lng = $this->lng;

        $this->initEditor();
        $this->tabs->setBackTarget("", "");

        $tpl->setContent($this->getTabPanels() . $this->getEditorScriptTag($this->pc_id, "Tabs"));
    }

    public function saveTabs(): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $captions = $this->request->getStringArray("caption");
        $positions = $this->request->getStringArray("position");
        if (count($captions) > 0) {
            $this->content_obj->saveCaptions($captions);
        }
        if (count($positions)) {
            $this->content_obj->savePositions($positions);
        }
        $this->updated = $this->pg_obj->update();
        $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        $ilCtrl->redirect($this, "edit");
    }

    public function addTab(): void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $this->content_obj->addTab($lng->txt("cont_new_tab"));
        $this->updated = $this->pg_obj->update();

        $this->tpl->setOnScreenMessage('success', $lng->txt("cont_added_tab"), true);
        $ilCtrl->redirect($this, "edit");
    }

    public function confirmTabsDeletion(): void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;

        $this->setTabs();

        $tids = $this->request->getStringArray("tid");
        if (count($tids) == 0) {
            $this->tpl->setOnScreenMessage('info', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "edit");
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($ilCtrl->getFormAction($this));
            $cgui->setHeaderText($lng->txt("cont_tabs_confirm_deletion"));
            $cgui->setCancel($lng->txt("cancel"), "cancelTabDeletion");
            $cgui->setConfirm($lng->txt("delete"), "deleteTabs");

            foreach ($tids as $k => $i) {
                $id = explode(":", $k);
                $cgui->addItem(
                    "tid[]",
                    $k,
                    $this->content_obj->getCaption($id[0], $id[1])
                );
            }

            $tpl->setContent($cgui->getHTML());
        }
    }

    public function cancelTabDeletion(): void
    {
        $ilCtrl = $this->ctrl;
        $ilCtrl->redirect($this, "edit");
    }

    public function deleteTabs(): void
    {
        $ilCtrl = $this->ctrl;

        $tids = $this->request->getStringArray("tid");
        foreach ($tids as $tid) {
            $ids = explode(":", $tid);
            $this->content_obj->deleteTab($ids[0], $ids[1]);
        }
        $this->updated = $this->pg_obj->update();

        $ilCtrl->redirect($this, "edit");
    }

    public function setTabs(): void
    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $ilTabs->setBackTarget(
            $lng->txt("pg"),
            $this->ctrl->getParentReturn($this)
        );

        $ilTabs->addTarget(
            "cont_tabs",
            $ilCtrl->getLinkTarget($this, "edit"),
            "edit",
            get_class($this)
        );

        $ilTabs->addTarget(
            "cont_edit_tabs",
            $ilCtrl->getLinkTarget($this, "editProperties"),
            "editProperties",
            get_class($this)
        );
    }

    protected function getCaptionForm(string $caption = ""): \ILIAS\Repository\Form\FormAdapterGUI
    {
        return $this->gui->form([self::class], "saveCaption")
                          ->text("caption", $this->lng->txt("title"), "", $caption);
    }

    protected function getTabPanels(): string
    {
        $tabs = $this->content_obj;
        $items = [];
        $ui = $this->gui->ui();

        $actions = [
            $this->lng->txt("cont_tab_add_above") => "addAbove",
            $this->lng->txt("cont_tab_add_below") => "addBelow",
            $this->lng->txt("cont_tab_move_up") => "moveUp",
            $this->lng->txt("cont_tab_move_down") => "moveDown",
            $this->lng->txt("cont_tab_move_top") => "moveTop",
            $this->lng->txt("cont_tab_move_bottom") => "moveBottom",
            $this->lng->txt("cont_tab_delete") => "deletePanel"
        ];

        $captions = $tabs->getCaptions();
        $cnt = 1;
        foreach ($captions as $cap) {
            $this->ctrl->setParameter($this, "cap_pc_id", $cap["pc_id"]);
            $form = $this->getCaptionForm($cap["caption"]);
            $components = $this->gui->modal($this->lng->txt("cont_edit_title"))
                ->form($form)->getTriggerButtonComponents(
                    $this->lng->txt("cont_edit_title"),
                    true
                );
            $items[] = $components["modal"];
            $dd_items = [$components["button"]];
            foreach ($actions as $lng => $act) {
                if ($cnt === 1 && in_array($act, ["moveUp", "moveTop"])) {
                    continue;
                }
                if ($cnt === count($captions) && in_array($act, ["moveDown", "moveBottom"])) {
                    continue;
                }
                $dd_items[] = $ui->factory()->link()->standard(
                    $lng,
                    $this->ctrl->getLinkTarget($this, $act)
                );
            }
            $dd = $ui->factory()->dropdown()->standard($dd_items);
            $content = $this->getTabContent($cap["pc_id"]);
            $items[] = $ui->factory()->panel()->standard(
                $cap["caption"],
                $ui->factory()->legacy()->content($content)
            )
                ->withActions($dd);
            $cnt++;
        }

        return $ui->renderer()->render($items);
    }

    protected function getTabContent(string $pc_id): string
    {
        $tabs = $this->content_obj;
        $xml = $tabs->getNodeXml($pc_id);

        $xml = "<dummy>" . $xml . $this->getPage()->getMultimediaXML() . "</dummy>";

        $wb_path = ilFileUtils::getWebspaceDir("output") . "/";
        $params = array('mode' => "presentation", 'enlarge_path' => "#",
                        'fullscreen_link' => "#",
                        'pg_frame' => "", 'webspace_path' => $wb_path);
        $output = $this->xsl->process($xml, $params);

        $defs = $this->pc_def->getPCDefinitions();
        foreach ($defs as $def) {
            $pc_class = $def["pc_class"];
            $pc_obj = new $pc_class($this->getPage());

            // post xsl page content modification by pc elements
            $output = $pc_obj->modifyPageContentPostXsl($output, "presentation", false);
        }

        return $output;
    }

    protected function saveCaption(): void
    {
        $tabs = $this->content_obj;

        $form = $this->getCaptionForm();
        if ($form->isValid()) {
            $pc_id = $this->request->getString("cap_pc_id");
            $tabs->saveCaption($pc_id, $form->getData("caption"));
            $this->updated = $this->pg_obj->update();
        }
        $this->ctrl->redirect($this, "edit");
    }

    protected function addAbove(): void
    {
        $tabs = $this->content_obj;
        $pc_id = $this->request->getString("cap_pc_id");
        $tabs->addAbove($pc_id, $this->lng->txt("cont_new_tab"));
        $this->updated = $this->pg_obj->update();
        $this->ctrl->redirect($this, "edit");
    }

    protected function addBelow(): void
    {
        $tabs = $this->content_obj;
        $pc_id = $this->request->getString("cap_pc_id");
        $tabs->addBelow($pc_id, $this->lng->txt("cont_new_tab"));
        $this->updated = $this->pg_obj->update();
        $this->ctrl->redirect($this, "edit");
    }

    protected function moveUp(): void
    {
        $tabs = $this->content_obj;
        $pc_id = $this->request->getString("cap_pc_id");
        $tabs->moveUp($pc_id);
        $this->updated = $this->pg_obj->update();
        $this->ctrl->redirect($this, "edit");
    }

    protected function moveDown(): void
    {
        $tabs = $this->content_obj;
        $pc_id = $this->request->getString("cap_pc_id");
        $tabs->moveDown($pc_id);
        $this->updated = $this->pg_obj->update();
        $this->ctrl->redirect($this, "edit");
    }

    protected function moveTop(): void
    {
        $tabs = $this->content_obj;
        $pc_id = $this->request->getString("cap_pc_id");
        $tabs->moveTop($pc_id);
        $this->updated = $this->pg_obj->update();
        $this->ctrl->redirect($this, "edit");
    }

    protected function moveBottom(): void
    {
        $tabs = $this->content_obj;
        $pc_id = $this->request->getString("cap_pc_id");
        $tabs->moveBottom($pc_id);
        $this->updated = $this->pg_obj->update();
        $this->ctrl->redirect($this, "edit");
    }

    protected function deletePanel(): void
    {
        $tabs = $this->content_obj;
        $pc_id = $this->request->getString("cap_pc_id");
        $tabs->deletePanel($pc_id);
        $this->updated = $this->pg_obj->update();
        $this->ctrl->redirect($this, "edit");
    }

}