ilMailFolderGUI Class Reference

Collaboration diagram for ilMailFolderGUI:

Public Member Functions
	__construct ()
	ilMailFolderGUI constructor. More...
	executeCommand ()

Data Fields
	$umail
	$mbox

Protected Member Functions
	initFolder ()
	parseCommand (string $originalCommand)
	parseFolderIdFromCommand (string $command)
	performEmptyTrash ()
	Called if the deletion of all messages in trash was confirmed by the acting user. More...
	confirmEmptyTrash ()
	Called if the deletion of messages in trash should be confirmed by the acting user. More...
	showUser ()
	addSubFolderCommands (bool $isUserSubFolder=false)
	showFolder (bool $oneConfirmationDialogueRendered=false)
	Shows current folder. More...
	deleteSubFolder ($a_show_confirm=true)
	performDeleteSubFolder ()
	getSubFolderForm (string $mode='create')
	performAddSubFolder ()
	Called if a folder is created by the action user. More...
	addSubFolder (ilPropertyFormGUI $form=null)
	Called if the acting user wants to create a folder. More...
	performRenameSubFolder ()
	Called if the folder title is renamed by the acting user. More...
	renameSubFolder (ilPropertyFormGUI $form=null)
	Called if the acting user wants to rename a folder. More...
	getMailIdsFromRequest (bool $ignoreHttpGet=false)
	markMailsRead ()
	Called if multiple messages should be marked as read in the list view. More...
	markMailsUnread ()
	Called if multiple messages should be marked as un-read in the list view. More...
	moveSingleMail ()
	Called if a single message should be be moved in the detail view. More...
	moveMails ()
	Called if a single message or multiple messages should be be moved in the list view. More...
	deleteMails ()
	Called if a single message or multiple messages should be deleted. More...
	confirmDeleteMails ()
	Called if the final deletion of selected messages was confirmed by the acting user. More...
	deliverFile ()
	deliverAttachments ()
	getMailFolderTable ()
	applyFilter ()
	resetFilter ()

Private Attributes
	$confirmTrashDeletion = false
	$errorDelete = false
	$tpl
	$ctrl
	$lng
	$toolbar
	$tabs
	$user
	$httpRequest
	$currentFolderId = 0

Detailed Description

Author

Jens Conze

Version

$Id$

@ilCtrl_Calls ilMailFolderGUI: ilMailOptionsGUI, ilMailAttachmentGUI, ilMailSearchGUI @ilCtrl_Calls ilMailFolderGUI: ilPublicUserProfileGUI

Definition at line 14 of file class.ilMailFolderGUI.php.

Constructor & Destructor Documentation

__construct()

ilMailFolderGUI::__construct

(

)

ilMailFolderGUI constructor.

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

    {
        global $DIC;
 
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->toolbar = $DIC->toolbar();
        $this->user = $DIC->user();
        $this->tabs = $DIC->tabs();
        $this->httpRequest = $DIC->http()->request();
 
        $this->umail = new ilMail($this->user->getId());
        $this->mbox = new ilMailbox($this->user->getId());
 
        $this->initFolder();
    }

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

Here is the call graph for this function:

Member Function Documentation

addSubFolder()

ilMailFolderGUI::addSubFolder ( ilPropertyFormGUI  $form = null )

protected

Called if the acting user wants to create a folder.

Parameters

ilPropertyFormGUI | null

$form

Definition at line 435 of file class.ilMailFolderGUI.php.

                                                                    : void
    {
        if (null === $form) {
            $form = $this->getSubFolderForm();
        }
 
        $this->tpl->setTitle($this->lng->txt('mail'));
        $this->tpl->setContent($form->getHTML());
        $this->tpl->printToStdout();
    }

References getSubFolderForm().

Referenced by performAddSubFolder().

Here is the call graph for this function:

Here is the caller graph for this function:

addSubFolderCommands()

ilMailFolderGUI::addSubFolderCommands ( bool  $isUserSubFolder = false )

protected

Parameters

bool

$isUserSubFolder

Definition at line 217 of file class.ilMailFolderGUI.php.

                                                                           : void
    {
        $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
        $this->toolbar->addButton(
            $this->lng->txt('mail_add_subfolder'),
            $this->ctrl->getLinkTarget($this, 'addSubFolder')
        );
 
        if ($isUserSubFolder) {
            $this->toolbar->addButton($this->lng->txt('rename'), $this->ctrl->getLinkTarget($this, 'renameSubFolder'));
            $this->toolbar->addButton($this->lng->txt('delete'), $this->ctrl->getLinkTarget($this, 'deleteSubFolder'));
        }
        $this->ctrl->clearParameters($this);
    }

