Inheritance diagram for ilMailFolderTableGUI:

Collaboration diagram for ilMailFolderTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_current_folder_id, $a_parent_cmd= '')
	Constructor.
	prepareHTML ()
	Call this before using getHTML()
	isDraftFolder ($a_bool=null)
	Setter/Getter for folder status.
	isSentFolder ($a_bool=null)
	Setter/Getter for folder status.
	isTrashFolder ($a_bool=null)
	Setter/Getter for folder status.
	setSelectedItems ($a_selected_items)
	Set the selected items.
	getSelectedItems ()
	Get all selected items.
	setNumerOfMails ($a_number_of_mails)
	Set the total number of mails of the current folder.
	getNumerOfMails ()
	Returns the total number of mails of the current folder.
	fillRow ($a_set)
	Fill row.
Public Member Functions inherited from ilTable2GUI
	setOpenFormTag ($a_val)
	Set open form tag.
	getOpenFormTag ()
	Get open form tag.
	setCloseFormTag ($a_val)
	Set close form tag.
	getCloseFormTag ()
	Get close form tag.
	determineLimit ()
	Determine the limit.
	getSelectableColumns ()
	Get selectable columns.
	determineSelectedColumns ()
	Determine selected columns.
	isColumnSelected ($a_col)
	Is given column selected?
	getSelectedColumns ()
	Get selected columns.
