ILIAS  trunk Revision v11.0_alpha-1843-g9e1fad99175
•All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes | Private Attributes
ilLPTableBaseGUI Class Reference

TableGUI class for learning progress. More...

+ Inheritance diagram for ilLPTableBaseGUI:
+ Collaboration diagram for ilLPTableBaseGUI:

Public Member Functions

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

Data Fields

const HIT_LIMIT = 5000
 
- Data Fields inherited from ilTable2GUI
const FILTER_TEXT = 1
 
const FILTER_SELECT = 2
 
const FILTER_DATE = 3
 
const FILTER_LANGUAGE = 4
 
const FILTER_NUMBER_RANGE = 5
 
const FILTER_DATE_RANGE = 6
 
const FILTER_DURATION_RANGE = 7
 
const FILTER_DATETIME_RANGE = 8
 
const FILTER_CHECKBOX = 9
 
const EXPORT_EXCEL = 1
 
const EXPORT_CSV = 2
 
const ACTION_ALL_LIMIT = 1000
 
- Data Fields inherited from ilTableGUI
string $title = ""
 
string $icon = ""
 
string $icon_alt = ""
 
string $help_page = ""
 
string $help_icon = ""
 
string $help_icon_alt = ""
 
array $header_names = []
 
array $header_vars = []
 
array $linkbar_vars = []
 
array $data = []
 
int $column_count = 0
 
array $column_width = []
 
int $max_count = 0
 
int $limit = 0
 
bool $max_limit = false
 
int $offset = 0
 
string $order_column = ""
 
string $order_direction = ""
 
string $footer_style = ""
 
string $footer_previous = ""
 
string $footer_next = ""
 
bool $lang_support = true
 
bool $global_tpl = false
 
string $form_name = ""
 
string $select_all_checkbox = ""
 
array $action_buttons = []
 
string $prefix = ""
 
string $base = ""
 
array $enabled
 
array $styles
 

Protected Member Functions

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

Protected Attributes

RefineryFactory $refinery
 
HttpService $http
 
array $filter = []
 
bool $anonymized = true
 
int $icon_variant = ilLPStatusIcons::ICON_VARIANT_LONG
 
ilSetting $setting
 
ilObjectDataCache $ilObjDataCache
 
ilObjectDefinition $objDefinition
 
ilTree $tree
 
ilGlobalTemplateInterface $main_tpl
 
- Protected Attributes inherited from ilTable2GUI
string $requested_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
 

Private Attributes

ilObjUser $user
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 
- Static Public Member Functions inherited from ilTableGUI
static linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='')
 

Detailed Description

TableGUI class for learning progress.

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

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

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

50  {
51  global $DIC;
52  $this->main_tpl = $DIC->ui()->mainTemplate();
53 
54  $this->objDefinition = $DIC['objDefinition'];
55  $this->ilObjDataCache = $DIC['ilObjDataCache'];
56  $this->tree = $DIC->repositoryTree();
57  $this->user = $DIC->user();
58  $this->setting = $DIC->settings();
59  $this->http = $DIC->http();
60  $this->refinery = $DIC->refinery();
61 
62  $this->anonymized = !ilObjUserTracking::_enabledUserRelatedData();
63  if (!$this->anonymized && isset($this->obj_id) && $this->obj_id > 0) {
64  $olp = ilObjectLP::getInstance($this->obj_id);
65  $this->anonymized = $olp->isAnonymized();
66  }
67 
68  /*
69  * BT 35453: parent constructor needs to be called after $this->anonymized
70  * is set, in order for getSelectableUserColumns to also properly return
71  * user defined fields (e.g. firstname, lastname, and other user data).
72  */
73  parent::__construct($a_parent_obj, $a_parent_cmd, $a_template_context);
74 
75  // country names
76  $this->lng->loadLanguageModule("meta");
77  }
ILIAS\FileDelivery\http
static http()
Fetches the global http state from ILIAS.
Definition: HttpServiceAware.php:55
$DIC
global $DIC
Definition: shib_login.php:22
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
Definition: PluginProviderHelper.php:37
ilObjectLP\getInstance
static getInstance(int $obj_id)
Definition: class.ilObjectLP.php:57
+ Here is the call graph for this function:

Member Function Documentation

◆ addToClipboard()

ilLPTableBaseGUI::addToClipboard ( )
protected

Add selected users to clipboard.

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

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

Referenced by executeCommand().

1182  : void
1183  {
1184  $users = $this->initUidFromPost();
1185  $clip = ilUserClipboard::getInstance($this->user->getId());
1186  $clip->add($users);
1187  $clip->save();
1188  $this->lng->loadLanguageModule('user');
1189  $this->main_tpl->setOnScreenMessage(
1190  'success',
1191  $this->lng->txt(
1192  'clipboard_user_added'
1193  ),
1194  true
1195  );
1196  }
ilUserClipboard\getInstance
static getInstance(int $a_usr_id)
Definition: class.ilUserClipboard.php:34
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ anonymizeValue()

ilLPTableBaseGUI::anonymizeValue (   $a_value,
bool  $a_force_number = false 
)
protected
Parameters
mixed$a_value
false$a_force_number
Returns
mixed

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

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

938  {
939  // currently inactive
940  return $a_value;
941  }
+ Here is the caller graph for this function:

◆ buildPath()

ilLPTableBaseGUI::buildPath ( array  $ref_ids)
protected

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

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

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

458  : array
459  {
460  if (!count($ref_ids)) {
461  return [];
462  }
463  $result = [];
464  foreach ($ref_ids as $ref_id) {
465  $path = "...";
466  $counter = 0;
467  $path_full = $this->tree->getPathFull($ref_id);
468  foreach ($path_full as $data) {
469  if (++$counter < (count($path_full) - 1)) {
470  continue;
471  }
472  $path .= " &raquo; ";
473  if ($ref_id != $data['ref_id']) {
474  $path .= $data['title'];
475  } else {
476  $path .= ('<a target="_top" href="' .
477  ilLink::_getLink(
478  $data['ref_id'],
479  $data['type']
480  ) . '">' .
481  $data['title'] . '</a>');
482  }
483  }
484 
485  $result[$ref_id] = $path;
486  }
487  return $result;
488  }
$path
$path
Definition: ltiservices.php:29
$ref_id
$ref_id
Definition: ltiauth.php:65
+ Here is the caller graph for this function:

◆ buildValueScale()

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

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

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

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