Referenced by showFolder().

Here is the caller graph for this function:

applyFilter()

ilMailFolderGUI::applyFilter ( )

protected

Definition at line 1065 of file class.ilMailFolderGUI.php.

                                     : void
    {
        $table = $this->getMailFolderTable();
        $table->resetOffset();
        $table->writeFilterToSession();
 
        $this->showFolder();
    }

References getMailFolderTable(), and showFolder().

Here is the call graph for this function:

confirmDeleteMails()

ilMailFolderGUI::confirmDeleteMails ( )

protected

Called if the final deletion of selected messages was confirmed by the acting user.

Definition at line 630 of file class.ilMailFolderGUI.php.

                                            : void
    {
        $mailIds = $this->getMailIdsFromRequest();
        if (0 === count($mailIds)) {
            $this->showFolder();
            ilUtil::sendInfo($this->lng->txt('mail_select_one'));
            return;
        }
 
        if ((int) $this->mbox->getTrashFolder() === (int) $this->currentFolderId) {
            $this->umail->deleteMails($mailIds);
            ilUtil::sendSuccess($this->lng->txt('mail_deleted'), true);
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $this->ctrl->redirect($this, 'showFolder');
        }
 
        $this->showFolder();
    }

References getMailIdsFromRequest(), ilUtil\sendInfo(), and showFolder().

Here is the call graph for this function:

confirmEmptyTrash()

ilMailFolderGUI::confirmEmptyTrash ( )

protected

Called if the deletion of messages in trash should be confirmed by the acting user.

Definition at line 181 of file class.ilMailFolderGUI.php.

                                           : void
    {
        if ($this->umail->countMailsOfFolder($this->currentFolderId)) {
            $this->confirmTrashDeletion = true;
        }
 
        $this->showFolder();
    }

References showFolder().

Here is the call graph for this function:

deleteMails()

ilMailFolderGUI::deleteMails ( )

protected

Called if a single message or multiple messages should be deleted.

Definition at line 602 of file class.ilMailFolderGUI.php.

                                     : void
    {
        $trashFolderId = (int) $this->mbox->getTrashFolder();
        $mailIds = $this->getMailIdsFromRequest();
 
        if ($trashFolderId == $this->currentFolderId) {
            if (0 === count($mailIds)) {
                ilUtil::sendInfo($this->lng->txt('mail_select_one'));
                $this->errorDelete = true;
            }
        } else {
            if (0 === count($mailIds)) {
                ilUtil::sendInfo($this->lng->txt('mail_select_one'));
            } elseif ($this->umail->moveMailsToFolder($mailIds, $trashFolderId)) {
                ilUtil::sendSuccess($this->lng->txt('mail_moved_to_trash'), true);
                $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
                $this->ctrl->redirect($this, 'showFolder');
            } else {
                ilUtil::sendFailure($this->lng->txt('mail_move_error'));
            }
        }
 
        $this->showFolder();
    }

References getMailIdsFromRequest(), ilUtil\sendFailure(), ilUtil\sendInfo(), and showFolder().

Here is the call graph for this function:

deleteSubFolder()

ilMailFolderGUI::deleteSubFolder (   $a_show_confirm = true )

protected

Parameters

bool

$a_show_confirm

Definition at line 347 of file class.ilMailFolderGUI.php.

                                                               : void
    {
        if ($a_show_confirm) {
            $confirmationGui = new ilConfirmationGUI();
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $confirmationGui->setFormAction($this->ctrl->getFormAction($this, 'showFolder'));
            $this->ctrl->clearParameters($this);
            $confirmationGui->setHeaderText($this->lng->txt('mail_sure_delete_folder'));
            $confirmationGui->setCancel($this->lng->txt('cancel'), 'showFolder');
            $confirmationGui->setConfirm($this->lng->txt('confirm'), 'performDeleteSubFolder');
            $this->tpl->setVariable('CONFIRMATION', $confirmationGui->getHTML());
 
            $this->showFolder(true);
        } else {
            $this->showFolder(false);
        }
    }

References showFolder().

Here is the call graph for this function:

deliverAttachments()

ilMailFolderGUI::deliverAttachments ( )

protected

