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

Collaboration diagram for ilObjNotificationSettingsGUI:

Public Member Functions
	__construct (int $a_ref_id)

	executeCommand ()

Protected Member Functions
	show ()

	initForm ()

	save ()

Protected Attributes
ilObjNotificationSettings	$settings

int	$ref_id

ilLanguage	$lng

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

int	$obj_id

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 Handles general notification settings, see e.g. https://www.ilias.de/docu/goto_docu_wiki_wpage_3457_1357.html

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

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

Constructor & Destructor Documentation

◆ __construct()

ilObjNotificationSettingsGUI::__construct ( int $a_ref_id )

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

References $DIC, ilObject\_lookupObjId(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->tpl = $DIC["tpl"];
         $this->ref_id = $a_ref_id;
         $this->obj_id = ilObject::_lookupObjId($a_ref_id);
         $this->settings = new ilObjNotificationSettings($this->obj_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilObjNotificationSettingsGUI::executeCommand ( )

Definition at line 42 of file class.ilObjNotificationSettingsGUI.php.

References $ctrl, ilCtrl\getCmd(), and ilCtrl\getNextClass().

                                     : void
     {
         $ctrl = $this->ctrl;
 
         $next_class = $ctrl->getNextClass($this);
         $cmd = $ctrl->getCmd("show");
 
         switch ($next_class) {
             default:
                 if (in_array($cmd, array("show", "save"))) {
                     $this->$cmd();
                 }
         }
     }

Here is the call graph for this function:

◆ initForm()

ilObjNotificationSettingsGUI::initForm ( )

protected

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

References $ctrl, $lng, ilRadioOption\addSubItem(), ilCtrl\getFormAction(), ILIAS\Repository\lng(), ilObjNotificationSettings\MODE_DEF_ON_NO_OPT_OUT, ilObjNotificationSettings\MODE_DEF_ON_OPT_OUT, ILIAS\Repository\settings(), ilCheckboxInputGUI\setValue(), ilRadioGroupInputGUI\setValue(), and ilLanguage\txt().

Referenced by save(), and show().

                                  : ilPropertyFormGUI
     {
         $ctrl = $this->ctrl;
         $lng = $this->lng;
 
         $form = new ilPropertyFormGUI();
 
         $form->setFormAction($ctrl->getFormAction($this, 'save'));
         $form->setTitle($lng->txt('obj_notification_settings'));
 
         $radio_grp = new ilRadioGroupInputGUI($lng->txt("obj_activation"), 'notification_type');
         $radio_grp->setValue('0');
 
         $opt_default = new ilRadioOption($lng->txt("obj_user_decides_notification"), '0');
         $opt_0 = new ilRadioOption($lng->txt("obj_settings_for_all_members"), '1');
 
         $radio_grp->addOption($opt_default);
         $radio_grp->addOption($opt_0);
 
         $chb_2 = new ilCheckboxInputGUI($lng->txt('obj_user_not_disable_not'), 'no_opt_out');
         $chb_2->setValue(1);
 
         $opt_0->addSubItem($chb_2);
         $form->addItem($radio_grp);
 
         if ($this->settings->getMode() === ilObjNotificationSettings::MODE_DEF_ON_OPT_OUT) {
             $radio_grp->setValue('1');
         }
         if ($this->settings->getMode() === ilObjNotificationSettings::MODE_DEF_ON_NO_OPT_OUT) {
             $radio_grp->setValue('1');
             $chb_2->setChecked(true);
         }
 
         $form->addCommandButton("save", $lng->txt("save"));
 
         $form->setTitle($this->lng->txt("notifications"));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilObjNotificationSettingsGUI::save ( )

protected

Definition at line 105 of file class.ilObjNotificationSettingsGUI.php.

References $ctrl, initForm(), ILIAS\Repository\lng(), ilObjNotificationSettings\MODE_DEF_OFF_USER_ACTIVATION, ilObjNotificationSettings\MODE_DEF_ON_NO_OPT_OUT, ilObjNotificationSettings\MODE_DEF_ON_OPT_OUT, ilCtrl\redirect(), ILIAS\Repository\settings(), and show().

                              : void
     {
         $ctrl = $this->ctrl;
 
         $form = $this->initForm();
         if ($form->checkInput()) {
             $this->settings->setMode(ilObjNotificationSettings::MODE_DEF_OFF_USER_ACTIVATION);
             if ($form->getInput('notification_type') === "1") {
                 if ((int) $form->getInput('no_opt_out')) {
                     $this->settings->setMode(ilObjNotificationSettings::MODE_DEF_ON_NO_OPT_OUT);
                 } else {
                     $this->settings->setMode(ilObjNotificationSettings::MODE_DEF_ON_OPT_OUT);
                 }
             }
             $this->settings->save();
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
             $ctrl->redirect($this, "show");
         }
 
         $form->setValuesByPost();
         $this->show();
     }

Here is the call graph for this function:

◆ show()

ilObjNotificationSettingsGUI::show ( )

protected

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

References $tpl, initForm(), and ilGlobalTemplateInterface\setContent().

Referenced by save().

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