ilLPObjectStatisticsTableGUI 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 ilLPObjectStatisticsTableGUI:

Collaboration diagram for ilLPObjectStatisticsTableGUI:

Public Member Functions
	__construct (?object $a_parent_obj, string $a_parent_cmd, ?array $a_preselect=null)
	Constructor. More...
	init ()
	getSelectableColumns ()
	Get selectable columns. More...
	numericOrdering (string $a_field)
	Should this field be sorted numeric? More...
	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 @access 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)
	Set table data. More...
	getData ()
	dataExists ()
	setPrefix (string $a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...
	getPrefix ()
	addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)
	addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
	Add filter by standard type. More...
	getFilterItems (bool $a_optionals=false)
	getFilterItemByPostVar (string $a_post_var)
	setFilterCols (int $a_val)
	getFilterCols ()
	setDisableFilterHiding (bool $a_val=true)
	getDisableFilterHiding ()
	isFilterSelected (string $a_col)
	Is given filter selected? More...
	getSelectedFilters ()
	determineSelectedFilters ()
	setCustomPreviousNext (string $a_prev_link, string $a_next_link)
	setFormAction (string $a_form_action, bool $a_multipart=false)
	getFormAction ()
	setFormName (string $a_name="")
	getFormName ()
	get the name of the parent form More...
	setId (string $a_val)
	getId ()
	setDisplayAsBlock (bool $a_val)
	getDisplayAsBlock ()
	setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)
	setExternalSorting (bool $a_val)
	getExternalSorting ()
	setFilterCommand (string $a_val, string $a_caption="")
	getFilterCommand ()
	setResetCommand (string $a_val, string $a_caption="")
	getResetCommand ()
	setExternalSegmentation (bool $a_val)
	getExternalSegmentation ()
	setRowTemplate (string $a_template, string $a_template_dir="")
	Set row template. More...
	setDefaultOrderField (string $a_defaultorderfield)
	getDefaultOrderField ()
	setDefaultOrderDirection (string $a_defaultorderdirection)
	getDefaultOrderDirection ()
	setDefaultFilterVisiblity (bool $a_status)
	getDefaultFilterVisibility ()
	clearCommandButtons ()
	addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")
	addCommandButtonInstance (ilButtonBase $a_button)
	addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')
	setCloseCommand (string $a_link)
	addMultiCommand (string $a_cmd, string $a_text)
	addHiddenInput (string $a_name, string $a_value)
	addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")
	setTopCommands (bool $a_val)
	getTopCommands ()
	addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
	getNavParameter ()
	setOrderLink (string $key, string $order_dir)
	fillHeader ()
	determineOffsetAndOrder (bool $a_omit_offset=false)
	storeNavParameter ()
	getHTML ()
	Get HTML. More...
	numericOrdering (string $a_field)
	Should this field be sorted numeric? More...
	render ()
	writeFilterToSession ()
	resetFilter ()
	fillFooter ()
	getLinkbar (string $a_num)
	fillHiddenRow ()
	fillActionRow ()
	setHeaderHTML (string $html)
	storeProperty (string $type, string $value)
	loadProperty (string $type)
	getCurrentState ()
	get current settings for order, limit, columns and filter More...
	setContext (string $id)
	getContext ()
	setShowRowsSelector (bool $a_value)
	Toggle rows-per-page selector. More...
	getShowRowsSelector ()
	setShowTemplates (bool $a_value)
	getShowTemplates ()
	restoreTemplate (string $a_name)
	Restore state from template. More...
	saveTemplate (string $a_name)
	Save current state as template. More...
	deleteTemplate (string $a_name)
	getLimit ()
	getOffset ()
	setExportFormats (array $formats)
	Set available export formats. More...
	setPrintMode (bool $a_value=false)
	getPrintMode ()
	getExportMode ()
	exportData (int $format, bool $send=false)
	Export and optionally send current table data. More...
	setEnableAllCommand (bool $a_value)
	setRowSelectorLabel (string $row_selector_label)
	getRowSelectorLabel ()
	setPreventDoubleSubmission (bool $a_val)
	getPreventDoubleSubmission ()
	setLimit (int $a_limit=0, int $a_default_limit=0)
	set max. More...
