TableGUI class for learning progress. More...

Inheritance diagram for ilLPTableBaseGUI:

Collaboration diagram for ilLPTableBaseGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
	ilTable2GUI constructor. More...

	executeCommand ()
	Execute command. More...

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

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

	getCurrentFilter ($as_query=false)

Public Member Functions inherited from ilTable2GUI
	__construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
	ilTable2GUI constructor. More...

	setOpenFormTag ($a_val)
	Set open form tag. More...

	getOpenFormTag ()
	Get open form tag. More...

	setCloseFormTag ($a_val)
	Set close form tag. More...

	getCloseFormTag ()
	Get close form tag. More...

	determineLimit ()
	Determine the limit. More...

	getSelectableColumns ()
	Get selectable columns. More...

	determineSelectedColumns ()
	Determine selected columns. More...

	isColumnSelected ($a_col)
	Is given column selected? More...

	getSelectedColumns ()
	Get selected columns. More...

	executeCommand ()
	Execute command. More...

	resetOffset ($a_in_determination=false)
	Reset offset. More...

	initFilter ()
	Init filter. More...

	getParentObject ()
	Get parent object. More...

	getParentCmd ()
	Get parent command. More...

	setTopAnchor ($a_val)
	Set top anchor. More...

	getTopAnchor ()
	Get top anchor. More...

	setNoEntriesText ($a_text)
	Set text for an empty table. More...

	getNoEntriesText ()
	Get text for an empty table. More...

	setIsDataTable ($a_val)
	Set is data table. More...

	getIsDataTable ()
	Get is data table. More...

	setEnableTitle ($a_enabletitle)
	Set Enable Title. More...

	getEnableTitle ()
	Get Enable Title. More...

	setEnableHeader ($a_enableheader)
	Set Enable Header. More...

	getEnableHeader ()
	Get Enable Header. More...

	setEnableNumInfo ($a_val)
	Set enable num info. More...

	getEnableNumInfo ()
	Get enable num info. More...

	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	Set title and title icon. More...

	setDescription ($a_val)
	Set description. More...

	getDescription ()
	Get description. More...

	setOrderField ($a_order_field)
	set order column More...

	getOrderField ()

	setData ($a_data)
	set table data @access public More...

	getData ()

	dataExists ()

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

	getPrefix ()

	addFilterItem ($a_input_item, $a_optional=false)
	Add filter item. More...

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

	getFilterItems ($a_optionals=false)
	Get filter items. More...

	getFilterItemByPostVar ($a_post_var)

	setFilterCols ($a_val)
	Set filter columns. More...

	getFilterCols ()
	Get filter columns. More...

	setDisableFilterHiding ($a_val=true)
	Set disable filter hiding. More...

	getDisableFilterHiding ()
	Get disable filter hiding. More...

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

	getSelectedFilters ()
	Get selected filters. More...

	determineSelectedFilters ()
	Determine selected filters. More...

	setCustomPreviousNext ($a_prev_link, $a_next_link)
	Set custom previous/next links. More...

	setFormAction ($a_form_action, $a_multipart=false)
	Set Form action parameter. More...

	getFormAction ()
	Get Form action parameter. More...

	setFormName ($a_formname="")
	Set Form name. More...

	getFormName ()
	Get Form name. More...

	setId ($a_val)
	Set id. More...

	getId ()
	Get element id. More...

	setDisplayAsBlock ($a_val)
	Set display as block. More...

	getDisplayAsBlock ()
	Get display as block. More...

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

	setSelectAllCheckbox ($a_select_all_checkbox)
	Set the name of the checkbox that should be toggled with a select all button. More...

	setExternalSorting ($a_val)
	Set external sorting. More...

	getExternalSorting ()
	Get external sorting. More...

	setFilterCommand ($a_val, $a_caption=null)
	Set filter command. More...

	getFilterCommand ()
	Get filter command. More...

	setResetCommand ($a_val, $a_caption=null)
	Set reset filter command. More...

	getResetCommand ()
	Get reset filter command. More...

	setExternalSegmentation ($a_val)
	Set external segmentation. More...

	getExternalSegmentation ()
	Get external segmentation. More...

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

	setDefaultOrderField ($a_defaultorderfield)
	Set Default order field. More...

	getDefaultOrderField ()
	Get Default order field. More...

	setDefaultOrderDirection ($a_defaultorderdirection)
	Set Default order direction. More...

	getDefaultOrderDirection ()
	Get Default order direction. More...

	setDefaultFilterVisiblity ($a_status)
	Set default filter visiblity. More...

	getDefaultFilterVisibility ()
	Get default filter visibility. More...

	clearCommandButtons ()

	addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
	Add Command button. More...

	addCommandButtonInstance (ilButtonBase $a_button)
	Add Command button instance. More...

	addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
	Add Selection List + Command button. More...

	addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
	Add Selection List + Command button for selected items. More...

	setCloseCommand ($a_link)
	Add command for closing table. More...

	addMultiCommand ($a_cmd, $a_text)
	Add Command button. More...

	addHiddenInput ($a_name, $a_value)
	Add Hidden Input field. More...

	addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
	Add Header Command (Link) (Image needed for now) More...

	setTopCommands ($a_val)
	Set top commands (display command buttons on top of table, too) More...

	getTopCommands ()
	Get top commands (display command buttons on top of table, too) More...

	addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
	Add a column to the header. More...

	getNavParameter ()

	setOrderLink ($sort_field, $order_dir)

	fillHeader ()

	determineOffsetAndOrder ($a_omit_offset=false)
	Determine offset and order. More...

	storeNavParameter ()

	getHTML ()
	Get HTML. More...

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

	render ()
	render table @access public More...

	writeFilterToSession ()
	Write filter values to session. More...

	resetFilter ()
	Reset filter. More...

	fillFooter ()
	Fill footer row. More...

	getLinkbar ($a_num)
	Get previous/next linkbar. More...

	fillHiddenRow ()

	fillActionRow ()
	Fill Action Row. More...

	setHeaderHTML ($html)
	set header html More...

	storeProperty ($type, $value)
	Store table property. More...

	loadProperty ($type)
	Load table property. More...

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

	setContext ($id)
	Set context. More...

	getContext ()
	Get context. More...

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

	getShowRowsSelector ()
	Get rows-per-page selector state. More...

	setShowTemplates ($a_value)
	Toggle templates. More...

	getShowTemplates ()
	Get template state. More...

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

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

	deleteTemplate ($a_name)
	Delete template. More...

	getLimit ()
	Get limit. More...

	getOffset ()
	Get offset. More...

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

	setPrintMode ($a_value=false)
	Toogle print mode. More...

	getPrintMode ()
	Get print mode. More...

	getExportMode ()
	Was export activated? More...

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

	setEnableAllCommand ($a_value)
	Enable actions for all entries in current result. More...

	setRowSelectorLabel ($row_selector_label)

	getRowSelectorLabel ()

	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...

	getPreventDoubleSubmission ()
	Get prevent double submission. More...

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