947  : array {
948  $step = 0;
949  if ($a_max_value) {
950  $step = $a_max_value / 10;
951  $base = ceil(log($step, 10));
952  $fac = ceil($step / pow(10, ($base - 1)));
953  $step = pow(10, $base - 1) * $fac;
954  }
955  if ($step <= 1) {
956  $step = 1;
957  }
958  $ticks = range(0, $a_max_value + $step, $step);
959 
960  $value_ticks = array(0 => 0);
961  foreach ($ticks as $tick) {
962  $value = $tvalue = $tick;
963  if ($a_anonymize) {
964  $value = $this->anonymizeValue($value, true);
965  $tvalue = $this->anonymizeValue($tvalue);
966  }
967  if ($a_format_seconds) {
968  $tvalue = $this->formatSeconds($value);
969  }
970  $value_ticks[$value] = $tvalue;
971  }
972 
973  return $value_ticks;
974  }
ilLPTableBaseGUI\anonymizeValue
anonymizeValue($a_value, bool $a_force_number=false)
Definition: class.ilLPTableBaseGUI.php:937
ilLPTableBaseGUI\formatSeconds
formatSeconds(int $seconds, bool $a_shorten_zero=false)
Definition: class.ilLPTableBaseGUI.php:910
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ executeCommand()

ilLPTableBaseGUI::executeCommand ( )

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

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

105  : bool
106  {
107  $this->determineSelectedFilters();
108  if (!$this->ctrl->getNextClass($this)) {
109  $to_hide = false;
110 
111  switch ($this->ctrl->getCmd()) {
112  case "applyFilter":
113  $this->resetOffset();
114  $this->writeFilterToSession();
115  $this->storeProperty("offset", "0");
116  break;
117 
118  case "resetFilter":
119  $this->resetOffset();
120  $this->resetFilter();
121  $this->storeProperty("offset", "0");
122  break;
123 
124  case "hideSelected":
125  $to_hide = $this->initItemIdFromPost();
126  break;
127 
128  case "hide":
129  $hide = 0;
130  if ($this->http->wrapper()->query()->has('hide')) {
131  $hide = $this->http->wrapper()->query()->retrieve(
132  'hide',
133  $this->refinery->kindlyTo()->int()
134  );
135  }
136  $to_hide = [$hide];
137  break;
138 
139  case "mailselectedusers":
140  if (!$this->initUidFromPost()) {
141  $this->main_tpl->setOnScreenMessage(
142  'failure',
143  $this->lng->txt(
144  "no_checkbox"
145  ),
146  true
147  );
148  } else {
149  $this->sendMail(
150  $this->initUidFromPost(),
151  $this->parent_obj,
152  $this->parent_cmd
153  );
154  }
155  break;
156 
157  case 'addToClipboard':
158  if (!$this->initUidFromPost()) {
159  $this->main_tpl->setOnScreenMessage(
160  'failure',
161  $this->lng->txt(
162  'no_checkbox'
163  ),
164  true
165  );
166  } else {
167  $this->addToClipboard();
168  }
169  break;
170 
171  // page selector
172  default:
173  $this->determineOffsetAndOrder();
174  $this->storeNavParameter();
175  $this->storeProperty("offset", (string) $this->getOffset());
176  break;
177  }
178 
179  if ($to_hide) {
180  $obj = $this->getFilterItemByPostVar("hide");
181  $value = array_unique(
182  array_merge((array) $obj->getValue(), $to_hide)
183  );
184  $obj->setValue($value);
185  $obj->writeToSession();
186  }
187 
188  if ($this->requested_tmpl_create !== "") {
189  $this->ctrl->setParameter(
190  $this->parent_obj,
191  "tbltplcrt",
192  $this->requested_tmpl_create
193  );
194  }
195  if ($this->requested_tmpl_delete !== "") {
196  $this->ctrl->setParameter(
197  $this->parent_obj,
198  "tbltpldel",
199  $this->requested_tmpl_delete
200  );
201  }
202  $this->ctrl->redirect($this->parent_obj, $this->parent_cmd);
203  } else {
204  // e.g. repository selector
205  return parent::executeCommand();
206  }
207  return true;
208  }
ilLPTableBaseGUI\sendMail
sendMail(array $a_user_ids, $a_parent_obj, string $a_parent_cmd)
Definition: class.ilLPTableBaseGUI.php:222
ilLPTableBaseGUI\addToClipboard
addToClipboard()
Add selected users to clipboard.
Definition: class.ilLPTableBaseGUI.php:1182
ilTable2GUI\getFilterItemByPostVar
getFilterItemByPostVar(string $a_post_var)
Definition: class.ilTable2GUI.php:627
ilTable2GUI\resetOffset
resetOffset(bool $a_in_determination=false)
Definition: class.ilTable2GUI.php:354
ILIAS\FileDelivery\http
static http()
Fetches the global http state from ILIAS.
Definition: HttpServiceAware.php:55
ilTable2GUI\determineOffsetAndOrder
determineOffsetAndOrder(bool $a_omit_offset=false)
Definition: class.ilTable2GUI.php:1163
ilTable2GUI\storeProperty
storeProperty(string $type, string $value)
Definition: class.ilTable2GUI.php:2263
+ Here is the call graph for this function:

◆ fillMetaCSV()

ilLPTableBaseGUI::fillMetaCSV ( ilCSVWriter  $a_csv)
protected

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

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

874  : void
875  {
876  foreach ($this->getExportMeta() as $caption => $value) {
877  $a_csv->addColumn(strip_tags($caption));
878  $a_csv->addColumn(strip_tags($value));
879  $a_csv->addRow();
880  }
881  $a_csv->addRow();
882  }
ilCSVWriter\addColumn
addColumn(string $a_col)
Definition: class.ilCSVWriter.php:43
ilLPTableBaseGUI\getExportMeta
getExportMeta()
Build export meta data.
Definition: class.ilLPTableBaseGUI.php:810
+ Here is the call graph for this function:

◆ fillMetaExcel()

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

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

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

864  : void
865  {
866  foreach ($this->getExportMeta() as $caption => $value) {
867  $a_excel->setCell($a_row, 0, $caption);
868  $a_excel->setCell($a_row, 1, $value);
869  $a_row++;
870  }
871  $a_row++;
872  }
ilExcel\setCell
setCell(int $a_row, int $col, $value, ?string $datatype=null, bool $disable_strip_tags_for_strings=false)
Set cell value.
Definition: class.ilExcel.php:291
ilLPTableBaseGUI\getExportMeta
getExportMeta()
Build export meta data.
Definition: class.ilLPTableBaseGUI.php:810
+ Here is the call graph for this function:

◆ findReferencesForObjId()

ilLPTableBaseGUI::findReferencesForObjId ( int  $a_obj_id)
protected
Returns
int[]

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

References ilObject\_getAllReferences(), and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

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

