TableGUI class for learning progress. More...

Inheritance diagram for ilLPTableBaseGUI:

Collaboration diagram for ilLPTableBaseGUI:

Public Member Functions
	__construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")

	executeCommand ()

	searchFilterListener (int $a_ref_id, array $a_data)
	Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED public. More...

	initBaseFilter (bool $a_split_learning_resources=false, bool $a_include_no_status_filter=true)
	Init filter. More...

	getCurrentFilter (bool $as_query=false)

	getIconVariant ()
	Gets the variant of LP icons that is shown in the table. More...

	setIconVariant (int $variant)
	Sets the variant of LP icons that is shown in the table. More...

Public Member Functions inherited from ilTable2GUI
	__construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")

	setOpenFormTag (bool $a_val)

	getOpenFormTag ()

	setCloseFormTag (bool $a_val)

	getCloseFormTag ()

	determineLimit ()

	getSelectableColumns ()
	Get selectable columns. More...

	determineSelectedColumns ()

	isColumnSelected (string $col)

	getSelectedColumns ()

	resetOffset (bool $a_in_determination=false)

	initFilter ()

	getParentObject ()

	getParentCmd ()

	setTopAnchor (string $a_val)

	getTopAnchor ()

	setNoEntriesText (string $a_text)

	getNoEntriesText ()

	setIsDataTable (bool $a_val)

	getIsDataTable ()

	setEnableTitle (bool $a_enabletitle)

	getEnableTitle ()

	setEnableHeader (bool $a_enableheader)

	getEnableHeader ()

	setEnableNumInfo (bool $a_val)

	getEnableNumInfo ()

	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")

	setDescription (string $a_val)

	getDescription ()

	setOrderField (string $a_order_field)

	getOrderField ()

	setData (array $a_data)

	getData ()

	dataExists ()

	setPrefix (string $a_prefix)

	getPrefix ()

	addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)

	addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
	Add filter by standard type. More...

	getFilterItems (bool $a_optionals=false)

	getFilterItemByPostVar (string $a_post_var)

	setFilterCols (int $a_val)

	getFilterCols ()

	setDisableFilterHiding (bool $a_val=true)

	getDisableFilterHiding ()

	isFilterSelected (string $a_col)
	Is given filter selected? More...

	getSelectedFilters ()

	determineSelectedFilters ()

	setCustomPreviousNext (string $a_prev_link, string $a_next_link)

	setFormAction (string $a_form_action, bool $a_multipart=false)

	getFormAction ()

	setFormName (string $a_name="")

	getFormName ()

	setId (string $a_val)

	getId ()

	setDisplayAsBlock (bool $a_val)

	getDisplayAsBlock ()

	setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)

	setExternalSorting (bool $a_val)

	getExternalSorting ()

	setFilterCommand (string $a_val, string $a_caption="")

	getFilterCommand ()

	setResetCommand (string $a_val, string $a_caption="")

	getResetCommand ()

	setExternalSegmentation (bool $a_val)

	getExternalSegmentation ()

	setRowTemplate (string $a_template, string $a_template_dir="")
	Set row template. More...

	setDefaultOrderField (string $a_defaultorderfield)

	getDefaultOrderField ()

	setDefaultOrderDirection (string $a_defaultorderdirection)

	getDefaultOrderDirection ()

	setDefaultFilterVisiblity (bool $a_status)

	getDefaultFilterVisibility ()

	clearCommandButtons ()

	addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")

	addCommandButtonInstance (ilButtonBase $a_button)

	addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')

	setCloseCommand (string $a_link)

	addMultiCommand (string $a_cmd, string $a_text)

	addHiddenInput (string $a_name, string $a_value)

	addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")

	setTopCommands (bool $a_val)

	getTopCommands ()

	addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)

	getNavParameter ()

	setOrderLink (string $key, string $order_dir)

	fillHeader ()

	determineOffsetAndOrder (bool $a_omit_offset=false)

	storeNavParameter ()

	getHTML ()
	Get HTML. More...

	numericOrdering (string $a_field)
	Should this field be sorted numeric? More...

	render ()

	writeFilterToSession ()

	resetFilter ()

	fillFooter ()

	getLinkbar (string $a_num)

	fillHiddenRow ()

	fillActionRow ()

	setHeaderHTML (string $html)

	storeProperty (string $type, string $value)

	loadProperty (string $type)

	getCurrentState ()
	get current settings for order, limit, columns and filter More...

	setContext (string $id)

	getContext ()

	setShowRowsSelector (bool $a_value)
	Toggle rows-per-page selector. More...

	getShowRowsSelector ()

	setShowTemplates (bool $a_value)

	getShowTemplates ()

	restoreTemplate (string $a_name)
	Restore state from template. More...

	saveTemplate (string $a_name)
	Save current state as template. More...

	deleteTemplate (string $a_name)

	getLimit ()

	getOffset ()

	setExportFormats (array $formats)
	Set available export formats. More...

	setPrintMode (bool $a_value=false)

	getPrintMode ()

	getExportMode ()

	exportData (int $format, bool $send=false)
	Export and optionally send current table data. More...

	setEnableAllCommand (bool $a_value)

	setRowSelectorLabel (string $row_selector_label)

	getRowSelectorLabel ()

	setPreventDoubleSubmission (bool $a_val)

	getPreventDoubleSubmission ()

	setLimit (int $a_limit=0, int $a_default_limit=0)

