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.

    {
        global $tpl,$ilCtrl,$lng,$ilObjDataCache,$ilTabs;
 
        $this->tpl = $tpl;
        $this->ctrl = $ilCtrl;
        $this->lng = $lng;
        $this->lng->loadLanguageModule('trac');
        $this->tabs_gui = $ilTabs;
 
        $this->mode = $a_mode;
        $this->ref_id = $a_ref_id;
        $this->obj_id = $ilObjDataCache->lookupObjId($this->ref_id);
        $this->obj_type = $ilObjDataCache->lookupType($this->obj_id);
        $this->usr_id = $a_usr_id;
 
        $this->anonymized = (bool) !ilObjUserTracking::_enabledUserRelatedData();
        if (!$this->anonymized && $this->obj_id) {
            include_once "Services/Object/classes/class.ilObjectLP.php";
            $olp = ilObjectLP::getInstance($this->obj_id);
            $this->anonymized = $olp->isAnonymized();
        }
        
        $this->logger = $GLOBALS['DIC']->logger()->trac();
    }

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 479 of file class.ilLearningProgressBaseGUI.php.

    {
        global $ilObjDataCache;
 
        $type = $ilObjDataCache->lookupType($item_id);
        
        // Section learning_progress
        // $info->addSection($this->lng->txt('trac_learning_progress'));
        // see ilLPTableBaseGUI::parseTitle();
        $info->addSection($this->lng->txt("trac_progress") . ": " . ilObject::_lookupTitle($item_id));
        
        $olp = ilObjectLP::getInstance($item_id);
        $info->addProperty(
            $this->lng->txt('trac_mode'),
            $olp->getModeText($olp->getCurrentMode())
        );
        
        switch ($type) {
            case 'lm':
            case 'htlm':
                include_once 'Services/Tracking/classes/class.ilLearningProgress.php';
                $progress = ilLearningProgress::_getProgress($user_id, $item_id);
            
                if ($progress['access_time']) {
                    $info->addProperty(
                        $this->lng->txt('last_access'),
                        ilDatePresentation::formatDate(new ilDateTime($progress['access_time'], IL_CAL_UNIX))
                    );
                } else {
                    $info->addProperty($this->lng->txt('last_access'), $this->lng->txt('trac_not_accessed'));
                }
                $info->addProperty($this->lng->txt('trac_visits'), (int) $progress['visits']);
                if (ilObjectLP::supportsSpentSeconds($type)) {
                    $info->addProperty($this->lng->txt('trac_spent_time'), ilDatePresentation::secondsToString($progress['spent_seconds']));
                }
                // fallthrough
                
                // no break
            case 'exc':
            case 'tst':
            case 'file':
            case 'mcst':
            case 'svy':
            case 'crs':
            case 'sahs':
            case 'grp':
            case 'iass':
            case 'sess':
                // display status as image
                include_once("./Services/Tracking/classes/class.ilLearningProgressBaseGUI.php");
                $status = $this->__readStatus($item_id, $user_id);
                $status_path = ilLearningProgressBaseGUI::_getImagePathForStatus($status);
                $status_text = ilLearningProgressBaseGUI::_getStatusText($status);
                $info->addProperty(
                    $this->lng->txt('trac_status'),
                    ilUtil::img($status_path, $status_text) . " " . $status_text
                );
                
                // #15334 - see ilLPTableBaseGUI::isPercentageAvailable()
                $mode = $olp->getCurrentMode();
                if (in_array($mode, array(ilLPObjSettings::LP_MODE_TLT,
                    ilLPObjSettings::LP_MODE_VISITS,
                    // ilLPObjSettings::LP_MODE_OBJECTIVES,
                    ilLPObjSettings::LP_MODE_SCORM,
                    ilLPObjSettings::LP_MODE_TEST_PASSED))) {
                    include_once 'Services/Tracking/classes/class.ilLPStatus.php';
                    $perc = ilLPStatus::_lookupPercentage($item_id, $user_id);
                    $info->addProperty($this->lng->txt('trac_percentage'), (int) $perc . "%");
                }
                break;
 
        }
        
        include_once 'Services/Tracking/classes/class.ilLPMarks.php';
 
        if (ilObjectLP::supportsMark($type)) {
            if (strlen($mark = ilLPMarks::_lookupMark($user_id, $item_id))) {
                $info->addProperty($this->lng->txt('trac_mark'), $mark);
            }
        }
        
        if (strlen($comment = ilLPMarks::_lookupComment($user_id, $item_id))) {
            $info->addProperty($this->lng->txt('trac_comment'), $comment);
        }
    }

