ilSettingsTemplateGUI Class Reference

Settings template. More...

Collaboration diagram for ilSettingsTemplateGUI:

Public Member Functions
	__construct ($a_config)
	Constructor. More...
	executeCommand ()
	Execute command. More...
	setConfig ($a_val)
	Set config object. More...
	getConfig ()
	Get config object. More...
	readSettingsTemplate ()
	Read settings template. More...
	listSettingsTemplates ()
	List all settings template. More...
	addSettingsTemplate ()
	Add settings template. More...
	editSettingsTemplate ()
	Edit settings template. More...
	initSettingsTemplateForm ($a_mode="edit")
	Init settings template form. More...
	getSettingsTemplateValues ()
	Get current values for settings template from. More...
	saveSettingsTemplate ()
	Save settings template form. More...
	updateSettingsTemplate ()
	Update settings template. More...
	setValuesFromForm ($a_set_templ)
	Set values from form. More...
	confirmSettingsTemplateDeletion ()
	Confirm settings template deletion. More...
	deleteSettingsTemplate ()
	Delete settings template. More...

Protected Attributes
	$ctrl
	$tpl
	$toolbar
	$lng

Private Attributes
	$config

Detailed Description

Settings template.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilSettingsTemplateGUI::__construct

(

$a_config

)

Constructor.

Parameters

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

References $DIC, $ilCtrl, array, readSettingsTemplate(), and setConfig().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC["tpl"];
        $this->toolbar = $DIC->toolbar();
        $this->lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();

        $ilCtrl->saveParameter($this, array("templ_id"));

        $this->setConfig($a_config);

        $this->readSettingsTemplate();
    }

Here is the call graph for this function:

Member Function Documentation

addSettingsTemplate()

ilSettingsTemplateGUI::addSettingsTemplate

(

)

Add settings template.

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

References $tpl, and initSettingsTemplateForm().

    {
        $tpl = $this->tpl;

        $this->initSettingsTemplateForm("create");
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

confirmSettingsTemplateDeletion()

ilSettingsTemplateGUI::confirmSettingsTemplateDeletion

(

)

Confirm settings template deletion.

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

References $_POST, $ctrl, $i, $ilCtrl, $lng, $tpl, ilSettingsTemplate\lookupTitle(), and ilUtil\sendInfo().

    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;

        if (!is_array($_POST["tid"]) || count($_POST["tid"]) == 0) {
            ilUtil::sendInfo($lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "listSettingsTemplates");
        } else {
            include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
            $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 ($_POST["tid"] as $i) {
                $cgui->addItem("tid[]", $i, ilSettingsTemplate::lookupTitle($i));
            }

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

Here is the call graph for this function:

deleteSettingsTemplate()

ilSettingsTemplateGUI::deleteSettingsTemplate

(

)

Delete settings template.

Parameters

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

References $_POST, $ctrl, $i, $ilCtrl, $lng, and ilUtil\sendSuccess().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        if (is_array($_POST["tid"])) {
            foreach ($_POST["tid"] as $i) {
                $templ = new ilSettingsTemplate($i);
                $templ->delete();
            }
        }
        ilUtil::sendSuccess("msg_obj_modified");
        $ilCtrl->redirect($this, "listSettingsTemplates");
    }

Here is the call graph for this function:

editSettingsTemplate()

ilSettingsTemplateGUI::editSettingsTemplate

(

)

Edit settings template.

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

References $tpl, getSettingsTemplateValues(), and initSettingsTemplateForm().

    {
        $tpl = $this->tpl;

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

Here is the call graph for this function:

executeCommand()

ilSettingsTemplateGUI::executeCommand

(

)

Execute command.

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

References $ctrl, and $ilCtrl.

    {
        $ilCtrl = $this->ctrl;

        $cmd = $ilCtrl->getCmd("listSettingsTemplates");
        $this->$cmd();
    }

getConfig()

ilSettingsTemplateGUI::getConfig

(

)

Get config object.

Returns

object config object

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

References $config.

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

    {
        return $this->config;
    }

Here is the caller graph for this function:

getSettingsTemplateValues()

ilSettingsTemplateGUI::getSettingsTemplateValues

(

)

Get current values for settings template from.

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

References $s, $t, $tabs, array, ilSettingsTemplateConfig\CHECKBOX, and getConfig().

Referenced by editSettingsTemplate().

    {
        $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"]);
                    } 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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initSettingsTemplateForm()

ilSettingsTemplateGUI::initSettingsTemplateForm

(

$a_mode = "edit"

)

Init settings template form.

Parameters

int

$a_mode

Edit Mode

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

References $ctrl, $ilCtrl, $key, $lng, $s, $si, $t, $tabs, ilCheckboxGroupInputGUI\addOption(), ilSubEnabledFormPropertyGUI\addSubItem(), ilSettingsTemplateConfig\BOOL, ilSettingsTemplateConfig\CHECKBOX, getConfig(), ilSettingsTemplateConfig\SELECT, ilFormPropertyGUI\setDisabled(), ilTextInputGUI\setMaxLength(), and ilSettingsTemplateConfig\TEXT.

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $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);
                }
            }
        }

        // 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));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listSettingsTemplates()

