ilLPProgressTableGUI Class Reference

TableGUI class for learning progress. More...

Inheritance diagram for ilLPProgressTableGUI:

Collaboration diagram for ilLPProgressTableGUI:

Public Member Functions
	__construct (?object $a_parent_obj, string $a_parent_cmd, ?ilObjUser $a_user=null, ?array $obj_ids=null, bool $details=false, ?int $mode=null, bool $personal_only=false, ?int $a_parent_id=null, ?int $a_parent_ref_id=null, ?int $lp_context=null)
	Constructor. More...
	numericOrdering (string $a_field)
	Should this field be sorted numeric? More...
	getItems ()
Public Member Functions inherited from ilLPTableBaseGUI
	__construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")
	executeCommand ()
	searchFilterListener (int $a_ref_id, array $a_data)
	Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED @access public. More...
	initBaseFilter (bool $a_split_learning_resources=false, bool $a_include_no_status_filter=true)
	Init filter. More...
	getCurrentFilter (bool $as_query=false)
	getIconVariant ()
	Gets the variant of LP icons that is shown in the table. More...
	setIconVariant (int $variant)
	Sets the variant of LP icons that is shown in the table. More...
Public Member Functions inherited from ilTable2GUI
	__construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")
	setOpenFormTag (bool $a_val)
	getOpenFormTag ()
	setCloseFormTag (bool $a_val)
	getCloseFormTag ()
	determineLimit ()
	getSelectableColumns ()
	Get selectable columns. More...
	determineSelectedColumns ()
	isColumnSelected (string $col)
	getSelectedColumns ()
	resetOffset (bool $a_in_determination=false)
	initFilter ()
	getParentObject ()
	getParentCmd ()
	setTopAnchor (string $a_val)
	getTopAnchor ()
	setNoEntriesText (string $a_text)
	getNoEntriesText ()
	setIsDataTable (bool $a_val)
	getIsDataTable ()
	setEnableTitle (bool $a_enabletitle)
	getEnableTitle ()
	setEnableHeader (bool $a_enableheader)
	getEnableHeader ()
	setEnableNumInfo (bool $a_val)
	getEnableNumInfo ()
	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
	setDescription (string $a_val)
	getDescription ()
	setOrderField (string $a_order_field)
	getOrderField ()
	setData (array $a_data)
	Set table data. More...
	getData ()
	dataExists ()
	setPrefix (string $a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...
	getPrefix ()
	addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)
	addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
	Add filter by standard type. More...
	getFilterItems (bool $a_optionals=false)
	getFilterItemByPostVar (string $a_post_var)
	setFilterCols (int $a_val)
	getFilterCols ()
	setDisableFilterHiding (bool $a_val=true)
	getDisableFilterHiding ()
	isFilterSelected (string $a_col)
	Is given filter selected? More...
	getSelectedFilters ()
	determineSelectedFilters ()
	setCustomPreviousNext (string $a_prev_link, string $a_next_link)
	setFormAction (string $a_form_action, bool $a_multipart=false)
	getFormAction ()
	setFormName (string $a_name="")
	getFormName ()
	get the name of the parent form More...
	setId (string $a_val)
	getId ()
	setDisplayAsBlock (bool $a_val)
	getDisplayAsBlock ()
	setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)
	setExternalSorting (bool $a_val)
	getExternalSorting ()
	setFilterCommand (string $a_val, string $a_caption="")
	getFilterCommand ()
	setResetCommand (string $a_val, string $a_caption="")
	getResetCommand ()
	setExternalSegmentation (bool $a_val)
	getExternalSegmentation ()
	setRowTemplate (string $a_template, string $a_template_dir="")
	Set row template. More...
	setDefaultOrderField (string $a_defaultorderfield)
	getDefaultOrderField ()
	setDefaultOrderDirection (string $a_defaultorderdirection)
	getDefaultOrderDirection ()
	setDefaultFilterVisiblity (bool $a_status)
	getDefaultFilterVisibility ()
	clearCommandButtons ()
	addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")
	addCommandButtonInstance (ilButtonBase $a_button)
	addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')
	setCloseCommand (string $a_link)
	addMultiCommand (string $a_cmd, string $a_text)
	addHiddenInput (string $a_name, string $a_value)
	addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")
	setTopCommands (bool $a_val)
	getTopCommands ()
	addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
	getNavParameter ()
	setOrderLink (string $key, string $order_dir)
	fillHeader ()
	determineOffsetAndOrder (bool $a_omit_offset=false)
	storeNavParameter ()
	getHTML ()
	Get HTML. More...
	numericOrdering (string $a_field)
	Should this field be sorted numeric? More...
	render ()
	writeFilterToSession ()
	resetFilter ()
	fillFooter ()
	getLinkbar (string $a_num)
	fillHiddenRow ()
	fillActionRow ()
	setHeaderHTML (string $html)
	storeProperty (string $type, string $value)
	loadProperty (string $type)
	getCurrentState ()
	get current settings for order, limit, columns and filter More...
	setContext (string $id)
	getContext ()
	setShowRowsSelector (bool $a_value)
	Toggle rows-per-page selector. More...
	getShowRowsSelector ()
	getLimit ()
	getOffset ()
	setExportFormats (array $formats)
	Set available export formats. More...
	setPrintMode (bool $a_value=false)
	getPrintMode ()
	getExportMode ()
	exportData (int $format, bool $send=false)
	Export and optionally send current table data. More...
	setEnableAllCommand (bool $a_value)
	setRowSelectorLabel (string $row_selector_label)
	getRowSelectorLabel ()
	setPreventDoubleSubmission (bool $a_val)
	getPreventDoubleSubmission ()
	setLimit (int $a_limit=0, int $a_default_limit=0)
	set max. More...