&	executeCommand ()
	Execute command.
	resetOffset ($a_in_determination=false)
	Reset offset.
	initFilter ()
	Init filter.
	getParentObject ()
	Get parent object.
	getParentCmd ()
	Get parent command.
	setTopAnchor ($a_val)
	Set top anchor.
	getTopAnchor ()
	Get top anchor.
	setNoEntriesText ($a_text)
	Set text for an empty table.
	getNoEntriesText ()
	Get text for an empty table.
	setIsDataTable ($a_val)
	Set is data table.
	getIsDataTable ()
	Get is data table.
	setEnableTitle ($a_enabletitle)
	Set Enable Title.
	getEnableTitle ()
	Get Enable Title.
	setEnableHeader ($a_enableheader)
	Set Enable Header.
	getEnableHeader ()
	Get Enable Header.
	setEnableNumInfo ($a_val)
	Set enable num info.
	getEnableNumInfo ()
	Get enable num info.
	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	Set title and title icon.
	setDescription ($a_val)
	Set description.
	getDescription ()
	Get description.
	setOrderField ($a_order_field)
	set order column
	getOrderField ()
	setData ($a_data)
	set table data public
	getData ()
	dataExists ()
	setPrefix ($a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) public
	getPrefix ()
	addFilterItem ($a_input_item, $a_optional=false)
	Add filter item.
	addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
	Add filter by standard type.
	getFilterItems ($a_optionals=false)
	Get filter items.
	getFilterItemByPostVar ($a_post_var)
	setFilterCols ($a_val)
	Set filter columns.
	getFilterCols ()
	Get filter columns.
	setDisableFilterHiding ($a_val=true)
	Set disable filter hiding.
	getDisableFilterHiding ()
	Get disable filter hiding.
	isFilterSelected ($a_col)
	Is given filter selected?
	getSelectedFilters ()
	Get selected filters.
	determineSelectedFilters ()
	Determine selected filters.
	setCustomPreviousNext ($a_prev_link, $a_next_link)
	Set custom previous/next links.
	setFormAction ($a_form_action)
	Set Form action parameter.
	getFormAction ()
	Get Form action parameter.
	setFormName ($a_formname)
	Set Form name.
	getFormName ()
	Get Form name.
	setId ($a_val)
	Set id.
	getId ()
	Get element id.
	setDisplayAsBlock ($a_val)
	Set display as block.
	getDisplayAsBlock ()
	Get display as block.
	getSelectAllCheckbox ()
	Get the name of the checkbox that should be toggled with a select all button.
	setSelectAllCheckbox ($a_select_all_checkbox)
	Set the name of the checkbox that should be toggled with a select all button.
	setExternalSorting ($a_val)
	Set external sorting.
	getExternalSorting ()
	Get external sorting.
	setFilterCommand ($a_val)
	Set filter command.
	getFilterCommand ()
	Get filter command.
	setResetCommand ($a_val)
	Set reset filter command.
	getResetCommand ()
	Get reset filter command.
	setExternalSegmentation ($a_val)
	Set external segmentation.
	getExternalSegmentation ()
	Get external segmentation.
	setRowTemplate ($a_template, $a_template_dir="")
	Set row template.
	setDefaultOrderField ($a_defaultorderfield)
	Set Default order field.
	getDefaultOrderField ()
	Get Default order field.
	setDefaultOrderDirection ($a_defaultorderdirection)
	Set Default order direction.
	getDefaultOrderDirection ()
	Get Default order direction.
	clearCommandButtons ()
	addCommandButton ($a_cmd, $a_text, $a_onclick= '', $a_id="")
	Add Command button.
	addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection= '')
	Add Selection List + Command button.
	addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection= '')
	Add Selection List + Command button for selected items.
	setCloseCommand ($a_link)
	Add command for closing table.
	addMultiCommand ($a_cmd, $a_text)
	Add Command button.
	addHiddenInput ($a_name, $a_value)
	Add Hidden Input field.
	addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
	Add Header Command (Link) (Image needed for now)
	setTopCommands ($a_val)
	Set top commands (display command buttons on top of table, too)
	getTopCommands ()
	Get top commands (display command buttons on top of table, too)
	addColumn ($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="")
	Add a column to the header.
	getNavParameter ()
	setOrderLink ($sort_field, $order_dir)
	fillHeader ()
	determineOffsetAndOrder ($a_omit_offset=false)
	Determine offset and order.
	storeNavParameter ()
	getHTML ()
	Get HTML.
	numericOrdering ($a_field)
	Should this field be sorted numeric?
	render ()
	render table public
	writeFilterToSession ()
	Write filter values to session.
	resetFilter ()
	Reset filter.
	fillFooter ()
	Fill footer row.
	getLinkbar ($a_num)
	Get previous/next linkbar.
	fillHiddenRow ()
	fillActionRow ()
	Fill Action Row.
	setHeaderHTML ($html)
	set header html
	storeProperty ($type, $value)
	Store table property.
	loadProperty ($type)
	Load table property.
	getCurrentState ()
	get current settings for order, limit, columns and filter
	setContext ($id)
	Set context.
	getContext ()
	Get context.
	setShowRowsSelector ($a_value)
	Toggle rows-per-page selector.
	getShowRowsSelector ()
	Get rows-per-page selector state.
	setShowTemplates ($a_value)
	Toggle templates.
	getShowTemplates ()
	Get template state.
	restoreTemplate ($a_name)
	Restore state from template.
	saveTemplate ($a_name)
	Save current state as template.
	deleteTemplate ($a_name)
	Delete template.
	getLimit ()
	Get limit.
	getOffset ()
	Get offset.
	setExportFormats (array $formats)
	Set available export formats.
	setPrintMode ($a_value=false)
	Toogle print mode.
	getPrintMode ()
	Get print mode.
	getExportMode ()
	Was export activated?
	exportData ($format, $send=false)
	Export and optionally send current table data.
Public Member Functions inherited from ilTableGUI
	ilTableGUI ($a_data=0, $a_global_tpl=true)
	Constructor.
	setTemplate (&$a_tpl)
	set template public
