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

Inheritance diagram for ilPDMailBlockGUI:

Collaboration diagram for ilPDMailBlockGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	getBlockType ()

	executeCommand ()
	execute command More...

	getHTML ()

	fillDataSection ()
	Fill data section. More...

	fillRow ($mail)
	get flat list for personal desktop More...

	deleteMail ()
	delete mail More...

Public Member Functions inherited from ilBlockGUI
	getBlockType ()

	__construct ()
	Constructor. More...

	setData ($a_data)
	Set Data. More...

	getData ()
	Get Data. More...

	setPresentation (int $type)
	Set presentation. More...

	getPresentation ()
	Get presentation type. More...

	setBlockId ($a_block_id=0)
	Set Block Id. More...

	getBlockId ()
	Get Block Id. More...

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

	getGuiObject ()
	Get GuiObject. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setOffset ($a_offset)
	Set Offset. More...

	getOffset ()
	Get Offset. More...

	correctOffset ()

	setLimit ($a_limit)
	Set Limit. More...

	getLimit ()
	Get Limit. More...

	setEnableEdit ($a_enableedit)
	Set EnableEdit. More...

	getEnableEdit ()
	Get EnableEdit. More...

	setRepositoryMode ($a_repositorymode)
	Set RepositoryMode. More...

	getRepositoryMode ()
	Get RepositoryMode. More...

	setSubtitle ($a_subtitle)
	Set Subtitle. More...

	getSubtitle ()
	Get Subtitle. More...

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

	getRefId ()
	Get Ref Id (only used if isRepositoryObject() is true). More...

	setAdminCommands (bool $a_admincommands)
	Set Administration Commmands. More...

	getAdminCommands ()
	Get Administration Commmands. More...

	setEnableNumInfo ($a_enablenuminfo)
	Set Enable Item Number Info. More...

	getEnableNumInfo ()
	Get Enable Item Number Info. More...

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

	getProperty ($a_property)

	setProperty ($a_property, $a_value)

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

	getNavParameter ()

	getConfigParameter ()

	getMoveParameter ()

	getRowTemplateName ()
	Get Row Template Name. More...

	getRowTemplateDir ()
	Get Row Template Directory. More...

	addBlockCommand (string $a_href, string $a_text, string $a_onclick="")
	Add Block Command. More...

	getBlockCommands ()
	Get Block commands. More...

	getHTML ()
	Get HTML. More...

	fillHeaderCommands ()
	Fill header commands block. More...

	fillHeaderTitleBlock ()
	Fill header title block (title and. More...

	setDataSection ($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 ($a_set)

	fillFooter ()

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

	setPreviousNextLinks ()
	Get previous/next linkbar. More...

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

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

	getHTMLNew ()
	Get HTML. More...

Static Public Member Functions
static	getScreenMode ()
	Get Screen Mode for current command. More...

Static Public Member Functions inherited from ilBlockGUI
static	getScreenMode ()
	Get Screen Mode for current command. More...

Static Public Attributes
static	$block_type = 'pdmail'

Protected Member Functions
	isRepositoryObject ()

	getMails ()
	Get Mails. More...

	getOverview ()
	Get overview. More...

	showMail ()
	show mail More...

	preloadData (array $data)

	getListItemForData (array $mail)

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

	initCommands ()
	Init commands. More...

	fillRowColor ($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...

	getNoItemFoundContent ()
	No item entry. More...

Protected Attributes
	$lng

	$user

	$ctrl

	$rbacsystem

	$setting

	$mails = array()

	$inbox

	$new_rendering = true

Protected Attributes inherited from ilBlockGUI
	$ui

	$data = array()

	$enablenuminfo = true

	$footer_links = array()

	$block_id = 0

	$allow_moving = true

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

	$block_commands = array()

	$max_count = false

	$close_command = false

	$image = false

	$property = false

	$nav_value = ""

	$css_row = ""

	$title = ""

	$admincommands = false

	$dropdown

	$tpl

	$main_tpl

	$user

	$ctrl

	$access

	$lng

	$obj_def

	$presentation

	$new_rendering = false

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

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

Version: $Id$ ilPDMailBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilPDMailBlockGUI::__construct ( )

Constructor.

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilBlockGUI\setLimit(), ilBlockGUI\setPresentation(), ilBlockGUI\setTitle(), and user().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->user = $DIC->user();
         $this->ctrl = $DIC->ctrl();
         $this->setting = $DIC->settings();
         $this->rbacsystem = $DIC->rbac()->system();
 
         include_once 'Services/User/classes/class.ilObjUser.php';
         include_once 'Services/Mail/classes/class.ilMailbox.php';
         include_once 'Services/Mail/classes/class.ilMail.php';
 
         parent::__construct();
 
         $this->setLimit(5);
         $this->setTitle($this->lng->txt('mail'));
         $this->setPresentation(self::PRES_SEC_LIST);
     }

Here is the call graph for this function:

Member Function Documentation

◆ deleteMail()

ilPDMailBlockGUI::deleteMail ( )

delete mail

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

References $_GET, ilUtil\sendInfo(), and user().

     {
         $this->lng->loadLanguageModule('mail');
 
         $umail = new ilMail($this->user->getId());
         $mbox = new ilMailbox($this->user->getId());
 
         if (!$_GET['mobj_id']) {
             $_GET['mobj_id'] = $mbox->getInboxFolder();
         }
 
         if ($umail->moveMailsToFolder(array((int) $_GET['mail_id']), (int) $mbox->getTrashFolder())) {
             \ilUtil::sendInfo($this->lng->txt('mail_moved_to_trash'), true);
         } else {
             \ilUtil::sendInfo($this->lng->txt('mail_move_error'), true);
         }
         $this->ctrl->redirectByClass('ildashboardgui', 'show');
     }

Here is the call graph for this function:

◆ executeCommand()

ilPDMailBlockGUI::executeCommand ( )

execute command

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

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

◆ fillDataSection()

ilPDMailBlockGUI::fillDataSection ( )

Fill data section.

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

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

     {
         $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());
         }
     }

