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

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 ()
 @description 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
 $ctrl
 
 $tpl
 
 $parent_obj
 
 $parent_cmd
 
 $close_command = ""
 
 $top_anchor = "il_table_top"
 
 $filters = array()
 
 $optional_filters = array()
 
 $filter_cmd = 'applyFilter'
 
 $reset_cmd = 'resetFilter'
 
 $filter_cols = 5
 
 $ext_sort = false
 
 $ext_seg = false
 
 $context = ""
 
 $mi_sel_buttons = []
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = true
 
 $rows_selector_off = false
 
 $nav_determined = false
 
 $limit_determined = false
 
 $filters_determined = false
 
 $columns_determined = false
 
 $open_form_tag = true
 
 $close_form_tag = true
 
 $export_formats = []
 
 $export_mode
 
 $print_mode
 
 $enable_command_for_all
 
 $restore_filter
 
 $restore_filter_values
 
 $default_filter_visibility = false
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 
 $select_all_on_top = false
 
 $sel_buttons = []
 
- Protected Attributes inherited from ilTableGUI
 $tpl
 
 $lng
 

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 FILTER_CHECKBOX = 9
 
const EXPORT_EXCEL = 1
 
const EXPORT_CSV = 2
 
const ACTION_ALL_LIMIT = 1000
 
- Data Fields inherited from ilTableGUI
 $title
 
 $icon
 
 $icon_alt
 
 $help_page
 
 $help_icon
 
 $help_icon_alt
 
 $header_names
 
 $header_vars
 
 $linkbar_vars
 
 $data
 
 $column_count
 
 $column_width
 
 $max_count
 
 $limit
 
 $max_limit = false
 
 $offset
 
 $order_column
 
 $order_direction
 
 $footer_style
 
 $footer_previous
 
 $footer_next
 
 $lang_support = true
 
 $global_tpl
 
 $form_name
 
 $select_all_checkbox
 
 $action_buttons
 
 $prefix
 
 $base = ""
 
 $enabled
 
 $styles
 

Detailed Description

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 16 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 66 of file class.arIndexTableGUI.php.

67 {
68 global $DIC;
69 $ilCtrl = $DIC['ilCtrl'];
70 $ilTabs = $DIC['ilTabs'];
71 $ilAccess = $DIC['ilAccess'];
72 $this->ctrl = $ilCtrl;
73 $this->tabs = $ilTabs;
74 $this->access = $ilAccess;
75
76 $this->parent_obj = $a_parent_obj;
77
78 $this->active_record_list = $active_record_list;
79
80 $this->setId(strtolower(get_class($this->active_record_list->getAR()) . "_index"));
81
83
84 parent::__construct($a_parent_obj, $a_parent_cmd);
85
87 }
setId($a_val)
Set id.
global $ilCtrl
Definition: ilias.php:18
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
$DIC
Definition: xapitoken.php:46

References $active_record_list, $DIC, $ilCtrl, ILIAS\GlobalScreen\Provider\__construct(), initAfterParentConstructor(), initBeforeParentConstructor(), and ilTable2GUI\setId().

+ Here is the call graph for this function:

Member Function Documentation

◆ addAction()

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

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

151 {
152 if (!$this->getActions()) {
153 $this->setActions(new arIndexTableActions());
154 }
155 $this->actions->addAction($action);
156 }
GUI-Class arIndexTableActions.

References getActions(), and setActions().

Referenced by initActions().

+ 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 855 of file class.arIndexTableGUI.php.

856 {
857 $this->getFields()->addField($field);
858 }

References getFields().

+ Here is the call graph for this function:

◆ addFilterCustomWhere()

arIndexTableGUI::addFilterCustomWhere ( )
protected

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

523 {
524 }

Referenced by addFilterWhere().

+ Here is the caller graph for this function:

◆ addFilterDateTimeWhere()

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

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

508 {
509 if ($value["from"] != null or $value["to"] != null) {
510 if ($value["from"] == null) {
511 $value["from"] = new ilDateTime("0001-01-01", IL_CAL_DATE);
512 }
513 if ($value["to"] == null) {
514 $value["to"] = new ilDateTime("9999-01-01", IL_CAL_DATE);
515 }
516 $this->active_record_list->where($this->active_record_list->getAR()->getConnectorContainerName() . "." . $name . " BETWEEN '"
517 . $value["from"]->get(IL_CAL_DATETIME) . "' AND '" . $value["to"]->get(IL_CAL_DATETIME) . "'");
518 }
519 }
const IL_CAL_DATE
const IL_CAL_DATETIME
@classDescription Date and time handling
if($format !==null) $name
Definition: metadata.php:230

