ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ilLPObjectStatisticsTypesTableGUI 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 ilLPObjectStatisticsTypesTableGUI:
+ Collaboration diagram for ilLPObjectStatisticsTypesTableGUI:

Public Member Functions

 __construct ( $a_parent_obj, $a_parent_cmd, array $a_preselect=null, $a_load_items=true)
 Constructor. More...
 
 numericOrdering (string $a_field)
 
 initFilter ()
 Init filter. More...
 
 getItems ()
 
 getGraph (array $a_graph_items)
 
- Public Member Functions inherited from ilLPTableBaseGUI
 __construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")
 
 executeCommand ()
 
 searchFilterListener (int $a_ref_id, array $a_data)
 Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED public. More...
 
 initBaseFilter (bool $a_split_learning_resources=false, bool $a_include_no_status_filter=true)
 Init filter. More...
 
 getCurrentFilter (bool $as_query=false)
 
 getIconVariant ()
 Gets the variant of LP icons that is shown in the table. More...
 
 setIconVariant (int $variant)
 Sets the variant of LP icons that is shown in the table. 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...
 
 fillMetaExcel (ilExcel $a_excel, int &$a_row)
 
 fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set)
 
 fillMetaCSV (ilCSVWriter $a_csv)
 
 fillRowCSV (ilCSVWriter $a_csv, array $a_set)
 
- Protected Member Functions inherited from ilLPTableBaseGUI
 initItemIdFromPost ()
 
 initUidFromPost ()
 
 findReferencesForObjId (int $a_obj_id)
 
 sendMail (array $a_user_ids, $a_parent_obj, string $a_parent_cmd)
 
 searchObjects (array $filter, string $permission, ?array $preset_obj_ids=null, bool $a_check_lp_activation=true)
 Search objects that match current filters. More...
 
 isForwardingToFormDispatcher ()
 
 initRepositoryFilter (array $filter)
 
 buildPath (array $ref_ids)
 
 getPossibleTypes (bool $a_split_learning_resources=false, bool $a_include_digilib=false, bool $a_allow_undefined_lp=false)
 
 parseValue (string $id, ?string $value, string $type)
 
 isPercentageAvailable (int $a_obj_id)
 
 parseTitle (int $a_obj_id, string $action, int $a_user_id=0)
 
 getExportMeta ()
 Build export meta data. More...
 
 fillMetaExcel (ilExcel $a_excel, int &$a_row)
 
 fillMetaCSV (ilCSVWriter $a_csv)
 
 showTimingsWarning (int $a_ref_id, int $a_user_id)
 
 formatSeconds (int $seconds, bool $a_shorten_zero=false)
 
 anonymizeValue ($a_value, bool $a_force_number=false)
 
 buildValueScale (int $a_max_value, bool $a_anonymize=false, bool $a_format_seconds=false)
 
 getMonthsFilter ($a_short=false)
 
 getMonthsYear ($a_year=null, $a_short=false)
 
 getSelectableUserColumns (int $a_in_course=0, int $a_in_group=0)
 
 addToClipboard ()
 Add selected users to clipboard. 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

array $preselected
 
- Protected Attributes inherited from ilLPTableBaseGUI
RefineryFactory $refinery
 
HttpService $http
 
array $filter = []
 
bool $anonymized = true
 
int $icon_variant = ilLPStatusIcons::ICON_VARIANT_LONG
 
ilSetting $setting
 
ilObjectDataCache $ilObjDataCache
 
ilObjectDefinition $objDefinition
 
ilTree $tree
 
ilGlobalTemplateInterface $main_tpl
 
- 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 ilLPTableBaseGUI
const HIT_LIMIT = 5000
 
- 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 TableGUI class for learning progress

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$ ilLPObjectStatisticsTypesTableGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilLPObjectStatisticsTypesTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
array  $a_preselect = null,
  $a_load_items = true 
)

Constructor.

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

References ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ILIAS\Repository\ctrl(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), getItems(), ilLPTableBaseGUI\getMonthsYear(), initFilter(), ILIAS\Repository\lng(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setResetCommand(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setTitle().

38  {
39  $this->preselected = $a_preselect;
40 
41  $this->setId("lpobjstattypetbl");
42  parent::__construct($a_parent_obj, $a_parent_cmd);
43 
44  $this->initFilter();
45  $this->addColumn("", "", "1", true);
46  $this->addColumn($this->lng->txt("type"), "title");
47  // #12788
48  foreach ($this->getMonthsYear(
49  $this->filter["year"]
50  ) as $num => $caption) {
51  $this->addColumn($caption, "month_" . $num);
52  }
53  if ($this->filter["year"] == date("Y")) {
54  $this->addColumn($this->lng->txt("trac_current"), "month_live");
55  }
56 
57  $this->setTitle($this->lng->txt("trac_object_stat_types"));
58 
59  // $this->setSelectAllCheckbox("item_id");
60  $this->addMultiCommand(
61  "showTypesGraph",
62  $this->lng->txt("trac_show_graph")
63  );
64  $this->setResetCommand("resetTypesFilter");
65  $this->setFilterCommand("applyTypesFilter");
66 
67  $this->setFormAction(
68  $this->ctrl->getFormAction($a_parent_obj, $a_parent_cmd)
69  );
70  $this->setRowTemplate(
71  "tpl.lp_object_statistics_types_row.html",
72  "Services/Tracking"
73  );
74  $this->setEnableHeader(true);
75  $this->setEnableNumInfo(true);
76  $this->setEnableTitle(true);
77  $this->setDefaultOrderField("title");
78  $this->setDefaultOrderDirection("asc");
79 
80  $this->setLimit(9999);
81 
82  $this->setExportFormats(array(self::EXPORT_EXCEL, self::EXPORT_CSV));
83 
84  if ($a_load_items) {
85  $this->getItems();
86  }
87  }
setExportFormats(array $formats)
Set available export formats.
setFormAction(string $a_form_action, bool $a_multipart=false)
setEnableTitle(bool $a_enabletitle)
setResetCommand(string $a_val, string $a_caption="")
getMonthsYear($a_year=null, $a_short=false)
setId(string $a_val)
setDefaultOrderField(string $a_defaultorderfield)
setRowTemplate(string $a_template, string $a_template_dir="")
Set row template.
setFilterCommand(string $a_val, string $a_caption="")
setDefaultOrderDirection(string $a_defaultorderdirection)
setTitle(string $a_title, string $a_icon="", string $a_icon_alt="")
setEnableNumInfo(bool $a_val)
__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)
addMultiCommand(string $a_cmd, string $a_text)
setEnableHeader(bool $a_enableheader)
+ Here is the call graph for this function:

Member Function Documentation

◆ fillMetaCSV()

ilLPObjectStatisticsTypesTableGUI::fillMetaCSV ( ilCSVWriter  $a_csv)
protected

Definition at line 338 of file class.ilLPObjectStatisticsTypesTableGUI.php.

338  : void
339  {
340  }

◆ fillMetaExcel()

ilLPObjectStatisticsTypesTableGUI::fillMetaExcel ( ilExcel  $a_excel,
int &  $a_row 
)
protected

Definition at line 315 of file class.ilLPObjectStatisticsTypesTableGUI.php.

315  : void
316  {
317  }

◆ fillRow()

ilLPObjectStatisticsTypesTableGUI::fillRow ( array  $a_set)
protected

Fill table row.

Definition at line 232 of file class.ilLPObjectStatisticsTypesTableGUI.php.

References ilLPTableBaseGUI\anonymizeValue(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilLPTableBaseGUI\getMonthsYear(), and ILIAS\Repository\lng().

232  : void
233  {
234  $this->tpl->setVariable("ICON_SRC", $a_set["icon"]);
235  $this->tpl->setVariable(
236  "ICON_ALT",
237  $this->lng->txt("objs_" . $a_set["type"])
238  );
239  $this->tpl->setVariable("TITLE_TEXT", $a_set["title"]);
240  $this->tpl->setVariable("OBJ_TYPE", $a_set["type"]);
241 
242  if ($this->preselected && in_array(
243  $a_set["type"],
244  $this->preselected
245  )) {
246  $this->tpl->setVariable("CHECKBOX_STATE", " checked=\"checked\"");
247  }
248 
249  $this->tpl->setCurrentBlock("item");
250  foreach (array_keys(
251  $this->getMonthsYear($this->filter["year"])
252  ) as $month) {
253  $this->tpl->setVariable(
254  "VALUE_ITEM",
255  $this->anonymizeValue(
256  (int) ($a_set["month_" . $month] ?? 0)
257  )
258  );
259  $this->tpl->parseCurrentBlock();
260  }
261 
262  if ($this->filter["year"] == date("Y")) {
263  $this->tpl->setVariable(
264  "VALUE_ITEM",
265  $this->anonymizeValue(
266  (int) ($a_set["month_live"] ?? 0)
267  )
268  );
269  $this->tpl->parseCurrentBlock();
270  }
271  }
getMonthsYear($a_year=null, $a_short=false)
anonymizeValue($a_value, bool $a_force_number=false)
+ Here is the call graph for this function:

◆ fillRowCSV()

ilLPObjectStatisticsTypesTableGUI::fillRowCSV ( ilCSVWriter  $a_csv,
array  $a_set 
)
protected

Definition at line 342 of file class.ilLPObjectStatisticsTypesTableGUI.php.

References ilCSVWriter\addColumn(), ilCSVWriter\addRow(), ilLPTableBaseGUI\anonymizeValue(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), and ilLPTableBaseGUI\getMonthsYear().

342  : void
343  {
344  $a_csv->addColumn($a_set["title"]);
345 
346  foreach (array_keys(
347  $this->getMonthsYear($this->filter["year"])
348  ) as $month) {
349  $value = $this->anonymizeValue((int) ($a_set["month_" . $month] ?? 0));
350  $a_csv->addColumn($value);
351  }
352 
353  $value = $this->anonymizeValue((int) ($a_set["month_live"] ?? 0));
354  $a_csv->addColumn($value);
355 
356  $a_csv->addRow();
357  }
addColumn(string $a_col)
getMonthsYear($a_year=null, $a_short=false)
anonymizeValue($a_value, bool $a_force_number=false)
+ Here is the call graph for this function:

◆ fillRowExcel()

ilLPObjectStatisticsTypesTableGUI::fillRowExcel ( ilExcel  $a_excel,
int &  $a_row,
array  $a_set 
)
protected

Definition at line 319 of file class.ilLPObjectStatisticsTypesTableGUI.php.

References ilLPTableBaseGUI\anonymizeValue(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilLPTableBaseGUI\getMonthsYear(), and ilExcel\setCell().

323  : void {
324  $a_excel->setCell($a_row, 0, $a_set["title"]);
325 
326  $cnt = 1;
327  foreach (array_keys(
328  $this->getMonthsYear($this->filter["year"])
329  ) as $month) {
330  $value = $this->anonymizeValue((int) ($a_set["month_" . $month] ?? 0));
331  $a_excel->setCell($a_row, $cnt++, $value);
332  }
333 
334  $value = $this->anonymizeValue((int) ($a_set["month_live"] ?? 0));
335  $a_excel->setCell($a_row, $cnt, $value);
336  }
getMonthsYear($a_year=null, $a_short=false)
setCell(int $a_row, int $a_col, $a_value, ?string $a_datatype=null)
Set cell value.
anonymizeValue($a_value, bool $a_force_number=false)
+ Here is the call graph for this function:

◆ getGraph()

ilLPObjectStatisticsTypesTableGUI::getGraph ( array  $a_graph_items)

Definition at line 273 of file class.ilLPObjectStatisticsTypesTableGUI.php.

References ilTable2GUI\$id, $type, ilChartGrid\DATA_LINES, ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilTable2GUI\getData(), ilChart\getInstanceByType(), ilLPTableBaseGUI\getMonthsYear(), and ilChart\TYPE_GRID.

273  : string
274  {
275  $chart = ilChart::getInstanceByType(ilChart::TYPE_GRID, "objsttp");
276  $chart->setSize("700", "500");
277 
278  $legend = new ilChartLegend();
279  $chart->setLegend($legend);
280 
281  $types = array();
282  foreach ($this->getData() as $id => $item) {
283  $types[$id] = $item["title"];
284  }
285 
286  $labels = [];
287  foreach (array_values(
288  $this->getMonthsYear($this->filter["year"], true)
289  ) as $idx => $caption) {
290  $labels[$idx + 1] = $caption;
291  }
292  $chart->setTicks($labels, false, true);
293 
294  foreach ($this->getData() as $type => $object) {
295  if (in_array($type, $a_graph_items)) {
296  $series = $chart->getDataInstance(ilChartGrid::DATA_LINES);
297  $series->setLabel($types[$type]);
298 
299  foreach (array_keys(
300  $this->getMonthsYear($this->filter["year"])
301  ) as $idx => $month) {
302  $series->addPoint(
303  $idx + 1,
304  (int) ($object["month_" . $month] ?? 0)
305  );
306  }
307 
308  $chart->addData($series);
309  }
310  }
311 
312  return $chart->getHTML();
313  }
$type
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
getMonthsYear($a_year=null, $a_short=false)
const TYPE_GRID
static getInstanceByType(int $a_type, string $a_id)
+ Here is the call graph for this function:

◆ getItems()

ilLPObjectStatisticsTypesTableGUI::getItems ( )

Definition at line 155 of file class.ilLPObjectStatisticsTypesTableGUI.php.

References ilTableGUI\$data, $res, $type, ilObject\_getIcon(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilTrQuery\getObjectTypeStatistics(), ilTrQuery\getObjectTypeStatisticsPerMonth(), ILIAS\Repository\lng(), ilObjectPlugin\lookupTxtById(), and ilTable2GUI\setData().

Referenced by __construct().

155  : void
156  {
158  $this->filter["aggregation"],
159  $this->filter["year"]
160  );
161 
162  $data = array();
163  foreach ($res as $type => $months) {
164  // inactive plugins, etc.
165  if (!$this->objDefinition->getLocation($type)) {
166  continue;
167  }
168 
169  $data[$type]["type"] = $type;
170 
171  // to enable sorting by title
172  if ($this->objDefinition->isPluginTypeName($type)) {
174  $type,
175  "obj_" . $type
176  );
177  $data[$type]["icon"] = ilObject::_getIcon(0, "tiny", $type);
178  } else {
179  $data[$type]["title"] = $this->lng->txt("objs_" . $type);
180  $data[$type]["icon"] = ilObject::_getIcon(0, "tiny", $type);
181  }
182 
183  foreach ($months as $month => $row) {
184  $value = '';
185  if (isset($this->filter['measure']) && isset($row[$this->filter['measure']])) {
186  $value = $row[$this->filter["measure"]];
187  }
188  $data[$type]["month_" . $month] = $value;
189  }
190  }
191 
192  // add live data
193  if ($this->filter["year"] == date("Y")) {
195  foreach ($live as $type => $item) {
196  // inactive plugins, etc.
197  if (!$this->objDefinition->getLocation($type)) {
198  continue;
199  }
200 
201  $data[$type]["type"] = $type;
202 
203  // to enable sorting by title
204  if ($this->objDefinition->isPluginTypeName($type)) {
206  $type,
207  "obj_" . $type
208  );
209  $data[$type]["icon"] = ilObject::_getIcon(0, "tiny", $type);
210  } else {
211  $data[$type]["title"] = $this->lng->txt("objs_" . $type);
212  $data[$type]["icon"] = ilObject::_getIcon(
213  0,
214  "tiny",
215  $type
216  );
217  }
218  $value = '';
219  if (isset($this->filter['measure']) && isset($item[$this->filter['measure']])) {
220  $value = $item[$this->filter["measure"]];
221  }
222  $data[$type]["month_live"] = $value;
223  }
224  }
225 
226  $this->setData($data);
227  }
setData(array $a_data)
$res
Definition: ltiservices.php:69
static _getIcon(int $obj_id=0, string $size="big", string $type="", bool $offline=false)
Get icon for repository item.
$type
static getObjectTypeStatisticsPerMonth(string $a_aggregation, ?string $a_year=null)
static lookupTxtById(string $plugin_id, string $lang_var)
static getObjectTypeStatistics()
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initFilter()

ilLPObjectStatisticsTypesTableGUI::initFilter ( )

Init filter.

Definition at line 100 of file class.ilLPObjectStatisticsTypesTableGUI.php.

References ilTable2GUI\addFilterItem(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ILIAS\Repository\lng(), ilTable2GUI\setDisableFilterHiding(), and ilSelectInputGUI\setOptions().

Referenced by __construct().

100  : void
101  {
102  $this->setDisableFilterHiding(true);
103 
104  // figure
105  $si = new ilSelectInputGUI($this->lng->txt("trac_figure"), "figure");
106  $options = array("objects" => $this->lng->txt("objects"),
107  "references" => $this->lng->txt("trac_reference"),
108  "deleted" => $this->lng->txt("trac_trash")
109  );
110  $si->setOptions($options);
111  $this->addFilterItem($si);
112  $si->readFromSession();
113  if (!$si->getValue()) {
114  $si->setValue("objects");
115  }
116  $this->filter["measure"] = $si->getValue();
117 
118  // aggregation
119  $si = new ilSelectInputGUI(
120  $this->lng->txt("trac_aggregation"),
121  "aggregation"
122  );
123  $options = array();
124  $options["max"] = $this->lng->txt(
125  "trac_object_stat_lp_max"
126  ) . " (" . $this->lng->txt("month") . ")";
127  $options["avg"] = "Ø (" . $this->lng->txt("month") . ")";
128  $options["min"] = $this->lng->txt(
129  "trac_object_stat_lp_min"
130  ) . " (" . $this->lng->txt("month") . ")";
131  $si->setOptions($options);
132  $this->addFilterItem($si);
133  $si->readFromSession();
134  if (!$si->getValue()) {
135  $si->setValue("max");
136  }
137  $this->filter["aggregation"] = $si->getValue();
138 
139  // year/month
140  $si = new ilSelectInputGUI($this->lng->txt("year"), "year");
141  $options = array();
142  for ($loop = 0; $loop < 4; $loop++) {
143  $year = date("Y") - $loop;
144  $options[$year] = $year;
145  }
146  $si->setOptions($options);
147  $this->addFilterItem($si);
148  $si->readFromSession();
149  if (!$si->getValue()) {
150  $si->setValue(date("Y"));
151  }
152  $this->filter["year"] = $si->getValue();
153  }
addFilterItem(ilTableFilterItem $a_input_item, bool $a_optional=false)
setDisableFilterHiding(bool $a_val=true)
setOptions(array $a_options)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ numericOrdering()

ilLPObjectStatisticsTypesTableGUI::numericOrdering ( string  $a_field)

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

89  : bool
90  {
91  if ($a_field != "title") {
92  return true;
93  }
94  return false;
95  }

Field Documentation

◆ $preselected

array ilLPObjectStatisticsTypesTableGUI::$preselected
protected

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


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