ilMailOptionsGUI Class Reference

Collaboration diagram for ilMailOptionsGUI:

Public Member Functions
	__construct (ilGlobalPageTemplate $tpl=null, ilCtrl $ctrl=null, ilLanguage $lng=null, ilObjUser $user=null, ServerRequestInterface $request=null, ilFormatMail $mail=null, ilMailbox $malBox=null, ilMailOptions $mail_options=null)
	ilMailOptionsGUI constructor. More...
	executeCommand ()
	setForm (ilMailOptionsFormGUI $form)

Protected Member Functions
	getForm ()
	saveOptions ()
	Called if the user pushes the submit button of the mail options form. More...
	showOptions (ilMailOptionsFormGUI $form=null)
	Called to display the mail options form. More...

Protected Attributes
	$request
	$form
	$mail_options

Private Attributes
	$tpl
	$ctrl
	$lng
	$settings
	$user
	$umail
	$mbox

Detailed Description

Author

Jens Conze

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilMailOptionsGUI::__construct	(	ilGlobalPageTemplate	$tpl = null,
		ilCtrl	$ctrl = null,
		ilLanguage	$lng = null,
		ilObjUser	$user = null,
		ServerRequestInterface	$request = null,
		ilFormatMail	$mail = null,
		ilMailbox	$malBox = null,
		ilMailOptions	$mail_options = null
	)

ilMailOptionsGUI constructor.

Parameters

ilGlobalPageTemplate | null	$tpl
ilCtrl | null	$ctrl
ilLanguage | null	$lng
ilObjUser | null	$user
ServerRequestInterface | null	$request
ilFormatMail | null	$mail
ilMailbox | null	$malBox

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

References $ctrl, $DIC, $lng, $mail_options, $request, $tpl, $user, and user().

      {
        global $DIC;

        $this->tpl = $tpl;
        if (null === $this->tpl) {
            $this->tpl = $DIC->ui()->mainTemplate();
        }

        $this->ctrl = $ctrl;
        if (null === $this->ctrl) {
            $this->ctrl = $DIC->ctrl();
        }

        $this->lng = $lng;
        if (null === $this->lng) {
            $this->lng = $DIC->language();
        }

        $this->user = $user;
        if (null === $this->user) {
            $this->user = $DIC->user();
        }

        $this->request = $request;
        if (null === $this->request) {
            $this->request = $DIC->http()->request();
        }

        $this->umail = $mail;
        if (null === $this->umail) {
            $this->umail = new ilFormatMail($this->user->getId());
        }

        $this->mbox = $malBox;
        if (null === $this->mbox) {
            $this->mbox = new ilMailbox($this->user->getId());
        }
        $this->mail_options = $mail_options ?? new ilMailOptions((int) $this->user->getId());

        $this->lng->loadLanguageModule('mail');
        $this->ctrl->saveParameter($this, 'mobj_id');
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilMailOptionsGUI::executeCommand

(

)

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

                                     : void
    {
        if (!$this->mail_options->mayManageInvididualSettings()) {
            $referrer = $this->request->getQueryParams()['referrer'] ?? '';
            if (strtolower('ilPersonalSettingsGUI') === strtolower($referrer)) {
                $this->ctrl->redirectByClass('ilPersonalSettingsGUI');
                return;
            }
            $this->ctrl->redirectByClass('ilMailGUI');
            return;
        }

        $nextClass = $this->ctrl->getNextClass($this);
        switch ($nextClass) {
            default:
                if (!($cmd = $this->ctrl->getCmd())) {
                    $cmd = 'showOptions';
                }

                $this->$cmd();
                break;
        }
    }

getForm()

ilMailOptionsGUI::getForm ( )

protected

Returns

ilMailOptionsFormGUI

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

References $form.

Referenced by saveOptions(), and showOptions().

                                 : ilMailOptionsFormGUI
    {
        if (null !== $this->form) {
            return $this->form;
        }

        return new ilMailOptionsFormGUI(
            $this->mail_options,
            $this,
            'saveOptions'
        );
    }

Here is the caller graph for this function:

saveOptions()

ilMailOptionsGUI::saveOptions ( )

protected

Called if the user pushes the submit button of the mail options form.

Passes the post data to the mail options model instance to store them.

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

References $form, getForm(), and showOptions().

                                     : void
    {
        $this->tpl->setTitle($this->lng->txt('mail'));

        $form = $this->getForm();
        if ($form->save()) {
            ilUtil::sendSuccess($this->lng->txt('mail_options_saved'), true);
            $this->ctrl->redirect($this, 'showOptions');
        }

        $this->showOptions($form);
    }

Here is the call graph for this function:

setForm()

ilMailOptionsGUI::setForm

(

ilMailOptionsFormGUI

$form

)

Parameters

ilMailOptionsFormGUI

$form

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

References $form.

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

showOptions()

ilMailOptionsGUI::showOptions ( ilMailOptionsFormGUI  $form = null )

protected

Called to display the mail options form.

Parameters

$form

ilMailOptionsFormGUI|null

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

References $form, and getForm().

Referenced by saveOptions().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilMailOptionsGUI::$ctrl

private

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

Referenced by __construct().

$form

ilMailOptionsGUI::$form

protected

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

Referenced by getForm(), saveOptions(), setForm(), and showOptions().

$lng

ilMailOptionsGUI::$lng

private

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

Referenced by __construct().

$mail_options

ilMailOptionsGUI::$mail_options

protected

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

Referenced by __construct().

$mbox

ilMailOptionsGUI::$mbox

private

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

$request

ilMailOptionsGUI::$request

protected

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

Referenced by __construct().

$settings

ilMailOptionsGUI::$settings

private

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

$tpl

ilMailOptionsGUI::$tpl

private

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

Referenced by __construct().

$umail

ilMailOptionsGUI::$umail

private

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

$user

ilMailOptionsGUI::$user

private

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

Referenced by __construct().

---

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

• Services/Mail/classes/class.ilMailOptionsGUI.php