ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
Public Member Functions | Protected Member Functions
ilTrSummaryTableGUI Class Reference

name table More...

+ Inheritance diagram for ilTrSummaryTableGUI:
+ Collaboration diagram for ilTrSummaryTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, $a_ref_id, $a_print_mode=false)
 Constructor. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 initFilter ()
 Init filter. More...
 
 getSelCountryCodes ()
 
 getItems ($a_object_id, $a_ref_id)
 Build summary item rows for given object and filter(s. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
- Public Member Functions inherited from ilLPTableBaseGUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 Constructor. More...
 
 executeCommand ()
 Execute command. More...
 
 searchFilterListener ($a_ref_id, $a_data)
 Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED @access public. More...
 
 initFilter ($a_split_learning_resources=false, $a_include_no_status_filter=true)
 Init filter. More...
 
 getCurrentFilter ($as_query=false)
 
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 Constructor. More...
 
 setOpenFormTag ($a_val)
 Set open form tag. More...
 
 getOpenFormTag ()
 Get open form tag. More...
 
 setCloseFormTag ($a_val)
 Set close form tag. More...
 
 getCloseFormTag ()
 Get close form tag. More...
 
 determineLimit ()
 Determine the limit. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 Determine selected columns. More...
 
 isColumnSelected ($a_col)
 Is given column selected? More...
 
 getSelectedColumns ()
 Get selected columns. More...
 
& executeCommand ()
 Execute command. More...
 
 resetOffset ($a_in_determination=false)
 Reset offset. More...
 
 initFilter ()
 Init filter. More...
 
 getParentObject ()
 Get parent object. More...
 
 getParentCmd ()
 Get parent command. More...
 
 setTopAnchor ($a_val)
 Set top anchor. More...
 
 getTopAnchor ()
 Get top anchor. More...
 
 setNoEntriesText ($a_text)
 Set text for an empty table. More...
 
 getNoEntriesText ()
 Get text for an empty table. More...
 
 setIsDataTable ($a_val)
 Set is data table. More...
 
 getIsDataTable ()
 Get is data table. More...
 
 setEnableTitle ($a_enabletitle)
 Set Enable Title. More...
 
 getEnableTitle ()
 Get Enable Title. More...
 
 setEnableHeader ($a_enableheader)
 Set Enable Header. More...
 
 getEnableHeader ()
 Get Enable Header. More...
 
 setEnableNumInfo ($a_val)
 Set enable num info. More...
 
 getEnableNumInfo ()
 Get enable num info. More...
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon. More...
 
 setDescription ($a_val)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 setOrderField ($a_order_field)
 set order column More...
 
 getOrderField ()
 
 setData ($a_data)
 set table data @access public More...
 
 getData ()
 
 dataExists ()
 
 setPrefix ($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) @access public More...
 
 getPrefix ()
 
 addFilterItem ($a_input_item, $a_optional=false)
 Add filter item. More...
 
 addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
 Add filter by standard type. More...
 
 getFilterItems ($a_optionals=false)
 Get filter items. More...
 
 getFilterItemByPostVar ($a_post_var)
 
 setFilterCols ($a_val)
 Set filter columns. More...
 
 getFilterCols ()
 Get filter columns. More...
 
 setDisableFilterHiding ($a_val=true)
 Set disable filter hiding. More...
 
 getDisableFilterHiding ()
 Get disable filter hiding
More...
 
 isFilterSelected ($a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 Get selected filters. More...
 
 determineSelectedFilters ()
 Determine selected filters. More...
 
 setCustomPreviousNext ($a_prev_link, $a_next_link)
 Set custom previous/next links. More...
 
 setFormAction ($a_form_action, $a_multipart=false)
 Set Form action parameter. More...
 
 getFormAction ()
 Get Form action parameter. More...
 
 setFormName ($a_formname)
 Set Form name. More...
 
 getFormName ()
 Get Form name. More...
 
 setId ($a_val)
 Set id. More...
 
 getId ()
 Get element id. More...
 
 setDisplayAsBlock ($a_val)
 Set display as block. More...
 
 getDisplayAsBlock ()
 Get display as block. More...
 
 getSelectAllCheckbox ()
 Get the name of the checkbox that should be toggled with a select all button. More...
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 Set the name of the checkbox that should be toggled with a select all button. More...
 
 setExternalSorting ($a_val)
 Set external sorting. More...
 
 getExternalSorting ()
 Get external sorting. More...
 
 setFilterCommand ($a_val, $a_caption=null)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val, $a_caption=null)
 Set reset filter command. More...
 
 getResetCommand ()
 Get reset filter command. More...
 
 setExternalSegmentation ($a_val)
 Set external segmentation. More...
 
 getExternalSegmentation ()
 Get external segmentation. More...
 
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field. More...
 
 getDefaultOrderField ()
 Get Default order field. More...
 
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction. More...
 
 getDefaultOrderDirection ()
 Get Default order direction. More...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButtonBase $a_button)
 Add Command button instance. More...
 
 addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button. More...
 
 addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button for selected items. More...
 
 setCloseCommand ($a_link)
 Add command for closing table. More...
 
 addMultiCommand ($a_cmd, $a_text)
 Add Command button. More...
 
 addHiddenInput ($a_name, $a_value)
 Add Hidden Input field. More...
 
 addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
 Add Header Command (Link) (Image needed for now) More...
 
 setTopCommands ($a_val)
 Set top commands (display command buttons on top of table, too) More...
 
 getTopCommands ()
 Get top commands (display command buttons on top of table, too) More...
 
 addColumn ($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
 Add a column to the header. More...
 
 getNavParameter ()
 
 setOrderLink ($sort_field, $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order. More...
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 render ()
 render table @access public More...
 
 writeFilterToSession ()
 Write filter values to session. More...
 
 resetFilter ()
 Reset filter. More...
 
 fillFooter ()
 Fill footer row. More...
 
 getLinkbar ($a_num)
 Get previous/next linkbar. More...
 
 fillHiddenRow ()
 
 fillActionRow ()
 Fill Action Row. More...
 
 setHeaderHTML ($html)
 set header html More...
 
 storeProperty ($type, $value)
 Store table property. More...
 
 loadProperty ($type)
 Load table property. More...
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext ($id)
 Set context. More...
 
 getContext ()
 Get context. More...
 
 setShowRowsSelector ($a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 Get rows-per-page selector state. More...
 
 setShowTemplates ($a_value)
 Toggle templates. More...
 
 getShowTemplates ()
 Get template state. More...
 
 restoreTemplate ($a_name)
 Restore state from template. More...
 
 saveTemplate ($a_name)
 Save current state as template. More...
 
 deleteTemplate ($a_name)
 Delete template. More...
 
 getLimit ()
 Get limit. More...
 
 getOffset ()
 Get offset. More...
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode ($a_value=false)
 Toogle print mode. More...
 
 getPrintMode ()
 Get print mode. More...
 
 getExportMode ()
 Was export activated? More...
 
 exportData ($format, $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand ($a_value)
 Enable actions for all entries in current result. More...
 
 setRowSelectorLabel ($row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission ($a_val)
 Set prevent double submission. More...
 
 getPreventDoubleSubmission ()
 Get prevent double submission. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
- Public Member Functions inherited from ilTableGUI
 ilTableGUI ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate (&$a_tpl)
 set template @access public More...
 
& getTemplateObject ()
 
 setData ($a_data)
 set table data @access public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title @access public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page @access public More...
 
 setHeaderNames ($a_header_names)
 set table header names @access public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns @access public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars @access public More...
 
 setColumnWidth ($a_column_width)
 set table column widths @access public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width @access public More...
 
 setMaxCount ($a_max_count)
 set max. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
 getLimit ()
 Get limit. More...
 
 setPrefix ($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) @access public More...
 
 setOffset ($a_offset)
 set dataset offset @access public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column @access public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction @access public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction @access public More...
 
 enable ($a_module_name)
 enables particular modules of table More...
 
 disable ($a_module_name)
 diesables particular modules of table More...
 
 sortData ()
 
 render ()
 render table @access public More...
 
 renderHeader ()
 
 setOrderLink ($key, $order_dir)
 
 setStyle ($a_element, $a_style)
 
 getStyle ($a_element)
 
 setBase ($a_base)
 Set Base script name (deprecated, only use this for workarounds). More...
 
 getBase ()
 Get Base script name (deprecated, only use this for workarounds). More...
 
 getFormName ()
 
 setFormName ($a_name="cmd")
 
 getSelectAllCheckbox ()
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton ($btn_name, $btn_value)
 

Protected Member Functions

 getItemsPercentages (array $data=NULL, $overall, array $value_map=NULL, $limit=3)
 Render data as needed for summary list (based on grouped values) More...
 
 getItemsPercentagesStatus (array $data=NULL, $overall, array $value_map=NULL)
 Render status data as needed for summary list (based on grouped values) More...
 
 parseValue ($id, $value, $type)
 
 fillRow ($a_set)
 Fill table row. More...
 
 renderPercentages ($id, $data)
 
 isArrayColumn ($a_name)
 
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel ($worksheet, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 
- Protected Member Functions inherited from ilLPTableBaseGUI
 sendMail (array $a_user_ids, $a_parent_obj, $a_parent_cmd)
 
 searchObjects (array $filter, $permission, array $preset_obj_ids=null, $a_check_lp_activation=true)
 Search objects that match current filters. More...
 
 buildPath ($ref_ids)
 Build path with deep-link. More...
 
 getPossibleTypes ($a_split_learning_resources=false, $a_include_digilib=false, $a_allow_undefined_lp=false)
 Get possible subtypes. More...
 
 parseValue ($id, $value, $type)
 
 isPercentageAvailable ($a_obj_id)
 
 parseTitle ($a_obj_id, $action, $a_user_id=false)
 
 getExportMeta ()
 Build export meta data. More...
 
 fillMetaExcel ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 showTimingsWarning ($a_ref_id, $a_user_id)
 
 formatSeconds ($seconds, $a_shorten_zero=false)
 
 anonymizeValue ($a_value, $a_force_number=false)
 
 buildValueScale ($a_max_value, $a_anonymize=false, $a_format_seconds=false)
 
 getMonthsFilter ($a_short=false)
 
 getMonthsYear ($a_year=null, $a_short=false)
 
 getSelectableUserColumns ($a_in_course=false, $a_in_group=false)
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel ($a_worksheet, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- 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 EXPORT_EXCEL = 1
 
const EXPORT_CSV = 2
 
const ACTION_ALL_LIMIT = 1000
 
- Data Fields inherited from ilTableGUI
 $title
 
 $icon
 
 $icon_alt
 
 $help_page
 
 $help_icon
 
 $help_icon_alt
 
 $header_names
 
 $header_vars
 
 $linkbar_vars
 
 $data
 
 $column_count
 
 $column_width
 
 $max_count
 
 $limit
 
 $max_limit = false
 
 $offset
 
 $order_column
 
 $order_direction
 
 $footer_style
 
 $footer_previous
 
 $footer_next
 
 $lang_support = true
 
 $global_tpl
 
 $form_name
 
 $select_all_checkbox
 
 $action_buttons
 
 $prefix
 
 $base = ""
 
 $enabled
 
 $styles
 
- Protected Attributes inherited from ilLPTableBaseGUI
 $filter
 
 $anonymized
 
- Protected Attributes inherited from ilTable2GUI
 $close_command = ""
 
 $top_anchor = "il_table_top"
 
 $filters = array()
 
 $optional_filters = array()
 
 $filter_cmd = 'applyFilter'
 
 $reset_cmd = 'resetFilter'
 
 $filter_cols = 5
 
 $ext_sort = false
 
 $ext_seg = false
 
 $context = ""
 
 $mi_sel_buttons = null
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = true
 
 $rows_selector_off = false
 
 $nav_determined = false
 
 $limit_determined = false
 
 $filters_determined = false
 
 $columns_determined = false
 
 $open_form_tag = true
 
 $close_form_tag = true
 
 $export_formats
 
 $export_mode
 
 $print_mode
 
 $enable_command_for_all
 
 $restore_filter
 
 $restore_filter_values
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

Detailed Description

name table

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

@ilCtrl_Calls ilTrSummaryTableGUI: ilFormPropertyDispatchGUI

Definition at line 15 of file class.ilTrSummaryTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTrSummaryTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
  $a_ref_id,
  $a_print_mode = false 
)

Constructor.

Definition at line 20 of file class.ilTrSummaryTableGUI.php.

21 {
22 global $ilCtrl, $objDefinition;
23
24 $this->setId("trsmy");
25
26 $this->ref_id = $a_ref_id;
27 $this->obj_id = ilObject::_lookupObjId($a_ref_id);
28 $this->is_root = ($a_ref_id == ROOT_FOLDER_ID);
29
30 if(!$this->is_root)
31 {
32 // #17084 - are we multi-object or not?
33 // we cannot parse type filter (too complicated)
34 $type = ilObject::_lookupType($this->obj_id);
35 if(!$objDefinition->isContainer($type))
36 {
37 $this->type = $type;
38 include_once './Services/Object/classes/class.ilObjectLP.php';
39 $this->olp = ilObjectLP::getInstance($this->obj_id);
40 }
41 }
42
43 parent::__construct($a_parent_obj, $a_parent_cmd);
44
45 if($a_print_mode)
46 {
47 $this->setPrintMode(true);
48 }
49
50 $this->parseTitle($this->obj_id, "trac_summary");
51 $this->setLimit(9999);
52 $this->setShowTemplates(true);
53 $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
54
55 $this->addColumn($this->lng->txt("title"), "title");
56 $this->setDefaultOrderField("title");
57
58 $labels = $this->getSelectableColumns();
59 foreach ($this->getSelectedColumns() as $c)
60 {
61 $this->addColumn($labels[$c]["txt"], $c);
62 }
63
64 if($this->is_root)
65 {
66 $this->addColumn($this->lng->txt("path"));
67 $this->addColumn($this->lng->txt("action"));
68 }
69
70 $this->initFilter();
71
72 // $this->setExternalSorting(true);
73 $this->setEnableHeader(true);
74 $this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
75 $this->setRowTemplate("tpl.trac_summary_row.html", "Services/Tracking");
76
77 $this->getItems($a_parent_obj->getObjId(), $a_ref_id);
78 }
ilLPTableBaseGUI\parseTitle
parseTitle($a_obj_id, $action, $a_user_id=false)
Definition: class.ilLPTableBaseGUI.php:657
ilObjectLP\getInstance
static getInstance($a_obj_id)
Definition: class.ilObjectLP.php:25
ilObject\_lookupObjId
static _lookupObjId($a_id)
Definition: class.ilObject.php:1041
ilObject\_lookupType
static _lookupType($a_id, $a_reference=false)
lookup object type
Definition: class.ilObject.php:1196
ilTable2GUI\getSelectedColumns
getSelectedColumns()
Get selected columns.
Definition: class.ilTable2GUI.php:302
ilTable2GUI\setEnableHeader
setEnableHeader($a_enableheader)
Set Enable Header.
Definition: class.ilTable2GUI.php:470
ilTable2GUI\addColumn
addColumn($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
Add a column to the header.
Definition: class.ilTable2GUI.php:1308
ilTable2GUI\setExportFormats
setExportFormats(array $formats)
Set available export formats.
Definition: class.ilTable2GUI.php:3119
ilTable2GUI\setPrintMode
setPrintMode($a_value=false)
Toogle print mode.
Definition: class.ilTable2GUI.php:3140
ilTable2GUI\setRowTemplate
setRowTemplate($a_template, $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:1125
ilTable2GUI\setLimit
setLimit($a_limit=0, $a_default_limit=0)
set max.
Definition: class.ilTable2GUI.php:3424
ilTable2GUI\setDefaultOrderField
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
Definition: class.ilTable2GUI.php:1136
ilTable2GUI\setId
setId($a_val)
Set id.
Definition: class.ilTable2GUI.php:976
ilTable2GUI\setFormAction
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
Definition: class.ilTable2GUI.php:935
ilTable2GUI\setShowTemplates
setShowTemplates($a_value)
Toggle templates.
Definition: class.ilTable2GUI.php:2986
ilTrSummaryTableGUI\getSelectableColumns
getSelectableColumns()
Get selectable columns.
Definition: class.ilTrSummaryTableGUI.php:80
ilTrSummaryTableGUI\getItems
getItems($a_object_id, $a_ref_id)
Build summary item rows for given object and filter(s.
Definition: class.ilTrSummaryTableGUI.php:333
$ilCtrl
global $ilCtrl
Definition: ilias.php:18

References $ilCtrl, ilObject\_lookupObjId(), ilObject\_lookupType(), ilTable2GUI\addColumn(), ilObjectLP\getInstance(), getItems(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), initFilter(), ilLPTableBaseGUI\parseTitle(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setPrintMode(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setShowTemplates().

+ Here is the call graph for this function:

Member Function Documentation

◆ fillHeaderCSV()

ilTrSummaryTableGUI::fillHeaderCSV (   $a_csv)
protected

CSV Version of Fill Header.

Likely to be overwritten by derived class.

Parameters
object$a_csvcurrent file

Reimplemented from ilTable2GUI.

Definition at line 900 of file class.ilTrSummaryTableGUI.php.

901 {
902 $a_csv->addColumn($this->lng->txt("title"));
903
904 $labels = $this->getSelectableColumns();
905 foreach ($this->getSelectedColumns() as $c)
906 {
907 $label = $labels[$c]["txt"];
908 $label = str_replace("Ø", $this->lng->txt("trac_average"), $label);
909 $label = str_replace("∑", $this->lng->txt("trac_sum"), $label);
910
911 if(!$this->isArrayColumn($c))
912 {
913 $a_csv->addColumn($label);
914 }
915 else
916 {
917 if($c != "status")
918 {
919 $a_csv->addColumn($label." #1");
920 $a_csv->addColumn($label." #1");
921 $a_csv->addColumn($label." #1 %");
922 $a_csv->addColumn($label." #2");
923 $a_csv->addColumn($label." #2");
924 $a_csv->addColumn($label." #2 %");
925 $a_csv->addColumn($label." #3");
926 $a_csv->addColumn($label." #3");
927 $a_csv->addColumn($label." #3 %");
928 $a_csv->addColumn($label." ".$this->lng->txt("trac_others"));
929 $a_csv->addColumn($label." ".$this->lng->txt("trac_others"));
930 $a_csv->addColumn($label." ".$this->lng->txt("trac_others")." %");
931 }
932 else
933 {
934 // build status to image map
935 include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
936 include_once("./Services/Tracking/classes/class.ilLPStatus.php");
937 $valid_status = array(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM,
938 ilLPStatus::LP_STATUS_IN_PROGRESS_NUM,
939 ilLPStatus::LP_STATUS_COMPLETED_NUM,
940 ilLPStatus::LP_STATUS_FAILED_NUM);
941 foreach($valid_status as $status)
942 {
943 $text = ilLearningProgressBaseGUI::_getStatusText($status);
944 $a_csv->addColumn($text);
945 $a_csv->addColumn($text." %");
946 }
947 }
948 }
949 }
950
951 $a_csv->addRow();
952 }
ilLPStatus\LP_STATUS_COMPLETED_NUM
const LP_STATUS_COMPLETED_NUM
Definition: class.ilLPStatus.php:30
ilLPStatus\LP_STATUS_IN_PROGRESS_NUM
const LP_STATUS_IN_PROGRESS_NUM
Definition: class.ilLPStatus.php:29
ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM
const LP_STATUS_NOT_ATTEMPTED_NUM
Definition: class.ilLPStatus.php:28
ilLPStatus\LP_STATUS_FAILED_NUM
const LP_STATUS_FAILED_NUM
Definition: class.ilLPStatus.php:31
ilLearningProgressBaseGUI\_getStatusText
_getStatusText($a_status, $a_lng=null)
Get status alt text.
Definition: class.ilLearningProgressBaseGUI.php:349
$text
$text
Definition: example_020.php:127

References $text, ilLearningProgressBaseGUI\_getStatusText(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), isArrayColumn(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

+ Here is the call graph for this function:

◆ fillHeaderExcel()

ilTrSummaryTableGUI::fillHeaderExcel (   $worksheet,
&  $a_row 
)
protected

Excel Version of Fill Header.

Likely to be overwritten by derived class.

Parameters
object$a_worksheetcurrent sheet
int$a_rowrow counter

Reimplemented from ilTable2GUI.

Definition at line 800 of file class.ilTrSummaryTableGUI.php.

801 {
802 $worksheet->write($a_row, 0, $this->lng->txt("title"));
803
804 $labels = $this->getSelectableColumns();
805 $cnt = 1;
806 foreach ($this->getSelectedColumns() as $c)
807 {
808 $label = $labels[$c]["txt"];
809 $label = str_replace("Ø", $this->lng->txt("trac_average"), $label);
810 $label = str_replace("∑", $this->lng->txt("trac_sum"), $label);
811
812 if(!$this->isArrayColumn($c))
813 {
814 $worksheet->write($a_row, $cnt, $label);
815 $cnt++;
816 }
817 else
818 {
819 if($c != "status")
820 {
821 $worksheet->write($a_row, $cnt, $label." #1");
822 $worksheet->write($a_row, ++$cnt, $label." #1");
823 $worksheet->write($a_row, ++$cnt, $label." #1 %");
824 $worksheet->write($a_row, ++$cnt, $label." #2");
825 $worksheet->write($a_row, ++$cnt, $label." #2");
826 $worksheet->write($a_row, ++$cnt, $label." #2 %");
827 $worksheet->write($a_row, ++$cnt, $label." #3");
828 $worksheet->write($a_row, ++$cnt, $label." #3");
829 $worksheet->write($a_row, ++$cnt, $label." #3 %");
830 $worksheet->write($a_row, ++$cnt, $label." ".$this->lng->txt("trac_others"));
831 $worksheet->write($a_row, ++$cnt, $label." ".$this->lng->txt("trac_others"));
832 $worksheet->write($a_row, ++$cnt, $label." ".$this->lng->txt("trac_others")." %");
833 }
834 else
835 {
836 // build status to image map
837 include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
838 include_once("./Services/Tracking/classes/class.ilLPStatus.php");
839 $valid_status = array(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM,
840 ilLPStatus::LP_STATUS_IN_PROGRESS_NUM,
841 ilLPStatus::LP_STATUS_COMPLETED_NUM,
842 ilLPStatus::LP_STATUS_FAILED_NUM);
843 $cnt--;
844 foreach($valid_status as $status)
845 {
846 $text = ilLearningProgressBaseGUI::_getStatusText($status);
847 $worksheet->write($a_row, ++$cnt, $text);
848 $worksheet->write($a_row, ++$cnt, $text." %");
849 }
850 }
851 $cnt++;
852 }
853 }
854 }

References $text, ilLearningProgressBaseGUI\_getStatusText(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), isArrayColumn(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

+ Here is the call graph for this function:

◆ fillRow()

ilTrSummaryTableGUI::fillRow (   $a_set)
protected

Fill table row.

Reimplemented from ilTable2GUI.

Definition at line 658 of file class.ilTrSummaryTableGUI.php.

659 {
660 global $lng, $ilCtrl;
661
662 $this->tpl->setVariable("ICON", ilObject::_getIcon("", "tiny", $a_set["type"]));
663 $this->tpl->setVariable("ICON_ALT", $lng->txt($a_set["type"]));
664 $this->tpl->setVariable("TITLE", $a_set["title"]);
665
666 if($a_set["offline"] || $a_set["privacy_conflict"])
667 {
668 $mess = array();
669 if($a_set["offline"])
670 {
671 $mess[] = $lng->txt("offline");
672 }
673 if($a_set["privacy_conflict"])
674 {
675 $mess[] = $lng->txt("status_no_permission");
676 }
677 $this->tpl->setCurrentBlock("status_bl");
678 $this->tpl->setVariable("TEXT_STATUS", implode(", ", $mess));
679 $this->tpl->parseCurrentBlock();
680 }
681
682 foreach ($this->getSelectedColumns() as $c)
683 {
684 switch($c)
685 {
686 case "country":
687 case "gender":
688 case "city":
689 case "language":
690 case "status":
691 case "mark":
692 case "sel_country":
693 $this->renderPercentages($c, $a_set[$c]);
694 break;
695
696 case "percentage_avg":
697 if((int)$a_set[$c] === 0 || !$this->isPercentageAvailable($a_set["obj_id"]))
698 {
699 $this->tpl->setVariable(strtoupper($c), "");
700 break;
701 }
702
703 default:
704 $value = $this->parseValue($c, $a_set[$c], $a_set["type"]);
705 $this->tpl->setVariable(strtoupper($c), $value);
706 break;
707 }
708 }
709
710 if($this->is_root)
711 {
712 $path = $this->buildPath($a_set["ref_ids"], false, true);
713 if($path)
714 {
715 $this->tpl->setCurrentBlock("item_path");
716 foreach($path as $ref_id => $path_item)
717 {
718 $this->tpl->setVariable("PATH_ITEM", $path_item);
719
720 if(!$this->anonymized)
721 {
722 $ilCtrl->setParameterByClass($ilCtrl->getCmdClass(), 'details_id', $ref_id);
723 $this->tpl->setVariable("URL_DETAILS", $ilCtrl->getLinkTargetByClass($ilCtrl->getCmdClass(), 'details'));
724 $ilCtrl->setParameterByClass($ilCtrl->getCmdClass(), 'details_id', '');
725 $this->tpl->setVariable("TXT_DETAILS", $lng->txt('trac_participants'));
726 }
727 else
728 {
729 $this->tpl->setVariable("URL_DETAILS", ilLink::_getLink($ref_id, $a_set["type"]));
730 $this->tpl->setVariable("TXT_DETAILS", $lng->txt('view'));
731 }
732
733 $this->tpl->parseCurrentBlock();
734 }
735 }
736
737 $this->tpl->setCurrentBlock("item_command");
738 $ilCtrl->setParameterByClass(get_class($this),'hide', $a_set["obj_id"]);
739 $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass(get_class($this),'hide'));
740 $this->tpl->setVariable("TXT_COMMAND", $this->lng->txt('trac_hide'));
741 $this->tpl->parseCurrentBlock();
742
743 $this->tpl->touchBlock("path_action");
744 }
745 else if($a_set["ref_ids"]) // #18446
746 {
747 // #16453
748 include_once './Services/Tree/classes/class.ilPathGUI.php';
749 $path = new ilPathGUI();
750 $path = $path->getPath($this->ref_id, array_pop($a_set["ref_ids"]));
751 if($path)
752 {
753 $this->tpl->setVariable('COLL_PATH', $this->lng->txt('path').': '.$path);
754 }
755 }
756 }
ilLPTableBaseGUI\buildPath
buildPath($ref_ids)
Build path with deep-link.
Definition: class.ilLPTableBaseGUI.php:353
ilObject\_getIcon
static _getIcon($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
Get icon for repository item.
Definition: class.ilObject.php:1900
ilPathGUI
Creates a path for a start and endnode.
Definition: class.ilPathGUI.php:34
ilTrSummaryTableGUI\parseValue
parseValue($id, $value, $type)
Definition: class.ilTrSummaryTableGUI.php:585
$lng
global $lng
Definition: privfeed.php:40
$ref_id
$ref_id
Definition: sahs_server.php:39
$path
$path
Definition: index.php:22

References $ilCtrl, $lng, $path, $ref_id, ilObject\_getIcon(), ilLink\_getLink(), ilLPTableBaseGUI\buildPath(), ilTable2GUI\getSelectedColumns(), ilLPTableBaseGUI\isPercentageAvailable(), parseValue(), and renderPercentages().

+ Here is the call graph for this function:

◆ fillRowCSV()

ilTrSummaryTableGUI::fillRowCSV (   $a_csv,
  $a_set 
)
protected

CSV Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
object$a_csvcurrent file
array$a_setdata array

Reimplemented from ilTable2GUI.

Definition at line 954 of file class.ilTrSummaryTableGUI.php.

955 {
956 $a_csv->addColumn($a_set["title"]);
957
958 foreach ($this->getSelectedColumns() as $c)
959 {
960 if(!$this->isArrayColumn($c))
961 {
962 $val = $this->parseValue($c, $a_set[$c], $a_set["type"]);
963 $a_csv->addColumn($val);
964 }
965 else
966 {
967 foreach((array) $a_set[$c] as $idx => $value)
968 {
969 if($c != "status")
970 {
971 $a_csv->addColumn($value["caption"]);
972 }
973 $a_csv->addColumn((int)$value["absolute"]);
974 $a_csv->addColumn($value["percentage"]);
975 }
976 if(sizeof($a_set[$c]) < 4 && $c != "status")
977 {
978 for($loop = 4; $loop > sizeof($a_set[$c]); $loop--)
979 {
980 $a_csv->addColumn("");
981 $a_csv->addColumn("");
982 $a_csv->addColumn("");
983 }
984 }
985 }
986 }
987
988 $a_csv->addRow();
989 }

References ilTable2GUI\getSelectedColumns(), isArrayColumn(), and parseValue().

+ Here is the call graph for this function:

◆ fillRowExcel()

ilTrSummaryTableGUI::fillRowExcel (   $a_worksheet,
&  $a_row,
  $a_set 
)
protected

Excel Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
object$a_worksheetcurrent sheet
int$a_rowrow counter
array$a_setdata array

Reimplemented from ilTable2GUI.

Definition at line 856 of file class.ilTrSummaryTableGUI.php.

857 {
858 $worksheet->write($a_row, 0, $a_set["title"]);
859
860 $cnt = 1;
861 foreach ($this->getSelectedColumns() as $c)
862 {
863 if(!$this->isArrayColumn($c))
864 {
865 $val = $this->parseValue($c, $a_set[$c], $a_set["type"]);
866 $worksheet->write($a_row, $cnt, $val);
867 $cnt++;
868 }
869 else
870 {
871 foreach((array) $a_set[$c] as $idx => $value)
872 {
873 if($c == "status")
874 {
875 $worksheet->write($a_row, $cnt, (int)$value["absolute"]);
876 $worksheet->write($a_row, ++$cnt, $value["percentage"]);
877 }
878 else
879 {
880 $worksheet->write($a_row, $cnt, $value["caption"]);
881 $worksheet->write($a_row, ++$cnt, (int)$value["absolute"]);
882 $worksheet->write($a_row, ++$cnt, $value["percentage"]);
883 }
884 $cnt++;
885 }
886 if(sizeof($a_set[$c]) < 4 && $c != "status")
887 {
888 for($loop = 4; $loop > sizeof($a_set[$c]); $loop--)
889 {
890 $worksheet->write($a_row, $cnt, "");
891 $worksheet->write($a_row, ++$cnt, "");
892 $worksheet->write($a_row, ++$cnt, "");
893 $cnt++;
894 }
895 }
896 }
897 }
898 }

References ilTable2GUI\getSelectedColumns(), isArrayColumn(), and parseValue().

+ Here is the call graph for this function:

◆ getItems()

ilTrSummaryTableGUI::getItems (   $a_object_id,
  $a_ref_id 
)

Build summary item rows for given object and filter(s.

Parameters
int$a_object_id
int$a_ref_id

Definition at line 333 of file class.ilTrSummaryTableGUI.php.

334 {
335 global $lng, $rbacsystem;
336
337 include_once("./Services/Tracking/classes/class.ilTrQuery.php");
338
339 // show only selected subobjects for lp mode
340 $preselected_obj_ids = $filter = NULL;
341
342 $olp = ilObjectLP::getInstance(ilObject::_lookupObjId($a_ref_id));
343 if(
344 $olp->getCurrentMode() == ilLPObjSettings::LP_MODE_COLLECTION_MANUAL ||
345 $olp->getCurrentMode() == ilLPObjSettings::LP_MODE_COLLECTION ||
346 $olp->getCurrentMode() == ilLPObjSettings::LP_MODE_MANUAL_BY_TUTOR
347 )
348 {
349 $collection = $olp->getCollectionInstance();
350 $preselected_obj_ids[$a_object_id][] = $a_ref_id;
351 foreach($collection->getItems() as $item => $item_info)
352 {
353 $tmp_lp = ilObjectLP::getInstance(ilObject::_lookupObjId($item_info));
354 if($tmp_lp->isActive())
355 {
356 $preselected_obj_ids[ilObject::_lookupObjId($item_info)][] = $item_info;
357 }
358 }
359 $filter = $this->getCurrentFilter();
360 }
361 elseif($this->is_root)
362 {
363 // using search to get all relevant objects
364 // #8498/#8499: restrict to objects with at least "read_learning_progress" access
365 $preselected_obj_ids = $this->searchObjects($this->getCurrentFilter(true), "read_learning_progress");
366 }
367 else
368 {
369 // using summary filters
370 $filter = $this->getCurrentFilter();
371 }
372
373 $data = ilTrQuery::getObjectsSummaryForObject(
374 $a_object_id,
375 $a_ref_id,
376 ilUtil::stripSlashes($this->getOrderField()),
377 ilUtil::stripSlashes($this->getOrderDirection()),
378 ilUtil::stripSlashes($this->getOffset()),
379 ilUtil::stripSlashes($this->getLimit()),
380 $filter,
381 $this->getSelectedColumns(),
382 $preselected_obj_ids
383 );
384
385 // build status to image map
386 include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
387 include_once("./Services/Tracking/classes/class.ilLPStatus.php");
388 $valid_status = array(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM,
389 ilLPStatus::LP_STATUS_IN_PROGRESS_NUM,
390 ilLPStatus::LP_STATUS_COMPLETED_NUM,
391 ilLPStatus::LP_STATUS_FAILED_NUM);
392 $status_map = array();
393 foreach($valid_status as $status)
394 {
395 $path = ilLearningProgressBaseGUI::_getImagePathForStatus($status);
396 $text = ilLearningProgressBaseGUI::_getStatusText($status);
397 $status_map[$status] = ilUtil::img($path, $text);
398 }
399
400 // language map
401 $lng->loadLanguageModule("meta");
402 $languages = array();
403 foreach ($lng->getInstalledLanguages() as $lang_key)
404 {
405 $languages[$lang_key] = $lng->txt("meta_l_".$lang_key);
406 }
407
408 $rows = array();
409 foreach($data["set"] as $idx => $result)
410 {
411 // sessions have no title
412 if($result["title"] == "" && $result["type"] == "sess")
413 {
414 include_once "Modules/Session/classes/class.ilObjSession.php";
415 $sess = new ilObjSession($result["obj_id"], false);
416 $data["set"][$idx]["title"] = $sess->getFirstAppointment()->appointmentToString();
417 }
418
419 $data["set"][$idx]["offline"] = ilLearningProgressBaseGUI::isObjectOffline($result["obj_id"], $result["type"]);
420
421 // #13807
422 if($result["ref_ids"])
423 {
424 $valid = false;
425 foreach($result["ref_ids"] as $check_ref_id)
426 {
427 include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
428 if(ilLearningProgressAccess::checkPermission('read_learning_progress', $check_ref_id))
429 {
430 $valid = true;
431 break;
432 }
433 }
434 if(!$valid)
435 {
436 foreach(array_keys($data["set"][$idx]) as $col_id)
437 {
438 if(!in_array($col_id, array("type", "title", "obj_id", "ref_id", "offline")))
439 {
440 $data["set"][$idx][$col_id] = null;
441 }
442 }
443 $data["set"][$idx]["privacy_conflict"] = true;
444 continue;
445 }
446 }
447
448 // percentages
449 $users_no = $result["user_total"];
450 $data["set"][$idx]["country"] = $this->getItemsPercentages($result["country"], $users_no);
451 $data["set"][$idx]["gender"] = $this->getItemsPercentages($result["gender"], $users_no, array("m"=>$lng->txt("gender_m"), "f"=>$lng->txt("gender_f")));
452 $data["set"][$idx]["city"] = $this->getItemsPercentages($result["city"], $users_no);
453 $data["set"][$idx]["sel_country"] = $this->getItemsPercentages($result["sel_country"], $users_no, $this->getSelCountryCodes());
454 $data["set"][$idx]["mark"] = $this->getItemsPercentages($result["mark"], $users_no);
455 $data["set"][$idx]["language"] = $this->getItemsPercentages($result["language"], $users_no, $languages);
456
457 // if we encounter any invalid status codes, e.g. null, map them to not attempted instead
458 foreach($result["status"] as $status_code => $status_counter)
459 {
460 // null is cast to ""
461 if($status_code === "" || !in_array($status_code, $valid_status))
462 {
463 $result["status"][ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM] += $status_counter;
464 unset($result["status"][$status_code]);
465 }
466 }
467 $data["set"][$idx]["status"] = $this->getItemsPercentagesStatus($result["status"], $users_no, $status_map);
468
469 if(!$this->isPercentageAvailable($result["obj_id"]))
470 {
471 $data["set"][$idx]["percentage_avg"] = NULL;
472 }
473 }
474
475 $this->setMaxCount($data["cnt"]);
476 $this->setData($data["set"]);
477 }
$result
$result
Definition: CleanUpTest.php:407
ilLPTableBaseGUI\getCurrentFilter
getCurrentFilter($as_query=false)
Definition: class.ilLPTableBaseGUI.php:548
ilLPTableBaseGUI\searchObjects
searchObjects(array $filter, $permission, array $preset_obj_ids=null, $a_check_lp_activation=true)
Search objects that match current filters.
Definition: class.ilLPTableBaseGUI.php:174
ilLearningProgressAccess\checkPermission
static checkPermission($a_permission, $a_ref_id, $a_user_id=null)
wrapper for rbac access checks
Definition: class.ilLearningProgressAccess.php:38
ilLearningProgressBaseGUI\_getImagePathForStatus
_getImagePathForStatus($a_status)
Get image path for status.
Definition: class.ilLearningProgressBaseGUI.php:310
ilLearningProgressBaseGUI\isObjectOffline
static isObjectOffline($a_obj_id, $a_type=null)
Definition: class.ilLearningProgressBaseGUI.php:788
ilTable2GUI\setData
setData($a_data)
set table data @access public
Definition: class.ilTable2GUI.php:548
ilTable2GUI\getLimit
getLimit()
Get limit.
Definition: class.ilTable2GUI.php:3093
ilTable2GUI\getOffset
getOffset()
Get offset.
Definition: class.ilTable2GUI.php:3105
ilTableGUI\getOrderDirection
getOrderDirection()
Get order direction.
Definition: class.ilTableGUI.php:396
ilTableGUI\setMaxCount
setMaxCount($a_max_count)
set max.
Definition: class.ilTableGUI.php:270
ilTrQuery\getObjectsSummaryForObject
static getObjectsSummaryForObject($a_parent_obj_id, $a_parent_ref_id, $a_order_field="", $a_order_dir="", $a_offset=0, $a_limit=9999, array $a_filters=NULL, array $a_additional_fields=NULL, $a_preselected_obj_ids=NULL)
Get all aggregated tracking data for parent object.
Definition: class.ilTrQuery.php:708
ilTrSummaryTableGUI\getItemsPercentagesStatus
getItemsPercentagesStatus(array $data=NULL, $overall, array $value_map=NULL)
Render status data as needed for summary list (based on grouped values)
Definition: class.ilTrSummaryTableGUI.php:561
ilTrSummaryTableGUI\getItemsPercentages
getItemsPercentages(array $data=NULL, $overall, array $value_map=NULL, $limit=3)
Render data as needed for summary list (based on grouped values)
Definition: class.ilTrSummaryTableGUI.php:488
ilUtil\img
static img($a_src, $a_alt="", $a_width="", $a_height="", $a_border=0, $a_id="", $a_class="")
Build img tag.
Definition: class.ilUtil.php:2087
ilUtil\stripSlashes
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
Definition: class.ilUtil.php:2691
$valid
$valid
Definition: dummy_client.php:53
$sess
$sess
Definition: inc.setup_header.php:114

References ilTableGUI\$data, ilLPTableBaseGUI\$filter, $lng, $path, $result, $sess, $text, $valid, ilLearningProgressBaseGUI\_getImagePathForStatus(), ilLearningProgressBaseGUI\_getStatusText(), ilObject\_lookupObjId(), ilLearningProgressAccess\checkPermission(), ilLPTableBaseGUI\getCurrentFilter(), ilObjectLP\getInstance(), getItemsPercentages(), getItemsPercentagesStatus(), ilTable2GUI\getLimit(), ilTrQuery\getObjectsSummaryForObject(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), getSelCountryCodes(), ilTable2GUI\getSelectedColumns(), ilUtil\img(), ilLearningProgressBaseGUI\isObjectOffline(), ilLPTableBaseGUI\isPercentageAvailable(), ilLPObjSettings\LP_MODE_COLLECTION, ilLPObjSettings\LP_MODE_COLLECTION_MANUAL, ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, ilLPTableBaseGUI\searchObjects(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), and ilUtil\stripSlashes().

Referenced by __construct().

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

◆ getItemsPercentages()

ilTrSummaryTableGUI::getItemsPercentages ( array  $data = NULL,
  $overall,
array  $value_map = NULL,
  $limit = 3 
)
protected

Render data as needed for summary list (based on grouped values)

Parameters
array$datarows data
int$overalloverall number of entries
array$value_maplabels for values
int$limitsummarize all entries beyond limit
Returns
array

Definition at line 488 of file class.ilTrSummaryTableGUI.php.

489 {
490 global $lng;
491
492 if(!$overall)
493 {
494 return false;
495 }
496
497 $result = array();
498
499 if($data)
500 {
501 // if we have only 1 item more than the limit, "others" makes no sense
502 if(sizeof($data) == $limit+1)
503 {
504 $limit++;
505 }
506
507 $counter = $others_counter = $others_sum = 0;
508 foreach($data as $id => $count)
509 {
510 $counter++;
511 if($counter <= $limit)
512 {
513 $caption = $id;
514
515 if($value_map && isset($value_map[$id]))
516 {
517 $caption = $value_map[$id];
518 }
519
520 if($caption == "")
521 {
522 $caption = $lng->txt("none");
523 }
524
525 $perc = round($count/$overall*100);
526 $result[] = array(
527 "caption" => $caption,
528 "absolute" => $count, // ." ".($count > 1 ? $lng->txt("users") : $lng->txt("user")),
529 "percentage" => $perc
530 );
531 }
532 else
533 {
534 $others_sum += $count;
535 $others_counter++;
536 }
537 }
538
539 if($others_counter)
540 {
541 $perc = round($others_sum/$overall*100);
542 $result[] = array(
543 "caption" => $otherss_counter." ".$lng->txt("trac_others"),
544 "absolute" => $others_sum, // ." ".($others_sum > 1 ? $lng->txt("users") : $lng->txt("user")),
545 "percentage" => $perc
546 );
547 }
548 }
549
550 return $result;
551 }

References ilTableGUI\$data, ilTableGUI\$limit, $lng, and $result.

Referenced by getItems().

+ Here is the caller graph for this function:

◆ getItemsPercentagesStatus()

ilTrSummaryTableGUI::getItemsPercentagesStatus ( array  $data = NULL,
  $overall,
array  $value_map = NULL 
)
protected

Render status data as needed for summary list (based on grouped values)

Parameters
array$datarows data
int$overalloverall number of entries
array$value_maplabels for values
Returns
array

Definition at line 561 of file class.ilTrSummaryTableGUI.php.

562 {
563 global $lng;
564
565 $result = array();
566 foreach($value_map as $id => $caption)
567 {
568 $count = 0;
569 if(isset($data[$id]))
570 {
571 $count = $data[$id];
572 }
573 $perc = round($count/$overall*100);
574
575 $result[] = array(
576 "caption" => $caption,
577 "absolute" => $count,
578 "percentage" => $perc
579 );
580 }
581
582 return $result;
583 }

References ilTableGUI\$data, $lng, and $result.

Referenced by getItems().

+ Here is the caller graph for this function:

◆ getSelCountryCodes()

ilTrSummaryTableGUI::getSelCountryCodes ( )

Definition at line 313 of file class.ilTrSummaryTableGUI.php.

314 {
315 global $lng;
316
317 include_once("./Services/Utilities/classes/class.ilCountry.php");
318 $options = array();
319 foreach (ilCountry::getCountryCodes() as $c)
320 {
321 $options[$c] = $lng->txt("meta_c_".$c);
322 }
323 asort($options);
324 return $options;
325 }
ilCountry\getCountryCodes
static getCountryCodes()
Get country codes (DIN EN 3166-1)
Definition: class.ilCountry.php:18
$options
if(!is_array($argv)) $options
Definition: tcpdf_addfont.php:137

References $lng, $options, and ilCountry\getCountryCodes().

Referenced by getItems().

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

◆ getSelectableColumns()

ilTrSummaryTableGUI::getSelectableColumns ( )

Get selectable columns.

Returns
array key: column id, val: true/false -> default on/off

Reimplemented from ilTable2GUI.

Definition at line 80 of file class.ilTrSummaryTableGUI.php.

81 {
82 global $lng, $ilSetting;
83
84 $lng_map = array("user_total" => "users", "first_access_min" => "trac_first_access",
85 "last_access_max" => "trac_last_access", "mark" => "trac_mark", "status" => "trac_status",
86 'status_changed_max' => 'trac_status_changed',
87 "spent_seconds_avg" => "trac_spent_seconds", "percentage_avg" => "trac_percentage",
88 "read_count_sum" => "trac_read_count", "read_count_avg" => "trac_read_count",
89 "read_count_spent_seconds_avg" => "trac_read_count_spent_seconds"
90 );
91
92
93 $all = array("user_total");
94 $default = array();
95
96 // show only if extended data was activated in lp settings
97 include_once 'Services/Tracking/classes/class.ilObjUserTracking.php';
98 $tracking = new ilObjUserTracking();
99 if($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_READ_COUNT))
100 {
101 $all[] = "read_count_sum";
102 $all[] = "read_count_avg";
103 $default[] = "read_count_sum";
104 }
105 if($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS))
106 {
107 if($this->is_root || !$this->type || ilObjectLP::supportsSpentSeconds($this->type))
108 {
109 $all[] = "spent_seconds_avg";
110 $default[] = "spent_seconds_avg";
111 }
112 }
113 if($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_READ_COUNT) &&
114 $tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS))
115 {
116 if($this->is_root || !$this->type || ilObjectLP::supportsSpentSeconds($this->type))
117 {
118 $all[] = "read_count_spent_seconds_avg";
119 // $default[] = "read_count_spent_seconds_avg";
120 }
121 }
122
123
124 if($this->is_root || !$this->type || $this->isPercentageAvailable($this->obj_id))
125 {
126 $all[] = "percentage_avg";
127 }
128
129 if($this->is_root || !$this->olp || $this->olp->isActive())
130 {
131 $all[] = "status";
132 $all[] = 'status_changed_max';
133 }
134
135 if($this->is_root || !$this->type || ilObjectLP::supportsMark($this->type))
136 {
137 $all[] = "mark";
138 }
139
140 $privacy = array("gender", "city", "country", "sel_country");
141 foreach($privacy as $field)
142 {
143 if($ilSetting->get("usr_settings_course_export_".$field))
144 {
145 $all[] = $field;
146 }
147 }
148
149 $all[] = "language";
150
151 $default[] = "percentage_avg";
152 $default[] = "status";
153 $default[] = "mark";
154
155 if($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS))
156 {
157 $all[] = "first_access_min";
158 $all[] = "last_access_max";
159 }
160
161 $all[] = "create_date_min";
162 $all[] = "create_date_max";
163
164 $columns = array();
165 foreach($all as $column)
166 {
167 $l = $column;
168
169 $prefix = false;
170 if(substr($l, -3) == "avg")
171 {
172 $prefix = "&#216; ";
173 }
174 else if(substr($l, -3) == "sum" || $l == "user_total")
175 {
176 $prefix = "&#8721; ";
177 }
178
179 if(isset($lng_map[$l]))
180 {
181 $l = $lng_map[$l];
182 }
183
184 $txt = $prefix.$lng->txt($l);
185
186 if(in_array($column, array("read_count_avg", "spent_seconds_avg", "percentage_avg")))
187 {
188 $txt .= " / ".$lng->txt("user");
189 }
190
191 $columns[$column] = array(
192 "txt" => $txt,
193 "default" => (in_array($column, $default) ? true :false)
194 );
195 }
196 return $columns;
197 }
$columns
if(! $in) $columns
Definition: Utf8Test.php:46
$l
global $l
Definition: afr.php:30
ilObjectLP\supportsMark
static supportsMark($a_obj_type)
Definition: class.ilObjectLP.php:663
ilObjectLP\supportsSpentSeconds
static supportsSpentSeconds($a_obj_type)
Definition: class.ilObjectLP.php:658
$txt
$txt
Definition: error.php:12
$ilSetting
global $ilSetting
Definition: privfeed.php:40

References $columns, $ilSetting, $l, $lng, ilTableGUI\$prefix, $txt, ilObjUserTracking\EXTENDED_DATA_LAST_ACCESS, ilObjUserTracking\EXTENDED_DATA_READ_COUNT, ilObjUserTracking\EXTENDED_DATA_SPENT_SECONDS, ilLPTableBaseGUI\isPercentageAvailable(), ilObjectLP\supportsMark(), and ilObjectLP\supportsSpentSeconds().

Referenced by __construct(), fillHeaderCSV(), and fillHeaderExcel().

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

◆ initFilter()

ilTrSummaryTableGUI::initFilter ( )

Init filter.

Reimplemented from ilTable2GUI.

Definition at line 202 of file class.ilTrSummaryTableGUI.php.

203 {
204 global $lng, $ilSetting;
205
206 if($this->is_root)
207 {
208 return parent::initFilter(true, false);
209 }
210
211 // show only if extended data was activated in lp settings
212 include_once 'Services/Tracking/classes/class.ilObjUserTracking.php';
213 $tracking = new ilObjUserTracking();
214
215 $item = $this->addFilterItemByMetaType("user_total", ilTable2GUI::FILTER_NUMBER_RANGE, true,
216 "&#8721; ".$lng->txt("users"));
217 $this->filter["user_total"] = $item->getValue();
218
219 if($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_READ_COUNT))
220 {
221 $item = $this->addFilterItemByMetaType("read_count", ilTable2GUI::FILTER_NUMBER_RANGE, true,
222 "&#8721; ".$lng->txt("trac_read_count"));
223 $this->filter["read_count"] = $item->getValue();
224 }
225
226 if($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS))
227 {
228 if($this->is_root || !$this->type || ilObjectLP::supportsSpentSeconds($this->type))
229 {
230 $item = $this->addFilterItemByMetaType("spent_seconds", ilTable2GUI::FILTER_DURATION_RANGE,
231 true, "&#216; ".$lng->txt("trac_spent_seconds")." / ".$lng->txt("user"));
232 $this->filter["spent_seconds"]["from"] = $item->getCombinationItem("from")->getValueInSeconds();
233 $this->filter["spent_seconds"]["to"] = $item->getCombinationItem("to")->getValueInSeconds();
234 }
235 }
236
237 if($this->is_root || !$this->type || $this->isPercentageAvailable($this->obj_id))
238 {
239 $item = $this->addFilterItemByMetaType("percentage", ilTable2GUI::FILTER_NUMBER_RANGE, true,
240 "&#216; ".$lng->txt("trac_percentage")." / ".$lng->txt("user"));
241 $this->filter["percentage"] = $item->getValue();
242 }
243
244 if($this->is_root || !$this->olp || $this->olp->isActive())
245 {
246 include_once "Services/Tracking/classes/class.ilLPStatus.php";
247 $item = $this->addFilterItemByMetaType("status", ilTable2GUI::FILTER_SELECT, true);
248 $item->setOptions(array("" => $lng->txt("trac_all"),
249 ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM+1 => $lng->txt(ilLPStatus::LP_STATUS_NOT_ATTEMPTED),
250 ilLPStatus::LP_STATUS_IN_PROGRESS_NUM+1 => $lng->txt(ilLPStatus::LP_STATUS_IN_PROGRESS),
251 ilLPStatus::LP_STATUS_COMPLETED_NUM+1 => $lng->txt(ilLPStatus::LP_STATUS_COMPLETED),
252 ilLPStatus::LP_STATUS_FAILED_NUM+1 => $lng->txt(ilLPStatus::LP_STATUS_FAILED)));
253 $this->filter["status"] = $item->getValue();
254 if($this->filter["status"])
255 {
256 $this->filter["status"]--;
257 }
258
259 $item = $this->addFilterItemByMetaType("trac_status_changed", ilTable2GUI::FILTER_DATE_RANGE, true);
260 $this->filter["status_changed"] = $item->getDate();
261 }
262
263 if($this->is_root || !$this->type || ilObjectLP::supportsMark($this->type))
264 {
265 $item = $this->addFilterItemByMetaType("mark", ilTable2GUI::FILTER_TEXT, true,
266 $lng->txt("trac_mark"));
267 $this->filter["mark"] = $item->getValue();
268 }
269
270 if($ilSetting->get("usr_settings_course_export_gender"))
271 {
272 $item = $this->addFilterItemByMetaType("gender", ilTable2GUI::FILTER_SELECT, true);
273 $item->setOptions(array("" => $lng->txt("trac_all"), "m" => $lng->txt("gender_m"),
274 "f" => $lng->txt("gender_f")));
275 $this->filter["gender"] = $item->getValue();
276 }
277
278 if($ilSetting->get("usr_settings_course_export_city"))
279 {
280 $item = $this->addFilterItemByMetaType("city", ilTable2GUI::FILTER_TEXT, true);
281 $this->filter["city"] = $item->getValue();
282 }
283
284 if($ilSetting->get("usr_settings_course_export_country"))
285 {
286 $item = $this->addFilterItemByMetaType("country", ilTable2GUI::FILTER_TEXT, true);
287 $this->filter["country"] = $item->getValue();
288 }
289
290 if($ilSetting->get("usr_settings_course_export_sel_country"))
291 {
292 $item = $this->addFilterItemByMetaType("sel_country", ilTable2GUI::FILTER_SELECT, true);
293 $item->setOptions(array("" => $lng->txt("trac_all"))+$this->getSelCountryCodes());
294 $this->filter["sel_country"] = $item->getValue();
295 }
296
297 $item = $this->addFilterItemByMetaType("language", ilTable2GUI::FILTER_LANGUAGE, true);
298 $this->filter["language"] = $item->getValue();
299
300 if($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS))
301 {
302 $item = $this->addFilterItemByMetaType("trac_first_access", ilTable2GUI::FILTER_DATETIME_RANGE, true);
303 $this->filter["first_access"] = $item->getDate();
304
305 $item = $this->addFilterItemByMetaType("trac_last_access", ilTable2GUI::FILTER_DATETIME_RANGE, true);
306 $this->filter["last_access"] = $item->getDate();
307 }
308
309 $item = $this->addFilterItemByMetaType("registration_filter", ilTable2GUI::FILTER_DATE_RANGE, true);
310 $this->filter["registration"] = $item->getDate();
311 }
ilLPStatus\LP_STATUS_COMPLETED
const LP_STATUS_COMPLETED
Definition: class.ilLPStatus.php:25
ilLPStatus\LP_STATUS_FAILED
const LP_STATUS_FAILED
Definition: class.ilLPStatus.php:26
ilLPStatus\LP_STATUS_NOT_ATTEMPTED
const LP_STATUS_NOT_ATTEMPTED
Definition: class.ilLPStatus.php:23
ilLPStatus\LP_STATUS_IN_PROGRESS
const LP_STATUS_IN_PROGRESS
Definition: class.ilLPStatus.php:24
ilTable2GUI\FILTER_DURATION_RANGE
const FILTER_DURATION_RANGE
Definition: class.ilTable2GUI.php:72
ilTable2GUI\addFilterItemByMetaType
addFilterItemByMetaType($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
Add filter by standard type.
Definition: class.ilTable2GUI.php:646
ilTable2GUI\FILTER_NUMBER_RANGE
const FILTER_NUMBER_RANGE
Definition: class.ilTable2GUI.php:70
ilTable2GUI\FILTER_DATETIME_RANGE
const FILTER_DATETIME_RANGE
Definition: class.ilTable2GUI.php:73

References $ilSetting, $lng, ilTable2GUI\addFilterItemByMetaType(), ilObjUserTracking\EXTENDED_DATA_LAST_ACCESS, ilObjUserTracking\EXTENDED_DATA_READ_COUNT, ilObjUserTracking\EXTENDED_DATA_SPENT_SECONDS, ilTable2GUI\FILTER_DATE_RANGE, ilTable2GUI\FILTER_DATETIME_RANGE, ilTable2GUI\FILTER_DURATION_RANGE, ilTable2GUI\FILTER_LANGUAGE, ilTable2GUI\FILTER_NUMBER_RANGE, ilTable2GUI\FILTER_SELECT, ilTable2GUI\FILTER_TEXT, ilLPTableBaseGUI\isPercentageAvailable(), ilLPStatus\LP_STATUS_COMPLETED, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, ilObjectLP\supportsMark(), and ilObjectLP\supportsSpentSeconds().

Referenced by __construct().

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

◆ isArrayColumn()

ilTrSummaryTableGUI::isArrayColumn (   $a_name)
protected

Definition at line 777 of file class.ilTrSummaryTableGUI.php.

778 {
779 if(in_array($a_name, array("country", "gender", "city", "language", "status", "mark")))
780 {
781 return true;
782 }
783 return false;
784 }

Referenced by fillHeaderCSV(), fillHeaderExcel(), fillRowCSV(), and fillRowExcel().

+ Here is the caller graph for this function:

◆ numericOrdering()

ilTrSummaryTableGUI::numericOrdering (   $a_field)

Should this field be sorted numeric?

Returns
boolean numeric ordering; default is false

Reimplemented from ilTable2GUI.

Definition at line 786 of file class.ilTrSummaryTableGUI.php.

787 {
788 $pos = strrpos($a_field, "_");
789 if($pos !== false)
790 {
791 $function = strtoupper(substr($a_field, $pos+1));
792 if(in_array($function, array("MIN", "MAX", "SUM", "AVG", "COUNT", "TOTAL")))
793 {
794 return true;
795 }
796 }
797 return false;
798 }

◆ parseValue()

ilTrSummaryTableGUI::parseValue (   $id,
  $value,
  $type 
)
protected

Reimplemented from ilLPTableBaseGUI.

Definition at line 585 of file class.ilTrSummaryTableGUI.php.

586 {
587 global $lng;
588
589 // get rid of aggregation
590 $pos = strrpos($id, "_");
591 if($pos !== false)
592 {
593 $function = strtoupper(substr($id, $pos+1));
594 if(in_array($function, array("MIN", "MAX", "SUM", "AVG", "COUNT")))
595 {
596 $id = substr($id, 0, $pos);
597 }
598 }
599
600 if(trim($value) == "")
601 {
602 if($id == "title")
603 {
604 return "--".$lng->txt("none")."--";
605 }
606 return "";
607 }
608 switch($id)
609 {
610 case 'status_changed':
611 case "first_access":
612 case "create_date":
613 $value = ilDatePresentation::formatDate(new ilDateTime($value, IL_CAL_DATETIME));
614 break;
615
616 case "last_access":
617 $value = ilDatePresentation::formatDate(new ilDateTime($value, IL_CAL_UNIX));
618 break;
619
620 case "spent_seconds":
621 case "read_count_spent_seconds":
622 if(!ilObjectLP::supportsSpentSeconds($type))
623 {
624 $value = "-";
625 }
626 else
627 {
628 include_once("./Services/Utilities/classes/class.ilFormat.php");
629 $value = ilFormat::_secondsToString($value, ($value < 3600 ? true : false)); // #14858
630 }
631 break;
632
633 case "percentage":
634 if(false /* $this->isPercentageAvailable() */)
635 {
636 $value = "-";
637 }
638 else
639 {
640 $value = $value."%";
641 }
642 break;
643
644 case "mark":
645 if(!ilObjectLP::supportsMark($type))
646 {
647 $value = "-";
648 }
649 break;
650 }
651
652 return $value;
653 }
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:11
IL_CAL_DATETIME
const IL_CAL_DATETIME
Definition: class.ilDateTime.php:9
ilDatePresentation\formatDate
static formatDate(ilDateTime $date)
Format a date @access public.
Definition: class.ilDatePresentation.php:113
ilDateTime
@classDescription Date and time handling
Definition: class.ilDateTime.php:33
ilFormat\_secondsToString
_secondsToString($seconds, $force_with_seconds=false, $a_lng=null)
converts seconds to string: Long: 7 days 4 hour(s) ...
Definition: class.ilFormat.php:549

References $lng, ilFormat\_secondsToString(), ilDatePresentation\formatDate(), IL_CAL_DATETIME, IL_CAL_UNIX, ilObjectLP\supportsMark(), and ilObjectLP\supportsSpentSeconds().

Referenced by fillRow(), fillRowCSV(), and fillRowExcel().

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

◆ renderPercentages()

ilTrSummaryTableGUI::renderPercentages (   $id,
  $data 
)
protected

Definition at line 758 of file class.ilTrSummaryTableGUI.php.

759 {
760 if($data)
761 {
762 foreach($data as $item)
763 {
764 $this->tpl->setCurrentBlock($id."_row");
765 $this->tpl->setVariable("CAPTION", $item["caption"]);
766 $this->tpl->setVariable("ABSOLUTE", $item["absolute"]);
767 $this->tpl->setVariable("PERCENTAGE", $item["percentage"]);
768 $this->tpl->parseCurrentBlock();
769 }
770 }
771 else
772 {
773 $this->tpl->touchBlock($id);;
774 }
775 }

References ilTableGUI\$data.

Referenced by fillRow().

+ Here is the caller graph for this function:
The documentation for this class was generated from the following file: