ILIAS  release_8 Revision v8.24
ilDclFieldListTableGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

+ 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)
 Set table data. More...
 
 getData ()
 
 dataExists ()
 
 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...
 
 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 ()
 get the name of the parent form More...
 
 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 ()
 
 setShowTemplates (bool $a_value)
 
 getShowTemplates ()
 
 restoreTemplate (string $a_name)
 Restore state from template. More...
 
 saveTemplate (string $a_name)
 Save current state as template. More...
 
 deleteTemplate (string $a_name)
 
 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)
 set max. More...
 
- 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 $factory
 
- Protected Attributes inherited from ilTable2GUI
string $requested_tmpl_delete
 
string $requested_tmpl_create
 
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_templates = false
 
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

 $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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 19 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 29 of file class.ilDclFieldListTableGUI.php.

30 {
31 global $DIC;
32 $lng = $DIC['lng'];
33 $ilCtrl = $DIC['ilCtrl'];
34
35 $this->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($lng->txt('dcl_order'), '', '30px');
47 $this->addColumn($lng->txt('dcl_fieldtitle'), '', 'auto');
48 $this->addColumn($lng->txt('dcl_in_export'), '', '30px');
49 $this->addColumn($lng->txt('dcl_description'), '', 'auto');
50 $this->addColumn($lng->txt('dcl_field_datatype'), '', 'auto');
51 $this->addColumn($lng->txt('dcl_unique'), '', 'auto');
52 $this->addColumn($lng->txt('actions'), '', '30px');
53 // Only add mutli command for custom fields
54 if (count($this->table->getRecordFields())) {
55 $this->setSelectAllCheckbox('dcl_field_ids[]');
56 $this->addMultiCommand('confirmDeleteFields', $lng->txt('dcl_delete_fields'));
57 }
58
59 $ilCtrl->setParameterByClass('ildclfieldeditgui', 'table_id', $this->parent_obj->getTableId());
60 $ilCtrl->setParameterByClass('ildclfieldlistgui', 'table_id', $this->parent_obj->getTableId());
61
62 $this->setFormAction($ilCtrl->getFormActionByClass('ildclfieldlistgui'));
63 $this->addCommandButton('save', $lng->txt('dcl_save'));
64
65 $this->setFormAction($ilCtrl->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->setShowTemplates(false);
76 $this->setEnableHeader(true);
77 $this->setEnableTitle(true);
78 $this->setDefaultOrderDirection('asc');
79
80 $this->setTitle($lng->txt('dcl_table_list_fields'));
81 $this->setRowTemplate('tpl.field_list_row.html', 'Modules/DataCollection');
82 $this->setStyle('table', $this->getStyle('table') . ' ' . 'dcl_record_list');
83
84 $this->setData($this->table->getFields());
85 }
static getTableCache(int $table_id=null)
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
setShowRowsSelector(bool $a_value)
Toggle rows-per-page selector.
setTitle(string $a_title, string $a_icon="", string $a_icon_alt="")
setExternalSegmentation(bool $a_val)
addCommandButton(string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")
setEnableTitle(bool $a_enabletitle)
setFormName(string $a_name="")
addMultiCommand(string $a_cmd, string $a_text)
setShowTemplates(bool $a_value)
setFormAction(string $a_form_action, bool $a_multipart=false)
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)
setEnableHeader(bool $a_enableheader)
setSelectAllCheckbox(string $a_select_all_checkbox, bool $a_select_all_on_top=false)
setTopCommands(bool $a_val)
setExternalSorting(bool $a_val)
setRowTemplate(string $a_template, string $a_template_dir="")
Set row template.
setId(string $a_val)
setDefaultOrderDirection(string $a_defaultorderdirection)
setData(array $a_data)
Set table data.
ilLanguage $lng
setStyle(string $a_element, string $a_style)
getStyle(string $a_element)
global $DIC
Definition: feed.php:28
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc

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

+ Here is the call graph for this function:

Member Function Documentation

◆ fillRowFromObject()

ilDclFieldListTableGUI::fillRowFromObject ( ilDclBaseFieldModel  $a_set)

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

213 : void
214 {
215 global $DIC;
216 $lng = $DIC['lng'];
217 $ilCtrl = $DIC['ilCtrl'];
218
219 if (!$a_set->isStandardField()) {
220 $this->tpl->setVariable('FIELD_ID', $a_set->getId());
221 }
222
223 $this->tpl->setVariable('NAME', 'order[' . $a_set->getId() . ']');
224 $this->tpl->setVariable('VALUE', $this->order);
225
226 /* Don't enable setting filter for MOB fields or reference fields that reference a MOB field */
227 $show_exportable = true;
228
229 if ($a_set->getId() == 'comments') {
230 $show_exportable = false;
231 }
232
233 if ($show_exportable) {
234 $this->tpl->setVariable('CHECKBOX_EXPORTABLE', 'exportable[' . $a_set->getId() . ']');
235 if ($a_set->getExportable()) {
236 $this->tpl->setVariable('CHECKBOX_EXPORTABLE_CHECKED', 'checked');
237 }
238 } else {
239 $this->tpl->setVariable('NO_FILTER_EXPORTABLE', '');
240 }
241
242 $this->order = $this->order + 10;
243 $this->tpl->setVariable('ORDER_NAME', 'order[' . $a_set->getId() . ']');
244 $this->tpl->setVariable('ORDER_VALUE', $this->order);
245
246 $this->tpl->setVariable('TITLE', $a_set->getTitle());
247 $this->tpl->setVariable('DESCRIPTION', $a_set->getDescription());
248 $this->tpl->setVariable('DATATYPE', $a_set->getPresentationTitle());
249
250 if (!$a_set->isStandardField()) {
251 switch ($a_set->isUnique()) {
252 case 0:
253 $icon = $this->factory->symbol()->icon()->custom(ilUtil::getImagePath('icon_not_ok_monochrome.svg'), $this->lng->txt("yes"));
254 break;
255 case 1:
256 $icon = $this->factory->symbol()->icon()->custom(ilUtil::getImagePath('icon_ok_monochrome.svg'), $this->lng->txt("no"));
257 break;
258 }
259 $this->tpl->setVariable('ICON_UNIQUE', $this->renderer->render($icon));
260 } else {
261 $this->tpl->setVariable('NO_UNIQUE', '');
262 }
263
264 $ilCtrl->setParameterByClass('ildclfieldeditgui', 'field_id', $a_set->getId());
265
266 if (!$a_set->isStandardField()) {
267 $alist = new ilAdvancedSelectionListGUI();
268 $alist->setId($a_set->getId());
269 $alist->setListTitle($lng->txt('actions'));
270
272 $this->parent_obj->getDataCollectionObject()->getRefId(),
273 $this->table->getId()
274 )) {
275 if (in_array($a_set->getDatatypeId(), array_keys(ilDclDatatype::getAllDatatype()))) {
276 $alist->addItem($lng->txt('edit'), 'edit', $ilCtrl->getLinkTargetByClass('ildclfieldeditgui', 'edit'));
277 }
278 $alist->addItem(
279 $lng->txt('delete'),
280 'delete',
281 $ilCtrl->getLinkTargetByClass('ildclfieldeditgui', 'confirmDelete')
282 );
283 }
284
285 $this->tpl->setVariable('ACTIONS', $alist->getHTML());
286 }
287 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
static getAllDatatype(bool $force=false)
Get all possible Datatypes.
static hasAccessToFields(int $ref_id, int $table_id)
static getImagePath(string $img, string $module_path="", string $mode="output", bool $offline=false)
get image path (for images located in a template directory)

References $DIC, ilTableGUI\$icon, ilTableGUI\$lng, 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 ilLanguage\txt().

Referenced by getHTML().

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

◆ getHTML()

ilDclFieldListTableGUI::getHTML ( )

Get HTML.

Reimplemented from ilTable2GUI.

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

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

References ilTable2GUI\$ctrl, ilTableGUI\$data, ilTableGUI\$lng, 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(), ilTable2GUI\storeNavParameter(), and ilLanguage\txt().

+ Here is the call graph for this function:

Field Documentation

◆ $factory

ILIAS UI Factory ilDclFieldListTableGUI::$factory
protected

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

◆ $order

ilDclFieldListTableGUI::$order = null
private

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

◆ $renderer

ILIAS UI Renderer ilDclFieldListTableGUI::$renderer
protected

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

◆ $table

ilDclTable ilDclFieldListTableGUI::$table
protected

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


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