ilObjNotificationSettingsGUI Class Reference

Handles general notification settings, see e.g. More...

Collaboration diagram for ilObjNotificationSettingsGUI:

Public Member Functions
	__construct ($a_ref_id)
	Constructor. More...
	executeCommand ()
	Execute command. More...

Protected Member Functions
	show ()
	Show form. More...
	initForm ()
	Init settings form. More...
	save ()
	Save. More...

Protected Attributes
	$lng
	$ctrl
	$tpl
	$obj_id

Detailed Description

Handles general notification settings, see e.g.

https://www.ilias.de/docu/goto_docu_wiki_wpage_3457_1357.html

Author

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

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

Constructor & Destructor Documentation

__construct()

ilObjNotificationSettingsGUI::__construct

(

$a_ref_id

)

Constructor.

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

References $DIC, ilObject\_lookupObjId(), and 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);
        include_once("./Services/Notification/classes/class.ilObjNotificationSettings.php");
        $this->settings = new ilObjNotificationSettings($this->obj_id);
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilObjNotificationSettingsGUI::executeCommand

(

)

Execute command.

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

References $ctrl, and array.

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

initForm()

ilObjNotificationSettingsGUI::initForm ( )

protected

Init settings form.

Returns

ilPropertyFormGUI

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

References $ctrl, $form, $lng, ilRadioOption\addSubItem(), ilObjNotificationSettings\MODE_DEF_ON_NO_OPT_OUT, ilObjNotificationSettings\MODE_DEF_ON_OPT_OUT, settings(), ilCheckboxInputGUI\setValue(), and ilRadioGroupInputGUI\setValue().

Referenced by save(), and show().

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

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

Save.

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

References $_POST, $ctrl, $form, initForm(), ilObjNotificationSettings\MODE_DEF_OFF_USER_ACTIVATION, ilObjNotificationSettings\MODE_DEF_ON_NO_OPT_OUT, ilObjNotificationSettings\MODE_DEF_ON_OPT_OUT, ilUtil\sendSuccess(), settings(), and show().

    {
        $ctrl = $this->ctrl;

        $form = $this->initForm();
        if ($form->checkInput()) {
            $this->settings->setMode(ilObjNotificationSettings::MODE_DEF_OFF_USER_ACTIVATION);
            if ($_POST['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();
            ilUtil::sendSuccess($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

Show form.

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

References $form, $tpl, and initForm().

Referenced by save().

    {
        $tpl = $this->tpl;

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilObjNotificationSettingsGUI::$ctrl

protected

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

Referenced by executeCommand(), initForm(), and save().

$lng

ilObjNotificationSettingsGUI::$lng

protected

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

Referenced by initForm().

$obj_id

ilObjNotificationSettingsGUI::$obj_id

protected

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

$tpl

ilObjNotificationSettingsGUI::$tpl

protected

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

Referenced by show().

---

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

• Services/Notification/classes/class.ilObjNotificationSettingsGUI.php