ilMailGUI Class Reference

Collaboration diagram for ilMailGUI:

Public Member Functions
	__construct ()
	executeCommand ()

Data Fields
const	VIEWMODE_SESSION_KEY = 'mail_viewmode'

Private Member Functions
	setViewMode ()
	showHeader ()
	isMailDetailCommand ($cmd)
	showExplorer ()

Private Attributes
	$tpl = null
	$ctrl = null
	$lng = null
	$tabs_gui = null
	$umail = null
	$exp = null
	$output = null
	$mtree = null
	$forwardClass = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilMailGUI::__construct

(

)

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

References $_GET, $_POST, $ilCtrl, $ilErr, $ilUser, $lng, and $tpl.

        {
                global $tpl, $ilCtrl, $lng, $rbacsystem, $ilErr, $ilUser;

                $this->tpl = $tpl;
                $this->ctrl = $ilCtrl;
                $this->lng = $lng;
                
                if(isset($_POST['mobj_id']) && (int)$_POST['mobj_id'])
                {
                        $_GET['mobj_id'] = $_POST['mobj_id'];
                }
                $_GET['mobj_id'] = (int)$_GET['mobj_id'];
                
                $this->ctrl->saveParameter($this, "mobj_id");
                $this->lng->loadLanguageModule("mail");

                $this->umail = new ilMail($ilUser->getId());

                // CHECK HACK
                if (!$rbacsystem->checkAccess('internal_mail', $this->umail->getMailObjectReferenceId()))
                {
                        $ilErr->raiseError($this->lng->txt("permission_denied"), $ilErr->WARNING);
                }
        }

Member Function Documentation

executeCommand()

ilMailGUI::executeCommand

(

)

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

