ilFileCommonSettingsGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilFileCommonSettingsGUI:

Public Member Functions
	__construct (protected ilObjFile $object, protected ilCtrl $ctrl, protected ilGlobalTemplateInterface $tpl, protected ilLanguage $lng, protected ilObjectService $object_service)
	executeCommand ()

Data Fields
const	CMD_EDIT = 'editSettings'
const	CMD_SAVE = 'saveSettings'

Protected Member Functions
	editSettings (?ilPropertyFormGUI $form=null)
	buildForm ()
	addServiceSettingsToForm (ilPropertyFormGUI $form)
	addCommonFieldsToForm (ilPropertyFormGUI $form)
	saveSettings ()
	txt (string $code)

Private Attributes
array	$services

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 22 of file class.ilFileCommonSettingsGUI.php.

Constructor & Destructor Documentation

__construct()

ilFileCommonSettingsGUI::__construct	(	protected ilObjFile	$object,
		protected ilCtrl	$ctrl,
		protected ilGlobalTemplateInterface	$tpl,
		protected ilLanguage	$lng,
		protected ilObjectService	$object_service
	)

Definition at line 30 of file class.ilFileCommonSettingsGUI.php.

    {
    }

Member Function Documentation

addCommonFieldsToForm()

ilFileCommonSettingsGUI::addCommonFieldsToForm ( ilPropertyFormGUI  $form )

protected

Definition at line 75 of file class.ilFileCommonSettingsGUI.php.

Referenced by buildForm().

                                                                     : void
    {
        //
    }

Here is the caller graph for this function:

addServiceSettingsToForm()

ilFileCommonSettingsGUI::addServiceSettingsToForm ( ilPropertyFormGUI  $form )

protected

Definition at line 66 of file class.ilFileCommonSettingsGUI.php.

References $services, ilObjectServiceSettingsGUI\initServiceSettingsForm(), and ILIAS\Repository\object().

Referenced by buildForm().

                                                                        : void
    {
        ilObjectServiceSettingsGUI::initServiceSettingsForm(
            $this->object->getId(),
            $form,
            $this->services
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildForm()

ilFileCommonSettingsGUI::buildForm ( )

protected

Definition at line 52 of file class.ilFileCommonSettingsGUI.php.

References addCommonFieldsToForm(), addServiceSettingsToForm(), ILIAS\Repository\ctrl(), and txt().

Referenced by editSettings(), and saveSettings().

                                  : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->txt('obj_features'));
        $form->addCommandButton(self::CMD_SAVE, $this->txt('save'));
        $form->addCommandButton(self::CMD_EDIT, $this->txt('cancel'));

        $this->addServiceSettingsToForm($form);
        $this->addCommonFieldsToForm($form);

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editSettings()

ilFileCommonSettingsGUI::editSettings ( ?ilPropertyFormGUI  $form = null )

protected

Definition at line 44 of file class.ilFileCommonSettingsGUI.php.

References buildForm().

Referenced by executeCommand(), and saveSettings().

                                                                    : void
    {
        if (is_null($form)) {
            $form = $this->buildForm();
        }
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilFileCommonSettingsGUI::executeCommand

(

)

Definition at line 34 of file class.ilFileCommonSettingsGUI.php.

References ILIAS\Repository\ctrl(), editSettings(), and saveSettings().

                                    : void
    {
        $cmd = $this->ctrl->getCmd();
        match ($cmd) {
            self::CMD_EDIT => $this->editSettings(),
            self::CMD_SAVE => $this->saveSettings(),
            default => throw new Exception('Unknown command ' . $cmd),
        };
    }

Here is the call graph for this function:

saveSettings()

ilFileCommonSettingsGUI::saveSettings ( )

protected

Definition at line 80 of file class.ilFileCommonSettingsGUI.php.

References $services, buildForm(), ILIAS\Repository\ctrl(), editSettings(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilObjectServiceSettingsGUI\updateServiceSettingsForm().

Referenced by executeCommand().

                                     : void
    {
        $form = $this->buildForm();

        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->editSettings($form);
            return;
        }

        ilObjectServiceSettingsGUI::updateServiceSettingsForm(
            $this->object->getId(),
            $form,
            $this->services
        );

        $this->tpl->setOnScreenMessage("success", $this->lng->txt('service_settings_saved'), true);
        $this->ctrl->redirect($this, self::CMD_EDIT);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

txt()

ilFileCommonSettingsGUI::txt ( string  $code )

protected

Definition at line 100 of file class.ilFileCommonSettingsGUI.php.

References ILIAS\Repository\lng().

Referenced by buildForm().

                                        : string
    {
        return $this->lng->txt($code);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$services

array ilFileCommonSettingsGUI::$services

private

Initial value:

= [
        ilObjectServiceSettingsGUI::CUSTOM_METADATA
    ]

Definition at line 26 of file class.ilFileCommonSettingsGUI.php.

Referenced by addServiceSettingsToForm(), and saveSettings().

CMD_EDIT

const ilFileCommonSettingsGUI::CMD_EDIT = 'editSettings'

Definition at line 24 of file class.ilFileCommonSettingsGUI.php.

Referenced by ilObjFileGUI\initSettingsTab().

CMD_SAVE

const ilFileCommonSettingsGUI::CMD_SAVE = 'saveSettings'

Definition at line 25 of file class.ilFileCommonSettingsGUI.php.

---

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

• components/ILIAS/File/classes/ObjectProperties/class.ilFileCommonSettingsGUI.php