Public Member Functions inherited from ilTableGUI
	__construct (array $a_data=[], bool $a_global_tpl=true)
	setTemplate (ilTemplate $a_tpl)
	getTemplateObject ()
	setData (array $a_data)
	Set table data. More...
	getData ()
	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
	setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")
	setHeaderNames (array $a_header_names)
	getColumnCount ()
	setHeaderVars (array $a_header_vars, array $a_header_params=[])
	setColumnWidth (array $a_column_width)
	set table column widths More...
	setOneColumnWidth (string $a_column_width, int $a_column_number)
	setMaxCount (int $a_max_count)
	set max. More...
	setLimit (int $a_limit=0, int $a_default_limit=0)
	set max. More...
	getLimit ()
	setPrefix (string $a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...
	setOffset (int $a_offset)
	set dataset offset More...
	getOffset ()
	setOrderColumn (string $a_order_column="", string $a_default_column="")
	getOrderColumn ()
	setOrderDirection (string $a_order_direction)
	getOrderDirection ()
	setFooter (string $a_style, string $a_previous="", string $a_next="")
	enable (string $a_module_name)
	disable (string $a_module_name)
	sortData ()
	render ()
	renderHeader ()
	setOrderLink (string $key, string $order_dir)
	setStyle (string $a_element, string $a_style)
	getStyle (string $a_element)
	setBase (string $a_base)
	getBase ()
	getFormName ()
	get the name of the parent form More...
	setFormName (string $a_name="cmd")
	getSelectAllCheckbox ()
	get the name of the checkbox that should be toggled with a select all button More...
	setSelectAllCheckbox (string $a_select_all_checkbox)
	clearActionButtons ()
	addActionButton (string $btn_name, string $btn_value)

Protected Member Functions
	fillRow (array $a_set)
	Standard Version of Fill Row. 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...
	fillHeaderCSV (ilCSVWriter $a_csv)
	CSV Version of Fill Header. More...
	fillRowCSV (ilCSVWriter $a_csv, array $a_set)
	CSV Version of Fill Row. More...
Protected Member Functions inherited from ilLPTableBaseGUI
	initItemIdFromPost ()
	initUidFromPost ()
	findReferencesForObjId (int $a_obj_id)
	sendMail (array $a_user_ids, $a_parent_obj, string $a_parent_cmd)
	searchObjects (array $filter, string $permission, ?array $preset_obj_ids=null, bool $a_check_lp_activation=true)
	Search objects that match current filters. More...
	isForwardingToFormDispatcher ()
	initRepositoryFilter (array $filter)
	buildPath (array $ref_ids)
	getPossibleTypes (bool $a_split_learning_resources=false, bool $a_include_digilib=false, bool $a_allow_undefined_lp=false)
	parseValue (string $id, ?string $value, string $type)
	isPercentageAvailable (int $a_obj_id)
	parseTitle (int $a_obj_id, string $action, int $a_user_id=0)
	getExportMeta ()
	Build export meta data. More...
	fillMetaExcel (ilExcel $a_excel, int &$a_row)
	Add meta information to excel export. More...
	fillMetaCSV (ilCSVWriter $a_csv)
	Add meta information to csv export. More...
	showTimingsWarning (int $a_ref_id, int $a_user_id)
	formatSeconds (int $seconds, bool $a_shorten_zero=false)
	anonymizeValue ($a_value, bool $a_force_number=false)
	buildValueScale (int $a_max_value, bool $a_anonymize=false, bool $a_format_seconds=false)
	getMonthsFilter ($a_short=false)
	getMonthsYear ($a_year=null, $a_short=false)
	getSelectableUserColumns (int $a_in_course=0, int $a_in_group=0)
	addToClipboard ()
	Add selected users to clipboard. More...
Protected Member Functions inherited from ilTable2GUI
	getRequestedValues ()
	prepareOutput ()
	Anything that must be done before HTML is generated. More...
	isFilterVisible ()
	Check if filter is visible: manually shown (session, db) or default value set. More...
	isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, ilTableFilterItem $a_element)
	Check if filter element is based on adv md. More...
	fillRow (array $a_set)
	Standard Version of Fill Row. More...
	getFilterValue (ilTableFilterItem $a_item)
	Get current filter value. More...
	setFilterValue (ilTableFilterItem $a_item, $a_value)
	fillMetaExcel (ilExcel $a_excel, int &$a_row)
	Add meta information to excel export. More...
	fillHeaderExcel (ilExcel $a_excel, int &$a_row)
	Excel Version of Fill Header. More...
	fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set)
	Excel Version of Fill Row. More...
	fillMetaCSV (ilCSVWriter $a_csv)
	Add meta information to csv export. More...
	fillHeaderCSV (ilCSVWriter $a_csv)
	CSV Version of Fill Header. More...
	fillRowCSV (ilCSVWriter $a_csv, array $a_set)
	CSV Version of Fill Row. More...

