ilMailFolderTableGUI Class Reference

Inheritance diagram for ilMailFolderTableGUI:

Collaboration diagram for ilMailFolderTableGUI:

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

Protected Member Functions
	isLuceneSearchEnabled ()
	fetchTableData ()
	setTitleData ($folderLabel, $mailCount, $unreadCount, $imgFolder)
	Function to set the table title @access protected. More...
Protected Member Functions inherited from ilTable2GUI
	prepareOutput ()
	Anything that must be done before HTML is generated. More...
	isFilterVisible ()
	Check if filter is visible: manually shown (session, db) or default value set. More...
	isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element)
	Check if filter element is based on adv md. More...
	fillRow ($a_set)
	Standard Version of Fill Row. More...
	getFilterValue (ilFormPropertyGUI $a_item)
	Get current filter value. More...
	SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
	Set current filter value. More...
	fillMetaExcel (ilExcel $a_excel, &$a_row)
	Add meta information to excel export. More...
	fillHeaderExcel (ilExcel $a_excel, &$a_row)
	Excel Version of Fill Header. More...
	fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
	Excel Version of Fill Row. More...
	fillMetaCSV ($a_csv)
	Add meta information to csv export. More...
	fillHeaderCSV ($a_csv)
	CSV Version of Fill Header. More...
	fillRowCSV ($a_csv, $a_set)
	CSV Version of Fill Row. More...

Protected Attributes
	$lng
	$ctrl
	$user
	$_folderNode = array()
	$_parentObject = null
	$_currentFolderId = 0
	$_number_of_mails = 0
	$_selectedItems = array()
	$_isTrashFolder = false
	$_isDraftsFolder = false
	$_isSentFolder = false
	$filter = array()
	$sub_filter = array()
Protected Attributes inherited from ilTable2GUI
	$ctrl
	$tpl
	$parent_obj
	$parent_cmd
	$close_command = ""
	$top_anchor = "il_table_top"
	$filters = array()
	$optional_filters = array()
	$filter_cmd = 'applyFilter'
	$reset_cmd = 'resetFilter'
	$filter_cols = 5
	$ext_sort = false
	$ext_seg = false
	$context = ""
	$mi_sel_buttons = []
	$disable_filter_hiding = false
	$selected_filter = false
	$top_commands = true
	$selectable_columns = array()
	$selected_column = array()
	$show_templates = false
	$show_rows_selector = true
	$rows_selector_off = 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
	$enable_command_for_all
	$restore_filter
	$restore_filter_values
	$default_filter_visibility = false
	$sortable_fields = array()
	$prevent_double_submission = true
	$row_selector_label
	$sel_buttons = []
Protected Attributes inherited from ilTableGUI
	$tpl
	$lng

Private Member Functions
	initCommandButtons ()
	Performs special actions for folders such as user folders, trash and local folders @access private. More...
	initMultiCommands ($actions)
	initMultiCommands @access private More...

Additional Inherited Members
Static Public Member Functions inherited from ilTable2GUI
static	getAllCommandLimit ()
	Get maximum number of entries to enable actions for all. More...
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	FILTER_DATETIME_RANGE = 8
const	FILTER_CHECKBOX = 9
const	EXPORT_EXCEL = 1
const	EXPORT_CSV = 2
const	ACTION_ALL_LIMIT = 1000
Data Fields inherited from ilTableGUI
	$title
	$icon
	$icon_alt
	$help_page
	$help_icon
	$help_icon_alt
	$header_names
	$header_vars
	$linkbar_vars
	$data
	$column_count
	$column_width
	$max_count
	$limit
	$max_limit = false
	$offset
	$order_column
	$order_direction
	$footer_style
	$footer_previous
	$footer_next
	$lang_support = true
	$global_tpl
	$form_name
	$select_all_checkbox
	$action_buttons
	$prefix
	$base = ""
	$enabled
	$styles

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$

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

Constructor & Destructor Documentation

__construct()

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

Constructor @access public.

Parameters

	$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 58 of file class.ilMailFolderTableGUI.php.

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