References $comment, $info, $mode, $type, __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 452 of file class.ilLearningProgressBaseGUI.php.

    {
        global $ilUser;
        
        // #13525 - irrelevant personal data is not to be presented
        return;
 
        if (!is_object($a_user)) {
            $a_user = ilObjectFactory::getInstanceByObjId($a_user);
        }
 
        if ($a_user->getId() != $ilUser->getId()) {
            $info->addSection($this->lng->txt("trac_user_data"));
            // $info->addProperty($this->lng->txt('username'),$a_user->getLogin());
            // $info->addProperty($this->lng->txt('name'),$a_user->getFullname());
            $info->addProperty(
                $this->lng->txt('last_login'),
                ilDatePresentation::formatDate(new ilDateTime($a_user->getLastLogin(), IL_CAL_DATETIME))
            );
            $info->addProperty(
                $this->lng->txt('trac_total_online'),
                ilDatePresentation::secondsToString(ilOnlineTracking::getOnlineTime($a_user->getId()))
            );
            return true;
        }
    }

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 258 of file class.ilLearningProgressBaseGUI.php.

    {
        switch ($this->getMode()) {
            case self::LP_CONTEXT_PERSONAL_DESKTOP:
 
                $this->tpl->show(true);
        }
    }

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 267 of file class.ilLearningProgressBaseGUI.php.

    {
        if ($this->getMode() == self::LP_CONTEXT_PERSONAL_DESKTOP) {
            $this->tpl->setTitle($this->lng->txt("learning_progress"));
            
            // set locator
            /*
                        $this->tpl->setVariable("TXT_LOCATOR", $this->lng->txt("locator"));
                        $this->tpl->touchBlock("locator_separator");
                        $this->tpl->touchBlock("locator_item");
                        //$this->tpl->setCurrentBlock("locator_item");
                        //$this->tpl->setVariable("ITEM", $this->lng->txt("personal_desktop"));
                        //$this->tpl->setVariable("LINK_ITEM",
                        //                                              $this->ctrl->getLinkTargetByClass("ilpersonaldesktopgui"));
                        //$this->tpl->parseCurrentBlock();
            
                        $this->tpl->setCurrentBlock("locator_item");
                        $this->tpl->setVariable("ITEM", $this->lng->txt("learning_progress"));
                        $this->tpl->setVariable("LINK_ITEM",
                                                $this->ctrl->getLinkTargetByClass('illearningprogressgui'));
                        $this->tpl->parseCurrentBlock();
            */
        
            // display infopanel if something happened
            ilUtil::infoPanel();
        }
    }

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 114 of file class.ilLearningProgressBaseGUI.php.

    {
        if (strlen($cmd = $this->ctrl->getCmd())) {
            return $cmd;
        }
        return 'show';
    }

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 661 of file class.ilLearningProgressBaseGUI.php.

    {
        global $lng;
        
        $tpl = new ilTemplate("tpl.lp_legend.html", true, true, "Services/Tracking");
        $tpl->setVariable(
            "IMG_NOT_ATTEMPTED",
            ilUtil::getImagePath("scorm/not_attempted.svg")
        );
        $tpl->setVariable(
            "IMG_IN_PROGRESS",
            ilUtil::getImagePath("scorm/incomplete.svg")
        );
        $tpl->setVariable(
            "IMG_COMPLETED",
            ilUtil::getImagePath("scorm/completed.svg")
        );
        $tpl->setVariable(
            "IMG_FAILED",
            ilUtil::getImagePath("scorm/failed.svg")
        );
        $tpl->setVariable(
            "TXT_NOT_ATTEMPTED",
            $lng->txt("trac_not_attempted")
        );
        $tpl->setVariable(
            "TXT_IN_PROGRESS",
            $lng->txt("trac_in_progress")
        );
        $tpl->setVariable(
            "TXT_COMPLETED",
            $lng->txt("trac_completed")
        );
        $tpl->setVariable(
            "TXT_FAILED",
            $lng->txt("trac_failed")
        );
        
        include_once "Services/UIComponent/Panel/classes/class.ilPanelGUI.php";
        $panel = ilPanelGUI::getInstance();
        $panel->setPanelStyle(ilPanelGUI::PANEL_STYLE_SECONDARY);
        $panel->setBody($tpl->get());
        
        return $panel->getHTML();
    }

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 625 of file class.ilLearningProgressBaseGUI.php.

    {
        if (!$max) {
            return "0%";
        }
 
        return sprintf("%d%%", $reached / $max * 100);
    }