Protected Attributes
ilObjUser	$tracked_user = null
array	$obj_ids = null
bool	$details = false
int	$mode = 0
int	$parent_obj_id = 0
int	$ref_id = 0
int	$obj_id = 0
int	$lp_context = 0
bool	$has_object_subitems = false
Protected Attributes inherited from ilLPTableBaseGUI
RefineryFactory	$refinery
HttpService	$http
array	$filter = []
bool	$anonymized = true
int	$icon_variant = ilLPStatusIcons::ICON_VARIANT_LONG
ilSetting	$setting
ilObjectDataCache	$ilObjDataCache
ilObjectDefinition	$objDefinition
ilTree	$tree
ilGlobalTemplateInterface	$main_tpl
Profile	$profile
Protected Attributes inherited from ilTable2GUI
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_rows_selector = true
bool	$rows_selector_off = false
bool	$nav_determined = false
bool	$limit_determined = false
bool	$filters_determined = false
bool	$columns_determined = false
bool	$open_form_tag = true
bool	$close_form_tag = true
array	$export_formats = []
int	$export_mode = 0
bool	$print_mode = false
bool	$enable_command_for_all = false
bool	$restore_filter = false
array	$restore_filter_values = []
bool	$default_filter_visibility = false
array	$sortable_fields = array()
bool	$prevent_double_submission = true
string	$row_selector_label = ""
bool	$select_all_on_top = false
array	$sel_buttons = []
string	$nav_value = ''
string	$noentriestext = ''
string	$css_row = ''
bool	$display_as_block = false
string	$description = ''
string	$id = ""
bool	$custom_prev_next = false
string	$reset_cmd_txt = ""
string	$defaultorderfield = ""
string	$defaultorderdirection = ""
array	$column = []
bool	$datatable = false
bool	$num_info = false
bool	$form_multipart = false
array	$row_data = []
string	$order_field = ""
array	$selected_filter = []
string	$form_action = ""
string	$formname = ""
string	$sort_order = ""
array	$buttons = []
array	$multi = []
array	$hidden_inputs = []
array	$header_commands = []
string	$row_template = ""
string	$row_template_dir = ""
string	$filter_cmd_txt = ""
string	$custom_prev = ""
string	$custom_next = ""
array	$raw_post_data = null
ilGlobalTemplateInterface	$main_tpl
Protected Attributes inherited from ilTableGUI
string	$sort_order
string	$link_params
array	$header_params
	$tpl
ilLanguage	$lng

Additional Inherited Members
Static Public Member Functions inherited from ilTable2GUI
static	getAllCommandLimit ()
Static Public Member Functions inherited from ilTableGUI
static	linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='')
Data Fields inherited from ilLPTableBaseGUI
const	HIT_LIMIT = 5000
Data Fields inherited from ilTable2GUI
const	FILTER_TEXT = 1
const	FILTER_SELECT = 2
const	FILTER_DATE = 3
const	FILTER_LANGUAGE = 4
const	FILTER_NUMBER_RANGE = 5
const	FILTER_DATE_RANGE = 6
const	FILTER_DURATION_RANGE = 7
const	FILTER_DATETIME_RANGE = 8
const	FILTER_CHECKBOX = 9
const	EXPORT_EXCEL = 1
const	EXPORT_CSV = 2
const	ACTION_ALL_LIMIT = 1000
Data Fields inherited from ilTableGUI
string	$title = ""
string	$icon = ""
string	$icon_alt = ""
string	$help_page = ""
string	$help_icon = ""
string	$help_icon_alt = ""
array	$header_names = []
array	$header_vars = []
array	$linkbar_vars = []
array	$data = []
int	$column_count = 0
array	$column_width = []
int	$max_count = 0
int	$limit = 0
bool	$max_limit = false
int	$offset = 0
string	$order_column = ""
string	$order_direction = ""
string	$footer_style = ""
string	$footer_previous = ""
string	$footer_next = ""
bool	$lang_support = true
bool	$global_tpl = false
string	$form_name = ""
string	$select_all_checkbox = ""
array	$action_buttons = []
string	$prefix = ""
string	$base = ""
array	$enabled
array	$styles

