ilPDSysMessageBlockGUI Class Reference

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

Inheritance diagram for ilPDSysMessageBlockGUI:

Collaboration diagram for ilPDSysMessageBlockGUI:

Public Member Functions
	ilPDSysMessageBlockGUI ()
	Constructor.
	getHTML ()
	Get HTML.
	getMails ()
	Get Mails.
	getOverview ()
	Get overview.
Public Member Functions inherited from ilPDMailBlockGUI
	ilPDMailBlockGUI ()
	Constructor.
&	executeCommand ()
	execute command
	fillDataSection ()
	Fill data section.
	fillRow ($mail)
	get flat bookmark list for personal desktop
	showMail ()
	show mail
	deleteMail ()
	delete mail
Public Member Functions inherited from ilBlockGUI
	ilBlockGUI ()
	Constructor.
	addHeaderLink ($a_href, $a_text, $status=true)
	getHeaderLinks ()
	setData ($a_data)
	Set Data.
	getData ()
	Get Data.
	setBigMode ($a_bigmode)
	Set Big Mode.
	getBigMode ()
	Get Big Mode.
	setBlockId ($a_block_id=0)
	Set Block Id.
	getBlockId ()
	Get Block Id.
	setAvailableDetailLevels ($a_max, $a_min=0)
	Set Available Detail Levels.
	setCurrentDetailLevel ($a_currentdetaillevel)
	Set Current Detail Level.
	setGuiObject (&$a_gui_object)
	Set GuiObject.
	getGuiObject ()
	Get GuiObject.
	getCurrentDetailLevel ()
	Get Current Detail Level.
	setTitle ($a_title)
	Set Title.
	getTitle ()
	Get Title.
	setImage ($a_image)
	Set Image.
	getImage ()
	Get Image.
	setOffset ($a_offset)
	Set Offset.
	getOffset ()
	Get Offset.
	correctOffset ()
	setLimit ($a_limit)
	Set Limit.
	getLimit ()
	Get Limit.
	setEnableEdit ($a_enableedit)
	Set EnableEdit.
	getEnableEdit ()
	Get EnableEdit.
	setRepositoryMode ($a_repositorymode)
	Set RepositoryMode.
	getRepositoryMode ()
	Get RepositoryMode.
	setFooterInfo ($a_footerinfo, $a_hide_and_icon=false)
	Set Footer Info.
	getFooterInfo ($a_hide_and_icon=false)
	Get Footer Info.
	setSubtitle ($a_subtitle)
	Set Subtitle.
	getSubtitle ()
	Get Subtitle.
	setRefId ($a_refid)
	Set Ref Id (only used if isRepositoryObject() is true).
	getRefId ()
	Get Ref Id (only used if isRepositoryObject() is true).
	setAdminCommands ($a_admincommands)
	Set Administration Commmands.
	getAdminCommands ()
	Get Administration Commmands.
	setColSpan ($a_colspan)
	Set Columns Span.
	getColSpan ()
	Get Columns Span.
	setEnableDetailRow ($a_enabledetailrow)
	Set EnableDetailRow.
	getEnableDetailRow ()
	Get EnableDetailRow.
	setEnableNumInfo ($a_enablenuminfo)
	Set Enable Item Number Info.
	getEnableNumInfo ()
	Get Enable Item Number Info.
	setProperties ($a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties.
	getProperty ($a_property)
	setProperty ($a_property, $a_value)
	setRowTemplate ($a_rowtemplatename, $a_rowtemplatedir="")
	Set Row Template Name.
	getNavParameter ()
	getDetailParameter ()
	getConfigParameter ()
	getMoveParameter ()
	getRowTemplateName ()
	Get Row Template Name.
	getRowTemplateDir ()
	Get Row Template Directory.
	addBlockCommand ($a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false)
	Add Block Command.
	getBlockCommands ()
	Get Block commands.
	addHeaderCommand ($a_href, $a_text, $a_as_close=false)
	Add Header Block Command.
	getHeaderCommands ()
	Get Header Block commands.
	addFooterLink ($a_text, $a_href="", $a_onclick="", $a_block_id="", $a_top=false, $a_omit_separator=false)
	Add a footer text/link.
	getFooterLinks ()
	Get footer links.
	clearFooterLinks ()
	Clear footer links.
	handleDetailLevel ()
	Handle read/write current detail level.
	setConfigMode ($a_configmode)
	Handle config status.
	getConfigMode ()
	Get Config Mode (move blocks).
	fillHeaderCommands ()
	Fill header commands block.
	fillHeaderTitleBlock ()
	Fill header title block (title and.
	setDataSection ($a_content)
	Call this from overwritten fillDataSection(), if standard row based data is not used.
	fillFooter ()
	fillPreviousNext ()
	Fill previous/next row.
	setPreviousNextLinks ()
	Get previous/next linkbar.
	fillFooterLinks ($a_top=false, $a_numinfo="")
	Fill footer links.
	fillDetailRow ()
	Fill Detail Setting Row.
	fillMoveRow ()
	Fill row for Moving.
	getAllowMove ($a_direction)
	setAllowMove ($a_direction, $a_allow=true)
	fillMoveLink ($a_value, $a_img, $a_txt)

Static Public Member Functions
static	getBlockType ()
	Get block type.
static	isRepositoryObject ()
	Get block type.
Static Public Member Functions inherited from ilPDMailBlockGUI
static	getScreenMode ()
	Get Screen Mode for current command.

Static Public Attributes
static	$block_type = "pdsysmess"
Static Public Attributes inherited from ilPDMailBlockGUI
static	$block_type = "pdmail"

Additional Inherited Members
Protected Member Functions inherited from ilPDMailBlockGUI
	getUserInstance ($a_usr_id)
	Caching method for user instances.
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 = ""

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 34 of file class.ilPDSysMessageBlockGUI.php.

Member Function Documentation

static ilPDSysMessageBlockGUI::getBlockType ( )

static

Get block type.

Returns

string Block type.

Reimplemented from ilPDMailBlockGUI.

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

References $block_type.

        {
                return self::$block_type;
        }

ilPDSysMessageBlockGUI::getHTML

(

)

Get HTML.

Reimplemented from ilPDMailBlockGUI.

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

References 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:

ilPDSysMessageBlockGUI::getMails

(

)

Get Mails.

Reimplemented from ilPDMailBlockGUI.

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

References $_SESSION.

        {
                global $ilUser;
                
                // BEGIN MAILS
                $umail = new ilMail($_SESSION["AccountId"]);
                $mbox = new ilMailBox($_SESSION["AccountId"]);
                $inbox = $mbox->getInboxFolder();
                
                //SHOW MAILS FOR EVERY USER
                $this->mails = $umail->getMailsOfFolder($inbox, array('status' => 'unread', 'type' => 'system'));
        }

ilPDSysMessageBlockGUI::getOverview

(

)

Get overview.

Reimplemented from ilPDMailBlockGUI.

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

References $ilCtrl, and $lng.

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

ilPDSysMessageBlockGUI::ilPDSysMessageBlockGUI

(

)

Constructor.

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

References $ilCtrl, $lng, ilUtil\getImagePath(), ilPDMailBlockGUI\ilPDMailBlockGUI(), ilBlockGUI\setAvailableDetailLevels(), ilBlockGUI\setImage(), and ilBlockGUI\setTitle().

        {
                global $ilCtrl, $lng, $ilUser;
                parent::ilPDMailBlockGUI();
                $this->setImage(ilUtil::getImagePath("icon_sysmess_s.gif"));
                $this->setTitle($lng->txt("show_system_messages"));
                $this->setAvailableDetailLevels(3, 1);
                $this->mail_mode = "system";
                $this->allow_moving = false;
        }

Here is the call graph for this function:

static ilPDSysMessageBlockGUI::isRepositoryObject ( )

static

Get block type.

Returns

string Block type.

Reimplemented from ilPDMailBlockGUI.

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

        {
                return false;
        }

Field Documentation

ilPDSysMessageBlockGUI::$block_type = "pdsysmess"

static

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

Referenced by getBlockType().

---

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

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