ILIAS  trunk Revision v11.0_alpha-1749-g1a06bdef097
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ilDclFieldListTableGUI Class Reference
+ Inheritance diagram for ilDclFieldListTableGUI:
+ Collaboration diagram for ilDclFieldListTableGUI:

Public Member Functions

 __construct (ilDclFieldListGUI $a_parent_obj, string $a_parent_cmd, int $table_id)
 
 getHTML ()
 Get HTML. More...
 
 fillRowFromObject (ilDclBaseFieldModel $a_set)
 
- Public Member Functions inherited from ilTable2GUI
 __construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")
 
 setOpenFormTag (bool $a_val)
 
 getOpenFormTag ()
 
 setCloseFormTag (bool $a_val)
 
 getCloseFormTag ()
 
 determineLimit ()
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 
 isColumnSelected (string $col)
 
 getSelectedColumns ()
 
 resetOffset (bool $a_in_determination=false)
 
 initFilter ()
 
 getParentObject ()
 
 getParentCmd ()
 
 setTopAnchor (string $a_val)
 
 getTopAnchor ()
 
 setNoEntriesText (string $a_text)
 
 getNoEntriesText ()
 
 setIsDataTable (bool $a_val)
 
 getIsDataTable ()
 
 setEnableTitle (bool $a_enabletitle)
 
 getEnableTitle ()
 
 setEnableHeader (bool $a_enableheader)
 
 getEnableHeader ()
 
 setEnableNumInfo (bool $a_val)
 
 getEnableNumInfo ()
 
 setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
 
 setDescription (string $a_val)
 
 getDescription ()
 
 setOrderField (string $a_order_field)
 
 getOrderField ()
 
 setData (array $a_data)
 
 getData ()
 
 dataExists ()
 
 setPrefix (string $a_prefix)
 
 getPrefix ()
 
 addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)
 
 addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
 Add filter by standard type. More...
 
 getFilterItems (bool $a_optionals=false)
 
 getFilterItemByPostVar (string $a_post_var)
 
 setFilterCols (int $a_val)
 
 getFilterCols ()
 
 setDisableFilterHiding (bool $a_val=true)
 
 getDisableFilterHiding ()
 
 isFilterSelected (string $a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 
 determineSelectedFilters ()
 
 setCustomPreviousNext (string $a_prev_link, string $a_next_link)
 
 setFormAction (string $a_form_action, bool $a_multipart=false)
 
 getFormAction ()
 
 setFormName (string $a_name="")
 
 getFormName ()
 
 setId (string $a_val)
 
 getId ()
 
 setDisplayAsBlock (bool $a_val)
 
 getDisplayAsBlock ()
 
 setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)
 
 setExternalSorting (bool $a_val)
 
 getExternalSorting ()
 
 setFilterCommand (string $a_val, string $a_caption="")
 
 getFilterCommand ()
 
 setResetCommand (string $a_val, string $a_caption="")
 
 getResetCommand ()
 
 setExternalSegmentation (bool $a_val)
 
 getExternalSegmentation ()
 
 setRowTemplate (string $a_template, string $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField (string $a_defaultorderfield)
 
 getDefaultOrderField ()
 
 setDefaultOrderDirection (string $a_defaultorderdirection)
 
 getDefaultOrderDirection ()
 
 setDefaultFilterVisiblity (bool $a_status)
 
 getDefaultFilterVisibility ()
 
 clearCommandButtons ()
 
 addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")
 
 addCommandButtonInstance (ilButtonBase $a_button)
 
 addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')
 
 setCloseCommand (string $a_link)
 
 addMultiCommand (string $a_cmd, string $a_text)
 
 addHiddenInput (string $a_name, string $a_value)
 
 addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")
 
 setTopCommands (bool $a_val)
 
 getTopCommands ()
 
 addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
 
 getNavParameter ()
 
 setOrderLink (string $key, string $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder (bool $a_omit_offset=false)
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering (string $a_field)
 Should this field be sorted numeric? More...
 
 render ()
 
 writeFilterToSession ()
 
 resetFilter ()
 
 fillFooter ()
 
 getLinkbar (string $a_num)
 
 fillHiddenRow ()
 
 fillActionRow ()
 
 setHeaderHTML (string $html)
 
 storeProperty (string $type, string $value)
 
 loadProperty (string $type)
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext (string $id)
 
 getContext ()
 
 setShowRowsSelector (bool $a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 
 getLimit ()
 
 getOffset ()
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode (bool $a_value=false)
 
 getPrintMode ()
 
 getExportMode ()
 
 exportData (int $format, bool $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand (bool $a_value)
 
 setRowSelectorLabel (string $row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission (bool $a_val)
 
 getPreventDoubleSubmission ()
 
 setLimit (int $a_limit=0, int $a_default_limit=0)
 
- Public Member Functions inherited from ilTableGUI
 __construct (array $a_data=[], bool $a_global_tpl=true)
 
 setTemplate (ilTemplate $a_tpl)
 
 getTemplateObject ()
 
 setData (array $a_data)
 Set table data. More...
 
 getData ()
 
 setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
 
 setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")
 
 setHeaderNames (array $a_header_names)
 
 getColumnCount ()
 
 setHeaderVars (array $a_header_vars, array $a_header_params=[])
 
 setColumnWidth (array $a_column_width)
 set table column widths More...
 
 setOneColumnWidth (string $a_column_width, int $a_column_number)
 
 setMaxCount (int $a_max_count)
 set max. More...
 
 setLimit (int $a_limit=0, int $a_default_limit=0)
 set max. More...
 
 getLimit ()
 
 setPrefix (string $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) More...
 
 setOffset (int $a_offset)
 set dataset offset More...
 
 getOffset ()
 
 setOrderColumn (string $a_order_column="", string $a_default_column="")
 
 getOrderColumn ()
 
 setOrderDirection (string $a_order_direction)
 
 getOrderDirection ()
 
 setFooter (string $a_style, string $a_previous="", string $a_next="")
 
 enable (string $a_module_name)
 
 disable (string $a_module_name)
 
 sortData ()
 
 render ()
 
 renderHeader ()
 
 setOrderLink (string $key, string $order_dir)
 
 setStyle (string $a_element, string $a_style)
 
 getStyle (string $a_element)
 
 setBase (string $a_base)
 
 getBase ()
 
 getFormName ()
 get the name of the parent form More...
 
 setFormName (string $a_name="cmd")
 
 getSelectAllCheckbox ()
 get the name of the checkbox that should be toggled with a select all button More...
 
 setSelectAllCheckbox (string $a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton (string $btn_name, string $btn_value)
 

Protected Attributes

ilDclTable $table
 
ILIAS UI Renderer $renderer
 
ILIAS UI Factory $ui_factory
 
- Protected Attributes inherited from ilTable2GUI
string $requested_nav_par2 = ""
 
string $requested_nav_par = ""
 
string $requested_nav_par1 = ""
 
ILIAS Table TableGUIRequest $table_request = null
 
array $selected_columns = []
 
ilCtrl $ctrl
 
object $parent_obj = null
 
string $parent_cmd = ""
 
string $close_command = ""
 
string $top_anchor = "il_table_top"
 
array $filters = array()
 
array $optional_filters = array()
 
string $filter_cmd = 'applyFilter'
 
string $reset_cmd = 'resetFilter'
 
int $filter_cols = 5
 
bool $ext_sort = false
 
bool $ext_seg = false
 
string $context = ""
 
array $mi_sel_buttons = []
 
bool $disable_filter_hiding = false
 
bool $top_commands = true
 
array $selectable_columns = array()
 
array $selected_column = array()
 
bool $show_rows_selector = true
 
bool $rows_selector_off = false
 
bool $nav_determined = false
 
bool $limit_determined = false
 
bool $filters_determined = false
 
bool $columns_determined = false
 
bool $open_form_tag = true
 
bool $close_form_tag = true
 
array $export_formats = []
 
int $export_mode = 0
 
bool $print_mode = false
 
bool $enable_command_for_all = false
 
bool $restore_filter = false
 
array $restore_filter_values = []
 
bool $default_filter_visibility = false
 
array $sortable_fields = array()
 
bool $prevent_double_submission = true
 
string $row_selector_label = ""
 
bool $select_all_on_top = false
 
array $sel_buttons = []
 
string $nav_value = ''
 
string $noentriestext = ''
 
string $css_row = ''
 
bool $display_as_block = false
 
string $description = ''
 
string $id = ""
 
bool $custom_prev_next = false
 
string $reset_cmd_txt = ""
 
string $defaultorderfield = ""
 
string $defaultorderdirection = ""
 
array $column = []
 
bool $datatable = false
 
bool $num_info = false
 
bool $form_multipart = false
 
array $row_data = []
 
string $order_field = ""
 
array $selected_filter = []
 
string $form_action = ""
 
string $formname = ""
 
string $sort_order = ""
 
array $buttons = []
 
array $multi = []
 
array $hidden_inputs = []
 
array $header_commands = []
 
string $row_template = ""
 
string $row_template_dir = ""
 
string $filter_cmd_txt = ""
 
string $custom_prev = ""
 
string $custom_next = ""
 
array $raw_post_data = null
 
ilGlobalTemplateInterface $main_tpl
 
- Protected Attributes inherited from ilTableGUI
string $sort_order
 
string $link_params
 
array $header_params
 
 $tpl
 
ilLanguage $lng
 

Private Attributes

int $order = null
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 
- Static Public Member Functions inherited from ilTableGUI
static linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='')
 
- 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
string $title = ""
 
string $icon = ""
 
string $icon_alt = ""
 
string $help_page = ""
 
string $help_icon = ""
 
string $help_icon_alt = ""
 
array $header_names = []
 
array $header_vars = []
 
array $linkbar_vars = []
 
array $data = []
 
int $column_count = 0
 
array $column_width = []
 
int $max_count = 0
 
int $limit = 0
 
bool $max_limit = false
 
int $offset = 0
 
string $order_column = ""
 
string $order_direction = ""
 
string $footer_style = ""
 
string $footer_previous = ""
 
string $footer_next = ""
 
bool $lang_support = true
 
bool $global_tpl = false
 
string $form_name = ""
 
string $select_all_checkbox = ""
 
array $action_buttons = []
 
string $prefix = ""
 
string $base = ""
 
array $enabled
 
array $styles
 
- Protected Member Functions inherited from ilTable2GUI
 getRequestedValues ()
 
 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, ilTableFilterItem $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow (array $a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilTableFilterItem $a_item)
 Get current filter value. More...
 
 setFilterValue (ilTableFilterItem $a_item, $a_value)
 
 fillMetaExcel (ilExcel $a_excel, int &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel (ilExcel $a_excel, int &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV (ilCSVWriter $a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV (ilCSVWriter $a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV (ilCSVWriter $a_csv, array $a_set)
 CSV Version of Fill Row. More...
 

Detailed Description

Definition at line 21 of file class.ilDclFieldListTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilDclFieldListTableGUI::__construct ( ilDclFieldListGUI  $a_parent_obj,
string  $a_parent_cmd,
int  $table_id 
)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ILIAS\Repository\ctrl(), ilTableGUI\getStyle(), ilDclCache\getTableCache(), ILIAS\Repository\lng(), renderer(), ilTable2GUI\setData(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), ilTable2GUI\setId(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setShowRowsSelector(), ilTableGUI\setStyle(), ilTable2GUI\setTitle(), and ilTable2GUI\setTopCommands().

32  {
33  global $DIC;
34 
35  $this->ui_factory = $DIC->ui()->factory();
36  $this->renderer = $DIC->ui()->renderer();
37 
38  parent::__construct($a_parent_obj, $a_parent_cmd);
39 
40  $this->parent_obj = $a_parent_obj;
41  $this->table = ilDclCache::getTableCache($table_id);
42  $this->table->showInvalidFields(true);
43 
44  $this->setId('dcl_field_list');
45  $this->addColumn('', '', '1', true);
46  $this->addColumn($this->lng->txt('dcl_order'), '', '30px');
47  $this->addColumn($this->lng->txt('dcl_fieldtitle'), '', 'auto');
48  $this->addColumn($this->lng->txt('dcl_in_export'), '', '30px');
49  $this->addColumn($this->lng->txt('dcl_description'), '', 'auto');
50  $this->addColumn($this->lng->txt('dcl_field_datatype'), '', 'auto');
51  $this->addColumn($this->lng->txt('dcl_unique'), '', 'auto');
52  $this->addColumn($this->lng->txt('actions'), '', '');
53  // Only add mutli command for custom fields
54  if (count($this->table->getRecordFields())) {
55  $this->setSelectAllCheckbox('dcl_field_ids[]');
56  $this->addMultiCommand('confirmDeleteFields', $this->lng->txt('dcl_delete_fields'));
57  }
58 
59  $this->ctrl->setParameterByClass('ildclfieldeditgui', 'table_id', $this->parent_obj->getTableId());
60  $this->ctrl->setParameterByClass('ildclfieldlistgui', 'table_id', $this->parent_obj->getTableId());
61 
62  $this->setFormAction($this->ctrl->getFormActionByClass('ildclfieldlistgui'));
63  $this->addCommandButton('save', $this->lng->txt('dcl_save'));
64 
65  $this->setFormAction($this->ctrl->getFormAction($a_parent_obj));
66  $this->setFormName('field_list');
67 
68  //those two are important as we get our data as objects not as arrays.
69  $this->setExternalSegmentation(true);
70  $this->setExternalSorting(true);
71 
72  $this->setTopCommands(true);
73  $this->setEnableHeader(true);
74  $this->setShowRowsSelector(false);
75  $this->setEnableHeader(true);
76  $this->setEnableTitle(true);
77  $this->setDefaultOrderDirection('asc');
78 
79  $this->setTitle($this->table->getTitle());
80  $this->setRowTemplate('tpl.field_list_row.html', 'components/ILIAS/DataCollection');
81  $this->setStyle('table', $this->getStyle('table') . ' ' . 'dcl_record_list');
82 
83  $this->setData($this->table->getFields());
84  }
setData(array $a_data)
setTopCommands(bool $a_val)
getStyle(string $a_element)
setFormAction(string $a_form_action, bool $a_multipart=false)
setEnableTitle(bool $a_enabletitle)
addCommandButton(string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")
setSelectAllCheckbox(string $a_select_all_checkbox, bool $a_select_all_on_top=false)
renderer()
setFormName(string $a_name="")
setId(string $a_val)
setStyle(string $a_element, string $a_style)
setExternalSorting(bool $a_val)
setShowRowsSelector(bool $a_value)
Toggle rows-per-page selector.
setRowTemplate(string $a_template, string $a_template_dir="")
Set row template.
global $DIC
Definition: shib_login.php:22
setDefaultOrderDirection(string $a_defaultorderdirection)
static getTableCache(?int $table_id=null)
setTitle(string $a_title, string $a_icon="", string $a_icon_alt="")
__construct(Container $dic, ilPlugin $plugin)
addColumn(string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
addMultiCommand(string $a_cmd, string $a_text)
setEnableHeader(bool $a_enableheader)
setExternalSegmentation(bool $a_val)
+ Here is the call graph for this function:

Member Function Documentation

◆ fillRowFromObject()

ilDclFieldListTableGUI::fillRowFromObject ( ilDclBaseFieldModel  $a_set)

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

References ilTableGUI\$icon, ILIAS\Repository\ctrl(), ilDclDatatype\getAllDatatype(), ilDclBaseFieldModel\getDatatypeId(), ilDclBaseFieldModel\getDescription(), ilDclBaseFieldModel\getExportable(), ilDclBaseFieldModel\getId(), ilUtil\getImagePath(), ilDclBaseFieldModel\getPresentationTitle(), ilDclBaseFieldModel\getTitle(), ilObjDataCollectionAccess\hasAccessToFields(), ilDclBaseFieldModel\isStandardField(), ilDclBaseFieldModel\isUnique(), ILIAS\Repository\lng(), and renderer().

Referenced by getHTML().

209  : void
210  {
211  if (!$a_set->isStandardField()) {
212  $this->tpl->setVariable('FIELD_ID', $a_set->getId());
213  }
214 
215  $this->tpl->setVariable('NAME', 'order[' . $a_set->getId() . ']');
216  $this->tpl->setVariable('VALUE', $this->order);
217 
218  /* Don't enable setting filter for MOB fields or reference fields that reference a MOB field */
219  $show_exportable = true;
220 
221  if ($a_set->getId() == 'comments') {
222  $show_exportable = false;
223  }
224 
225  if ($show_exportable) {
226  $this->tpl->setVariable('CHECKBOX_EXPORTABLE', 'exportable[' . $a_set->getId() . ']');
227  if ($a_set->getExportable()) {
228  $this->tpl->setVariable('CHECKBOX_EXPORTABLE_CHECKED', 'checked');
229  }
230  } else {
231  $this->tpl->setVariable('NO_FILTER_EXPORTABLE');
232  }
233 
234  $this->order = $this->order + 10;
235  $this->tpl->setVariable('ORDER_NAME', 'order[' . $a_set->getId() . ']');
236  $this->tpl->setVariable('ORDER_VALUE', $this->order);
237 
238  $this->tpl->setVariable('TITLE', $a_set->getTitle());
239  $this->tpl->setVariable('DESCRIPTION', $a_set->getDescription());
240  $this->tpl->setVariable('DATATYPE', $a_set->getPresentationTitle());
241 
242  if (!$a_set->isStandardField()) {
243  if ($a_set->isUnique()) {
244  $icon = $this->ui_factory->symbol()->icon()->custom(ilUtil::getImagePath('standard/icon_checked.svg'), $this->lng->txt("yes"));
245  } else {
246  $icon = $this->ui_factory->symbol()->icon()->custom(ilUtil::getImagePath('standard/icon_unchecked.svg'), $this->lng->txt("no"));
247  }
248  $this->tpl->setVariable('ICON_UNIQUE', $this->renderer->render($icon));
249  } else {
250  $this->tpl->setVariable('NO_UNIQUE');
251  }
252 
253  $this->ctrl->setParameterByClass('ildclfieldeditgui', 'field_id', $a_set->getId());
254 
255  if (!$a_set->isStandardField()) {
257  $this->parent_obj->getDataCollectionObject()->getRefId(),
258  $this->table->getId()
259  )) {
260  $dropdown_items = [];
261  if (in_array($a_set->getDatatypeId(), array_keys(ilDclDatatype::getAllDatatype()))) {
262  $dropdown_items[] = $this->ui_factory->link()->standard(
263  $this->lng->txt('edit'),
264  $this->ctrl->getLinkTargetByClass(ilDclFieldEditGUI::class, 'edit')
265  );
266  }
267  $dropdown_items[] = $this->ui_factory->link()->standard(
268  $this->lng->txt('delete'),
269  $this->ctrl->getLinkTargetByClass(ilDclFieldEditGUI::class, 'confirmDelete')
270  );
271  $dropdown = $this->ui_factory->dropdown()->standard($dropdown_items)->withLabel($this->lng->txt('actions'));
272 
273  $this->tpl->setVariable('ACTIONS', $this->renderer->render($dropdown));
274  } else {
275  $this->tpl->setVariable('ACTIONS');
276  }
277  }
278  }
renderer()
static hasAccessToFields(int $ref_id, int $table_id)
static getAllDatatype(bool $force=false)
Get all possible Datatypes.
static getImagePath(string $image_name, string $module_path="", string $mode="output", bool $offline=false)
get image path (for images located in a template directory)
getDescription()
Get description.
getDatatypeId()
Get datatype_id.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getHTML()

ilDclFieldListTableGUI::getHTML ( )

Get HTML.

Definition at line 89 of file class.ilDclFieldListTableGUI.php.

References ilTableGUI\$data, ILIAS\Repository\ctrl(), ilTable2GUI\dataExists(), ilTable2GUI\determineOffsetAndOrder(), ilTable2GUI\exportData(), ilTable2GUI\fillActionRow(), ilTable2GUI\fillFooter(), ilTable2GUI\fillHiddenRow(), fillRowFromObject(), ilTable2GUI\getCloseFormTag(), ilTable2GUI\getData(), ilTable2GUI\getExportMode(), ilTable2GUI\getExternalSegmentation(), ilTable2GUI\getExternalSorting(), ilTable2GUI\getFormAction(), ilTable2GUI\getFormName(), ilTable2GUI\getId(), ilTable2GUI\getLimit(), ilTable2GUI\getNavParameter(), ilTable2GUI\getNoEntriesText(), ilTable2GUI\getOffset(), ilTable2GUI\getOpenFormTag(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\getParentObject(), ilTable2GUI\getPreventDoubleSubmission(), ilTable2GUI\getPrintMode(), ILIAS\Repository\lng(), ilTable2GUI\numericOrdering(), ilTable2GUI\prepareOutput(), ilTable2GUI\render(), ilTableGUI\setFooter(), ilTableGUI\setMaxCount(), ilDatePresentation\setUseRelativeDates(), ilArrayUtil\sortArray(), and ilTable2GUI\storeNavParameter().

89  : string
90  {
91  if ($this->getExportMode()) {
92  $this->exportData($this->getExportMode(), true);
93  }
94 
95  $this->prepareOutput();
96 
97  if (is_object($this->getParentObject()) && $this->getId() == "") {
98  $this->ctrl->saveParameter($this->getParentObject(), $this->getNavParameter());
99  }
100 
101  if (!$this->getPrintMode()) {
102  // set form action
103  if ($this->form_action != "" && $this->getOpenFormTag()) {
104  $hash = "";
105 
106  if ($this->form_multipart) {
107  $this->tpl->touchBlock("form_multipart_bl");
108  }
109 
110  if ($this->getPreventDoubleSubmission()) {
111  $this->tpl->touchBlock("pdfs");
112  }
113 
114  $this->tpl->setCurrentBlock("tbl_form_header");
115  $this->tpl->setVariable("FORMACTION", $this->getFormAction() . $hash);
116  $this->tpl->setVariable("FORMNAME", $this->getFormName());
117  $this->tpl->parseCurrentBlock();
118  }
119 
120  if ($this->form_action != "" && $this->getCloseFormTag()) {
121  $this->tpl->touchBlock("tbl_form_footer");
122  }
123  }
124 
125  if (!$this->enabled['content']) {
126  return $this->render();
127  }
128 
129  if (!$this->getExternalSegmentation()) {
130  $this->setMaxCount(count($this->row_data));
131  }
132 
133  $this->determineOffsetAndOrder();
134 
135  $this->setFooter("tblfooter", $this->lng->txt("previous"), $this->lng->txt("next"));
136 
137  $data = $this->getData();
138  if ($this->dataExists()) {
139  // sort
140  if (!$this->getExternalSorting() && $this->enabled["sort"]) {
141  $data = ilArrayUtil::sortArray(
142  $data,
143  $this->getOrderField(),
144  $this->getOrderDirection(),
145  $this->numericOrdering($this->getOrderField())
146  );
147  }
148 
149  // slice
150  if (!$this->getExternalSegmentation()) {
151  $data = array_slice($data, $this->getOffset(), $this->getLimit());
152  }
153  }
154 
155  // fill rows
156  if ($this->dataExists()) {
157  if ($this->getPrintMode()) {
159  }
160 
161  $this->tpl->addBlockFile(
162  "TBL_CONTENT",
163  "tbl_content",
164  $this->row_template,
165  $this->row_template_dir
166  );
167 
168  foreach ($data as $set) {
169  $this->tpl->setCurrentBlock("tbl_content");
170  $this->css_row = ($this->css_row !== "tblrow1")
171  ? "tblrow1"
172  : "tblrow2";
173  $this->tpl->setVariable("CSS_ROW", $this->css_row);
174 
175  $this->fillRowFromObject($set);
176  $this->tpl->setCurrentBlock("tbl_content");
177  $this->tpl->parseCurrentBlock();
178  }
179  } else {
180  // add standard no items text (please tell me, if it messes something up, alex, 29.8.2008)
181  $no_items_text = (trim($this->getNoEntriesText()) != '')
182  ? $this->getNoEntriesText()
183  : $this->lng->txt("no_items");
184 
185  $this->css_row = ($this->css_row !== "tblrow1")
186  ? "tblrow1"
187  : "tblrow2";
188 
189  $this->tpl->setCurrentBlock("tbl_no_entries");
190  $this->tpl->setVariable('TBL_NO_ENTRY_CSS_ROW', $this->css_row);
191  $this->tpl->setVariable('TBL_NO_ENTRY_COLUMN_COUNT', $this->column_count);
192  $this->tpl->setVariable('TBL_NO_ENTRY_TEXT', trim($no_items_text));
193  $this->tpl->parseCurrentBlock();
194  }
195 
196  if (!$this->getPrintMode()) {
197  $this->fillFooter();
198 
199  $this->fillHiddenRow();
200 
201  $this->fillActionRow();
202 
203  $this->storeNavParameter();
204  }
205 
206  return $this->render();
207  }
numericOrdering(string $a_field)
Should this field be sorted numeric?
static array static setUseRelativeDates(bool $a_status)
set use relative dates
prepareOutput()
Anything that must be done before HTML is generated.
exportData(int $format, bool $send=false)
Export and optionally send current table data.
fillRowFromObject(ilDclBaseFieldModel $a_set)
setFooter(string $a_style, string $a_previous="", string $a_next="")
determineOffsetAndOrder(bool $a_omit_offset=false)
setMaxCount(int $a_max_count)
set max.
static sortArray(array $array, string $a_array_sortby_key, string $a_array_sortorder="asc", bool $a_numeric=false, bool $a_keep_keys=false)
+ Here is the call graph for this function:

Field Documentation

◆ $order

int ilDclFieldListTableGUI::$order = null
private

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

◆ $renderer

ILIAS UI Renderer ilDclFieldListTableGUI::$renderer
protected

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

◆ $table

ilDclTable ilDclFieldListTableGUI::$table
protected

Definition at line 25 of file class.ilDclFieldListTableGUI.php.

◆ $ui_factory

ILIAS UI Factory ilDclFieldListTableGUI::$ui_factory
protected

Definition at line 28 of file class.ilDclFieldListTableGUI.php.


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