ILIAS  trunk Revision v5.2.0beta1-34115-g3a2438be29
ilAdvancedMDFieldTableGUI 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 ilAdvancedMDFieldTableGUI:
+ Collaboration diagram for ilAdvancedMDFieldTableGUI:

Public Member Functions

 __construct ( $a_parent_obj, $a_parent_cmd, ilAdvancedMDPermissionHelper $a_permissions, bool $a_may_edit_pos, string $active_language)
 
 numericOrdering (string $a_field)
 
 parseDefinitions (array $a_definitions)
 
- 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 ()
 
 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)
 
- 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

 fillRow (array $a_set)
 
- 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

ilClaimingPermissionHelper $permissions
 
bool $may_edit_pos
 
string $active_language
 
- 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

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDFieldTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
ilAdvancedMDPermissionHelper  $a_permissions,
bool  $a_may_edit_pos,
string  $active_language 
)

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

References $active_language, $DIC, ilTableGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setFormAction(), ilTable2GUI\setLimit(), and ilTable2GUI\setRowTemplate().

41  {
42  global $DIC;
43 
44  $lng = $DIC['lng'];
45  $ilCtrl = $DIC['ilCtrl'];
46 
47  $this->lng = $lng;
48  $this->ctrl = $ilCtrl;
49  $this->permissions = $a_permissions;
50  $this->may_edit_pos = $a_may_edit_pos;
51  $this->active_language = $active_language;
52 
53  parent::__construct($a_parent_obj, $a_parent_cmd);
54  $this->addColumn('', 'f', '1');
55  $this->addColumn($this->lng->txt('position'), 'position', "5%");
56  $this->addColumn($this->lng->txt('title'), 'title', "30%");
57  $this->addColumn($this->lng->txt('md_adv_field_fields'), 'type', "35%");
58  $this->addColumn($this->lng->txt('options'), 'searchable', "30%");
59 
60  $this->setFormAction($this->ctrl->getFormAction($a_parent_obj));
61  $this->setRowTemplate("tpl.edit_fields_row.html", "components/ILIAS/AdvancedMetaData");
62  $this->setDefaultOrderField("position");
63  /*
64  * BT 35830: disable pagination to prevent that and similar issues due to
65  * this object being a sort of table/form hybrid. There should rarely be more
66  * than 10 rows anyways, and the fix is only temporary until the switch to KS.
67  */
68  $this->setLimit(9999);
69  }
setFormAction(string $a_form_action, bool $a_multipart=false)
ilLanguage $lng
setDefaultOrderField(string $a_defaultorderfield)
setRowTemplate(string $a_template, string $a_template_dir="")
Set row template.
$DIC
Definition: xapitoken.php:62
__construct(Container $dic, ilPlugin $plugin)
setLimit(int $a_limit=0, int $a_default_limit=0)
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)
+ Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilAdvancedMDFieldTableGUI::fillRow ( array  $a_set)
protected

Definition at line 79 of file class.ilAdvancedMDFieldTableGUI.php.

References ILIAS\LTI\ToolProvider\$key, ilAdvancedMDPermissionHelper\ACTION_FIELD_EDIT, ilAdvancedMDPermissionHelper\ACTION_FIELD_EDIT_PROPERTY, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilAdvancedMDPermissionHelper\SUBACTION_FIELD_SEARCHABLE.