Definition at line 994 of file class.ilMailFolderGUI.php.

                                            : void
    {
        try {
            $mailId = $this->httpRequest->getQueryParams()['mail_id'] ?? 0;
 
            $mailData = $this->umail->getMail((int) $mailId);
            if (null === $mailData || 0 === count((array) $mailData['attachments'])) {
                throw new ilException('mail_error_reading_attachment');
            }
 
            $type = $this->httpRequest->getQueryParams()['type'] ?? '';
 
            $mailFileData = new ilFileDataMail($this->user->getId());
            if (count($mailData['attachments']) === 1) {
                $attachment = current($mailData['attachments']);
 
                try {
                    if ('draft' === $type) {
                        if (!$mailFileData->checkFilesExist([$attachment])) {
                            throw new OutOfBoundsException('');
                        }
                        $pathToFile = $mailFileData->getAbsoluteAttachmentPoolPathByFilename($attachment);
                        $fileName = $attachment;
                    } else {
                        $file = $mailFileData->getAttachmentPathAndFilenameByMd5Hash(
                            md5($attachment),
                            (int) $mailId
                        );
                        $pathToFile = $file['path'];
                        $fileName = $file['filename'];
                    }
                    ilUtil::deliverFile($pathToFile, $fileName);
                } catch (OutOfBoundsException $e) {
                    throw new ilException('mail_error_reading_attachment');
                }
            } else {
                $mailFileData->deliverAttachmentsAsZip(
                    $mailData['m_subject'],
                    (int) $mailId,
                    $mailData['attachments'],
                    'draft' === $type
                );
            }
        } catch (Exception $e) {
            ilUtil::sendFailure($this->lng->txt($e->getMessage()), true);
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $this->ctrl->redirect($this);
        }
    }

References Vendor\Package\$e, $type, ilUtil\deliverFile(), ilUtil\sendFailure(), and user().

Here is the call graph for this function:

deliverFile()

ilMailFolderGUI::deliverFile ( )

protected

Definition at line 956 of file class.ilMailFolderGUI.php.

                                     : void
    {
        $mailId = $this->httpRequest->getQueryParams()['mail_id'] ?? 0;
        if ((int) ilSession::get('mail_id') > 0) {
            $mailId = ilSession::get('mail_id');
            ilSession::set('mail_id', null);
        }
 
        $filename = $this->httpRequest->getParsedBody()['filename'] ?? '';
        if (is_string(ilSession::get('filename')) && strlen(ilSession::get('filename')) > 0) {
            $filename = ilSession::get('filename');
            ilSession::set('filename', null);
        }
 
        try {
            if ($mailId > 0 && $filename !== '') {
                while (strpos($filename, '..') !== false) {
                    $filename = str_replace('..', '', $filename);
                }
 
                $mailFileData = new ilFileDataMail($this->user->getId());
                try {
                    $file = $mailFileData->getAttachmentPathAndFilenameByMd5Hash($filename, (int) $mailId);
                    ilUtil::deliverFile($file['path'], $file['filename']);
                } catch (OutOfBoundsException $e) {
                    throw new ilException('mail_error_reading_attachment');
                }
            } else {
                ilUtil::sendInfo($this->lng->txt('mail_select_attachment'));
                $this->showMail();
            }
        } catch (Exception $e) {
            ilUtil::sendFailure($this->lng->txt($e->getMessage()), true);
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $this->ctrl->redirect($this);
        }
    }

References Vendor\Package\$e, $filename, ilUtil\deliverFile(), ilSession\get(), ilUtil\sendFailure(), ilUtil\sendInfo(), ilSession\set(), and user().

Here is the call graph for this function:

executeCommand()

ilMailFolderGUI::executeCommand

(

)

Definition at line 125 of file class.ilMailFolderGUI.php.

                                     : void
    {
        $cmd = $this->parseCommand(
            $this->ctrl->getCmd()
        );
 
        $nextClass = $this->ctrl->getNextClass($this);
        switch ($nextClass) {
            case 'ilcontactgui':
                $this->ctrl->forwardCommand(new ilContactGUI());
                break;
 
            case 'ilmailoptionsgui':
                $this->tpl->setTitle($this->lng->txt('mail'));
                $this->ctrl->forwardCommand(new ilMailOptionsGUI());
                break;
 
            case 'ilpublicuserprofilegui':
                $this->tpl->setTitle($this->lng->txt('mail'));
                $profileGui = new ilPublicUserProfileGUI((int) ($this->httpRequest->getQueryParams()['user'] ?? 0));
 
                $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
                $profileGui->setBackUrl($this->ctrl->getLinkTarget($this, 'showMail'));
                $this->ctrl->clearParameters($this);
 
                $ret = $this->ctrl->forwardCommand($profileGui);
                if ($ret != '') {
                    $this->tpl->setContent($ret);
                }
                $this->tpl->printToStdout();
                break;
 
            default:
                if (!method_exists($this, $cmd)) {
                    $cmd = 'showFolder';
                }
                $this->{$cmd}();
                break;
        }
    }