References $DIC, ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setPrefix(), ilTable2GUI\setResetCommand(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and user().

Here is the call graph for this function:

Member Function Documentation

fetchTableData()

ilMailFolderTableGUI::fetchTableData ( )

protected

Returns

$this

Exceptions

Exception

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

    {
        if ($this->_folderNode['m_type'] == 'user_folder') {
            $txt_folder = $this->_folderNode['title'];
            $img_folder = 'icon_user_folder.png';
        } else {
            $txt_folder = $this->lng->txt('mail_' . $this->_folderNode['title']);
            $img_folder = 'icon' . substr($this->_folderNode['title'], 1) . '.png';
        }
 
        try {
            if ($this->isLuceneSearchEnabled()) {
                include_once 'Services/Mail/classes/class.ilMailLuceneQueryParser.php';
                $query_parser = new ilMailLuceneQueryParser($this->filter['mail_filter']);
                $query_parser->setFields(array(
                    'title'       => (bool) $this->filter['mail_filter_subject'],
                    'content'     => (bool) $this->filter['mail_filter_body'],
                    'mattachment' => (bool) $this->filter['mail_filter_attach'],
                    'msender'     => (bool) $this->filter['mail_filter_sender'],
                    'mrcp'        => (bool) $this->filter['mail_filter_recipients']
                ));
                $query_parser->parse();
                
                require_once 'Services/Mail/classes/class.ilMailLuceneSearcher.php';
                require_once 'Services/Mail/classes/class.ilMailSearchResult.php';
                $result = new ilMailSearchResult();
                $searcher = new ilMailLuceneSearcher($query_parser, $result);
                $searcher->search($this->user->getId(), $this->_currentFolderId);
 
                if (!$result->getIds()) {
                    throw new ilException('mail_search_empty_result');
                }
    
                ilMailBoxQuery::$filtered_ids   = $result->getIds();
                ilMailBoxQuery::$filter         = array();
            } else {
                ilMailBoxQuery::$filter         = (array) $this->filter;
            }
                
            $this->determineOffsetAndOrder();
    
            ilMailBoxQuery::$folderId       = $this->_currentFolderId;
            ilMailBoxQuery::$userId         = $this->user->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();
            }
        } catch (Exception $e) {
            $this->setTitleData($txt_folder, 0, 0, $img_folder);
 
            if ('mail_search_empty_result' == $e->getMessage()) {
                $data['set'] = array();
                $data['cnt'] = 0;
            } else {
                throw $e;
            }
        }
 
        if (!$this->isDraftFolder() && !$this->isSentFolder()) {
            $user_ids = array();
            foreach ($data['set'] as $mail) {
                if ($mail['sender_id'] && $mail['sender_id'] != ANONYMOUS_USER_ID) {
                    $user_ids[$mail['sender_id']] = $mail['sender_id'];
                }
            }
 
            ilMailUserCache::preloadUserObjects($user_ids);
        }
 
        $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" ';
            }
 
            if ($this->isDraftFolder() || $this->isSentFolder()) {
                $mail['rcp_to'] = $mail['mail_login'] = ilUtil::htmlencodePlainString(
                    $this->_parentObject->umail->formatNamesForOutput($mail['rcp_to']),
                    false
                );
            } else {
                if ($mail['sender_id'] == ANONYMOUS_USER_ID) {
                    $mail['img_sender'] = ilUtil::getImagePath('HeaderIconAvatar.svg');
                    $mail['from'] = $mail['mail_login'] = $mail['alt_sender'] = htmlspecialchars(ilMail::_getIliasMailerName());
                } else {
                    $user = ilMailUserCache::getUserObjectById($mail['sender_id']);
                    if ($user) {
                        $mail['img_sender'] = $user->getPersonalPicturePath('xxsmall');
                        $mail['from'] = $mail['mail_login'] = $mail['alt_sender'] = htmlspecialchars($user->getPublicName());
                    } else {
                        $mail['from'] = $mail['mail_login'] = $mail['import_name'] . ' (' . $this->lng->txt('user_deleted') . ')';
                    }
                }
            }
 
            if ($this->isDraftFolder()) {
                $this->ctrl->setParameterByClass('ilmailformgui', 'mail_id', $mail['mail_id']);
                $this->ctrl->setParameterByClass('ilmailformgui', 'type', 'draft');
                $link_mark_as_read = $this->ctrl->getLinkTargetByClass('ilmailformgui');
                $this->ctrl->clearParametersByClass('ilmailformgui');
            } else {
                $this->ctrl->setParameter($this->_parentObject, 'mail_id', $mail['mail_id']);
                $link_mark_as_read = $this->ctrl->getLinkTarget($this->_parentObject, 'showMail');
                $this->ctrl->clearParameters($this->_parentObject);
            }
            $css_class = $mail['m_status'] == 'read' ? 'mailread' : 'mailunread';
 
            if ($this->isLuceneSearchEnabled()) {
                $search_result = array();
                foreach ($result->getFields($mail['mail_id']) as $content) {
                    if ('title' == $content[0]) {
                        $mail['msr_subject_link_read'] = $link_mark_as_read;
                        $mail['msr_subject_mailclass'] = $css_class;
                        $mail['msr_subject']           = $content[1];
                    } else {
                        $search_result[] = $content[1];
                    }
                }
                $mail['msr_data'] = implode('', array_map(function ($value) {
                    return '<p>' . $value . '</p>';
                }, $search_result));
                
                if (!$mail['msr_subject']) {
                    $mail['msr_subject_link_read'] = $link_mark_as_read;
                    $mail['msr_subject_mailclass'] = $css_class;
                    $mail['msr_subject']           = htmlspecialchars($mail['m_subject']);
                }
            } else {
                $mail['mail_link_read'] = $link_mark_as_read;
                $mail['mailclass']      = $css_class;
                $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']);
 
        $this->setTitleData($txt_folder, $data['cnt'], $data['cnt_unread'], $img_folder);
 
        return $this;
    }