Public Member Functions inherited from ilTableGUI
	__construct ($a_data=0, $a_global_tpl=true)
	Constructor. More...

	setTemplate ($a_tpl)
	set template @access public More...

&	getTemplateObject ()

	setData ($a_data)
	set table data @access public More...

	getData ()

	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	set table title @access public More...

	setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
	set table help page @access public More...

	setHeaderNames ($a_header_names)
	set table header names @access public More...

	getColumnCount ()
	Returns the column count based on the number of the header row columns @access public. More...

	setHeaderVars ($a_header_vars, $a_header_params=0)
	set table header vars @access public More...

	setColumnWidth ($a_column_width)
	set table column widths @access public More...

	setOneColumnWidth ($a_column_width, $a_column_number)
	set one table column width @access public More...

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

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

	getLimit ()
	Get limit. More...

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

	setOffset ($a_offset)
	set dataset offset @access public More...

	getOffset ()
	Get offset. More...

	setOrderColumn ($a_order_column=0, $a_default_column=0)
	set order column @access public More...

	getOrderColumn ()
	Get order column. More...

	setOrderDirection ($a_order_direction)
	set order direction @access public More...

	getOrderDirection ()
	Get order direction. More...

	setFooter ($a_style, $a_previous=0, $a_next=0)
	set order direction @access public More...

	enable ($a_module_name)
	enables particular modules of table More...

	disable ($a_module_name)
	diesables particular modules of table More...

	sortData ()

	render ()
	render table @access public More...

	renderHeader ()

	setOrderLink ($key, $order_dir)

	setStyle ($a_element, $a_style)

	getStyle ($a_element)

	setBase ($a_base)
	Set Base script name (deprecated, only use this for workarounds). More...

	getBase ()
	Get Base script name (deprecated, only use this for workarounds). More...

	getFormName ()

	setFormName ($a_name="cmd")

	getSelectAllCheckbox ()

	setSelectAllCheckbox ($a_select_all_checkbox)

	clearActionButtons ()

	addActionButton ($btn_name, $btn_value)