213  : array
214  {
215  $ref_ids = array_keys(ilObject::_getAllReferences($a_obj_id));
216  sort($ref_ids, SORT_NUMERIC);
217  return $ref_ids;
218  }
ilObject\_getAllReferences
static _getAllReferences(int $id)
get all reference ids for object ID
Definition: class.ilObject.php:809
ILIAS\UI\examples\Symbol\Glyph\Sort\sort
sort()
description: > Example for rendering a Sort Glyph.
Definition: sort.php:41
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ formatSeconds()

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

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

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

913  : string {
914  $seconds = ($seconds > 0) ? $seconds : 0;
915  if ($a_shorten_zero && !$seconds) {
916  return "-";
917  }
918 
919  $hours = floor($seconds / 3600);
920  $rest = $seconds % 3600;
921 
922  $minutes = floor($rest / 60);
923  $rest = $rest % 60;
924 
925  if ($rest) {
926  $minutes++;
927  }
928 
929  return sprintf("%dh%02dm", $hours, $minutes);
930  }
+ Here is the caller graph for this function:

◆ getCurrentFilter()

ilLPTableBaseGUI::getCurrentFilter ( bool  $as_query = false)

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

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

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

646  : array
647  {
648  $result = array();
649  foreach ($this->filter as $id => $value) {
650  $item = $this->getFilterItemByPostVar($id);
651  switch ($id) {
652  case "title":
653  case "country":
654  case "gender":
655  case "city":
656  case "language":
657  case "login":
658  case "firstname":
659  case "lastname":
660  case "mark":
661  case "u_comment":
662  case "institution":
663  case "department":
664  case "street":
665  case "zipcode":
666  case "email":
667  case "matriculation":
668  case "sel_country":
669  case "query":
670  case "type":
671  case "area":
672  if ($value) {
673  $result[$id] = $value;
674  }
675  break;
676 
677  case "status":
678  if (!is_null($value) && $value !== "") {
679  $result[$id] = $value;
680  }
681  break;
682 
683  case "user_total":
684  case "read_count":
685  case "percentage":
686  case "hide":
687  case "spent_seconds":
688  if (is_array($value) && implode("", $value)) {
689  $result[$id] = $value;
690  }
691  break;
692 
693  case "registration":
694  case "create_date":
695  case "first_access":
696  case "last_access":
697  case 'status_changed':
698  if ($value) {
699  if ($value["from"]) {
700  $result[$id]["from"] = $value["from"]->get(
701  IL_CAL_DATETIME
702  );
703  }
704  if ($value["to"]) {
705  $result[$id]["to"] = $value["to"]->get(
706  IL_CAL_DATETIME
707  );
708  }
709  }
710  break;
711 
712  case "birthday":
713  if ($value) {
714  if ($value["from"]) {
715  $result[$id]["from"] = $value["from"]->get(
716  IL_CAL_DATETIME
717  );
718  $result[$id]["from"] = substr(
719  $result[$id]["from"],
720  0,
721  -8
722  ) . "00:00:00";
723  }
724  if ($value["to"]) {
725  $result[$id]["to"] = $value["to"]->get(
726  IL_CAL_DATETIME
727  );
728  $result[$id]["to"] = substr(
729  $result[$id]["to"],
730  0,
731  -8
732  ) . "23:59:59";
733  }
734  }
735  break;
736  }
737  }
738  return $result;
739  }
IL_CAL_DATETIME
const IL_CAL_DATETIME
Definition: class.ilDateTime.php:21
ilTable2GUI\getFilterItemByPostVar
getFilterItemByPostVar(string $a_post_var)
Definition: class.ilTable2GUI.php:627
ILIAS\Repository\filter
filter(string $filter_id, $class_path, string $cmd, bool $activated=true, bool $expanded=true)
Definition: trait.GlobalDICGUIServices.php:171
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getExportMeta()

ilLPTableBaseGUI::getExportMeta ( )
protected

Build export meta data.

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

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

Referenced by fillMetaCSV(), and fillMetaExcel().

810  : array
811  {
812  global $DIC;
813 
814  $ilClientIniFile = $DIC['ilClientIniFile'];
815 
816  /* see spec
817  Name of installation
818  Name of the course
819  Permalink to course
820  Owner of course object
821  Date of report generation
822  Reporting period
823  Name of person who generated the report.
824  */
825 
826  ilDatePresentation::setUseRelativeDates(false);
827 
828  $data = array();
829  $data[$this->lng->txt(
830  "trac_name_of_installation"
831  )] = $ilClientIniFile->readVariable('client', 'name');
832 
833  if ($this->obj_id) {
834  $data[$this->lng->txt(
835  "trac_object_name"
836  )] = $this->ilObjDataCache->lookupTitle((int) $this->obj_id);
837  if ($this->ref_id) {
838  $data[$this->lng->txt("trac_object_link")] = ilLink::_getLink(
839  $this->ref_id,
840  ilObject::_lookupType($this->obj_id)
841  );
842  }
843  $data[$this->lng->txt(
844  "trac_object_owner"
845  )] = ilObjUser::_lookupFullname(
846  ilObject::_lookupOwner($this->obj_id)
847  );
848  }
849 
850  $data[$this->lng->txt(
851  "trac_report_date"
852  )] = ilDatePresentation::formatDate(
853  new ilDateTime(
854  time(),
855  IL_CAL_UNIX
856  )
857  );
858  $data[$this->lng->txt("trac_report_owner")] = $this->user->getFullName(
859  );
860 
861  return $data;
862  }
ilDatePresentation\setUseRelativeDates
static array static setUseRelativeDates(bool $a_status)
set use relative dates
Definition: class.ilDatePresentation.php:46
ilObjUser\_lookupFullname
static _lookupFullname(int $a_user_id)
Definition: class.ilObjUser.php:586
ilObject\_lookupOwner
static _lookupOwner(int $obj_id)
Lookup owner user ID for object ID.
Definition: class.ilObject.php:848
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:23
$DIC
global $DIC
Definition: shib_login.php:22
ilDatePresentation\formatDate
static formatDate(ilDateTime $date, bool $a_skip_day=false, bool $a_include_wd=false, bool $include_seconds=false, ?ilObjUser $user=null,)
Definition: class.ilDatePresentation.php:82
ilObject\_lookupType
static _lookupType(int $id, bool $reference=false)
Definition: class.ilObject.php:1084
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getIconVariant()

ilLPTableBaseGUI::getIconVariant ( )

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

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

References $icon_variant.

Referenced by parseValue().

1201  : int
1202  {
1203  return $this->icon_variant;
1204  }
+ Here is the caller graph for this function:

◆ getMonthsFilter()

ilLPTableBaseGUI::getMonthsFilter (   $a_short = false)
protected

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

References ILIAS\Repository\lng().

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