References sprintf.

◆ __initTableGUI()

& ilLearningProgressBaseGUI::__initTableGUI ( )

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

    {
        include_once "./Services/Table/classes/class.ilTableGUI.php";
 
        return new ilTableGUI(0, false);
    }

◆ __insertPath()

ilLearningProgressBaseGUI::__insertPath	(	&	$a_tpl,
			$a_ref_id
	)

insert path

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

    {
        global $tree;
 
        $path_arr = $tree->getPathFull($a_ref_id);
        $counter = 0;
        foreach ($tree->getPathFull($a_ref_id) as $data) {
            if ($counter++) {
                $path .= " -> ";
            }
            $path .= $data['title'];
        }
        $a_tpl->setCurrentBlock("path_item");
        $a_tpl->setVariable("PATH_ITEM", $path);
        $a_tpl->parseCurrentBlock();
 
        $a_tpl->setCurrentBlock("path");
        $a_tpl->parseCurrentBlock();
 
        return $path;
    }

References $counter, $data, and $path.

◆ __readItemStatusInfo()

ilLearningProgressBaseGUI::__readItemStatusInfo ( $a_items )

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

    {
        global $ilObjDataCache;
 
        include_once 'Services/Object/classes/class.ilObjectLP.php';
        
        foreach ($a_items as $item_id) {
            $olp = ilObjectLP::getInstance($item_id);
            
            $this->obj_data[$item_id]['type'] = $ilObjDataCache->lookupType($item_id);
            $this->obj_data[$item_id]['mode'] = $olp->getCurrentMode();
            if ($this->obj_data[$item_id]['mode'] == ilLPObjSettings::LP_MODE_TLT) {
                include_once './Services/MetaData/classes/class.ilMDEducational.php';
                $this->obj_data[$item_id]['tlt'] = ilMDEducational::_getTypicalLearningTimeSeconds($item_id);
            }
            if ($this->obj_data[$item_id]['mode'] == ilLPObjSettings::LP_MODE_VISITS) {
                $this->obj_data[$item_id]['visits'] = ilLPObjSettings::_lookupVisits($item_id);
            }
            if ($this->obj_data[$item_id]['mode'] == ilLPObjSettings::LP_MODE_SCORM) {
                $collection = $olp->getCollectionInstance();
                if ($collection) {
                    $this->obj_data[$item_id]['scos'] = count($collection->getItems());
                }
            }
        }
    }

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 565 of file class.ilLearningProgressBaseGUI.php.

    {
        include_once 'Services/Tracking/classes/class.ilLPStatus.php';
        $status = ilLPStatus::_lookupStatus($a_obj_id, $user_id);
 
        include_once("./Services/Tracking/classes/class.ilLPStatus.php");
        switch ($status) {
            case ilLPStatus::LP_STATUS_IN_PROGRESS_NUM:
                return ilLPStatus::LP_STATUS_IN_PROGRESS;
 
            case ilLPStatus::LP_STATUS_COMPLETED_NUM:
                return ilLPStatus::LP_STATUS_COMPLETED;
 
            case ilLPStatus::LP_STATUS_FAILED_NUM:
                return ilLPStatus::LP_STATUS_FAILED;
 
            case ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM:
                return ilLPStatus::LP_STATUS_NOT_ATTEMPTED;
 
            default:
                return $status;
        }
    }

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 122 of file class.ilLearningProgressBaseGUI.php.

    {
        global $rbacsystem,$ilObjDataCache;
 
 
        
        switch ($this->getMode()) {
            case self::LP_CONTEXT_PERSONAL_DESKTOP:
 
                include_once("Services/Tracking/classes/class.ilObjUserTracking.php");
                if (ilObjUserTracking::_hasLearningProgressLearner() &&
                    ilObjUserTracking::_enabledUserRelatedData()) {
                    $this->tabs_gui->addTarget(
                        'trac_progress',
                        $this->ctrl->getLinkTargetByClass('illplistofprogressgui', ''),
                        "",
                        "",
                        "",
                        $a_active == self::LP_ACTIVE_PROGRESS
                    );
                }
 
                if (ilObjUserTracking::_hasLearningProgressOtherUsers()) {
                    $this->tabs_gui->addTarget(
                        'trac_objects',
                        $this->ctrl->getLinkTargetByClass("illplistofobjectsgui", ''),
                        "",
                        "",
                        "",
                        $a_active == self::LP_ACTIVE_OBJECTS
                    );
                }
                break;
 
 
            case self::LP_CONTEXT_REPOSITORY:
                // #12771 - do not show status if learning progress is deactivated
                include_once './Services/Object/classes/class.ilObjectLP.php';
                $olp = ilObjectLP::getInstance($this->obj_id);
                if ($olp->isActive()) {
                    include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
                    $has_read = ilLearningProgressAccess::checkPermission('read_learning_progress', $this->getRefId());
                                
                    if ($this->isAnonymized() || !$has_read) {
                        $this->ctrl->setParameterByClass('illplistofprogressgui', 'user_id', $this->getUserId());
                        $this->tabs_gui->addSubTabTarget(
                            'trac_progress',
                            $this->ctrl->getLinkTargetByClass('illplistofprogressgui', ''),
                            "",
                            "",
                            "",
                            $a_active == self::LP_ACTIVE_PROGRESS
                        );
                    } else {
                        // Check if it is a course
                        $sub_tab = ($ilObjDataCache->lookupType($ilObjDataCache->lookupObjId($this->getRefId())) == 'crs') ?
                            'trac_crs_objects' :
                            'trac_objects';
 
                        $this->tabs_gui->addSubTabTarget(
                            $sub_tab,
                            $this->ctrl->getLinkTargetByClass("illplistofobjectsgui", ''),
                            "",
                            "",
                            "",
                            $a_active == self::LP_ACTIVE_OBJECTS
                        );
                    }
 
                    if ($has_read) {
                        if (!$this->isAnonymized() &&
                            !($olp instanceof ilPluginLP) &&
                            ilObjectLP::supportsMatrixView($this->obj_type)) {
                            $this->tabs_gui->addSubTabTarget(
                                "trac_matrix",
                                $this->ctrl->getLinkTargetByClass("illplistofobjectsgui", 'showUserObjectMatrix'),
                                "",
                                "",
                                "",
                                $a_active == self::LP_ACTIVE_MATRIX
                            );
                        }
 
                        $this->tabs_gui->addSubTabTarget(
                            "trac_summary",
                            $this->ctrl->getLinkTargetByClass("illplistofobjectsgui", 'showObjectSummary'),
                            "",
                            "",
                            "",
                            $a_active == self::LP_ACTIVE_SUMMARY
                        );
                    }
                }
                include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
                if (!($olp instanceof ilPluginLP) &&
                    ilLearningProgressAccess::checkPermission('edit_learning_progress', $this->getRefId())) {
                    $this->tabs_gui->addSubTabTarget(
                        'trac_settings',
                        $this->ctrl->getLinkTargetByClass('illplistofsettingsgui', ''),
                        "",
                        "",
                        "",
                        $a_active == self::LP_ACTIVE_SETTINGS
                    );
                }
                break;
 
            case self::LP_CONTEXT_ADMINISTRATION:
                /*
                $this->tabs_gui->addSubTabTarget('trac_progress',
                                     $this->ctrl->getLinkTargetByClass('illplistofprogressgui',''),
                                     "","","",$a_active == self::LP_ACTIVE_PROGRESS);
                */
                $this->tabs_gui->addSubTabTarget(
                    'trac_objects',
                    $this->ctrl->getLinkTargetByClass("illplistofobjectsgui", ''),
                    "",
                    "",
                    "",
                    $a_active == self::LP_ACTIVE_OBJECTS
                );
                break;
 
            case self::LP_CONTEXT_USER_FOLDER:
            case self::LP_CONTEXT_ORG_UNIT:
                // No tabs default class is lpprogressgui
                break;
 
            default:
                die('No valid mode given');
                break;
        }
 
        return true;
    }

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 761 of file class.ilLearningProgressBaseGUI.php.

    {
        global $ilCtrl;
        
        if (!$a_sub_id) {
            $obj_id = ilObject::_lookupObjId($a_ref_id);
        } else {
            $ilCtrl->setParameter($this, 'userdetails_id', $a_sub_id);
            $obj_id = ilObject::_lookupObjId($a_sub_id);
        }
                
        $ilCtrl->setParameter($this, 'user_id', $a_user_id);
        $ilCtrl->setParameter($this, 'details_id', $a_ref_id);
        
        $form = $this->initEditUserForm($a_user_id, $obj_id, $a_cancel);
        
        return $form->getHTML();
    }

