Public Member Functions |
Protected Member Functions |
Protected Attributes |
Private Member Functions
ilMailFolderTableGUI Class Reference
Inheritance diagram for ilMailFolderTableGUI:
Collaboration diagram for ilMailFolderTableGUI:
Public Member Functions | |
| 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="") | |
| 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... | |
| clearCommandButtons () | |
| addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null) | |
| Add Command button. More... | |
| addCommandButtonInstance (ilButton $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="") | |
| 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... | |
| Public Member Functions inherited from ilTableGUI | |
| ilTableGUI ($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 () | |
| 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... | |
| 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 ($worksheet, &$a_row) | |
| Add meta information to excel export. More... | |
| fillHeaderExcel ($worksheet, &$a_row) | |
| Excel Version of Fill Header. More... | |
| fillRowExcel ($a_worksheet, &$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... | |
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 | 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
- Version
- $Id$
Definition at line 14 of file class.ilMailFolderTableGUI.php.
Member Function Documentation
◆ fillRow()
| ilMailFolderTableGUI::fillRow | ( | $a_set | ) |
Fill row @access public.
- Parameters
-
array $a_set result set array (assoc.)
Reimplemented from ilTable2GUI.
Definition at line 540 of file class.ilMailFolderTableGUI.php.
541 {
542 foreach($a_set as $key => $value)
543 {
544 $this->tpl->setVariable(strtoupper($key), $value);
545 }
546 }
◆ 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 529 of file class.ilMailFolderTableGUI.php.
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
- integer selected items
Definition at line 260 of file class.ilMailFolderTableGUI.php.
261 {
263 }
References $_selectedItems.
◆ initCommandButtons()
|
private |
Performs special actions for folders such as user folders, trash and local folders @access private.
- Returns
- ilMailFolderTableGUI
Definition at line 189 of file class.ilMailFolderTableGUI.php.
190 {
192 {
194 }
195
196 return $this;
197 }
getNumerOfMails()
Returns the total number of mails of the current folder @access public.
Definition: class.ilMailFolderTableGUI.php:529
addCommandButton($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
Add Command button.
Definition: class.ilTable2GUI.php:1186
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 548 of file class.ilMailFolderTableGUI.php.
549 {
550 $this->filter = array();
551
552 include_once 'Services/Mail/classes/Form/class.ilMailQuickFilterInputGUI.php';
554 $ti->setSubmitFormOnEnter(false);
555 $this->addFilterItem($ti);
556 $ti->readFromSession();
557 $this->filter['mail_filter'] = $ti->getValue();
558
559 include_once 'Services/Form/classes/class.ilCheckboxInputGUI.php';
560
562 {
563 $this->sub_filter[] = $ci = new ilCheckboxInputGUI($this->lng->txt('mail_filter_recipients'), 'mail_filter_recipients');
564 $ci->setOptionTitle($this->lng->txt('mail_filter_recipients'));
565 $ci->setValue(1);
566 $ti->addSubItem($ci);
567 $ci->setParent($this);
568 $ci->readFromSession();
569 $this->filter['mail_filter_recipients'] = (int)$ci->getChecked();
570 }
571 else
572 {
573 $this->sub_filter[] = $ci = new ilCheckboxInputGUI($this->lng->txt('mail_filter_sender'), 'mail_filter_sender');
574 $ci->setOptionTitle($this->lng->txt('mail_filter_sender'));
575 $ci->setValue(1);
576 $ti->addSubItem($ci);
577 $ci->setParent($this);
578 $ci->readFromSession();
579 $this->filter['mail_filter_sender'] = (int)$ci->getChecked();
580 }
581
582 $this->sub_filter[] = $ci = new ilCheckboxInputGUI($this->lng->txt('mail_filter_subject'), 'mail_filter_subject');
583 $ci->setOptionTitle($this->lng->txt('mail_filter_subject'));
584 $ci->setValue(1);
585 $ti->addSubItem($ci);
586 $ci->setParent($this);
587 $ci->readFromSession();
588 $this->filter['mail_filter_subject'] = (int)$ci->getChecked();
589
590 $this->sub_filter[] = $ci = new ilCheckboxInputGUI($this->lng->txt('mail_filter_body'), 'mail_filter_body');
591 $ci->setOptionTitle($this->lng->txt('mail_filter_body'));
592 $ci->setValue(1);
593 $ti->addSubItem($ci);
594 $ci->setParent($this);
595 $ci->readFromSession();
596 $this->filter['mail_filter_body'] = (int)$ci->getChecked();
597
598 $this->sub_filter[] = $ci = new ilCheckboxInputGUI($this->lng->txt('mail_filter_attach'), 'mail_filter_attach');
599 $ci->setOptionTitle($this->lng->txt('mail_filter_attach'));
600 $ci->setValue(1);
601 $ti->addSubItem($ci);
602 $ci->setParent($this);
603 $ci->readFromSession();
604 $this->filter['mail_filter_attach'] = (int)$ci->getChecked();
605 }
This class represents a checkbox property in a property form.
Definition: class.ilCheckboxInputGUI.php:34
isSentFolder($a_bool=null)
Setter/Getter for folder status @access public.
Definition: class.ilMailFolderTableGUI.php:151
isDraftFolder($a_bool=null)
Setter/Getter for folder status @access public.
Definition: class.ilMailFolderTableGUI.php:132
addFilterItem($a_input_item, $a_optional=false)
Add filter item.
Definition: class.ilTable2GUI.php:610
References ilTable2GUI\addFilterItem(), isDraftFolder(), and isSentFolder().
Here is the call graph for this function:
◆ initMultiCommands()
|
private |
initMultiCommands @access private
- Parameters
-
array $actions array for multi commands
- Returns
- ilMailFolderTableGUI
Definition at line 206 of file class.ilMailFolderTableGUI.php.
207 {
208 foreach($actions as $key => $action)
209 {
210 if($key == 'moveMails')
211 {
212 $folders = $this->_parentObject->mbox->getSubFolders();
213 foreach($folders as $folder)
214 {
215 if($folder['type'] != 'trash' ||
216 !$this->isTrashFolder()
217 )
218 {
219 if($folder['type'] != 'user_folder')
220 {
221 $label = $action . ' ' . $this->lng->txt('mail_' . $folder['title']) .
222 ($folder['type'] == 'trash' ? ' (' . $this->lng->txt('delete') . ')' : '');
224 }
225 else
227 }
228 }
229 }
230 else
231 {
233 $this->addMultiCommand($key, $action);
234 }
235 }
236
237 return $this;
238 }
isTrashFolder($a_bool=null)
Setter/Getter for folder status @access public.
Definition: class.ilMailFolderTableGUI.php:170
References 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 132 of file class.ilMailFolderTableGUI.php.
133 {
134 if(null === $a_bool)
135 {
137 }
138
139 $this->_isDraftsFolder = $a_bool;
140
141 return $this;
142 }
References $_isDraftsFolder.
Referenced by initFilter(), and prepareHTML().
Here is the caller graph for this function:
◆ isLuceneSearchEnabled()
|
protected |
- Returns
- bool
Definition at line 268 of file class.ilMailFolderTableGUI.php.
269 {
270 include_once 'Services/Search/classes/class.ilSearchSettings.php';
272 {
273 return true;
274 }
275 }
References ilSearchSettings\getInstance().
Referenced by 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 151 of file class.ilMailFolderTableGUI.php.
152 {
153 if(null === $a_bool)
154 {
156 }
157
158 $this->_isSentFolder = $a_bool;
159
160 return $this;
161 }
References $_isSentFolder.
Referenced by 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 170 of file class.ilMailFolderTableGUI.php.
171 {
172 if(null === $a_bool)
173 {
175 }
176
177 $this->_isTrashFolder = $a_bool;
178
179 return $this;
180 }
References $_isTrashFolder.
Referenced by initMultiCommands().
Here is the caller graph for this function:
◆ prepareHTML()
|
final |
Call this before using getHTML() @access public.
- Returns
- ilMailFolderTableGUI @final
Definition at line 87 of file class.ilMailFolderTableGUI.php.
88 {
89 global $ilUser;
90
95 else
97
99 {
101 }
102 else
103 {
105 }
107
108 // init folder data
110 $mtree->setTableNames('mail_tree', 'mail_obj_data');
111 $this->_folderNode = $mtree->getNodeData($this->_currentFolderId);
112
113 // fetch table data
114 $this->fetchTableData();
115
116 // command buttons
117 $this->initCommandButtons();
118
119 // mail actions
120 $this->initMultiCommands($this->_parentObject->mbox->getActions($this->_currentFolderId));
121
122 return $this;
123 }
initMultiCommands($actions)
initMultiCommands @access private
Definition: class.ilMailFolderTableGUI.php:206
initCommandButtons()
Performs special actions for folders such as user folders, trash and local folders @access private.
Definition: class.ilMailFolderTableGUI.php:189
isLuceneSearchEnabled()
Definition: class.ilMailFolderTableGUI.php:268
addColumn($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="")
Add a column to the header.
Definition: class.ilTable2GUI.php:1307
Tree class data representation in hierachical trees using the Nested Set Model with Gaps by Joe Celco...
Definition: class.ilTree.php:25
References $ilUser, ilTable2GUI\addColumn(), initCommandButtons(), initMultiCommands(), isDraftFolder(), isLuceneSearchEnabled(), and isSentFolder().
Here is the call graph for this function:
◆ resetFilter()
| ilMailFolderTableGUI::resetFilter | ( | ) |
Reset filter.
Reimplemented from ilTable2GUI.
Definition at line 627 of file class.ilMailFolderTableGUI.php.
628 {
629 parent::resetFilter();
630
631 foreach($this->sub_filter as $item)
632 {
633 if($item->checkInput())
634 {
635 $item->setValueByArray($_POST);
636 $item->clearFromSession();
637 }
638 }
639 }
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 516 of file class.ilMailFolderTableGUI.php.
517 {
518 $this->_number_of_mails = $a_number_of_mails;
519
520 return $this;
521 }
◆ setSelectedItems()
| ilMailFolderTableGUI::setSelectedItems | ( | $a_selected_items | ) |
Set the selected items @access public.
- Parameters
-
integer $a_selected_items selected items
- Returns
- ilMailFolderTableGUI
Definition at line 247 of file class.ilMailFolderTableGUI.php.
248 {
249 $this->_selectedItems = $a_selected_items;
250
251 return $this;
252 }
◆ setTitleData()
|
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 495 of file class.ilMailFolderTableGUI.php.
496 {
498 $titleTemplate->setVariable('TXT_FOLDER', $folderLabel);
499 $titleTemplate->setVariable('MAIL_COUNT', $mailCount);
500 $titleTemplate->setVariable('TXT_MAIL_S', $this->lng->txt('mail_s'));
501 $titleTemplate->setVariable('MAIL_COUNT_UNREAD', $unreadCount);
502 $titleTemplate->setVariable('TXT_UNREAD', $this->lng->txt('unread'));
503
504 parent::setTitle($titleTemplate->get(), $imgFolder);
505
506 return $this;
507 }
special template class to simplify handling of ITX/PEAR
Definition: class.ilTemplate.php:12
◆ writeFilterToSession()
| ilMailFolderTableGUI::writeFilterToSession | ( | ) |
Write filter values to session.
Reimplemented from ilTable2GUI.
Definition at line 610 of file class.ilMailFolderTableGUI.php.
611 {
612 parent::writeFilterToSession();
613
614 foreach($this->sub_filter as $item)
615 {
616 if($item->checkInput())
617 {
618 $item->setValueByArray($_POST);
619 $item->writeToSession();
620 }
621 }
622 }
References $_POST.
Field Documentation
◆ $_currentFolderId
|
protected |
Definition at line 21 of file class.ilMailFolderTableGUI.php.
◆ $_folderNode
|
protected |
Definition at line 19 of file class.ilMailFolderTableGUI.php.
◆ $_isDraftsFolder
|
protected |
Definition at line 25 of file class.ilMailFolderTableGUI.php.
Referenced by isDraftFolder().
◆ $_isSentFolder
|
protected |
Definition at line 26 of file class.ilMailFolderTableGUI.php.
Referenced by isSentFolder().
◆ $_isTrashFolder
|
protected |
Definition at line 24 of file class.ilMailFolderTableGUI.php.
Referenced by isTrashFolder().
◆ $_number_of_mails
|
protected |
Definition at line 22 of file class.ilMailFolderTableGUI.php.
Referenced by getNumerOfMails().
◆ $_parentObject
|
protected |
Definition at line 20 of file class.ilMailFolderTableGUI.php.
◆ $_selectedItems
|
protected |
Definition at line 23 of file class.ilMailFolderTableGUI.php.
Referenced by getSelectedItems().
◆ $ctrl
|
protected |
Definition at line 17 of file class.ilMailFolderTableGUI.php.
◆ $filter
|
protected |
Definition at line 31 of file class.ilMailFolderTableGUI.php.
◆ $lng
|
protected |
Definition at line 16 of file class.ilMailFolderTableGUI.php.
◆ $sub_filter
|
protected |
Definition at line 36 of file class.ilMailFolderTableGUI.php.
The documentation for this class was generated from the following file:
- Services/Mail/classes/class.ilMailFolderTableGUI.php
