ilMailGUI Class Reference

ilMailGUI: ilMailFolderGUI, ilMailFormGUI, ilContactGUI, ilMailOptionsGUI, ilMailAttachmentGUI, ilMailSearchGUI, ilObjUserGUI More...

Inheritance diagram for ilMailGUI:

Collaboration diagram for ilMailGUI:

Public Member Functions
	__construct ()
	executeCommand ()

Data Fields
ilMail	$umail
ilMailbox	$mbox

Protected Member Functions
	initFolder ()
	toggleExplorerNodeState ()

Private Member Functions
	setViewMode ()
	showHeader ()

Private Attributes
readonly ilGlobalTemplateInterface	$tpl
readonly ilCtrlInterface	$ctrl
readonly ilLanguage	$lng
string	$forward_class = ''
readonly GlobalHttpState	$http
readonly Refinery	$refinery
int	$current_folder_id = 0
readonly ilObjUser	$user

Detailed Description

ilMailGUI: ilMailFolderGUI, ilMailFormGUI, ilContactGUI, ilMailOptionsGUI, ilMailAttachmentGUI, ilMailSearchGUI, ilObjUserGUI

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

Constructor & Destructor Documentation

__construct()

ilMailGUI::__construct

(

)

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

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

    {
        global $DIC;
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();

        $this->lng->loadLanguageModule('mail');

        $this->mbox = new ilMailbox($this->user->getId());
        $this->umail = new ilMail($this->user->getId());
        if (
            !$DIC->rbac()->system()->checkAccess(
                'internal_mail',
                $this->umail->getMailObjectReferenceId()
            )
        ) {
            $DIC['ilErr']->raiseError($this->lng->txt('permission_denied'), $DIC['ilErr']->WARNING);
        }

        $this->initFolder();

        $tool_context = $DIC->globalScreen()
                           ->tool()
                           ->context()
                           ->current();

        $additional_data_exists = $tool_context->getAdditionalData()->exists(
            MailGlobalScreenToolProvider::SHOW_MAIL_FOLDERS_TOOL
        );
        if ($additional_data_exists === false) {
            $tool_context->addAdditionalData(MailGlobalScreenToolProvider::SHOW_MAIL_FOLDERS_TOOL, true);
        }
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilMailGUI::executeCommand

(

)

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

References $filename, ILIAS\Repository\ctrl(), ilSession\get(), ilMailFormCall\getRecipients(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilMailFormGUI\MAIL_FORM_TYPE_ATTACH, ilMailFormGUI\MAIL_FORM_TYPE_NEW, ilMailFormGUI\MAIL_FORM_TYPE_REPLY, ilMailFormGUI\MAIL_FORM_TYPE_ROLE, ilMailFormGUI\MAIL_FORM_TYPE_SEARCH_RESULT, ILIAS\Repository\refinery(), ilSession\set(), ilMailFormCall\setRecipients(), showHeader(), ilMailFormCall\storeReferer(), and ilUtil\stripSlashes().

                                    : void
    {
        $type = '';
        if ($this->http->wrapper()->query()->has('type')) {
            $type = $this->http->wrapper()->query()->retrieve('type', $this->refinery->kindlyTo()->string());
        }
        $mail_id = 0;
        if ($this->http->wrapper()->query()->has('mail_id')) {
            $mail_id = $this->http->wrapper()->query()->retrieve('mail_id', $this->refinery->kindlyTo()->int());
        }

        $this->ctrl->setParameterByClass(ilMailFormGUI::class, 'mobj_id', $this->current_folder_id);
        $this->ctrl->setParameterByClass(ilMailFolderGUI::class, 'mobj_id', $this->current_folder_id);

        if (ilMailFormGUI::MAIL_FORM_TYPE_SEARCH_RESULT === $type) {
            ilMailFormCall::storeReferer($this->http->request()->getQueryParams());
            $this->ctrl->redirectByClass(ilMailFormGUI::class, 'searchResults');
        } elseif (ilMailFormGUI::MAIL_FORM_TYPE_ATTACH === $type) {
            ilMailFormCall::storeReferer($this->http->request()->getQueryParams());
            $this->ctrl->redirectByClass(ilMailFormGUI::class, 'mailAttachment');
        } elseif (ilMailFormGUI::MAIL_FORM_TYPE_NEW === $type) {
            foreach (['to', 'cc', 'bcc'] as $reciepient_type) {
                $key = 'rcp_' . $reciepient_type;

                $recipients = '';
                if ($this->http->wrapper()->query()->has($key)) {
                    $recipients = $this->http->wrapper()->query()->retrieve(
                        $key,
                        $this->refinery->kindlyTo()->string()
                    );
                }

                ilSession::set($key, ilUtil::stripSlashes($recipients));

                if (ilSession::get($key) === '' &&
                    ($recipients = ilMailFormCall::getRecipients($reciepient_type))) {
                    ilSession::set($key, implode(',', $recipients));
                    ilMailFormCall::setRecipients([], $reciepient_type);
                }
            }
            ilMailFormCall::storeReferer($this->http->request()->getQueryParams());
            $this->ctrl->redirectByClass(ilMailFormGUI::class, 'mailUser');
        } elseif (ilMailFormGUI::MAIL_FORM_TYPE_REPLY === $type) {
            $this->ctrl->setParameterByClass(ilMailFormGUI::class, 'mail_id', $mail_id);
            $this->ctrl->redirectByClass(ilMailFormGUI::class, 'replyMail');
        } elseif ($type === 'read') {
            $this->ctrl->setParameterByClass(ilMailFolderGUI::class, 'mail_id', $mail_id);
            $this->ctrl->redirectByClass(ilMailFolderGUI::class, 'showMail');
        } elseif ($type === 'deliverFile') {
            $filename = '';
            if ($this->http->wrapper()->post()->has('filename')) {
                $filename = $this->http->wrapper()->post()->retrieve(
                    'filename',
                    $this->refinery->kindlyTo()->string()
                );
            } elseif ($this->http->wrapper()->query()->has('filename')) {
                $filename = $this->http->wrapper()->query()->retrieve(
                    'filename',
                    $this->refinery->kindlyTo()->string()
                );
            }

            ilSession::set('filename', ilUtil::stripSlashes($filename));
            $this->ctrl->setParameterByClass(ilMailFolderGUI::class, 'mail_id', $mail_id);
            $this->ctrl->redirectByClass(ilMailFolderGUI::class, 'deliverFile');
        } elseif ($type === 'message_sent') {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_message_send'), true);
            $this->ctrl->redirectByClass(ilMailFolderGUI::class);
        } elseif (ilMailFormGUI::MAIL_FORM_TYPE_ROLE === $type) {
            $roles = [];
            if ($this->http->wrapper()->post()->has('roles')) {
                $roles = $this->http->wrapper()->post()->retrieve(
                    'roles',
                    $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string())
                );
            } elseif ($this->http->wrapper()->query()->has('role')) {
                $roles = [$this->http->wrapper()->query()->retrieve('role', $this->refinery->kindlyTo()->string())];
            }

            if ($roles !== []) {
                ilSession::set('mail_roles', $roles);
            }

            ilMailFormCall::storeReferer($this->http->request()->getQueryParams());
            $this->ctrl->redirectByClass(ilMailFormGUI::class, 'mailRole');
        }

        $view = '';
        if ($this->http->wrapper()->query()->has('view')) {
            $view = $this->http->wrapper()->query()->retrieve('view', $this->refinery->kindlyTo()->string());
        }
        if ($view === 'my_courses') {
            $search_crs = '';
            if ($this->http->wrapper()->query()->has('search_crs')) {
                $search_crs = ilUtil::stripSlashes(
                    $this->http->wrapper()->query()->retrieve('search_crs', $this->refinery->kindlyTo()->string())
                );
            }
            $this->ctrl->setParameter($this, 'search_crs', $search_crs);
            $this->ctrl->redirectByClass(ilMailFormGUI::class, 'searchCoursesTo');
        }

        $this->forward_class = (string) $this->ctrl->getNextClass($this);
        $this->showHeader();

        switch (strtolower($this->forward_class)) {
            case strtolower(ilMailFormGUI::class):
                $this->ctrl->forwardCommand(new ilMailFormGUI());
                break;

            case strtolower(ilContactGUI::class):
                $this->tpl->setTitle($this->lng->txt('mail_addressbook'));
                $this->ctrl->forwardCommand(new ilContactGUI());
                break;

            case strtolower(ilMailAttachmentGUI::class):
                $this->tpl->setTitle($this->lng->txt('mail'));
                $gui = new ilMailAttachmentGUI();
                $gui->manage();
                $this->ctrl->forwardCommand($gui);
                break;

            case strtolower(ilMailOptionsGUI::class):
                $this->tpl->setTitle($this->lng->txt('mail'));
                $this->ctrl->forwardCommand(new ilMailOptionsGUI());
                break;

            case strtolower(ilMailFolderGUI::class):
                $this->ctrl->forwardCommand(new ilMailFolderGUI());
                break;

            default:
                if (!($cmd = $this->ctrl->getCmd()) || !method_exists($this, $cmd)) {
                    $cmd = 'setViewMode';
                }

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

Here is the call graph for this function:

initFolder()

ilMailGUI::initFolder ( )

protected

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

References ilSession\get(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and ILIAS\Refinery\transform().

Referenced by __construct().

                                   : void
    {
        if ($this->http->wrapper()->post()->has('mobj_id')) {
            $folder_id = $this->http->wrapper()->post()->retrieve('mobj_id', $this->refinery->kindlyTo()->int());
        } elseif ($this->http->wrapper()->query()->has('mobj_id')) {
            $folder_id = $this->http->wrapper()->query()->retrieve('mobj_id', $this->refinery->kindlyTo()->int());
        } else {
            $folder_id = $this->refinery->byTrying([
                $this->refinery->kindlyTo()->int(),
                $this->refinery->always($this->current_folder_id),
            ])->transform(ilSession::get('mobj_id'));
        }
        if ($folder_id === 0 || !$this->mbox->isOwnedFolder($folder_id)) {
            $folder_id = $this->mbox->getInboxFolder();
        }
        $this->current_folder_id = $folder_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setViewMode()

ilMailGUI::setViewMode ( )

private

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

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

                                  : void
    {
        $target_class = ilMailFolderGUI::class;
        if ($this->http->wrapper()->query()->has('target')) {
            $target_class = $this->http->wrapper()->query()->retrieve(
                'target',
                $this->refinery->kindlyTo()->string()
            );
        }
        $type = '';
        if ($this->http->wrapper()->query()->has('type')) {
            $type = $this->http->wrapper()->query()->retrieve('type', $this->refinery->kindlyTo()->string());
        }
        $mail_id = 0;
        if ($this->http->wrapper()->query()->has('mail_id')) {
            $mail_id = $this->http->wrapper()->query()->retrieve('mail_id', $this->refinery->kindlyTo()->int());
        }

        $this->ctrl->setParameterByClass($target_class, 'mobj_id', $this->current_folder_id);

        if ($type === 'redirect_to_read') {
            $this->ctrl->setParameterByClass(
                ilMailFolderGUI::class,
                'mail_id',
                $mail_id
            );
            $this->ctrl->setParameterByClass(
                ilMailFolderGUI::class,
                'mobj_id',
                $this->current_folder_id
            );
            $this->ctrl->redirectByClass(ilMailFolderGUI::class, 'showMail');
        } elseif ($type === 'add_subfolder') {
            $this->ctrl->redirectByClass($target_class, 'addSubFolder');
        } elseif ($type === 'enter_folderdata') {
            $this->ctrl->redirectByClass($target_class, 'enterFolderData');
        } elseif ($type === 'confirmdelete_folderdata') {
            $this->ctrl->redirectByClass($target_class, 'confirmDeleteFolder');
        } else {
            $this->ctrl->redirectByClass($target_class);
        }
    }

Here is the call graph for this function:

showHeader()

ilMailGUI::showHeader ( )

private

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

References $DIC, ILIAS\Repository\ctrl(), ilUtil\getImagePath(), ILIAS\FileDelivery\http(), and ilMailFormGUI\MAIL_FORM_TYPE_NEW.

Referenced by executeCommand().

                                 : void
    {
        global $DIC;

        $DIC['ilHelp']->setScreenIdComponent('mail');

        $this->tpl->loadStandardTemplate();
        $this->tpl->setTitleIcon(ilUtil::getImagePath('standard/icon_mail.svg'));

        $this->ctrl->setParameterByClass(ilMailFolderGUI::class, 'mobj_id', $this->current_folder_id);
        $DIC->tabs()->addTarget('fold', $this->ctrl->getLinkTargetByClass(ilMailFolderGUI::class));
        $this->ctrl->clearParametersByClass(ilMailFormGUI::class);

        $this->ctrl->setParameterByClass(ilMailFormGUI::class, 'type', ilMailFormGUI::MAIL_FORM_TYPE_NEW);
        $this->ctrl->setParameterByClass(ilMailFormGUI::class, 'mobj_id', $this->current_folder_id);
        $DIC->tabs()->addTarget('compose', $this->ctrl->getLinkTargetByClass(ilMailFormGUI::class));
        $this->ctrl->clearParametersByClass(ilMailFormGUI::class);

        $this->ctrl->setParameterByClass(ilContactGUI::class, 'mobj_id', $this->current_folder_id);
        $DIC->tabs()->addTarget(
            'mail_addressbook',
            $this->ctrl->getLinkTargetByClass(ilContactGUI::class)
        );
        $this->ctrl->clearParametersByClass(ilContactGUI::class);

        $this->ctrl->setParameterByClass(
            ilMailAttachmentGUI::class,
            'mobj_id',
            $this->current_folder_id
        );
        $DIC->tabs()->addTarget(
            'mail_manage_attachments',
            $this->ctrl->getLinkTargetByClass([self::class, ilMailAttachmentGUI::class])
        );
        $this->ctrl->clearParametersByClass(ilMailAttachmentGUI::class);

        if ($DIC->settings()->get('show_mail_settings', '0')) {
            $this->ctrl->setParameterByClass(
                ilMailOptionsGUI::class,
                'mobj_id',
                $this->current_folder_id
            );
            $DIC->tabs()->addTarget(
                'options',
                $this->ctrl->getLinkTargetByClass(ilMailOptionsGUI::class)
            );
            $this->ctrl->clearParametersByClass(ilMailOptionsGUI::class);
        }

        match (strtolower($this->forward_class)) {
            strtolower(ilMailFormGUI::class) => $DIC->tabs()->setTabActive('compose'),
            strtolower(ilContactGUI::class) => $DIC->tabs()->setTabActive('mail_addressbook'),
            strtolower(ilMailOptionsGUI::class) => $DIC->tabs()->setTabActive('options'),
            strtolower(ilMailAttachmentGUI::class) => $DIC->tabs()->setTabActive('mail_manage_attachments'),
            default => $DIC->tabs()->setTabActive('fold'),
        };

        if ($this->http->wrapper()->query()->has('message_sent')) {
            $DIC->tabs()->setTabActive('fold');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

toggleExplorerNodeState()

ilMailGUI::toggleExplorerNodeState ( )

protected

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

References ILIAS\Repository\user().

                                                : void
    {
        $exp = new ilMailExplorer($this, $this->user->getId());
        $exp->toggleExplorerNodeState();
    }

Here is the call graph for this function:

Field Documentation

$ctrl

readonly ilCtrlInterface ilMailGUI::$ctrl

private

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

$current_folder_id

int ilMailGUI::$current_folder_id = 0

private

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

$forward_class

string ilMailGUI::$forward_class = ''

private

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

$http

readonly GlobalHttpState ilMailGUI::$http

private

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

$lng

readonly ilLanguage ilMailGUI::$lng

private

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

$mbox

ilMailbox ilMailGUI::$mbox

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

$refinery

readonly Refinery ilMailGUI::$refinery

private

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

$tpl

readonly ilGlobalTemplateInterface ilMailGUI::$tpl

private

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

$umail

ilMail ilMailGUI::$umail

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

$user

readonly ilObjUser ilMailGUI::$user

private

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

---

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

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