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 bookmark list for personal desktop More...

	deleteMail ()
	delete mail More...

Public Member Functions inherited from ilBlockGUI
	getBlockType ()

	__construct ()
	Constructor. More...

	addHeaderLink ($a_href, $a_text, $status=true)

	getHeaderLinks ()

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

	getData ()
	Get Data. More...

	setBigMode ($a_bigmode)
	Set Big Mode. More...

	getBigMode ()
	Get Big Mode. More...

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

	getBlockId ()
	Get Block Id. More...

	setAvailableDetailLevels ($a_max, $a_min=0)
	Set Available Detail Levels. More...

	setCurrentDetailLevel ($a_currentdetaillevel)
	Set Current Detail Level. More...

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

	getGuiObject ()
	Get GuiObject. More...

	getCurrentDetailLevel ()
	Get Current Detail Level. More...

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

	getTitle ()
	Get Title. More...

	setImage ($a_image)
	Set Image. More...

	getImage ()
	Get Image. 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...

	setFooterInfo ($a_footerinfo, $a_hide_and_icon=false)
	Set Footer Info. More...

	getFooterInfo ($a_hide_and_icon=false)
	Get Footer Info. 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 ($a_admincommands)
	Set Administration Commmands. More...

	getAdminCommands ()
	Get Administration Commmands. More...

	setColSpan ($a_colspan)
	Set Columns Span. More...

	getColSpan ()
	Get Columns Span. More...

	setEnableDetailRow ($a_enabledetailrow)
	Set EnableDetailRow. More...

	getEnableDetailRow ()
	Get EnableDetailRow. 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 ()

	getDetailParameter ()

	getConfigParameter ()

	getMoveParameter ()

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

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

	addBlockCommand ( $a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false, $a_checked=false, $a_html="")
	Add Block Command. More...

	getBlockCommands ()
	Get Block commands. More...

	addHeaderCommand ($a_href, $a_text, $a_as_close=false)
	Add Header Block Command. More...

	getHeaderCommands ()
	Get Header Block commands. More...

	addFooterLink ( $a_text, $a_href="", $a_onclick="", $a_block_id="", $a_top=false, $a_omit_separator=false, $a_checked=false)
	Add a footer text/link. More...

	getFooterLinks ()
	Get footer links. More...

	clearFooterLinks ()
	Clear footer links. More...

	handleDetailLevel ()
	Handle read/write current detail level. More...

	getHTML ()
	Handle config status. 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...

	fillFooterLinks ($a_top=false, $a_numinfo="")
	Fill footer links. More...

	fillDetailRow ()
	Fill Detail Setting Row. 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)

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

	fillRowColor ($a_placeholder="CSS_ROW")

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

Protected Attributes
	$lng

	$user

	$ctrl

	$rbacsystem

	$setting

	$mails = array()

	$inbox

Protected Attributes inherited from ilBlockGUI
	$data = array()

	$colspan = 1

	$enablenuminfo = true

	$detail_min = 0

	$detail_max = 0

	$bigmode = false

	$footer_links = array()

	$block_id = 0

	$header_commands = array()

	$allow_moving = true

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

	$enabledetailrow = true

	$header_links = array()

	$footerinfo = false

	$footerinfo_icon = false

	$block_commands = array()

	$max_count = false

	$close_command = false

	$image = false

	$property = false

	$nav_value = ""

	$css_row = ""

	$dropdown

	$tpl

	$main_tpl

	$user

	$ctrl

	$access

	$lng

	$obj_def

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, ilUtil\getImagePath(), ilBlockGUI\setAvailableDetailLevels(), ilBlockGUI\setImage(), ilBlockGUI\setLimit(), 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->setImage(ilUtil::getImagePath('icon_mail.svg'));
         $this->setTitle($this->lng->txt('mail'));
         $this->setAvailableDetailLevels(3);
     }

Here is the call graph for this function:

Member Function Documentation

◆ deleteMail()

ilPDMailBlockGUI::deleteMail ( )

delete mail

Definition at line 281 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('ilpersonaldesktopgui', 'show');
     }

Here is the call graph for this function:

◆ executeCommand()

ilPDMailBlockGUI::executeCommand ( )

execute command

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

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

◆ fillDataSection()

ilPDMailBlockGUI::fillDataSection ( )

