ilMailOptionsGUI Class Reference

Collaboration diagram for ilMailOptionsGUI:

Public Member Functions
	__construct ()
	ilMailOptionsGUI constructor. More...
	executeCommand ()
	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 Member Functions
	getForm ()

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

Detailed Description

Author

Jens Conze

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilMailOptionsGUI::__construct

(

)

ilMailOptionsGUI constructor.

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

    {
        global $DIC;
 
        $this->tpl      = $DIC->ui()->mainTemplate();
        $this->ctrl     = $DIC->ctrl();
        $this->settings = $DIC->settings();
        $this->lng      = $DIC->language();
        $this->user     = $DIC->user();
 
        $this->lng->loadLanguageModule('mail');
 
        $this->ctrl->saveParameter($this, 'mobj_id');
 
        $this->umail = new ilFormatMail($this->user->getId());
        $this->mbox  = new ilMailBox($this->user->getId());
    }

References $DIC, settings(), and user().

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilMailOptionsGUI::executeCommand

(

)

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

    {
        $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 90 of file class.ilMailOptionsGUI.php.

    {
        return new ilMailOptionsFormGUI(
            new ilMailOptions($this->user->getId()),
            $this,
            'saveOptions'
        );
    }

References 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

(

)

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 103 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'));
        }
 
        $this->showOptions($form);
    }

References $form, getForm(), ilUtil\sendSuccess(), and showOptions().

Here is the call graph for this function:

showOptions()

ilMailOptionsGUI::showOptions

(

ilMailOptionsFormGUI

$form = null

)

Called to display the mail options form.

Parameters

$form

ilMailOptionsFormGUI|null

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

$lng

ilMailOptionsGUI::$lng

private

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

$mbox

ilMailOptionsGUI::$mbox

private

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

$settings

ilMailOptionsGUI::$settings

private

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

$tpl

ilMailOptionsGUI::$tpl

private

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

$umail

ilMailOptionsGUI::$umail

private

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

$user

ilMailOptionsGUI::$user

private

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

---

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

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