References $_currentFolderId, $counter, ilTableGUI\$data, ilMailBoxQuery\$filter, ilMailBoxQuery\$filtered_ids, ilMailBoxQuery\$folderId, $key, ilMailBoxQuery\$limit, ilMailBoxQuery\$offset, ilMailBoxQuery\$orderColumn, ilMailBoxQuery\$orderDirection, $result, $user, ilMailBoxQuery\$userId, ilMailBoxQuery\_getMailBoxListData(), ilTable2GUI\determineOffsetAndOrder(), ilDatePresentation\formatDate(), ilUtil\getImagePath(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), getSelectedItems(), ilMailUserCache\getUserObjectById(), ilUtil\htmlencodePlainString(), IL_CAL_DATETIME, isDraftFolder(), isLuceneSearchEnabled(), isSentFolder(), ilMailUserCache\preloadUserObjects(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), setNumerOfMails(), setTitleData(), and user().

Referenced by prepareHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

fillRow()

ilMailFolderTableGUI::fillRow

(

$a_set

)

Fill row @access public.

Parameters

array

$a_set

result set array (assoc.)

Reimplemented from ilTable2GUI.

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

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

References $key.

getNumerOfMails()

ilMailFolderTableGUI::getNumerOfMails

(

)

Returns the total number of mails of the current folder @access public.

Returns

integer total number of mails of the current folder

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

    {
        return $this->_number_of_mails;
    }

References $_number_of_mails.

Referenced by initCommandButtons().

Here is the caller graph for this function:

getSelectedItems()

ilMailFolderTableGUI::getSelectedItems

(

)

Get all selected items @access public.

Returns

array

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

    {
        return $this->_selectedItems;
    }

References $_selectedItems.

Referenced by fetchTableData().

Here is the caller graph for this function:

initCommandButtons()

ilMailFolderTableGUI::initCommandButtons ( )

private

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

Returns

ilMailFolderTableGUI

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

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

References ilTable2GUI\addCommandButton(), and getNumerOfMails().

Referenced by prepareHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

initFilter()

ilMailFolderTableGUI::initFilter

(

)

Init filter.

Overwrite this to initialize all filter input property objects.