Detailed Description

TableGUI class for learning progress.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e @ilCtrl_Calls ilLPProgressTableGUI: ilFormPropertyDispatchGUI

Definition at line 27 of file class.ilLPProgressTableGUI.php.

Constructor & Destructor Documentation

__construct()

ilLPProgressTableGUI::__construct	(	?object	$a_parent_obj,
		string	$a_parent_cmd,
		?ilObjUser	$a_user = null,
		?array	$obj_ids = null,
		bool	$details = false,
		?int	$mode = null,
		bool	$personal_only = false,
		?int	$a_parent_id = null,
		?int	$a_parent_ref_id = null,
		?int	$lp_context = null
	)

Constructor.

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

      {
        global $DIC;
 
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
 
        $this->tracked_user = $a_user;
        $this->obj_ids = $obj_ids;
        $this->details = $details;
        $this->mode = (int) $mode;
        $this->parent_obj_id = (int) $a_parent_id;
        $this->lp_context = (int) $lp_context;
 
        if ($a_parent_id) {
            $this->obj_id = $this->parent_obj_id;
            $this->ref_id = (int) $a_parent_ref_id;
        }
 
        $this->setId("lpprgtbl");
        parent::__construct($a_parent_obj, $a_parent_cmd);
        $this->setLimit(9999);
 
        if (!$this->details) {
            $this->has_object_subitems = true;
            $user = $this->tracked_user;
            if (!$user) {
                $user = $DIC->user();
            }
            $this->addColumn("", "", "1", true);
            $this->addColumn($this->lng->txt("trac_title"), "title", "26%");
            $this->addColumn($this->lng->txt("status"), "status", "7%");
            $this->addColumn(
                $this->lng->txt('trac_status_changed'),
                'status_changed',
                '10%'
            );
            $this->addColumn(
                $this->lng->txt("trac_percentage"),
                "percentage",
                "7%"
            );
            $this->addColumn($this->lng->txt("trac_mark"), "", "5%");
            $this->addColumn($this->lng->txt("comment"), "", "10%");
            $this->addColumn($this->lng->txt("trac_mode"), "", "20%");
            $this->addColumn($this->lng->txt("path"), "", "20%");
            $this->addColumn($this->lng->txt("actions"), "", "5%");
 
            $this->setTitle(
                sprintf(
                    $this->lng->txt("trac_learning_progress_of"),
                    $user->getFullName()
                )
            );
            $this->initBaseFilter();
 
            $this->setSelectAllCheckbox("item_id");
            $this->addMultiCommand(
                "hideSelected",
                $this->lng->txt("trac_hide_selected")
            );
        } else {
            $olp = ilObjectLP::getInstance($this->parent_obj_id);
            $collection = $olp->getCollectionInstance();
            $this->has_object_subitems = ($collection instanceof ilLPCollectionOfRepositoryObjects);
 
            $this->setTitle($this->lng->txt("details")); // #15247
 
            $this->addColumn($this->lng->txt("trac_title"), "title", "31%");
            $this->addColumn($this->lng->txt("status"), "status", "7%");
 
            if ($this->mode == ilLPObjSettings::LP_MODE_SCORM) {
                $this->lng->loadLanguageModule('content');
                $this->addColumn($this->lng->txt('cont_score'), 'score', '10%');
            } elseif ($this->has_object_subitems) {
                $this->addColumn(
                    $this->lng->txt('trac_status_changed'),
                    'status_changed',
                    '10%'
                );
                $this->addColumn(
                    $this->lng->txt("trac_percentage"),
                    "percentage",
                    "7%"
                );
                $this->addColumn($this->lng->txt("trac_mark"), "", "5%");
                $this->addColumn($this->lng->txt("comment"), "", "10%");
                $this->addColumn($this->lng->txt("trac_mode"), "", "20%");
                $this->addColumn($this->lng->txt("path"), "", "20%");
            }
        }
 
        $this->setEnableHeader(true);
        $this->setFormAction(
            $this->ctrl->getFormActionByClass(get_class($this))
        );
        $this->setRowTemplate(
            "tpl.lp_progress_list_row.html",
            "components/ILIAS/Tracking"
        );
        $this->setEnableHeader(true);
        $this->setEnableNumInfo(false);
        $this->setEnableTitle(true);
        $this->setDefaultOrderField("title");
        $this->setDefaultOrderDirection("asc");
 
        if ($this->has_object_subitems) {
            $this->setExportFormats(
                array(self::EXPORT_CSV, self::EXPORT_EXCEL)
            );
        }
 
        // area selector gets in the way
        if ($this->tracked_user) {
            $this->getItems();
        }
    }