Public Member Functions inherited from ilTableGUI
	__construct (array $a_data=[], bool $a_global_tpl=true)
	setTemplate (ilTemplate $a_tpl)
	getTemplateObject ()
	setData (array $a_data)
	Set table data. More...
	getData ()
	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
	setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")
	setHeaderNames (array $a_header_names)
	getColumnCount ()
	setHeaderVars (array $a_header_vars, array $a_header_params=[])
	setColumnWidth (array $a_column_width)
	set table column widths More...
	setOneColumnWidth (string $a_column_width, int $a_column_number)
	setMaxCount (int $a_max_count)
	set max. More...
	setLimit (int $a_limit=0, int $a_default_limit=0)
	set max. More...
	getLimit ()
	setPrefix (string $a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...
	setOffset (int $a_offset)
	set dataset offset More...
	getOffset ()
	setOrderColumn (string $a_order_column="", string $a_default_column="")
	getOrderColumn ()
	setOrderDirection (string $a_order_direction)
	getOrderDirection ()
	setFooter (string $a_style, string $a_previous="", string $a_next="")
	enable (string $a_module_name)
	disable (string $a_module_name)
	sortData ()
	render ()
	renderHeader ()
	setOrderLink (string $key, string $order_dir)
	setStyle (string $a_element, string $a_style)
	getStyle (string $a_element)
	setBase (string $a_base)
	getBase ()
	getFormName ()
	get the name of the parent form More...
	setFormName (string $a_name="cmd")
	getSelectAllCheckbox ()
	get the name of the checkbox that should be toggled with a select all button More...
	setSelectAllCheckbox (string $a_select_all_checkbox)
	clearActionButtons ()
	addActionButton (string $btn_name, string $btn_value)

Protected Member Functions
	isForwardingToFormDispatcher ()
	findReferencesForObjId (int $a_obj_id)
	fillRow (array $a_set)
	Fill table row. More...
	fillMetaExcel (ilExcel $a_excel, int &$a_row)
	Add meta information to excel export. 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...
	fillRowCSV (ilCSVWriter $a_csv, array $a_set)
	CSV Version of Fill Row. More...
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)
	Add meta information to excel export. More...
	fillMetaCSV (ilCSVWriter $a_csv)
	Add meta information to csv export. More...
	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$ @ilCtrl_Calls ilLPObjectStatisticsTableGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

__construct()

ilLPObjectStatisticsTableGUI::__construct	(	?object	$a_parent_obj,
		string	$a_parent_cmd,
		?array	$a_preselect = null
	)

Constructor.

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

      {
        $this->preselected = $a_preselect;
 
        $this->setId("lpobjstattbl");
        parent::__construct($a_parent_obj, $a_parent_cmd);
    }

References ILIAS\GlobalScreen\Provider\__construct(), and ilTable2GUI\setId().

Here is the call graph for this function:

Member Function Documentation

fillMetaCSV()

ilLPObjectStatisticsTableGUI::fillMetaCSV ( ilCSVWriter  $a_csv )

protected

Add meta information to csv export.

Likely to be overwritten by derived class.

Parameters

ilCSVWriter

$a_csv

current file

Reimplemented from ilLPTableBaseGUI.

Definition at line 483 of file class.ilLPObjectStatisticsTableGUI.php.

                                                      : void
    {
    }

fillMetaExcel()

ilLPObjectStatisticsTableGUI::fillMetaExcel ( ilExcel  $a_excel, int &  $a_row  )

protected

Add meta information to excel export.

Likely to be overwritten by derived class.

Parameters

ilExcel	$a_excel	excel wrapper
int	$a_row	row counter

Reimplemented from ilLPTableBaseGUI.

Definition at line 424 of file class.ilLPObjectStatisticsTableGUI.php.

                                                                   : void
    {
    }

fillRow()

ilLPObjectStatisticsTableGUI::fillRow ( array  $a_set )

protected

Fill table row.

Reimplemented from ilTable2GUI.