&	getTemplateObject ()
	setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
	set table help page public
	setHeaderNames ($a_header_names)
	set table header names public
	getColumnCount ()
	Returns the column count based on the number of the header row columns public.
	setHeaderVars ($a_header_vars, $a_header_params=0)
	set table header vars public
	setColumnWidth ($a_column_width)
	set table column widths public
	setOneColumnWidth ($a_column_width, $a_column_number)
	set one table column width public
	setMaxCount ($a_max_count)
	set max.
	setLimit ($a_limit=0, $a_default_limit=0)
	set max.
	setOffset ($a_offset)
	set dataset offset public
	setOrderColumn ($a_order_column=0, $a_default_column=0)
	set order column public
	getOrderColumn ()
	Get order column.
	setOrderDirection ($a_order_direction)
	set order direction public
	getOrderDirection ()
	Get order direction.
	setFooter ($a_style, $a_previous=0, $a_next=0)
	set order direction public
	enable ($a_module_name)
	enables particular modules of table
	disable ($a_module_name)
	diesables particular modules of table
	sortData ()
	renderHeader ()
	setStyle ($a_element, $a_style)
	getStyle ($a_element)
	setBase ($a_base)
	Set Base script name (deprecated, only use this for workarounds).
	getBase ()
	Get Base script name (deprecated, only use this for workarounds).
	clearActionButtons ()
	addActionButton ($btn_name, $btn_value)

Protected Member Functions
	fetchTableData ()
	fetchTableData
	setTitleData ($folderLabel, $mailCount, $unreadCount, $imgFolder)
	Function to set the table title.
Protected Member Functions inherited from ilTable2GUI
	prepareOutput ()
	Anything that must be done before HTML is generated.
	getFilterValue (ilFormPropertyGUI $a_item)
	Get current filter value.
	SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
	Set current filter value.
	fillMetaExcel ($worksheet, &$a_row)
	Add meta information to excel export.
	fillHeaderExcel ($worksheet, &$a_row)
	Excel Version of Fill Row.
	fillRowExcel ($a_worksheet, &$a_row, $a_set)
	Excel Version of Fill Row.
	fillMetaCSV ($a_csv)
	Add meta information to csv export.
	fillHeaderCSV ($a_csv)
	CSV Version of Fill Header.
	fillRowCSV ($a_csv, $a_set)
	CSV Version of Fill Row.

Protected Attributes
	$lng = null
	$ctrl = null
	$_folderNode = array()
	$_parentObject = null
	$_currentFolderId = 0
	$_number_of_mails = 0
	$_selectedItems = array()
	$_isTrashFolder = false
	$_isDraftsFolder = false
	$_isSentFolder = false
Protected Attributes inherited from ilTable2GUI
	$close_command = ""
	$top_anchor = "il_table_top"
	$filters = array()
	$optional_filters = array()
	$filter_cmd = 'applyFilter'
	$reset_cmd = 'resetFilter'
	$filter_cols = 4
	$ext_sort = false
	$ext_seg = false
	$context = ""
	$mi_sel_buttons = null
	$disable_filter_hiding = false
	$selected_filter = false
	$top_commands = true
	$selectable_columns = array()
	$selected_column = array()
	$show_templates = false
	$show_rows_selector = false
	$nav_determined = false
	$limit_determined = false
	$filters_determined = false
	$columns_determined = false
	$open_form_tag = true
	$close_form_tag = true
	$export_formats
	$export_mode
	$print_mode

Private Member Functions
	initCommandButtons ()
	Performs special actions for folders such as user folders, trash and local folders.
	initMultiCommands ($actions)
	initMultiCommands
	getUserInstance ($a_usr_id)
	Caching method for user instances.

Additional Inherited Members
Data Fields inherited from ilTable2GUI
const	FILTER_TEXT = 1
const	FILTER_SELECT = 2
const	FILTER_DATE = 3
const	FILTER_LANGUAGE = 4
const	FILTER_NUMBER_RANGE = 5
const	FILTER_DATE_RANGE = 6
const	FILTER_DURATION_RANGE = 7
const	EXPORT_EXCEL = 1
const	EXPORT_CSV = 2

Detailed Description

Author: Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e; Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version

Id:: class.ilMailFolderTableGUI.php 35235 2012-06-27 09:21:25Z nkrzywon

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

Constructor & Destructor Documentation