References $ret, and parseCommand().

Here is the call graph for this function:

getMailFolderTable()

ilMailFolderGUI::getMailFolderTable ( )

protected

Returns

ilMailFolderTableGUI

Definition at line 1047 of file class.ilMailFolderGUI.php.

                                            : ilMailFolderTableGUI
    {
        $table = new ilMailFolderTableGUI(
            $this,
            $this->currentFolderId,
            'showFolder',
            $this->currentFolderId == $this->mbox->getTrashFolder(),
            $this->currentFolderId == $this->mbox->getSentFolder(),
            $this->currentFolderId == $this->mbox->getDraftsFolder()
        );
        $table->initFilter();
        
        return $table;
    }

Referenced by applyFilter(), resetFilter(), and showFolder().

Here is the caller graph for this function:

getMailIdsFromRequest()

ilMailFolderGUI::getMailIdsFromRequest ( bool  $ignoreHttpGet = false )

protected

Parameters

bool

$ignoreHttpGet

Returns

int[]

Definition at line 495 of file class.ilMailFolderGUI.php.

                                                                          : array
    {
        $mailIds = $this->httpRequest->getParsedBody()['mail_id'] ?? [];
        if (!is_array($mailIds)) {
            return [];
        }
 
        if (0 === count($mailIds) && !$ignoreHttpGet) {
            $mailId = $this->httpRequest->getQueryParams()['mail_id'] ?? 0;
            if (is_numeric($mailId)) {
                $mailIds = [$mailId];
            }
        }
 
        return array_filter(array_map('intval', $mailIds));
    }

Referenced by confirmDeleteMails(), deleteMails(), markMailsRead(), markMailsUnread(), moveMails(), moveSingleMail(), and showFolder().

Here is the caller graph for this function:

getSubFolderForm()

ilMailFolderGUI::getSubFolderForm ( string  $mode = 'create' )

protected

Parameters

string

$mode

Returns

ilPropertyFormGUI

Definition at line 385 of file class.ilMailFolderGUI.php.

                                                                 : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
        $form->setFormAction($this->ctrl->getFormAction($this, 'performAddSubFolder'));
        $this->ctrl->clearParameters($this);
        if ('edit' === $mode) {
            $form->addCommandButton('performRenameSubFolder', $this->lng->txt('save'));
            $form->setTitle($this->lng->txt('mail_rename_folder'));
        } else {
            $form->addCommandButton('performAddSubFolder', $this->lng->txt('save'));
            $form->setTitle($this->lng->txt('mail_add_folder'));
        }
        $form->addCommandButton('showFolder', $this->lng->txt('cancel'));
 
        $title = new ilTextInputGUI($this->lng->txt('title'), 'subfolder_title');
        $title->setRequired(true);
        $form->addItem($title);
 
        return $form;
    }

Referenced by addSubFolder(), performAddSubFolder(), performRenameSubFolder(), and renameSubFolder().

Here is the caller graph for this function:

initFolder()

ilMailFolderGUI::initFolder ( )

protected

Definition at line 76 of file class.ilMailFolderGUI.php.

                                    : void
    {
        $folderId = (int) ($this->httpRequest->getParsedBody()['mobj_id'] ?? 0);
        if (0 === $folderId) {
            $folderId = (int) ($this->httpRequest->getQueryParams()['mobj_id'] ?? 0);
        }
 
        if (0 === $folderId || !$this->mbox->isOwnedFolder($folderId)) {
            $folderId = $this->mbox->getInboxFolder();
        }
 
        $this->currentFolderId = (int) $folderId;
    }

Referenced by __construct().

Here is the caller graph for this function:

markMailsRead()

ilMailFolderGUI::markMailsRead ( )

protected

Called if multiple messages should be marked as read in the list view.