References $name, IL_CAL_DATE, and IL_CAL_DATETIME.

Referenced by addFilterWhere().

+ Here is the caller graph for this function:

◆ addFilterDateWhere()

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

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

488 {
489 if ($value["from"] != null or $value["to"] != null) {
490 if ($value["from"] == null) {
491 $value["from"] = new ilDateTime("0001-01-01", IL_CAL_DATE);
492 }
493 if ($value["to"] == null) {
494 $value["to"] = new ilDateTime("9999-01-01", IL_CAL_DATE);
495 }
496 $this->active_record_list->where($this->active_record_list->getAR()->getConnectorContainerName() . "." . $name . " BETWEEN '"
497 . $value["from"]->get(IL_CAL_DATE) . "' AND '" . $value["to"]->get(IL_CAL_DATE) . "'");
498 }
499 }

References $name, and IL_CAL_DATE.

Referenced by addFilterWhere().

+ Here is the caller graph for this function:

◆ addFilterField()

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

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

264 {
265 switch ($field->getFieldType()) {
266 case 'integer':
267 case 'float':
268 $this->addFilterItemByMetaType($field->getName(), self::FILTER_NUMBER_RANGE, false, $this->txt($field->getTxt()));
269 break;
270 case 'text':
271 case 'clob':
272 $this->addFilterItemByMetaType($field->getName(), self::FILTER_TEXT, false, $this->txt($field->getTxt()));
273 break;
274 case 'date':
275 $this->addFilterItemByMetaType($field->getName(), self::FILTER_DATE_RANGE, false, $this->txt($field->getTxt()));
276 break;
277 case 'time':
278 case 'timestamp':
279 $this->addFilterItemByMetaType($field->getName(), self::FILTER_DATETIME_RANGE, false, $this->txt($field->getTxt()));
280 break;
281 }
282 }
addFilterItemByMetaType($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null)
Add filter by standard type.

References ilTable2GUI\addFilterItemByMetaType(), arField\getFieldType(), arField\getName(), and arViewField\getTxt().

+ Here is the call graph for this function:

◆ addFilterNumericWhere()

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

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

457 {
458 if ($value["from"] != "" or $value["to"] != "") {
459 if ($value["from"] == "") {
460 $value["from"] = 0;
461 }
462 if ($value["to"] == "") {
463 $value["to"] = PHP_INT_MAX;
464 }
465 $this->active_record_list->where($this->active_record_list->getAR()->getConnectorContainerName() . "." . $name . " >= " . $value["from"]
466 . " AND " . $this->active_record_list->getAR()->getConnectorContainerName() . "." . $name . " <= " . $value["to"]);
467 }
468 }

References $name.

Referenced by addFilterWhere().

+ Here is the caller graph for this function:

◆ addFilterTextWhere()

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

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

477 {
478 $this->active_record_list->where($this->active_record_list->getAR()->getConnectorContainerName() . "." . $name . " like '%" . $value . "%'");
479 }

References $name.

Referenced by addFilterWhere().

+ Here is the caller graph for this function:

◆ addFilterWhere()

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

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

418 {
419 switch (get_class($filter)) {
420 case 'ilTextInputGUI':
421 $this->addFilterTextWhere($filter, $name, $value);
422
423 return;
424 case 'ilCombinationInputGUI':
425 if (is_object($value["from"]) || is_object($value["to"])) {
426 if (get_class($value["from"]) == "ilDateTime" || get_class($value["to"]) == "ilDateTime") {
427 $this->addFilterDateTimeWhere($filter, $name, $value);
428
429 return;
430 }
431 if (get_class($value["from"]) == "ilDate" || get_class($value["to"]) == "ilDate") {
432 $this->addFilterDateWhere($filter, $name, $value);
433
434 return;
435 }
436 $this->addFilterCustomWhere($filter, $name, $value);
437
438 return;
439 }
440
441 $this->addFilterNumericWhere($filter, $name, $value);
442 break;
443 default:
444 $this->addFilterCustomWhere($filter, $name, $value);
445
446 return;
447 }
448 }
addFilterTextWhere(ilTextInputGUI $filter, $name, $value)
addFilterDateTimeWhere(ilCombinationInputGUI $filter, $name, $value)
addFilterNumericWhere(ilCombinationInputGUI $filter, $name, $value)
addFilterDateWhere(ilCombinationInputGUI $filter, $name, $value)

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