References $details, $DIC, ilTableGUI\$lng, $lp_context, $mode, $obj_ids, $parent_obj_id, $tracked_user, ilLPTableBaseGUI\$user, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ILIAS\Repository\ctrl(), ilObjectLP\getInstance(), getItems(), ilLPTableBaseGUI\initBaseFilter(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilLPObjSettings\LP_MODE_SCORM, ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setTitle().

Here is the call graph for this function:

Member Function Documentation

fillHeaderCSV()

ilLPProgressTableGUI::fillHeaderCSV ( ilCSVWriter  $a_csv )

protected

CSV Version of Fill Header.

Likely to be overwritten by derived class.

Parameters

ilCSVWriter

$a_csv

current file

Reimplemented from ilTable2GUI.

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

                                                        : void
    {
        $a_csv->addColumn($this->lng->txt("type"));
        $a_csv->addColumn($this->lng->txt("trac_title"));
        $a_csv->addColumn($this->lng->txt("status"));
        $a_csv->addColumn($this->lng->txt("trac_status_changed"));
        $a_csv->addColumn($this->lng->txt("trac_percentage"));
        $a_csv->addColumn($this->lng->txt("trac_mark"));
        $a_csv->addColumn($this->lng->txt("comment"));
        $a_csv->addColumn($this->lng->txt("trac_mode"));
        // $a_csv->addColumn($this->lng->txt("path"));
        $a_csv->addRow();
    }

References ilCSVWriter\addColumn(), ilCSVWriter\addRow(), and ILIAS\Repository\lng().

Here is the call graph for this function:

fillHeaderExcel()

ilLPProgressTableGUI::fillHeaderExcel ( ilExcel  $a_excel, int &  $a_row  )

protected

Excel Version of Fill Header.

Likely to be overwritten by derived class.

Parameters

ilExcel	$a_excel	excel wrapper
int	$a_row	row counter

Reimplemented from ilTable2GUI.

Definition at line 430 of file class.ilLPProgressTableGUI.php.

                                                                     : void
    {
        $a_excel->setCell($a_row, 0, $this->lng->txt("type"));
        $a_excel->setCell($a_row, 1, $this->lng->txt("trac_title"));
        $a_excel->setCell($a_row, 2, $this->lng->txt("status"));
        $a_excel->setCell($a_row, 3, $this->lng->txt("trac_status_changed"));
        $a_excel->setCell($a_row, 4, $this->lng->txt("trac_percentage"));
        $a_excel->setCell($a_row, 5, $this->lng->txt("trac_mark"));
        $a_excel->setCell($a_row, 6, $this->lng->txt("comment"));
        $a_excel->setCell($a_row, 7, $this->lng->txt("trac_mode"));
        // $a_excel->setCell($a_row, 7, $this->lng->txt("path"));
 
        $a_excel->setBold("A" . $a_row . ":H" . $a_row);
    }

References ILIAS\Repository\lng(), ilExcel\setBold(), and ilExcel\setCell().

Here is the call graph for this function:

fillRow()

ilLPProgressTableGUI::fillRow ( array  $a_set )

protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

array<string,mixed>

$a_set data array

Reimplemented from ilTable2GUI.

Definition at line 267 of file class.ilLPProgressTableGUI.php.

                                            : void
    {
        if (!$this->details) {
            $this->tpl->setCurrentBlock("column_checkbox");
            $this->tpl->setVariable("OBJ_ID", $a_set["obj_id"]);
            $this->tpl->parseCurrentBlock();
        }
 
        $this->tpl->setVariable(
            "ICON_SRC",
            ilObject::_getIcon(0, "tiny", $a_set["type"])
        );
        $this->tpl->setVariable("ICON_ALT", $this->lng->txt('obj_' . $a_set["type"]));
        $this->tpl->setVariable("TITLE_TEXT", $a_set["title"]);
 
        if ($a_set["offline"] ?? false) {
            $this->tpl->setCurrentBlock("offline");
            $this->tpl->setVariable("TEXT_STATUS", $this->lng->txt("status"));
            $this->tpl->setVariable("TEXT_OFFLINE", $this->lng->txt("offline"));
            $this->tpl->parseCurrentBlock();
        }
 
        $icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_LONG);
        $this->tpl->setVariable(
            "STATUS_ICON",
            $icons->renderIconForStatus((int) $a_set["status"])
        );
 
        if ($this->mode == ilLPObjSettings::LP_MODE_SCORM) {
            $this->tpl->setVariable('SCORE_VAL', $a_set["score"]);
        } elseif ($this->has_object_subitems) {
            $this->tpl->setCurrentBlock("status_details");
 
            $this->tpl->setVariable(
                'STATUS_CHANGED_VAL',
                ilDatePresentation::formatDate(
                    new ilDateTime(
                        $a_set['status_changed'],
                        IL_CAL_DATETIME
                    )
                )
            );
 
            $olp = ilObjectLP::getInstance($a_set["obj_id"]);
            $this->tpl->setVariable(
                "MODE_TEXT",
                $olp->getModeText($a_set["u_mode"])
            );
            $this->tpl->setVariable("MARK_VALUE", $a_set["mark"]);
            $this->tpl->setVariable("COMMENT_TEXT", $a_set["comment"]);
 
            if ($a_set["percentage"] < 0) {
                $this->tpl->setVariable("PERCENTAGE_VALUE", "");
            } else {
                $this->tpl->setVariable(
                    "PERCENTAGE_VALUE",
                    sprintf("%d%%", $a_set["percentage"])
                );
            }
 
            // path
            $path = $this->buildPath($a_set["ref_ids"]);
            if ($path) {
                $this->tpl->setCurrentBlock("item_path");
                foreach ($path as $path_item) {
                    $this->tpl->setVariable("PATH_ITEM", $path_item);
                    $this->tpl->parseCurrentBlock();
                }
            }
 
            $this->tpl->parseCurrentBlock();
        }
 
        // not for objectives/scos
        if (!$this->mode) {
            // tlt warning
            if ($a_set["status"] != ilLPStatus::LP_STATUS_COMPLETED_NUM && $a_set["ref_ids"]) {
                $ref_id = $a_set["ref_ids"];
                $ref_id = array_shift($ref_id);
                $timing = $this->showTimingsWarning(
                    $ref_id,
                    $this->tracked_user->getId()
                );
                if ($timing) {
                    if ($timing !== true) {
                        $timing = ": " . ilDatePresentation::formatDate(
                            new ilDate($timing, IL_CAL_UNIX)
                        );
                    } else {
                        $timing = "";
                    }
                    $this->tpl->setCurrentBlock('warning_img');
                    $this->tpl->setVariable(
                        'WARNING_IMG',
                        ilUtil::getImagePath(
                            'media/time_warn.svg'
                        )
                    );
                    $this->tpl->setVariable(
                        'WARNING_ALT',
                        $this->lng->txt(
                            'trac_time_passed'
                        ) . $timing
                    );
                    $this->tpl->parseCurrentBlock();
                }
            }
 
            // hide / unhide?!
            if (!$this->details) {
                $this->tpl->setCurrentBlock("item_command");
                $this->ctrl->setParameterByClass(
                    get_class($this),
                    'hide',
                    $a_set["obj_id"]
                );
                $this->tpl->setVariable(
                    "HREF_COMMAND",
                    $this->ctrl->getLinkTargetByClass(
                        get_class($this),
                        'hide'
                    )
                );
                $this->tpl->setVariable(
                    "TXT_COMMAND",
                    $this->lng->txt('trac_hide')
                );
                $this->tpl->parseCurrentBlock();
 
                $olp = ilObjectLP::getInstance($a_set["obj_id"]);
                if ($olp->getCollectionInstance() && $a_set["ref_ids"]) {
                    $ref_id = $a_set["ref_ids"];
                    $ref_id = array_shift($ref_id);
                    $this->ctrl->setParameterByClass(
                        $this->ctrl->getCmdClass(),
                        'details_id',
                        $ref_id
                    );
                    $this->tpl->setVariable(
                        "HREF_COMMAND",
                        $this->ctrl->getLinkTargetByClass(
                            $this->ctrl->getCmdClass(),
                            'details'
                        )
                    );
                    $this->ctrl->setParameterByClass(
                        $this->ctrl->getCmdClass(),
                        'details_id',
                        ''
                    );
                    $this->tpl->setVariable(
                        "TXT_COMMAND",
                        $this->lng->txt('trac_subitems')
                    );
                    $this->tpl->parseCurrentBlock();
                }
 
                $this->tpl->setCurrentBlock("column_action");
                $this->tpl->parseCurrentBlock();
            }
        }
    }

