BlockGUI class for System Messages block on personal desktop. More...

Inheritance diagram for ilPDSysMessageBlockGUI:

Collaboration diagram for ilPDSysMessageBlockGUI:

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

	getBlockType ()

	getHTML ()

	getMails ()
	Get Mails. More...

	getOverview ()
	Get overview. More...

Public Member Functions inherited from ilPDMailBlockGUI
	__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 Attributes
static	$block_type = "pdsysmess"

Static Public Attributes inherited from ilPDMailBlockGUI
static	$block_type = 'pdmail'

Protected Member Functions
	isRepositoryObject ()

Protected Member Functions inherited from ilPDMailBlockGUI
	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...

Additional Inherited Members
Static Public Member Functions inherited from ilPDMailBlockGUI
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...

Protected Attributes inherited from ilPDMailBlockGUI
	$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 System Messages block on personal desktop.

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

Version: $Id$

ilPDSysMessageBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilPDSysMessageBlockGUI::__construct ( )

Constructor.

Definition at line 21 of file class.ilPDSysMessageBlockGUI.php.

References ilBlockGUI\setAvailableDetailLevels(), and ilBlockGUI\setTitle().

     {
         parent::__construct();
 
         $this->setTitle($this->lng->txt("show_system_messages"));
         $this->setAvailableDetailLevels(3);
         $this->mail_mode = "system";
         $this->allow_moving = false;
     }

Here is the call graph for this function:

Member Function Documentation

◆ getBlockType()

ilPDSysMessageBlockGUI::getBlockType ( )

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

                                    : string
     {
         return self::$block_type;
     }

◆ getHTML()

ilPDSysMessageBlockGUI::getHTML ( )

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

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

     {
         if ($this->getCurrentDetailLevel() < 1) {
             $this->setCurrentDetailLevel(1);
         }
 
         $html = parent::getHTML();
         
         if (count($this->mails) == 0) {
             return "";
         } else {
             return $html;
         }
     }

Here is the call graph for this function:

◆ getMails()

ilPDSysMessageBlockGUI::getMails ( )

Get Mails.

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

References ilPDMailBlockGUI\$inbox, ilMail\getMailsOfFolder(), and user().

     {
         $umail = new ilMail($this->user->getId());
         $mbox = new ilMailbox($this->user->getId());
         $inbox = $mbox->getInboxFolder();
 
         $this->mails = $umail->getMailsOfFolder($inbox, array('status' => 'unread', 'type' => 'system'));
     }

Here is the call graph for this function:

◆ getOverview()

ilPDSysMessageBlockGUI::getOverview ( )

Get overview.

Definition at line 77 of file class.ilPDSysMessageBlockGUI.php.

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

◆ isRepositoryObject()

ilPDSysMessageBlockGUI::isRepositoryObject ( )

protected

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

                                             : bool
     {
         return false;
     }

Field Documentation

◆ $block_type

ilPDSysMessageBlockGUI::$block_type = "pdsysmess"

static

Definition at line 16 of file class.ilPDSysMessageBlockGUI.php.

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

Services/Mail/classes/class.ilPDSysMessageBlockGUI.php

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getBlockType()

◆ getHTML()

◆ getMails()

◆ getOverview()

◆ isRepositoryObject()

Field Documentation

◆ $block_type