ilCloudPluginSettingsGUI Class Reference

Class ilCloudPluginSettingsGUI. More...

Inheritance diagram for ilCloudPluginSettingsGUI:

Collaboration diagram for ilCloudPluginSettingsGUI:

Public Member Functions
	setCloudObject (ilObjCloud $object)
	editSettings ()
	Edit Settings. More...
	initSettingsForm ()
	getSettingsValues ()
	Get values for edit Settings form. More...
	updateSettings ()
	Update Settings. More...
Public Member Functions inherited from ilCloudPluginGUI
	__construct ($plugin_service_class)
	getPluginObject ()
	getPluginHookObject ()
	getAdminConfigObject ()
	getService ()
	txt ($var="")
	executeCommand ()

Protected Member Functions
	createPluginSection ()
	initPluginSettings ()
	getMakeOwnPluginSection ()
	getPluginSettingsValues (&$values)
	updatePluginSettings ()

Protected Attributes
	$cloud_object
	$form
Protected Attributes inherited from ilCloudPluginGUI
	$service = null

Detailed Description

Class ilCloudPluginSettingsGUI.

Base class for the settings. Needs to be overwritten if the plugin needs custom settings.

Author

Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version

$Id:

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

Member Function Documentation

createPluginSection()

ilCloudPluginSettingsGUI::createPluginSection ( )

protected

Definition at line 96 of file class.ilCloudPluginSettingsGUI.php.

References $DIC, $lng, $section, and getMakeOwnPluginSection().