Definition at line 515 of file class.ilMailFolderGUI.php.

                                       : void
    {
        $mailIds = $this->getMailIdsFromRequest();
        if (count($mailIds) > 0) {
            $this->umail->markRead($mailIds);
            ilUtil::sendSuccess($this->lng->txt('saved_successfully'));
        } else {
            ilUtil::sendInfo($this->lng->txt('mail_select_one'));
        }
 
        $this->showFolder();
    }

References getMailIdsFromRequest(), ilUtil\sendInfo(), and showFolder().

Here is the call graph for this function:

markMailsUnread()

ilMailFolderGUI::markMailsUnread ( )

protected

Called if multiple messages should be marked as un-read in the list view.

Definition at line 531 of file class.ilMailFolderGUI.php.

                                         : void
    {
        $mailIds = $this->getMailIdsFromRequest();
        if (count($mailIds) > 0) {
            $this->umail->markUnread($mailIds);
            ilUtil::sendSuccess($this->lng->txt('saved_successfully'));
        } else {
            ilUtil::sendInfo($this->lng->txt('mail_select_one'));
        }
 
        $this->showFolder();
    }

References getMailIdsFromRequest(), ilUtil\sendInfo(), and showFolder().

Here is the call graph for this function:

moveMails()

ilMailFolderGUI::moveMails ( )

protected

Called if a single message or multiple messages should be be moved in the list view.

Definition at line 579 of file class.ilMailFolderGUI.php.

                                   : void
    {
        $mailIds = $this->getMailIdsFromRequest();
        if (0 === count($mailIds)) {
            $this->showFolder();
            ilUtil::sendInfo($this->lng->txt('mail_select_one'));
            return;
        }
 
        $folderId = $this->parseFolderIdFromCommand($this->ctrl->getCmd());
        if ($this->umail->moveMailsToFolder($mailIds, $folderId)) {
            ilUtil::sendSuccess($this->lng->txt('mail_moved'), true);
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $this->ctrl->redirect($this, 'showFolder');
        } else {
            ilUtil::sendFailure($this->lng->txt('mail_move_error'));
            $this->showFolder();
        }
    }

References getMailIdsFromRequest(), parseFolderIdFromCommand(), ilUtil\sendFailure(), ilUtil\sendInfo(), and showFolder().

Here is the call graph for this function:

moveSingleMail()

ilMailFolderGUI::moveSingleMail ( )

protected

Called if a single message should be be moved in the detail view.

Definition at line 547 of file class.ilMailFolderGUI.php.

                                        : void
    {
        $mailIds = $this->getMailIdsFromRequest();
        if (1 !== count($mailIds)) {
            $this->showMail();
            ilUtil::sendInfo($this->lng->txt('mail_select_one'));
            return;
        }
 
        $newFolderId = (int) ($this->httpRequest->getParsedBody()['folder_id'] ?? 0);
        $redirectFolderId = $newFolderId;
        foreach ($mailIds as $mailId) {
            $mailData = $this->umail->getMail($mailId);
            if (isset($mailData['folder_id']) && is_numeric($mailData['folder_id']) && (int) $mailData['folder_id'] > 0) {
                $redirectFolderId = $mailData['folder_id'];
                break;
            }
        }
 
        if ($this->umail->moveMailsToFolder($mailIds, $newFolderId)) {
            ilUtil::sendSuccess($this->lng->txt('mail_moved'), true);
            $this->ctrl->setParameter($this, 'mobj_id', $redirectFolderId);
            $this->ctrl->redirect($this, 'showFolder');
        } else {
            ilUtil::sendFailure($this->lng->txt('mail_move_error'));
            $this->showMail();
        }
    }

References getMailIdsFromRequest(), ilUtil\sendFailure(), and ilUtil\sendInfo().

Here is the call graph for this function:

parseCommand()

ilMailFolderGUI::parseCommand ( string  $originalCommand )

protected

Parameters

string

$originalCommand

Returns

string

Definition at line 94 of file class.ilMailFolderGUI.php.

                                                             : string
    {
        $matches = [];
        if (preg_match('/^([a-zA-Z0-9]+?)_(\d+?)$/', $originalCommand, $matches) && 3 === count($matches)) {
            $originalCommand = $matches[1];
        }
 
        return $originalCommand;
    }

Referenced by executeCommand(), and showFolder().

Here is the caller graph for this function:

parseFolderIdFromCommand()

ilMailFolderGUI::parseFolderIdFromCommand ( string  $command )

protected

Parameters

string

$command

Returns

int

Exceptions