976  : array
977  {
978  $options = array();
979  for ($loop = 0; $loop < 10; $loop++) {
980  $year = date("Y") - $loop;
981  $options[$year] = $year;
982  for ($loop2 = 12; $loop2 > 0; $loop2--) {
983  $month = str_pad($loop2, 2, "0", STR_PAD_LEFT);
984  if ($year . $month <= date("Ym")) {
985  if (!$a_short) {
986  $caption = $year . " / " . $this->lng->txt(
987  "month_" . $month . "_long"
988  );
989  } else {
990  $caption = $year . "/" . $month;
991  }
992  $options[$year . "-" . $month] = $caption;
993  }
994  }
995  }
996  return $options;
997  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMonthsYear()

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

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

References ILIAS\Repository\lng().

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

999  : array
1000  {
1001  if (!$a_year) {
1002  $a_year = date("Y");
1003  }
1004 
1005  $all = array();
1006  for ($loop = 1; $loop < 13; $loop++) {
1007  $month = str_pad($loop, 2, "0", STR_PAD_LEFT);
1008  if ($a_year . "-" . $month <= date("Y-m")) {
1009  if (!$a_short) {
1010  $caption = $this->lng->txt("month_" . $month . "_long");
1011  } else {
1012  $caption = $this->lng->txt("month_" . $month . "_short");
1013  }
1014  $all[$a_year . "-" . $month] = $caption;
1015  }
1016  }
1017  return $all;
1018  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getPossibleTypes()

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

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

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

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

494  : array {
495  global $DIC;
496 
497  $component_repository = $DIC['component.repository'];
498 
499  $options = array();
500 
501  if ($a_split_learning_resources) {
502  $options['lm'] = $this->lng->txt('objs_lm');
503  $options['sahs'] = $this->lng->txt('objs_sahs');
504  $options['htlm'] = $this->lng->txt('objs_htlm');
505  } else {
506  $options['lres'] = $this->lng->txt('obj_lrss');
507  }
508 
509  $options['crs'] = $this->lng->txt('objs_crs');
510  $options['grp'] = $this->lng->txt('objs_grp');
511  $options['exc'] = $this->lng->txt('objs_exc');
512  $options['file'] = $this->lng->txt('objs_file');
513  $options['mcst'] = $this->lng->txt('objs_mcst');
514  $options['svy'] = $this->lng->txt('objs_svy');
515  $options['tst'] = $this->lng->txt('objs_tst');
516  $options['prg'] = $this->lng->txt('objs_prg');
517  $options['iass'] = $this->lng->txt('objs_iass');
518  $options['copa'] = $this->lng->txt('objs_copa');
519  $options['frm'] = $this->lng->txt('objs_frm');
520  $options['cmix'] = $this->lng->txt('objs_cmix');
521  $options['lti'] = $this->lng->txt('objs_lti');
522  $options['lso'] = $this->lng->txt('objs_lso');
523 
524  if ($a_allow_undefined_lp) {
525  $options['root'] = $this->lng->txt('obj_reps');
526  $options['cat'] = $this->lng->txt('objs_cat');
527  $options["webr"] = $this->lng->txt("objs_webr");
528  $options["wiki"] = $this->lng->txt("objs_wiki");
529  $options["blog"] = $this->lng->txt("objs_blog");
530  $options["prtf"] = $this->lng->txt("objs_prtf");
531  $options["prtt"] = $this->lng->txt("objs_prtt");
532  }
533 
534  // repository plugins (currently only active)
535  $plugins = $component_repository->getPluginSlotById(
536  "robj"
537  )->getActivePlugins();
538  foreach ($plugins as $pl) {
539  $pl_id = $pl->getId();
540  if (ilRepositoryObjectPluginSlot::isTypePluginWithLP($pl_id)) {
541  $options[$pl_id] = ilObjectPlugin::lookupTxtById(
542  $pl_id,
543  "objs_" . $pl_id
544  );
545  }
546  }
547 
548  asort($options);
549  return $options;
550  }
$DIC
global $DIC
Definition: shib_login.php:22
ilObjectPlugin\lookupTxtById
static lookupTxtById(string $plugin_id, string $lang_var)
Definition: class.ilObjectPlugin.php:55
ilRepositoryObjectPluginSlot\isTypePluginWithLP
static isTypePluginWithLP(string $a_type, bool $a_active_status=true)
Definition: class.ilRepositoryObjectPluginSlot.php:63
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSelectableUserColumns()

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

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

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

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

1023  : array {
1024  $cols = $privacy_fields = array();
1025 
1026  $up = new ilUserProfile();
1027  $up->skipGroup("preferences");
1028  $up->skipGroup("settings");
1029  $up->skipGroup("interests");
1030  $ufs = $up->getStandardFields();
1031 
1032  // default fields
1033  $cols["login"] = array(
1034  "txt" => $this->lng->txt("login"),
1035  "default" => true
1036  );
1037 
1038  if (!$this->anonymized) {
1039  $cols["firstname"] = array(
1040  "txt" => $this->lng->txt("firstname"),
1041  "default" => true
1042  );
1043  $cols["lastname"] = array(
1044  "txt" => $this->lng->txt("lastname"),
1045  "default" => true
1046  );
1047  }
1048 
1049  // show only if extended data was activated in lp settings
1050  $tracking = new ilObjUserTracking();
1051  if ($tracking->hasExtendedData(
1052  ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS
1053  )) {
1054  $cols["first_access"] = array(
1055  "txt" => $this->lng->txt("trac_first_access"),
1056  "default" => true
1057  );
1058  $cols["last_access"] = array(
1059  "txt" => $this->lng->txt("trac_last_access"),
1060  "default" => true
1061  );
1062  }
1063  if ($tracking->hasExtendedData(
1064  ilObjUserTracking::EXTENDED_DATA_READ_COUNT
1065  )) {
1066  $cols["read_count"] = array(
1067  "txt" => $this->lng->txt("trac_read_count"),
1068  "default" => true
1069  );
1070  }
1071  if ($tracking->hasExtendedData(
1072  ilObjUserTracking::EXTENDED_DATA_SPENT_SECONDS
1073  ) &&
1074  ilObjectLP::supportsSpentSeconds($this->type)) {
1075  $cols["spent_seconds"] = array(
1076  "txt" => $this->lng->txt("trac_spent_seconds"),
1077  "default" => true
1078  );
1079  }
1080 
1081  if ($this->isPercentageAvailable($this->obj_id)) {
1082  $cols["percentage"] = array(
1083  "txt" => $this->lng->txt("trac_percentage"),
1084  "default" => true
1085  );
1086  }
1087 
1088  // do not show status if learning progress is deactivated
1089  $olp = ilObjectLP::getInstance($this->obj_id);
1090  if ($olp->isActive()) {
1091  $cols["status"] = array(
1092  "txt" => $this->lng->txt("trac_status"),
1093  "default" => true
1094  );
1095 
1096  $cols['status_changed'] = array(
1097  'txt' => $this->lng->txt('trac_status_changed'),
1098  'default' => false
1099  );
1100  }
1101 
1102  if (ilObjectLP::supportsMark($this->type)) {
1103  $cols["mark"] = array(
1104  "txt" => $this->lng->txt("trac_mark"),
1105  "default" => true
1106  );
1107  }
1108 
1109  $cols["u_comment"] = array(
1110  "txt" => $this->lng->txt("trac_comment"),
1111  "default" => false
1112  );
1113 
1114  $cols["create_date"] = array(
1115  "txt" => $this->lng->txt("create_date"),
1116  "default" => false
1117  );
1118  $cols["language"] = array(
1119  "txt" => $this->lng->txt("language"),
1120  "default" => false
1121  );
1122 
1123  // add user data only if object is [part of] course
1124  if (!$this->anonymized &&
1125  ($a_in_course || $a_in_group)) {
1126  // only show if export permission is granted
1127  if (ilPrivacySettings::getInstance()->checkExportAccess(
1128  $a_in_group === 0 ? $a_in_course : $a_in_group
1129  )) {
1130  // other user profile fields
1131  foreach ($ufs as $f => $fd) {
1132  if (!isset($cols[$f]) && $f != "username" && !($fd["lists_hide"] ?? false)) {
1133  if ($a_in_course &&
1134  !(($fd["course_export_fix_value"] ?? false) || $this->setting->get(
1135  "usr_settings_course_export_" . $f
1136  ))) {
1137  continue;
1138  }
1139  if ($a_in_group &&
1140  !(($fd["group_export_fix_value"] ?? false) || $this->setting->get(
1141  "usr_settings_group_export_" . $f
1142  ))) {
1143  continue;
1144  }
1145 
1146  $cols[$f] = array(
1147  "txt" => $this->lng->txt($f),
1148  "default" => false
1149  );
1150  $privacy_fields[] = $f;
1151  }
1152  }
1153 
1154  // additional defined user data fields
1155  $user_defined_fields = ilUserDefinedFields::_getInstance();
1156  if ($a_in_course) {
1157  $user_defined_fields = $user_defined_fields->getCourseExportableFields(
1158  );
1159  } else {
1160  $user_defined_fields = $user_defined_fields->getGroupExportableFields(
1161  );
1162  }
1163  foreach ($user_defined_fields as $definition) {
1164  if ($definition["field_type"] != UDF_TYPE_WYSIWYG) {
1165  $f = "udf_" . $definition["field_id"];
1166  $cols[$f] = array(
1167  "txt" => $definition["field_name"],
1168  "default" => false
1169  );
1170 
1171  $privacy_fields[] = $f;
1172  }
1173  }
1174  }
1175  }
1176  return array($cols, $privacy_fields);
1177  }
ilUserProfile
Class ilUserProfile.
Definition: class.ilUserProfile.php:28
ilLPTableBaseGUI\isPercentageAvailable
isPercentageAvailable(int $a_obj_id)
Definition: class.ilLPTableBaseGUI.php:741
UDF_TYPE_WYSIWYG
const UDF_TYPE_WYSIWYG
Definition: class.ilUserDefinedFields.php:21
ilObjectLP\supportsSpentSeconds
static supportsSpentSeconds(string $obj_type)
Definition: class.ilObjectLP.php:630
ilObjectLP\supportsMark
static supportsMark(string $obj_type)
Definition: class.ilObjectLP.php:635
ilObjectLP\getInstance
static getInstance(int $obj_id)
Definition: class.ilObjectLP.php:57
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initBaseFilter()

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

Init filter.

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

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

Referenced by ilLPProgressTableGUI\__construct().

390  {
391  $this->setDisableFilterHiding(true);
392 
393  // object type selection
394  $si = new ilSelectInputGUI($this->lng->txt("obj_type"), "type");
395  $si->setOptions($this->getPossibleTypes($a_split_learning_resources));
396  $this->addFilterItem($si);
397  $si->readFromSession();
398  if (!$si->getValue()) {
399  $si->setValue("crs");
400  }
401  $this->filter["type"] = $si->getValue();
402 
403  // hidden items
404  $msi = new ilMultiSelectInputGUI(
405  $this->lng->txt("trac_filter_hidden"),
406  "hide"
407  );
408  $this->addFilterItem($msi);
409  $msi->readFromSession();
410  $this->filter["hide"] = $msi->getValue();
411  if ($this->filter["hide"]) {
412  // create options from current value
413  $types = $this->getCurrentFilter(true);
414  $options = [];
415  foreach ($this->filter["hide"] as $obj_id) {
416  $options[$obj_id] = $this->ilObjDataCache->lookupTitle(
417  (int) $obj_id
418  );
419  }
420  $msi->setOptions($options);
421  }
422 
423  // title/description
424  $ti = new ilTextInputGUI(
425  $this->lng->txt("trac_title_description"),
426  "query"
427  );
428  $ti->setMaxLength(64);
429  $ti->setSize(20);
430  $this->addFilterItem($ti);
431  $ti->readFromSession();
432  $this->filter["query"] = $ti->getValue();
433 
434  // repository area selection
435  $rs = new ilRepositorySelectorInputGUI(
436  $this->lng->txt("trac_filter_area"),
437  "area"
438  );
439  $rs->setSelectText($this->lng->txt("trac_select_area"));
440  $this->addFilterItem($rs);
441  $rs->readFromSession();
442  $this->filter["area"] = $rs->getValue();
443 
444  // hide "not started yet"
445  if ($a_include_no_status_filter) {
446  $cb = new ilCheckboxInputGUI(
447  $this->lng->txt("trac_filter_has_status"),
448  "status"
449  );
450  $this->addFilterItem($cb);
451  $cb->readFromSession();
452  $this->filter["status"] = $cb->getChecked();
453  }
454  }
ilLPTableBaseGUI\getPossibleTypes
getPossibleTypes(bool $a_split_learning_resources=false, bool $a_include_digilib=false, bool $a_allow_undefined_lp=false)
Definition: class.ilLPTableBaseGUI.php:490
ilLPTableBaseGUI\getCurrentFilter
getCurrentFilter(bool $as_query=false)
Definition: class.ilLPTableBaseGUI.php:646
ilSelectInputGUI
This class represents a selection list property in a property form.
Definition: class.ilSelectInputGUI.php:26
ilTable2GUI\addFilterItem
addFilterItem(ilTableFilterItem $a_input_item, bool $a_optional=false)
Definition: class.ilTable2GUI.php:492
ilTable2GUI\setDisableFilterHiding
setDisableFilterHiding(bool $a_val=true)
Definition: class.ilTable2GUI.php:652
ilSelectInputGUI\setOptions
setOptions(array $a_options)
Definition: class.ilSelectInputGUI.php:48
ilMultiSelectInputGUI
This class represents a multi selection list property in a property form.
Definition: class.ilMultiSelectInputGUI.php:26
ilRepositorySelectorInputGUI
This class represents a repository selector in a property form.
Definition: class.ilRepositorySelectorInputGUI.php:30
ILIAS\Repository\filter
filter(string $filter_id, $class_path, string $cmd, bool $activated=true, bool $expanded=true)
Definition: trait.GlobalDICGUIServices.php:171
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initItemIdFromPost()

ilLPTableBaseGUI::initItemIdFromPost ( )
protected

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

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

Referenced by executeCommand().

79  : array
80  {
81  if ($this->http->wrapper()->post()->has('item_id')) {
82  return $this->http->wrapper()->post()->retrieve(
83  'item_id',
84  $this->refinery->kindlyTo()->listOf(
85  $this->refinery->kindlyTo()->int()
86  )
87  );
88  }
89  return [];
90  }
ILIAS\FileDelivery\http
static http()
Fetches the global http state from ILIAS.
Definition: HttpServiceAware.php:55
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initRepositoryFilter()

ilLPTableBaseGUI::initRepositoryFilter ( array  $filter)
protected

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

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

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

363  : array
364  {
365  $repo = new ilRepositorySelector2InputGUI(
366  $this->lng->txt('trac_filter_area'),
367  'effective_from',
368  false,
369  ($this->isForwardingToFormDispatcher()) ? $this : null
370  );
371  $white_list = [];
372  foreach ($this->objDefinition->getAllRepositoryTypes() as $type) {
373  if ($this->objDefinition->isContainer($type)) {
374  $white_list[] = $type;
375  }
376  }
377  $repo->getExplorerGUI()->setTypeWhiteList($white_list);
378  $this->addFilterItem($repo);
379  $repo->readFromSession();
380  $filter['area'] = (int) $repo->getValue();
381  return $filter;
382  }
ilTable2GUI\addFilterItem
addFilterItem(ilTableFilterItem $a_input_item, bool $a_optional=false)
Definition: class.ilTable2GUI.php:492
null
while($session_entry=$r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) return null
Definition: shib_logout.php:142
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initUidFromPost()

ilLPTableBaseGUI::initUidFromPost ( )
protected

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

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

Referenced by addToClipboard(), and executeCommand().

92  : array
93  {
94  if ($this->http->wrapper()->post()->has('uid')) {
95  return $this->http->wrapper()->post()->retrieve(
96  'uid',
97  $this->refinery->kindlyTo()->listOf(
98  $this->refinery->kindlyTo()->int()
99  )
100  );
101  }
102  return [];
103  }
ILIAS\FileDelivery\http
static http()
Fetches the global http state from ILIAS.
Definition: HttpServiceAware.php:55
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isForwardingToFormDispatcher()

ilLPTableBaseGUI::isForwardingToFormDispatcher ( )
protected

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

Referenced by initRepositoryFilter().

358  : bool
359  {
360  return false;
361  }
+ Here is the caller graph for this function:

◆ isPercentageAvailable()

ilLPTableBaseGUI::isPercentageAvailable ( int  $a_obj_id)
protected

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

References ilObjectLP\getInstance(), ilLPObjSettings\LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED, ilLPObjSettings\LP_MODE_CMIX_COMPL_WITH_FAILED, ilLPObjSettings\LP_MODE_CMIX_COMPLETED, ilLPObjSettings\LP_MODE_CMIX_COMPLETED_OR_PASSED, ilLPObjSettings\LP_MODE_CMIX_PASSED, ilLPObjSettings\LP_MODE_CMIX_PASSED_WITH_FAILED, ilLPObjSettings\LP_MODE_COLLECTION, ilLPObjSettings\LP_MODE_LTI_OUTCOME, 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 ilTrUserObjectsPropsTableGUI\fillRow(), ilTrSummaryTableGUI\fillRow(), ilLPProgressTableGUI\fillRowCSV(), ilLPProgressTableGUI\fillRowExcel(), ilLPProgressTableGUI\getItems(), ilTrMatrixTableGUI\getItems(), ilTrSummaryTableGUI\getItems(), ilTrSummaryTableGUI\getSelectableColumns(), getSelectableUserColumns(), and ilTrSummaryTableGUI\initFilter().

741  : bool
742  {
743  if ($a_obj_id === 0) {
744  return false;
745  }
746  $olp = ilObjectLP::getInstance($a_obj_id);
747  $mode = $olp->getCurrentMode();
748  if (in_array(
749  $mode,
750  [
751  ilLPObjSettings::LP_MODE_TLT,
752  ilLPObjSettings::LP_MODE_VISITS,
753  ilLPObjSettings::LP_MODE_SCORM,
754  ilLPObjSettings::LP_MODE_LTI_OUTCOME,
755  ilLPObjSettings::LP_MODE_CMIX_COMPLETED,
756  ilLPObjSettings::LP_MODE_CMIX_COMPL_WITH_FAILED,
757  ilLPObjSettings::LP_MODE_CMIX_PASSED,
758  ilLPObjSettings::LP_MODE_CMIX_PASSED_WITH_FAILED,
759  ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED,
760  ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED,
761  ilLPObjSettings::LP_MODE_VISITED_PAGES,
762  ilLPObjSettings::LP_MODE_TEST_PASSED,
763  ilLPObjSettings::LP_MODE_COLLECTION
764  ]
765  )) {
766  return true;
767  }
768  return false;
769  }
ilLPObjSettings\LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
const LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
Definition: class.ilLPObjSettings.php:64
ilObjectLP\getInstance
static getInstance(int $obj_id)
Definition: class.ilObjectLP.php:57
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parseTitle()

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

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

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

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

775  {
776  global $DIC;
777 
778  $user = "";
779  if ($a_user_id) {
780  if ($a_user_id != $this->user->getId()) {
781  $a_user = ilObjectFactory::getInstanceByObjId($a_user_id);
782  } else {
783  $a_user = $this->user;
784  }
785  $user .= ", " . $a_user->getFullName(
786  ); // " [".$a_user->getLogin()."]";
787  }
788 
789  if ($a_obj_id != ROOT_FOLDER_ID) {
790  $this->setTitle(
791  $this->lng->txt(
792  $action
793  ) . ": " . $this->ilObjDataCache->lookupTitle($a_obj_id) . $user
794  );
795 
796  $olp = ilObjectLP::getInstance($a_obj_id);
797  $this->setDescription(
798  $this->lng->txt('trac_mode') . ": " . $olp->getModeText(
799  $olp->getCurrentMode()
800  )
801  );
802  } else {
803  $this->setTitle($this->lng->txt($action));
804  }
805  }
ROOT_FOLDER_ID
const ROOT_FOLDER_ID
Definition: constants.php:32
ilTable2GUI\setDescription
setDescription(string $a_val)
Definition: class.ilTable2GUI.php:446
$DIC
global $DIC
Definition: shib_login.php:22
ilTable2GUI\setTitle
setTitle(string $a_title, string $a_icon="", string $a_icon_alt="")
Definition: class.ilTable2GUI.php:438
ilObjectFactory\getInstanceByObjId
static getInstanceByObjId(?int $obj_id, bool $stop_on_error=true)
get an instance of an Ilias object by object id
Definition: class.ilObjectFactory.php:84
ilObjectLP\getInstance
static getInstance(int $obj_id)
Definition: class.ilObjectLP.php:57
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parseValue()

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

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

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

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

556  : string {
557  // get rid of aggregation
558  $pos = strrpos($id, "_");
559  if ($pos !== false) {
560  $function = strtoupper(substr($id, $pos + 1));
561  if (in_array(
562  $function,
563  array("MIN", "MAX", "SUM", "AVG", "COUNT")
564  )) {
565  $id = substr($id, 0, $pos);
566  }
567  }
568 
569  if ((trim((string) $value) == "") && $id != "status") {
570  if ($id == "title" &&
571  get_class($this) != "ilTrObjectUsersPropsTableGUI" &&
572  get_class($this) != "ilTrMatrixTableGUI") {
573  return "--" . $this->lng->txt("none") . "--";
574  }
575  return " ";
576  }
577 
578  switch ($id) {
579  case "first_access":
580  case "create_date":
581  case 'status_changed':
582  $value = ilDatePresentation::formatDate(
583  new ilDateTime($value, IL_CAL_DATETIME)
584  );
585  break;
586 
587  case "last_access":
588  $value = ilDatePresentation::formatDate(
589  new ilDateTime($value, IL_CAL_UNIX)
590  );
591  break;
592 
593  case "birthday":
594  $value = ilDatePresentation::formatDate(
595  new ilDate($value, IL_CAL_DATE)
596  );
597  break;
598 
599  case "spent_seconds":
600  if (!ilObjectLP::supportsSpentSeconds($type)) {
601  $value = "-";
602  } else {
603  $value = ilDatePresentation::secondsToString(
604  (int) $value,
605  ((int) $value < 3600 ? true : false)
606  ); // #14858
607  }
608  break;
609 
610  case "percentage":
611  if (false /* $this->isPercentageAvailable() */) {
612  $value = "-";
613  } else {
614  $value = $value . "%";
615  }
616  break;
617 
618  case "mark":
619  if (!ilObjectLP::supportsMark($type)) {
620  $value = "-";
621  }
622  break;
623 
624  case "gender":
625  $value = $this->lng->txt("gender_" . $value);
626  break;
627 
628  case "status":
629  $icons = ilLPStatusIcons::getInstance($this->getIconVariant());
630  $value = $icons->renderIconForStatus((int) $value);
631  break;
632 
633  case "language":
634  $this->lng->loadLanguageModule("meta");
635  $value = $this->lng->txt("meta_l_" . $value);
636  break;
637 
638  case "sel_country":
639  $value = $this->lng->txt("meta_c_" . $value);
640  break;
641  }
642 
643  return $value ?? '';
644  }
IL_CAL_DATETIME
const IL_CAL_DATETIME
Definition: class.ilDateTime.php:21
ilLPStatusIcons\getInstance
static getInstance(int $variant=ilLPStatusIcons::ICON_VARIANT_DEFAULT, ?\ILIAS\UI\Renderer $renderer=null, ?\ILIAS\UI\Factory $factory=null)
Definition: class.ilLPStatusIcons.php:48
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:23
ilDatePresentation\secondsToString
static secondsToString(int $seconds, bool $force_with_seconds=false, ?ilLanguage $a_lng=null)
converts seconds to string: Long: 7 days 4 hour(s) ...
Definition: class.ilDatePresentation.php:323
ilLPTableBaseGUI\getIconVariant
getIconVariant()
Gets the variant of LP icons that is shown in the table.
Definition: class.ilLPTableBaseGUI.php:1201
ilObjectLP\supportsSpentSeconds
static supportsSpentSeconds(string $obj_type)
Definition: class.ilObjectLP.php:630
IL_CAL_DATE
const IL_CAL_DATE
Definition: class.ilDateTime.php:22
ilDatePresentation\formatDate
static formatDate(ilDateTime $date, bool $a_skip_day=false, bool $a_include_wd=false, bool $include_seconds=false, ?ilObjUser $user=null,)
Definition: class.ilDatePresentation.php:82
ilObjectLP\supportsMark
static supportsMark(string $obj_type)
Definition: class.ilObjectLP.php:635
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ searchFilterListener()

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

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

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

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

340  : bool
341  {
342  if (is_array($this->filter["hide"]) && in_array(
343  $a_data["obj_id"],
344  $this->filter["hide"]
345  )) {
346  return false;
347  }
348  $olp = ilObjectLP::getInstance($a_data["obj_id"]);
349  if (get_class(
350  $olp
351  ) != "ilObjectLP" && // #13654 - LP could be unsupported
352  !$olp->isActive()) {
353  return false;
354  }
355  return true;
356  }
ILIAS\Repository\filter
filter(string $filter_id, $class_path, string $cmd, bool $activated=true, bool $expanded=true)
Definition: trait.GlobalDICGUIServices.php:171
ilObjectLP\getInstance
static getInstance(int $obj_id)
Definition: class.ilObjectLP.php:57
+ Here is the call graph for this function:

◆ searchObjects()

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

Search objects that match current filters.

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

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

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

286  : array {
287  $query_parser = new ilQueryParser($filter["query"] ?? '');
288  $query_parser->setMinWordLength(0);
289  $query_parser->setCombination(ilQueryParser::QP_COMBINATION_AND);
290  $query_parser->parse();
291  if (!$query_parser->validate()) {
292  ilLoggerFactory::getLogger('trac')->notice(
293  $query_parser->getMessage()
294  );
295  // echo $query_parser->getMessage();
296  return [];
297  }
298 
299  if ($filter["type"] == "lres") {
300  $filter["type"] = array('lm', 'sahs', 'htlm');
301  } else {
302  $filter["type"] = array($filter["type"]);
303  }
304 
305  $object_search = new ilLikeObjectSearch($query_parser);
306  $object_search->setFilter($filter["type"]);
307  if ($preset_obj_ids) {
308  $object_search->setIdFilter($preset_obj_ids);
309  }
310  $res = $object_search->performSearch();
311 
312  if ($permission) {
313  $res->setRequiredPermission($permission);
314  }
315 
316  $res->setMaxHits(self::HIT_LIMIT);
317 
318  if ($a_check_lp_activation) {
319  $res->addObserver($this, "searchFilterListener");
320  }
321 
322  if (!$this->filter["area"]) {
323  $res->filter(ROOT_FOLDER_ID, true);
324  } else {
325  $res->filter($this->filter["area"], true);
326  }
327 
328  $objects = array();
329  foreach ($res->getResults() as $obj_data) {
330  $objects[$obj_data['obj_id']][] = $obj_data['ref_id'];
331  }
332  return $objects ?: array();
333  }
$res
$res
Definition: ltiservices.php:66
ilLoggerFactory\getLogger
static getLogger(string $a_component_id)
Get component logger.
Definition: class.ilLoggerFactory.php:89
ROOT_FOLDER_ID
const ROOT_FOLDER_ID
Definition: constants.php:32
ILIAS\Repository\filter
filter(string $filter_id, $class_path, string $cmd, bool $activated=true, bool $expanded=true)
Definition: trait.GlobalDICGUIServices.php:171
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ sendMail()

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

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

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

Referenced by executeCommand().

226  : void {
227  // see ilObjCourseGUI::sendMailToSelectedUsersObject()
228 
229  $rcps = array();
230  foreach ($a_user_ids as $usr_id) {
231  $rcps[] = ilObjUser::_lookupLogin($usr_id);
232  }
233 
234  $template = array();
235  $sig = null;
236 
237  $ref_id = 0;
238  if ($this->http->wrapper()->query()->has('ref_id')) {
239  $ref_id = $this->http->wrapper()->query()->retrieve(
240  'ref_id',
241  $this->refinery->kindlyTo()->int()
242  );
243  }
244  // repository-object-specific
245  if ($ref_id) {
246  $obj_lp = ilObjectLP::getInstance(
247  ilObject::_lookupObjectId($ref_id)
248  );
249  $tmpl_id = $obj_lp->getMailTemplateId();
250 
251  if ($tmpl_id) {
252  $template = array(
253  ilMailFormCall::CONTEXT_KEY => $tmpl_id,
254  'ref_id' => $ref_id,
255  'ts' => time()
256  );
257  } else {
258  $sig = ilLink::_getLink($ref_id);
259  $sig = rawurlencode(base64_encode($sig));
260  }
261  }
262 
263  ilUtil::redirect(
264  ilMailFormCall::getRedirectTarget(
265  $a_parent_obj,
266  $a_parent_cmd,
267  array(),
268  array(
269  'type' => 'new',
270  'rcp_to' => implode(',', $rcps),
271  'sig' => $sig
272  ),
273  $template
274  )
275  );
276  }
null
while($session_entry=$r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) return null
Definition: shib_logout.php:142
ILIAS\FileDelivery\http
static http()
Fetches the global http state from ILIAS.
Definition: HttpServiceAware.php:55
$ref_id
$ref_id
Definition: ltiauth.php:65
ilObject\_lookupObjectId
static _lookupObjectId(int $ref_id)
Definition: class.ilObject.php:1116
ilUtil\redirect
static redirect(string $a_script)
Definition: class.ilUtil.php:938
ilMailFormCall\getRedirectTarget
static getRedirectTarget( $gui, string $cmd, array $gui_params=[], array $mail_params=[], array $context_params=[])
Definition: class.ilMailFormCall.php:51
ilObjectLP\getInstance
static getInstance(int $obj_id)
Definition: class.ilObjectLP.php:57
ilObjUser\_lookupLogin
static _lookupLogin(int $a_user_id)
Definition: class.ilObjUser.php:678
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setIconVariant()

ilLPTableBaseGUI::setIconVariant ( int  $variant)

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

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

1209  : void
1210  {
1211  $this->icon_variant = $variant;
1212  }

◆ showTimingsWarning()

ilLPTableBaseGUI::showTimingsWarning ( int  $a_ref_id,
int  $a_user_id 
)
protected
Parameters
int$a_ref_id
int$a_user_id
Returns
bool|mixed

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

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

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

890  {
891  $timing_cache = ilTimingCache::getInstanceByRefId($a_ref_id);
892  if ($timing_cache->isWarningRequired($a_user_id)) {
893  $timings = ilTimingCache::_getTimings($a_ref_id);
894  if (
895  $timings['item']['changeable'] &&
896  ($timings['user'][$a_user_id] ?? false) &&
897  $timings['user'][$a_user_id]['end']
898  ) {
899  $end = $timings['user'][$a_user_id]['end'];
900  } elseif ($timings['item']['suggestion_end']) {
901  $end = $timings['item']['suggestion_end'];
902  } else {
903  $end = true;
904  }
905  return $end;
906  }
907  return false;
908  }
ilTimingCache\_getTimings
static _getTimings(int $a_ref_id)
Definition: class.ilTimingCache.php:92
ilTimingCache\getInstanceByRefId
static getInstanceByRefId(int $ref_id)
Definition: class.ilTimingCache.php:43
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $anonymized

bool ilLPTableBaseGUI::$anonymized = true
protected

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

◆ $filter

array ilLPTableBaseGUI::$filter = []
protected

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

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

◆ $http

HttpService ilLPTableBaseGUI::$http
protected

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

◆ $icon_variant

int ilLPTableBaseGUI::$icon_variant = ilLPStatusIcons::ICON_VARIANT_LONG
protected

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

Referenced by getIconVariant().

◆ $ilObjDataCache

ilObjectDataCache ilLPTableBaseGUI::$ilObjDataCache
protected

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

◆ $main_tpl

ilGlobalTemplateInterface ilLPTableBaseGUI::$main_tpl
protected

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

◆ $objDefinition

ilObjectDefinition ilLPTableBaseGUI::$objDefinition
protected

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

◆ $refinery

RefineryFactory ilLPTableBaseGUI::$refinery
protected

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

◆ $setting

ilSetting ilLPTableBaseGUI::$setting
protected

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

◆ $tree

ilTree ilLPTableBaseGUI::$tree
protected

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

◆ $user

ilObjUser ilLPTableBaseGUI::$user
private

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

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

◆ HIT_LIMIT

const ilLPTableBaseGUI::HIT_LIMIT = 5000

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

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