BlockGUI class for Personal Desktop Mail block. More...

Inheritance diagram for ilPDMailBlockGUI:

Collaboration diagram for ilPDMailBlockGUI:

Public Member Functions
	__construct ()

	getBlockType ()

	executeCommand ()

	getHTML ()

	fillDataSection ()
	Standard implementation for row based data. More...

	fillRow (array $a_set)

	deleteMail ()

Public Member Functions inherited from ilBlockGUI
	__construct ()

	getBlockType ()

	setData (array $a_data)

	getData ()

	setPresentation (int $type)

	getPresentation ()

	setBlockId (string $a_block_id="0")

	getBlockId ()

	setGuiObject (object $a_gui_object)
	Set GuiObject. More...

	getGuiObject ()

	setTitle (string $a_title)

	getTitle ()

	setOffset (int $a_offset)

	getOffset ()

	correctOffset ()

	setLimit (int $a_limit)

	getLimit ()

	setEnableEdit (bool $a_enableedit)

	getEnableEdit ()

	setRepositoryMode (bool $a_repositorymode)

	getRepositoryMode ()

	setSubtitle (string $a_subtitle)

	getSubtitle ()

	setRefId (int $a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...

	getRefId ()

	setAdminCommands (bool $a_admincommands)

	getAdminCommands ()

	setEnableNumInfo (bool $a_enablenuminfo)

	getEnableNumInfo ()

	setProperties (array $a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...

	getProperty (string $a_property)

	setProperty (string $a_property, string $a_value)

	setRowTemplate (string $a_rowtemplatename, string $a_rowtemplatedir="")
	Set Row Template Name. More...

	getNavParameter ()

	getConfigParameter ()

	getMoveParameter ()

	getRowTemplateName ()

	getRowTemplateDir ()

	addBlockCommand (string $a_href, string $a_text, string $a_onclick="")

	getBlockCommands ()

	getHTML ()

	fillHeaderCommands ()

	fillHeaderTitleBlock ()

	setDataSection (string $a_content)
	Call this from overwritten fillDataSection(), if standard row based data is not used. More...

	fillDataSection ()
	Standard implementation for row based data. More...

	fillRow (array $a_set)

	fillFooter ()

	fillPreviousNext ()

	setPreviousNextLinks ()

	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...

	getPaginationViewControl ()
	Fill previous/next row. More...

	getHTMLNew ()

	getNoItemFoundContent ()

Static Public Member Functions
static	getScreenMode ()

static	getScreenMode ()

Static Public Attributes
static string	$block_type = 'pdmail'

Protected Member Functions
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...

	getMails ()

	getOverview ()

	showMail ()

	preloadData (array $data)
	Can be overwritten in subclasses. More...

	getListItemForData (array $data)
	Get list item for data array. More...

Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...

	specialCharsAsEntities (string $string)

	initCommands ()

	fillRowColor (string $a_placeholder="CSS_ROW")

	preloadData (array $data)
	Can be overwritten in subclasses. More...

	getLegacyContent ()
	Get legacy content. More...

	getViewControls ()
	Get view controls. More...

	getListItemForData (array $data)
	Get list item for data array. More...

	handleNavigation ()
	Handle navigation. More...

	loadData ()
	Load data for current page. More...

	getListItemGroups ()
	Get items. More...

	addRepoCommands ()
	Add repo commands. More...

	send (string $output)
	Send. More...

Protected Attributes
ilRbacSystem	$rbacsystem

ilSetting	$setting

array	$mails = []

int	$inbox

bool	$new_rendering = true

Protected Attributes inherited from ilBlockGUI
object	$gui_object

ILIAS Block StandardGUIRequest	$request

ILIAS Block BlockManager	$block_manager

bool	$repositorymode = false

ILIAS DI UIServices	$ui

array	$data = array()

bool	$enablenuminfo = true

array	$footer_links = array()

string	$block_id = "0"

bool	$allow_moving = true

array	$move = array("left" => false, "right" => false, "up" => false, "down" => false)

array	$block_commands = array()

int	$max_count = 0

bool	$close_command = false

bool	$image = false

array	$property = []

string	$nav_value = ""

string	$css_row = ""

string	$title = ""

bool	$admincommands = false

array	$dropdown

ilTemplate	$tpl

ilGlobalTemplateInterface	$main_tpl

ilObjUser	$user

ilCtrl	$ctrl

ilAccessHandler	$access

ilLanguage	$lng

ilObjectDefinition	$obj_def

int	$presentation

int	$requested_ref_id

bool	$new_rendering = false

Private Attributes
GlobalHttpState	$http

Refinery	$refinery

int	$requestMailObjId = 0

Additional Inherited Members
Data Fields inherited from ilBlockGUI
const	PRES_MAIN_LEG = 0

const	PRES_SEC_LEG = 1

const	PRES_SEC_LIST = 2

const	PRES_MAIN_LIST = 3

const	PRES_MAIN_TILE = 4

Detailed Description

BlockGUI class for Personal Desktop Mail block.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e @ilCtrl_IsCalledBy ilPDMailBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilPDMailBlockGUI::__construct ( )

Reimplemented from ilBlockGUI.

Definition at line 42 of file class.ilPDMailBlockGUI.php.

    {
        global $DIC;
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->ctrl = $DIC->ctrl();
        $this->setting = $DIC->settings();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
 
        parent::__construct();
 
        $this->setLimit(5);
        $this->setTitle($this->lng->txt('mail'));
        $this->setPresentation(self::PRES_SEC_LIST);
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilBlockGUI\setLimit(), ilBlockGUI\setPresentation(), ilBlockGUI\setTitle(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ deleteMail()

ilPDMailBlockGUI::deleteMail ( )

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

                                : void
    {
        $this->lng->loadLanguageModule('mail');
 
        $umail = new ilMail($this->user->getId());
        $mbox = new ilMailbox($this->user->getId());
 
        $mailId = 0;
        if ($this->http->wrapper()->query()->has('mail_id')) {
            $mailId = $this->http->wrapper()->query()->retrieve('mail_id', $this->refinery->kindlyTo()->int());
        }
        $mobjId = 0;
        if ($this->http->wrapper()->query()->has('mobj_id')) {
            $mobjId = $this->http->wrapper()->query()->retrieve('mobj_id', $this->refinery->kindlyTo()->int());
        }
 
        if ($mobjId) {
            $this->requestMailObjId = $mbox->getInboxFolder();
        }
 
        if ($umail->moveMailsToFolder(
            [$mailId],
            $mbox->getTrashFolder()
        )) {
            $this->main_tpl->setOnScreenMessage('info', $this->lng->txt('mail_moved_to_trash'), true);
        } else {
            $this->main_tpl->setOnScreenMessage('info', $this->lng->txt('mail_move_error'), true);
        }
        $this->ctrl->redirectByClass(ilDashboardGUI::class, 'show');
    }

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

Here is the call graph for this function:

◆ executeCommand()

ilPDMailBlockGUI::executeCommand ( )

Definition at line 84 of file class.ilPDMailBlockGUI.php.

                                    : string
    {
        $cmd = $this->ctrl->getCmd('getHTML');
 
        return $this->$cmd();
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ fillDataSection()

ilPDMailBlockGUI::fillDataSection ( )

Standard implementation for row based data.

Overwrite this and call setContent for other data.

Reimplemented from ilBlockGUI.

Definition at line 118 of file class.ilPDMailBlockGUI.php.

                                     : void
    {
        $this->getMails();
        $this->setData($this->mails);
 
        if (count($this->mails) > 0) {
            $this->setRowTemplate("tpl.pd_mail_row.html", "Services/Mail");
            parent::fillDataSection();
        } else {
            $this->setEnableNumInfo(false);
            $this->setDataSection($this->getOverview());
        }
    }

References getMails(), getOverview(), ilBlockGUI\setData(), ilBlockGUI\setDataSection(), ilBlockGUI\setEnableNumInfo(), and ilBlockGUI\setRowTemplate().

Here is the call graph for this function:

◆ fillRow()

ilPDMailBlockGUI::fillRow ( array $a_set )

Reimplemented from ilBlockGUI.

Definition at line 132 of file class.ilPDMailBlockGUI.php.

                                         : void
    {
        $user = ilMailUserCache::getUserObjectById((int) $a_set['sender_id']);
 
        $this->tpl->touchBlock('usr_image_space');
        if ($user && $user->getId() !== ANONYMOUS_USER_ID) {
            $this->tpl->setVariable('PUBLIC_NAME_LONG', $user->getPublicName());
            $this->tpl->setVariable('IMG_SENDER', $user->getPersonalPicturePath('xxsmall'));
            $this->tpl->setVariable('ALT_SENDER', htmlspecialchars($user->getPublicName()));
        } elseif (!$user) {
            $this->tpl->setVariable(
                'PUBLIC_NAME_LONG',
                trim(($a_set['import_name'] ?? '') . ' (' . $this->lng->txt('user_deleted') . ')')
            );
 
            $this->tpl->setCurrentBlock('image_container');
            $this->tpl->touchBlock('image_container');
            $this->tpl->parseCurrentBlock();
        } else {
            $this->tpl->setVariable('PUBLIC_NAME_LONG', ilMail::_getIliasMailerName());
            $this->tpl->setVariable('IMG_SENDER', ilUtil::getImagePath('HeaderIconAvatar.svg'));
            $this->tpl->setVariable('ALT_SENDER', htmlspecialchars(ilMail::_getIliasMailerName()));
        }
 
        $this->tpl->setVariable(
            'NEW_MAIL_DATE',
            ilDatePresentation::formatDate(new ilDate($a_set['send_time'], IL_CAL_DATE))
        );
 
        $this->tpl->setVariable(
            'NEW_MAIL_SUBJ',
            htmlentities($a_set['m_subject'], ENT_NOQUOTES, 'UTF-8')
        );
        $this->ctrl->setParameter($this, 'mobj_id', $this->inbox);
        $this->ctrl->setParameter($this, 'mail_id', $a_set['mail_id']);
        $this->tpl->setVariable('NEW_MAIL_LINK_READ', $this->ctrl->getLinkTarget($this, 'showMail'));
        $this->ctrl->clearParameters($this);
    }

References ilBlockGUI\$user, ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilObject\getId(), ilUtil\getImagePath(), ilObjUser\getPersonalPicturePath(), ilObjUser\getPublicName(), ilMailUserCache\getUserObjectById(), IL_CAL_DATE, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getBlockType()

ilPDMailBlockGUI::getBlockType ( )

Reimplemented from ilBlockGUI.

Definition at line 60 of file class.ilPDMailBlockGUI.php.

                                  : string
    {
        return self::$block_type;
    }

References $block_type.

◆ getHTML()

ilPDMailBlockGUI::getHTML ( )

Reimplemented from ilBlockGUI.

Definition at line 91 of file class.ilPDMailBlockGUI.php.

                             : string
    {
        $umail = new ilMail($this->user->getId());
        if (!$this->rbacsystem->checkAccess('internal_mail', $umail->getMailObjectReferenceId())) {
            return '';
        }
 
        $this->getMails();
        $this->setData($this->mails);
 
        return parent::getHTML();
    }

References getMails(), ilBlockGUI\setData(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ getListItemForData()

ilPDMailBlockGUI::getListItemForData ( array $data )

protected

Get list item for data array.

Parameters

array $data

Returns: null|\ILIAS\UI\Component\Item\Item

Reimplemented from ilBlockGUI.

Definition at line 267 of file class.ilPDMailBlockGUI.php.

                                                      : ?Item
    {
        $f = $this->ui->factory();
 
        $user = ilMailUserCache::getUserObjectById($data['sender_id']);
 
        if ($user && $user->getId() !== ANONYMOUS_USER_ID) {
            $public_name_long = $user->getPublicName();
            $img_sender = $user->getPersonalPicturePath('xxsmall');
            $alt_sender = htmlspecialchars($user->getPublicName());
        } elseif (!$user) {
            $public_name_long = trim(($data['import_name'] ?? '') . ' (' . $this->lng->txt('user_deleted') . ')');
            $img_sender = "";
            $alt_sender = "";
        } else {
            $public_name_long = ilMail::_getIliasMailerName();
            $img_sender = ilUtil::getImagePath('HeaderIconAvatar.svg');
            $alt_sender = htmlspecialchars(ilMail::_getIliasMailerName());
        }
 
        $new_mail_date = ilDatePresentation::formatDate(new ilDate($data['send_time'], IL_CAL_DATE));
        $new_mail_subj = htmlentities($data['m_subject'], ENT_NOQUOTES, 'UTF-8');
        $this->ctrl->setParameter($this, 'mobj_id', $this->inbox);
        $this->ctrl->setParameter($this, 'mail_id', $data['mail_id']);
        $new_mail_link = $this->ctrl->getLinkTarget($this, 'showMail');
        $this->ctrl->clearParameters($this);
 
 
        $button = $f->button()->shy($new_mail_subj, $new_mail_link);
 
        $item = $f->item()->standard($button)->withDescription($new_mail_date);
        if ($img_sender !== "") {
            $item = $item->withLeadImage($f->image()->standard($img_sender, $alt_sender));
        }
 
        return $item;
    }

References ilBlockGUI\$data, Vendor\Package\$f, ilBlockGUI\$user, ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilObject\getId(), ilUtil\getImagePath(), ilObjUser\getPersonalPicturePath(), ilObjUser\getPublicName(), ilMailUserCache\getUserObjectById(), IL_CAL_DATE, ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ getMails()

ilPDMailBlockGUI::getMails ( )

protected

Definition at line 104 of file class.ilPDMailBlockGUI.php.

                                 : void
    {
        $umail = new ilMail($this->user->getId());
        $mbox = new ilMailbox($this->user->getId());
        $this->inbox = $mbox->getInboxFolder();
 
        $this->mails = $umail->getMailsOfFolder(
            $this->inbox,
            [
                 'status' => 'unread',
            ]
        );
    }

References ILIAS\Repository\user().

Referenced by fillDataSection(), and getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOverview()

ilPDMailBlockGUI::getOverview ( )

protected

Definition at line 171 of file class.ilPDMailBlockGUI.php.

                                    : string
    {
        return '<div class="small">' . (count($this->mails)) . " " . $this->lng->txt("mails_pl") . "</div>";
    }

References ILIAS\Repository\lng().

Referenced by fillDataSection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getScreenMode()

static ilPDMailBlockGUI::getScreenMode ( )

static

Reimplemented from ilBlockGUI.

Definition at line 70 of file class.ilPDMailBlockGUI.php.

                                          : string
    {
        global $DIC;
        $cmd = "";
        if ($DIC->http()->wrapper()->query()->has('cmd')) {
            $cmd = $DIC->http()->wrapper()->query()->retrieve('cmd', $DIC->refinery()->kindlyTo()->string());
        }
        if ($cmd === 'showMail') {
            return IL_SCREEN_CENTER;
        }
 
        return IL_SCREEN_SIDE;
    }

References $DIC, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

◆ isRepositoryObject()

ilPDMailBlockGUI::isRepositoryObject ( )

protected

Returns whether block has a corresponding repository object.

Reimplemented from ilBlockGUI.

Definition at line 65 of file class.ilPDMailBlockGUI.php.

                                           : bool
    {
        return false;
    }

◆ preloadData()

ilPDMailBlockGUI::preloadData ( array $data )

protected

Can be overwritten in subclasses.

Only the visible part of the complete data was passed so a preload of the visible data is possible.

Parameters

array $data

Reimplemented from ilBlockGUI.

Definition at line 248 of file class.ilPDMailBlockGUI.php.

                                               : void
    {
        $usr_ids = [];
 
        foreach ($data as $mail) {
            if ($mail['sender_id'] && $mail['sender_id'] !== ANONYMOUS_USER_ID) {
                $usr_ids[$mail['sender_id']] = $mail['sender_id'];
            }
        }
 
        ilMailUserCache::preloadUserObjects($usr_ids);
    }

References ilBlockGUI\$data, ANONYMOUS_USER_ID, and ilMailUserCache\preloadUserObjects().

Here is the call graph for this function:

◆ showMail()

ilPDMailBlockGUI::showMail ( )

protected

Definition at line 176 of file class.ilPDMailBlockGUI.php.

                                 : string
    {
        $mail_gui = new ilPDMailGUI();
 
        $content_block = new ilDashboardContentBlockGUI();
        $mailId = 0;
        if ($this->http->wrapper()->query()->has('mail_id')) {
            $mailId = $this->http->wrapper()->query()->retrieve('mail_id', $this->refinery->kindlyTo()->int());
        }
        $mobjId = $this->requestMailObjId;
        if ($this->http->wrapper()->query()->has('mobj_id')) {
            $mobjId = $this->http->wrapper()->query()->retrieve('mobj_id', $this->refinery->kindlyTo()->int());
        }
        $content_block->setContent($mail_gui->getPDMailHTML(
            $mailId,
            $mobjId
        ));
        $content_block->setTitle($this->lng->txt("message"));
 
        $content_block->addBlockCommand(
            "ilias.php?baseClass=ilMailGUI&mail_id=" .
            $mailId . "&mobj_id="
            . $mobjId . "&type=reply",
            $this->lng->txt("reply")
        );
        $content_block->addBlockCommand(
            "ilias.php?baseClass=ilMailGUI&mail_id=" .
            $mailId . "&mobj_id="
            . $mobjId . "&type=read",
            $this->lng->txt("inbox")
        );
 
        $this->ctrl->setParameter($this, 'mail_id', $mailId);
        $content_block->addBlockCommand(
            $this->ctrl->getLinkTarget($this, 'deleteMail'),
            $this->lng->txt('delete')
        );
 
        return $content_block->getHTML();
    }

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

Here is the call graph for this function:

Field Documentation

◆ $block_type

string ilPDMailBlockGUI::$block_type = 'pdmail'

static

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

Referenced by getBlockType().

◆ $http

GlobalHttpState ilPDMailBlockGUI::$http

private

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

◆ $inbox

int ilPDMailBlockGUI::$inbox

protected

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

◆ $mails

array ilPDMailBlockGUI::$mails = []

protected

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

◆ $new_rendering

bool ilPDMailBlockGUI::$new_rendering = true

protected

Definition at line 265 of file class.ilPDMailBlockGUI.php.

◆ $rbacsystem

ilRbacSystem ilPDMailBlockGUI::$rbacsystem

protected

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

◆ $refinery

Refinery ilPDMailBlockGUI::$refinery

private

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

◆ $requestMailObjId

int ilPDMailBlockGUI::$requestMailObjId = 0

private

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

Referenced by showMail().

◆ $setting

ilSetting ilPDMailBlockGUI::$setting

protected

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

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

Services/Mail/classes/class.ilPDMailBlockGUI.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteMail()

◆ executeCommand()

◆ fillDataSection()

◆ fillRow()

◆ getBlockType()

◆ getHTML()

◆ getListItemForData()

◆ getMails()

◆ getOverview()

◆ getScreenMode()

◆ isRepositoryObject()

◆ preloadData()

◆ showMail()

Field Documentation

◆ $block_type

◆ $http

◆ $inbox

◆ $mails

◆ $new_rendering

◆ $rbacsystem

◆ $refinery

◆ $requestMailObjId

◆ $setting