ILIAS
Release_4_0_x_branch Revision 61816
|
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 | |
__construct ($a_parent_obj, $a_parent_cmd="") | |
Constructor. | |
& | 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. | |
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 disable filter hiding. | |
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= '') | |
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="") | |
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 | |
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. | |
getLimit () | |
Get limit. | |
setOffset ($a_offset) | |
set dataset offset public | |
getOffset () | |
Get offset. | |
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. |
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 | |
$mi_sel_buttons = null | |
$disable_filter_hiding = false | |
$top_commands = false |
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 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 |
Definition at line 15 of file class.ilMailFolderTableGUI.php.
ilMailFolderTableGUI::__construct | ( | $a_parent_obj, | |
$a_current_folder_id, | |||
$a_parent_cmd = '' |
|||
) |
Constructor.
public
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 |
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().
|
protected |
fetchTableData
protected
Definition at line 294 of file class.ilMailFolderTableGUI.php.
References $_currentFolderId, ilTableGUI\$data, ilMailBoxQuery\$folderId, $key, ilMailBoxQuery\$limit, $login, ilMailBoxQuery\$offset, ilMailBoxQuery\$orderColumn, ilMailBoxQuery\$orderDirection, ilMailBoxQuery\$userId, ilMail\_getAnonymousName(), ilMailBoxQuery\_getMailBoxListData(), ilObjUser\_lookupPref(), ilTable2GUI\determineOffsetAndOrder(), ilDatePresentation\formatDate(), ilUtil\getImagePath(), ilTableGUI\getLimit(), ilTableGUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), getSelectedItems(), getUserInstance(), IL_CAL_DATETIME, isDraftFolder(), isSentFolder(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), setNumerOfMails(), and setTitleData().
Referenced by prepareHTML().
ilMailFolderTableGUI::fillRow | ( | $a_set | ) |
Fill row.
public
array | $a_set | result set array (assoc.) |
Reimplemented from ilTable2GUI.
Definition at line 470 of file class.ilMailFolderTableGUI.php.
References $key.
ilMailFolderTableGUI::getNumerOfMails | ( | ) |
Returns the total number of mails of the current folder.
public
Definition at line 457 of file class.ilMailFolderTableGUI.php.
References $_number_of_mails.
ilMailFolderTableGUI::getSelectedItems | ( | ) |
Get all selected items.
public
Definition at line 281 of file class.ilMailFolderTableGUI.php.
References $_selectedItems.
Referenced by fetchTableData().
|
private |
Caching method for user instances.
private
integer | $a_usr_id | Id of a user instance |
Definition at line 246 of file class.ilMailFolderTableGUI.php.
Referenced by fetchTableData().
|
private |
Performs special actions for folders such as user folders, trash and local folders.
private
Definition at line 176 of file class.ilMailFolderTableGUI.php.
References ilTable2GUI\addCommandButton().
Referenced by prepareHTML().
|
private |
initMultiCommands
private
array | $actions | array for multi commands |
Definition at line 204 of file class.ilMailFolderTableGUI.php.
References $key, ilTable2GUI\addMultiCommand(), and isTrashFolder().
Referenced by prepareHTML().
ilMailFolderTableGUI::isDraftFolder | ( | $a_bool = null | ) |
Setter/Getter for folder status.
public
mixed | $a_bool | Boolean folder status or null |
Definition at line 113 of file class.ilMailFolderTableGUI.php.
References $_isDraftsFolder.
Referenced by fetchTableData(), and prepareHTML().
ilMailFolderTableGUI::isSentFolder | ( | $a_bool = null | ) |
Setter/Getter for folder status.
public
mixed | $a_bool | Boolean folder status or null |
Definition at line 134 of file class.ilMailFolderTableGUI.php.
References $_isSentFolder.
Referenced by fetchTableData(), and prepareHTML().
ilMailFolderTableGUI::isTrashFolder | ( | $a_bool = null | ) |
Setter/Getter for folder status.
public
mixed | $a_bool | Boolean folder status or null |
Definition at line 155 of file class.ilMailFolderTableGUI.php.
References $_isTrashFolder.
Referenced by initMultiCommands().
|
final |
Call this before using getHTML()
public
Definition at line 74 of file class.ilMailFolderTableGUI.php.
References ilTable2GUI\addColumn(), fetchTableData(), initCommandButtons(), initMultiCommands(), isDraftFolder(), isSentFolder(), and ilTree\setTableNames().
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 442 of file class.ilMailFolderTableGUI.php.
Referenced by fetchTableData().
ilMailFolderTableGUI::setSelectedItems | ( | $a_selected_items | ) |
Set the selected items.
public
integer | $a_selected_items | selected items |
Definition at line 266 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 419 of file class.ilMailFolderTableGUI.php.
References ilTable2GUI\setTitle().
Referenced by fetchTableData().
|
protected |
Definition at line 22 of file class.ilMailFolderTableGUI.php.
Referenced by fetchTableData().
|
protected |
Definition at line 20 of file class.ilMailFolderTableGUI.php.
|
protected |
Definition at line 26 of file class.ilMailFolderTableGUI.php.
Referenced by isDraftFolder().
|
protected |
Definition at line 27 of file class.ilMailFolderTableGUI.php.
Referenced by isSentFolder().
|
protected |
Definition at line 25 of file class.ilMailFolderTableGUI.php.
Referenced by isTrashFolder().
|
protected |
Definition at line 23 of file class.ilMailFolderTableGUI.php.
Referenced by getNumerOfMails().
|
protected |
Definition at line 21 of file class.ilMailFolderTableGUI.php.
|
protected |
Definition at line 24 of file class.ilMailFolderTableGUI.php.
Referenced by getSelectedItems().
|
protected |
Definition at line 18 of file class.ilMailFolderTableGUI.php.
|
protected |
Definition at line 17 of file class.ilMailFolderTableGUI.php.
Referenced by __construct().