References $path, $ref_id, ilObject\_getIcon(), ilLPTableBaseGUI\buildPath(), ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilUtil\getImagePath(), ilObjectLP\getInstance(), ilLPStatusIcons\getInstance(), ilLPStatusIcons\ICON_VARIANT_LONG, IL_CAL_DATETIME, IL_CAL_UNIX, ILIAS\Repository\lng(), ilLPObjSettings\LP_MODE_SCORM, ilLPStatus\LP_STATUS_COMPLETED_NUM, and ilLPTableBaseGUI\showTimingsWarning().

Here is the call graph for this function:

fillRowCSV()

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

protected

CSV Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

ilCSVWriter	$a_csv	current file
array	$a_set	data array

Reimplemented from ilTable2GUI.

Definition at line 497 of file class.ilLPProgressTableGUI.php.

                                                                   : void
    {
        $a_csv->addColumn($this->lng->txt('obj_' . $a_set["type"]));
        $a_csv->addColumn($a_set["title"]);
        $a_csv->addColumn(
            ilLearningProgressBaseGUI::_getStatusText($a_set["status"])
        );
 
        ilDatePresentation::setUseRelativeDates(false);
        $a_csv->addColumn(
            ilDatePresentation::formatDate(
                new ilDateTime(
                    $a_set['status_changed'],
                    IL_CAL_DATETIME
                )
            )
        );
        ilDatePresentation::resetToDefaults();
 
        if (!$this->isPercentageAvailable($a_set['obj_id'])) {
            $a_csv->addColumn('-');
        } else {
            $a_csv->addColumn(sprintf("%d%%", $a_set["percentage"]));
        }
        $a_csv->addColumn((string) $a_set["mark"]);
        $a_csv->addColumn((string) $a_set["comment"]);
        $a_csv->addColumn(ilLPObjSettings::_mode2Text($a_set["u_mode"]));
 
        $a_csv->addRow();
    }

