ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
ilLPTableBaseGUI Class Reference

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="")
 Constructor. More...
 
 executeCommand ()
 Execute command. More...
 
 searchFilterListener ($a_ref_id, $a_data)
 Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED @access public. More...
 
 initFilter ($a_split_learning_resources=false, $a_include_no_status_filter=true)
 Init filter. More...
 
 getCurrentFilter ($as_query=false)
 
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 Constructor. More...
 
 setOpenFormTag ($a_val)
 Set open form tag. More...
 
 getOpenFormTag ()
 Get open form tag. More...
 
 setCloseFormTag ($a_val)
 Set close form tag. More...
 
 getCloseFormTag ()
 Get close form tag. More...
 
 determineLimit ()
 Determine the limit. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 Determine selected columns. More...
 
 isColumnSelected ($a_col)
 Is given column selected? More...
 
 getSelectedColumns ()
 Get selected columns. More...
 
executeCommand ()
 Execute command. More...
 
 resetOffset ($a_in_determination=false)
 Reset offset. More...
 
 initFilter ()
 Init filter. More...
 
 getParentObject ()
 Get parent object. More...
 
 getParentCmd ()
 Get parent command. More...
 
 setTopAnchor ($a_val)
 Set top anchor. More...
 
 getTopAnchor ()
 Get top anchor. More...
 
 setNoEntriesText ($a_text)
 Set text for an empty table. More...
 
 getNoEntriesText ()
 Get text for an empty table. More...
 
 setIsDataTable ($a_val)
 Set is data table. More...
 
 getIsDataTable ()
 Get is data table. More...
 
 setEnableTitle ($a_enabletitle)
 Set Enable Title. More...
 
 getEnableTitle ()
 Get Enable Title. More...
 
 setEnableHeader ($a_enableheader)
 Set Enable Header. More...
 
 getEnableHeader ()
 Get Enable Header. More...
 
 setEnableNumInfo ($a_val)
 Set enable num info. More...
 
 getEnableNumInfo ()
 Get enable num info. More...
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon. More...
 
 setDescription ($a_val)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 setOrderField ($a_order_field)
 set order column More...
 
 getOrderField ()
 
 setData ($a_data)
 set table data @access public More...
 
 getData ()
 
 dataExists ()
 
 setPrefix ($a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More...
 
 getPrefix ()
 
 addFilterItem ($a_input_item, $a_optional=false)
 Add filter item. More...
 
 addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
 Add filter by standard type. More...
 
 getFilterItems ($a_optionals=false)
 Get filter items. More...
 
 getFilterItemByPostVar ($a_post_var)
 
 setFilterCols ($a_val)
 Set filter columns. More...
 
 getFilterCols ()
 Get filter columns. More...
 
 setDisableFilterHiding ($a_val=true)
 Set disable filter hiding. More...
 
 getDisableFilterHiding ()
 Get disable filter hiding
More...
 
 isFilterSelected ($a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 Get selected filters. More...
 
 determineSelectedFilters ()
 Determine selected filters. More...
 
 setCustomPreviousNext ($a_prev_link, $a_next_link)
 Set custom previous/next links. More...
 
 setFormAction ($a_form_action, $a_multipart=false)
 Set Form action parameter. More...
 
 getFormAction ()
 Get Form action parameter. More...
 
 setFormName ($a_formname)
 Set Form name. More...
 
 getFormName ()
 Get Form name. More...
 
 setId ($a_val)
 Set id. More...
 
 getId ()
 Get element id. More...
 
 setDisplayAsBlock ($a_val)
 Set display as block. More...
 
 getDisplayAsBlock ()
 Get display as block. More...
 
 getSelectAllCheckbox ()
 Get the name of the checkbox that should be toggled with a select all button. More...
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 Set the name of the checkbox that should be toggled with a select all button. More...
 
 setExternalSorting ($a_val)
 Set external sorting. More...
 
 getExternalSorting ()
 Get external sorting. More...
 
 setFilterCommand ($a_val, $a_caption=null)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val, $a_caption=null)
 Set reset filter command. More...
 
 getResetCommand ()
 Get reset filter command. More...
 
 setExternalSegmentation ($a_val)
 Set external segmentation. More...
 
 getExternalSegmentation ()
 Get external segmentation. More...
 
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field. More...
 
 getDefaultOrderField ()
 Get Default order field. More...
 
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction. More...
 
 getDefaultOrderDirection ()
 Get Default order direction. More...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButton $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="")
 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...
 