InvalidArgumentException

Definition at line 109 of file class.ilMailFolderGUI.php.

                                                                 : int
    {
        $matches = [];
        if (
            preg_match('/^([a-zA-Z0-9]+?)_(\d+?)$/', $command, $matches) &&
            3 === count($matches) && is_numeric($matches[2])
        ) {
            return (int) $matches[2];
        }
 
        throw new InvalidArgumentException("Cannot parse a numeric folder id from command string!");
    }

Referenced by moveMails().

Here is the caller graph for this function:

performAddSubFolder()

ilMailFolderGUI::performAddSubFolder ( )

protected

Called if a folder is created by the action user.

Definition at line 410 of file class.ilMailFolderGUI.php.

                                             : void
    {
        $form = $this->getSubFolderForm();
        $isFormValid = $form->checkInput();
        $form->setValuesByPost();
        if (!$isFormValid) {
            $this->addSubFolder($form);
            return;
        }
 
        $newFolderId = $this->mbox->addFolder($this->currentFolderId, $form->getInput('subfolder_title'));
        if ($newFolderId > 0) {
            ilUtil::sendSuccess($this->lng->txt('mail_folder_created'), true);
            $this->ctrl->setParameterByClass('ilMailGUI', 'mobj_id', $newFolderId);
            $this->ctrl->redirectByClass('ilMailGUI');
        }
 
        ilUtil::sendFailure($this->lng->txt('mail_folder_exists'));
        $this->addSubFolder($form);
    }

References addSubFolder(), getSubFolderForm(), and ilUtil\sendFailure().

Here is the call graph for this function:

performDeleteSubFolder()

ilMailFolderGUI::performDeleteSubFolder ( )

protected

Exceptions

ilInvalidTreeStructureException

Definition at line 368 of file class.ilMailFolderGUI.php.

                                                : void
    {
        $parentFolderId = $this->mbox->getParentFolderId($this->currentFolderId);
        if ($parentFolderId > 0 && $this->mbox->deleteFolder($this->currentFolderId)) {
            ilUtil::sendInfo($this->lng->txt('mail_folder_deleted'), true);
            $this->ctrl->setParameterByClass('ilMailGUI', 'mobj_id', (int) $parentFolderId);
            $this->ctrl->redirectByClass('ilMailGUI');
        } else {
            ilUtil::sendFailure($this->lng->txt('mail_error_delete'));
            $this->showFolder();
        }
    }

References ilUtil\sendFailure(), ilUtil\sendInfo(), and showFolder().

Here is the call graph for this function:

performEmptyTrash()

ilMailFolderGUI::performEmptyTrash ( )

protected

Called if the deletion of all messages in trash was confirmed by the acting user.

Definition at line 169 of file class.ilMailFolderGUI.php.

                                           : void
    {
        $this->umail->deleteMailsOfFolder($this->currentFolderId);
 
        ilUtil::sendSuccess($this->lng->txt('mail_deleted'), true);
        $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
        $this->ctrl->redirect($this, 'showFolder');
    }

performRenameSubFolder()

ilMailFolderGUI::performRenameSubFolder ( )

protected

Called if the folder title is renamed by the acting user.

Definition at line 449 of file class.ilMailFolderGUI.php.

                                                : void
    {
        $form = $this->getSubFolderForm('edit');
        $isFormValid = $form->checkInput();
        $form->setValuesByPost();
        if (!$isFormValid) {
            $this->renameSubFolder($form);
            return;
        }
 
        $folderData = $this->mbox->getFolderData($this->currentFolderId);
        if ($folderData['title'] === $form->getInput('subfolder_title')) {
            $this->showFolder();
            return;
        }
 
        if ($this->mbox->renameFolder($this->currentFolderId, $form->getInput('subfolder_title'))) {
            ilUtil::sendSuccess($this->lng->txt('mail_folder_name_changed'), true);
            $this->ctrl->setParameterByClass('ilMailGUI', 'mobj_id', $this->currentFolderId);
            $this->ctrl->redirectByClass('ilMailGUI');
        }
 
        ilUtil::sendFailure($this->lng->txt('mail_folder_exists'));
        $this->renameSubFolder($form);
    }

References getSubFolderForm(), renameSubFolder(), ilUtil\sendFailure(), and showFolder().

Here is the call graph for this function:

renameSubFolder()

ilMailFolderGUI::renameSubFolder ( ilPropertyFormGUI  $form = null )

protected