References $_GET, $_POST, $_SESSION, $cmd, array, ilSession\get(), ilMailFormCall\getRecipients(), ilUtil\sendInfo(), ilSession\set(), ilMailFormCall\setRecipients(), showExplorer(), showHeader(), and ilMailFormCall\storeReferer().

        {
                if ($_GET["type"] == "search_res")
                {
                        ilMailFormCall::storeReferer($_GET);

                        $this->ctrl->setParameterByClass("ilmailformgui", "cmd", "searchResults");
                        $this->ctrl->redirectByClass("ilmailformgui");
                }

                if ($_GET["type"] == "attach")
                {
            ilMailFormCall::storeReferer($_GET);

                        $this->ctrl->setParameterByClass("ilmailformgui", "cmd", "mailAttachment");
                        $this->ctrl->redirectByClass("ilmailformgui");
                }

                if ($_GET["type"] == "new")
                {
                        $_SESSION['rcp_to'] = $_GET['rcp_to'];
                        if(!strlen($_SESSION['rcp_to']) && ($recipients = ilMailFormCall::getRecipients()))
                        {
                                $_SESSION['rcp_to'] = implode(',', $recipients);
                                ilMailFormCall::setRecipients(array());
                        }
                        $_SESSION['rcp_cc'] = $_GET['rcp_cc'];
                        $_SESSION['rcp_bcc'] = $_GET['rcp_bcc'];

            ilMailFormCall::storeReferer($_GET);
                        
                        $this->ctrl->setParameterByClass("ilmailformgui", "cmd", "mailUser");
                        $this->ctrl->redirectByClass("ilmailformgui");
                }

                if ($_GET["type"] == "reply")
                {
                        $_SESSION['mail_id'] = $_GET['mail_id'];
                        $this->ctrl->setParameterByClass("ilmailformgui", "cmd", "replyMail");
                        $this->ctrl->redirectByClass("ilmailformgui");
                }

                if ($_GET["type"] == "read")
                {
                        $_SESSION['mail_id'] = $_GET['mail_id'];
                        $this->ctrl->setParameterByClass("ilmailfoldergui", "cmd", "showMail");
                        $this->ctrl->redirectByClass("ilmailfoldergui");
                }

                if ($_GET["type"] == "deliverFile")
                {
                        $_SESSION['mail_id'] = $_GET['mail_id'];
                        $_SESSION['filename'] = ($_POST["filename"] ? $_POST["filename"] : $_GET["filename"]);
                        $this->ctrl->setParameterByClass("ilmailfoldergui", "cmd", "deliverFile");
                        $this->ctrl->redirectByClass("ilmailfoldergui");
                }
                
                if ($_GET["type"] == "message_sent")
                {
                        ilUtil::sendInfo($this->lng->txt('mail_message_send'), true);
                        $this->ctrl->redirectByClass("ilmailfoldergui");
                }

                if ($_GET["type"] == "role")
                {
                        if (is_array($_POST['roles']))
                        {
                                $_SESSION['mail_roles'] = $_POST['roles'];
                        }
                        else if ($_GET["role"])
                        {
                                $_SESSION['mail_roles'] = array($_GET["role"]);
                        }

            ilMailFormCall::storeReferer($_GET);

                        $this->ctrl->setParameterByClass("ilmailformgui", "cmd", "mailRole");
                        $this->ctrl->redirectByClass("ilmailformgui");
                }

                if ($_GET["view"] == "my_courses")
                {
                        $_SESSION['search_crs'] = $_GET['search_crs'];
                        $this->ctrl->setParameterByClass("ilmailformgui", "cmd", "searchCoursesTo");
                        $this->ctrl->redirectByClass("ilmailformgui");
                }

                if (isset($_GET["viewmode"]))
                {
                        ilSession::set(self::VIEWMODE_SESSION_KEY, $_GET["viewmode"]);
                        $this->ctrl->setCmd("setViewMode");
                }
                
                $this->forwardClass = $this->ctrl->getNextClass($this);
                
                $this->showHeader();

                if('tree' == ilSession::get(self::VIEWMODE_SESSION_KEY) &&
                        $this->ctrl->getCmd() != "showExplorer")
                {
                        $this->showExplorer();
                }

                switch($this->forwardClass)
                {                       
                        case 'ilmailformgui':
                                include_once 'Services/Mail/classes/class.ilMailFormGUI.php';

                                $this->ctrl->forwardCommand(new ilMailFormGUI());
                                break;

                        case 'ilcontactgui':
                                require_once 'Services/Contact/classes/class.ilContactGUI.php';
                                $this->tpl->setTitle($this->lng->txt('mail_addressbook'));
                                $this->ctrl->forwardCommand(new ilContactGUI());
                                break;

                        case 'ilmailoptionsgui':
                                include_once 'Services/Mail/classes/class.ilMailOptionsGUI.php';

                                $this->ctrl->forwardCommand(new ilMailOptionsGUI());
                                break;

                        case 'ilmailfoldergui':
                                include_once 'Services/Mail/classes/class.ilMailFolderGUI.php';
                                $this->ctrl->forwardCommand(new ilMailFolderGUI());
                                break;

                        default:
                                if (!($cmd = $this->ctrl->getCmd()))
                                {
                                        $cmd = "setViewMode";
                                }

                                $this->$cmd();
                                break;

                }
                return true;
        }

Here is the call graph for this function:

isMailDetailCommand()

ilMailGUI::isMailDetailCommand (   $cmd )

private

Parameters

string

$cmd

Returns

bool

Definition at line 301 of file class.ilMailGUI.php.

References $_GET, $cmd, and array.

Referenced by showHeader().

        {
                return in_array(strtolower($cmd), array('showmail')) && isset($_GET['mail_id']) && (int)$_GET['mail_id'];
        }

Here is the caller graph for this function:

setViewMode()

ilMailGUI::setViewMode ( )

private

Definition at line 200 of file class.ilMailGUI.php.

References $_GET.

        {
                if ($_GET["target"] == "")
                {
                        $_GET["target"] = "ilmailfoldergui";
                }

                if($_GET['type'] == 'redirect_to_read')
                {
                        $this->ctrl->setParameterByClass('ilMailFolderGUI', 'mail_id', (int)$_GET['mail_id']);
                        $this->ctrl->redirectByClass('ilMailFolderGUI', 'showMail');
                }
                else if ($_GET["type"] == "add_subfolder")
                {
                        $this->ctrl->redirectByClass($_GET["target"], "addSubFolder");
                }
                else if ($_GET["type"] == "enter_folderdata")
                {
                        $this->ctrl->redirectByClass($_GET["target"], "enterFolderData");
                }
                else if ($_GET["type"] == "confirmdelete_folderdata")
                {
                        $this->ctrl->redirectByClass($_GET["target"], "confirmDeleteFolder");
                }
                else
                {
                        $this->ctrl->redirectByClass($_GET["target"]);
                }
        }