ilSettingsTemplateGUI::listSettingsTemplates

(

)

List all settings template.

Parameters

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

References $ctrl, $ilCtrl, $lng, $table, $toolbar, $tpl, and getConfig().

    {
        $tpl = $this->tpl;
        $ilToolbar = $this->toolbar;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $ilToolbar->addButton(
            $lng->txt("adm_add_settings_template"),
            $ilCtrl->getLinkTarget($this, "addSettingsTemplate")
        );

        include_once("./Services/Administration/classes/class.ilSettingsTemplateTableGUI.php");
        $table = new ilSettingsTemplateTableGUI(
            $this,
            "listSettingsTemplates",
            $this->getConfig()->getType()
        );

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

Here is the call graph for this function:

readSettingsTemplate()

ilSettingsTemplateGUI::readSettingsTemplate

(

)

Read settings template.

Parameters

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

References $_GET, and getConfig().

Referenced by __construct().

    {
        if ($this->getConfig()) {
            $this->settings_template = new ilSettingsTemplate((int) $_GET["templ_id"], $this->getConfig());
        } else {
            $this->settings_template = new ilSettingsTemplate((int) $_GET["templ_id"]);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveSettingsTemplate()

ilSettingsTemplateGUI::saveSettingsTemplate

(

)

Save settings template form.

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

References $ctrl, $ilCtrl, $lng, $tpl, getConfig(), initSettingsTemplateForm(), ilUtil\sendSuccess(), and setValuesFromForm().

    {
        $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();

            ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
            $ilCtrl->redirect($this, "listSettingsTemplates");
        }

        $this->form->setValuesByPost();
        $tpl->setContent($this->form->getHtml());
    }

Here is the call graph for this function:

setConfig()

ilSettingsTemplateGUI::setConfig

(

$a_val

)

Set config object.

Parameters

object

$a_val

config object

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

Referenced by __construct().

    {
        $this->config = $a_val;
    }

Here is the caller graph for this function:

setValuesFromForm()

ilSettingsTemplateGUI::setValuesFromForm

(

$a_set_templ

)

Set values from form.

Parameters

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

References $_POST, $s, $t, and getConfig().

Referenced by saveSettingsTemplate(), and updateSettingsTemplate().

    {
        // perform update
        $a_set_templ->setTitle($_POST["title"]);
        $a_set_templ->setDescription($_POST["description"]);

        // save tabs to be hidden
        $a_set_templ->removeAllHiddenTabs();
        foreach ($this->getConfig()->getHidableTabs() as $t) {
            if ($_POST["tab_" . $t["id"]]) {
                $a_set_templ->addHiddenTab($t["id"]);
            }
        }

        // save settings values
        $a_set_templ->removeAllSettings();
        foreach ($this->getConfig()->getSettings() as $s) {
            if ($_POST["set_" . $s["id"]]) {
                $a_set_templ->setSetting(
                    $s["id"],
                    $_POST["value_" . $s["id"]],
                    $_POST["hide_" . $s["id"]]
                );
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateSettingsTemplate()

ilSettingsTemplateGUI::updateSettingsTemplate

(

)

Update settings template.

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

References $ctrl, $ilCtrl, $lng, $tpl, initSettingsTemplateForm(), ilUtil\sendSuccess(), and setValuesFromForm().

    {
        $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();

            ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
            $ilCtrl->redirect($this, "listSettingsTemplates");
        }

        $this->form->setValuesByPost();
        $tpl->setContent($this->form->getHtml());
    }

Here is the call graph for this function:

Field Documentation

$config

ilSettingsTemplateGUI::$config

private

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

Referenced by getConfig().

$ctrl

ilSettingsTemplateGUI::$ctrl

protected

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

Referenced by confirmSettingsTemplateDeletion(), deleteSettingsTemplate(), executeCommand(), initSettingsTemplateForm(), listSettingsTemplates(), saveSettingsTemplate(), and updateSettingsTemplate().

$lng

ilSettingsTemplateGUI::$lng

protected

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

Referenced by confirmSettingsTemplateDeletion(), deleteSettingsTemplate(), initSettingsTemplateForm(), listSettingsTemplates(), saveSettingsTemplate(), and updateSettingsTemplate().

$toolbar

ilSettingsTemplateGUI::$toolbar

protected

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

Referenced by listSettingsTemplates().

$tpl

ilSettingsTemplateGUI::$tpl

protected

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

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

---

The documentation for this class was generated from the following file:

• Services/Administration/classes/class.ilSettingsTemplateGUI.php