ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilLearningProgressBaseGUI Class Reference
+ Inheritance diagram for ilLearningProgressBaseGUI:
+ Collaboration diagram for ilLearningProgressBaseGUI:

Public Member Functions

 __construct ($a_mode, $a_ref_id=0, $a_usr_id=0)
 
 isAnonymized ()
 
 getMode ()
 
 getRefId ()
 
 getObjId ()
 
 getUserId ()
 
 __getDefaultCommand ()
 
 __setSubTabs ($a_active)
 
 __buildFooter ()
 
 __buildHeader ()
 
 __insertPath (&$a_tpl, $a_ref_id)
 insert path More...
 
 __showImageByStatus (&$tpl, $a_status, $tpl_prefix="")
 
__initTableGUI ()
 
 __showObjectDetails (&$info, $item_id=0, $add_section=true)
 show details about current object. More...
 
 __appendUserInfo (&$info, $a_user)
 
 __appendLPDetails (&$info, $item_id, $user_id)
 
 __sort ($a_ids, $a_table, $a_field, $a_id_name)
 Function that sorts ids by a given table field using WHERE IN E.g: __sort(array(6,7),'usr_data','lastname','usr_id') => sorts by lastname. More...
 
 __getPercent ($max, $reached)
 
 __readItemStatusInfo ($a_items)
 
 __getLegendHTML ()
 
 __showEditUser ($a_user_id, $a_ref_id, $a_cancel, $a_sub_id=false)
 
 __updateUser ($user_id, $obj_id)
 

Static Public Member Functions

static _showImageByStatus (&$tpl, $a_status, $tpl_prefix="")
 
static _getImagePathForStatus ($a_status)
 Get image path for status. More...
 
static _getStatusText ($a_status, $a_lng=null)
 Get status alt text. More...
 
static __readStatus ($a_obj_id, $user_id)
 
static isObjectOffline ($a_obj_id, $a_type=null)
 

Data Fields

 $tpl = null
 
 $ctrl = null
 
 $lng = null
 
 $ref_id = 0
 
 $mode = 0
 
const LP_CONTEXT_PERSONAL_DESKTOP = 1
 
const LP_CONTEXT_ADMINISTRATION = 2
 
const LP_CONTEXT_REPOSITORY = 3
 
const LP_CONTEXT_USER_FOLDER = 4
 
const LP_CONTEXT_ORG_UNIT = 5
 
const LP_ACTIVE_SETTINGS = 1
 
const LP_ACTIVE_OBJECTS = 2
 
const LP_ACTIVE_PROGRESS = 3
 
const LP_ACTIVE_USERS = 5
 
const LP_ACTIVE_SUMMARY = 6
 
const LP_ACTIVE_OBJSTATACCESS = 7
 
const LP_ACTIVE_OBJSTATTYPES = 8
 
const LP_ACTIVE_OBJSTATDAILY = 9
 
const LP_ACTIVE_OBJSTATADMIN = 10
 
const LP_ACTIVE_MATRIX = 11
 

Protected Member Functions

 initEditUserForm ($a_user_id, $a_obj_id, $a_cancel=null)
 

Protected Attributes

 $anonymized
 
 $logger
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilLearningProgressBaseGUI::__construct (   $a_mode,
  $a_ref_id = 0,
  $a_usr_id = 0 
)

Reimplemented in ilLPListOfProgressGUI.

Definition at line 56 of file class.ilLearningProgressBaseGUI.php.

57 {
58 global $tpl,$ilCtrl,$lng,$ilObjDataCache,$ilTabs;
59
60 $this->tpl = $tpl;
61 $this->ctrl = $ilCtrl;
62 $this->lng = $lng;
63 $this->lng->loadLanguageModule('trac');
64 $this->tabs_gui = $ilTabs;
65
66 $this->mode = $a_mode;
67 $this->ref_id = $a_ref_id;
68 $this->obj_id = $ilObjDataCache->lookupObjId($this->ref_id);
69 $this->obj_type = $ilObjDataCache->lookupType($this->obj_id);
70 $this->usr_id = $a_usr_id;
71
72 $this->anonymized = (bool)!ilObjUserTracking::_enabledUserRelatedData();
73 if(!$this->anonymized && $this->obj_id)
74 {
75 include_once "Services/Object/classes/class.ilObjectLP.php";
76 $olp = ilObjectLP::getInstance($this->obj_id);
77 $this->anonymized = $olp->isAnonymized();
78 }
79
80 $this->logger = $GLOBALS['DIC']->logger()->trac();
81 }
static _enabledUserRelatedData()
check wether user related tracking is enabled or not
static getInstance($a_obj_id)
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
global $ilCtrl
Definition: ilias.php:18

References $GLOBALS, $ilCtrl, $lng, $tpl, ilObjUserTracking\_enabledUserRelatedData(), and ilObjectLP\getInstance().

+ Here is the call graph for this function:

Member Function Documentation

◆ __appendLPDetails()

ilLearningProgressBaseGUI::__appendLPDetails ( $info,
  $item_id,
  $user_id 
)

Definition at line 462 of file class.ilLearningProgressBaseGUI.php.