79  : void
80  {
81  $this->tpl->setVariable('TXT_SEARCHABLE', $this->lng->txt('md_adv_searchable'));
82  $this->tpl->setVariable('ASS_ID', $a_set['id']);
83  if ($a_set['searchable']) {
84  $this->tpl->setVariable('ASS_CHECKED', 'checked="checked"');
85  }
87  !(bool) $a_set['supports_search']) {
88  $this->tpl->setVariable('ASS_DISABLED', ' disabled="disabled"');
89  }
90 
91  $this->tpl->setVariable('VAL_POS', $a_set['position']);
92  if (!$this->may_edit_pos) {
93  $this->tpl->setVariable('POS_DISABLED', ' disabled="disabled"');
94  }
95 
96  $this->tpl->setVariable('VAL_ID', $a_set['id']);
97  $this->tpl->setVariable('VAL_TITLE', $a_set['title']);
98  if (strlen($a_set['description'])) {
99  $this->tpl->setVariable('VAL_DESCRIPTION', $a_set['description']);
100  }
101 
102  $this->tpl->setVariable('FIELD_TYPE', $a_set['type']);
103 
104  foreach ((array) $a_set['properties'] as $key => $value) {
105  $this->tpl->setCurrentBlock('field_value');
106  $this->tpl->setVariable('FIELD_KEY', $key);
107  $this->tpl->setVariable('FIELD_VAL', $value);
108  $this->tpl->parseCurrentBlock();
109  }
110 
112  $this->ctrl->setParameter($this->parent_obj, 'field_id', $a_set['id']);
113  $this->tpl->setVariable('EDIT_LINK', $this->ctrl->getLinkTarget($this->parent_obj, 'editField'));
114  $this->tpl->setVariable('TXT_EDIT_RECORD', $this->lng->txt('edit'));
115  }
116  }
string $key
Consumer key/client ID value.
Definition: System.php:193
+ Here is the call graph for this function:

◆ numericOrdering()

ilAdvancedMDFieldTableGUI::numericOrdering ( string  $a_field)

Definition at line 71 of file class.ilAdvancedMDFieldTableGUI.php.

71  : bool
72  {
73  if ($a_field === 'position') {
74  return true;
75  }
76  return false;
77  }

◆ parseDefinitions()

ilAdvancedMDFieldTableGUI::parseDefinitions ( array  $a_definitions)

Definition at line 118 of file class.ilAdvancedMDFieldTableGUI.php.

References $active_language, ilAdvancedMDPermissionHelper\ACTION_FIELD_EDIT, ilAdvancedMDPermissionHelper\ACTION_FIELD_EDIT_PROPERTY, ilAdvancedMDPermissionHelper\CONTEXT_FIELD, ilAdvancedMDFieldTranslations\getInstanceByRecordId(), ILIAS\Repository\lng(), ilTable2GUI\setData(), and ilAdvancedMDPermissionHelper\SUBACTION_FIELD_SEARCHABLE.

118  : void
119  {
120  $counter = 0;
121  $defs_arr = [];
122  foreach ($a_definitions as $definition) {
123  $field_translations = ilAdvancedMDFieldTranslations::getInstanceByRecordId($definition->getRecordId());
124 
125  $tmp_arr['position'] = ++$counter * 10;
126  $tmp_arr['id'] = $definition->getFieldId();
127  $tmp_arr['title'] = $field_translations->getTitleForLanguage(
128  $definition->getFieldId(),
130  );
131  $tmp_arr['description'] = $field_translations->getDescriptionForLanguage(
132  $definition->getFieldId(),
134  );
135  $tmp_arr['searchable'] = $definition->isSearchable();
136  $tmp_arr['type'] = $this->lng->txt($definition->getTypeTitle());
137  $tmp_arr['properties'] = $definition->getFieldDefinitionForTableGUI($this->active_language);
138  $tmp_arr['supports_search'] = $definition->isSearchSupported();
139 
140  $tmp_arr['perm'] = $this->permissions->hasPermissions(
142  (string) $definition->getFieldId(),
143  array(
145  ,
148  )
149  )
150  );
151 
152  $defs_arr[] = $tmp_arr;
153  }
154  $this->setData($defs_arr);
155  }
setData(array $a_data)
+ Here is the call graph for this function:

Field Documentation

◆ $active_language

string ilAdvancedMDFieldTableGUI::$active_language
protected

Definition at line 33 of file class.ilAdvancedMDFieldTableGUI.php.

Referenced by __construct(), and parseDefinitions().

◆ $may_edit_pos

bool ilAdvancedMDFieldTableGUI::$may_edit_pos
protected

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

◆ $permissions

ilClaimingPermissionHelper ilAdvancedMDFieldTableGUI::$permissions
protected

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


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