Settings template. More...

Collaboration diagram for ilSettingsTemplateGUI:

Public Member Functions
	executeCommand ()

	setConfig (ilSettingsTemplateConfig $a_val)

	getConfig ()

	readSettingsTemplate ()

	listSettingsTemplates ()

	addSettingsTemplate ()

	editSettingsTemplate ()

	initSettingsTemplateForm (string $a_mode="edit")

	getSettingsTemplateValues ()

	saveSettingsTemplate ()

	updateSettingsTemplate ()

	setValuesFromForm (ilSettingsTemplate $a_set_templ)

	confirmSettingsTemplateDeletion ()

	deleteSettingsTemplate ()

Protected Attributes
ilCtrlInterface	$ctrl

ilGlobalTemplateInterface	$tpl

ilToolbarGUI	$toolbar

ilLanguage	$lng

ILIAS DI Container	$dic

ilRbacSystem	$rbacsystem

ilPropertyFormGUI	$form

ilSettingsTemplate	$settings_template

SettingsTemplateGUIRequest	$request

Private Attributes
ilSettingsTemplateConfig	$config

Detailed Description

Settings template.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 28 of file class.ilSettingsTemplateGUI.php.

Member Function Documentation

◆ addSettingsTemplate()

ilSettingsTemplateGUI::addSettingsTemplate ( )

Definition at line 120 of file class.ilSettingsTemplateGUI.php.

                                         : void
    {
        $tpl = $this->tpl;
 
        $this->initSettingsTemplateForm("create");
        $tpl->setContent($this->form->getHTML());
    }

References $tpl, ILIAS\Repository\form(), initSettingsTemplateForm(), and ilGlobalTemplateInterface\setContent().

Here is the call graph for this function:

◆ confirmSettingsTemplateDeletion()

ilSettingsTemplateGUI::confirmSettingsTemplateDeletion ( )

Definition at line 347 of file class.ilSettingsTemplateGUI.php.

                                                     : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;
 
        if (count($this->request->getTemplateIds()) === 0) {
            $this->tpl->setOnScreenMessage('info', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "listSettingsTemplates");
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($ilCtrl->getFormAction($this));
            $cgui->setHeaderText($lng->txt("adm_sure_delete_settings_template"));
            $cgui->setCancel($lng->txt("cancel"), "listSettingsTemplates");
            $cgui->setConfirm($lng->txt("delete"), "deleteSettingsTemplate");
 
            foreach ($this->request->getTemplateIds() as $i) {
                $cgui->addItem("tid[]", (string) $i, ilSettingsTemplate::lookupTitle($i));
            }
 
            $tpl->setContent($cgui->getHTML());
        }
    }