Here is the call graph for this function:

◆ fillRow()

ilPDMailBlockGUI::fillRow ( $mail )

get flat list for personal desktop

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

References $user, ANONYMOUS_USER_ID, ilDatePresentation\formatDate(), ilUtil\getImagePath(), ilMailUserCache\getUserObjectById(), and IL_CAL_DATE.

     {
         $user = ilMailUserCache::getUserObjectById($mail['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', $mail['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($mail['send_time'], IL_CAL_DATE)));
 
         $this->tpl->setVariable('NEW_MAIL_SUBJ', htmlentities($mail['m_subject'], ENT_NOQUOTES, 'UTF-8'));
         $this->ctrl->setParameter($this, 'mobj_id', $this->inbox);
         $this->ctrl->setParameter($this, 'mail_id', $mail['mail_id']);
         $this->tpl->setVariable('NEW_MAIL_LINK_READ', $this->ctrl->getLinkTarget($this, 'showMail'));
         $this->ctrl->clearParameters($this);
     }

Here is the call graph for this function:

◆ getBlockType()

ilPDMailBlockGUI::getBlockType ( )

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

                                    : string
     {
         return self::$block_type;
     }

◆ getHTML()

ilPDMailBlockGUI::getHTML ( )

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

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

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

Here is the call graph for this function:

◆ getListItemForData()

ilPDMailBlockGUI::getListItemForData ( array $mail )

protected

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

References Vendor\Package\$f, $user, ANONYMOUS_USER_ID, ilDatePresentation\formatDate(), ilUtil\getImagePath(), ilMailUserCache\getUserObjectById(), IL_CAL_DATE, and ui().

                                                        : \ILIAS\UI\Component\Item\Item
     {
         $f = $this->ui->factory();
 
         $user = ilMailUserCache::getUserObjectById($mail['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 = $mail['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($mail['send_time'], IL_CAL_DATE));
         $new_mail_subj = htmlentities($mail['m_subject'], ENT_NOQUOTES, 'UTF-8');
         $this->ctrl->setParameter($this, 'mobj_id', $this->inbox);
         $this->ctrl->setParameter($this, 'mail_id', $mail['mail_id']);
         $new_mail_link = $this->ctrl->getLinkTarget($this, 'showMail', "", false, false);
         $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;
     }

Here is the call graph for this function:

◆ getMails()

ilPDMailBlockGUI::getMails ( )

protected

Get Mails.

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

References ilMail\getMailsOfFolder(), and user().

Referenced by fillDataSection(), and getHTML().

     {
         require_once 'Services/Mail/classes/class.ilObjMail.php';
 
         $umail = new ilMail($this->user->getId());
         $mbox = new ilMailbox($this->user->getId());
         $this->inbox = $mbox->getInboxFolder();
 
         $this->mails = $umail->getMailsOfFolder(
             $this->inbox,
             array(
                  'status' => 'unread'
             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOverview()

ilPDMailBlockGUI::getOverview ( )

protected

Get overview.

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

Referenced by fillDataSection().

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

Here is the caller graph for this function:

◆ getScreenMode()

static ilPDMailBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

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

References $_GET, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

     {
         switch ($_GET['cmd']) {
             case 'showMail':
                 return IL_SCREEN_CENTER;
                 break;
 
             default:
                 return IL_SCREEN_SIDE;
                 break;
         }
     }

◆ isRepositoryObject()

ilPDMailBlockGUI::isRepositoryObject ( )

protected

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

                                             : bool
     {
         return false;
     }

◆ preloadData()

ilPDMailBlockGUI::preloadData ( array $data )

protected

Parameters

array $data

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

References ANONYMOUS_USER_ID, and ilMailUserCache\preloadUserObjects().

     {
         $usr_ids = array();
 
         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);
     }

Here is the call graph for this function:

◆ showMail()

ilPDMailBlockGUI::showMail ( )

protected

show mail

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

References $_GET.

     {
         include_once("./Services/Mail/classes/class.ilPDMailGUI.php");
         $mail_gui = new ilPDMailGUI();
 
         $content_block = new ilDashboardContentBlockGUI();
         $content_block->setContent($mail_gui->getPDMailHTML(
             $_GET["mail_id"],
             $_GET["mobj_id"]
         ));
         $content_block->setTitle($this->lng->txt("message"));
 
         $content_block->addBlockCommand(
             "ilias.php?baseClass=ilMailGUI&mail_id=" .
             $_GET["mail_id"] . "&mobj_id=" . $_GET["mobj_id"] . "&type=reply",
             $this->lng->txt("reply")
         );
         $content_block->addBlockCommand(
             "ilias.php?baseClass=ilMailGUI&mail_id=" .
             $_GET["mail_id"] . "&mobj_id=" . $_GET["mobj_id"] . "&type=read",
             $this->lng->txt("inbox")
         );
 
         $this->ctrl->setParameter($this, 'mail_id', (int) $_GET['mail_id']);
         $content_block->addBlockCommand($this->ctrl->getLinkTarget($this, 'deleteMail'), $this->lng->txt('delete'));
 
         return $content_block->getHTML();
     }

Field Documentation

◆ $block_type

ilPDMailBlockGUI::$block_type = 'pdmail'

static

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

◆ $ctrl

ilPDMailBlockGUI::$ctrl

protected

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

◆ $inbox

ilPDMailBlockGUI::$inbox

protected

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

◆ $lng

ilPDMailBlockGUI::$lng

protected

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

◆ $mails

ilPDMailBlockGUI::$mails = array()

protected

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

◆ $new_rendering

ilPDMailBlockGUI::$new_rendering = true

protected

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

◆ $rbacsystem

ilPDMailBlockGUI::$rbacsystem

protected

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

◆ $setting

ilPDMailBlockGUI::$setting

protected

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

◆ $user

ilPDMailBlockGUI::$user

protected

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

Referenced by fillRow(), and getListItemForData().

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

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

◆ $ctrl

◆ $inbox

◆ $lng

◆ $mails

◆ $new_rendering

◆ $rbacsystem

◆ $setting

◆ $user