References $form, $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 320 of file class.ilLearningProgressBaseGUI.php.

    {
        return ilLearningProgressBaseGUI::_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 421 of file class.ilLearningProgressBaseGUI.php.

    {
        global $ilObjDataCache;
 
        $details_id = $item_id ? $item_id : $this->details_id;
        
        include_once 'Services/Object/classes/class.ilObjectLP.php';
        $olp = ilObjectLP::getInstance($details_id);
        $mode = $olp->getCurrentMode();
 
        include_once './Services/MetaData/classes/class.ilMDEducational.php';
        if ($mode == ilLPObjSettings::LP_MODE_VISITS ||
           ilMDEducational::_getTypicalLearningTimeSeconds($details_id)) {
            // Section object details
            if ($add_section) {
                $info->addSection($this->lng->txt('details'));
            }
 
            if ($mode == ilLPObjSettings::LP_MODE_VISITS) {
                $info->addProperty($this->lng->txt('trac_required_visits'), ilLPObjSettings::_lookupVisits($details_id));
            }
 
            if ($seconds = ilMDEducational::_getTypicalLearningTimeSeconds($details_id)) {
                $info->addProperty($this->lng->txt('meta_typical_learning_time'), ilDatePresentation::secondsToString($seconds));
            }
 
            return true;
        }
        return false;
    }

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

array	Array of ids
string	table name
string	table field
string	id name

Returns: array sorted ids

@access protected

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

    {
        global $ilDB;
 
        if (!$a_ids) {
            return array();
        }
 
        // comment by mjansen: Requesting database in gui classes?
 
        // use database to sort user array
        $where = "WHERE " . $ilDB->in($a_id_name, $a_ids, false, 'integer') . " ";
 
        $query = "SELECT " . $a_id_name . " FROM " . $a_table . " " .
            $where .
            "ORDER BY " . $a_field;
 
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $ids[] = $row->$a_id_name;
        }
        return $ids ? $ids : array();
    }

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