References $ctrl, $i, $lng, $tpl, ilSettingsTemplate\lookupTitle(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

Here is the call graph for this function:

◆ deleteSettingsTemplate()

ilSettingsTemplateGUI::deleteSettingsTemplate ( )

Definition at line 371 of file class.ilSettingsTemplateGUI.php.

                                            : void
    {
        $ilCtrl = $this->ctrl;
 
        foreach ($this->request->getTemplateIds() as $i) {
            $templ = new ilSettingsTemplate($i);
            $templ->delete();
        }
        $this->tpl->setOnScreenMessage('success', "msg_obj_modified");
        $ilCtrl->redirect($this, "listSettingsTemplates");
    }

References $ctrl, and $i.

◆ editSettingsTemplate()

ilSettingsTemplateGUI::editSettingsTemplate ( )

Definition at line 128 of file class.ilSettingsTemplateGUI.php.

                                          : void
    {
        $tpl = $this->tpl;
 
        $this->initSettingsTemplateForm("edit");
        $this->getSettingsTemplateValues();
        $tpl->setContent($this->form->getHTML());
    }

References $tpl, ILIAS\Repository\form(), getSettingsTemplateValues(), initSettingsTemplateForm(), and ilGlobalTemplateInterface\setContent().

Here is the call graph for this function:

◆ executeCommand()

ilSettingsTemplateGUI::executeCommand ( )

Definition at line 65 of file class.ilSettingsTemplateGUI.php.

                                    : void
    {
        $ilCtrl = $this->ctrl;
 
        $cmd = $ilCtrl->getCmd("listSettingsTemplates");
        $this->$cmd();
    }

References $ctrl, and ilCtrlInterface\getCmd().

Here is the call graph for this function:

◆ getConfig()

ilSettingsTemplateGUI::getConfig ( )

Definition at line 78 of file class.ilSettingsTemplateGUI.php.

                               : ilSettingsTemplateConfig
    {
        return $this->config;
    }

References $config.

Referenced by getSettingsTemplateValues(), initSettingsTemplateForm(), listSettingsTemplates(), readSettingsTemplate(), saveSettingsTemplate(), and setValuesFromForm().

Here is the caller graph for this function:

◆ getSettingsTemplateValues()

ilSettingsTemplateGUI::getSettingsTemplateValues ( )

Definition at line 243 of file class.ilSettingsTemplateGUI.php.

                                               : void
    {
        $values = array();
 
        $values["title"] = $this->settings_template->getTitle();
        $values["description"] = $this->settings_template->getDescription();
 
        // save tabs to be hidden
        $tabs = $this->settings_template->getHiddenTabs();
        foreach ($tabs as $t) {
            $values["tab_" . $t] = true;
        }
 
        // save settings values
        $set = $this->settings_template->getSettings();
        foreach ($this->getConfig()->getSettings() as $s) {
            if (isset($set[$s["id"]])) {
                $values["set_" . $s["id"]] = true;
 
                if ($s['type'] === ilSettingsTemplateConfig::CHECKBOX) {
                    if (!is_array($set[$s["id"]]["value"])) {
                        $ar = unserialize($set[$s["id"]]["value"], ['allowed_classes' => false]);
                    } else {
                        $ar = $set[$s["id"]]["value"];
                    }
                    $values["value_" . $s["id"]] = is_array($ar) ? $ar : array();
                } else {
                    $values["value_" . $s["id"]] = $set[$s["id"]]["value"];
                }
 
                $values["hide_" . $s["id"]] = $set[$s["id"]]["hide"];
            }
        }
        $this->form->setValuesByArray($values);
    }

References ilSettingsTemplateConfig\CHECKBOX, ILIAS\Repository\form(), getConfig(), and ILIAS\LTI\ToolProvider\getSettings().

Referenced by editSettingsTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSettingsTemplateForm()

ilSettingsTemplateGUI::initSettingsTemplateForm ( string $a_mode = "edit" )

Definition at line 137 of file class.ilSettingsTemplateGUI.php.

                                                                     : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $this->form = new ilPropertyFormGUI();
 
        // title
        $ti = new ilTextInputGUI($lng->txt("title"), "title");
        $ti->setMaxLength(200);
        $ti->setRequired(true);
        // begin-patch lok
        if ($this->settings_template->getAutoGenerated()) {
            $ti->setDisabled(true);
        }
        // end-patch lok
        $this->form->addItem($ti);
 
        // description
        $ti = new ilTextAreaInputGUI($lng->txt("description"), "description");
        // begin-patch lok
        if ($this->settings_template->getAutoGenerated()) {
            $ti->setDisabled(true);
        }
        $this->form->addItem($ti);
 
        // hidable tabs
        $tabs = $this->getConfig()->getHidableTabs();
        if (is_array($tabs) && count($tabs) > 0) {
            $sec = new ilFormSectionHeaderGUI();
            $sec->setTitle($lng->txt("adm_hide_tabs"));
            $this->form->addItem($sec);
 
            foreach ($tabs as $t) {
                // hide tab $t?
                $cb = new ilCheckboxInputGUI($t["text"], "tab_" . $t["id"]);
                $this->form->addItem($cb);
            }
        }
 
        // settings
        $settings = $this->getConfig()->getSettings();
        if (is_array($settings) && count($settings) > 0) {
            $sec = new ilFormSectionHeaderGUI();
            $sec->setTitle($lng->txt("adm_predefined_settings"));
            $this->form->addItem($sec);
 
            foreach ($settings as $s) {
                // setting
                $cb = new ilCheckboxInputGUI($s["text"], "set_" . $s["id"]);
                $this->form->addItem($cb);
 
                switch ($s["type"]) {
                    case ilSettingsTemplateConfig::TEXT:
 
                        $ti = new ilTextInputGUI($lng->txt("adm_value"), "value_" . $s["id"]);
                        //$ti->setMaxLength();
                        //$ti->setSize();
                        $cb->addSubItem($ti);
                        break;
 
                    case ilSettingsTemplateConfig::BOOL:
                        $cb2 = new ilCheckboxInputGUI($lng->txt("adm_value"), "value_" . $s["id"]);
                        $cb->addSubItem($cb2);
                        break;
 
                    case ilSettingsTemplateConfig::SELECT:
                        $si = new ilSelectInputGUI($lng->txt("adm_value"), "value_" . $s["id"]);
                        $si->setOptions($s["options"]);
                        $cb->addSubItem($si);
                        break;
 
                                        case ilSettingsTemplateConfig::CHECKBOX:
                                                $chbs = new ilCheckboxGroupInputGUI($lng->txt("adm_value"), "value_" . $s["id"]);
                                                foreach ($s['options'] as $key => $value) {
                                                    $chbs->addOption($c = new ilCheckboxInputGUI($value, $key));
                                                    $c->setValue($key);
                                                }
                                                $cb->addSubItem($chbs);
                                                break;
                }
 
                if ($s['hidable']) {
                    // hide setting
                    $cb_hide = new ilCheckboxInputGUI($lng->txt("adm_hide"), "hide_" . $s["id"]);
                    $cb->addSubItem($cb_hide);
                }
            }
        }
 
        if ($this->rbacsystem->checkAccess('write', $this->request->getRefId())) {
            // save and cancel commands
            if ($a_mode === "create") {
                $this->form->addCommandButton("saveSettingsTemplate", $lng->txt("save"));
                $this->form->addCommandButton("listSettingsTemplates", $lng->txt("cancel"));
                $this->form->setTitle($lng->txt("adm_add_settings_template"));
            } else {
                $this->form->addCommandButton("updateSettingsTemplate", $lng->txt("save"));
                $this->form->addCommandButton("listSettingsTemplates", $lng->txt("cancel"));
                $this->form->setTitle($lng->txt("adm_edit_settings_template"));
            }
        }
 
        $this->form->setFormAction($ilCtrl->getFormAction($this));
    }