Reimplemented from ilTable2GUI.

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

    {
        $this->filter = array();
        
        include_once 'Services/Mail/classes/Form/class.ilMailQuickFilterInputGUI.php';
        $ti = new ilMailQuickFilterInputGUI($this->lng->txt('mail_filter'), 'mail_filter');
        $ti->setSubmitFormOnEnter(false);
        $this->addFilterItem($ti);
        $ti->readFromSession();
        $this->filter['mail_filter'] = $ti->getValue();
 
        include_once 'Services/Form/classes/class.ilCheckboxInputGUI.php';
 
        if ($this->isDraftFolder() || $this->isSentFolder()) {
            $this->sub_filter[] = $ci = new ilCheckboxInputGUI($this->lng->txt('mail_filter_recipients'), 'mail_filter_recipients');
            $ci->setOptionTitle($this->lng->txt('mail_filter_recipients'));
            $ci->setValue(1);
            $ti->addSubItem($ci);
            $ci->setParent($this);
            $ci->readFromSession();
            $this->filter['mail_filter_recipients'] = (int) $ci->getChecked();
        } else {
            $this->sub_filter[] = $ci = new ilCheckboxInputGUI($this->lng->txt('mail_filter_sender'), 'mail_filter_sender');
            $ci->setOptionTitle($this->lng->txt('mail_filter_sender'));
            $ci->setValue(1);
            $ti->addSubItem($ci);
            $ci->setParent($this);
            $ci->readFromSession();
            $this->filter['mail_filter_sender'] = (int) $ci->getChecked();
        }
 
        $this->sub_filter[] = $ci = new ilCheckboxInputGUI($this->lng->txt('mail_filter_subject'), 'mail_filter_subject');
        $ci->setOptionTitle($this->lng->txt('mail_filter_subject'));
        $ci->setValue(1);
        $ti->addSubItem($ci);
        $ci->setParent($this);
        $ci->readFromSession();
        $this->filter['mail_filter_subject'] = (int) $ci->getChecked();
 
        $this->sub_filter[] = $ci = new ilCheckboxInputGUI($this->lng->txt('mail_filter_body'), 'mail_filter_body');
        $ci->setOptionTitle($this->lng->txt('mail_filter_body'));
        $ci->setValue(1);
        $ti->addSubItem($ci);
        $ci->setParent($this);
        $ci->readFromSession();
        $this->filter['mail_filter_body'] = (int) $ci->getChecked();
 
        $this->sub_filter[] = $ci = new ilCheckboxInputGUI($this->lng->txt('mail_filter_attach'), 'mail_filter_attach');
        $ci->setOptionTitle($this->lng->txt('mail_filter_attach'));
        $ci->setValue(1);
        $ti->addSubItem($ci);
        $ci->setParent($this);
        $ci->readFromSession();
        $this->filter['mail_filter_attach'] = (int) $ci->getChecked();
    }

References ilTable2GUI\addFilterItem(), isDraftFolder(), and isSentFolder().

Here is the call graph for this function:

initMultiCommands()

ilMailFolderTableGUI::initMultiCommands (   $actions )

private

initMultiCommands @access private

Parameters

array

$actions

array for multi commands

Returns

ilMailFolderTableGUI

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

    {
        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;
    }

References $action, $key, ilTable2GUI\addMultiCommand(), and isTrashFolder().

Referenced by prepareHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

isDraftFolder()

ilMailFolderTableGUI::isDraftFolder

(

$a_bool = null

)

Setter/Getter for folder status @access public.

Parameters

mixed

$a_bool

Boolean folder status or null

Returns

bool|ilMailFolderTableGUI Either an object of type ilMailFolderTableGUI or the boolean folder status

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

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

References $_isDraftsFolder.

Referenced by fetchTableData(), initFilter(), and prepareHTML().

Here is the caller graph for this function:

isLuceneSearchEnabled()

ilMailFolderTableGUI::isLuceneSearchEnabled ( )

protected

Returns

bool

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

    {
        include_once 'Services/Search/classes/class.ilSearchSettings.php';
        if (ilSearchSettings::getInstance()->enabledLucene() && strlen($this->filter['mail_filter'])) {
            return true;
        }
    }

References ilSearchSettings\getInstance().

Referenced by fetchTableData(), and prepareHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

isSentFolder()

ilMailFolderTableGUI::isSentFolder

(

$a_bool = null

)

Setter/Getter for folder status @access public.

Parameters

mixed

$a_bool

Boolean folder status or null

Returns

bool|ilMailFolderTableGUI Either an object of type ilMailFolderTableGUI or the boolean folder status

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

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

References $_isSentFolder.

Referenced by fetchTableData(), initFilter(), and prepareHTML().

Here is the caller graph for this function:

isTrashFolder()

ilMailFolderTableGUI::isTrashFolder

(

$a_bool = null

)

Setter/Getter for folder status @access public.

Parameters

mixed

$a_bool

Boolean folder status or null

Returns

bool|ilMailFolderTableGUI Either an object of type ilMailFolderTableGUI or the boolean folder status

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

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

