ilMailOptionsGUI Class Reference

Collaboration diagram for ilMailOptionsGUI:

Public Member Functions
	__construct (\ilTemplate $tpl=null, \ilCtrl $ctrl=null, \ilSetting $setting=null, \ilLanguage $lng=null, \ilObjUser $user=null, \Psr\Http\Message\ServerRequestInterface $request=null, \ilFormatMail $mail=null, \ilMailbox $malBox=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 = null

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

Detailed Description

Author

Jens Conze

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilMailOptionsGUI::__construct	(	\ilTemplate	$tpl = null,
		\ilCtrl	$ctrl = null,
		\ilSetting	$setting = null,
		\ilLanguage	$lng = null,
		\ilObjUser	$user = null,
		\Psr\Http\Message\ServerRequestInterface	$request = null,
		\ilFormatMail	$mail = null,
		\ilMailbox	$malBox = null
	)

ilMailOptionsGUI constructor.

Parameters

ilTemplate | null	$tpl
ilCtrl | null	$ctrl
ilSetting | null	$setting
ilLanguage | null	$lng
ilObjUser | null	$user
\Psr\Http\Message\ServerRequestInterface | null	$request
\ilFormatMail | null	$mail
\ilMailBox | null	$malBox

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

      {
        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->settings = $setting;
        if (null === $this->settings) {
            $this->settings = $DIC->settings();
        }
 
        $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->lng->loadLanguageModule('mail');
        $this->ctrl->saveParameter($this, 'mobj_id');
    }

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

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilMailOptionsGUI::executeCommand

(

)

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

    {
        if (!$this->settings->get('show_mail_settings')) {
            $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;
        }
    }

References settings().

Here is the call graph for this function:

getForm()

ilMailOptionsGUI::getForm ( )

protected

Returns

\ilMailOptionsFormGUI

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

    {
        if (null !== $this->form) {
            return $this->form;
        }
 
        return new \ilMailOptionsFormGUI(
            new \ilMailOptions($this->user->getId()),
            $this,
            'saveOptions'
        );
    }

References $form, and user().

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

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 176 of file class.ilMailOptionsGUI.php.

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

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

Here is the call graph for this function:

setForm()

ilMailOptionsGUI::setForm

(

\ilMailOptionsFormGUI

$form

)

Parameters

\ilMailOptionsFormGUI

$form

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

    {
        $this->form = $form;
    }

References $form.

showOptions()

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

protected

Called to display the mail options form.

Parameters

$form

\ilMailOptionsFormGUI|null

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

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

References $form, and getForm().

Referenced by saveOptions().

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 20 of file class.ilMailOptionsGUI.php.

Referenced by __construct().

$form

ilMailOptionsGUI::$form = null

protected

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

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

$lng

ilMailOptionsGUI::$lng

private

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

Referenced by __construct().

$mbox

ilMailOptionsGUI::$mbox

private

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

$request

ilMailOptionsGUI::$request

protected

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

Referenced by __construct().

$settings

ilMailOptionsGUI::$settings

private

Definition at line 30 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 40 of file class.ilMailOptionsGUI.php.

$user

ilMailOptionsGUI::$user

private

Definition at line 35 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