References $c, $ctrl, ILIAS\LTI\ToolProvider\$key, $lng, ILIAS\LTI\ToolProvider\$settings, ilSettingsTemplateConfig\BOOL, ilSettingsTemplateConfig\CHECKBOX, ILIAS\Repository\form(), getConfig(), ilSettingsTemplateConfig\SELECT, ilSettingsTemplateConfig\TEXT, and ilLanguage\txt().

Referenced by addSettingsTemplate(), editSettingsTemplate(), saveSettingsTemplate(), and updateSettingsTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listSettingsTemplates()

ilSettingsTemplateGUI::listSettingsTemplates ( )

Definition at line 97 of file class.ilSettingsTemplateGUI.php.

                                           : void
    {
        $tpl = $this->tpl;
        $ilToolbar = $this->toolbar;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        if ($this->rbacsystem->checkAccess('write', $this->request->getRefId())) {
            $ilToolbar->addButton(
                $lng->txt("adm_add_settings_template"),
                $ilCtrl->getLinkTarget($this, "addSettingsTemplate")
            );
        }
 
        $table = new ilSettingsTemplateTableGUI(
            $this,
            "listSettingsTemplates",
            $this->getConfig()->getType()
        );
 
        $tpl->setContent($table->getHTML());
    }

References $ctrl, $lng, $toolbar, $tpl, getConfig(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

Here is the call graph for this function:

◆ readSettingsTemplate()

ilSettingsTemplateGUI::readSettingsTemplate ( )

Definition at line 83 of file class.ilSettingsTemplateGUI.php.

                                          : void
    {
        if ($this->getConfig()) {
            $this->settings_template = new ilSettingsTemplate(
                $this->request->getTemplateId(),
                $this->getConfig()
            );
        } else {
            $this->settings_template = new ilSettingsTemplate(
                $this->request->getTemplateId()
            );
        }
    }

References getConfig().

Here is the call graph for this function:

◆ saveSettingsTemplate()

ilSettingsTemplateGUI::saveSettingsTemplate ( )

Definition at line 279 of file class.ilSettingsTemplateGUI.php.

                                          : void
    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $this->initSettingsTemplateForm("create");
        if ($this->form->checkInput()) {
            $settings_template = new ilSettingsTemplate();
            $settings_template->setType($this->getConfig()->getType());
 
            $this->setValuesFromForm($settings_template);
            $settings_template->create();
 
            $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
            $ilCtrl->redirect($this, "listSettingsTemplates");
        }
 
        $this->form->setValuesByPost();
        $tpl->setContent($this->form->getHTML());
    }