+ Here is the call graph for this function:

◆ addMultiItemActionCheckboxToRow()

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

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

670 {
671 if ($this->getMultiItemActions()) {
672 $this->tpl->setVariable('ID', self::domid_encode($a_set[$this->getFields()->getPrimaryField()->getName()]));
673 }
674 }

References getFields(), and getMultiItemActions().

Referenced by fillRow().

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

◆ addMultipleSelectionColumn()

arIndexTableGUI::addMultipleSelectionColumn ( )
protected

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

342 {
343 if ($this->getMultiItemActions()) {
344 $this->addColumn("", "", 1);
345 }
346 }
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.

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

+ Here is the call graph for this function:

◆ addMutliItemAction()

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

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

210 {
211 if (!$this->getMultiItemActions()) {
213 }
214 $this->multi_item_actions->addAction($action);
215 }
setMultiItemActions($multi_item_actions)

References getMultiItemActions(), and setMultiItemActions().

Referenced by initMultiItemActions().

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

◆ applyFilter()

arIndexTableGUI::applyFilter ( )

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

760 {
761 $this->writeFilterToSession();
762 $this->resetOffset();
763 $this->initTableData();
764 }
resetOffset($a_in_determination=false)
Reset offset.
writeFilterToSession()
Write filter values to session.

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

+ Here is the call graph for this function:

◆ beforeGetData()

arIndexTableGUI::beforeGetData ( )
protected

Reimplemented in arDeleteGUI.

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

528 {
529 }

◆ checkColumnVisibile()

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

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

355 {
356 return ($field->getVisible() && !$this->getSelectableColumns()) || $this->isColumnSelected($field->getName());
357 }
isColumnSelected($a_col)
Is given column selected?

References arField\getName(), arViewField\getVisible(), and ilTable2GUI\isColumnSelected().

Referenced by parseRow().

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

◆ customizeFields()

arIndexTableGUI::customizeFields ( )
protected

@description To be overridden

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

132 {
133 }

Referenced by initFields().

+ Here is the caller graph for this function:

◆ domid_decode()

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

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

802 {
803 $decoded_id = "";
804 if (!empty($id_to_decode)) {
805 $decoded_id = preg_replace_callback('/__idstart_(.{2})_idend__/', function ($matches) {
806 return chr(hexdec($matches[1]));
807 }, $id_to_decode);
808 }
809
810 return $decoded_id;
811 }

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

+ 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 @description 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 782 of file class.arIndexTableGUI.php.

783 {
784 $encoded_id = null;
785 if (!empty($id_to_encode)) {
786 $encoded_id = preg_replace_callback('/([^a-zA-Z0-9])/', function ($matches) {
787 return "__idstart_" . strtolower(dechex(ord($matches[0]))) . "_idend__";
788 }, $id_to_encode);
789 }
790
791 return $encoded_id;
792 }

◆ fillRow()

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

Reimplemented from ilTable2GUI.

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

648 {
649 $this->setCtrlParametersForRow($a_set);
650 $this->addMultiItemActionCheckboxToRow($a_set);
651 $this->parseRow($a_set);
652 $this->addActionsToRow($a_set);
653 }
addMultiItemActionCheckboxToRow($a_set)

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

+ Here is the call graph for this function:

◆ getActions()

arIndexTableGUI::getActions ( )
Returns
\arIndexTableActions

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

910 {
911 return $this->actions;
912 }

References $actions.

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

+ Here is the caller graph for this function:

◆ getActionsAsArray()

arIndexTableGUI::getActionsAsArray ( )
Returns
\arIndexTableAction[]

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

919 {
920 return $this->actions->getActions();
921 }

◆ getAddButtonTxt()

arIndexTableGUI::getAddButtonTxt ( )
protected
Returns
string

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

184 {
185 return $this->txt("add_item");
186 }
txt($txt, $plugin_txt=true)

References txt().

Referenced by initToolbar().

+ 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 846 of file class.arIndexTableGUI.php.

847 {
848 return $this->getFields()->getField($field_name);
849 }

References getFields().

Referenced by parseRow().

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

◆ getFields()

arIndexTableGUI::getFields ( )
Returns
arIndexTableFields

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

827 {
828 return $this->fields;
829 }
$fields
arIndexTableFields

References $fields.

