ILIAS  release_8 Revision v8.23
Public Member Functions | Protected Member Functions | Protected Attributes
ilLanguageTableGUI Class Reference

TableGUI class for. More...

+ Inheritance diagram for ilLanguageTableGUI:
+ Collaboration diagram for ilLanguageTableGUI:

Public Member Functions

 __construct (object $a_parent_obj, string $a_parent_cmd, $a_folder)
 Constructor. More...
 
 getItems ()
 Get language data. More...
 
- 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)
 Fill table row. 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

ilObjLanguageFolder $folder
 
- 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

TableGUI class for.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilLanguageTableGUI::__construct ( object  $a_parent_obj,
string  $a_parent_cmd,
  $a_folder 
)

Constructor.

Definition at line 39 of file class.ilLanguageTableGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ILIAS\Repository\ctrl(), ilTableGUI\disable(), getItems(), ILIAS\Repository\lng(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFormAction(), ilTable2GUI\setLimit(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setSelectAllCheckbox().

40  {
41  global $DIC;
42  $ilAccess = $DIC->access();
43 
44  $this->folder = $a_folder;
45 
46  parent::__construct($a_parent_obj, $a_parent_cmd);
47  $this->setLimit(9999);
48 
49  if ($ilAccess->checkAccess("write", "", $this->folder->getRefId())) {
50  $this->addColumn("", "", "1", true);
51  }
52  $this->addColumn($this->lng->txt("language"));
53  $this->addColumn($this->lng->txt("status"));
54  $this->addColumn($this->lng->txt("users"));
55  $this->addColumn($this->lng->txt("last_refresh"));
56  $this->addColumn($this->lng->txt("last_change"));
57 
58  $this->setEnableHeader(true);
59  $this->setFormAction($this->ctrl->getFormAction($a_parent_obj));
60  $this->setRowTemplate("tpl.lang_list_row_extended.html", "Services/Language");
61  $this->disable("footer");
62  $this->setEnableTitle(true);
63 
64  if ($ilAccess->checkAccess("write", "", $this->folder->getRefId())) {
65  $this->setSelectAllCheckbox("id[]");
66  $this->addMultiCommand("confirmRefreshSelected", $this->lng->txt("refresh"));
67  $this->addMultiCommand("install", $this->lng->txt("install"));
68  $this->addMultiCommand("installLocal", $this->lng->txt("install_local"));
69  $this->addMultiCommand("confirmUninstall", $this->lng->txt("uninstall"));
70  $this->addMultiCommand("confirmUninstallChanges", $this->lng->txt("lang_uninstall_changes"));
71  $this->addMultiCommand("setSystemLanguage", $this->lng->txt("setSystemLanguage"));
72  $this->addMultiCommand("setUserLanguage", $this->lng->txt("setUserLanguage"));
73  }
74 
75  $this->getItems();
76  }
ilTable2GUI\setFormAction
setFormAction(string $a_form_action, bool $a_multipart=false)
Definition: class.ilTable2GUI.php:746
ilTable2GUI\setEnableTitle
setEnableTitle(bool $a_enabletitle)
Definition: class.ilTable2GUI.php:418
ilTable2GUI\setSelectAllCheckbox
setSelectAllCheckbox(string $a_select_all_checkbox, bool $a_select_all_on_top=false)
Definition: class.ilTable2GUI.php:795
ilLanguageTableGUI\getItems
getItems()
Get language data.
Definition: class.ilLanguageTableGUI.php:81
$DIC
global $DIC
Definition: feed.php:28
ilTable2GUI\setRowTemplate
setRowTemplate(string $a_template, string $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:854
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
Definition: PluginProviderHelper.php:37
ilTable2GUI\setLimit
setLimit(int $a_limit=0, int $a_default_limit=0)
Definition: class.ilTable2GUI.php:2837
ilTable2GUI\addColumn
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)
Definition: class.ilTable2GUI.php:966
ilTableGUI\disable
disable(string $a_module_name)
Definition: class.ilTableGUI.php:329
ilTable2GUI\addMultiCommand
addMultiCommand(string $a_cmd, string $a_text)
Definition: class.ilTable2GUI.php:936
ilTable2GUI\setEnableHeader
setEnableHeader(bool $a_enableheader)
Definition: class.ilTable2GUI.php:428
+ Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilLanguageTableGUI::fillRow ( array  $a_set)
protected

Fill table row.

Definition at line 104 of file class.ilLanguageTableGUI.php.

References $DIC, $ilSetting, $url, ilObjLanguage\_getLastLocalChange(), ilObjLanguage\countUsers(), ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), IL_CAL_DATETIME, and ILIAS\Repository\lng().

104  : void
105  {
106  global $DIC;
107  $ilSetting = $DIC->settings();
108  $ilAccess = $DIC->access();
109 
110  $status = "";
111 
112  // set status info (in use or systemlanguage)
113  if ($a_set["status"] ?? false) {
114  $status = "<span class=\"small\"> (" . $this->lng->txt($a_set["status"]) . ")</span>";
115  }
116 
117  // set remark color
118  $remark = "";
119  switch ($a_set["info"]) {
120  case "file_not_found":
121  $remark = "<span class=\"smallred\"> " . $this->lng->txt($a_set["info"]) . "</span>";
122  break;
123  case "new_language":
124  //$remark = "<span class=\"smallgreen\"> ".$lng->txt($a_set["info"])."</span>";
125  break;
126  }
127 
128  // show page translation
129  if ($ilSetting->get("lang_translate_" . $a_set["key"])) {
130  $remark .= $remark ? '<br />' : '';
131  $remark .= "<span class=\"smallgreen\"> " . $this->lng->txt("language_translation_enabled") . "</span>";
132  }
133 
134  if ($a_set["desc"] !== "not_installed") {
135  $this->tpl->setVariable(
136  "LAST_REFRESH",
137  ilDatePresentation::formatDate(new ilDateTime($a_set["last_update"], IL_CAL_DATETIME))
138  );
139 
140  $last_change = ilObjLanguage::_getLastLocalChange($a_set["key"]);
141  $this->tpl->setVariable(
142  "LAST_CHANGE",
143  ilDatePresentation::formatDate(new ilDateTime($last_change, IL_CAL_DATETIME))
144  );
145  }
146 
147  $this->tpl->setVariable("NR_OF_USERS", ilObjLanguage::countUsers($a_set["key"]));
148 
149  // make language name clickable
150  if ($ilAccess->checkAccess("write", "", $this->folder->getRefId()) && strpos(
151  $a_set["description"],
152  "installed"
153  ) === 0) {
154  $this->ctrl->setParameterByClass("ilobjlanguageextgui", "obj_id", $a_set["obj_id"]);
155  $url = $this->ctrl->getLinkTargetByClass("ilobjlanguageextgui", "");
156  $a_set["name"] = '<a href="' . $url . '">' . $a_set["name"] . '</a>';
157  }
158 
159  $this->tpl->setVariable("VAL_LANGUAGE", $a_set["name"] . $status);
160  $this->tpl->setVariable("VAL_STATUS", $this->lng->txt($a_set["desc"]) . "<br/>" . $remark);
161 
162  if ($ilAccess->checkAccess("write", '', $this->folder->getRefId())) {
163  $this->tpl->setVariable("OBJ_ID", $a_set["obj_id"]);
164  }
165  }
IL_CAL_DATETIME
const IL_CAL_DATETIME
Definition: class.ilDateTime.php:7
ilObjLanguage\countUsers
static countUsers(string $a_lang)
Count number of users that use a language.
Definition: class.ilObjLanguage.php:736
ilDatePresentation\formatDate
static formatDate(ilDateTime $date, bool $a_skip_day=false, bool $a_include_wd=false, bool $include_seconds=false)
Definition: class.ilDatePresentation.php:88
$DIC
global $DIC
Definition: feed.php:28
$ilSetting
global $ilSetting
Definition: privfeed.php:17
$url
$url
Definition: proxy_ylocal.php:28
ilObjLanguage\_getLastLocalChange
static _getLastLocalChange(string $a_key)
get the date of the last local change $a_key language key Return change_date "yyyy-mm-dd hh:mm:ss" ...
Definition: class.ilObjLanguage.php:365
+ Here is the call graph for this function:

◆ getItems()

ilLanguageTableGUI::getItems ( )

Get language data.

Definition at line 81 of file class.ilLanguageTableGUI.php.

References ilTableGUI\$data, and ilTable2GUI\setData().

Referenced by __construct().

81  : void
82  {
83  $languages = $this->folder->getLanguages();
84  $data = [];
85  $names = [];
86  $installed = [];
87 
88  foreach ($languages as $k => $l) {
89  $data[] = array_merge($l, ["key" => $k]);
90  $names[] = $l['name'];
91  $installed[] = str_starts_with($l["desc"], 'installed') ? 1 : 2;
92  }
93 
94  // sort alphabetically but show installed languages first
95  array_multisort($installed, SORT_ASC, $names, SORT_ASC, $data);
96 
97  $this->setData($data);
98  }
ilTable2GUI\setData
setData(array $a_data)
Definition: class.ilTable2GUI.php:476
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $folder

ilObjLanguageFolder ilLanguageTableGUI::$folder
protected

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

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