References $ctrl, $lng, $settings_template, $tpl, ilSettingsTemplate\create(), ILIAS\Repository\form(), getConfig(), initSettingsTemplateForm(), ilGlobalTemplateInterface\setContent(), ilSettingsTemplate\setType(), setValuesFromForm(), and ilLanguage\txt().

Here is the call graph for this function:

◆ setConfig()

ilSettingsTemplateGUI::setConfig ( ilSettingsTemplateConfig $a_val )

Definition at line 73 of file class.ilSettingsTemplateGUI.php.

                                                              : void
    {
        $this->config = $a_val;
    }

◆ setValuesFromForm()

ilSettingsTemplateGUI::setValuesFromForm ( ilSettingsTemplate $a_set_templ )

Definition at line 320 of file class.ilSettingsTemplateGUI.php.

                                                                      : void
    {
        // perform update
        $a_set_templ->setTitle($this->form->getInput("title"));
        $a_set_templ->setDescription($this->form->getInput("description"));
 
        // save tabs to be hidden
        $a_set_templ->removeAllHiddenTabs();
        foreach ($this->getConfig()->getHidableTabs() as $t) {
            if ($this->request->getTab($t["id"])) {
                $a_set_templ->addHiddenTab($t["id"]);
            }
        }
 
        // save settings values
        $a_set_templ->removeAllSettings();
        foreach ($this->getConfig()->getSettings() as $s) {
            if ($this->request->getSetting($s["id"])) {
                $a_set_templ->setSetting(
                    $s["id"],
                    $this->request->getValue($s["id"]),
                    $this->request->getHide($s["id"])
                );
            }
        }
    }

References ilSettingsTemplate\addHiddenTab(), ILIAS\Repository\form(), getConfig(), ILIAS\LTI\ToolProvider\getSettings(), ilSettingsTemplate\removeAllHiddenTabs(), ilSettingsTemplate\removeAllSettings(), ilSettingsTemplate\setDescription(), ilSettingsTemplate\setSetting(), and ilSettingsTemplate\setTitle().

Referenced by saveSettingsTemplate(), and updateSettingsTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateSettingsTemplate()

ilSettingsTemplateGUI::updateSettingsTemplate ( )

Definition at line 301 of file class.ilSettingsTemplateGUI.php.

                                            : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
 
        $this->initSettingsTemplateForm("edit");
        if ($this->form->checkInput()) {
            $this->setValuesFromForm($this->settings_template);
            $this->settings_template->update();
 
            $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
            $ilCtrl->redirect($this, "listSettingsTemplates");
        }
 
        $this->form->setValuesByPost();
        $tpl->setContent($this->form->getHTML());
    }