References ilLearningProgressBaseGUI\_getStatusText(), ilLPObjSettings\_mode2Text(), ilCSVWriter\addColumn(), ilCSVWriter\addRow(), ilDatePresentation\formatDate(), IL_CAL_DATETIME, ILIAS\Repository\lng(), ilDatePresentation\resetToDefaults(), and ilDatePresentation\setUseRelativeDates().

Here is the call graph for this function:

fillRowExcel()

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

protected

Excel Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

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

Reimplemented from ilTable2GUI.

Definition at line 445 of file class.ilLPProgressTableGUI.php.

     : void {
        $a_excel->setCell($a_row, 0, $this->lng->txt('obj_' . $a_set["type"]));
        $a_excel->setCell($a_row, 1, $a_set["title"]);
        $a_excel->setCell(
            $a_row,
            2,
            ilLearningProgressBaseGUI::_getStatusText(
                $a_set["status"]
            )
        );
 
        $a_excel->setCell(
            $a_row,
            3,
            new ilDateTime(
                $a_set['status_changed'],
                IL_CAL_DATETIME
            )
        );
 
        if (!$this->isPercentageAvailable($a_set['obj_id'])) {
            $a_excel->setCell($a_row, 4, '-');
        } else {
            $a_excel->setCell($a_row, 4, $a_set["percentage"] . "%");
        }
        $a_excel->setCell($a_row, 5, (string) $a_set["mark"]);
        $a_excel->setCell($a_row, 6, (string) $a_set["comment"]);
        $a_excel->setCell(
            $a_row,
            7,
            ilLPObjSettings::_mode2Text($a_set["u_mode"])
        );
    }

References ilExcel\setCell().

Here is the call graph for this function:

getItems()

ilLPProgressTableGUI::getItems

(

)

