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

Collaboration diagram for ilStudyProgrammeCommonSettingsGUI:

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

	executeCommand ()

	setObject (ilObjStudyProgramme $object)

Protected Member Functions
	editSettings (ilPropertyFormGUI $form=null)

	buildForm ()

	addServiceSettingsToForm (ilPropertyFormGUI $form)

	saveSettings ()

	txt (string $code)

Protected Attributes
ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilObjectService	$object_service

ilObjStudyProgramme	$object = null

Private Attributes
const	CMD_EDIT = 'editSettings'

const	CMD_SAVE = 'saveSettings'

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

Definition at line 21 of file class.ilStudyProgrammeCommonSettingsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeCommonSettingsGUI::__construct	(	ilCtrl	$ctrl,
		ilGlobalTemplateInterface	$tpl,
		ilLanguage	$lng,
		ilObjectService	$object_service
	)

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

References $ctrl, $lng, $object_service, $tpl, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

       {
         $this->ctrl = $ctrl;
         $this->tpl = $tpl;
         $this->lng = $lng;
         $this->object_service = $object_service;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addServiceSettingsToForm()

ilStudyProgrammeCommonSettingsGUI::addServiceSettingsToForm ( ilPropertyFormGUI $form )

protected

Definition at line 93 of file class.ilStudyProgrammeCommonSettingsGUI.php.

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

Referenced by buildForm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildForm()

ilStudyProgrammeCommonSettingsGUI::buildForm ( )

protected

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

References 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);
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editSettings()

ilStudyProgrammeCommonSettingsGUI::editSettings ( ilPropertyFormGUI $form = null )

protected

Definition at line 72 of file class.ilStudyProgrammeCommonSettingsGUI.php.

References buildForm().

Referenced by executeCommand(), and saveSettings().

                                                                    : string
     {
         if (is_null($form)) {
             $form = $this->buildForm();
         }
         return $form->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilStudyProgrammeCommonSettingsGUI::executeCommand ( )

Returns: string|void

Exceptions

Exception

Definition at line 49 of file class.ilStudyProgrammeCommonSettingsGUI.php.

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

     {
         if (is_null($this->object)) {
             throw new Exception('Object of ilObjStudyProgramme is not set');
         }
 
         $cmd = $this->ctrl->getCmd();
         switch ($cmd) {
             case self::CMD_EDIT:
                 return $this->editSettings();
             case self::CMD_SAVE:
                 $this->saveSettings();
                 break;
             default:
                 throw new Exception('Unknown command ' . $cmd);
         }
     }

Here is the call graph for this function:

◆ saveSettings()

ilStudyProgrammeCommonSettingsGUI::saveSettings ( )

protected

Definition at line 104 of file class.ilStudyProgrammeCommonSettingsGUI.php.

References buildForm(), ILIAS\Repository\ctrl(), editSettings(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilObjectServiceSettingsGUI\ORGU_POSITION_ACCESS, 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,
             [
                 ilObjectServiceSettingsGUI::ORGU_POSITION_ACCESS
             ]
         );
 
         $this->tpl->setOnScreenMessage("success", $this->lng->txt('msg_obj_modified'), true);
         $this->ctrl->redirect($this, self::CMD_EDIT);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setObject()

ilStudyProgrammeCommonSettingsGUI::setObject ( ilObjStudyProgramme $object )

Definition at line 67 of file class.ilStudyProgrammeCommonSettingsGUI.php.

References $object.

                                                           : void
     {
         $this->object = $object;
     }

◆ txt()

ilStudyProgrammeCommonSettingsGUI::txt ( string $code )

protected

Definition at line 126 of file class.ilStudyProgrammeCommonSettingsGUI.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

◆ $ctrl

ilCtrl ilStudyProgrammeCommonSettingsGUI::$ctrl

protected

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

Referenced by __construct().

◆ $lng

ilLanguage ilStudyProgrammeCommonSettingsGUI::$lng

protected

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

Referenced by __construct().

◆ $object

ilObjStudyProgramme ilStudyProgrammeCommonSettingsGUI::$object = null

protected

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

Referenced by setObject().

◆ $object_service

ilObjectService ilStudyProgrammeCommonSettingsGUI::$object_service

protected

Definition at line 29 of file class.ilStudyProgrammeCommonSettingsGUI.php.

Referenced by __construct().

◆ $tpl

ilGlobalTemplateInterface ilStudyProgrammeCommonSettingsGUI::$tpl

protected

Definition at line 27 of file class.ilStudyProgrammeCommonSettingsGUI.php.

Referenced by __construct().

◆ CMD_EDIT

const ilStudyProgrammeCommonSettingsGUI::CMD_EDIT = 'editSettings'

private

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

◆ CMD_SAVE

const ilStudyProgrammeCommonSettingsGUI::CMD_SAVE = 'saveSettings'

private

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

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

components/ILIAS/StudyProgramme/classes/class.ilStudyProgrammeCommonSettingsGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addServiceSettingsToForm()

◆ buildForm()

◆ editSettings()

◆ executeCommand()

◆ saveSettings()

◆ setObject()

◆ txt()

Field Documentation

◆ $ctrl

◆ $lng

◆ $object

◆ $object_service

◆ $tpl

◆ CMD_EDIT

◆ CMD_SAVE