Fill data section.

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

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

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

Here is the call graph for this function:

◆ fillRow()

ilPDMailBlockGUI::fillRow ( $mail )

get flat bookmark list for personal desktop

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

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

     {
         $user = ilMailUserCache::getUserObjectById($mail['sender_id']);
         
         if ($this->getCurrentDetailLevel() > 2) {
             $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)));
         } else {
             if ($user && $user->getId() != ANONYMOUS_USER_ID) {
                 $this->tpl->setVariable('PUBLIC_NAME_SHORT', $user->getPublicName());
             } elseif (!$user) {
                 $this->tpl->setVariable('PUBLIC_NAME_SHORT', $mail['import_name'] . ' (' . $this->lng->txt('user_deleted') . ')');
             } else {
                 $this->tpl->setVariable('PUBLIC_NAME_SHORT', ilMail::_getIliasMailerName());
             }
         }
 
         $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->ctrl->setParameter($this, 'mail_mode', $this->mail_mode);
         $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 80 of file class.ilPDMailBlockGUI.php.

                                    : string
     {
         return self::$block_type;
     }

◆ getHTML()

ilPDMailBlockGUI::getHTML ( )

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

References $html, ilBlockGUI\getCurrentDetailLevel(), and user().

     {
         $umail = new ilMail($this->user->getId());
         if (!$this->rbacsystem->checkAccess('internal_mail', $umail->getMailObjectReferenceId())) {
             return '';
         }
 
         if ($this->getCurrentDetailLevel() == 0) {
             return '';
         } else {
             $html = parent::getHTML();
             return $html;
         }
     }

Here is the call graph for this function:

◆ getMails()

ilPDMailBlockGUI::getMails ( )

protected

Get Mails.

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

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

Referenced by fillDataSection().

     {
         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',
                  'type' => ((int) $this->setting->get('pd_sys_msg_mode')) != ilObjMail::PD_SYS_MSG_MAIL_BLOCK ? 'normal' : ''
             )
         );
     }

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 224 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 96 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 88 of file class.ilPDMailBlockGUI.php.

                                             : bool
     {
         return false;
     }

◆ preloadData()

ilPDMailBlockGUI::preloadData ( array $data )

protected

Parameters

array $data

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

References 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 232 of file class.ilPDMailBlockGUI.php.

References $_GET, and ilUtil\getImagePath().

     {
         include_once("./Services/Mail/classes/class.ilPDMailGUI.php");
         $mail_gui = new ilPDMailGUI();
 
         include_once("./Services/PersonalDesktop/classes/class.ilPDContentBlockGUI.php");
         $content_block = new ilPDContentBlockGUI();
         $content_block->setContent($mail_gui->getPDMailHTML(
             $_GET["mail_id"],
             $_GET["mobj_id"]
         ));
         $content_block->setTitle($this->lng->txt("message"));
         $content_block->setColSpan(2);
         $content_block->setImage(ilUtil::getImagePath("icon_mail.svg"));
         $content_block->addHeaderCommand(
             $this->ctrl->getLinkTargetByClass("ilpersonaldesktopgui", "show"),
             $this->lng->txt("selected_items_back")
         );
 
         if ($_GET["mail_mode"] != "system") {
             $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'));
         } else {
             $this->ctrl->setParameter($this, "mail_id", $_GET["mail_id"]);
             $this->ctrl->setParameter($this, "mobj_id", $_GET["mobj_id"]);
             $content_block->addBlockCommand(
                 $this->ctrl->getLinkTarget($this, "deleteMail"),
                 $this->lng->txt("delete")
             );
             $this->ctrl->clearParameters($this);
         }
 
         return $content_block->getHTML();
     }

Here is the call graph for this function:

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.

Referenced by ilPDSysMessageBlockGUI\getMails().

◆ $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.

◆ $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().

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

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteMail()

◆ executeCommand()

◆ fillDataSection()

◆ fillRow()

◆ getBlockType()

◆ getHTML()

◆ getMails()

◆ getOverview()

◆ getScreenMode()

◆ isRepositoryObject()

◆ preloadData()

◆ showMail()

Field Documentation

◆ $block_type

◆ $ctrl

◆ $inbox

◆ $lng

◆ $mails

◆ $rbacsystem

◆ $setting

◆ $user