- Public Member Functions inherited from ilTableGUI
 ilTableGUI ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate (&$a_tpl)
 set template @access public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data @access public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title @access public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page @access public More...
 
 setHeaderNames ($a_header_names)
 set table header names @access public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns @access public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars @access public More...
 
 setColumnWidth ($a_column_width)
 set table column widths @access public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width @access public More...
 
 setMaxCount ($a_max_count)
 set max. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
 getLimit ()
 Get limit. More...
 
 setPrefix ($a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More...
 
 setOffset ($a_offset)
 set dataset offset @access public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column @access public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction @access public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction @access public More...
 
 enable ($a_module_name)
 enables particular modules of table More...
 
 disable ($a_module_name)
 diesables particular modules of table More...
 
 sortData ()
 
 render ()
 render table @access public More...
 
 renderHeader ()
 
 setOrderLink ($key, $order_dir)
 
 setStyle ($a_element, $a_style)
 
 getStyle ($a_element)
 
 setBase ($a_base)
 Set Base script name (deprecated, only use this for workarounds). More...
 
 getBase ()
 Get Base script name (deprecated, only use this for workarounds). More...
 
 getFormName ()
 
 setFormName ($a_name="cmd")
 
 getSelectAllCheckbox ()
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton ($btn_name, $btn_value)
 

Protected Member Functions

 searchObjects (array $filter, $permission, array $preset_obj_ids=null)
 Search objects that match current filters. More...
 
 buildPath ($ref_ids)
 Build path with deep-link. More...
 
 getPossibleTypes ($a_split_learning_resources=false, $a_include_digilib=false, $a_allow_undefined_lp=false)
 Get possible subtypes. More...
 
 parseValue ($id, $value, $type)
 
 isPercentageAvailable ($a_obj_id)
 
 parseTitle ($a_obj_id, $action, $a_user_id=false)
 
 getExportMeta ()
 Build export meta data. More...
 
 fillMetaExcel ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 showTimingsWarning ($a_ref_id, $a_user_id)
 
 formatSeconds ($seconds, $a_shorten_zero=false)
 
 anonymizeValue ($a_value, $a_force_number=false)
 
 buildValueScale ($a_max_value, $a_anonymize=false, $a_format_seconds=false)
 
 getMonthsFilter ($a_short=false)
 
 getMonthsYear ($a_year=null, $a_short=false)
 
 getSelectableUserColumns ($a_in_course=false, $a_in_group=false)
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel ($a_worksheet, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 

Protected Attributes

 $filter
 
 $anonymized
 
- Protected Attributes inherited from ilTable2GUI
 $close_command = ""
 
 $top_anchor = "il_table_top"
 
 $filters = array()
 
 $optional_filters = array()
 
 $filter_cmd = 'applyFilter'
 
 $reset_cmd = 'resetFilter'
 
 $filter_cols = 5
 
 $ext_sort = false
 
 $ext_seg = false
 
 $context = ""
 
 $mi_sel_buttons = null
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = true
 
 $nav_determined = false
 
 $limit_determined = false
 
 $filters_determined = false
 
 $columns_determined = false
 
 $open_form_tag = true
 
 $close_form_tag = true
 
 $export_formats
 
 $export_mode
 
 $print_mode
 
 $enable_command_for_all
 
 $restore_filter
 
 $restore_filter_values
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- Data Fields inherited from ilTable2GUI
const FILTER_TEXT = 1
 
const FILTER_SELECT = 2
 
const FILTER_DATE = 3
 
const FILTER_LANGUAGE = 4
 
const FILTER_NUMBER_RANGE = 5
 
const FILTER_DATE_RANGE = 6
 
const FILTER_DURATION_RANGE = 7
 
const FILTER_DATETIME_RANGE = 8
 
const EXPORT_EXCEL = 1
 
const EXPORT_CSV = 2
 
const ACTION_ALL_LIMIT = 1000
 
- Data Fields inherited from ilTableGUI
 $title
 
 $icon
 
 $icon_alt
 
 $help_page
 
 $help_icon
 
 $help_icon_alt
 
 $header_names
 
 $header_vars
 
 $linkbar_vars
 
 $data
 
 $column_count
 
 $column_width
 
 $max_count
 
 $limit
 
 $max_limit = false
 
 $offset
 
 $order_column
 
 $order_direction
 
 $footer_style
 
 $footer_previous
 
 $footer_next
 
 $lang_support = true
 
 $global_tpl
 
 $form_name
 
 $select_all_checkbox
 
 $action_buttons
 
 $prefix
 
 $base = ""
 
 $enabled
 
 $styles
 

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Reimplemented from ilTable2GUI.

Reimplemented in ilTrMatrixTableGUI.

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

21 {
22 parent::__construct($a_parent_obj, $a_parent_cmd, $a_template_context);
23
24 // country names
25 $this->lng->loadLanguageModule("meta");
26
27 include_once("./Services/Object/classes/class.ilObjectLP.php");
28
29 $this->anonymized = (bool)!ilObjUserTracking::_enabledUserRelatedData();
30 if(!$this->anonymized && $this->obj_id)
31 {
32 include_once "Services/Object/classes/class.ilObjectLP.php";
33 $olp = ilObjectLP::getInstance($this->obj_id);
34 $this->anonymized = $olp->isAnonymized();
35 }
36 }
static _enabledUserRelatedData()
check wether user related tracking is enabled or not
static getInstance($a_obj_id)

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

+ Here is the call graph for this function:

Member Function Documentation

◆ anonymizeValue()

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

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

733 {
734 // currently inactive
735 return $a_value;
736
737 if(is_numeric($a_value))
738 {
739 $threshold = 3;
740 $a_value = (int)$a_value;
741 if($a_value <= $threshold)
742 {
743 if(!$a_force_number)
744 {
745 return "0-".$threshold;
746 }
747 else
748 {
749 return $threshold;
750 }
751 }
752 }
753 return $a_value;
754 }

Referenced by buildValueScale(), ilLPObjectStatisticsDailyTableGUI\fillRow(), ilLPObjectStatisticsLPTableGUI\fillRow(), ilLPObjectStatisticsTableGUI\fillRow(), ilLPObjectStatisticsTypesTableGUI\fillRow(), ilLPObjectStatisticsDailyTableGUI\fillRowCSV(), ilLPObjectStatisticsTableGUI\fillRowCSV(), ilLPObjectStatisticsTypesTableGUI\fillRowCSV(), ilLPObjectStatisticsDailyTableGUI\fillRowExcel(), ilLPObjectStatisticsTableGUI\fillRowExcel(), ilLPObjectStatisticsTypesTableGUI\fillRowExcel(), ilLPObjectStatisticsDailyTableGUI\getGraph(), ilLPObjectStatisticsLPTableGUI\getGraph(), and ilLPObjectStatisticsTableGUI\getGraph().

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

289 {
290 global $tree, $ilCtrl;
291
292 include_once './Services/Link/classes/class.ilLink.php';
293
294 if(!count($ref_ids))
295 {
296 return false;
297 }
298 foreach($ref_ids as $ref_id)
299 {
300 $path = "...";
301 $counter = 0;
302 $path_full = $tree->getPathFull($ref_id);
303 foreach($path_full as $data)
304 {
305 if(++$counter < (count($path_full)-1))
306 {
307 continue;
308 }
309 $path .= " &raquo; ";
310 if($ref_id != $data['ref_id'])
311 {
312 $path .= $data['title'];
313 }
314 else
315 {
316 $path .= ('<a target="_top" href="'.
317 ilLink::_getLink($data['ref_id'],$data['type']).'">'.
318 $data['title'].'</a>');
319 }
320 }
321
323 }
324 return $result;
325 }
$result
global $ilCtrl
Definition: ilias.php:18
$ref_id
Definition: sahs_server.php:39
$path
Definition: index.php:22

References ilTableGUI\$data, $ilCtrl, $path, $ref_id, $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 756 of file class.ilLPTableBaseGUI.php.

757 {
758 $step = 0;
759 if($a_max_value)
760 {
761 $step = $a_max_value / 10;
762 $base = ceil(log($step, 10));
763 $fac = ceil($step / pow(10, ($base - 1)));
764 $step = pow(10, $base - 1) * $fac;
765 }
766 if ($step <= 1)
767 {
768 $step = 1;
769 }
770 $ticks = range(0, $a_max_value+$step, $step);
771
772 $value_ticks = array(0 => 0);
773 foreach($ticks as $tick)
774 {
775 $value = $tvalue = $tick;
776 if($a_anonymize)
777 {
778 $value = $this->anonymizeValue($value, true);
779 $tvalue = $this->anonymizeValue($tvalue);
780 }
781 if($a_format_seconds)
782 {
783 $tvalue = $this->formatSeconds($value);
784 }
785 $value_ticks[$value] = $tvalue;
786 }
787
788 return $value_ticks;
789 }
formatSeconds($seconds, $a_shorten_zero=false)
anonymizeValue($a_value, $a_force_number=false)

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.

39 {
40 global $ilCtrl;
41
43
44 if(!$ilCtrl->getNextClass($this))
45 {
46 $to_hide = false;
47
48 switch($ilCtrl->getCmd())
49 {
50 case "applyFilter":
51 $this->resetOffset();
52 $this->writeFilterToSession();
53 break;
54
55 case "resetFilter":
56 $this->resetOffset();
57 $this->resetFilter();
58 break;
59
60 case "hideSelected":
61 $to_hide = $_POST["item_id"];
62 break;
63
64 case "hide":
65 $to_hide = array((int)$_GET["hide"]);
66 break;
67
68 // page selector
69 default:
71 $this->storeNavParameter();
72 break;
73 }
74
75 if($to_hide)
76 {
77 $obj = $this->getFilterItemByPostVar("hide");
78 $value = array_unique(array_merge((array)$obj->getValue(), $to_hide));
79 $obj->setValue($value);
80 $obj->writeToSession();
81 }
82
83 if(isset($_REQUEST["tbltplcrt"]))
84 {
85 $ilCtrl->setParameter($this->parent_obj, "tbltplcrt", $_REQUEST["tbltplcrt"]);
86 }
87 if(isset($_REQUEST["tbltpldel"]))
88 {
89 $ilCtrl->setParameter($this->parent_obj, "tbltpldel", $_REQUEST["tbltpldel"]);
90 }
91
92 $ilCtrl->redirect($this->parent_obj, $this->parent_cmd);
93 }
94 else
95 {
96 // e.g. repository selector
97 return parent::executeCommand();
98 }
99 }
$_GET["client_id"]
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
resetOffset($a_in_determination=false)
Reset offset.
getFilterItemByPostVar($a_post_var)
resetFilter()
Reset filter.
writeFilterToSession()
Write filter values to session.
determineSelectedFilters()
Determine selected filters.
$_POST['username']
Definition: cron.php:12
if($_REQUEST['ilias_path']) define('ILIAS_HTTP_PATH' $_REQUEST['ilias_path']
Definition: index.php:7

References $_GET, $_POST, $_REQUEST, $ilCtrl, ilTable2GUI\determineOffsetAndOrder(), ilTable2GUI\determineSelectedFilters(), ilTable2GUI\getFilterItemByPostVar(), ilTable2GUI\resetFilter(), ilTable2GUI\resetOffset(), 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_csvcurrent file

Reimplemented from ilTable2GUI.

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

678 {
679 foreach($this->getExportMeta() as $caption => $value)
680 {
681 $a_csv->addColumn(strip_tags($caption));
682 $a_csv->addColumn(strip_tags($value));
683 $a_csv->addRow();
684 }
685 $a_csv->addRow();
686 }
getExportMeta()
Build export meta data.

References getExportMeta().

+ Here is the call graph for this function:

◆ fillMetaExcel()

ilLPTableBaseGUI::fillMetaExcel (   $worksheet,
$a_row 
)
protected

Add meta information to excel export.

Likely to be overwritten by derived class.

Parameters
object$a_worksheetcurrent sheet
int$a_rowrow counter

Reimplemented from ilTable2GUI.

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

667 {
668 foreach($this->getExportMeta() as $caption => $value)
669 {
670 $worksheet->write($a_row, 0, $caption);
671 $worksheet->write($a_row, 1, $value);
672 $a_row++;
673 }
674 $a_row++;
675 }

References getExportMeta().

+ Here is the call graph for this function:

◆ formatSeconds()

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

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

711 {
712 $seconds = ((int)$seconds > 0) ? $seconds : 0;
713 if($a_shorten_zero && !$seconds)
714 {
715 return "-";
716 }
717
718 $hours = floor($seconds / 3600);
719 $rest = $seconds % 3600;
720
721 $minutes = floor($rest / 60);
722 $rest = $rest % 60;
723
724 if($rest)
725 {
726 $minutes++;
727 }
728
729 return sprintf("%dh%02dm",$hours,$minutes);
730 }
$rest
Definition: goto.php:85

References $rest.

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

486 {
487 $result = array();
488 foreach($this->filter as $id => $value)
489 {
490 $item = $this->getFilterItemByPostVar($id);
491 switch($id)
492 {
493 case "title":
494 case "country":
495 case "gender":
496 case "city":
497 case "language":
498 case "login":
499 case "firstname":
500 case "lastname":
501 case "mark":
502 case "u_comment":
503 case "institution":
504 case "department":
505 case "title":
506 case "street":
507 case "zipcode":
508 case "email":
509 case "matriculation":
510 case "sel_country":
511 case "query":
512 case "type":
513 case "area":
514 if($value)
515 {
516 $result[$id] = $value;
517 }
518 break;
519
520 case "status":
521 if($value !== false)
522 {
523 $result[$id] = $value;
524 }
525 break;
526
527 case "user_total":
528 case "read_count":
529 case "percentage":
530 case "hide":
531 case "spent_seconds":
532 if(is_array($value) && implode("", $value))
533 {
534 $result[$id] = $value;
535 }
536 break;
537
538 case "registration":
539 case "create_date":
540 case "first_access":
541 case "last_access":
542 case 'status_changed':
543 if($value)
544 {
545 if($value["from"])
546 {
547 $result[$id]["from"] = $value["from"]->get(IL_CAL_DATETIME);
548 }
549 if($value["to"])
550 {
551 $result[$id]["to"] = $value["to"]->get(IL_CAL_DATETIME);
552 }
553 }
554 break;
555
556 case "birthday":
557 if($value)
558 {
559 if($value["from"])
560 {
561 $result[$id]["from"] = $value["from"]->get(IL_CAL_DATETIME);
562 $result[$id]["from"] = substr($result[$id]["from"], 0, -8)."00:00:00";
563 }
564 if($value["to"])
565 {
566 $result[$id]["to"] = $value["to"]->get(IL_CAL_DATETIME);
567 $result[$id]["to"] = substr($result[$id]["to"], 0, -8)."23:59:59";
568 }
569 }
570 break;
571 }
572 }
573
574 return $result;
575 }
const IL_CAL_DATETIME

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

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

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

630 {
631 global $lng, $ilObjDataCache, $ilUser, $ilClientIniFile;
632
633 /* see spec
634 Name of installation
635 Name of the course
636 Permalink to course
637 Owner of course object
638 Date of report generation
639 Reporting period
640 Name of person who generated the report.
641 */
642
644 include_once './Services/Link/classes/class.ilLink.php';
645
646 $data = array();
647 $data[$lng->txt("trac_name_of_installation")] = $ilClientIniFile->readVariable('client', 'name');
648
649 if($this->obj_id)
650 {
651 $data[$lng->txt("trac_object_name")] = $ilObjDataCache->lookupTitle($this->obj_id);
652 if($this->ref_id)
653 {
654 $data[$lng->txt("trac_object_link")] = ilLink::_getLink($this->ref_id, ilObject::_lookupType($this->obj_id));
655 }
656 $data[$lng->txt("trac_object_owner")] = ilObjUser::_lookupFullname(ilObject::_lookupOwner($this->obj_id));
657 }
658
659 $data[$lng->txt("trac_report_date")] =
661 $data[$lng->txt("trac_report_owner")] = $ilUser->getFullName();
662
663 return $data;
664 }
const IL_CAL_UNIX
static setUseRelativeDates($a_status)
set use relative dates
static formatDate(ilDateTime $date)
Format a date @access public.
@classDescription Date and time handling
_lookupFullname($a_user_id)
Lookup Full Name.
_lookupOwner($a_id)
lookup object owner
static _lookupType($a_id, $a_reference=false)
lookup object type
global $lng
Definition: privfeed.php:40
global $ilUser
Definition: imgupload.php:15

References ilTableGUI\$data, $ilUser, $lng, ilLink\_getLink(), ilObjUser\_lookupFullname(), ilObject\_lookupOwner(), ilObject\_lookupType(), ilDatePresentation\formatDate(), IL_CAL_DATETIME, 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 791 of file class.ilLPTableBaseGUI.php.

792 {
793 global $lng;
794
795 $options = array();
796 for($loop = 0; $loop < 10; $loop++)
797 {
798 $year = date("Y")-$loop;
799 $options[$year] = $year;
800 for($loop2 = 12; $loop2 > 0; $loop2--)
801 {
802 $month = str_pad($loop2, 2, "0", STR_PAD_LEFT);
803 if($year.$month <= date("Ym"))
804 {
805 if(!$a_short)
806 {
807 $caption = $year." / ".$lng->txt("month_".$month."_long");
808 }
809 else
810 {
811 $caption = $year."/".$month;
812 }
813 $options[$year."-".$month] = $caption;
814 }
815 }
816 }
817 return $options;
818 }
if(!is_array($argv)) $options

References $lng, and $options.

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

821 {
822 global $lng;
823
824 if(!$a_year)
825 {
826 $a_year = date("Y");
827 }
828
829 $all = array();
830 for($loop = 1; $loop<13; $loop++)
831 {
832 $month = str_pad($loop, 2, "0", STR_PAD_LEFT);
833 if($a_year."-".$month <= date("Y-m"))
834 {
835 if(!$a_short)
836 {
837 $caption = $lng->txt("month_".$month."_long");
838 }
839 else
840 {
841 $caption = $lng->txt("month_".$month."_short");
842 }
843 $all[$a_year."-".$month] = $caption;
844 }
845 }
846 return $all;
847 }

References $lng.

Referenced by ilLPObjectStatisticsTableGUI\__construct(), ilLPObjectStatisticsTypesTableGUI\__construct(), ilLPObjectStatisticsLPTableGUI\__construct(), ilLPObjectStatisticsLPTableGUI\fillRow(), ilLPObjectStatisticsTableGUI\fillRow(), ilLPObjectStatisticsTypesTableGUI\fillRow(), ilLPObjectStatisticsTableGUI\fillRowCSV(), ilLPObjectStatisticsTypesTableGUI\fillRowCSV(), ilLPObjectStatisticsTableGUI\fillRowExcel(), ilLPObjectStatisticsTypesTableGUI\fillRowExcel(), ilLPObjectStatisticsLPTableGUI\getGraph(), ilLPObjectStatisticsTableGUI\getGraph(), ilLPObjectStatisticsTypesTableGUI\getGraph(), and ilLPObjectStatisticsLPTableGUI\getItems().

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

335 {
336 global $lng, $ilPluginAdmin;
337
338 $options = array();
339
340 if($a_split_learning_resources)
341 {
342 $options['lm'] = $lng->txt('objs_lm');
343 $options['sahs'] = $lng->txt('objs_sahs');
344 $options['htlm'] = $lng->txt('objs_htlm');
345
346 if($a_include_digilib)
347 {
348 $options['dbk'] = $lng->txt('objs_dbk');
349 }
350 }
351 else
352 {
353 $options['lres'] = $lng->txt('learning_resources');
354 }
355
356 $options['crs'] = $lng->txt('objs_crs');
357 $options['grp'] = $lng->txt('objs_grp');
358 $options['exc'] = $lng->txt('objs_exc');
359 $options['tst'] = $lng->txt('objs_tst');
360
361 if($a_allow_undefined_lp)
362 {
363 $options["file"] = $lng->txt("objs_file");
364 $options["webr"] = $lng->txt("objs_webr");
365 $options["wiki"] = $lng->txt("objs_wiki");
366 }
367
368 // repository plugins (currently only active)
369 include_once 'Services/Repository/classes/class.ilRepositoryObjectPluginSlot.php';
370 $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "Repository", "robj");
371 foreach ($pl_names as $pl)
372 {
373 $pl_id = $ilPluginAdmin->getId(IL_COMP_SERVICE, "Repository", "robj", $pl);
375 {
376 $options[$pl_id] = ilPlugin::lookupTxt("rep_robj", $pl_id, "objs_".$pl_id);
377 }
378 }
379
380 asort($options);
381 return $options;
382 }
const IL_COMP_SERVICE
static lookupTxt($a_mod_prefix, $a_pl_id, $a_lang_var)
Lookup language text.
static isTypePluginWithLP($a_type, $a_active_status=true)
Check whether a repository type is a plugin which has active learning progress.

References $lng, $options, IL_COMP_SERVICE, ilRepositoryObjectPluginSlot\isTypePluginWithLP(), and ilPlugin\lookupTxt().

Referenced by initFilter(), 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 849 of file class.ilLPTableBaseGUI.php.

850 {
851 global $lng, $ilSetting;
852
853 $cols = $privacy_fields = array();
854
855 include_once("./Services/User/classes/class.ilUserProfile.php");
856 $up = new ilUserProfile();
857 $up->skipGroup("preferences");
858 $up->skipGroup("settings");
859 $up->skipGroup("interests");
860 $ufs = $up->getStandardFields();
861
862 // default fields
863 $cols["login"] = array(
864 "txt" => $lng->txt("login"),
865 "default" => true);
866
867 if(!$this->anonymized)
868 {
869 $cols["firstname"] = array(
870 "txt" => $lng->txt("firstname"),
871 "default" => true);
872 $cols["lastname"] = array(
873 "txt" => $lng->txt("lastname"),
874 "default" => true);
875 }
876
877 // show only if extended data was activated in lp settings
878 include_once 'Services/Tracking/classes/class.ilObjUserTracking.php';
879 $tracking = new ilObjUserTracking();
880 if($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS))
881 {
882 $cols["first_access"] = array(
883 "txt" => $lng->txt("trac_first_access"),
884 "default" => true);
885 $cols["last_access"] = array(
886 "txt" => $lng->txt("trac_last_access"),
887 "default" => true);
888 }
889 if($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_READ_COUNT))
890 {
891 $cols["read_count"] = array(
892 "txt" => $lng->txt("trac_read_count"),
893 "default" => true);
894 }
895 if($tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS))
896 {
897 $cols["spent_seconds"] = array(
898 "txt" => $lng->txt("trac_spent_seconds"),
899 "default" => true);
900 }
901
902 if($this->isPercentageAvailable($this->obj_id))
903 {
904 $cols["percentage"] = array(
905 "txt" => $lng->txt("trac_percentage"),
906 "default" => true);
907 }
908
909 // do not show status if learning progress is deactivated
910 $olp = ilObjectLP::getInstance($this->obj_id);
911 if($olp->isActive())
912 {
913 $cols["status"] = array(
914 "txt" => $lng->txt("trac_status"),
915 "default" => true);
916
917 $cols['status_changed'] = array(
918 'txt' => $lng->txt('trac_status_changed'),
919 'default' => false);
920 }
921
922 if($this->type != "lm")
923 {
924 $cols["mark"] = array(
925 "txt" => $lng->txt("trac_mark"),
926 "default" => true);
927 }
928
929 $cols["u_comment"] = array(
930 "txt" => $lng->txt("trac_comment"),
931 "default" => false);
932
933 $cols["create_date"] = array(
934 "txt" => $lng->txt("create_date"),
935 "default" => false);
936 $cols["language"] = array(
937 "txt" => $lng->txt("language"),
938 "default" => false);
939
940 // add user data only if object is [part of] course
941 if(!$this->anonymized &&
942 ($a_in_course || $a_in_group))
943 {
944 // only show if export permission is granted
945 include_once('Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
946 if(ilPrivacySettings::_getInstance()->checkExportAccess($this->ref_id))
947 {
948 // other user profile fields
949 foreach ($ufs as $f => $fd)
950 {
951 if (!isset($cols[$f]) && $f != "username" && !$fd["lists_hide"])
952 {
953 if($a_in_course &&
954 !($fd["course_export_fix_value"] || $ilSetting->get("usr_settings_course_export_".$f)))
955 {
956 continue;
957 }
958 if($a_in_group &&
959 !($fd["group_export_fix_value"] || $ilSetting->get("usr_settings_group_export_".$f)))
960 {
961 continue;
962 }
963
964 $cols[$f] = array(
965 "txt" => $lng->txt($f),
966 "default" => false);
967
968 $privacy_fields[] = $f;
969 }
970 }
971
972 // additional defined user data fields
973 include_once './Services/User/classes/class.ilUserDefinedFields.php';
974 $user_defined_fields = ilUserDefinedFields::_getInstance();
975 if($a_in_course)
976 {
977 $user_defined_fields = $user_defined_fields->getCourseExportableFields();
978 }
979 else
980 {
981 $user_defined_fields = $user_defined_fields->getGroupExportableFields();
982 }
983 foreach($user_defined_fields as $definition)
984 {
985 if($definition["field_type"] != UDF_TYPE_WYSIWYG)
986 {
987 $f = "udf_".$definition["field_id"];
988 $cols[$f] = array(
989 "txt" => $definition["field_name"],
990 "default" => false);
991
992 $privacy_fields[] = $f;
993 }
994 }
995 }
996 }
997
998 return array($cols, $privacy_fields);
999 }
const UDF_TYPE_WYSIWYG
static _getInstance()
Get instance of ilPrivacySettings.
static _getInstance()
Get instance.
Class ilUserProfile.
global $ilSetting
Definition: privfeed.php:40

