ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
arIndexTableGUI Class Reference

GUI-Class arIndexTableGUI. More...

+ Inheritance diagram for arIndexTableGUI:
+ Collaboration diagram for arIndexTableGUI:

Public Member Functions

 __construct (arGUI $a_parent_obj, $a_parent_cmd, ActiveRecordList $active_record_list)
 
 addMutliItemAction (arIndexTableAction $action)
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 fillRow ($a_set)
 
 render ()
 
 txt ($txt, $plugin_txt=true)
 
 applyFilter ()
 
 resetFilter ()
 
 setFields (arIndexTableFields $fields)
 
 getFields ()
 
 getFieldsAsArray ()
 
 getField ($field_name)
 
 addField (arIndexTableField $field)
 
 setTableTitle ($table_title)
 
 getTableTitle ()
 
 setToolbar ($toolbar)
 
 getToolbar ()
 
 setActions ($actions)
 
 getActions ()
 
 getActionsAsArray ()
 
 setMultiItemActions ($multi_item_actions)
 
 getMultiItemActions ()
 
 getMultiItemActionsAsArray ()
 
- 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)
 
 getData ()
 
 dataExists ()
 
 setPrefix ($a_prefix)
 
 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 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)
 
- Public Member Functions inherited from ilTableGUI
 __construct ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate ($a_tpl)
 set template public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page public More...
 
 setHeaderNames ($a_header_names)
 set table header names public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars public More...
 
 setColumnWidth ($a_column_width)
 set table column widths public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width 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) public More...
 
 setOffset ($a_offset)
 set dataset offset public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction 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 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)
 

Static Public Member Functions

static domid_encode ($id_to_encode)
 
static domid_decode ($id_to_decode)
 
- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 

Protected Member Functions

 initBeforeParentConstructor ()
 
 initAfterParentConstructor ()
 
 initTitle ()
 
 initFields ()
 
 customizeFields ()
 To be overridden More...
 
 initActions ()
 
 addAction (arIndexTableAction $action)
 
 initFormAction ()
 
 initCommandButtons ()
 
 initToolbar ()
 
 getAddButtonTxt ()
 
 initMultiItemActions ()
 
 getMultiDeleteTxt ()
 
 initMultiItemActionsButton ()
 
 addFilterField (arIndexTableField $field)
 
 initRowSelector ()
 
 initTableRowTemplate ()
 
 addMultipleSelectionColumn ()
 
 checkColumnVisibile (arIndexTableField $field)
 
 addFilterWhere (ilFormPropertyGUI $filter, $name, $value)
 
 addFilterNumericWhere (ilCombinationInputGUI $filter, $name, $value)
 
 addFilterTextWhere (ilTextInputGUI $filter, $name, $value)
 
 addFilterDateWhere (ilCombinationInputGUI $filter, $name, $value)
 
 addFilterDateTimeWhere (ilCombinationInputGUI $filter, $name, $value)
 
 addFilterCustomWhere ()
 
 beforeGetData ()
 
 setOrderAndSegmentation ()
 
 setEmptyFieldData (arIndexTableField $field, $item)
 
 setArModifiedByField (arIndexTableField $field, $item, $value)
 
 setArCreatedByField (arIndexTableField $field, $item, $value)
 
 setArFieldData (arIndexTableField $field, $item, $value)
 
 setDateFieldData (arIndexTableField $field, $item, $value)
 
 setCustomFieldData (arIndexTableField $field, $item)
 
 setCtrlParametersForRow ($a_set)
 
 addMultiItemActionCheckboxToRow ($a_set)
 
 parseRow ($a_set)
 
 parseEntry (arIndexTableField $field, $value)
 
- 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

 $ctrl
 
 $tabs
 
 $access
 
 $actions
 
 $multi_item_actions = array()
 
 $toolbar = NULL
 
 $table_title = ''
 
 $fields = NULL
 arIndexTableFields More...
 
 $active_record_list = NULL
 
 $parent_obj = NULL
 
- 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 = 5
 
 $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 = 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
 

Additional Inherited Members

- Data Fields inherited from ilTable2GUI
const FILTER_TEXT = 1
 
const FILTER_SELECT = 2
 
const FILTER_DATE = 3
 
const FILTER_LANGUAGE = 4
 
const FILTER_NUMBER_RANGE = 5
 
const FILTER_DATE_RANGE = 6
 
const FILTER_DURATION_RANGE = 7
 
const 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

GUI-Class arIndexTableGUI.

Author
Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch
Version
2.0.7

Definition at line 18 of file class.arIndexTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

arIndexTableGUI::__construct ( arGUI  $a_parent_obj,
  $a_parent_cmd,
ActiveRecordList  $active_record_list 
)
Parameters
arGUI$a_parent_obj
string$a_parent_cmd
ActiveRecordList$active_record_list

Definition at line 67 of file class.arIndexTableGUI.php.

References $active_record_list, $ilCtrl, initAfterParentConstructor(), initBeforeParentConstructor(), and ilTable2GUI\setId().