Protected Member Functions
	sendMail (array $a_user_ids, $a_parent_obj, $a_parent_cmd)

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

	buildPath ($ref_ids)
	Build path with deep-link. More...

	getPossibleTypes ($a_split_learning_resources=false, $a_include_digilib=false, $a_allow_undefined_lp=false)
	Get possible subtypes. More...

	parseValue ($id, $value, $type)

	isPercentageAvailable ($a_obj_id)

	parseTitle ($a_obj_id, $action, $a_user_id=false)

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

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

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

	showTimingsWarning ($a_ref_id, $a_user_id)

	formatSeconds ($seconds, $a_shorten_zero=false)

	anonymizeValue ($a_value, $a_force_number=false)

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

	getMonthsFilter ($a_short=false)

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

	getSelectableUserColumns ($a_in_course=false, $a_in_group=false)

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

Protected Member Functions inherited from ilTable2GUI
	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, $a_element)
	Check if filter element is based on adv md. More...

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

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

	SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
	Set current filter value. More...

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

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

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

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

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

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

Protected Attributes
	$filter

	$anonymized

Protected Attributes inherited from ilTable2GUI
	$ctrl

	$tpl

	$parent_obj

	$parent_cmd

	$close_command = ""

	$top_anchor = "il_table_top"

	$filters = array()

	$optional_filters = array()

	$filter_cmd = 'applyFilter'

	$reset_cmd = 'resetFilter'

	$filter_cols = 5

	$ext_sort = false

	$ext_seg = false

	$context = ""

	$mi_sel_buttons = []

	$disable_filter_hiding = false

	$selected_filter = false

	$top_commands = true

	$selectable_columns = array()

	$selected_column = array()

	$show_templates = false

	$show_rows_selector = true

	$rows_selector_off = false

	$nav_determined = false

	$limit_determined = false

	$filters_determined = false

	$columns_determined = false

	$open_form_tag = true

	$close_form_tag = true

	$export_formats = []

	$export_mode

	$print_mode

	$enable_command_for_all

	$restore_filter

	$restore_filter_values

	$default_filter_visibility = false

	$sortable_fields = array()

	$prevent_double_submission = true

	$row_selector_label

	$sel_buttons = []

Protected Attributes inherited from ilTableGUI
	$tpl

	$lng

Additional Inherited Members
Static Public Member Functions inherited from ilTable2GUI
static	getAllCommandLimit ()
	Get maximum number of entries to enable actions for all. More...

Data Fields inherited from ilTable2GUI
const	FILTER_TEXT = 1

const	FILTER_SELECT = 2

const	FILTER_DATE = 3

const	FILTER_LANGUAGE = 4

const	FILTER_NUMBER_RANGE = 5

const	FILTER_DATE_RANGE = 6

const	FILTER_DURATION_RANGE = 7

const	FILTER_DATETIME_RANGE = 8

const	FILTER_CHECKBOX = 9

const	EXPORT_EXCEL = 1

const	EXPORT_CSV = 2

const	ACTION_ALL_LIMIT = 1000

Data Fields inherited from ilTableGUI
	$title

	$icon

	$icon_alt

	$help_page

	$help_icon

	$help_icon_alt

	$header_names

	$header_vars

	$linkbar_vars

	$data

	$column_count

	$column_width

	$max_count

	$limit

	$max_limit = false

	$offset

	$order_column

	$order_direction

	$footer_style

	$footer_previous

	$footer_next

	$lang_support = true

	$global_tpl

	$form_name

	$select_all_checkbox

	$action_buttons

	$prefix

	$base = ""

	$enabled

	$styles

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 16 of file class.ilLPTableBaseGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

ilTable2GUI constructor.

Parameters

object	$a_parent_obj	ob Mostly ILIAS-GUI-Classes
string	$a_parent_cmd
string	$a_template_context

Reimplemented from ilTable2GUI.

Reimplemented in ilTrMatrixTableGUI.

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

    {
        parent::__construct($a_parent_obj, $a_parent_cmd, $a_template_context);
 
        // country names
        $this->lng->loadLanguageModule("meta");
        
        include_once("./Services/Object/classes/class.ilObjectLP.php");
        
        $this->anonymized = (bool) !ilObjUserTracking::_enabledUserRelatedData();
        if (!$this->anonymized && $this->obj_id) {
            include_once "Services/Object/classes/class.ilObjectLP.php";
            $olp = ilObjectLP::getInstance($this->obj_id);
            $this->anonymized = $olp->isAnonymized();
        }
    }

References ilObjUserTracking\_enabledUserRelatedData(), and ilObjectLP\getInstance().

Here is the call graph for this function:

Member Function Documentation

◆ addToClipboard()

ilLPTableBaseGUI::addToClipboard ( )

protected