ilMailFolderTableGUI::__construct	(	$a_parent_obj,
		$a_current_folder_id,
		$a_parent_cmd = `''`
	)

Constructor.

public

Parameters

ilObjectGUI	$a_parent_obj	Pass an instance of ilObjectGUI
integer	$a_current_folder_id	Id of the current mail box folder
string	$a_parent_cmd	Command for the parent class

Reimplemented from ilTable2GUI.

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

References $ilCtrl, $lng, ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setPrefix(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setSelectAllCheckbox().

        {
                global $lng, $ilCtrl;
                
                $this->lng = $lng;
                $this->ctrl = $ilCtrl;
                $this->_currentFolderId = $a_current_folder_id;
                $this->_parentObject = $a_parent_obj;
                
                $this->setId('mail_folder_tbl');        
                $this->setPrefix('mtable');
 
                parent::__construct($a_parent_obj, $a_parent_cmd);
                
                $this->setFormAction($this->ctrl->getFormAction($this->_parentObject, 'showFolder'));
                
                $this->setEnableTitle(true);
                $this->setExternalSorting(true);
                $this->setExternalSegmentation(true);
                $this->setDefaultOrderField('send_time');
                $this->setDefaultOrderDirection('desc');                
                $this->setSelectAllCheckbox('mail_id[]');               
                $this->setRowTemplate('tpl.mail_folder_row.html', 'Services/Mail');
        }

Here is the call graph for this function:

Member Function Documentation

ilMailFolderTableGUI::fetchTableData ( )

protected

fetchTableData

protected

Returns: ilMailFolderTableGUI

Definition at line 285 of file class.ilMailFolderTableGUI.php.

References $_currentFolderId, ilTableGUI\$data, ilMailBoxQuery\$folderId, ilMailBoxQuery\$limit, ilMailBoxQuery\$offset, ilMailBoxQuery\$orderColumn, ilMailBoxQuery\$orderDirection, ilMailBoxQuery\$userId, ilMailBoxQuery\_getMailBoxListData(), ilObjUser\_lookupPref(), ilTable2GUI\determineOffsetAndOrder(), ilDatePresentation\formatDate(), ilUtil\getImagePath(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), getSelectedItems(), getUserInstance(), IL_CAL_DATETIME, isDraftFolder(), isSentFolder(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), setNumerOfMails(), and setTitleData().

Referenced by prepareHTML().

        {
                global $ilUser;
                
                $this->determineOffsetAndOrder();
                
                require_once 'Services/Mail/classes/class.ilMailBoxQuery.php';
                
                ilMailBoxQuery::$folderId = $this->_currentFolderId;
                ilMailBoxQuery::$userId = $ilUser->getId();
                ilMailBoxQuery::$limit = $this->getLimit();
                ilMailBoxQuery::$offset = $this->getOffset();
                ilMailBoxQuery::$orderDirection = $this->getOrderDirection();
                ilMailBoxQuery::$orderColumn = $this->getOrderField();          
                $data = ilMailBoxQuery::_getMailBoxListData();
                
                if(!count($data['set']) && $this->getOffset() > 0)
                {
                        $this->resetOffset();
                        
                        ilMailBoxQuery::$limit = $this->getLimit();
                        ilMailBoxQuery::$offset = $this->getOffset();                   
                        $data = ilMailBoxQuery::_getMailBoxListData();
                }
                
                $counter = 0;
                foreach($data['set'] as $key => $mail)
                {
                        ++$counter;
                        if(is_array($this->getSelectedItems()) &&
                           in_array($mail['mail_id'], $this->getSelectedItems()))
                        {
                                $mail['checked'] = ' checked="checked" ';
                        }
                        // GET FULLNAME OF SENDER
                        if($this->isDraftFolder() || $this->isSentFolder())
                        {
                                $mail['mail_login'] = $this->_parentObject->umail->formatNamesForOutput($mail['rcp_to']);
                        }
                        else
                        {
                                if($mail['sender_id'] != ANONYMOUS_USER_ID)
                                {
                                        $tmp_user = $this->getUserInstance($mail['sender_id']); 
                                        if(in_array(ilObjUser::_lookupPref($mail['sender_id'], 'public_profile'), array('y', 'g')))
                                        {
                                                $mail['mail_from'] = $tmp_user->getFullname();
                                        }
                                        if(!($login = $tmp_user->getLogin()))
                                        {
                                                $login = $mail['import_name'].' ('.$this->lng->txt('user_deleted').')';
                                                $mail['mail_login'] = $mail['import_name'].' ('.$this->lng->txt('user_deleted').')';                            
                                        }
                                        
                                        $mail['img_sender'] = $tmp_user->getPersonalPicturePath('xxsmall');
                                        $mail['mail_login'] = $mail['alt_sender'] = $login;
                                }
                                else
                                {
                                        $tmp_user = $this->getUserInstance(ANONYMOUS_USER_ID);  
                                        $mail['img_sender'] = ilUtil::getImagePath('HeaderIcon50.png');
                                        $mail['mail_login'] = $mail['alt_sender'] = ilMail::_getIliasMailerName();
                                }
                        }
                        $mail['mailclass'] = $mail['m_status'] == 'read' ? 'mailread' : 'mailunread';
                        
                        // IF ACTUAL FOLDER IS DRAFT BOX, DIRECT TO COMPOSE MESSAGE
                        if($this->isDraftFolder())
                        {
                                $this->ctrl->setParameterByClass('ilmailformgui', 'mail_id', $mail['mail_id']);
                                $this->ctrl->setParameterByClass('ilmailformgui', 'type', 'draft');
                                $mail['mail_link_read'] = $this->ctrl->getLinkTargetByClass('ilmailformgui');
                                $this->ctrl->clearParametersByClass('ilmailformgui');
                        }
                        else
                        {
                                $this->ctrl->setParameter($this->_parentObject, 'mail_id', $mail['mail_id']);
                                $this->ctrl->setParameter($this->_parentObject, 'cmd', 'showMail');
                                $mail['mail_link_read'] = $this->ctrl->getLinkTarget($this->_parentObject);
                                $this->ctrl->clearParameters($this->_parentObject);
                        }
                        
                        $mail['mail_subject'] = htmlspecialchars($mail['m_subject']);
                        $mail['mail_date'] = ilDatePresentation::formatDate(new ilDateTime($mail['send_time'], IL_CAL_DATETIME));
                        
                        $data['set'][$key] = $mail;
                }               
                
                $this->setData($data['set']);
                $this->setMaxCount($data['cnt']);
                $this->setNumerOfMails($data['cnt']);
                // table title
                $txt_folder = '';
                $img_folder = '';
                if($this->_folderNode['m_type'] == 'user_folder')
                {
                        $txt_folder = $this->_folderNode['title'];
                        $img_folder = 'icon_user_folder.gif';           
                }
                else
                {
                        $txt_folder = $this->lng->txt('mail_'.$this->_folderNode['title']);
                        $img_folder = 'icon'.substr($this->_folderNode['title'], 1).'.gif';
                }               
                $this->setTitleData($txt_folder, $data['cnt'], $data['cnt_unread'], $img_folder);
                
                return $this;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMailFolderTableGUI::fillRow ( $a_set )

Fill row.

public

Parameters

array $a_set result set array (assoc.)

Reimplemented from ilTable2GUI.

Definition at line 460 of file class.ilMailFolderTableGUI.php.

        {
                foreach($a_set as $key => $value)
                {
                        $this->tpl->setVariable(strtoupper($key), $value);
                }               
        }       

ilMailFolderTableGUI::getNumerOfMails ( )

Returns the total number of mails of the current folder.

public

Returns: integer total number of mails of the current folder

Definition at line 447 of file class.ilMailFolderTableGUI.php.

References $_number_of_mails.

        {
                return $this->_number_of_mails;
        }

ilMailFolderTableGUI::getSelectedItems ( )

Get all selected items.

public

Returns: integer selected items

Definition at line 272 of file class.ilMailFolderTableGUI.php.

References $_selectedItems.

Referenced by fetchTableData().

        {
                return $this->_selectedItems;
        }

Here is the caller graph for this function:

ilMailFolderTableGUI::getUserInstance ( $a_usr_id )

private

Caching method for user instances.

private

Parameters

integer $a_usr_id Id of a user instance

Returns: ilObjUser

Definition at line 237 of file class.ilMailFolderTableGUI.php.

Referenced by fetchTableData().

        {               
                static $userObjectCache = array();
                
                if(isset($userObjectCache[$a_usr_id])) return $userObjectCache[$a_usr_id];
                
                $userObjectCache[$a_usr_id] = new ilObjUser($a_usr_id);
                
                return $userObjectCache[$a_usr_id];
        }

Here is the caller graph for this function:

ilMailFolderTableGUI::initCommandButtons ( )

private

Performs special actions for folders such as user folders, trash and local folders.

private

Returns: ilMailFolderTableGUI

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

References ilTable2GUI\addCommandButton().

Referenced by prepareHTML().

        {
                if($this->_folderNode['m_type'] == 'trash')
                {
                        $this->addCommandButton('askForEmptyTrash', $this->lng->txt('mail_empty_trash'));
                }
                
                return $this;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMailFolderTableGUI::initMultiCommands ( $actions )

private

initMultiCommands

private

Parameters

array $actions array for multi commands

Returns: ilMailFolderTableGUI

Definition at line 195 of file class.ilMailFolderTableGUI.php.

References ilTable2GUI\addMultiCommand(), and isTrashFolder().

Referenced by prepareHTML().

        {
                foreach($actions as $key => $action)
                {
                        if($key == 'moveMails')
                        {
                                $folders = $this->_parentObject->mbox->getSubFolders();
                                foreach($folders as $folder)
                                {
                                        if($folder['type'] != 'trash' || 
                                           !$this->isTrashFolder())
                                        {
                                                if($folder['type'] != 'user_folder')
                                                {
                                                        $label = $action.' '.$this->lng->txt('mail_'.$folder['title']).
                                                                ($folder['type'] == 'trash' ? ' ('.$this->lng->txt('delete').')' : '');
                                                        $this->addMultiCommand($folder['obj_id'], $label);
                                                }
                                                else
                                                        $this->addMultiCommand($folder['obj_id'], $action.' '.$folder['title']);
                                        }
                                }
                        }
                        else
                        {
                                if($key != 'deleteMails' || $this->isTrashFolder())
                                        $this->addMultiCommand($key, $action);
                        }
                }
                
                return $this;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMailFolderTableGUI::isDraftFolder ( $a_bool = null )

Setter/Getter for folder status.

public

Parameters

mixed $a_bool Boolean folder status or null

Returns: mixed Either an object of type ilMailFolderTableGUI or the boolean folder status

Definition at line 113 of file class.ilMailFolderTableGUI.php.

References $_isDraftsFolder.

Referenced by fetchTableData(), and prepareHTML().

        {
                if(null === $a_bool)
                {
                        return $this->_isDraftsFolder;
                }
                
                $this->_isDraftsFolder = $a_bool;
                
                return $this;
        }

Here is the caller graph for this function:

ilMailFolderTableGUI::isSentFolder ( $a_bool = null )

Setter/Getter for folder status.

public

Parameters

mixed $a_bool Boolean folder status or null

Returns: mixed Either an object of type ilMailFolderTableGUI or the boolean folder status

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

References $_isSentFolder.

Referenced by fetchTableData(), and prepareHTML().

        {
                if(null === $a_bool)
                {
                        return $this->_isSentFolder;
                }
                
                $this->_isSentFolder = $a_bool;
                
                return $this;
        }

Here is the caller graph for this function:

ilMailFolderTableGUI::isTrashFolder ( $a_bool = null )

Setter/Getter for folder status.

public

Parameters

mixed $a_bool Boolean folder status or null

Returns: mixed Either an object of type ilMailFolderTableGUI or the boolean folder status

Definition at line 155 of file class.ilMailFolderTableGUI.php.

References $_isTrashFolder.

Referenced by initMultiCommands().

        {
                if(null === $a_bool)
                {
                        return $this->_isTrashFolder;
                }
                
                $this->_isTrashFolder = $a_bool;
                
                return $this;
        }

Here is the caller graph for this function:

ilMailFolderTableGUI::prepareHTML ( )

final

Call this before using getHTML()

public

Returns: ilMailFolderTableGUI

Definition at line 74 of file class.ilMailFolderTableGUI.php.

References ilTable2GUI\addColumn(), fetchTableData(), initCommandButtons(), initMultiCommands(), isDraftFolder(), isSentFolder(), and ilTree\setTableNames().

        {
                global $ilUser;
                
                $this->addColumn('', 'sort', '5%', true);
                $this->addColumn($this->lng->txt('personal_picture'), '', '10%');
                if($this->isDraftFolder() || $this->isSentFolder())
                        $this->addColumn($this->lng->txt('recipient'), 'rcp_to', '25%');
                else
                        $this->addColumn($this->lng->txt('sender'), 'from', '25%');
                $this->addColumn($this->lng->txt('subject'), 'm_subject', '40%');
                $this->addColumn($this->lng->txt('date'), 'send_time', '20%');  
                
                // init folder data
                $mtree = new ilTree($ilUser->getId());
                $mtree->setTableNames('mail_tree', 'mail_obj_data');
                $this->_folderNode = $mtree->getNodeData($this->_currentFolderId);
                
                // command buttons
                $this->initCommandButtons();
                
                // mail actions
                $this->initMultiCommands($this->_parentObject->mbox->getActions($this->_currentFolderId));
                
                // fetch table data
                $this->fetchTableData();
                
                return $this;
        }

Here is the call graph for this function:

ilMailFolderTableGUI::setNumerOfMails ( $a_number_of_mails )

Set the total number of mails of the current folder.

public

Parameters

integer $a_number_of_mails total number of mails of the current folder

Returns: ilMailFolderTableGUI

Definition at line 432 of file class.ilMailFolderTableGUI.php.

Referenced by fetchTableData().

        {
                $this->_number_of_mails = $a_number_of_mails;
                
                return $this;
        }

Here is the caller graph for this function:

ilMailFolderTableGUI::setSelectedItems ( $a_selected_items )

Set the selected items.

public

Parameters

integer $a_selected_items selected items

Returns: ilMailFolderTableGUI

Definition at line 257 of file class.ilMailFolderTableGUI.php.

        {
                $this->_selectedItems = $a_selected_items;
                
                return $this;
        }

ilMailFolderTableGUI::setTitleData	(	$folderLabel,
		$mailCount,
		$unreadCount,
		$imgFolder
	)

protected

Function to set the table title.

protected

Parameters

string	$folderLabel	table title
integer	$mailCount	number of total mails of the current folder
integer	$unreadCount	number of unread mails of the current folder
string	$imgFolder	image path

Returns: ilMailFolderTableGUI

Definition at line 409 of file class.ilMailFolderTableGUI.php.

References ilTable2GUI\setTitle().

Referenced by fetchTableData().

        {
                $titleTemplate = new ilTemplate('tpl.mail_folder_title.html', true, true, 'Services/Mail');
                $titleTemplate->setVariable('TXT_FOLDER', $folderLabel);
                $titleTemplate->setVariable('MAIL_COUNT', $mailCount);
                $titleTemplate->setVariable('TXT_MAIL_S', $this->lng->txt('mail_s'));
                $titleTemplate->setVariable('MAIL_COUNT_UNREAD', $unreadCount);
                $titleTemplate->setVariable('TXT_UNREAD', $this->lng->txt('unread'));
                
                parent::setTitle($titleTemplate->get(), $imgFolder);
                
                return $this;
        }