Called if the acting user wants to rename a folder.

Parameters

ilPropertyFormGUI | null

$form

Definition at line 479 of file class.ilMailFolderGUI.php.

                                                                       : void
    {
        if (null === $form) {
            $form = $this->getSubFolderForm('edit');
            $form->setValuesByArray(['subfolder_title' => $this->mbox->getFolderData($this->currentFolderId)['title']]);
        }
 
        $this->tpl->setTitle($this->lng->txt('mail'));
        $this->tpl->setContent($form->getHTML());
        $this->tpl->printToStdout();
    }

References getSubFolderForm().

Referenced by performRenameSubFolder().

Here is the call graph for this function:

Here is the caller graph for this function:

resetFilter()

ilMailFolderGUI::resetFilter ( )

protected

Definition at line 1077 of file class.ilMailFolderGUI.php.

                                     : void
    {
        $table = $this->getMailFolderTable();
        $table->resetOffset();
        $table->resetFilter();
 
        $this->showFolder();
    }

References getMailFolderTable(), and showFolder().

Here is the call graph for this function:

showFolder()

ilMailFolderGUI::showFolder ( bool  $oneConfirmationDialogueRendered = false )

protected

Shows current folder.

Current Folder is determined by $_GET["mobj_id"]

Parameters

bool

$oneConfirmationDialogueRendered

Definition at line 236 of file class.ilMailFolderGUI.php.

                                                                                 : void
    {
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.mail.html', 'Services/Mail');
        $this->tpl->setTitle($this->lng->txt('mail'));
 
        $isTrashFolder = $this->currentFolderId == $this->mbox->getTrashFolder();
 
        if ($isTrashFolder && 'deleteMails' === $this->parseCommand($this->ctrl->getCmd()) && !$this->errorDelete) {
            $confirmationGui = new ilConfirmationGUI();
            $confirmationGui->setHeaderText($this->lng->txt('mail_sure_delete'));
            foreach ($this->getMailIdsFromRequest() as $mailId) {
                $confirmationGui->addHiddenItem('mail_id[]', $mailId);
            }
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $confirmationGui->setFormAction($this->ctrl->getFormAction($this, 'showFolder'));
            $this->ctrl->clearParameters($this);
            $confirmationGui->setConfirm($this->lng->txt('confirm'), 'confirmDeleteMails');
            $confirmationGui->setCancel($this->lng->txt('cancel'), 'showFolder');
            $this->tpl->setVariable('CONFIRMATION', $confirmationGui->getHTML());
            $oneConfirmationDialogueRendered = true;
        }
 
        $folders = $this->mbox->getSubFolders();
        $mtree = new ilTree($this->user->getId());
        $mtree->setTableNames('mail_tree', 'mail_obj_data');
 
        $isUserSubFolder = false;
        $isUserRootFolder = false;
 
        $folder_d = $mtree->getNodeData($this->currentFolderId);
        if ($folder_d['m_type'] === 'user_folder') {
            $isUserSubFolder = true;
        } elseif ($folder_d['m_type'] === 'local') {
            $isUserRootFolder = true;
        }
 
        $mailtable = $this->getMailFolderTable();
        $mailtable->setSelectedItems($this->getMailIdsFromRequest(true));
 
        try {
            $mailtable->prepareHTML();
        } catch (Exception $e) {
            ilUtil::sendFailure(
                $this->lng->txt($e->getMessage()) != '-' . $e->getMessage() . '-' ?
                    $this->lng->txt($e->getMessage()) :
                    $e->getMessage()
            );
        }
 
        $table_html = $mailtable->getHtml();
 
        $folder_options = [];
        foreach ($folders as $folder) {
            $folder_d = $mtree->getNodeData($folder['obj_id']);
 
            if ($folder['obj_id'] == $this->currentFolderId) {
                if ($folder['type'] === 'user_folder') {
                    $isUserSubFolder = true;
                } elseif ($folder['type'] === 'local') {
                    $isUserRootFolder = true;
                    $isUserSubFolder = false;
                }
            }
 
            $folder_options[$folder['obj_id']] = sprintf(
                $this->lng->txt('mail_change_to_folder'),
                $this->lng->txt('mail_' . $folder['title'])
            );
            if ($folder['type'] === 'user_folder') {
                $pre = '';
                for ($i = 2; $i < $folder_d['depth'] - 1; $i++) {
                    $pre .= '&nbsp;';
                }
 
                if ($folder_d['depth'] > 1) {
                    $pre .= '+';
                }
 
                $folder_options[$folder['obj_id']] = sprintf(
                    $this->lng->txt('mail_change_to_folder'),
                    $pre . ' ' . $folder['title']
                );
            }
        }
 
        if ($oneConfirmationDialogueRendered === false && $this->confirmTrashDeletion === false) {
            $this->toolbar->setFormAction($this->ctrl->getFormAction($this, 'showFolder'));
 
            if ($isUserRootFolder == true || $isUserSubFolder == true) {
                $this->addSubFolderCommands($isUserSubFolder);
            }
        }
 
        if ($mailtable->isTrashFolder() && $mailtable->getNumberOfMails() > 0 && $this->confirmTrashDeletion === true) {
            $confirmationGui = new ilConfirmationGUI();
            $confirmationGui->setHeaderText($this->lng->txt('mail_empty_trash_confirmation'));
            $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
            $confirmationGui->setFormAction($this->ctrl->getFormAction($this, 'performEmptyTrash'));
            $this->ctrl->clearParameters($this);
            $confirmationGui->setConfirm($this->lng->txt('confirm'), 'performEmptyTrash');
            $confirmationGui->setCancel($this->lng->txt('cancel'), 'showFolder');
            $this->tpl->setVariable('CONFIRMATION', $confirmationGui->getHTML());
        }
 
        $this->tpl->setVariable('MAIL_TABLE', $table_html);
        $this->tpl->printToStdout();
    }