Referenced by initSettingsForm().

    {
        if (get_class($this) != "ilCloudPluginSettingsGUI" && $this->getMakeOwnPluginSection()) {
            global $DIC;
            $lng = $DIC['lng'];
            $section = new ilFormSectionHeaderGUI();
            $section->setTitle($this->cloud_object->getServiceName() . " " . $lng->txt("cld_service_specific_settings"));
            $this->form->addItem($section);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editSettings()

ilCloudPluginSettingsGUI::editSettings

(

)

Edit Settings.

This commands uses the form class to display an input form.

Definition at line 39 of file class.ilCloudPluginSettingsGUI.php.

References $DIC, $lng, $tpl, getSettingsValues(), initSettingsForm(), and ilUtil\sendFailure().

    {
        global $DIC;
        $tpl = $DIC['tpl'];
        $ilTabs = $DIC['ilTabs'];
        $lng = $DIC['lng'];

        $ilTabs->activateTab("settings");

        try {
            $this->initSettingsForm();
            $this->getSettingsValues();
            $tpl->setContent($this->form->getHTML());
        } catch (Exception $e) {
            ilUtil::sendFailure($e->getMessage());
        }
    }

Here is the call graph for this function:

getMakeOwnPluginSection()

ilCloudPluginSettingsGUI::getMakeOwnPluginSection ( )

protected

Definition at line 111 of file class.ilCloudPluginSettingsGUI.php.

Referenced by createPluginSection().

    {
        return true;
    }

Here is the caller graph for this function:

getPluginSettingsValues()

ilCloudPluginSettingsGUI::getPluginSettingsValues ( &  $values )

protected

Definition at line 130 of file class.ilCloudPluginSettingsGUI.php.

Referenced by getSettingsValues().

    {
    }

Here is the caller graph for this function:

getSettingsValues()

ilCloudPluginSettingsGUI::getSettingsValues

(

)

Get values for edit Settings form.

Definition at line 119 of file class.ilCloudPluginSettingsGUI.php.

References getPluginSettingsValues().

Referenced by editSettings().

    {
        $values["title"]       = $this->cloud_object->getTitle();
        $values["desc"]        = $this->cloud_object->getDescription();
        $values["online"]      = $this->cloud_object->getOnline();
        $values["root_folder"] = $this->cloud_object->getRootFolder();
        $this->getPluginSettingsValues($values);
        $this->form->setValuesByArray($values);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initPluginSettings()

ilCloudPluginSettingsGUI::initPluginSettings ( )

protected

Definition at line 107 of file class.ilCloudPluginSettingsGUI.php.

Referenced by initSettingsForm().

    {
    }

Here is the caller graph for this function:

initSettingsForm()

ilCloudPluginSettingsGUI::initSettingsForm

(

)

Definition at line 57 of file class.ilCloudPluginSettingsGUI.php.

References $DIC, $ilCtrl, $lng, createPluginSection(), initPluginSettings(), ilFormPropertyGUI\setDisabled(), and ilFormPropertyGUI\setRequired().

Referenced by editSettings(), and updateSettings().

    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];

        $this->form = new ilPropertyFormGUI();

        // title
        $ti = new ilTextInputGUI($lng->txt("title"), "title");
        $ti->setRequired(true);
        $this->form->addItem($ti);

        // description
        $ta = new ilTextAreaInputGUI($lng->txt("description"), "desc");
        $this->form->addItem($ta);

        // online
        $cb = new ilCheckboxInputGUI($lng->txt("online"), "online");
        $this->form->addItem($cb);

        $folder = new ilTextInputGUI($lng->txt("cld_root_folder"), "root_folder");
        if (!$this->cloud_object->currentUserIsOwner()) {
            $folder->setDisabled(true);
            $folder->setInfo($lng->txt("cld_only_owner_has_permission_to_change_root_path"));
        }

        $folder->setMaxLength(255);
        $folder->setSize(50);
        $this->form->addItem($folder);

        $this->createPluginSection();
        $this->initPluginSettings();

        $this->form->addCommandButton("updateSettings", $lng->txt("save"));

        $this->form->setTitle($lng->txt("cld_edit_Settings"));
        $this->form->setFormAction($ilCtrl->getFormActionByClass("ilCloudPluginSettingsGUI"));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCloudObject()

ilCloudPluginSettingsGUI::setCloudObject

(

ilObjCloud

$object

)

Definition at line 31 of file class.ilCloudPluginSettingsGUI.php.

    {
        $this->cloud_object = $object;
    }

updatePluginSettings()

ilCloudPluginSettingsGUI::updatePluginSettings ( )

protected

Definition at line 169 of file class.ilCloudPluginSettingsGUI.php.

Referenced by updateSettings().

    {
    }

Here is the caller graph for this function:

updateSettings()

ilCloudPluginSettingsGUI::updateSettings

(

)

Update Settings.

Definition at line 136 of file class.ilCloudPluginSettingsGUI.php.

References $DIC, $ilCtrl, $lng, $tpl, ilCloudPluginGUI\getService(), initSettingsForm(), ilCloudUtil\normalizePath(), ilUtil\sendFailure(), ilUtil\sendSuccess(), and updatePluginSettings().

    {
        global $DIC;
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        $ilTabs = $DIC['ilTabs'];

        $ilTabs->activateTab("settings");

        try {
            $this->initSettingsForm();
            if ($this->form->checkInput()) {
                $this->cloud_object->setTitle($this->form->getInput("title"));
                $this->cloud_object->setDescription($this->form->getInput("desc"));
                $this->updatePluginSettings();
                if (ilCloudUtil::normalizePath($this->form->getInput("root_folder")) != $this->cloud_object->getRootFolder()) {
                    $this->cloud_object->setRootFolder($this->form->getInput("root_folder"));
                    $this->cloud_object->setRootId($this->getService()->getRootId($this->cloud_object->getRootFolder()));
                }

                $this->cloud_object->setOnline($this->form->getInput("online"));
                $this->cloud_object->update();
                ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
                $ilCtrl->redirect($this, 'editSettings');
            }
        } catch (Exception $e) {
            ilUtil::sendFailure($e->getMessage());
        }

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

Here is the call graph for this function:

Field Documentation

$cloud_object

ilCloudPluginSettingsGUI::$cloud_object

protected

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

$form

ilCloudPluginSettingsGUI::$form

protected

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

---

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

• Modules/Cloud/classes/class.ilCloudPluginSettingsGUI.php