Public Member Functions inherited from ilTableGUI
	__construct (array $a_data=[], bool $a_global_tpl=true)

	setTemplate (ilTemplate $a_tpl)

	getTemplateObject ()

	setData (array $a_data)
	Set table data. More...

	getData ()

	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")

	setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")

	setHeaderNames (array $a_header_names)

	getColumnCount ()

	setHeaderVars (array $a_header_vars, array $a_header_params=[])

	setColumnWidth (array $a_column_width)
	set table column widths More...

	setOneColumnWidth (string $a_column_width, int $a_column_number)

	setMaxCount (int $a_max_count)
	set max. More...

	setLimit (int $a_limit=0, int $a_default_limit=0)
	set max. More...

	getLimit ()

	setPrefix (string $a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...

	setOffset (int $a_offset)
	set dataset offset More...

	getOffset ()

	setOrderColumn (string $a_order_column="", string $a_default_column="")

	getOrderColumn ()

	setOrderDirection (string $a_order_direction)

	getOrderDirection ()

	setFooter (string $a_style, string $a_previous="", string $a_next="")

	enable (string $a_module_name)

	disable (string $a_module_name)

	sortData ()

	render ()

	renderHeader ()

	setOrderLink (string $key, string $order_dir)

	setStyle (string $a_element, string $a_style)

	getStyle (string $a_element)

	setBase (string $a_base)

	getBase ()

	getFormName ()
	get the name of the parent form More...

	setFormName (string $a_name="cmd")

	getSelectAllCheckbox ()
	get the name of the checkbox that should be toggled with a select all button More...

	setSelectAllCheckbox (string $a_select_all_checkbox)

	clearActionButtons ()

	addActionButton (string $btn_name, string $btn_value)

Data Fields
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

Protected Member Functions
	initItemIdFromPost ()

	initUidFromPost ()

	findReferencesForObjId (int $a_obj_id)

	sendMail (array $a_user_ids, $a_parent_obj, string $a_parent_cmd)

	searchObjects (array $filter, string $permission, ?array $preset_obj_ids=null, bool $a_check_lp_activation=true)
	Search objects that match current filters. More...

	isForwardingToFormDispatcher ()

	initRepositoryFilter (array $filter)

	buildPath (array $ref_ids)

	getPossibleTypes (bool $a_split_learning_resources=false, bool $a_include_digilib=false, bool $a_allow_undefined_lp=false)

	parseValue (string $id, ?string $value, string $type)

	isPercentageAvailable (int $a_obj_id)

	parseTitle (int $a_obj_id, string $action, int $a_user_id=0)

	getExportMeta ()
	Build export meta data. More...

	fillMetaExcel (ilExcel $a_excel, int &$a_row)

	fillMetaCSV (ilCSVWriter $a_csv)

	showTimingsWarning (int $a_ref_id, int $a_user_id)

	formatSeconds (int $seconds, bool $a_shorten_zero=false)

	anonymizeValue ($a_value, bool $a_force_number=false)

	buildValueScale (int $a_max_value, bool $a_anonymize=false, bool $a_format_seconds=false)

	getMonthsFilter ($a_short=false)

	getMonthsYear ($a_year=null, $a_short=false)

	getSelectableUserColumns (int $a_in_course=0, int $a_in_group=0)

	addToClipboard ()
	Add selected users to clipboard. More...

Protected Member Functions inherited from ilTable2GUI
	getRequestedValues ()

	prepareOutput ()
	Anything that must be done before HTML is generated. More...

	isFilterVisible ()
	Check if filter is visible: manually shown (session, db) or default value set. More...

	isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, ilTableFilterItem $a_element)
	Check if filter element is based on adv md. More...

	fillRow (array $a_set)
	Standard Version of Fill Row. More...

	getFilterValue (ilTableFilterItem $a_item)
	Get current filter value. More...

	setFilterValue (ilTableFilterItem $a_item, $a_value)

	fillMetaExcel (ilExcel $a_excel, int &$a_row)
	Add meta information to excel export. More...

	fillHeaderExcel (ilExcel $a_excel, int &$a_row)
	Excel Version of Fill Header. More...

	fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set)
	Excel Version of Fill Row. More...

	fillMetaCSV (ilCSVWriter $a_csv)
	Add meta information to csv export. More...

	fillHeaderCSV (ilCSVWriter $a_csv)
	CSV Version of Fill Header. More...

	fillRowCSV (ilCSVWriter $a_csv, array $a_set)
	CSV Version of Fill Row. More...

Protected Attributes
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

Private Attributes
ilObjUser	$user

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='')

Detailed Description

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$

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

Constructor & Destructor Documentation

◆ __construct()