Add selected users to clipboard.

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

    {
        $users = (array) $_POST['uid'];
        include_once './Services/User/classes/class.ilUserClipboard.php';
        $clip = ilUserClipboard::getInstance($GLOBALS['ilUser']->getId());
        $clip->add($users);
        $clip->save();
        
        $GLOBALS['lng']->loadLanguageModule('user');
        ilUtil::sendSuccess($this->lng->txt('clipboard_user_added'), true);
    }

References $_POST, $GLOBALS, $users, ilTable2GUI\getId(), ilUserClipboard\getInstance(), and ilUtil\sendSuccess().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ anonymizeValue()

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

protected

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

    {
        // currently inactive
        return $a_value;
        
        if (is_numeric($a_value)) {
            $threshold = 3;
            $a_value = (int) $a_value;
            if ($a_value <= $threshold) {
                if (!$a_force_number) {
                    return "0-" . $threshold;
                } else {
                    return $threshold;
                }
            }
        }
        return $a_value;
    }

Here is the caller graph for this function:

◆ buildPath()

ilLPTableBaseGUI::buildPath ( $ref_ids )

protected

Build path with deep-link.

Parameters

array $ref_ids

Returns: array

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

    {
        global $tree, $ilCtrl;
 
        include_once './Services/Link/classes/class.ilLink.php';
        
        if (!count($ref_ids)) {
            return false;
        }
        foreach ($ref_ids as $ref_id) {
            $path = "...";
            $counter = 0;
            $path_full = $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;
    }

References $counter, ilTableGUI\$data, $ilCtrl, $path, $result, and ilLink\_getLink().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildValueScale()

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

protected

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

    {
        $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;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilLPTableBaseGUI::executeCommand ( )

Execute command.

Reimplemented from ilTable2GUI.

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

    {
        global $ilCtrl, $lng;
 
        $this->determineSelectedFilters();
 
        if (!$ilCtrl->getNextClass($this)) {
            $to_hide = false;
 
            switch ($ilCtrl->getCmd()) {
                case "applyFilter":
                    $this->resetOffset();
                    $this->writeFilterToSession();
                    break;
 
                case "resetFilter":
                    $this->resetOffset();
                    $this->resetFilter();
                    break;
 
                case "hideSelected":
                    $to_hide = $_POST["item_id"];
                    break;
 
                case "hide":
                    $to_hide = array((int) $_GET["hide"]);
                    break;
                
                case "mailselectedusers":
                    if (!sizeof($_POST["uid"])) {
                        ilUtil::sendFailure($lng->txt("no_checkbox"), true);
                    } else {
                        $this->sendMail($_POST["uid"], $this->parent_obj, $this->parent_cmd);
                    }
                    break;
                    
                case 'addToClipboard':
                    if (!sizeof($_POST['uid'])) {
                        ilUtil::sendFailure($lng->txt('no_checkbox'), true);
                    } else {
                        $this->addToClipboard();
                    }
                    break;
                
                // page selector
                default:
                    $this->determineOffsetAndOrder();
                    $this->storeNavParameter();
                    break;
            }
 
            if ($to_hide) {
                $obj = $this->getFilterItemByPostVar("hide");
                $value = array_unique(array_merge((array) $obj->getValue(), $to_hide));
                $obj->setValue($value);
                $obj->writeToSession();
            }
 
            if (isset($_REQUEST["tbltplcrt"])) {
                $ilCtrl->setParameter($this->parent_obj, "tbltplcrt", $_REQUEST["tbltplcrt"]);
            }
            if (isset($_REQUEST["tbltpldel"])) {
                $ilCtrl->setParameter($this->parent_obj, "tbltpldel", $_REQUEST["tbltpldel"]);
            }
 
            $ilCtrl->redirect($this->parent_obj, $this->parent_cmd);
        } else {
            // e.g. repository selector
            return parent::executeCommand();
        }
    }

References $_GET, $_POST, $ilCtrl, ilTableGUI\$lng, addToClipboard(), ilTable2GUI\determineOffsetAndOrder(), ilTable2GUI\determineSelectedFilters(), ilTable2GUI\getFilterItemByPostVar(), ilTable2GUI\resetFilter(), ilTable2GUI\resetOffset(), ilUtil\sendFailure(), sendMail(), ilTable2GUI\storeNavParameter(), and ilTable2GUI\writeFilterToSession().

Here is the call graph for this function:

◆ fillMetaCSV()

ilLPTableBaseGUI::fillMetaCSV ( $a_csv )

protected

Add meta information to csv export.

Likely to be overwritten by derived class.

Parameters

object $a_csv current file

Reimplemented from ilTable2GUI.

Reimplemented in ilLPObjectStatisticsDailyTableGUI, ilLPObjectStatisticsTableGUI, and ilLPObjectStatisticsTypesTableGUI.

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

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

References getExportMeta().

Here is the call graph for this function:

◆ fillMetaExcel()

ilLPTableBaseGUI::fillMetaExcel	(	ilExcel	$a_excel,
		&	$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 ilTable2GUI.

Reimplemented in ilLPObjectStatisticsDailyTableGUI, ilLPObjectStatisticsTableGUI, and ilLPObjectStatisticsTypesTableGUI.

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

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

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

Here is the call graph for this function:

◆ formatSeconds()

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

protected

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

    {
        $seconds = ((int) $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);
    }

References $rest, and sprintf.

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

Here is the caller graph for this function:

◆ getCurrentFilter()

ilLPTableBaseGUI::getCurrentFilter ( $as_query = false )

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

    {
        $result = array();
        foreach ((array) $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 "title":
                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 ($value !== false) {
                        $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;
    }

References $id, $result, ilTable2GUI\getFilterItemByPostVar(), and IL_CAL_DATETIME.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExportMeta()

ilLPTableBaseGUI::getExportMeta ( )

protected

Build export meta data.

Returns: array

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

    {
        global $lng, $ilObjDataCache, $ilUser, $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);
        include_once './Services/Link/classes/class.ilLink.php';
        
        $data = array();
        $data[$lng->txt("trac_name_of_installation")] = $ilClientIniFile->readVariable('client', 'name');
        
        if ($this->obj_id) {
            $data[$lng->txt("trac_object_name")] = $ilObjDataCache->lookupTitle($this->obj_id);
            if ($this->ref_id) {
                $data[$lng->txt("trac_object_link")] = ilLink::_getLink($this->ref_id, ilObject::_lookupType($this->obj_id));
            }
            $data[$lng->txt("trac_object_owner")] = ilObjUser::_lookupFullname(ilObject::_lookupOwner($this->obj_id));
        }
        
        $data[$lng->txt("trac_report_date")] = ilDatePresentation::formatDate(new ilDateTime(time(), IL_CAL_UNIX));
        $data[$lng->txt("trac_report_owner")] = $ilUser->getFullName();
        
        return $data;
    }

References ilTableGUI\$data, $ilUser, ilTableGUI\$lng, ilLink\_getLink(), ilObjUser\_lookupFullname(), ilObject\_lookupOwner(), ilObject\_lookupType(), ilDatePresentation\formatDate(), IL_CAL_UNIX, and ilDatePresentation\setUseRelativeDates().

Referenced by fillMetaCSV(), and fillMetaExcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMonthsFilter()

ilLPTableBaseGUI::getMonthsFilter ( $a_short = false )

protected

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

    {
        global $lng;
        
        $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 . " / " . $lng->txt("month_" . $month . "_long");
                    } else {
                        $caption = $year . "/" . $month;
                    }
                    $options[$year . "-" . $month] = $caption;
                }
            }
        }
        return $options;
    }