Referenced by addField(), addMultiItemActionCheckboxToRow(), arDeleteGUI\buildWhereQueryForIds(), getField(), getFieldsAsArray(), getSelectableColumns(), and setCtrlParametersForRow().

+ Here is the caller graph for this function:

◆ getFieldsAsArray()

arIndexTableGUI::getFieldsAsArray ( )
Returns
arIndexTableField[]

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

836 {
837 return $this->getFields()->getFields();
838 }

References getFields().

+ Here is the call graph for this function:

◆ getMultiDeleteTxt()

arIndexTableGUI::getMultiDeleteTxt ( )
protected
Returns
string

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

201 {
202 return $this->txt("delete", false);
203 }

References txt().

Referenced by initMultiItemActions().

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

◆ getMultiItemActions()

arIndexTableGUI::getMultiItemActions ( )
Returns
\arIndexTableActions

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

References $multi_item_actions.

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

+ Here is the caller graph for this function:

◆ getMultiItemActionsAsArray()

arIndexTableGUI::getMultiItemActionsAsArray ( )
Returns
\arIndexTableActions

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

946 {
948 }

References $multi_item_actions.

◆ getSelectableColumns()

arIndexTableGUI::getSelectableColumns ( )

Get selectable columns.

Returns
array

Reimplemented from ilTable2GUI.

Reimplemented in arDeleteGUI.

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

233 {
234 return $this->getFields()->getSelectableColumns($this);
235 }

References getFields().

+ Here is the call graph for this function:

◆ getTableTitle()

arIndexTableGUI::getTableTitle ( )
Returns
string

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

874 {
875 return $this->table_title;
876 }

References $table_title.

◆ getToolbar()

arIndexTableGUI::getToolbar ( )
Returns
\ilToolbarGUI

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

892 {
893 return $this->toolbar;
894 }

References $toolbar.

Referenced by render().

+ Here is the caller graph for this function:

◆ initActions()

arIndexTableGUI::initActions ( )
protected

Reimplemented in arDeleteGUI.

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

137 {
138 global $DIC;
139 $lng = $DIC['lng'];
140
141 $this->addAction(new arIndexTableAction('view', $lng->txt('view'), get_class($this->parent_obj), 'view', 'view'));
142 $this->addAction(new arIndexTableAction('edit', $lng->txt('edit'), get_class($this->parent_obj), 'edit', 'write'));
143 $this->addAction(new arIndexTableAction('delete', $lng->txt('delete'), get_class($this->parent_obj), 'delete', 'write'));
144 }
GUI-Class arIndexTableAction.
addAction(arIndexTableAction $action)

References $DIC, ilTableGUI\$lng, and addAction().

Referenced by initBeforeParentConstructor().

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

◆ initAfterParentConstructor()

arIndexTableGUI::initAfterParentConstructor ( )
protected

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

100 {
101 $this->initFormAction();
102 $this->initCommandButtons();
103 $this->initToolbar();
104
105 $this->initTableFilter();
106 $this->initRowSelector();
107
108 $this->initTableRowTemplate();
109 $this->initTableColumns();
110 $this->initTableData();
111 }

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

Referenced by __construct().

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

◆ initBeforeParentConstructor()

arIndexTableGUI::initBeforeParentConstructor ( )
protected

Definition at line 90 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

Reimplemented in arDeleteGUI.

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

166 {
167 }

Referenced by initAfterParentConstructor().

+ Here is the caller graph for this function:

◆ initFields()

arIndexTableGUI::initFields ( )
protected

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

121 {
122 $this->fields = new arIndexTableFields($this->active_record_list->getAR());
123 $this->customizeFields();
124 $this->fields->sortFields();
125 }
GUI-Class arIndexTableFields.
customizeFields()
@description To be overridden
$errors fields
Definition: imgupload.php:51

References customizeFields(), and fields.

Referenced by initBeforeParentConstructor().

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

◆ initFormAction()

arIndexTableGUI::initFormAction ( )
protected

Reimplemented in arDeleteGUI.

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

160 {
161 $this->setFormAction($this->ctrl->getFormAction($this->parent_obj));
162 }
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.

References ilTable2GUI\setFormAction().

Referenced by initAfterParentConstructor().

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

◆ initMultiItemActions()

arIndexTableGUI::initMultiItemActions ( )
protected

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