References Vendor\Package\$e, $i, addSubFolderCommands(), getMailFolderTable(), getMailIdsFromRequest(), parseCommand(), ilUtil\sendFailure(), and user().

Referenced by applyFilter(), confirmDeleteMails(), confirmEmptyTrash(), deleteMails(), deleteSubFolder(), markMailsRead(), markMailsUnread(), moveMails(), performDeleteSubFolder(), performRenameSubFolder(), and resetFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

showUser()

ilMailFolderGUI::showUser ( )

protected

Exceptions

ilCtrlException

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

                                  : void
    {
        $this->tpl->setVariable('TBL_TITLE', implode(' ', [
            $this->lng->txt('profile_of'),
            ilObjUser::_lookupLogin((int) ($this->httpRequest->getQueryParams()['user'] ?? 0))
        ]));
        $this->tpl->setVariable('TBL_TITLE_IMG', ilUtil::getImagePath('icon_usr.svg'));
        $this->tpl->setVariable('TBL_TITLE_IMG_ALT', $this->lng->txt('public_profile'));
 
        $profile_gui = new ilPublicUserProfileGUI((int) ($this->httpRequest->getQueryParams()['user'] ?? 0));
 
        $this->ctrl->setParameter($this, 'mail_id', (int) $this->httpRequest->getQueryParams()['mail_id']);
        $this->ctrl->setParameter($this, 'mobj_id', $this->currentFolderId);
        $profile_gui->setBackUrl($this->ctrl->getLinkTarget($this, 'showMail'));
        $this->ctrl->clearParameters($this);
 
        $this->tpl->setTitle($this->lng->txt('mail'));
        $this->tpl->setContent($this->ctrl->getHTML($profile_gui));
        $this->tpl->printToStdout();
    }

References ilObjUser\_lookupLogin(), and ilUtil\getImagePath().

Here is the call graph for this function:

Field Documentation

$confirmTrashDeletion

ilMailFolderGUI::$confirmTrashDeletion = false

private

Definition at line 17 of file class.ilMailFolderGUI.php.

$ctrl

ilMailFolderGUI::$ctrl

private

Definition at line 26 of file class.ilMailFolderGUI.php.

$currentFolderId

ilMailFolderGUI::$currentFolderId = 0

private

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

$errorDelete

ilMailFolderGUI::$errorDelete = false

private

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

$httpRequest

ilMailFolderGUI::$httpRequest

private

Definition at line 47 of file class.ilMailFolderGUI.php.

$lng

ilMailFolderGUI::$lng

private

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

$mbox

ilMailFolderGUI::$mbox

Definition at line 44 of file class.ilMailFolderGUI.php.

$tabs

ilMailFolderGUI::$tabs

private

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

$toolbar

ilMailFolderGUI::$toolbar

private

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

$tpl

ilMailFolderGUI::$tpl

private

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

$umail

ilMailFolderGUI::$umail

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

$user

ilMailFolderGUI::$user

private

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

---

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

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