◆ __updateUser()

ilLearningProgressBaseGUI::__updateUser	(	$user_id,
		$obj_id
	)

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

    {
        $form = $this->initEditUserForm($user_id, $obj_id);
        if ($form->checkInput()) {
            include_once 'Services/Tracking/classes/class.ilLPMarks.php';
 
            $marks = new ilLPMarks($obj_id, $user_id);
            $marks->setMark($form->getInput("mark"));
            $marks->setComment($form->getInput("comment"));
            
            $do_lp = false;
            
            // status/completed is optional
            $status = $form->getItemByPostVar("completed");
            if (is_object($status)) {
                if ($marks->getCompleted() != $form->getInput("completed")) {
                    $marks->setCompleted($form->getInput("completed"));
                    $do_lp = true;
                }
            }
 
            $marks->update();
 
            // #11600
            if ($do_lp) {
                include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
                ilLPStatusWrapper::_updateStatus($obj_id, $user_id);
            }
        }
    }

References $form, 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 342 of file class.ilLearningProgressBaseGUI.php.

    {
        include_once("./Services/Tracking/classes/class.ilLPStatus.php");
 
        // constants are either number or string, so make comparison string-based
        switch ((string) $a_status) {
            case ilLPStatus::LP_STATUS_IN_PROGRESS_NUM:
            case ilLPStatus::LP_STATUS_IN_PROGRESS:
            case ilLPStatus::LP_STATUS_REGISTERED:
                return ilUtil::getImagePath('scorm/incomplete.svg');
                break;
 
            case ilLPStatus::LP_STATUS_COMPLETED_NUM:
            case ilLPStatus::LP_STATUS_COMPLETED:
            case ilLPStatus::LP_STATUS_PARTICIPATED:
                return ilUtil::getImagePath('scorm/complete.svg');
                break;
            
            case ilLPStatus::LP_STATUS_NOT_ATTEMPTED:
            case ilLPStatus::LP_STATUS_NOT_PARTICIPATED:
            case ilLPStatus::LP_STATUS_NOT_REGISTERED:
                return ilUtil::getImagePath('scorm/not_attempted.svg');
                break;
 
            case ilLPStatus::LP_STATUS_FAILED_NUM:
            case ilLPStatus::LP_STATUS_FAILED:
                return ilUtil::getImagePath('scorm/failed.svg');
                break;
            
            default:
                return ilUtil::getImagePath('scorm/not_attempted.svg');
                break;
        }
    }

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(), ilMyStaffGUI\getUserLpStatusAsHtml(), 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 380 of file class.ilLearningProgressBaseGUI.php.

    {
        global $lng;
        
        if (!$a_lng) {
            $a_lng = $lng;
        }
        
        include_once("./Services/Tracking/classes/class.ilLPStatus.php");
        //echo "#".$a_status."#";
        switch ($a_status) {
            case ilLPStatus::LP_STATUS_IN_PROGRESS_NUM:
                return $a_lng->txt(ilLPStatus::LP_STATUS_IN_PROGRESS);
                
            case ilLPStatus::LP_STATUS_COMPLETED_NUM:
                return $a_lng->txt(ilLPStatus::LP_STATUS_COMPLETED);
 
            case ilLPStatus::LP_STATUS_FAILED_NUM:
                return $a_lng->txt(ilLPStatus::LP_STATUS_FAILED);
 
            default:
                if ($a_status === ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM) {
                    return $a_lng->txt(ilLPStatus::LP_STATUS_NOT_ATTEMPTED);
                }
                return $a_lng->txt($a_status);
        }
    }

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(), ilMyStaffGUI\getUserLpStatusAsHtml(), ilMyStaffGUI\getUserLpStatusAsText(), 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 326 of file class.ilLearningProgressBaseGUI.php.

    {
        global $lng;
        
        $tpl->setVariable(
            $tpl_prefix . "STATUS_IMG",
            ilLearningProgressBaseGUI::_getImagePathForStatus($a_status)
        );
        $tpl->setVariable($tpl_prefix . "STATUS_ALT", $lng->txt($a_status));
        
        return true;
    }

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()