463 {
464 global $ilObjDataCache;
465
466 $type = $ilObjDataCache->lookupType($item_id);
467
468 // Section learning_progress
469 // $info->addSection($this->lng->txt('trac_learning_progress'));
470 // see ilLPTableBaseGUI::parseTitle();
471 $info->addSection($this->lng->txt("trac_progress").": ".ilObject::_lookupTitle($item_id));
472
473 $olp = ilObjectLP::getInstance($item_id);
474 $info->addProperty($this->lng->txt('trac_mode'),
475 $olp->getModeText($olp->getCurrentMode()));
476
477 switch($type)
478 {
479 case 'lm':
480 case 'htlm':
481 include_once 'Services/Tracking/classes/class.ilLearningProgress.php';
482 $progress = ilLearningProgress::_getProgress($user_id,$item_id);
483
484 if($progress['access_time'])
485 {
486 $info->addProperty($this->lng->txt('last_access'),
487 ilDatePresentation::formatDate(new ilDateTime($progress['access_time'],IL_CAL_UNIX)));
488 }
489 else
490 {
491 $info->addProperty($this->lng->txt('last_access'),$this->lng->txt('trac_not_accessed'));
492 }
493 $info->addProperty($this->lng->txt('trac_visits'),(int) $progress['visits']);
495 {
496 $info->addProperty($this->lng->txt('trac_spent_time'),ilDatePresentation::secondsToString($progress['spent_seconds']));
497 }
498 // fallthrough
499
500 case 'exc':
501 case 'tst':
502 case 'file':
503 case 'mcst':
504 case 'svy':
505 case 'crs':
506 case 'sahs':
507 case 'grp':
508 case 'iass':
509 case 'sess':
510 // display status as image
511 include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
512 $status = $this->__readStatus($item_id,$user_id);
514 $status_text = ilLearningProgressBaseGUI::_getStatusText($status);
515 $info->addProperty($this->lng->txt('trac_status'),
516 ilUtil::img($status_path, $status_text)." ".$status_text);
517
518 // #15334 - see ilLPTableBaseGUI::isPercentageAvailable()
519 $mode = $olp->getCurrentMode();
520 if(in_array($mode, array(ilLPObjSettings::LP_MODE_TLT,
522 // ilLPObjSettings::LP_MODE_OBJECTIVES,
525 {
526 include_once 'Services/Tracking/classes/class.ilLPStatus.php';
527 $perc = ilLPStatus::_lookupPercentage($item_id, $user_id);
528 $info->addProperty($this->lng->txt('trac_percentage'), (int)$perc."%");
529 }
530 break;
531
532 }
533
534 include_once 'Services/Tracking/classes/class.ilLPMarks.php';
535
536 if(ilObjectLP::supportsMark($type))
537 {
538 if(strlen($mark = ilLPMarks::_lookupMark($user_id,$item_id)))
539 {
540 $info->addProperty($this->lng->txt('trac_mark'),$mark);
541 }
542 }
543
544 if(strlen($comment = ilLPMarks::_lookupComment($user_id,$item_id)))
545 {
546 $info->addProperty($this->lng->txt('trac_comment'),$comment);
547 }
548 }
$comment
Definition: buildRTE.php:83
const IL_CAL_UNIX
static secondsToString($seconds, $force_with_seconds=false, $a_lng=null)
converts seconds to string: Long: 7 days 4 hour(s) ...
static formatDate(ilDateTime $date)
Format a date @access public.
@classDescription Date and time handling
static _lookupMark($a_usr_id, $a_obj_id)
static _lookupComment($a_usr_id, $a_obj_id)
static _lookupPercentage($a_obj_id, $a_user_id)
Lookup percentage.
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
static __readStatus($a_obj_id, $user_id)
static _getImagePathForStatus($a_status)
Get image path for status.
static _getProgress($a_user_id, $a_obj_id)
static supportsMark($a_obj_type)
static supportsSpentSeconds($a_obj_type)
static _lookupTitle($a_id)
lookup object title
static img($a_src, $a_alt="", $a_width="", $a_height="", $a_border=0, $a_id="", $a_class="")
Build img tag.
$info
Definition: example_052.php:80

References $comment, $info, $mode, __readStatus(), _getImagePathForStatus(), ilLearningProgress\_getProgress(), _getStatusText(), ilLPMarks\_lookupComment(), ilLPMarks\_lookupMark(), ilLPStatus\_lookupPercentage(), ilObject\_lookupTitle(), ilDatePresentation\formatDate(), ilObjectLP\getInstance(), IL_CAL_UNIX, ilUtil\img(), ilLPObjSettings\LP_MODE_SCORM, ilLPObjSettings\LP_MODE_TEST_PASSED, ilLPObjSettings\LP_MODE_TLT, ilLPObjSettings\LP_MODE_VISITS, ilDatePresentation\secondsToString(), ilObjectLP\supportsMark(), and ilObjectLP\supportsSpentSeconds().

+ Here is the call graph for this function:

◆ __appendUserInfo()

ilLearningProgressBaseGUI::__appendUserInfo ( $info,
  $a_user 
)

Definition at line 437 of file class.ilLearningProgressBaseGUI.php.

438 {
439 global $ilUser;
440
441 // #13525 - irrelevant personal data is not to be presented
442 return;
443
444 if(!is_object($a_user))
445 {
446 $a_user = ilObjectFactory::getInstanceByObjId($a_user);
447 }
448
449 if($a_user->getId() != $ilUser->getId())
450 {
451 $info->addSection($this->lng->txt("trac_user_data"));
452 // $info->addProperty($this->lng->txt('username'),$a_user->getLogin());
453 // $info->addProperty($this->lng->txt('name'),$a_user->getFullname());
454 $info->addProperty($this->lng->txt('last_login'),
455 ilDatePresentation::formatDate(new ilDateTime($a_user->getLastLogin(),IL_CAL_DATETIME)));
456 $info->addProperty($this->lng->txt('trac_total_online'),
457 ilDatePresentation::secondsToString(ilOnlineTracking::getOnlineTime($a_user->getId())));
458 return true;
459 }
460 }
const IL_CAL_DATETIME
static getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
$ilUser
Definition: imgupload.php:18

References $ilUser, $info, ilDatePresentation\formatDate(), ilObjectFactory\getInstanceByObjId(), IL_CAL_DATETIME, and ilDatePresentation\secondsToString().

Referenced by ilLPListOfProgressGUI\__showProgressList(), ilLPListOfObjectsGUI\editUser(), and ilLPListOfObjectsGUI\userDetails().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __buildFooter()

ilLearningProgressBaseGUI::__buildFooter ( )

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

233 {
234 switch($this->getMode())
235 {
237
238 $this->tpl->show(true);
239 }
240 }

References getMode(), and LP_CONTEXT_PERSONAL_DESKTOP.

Referenced by ilLearningProgressGUI\executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __buildHeader()

ilLearningProgressBaseGUI::__buildHeader ( )

Definition at line 242 of file class.ilLearningProgressBaseGUI.php.

243 {
244 if($this->getMode() == self::LP_CONTEXT_PERSONAL_DESKTOP)
245 {
246 $this->tpl->setTitle($this->lng->txt("learning_progress"));
247
248 // set locator
249/*
250 $this->tpl->setVariable("TXT_LOCATOR", $this->lng->txt("locator"));
251 $this->tpl->touchBlock("locator_separator");
252 $this->tpl->touchBlock("locator_item");
253 //$this->tpl->setCurrentBlock("locator_item");
254 //$this->tpl->setVariable("ITEM", $this->lng->txt("personal_desktop"));
255 //$this->tpl->setVariable("LINK_ITEM",
256 // $this->ctrl->getLinkTargetByClass("ilpersonaldesktopgui"));
257 //$this->tpl->parseCurrentBlock();
258
259 $this->tpl->setCurrentBlock("locator_item");
260 $this->tpl->setVariable("ITEM", $this->lng->txt("learning_progress"));
261 $this->tpl->setVariable("LINK_ITEM",
262 $this->ctrl->getLinkTargetByClass('illearningprogressgui'));
263 $this->tpl->parseCurrentBlock();
264*/
265
266 // display infopanel if something happened
268 }
269
270 }
static infoPanel($a_keep=true)

References getMode(), and ilUtil\infoPanel().

Referenced by ilLearningProgressGUI\executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __getDefaultCommand()

ilLearningProgressBaseGUI::__getDefaultCommand ( )

Definition at line 117 of file class.ilLearningProgressBaseGUI.php.

118 {
119 if(strlen($cmd = $this->ctrl->getCmd()))
120 {
121 return $cmd;
122 }
123 return 'show';
124 }
$cmd
Definition: sahs_server.php:35

References $cmd.

Referenced by ilLPObjectStatisticsGUI\executeCommand(), ilLPListOfObjectsGUI\executeCommand(), ilLPListOfProgressGUI\executeCommand(), and ilLPListOfSettingsGUI\executeCommand().

+ Here is the caller graph for this function:

◆ __getLegendHTML()

ilLearningProgressBaseGUI::__getLegendHTML ( )

Definition at line 655 of file class.ilLearningProgressBaseGUI.php.

656 {
657 global $lng;
658
659 $tpl = new ilTemplate("tpl.lp_legend.html", true, true, "Services/Tracking");
660 $tpl->setVariable("IMG_NOT_ATTEMPTED",
661 ilUtil::getImagePath("scorm/not_attempted.svg"));
662 $tpl->setVariable("IMG_IN_PROGRESS",
663 ilUtil::getImagePath("scorm/incomplete.svg"));
664 $tpl->setVariable("IMG_COMPLETED",
665 ilUtil::getImagePath("scorm/completed.svg"));
666 $tpl->setVariable("IMG_FAILED",
667 ilUtil::getImagePath("scorm/failed.svg"));
668 $tpl->setVariable("TXT_NOT_ATTEMPTED",
669 $lng->txt("trac_not_attempted"));
670 $tpl->setVariable("TXT_IN_PROGRESS",
671 $lng->txt("trac_in_progress"));
672 $tpl->setVariable("TXT_COMPLETED",
673 $lng->txt("trac_completed"));
674 $tpl->setVariable("TXT_FAILED",
675 $lng->txt("trac_failed"));
676
677 include_once "Services/UIComponent/Panel/classes/class.ilPanelGUI.php";
678 $panel = ilPanelGUI::getInstance();
679 $panel->setPanelStyle(ilPanelGUI::PANEL_STYLE_SECONDARY);
680 $panel->setBody($tpl->get());
681
682 return $panel->getHTML();
683 }
const PANEL_STYLE_SECONDARY
static getInstance()
Get instance.
special template class to simplify handling of ITX/PEAR
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)

References $lng, $tpl, ilUtil\getImagePath(), ilPanelGUI\getInstance(), and ilPanelGUI\PANEL_STYLE_SECONDARY.

Referenced by ilLPListOfObjectsGUI\__listObjects(), ilLPListOfProgressGUI\__showProgressList(), ilLPListOfObjectsGUI\__showUsersList(), ilLPListOfObjectsGUI\showUserObjectMatrix(), and ilLPListOfObjectsGUI\userDetails().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __getPercent()

ilLearningProgressBaseGUI::__getPercent (   $max,
  $reached 
)

Definition at line 613 of file class.ilLearningProgressBaseGUI.php.

614 {
615 if(!$max)
616 {
617 return "0%";
618 }
619
620 return sprintf("%d%%",$reached / $max * 100);
621 }
sprintf('%.4f', $callTime)

References sprintf.

◆ __initTableGUI()

& ilLearningProgressBaseGUI::__initTableGUI ( )

Definition at line 391 of file class.ilLearningProgressBaseGUI.php.

392 {
393 include_once "./Services/Table/classes/class.ilTableGUI.php";
394
395 return new ilTableGUI(0,false);
396 }
Class ilTableGUI.

◆ __insertPath()

ilLearningProgressBaseGUI::__insertPath ( $a_tpl,
  $a_ref_id 
)

insert path

Definition at line 275 of file class.ilLearningProgressBaseGUI.php.

276 {
277 global $tree;
278
279 $path_arr = $tree->getPathFull($a_ref_id);
280 $counter = 0;
281 foreach($tree->getPathFull($a_ref_id) as $data)
282 {
283 if($counter++)
284 {
285 $path .= " -> ";
286 }
287 $path .= $data['title'];
288 }
289 $a_tpl->setCurrentBlock("path_item");
290 $a_tpl->setVariable("PATH_ITEM",$path);
291 $a_tpl->parseCurrentBlock();
292
293 $a_tpl->setCurrentBlock("path");
294 $a_tpl->parseCurrentBlock();
295
296 return $path;
297 }
$path
Definition: aliased.php:25
$counter

References $counter, $data, and $path.

◆ __readItemStatusInfo()

ilLearningProgressBaseGUI::__readItemStatusInfo (   $a_items)

Definition at line 623 of file class.ilLearningProgressBaseGUI.php.

624 {
625 global $ilObjDataCache;
626
627 include_once 'Services/Object/classes/class.ilObjectLP.php';
628
629 foreach($a_items as $item_id)
630 {
631 $olp = ilObjectLP::getInstance($item_id);
632
633 $this->obj_data[$item_id]['type'] = $ilObjDataCache->lookupType($item_id);
634 $this->obj_data[$item_id]['mode'] = $olp->getCurrentMode();
635 if($this->obj_data[$item_id]['mode'] == ilLPObjSettings::LP_MODE_TLT)
636 {
637 include_once './Services/MetaData/classes/class.ilMDEducational.php';
638 $this->obj_data[$item_id]['tlt'] = ilMDEducational::_getTypicalLearningTimeSeconds($item_id);
639 }
640 if($this->obj_data[$item_id]['mode'] == ilLPObjSettings::LP_MODE_VISITS)
641 {
642 $this->obj_data[$item_id]['visits'] = ilLPObjSettings::_lookupVisits($item_id);
643 }
644 if($this->obj_data[$item_id]['mode'] == ilLPObjSettings::LP_MODE_SCORM)
645 {
646 $collection = $olp->getCollectionInstance();
647 if($collection)
648 {
649 $this->obj_data[$item_id]['scos'] = count($collection->getItems());
650 }
651 }
652 }
653 }
static _lookupVisits($a_obj_id)
static _getTypicalLearningTimeSeconds($a_rbac_id, $a_obj_id=0)

References ilMDEducational\_getTypicalLearningTimeSeconds(), ilLPObjSettings\_lookupVisits(), ilObjectLP\getInstance(), ilLPObjSettings\LP_MODE_SCORM, ilLPObjSettings\LP_MODE_TLT, and ilLPObjSettings\LP_MODE_VISITS.

+ Here is the call graph for this function:

◆ __readStatus()

static ilLearningProgressBaseGUI::__readStatus (   $a_obj_id,
  $user_id 
)
static

Definition at line 550 of file class.ilLearningProgressBaseGUI.php.

551 {
552 include_once 'Services/Tracking/classes/class.ilLPStatus.php';
553 $status = ilLPStatus::_lookupStatus($a_obj_id, $user_id);
554
555 include_once("./Services/Tracking/classes/class.ilLPStatus.php");
556 switch($status)
557 {
560
563
566
569
570 default:
571 return $status;
572 }
573 }
const LP_STATUS_COMPLETED_NUM
static _lookupStatus($a_obj_id, $a_user_id, $a_create=true)
Lookup status.
const LP_STATUS_COMPLETED
const LP_STATUS_FAILED
const LP_STATUS_IN_PROGRESS_NUM
const LP_STATUS_NOT_ATTEMPTED_NUM
const LP_STATUS_FAILED_NUM
const LP_STATUS_NOT_ATTEMPTED
const LP_STATUS_IN_PROGRESS

References ilLPStatus\_lookupStatus(), ilLPStatus\LP_STATUS_COMPLETED, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

Referenced by __appendLPDetails(), and ilObjSCORMLearningModule\exportSelected().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __setSubTabs()

ilLearningProgressBaseGUI::__setSubTabs (   $a_active)

Definition at line 126 of file class.ilLearningProgressBaseGUI.php.

127 {
128 global $rbacsystem,$ilObjDataCache;
129
130
131
132 switch($this->getMode())
133 {
135
136 include_once("Services/Tracking/classes/class.ilObjUserTracking.php");
139 {
140 $this->tabs_gui->addTarget('trac_progress',
141 $this->ctrl->getLinkTargetByClass('illplistofprogressgui',''),
142 "","","",$a_active == self::LP_ACTIVE_PROGRESS);
143 }
144
146 {
147 $this->tabs_gui->addTarget('trac_objects',
148 $this->ctrl->getLinkTargetByClass("illplistofobjectsgui",''),
149 "","","",$a_active == self::LP_ACTIVE_OBJECTS);
150 }
151 break;
152
153
155 // #12771 - do not show status if learning progress is deactivated
156 include_once './Services/Object/classes/class.ilObjectLP.php';
157 $olp = ilObjectLP::getInstance($this->obj_id);
158 if($olp->isActive())
159 {
160 include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
161 $has_read = ilLearningProgressAccess::checkPermission('read_learning_progress', $this->getRefId());
162
163 if($this->isAnonymized() || !$has_read)
164 {
165 $this->ctrl->setParameterByClass('illplistofprogressgui','user_id',$this->getUserId());
166 $this->tabs_gui->addSubTabTarget('trac_progress',
167 $this->ctrl->getLinkTargetByClass('illplistofprogressgui',''),
168 "","","",$a_active == self::LP_ACTIVE_PROGRESS);
169 }
170 else
171 {
172 // Check if it is a course
173 $sub_tab = ($ilObjDataCache->lookupType($ilObjDataCache->lookupObjId($this->getRefId())) == 'crs') ?
174 'trac_crs_objects' :
175 'trac_objects';
176
177 $this->tabs_gui->addSubTabTarget($sub_tab,
178 $this->ctrl->getLinkTargetByClass("illplistofobjectsgui",''),
179 "","","",$a_active == self::LP_ACTIVE_OBJECTS);
180 }
181
182 if($has_read)
183 {
184 if(!$this->isAnonymized() &&
185 !($olp instanceof ilPluginLP) &&
186 ilObjectLP::supportsMatrixView($this->obj_type))
187 {
188 $this->tabs_gui->addSubTabTarget("trac_matrix",
189 $this->ctrl->getLinkTargetByClass("illplistofobjectsgui", 'showUserObjectMatrix'),
190 "", "", "", $a_active == self::LP_ACTIVE_MATRIX);
191 }
192
193 $this->tabs_gui->addSubTabTarget("trac_summary",
194 $this->ctrl->getLinkTargetByClass("illplistofobjectsgui", 'showObjectSummary'),
195 "", "", "", $a_active == self::LP_ACTIVE_SUMMARY);
196 }
197 }
198 include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
199 if(!($olp instanceof ilPluginLP) &&
200 ilLearningProgressAccess::checkPermission('edit_learning_progress', $this->getRefId()))
201 {
202 $this->tabs_gui->addSubTabTarget('trac_settings',
203 $this->ctrl->getLinkTargetByClass('illplistofsettingsgui',''),
204 "","","",$a_active == self::LP_ACTIVE_SETTINGS);
205 }
206 break;
207
209 /*
210 $this->tabs_gui->addSubTabTarget('trac_progress',
211 $this->ctrl->getLinkTargetByClass('illplistofprogressgui',''),
212 "","","",$a_active == self::LP_ACTIVE_PROGRESS);
213 */
214 $this->tabs_gui->addSubTabTarget('trac_objects',
215 $this->ctrl->getLinkTargetByClass("illplistofobjectsgui",''),
216 "","","",$a_active == self::LP_ACTIVE_OBJECTS);
217 break;
218
221 // No tabs default class is lpprogressgui
222 break;
223
224 default:
225 die ('No valid mode given');
226 break;
227 }
228
229 return true;
230 }
static checkPermission($a_permission, $a_ref_id, $a_user_id=null)
wrapper for rbac access checks
static supportsMatrixView($a_obj_type)

References ilObjUserTracking\_enabledUserRelatedData(), ilObjUserTracking\_hasLearningProgressLearner(), ilObjUserTracking\_hasLearningProgressOtherUsers(), ilLearningProgressAccess\checkPermission(), ilObjectLP\getInstance(), getMode(), getRefId(), getUserId(), isAnonymized(), LP_ACTIVE_MATRIX, LP_ACTIVE_OBJECTS, LP_ACTIVE_SETTINGS, LP_ACTIVE_SUMMARY, LP_CONTEXT_ADMINISTRATION, LP_CONTEXT_ORG_UNIT, LP_CONTEXT_PERSONAL_DESKTOP, LP_CONTEXT_REPOSITORY, LP_CONTEXT_USER_FOLDER, and ilObjectLP\supportsMatrixView().

Referenced by ilLearningProgressGUI\executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __showEditUser()

ilLearningProgressBaseGUI::__showEditUser (   $a_user_id,
  $a_ref_id,
  $a_cancel,
  $a_sub_id = false 
)

Definition at line 742 of file class.ilLearningProgressBaseGUI.php.

743 {
744 global $ilCtrl;
745
746 if(!$a_sub_id)
747 {
748 $obj_id = ilObject::_lookupObjId($a_ref_id);
749 }
750 else
751 {
752 $ilCtrl->setParameter($this,'userdetails_id',$a_sub_id);
753 $obj_id = ilObject::_lookupObjId($a_sub_id);
754 }
755
756 $ilCtrl->setParameter($this, 'user_id', $a_user_id);
757 $ilCtrl->setParameter($this, 'details_id', $a_ref_id);
758
759 $form = $this->initEditUserForm($a_user_id, $obj_id, $a_cancel);
760
761 return $form->getHTML();
762 }
initEditUserForm($a_user_id, $a_obj_id, $a_cancel=null)
static _lookupObjId($a_id)

References $ilCtrl, ilObject\_lookupObjId(), and initEditUserForm().

Referenced by ilLPListOfObjectsGUI\editUser().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __showImageByStatus()

ilLearningProgressBaseGUI::__showImageByStatus ( $tpl,
  $a_status,
  $tpl_prefix = "" 
)

Definition at line 299 of file class.ilLearningProgressBaseGUI.php.

300 {
301 return ilLearningProgressBaseGUI::_showImageByStatus($tpl,$a_status,$tpl_prefix);
302 }
static _showImageByStatus(&$tpl, $a_status, $tpl_prefix="")

References $tpl, and _showImageByStatus().

+ Here is the call graph for this function:

◆ __showObjectDetails()

ilLearningProgressBaseGUI::__showObjectDetails ( $info,
  $item_id = 0,
  $add_section = true 
)

show details about current object.

Uses an existing info_gui object.

Definition at line 402 of file class.ilLearningProgressBaseGUI.php.

403 {
404 global $ilObjDataCache;
405
406 $details_id = $item_id ? $item_id : $this->details_id;
407
408 include_once 'Services/Object/classes/class.ilObjectLP.php';
409 $olp = ilObjectLP::getInstance($details_id);
410 $mode = $olp->getCurrentMode();
411
412 include_once './Services/MetaData/classes/class.ilMDEducational.php';
415 {
416 // Section object details
417 if($add_section)
418 {
419 $info->addSection($this->lng->txt('details'));
420 }
421
423 {
424 $info->addProperty($this->lng->txt('trac_required_visits'), ilLPObjSettings::_lookupVisits($details_id));
425 }
426
427 if($seconds = ilMDEducational::_getTypicalLearningTimeSeconds($details_id))
428 {
429 $info->addProperty($this->lng->txt('meta_typical_learning_time'), ilDatePresentation::secondsToString($seconds));
430 }
431
432 return true;
433 }
434 return false;
435 }

References $info, $mode, ilMDEducational\_getTypicalLearningTimeSeconds(), ilLPObjSettings\_lookupVisits(), ilObjectLP\getInstance(), ilLPObjSettings\LP_MODE_VISITS, and ilDatePresentation\secondsToString().

Referenced by ilLPListOfObjectsGUI\details(), ilLPListOfObjectsGUI\editUser(), ilLPListOfObjectsGUI\showUserObjectMatrix(), and ilLPListOfObjectsGUI\userDetails().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __sort()

ilLearningProgressBaseGUI::__sort (   $a_ids,
  $a_table,
  $a_field,
  $a_id_name 
)

Function that sorts ids by a given table field using WHERE IN E.g: __sort(array(6,7),'usr_data','lastname','usr_id') => sorts by lastname.

Parameters
arrayArray of ids
stringtable name
stringtable field
stringid name
Returns
array sorted ids

@access protected

Definition at line 587 of file class.ilLearningProgressBaseGUI.php.

588 {
589 global $ilDB;
590
591 if(!$a_ids)
592 {
593 return array();
594 }
595
596 // comment by mjansen: Requesting database in gui classes?
597
598 // use database to sort user array
599 $where = "WHERE ".$ilDB->in($a_id_name, $a_ids, false, 'integer')." ";
600
601 $query = "SELECT ".$a_id_name." FROM ".$a_table." ".
602 $where.
603 "ORDER BY ".$a_field;
604
605 $res = $ilDB->query($query);
606 while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
607 {
608 $ids[] = $row->$a_id_name;
609 }
610 return $ids ? $ids : array();
611 }
global $ilDB

References $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

◆ __updateUser()

ilLearningProgressBaseGUI::__updateUser (   $user_id,
  $obj_id 
)

Definition at line 764 of file class.ilLearningProgressBaseGUI.php.

765 {
766 $form = $this->initEditUserForm($user_id, $obj_id);
767 if($form->checkInput())
768 {
769 include_once 'Services/Tracking/classes/class.ilLPMarks.php';
770
771 $marks = new ilLPMarks($obj_id, $user_id);
772 $marks->setMark($form->getInput("mark"));
773 $marks->setComment($form->getInput("comment"));
774
775 $do_lp = false;
776
777 // status/completed is optional
778 $status = $form->getItemByPostVar("completed");
779 if(is_object($status))
780 {
781 if($marks->getCompleted() != $form->getInput("completed"))
782 {
783 $marks->setCompleted($form->getInput("completed"));
784 $do_lp = true;
785 }
786 }
787
788 $marks->update();
789
790 // #11600
791 if($do_lp)
792 {
793 include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
794 ilLPStatusWrapper::_updateStatus($obj_id, $user_id);
795 }
796 }
797 }
static _updateStatus($a_obj_id, $a_usr_id, $a_obj=null, $a_percentage=false, $a_force_raise=false)
Update status.

References ilLPStatusWrapper\_updateStatus(), and initEditUserForm().

Referenced by ilLPListOfObjectsGUI\updateUser().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _getImagePathForStatus()

static ilLearningProgressBaseGUI::_getImagePathForStatus (   $a_status)
static

Get image path for status.

Definition at line 319 of file class.ilLearningProgressBaseGUI.php.

320 {
321 include_once("./Services/Tracking/classes/class.ilLPStatus.php");
322
323 // constants are either number or string, so make comparison string-based
324 switch((string)$a_status)
325 {
329 return ilUtil::getImagePath('scorm/incomplete.svg');
330 break;
331
335 return ilUtil::getImagePath('scorm/complete.svg');
336 break;
337
341 return ilUtil::getImagePath('scorm/not_attempted.svg');
342 break;
343
346 return ilUtil::getImagePath('scorm/failed.svg');
347 break;
348
349 default:
350 return ilUtil::getImagePath('scorm/not_attempted.svg');
351 break;
352 }
353 }
const LP_STATUS_NOT_PARTICIPATED
const LP_STATUS_NOT_REGISTERED
const LP_STATUS_PARTICIPATED
const LP_STATUS_REGISTERED

References ilUtil\getImagePath(), ilLPStatus\LP_STATUS_COMPLETED, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED, ilLPStatus\LP_STATUS_NOT_PARTICIPATED, ilLPStatus\LP_STATUS_NOT_REGISTERED, ilLPStatus\LP_STATUS_PARTICIPATED, and ilLPStatus\LP_STATUS_REGISTERED.

Referenced by __appendLPDetails(), ilLPObjectStatisticsLPTableGUI\__construct(), _showImageByStatus(), ilLMExplorerGUI\checkLPIcon(), ilLPProgressTableGUI\fillRow(), ilTrUserObjectsPropsTableGUI\fillRow(), ilLPObjectStatisticsLPTableGUI\getDetailItems(), ilIndividualAssessmentMembersTableGUI\getImagetPathForStatus(), ilTrSummaryTableGUI\getItems(), ilDclRecordListTableGUI\getStatus(), ilLearningProgressGUI\initCollectionManualForm(), ilSCORM2004TrackingItemsTableGUI\parseValue(), ilSCORMTrackingItemsTableGUI\parseValue(), ilLPTableBaseGUI\parseValue(), ilLPStatus\preloadListGUIData(), ilPortfolioPageGUI\renderMyCourses(), and ilLearningProgressGUI\showtlt().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _getStatusText()

static ilLearningProgressBaseGUI::_getStatusText (   $a_status,
  $a_lng = null 
)
static

Get status alt text.

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

359 {
360 global $lng;
361
362 if(!$a_lng)
363 {
364 $a_lng = $lng;
365 }
366
367 include_once("./Services/Tracking/classes/class.ilLPStatus.php");
368//echo "#".$a_status."#";
369 switch($a_status)
370 {
372 return $a_lng->txt(ilLPStatus::LP_STATUS_IN_PROGRESS);
373
375 return $a_lng->txt(ilLPStatus::LP_STATUS_COMPLETED);
376
378 return $a_lng->txt(ilLPStatus::LP_STATUS_FAILED);
379
380 default:
382 {
383 return $a_lng->txt(ilLPStatus::LP_STATUS_NOT_ATTEMPTED);
384 }
385 return $a_lng->txt($a_status);
386 }
387 }

References $lng, ilLPStatus\LP_STATUS_COMPLETED, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

Referenced by __appendLPDetails(), ilLPObjectStatisticsLPTableGUI\__construct(), ilTrSummaryTableGUI\fillHeaderCSV(), ilTrSummaryTableGUI\fillHeaderExcel(), ilLPProgressTableGUI\fillRow(), ilTrUserObjectsPropsTableGUI\fillRow(), ilSCORM2004TrackingItemsTableGUI\fillRowCSV(), ilSCORMTrackingItemsTableGUI\fillRowCSV(), ilLPProgressTableGUI\fillRowCSV(), ilTrMatrixTableGUI\fillRowCSV(), ilTrObjectUsersPropsTableGUI\fillRowCSV(), ilTrUserObjectsPropsTableGUI\fillRowCSV(), ilLPProgressTableGUI\fillRowExcel(), ilTrMatrixTableGUI\fillRowExcel(), ilTrObjectUsersPropsTableGUI\fillRowExcel(), ilTrUserObjectsPropsTableGUI\fillRowExcel(), ilSCORM2004TrackingItemsTableGUI\fillRowExcel(), ilSCORMTrackingItemsTableGUI\fillRowExcel(), ilLPObjectStatisticsLPTableGUI\getDetailItems(), ilLPObjectStatisticsLPTableGUI\getGraph(), ilTrSummaryTableGUI\getItems(), ilLearningProgressGUI\initCollectionManualForm(), ilLPObjectStatisticsLPTableGUI\initFilter(), ilSCORM2004TrackingItemsTableGUI\parseValue(), ilSCORMTrackingItemsTableGUI\parseValue(), ilLPTableBaseGUI\parseValue(), ilLPStatus\preloadListGUIData(), ilPortfolioPageGUI\renderMyCourses(), and ilLearningProgressGUI\showtlt().

+ Here is the caller graph for this function:

◆ _showImageByStatus()

static ilLearningProgressBaseGUI::_showImageByStatus ( $tpl,
  $a_status,
  $tpl_prefix = "" 
)
static

Definition at line 305 of file class.ilLearningProgressBaseGUI.php.

306 {
307 global $lng;
308
309 $tpl->setVariable($tpl_prefix."STATUS_IMG",
311 $tpl->setVariable($tpl_prefix."STATUS_ALT",$lng->txt($a_status));
312
313 return true;
314 }

References $lng, $tpl, and _getImagePathForStatus().

Referenced by __showImageByStatus().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMode()

◆ getObjId()

◆ getRefId()

◆ getUserId()

ilLearningProgressBaseGUI::getUserId ( )

Definition at line 103 of file class.ilLearningProgressBaseGUI.php.

104 {
105 if($this->usr_id)
106 {
107 return $this->usr_id;
108 }
109 if((int) $_GET['user_id'])
110 {
111 return (int) $_GET['user_id'];
112 }
113 return 0;
114 }
$_GET["client_id"]

References $_GET.

Referenced by __setSubTabs(), ilLearningProgressGUI\executeCommand(), ilLPListOfProgressGUI\executeCommand(), and ilLPListOfProgressGUI\show().

+ Here is the caller graph for this function:

◆ initEditUserForm()

ilLearningProgressBaseGUI::initEditUserForm (   $a_user_id,
  $a_obj_id,
  $a_cancel = null 
)
protected

Definition at line 685 of file class.ilLearningProgressBaseGUI.php.

686 {
687 global $lng, $ilCtrl;
688
689 include_once 'Services/Object/classes/class.ilObjectLP.php';
690 $olp = ilObjectLP::getInstance($a_obj_id);
691 $lp_mode = $olp->getCurrentMode();
692
693 include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
694 $form = new ilPropertyFormGUI();
695
696 $form->setFormAction($ilCtrl->getFormAction($this, "updateUser"));
697
698 $form->setTitle($lng->txt("edit").": ".ilObject::_lookupTitle($a_obj_id));
699 $form->setDescription($lng->txt('trac_mode').": ".$olp->getModeText($lp_mode));
700
701 include_once "Services/User/classes/class.ilUserUtil.php";
702 $user = new ilNonEditableValueGUI($lng->txt("user"), null, true);
703 $user->setValue(ilUserUtil::getNamePresentation($a_user_id, true));
704 $form->addItem($user);
705
706 include_once 'Services/Tracking/classes/class.ilLPMarks.php';
707 $marks = new ilLPMarks($a_obj_id, $a_user_id);
708
710 {
711 $mark = new ilTextInputGUI($lng->txt("trac_mark"), "mark");
712 $mark->setValue($marks->getMark());
713 $mark->setMaxLength(32);
714 $form->addItem($mark);
715 }
716
717 $comm = new ilTextInputGUI($lng->txt("trac_comment"), "comment");
718 $comm->setValue($marks->getComment());
719 $form->addItem($comm);
720
721 if($lp_mode == ilLPObjSettings::LP_MODE_MANUAL ||
723 {
724 include_once("./Services/Tracking/classes/class.ilLPStatus.php");
725 $completed = ilLPStatus::_lookupStatus($a_obj_id, $a_user_id);
726
727 $status = new ilCheckboxInputGUI($lng->txt('trac_completed'), "completed");
728 $status->setChecked(($completed == ilLPStatus::LP_STATUS_COMPLETED_NUM));
729 $form->addItem($status);
730 }
731
732 $form->addCommandButton("updateUser", $lng->txt('save'));
733
734 if($a_cancel)
735 {
736 $form->addCommandButton($a_cancel, $lng->txt('cancel'));
737 }
738
739 return $form;
740 }
This class represents a checkbox property in a property form.
This class represents a non editable value in a property form.
static _lookupType($a_id, $a_reference=false)
lookup object type
This class represents a property form user interface.
This class represents a text property in a property form.
static getNamePresentation($a_user_id, $a_user_image=false, $a_profile_link=false, $a_profile_back_link="", $a_force_first_lastname=false, $a_omit_login=false, $a_sortable=true, $a_return_data_array=false)
Default behaviour is:

References $ilCtrl, $lng, ilLPStatus\_lookupStatus(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilObjectLP\getInstance(), ilUserUtil\getNamePresentation(), ilLPObjSettings\LP_MODE_MANUAL, ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR, ilLPStatus\LP_STATUS_COMPLETED_NUM, and ilObjectLP\supportsMark().

Referenced by __showEditUser(), and __updateUser().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isAnonymized()

ilLearningProgressBaseGUI::isAnonymized ( )

◆ isObjectOffline()

static ilLearningProgressBaseGUI::isObjectOffline (   $a_obj_id,
  $a_type = null 
)
static

Definition at line 799 of file class.ilLearningProgressBaseGUI.php.

800 {
801 global $objDefinition, $ilObjDataCache;
802
803 if(!$a_type)
804 {
805 $a_type = $ilObjDataCache->lookupType($a_obj_id);
806 }
807
808 if($objDefinition->isPluginTypeName($a_type))
809 {
810 return false;
811 }
812
813 $class = "ilObj".$objDefinition->getClassName($a_type)."Access";
814 include_once $objDefinition->getLocation($a_type)."/class.".$class.".php";
815 return call_user_func(array($class,'_isOffline'), $a_obj_id);
816
817 // PHP 5.3 only ?
818 //return $class::_isOffline($obj_id);
819 }
$a_type
Definition: workflow.php:93

References $a_type.

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

+ Here is the caller graph for this function:

Field Documentation

◆ $anonymized

ilLearningProgressBaseGUI::$anonymized
protected

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

Referenced by isAnonymized().

◆ $ctrl

ilLearningProgressBaseGUI::$ctrl = null

Definition at line 24 of file class.ilLearningProgressBaseGUI.php.

◆ $lng

◆ $logger

ilLearningProgressBaseGUI::$logger
protected

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

◆ $mode

ilLearningProgressBaseGUI::$mode = 0

◆ $ref_id

ilLearningProgressBaseGUI::$ref_id = 0

◆ $tpl

◆ LP_ACTIVE_MATRIX

const ilLearningProgressBaseGUI::LP_ACTIVE_MATRIX = 11

Definition at line 54 of file class.ilLearningProgressBaseGUI.php.

Referenced by __setSubTabs().

◆ LP_ACTIVE_OBJECTS

const ilLearningProgressBaseGUI::LP_ACTIVE_OBJECTS = 2

Definition at line 45 of file class.ilLearningProgressBaseGUI.php.

Referenced by __setSubTabs().

◆ LP_ACTIVE_OBJSTATACCESS

const ilLearningProgressBaseGUI::LP_ACTIVE_OBJSTATACCESS = 7

Definition at line 50 of file class.ilLearningProgressBaseGUI.php.

◆ LP_ACTIVE_OBJSTATADMIN

const ilLearningProgressBaseGUI::LP_ACTIVE_OBJSTATADMIN = 10

Definition at line 53 of file class.ilLearningProgressBaseGUI.php.

◆ LP_ACTIVE_OBJSTATDAILY

const ilLearningProgressBaseGUI::LP_ACTIVE_OBJSTATDAILY = 9

Definition at line 52 of file class.ilLearningProgressBaseGUI.php.

◆ LP_ACTIVE_OBJSTATTYPES

const ilLearningProgressBaseGUI::LP_ACTIVE_OBJSTATTYPES = 8

Definition at line 51 of file class.ilLearningProgressBaseGUI.php.

◆ LP_ACTIVE_PROGRESS

const ilLearningProgressBaseGUI::LP_ACTIVE_PROGRESS = 3

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

◆ LP_ACTIVE_SETTINGS

const ilLearningProgressBaseGUI::LP_ACTIVE_SETTINGS = 1

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

Referenced by __setSubTabs().

◆ LP_ACTIVE_SUMMARY

const ilLearningProgressBaseGUI::LP_ACTIVE_SUMMARY = 6

Definition at line 49 of file class.ilLearningProgressBaseGUI.php.

Referenced by __setSubTabs().

◆ LP_ACTIVE_USERS

const ilLearningProgressBaseGUI::LP_ACTIVE_USERS = 5

Definition at line 48 of file class.ilLearningProgressBaseGUI.php.

◆ LP_CONTEXT_ADMINISTRATION

const ilLearningProgressBaseGUI::LP_CONTEXT_ADMINISTRATION = 2

◆ LP_CONTEXT_ORG_UNIT

◆ LP_CONTEXT_PERSONAL_DESKTOP

const ilLearningProgressBaseGUI::LP_CONTEXT_PERSONAL_DESKTOP = 1

◆ LP_CONTEXT_REPOSITORY

◆ LP_CONTEXT_USER_FOLDER

const ilLearningProgressBaseGUI::LP_CONTEXT_USER_FOLDER = 4

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