References ilTableGUI\$lng, $options, and date.

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

Here is the caller graph for this function:

◆ getMonthsYear()

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

protected

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

    {
        global $lng;
        
        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 = $lng->txt("month_" . $month . "_long");
                } else {
                    $caption = $lng->txt("month_" . $month . "_short");
                }
                $all[$a_year . "-" . $month] = $caption;
            }
        }
        return $all;
    }

References ilTableGUI\$lng, and date.

Here is the caller graph for this function:

◆ getPossibleTypes()

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

protected

Get possible subtypes.

Parameters

bool	$a_split_learning_resources
bool	$a_include_digilib
bool	$a_allow_undefined_lp

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

    {
        global $lng, $ilPluginAdmin;
 
        $options = array();
 
        if ($a_split_learning_resources) {
            $options['lm'] = $lng->txt('objs_lm');
            $options['sahs'] = $lng->txt('objs_sahs');
            $options['htlm'] = $lng->txt('objs_htlm');
        } else {
            $options['lres'] = $lng->txt('learning_resources');
        }
 
        $options['crs'] = $lng->txt('objs_crs');
        $options['grp'] = $lng->txt('objs_grp');
        $options['exc'] = $lng->txt('objs_exc');
        $options['file'] = $lng->txt('objs_file');
        $options['mcst'] = $lng->txt('objs_mcst');
        $options['svy'] = $lng->txt('objs_svy');
        $options['tst'] = $lng->txt('objs_tst');
        $options['prg'] = $lng->txt('objs_prg');
        $options['iass'] = $lng->txt('objs_iass');
        
        if ($a_allow_undefined_lp) {
            $options["webr"] = $lng->txt("objs_webr");
            $options["wiki"] = $lng->txt("objs_wiki");
            $options["blog"] = $lng->txt("objs_blog");
            $options["prtf"] = $lng->txt("objs_prtf");
            $options["prtt"] = $lng->txt("objs_prtt");
        }
        
        // repository plugins (currently only active)
        include_once 'Services/Repository/classes/class.ilRepositoryObjectPluginSlot.php';
        $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "Repository", "robj");
        foreach ($pl_names as $pl) {
            $pl_id = $ilPluginAdmin->getId(IL_COMP_SERVICE, "Repository", "robj", $pl);
            if (ilRepositoryObjectPluginSlot::isTypePluginWithLP($pl_id)) {
                $options[$pl_id] = ilObjectPlugin::lookupTxtById($pl_id, "objs_" . $pl_id);
            }
        }
        
        asort($options);
        return $options;
    }

