ilMailOptionsGUI Class Reference

Collaboration diagram for ilMailOptionsGUI:

Public Member Functions
	__construct (?ilGlobalTemplateInterface $tpl=null, ?ilCtrlInterface $ctrl=null, ?ilLanguage $lng=null, ?ilObjUser $user=null, ?GlobalHttpState $http=null, ?Refinery $refinery=null, ?ilMailOptions $mail_options=null)
	executeCommand ()
	setForm (ilMailOptionsFormGUI $form)

Protected Member Functions
	getForm ()
	saveOptions ()
	showOptions (?ilMailOptionsFormGUI $form=null)

Protected Attributes
GlobalHttpState	$http
Refinery	$refinery
ilMailOptionsFormGUI	$form
ilMailOptions	$mail_options

Private Attributes
readonly ilGlobalTemplateInterface	$tpl
readonly ilCtrlInterface	$ctrl
readonly ilLanguage	$lng
readonly ilSetting	$settings
readonly ilObjUser	$user

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilMailOptionsGUI::__construct	(	?ilGlobalTemplateInterface	$tpl = null,
		?ilCtrlInterface	$ctrl = null,
		?ilLanguage	$lng = null,
		?ilObjUser	$user = null,
		?GlobalHttpState	$http = null,
		?Refinery	$refinery = null,
		?ilMailOptions	$mail_options = null
	)

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

      {
        global $DIC;
        $this->tpl = $tpl ?? $DIC->ui()->mainTemplate();
        $this->ctrl = $ctrl ?? $DIC->ctrl();
        $this->lng = $lng ?? $DIC->language();
        $this->user = $user ?? $DIC->user();
        $this->http = $http ?? $DIC->http();
        $this->refinery = $refinery ?? $DIC->refinery();
        $this->mail_options = $mail_options ?? new ilMailOptions($this->user->getId());
 
        $this->lng->loadLanguageModule('mail');
        $this->ctrl->saveParameter($this, 'mobj_id');
    }

References $DIC, $mail_options, $tpl, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilMailOptionsGUI::executeCommand

(

)

Definition at line 59 of file class.ilMailOptionsGUI.php.

                                    : void
    {
        if (!$this->mail_options->mayManageInvididualSettings()) {
            $referrer = '';
            if ($this->http->wrapper()->query()->has('referrer')) {
                $referrer = $this->http->wrapper()->query()->retrieve(
                    'referrer',
                    $this->refinery->kindlyTo()->string()
                );
            }
            if (strtolower(ilPersonalSettingsGUI::class) === strtolower($referrer)) {
                $this->ctrl->redirectByClass(PersonalSettingsGUI::class);
            }
            $this->ctrl->redirectByClass(ilMailGUI::class);
        }
 
        if (!($cmd = $this->ctrl->getCmd())) {
            $cmd = 'showOptions';
        }
        $this->$cmd();
    }

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

getForm()

ilMailOptionsGUI::getForm ( )

protected

Definition at line 86 of file class.ilMailOptionsGUI.php.

                                : ilMailOptionsFormGUI
    {
        return $this->form ?? new ilMailOptionsFormGUI(
            $this->mail_options,
            $this,
            'saveOptions'
        );
    }

References ILIAS\Repository\form().

Referenced by saveOptions(), and showOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

saveOptions()

ilMailOptionsGUI::saveOptions ( )

protected

Definition at line 95 of file class.ilMailOptionsGUI.php.

                                    : void
    {
        $this->tpl->setTitle($this->lng->txt('mail'));
 
        $form = $this->getForm();
        if ($form->save()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_options_saved'), true);
            $this->ctrl->redirect($this, 'showOptions');
        }
 
        $this->showOptions($form);
    }

References ILIAS\Repository\ctrl(), getForm(), ILIAS\Repository\lng(), ilMailOptionsFormGUI\save(), and showOptions().

Here is the call graph for this function:

setForm()

ilMailOptionsGUI::setForm

(

ilMailOptionsFormGUI

$form

)

Definition at line 81 of file class.ilMailOptionsGUI.php.

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

References $form, and ILIAS\Repository\form().

Here is the call graph for this function:

showOptions()

ilMailOptionsGUI::showOptions ( ?ilMailOptionsFormGUI  $form = null )

protected

Definition at line 108 of file class.ilMailOptionsGUI.php.

                                                                      : void
    {
        if (null === $form) {
            $form = $this->getForm();
            $form->populate();
        } else {
            $form->setValuesByPost();
        }
 
        $this->tpl->setContent($form->getHTML());
        $this->tpl->printToStdout();
    }

References $form, getForm(), ilPropertyFormGUI\getHTML(), ilMailOptionsFormGUI\populate(), and ilPropertyFormGUI\setValuesByPost().

Referenced by saveOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

readonly ilCtrlInterface ilMailOptionsGUI::$ctrl

private

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

$form

ilMailOptionsFormGUI ilMailOptionsGUI::$form

protected

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

Referenced by setForm(), and showOptions().

$http

GlobalHttpState ilMailOptionsGUI::$http

protected

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

$lng

readonly ilLanguage ilMailOptionsGUI::$lng

private

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

$mail_options

ilMailOptions ilMailOptionsGUI::$mail_options

protected

Definition at line 35 of file class.ilMailOptionsGUI.php.

Referenced by __construct().

$refinery

Refinery ilMailOptionsGUI::$refinery

protected

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

$settings

readonly ilSetting ilMailOptionsGUI::$settings

private

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

$tpl

readonly ilGlobalTemplateInterface ilMailOptionsGUI::$tpl

private

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

Referenced by __construct().

$user

readonly ilObjUser ilMailOptionsGUI::$user

private

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

---

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

• components/ILIAS/Mail/classes/class.ilMailOptionsGUI.php