showExplorer()

ilMailGUI::showExplorer ( )

private

Definition at line 306 of file class.ilMailGUI.php.

References $exp, and $ilUser.

Referenced by executeCommand().

        {
                global $ilUser;
                
                require_once "Services/Mail/classes/class.ilMailExplorer.php";
                $exp = new ilMailExplorer($this, "showExplorer", $ilUser->getId());             
                if (!$exp->handleCommand())
                {                       
                        $this->tpl->setLeftNavContent($exp->getHTML());
                }
        }

Here is the caller graph for this function:

showHeader()

ilMailGUI::showHeader ( )

private

Definition at line 230 of file class.ilMailGUI.php.

References $_GET, ilSession\get(), ilUtil\getImagePath(), ilUtil\infoPanel(), and isMailDetailCommand().

Referenced by executeCommand().

        {
                global $ilMainMenu, $ilTabs, $ilHelp;
                
                $ilHelp->setScreenIdComponent("mail");

                $ilMainMenu->setActive("mail");

                $this->tpl->getStandardTemplate();

                $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_mail.svg"));

                // display infopanel if something happened
                ilUtil::infoPanel();
                
                $ilTabs->addTarget('fold', $this->ctrl->getLinkTargetByClass('ilmailfoldergui'));               
                $this->ctrl->setParameterByClass('ilmailformgui', 'type', 'new');
                $ilTabs->addTarget('compose', $this->ctrl->getLinkTargetByClass('ilmailformgui'));
                $this->ctrl->clearParametersByClass('ilmailformgui');
                $ilTabs->addTarget('mail_addressbook', $this->ctrl->getLinkTargetByClass('ilcontactgui'));
                $ilTabs->addTarget('options', $this->ctrl->getLinkTargetByClass('ilmailoptionsgui'));
                
                switch($this->forwardClass)
                {                               
                        case 'ilmailformgui':
                                $ilTabs->setTabActive('compose');
                                break;
                                
                        case 'ilcontactgui':
                                $ilTabs->setTabActive('mail_addressbook');
                                break;
                                
                        case 'ilmailoptionsgui':
                                $ilTabs->setTabActive('options');
                                break;
                                
                        case 'ilmailfoldergui':
                        default:
                                $ilTabs->setTabActive('fold');
                                break;
                        
                }
                if(isset($_GET['message_sent'])) $ilTabs->setTabActive('fold');
                
                if('tree' != ilSession::get(self::VIEWMODE_SESSION_KEY))
                {
                        $tree_state = 'tree';
                }
                else
                {
                        $tree_state = 'flat';
                }

                if($this->isMailDetailCommand($this->ctrl->getCmd()))
                {
                        $this->ctrl->setParameter($this, 'mail_id', (int)$_GET['mail_id']);
                        $this->ctrl->setParameter($this, 'type', 'redirect_to_read');
                }

                $this->ctrl->setParameter($this, 'viewmode', $tree_state);
                $this->tpl->setTreeFlatIcon($this->ctrl->getLinkTarget($this), $tree_state);

                $this->ctrl->clearParameters($this);
                $this->tpl->setCurrentBlock("tree_icons");
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilMailGUI::$ctrl = null

private

Definition at line 23 of file class.ilMailGUI.php.

$exp

ilMailGUI::$exp = null

private

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

Referenced by showExplorer().

$forwardClass

ilMailGUI::$forwardClass = null

private

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

$lng

ilMailGUI::$lng = null

private

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

Referenced by __construct().

$mtree

ilMailGUI::$mtree = null

private

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

$output

ilMailGUI::$output = null

private

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

$tabs_gui

ilMailGUI::$tabs_gui = null

private

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

$tpl

ilMailGUI::$tpl = null

private

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

Referenced by __construct().

$umail

ilMailGUI::$umail = null

private

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

VIEWMODE_SESSION_KEY

const ilMailGUI::VIEWMODE_SESSION_KEY = 'mail_viewmode'

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

Referenced by ilMailFolderGUI\addSubfolderCommands(), ilMailFolderGUI\cancelDeleteMails(), ilMailFolderGUI\performAddSubFolder(), and ilMailFolderGUI\performRenameSubFolder().

---

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

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