ILIAS  release_8 Revision v8.24
ilDclTableViewTableGUI 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 ilDclTableViewTableGUI:
+ Collaboration diagram for ilDclTableViewTableGUI:

Public Member Functions

 __construct (object $a_parent_obj, $a_parent_cmd, ilDclTable $table, int $ref_id)
 ilDclTableViewTableGUI constructor. More...
 
 getHTML ()
 Get HTML. More...
 
 fillRowFromObject (ilDclTableView $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 Member Functions

 buildAction (int $id)
 build either actions menu or view button More...
 
- 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...
 

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
 

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
 

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.ilDclTableViewTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilDclTableViewTableGUI::__construct ( object  $a_parent_obj,
  $a_parent_cmd,
ilDclTable  $table,
int  $ref_id 
)

ilDclTableViewTableGUI constructor.

Parameters
object$a_parent_obj//object|ilDclTableViewGUI
string$a_parent_cmd
ilDclTable$table

Definition at line 32 of file class.ilDclTableViewTableGUI.php.

33 {
34 global $DIC;
35 $lng = $DIC['lng'];
36 $ilCtrl = $DIC['ilCtrl'];
37
38 $this->factory = $DIC->ui()->factory();
39 $this->renderer = $DIC->ui()->renderer();
40
41 parent::__construct($a_parent_obj, $a_parent_cmd);
42
43 $this->parent_obj = $a_parent_obj;
44 $this->table = $table;
45 $this->ctrl = $ilCtrl;
46 $this->lng = $lng;
47
48 $this->setExternalSegmentation(true);
49 $this->setExternalSorting(true);
50
51 if ($this->parent_obj instanceof ilDclTableViewGUI) {
52 $ilCtrl->setParameterByClass('ildcltableviewgui', 'table_id', $table->getId());
53 $this->setFormAction($ilCtrl->getFormActionByClass('ildcltableviewgui'));
54 $this->addMultiCommand('confirmDeleteTableviews', $lng->txt('dcl_delete_views'));
55 $this->addCommandButton('saveTableViewOrder', $lng->txt('dcl_save_order'));
56
57 $this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
58 $this->setFormName('tableview_list');
59
60 $this->addColumn('', '', '1', true);
61 $this->addColumn($lng->txt('dcl_order'), '', '30px');
62
63 $this->setRowTemplate('tpl.tableview_list_row.html', 'Modules/DataCollection');
64 $this->setData($this->table->getTableViews());
65 } elseif ($this->parent_obj instanceof ilDclDetailedViewGUI) {
66 $this->setRowTemplate('tpl.detailview_list_row.html', 'Modules/DataCollection');
67 $this->setData($this->table->getVisibleTableViews($ref_id, true));
68 }
69
70 $this->addColumn($lng->txt('title'), '', 'auto');
71 $this->addColumn($lng->txt('description'), '', 'auto');
72 $this->addColumn($lng->txt('dcl_configuration_complete'), '', 'auto');
73 $this->addColumn($lng->txt('actions'), '', '30px');
74
75 $this->setTopCommands(true);
76 $this->setEnableHeader(true);
77 $this->setShowRowsSelector(false);
78 $this->setShowTemplates(false);
79 $this->setEnableHeader(true);
80 $this->setEnableTitle(true);
81 $this->setDefaultOrderDirection('asc');
82 $this->setLimit(0);
83
84 $this->setId('dcl_tableviews');
85 $this->setTitle($lng->txt("dcl_tableviews_table"));
86 $this->setStyle('table', $this->getStyle('table') . ' ' . 'dcl_record_list');
87 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
getId()
Get table id.
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.
setLimit(int $a_limit=0, int $a_default_limit=0)
set max.
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)
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
$ref_id
Definition: ltiauth.php:67
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc

References $DIC, ilTableGUI\$lng, $ref_id, $table, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ILIAS\Repository\ctrl(), ilDclTable\getId(), ilTableGUI\getStyle(), ILIAS\Repository\lng(), ilTable2GUI\setData(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), ilTable2GUI\setShowTemplates(), ilTableGUI\setStyle(), ilTable2GUI\setTitle(), ilTable2GUI\setTopCommands(), and ilLanguage\txt().

+ Here is the call graph for this function:

Member Function Documentation

◆ buildAction()

ilDclTableViewTableGUI::buildAction ( int  $id)
protected

build either actions menu or view button

Definition at line 243 of file class.ilDclTableViewTableGUI.php.

243 : string
244 {
245 if ($this->parent_obj instanceof ilDclTableViewGUI) {
246 $alist = new ilAdvancedSelectionListGUI();
247 $alist->setId($id);
248 $alist->setListTitle($this->lng->txt('actions'));
249 $this->ctrl->setParameterByClass('ildcltableviewgui', 'tableview_id', $id);
250 $this->ctrl->setParameterByClass('ilDclDetailedViewDefinitionGUI', 'tableview_id', $id);
251 $alist->addItem(
252 $this->lng->txt('edit'),
253 '',
254 $this->ctrl->getLinkTargetByClass('ildcltablevieweditgui', 'editGeneralSettings')
255 );
256 $alist->addItem(
257 $this->lng->txt('copy'),
258 '',
259 $this->ctrl->getLinkTargetByClass('ildcltablevieweditgui', 'copy')
260 );
261 $alist->addItem(
262 $this->lng->txt('delete'),
263 '',
264 $this->ctrl->getLinkTargetByClass('ildcltablevieweditgui', 'confirmDelete')
265 );
266
267 return $alist->getHTML();
268 } elseif ($this->parent_obj instanceof ilDclDetailedViewGUI) {
270 $this->ctrl->setParameterByClass('ilDclDetailedViewGUI', 'tableview_id', $id);
271 $this->ctrl->saveParameterByClass('ilDclDetailedViewGUI', 'record_id');
272 $button->setUrl($this->ctrl->getLinkTargetByClass('ilDclDetailedViewGUI', 'renderRecord'));
273 $button->setCaption('view');
274
275 return $button->getToolbarHTML();
276 }
277 return "";
278 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

References ilTable2GUI\$id, ILIAS\Repository\ctrl(), ilDclLinkButton\getInstance(), and ILIAS\Repository\lng().

Referenced by fillRowFromObject().

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

◆ fillRowFromObject()

ilDclTableViewTableGUI::fillRowFromObject ( ilDclTableView  $a_set)
Parameters
ilDclTableView$a_set

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

218 : void
219 {
220 if ($this->parent_obj instanceof ilDclTableViewGUI) {
221 $this->tpl->setVariable("ID", $a_set->getId());
222 $this->tpl->setVariable("ORDER_NAME", "order[{$a_set->getId()}]");
223 $this->tpl->setVariable("ORDER_VALUE", $a_set->getOrder());
224 }
225 $this->tpl->setVariable("TITLE", $a_set->getTitle());
226 $this->ctrl->setParameterByClass('ildcltablevieweditgui', 'tableview_id', $a_set->getId());
227 $this->tpl->setVariable("TITLE_LINK", $this->ctrl->getLinkTargetByClass(
228 [ilDclTableListGUI::class, ilDclTableViewGUI::class, ilDclTableViewEditGUI::class]
229 ));
230 $this->tpl->setVariable("DESCRIPTION", $a_set->getDescription());
231
232 $icon = $this->factory->symbol()->icon()->custom(ilUtil::getImagePath('icon_not_ok_monochrome.svg'), $this->lng->txt("yes"));
233 if ($a_set->validateConfigCompletion()) {
234 $icon = $this->factory->symbol()->icon()->custom(ilUtil::getImagePath('icon_ok_monochrome.svg'), $this->lng->txt("no"));
235 }
236 $this->tpl->setVariable("ICON_CONFIG", $this->renderer->render($icon));
237 $this->tpl->setVariable('ACTIONS', $this->buildAction($a_set->getId()));
238 }
buildAction(int $id)
build either actions menu or view button
validateConfigCompletion()
Check if the configuration of the view is complete.
static getImagePath(string $img, string $module_path="", string $mode="output", bool $offline=false)
get image path (for images located in a template directory)

References ilTableGUI\$icon, buildAction(), ILIAS\Repository\ctrl(), ilDclTableView\getDescription(), ilDclTableView\getId(), ilUtil\getImagePath(), ilDclTableView\getOrder(), ilDclTableView\getTitle(), ILIAS\Repository\lng(), and ilDclTableView\validateConfigCompletion().

Referenced by getHTML().

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

◆ getHTML()

ilDclTableViewTableGUI::getHTML ( )

Get HTML.

Reimplemented from ilTable2GUI.

Definition at line 92 of file class.ilDclTableViewTableGUI.php.

92 : string
93 {
95 $ilCtrl = $this->ctrl;
96
97 if ($this->getExportMode()) {
98 $this->exportData($this->getExportMode(), true);
99 }
100
101 $this->prepareOutput();
102
103 if (is_object($ilCtrl) && is_object($this->getParentObject()) && $this->getId() == "") {
104 $ilCtrl->saveParameter($this->getParentObject(), $this->getNavParameter());
105 }
106
107 if (!$this->getPrintMode()) {
108 // set form action
109 if ($this->form_action != "" && $this->getOpenFormTag()) {
110 $hash = "";
111
112 if ($this->form_multipart) {
113 $this->tpl->touchBlock("form_multipart_bl");
114 }
115
116 if ($this->getPreventDoubleSubmission()) {
117 $this->tpl->touchBlock("pdfs");
118 }
119
120 $this->tpl->setCurrentBlock("tbl_form_header");
121 $this->tpl->setVariable("FORMACTION", $this->getFormAction() . $hash);
122 $this->tpl->setVariable("FORMNAME", $this->getFormName());
123 $this->tpl->parseCurrentBlock();
124 }
125
126 if ($this->form_action != "" && $this->getCloseFormTag()) {
127 $this->tpl->touchBlock("tbl_form_footer");
128 }
129 }
130
131 if (!$this->enabled['content']) {
132 return $this->render();
133 }
134
135 if (!$this->getExternalSegmentation()) {
136 $this->setMaxCount(count($this->row_data));
137 }
138
140
141 $this->setFooter("tblfooter", $this->lng->txt("previous"), $this->lng->txt("next"));
142
143 $data = $this->getData();
144 if ($this->dataExists()) {
145 // sort
146 if (!$this->getExternalSorting() && $this->enabled["sort"]) {
148 $data,
149 $this->getOrderField(),
150 $this->getOrderDirection(),
151 $this->numericOrdering($this->getOrderField())
152 );
153 }
154
155 // slice
156 if (!$this->getExternalSegmentation()) {
157 $data = array_slice($data, $this->getOffset(), $this->getLimit());
158 }
159 }
160
161 // fill rows
162 if ($this->dataExists()) {
163 if ($this->getPrintMode()) {
165 }
166
167 $this->tpl->addBlockFile(
168 "TBL_CONTENT",
169 "tbl_content",
170 $this->row_template,
171 $this->row_template_dir
172 );
173
174 foreach ($data as $set) {
175 $this->tpl->setCurrentBlock("tbl_content");
176 $this->css_row = ($this->css_row !== "tblrow1")
177 ? "tblrow1"
178 : "tblrow2";
179 $this->tpl->setVariable("CSS_ROW", $this->css_row);
180
181 $this->fillRowFromObject($set);
182 $this->tpl->setCurrentBlock("tbl_content");
183 $this->tpl->parseCurrentBlock();
184 }
185 } else {
186 // add standard no items text (please tell me, if it messes something up, alex, 29.8.2008)
187 $no_items_text = (trim($this->getNoEntriesText()) != '')
188 ? $this->getNoEntriesText()
189 : $lng->txt("no_items");
190
191 $this->css_row = ($this->css_row !== "tblrow1")
192 ? "tblrow1"
193 : "tblrow2";
194
195 $this->tpl->setCurrentBlock("tbl_no_entries");
196 $this->tpl->setVariable('TBL_NO_ENTRY_CSS_ROW', $this->css_row);
197 $this->tpl->setVariable('TBL_NO_ENTRY_COLUMN_COUNT', $this->column_count);
198 $this->tpl->setVariable('TBL_NO_ENTRY_TEXT', trim($no_items_text));
199 $this->tpl->parseCurrentBlock();
200 }
201
202 if (!$this->getPrintMode()) {
203 $this->fillFooter();
204
205 $this->fillHiddenRow();
206
207 $this->fillActionRow();
208
209 $this->storeNavParameter();
210 }
211
212 return $this->render();
213 }
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(ilDclTableView $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 ilDclTableViewTableGUI::$factory
protected

Definition at line 24 of file class.ilDclTableViewTableGUI.php.

◆ $renderer

ILIAS UI Renderer ilDclTableViewTableGUI::$renderer
protected

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

◆ $table

ilDclTable ilDclTableViewTableGUI::$table
protected

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

Referenced by __construct().


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