ilLPTableBaseGUI::__construct	(	?object	$a_parent_obj,
		string	$a_parent_cmd = `""`,
		string	$a_template_context = `""`
	)

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

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), ilObjUserTracking\_enabledUserRelatedData(), ilObjectLP\getInstance(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

       {
         global $DIC;
         $this->main_tpl = $DIC->ui()->mainTemplate();
 
         $this->objDefinition = $DIC['objDefinition'];
         $this->ilObjDataCache = $DIC['ilObjDataCache'];
         $this->tree = $DIC->repositoryTree();
         $this->user = $DIC->user();
         $this->setting = $DIC->settings();
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
 
         $this->anonymized = !ilObjUserTracking::_enabledUserRelatedData();
         if (!$this->anonymized && isset($this->obj_id) && $this->obj_id > 0) {
             $olp = ilObjectLP::getInstance($this->obj_id);
             $this->anonymized = $olp->isAnonymized();
         }
 
         /*
          * BT 35453: parent constructor needs to be called after $this->anonymized
          * is set, in order for getSelectableUserColumns to also properly return
          * user defined fields (e.g. firstname, lastname, and other user data).
          */
         parent::__construct($a_parent_obj, $a_parent_cmd, $a_template_context);
 
         // country names
         $this->lng->loadLanguageModule("meta");
     }

Here is the call graph for this function:

Member Function Documentation

◆ addToClipboard()

ilLPTableBaseGUI::addToClipboard ( )

protected

Add selected users to clipboard.

Definition at line 1192 of file class.ilLPTableBaseGUI.php.

References ilUserClipboard\getInstance(), initUidFromPost(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by executeCommand().

                                        : void
     {
         $users = $this->initUidFromPost();
         $clip = ilUserClipboard::getInstance($this->user->getId());
         $clip->add($users);
         $clip->save();
         $this->lng->loadLanguageModule('user');
         $this->main_tpl->setOnScreenMessage(
             'success',
             $this->lng->txt(
                 'clipboard_user_added'
             ),
             true
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ anonymizeValue()

ilLPTableBaseGUI::anonymizeValue	(		$a_value,
		bool	$a_force_number = `false`
	)

protected

Parameters

mixed	$a_value
false	$a_force_number

Returns: mixed

Definition at line 947 of file class.ilLPTableBaseGUI.php.

     {
         // currently inactive
         return $a_value;
     }

Here is the caller graph for this function:

◆ buildPath()

ilLPTableBaseGUI::buildPath ( array $ref_ids )

protected

Definition at line 469 of file class.ilLPTableBaseGUI.php.

References ilTableGUI\$data, $path, and $ref_id.

Referenced by ilLPProgressTableGUI\fillRow(), and ilTrSummaryTableGUI\fillRow().

                                                 : array
     {
         if (!count($ref_ids)) {
             return [];
         }
         $result = [];
         foreach ($ref_ids as $ref_id) {
             $path = "...";
             $counter = 0;
             $path_full = $this->tree->getPathFull($ref_id);
             foreach ($path_full as $data) {
                 if (++$counter < (count($path_full) - 1)) {
                     continue;
                 }
                 $path .= " &raquo; ";
                 if ($ref_id != $data['ref_id']) {
                     $path .= $data['title'];
                 } else {
                     $path .= ('<a target="_top" href="' .
                         ilLink::_getLink(
                             $data['ref_id'],
                             $data['type']
                         ) . '">' .
                         $data['title'] . '</a>');
                 }
             }
 
             $result[$ref_id] = $path;
         }
         return $result;
     }

Here is the caller graph for this function:

◆ buildValueScale()

ilLPTableBaseGUI::buildValueScale	(	int	$a_max_value,
		bool	$a_anonymize = `false`,
		bool	$a_format_seconds = `false`
	)

protected

Definition at line 953 of file class.ilLPTableBaseGUI.php.

References ilTableGUI\$base, anonymizeValue(), and formatSeconds().

Referenced by ilLPObjectStatisticsDailyTableGUI\getGraph(), ilLPObjectStatisticsTableGUI\getGraph(), and ilLPObjectStatisticsLPTableGUI\getGraph().

      : array {
         $step = 0;
         if ($a_max_value) {
             $step = $a_max_value / 10;
             $base = ceil(log($step, 10));
             $fac = ceil($step / pow(10, ($base - 1)));
             $step = pow(10, $base - 1) * $fac;
         }
         if ($step <= 1) {
             $step = 1;
         }
         $ticks = range(0, $a_max_value + $step, $step);
 
         $value_ticks = array(0 => 0);
         foreach ($ticks as $tick) {
             $value = $tvalue = $tick;
             if ($a_anonymize) {
                 $value = $this->anonymizeValue($value, true);
                 $tvalue = $this->anonymizeValue($tvalue);
             }
             if ($a_format_seconds) {
                 $tvalue = $this->formatSeconds($value);
             }
             $value_ticks[$value] = $tvalue;
         }
 
         return $value_ticks;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilLPTableBaseGUI::executeCommand ( )

Definition at line 105 of file class.ilLPTableBaseGUI.php.

References addToClipboard(), ILIAS\Repository\ctrl(), ilTable2GUI\determineOffsetAndOrder(), ilTable2GUI\determineSelectedFilters(), ilTable2GUI\getFilterItemByPostVar(), ilTable2GUI\getOffset(), ILIAS\FileDelivery\http(), initItemIdFromPost(), initUidFromPost(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilTable2GUI\resetFilter(), ilTable2GUI\resetOffset(), sendMail(), ilTable2GUI\storeNavParameter(), ilTable2GUI\storeProperty(), and ilTable2GUI\writeFilterToSession().

                                     : bool
     {
         $this->determineSelectedFilters();
         if (!$this->ctrl->getNextClass($this)) {
             $to_hide = false;
 
             switch ($this->ctrl->getCmd()) {
                 case "applyFilter":
                     $this->resetOffset();
                     $this->writeFilterToSession();
                     $this->storeProperty("offset", "0");
                     break;
 
                 case "resetFilter":
                     $this->resetOffset();
                     $this->resetFilter();
                     $this->storeProperty("offset", "0");
                     break;
 
                 case "hideSelected":
                     $to_hide = $this->initItemIdFromPost();
                     break;
 
                 case "hide":
                     $hide = 0;
                     if ($this->http->wrapper()->query()->has('hide')) {
                         $hide = $this->http->wrapper()->query()->retrieve(
                             'hide',
                             $this->refinery->kindlyTo()->int()
                         );
                     }
                     $to_hide = [$hide];
                     break;
 
                 case "mailselectedusers":
                     if (!$this->initUidFromPost()) {
                         $this->main_tpl->setOnScreenMessage(
                             'failure',
                             $this->lng->txt(
                                 "no_checkbox"
                             ),
                             true
                         );
                     } else {
                         $this->sendMail(
                             $this->initUidFromPost(),
                             $this->parent_obj,
                             $this->parent_cmd
                         );
                     }
                     break;
 
                 case 'addToClipboard':
                     if (!$this->initUidFromPost()) {
                         $this->main_tpl->setOnScreenMessage(
                             'failure',
                             $this->lng->txt(
                                 'no_checkbox'
                             ),
                             true
                         );
                     } else {
                         $this->addToClipboard();
                     }
                     break;
 
                     // page selector
                 default:
                     $this->determineOffsetAndOrder();
                     $this->storeNavParameter();
                     $this->storeProperty("offset", (string) $this->getOffset());
                     break;
             }
 
             if ($to_hide) {
                 $obj = $this->getFilterItemByPostVar("hide");
                 $value = array_unique(
                     array_merge((array) $obj->getValue(), $to_hide)
                 );
                 $obj->setValue($value);
                 $obj->writeToSession();
             }
 
             if ($this->requested_tmpl_create !== "") {
                 $this->ctrl->setParameter(
                     $this->parent_obj,
                     "tbltplcrt",
                     $this->requested_tmpl_create
                 );
             }
             if ($this->requested_tmpl_delete !== "") {
                 $this->ctrl->setParameter(
                     $this->parent_obj,
                     "tbltpldel",
                     $this->requested_tmpl_delete
                 );
             }
             $this->ctrl->redirect($this->parent_obj, $this->parent_cmd);
         } else {
             // e.g. repository selector
             return parent::executeCommand();
         }
         return true;
     }

Here is the call graph for this function:

◆ fillMetaCSV()

ilLPTableBaseGUI::fillMetaCSV ( ilCSVWriter $a_csv )

protected

Definition at line 884 of file class.ilLPTableBaseGUI.php.

References ilCSVWriter\addColumn(), ilCSVWriter\addRow(), and getExportMeta().

                                                       : void
     {
         foreach ($this->getExportMeta() as $caption => $value) {
             $a_csv->addColumn(strip_tags($caption));
             $a_csv->addColumn(strip_tags($value));
             $a_csv->addRow();
         }
         $a_csv->addRow();
     }

Here is the call graph for this function:

◆ fillMetaExcel()

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

protected

Definition at line 874 of file class.ilLPTableBaseGUI.php.

References getExportMeta(), and ilExcel\setCell().

                                                                    : void
     {
         foreach ($this->getExportMeta() as $caption => $value) {
             $a_excel->setCell($a_row, 0, $caption);
             $a_excel->setCell($a_row, 1, $value);
             $a_row++;
         }
         $a_row++;
     }

Here is the call graph for this function:

◆ findReferencesForObjId()

ilLPTableBaseGUI::findReferencesForObjId ( int $a_obj_id )

protected

Returns: int[]

Definition at line 213 of file class.ilLPTableBaseGUI.php.

References ilObject\_getAllReferences().

Referenced by ilLPObjectStatisticsDailyTableGUI\getItems(), and ilLPObjectStatisticsLPTableGUI\getItems().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ formatSeconds()

ilLPTableBaseGUI::formatSeconds	(	int	$seconds,
		bool	$a_shorten_zero = `false`
	)

protected

Definition at line 920 of file class.ilLPTableBaseGUI.php.

Referenced by buildValueScale(), ilLPObjectStatisticsDailyTableGUI\fillRow(), and ilLPObjectStatisticsTableGUI\fillRow().

      : string {
         $seconds = ($seconds > 0) ? $seconds : 0;
         if ($a_shorten_zero && !$seconds) {
             return "-";
         }
 
         $hours = floor($seconds / 3600);
         $rest = $seconds % 3600;
 
         $minutes = floor($rest / 60);
         $rest = $rest % 60;
 
         if ($rest) {
             $minutes++;
         }
 
         return sprintf("%dh%02dm", $hours, $minutes);
     }

Here is the caller graph for this function:

◆ getCurrentFilter()

ilLPTableBaseGUI::getCurrentFilter ( bool $as_query = false )

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

References ilTable2GUI\$id, ILIAS\Repository\filter(), ilTable2GUI\getFilterItemByPostVar(), and IL_CAL_DATETIME.

Referenced by ilLPProgressTableGUI\getItems(), ilTrObjectUsersPropsTableGUI\getItems(), ilLPObjectStatisticsTableGUI\getItems(), ilLPObjectStatisticsDailyTableGUI\getItems(), ilLPObjectStatisticsLPTableGUI\getItems(), ilTrSummaryTableGUI\getItems(), and initBaseFilter().

                                                             : array
     {
         $result = array();
         foreach ($this->filter as $id => $value) {
             $item = $this->getFilterItemByPostVar($id);
             switch ($id) {
                 case "title":
                 case "country":
                 case "gender":
                 case "city":
                 case "language":
                 case "login":
                 case "firstname":
                 case "lastname":
                 case "mark":
                 case "u_comment":
                 case "institution":
                 case "department":
                 case "street":
                 case "zipcode":
                 case "email":
                 case "matriculation":
                 case "sel_country":
                 case "query":
                 case "type":
                 case "area":
                     if ($value) {
                         $result[$id] = $value;
                     }
                     break;
 
                 case "status":
                     if (!is_null($value) && $value !== "") {
                         $result[$id] = $value;
                     }
                     break;
 
                 case "user_total":
                 case "read_count":
                 case "percentage":
                 case "hide":
                 case "spent_seconds":
                     if (is_array($value) && implode("", $value)) {
                         $result[$id] = $value;
                     }
                     break;
 
                 case "registration":
                 case "create_date":
                 case "first_access":
                 case "last_access":
                 case 'status_changed':
                     if ($value) {
                         if ($value["from"]) {
                             $result[$id]["from"] = $value["from"]->get(
                                 IL_CAL_DATETIME
                             );
                         }
                         if ($value["to"]) {
                             $result[$id]["to"] = $value["to"]->get(
                                 IL_CAL_DATETIME
                             );
                         }
                     }
                     break;
 
                 case "birthday":
                     if ($value) {
                         if ($value["from"]) {
                             $result[$id]["from"] = $value["from"]->get(
                                 IL_CAL_DATETIME
                             );
                             $result[$id]["from"] = substr(
                                 $result[$id]["from"],
                                 0,
                                 -8
                             ) . "00:00:00";
                         }
                         if ($value["to"]) {
                             $result[$id]["to"] = $value["to"]->get(
                                 IL_CAL_DATETIME
                             );
                             $result[$id]["to"] = substr(
                                 $result[$id]["to"],
                                 0,
                                 -8
                             ) . "23:59:59";
                         }
                     }
                     break;
             }
         }
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExportMeta()

ilLPTableBaseGUI::getExportMeta ( )

protected

Build export meta data.

Definition at line 820 of file class.ilLPTableBaseGUI.php.

References ilTableGUI\$data, $DIC, ilObjUser\_lookupFullname(), ilObject\_lookupOwner(), ilObject\_lookupType(), ilDatePresentation\formatDate(), IL_CAL_UNIX, ILIAS\Repository\lng(), ilDatePresentation\setUseRelativeDates(), and ILIAS\Repository\user().

Referenced by fillMetaCSV(), and fillMetaExcel().

                                       : array
     {
         global $DIC;
 
         $ilClientIniFile = $DIC['ilClientIniFile'];
 
         /* see spec
             Name of installation
             Name of the course
             Permalink to course
             Owner of course object
             Date of report generation
             Reporting period
             Name of person who generated the report.
         */
 
         ilDatePresentation::setUseRelativeDates(false);
 
         $data = array();
         $data[$this->lng->txt(
             "trac_name_of_installation"
         )] = $ilClientIniFile->readVariable('client', 'name');
 
         if ($this->obj_id) {
             $data[$this->lng->txt(
                 "trac_object_name"
             )] = $this->ilObjDataCache->lookupTitle((int) $this->obj_id);
             if ($this->ref_id) {
                 $data[$this->lng->txt("trac_object_link")] = ilLink::_getLink(
                     $this->ref_id,
                     ilObject::_lookupType($this->obj_id)
                 );
             }
             $data[$this->lng->txt(
                 "trac_object_owner"
             )] = ilObjUser::_lookupFullname(
                 ilObject::_lookupOwner($this->obj_id)
             );
         }
 
         $data[$this->lng->txt(
             "trac_report_date"
         )] = ilDatePresentation::formatDate(
             new ilDateTime(
                 time(),
                 IL_CAL_UNIX
             )
         );
         $data[$this->lng->txt("trac_report_owner")] = $this->user->getFullName(
         );
 
         return $data;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIconVariant()

ilLPTableBaseGUI::getIconVariant ( )

Gets the variant of LP icons that is shown in the table.

Definition at line 1211 of file class.ilLPTableBaseGUI.php.

References $icon_variant.

Referenced by parseValue().

                                     : int
     {
         return $this->icon_variant;
     }

Here is the caller graph for this function:

◆ getMonthsFilter()

ilLPTableBaseGUI::getMonthsFilter ( $a_short = false )

protected

Definition at line 986 of file class.ilLPTableBaseGUI.php.

References ILIAS\Repository\lng().

Referenced by ilLPObjectStatisticsTableGUI\initFilter(), ilLPObjectStatisticsDailyTableGUI\initFilter(), and ilLPObjectStatisticsLPTableGUI\initFilter().

                                                         : array
     {
         $options = array();
         for ($loop = 0; $loop < 10; $loop++) {
             $year = date("Y") - $loop;
             $options[$year] = $year;
             for ($loop2 = 12; $loop2 > 0; $loop2--) {
                 $month = str_pad($loop2, 2, "0", STR_PAD_LEFT);
                 if ($year . $month <= date("Ym")) {
                     if (!$a_short) {
                         $caption = $year . " / " . $this->lng->txt(
                             "month_" . $month . "_long"
                         );
                     } else {
                         $caption = $year . "/" . $month;
                     }
                     $options[$year . "-" . $month] = $caption;
                 }
             }
         }
         return $options;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMonthsYear()

ilLPTableBaseGUI::getMonthsYear	(	$a_year = `null`,
		$a_short = `false`
	)

protected

Definition at line 1009 of file class.ilLPTableBaseGUI.php.

References ILIAS\Repository\lng().

                                                                       : array
     {
         if (!$a_year) {
             $a_year = date("Y");
         }
 
         $all = array();
         for ($loop = 1; $loop < 13; $loop++) {
             $month = str_pad($loop, 2, "0", STR_PAD_LEFT);
             if ($a_year . "-" . $month <= date("Y-m")) {
                 if (!$a_short) {
                     $caption = $this->lng->txt("month_" . $month . "_long");
                 } else {
                     $caption = $this->lng->txt("month_" . $month . "_short");
                 }
                 $all[$a_year . "-" . $month] = $caption;
             }
         }
         return $all;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPossibleTypes()

ilLPTableBaseGUI::getPossibleTypes	(	bool	$a_split_learning_resources = `false`,
		bool	$a_include_digilib = `false`,
		bool	$a_allow_undefined_lp = `false`
	)

protected

Definition at line 501 of file class.ilLPTableBaseGUI.php.

References $DIC, ilRepositoryObjectPluginSlot\isTypePluginWithLP(), ILIAS\Repository\lng(), and ilObjectPlugin\lookupTxtById().

Referenced by initBaseFilter(), ilLPObjectStatisticsTableGUI\initFilter(), and ilLPObjectStatisticsDailyTableGUI\initFilter().

      : array {
         global $DIC;
 
         $component_repository = $DIC['component.repository'];
 
         $options = array();
 
         if ($a_split_learning_resources) {
             $options['lm'] = $this->lng->txt('objs_lm');
             $options['sahs'] = $this->lng->txt('objs_sahs');
             $options['htlm'] = $this->lng->txt('objs_htlm');
         } else {
             $options['lres'] = $this->lng->txt('obj_lrss');
         }
 
         $options['crs'] = $this->lng->txt('objs_crs');
         $options['grp'] = $this->lng->txt('objs_grp');
         $options['exc'] = $this->lng->txt('objs_exc');
         $options['file'] = $this->lng->txt('objs_file');
         $options['mcst'] = $this->lng->txt('objs_mcst');
         $options['svy'] = $this->lng->txt('objs_svy');
         $options['tst'] = $this->lng->txt('objs_tst');
         $options['prg'] = $this->lng->txt('objs_prg');
         $options['iass'] = $this->lng->txt('objs_iass');
         $options['copa'] = $this->lng->txt('objs_copa');
         $options['frm'] = $this->lng->txt('objs_frm');
         $options['cmix'] = $this->lng->txt('objs_cmix');
         $options['lti'] = $this->lng->txt('objs_lti');
         $options['lso'] = $this->lng->txt('objs_lso');
         $options['dcl'] = $this->lng->txt('objs_dcl');
 
         if ($a_allow_undefined_lp) {
             $options['root'] = $this->lng->txt('obj_reps');
             $options['cat'] = $this->lng->txt('objs_cat');
             $options["webr"] = $this->lng->txt("objs_webr");
             $options["wiki"] = $this->lng->txt("objs_wiki");
             $options["blog"] = $this->lng->txt("objs_blog");
             $options["prtf"] = $this->lng->txt("objs_prtf");
             $options["prtt"] = $this->lng->txt("objs_prtt");
         }
 
         // repository plugins (currently only active)
         $plugins = $component_repository->getPluginSlotById(
             "robj"
         )->getActivePlugins();
         foreach ($plugins as $pl) {
             $pl_id = $pl->getId();
             if (ilRepositoryObjectPluginSlot::isTypePluginWithLP($pl_id)) {
                 $options[$pl_id] = ilObjectPlugin::lookupTxtById(
                     $pl_id,
                     "objs_" . $pl_id
                 );
             }
         }
 
         asort($options);
         return $options;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectableUserColumns()

ilLPTableBaseGUI::getSelectableUserColumns	(	int	$a_in_course = `0`,
		int	$a_in_group = `0`
	)

protected

Definition at line 1030 of file class.ilLPTableBaseGUI.php.

References Vendor\Package\$f, ilUserDefinedFields\_getInstance(), ilObjUserTracking\EXTENDED_DATA_LAST_ACCESS, ilObjUserTracking\EXTENDED_DATA_READ_COUNT, ilObjUserTracking\EXTENDED_DATA_SPENT_SECONDS, ilObjectLP\getInstance(), ilPrivacySettings\getInstance(), isPercentageAvailable(), ILIAS\Repository\lng(), ilObjectLP\supportsMark(), ilObjectLP\supportsSpentSeconds(), and UDF_TYPE_WYSIWYG.

Referenced by ilTrObjectUsersPropsTableGUI\getSelectableColumns(), and ilTrMatrixTableGUI\getSelectableColumns().

      : array {
         $cols = $privacy_fields = array();
 
         $up = new ilUserProfile();
         $up->skipGroup("preferences");
         $up->skipGroup("settings");
         $up->skipGroup("interests");
         $ufs = $up->getStandardFields();
 
         // default fields
         $cols["login"] = array(
             "txt" => $this->lng->txt("login"),
             "default" => true
         );
 
         if (!$this->anonymized) {
             $cols["firstname"] = array(
                 "txt" => $this->lng->txt("firstname"),
                 "default" => true
             );
             $cols["lastname"] = array(
                 "txt" => $this->lng->txt("lastname"),
                 "default" => true
             );
         }
 
         // show only if extended data was activated in lp settings
         $tracking = new ilObjUserTracking();
         if ($tracking->hasExtendedData(
             ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS
         )) {
             $cols["first_access"] = array(
                 "txt" => $this->lng->txt("trac_first_access"),
                 "default" => true
             );
             $cols["last_access"] = array(
                 "txt" => $this->lng->txt("trac_last_access"),
                 "default" => true
             );
         }
         if ($tracking->hasExtendedData(
             ilObjUserTracking::EXTENDED_DATA_READ_COUNT
         )) {
             $cols["read_count"] = array(
                 "txt" => $this->lng->txt("trac_read_count"),
                 "default" => true
             );
         }
         if ($tracking->hasExtendedData(
             ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS
         ) &&
             ilObjectLP::supportsSpentSeconds($this->type)) {
             $cols["spent_seconds"] = array(
                 "txt" => $this->lng->txt("trac_spent_seconds"),
                 "default" => true
             );
         }
 
         if ($this->isPercentageAvailable($this->obj_id)) {
             $cols["percentage"] = array(
                 "txt" => $this->lng->txt("trac_percentage"),
                 "default" => true
             );
         }
 
         // do not show status if learning progress is deactivated
         $olp = ilObjectLP::getInstance($this->obj_id);
         if ($olp->isActive()) {
             $cols["status"] = array(
                 "txt" => $this->lng->txt("trac_status"),
                 "default" => true
             );
 
             $cols['status_changed'] = array(
                 'txt' => $this->lng->txt('trac_status_changed'),
                 'default' => false
             );
         }
 
         if (ilObjectLP::supportsMark($this->type)) {
             $cols["mark"] = array(
                 "txt" => $this->lng->txt("trac_mark"),
                 "default" => true
             );
         }
 
         $cols["u_comment"] = array(
             "txt" => $this->lng->txt("trac_comment"),
             "default" => false
         );
 
         $cols["create_date"] = array(
             "txt" => $this->lng->txt("create_date"),
             "default" => false
         );
         $cols["language"] = array(
             "txt" => $this->lng->txt("language"),
             "default" => false
         );
 
         // add user data only if object is [part of] course
         if (!$this->anonymized &&
             ($a_in_course || $a_in_group)) {
             // only show if export permission is granted
             if (ilPrivacySettings::getInstance()->checkExportAccess(
                 $a_in_group === 0 ? $a_in_course : $a_in_group
             )) {
                 // other user profile fields
                 foreach ($ufs as $f => $fd) {
                     if (!isset($cols[$f]) && $f != "username" && !($fd["lists_hide"] ?? false)) {
                         if ($a_in_course &&
                             !(($fd["course_export_fix_value"] ?? false) || $this->setting->get(
                                 "usr_settings_course_export_" . $f
                             ))) {
                             continue;
                         }
                         if ($a_in_group &&
                             !(($fd["group_export_fix_value"] ?? false) || $this->setting->get(
                                 "usr_settings_group_export_" . $f
                             ))) {
                             continue;
                         }
 
                         $cols[$f] = array(
                             "txt" => $this->lng->txt($f),
                             "default" => false
                         );
                         $privacy_fields[] = $f;
                     }
                 }
 
                 // additional defined user data fields
                 $user_defined_fields = ilUserDefinedFields::_getInstance();
                 if ($a_in_course) {
                     $user_defined_fields = $user_defined_fields->getCourseExportableFields(
                     );
                 } else {
                     $user_defined_fields = $user_defined_fields->getGroupExportableFields(
                     );
                 }
                 foreach ($user_defined_fields as $definition) {
                     if ($definition["field_type"] != UDF_TYPE_WYSIWYG) {
                         $f = "udf_" . $definition["field_id"];
                         $cols[$f] = array(
                             "txt" => $definition["field_name"],
                             "default" => false
                         );
 
                         $privacy_fields[] = $f;
                     }
                 }
             }
         }
         return array($cols, $privacy_fields);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initBaseFilter()

ilLPTableBaseGUI::initBaseFilter	(	bool	$a_split_learning_resources = `false`,
		bool	$a_include_no_status_filter = `true`
	)

Init filter.

Definition at line 387 of file class.ilLPTableBaseGUI.php.

References ilTable2GUI\addFilterItem(), ILIAS\Repository\filter(), getCurrentFilter(), getPossibleTypes(), ILIAS\Repository\lng(), ilTable2GUI\setDisableFilterHiding(), ilSelectInputGUI\setOptions(), and ilRepositorySelectorInputGUI\setSelectText().

Referenced by ilLPProgressTableGUI\__construct().

       {
         $this->setDisableFilterHiding(true);
 
         // object type selection
         $si = new ilSelectInputGUI($this->lng->txt("obj_type"), "type");
         $si->setOptions($this->getPossibleTypes($a_split_learning_resources));
         $this->addFilterItem($si);
         $si->readFromSession();
         if (!$si->getValue()) {
             $si->setValue("crs");
         }
         $this->filter["type"] = $si->getValue();
 
         // hidden items
         $msi = new ilMultiSelectInputGUI(
             $this->lng->txt("trac_filter_hidden"),
             "hide"
         );
         $this->addFilterItem($msi);
         $msi->readFromSession();
         $this->filter["hide"] = $msi->getValue();
         if ($this->filter["hide"]) {
             // create options from current value
             $types = $this->getCurrentFilter(true);
             $type = $types["type"];
             $options = array();
             if ($type == 'lres') {
                 $type = array('lm', 'sahs', 'htlm');
             } else {
                 $type = array($type);
             }
             foreach ($this->filter["hide"] as $obj_id) {
                 if (in_array(
                     $this->ilObjDataCache->lookupType((int) $obj_id),
                     $type
                 )) {
                     $options[$obj_id] = $this->ilObjDataCache->lookupTitle(
                         (int) $obj_id
                     );
                 }
             }
             $msi->setOptions($options);
         }
 
         // 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();
 
         // repository area selection
         $rs = new ilRepositorySelectorInputGUI(
             $this->lng->txt("trac_filter_area"),
             "area"
         );
         $rs->setSelectText($this->lng->txt("trac_select_area"));
         $this->addFilterItem($rs);
         $rs->readFromSession();
         $this->filter["area"] = $rs->getValue();
 
         // hide "not started yet"
         if ($a_include_no_status_filter) {
             $cb = new ilCheckboxInputGUI(
                 $this->lng->txt("trac_filter_has_status"),
                 "status"
             );
             $this->addFilterItem($cb);
             $cb->readFromSession();
             $this->filter["status"] = $cb->getChecked();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initItemIdFromPost()

ilLPTableBaseGUI::initItemIdFromPost ( )

protected

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

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by executeCommand().

                                            : array
     {
         if ($this->http->wrapper()->post()->has('item_id')) {
             return $this->http->wrapper()->post()->retrieve(
                 'item_id',
                 $this->refinery->kindlyTo()->listOf(
                     $this->refinery->kindlyTo()->int()
                 )
             );
         }
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initRepositoryFilter()

ilLPTableBaseGUI::initRepositoryFilter ( array $filter )

protected

Definition at line 363 of file class.ilLPTableBaseGUI.php.

References $filter, ilTable2GUI\addFilterItem(), ILIAS\Repository\int(), isForwardingToFormDispatcher(), and ILIAS\Repository\lng().

Referenced by ilLPObjectStatisticsTableGUI\initFilter(), ilLPObjectStatisticsDailyTableGUI\initFilter(), and ilLPObjectStatisticsLPTableGUI\initFilter().

                                                           : array
     {
         $repo = new ilRepositorySelector2InputGUI(
             $this->lng->txt('trac_filter_area'),
             'effective_from',
             false,
             ($this->isForwardingToFormDispatcher()) ? $this : null
         );
         $white_list = [];
         foreach ($this->objDefinition->getAllRepositoryTypes() as $type) {
             if ($this->objDefinition->isContainer($type)) {
                 $white_list[] = $type;
             }
         }
         $repo->getExplorerGUI()->setTypeWhiteList($white_list);
         $this->addFilterItem($repo);
         $repo->readFromSession();
         $filter['area'] = (int) $repo->getValue();
         return $filter;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUidFromPost()

ilLPTableBaseGUI::initUidFromPost ( )

protected

Definition at line 92 of file class.ilLPTableBaseGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by addToClipboard(), and executeCommand().

                                         : array
     {
         if ($this->http->wrapper()->post()->has('uid')) {
             return $this->http->wrapper()->post()->retrieve(
                 'uid',
                 $this->refinery->kindlyTo()->listOf(
                     $this->refinery->kindlyTo()->int()
                 )
             );
         }
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isForwardingToFormDispatcher()

ilLPTableBaseGUI::isForwardingToFormDispatcher ( )

protected

Definition at line 358 of file class.ilLPTableBaseGUI.php.

Referenced by initRepositoryFilter().

                                                      : bool
     {
         return false;
     }

Here is the caller graph for this function:

◆ isPercentageAvailable()

ilLPTableBaseGUI::isPercentageAvailable ( int $a_obj_id )

protected

Definition at line 753 of file class.ilLPTableBaseGUI.php.

Referenced by ilTrUserObjectsPropsTableGUI\fillRow(), ilTrSummaryTableGUI\fillRow(), ilLPProgressTableGUI\fillRowCSV(), ilLPProgressTableGUI\fillRowExcel(), ilLPProgressTableGUI\getItems(), ilTrMatrixTableGUI\getItems(), ilTrSummaryTableGUI\getItems(), ilTrSummaryTableGUI\getSelectableColumns(), getSelectableUserColumns(), and ilTrSummaryTableGUI\initFilter().

                                                            : bool
     {
         if ($a_obj_id === 0) {
             return false;
         }
         $olp = ilObjectLP::getInstance($a_obj_id);
         $mode = $olp->getCurrentMode();
         if (in_array(
             $mode,
             array(ilLPObjSettings::LP_MODE_TLT,
                          ilLPObjSettings::LP_MODE_VISITS,
                          ilLPObjSettings::LP_MODE_SCORM,
                          ilLPObjSettings::LP_MODE_LTI_OUTCOME,
                          ilLPObjSettings::LP_MODE_CMIX_COMPLETED,
                          ilLPObjSettings::LP_MODE_CMIX_COMPL_WITH_FAILED,
                          ilLPObjSettings::LP_MODE_CMIX_PASSED,
                          ilLPObjSettings::LP_MODE_CMIX_PASSED_WITH_FAILED,
                          ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED,
                          ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED,
                          ilLPObjSettings::LP_MODE_VISITED_PAGES,
                          ilLPObjSettings::LP_MODE_TEST_PASSED
         )
         )) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseTitle()

ilLPTableBaseGUI::parseTitle	(	int	$a_obj_id,
		string	$action,
		int	$a_user_id = `0`
	)

protected

Definition at line 781 of file class.ilLPTableBaseGUI.php.

References $DIC, $user, ilObjectLP\getInstance(), ilObjectFactory\getInstanceByObjId(), ILIAS\Repository\lng(), ROOT_FOLDER_ID, ilTable2GUI\setDescription(), ilTable2GUI\setTitle(), and ILIAS\Repository\user().

Referenced by ilTrUserObjectsPropsTableGUI\__construct(), ilTrSummaryTableGUI\__construct(), ilTrMatrixTableGUI\__construct(), and ilTrObjectUsersPropsTableGUI\__construct().

       {
         global $DIC;
 
         $user = "";
         if ($a_user_id) {
             if ($a_user_id != $this->user->getId()) {
                 $a_user = ilObjectFactory::getInstanceByObjId($a_user_id);
             } else {
                 $a_user = $this->user;
             }
             $user .= ", " . $a_user->getFullName(
             ); // " [".$a_user->getLogin()."]";
         }
 
         if ($a_obj_id != ROOT_FOLDER_ID) {
             $this->setTitle(
                 $this->lng->txt(
                     $action
                 ) . ": " . $this->ilObjDataCache->lookupTitle($a_obj_id) . $user
             );
 
             $olp = ilObjectLP::getInstance($a_obj_id);
             $this->setDescription(
                 $this->lng->txt('trac_mode') . ": " . $olp->getModeText(
                     $olp->getCurrentMode()
                 )
             );
         } else {
             $this->setTitle($this->lng->txt($action));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseValue()

ilLPTableBaseGUI::parseValue	(	string	$id,
		?string	$value,
		string	$type
	)

protected

Definition at line 564 of file class.ilLPTableBaseGUI.php.

References ilDatePresentation\formatDate(), getIconVariant(), ilLPStatusIcons\getInstance(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_UNIX, ILIAS\Repository\lng(), ilDatePresentation\secondsToString(), ilObjectLP\supportsMark(), and ilObjectLP\supportsSpentSeconds().

Referenced by ilTrObjectUsersPropsTableGUI\fillRow(), ilTrMatrixTableGUI\fillRow(), ilTrObjectUsersPropsTableGUI\fillRowCSV(), ilTrUserObjectsPropsTableGUI\fillRowCSV(), ilTrMatrixTableGUI\fillRowCSV(), ilTrObjectUsersPropsTableGUI\fillRowExcel(), ilTrUserObjectsPropsTableGUI\fillRowExcel(), and ilTrMatrixTableGUI\fillRowExcel().

      : string {
         // get rid of aggregation
         $pos = strrpos($id, "_");
         if ($pos !== false) {
             $function = strtoupper(substr($id, $pos + 1));
             if (in_array(
                 $function,
                 array("MIN", "MAX", "SUM", "AVG", "COUNT")
             )) {
                 $id = substr($id, 0, $pos);
             }
         }
 
         if ((trim((string) $value) == "") && $id != "status") {
             if ($id == "title" &&
                 get_class($this) != "ilTrObjectUsersPropsTableGUI" &&
                 get_class($this) != "ilTrMatrixTableGUI") {
                 return "--" . $this->lng->txt("none") . "--";
             }
             return " ";
         }
 
         switch ($id) {
             case "first_access":
             case "create_date":
             case 'status_changed':
                 $value = ilDatePresentation::formatDate(
                     new ilDateTime($value, IL_CAL_DATETIME)
                 );
                 break;
 
             case "last_access":
                 $value = ilDatePresentation::formatDate(
                     new ilDateTime($value, IL_CAL_UNIX)
                 );
                 break;
 
             case "birthday":
                 $value = ilDatePresentation::formatDate(
                     new ilDate($value, IL_CAL_DATE)
                 );
                 break;
 
             case "spent_seconds":
                 if (!ilObjectLP::supportsSpentSeconds($type)) {
                     $value = "-";
                 } else {
                     $value = ilDatePresentation::secondsToString(
                         (int) $value,
                         ((int) $value < 3600 ? true : false)
                     ); // #14858
                 }
                 break;
 
             case "percentage":
                 if (false /* $this->isPercentageAvailable() */) {
                     $value = "-";
                 } else {
                     $value = $value . "%";
                 }
                 break;
 
             case "mark":
                 if (!ilObjectLP::supportsMark($type)) {
                     $value = "-";
                 }
                 break;
 
             case "gender":
                 $value = $this->lng->txt("gender_" . $value);
                 break;
 
             case "status":
                 $icons = ilLPStatusIcons::getInstance($this->getIconVariant());
                 $value = $icons->renderIconForStatus((int) $value);
                 break;
 
             case "language":
                 $this->lng->loadLanguageModule("meta");
                 $value = $this->lng->txt("meta_l_" . $value);
                 break;
 
             case "sel_country":
                 $value = $this->lng->txt("meta_c_" . $value);
                 break;
         }
 
         return $value ?? '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ searchFilterListener()

ilLPTableBaseGUI::searchFilterListener	(	int	$a_ref_id,
		array	$a_data
	)

Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED public.

Definition at line 340 of file class.ilLPTableBaseGUI.php.

References ILIAS\Repository\filter(), and ilObjectLP\getInstance().

                                                                       : bool
     {
         if (is_array($this->filter["hide"]) && in_array(
             $a_data["obj_id"],
             $this->filter["hide"]
         )) {
             return false;
         }
         $olp = ilObjectLP::getInstance($a_data["obj_id"]);
         if (get_class(
             $olp
         ) != "ilObjectLP" && // #13654 - LP could be unsupported
             !$olp->isActive()) {
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ searchObjects()

ilLPTableBaseGUI::searchObjects	(	array	$filter,
		string	$permission,
		?array	$preset_obj_ids = `null`,
		bool	$a_check_lp_activation = `true`
	)

protected

Search objects that match current filters.

Definition at line 281 of file class.ilLPTableBaseGUI.php.

References $res, ILIAS\Repository\filter(), ilLoggerFactory\getLogger(), ilQueryParser\QP_COMBINATION_AND, and ROOT_FOLDER_ID.

Referenced by ilLPProgressTableGUI\getItems(), ilLPObjectStatisticsTableGUI\getItems(), ilLPObjectStatisticsDailyTableGUI\getItems(), ilLPObjectStatisticsLPTableGUI\getItems(), and ilTrSummaryTableGUI\getItems().

      : array {
         $query_parser = new ilQueryParser($filter["query"] ?? '');
         $query_parser->setMinWordLength(0);
         $query_parser->setCombination(ilQueryParser::QP_COMBINATION_AND);
         $query_parser->parse();
         if (!$query_parser->validate()) {
             ilLoggerFactory::getLogger('trac')->notice(
                 $query_parser->getMessage()
             );
             // echo $query_parser->getMessage();
             return [];
         }
 
         if ($filter["type"] == "lres") {
             $filter["type"] = array('lm', 'sahs', 'htlm');
         } else {
             $filter["type"] = array($filter["type"]);
         }
 
         $object_search = new ilLikeObjectSearch($query_parser);
         $object_search->setFilter($filter["type"]);
         if ($preset_obj_ids) {
             $object_search->setIdFilter($preset_obj_ids);
         }
         $res = $object_search->performSearch();
 
         if ($permission) {
             $res->setRequiredPermission($permission);
         }
 
         $res->setMaxHits(self::HIT_LIMIT);
 
         if ($a_check_lp_activation) {
             $res->addObserver($this, "searchFilterListener");
         }
 
         if (!$this->filter["area"]) {
             $res->filter(ROOT_FOLDER_ID, true);
         } else {
             $res->filter($this->filter["area"], true);
         }
 
         $objects = array();
         foreach ($res->getResults() as $obj_data) {
             $objects[$obj_data['obj_id']][] = $obj_data['ref_id'];
         }
         return $objects ?: array();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendMail()

ilLPTableBaseGUI::sendMail	(	array	$a_user_ids,
			$a_parent_obj,
		string	$a_parent_cmd
	)

protected

Definition at line 222 of file class.ilLPTableBaseGUI.php.

References $ref_id, ilObjUser\_lookupLogin(), ilObject\_lookupObjectId(), ilMailFormCall\CONTEXT_KEY, ilObjectLP\getInstance(), ilMailFormCall\getRedirectTarget(), ILIAS\FileDelivery\http(), ilUtil\redirect(), and ILIAS\Repository\refinery().

Referenced by executeCommand().

      : void {
         // see ilObjCourseGUI::sendMailToSelectedUsersObject()
 
         $rcps = array();
         foreach ($a_user_ids as $usr_id) {
             $rcps[] = ilObjUser::_lookupLogin($usr_id);
         }
 
         $template = array();
         $sig = null;
 
         $ref_id = 0;
         if ($this->http->wrapper()->query()->has('ref_id')) {
             $ref_id = $this->http->wrapper()->query()->retrieve(
                 'ref_id',
                 $this->refinery->kindlyTo()->int()
             );
         }
         // repository-object-specific
         if ($ref_id) {
             $obj_lp = ilObjectLP::getInstance(
                 ilObject::_lookupObjectId($ref_id)
             );
             $tmpl_id = $obj_lp->getMailTemplateId();
 
             if ($tmpl_id) {
                 $template = array(
                     ilMailFormCall::CONTEXT_KEY => $tmpl_id,
                     'ref_id' => $ref_id,
                     'ts' => time()
                 );
             } else {
                 $sig = ilLink::_getLink($ref_id);
                 $sig = rawurlencode(base64_encode($sig));
             }
         }
 
         ilUtil::redirect(
             ilMailFormCall::getRedirectTarget(
                 $a_parent_obj,
                 $a_parent_cmd,
                 array(),
                 array(
                     'type' => 'new',
                     'rcp_to' => implode(',', $rcps),
                     'sig' => $sig
                 ),
                 $template
             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIconVariant()

ilLPTableBaseGUI::setIconVariant ( int $variant )

Sets the variant of LP icons that is shown in the table.

Definition at line 1219 of file class.ilLPTableBaseGUI.php.

                                                 : void
     {
         $this->icon_variant = $variant;
     }

◆ showTimingsWarning()

ilLPTableBaseGUI::showTimingsWarning	(	int	$a_ref_id,
		int	$a_user_id
	)

protected

Parameters

int	$a_ref_id
int	$a_user_id

Returns: bool|mixed

Definition at line 899 of file class.ilLPTableBaseGUI.php.

References ilTimingCache\_getTimings(), and ilTimingCache\getInstanceByRefId().

Referenced by ilLPProgressTableGUI\fillRow(), ilTrUserObjectsPropsTableGUI\fillRow(), ilTrObjectUsersPropsTableGUI\fillRow(), and ilTrMatrixTableGUI\fillRow().

     {
         $timing_cache = ilTimingCache::getInstanceByRefId($a_ref_id);
         if ($timing_cache->isWarningRequired($a_user_id)) {
             $timings = ilTimingCache::_getTimings($a_ref_id);
             if (
                 $timings['item']['changeable'] &&
                 ($timings['user'][$a_user_id] ?? false) &&
                 $timings['user'][$a_user_id]['end']
             ) {
                 $end = $timings['user'][$a_user_id]['end'];
             } elseif ($timings['item']['suggestion_end']) {
                 $end = $timings['item']['suggestion_end'];
             } else {
                 $end = true;
             }
             return $end;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $anonymized

bool ilLPTableBaseGUI::$anonymized = true

protected

Definition at line 37 of file class.ilLPTableBaseGUI.php.

◆ $filter

array ilLPTableBaseGUI::$filter = []

protected

Definition at line 36 of file class.ilLPTableBaseGUI.php.

Referenced by ilTrSummaryTableGUI\getItems(), and initRepositoryFilter().

◆ $http

HttpService ilLPTableBaseGUI::$http

protected

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

◆ $icon_variant

int ilLPTableBaseGUI::$icon_variant = ilLPStatusIcons::ICON_VARIANT_LONG

protected

Definition at line 38 of file class.ilLPTableBaseGUI.php.

Referenced by getIconVariant().

◆ $ilObjDataCache

ilObjectDataCache ilLPTableBaseGUI::$ilObjDataCache

protected

Definition at line 41 of file class.ilLPTableBaseGUI.php.

◆ $main_tpl

ilGlobalTemplateInterface ilLPTableBaseGUI::$main_tpl

protected

Definition at line 44 of file class.ilLPTableBaseGUI.php.

◆ $objDefinition

ilObjectDefinition ilLPTableBaseGUI::$objDefinition

protected

Definition at line 42 of file class.ilLPTableBaseGUI.php.

◆ $refinery

RefineryFactory ilLPTableBaseGUI::$refinery

protected

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

◆ $setting

ilSetting ilLPTableBaseGUI::$setting

protected

Definition at line 40 of file class.ilLPTableBaseGUI.php.

◆ $tree

ilTree ilLPTableBaseGUI::$tree

protected

Definition at line 43 of file class.ilLPTableBaseGUI.php.

◆ $user

ilObjUser ilLPTableBaseGUI::$user

private

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

Referenced by ilLPProgressTableGUI\__construct(), and parseTitle().

◆ HIT_LIMIT

const ilLPTableBaseGUI::HIT_LIMIT = 5000

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

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

Services/Tracking/classes/class.ilLPTableBaseGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addToClipboard()

◆ anonymizeValue()

◆ buildPath()

◆ buildValueScale()

◆ executeCommand()

◆ fillMetaCSV()

◆ fillMetaExcel()

◆ findReferencesForObjId()

◆ formatSeconds()

◆ getCurrentFilter()

◆ getExportMeta()

◆ getIconVariant()

◆ getMonthsFilter()

◆ getMonthsYear()

◆ getPossibleTypes()

◆ getSelectableUserColumns()

◆ initBaseFilter()

◆ initItemIdFromPost()

◆ initRepositoryFilter()

◆ initUidFromPost()

◆ isForwardingToFormDispatcher()

◆ isPercentageAvailable()

◆ parseTitle()

◆ parseValue()

◆ searchFilterListener()

◆ searchObjects()

◆ sendMail()

◆ setIconVariant()

◆ showTimingsWarning()

Field Documentation

◆ $anonymized

◆ $filter

◆ $http

◆ $icon_variant

◆ $ilObjDataCache

◆ $main_tpl

◆ $objDefinition

◆ $refinery

◆ $setting

◆ $tree

◆ $user

◆ HIT_LIMIT