References $ilSetting, $lng, ilPrivacySettings\_getInstance(), ilUserDefinedFields\_getInstance(), ilObjUserTracking\EXTENDED_DATA_LAST_ACCESS, ilObjUserTracking\EXTENDED_DATA_READ_COUNT, ilObjUserTracking\EXTENDED_DATA_SPENT_SECONDS, ilObjectLP\getInstance(), isPercentageAvailable(), 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:

◆ initFilter()

ilLPTableBaseGUI::initFilter (   $a_split_learning_resources = false,
  $a_include_no_status_filter = true 
)

Init filter.

Parameters
bool$a_split_learning_resources

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

207 {
208 global $lng, $ilObjDataCache;
209
210 $this->setDisableFilterHiding(true);
211
212 // object type selection
213 include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
214 $si = new ilSelectInputGUI($this->lng->txt("obj_type"), "type");
215 $si->setOptions($this->getPossibleTypes($a_split_learning_resources));
216 $this->addFilterItem($si);
217 $si->readFromSession();
218 if(!$si->getValue())
219 {
220 $si->setValue("crs");
221 }
222 $this->filter["type"] = $si->getValue();
223
224 // hidden items
225 include_once("./Services/Form/classes/class.ilMultiSelectInputGUI.php");
226 $msi = new ilMultiSelectInputGUI($lng->txt("trac_filter_hidden"), "hide");
227 $this->addFilterItem($msi);
228 $msi->readFromSession();
229 $this->filter["hide"] = $msi->getValue();
230 if($this->filter["hide"])
231 {
232 // create options from current value
233 $types = $this->getCurrentFilter(true);
234 $type = $types["type"];
235 $options = array();
236 if($type == 'lres')
237 {
238 $type = array('lm','sahs','htlm','dbk');
239 }
240 else
241 {
242 $type = array($type);
243 }
244 foreach($this->filter["hide"] as $obj_id)
245 {
246 if(in_array($ilObjDataCache->lookupType($obj_id), $type))
247 {
248 $options[$obj_id] = $ilObjDataCache->lookupTitle($obj_id);
249 }
250 }
251 $msi->setOptions($options);
252 }
253
254 // title/description
255 include_once("./Services/Form/classes/class.ilTextInputGUI.php");
256 $ti = new ilTextInputGUI($lng->txt("trac_title_description"), "query");
257 $ti->setMaxLength(64);
258 $ti->setSize(20);
259 $this->addFilterItem($ti);
260 $ti->readFromSession();
261 $this->filter["query"] = $ti->getValue();
262
263 // repository area selection
264 include_once("./Services/Form/classes/class.ilRepositorySelectorInputGUI.php");
265 $rs = new ilRepositorySelectorInputGUI($lng->txt("trac_filter_area"), "area");
266 $rs->setSelectText($lng->txt("trac_select_area"));
267 $this->addFilterItem($rs);
268 $rs->readFromSession();
269 $this->filter["area"] = $rs->getValue();
270
271 // hide "not started yet"
272 if($a_include_no_status_filter)
273 {
274 include_once("./Services/Form/classes/class.ilCheckboxInputGUI.php");
275 $cb = new ilCheckboxInputGUI($lng->txt("trac_filter_has_status"), "status");
276 $this->addFilterItem($cb);
277 $cb->readFromSession();
278 $this->filter["status"] = $cb->getChecked();
279 }
280 }
This class represents a checkbox property in a property form.
getCurrentFilter($as_query=false)
getPossibleTypes($a_split_learning_resources=false, $a_include_digilib=false, $a_allow_undefined_lp=false)
Get possible subtypes.
This class represents a multi selection list property in a property form.
This class represents a repository selector in a property form.
This class represents a selection list property in a property form.
setDisableFilterHiding($a_val=true)
Set disable filter hiding.
addFilterItem($a_input_item, $a_optional=false)
Add filter item.
This class represents a text property in a property form.

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