Definition at line 175 of file class.ilLPProgressTableGUI.php.

                              : void
    {
        $data = [];
        $obj_ids = $this->obj_ids;
        if (!$obj_ids && !$this->details) {
            switch ($this->lp_context) {
                case ilLearningProgressGUI::LP_CONTEXT_ORG_UNIT:
                    $obj_ids = $this->searchObjects(
                        $this->getCurrentFilter(true),
                        ''
                    );
                    break;
 
                default:
                    $obj_ids = $this->searchObjects(
                        $this->getCurrentFilter(true),
                        "read"
                    );
 
                    // check for LP relevance
                    foreach (ilObjectLP::getLPMemberships(
                        $this->tracked_user->getId(),
                        $obj_ids,
                        null,
                        true
                    ) as $obj_id => $status) {
                        if (!$status) {
                            unset($obj_ids[$obj_id]);
                        }
                    }
                    break;
            }
        }
        if ($obj_ids) {
            switch ($this->mode) {
                case ilLPObjSettings::LP_MODE_SCORM:
                    $data = ilTrQuery::getSCOsStatusForUser(
                        $this->tracked_user->getId(),
                        $this->parent_obj_id,
                        $obj_ids
                    );
                    break;
 
                case ilLPObjSettings::LP_MODE_OBJECTIVES:
                    $data = ilTrQuery::getObjectivesStatusForUser(
                        $this->tracked_user->getId(),
                        $this->parent_obj_id,
                        $obj_ids
                    );
                    break;
 
                case ilLPObjSettings::LP_MODE_COLLECTION_MANUAL:
                case ilLPObjSettings::LP_MODE_COLLECTION_TLT:
                case ilLPObjSettings::LP_MODE_COLLECTION_MOBS:
                    if ($this->tracked_user) {
                        $data = ilTrQuery::getSubItemsStatusForUser(
                            $this->tracked_user->getId(),
                            $this->parent_obj_id,
                            $obj_ids
                        );
                    }
                    break;
 
                default:
                    $data = ilTrQuery::getObjectsStatusForUser(
                        $this->tracked_user->getId(),
                        $obj_ids
                    );
                    foreach ($data as $idx => $item) {
                        if (!($item["status"] ?? false) && !($this->filter["status"] ?? false) && !$this->details) {
                            unset($data[$idx]);
                        } else {
                            $data[$idx]["offline"] = ilLearningProgressBaseGUI::isObjectOffline(
                                $item["obj_id"],
                                $item["type"]
                            );
                        }
                    }
                    break;
            }
 
            // #15334
            foreach ($data as $idx => $row) {
                if (!$this->isPercentageAvailable($row["obj_id"] ?? 0)) {
                    // #17000 - enable proper (numeric) sorting
                    $data[$idx]["percentage"] = -1;
                }
            }
            $this->setData($data);
        }
    }

References ilTableGUI\$data, $obj_id, $obj_ids, ILIAS\Repository\filter(), ilLPTableBaseGUI\getCurrentFilter(), ilObjectLP\getLPMemberships(), ilTrQuery\getObjectivesStatusForUser(), ilTrQuery\getObjectsStatusForUser(), ilTrQuery\getSCOsStatusForUser(), ilTrQuery\getSubItemsStatusForUser(), ilLearningProgressBaseGUI\isObjectOffline(), ilLPTableBaseGUI\isPercentageAvailable(), ilLearningProgressBaseGUI\LP_CONTEXT_ORG_UNIT, ilLPObjSettings\LP_MODE_COLLECTION_MANUAL, ilLPObjSettings\LP_MODE_COLLECTION_MOBS, ilLPObjSettings\LP_MODE_COLLECTION_TLT, ilLPObjSettings\LP_MODE_OBJECTIVES, ilLPObjSettings\LP_MODE_SCORM, ilLPTableBaseGUI\searchObjects(), and ilTable2GUI\setData().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

numericOrdering()

ilLPProgressTableGUI::numericOrdering

(

string

$a_field

)

Should this field be sorted numeric?

Reimplemented from ilTable2GUI.

Definition at line 170 of file class.ilLPProgressTableGUI.php.

                                                    : bool
    {
        return $a_field == "percentage";
    }

Field Documentation

$details

bool ilLPProgressTableGUI::$details = false

protected

Definition at line 31 of file class.ilLPProgressTableGUI.php.

Referenced by __construct().

$has_object_subitems

bool ilLPProgressTableGUI::$has_object_subitems = false

protected

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

$lp_context

int ilLPProgressTableGUI::$lp_context = 0

protected

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

Referenced by __construct().

$mode

int ilLPProgressTableGUI::$mode = 0

protected

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

Referenced by __construct().

$obj_id

int ilLPProgressTableGUI::$obj_id = 0

protected

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

Referenced by getItems().

$obj_ids

array ilLPProgressTableGUI::$obj_ids = null

protected

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

Referenced by __construct(), and getItems().

$parent_obj_id

int ilLPProgressTableGUI::$parent_obj_id = 0

protected

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

Referenced by __construct().

$ref_id

int ilLPProgressTableGUI::$ref_id = 0

protected

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

Referenced by fillRow().

$tracked_user

ilObjUser ilLPProgressTableGUI::$tracked_user = null

protected

Definition at line 29 of file class.ilLPProgressTableGUI.php.

Referenced by __construct().

---

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

• components/ILIAS/Tracking/classes/repository_statistics/class.ilLPProgressTableGUI.php