References $_isTrashFolder.

Referenced by initMultiCommands().

Here is the caller graph for this function:

prepareHTML()

ilMailFolderTableGUI::prepareHTML ( )

final

Call this before using getHTML() @access public.

Returns

ilMailFolderTableGUI @final

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

    {
        $this->addColumn('', '', '1px', 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%');
        }
        
        if ($this->isLuceneSearchEnabled()) {
            $this->addColumn($this->lng->txt('search_content'), '', '40%');
        } else {
            $this->addColumn($this->lng->txt('subject'), 'm_subject', '40%');
        }
        $this->addColumn($this->lng->txt('date'), 'send_time', '20%');
 
        // init folder data
        $mtree = new ilTree($this->user->getId());
        $mtree->setTableNames('mail_tree', 'mail_obj_data');
        $this->_folderNode = $mtree->getNodeData($this->_currentFolderId);
 
        // fetch table data
        $this->fetchTableData();
 
        // command buttons
        $this->initCommandButtons();
 
        // mail actions
        $this->initMultiCommands($this->_parentObject->mbox->getActions($this->_currentFolderId));
 
        return $this;
    }

References ilTable2GUI\addColumn(), fetchTableData(), initCommandButtons(), initMultiCommands(), isDraftFolder(), isLuceneSearchEnabled(), isSentFolder(), and user().

Here is the call graph for this function:

resetFilter()

ilMailFolderTableGUI::resetFilter

(

)

Reset filter.

Reimplemented from ilTable2GUI.

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

    {
        parent::resetFilter();
 
        foreach ($this->sub_filter as $item) {
            if ($item->checkInput()) {
                $item->setValueByArray($_POST);
                $item->clearFromSession();
            }
        }
    }

References $_POST.

setNumerOfMails()

ilMailFolderTableGUI::setNumerOfMails

(

$a_number_of_mails

)

Set the total number of mails of the current folder @access public.

Parameters

integer

$a_number_of_mails

total number of mails of the current folder

Returns

ilMailFolderTableGUI

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

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

Referenced by fetchTableData().

Here is the caller graph for this function:

setSelectedItems()

ilMailFolderTableGUI::setSelectedItems

(

$a_selected_items

)

Set the selected items @access public.

Parameters

integer

$a_selected_items

selected items

Returns

ilMailFolderTableGUI

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

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

setTitleData()

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

protected

Function to set the table title @access 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 443 of file class.ilMailFolderTableGUI.php.

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

Referenced by fetchTableData().

Here is the caller graph for this function:

writeFilterToSession()

ilMailFolderTableGUI::writeFilterToSession

(

)

Write filter values to session.

Reimplemented from ilTable2GUI.

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

    {
        parent::writeFilterToSession();
 
        foreach ($this->sub_filter as $item) {
            if ($item->checkInput()) {
                $item->setValueByArray($_POST);
                $item->writeToSession();
            }
        }
    }

References $_POST.

Field Documentation

$_currentFolderId

ilMailFolderTableGUI::$_currentFolderId = 0

protected

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

Referenced by fetchTableData().

$_folderNode

ilMailFolderTableGUI::$_folderNode = array()

protected

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

$_isDraftsFolder

ilMailFolderTableGUI::$_isDraftsFolder = false

protected

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

Referenced by isDraftFolder().

$_isSentFolder

ilMailFolderTableGUI::$_isSentFolder = false

protected

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

Referenced by isSentFolder().

$_isTrashFolder

ilMailFolderTableGUI::$_isTrashFolder = false

protected

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

Referenced by isTrashFolder().

$_number_of_mails

ilMailFolderTableGUI::$_number_of_mails = 0

protected

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

Referenced by getNumerOfMails().

$_parentObject

ilMailFolderTableGUI::$_parentObject = null

protected

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

$_selectedItems

ilMailFolderTableGUI::$_selectedItems = array()

protected

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

Referenced by getSelectedItems().

$ctrl

ilMailFolderTableGUI::$ctrl

protected

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

$filter

ilMailFolderTableGUI::$filter = array()

protected

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

$lng

ilMailFolderTableGUI::$lng

protected

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

$sub_filter

ilMailFolderTableGUI::$sub_filter = array()

protected

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

$user

ilMailFolderTableGUI::$user

protected

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

Referenced by fetchTableData().

---

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

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