|
ILIAS
release_4-3 Revision
|
Inheritance diagram for ilMailFolderTableGUI:
Collaboration diagram for ilMailFolderTableGUI:Public Member Functions | |
| prepareHTML () | |
| Call this before using getHTML() public. | |
| isDraftFolder ($a_bool=null) | |
| Setter/Getter for folder status public. | |
| isSentFolder ($a_bool=null) | |
| Setter/Getter for folder status public. | |
| isTrashFolder ($a_bool=null) | |
| Setter/Getter for folder status public. | |
| setSelectedItems ($a_selected_items) | |
| Set the selected items public. | |
| getSelectedItems () | |
| Get all selected items public. | |
| setNumerOfMails ($a_number_of_mails) | |
| Set the total number of mails of the current folder public. | |
| getNumerOfMails () | |
| Returns the total number of mails of the current folder public. | |
| fillRow ($a_set) | |
| Fill row public. | |
Public Member Functions inherited from ilTable2GUI | |
| __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="") | |
| Constructor. | |
| 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. | |
| setEnableAllCommand ($a_value) | |
| Enable actions for all entries in current result. | |
| setRowSelectorLabel ($row_selector_label) | |
| getRowSelectorLabel () | |
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 protected | |
| setTitleData ($folderLabel, $mailCount, $unreadCount, $imgFolder) | |
| Function to set the table title protected. | |
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 | |
| $enable_command_for_all | |
| $row_selector_label | |
Private Member Functions | |
| initCommandButtons () | |
| Performs special actions for folders such as user folders, trash and local folders private. | |
| initMultiCommands ($actions) | |
| initMultiCommands private | |
Additional Inherited Members | |
Static Public Member Functions inherited from ilTable2GUI | |
| static | getAllCommandLimit () |
| Get maximum number of entries to enable actions for all. | |
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 |
Definition at line 13 of file class.ilMailFolderTableGUI.php.
|
protected |
fetchTableData protected
Definition at line 248 of file class.ilMailFolderTableGUI.php.
References $_currentFolderId, ilTableGUI\$data, ilMailBoxQuery\$folderId, $ilUser, ilMailBoxQuery\$limit, ilMailBoxQuery\$offset, ilMailBoxQuery\$orderColumn, ilMailBoxQuery\$orderDirection, ilMailBoxQuery\$userId, ilMailBoxQuery\_getMailBoxListData(), ilTable2GUI\determineOffsetAndOrder(), ilDatePresentation\formatDate(), ilUtil\getImagePath(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), getSelectedItems(), ilMailUserCache\getUserObjectById(), IL_CAL_DATETIME, isDraftFolder(), isSentFolder(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), setNumerOfMails(), and setTitleData().
Referenced by prepareHTML().
Here is the call graph for this function:
Here is the caller graph for this function:| ilMailFolderTableGUI::fillRow | ( | $a_set | ) |
Fill row public.
| array | $a_set | result set array (assoc.) |
Reimplemented from ilTable2GUI.
Definition at line 421 of file class.ilMailFolderTableGUI.php.
| ilMailFolderTableGUI::getNumerOfMails | ( | ) |
Returns the total number of mails of the current folder public.
Definition at line 410 of file class.ilMailFolderTableGUI.php.
References $_number_of_mails.
Referenced by initCommandButtons().
Here is the caller graph for this function:| ilMailFolderTableGUI::getSelectedItems | ( | ) |
Get all selected items public.
Definition at line 237 of file class.ilMailFolderTableGUI.php.
References $_selectedItems.
Referenced by fetchTableData().
Here is the caller graph for this function:
|
private |
Performs special actions for folders such as user folders, trash and local folders private.
Definition at line 166 of file class.ilMailFolderTableGUI.php.
References ilTable2GUI\addCommandButton(), and getNumerOfMails().
Referenced by prepareHTML().
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
initMultiCommands private
| array | $actions | array for multi commands |
Definition at line 183 of file class.ilMailFolderTableGUI.php.
References ilTable2GUI\addMultiCommand(), and isTrashFolder().
Referenced by prepareHTML().
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.
| mixed | $a_bool | Boolean folder status or null |
Definition at line 109 of file class.ilMailFolderTableGUI.php.
References $_isDraftsFolder.
Referenced by fetchTableData(), and prepareHTML().
Here is the caller graph for this function:| ilMailFolderTableGUI::isSentFolder | ( | $a_bool = null | ) |
Setter/Getter for folder status public.
| mixed | $a_bool | Boolean folder status or null |
Definition at line 128 of file class.ilMailFolderTableGUI.php.
References $_isSentFolder.
Referenced by fetchTableData(), and prepareHTML().
Here is the caller graph for this function:| ilMailFolderTableGUI::isTrashFolder | ( | $a_bool = null | ) |
Setter/Getter for folder status public.
| mixed | $a_bool | Boolean folder status or null |
Definition at line 147 of file class.ilMailFolderTableGUI.php.
References $_isTrashFolder.
Referenced by initMultiCommands().
Here is the caller graph for this function:
|
final |
Call this before using getHTML() public.
Definition at line 72 of file class.ilMailFolderTableGUI.php.
References $ilUser, ilTable2GUI\addColumn(), fetchTableData(), initCommandButtons(), initMultiCommands(), isDraftFolder(), isSentFolder(), and ilTree\setTableNames().
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.
| integer | $a_number_of_mails | total number of mails of the current folder |
Definition at line 397 of file class.ilMailFolderTableGUI.php.
Referenced by fetchTableData().
Here is the caller graph for this function:| ilMailFolderTableGUI::setSelectedItems | ( | $a_selected_items | ) |
Set the selected items public.
| integer | $a_selected_items | selected items |
Definition at line 224 of file class.ilMailFolderTableGUI.php.
|
protected |
Function to set the table title protected.
| 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 |
Definition at line 376 of file class.ilMailFolderTableGUI.php.
References ilTable2GUI\setTitle().
Referenced by fetchTableData().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
Definition at line 20 of file class.ilMailFolderTableGUI.php.
Referenced by fetchTableData().
|
protected |
Definition at line 18 of file class.ilMailFolderTableGUI.php.
|
protected |
Definition at line 24 of file class.ilMailFolderTableGUI.php.
Referenced by isDraftFolder().
|
protected |
Definition at line 25 of file class.ilMailFolderTableGUI.php.
Referenced by isSentFolder().
|
protected |
Definition at line 23 of file class.ilMailFolderTableGUI.php.
Referenced by isTrashFolder().
|
protected |
Definition at line 21 of file class.ilMailFolderTableGUI.php.
Referenced by getNumerOfMails().
|
protected |
Definition at line 19 of file class.ilMailFolderTableGUI.php.
|
protected |
Definition at line 22 of file class.ilMailFolderTableGUI.php.
Referenced by getSelectedItems().
|
protected |
Definition at line 16 of file class.ilMailFolderTableGUI.php.
|
protected |
Definition at line 15 of file class.ilMailFolderTableGUI.php.