ilLearningProgressBaseGUI::getMode ( )

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

    {
        return $this->mode;
    }

References $mode.

Referenced by __buildFooter(), __buildHeader(), ilLearningProgressGUI\__getNextClass(), __setSubTabs(), ilLPListOfProgressGUI\__showProgressList(), ilLPListOfObjectsGUI\details(), ilLearningProgressGUI\executeCommand(), ilLPListOfObjectsGUI\show(), and ilLPListOfProgressGUI\show().

Here is the caller graph for this function:

◆ getObjId()

ilLearningProgressBaseGUI::getObjId ( )

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

    {
        return $this->obj_id;
    }

Referenced by ilLPListOfSettingsGUI\__construct(), ilLPListOfSettingsGUI\assign(), ilLPListOfSettingsGUI\deassign(), ilLPListOfSettingsGUI\groupMaterials(), ilLearningProgressGUI\initCollectionManualForm(), ilLPListOfSettingsGUI\releaseMaterials(), ilLPListOfSettingsGUI\saveObligatoryMaterials(), ilLearningProgressGUI\showtlt(), ilLearningProgressGUI\updateManual(), and ilLPListOfSettingsGUI\updateTLT().

Here is the caller graph for this function:

◆ getRefId()

ilLearningProgressBaseGUI::getRefId ( )

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

    {
        return $this->ref_id;
    }

References $ref_id.