67  {
68  global $ilCtrl, $ilTabs, $ilAccess;
69  $this->ctrl = $ilCtrl;
70  $this->tabs = $ilTabs;
71  $this->access = $ilAccess;
72 
73  $this->parent_obj = $a_parent_obj;
74 
75  $this->active_record_list = $active_record_list;
76 
77  $this->setId(strtolower(get_class($this->active_record_list->getAR()) . "_index"));
78 
80 
81  parent::__construct($a_parent_obj, $a_parent_cmd);
82 
84  }
setId($a_val)
Set id.
global $ilCtrl
Definition: ilias.php:18
+ Here is the call graph for this function:

Member Function Documentation

◆ addAction()

arIndexTableGUI::addAction ( arIndexTableAction  $action)
protected
Parameters
arIndexTableAction$action

Definition at line 140 of file class.arIndexTableGUI.php.

References getActions(), and setActions().

Referenced by initActions().

140  {
141  if (!$this->getActions()) {
142  $this->setActions(new arIndexTableActions());
143  }
144  $this->actions->addAction($action);
145  }
GUI-Class arIndexTableActions.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addField()

arIndexTableGUI::addField ( arIndexTableField  $field)
Parameters
arIndexTableField

Definition at line 798 of file class.arIndexTableGUI.php.

References getFields().

798  {
799  $this->getFields()->addField($field);
800  }
+ Here is the call graph for this function:

◆ addFilterCustomWhere()

arIndexTableGUI::addFilterCustomWhere ( )
protected

Definition at line 489 of file class.arIndexTableGUI.php.

Referenced by addFilterWhere().

489  {
490  }
+ Here is the caller graph for this function:

◆ addFilterDateTimeWhere()

arIndexTableGUI::addFilterDateTimeWhere ( ilCombinationInputGUI  $filter,
  $name,
  $value 
)
protected
Parameters
ilCombinationInputGUI$filter
$name
$value

Definition at line 475 of file class.arIndexTableGUI.php.

References IL_CAL_DATE, and IL_CAL_DATETIME.

Referenced by addFilterWhere().

475  {
476  if ($value["from"] != NULL OR $value["to"] != NULL) {
477  if ($value["from"] == NULL) {
478  $value["from"] = new ilDateTime("0001-01-01", IL_CAL_DATE);
479  }
480  if ($value["to"] == NULL) {
481  $value["to"] = new ilDateTime("9999-01-01", IL_CAL_DATE);
482  }
483  $this->active_record_list->where($this->active_record_list->getAR()->getConnectorContainerName() . "." . $name . " BETWEEN '"
484  . $value["from"]->get(IL_CAL_DATETIME) . "' AND '" . $value["to"]->get(IL_CAL_DATETIME) . "'");
485  }
486  }
const IL_CAL_DATETIME
Date and time handling
const IL_CAL_DATE
+ Here is the caller graph for this function:

◆ addFilterDateWhere()

arIndexTableGUI::addFilterDateWhere ( ilCombinationInputGUI  $filter,
  $name,
  $value 
)
protected
Parameters
ilCombinationInputGUI$filter
$name
$value

Definition at line 456 of file class.arIndexTableGUI.php.

References IL_CAL_DATE.

Referenced by addFilterWhere().

456  {
457  if ($value["from"] != NULL OR $value["to"] != NULL) {
458  if ($value["from"] == NULL) {
459  $value["from"] = new ilDateTime("0001-01-01", IL_CAL_DATE);
460  }
461  if ($value["to"] == NULL) {
462  $value["to"] = new ilDateTime("9999-01-01", IL_CAL_DATE);
463  }
464  $this->active_record_list->where($this->active_record_list->getAR()->getConnectorContainerName() . "." . $name . " BETWEEN '"
465  . $value["from"]->get(IL_CAL_DATE) . "' AND '" . $value["to"]->get(IL_CAL_DATE) . "'");
466  }
467  }
Date and time handling
const IL_CAL_DATE
+ Here is the caller graph for this function:

◆ addFilterField()

arIndexTableGUI::addFilterField ( arIndexTableField  $field)
protected
Parameters
arIndexTableField$field

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

References ilTable2GUI\addFilterItem(), ilTable2GUI\addFilterItemByMetaType(), arField\getFieldType(), arField\getName(), ilFormPropertyGUI\getPostVar(), arViewField\getTxt(), ilFormPropertyGUI\readFromSession(), and txt().

Referenced by getSelectableColumns().