190 {
191 if ($this->getActions() && $this->getActions()->getAction("delete")) {
192 $this->addMutliItemAction(new arIndexTableAction('delete', $this->getMultiDeleteTxt(), get_class($this->parent_obj), 'delete'));
193 }
194 }
addMutliItemAction(arIndexTableAction $action)

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

Referenced by initBeforeParentConstructor().

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

◆ initMultiItemActionsButton()

arIndexTableGUI::initMultiItemActionsButton ( )
protected

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

219 {
220 if ($this->getMultiItemActions()) {
221 $this->addMultiItemSelectionButton("index_table_multi_action", $this->multi_item_actions->getActionsAsKeyTextArray(), "multiAction", $this->txt('execute', false));
222 $this->setSelectAllCheckbox("id[]");
223 }
224 }
setSelectAllCheckbox($a_select_all_checkbox, $a_select_all_on_top=false)
Set the name of the checkbox that should be toggled with a select all button.
addMultiItemSelectionButton($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
Add Selection List + Command button for selected items.

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

Referenced by initBeforeParentConstructor().

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

◆ initRowSelector()

arIndexTableGUI::initRowSelector ( )
protected

Reimplemented in arDeleteGUI.

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

301 {
302 $this->setShowRowsSelector(true);
303 }
setShowRowsSelector($a_value)
Toggle rows-per-page selector.

References ilTable2GUI\setShowRowsSelector().

Referenced by initAfterParentConstructor().

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

◆ initTableRowTemplate()

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

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

311 {
312 $this->setRowTemplate('tpl.record_row.html', './Services/ActiveRecord/');
313 }
setRowTemplate($a_template, $a_template_dir="")
Set row template.

References ilTable2GUI\setRowTemplate().

Referenced by initAfterParentConstructor().

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

◆ initTitle()

arIndexTableGUI::initTitle ( )
protected

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

115 {
116 $this->setTableTitle($this->getId());
117 }
setTableTitle($table_title)
getId()
Get element id.

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

+ Here is the call graph for this function:

◆ initToolbar()

arIndexTableGUI::initToolbar ( )
protected

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

171 {
172 if ($this->getActions() && $this->getActions()->getAction("edit")) {
173 $toolbar = new ilToolbarGUI();
174 $toolbar->addButton($this->getAddButtonTxt(), $this->ctrl->getLinkTarget($this->parent_obj, "add"));
175 $this->setToolbar($toolbar);
176 }
177 }

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

Referenced by initAfterParentConstructor().

+ 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 695 of file class.arIndexTableGUI.php.

696 {
697 $this->tpl->setCurrentBlock('entry');
698 $this->tpl->setVariable('ENTRY_CONTENT', $value);
699 $this->tpl->parseCurrentBlock('entry');
700 }

Referenced by parseRow().

+ Here is the caller graph for this function:

◆ parseRow()

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

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

681 {
682 foreach ($a_set as $key => $value) {
683 $field = $this->getField($key);
684 if ($this->checkColumnVisibile($field)) {
685 $this->parseEntry($field, $value);
686 }
687 }
688 }
parseEntry(arIndexTableField $field, $value)
checkColumnVisibile(arIndexTableField $field)

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

Referenced by fillRow().

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

◆ render()

arIndexTableGUI::render ( )
Returns
string

Reimplemented from ilTable2GUI.

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

735 {
736 $index_table_tpl = new ilTemplate("tpl.index_table.html", true, true, "./Services/ActiveRecord/");
737 if ($this->getToolbar()) {
738 $index_table_tpl->setVariable("TOOLBAR", $this->getToolbar()->getHTML());
739 }
740
741 $index_table_tpl->setVariable("TABLE", parent::render());
742
743 return $index_table_tpl->get();
744 }
getHTML()
Get HTML.
special template class to simplify handling of ITX/PEAR

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

+ Here is the call graph for this function:

◆ resetFilter()

arIndexTableGUI::resetFilter ( )

Reset filter.

Reimplemented from ilTable2GUI.

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

768 {
769 parent::resetFilter();
770 $this->resetOffset();
771 $this->initTableData();
772 }

References ilTable2GUI\resetOffset().

+ Here is the call graph for this function:

◆ setActions()

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

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

901 {
902 $this->actions = $actions;
903 }

References $actions.

Referenced by addAction().

+ 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 581 of file class.arIndexTableGUI.php.

582 {
583 $user = new ilObjUser($value);
584
585 return $user->getPublicName();
586 }

◆ setArFieldData()

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

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

597 {
598 switch ($field->getFieldType()) {
599 case 'integer':
600 case 'float':
601 case 'text':
602 case 'clob':
603 return $value;
604 case 'date':
605 case 'time':
606 case 'timestamp':
607 return $this->setDateFieldData($field, $item, $value);
608 }
609
610 return "";
611 }
setDateFieldData(arIndexTableField $field, $item, $value)

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

+ Here is the call graph for this function:

◆ setArModifiedByField()

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

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

567 {
568 $user = new ilObjUser($value);
569
570 return $user->getPublicName();
571 }

◆ setCtrlParametersForRow()

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

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

660 {
661 $this->ctrl->setParameterByClass(get_class($this->parent_obj), 'ar_id', self::domid_encode($a_set[$this->getFields()->getPrimaryField()
662 ->getName()]));
663 }

References getFields().

Referenced by fillRow().

+ 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 635 of file class.arIndexTableGUI.php.

636 {
637 return "CUSTOM-OVERRIDE: setCustomFieldData";
638 }

◆ setDateFieldData()

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

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

622 {
623 $datetime = new ilDateTime($value, IL_CAL_DATETIME);
624
626 }
const IL_CAL_UNIX
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false, $include_seconds=false)
Format a date @access public.

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