Referenced by ilLearningProgressGUI\__getNextClass(), ilLPListOfObjectsGUI\__initDetails(), ilLPListOfProgressGUI\__initDetails(), __setSubTabs(), ilLearningProgressGUI\editManual(), ilLearningProgressGUI\executeCommand(), ilLPListOfSettingsGUI\getTableByMode(), ilLearningProgressGUI\initCollectionManualForm(), ilLPListOfObjectsGUI\show(), ilLPListOfProgressGUI\show(), ilLPListOfObjectsGUI\showObjectSummary(), ilLearningProgressGUI\showtlt(), ilLPListOfObjectsGUI\showUserObjectMatrix(), and ilLearningProgressGUI\updateManual().

Here is the caller graph for this function:

◆ getUserId()

ilLearningProgressBaseGUI::getUserId ( )

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

    {
        if ($this->usr_id) {
            return $this->usr_id;
        }
        if ((int) $_GET['user_id']) {
            return (int) $_GET['user_id'];
        }
        return 0;
    }

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 707 of file class.ilLearningProgressBaseGUI.php.

    {
        global $lng, $ilCtrl;
        
        include_once 'Services/Object/classes/class.ilObjectLP.php';
        $olp = ilObjectLP::getInstance($a_obj_id);
        $lp_mode = $olp->getCurrentMode();
        
        include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
        
        $form->setFormAction($ilCtrl->getFormAction($this, "updateUser"));
        
        $form->setTitle($lng->txt("edit") . ": " . ilObject::_lookupTitle($a_obj_id));
        $form->setDescription($lng->txt('trac_mode') . ": " . $olp->getModeText($lp_mode));
        
        include_once "Services/User/classes/class.ilUserUtil.php";
        $user = new ilNonEditableValueGUI($lng->txt("user"), null, true);
        $user->setValue(ilUserUtil::getNamePresentation($a_user_id, true));
        $form->addItem($user);
                
        include_once 'Services/Tracking/classes/class.ilLPMarks.php';
        $marks = new ilLPMarks($a_obj_id, $a_user_id);
        
        if (ilObjectLP::supportsMark(ilObject::_lookupType($a_obj_id))) {
            $mark = new ilTextInputGUI($lng->txt("trac_mark"), "mark");
            $mark->setValue($marks->getMark());
            $mark->setMaxLength(32);
            $form->addItem($mark);
        }
        
        $comm = new ilTextInputGUI($lng->txt("trac_comment"), "comment");
        $comm->setValue($marks->getComment());
        $form->addItem($comm);
            
        if ($lp_mode == ilLPObjSettings::LP_MODE_MANUAL ||
            $lp_mode == ilLPObjSettings::LP_MODE_MANUAL_BY_TUTOR) {
            include_once("./Services/Tracking/classes/class.ilLPStatus.php");
            $completed = ilLPStatus::_lookupStatus($a_obj_id, $a_user_id);
            
            $status = new ilCheckboxInputGUI($lng->txt('trac_completed'), "completed");
            $status->setChecked(($completed == ilLPStatus::LP_STATUS_COMPLETED_NUM));
            $form->addItem($status);
        }
            
        $form->addCommandButton("updateUser", $lng->txt('save'));
        
        if ($a_cancel) {
            $form->addCommandButton($a_cancel, $lng->txt('cancel'));
        }
        
        return $form;
    }

References $form, $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 ( )

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

    {
        return $this->anonymized;
    }

References $anonymized.

Referenced by __setSubTabs(), ilLPListOfObjectsGUI\__showUsersList(), ilLPListOfObjectsGUI\showUserObjectMatrix(), and ilLPListOfObjectsGUI\userDetails().

Here is the caller graph for this function:

◆ isObjectOffline()

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

static

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

    {
        global $objDefinition, $ilObjDataCache;
 
        if (!$a_type) {
            $a_type = $ilObjDataCache->lookupType($a_obj_id);
        }
        
        if ($objDefinition->isPluginTypeName($a_type)) {
            return false;
        }
        
        $class = "ilObj" . $objDefinition->getClassName($a_type) . "Access";
        include_once $objDefinition->getLocation($a_type) . "/class." . $class . ".php";
        return call_user_func(array($class,'_isOffline'), $a_obj_id);
 
        // PHP 5.3 only ?
        //return $class::_isOffline($obj_id);
    }