References ilTableGUI\$lng, $options, IL_COMP_SERVICE, ilRepositoryObjectPluginSlot\isTypePluginWithLP(), and ilObjectPlugin\lookupTxtById().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectableUserColumns()

ilLPTableBaseGUI::getSelectableUserColumns	(	$a_in_course = `false`,
		$a_in_group = `false`
	)

protected

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

    {
        global $lng, $ilSetting;
        
        $cols = $privacy_fields = array();
        
        include_once("./Services/User/classes/class.ilUserProfile.php");
        $up = new ilUserProfile();
        $up->skipGroup("preferences");
        $up->skipGroup("settings");
        $up->skipGroup("interests");
        $ufs = $up->getStandardFields();
 
        // default fields
        $cols["login"] = array(
            "txt" => $lng->txt("login"),
            "default" => true);
 
        if (!$this->anonymized) {
            $cols["firstname"] = array(
                "txt" => $lng->txt("firstname"),
                "default" => true);
            $cols["lastname"] = array(
                "txt" => $lng->txt("lastname"),
                "default" => true);
        }
 
        // show only if extended data was activated in lp settings
        include_once 'Services/Tracking/classes/class.ilObjUserTracking.php';
        $tracking = new ilObjUserTracking();
        if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS)) {
            $cols["first_access"] = array(
                "txt" => $lng->txt("trac_first_access"),
                "default" => true);
            $cols["last_access"] = array(
                "txt" => $lng->txt("trac_last_access"),
                "default" => true);
        }
        if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_READ_COUNT)) {
            $cols["read_count"] = array(
                "txt" => $lng->txt("trac_read_count"),
                "default" => true);
        }
        if ($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS) &&
            ilObjectLP::supportsSpentSeconds($this->type)) {
            $cols["spent_seconds"] = array(
                "txt" => $lng->txt("trac_spent_seconds"),
                "default" => true);
        }
 
        if ($this->isPercentageAvailable($this->obj_id)) {
            $cols["percentage"] = array(
                "txt" => $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" => $lng->txt("trac_status"),
                "default" => true);
 
            $cols['status_changed'] = array(
                'txt' => $lng->txt('trac_status_changed'),
                'default' => false);
        }
 
        if (ilObjectLP::supportsMark($this->type)) {
            $cols["mark"] = array(
                "txt" => $lng->txt("trac_mark"),
                "default" => true);
        }
 
        $cols["u_comment"] = array(
            "txt" => $lng->txt("trac_comment"),
            "default" => false);
 
        $cols["create_date"] = array(
            "txt" => $lng->txt("create_date"),
            "default" => false);
        $cols["language"] = array(
            "txt" => $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
            include_once('Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
            if (ilPrivacySettings::_getInstance()->checkExportAccess($this->ref_id)) {
                // other user profile fields
                foreach ($ufs as $f => $fd) {
                    if (!isset($cols[$f]) && $f != "username" && !$fd["lists_hide"]) {
                        if ($a_in_course &&
                            !($fd["course_export_fix_value"] || $ilSetting->get("usr_settings_course_export_" . $f))) {
                            continue;
                        }
                        if ($a_in_group &&
                            !($fd["group_export_fix_value"] || $ilSetting->get("usr_settings_group_export_" . $f))) {
                            continue;
                        }
 
                        $cols[$f] = array(
                            "txt" => $lng->txt($f),
                            "default" => false);
 
                        $privacy_fields[] = $f;
                    }
                }
 
                // additional defined user data fields
                include_once './Services/User/classes/class.ilUserDefinedFields.php';
                $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);
    }

References $cols, $ilSetting, ilTableGUI\$lng, ilPrivacySettings\_getInstance(), ilUserDefinedFields\_getInstance(), ilObjUserTracking\EXTENDED_DATA_LAST_ACCESS, ilObjUserTracking\EXTENDED_DATA_READ_COUNT, ilObjUserTracking\EXTENDED_DATA_SPENT_SECONDS, ilObjectLP\getInstance(), isPercentageAvailable(), ilObjectLP\supportsMark(), ilObjectLP\supportsSpentSeconds(), and UDF_TYPE_WYSIWYG.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initBaseFilter()

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

Init filter.

Parameters

bool $a_split_learning_resources

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

    {
        global $lng, $ilObjDataCache;
        
        $this->setDisableFilterHiding(true);
        
        // object type selection
        include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
        $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
        include_once("./Services/Form/classes/class.ilMultiSelectInputGUI.php");
        $msi = new ilMultiSelectInputGUI($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($ilObjDataCache->lookupType($obj_id), $type)) {
                    $options[$obj_id] = $ilObjDataCache->lookupTitle($obj_id);
                }
            }
            $msi->setOptions($options);
        }
 
        // title/description
        include_once("./Services/Form/classes/class.ilTextInputGUI.php");
        $ti = new ilTextInputGUI($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
        include_once("./Services/Form/classes/class.ilRepositorySelectorInputGUI.php");
        $rs = new ilRepositorySelectorInputGUI($lng->txt("trac_filter_area"), "area");
        $rs->setSelectText($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) {
            include_once("./Services/Form/classes/class.ilCheckboxInputGUI.php");
            $cb = new ilCheckboxInputGUI($lng->txt("trac_filter_has_status"), "status");
            $this->addFilterItem($cb);
            $cb->readFromSession();
            $this->filter["status"] = $cb->getChecked();
        }
    }