Referenced by setArFieldData().

+ 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 553 of file class.arIndexTableGUI.php.

554 {
555 return "";
556 }

◆ setFields()

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

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

818 {
819 $this->fields = $fields;
820 }

References $fields, and fields.

◆ setMultiItemActions()

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

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

928 {
929 $this->multi_item_actions = $multi_item_actions;
930 }

References $multi_item_actions.

Referenced by addMutliItemAction().

+ Here is the caller graph for this function:

◆ setOrderAndSegmentation()

arIndexTableGUI::setOrderAndSegmentation ( )
protected

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

533 {
534 $this->setExternalSorting(true);
535 $this->setExternalSegmentation(true);
536 if (!$this->getDefaultOrderField()) {
537 $this->setDefaultOrderField($this->active_record_list->getAR()->getArFieldList()->getPrimaryField()->getName());
538 }
539 $this->determineLimit();
541 $this->setMaxCount($this->active_record_list->count());
542 $this->active_record_list->orderBy($this->getOrderField(), $this->getOrderDirection());
543 $this->active_record_list->limit($this->getOffset(), $this->getLimit());
544 }
setExternalSorting($a_val)
Set external sorting.
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
getLimit()
Get limit.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
getOffset()
Get offset.
setExternalSegmentation($a_val)
Set external segmentation.
determineLimit()
Determine the limit.
getDefaultOrderField()
Get Default order field.
getOrderDirection()
Get order direction.
setMaxCount($a_max_count)
set max.

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

+ Here is the call graph for this function:

◆ setTableTitle()

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

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

865 {
866 $this->table_title = $table_title;
867 }

References $table_title.

Referenced by initTitle().

+ Here is the caller graph for this function:

◆ setToolbar()

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

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

883 {
884 $this->toolbar = $toolbar;
885 }

References $toolbar.

Referenced by initToolbar().

+ 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 753 of file class.arIndexTableGUI.php.

754 {
755 return $this->parent_obj->txt($txt, $plugin_txt);
756 }
$txt
Definition: error.php:13

References $txt.

Referenced by getAddButtonTxt(), getMultiDeleteTxt(), and arDeleteGUI\initCommandButtons().

+ Here is the caller graph for this function:

Field Documentation

◆ $access

arIndexTableGUI::$access
protected

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

◆ $actions

arIndexTableGUI::$actions
protected

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

Referenced by getActions(), and setActions().

◆ $active_record_list

arIndexTableGUI::$active_record_list = null
protected

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

Referenced by __construct(), and arDeleteGUI\__construct().

◆ $ctrl

arIndexTableGUI::$ctrl
protected

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

◆ $fields

arIndexTableGUI::$fields = null
protected

arIndexTableFields

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

Referenced by getFields(), and setFields().

◆ $multi_item_actions

arIndexTableGUI::$multi_item_actions = array()
protected

◆ $parent_obj

arIndexTableGUI::$parent_obj = null
protected

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

◆ $table_title

arIndexTableGUI::$table_title = ''
protected

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

Referenced by getTableTitle(), and setTableTitle().

◆ $tabs

arIndexTableGUI::$tabs
protected

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

◆ $toolbar

arIndexTableGUI::$toolbar = null
protected

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

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


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