Definition at line 296 of file class.ilLPObjectStatisticsTableGUI.php.

                                            : void
    {
        $type = ilObject::_lookupType($a_set["obj_id"]);
 
        $this->tpl->setVariable("OBJ_ID", $a_set["obj_id"]);
        $this->tpl->setVariable(
            "ICON_SRC",
            ilObject::_getIcon(0, "tiny", $type)
        );
        $this->tpl->setVariable("ICON_ALT", $this->lng->txt($type));
        $this->tpl->setVariable("TITLE_TEXT", $a_set["title"]);
 
        if ($this->preselected && in_array(
            $a_set["obj_id"],
            $this->preselected
        )) {
            $this->tpl->setVariable("CHECKBOX_STATE", " checked=\"checked\"");
        }
 
        $sum = 0;
        if (strpos($this->filter["yearmonth"], "-") === false) {
            $this->tpl->setCurrentBlock("month");
            foreach (array_keys(
                $this->getMonthsYear($this->filter["yearmonth"])
            ) as $num) {
                $value = (int) ($a_set["month_" . $num] ?? 0);
                if (($this->filter["measure"] ?? "") != "spent_seconds") {
                    $value = $this->anonymizeValue($value);
                } else {
                    $value = $this->formatSeconds($value, true);
                }
                $this->tpl->setVariable("MONTH_VALUE", $value);
                $this->tpl->parseCurrentBlock();
            }
        }
 
        if (($this->filter["measure"] ?? "") == "spent_seconds") {
            $sum = $this->formatSeconds((int) ($a_set["total"] ?? 0), true);
        } else {
            $sum = $this->anonymizeValue((int) ($a_set["total"] ?? 0));
        }
        $this->tpl->setVariable("TOTAL", $sum);
 
        // optional columns
        if ($this->isColumnSelected('obj_id')) {
            $this->tpl->setVariable('OBJ_ID_COL_VALUE', (string) $a_set['obj_id']);
        }
        if ($this->isColumnSelected('reference_ids')) {
            $this->tpl->setVariable('REF_IDS', (string) implode(', ', $a_set['reference_ids']));
        }
        if ($this->isColumnSelected('paths')) {
            $paths = [];
            foreach ($a_set['reference_ids'] as $reference_id) {
                $path_gui = new ilPathGUI();
                $path_gui->enableTextOnly(false);
                $path_gui->enableHideLeaf(false);
                $path_gui->setUseImages(true);
                $paths[] = $path_gui->getPath(ROOT_FOLDER_ID, $reference_id);
            }
            $this->tpl->setVariable('PATHS', implode('<br /> ', $paths));
        }
    }