+ Here is the call graph for this function:

◆ isPercentageAvailable()

ilLPTableBaseGUI::isPercentageAvailable (   $a_obj_id)
protected

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

578 {
579 // :TODO:
580 $olp = ilObjectLP::getInstance($a_obj_id);
581 $mode = $olp->getCurrentMode();
582 if(in_array($mode, array(ilLPObjSettings::LP_MODE_TLT,
584 // ilLPObjSettings::LP_MODE_OBJECTIVES,
587 {
588 return true;
589 }
590 return false;
591 }

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

Referenced by ilLPProgressTableGUI\fillRow(), ilTrSummaryTableGUI\fillRow(), ilTrUserObjectsPropsTableGUI\fillRow(), ilTrSummaryTableGUI\getItems(), and getSelectableUserColumns().

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

594 {
595 global $lng, $ilObjDataCache, $ilUser;
596
597 $user = "";
598 if($a_user_id)
599 {
600 if($a_user_id != $ilUser->getId())
601 {
602 $a_user = ilObjectFactory::getInstanceByObjId($a_user_id);
603 }
604 else
605 {
606 $a_user = $ilUser;
607 }
608 $user .= ", ".$a_user->getFullName(); // " [".$a_user->getLogin()."]";
609 }
610
611 if($a_obj_id != ROOT_FOLDER_ID)
612 {
613 $this->setTitle($lng->txt($action).": ".$ilObjDataCache->lookupTitle($a_obj_id).$user);
614
615 $olp = ilObjectLP::getInstance($a_obj_id);
616 $this->setDescription($this->lng->txt('trac_mode').": ".$olp->getModeText($olp->getCurrentMode()));
617 }
618 else
619 {
620 $this->setTitle($lng->txt($action));
621 }
622 }
getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
setDescription($a_val)
Set description.

References $ilUser, $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 384 of file class.ilLPTableBaseGUI.php.

385 {
386 global $lng;
387
388 // get rid of aggregation
389 $pos = strrpos($id, "_");
390 if($pos !== false)
391 {
392 $function = strtoupper(substr($id, $pos+1));
393 if(in_array($function, array("MIN", "MAX", "SUM", "AVG", "COUNT")))
394 {
395 $id = substr($id, 0, $pos);
396 }
397 }
398
399 if(trim($value) == "" && $id != "status")
400 {
401 if($id == "title" &&
402 get_class($this) != "ilTrObjectUsersPropsTableGUI" &&
403 get_class($this) != "ilTrMatrixTableGUI")
404 {
405 return "--".$lng->txt("none")."--";
406 }
407 return " ";
408 }
409
410 switch($id)
411 {
412 case "first_access":
413 case "create_date":
414 case 'status_changed':
416 break;
417
418 case "last_access":
420 break;
421
422 case "birthday":
424 break;
425
426 case "spent_seconds":
427 if(in_array($type, array("exc")))
428 {
429 $value = "-";
430 }
431 else
432 {
433 include_once("./Services/Utilities/classes/class.ilFormat.php");
434 $value = ilFormat::_secondsToString($value, ($value < 3600 ? true : false)); // #14858
435 }
436 break;
437
438 case "percentage":
439 /* :TODO:
440 if(in_array(strtolower($this->status_class),
441 array("illpstatusmanual", "illpstatusscormpackage", "illpstatustestfinished")) ||
442 $type == "exc"))
443 */
444 if(false)
445 {
446 $value = "-";
447 }
448 else
449 {
450 $value = $value."%";
451 }
452 break;
453
454 case "mark":
455 if(in_array($type, array("lm", "dbk")))
456 {
457 $value = "-";
458 }
459 break;
460
461 case "gender":
462 $value = $lng->txt("gender_".$value);
463 break;
464
465 case "status":
466 include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
469 $value = ilUtil::img($path, $text);
470 break;
471
472 case "language":
473 $lng->loadLanguageModule("meta");
474 $value = $lng->txt("meta_l_".$value);
475 break;
476
477 case "sel_country":
478 $value = $lng->txt("meta_c_".$value);
479 break;
480 }
481
482 return $value;
483 }
const IL_CAL_DATE
Class for single dates.
_secondsToString($seconds, $force_with_seconds=false, $a_lng=null)
converts seconds to string: Long: 7 days 4 hour(s) ...
_getImagePathForStatus($a_status)
Get image path for status.
_getStatusText($a_status)
Get status alt text.
static img($a_src, $a_alt="", $a_width="", $a_height="", $a_border=0, $a_id="", $a_class="")
Build img tag.

References $lng, $path, ilLearningProgressBaseGUI\_getImagePathForStatus(), ilLearningProgressBaseGUI\_getStatusText(), ilFormat\_secondsToString(), ilDatePresentation\formatDate(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_UNIX, and ilUtil\img().

Referenced by ilTrObjectUsersPropsTableGUI\fillRow(), ilTrMatrixTableGUI\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 186 of file class.ilLPTableBaseGUI.php.

187 {
188 if(is_array($this->filter["hide"]) && in_array($a_data["obj_id"], $this->filter["hide"]))
189 {
190 return false;
191 }
192 $olp = ilObjectLP::getInstance($a_data["obj_id"]);
193 if(get_class($olp) != "ilObjectLP" && // #13654 - LP could be unsupported
194 !$olp->isActive())
195 {
196 return false;
197 }
198 return true;
199 }

References ilObjectLP\getInstance().

+ Here is the call graph for this function:

◆ searchObjects()

ilLPTableBaseGUI::searchObjects ( array  $filter,
  $permission,
array  $preset_obj_ids = null 
)
protected

Search objects that match current filters.

Parameters
array$filter
string$permission
Returns
array

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

109 {
110 global $ilObjDataCache;
111
112 /* for performance issues: fast search WITHOUT any permission checks
113 include_once "Services/Tracking/classes/class.ilTrQuery.php";
114 return ilTrQuery::searchObjects($filter["type"], $filter["query"],
115 $filter["area"], $filter["hide"], $preset_obj_ids);
116 */
117
118 include_once './Services/Search/classes/class.ilQueryParser.php';
119
120 $query_parser =& new ilQueryParser($filter["query"]);
121 $query_parser->setMinWordLength(0);
122 $query_parser->setCombination(QP_COMBINATION_AND);
123 $query_parser->parse();
124 if(!$query_parser->validate())
125 {
126 // echo $query_parser->getMessage();
127 return false;
128 }
129
130 if($filter["type"] == "lres")
131 {
132 $filter["type"] = array('lm','sahs','htlm','dbk');
133 }
134 else
135 {
136 $filter["type"] = array($filter["type"]);
137 }
138
139 include_once 'Services/Search/classes/Like/class.ilLikeObjectSearch.php';
140 $object_search =& new ilLikeObjectSearch($query_parser);
141 $object_search->setFilter($filter["type"]);
142 if($preset_obj_ids)
143 {
144 $object_search->setIdFilter($preset_obj_ids);
145 }
146 $res =& $object_search->performSearch();
147
148 if($permission)
149 {
150 $res->setRequiredPermission($permission);
151 }
152
153 $res->setMaxHits(1000);
154 $res->addObserver($this, "searchFilterListener");
155
156 if(!$this->filter["area"])
157 {
158 $res->filter(ROOT_FOLDER_ID, false);
159 }
160 else
161 {
162 $res->filter($this->filter["area"], false);
163 }
164
165 $objects = array();
166 foreach($res->getResults() as $obj_data)
167 {
168 $objects[$obj_data['obj_id']][] = $obj_data['ref_id'];
169 }
170
171 // Check if search max hits is reached
172 if($res->isLimitReached())
173 {
174 $this->lng->loadLanguageModule("search");
175 ilUtil::sendFailure(sprintf($this->lng->txt("search_limit_reached"), 1000));
176 }
177
178 return $objects ? $objects : array();
179 }
const QP_COMBINATION_AND
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.

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

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:

◆ showTimingsWarning()

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

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

689 {
690 include_once 'Modules/Course/classes/Timings/class.ilTimingCache.php';
691 if(ilTimingCache::_showWarning($a_ref_id, $a_user_id))
692 {
693 $timings = ilTimingCache::_getTimings($a_ref_id);
694 if($timings['item']['changeable'] && $timings['user'][$a_user_id]['end'])
695 {
696 $end = $timings['user'][$a_user_id]['end'];
697 }
698 else if ($timings['item']['suggestion_end'])
699 {
700 $end = $timings['item']['suggestion_end'];
701 }
702 else
703 {
704 $end = true;
705 }
706 return $end;
707 }
708 }
& _getTimings($a_ref_id)
_showWarning($a_ref_id, $a_usr_id)

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

Referenced by ilLPProgressTableGUI\fillRow(), ilTrObjectUsersPropsTableGUI\fillRow(), ilTrUserObjectsPropsTableGUI\fillRow(), and ilTrMatrixTableGUI\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 18 of file class.ilLPTableBaseGUI.php.

◆ $filter

ilLPTableBaseGUI::$filter
protected

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

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


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