References ilTableGUI\$lng, $options, $si, $type, ilTable2GUI\addFilterItem(), getCurrentFilter(), getPossibleTypes(), and ilTable2GUI\setDisableFilterHiding().

Referenced by ilLPProgressTableGUI\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isPercentageAvailable()

ilLPTableBaseGUI::isPercentageAvailable ( $a_obj_id )

protected

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

    {
        // :TODO:
        $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_VISITED_PAGES,
            ilLPObjSettings::LP_MODE_TEST_PASSED))) {
            return true;
        }
        return false;
    }

References ilObjectLP\getInstance(), ilLPObjSettings\LP_MODE_SCORM, ilLPObjSettings\LP_MODE_TEST_PASSED, ilLPObjSettings\LP_MODE_TLT, ilLPObjSettings\LP_MODE_VISITED_PAGES, and ilLPObjSettings\LP_MODE_VISITS.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseTitle()

ilLPTableBaseGUI::parseTitle	(	$a_obj_id,
		$action,
		$a_user_id = `false`
	)

protected

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

    {
        global $lng, $ilObjDataCache, $ilUser;
 
        $user = "";
        if ($a_user_id) {
            if ($a_user_id != $ilUser->getId()) {
                $a_user = ilObjectFactory::getInstanceByObjId($a_user_id);
            } else {
                $a_user = $ilUser;
            }
            $user .= ", " . $a_user->getFullName(); // " [".$a_user->getLogin()."]";
        }
 
        if ($a_obj_id != ROOT_FOLDER_ID) {
            $this->setTitle($lng->txt($action) . ": " . $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($lng->txt($action));
        }
    }

References $action, $ilUser, ilTableGUI\$lng, ilObjectLP\getInstance(), ilObjectFactory\getInstanceByObjId(), ilTable2GUI\setDescription(), and ilTable2GUI\setTitle().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseValue()

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

protected

Reimplemented in ilTrSummaryTableGUI.

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

    {
        global $lng;
 
        // 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($value) == "" && $id != "status") {
            if ($id == "title" &&
                get_class($this) != "ilTrObjectUsersPropsTableGUI" &&
                get_class($this) != "ilTrMatrixTableGUI") {
                return "--" . $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($value, ($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 = $lng->txt("gender_" . $value);
                break;
 
            case "status":
                include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
                $path = ilLearningProgressBaseGUI::_getImagePathForStatus($value);
                $text = ilLearningProgressBaseGUI::_getStatusText($value);
                $value = ilUtil::img($path, $text);
                break;
 
            case "language":
                $lng->loadLanguageModule("meta");
                $value = $lng->txt("meta_l_" . $value);
                break;
 
            case "sel_country":
                $value = $lng->txt("meta_c_" . $value);
                break;
        }
 
        return $value;
    }

References $function, $id, ilTableGUI\$lng, $path, $text, $type, ilLearningProgressBaseGUI\_getImagePathForStatus(), ilLearningProgressBaseGUI\_getStatusText(), ilDatePresentation\formatDate(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_UNIX, ilUtil\img(), ilDatePresentation\secondsToString(), ilObjectLP\supportsMark(), and ilObjectLP\supportsSpentSeconds().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ searchFilterListener()

ilLPTableBaseGUI::searchFilterListener	(	$a_ref_id,
		$a_data
	)

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

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

    {
        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;
    }

References ilObjectLP\getInstance().

Here is the call graph for this function:

◆ searchObjects()

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

protected

Search objects that match current filters.

Parameters

array	$filter
string	$permission
	array	preset obj_ids
	bool	check lp activation

Returns: array

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

    {
        global $ilObjDataCache;
                
        include_once './Services/Search/classes/class.ilQueryParser.php';
 
        $query_parser = new ilQueryParser($filter["query"]);
        $query_parser->setMinWordLength(0);
        $query_parser->setCombination(QP_COMBINATION_AND);
        $query_parser->parse();
        if (!$query_parser->validate()) {
            ilLoggerFactory::getLogger('trac')->notice($query_parser->getMessage());
            // echo $query_parser->getMessage();
            return false;
        }
 
        if ($filter["type"] == "lres") {
            $filter["type"] = array('lm','sahs','htlm');
        } else {
            $filter["type"] = array($filter["type"]);
        }
 
        include_once 'Services/Search/classes/Like/class.ilLikeObjectSearch.php';
        $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(1000);
        
        if ($a_check_lp_activation) {
            $res->addObserver($this, "searchFilterListener");
        }
        
        if (!$this->filter["area"]) {
            $res->filter(ROOT_FOLDER_ID, false);
        } else {
            $res->filter($this->filter["area"], false);
        }
 
        $objects = array();
        foreach ($res->getResults() as $obj_data) {
            $objects[$obj_data['obj_id']][] = $obj_data['ref_id'];
        }
 
        // Check if search max hits is reached
        if ($res->isLimitReached()) {
            $this->lng->loadLanguageModule("search");
            ilUtil::sendFailure(sprintf($this->lng->txt("search_limit_reached"), 1000));
        }
 
        return $objects ? $objects : array();
    }

References $filter, $res, ilLoggerFactory\getLogger(), QP_COMBINATION_AND, ilUtil\sendFailure(), and sprintf.

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

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,
			$a_parent_cmd
	)

protected

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

    {
        // see ilObjCourseGUI::sendMailToSelectedUsersObject()
        
        require_once 'Services/Mail/classes/class.ilMailFormCall.php';
        
        $rcps = array();
        foreach ($a_user_ids as $usr_id) {
            $rcps[] = ilObjUser::_lookupLogin($usr_id);
        }
        
        $template = array();
        $sig = null;
        
        // repository-object-specific
        $ref_id = (int) $_REQUEST["ref_id"];
        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 {
                include_once './Services/Link/classes/class.ilLink.php';
                $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
            )
        );
    }

References $template, ilLink\_getLink(), ilObjUser\_lookupLogin(), ilObject\_lookupObjectId(), ilMailFormCall\CONTEXT_KEY, ilObjectLP\getInstance(), ilMailFormCall\getRedirectTarget(), and ilUtil\redirect().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showTimingsWarning()

ilLPTableBaseGUI::showTimingsWarning	(	$a_ref_id,
		$a_user_id
	)

protected

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

    {
        $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]['end']) {
                $end = $timings['user'][$a_user_id]['end'];
            } elseif ($timings['item']['suggestion_end']) {
                $end = $timings['item']['suggestion_end'];
            } else {
                $end = true;
            }
            return $end;
        }
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $anonymized

ilLPTableBaseGUI::$anonymized

protected

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

◆ $filter

ilLPTableBaseGUI::$filter

protected

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

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

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

Services/Tracking/classes/class.ilLPTableBaseGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addToClipboard()

◆ anonymizeValue()

◆ buildPath()

◆ buildValueScale()

◆ executeCommand()

◆ fillMetaCSV()

◆ fillMetaExcel()

◆ formatSeconds()

◆ getCurrentFilter()

◆ getExportMeta()

◆ getMonthsFilter()

◆ getMonthsYear()

◆ getPossibleTypes()

◆ getSelectableUserColumns()

◆ initBaseFilter()

◆ isPercentageAvailable()

◆ parseTitle()

◆ parseValue()

◆ searchFilterListener()

◆ searchObjects()

◆ sendMail()

◆ showTimingsWarning()

Field Documentation

◆ $anonymized

◆ $filter