References $type, ilObject\_getIcon(), ilObject\_lookupType(), ilLPTableBaseGUI\anonymizeValue(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilLPTableBaseGUI\formatSeconds(), ilLPTableBaseGUI\getMonthsYear(), ILIAS\Repository\int(), ilTable2GUI\isColumnSelected(), ILIAS\Repository\lng(), and ROOT_FOLDER_ID.

Here is the call graph for this function:

fillRowCSV()

ilLPObjectStatisticsTableGUI::fillRowCSV ( ilCSVWriter  $a_csv, array  $a_set  )

protected

CSV Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

ilCSVWriter	$a_csv	current file
array	$a_set	data array

Reimplemented from ilTable2GUI.

Definition at line 487 of file class.ilLPObjectStatisticsTableGUI.php.

                                                                   : void
    {
        $a_csv->addColumn(ilObject::_lookupTitle($a_set["obj_id"]));
 
        // optional columns
        if ($this->isColumnSelected('obj_id')) {
            $a_csv->addColumn($a_set["obj_id"]);
        }
        if ($this->isColumnSelected('reference_ids')) {
            $a_csv->addColumn(implode(', ', $a_set['reference_ids']));
        }
        if ($this->isColumnSelected('paths')) {
            $paths = [];
            foreach ($a_set['reference_ids'] as $reference_id) {
                $path_gui = new ilPathGUI();
                $path_gui->enableTextOnly(true);
                $path_gui->enableHideLeaf(false);
                $path_gui->setUseImages(false);
                $paths[] = $path_gui->getPath(ROOT_FOLDER_ID, $reference_id);
            }
            /*
            * The strings returned by the PathGUI have a linebreak at the end,
            * which has to be removed or it messes up how the paths are displayed in excel.
            */
            $a_csv->addColumn(substr(implode(', ', $paths), 0, -1));
        }
 
        if (strpos($this->filter["yearmonth"], "-") === false) {
            foreach (array_keys(
                $this->getMonthsYear($this->filter["yearmonth"])
            ) as $num) {
                $value = (int) ($a_set["month_" . $num] ?? 0);
                if ($this->filter["measure"] != "spent_seconds") {
                    $value = $this->anonymizeValue($value);
                }
 
                $a_csv->addColumn($value);
            }
        }
 
        if ($this->filter["measure"] == "spent_seconds") {
            // keep seconds
            // $sum = $this->formatSeconds((int)$a_set["total"]);
            $sum = (int) ($a_set["total"] ?? 0);
        } else {
            $sum = $this->anonymizeValue((int) ($a_set["total"] ?? 0));
        }
        $a_csv->addColumn($sum);
 
        $a_csv->addRow();
    }

References ilObject\_lookupTitle(), ilCSVWriter\addColumn(), ilCSVWriter\addRow(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ILIAS\Repository\int(), and ROOT_FOLDER_ID.

Here is the call graph for this function:

fillRowExcel()

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

protected

Excel Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

ilExcel	$a_excel	excel wrapper
int	$a_row	row counter
array	$a_set	data array

Reimplemented from ilTable2GUI.

Definition at line 428 of file class.ilLPObjectStatisticsTableGUI.php.

     : void {
        $a_excel->setCell($a_row, 0, ilObject::_lookupTitle($a_set["obj_id"]));
 
        $col = 0;
 
        // optional columns
        if ($this->isColumnSelected('obj_id')) {
            $a_excel->setCell($a_row, ++$col, (string) $a_set['obj_id']);
        }
        if ($this->isColumnSelected('reference_ids')) {
            $a_excel->setCell($a_row, ++$col, implode(', ', $a_set['reference_ids']));
        }
        if ($this->isColumnSelected('paths')) {
            $paths = [];
            foreach ($a_set['reference_ids'] as $reference_id) {
                $path_gui = new ilPathGUI();
                $path_gui->enableTextOnly(true);
                $path_gui->enableHideLeaf(false);
                $path_gui->setUseImages(false);
                $paths[] = $path_gui->getPath(ROOT_FOLDER_ID, $reference_id);
            }
            /*
             * The strings returned by the PathGUI have a linebreak at the end,
             * which has to be removed or it messes up how the paths are displayed in excel.
             */
            $a_excel->setCell($a_row, ++$col, substr(implode(', ', $paths), 0, -1));
        }
 
        if (strpos($this->filter["yearmonth"], "-") === false) {
            foreach (array_keys(
                $this->getMonthsYear($this->filter["yearmonth"])
            ) as $num) {
                $value = (int) ($a_set["month_" . $num] ?? 0);
                if ($this->filter["measure"] != "spent_seconds") {
                    $value = $this->anonymizeValue($value);
                }
 
                $a_excel->setCell($a_row, ++$col, $value);
            }
        }
 
        if ($this->filter["measure"] == "spent_seconds") {
            // keep seconds
            // $sum = $this->formatSeconds((int)$a_set["total"]);
            $sum = (int) ($a_set["total"] ?? 0);
        } else {
            $sum = $this->anonymizeValue((int) ($a_set["total"] ?? 0));
        }
        $a_excel->setCell($a_row, ++$col, $sum);
    }

References ilExcel\setCell().

Here is the call graph for this function:

findReferencesForObjId()

ilLPObjectStatisticsTableGUI::findReferencesForObjId ( int  $a_obj_id )

protected

Returns

int[]

Reimplemented from ilLPTableBaseGUI.

Definition at line 286 of file class.ilLPObjectStatisticsTableGUI.php.

                                                            : array
    {
        $ref_ids = array_keys(ilObject::_getAllReferences($a_obj_id));
        sort($ref_ids, SORT_NUMERIC);
        return $ref_ids;
    }

References ilObject\_getAllReferences().

Referenced by getItems().

Here is the call graph for this function:

Here is the caller graph for this function:

getGraph()

ilLPObjectStatisticsTableGUI::getGraph

(

array

$a_graph_items

)

Definition at line 359 of file class.ilLPObjectStatisticsTableGUI.php.

                                                  : string
    {
        $chart = ilChart::getInstanceByType(ilChart::TYPE_GRID, "objstacc");
        $chart->setSize("700", "500");
 
        $legend = new ilChartLegend();
        $chart->setLegend($legend);
 
        $max_value = 0;
        foreach ($this->getData() as $object) {
            if (in_array($object["obj_id"], $a_graph_items)) {
                $series = $chart->getDataInstance(ilChartGrid::DATA_LINES);
                $series->setLabel(ilObject::_lookupTitle($object["obj_id"]));
 
                if (strpos($this->filter["yearmonth"], "-") === false) {
                    foreach (array_keys(
                        $this->getMonthsYear(
                            $this->filter["yearmonth"]
                        )
                    ) as $idx => $num) {
                        $value = (int) ($object["month_" . $num] ?? 0);
                        $max_value = max($max_value, $value);
                        if ($this->filter["measure"] != "spent_seconds") {
                            $value = $this->anonymizeValue($value, true);
                        }
                        $series->addPoint($idx, $value);
                    }
                } else {
                    for ($loop = 1; $loop < 32; $loop++) {
                        $value = (int) ($object["day_" . $loop] ?? 0);
                        $max_value = max($max_value, $value);
                        if ($this->filter["measure"] != "spent_seconds") {
                            $value = $this->anonymizeValue($value, true);
                        }
                        $series->addPoint($loop, $value);
                    }
                }
 
                $chart->addData($series);
            }
        }
 
        $value_ticks = $this->buildValueScale(
            $max_value,
            ($this->filter["measure"] != "spent_seconds"),
            ($this->filter["measure"] == "spent_seconds")
        );
 
        $labels = array();
        if (strpos($this->filter["yearmonth"], "-") === false) {
            foreach (array_values(
                $this->getMonthsYear($this->filter["yearmonth"], true)
            ) as $idx => $caption) {
                $labels[$idx] = $caption;
            }
        } else {
            for ($loop = 1; $loop < 32; $loop++) {
                $labels[$loop] = $loop . ".";
            }
        }
        $chart->setTicks($labels, $value_ticks, true);
 
        return $chart->getHTML();
    }

References ilObject\_lookupTitle(), ilLPTableBaseGUI\anonymizeValue(), ilLPTableBaseGUI\buildValueScale(), ilChartGrid\DATA_LINES, ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilTable2GUI\getData(), ilChart\getInstanceByType(), ilLPTableBaseGUI\getMonthsYear(), ILIAS\Repository\int(), and ilChart\TYPE_GRID.

Here is the call graph for this function:

getItems()

ilLPObjectStatisticsTableGUI::getItems

(

)

Definition at line 203 of file class.ilLPObjectStatisticsTableGUI.php.

                              : void
    {
        $data = array();
        $objects = [];
        if ($this->filter["type"] != "prtf") {
            // JF, 2016-06-06
            $objects = $this->searchObjects(
                $this->getCurrentFilter(true),
                "",
                null,
                false
            );
 
            if ($this->filter["type"] == "blog") {
                foreach (ilTrQuery::getWorkspaceBlogs(
                    $this->filter["query"]
                ) as $obj_id) {
                    $objects[$obj_id] = array($obj_id);
                }
            }
        } else {
            // portfolios are not part of repository
            foreach (ilTrQuery::getPortfolios(
                $this->filter["query"]
            ) as $obj_id) {
                $objects[$obj_id] = array($obj_id);
            }
        }
 
        if ($objects) {
            $yearmonth = explode("-", $this->filter["yearmonth"]);
            if (sizeof($yearmonth) == 1) {
                foreach (ilTrQuery::getObjectAccessStatistics(
                    $objects,
                    $yearmonth[0]
                ) as $obj_id => $months) {
                    $data[$obj_id]["obj_id"] = $obj_id;
                    $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
                    $data[$obj_id]['reference_ids'] = $this->findReferencesForObjId($obj_id);
 
                    foreach ($months as $month => $values) {
                        $idx = $yearmonth[0] . "-" . str_pad(
                            $month,
                            2,
                            "0",
                            STR_PAD_LEFT
                        );
                        $data[$obj_id]["month_" . $idx] = (int) ($values[$this->filter["measure"]] ?? 0);
                        $data[$obj_id]["total"] = ($data[$obj_id]["total"] ?? 0) + (int) ($values[$this->filter["measure"]] ?? 0);
                    }
                }
            } else {
                foreach (ilTrQuery::getObjectAccessStatistics(
                    $objects,
                    (string) $yearmonth[0],
                    (string) $yearmonth[1]
                ) as $obj_id => $days) {
                    $data[$obj_id]["obj_id"] = $obj_id;
                    $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
                    $data[$obj_id]['reference_ids'] = $this->findReferencesForObjId($obj_id);
 
                    foreach ($days as $day => $values) {
                        $data[$obj_id]["day_" . $day] = (int) ($values[$this->filter["measure"]] ?? 0);
                        $data[$obj_id]["total"] = ($data[$obj_id]["total"] ?? 0) + (int) ($values[$this->filter["measure"]] ?? 0);
                    }
                }
            }
 
            // add objects with no usage data
            foreach (array_keys($objects) as $obj_id) {
                if (!isset($data[$obj_id])) {
                    $data[$obj_id]["obj_id"] = $obj_id;
                    $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
                    $data[$obj_id]['reference_ids'] = $this->findReferencesForObjId($obj_id);
                }
            }
        }
        $this->setData($data);
    }

References ilTableGUI\$data, ilObject\_lookupTitle(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), findReferencesForObjId(), ilLPTableBaseGUI\getCurrentFilter(), ilTrQuery\getObjectAccessStatistics(), ilTrQuery\getPortfolios(), ilTrQuery\getWorkspaceBlogs(), ILIAS\Repository\int(), ilLPTableBaseGUI\searchObjects(), and ilTable2GUI\setData().

Here is the call graph for this function:

getSelectableColumns()

ilLPObjectStatisticsTableGUI::getSelectableColumns

(

)

Get selectable columns.

Returns

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

Reimplemented from ilTable2GUI.

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

                                          : array
    {
        $columns = [];
        $columns['obj_id'] = [
            'field' => 'obj_id',
            'txt' => $this->lng->txt('object_id'),
            'default' => false,
            'optional' => true,
            'sortable' => true,
            'width' => '5%'
        ];
        $columns['reference_ids'] = [
            'field' => 'reference_ids',
            'txt' => $this->lng->txt('trac_reference_ids_column'),
            'default' => false,
            'optional' => true,
            'sortable' => true,
            'width' => '5%'
        ];
        $columns['paths'] = [
            'field' => 'paths',
            'txt' => $this->lng->txt('trac_paths'),
            'default' => false,
            'optional' => true,
            'sortable' => false,
            'width' => '25%'
        ];
        return $columns;
    }

References ILIAS\Repository\lng().

Referenced by init().

Here is the call graph for this function:

Here is the caller graph for this function:

init()

ilLPObjectStatisticsTableGUI::init

(

)

Definition at line 46 of file class.ilLPObjectStatisticsTableGUI.php.

                          : void
    {
        $this->setShowRowsSelector(true);
        $this->initFilter();
 
        $this->addColumn("", "", "1", true);
        $this->addColumn($this->lng->txt("trac_title"), "title", '30%');
 
        $all_columns = $this->getSelectableColumns();
        foreach ($this->getSelectedColumns() as $col_name => $col_info) {
            $column_definition = $all_columns[$col_name];
            $this->addColumn(
                $column_definition['txt'],
                $column_definition['sortable'] ? $column_definition['field'] : '',
                $column_definition['width']
            );
        }
        if (strpos($this->filter["yearmonth"], "-") === false) {
            foreach ($this->getMonthsYear(
                $this->filter["yearmonth"]
            ) as $num => $caption) {
                $this->addColumn($caption, "month_" . $num);
            }
        }
        $this->addColumn($this->lng->txt("total"), "total");
 
        $this->setTitle($this->lng->txt("trac_object_stat_access"));
 
        // $this->setSelectAllCheckbox("item_id");
        $this->addMultiCommand(
            "showAccessGraph",
            $this->lng->txt("trac_show_graph")
        );
        $this->setResetCommand("resetAccessFilter");
        $this->setFilterCommand("applyAccessFilter");
 
        $this->setFormAction(
            $this->ctrl->getFormAction(
                $this->getParentObject(),
                $this->getParentCmd()
            )
        );
        $this->setRowTemplate(
            "tpl.lp_object_statistics_row.html",
            "Services/Tracking"
        );
        $this->setEnableHeader(true);
        $this->setEnableNumInfo(true);
        $this->setEnableTitle(true);
        $this->setDefaultOrderField("title");
        $this->setDefaultOrderDirection("asc");
        $this->setExportFormats(array(self::EXPORT_EXCEL, self::EXPORT_CSV));
    }

References ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ILIAS\Repository\ctrl(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilLPTableBaseGUI\getMonthsYear(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), initFilter(), ILIAS\Repository\lng(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setResetCommand(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTitle().

Here is the call graph for this function:

initFilter()

ilLPObjectStatisticsTableGUI::initFilter

(

)

Init filter.

Reimplemented from ilTable2GUI.

Definition at line 144 of file class.ilLPObjectStatisticsTableGUI.php.

                                : void
    {
        $this->setDisableFilterHiding(true);
        // object type selection
        $si = new ilSelectInputGUI($this->lng->txt("obj_type"), "type");
        $si->setOptions($this->getPossibleTypes(true, false, true));
        $this->addFilterItem($si);
        $si->readFromSession();
        if (!$si->getValue()) {
            $si->setValue("crs");
        }
        $this->filter["type"] = $si->getValue();
 
        // title/description
        $ti = new ilTextInputGUI(
            $this->lng->txt("trac_title_description"),
            "query"
        );
        $ti->setMaxLength(64);
        $ti->setSize(20);
        $this->addFilterItem($ti);
        $ti->readFromSession();
        $this->filter["query"] = $ti->getValue();
 
        // read_count/spent_seconds
        $si = new ilSelectInputGUI($this->lng->txt("trac_figure"), "figure");
        $si->setOptions(
            array("read_count" => $this->lng->txt("trac_read_count"),
                  "spent_seconds" => $this->lng->txt("trac_spent_seconds"),
                  "users" => $this->lng->txt("users")
            )
        );
        $this->addFilterItem($si);
        $si->readFromSession();
        if (!$si->getValue()) {
            $si->setValue("read_count");
        }
        $this->filter["measure"] = $si->getValue();
 
        // year/month
        $si = new ilSelectInputGUI(
            $this->lng->txt("year") . " / " . $this->lng->txt("month"),
            "yearmonth"
        );
        $si->setOptions($this->getMonthsFilter());
        $this->addFilterItem($si);
        $si->readFromSession();
        if (!$si->getValue()) {
            $si->setValue(date("Y-m"));
        }
        $this->filter["yearmonth"] = $si->getValue();
        $this->filter = $this->initRepositoryFilter($this->filter);
    }

References ilTable2GUI\addFilterItem(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilLPTableBaseGUI\getMonthsFilter(), ilLPTableBaseGUI\getPossibleTypes(), ilLPTableBaseGUI\initRepositoryFilter(), ILIAS\Repository\lng(), and ilTable2GUI\setDisableFilterHiding().

Referenced by init().

Here is the call graph for this function:

Here is the caller graph for this function:

isForwardingToFormDispatcher()

ilLPObjectStatisticsTableGUI::isForwardingToFormDispatcher ( )

protected

Reimplemented from ilLPTableBaseGUI.

Definition at line 198 of file class.ilLPObjectStatisticsTableGUI.php.

                                                     : bool
    {
        return true;
    }

numericOrdering()

ilLPObjectStatisticsTableGUI::numericOrdering

(

string

$a_field

)

Should this field be sorted numeric?

Reimplemented from ilTable2GUI.

Definition at line 130 of file class.ilLPObjectStatisticsTableGUI.php.

                                                    : bool
    {
        $alphabetic_ordering = [
            'title'
        ];
        if (!in_array($a_field, $alphabetic_ordering)) {
            return true;
        }
        return false;
    }

Field Documentation

$preselected

array ilLPObjectStatisticsTableGUI::$preselected

protected

Definition at line 30 of file class.ilLPObjectStatisticsTableGUI.php.

---

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

• Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsTableGUI.php