242  {
243  switch ($field->getFieldType()) {
244  case 'integer':
245  case 'float':
246  $this->addFilterItemByMetaType($field->getName(), self::FILTER_NUMBER_RANGE, false, $this->txt($field->getTxt()));
247  break;
248  case 'text':
249  case 'clob':
250  $this->addFilterItemByMetaType($field->getName(), self::FILTER_TEXT, false, $this->txt($field->getTxt()));
251  break;
252  case 'date':
253  $this->addFilterItemByMetaType($field->getName(), self::FILTER_DATE_RANGE, false, $this->txt($field->getTxt()));
254  break;
255  case 'time':
256  case 'timestamp':
257  $this->addFilterItemByMetaType($field->getName(), self::FILTER_DATETIME_RANGE, false, $this->txt($field->getTxt()));
258  break;
259  }
260  }
addFilterItemByMetaType($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
Add filter by standard type.
txt($txt, $plugin_txt=true)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addFilterNumericWhere()

arIndexTableGUI::addFilterNumericWhere ( ilCombinationInputGUI  $filter,
  $name,
  $value 
)
protected
Parameters
ilCombinationInputGUI$filter
$name
$value

Definition at line 426 of file class.arIndexTableGUI.php.

Referenced by addFilterWhere().

426  {
427 
428  if ($value["from"] != "" OR $value["to"] != "") {
429  if ($value["from"] == "") {
430  $value["from"] = 0;
431  }
432  if ($value["to"] == "") {
433  $value["to"] = PHP_INT_MAX;
434  }
435  $this->active_record_list->where($this->active_record_list->getAR()->getConnectorContainerName() . "." . $name . " >= " . $value["from"]
436  . " AND " . $this->active_record_list->getAR()->getConnectorContainerName() . "." . $name . " <= " . $value["to"]);
437  }
438  }
+ Here is the caller graph for this function:

◆ addFilterTextWhere()

arIndexTableGUI::addFilterTextWhere ( ilTextInputGUI  $filter,
  $name,
  $value 
)
protected
Parameters
ilTextInputGUI$filter
$name
$value

Definition at line 446 of file class.arIndexTableGUI.php.

Referenced by addFilterWhere().

446  {
447  $this->active_record_list->where($this->active_record_list->getAR()->getConnectorContainerName() . "." . $name . " like '%" . $value . "%'");
448  }
+ Here is the caller graph for this function:

◆ addFilterWhere()

arIndexTableGUI::addFilterWhere ( ilFormPropertyGUI  $filter,
  $name,
  $value 
)
protected
Parameters
ilFormPropertyGUI$filter
$name
$value

Definition at line 387 of file class.arIndexTableGUI.php.

References addFilterCustomWhere(), addFilterDateTimeWhere(), addFilterDateWhere(), addFilterNumericWhere(), and addFilterTextWhere().

Referenced by checkColumnVisibile().

387  {
388 
389  switch (get_class($filter)) {
390  case 'ilTextInputGUI':
391  $this->addFilterTextWhere($filter, $name, $value);
392 
393  return;
394  case 'ilCombinationInputGUI':
395  if (is_object($value["from"]) || is_object($value["to"])) {
396  if (get_class($value["from"]) == "ilDateTime" || get_class($value["to"]) == "ilDateTime") {
397  $this->addFilterDateTimeWhere($filter, $name, $value);
398 
399  return;
400  }
401  if (get_class($value["from"]) == "ilDate" || get_class($value["to"]) == "ilDate") {
402  $this->addFilterDateWhere($filter, $name, $value);
403 
404  return;
405  }
406  $this->addFilterCustomWhere($filter, $name, $value);
407 
408  return;
409  }
410 
411  $this->addFilterNumericWhere($filter, $name, $value);
412  break;
413  default:
414  $this->addFilterCustomWhere($filter, $name, $value);
415 
416  return;
417  }
418  }
addFilterDateTimeWhere(ilCombinationInputGUI $filter, $name, $value)
addFilterDateWhere(ilCombinationInputGUI $filter, $name, $value)
addFilterTextWhere(ilTextInputGUI $filter, $name, $value)
addFilterNumericWhere(ilCombinationInputGUI $filter, $name, $value)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addMultiItemActionCheckboxToRow()

arIndexTableGUI::addMultiItemActionCheckboxToRow (   $a_set)
protected
Parameters
$a_set

Definition at line 625 of file class.arIndexTableGUI.php.

References getFields(), and getMultiItemActions().

Referenced by fillRow().

625  {
626  if ($this->getMultiItemActions()) {
627  $this->tpl->setVariable('ID', self::domid_encode($a_set[$this->getFields()->getPrimaryField()->getName()]));
628  }
629  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addMultipleSelectionColumn()

arIndexTableGUI::addMultipleSelectionColumn ( )
protected

Definition at line 315 of file class.arIndexTableGUI.php.

References ilTable2GUI\addColumn(), and getMultiItemActions().

Referenced by initTableRowTemplate().

315  {
316  if ($this->getMultiItemActions()) {
317  $this->addColumn("", "", 1);
318  }
319  }
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.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addMutliItemAction()

arIndexTableGUI::addMutliItemAction ( arIndexTableAction  $action)
Parameters
arIndexTableAction$action

Definition at line 192 of file class.arIndexTableGUI.php.

References getMultiItemActions(), and setMultiItemActions().

Referenced by initMultiItemActions().

192  {
193  if (!$this->getMultiItemActions()) {
195  }
196  $this->multi_item_actions->addAction($action);
197  }
GUI-Class arIndexTableActions.
setMultiItemActions($multi_item_actions)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ applyFilter()

arIndexTableGUI::applyFilter ( )

Definition at line 710 of file class.arIndexTableGUI.php.

References ilTable2GUI\resetOffset(), and ilTable2GUI\writeFilterToSession().

710  {
711  $this->writeFilterToSession();
712  $this->resetOffset();
713  $this->initTableData();
714  }
resetOffset($a_in_determination=false)
Reset offset.
writeFilterToSession()
Write filter values to session.
+ Here is the call graph for this function:

◆ beforeGetData()

arIndexTableGUI::beforeGetData ( )
protected

Definition at line 493 of file class.arIndexTableGUI.php.

Referenced by checkColumnVisibile().

493  {
494  }
+ Here is the caller graph for this function:

◆ checkColumnVisibile()

arIndexTableGUI::checkColumnVisibile ( arIndexTableField  $field)
protected
Parameters
arIndexTableField$field
Returns
bool

Definition at line 327 of file class.arIndexTableGUI.php.

References ilTableGUI\$data, ilTable2GUI\$filters, addFilterWhere(), array, beforeGetData(), getFields(), ilTable2GUI\getFilterItems(), arField\getName(), getSelectableColumns(), arViewField\getVisible(), ilTable2GUI\isColumnSelected(), setArCreatedByField(), setArFieldData(), setArModifiedByField(), setCustomFieldData(), ilTable2GUI\setData(), setEmptyFieldData(), and setOrderAndSegmentation().

Referenced by initTableRowTemplate(), and parseRow().

327  {
328  return ($field->getVisible() && !$this->getSelectableColumns()) || $this->isColumnSelected($field->getName());
329  }
isColumnSelected($a_col)
Is given column selected?
getSelectableColumns()
Get selectable columns.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ customizeFields()

arIndexTableGUI::customizeFields ( )
protected

To be overridden

Definition at line 124 of file class.arIndexTableGUI.php.

Referenced by arDeleteGUI\initCommandButtons(), and initFields().

124  {
125  }
+ Here is the caller graph for this function:

◆ domid_decode()

static arIndexTableGUI::domid_decode (   $id_to_decode)
static
Parameters
$id_to_decode
Returns
mixed Decode a DOM id encoded by domid_encode().

Definition at line 749 of file class.arIndexTableGUI.php.

Referenced by arGUI\executeCommand(), and arGUI\multiAction().

749  {
750  $decoded_id = "";
751  if (!empty($id_to_decode)) {
752  $decoded_id = preg_replace_callback('/__idstart_(.{2})_idend__/', function ($matches) {
753  return chr(hexdec($matches[1]));
754  }, $id_to_decode);
755  }
756 
757  return $decoded_id;
758  }
+ Here is the caller graph for this function:

◆ domid_encode()

static arIndexTableGUI::domid_encode (   $id_to_encode)
static
Parameters
$id_to_encode
Returns
mixed|null Encode a string for use as a DOM id. Replaces non-alphanumeric characters with an underscore and the hex representation of the character code with letters in lowercase see: http://brightonart.co.uk/blogs/dom-id-encode-php-function

Definition at line 731 of file class.arIndexTableGUI.php.

731  {
732  $encoded_id = NULL;
733  if (!empty($id_to_encode)) {
734  $encoded_id = preg_replace_callback('/([^a-zA-Z0-9])/', function ($matches) {
735  return "__idstart_" . strtolower(dechex(ord($matches[0]))) . "_idend__";
736  }, $id_to_encode);
737  }
738 
739  return $encoded_id;
740  }

◆ fillRow()

arIndexTableGUI::fillRow (   $a_set)
final
Parameters
array$a_set

Definition at line 605 of file class.arIndexTableGUI.php.

References addMultiItemActionCheckboxToRow(), parseRow(), and setCtrlParametersForRow().

605  {
606  $this->setCtrlParametersForRow($a_set);
607  $this->addMultiItemActionCheckboxToRow($a_set);
608  $this->parseRow($a_set);
609  $this->addActionsToRow($a_set);
610  }
addMultiItemActionCheckboxToRow($a_set)
+ Here is the call graph for this function:

◆ getActions()

arIndexTableGUI::getActions ( )
Returns

Definition at line 846 of file class.arIndexTableGUI.php.

References $actions.

Referenced by addAction(), initMultiItemActions(), initTableRowTemplate(), initToolbar(), and parseEntry().

846  {
847  return $this->actions;
848  }
+ Here is the caller graph for this function:

◆ getActionsAsArray()

arIndexTableGUI::getActionsAsArray ( )
Returns
[]

Definition at line 854 of file class.arIndexTableGUI.php.

Referenced by parseEntry().

854  {
855  return $this->actions->getActions();
856  }
+ Here is the caller graph for this function:

◆ getAddButtonTxt()

arIndexTableGUI::getAddButtonTxt ( )
protected
Returns
string

Definition at line 169 of file class.arIndexTableGUI.php.

References txt().

Referenced by initToolbar().

169  {
170  return $this->txt("add_item");
171  }
txt($txt, $plugin_txt=true)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getField()

arIndexTableGUI::getField (   $field_name)
Parameters
$field_name
Returns
arIndexTableField

Definition at line 790 of file class.arIndexTableGUI.php.

References getFields().

Referenced by parseRow().

790  {
791  return $this->getFields()->getField($field_name);
792  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getFields()

arIndexTableGUI::getFields ( )

◆ getFieldsAsArray()

arIndexTableGUI::getFieldsAsArray ( )
Returns
arIndexTableField[]

Definition at line 780 of file class.arIndexTableGUI.php.

References getFields().

Referenced by getSelectableColumns(), and initTableRowTemplate().

780  {
781  return $this->getFields()->getFields();
782  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMultiDeleteTxt()

arIndexTableGUI::getMultiDeleteTxt ( )
protected
Returns
string

Definition at line 184 of file class.arIndexTableGUI.php.

References txt().

Referenced by initMultiItemActions().

184  {
185  return $this->txt("delete", false);
186  }
txt($txt, $plugin_txt=true)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMultiItemActions()

arIndexTableGUI::getMultiItemActions ( )
Returns

Definition at line 870 of file class.arIndexTableGUI.php.

References $multi_item_actions.

Referenced by addMultiItemActionCheckboxToRow(), addMultipleSelectionColumn(), addMutliItemAction(), and initMultiItemActionsButton().

870  {
872  }
+ Here is the caller graph for this function:

◆ getMultiItemActionsAsArray()

arIndexTableGUI::getMultiItemActionsAsArray ( )
Returns

Definition at line 878 of file class.arIndexTableGUI.php.

References $multi_item_actions.

878  {
880  }

◆ getSelectableColumns()

arIndexTableGUI::getSelectableColumns ( )

Get selectable columns.

Returns
array

Definition at line 213 of file class.arIndexTableGUI.php.

References $fields, addFilterField(), getFields(), getFieldsAsArray(), ilTable2GUI\setFilterCols(), ilTable2GUI\setFilterCommand(), and ilTable2GUI\setResetCommand().

Referenced by checkColumnVisibile().

213  {
214  return $this->getFields()->getSelectableColumns($this);
215  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getTableTitle()

arIndexTableGUI::getTableTitle ( )
Returns
string

Definition at line 814 of file class.arIndexTableGUI.php.

References $table_title.

814  {
815  return $this->table_title;
816  }

◆ getToolbar()

arIndexTableGUI::getToolbar ( )
Returns

Definition at line 830 of file class.arIndexTableGUI.php.

References $toolbar.

Referenced by render().

830  {
831  return $this->toolbar;
832  }
+ Here is the caller graph for this function:

◆ initActions()

arIndexTableGUI::initActions ( )
protected

Definition at line 128 of file class.arIndexTableGUI.php.

References $lng, and addAction().

Referenced by initBeforeParentConstructor().

128  {
129  global $lng;
130 
131  $this->addAction(new arIndexTableAction('view', $lng->txt('view'), get_class($this->parent_obj), 'view', 'view'));
132  $this->addAction(new arIndexTableAction('edit', $lng->txt('edit'), get_class($this->parent_obj), 'edit', 'write'));
133  $this->addAction(new arIndexTableAction('delete', $lng->txt('delete'), get_class($this->parent_obj), 'delete', 'write'));
134  }
addAction(arIndexTableAction $action)
global $lng
Definition: privfeed.php:17
GUI-Class arIndexTableAction.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initAfterParentConstructor()

arIndexTableGUI::initAfterParentConstructor ( )
protected

Definition at line 95 of file class.arIndexTableGUI.php.

References initCommandButtons(), initFormAction(), initRowSelector(), initTableRowTemplate(), and initToolbar().

Referenced by __construct().

95  {
96  $this->initFormAction();
97  $this->initCommandButtons();
98  $this->initToolbar();
99 
100  $this->initTableFilter();
101  $this->initRowSelector();
102 
103  $this->initTableRowTemplate();
104  $this->initTableColumns();
105  $this->initTableData();
106  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initBeforeParentConstructor()

arIndexTableGUI::initBeforeParentConstructor ( )
protected

Definition at line 87 of file class.arIndexTableGUI.php.

References initActions(), initFields(), initMultiItemActions(), and initMultiItemActionsButton().

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initCommandButtons()

arIndexTableGUI::initCommandButtons ( )
protected

Definition at line 153 of file class.arIndexTableGUI.php.

Referenced by initAfterParentConstructor().

153  {
154  }
+ Here is the caller graph for this function:

◆ initFields()

arIndexTableGUI::initFields ( )
protected

Definition at line 114 of file class.arIndexTableGUI.php.

References customizeFields(), and fields.

Referenced by initBeforeParentConstructor().

114  {
115  $this->fields = new arIndexTableFields($this->active_record_list->getAR());
116  $this->customizeFields();
117  $this->fields->sortFields();
118  }
GUI-Class arIndexTableFields.
$errors fields
Definition: imgupload.php:52
customizeFields()
To be overridden
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initFormAction()

arIndexTableGUI::initFormAction ( )
protected

Definition at line 148 of file class.arIndexTableGUI.php.

References ilTable2GUI\setFormAction().

Referenced by initAfterParentConstructor().

148  {
149  $this->setFormAction($this->ctrl->getFormAction($this->parent_obj));
150  }
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initMultiItemActions()

arIndexTableGUI::initMultiItemActions ( )
protected

Definition at line 174 of file class.arIndexTableGUI.php.

References addMutliItemAction(), getActions(), and getMultiDeleteTxt().

Referenced by initBeforeParentConstructor().

174  {
175  if ($this->getActions() && $this->getActions()->getAction("delete")) {
176  $this->addMutliItemAction(new arIndexTableAction('delete', $this->getMultiDeleteTxt(), get_class($this->parent_obj), 'delete'));
177  }
178  }
addMutliItemAction(arIndexTableAction $action)
GUI-Class arIndexTableAction.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initMultiItemActionsButton()

arIndexTableGUI::initMultiItemActionsButton ( )
protected

Definition at line 200 of file class.arIndexTableGUI.php.

References ilTable2GUI\addMultiItemSelectionButton(), getMultiItemActions(), ilTable2GUI\setSelectAllCheckbox(), and txt().

Referenced by initBeforeParentConstructor().

200  {
201  if ($this->getMultiItemActions()) {
202  $this->addMultiItemSelectionButton("index_table_multi_action", $this->multi_item_actions->getActionsAsKeyTextArray(), "multiAction", $this->txt('execute', false));
203  $this->setSelectAllCheckbox("id[]");
204  }
205  }
txt($txt, $plugin_txt=true)
addMultiItemSelectionButton($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
Add Selection List + Command button for selected items.
setSelectAllCheckbox($a_select_all_checkbox)
Set the name of the checkbox that should be toggled with a select all button.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initRowSelector()

arIndexTableGUI::initRowSelector ( )
protected

Definition at line 277 of file class.arIndexTableGUI.php.

References ilTable2GUI\setShowRowsSelector().

Referenced by initAfterParentConstructor().

277  {
278  $this->setShowRowsSelector(true);
279  }
setShowRowsSelector($a_value)
Toggle rows-per-page selector.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initTableRowTemplate()

arIndexTableGUI::initTableRowTemplate ( )
protected
Returns
bool returns false, if dynamic template is needed, otherwise implement your own template by $this->setRowTemplate($a_template, $a_template_dir = '')

Definition at line 286 of file class.arIndexTableGUI.php.

References ilTable2GUI\addColumn(), addMultipleSelectionColumn(), checkColumnVisibile(), getActions(), getFieldsAsArray(), ilTable2GUI\setRowTemplate(), and txt().

Referenced by initAfterParentConstructor().

286  {
287  $this->setRowTemplate('tpl.record_row.html', './Services/ActiveRecord/');
288  }
setRowTemplate($a_template, $a_template_dir="")
Set row template.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initTitle()

arIndexTableGUI::initTitle ( )
protected

Definition at line 109 of file class.arIndexTableGUI.php.

References ilTable2GUI\getId(), and setTableTitle().

109  {
110  $this->setTableTitle($this->getId());
111  }
setTableTitle($table_title)
getId()
Get element id.
+ Here is the call graph for this function:

◆ initToolbar()

arIndexTableGUI::initToolbar ( )
protected

Definition at line 157 of file class.arIndexTableGUI.php.

References $toolbar, getActions(), getAddButtonTxt(), and setToolbar().

Referenced by initAfterParentConstructor().

157  {
158  if ($this->getActions() && $this->getActions()->getAction("edit")) {
159  $toolbar = new ilToolbarGUI();
160  $toolbar->addButton($this->getAddButtonTxt(), $this->ctrl->getLinkTarget($this->parent_obj, "add"));
161  $this->setToolbar($toolbar);
162  }
163  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parseEntry()

arIndexTableGUI::parseEntry ( arIndexTableField  $field,
  $value 
)
protected
Parameters
arIndexTableField$field
mixed$value

Definition at line 649 of file class.arIndexTableGUI.php.

References $_GET, $access, getActions(), getActionsAsArray(), getFields(), and txt().

Referenced by parseRow().

649  {
650  $this->tpl->setCurrentBlock('entry');
651  $this->tpl->setVariable('ENTRY_CONTENT', $value);
652  $this->tpl->parseCurrentBlock('entry');
653  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parseRow()

arIndexTableGUI::parseRow (   $a_set)
protected
Parameters
$a_set

Definition at line 635 of file class.arIndexTableGUI.php.

References checkColumnVisibile(), getField(), and parseEntry().

Referenced by fillRow().

635  {
636  foreach ($a_set as $key => $value) {
637  $field = $this->getField($key);
638  if ($this->checkColumnVisibile($field)) {
639  $this->parseEntry($field, $value);
640  }
641  }
642  }
checkColumnVisibile(arIndexTableField $field)
parseEntry(arIndexTableField $field, $value)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ render()

arIndexTableGUI::render ( )
Returns
string

Definition at line 686 of file class.arIndexTableGUI.php.

References ilTable2GUI\getHTML(), and getToolbar().

686  {
687 
688  $index_table_tpl = new ilTemplate("tpl.index_table.html", true, true, "./Services/ActiveRecord/");
689  if ($this->getToolbar()) {
690  $index_table_tpl->setVariable("TOOLBAR", $this->getToolbar()->getHTML());
691  }
692 
693  $index_table_tpl->setVariable("TABLE", parent::render());
694 
695  return $index_table_tpl->get();
696  }
getHTML()
Get HTML.
special template class to simplify handling of ITX/PEAR
+ Here is the call graph for this function:

◆ resetFilter()

arIndexTableGUI::resetFilter ( )

Definition at line 717 of file class.arIndexTableGUI.php.

References ilTable2GUI\resetOffset().

717  {
718  parent::resetFilter();
719  $this->resetOffset();
720  $this->initTableData();
721  }
resetOffset($a_in_determination=false)
Reset offset.
+ Here is the call graph for this function:

◆ setActions()

arIndexTableGUI::setActions (   $actions)
Parameters
\arIndexTableActions$actions

Definition at line 838 of file class.arIndexTableGUI.php.

References $actions.

Referenced by addAction().

838  {
839  $this->actions = $actions;
840  }
+ Here is the caller graph for this function:

◆ setArCreatedByField()

arIndexTableGUI::setArCreatedByField ( arIndexTableField  $field,
  $item,
  $value 
)
protected
Parameters
arIndexTableField$field
$item
$value
Returns
string

Definition at line 543 of file class.arIndexTableGUI.php.

Referenced by checkColumnVisibile().

543  {
544  $user = new ilObjUser($value);
545 
546  return $user->getPublicName();
547  }
+ Here is the caller graph for this function:

◆ setArFieldData()

arIndexTableGUI::setArFieldData ( arIndexTableField  $field,
  $item,
  $value 
)
protected
Parameters
arIndexTableField$field
$item
$value
Returns
string

Definition at line 557 of file class.arIndexTableGUI.php.

References arField\getFieldType(), and setDateFieldData().

Referenced by checkColumnVisibile().

557  {
558  switch ($field->getFieldType()) {
559  case 'integer':
560  case 'float':
561  case 'text':
562  case 'clob':
563  return $value;
564  case 'date':
565  case 'time':
566  case 'timestamp':
567  return $this->setDateFieldData($field, $item, $value);
568  }
569 
570  return "";
571  }
setDateFieldData(arIndexTableField $field, $item, $value)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setArModifiedByField()

arIndexTableGUI::setArModifiedByField ( arIndexTableField  $field,
  $item,
  $value 
)
protected
Parameters
arIndexTableField$field
$item
$value
Returns
string

Definition at line 529 of file class.arIndexTableGUI.php.

Referenced by checkColumnVisibile().

529  {
530  $user = new ilObjUser($value);
531 
532  return $user->getPublicName();
533  }
+ Here is the caller graph for this function:

◆ setCtrlParametersForRow()

arIndexTableGUI::setCtrlParametersForRow (   $a_set)
protected
Parameters
$a_set

Definition at line 616 of file class.arIndexTableGUI.php.

References getFields().

Referenced by fillRow().

616  {
617  $this->ctrl->setParameterByClass(get_class($this->parent_obj), 'ar_id', self::domid_encode($a_set[$this->getFields()->getPrimaryField()
618  ->getName()]));
619  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setCustomFieldData()

arIndexTableGUI::setCustomFieldData ( arIndexTableField  $field,
  $item 
)
protected
Parameters
arIndexTableField$field
$item
Returns
string

Definition at line 594 of file class.arIndexTableGUI.php.

Referenced by checkColumnVisibile().

594  {
595  return "CUSTOM-OVERRIDE: setCustomFieldData";
596  }
+ Here is the caller graph for this function:

◆ setDateFieldData()

arIndexTableGUI::setDateFieldData ( arIndexTableField  $field,
  $item,
  $value 
)
protected
Parameters
arIndexTableField$field
$item
$value
Returns
string

Definition at line 581 of file class.arIndexTableGUI.php.

References ilDatePresentation\formatDate(), IL_CAL_DATETIME, and IL_CAL_UNIX.

Referenced by setArFieldData().

581  {
582  $datetime = new ilDateTime($value, IL_CAL_DATETIME);
583 
584  return ilDatePresentation::formatDate($datetime, IL_CAL_UNIX);
585  }
const IL_CAL_DATETIME
const IL_CAL_UNIX
static formatDate(ilDateTime $date)
Format a date public.
Date and time handling
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setEmptyFieldData()

arIndexTableGUI::setEmptyFieldData ( arIndexTableField  $field,
  $item 
)
protected
Parameters
arIndexTableField$field
$item
Returns
string

Definition at line 517 of file class.arIndexTableGUI.php.

Referenced by checkColumnVisibile().

517  {
518  return "";
519  }
+ Here is the caller graph for this function:

◆ setFields()

arIndexTableGUI::setFields ( arIndexTableFields  $fields)
Parameters
arIndexTableFields$fields

Definition at line 764 of file class.arIndexTableGUI.php.

References $fields, and fields.

764  {
765  $this->fields = $fields;
766  }
$fields
arIndexTableFields
$errors fields
Definition: imgupload.php:52

◆ setMultiItemActions()

arIndexTableGUI::setMultiItemActions (   $multi_item_actions)
Parameters
\arIndexTableActions$multi_item_actions

Definition at line 862 of file class.arIndexTableGUI.php.

References $multi_item_actions.

Referenced by addMutliItemAction().

862  {
863  $this->multi_item_actions = $multi_item_actions;
864  }
+ Here is the caller graph for this function:

◆ setOrderAndSegmentation()

arIndexTableGUI::setOrderAndSegmentation ( )
protected

Definition at line 497 of file class.arIndexTableGUI.php.

References ilTable2GUI\determineLimit(), ilTable2GUI\determineOffsetAndOrder(), ilTable2GUI\getDefaultOrderField(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), and ilTableGUI\setMaxCount().

Referenced by checkColumnVisibile().

497  {
498  $this->setExternalSorting(true);
499  $this->setExternalSegmentation(true);
500  if (!$this->getDefaultOrderField()) {
501  $this->setDefaultOrderField($this->active_record_list->getAR()->getArFieldList()->getPrimaryField()->getName());
502  }
503  $this->determineLimit();
504  $this->determineOffsetAndOrder();
505  $this->setMaxCount($this->active_record_list->count());
506  $this->active_record_list->orderBy($this->getOrderField(), $this->getOrderDirection());
507  $this->active_record_list->limit($this->getOffset(), $this->getLimit());
508  }
setExternalSorting($a_val)
Set external sorting.
getDefaultOrderField()
Get Default order field.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
setExternalSegmentation($a_val)
Set external segmentation.
determineLimit()
Determine the limit.
getOrderDirection()
Get order direction.
getOffset()
Get offset.
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
getLimit()
Get limit.
setMaxCount($a_max_count)
set max.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setTableTitle()

arIndexTableGUI::setTableTitle (   $table_title)
Parameters
string$table_title

Definition at line 806 of file class.arIndexTableGUI.php.

References $table_title.

Referenced by initTitle().

806  {
807  $this->table_title = $table_title;
808  }
+ Here is the caller graph for this function:

◆ setToolbar()

arIndexTableGUI::setToolbar (   $toolbar)
Parameters
\ilToolbarGUI$toolbar

Definition at line 822 of file class.arIndexTableGUI.php.

References $toolbar.

Referenced by initToolbar().

822  {
823  $this->toolbar = $toolbar;
824  }
+ Here is the caller graph for this function:

◆ txt()

arIndexTableGUI::txt (   $txt,
  $plugin_txt = true 
)
Parameters
$txt
bool$plugin_txt
Returns
string

Definition at line 705 of file class.arIndexTableGUI.php.

References $txt.

Referenced by addFilterField(), getAddButtonTxt(), getMultiDeleteTxt(), arDeleteGUI\initCommandButtons(), initMultiItemActionsButton(), initTableRowTemplate(), and parseEntry().

705  {
706  return $this->parent_obj->txt($txt, $plugin_txt);
707  }
$txt
Definition: error.php:12
+ Here is the caller graph for this function:

Field Documentation

◆ $access

arIndexTableGUI::$access
protected

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

Referenced by parseEntry().

◆ $actions

arIndexTableGUI::$actions
protected

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

Referenced by getActions(), and setActions().

◆ $active_record_list

arIndexTableGUI::$active_record_list = NULL
protected

Definition at line 55 of file class.arIndexTableGUI.php.

Referenced by __construct().

◆ $ctrl

arIndexTableGUI::$ctrl
protected

Definition at line 23 of file class.arIndexTableGUI.php.

◆ $fields

arIndexTableGUI::$fields = NULL
protected

◆ $multi_item_actions

arIndexTableGUI::$multi_item_actions = array()
protected

◆ $parent_obj

arIndexTableGUI::$parent_obj = NULL
protected

Definition at line 59 of file class.arIndexTableGUI.php.

◆ $table_title

arIndexTableGUI::$table_title = ''
protected

Definition at line 47 of file class.arIndexTableGUI.php.

Referenced by getTableTitle(), and setTableTitle().

◆ $tabs

arIndexTableGUI::$tabs
protected

Definition at line 27 of file class.arIndexTableGUI.php.

◆ $toolbar

arIndexTableGUI::$toolbar = NULL
protected

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

Referenced by getToolbar(), initToolbar(), and setToolbar().


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