Inheritance diagram for ilLearningProgressBaseGUI:

Collaboration diagram for ilLearningProgressBaseGUI:

Public Member Functions
	__construct (int $a_mode, int $a_ref_id=0, int $a_usr_id=0)

	isAnonymized ()

	getMode ()

	getRefId ()

	getObjId ()

	getUserId ()

	__getDefaultCommand ()

	__setSubTabs (int $a_active)

	__buildFooter ()

	__buildHeader ()

	__showObjectDetails (ilInfoScreenGUI $info, int $item_id=0, string $item_type='', bool $add_section=true)
	show details about current object. More...

	__appendLPDetails (ilInfoScreenGUI $info, int $item_id, int $user_id)

	__getLegendHTML (int $variant=ilLPStatusIcons::ICON_VARIANT_LONG)

	__showEditUser (int $a_user_id, int $a_ref_id, ?string $a_cancel=null, int $a_sub_id=0)

	__updateUser (int $user_id, int $obj_id)

Static Public Member Functions
static	_getStatusText (int $a_status, ?ilLanguage $a_lng=null)
	Get status alt text. More...

static	__readStatus (int $a_obj_id, int $user_id)
	@noinspection PhpInconsistentReturnPointsInspection More...

static	isObjectOffline (int $a_obj_id, string $a_type='')

Data Fields
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

Protected Member Functions
	initUserIdFromQuery ()

	readTypicalLearningTimeInSeconds (int $obj_id, int $sub_id, string $type)

	initEditUserForm (int $a_user_id, int $a_obj_id, ?string $a_cancel=null)

Protected Attributes
RefineryFactory	$refinery

HttpServices	$http

ilGlobalTemplateInterface	$tpl

ilHelpGUI	$help

ilCtrlInterface	$ctrl

ilLanguage	$lng

ilLogger	$logger

ilTabsGUI	$tabs_gui

ilToolbarGUI	$toolbar

ilObjectDataCache	$ilObjectDataCache

ilObjUser	$user

ilAccessHandler	$access

ilRbacSystem	$rbacsystem

ilRbacReview	$rbacreview

ilTree	$tree

UIFactory	$ui_factory

UIRenderer	$ui_renderer

LOMServices	$lom_services

bool	$anonymized

int	$usr_id = 0

int	$ref_id = 0

int	$obj_id = 0

string	$obj_type = ''

int	$mode = 0

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

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented in ilLPListOfProgressGUI.

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

      {
        global $DIC;
 
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->help = $DIC->help();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('trac');
        $this->tabs_gui = $DIC->tabs();
        $this->toolbar = $DIC->toolbar();
        $this->ilObjectDataCache = $DIC['ilObjDataCache'];
        $this->user = $DIC->user();
        $this->access = $DIC->access();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->rbacreview = $DIC->rbac()->review();
        $this->tree = $DIC->repositoryTree();
        $this->lom_services = $DIC->learningObjectMetadata();
 
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
 
        $this->mode = $a_mode;
        $this->ref_id = $a_ref_id;
        $this->obj_id = $this->ilObjectDataCache->lookupObjId($this->ref_id);
        $this->obj_type = $this->ilObjectDataCache->lookupType($this->obj_id);
        $this->usr_id = $a_usr_id;
 
        $this->anonymized = !ilObjUserTracking::_enabledUserRelatedData();
        if (!$this->anonymized && $this->obj_id) {
            $olp = ilObjectLP::getInstance($this->obj_id);
            $this->anonymized = $olp->isAnonymized();
        }
        $this->logger = $DIC->logger()->trac();
    }

References $DIC, ilObjUserTracking\_enabledUserRelatedData(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilObjectLP\getInstance(), ILIAS\Repository\help(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ilObjectDataCache\lookupObjId(), ilObjectDataCache\lookupType(), ILIAS\Repository\refinery(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ __appendLPDetails()

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

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

     : void {
        $type = $this->ilObjectDataCache->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())
        );
 
        if (ilObjectLP::isSupportedObjectType($type)) {
            $icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_LONG);
 
            $status_text = ilLearningProgressBaseGUI::_getStatusText(
                ilLPStatus::_lookupStatus($item_id, $user_id)
            );
            $info->addProperty(
                $this->lng->txt('trac_status'),
                $icons->renderIconForStatus(ilLPStatus::_lookupStatus($item_id, $user_id)) .
                    " " .
                    $status_text
            );
 
            if ($olp->getCurrentMode() === ilLPObjSettings::LP_MODE_MANUAL) {
                // status
                $i_tpl = new ilTemplate(
                    "tpl.lp_edit_manual_info_page.html",
                    true,
                    true,
                    "components/ILIAS/Tracking"
                );
                $i_tpl->setVariable(
                    "INFO_EDITED",
                    $this->lng->txt("trac_info_edited")
                );
                $i_tpl->setVariable(
                    "SELECT_STATUS",
                    ilLegacyFormElementsUtil::formSelect(
                        (int) ilLPMarks::_hasCompleted(
                            $user_id,
                            $item_id
                        ),
                        'lp_edit',
                        [0 => $this->lng->txt('trac_not_completed'),
                         1 => $this->lng->txt('trac_completed')
                        ],
                        false,
                        true
                    )
                );
                $i_tpl->setVariable("TXT_SAVE", $this->lng->txt("save"));
                $info->addProperty($this->lng->txt('trac_status'), $i_tpl->get());
            }
 
            // #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_LTI_OUTCOME,
                             ilLPObjSettings::LP_MODE_CMIX_COMPLETED,
                             ilLPObjSettings::LP_MODE_CMIX_COMPL_WITH_FAILED,
                             ilLPObjSettings::LP_MODE_CMIX_PASSED,
                             ilLPObjSettings::LP_MODE_CMIX_PASSED_WITH_FAILED,
                             ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED,
                             ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED,
                             ilLPObjSettings::LP_MODE_SCORM,
                             ilLPObjSettings::LP_MODE_TEST_PASSED
            )
            )) {
                $perc = ilLPStatus::_lookupPercentage($item_id, $user_id);
                $info->addProperty(
                    $this->lng->txt('trac_percentage'),
                    (int) $perc . "%"
                );
            }
        }
 
        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);
        }
 
        // More infos for lm's
        if (in_array($type, ["lm", "htlm"])) {
            $progress = ilLearningProgress::_getProgress($user_id, $item_id);
            if ($progress['access_time'] ?? false) {
                $info->addProperty(
                    $this->lng->txt('trac_last_access'),
                    ilDatePresentation::formatDate(
                        new ilDateTime($progress['access_time'], IL_CAL_UNIX)
                    )
                );
            } else {
                $info->addProperty(
                    $this->lng->txt('trac_last_access'),
                    $this->lng->txt('trac_not_accessed')
                );
            }
 
            $info->addProperty(
                $this->lng->txt('trac_visits'),
                (string) ($progress['visits'] ?? "")
            );
 
            if ($type == 'lm') {
                $info->addProperty(
                    $this->lng->txt('trac_spent_time'),
                    ilDatePresentation::secondsToString(
                        $progress['spent_seconds']
                    )
                );
            }
        }
    }

Referenced by ilLPListOfProgressGUI\details().

Here is the caller graph for this function:

◆ __buildFooter()

ilLearningProgressBaseGUI::__buildFooter ( )

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

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

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

                                   : void
    {
    }

Referenced by ilLearningProgressGUI\executeCommand().

Here is the caller graph for this function:

◆ __getDefaultCommand()

ilLearningProgressBaseGUI::__getDefaultCommand ( )

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

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __getLegendHTML()

ilLearningProgressBaseGUI::__getLegendHTML ( int $variant = ilLPStatusIcons::ICON_VARIANT_LONG )

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

                                                                                    : string
    {
        $icons = ilLPStatusIcons::getInstance($variant);
 
        $tpl = new ilTemplate(
            "tpl.lp_legend.html",
            true,
            true,
            "components/ILIAS/Tracking"
        );
        $tpl->setVariable(
            "IMG_NOT_ATTEMPTED",
            $icons->renderIconForStatus(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM)
        );
        $tpl->setVariable(
            "IMG_IN_PROGRESS",
            $icons->renderIconForStatus(ilLPStatus::LP_STATUS_IN_PROGRESS_NUM)
        );
        $tpl->setVariable(
            "IMG_COMPLETED",
            $icons->renderIconForStatus(ilLPStatus::LP_STATUS_COMPLETED_NUM)
        );
        $tpl->setVariable(
            "IMG_FAILED",
            $icons->renderIconForStatus(ilLPStatus::LP_STATUS_FAILED_NUM)
        );
        $tpl->setVariable(
            "TXT_NOT_ATTEMPTED",
            $this->lng->txt("trac_not_attempted")
        );
        $tpl->setVariable(
            "TXT_IN_PROGRESS",
            $this->lng->txt("trac_in_progress")
        );
        $tpl->setVariable(
            "TXT_COMPLETED",
            $this->lng->txt("trac_completed")
        );
        $tpl->setVariable(
            "TXT_FAILED",
            $this->lng->txt("trac_failed")
        );
 
        $panel = $this->ui_factory->panel()->secondary()->legacy(
            '',
            $this->ui_factory->legacy()->content($tpl->get())
        );
 
        return $this->ui_renderer->render($panel);
    }

References ILIAS\UICore\GlobalTemplate\get(), ilLPStatusIcons\getInstance(), ILIAS\Repository\lng(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, and ILIAS\UICore\GlobalTemplate\setVariable().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __readStatus()

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

static

@noinspection PhpInconsistentReturnPointsInspection

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

                                                                    : string
    {
        $status = ilLPStatus::_lookupStatus($a_obj_id, $user_id);
 
        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;
 
            default:
            case ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM:
                return ilLPStatus::LP_STATUS_NOT_ATTEMPTED;
        }
    }

References $user_id, 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 ilObjSCORMLearningModule\exportSelected().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __setSubTabs()

ilLearningProgressBaseGUI::__setSubTabs ( int $a_active )

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

                                               : void
    {
        switch ($this->getMode()) {
            case self::LP_CONTEXT_PERSONAL_DESKTOP:
 
                if (ilObjUserTracking::_hasLearningProgressLearner() &&
                    ilObjUserTracking::_enabledUserRelatedData()) {
                    $this->tabs_gui->addTarget(
                        'trac_progress',
                        $this->ctrl->getLinkTargetByClass(
                            'illplistofprogressgui',
                            ''
                        ),
                        "",
                        "",
                        "",
                        $a_active == self::LP_ACTIVE_PROGRESS
                    );
                }
                break;
 
            case self::LP_CONTEXT_REPOSITORY:
                // #12771 - do not show status if learning progress is deactivated
                $olp = ilObjectLP::getInstance($this->obj_id);
                if ($olp->isActive()) {
                    $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 = ($this->ilObjectDataCache->lookupType(
                            $this->ilObjectDataCache->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
                        );
                    }
                }
                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_USER_FOLDER:
            case self::LP_CONTEXT_ORG_UNIT:
                // No tabs default class is lpprogressgui
                break;
 
            default:
                die('No valid mode given');
                break;
        }
    }

References ilObjUserTracking\_enabledUserRelatedData(), ilObjUserTracking\_hasLearningProgressLearner(), ilLearningProgressAccess\checkPermission(), ILIAS\Repository\ctrl(), ilObjectLP\getInstance(), getMode(), getRefId(), getUserId(), isAnonymized(), ilObjectDataCache\lookupObjId(), ilObjectDataCache\lookupType(), LP_ACTIVE_MATRIX, LP_ACTIVE_OBJECTS, LP_ACTIVE_SETTINGS, LP_ACTIVE_SUMMARY, 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	(	int	$a_user_id,
		int	$a_ref_id,
		?string	$a_cancel = `null`,
		int	$a_sub_id = `0`
	)

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

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

References ilObject\_lookupObjId().

Referenced by ilLPListOfObjectsGUI\editUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __showObjectDetails()

ilLearningProgressBaseGUI::__showObjectDetails	(	ilInfoScreenGUI	$info,
		int	$item_id = `0`,
		string	$item_type = `''`,
		bool	$add_section = `true`
	)

show details about current object.

Uses an existing info_gui object.

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

     : bool {
        $details_id = $item_id ?: $this->details_id;
        $details_type = $item_type ?: $this->details_type;
 
        $olp = ilObjectLP::getInstance($details_id);
        $mode = $olp->getCurrentMode();
        if (
            $mode == ilLPObjSettings::LP_MODE_VISITS ||
            $this->readTypicalLearningTimeInSeconds($details_id, 0, $details_type)
        ) {
            // 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'),
                    (string) ilLPObjSettings::_lookupVisits($details_id)
                );
            }
 
            if ($seconds = $this->readTypicalLearningTimeInSeconds($details_id, 0, $details_type)) {
                $info->addProperty(
                    $this->lng->txt('meta_typical_learning_time'),
                    ilDatePresentation::secondsToString($seconds)
                );
            }
            return true;
        }
        return false;
    }

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

Here is the caller graph for this function:

◆ __updateUser()

ilLearningProgressBaseGUI::__updateUser	(	int	$user_id,
		int	$obj_id
	)

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

                                                           : void
    {
        $form = $this->initEditUserForm($user_id, $obj_id);
        if ($form->checkInput()) {
            $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) {
                ilLPStatusWrapper::_updateStatus($obj_id, $user_id);
            }
        }
    }

References $user_id, and ilLPStatusWrapper\_updateStatus().

Referenced by ilLPListOfObjectsGUI\updateUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getStatusText()

static ilLearningProgressBaseGUI::_getStatusText	(	int	$a_status,
		?ilLanguage	$a_lng = `null`
	)

static

Get status alt text.

Todo:: Move this to a factory.

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

     : string {
        global $DIC;
 
        $lng = $DIC->language();
        if (!$a_lng) {
            $a_lng = $lng;
        }
        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((string) $a_status);
        }
    }

References $lng.

Referenced by ilTrSummaryTableGUI\fillHeaderCSV(), ilTrSummaryTableGUI\fillHeaderExcel(), ilSCORM2004TrackingItemsTableGUI\fillRowCSV(), ilSCORMTrackingItemsTableGUI\fillRowCSV(), ilLPProgressTableGUI\fillRowCSV(), ilTrMatrixTableGUI\fillRowCSV(), ilTrObjectUsersPropsTableGUI\fillRowCSV(), ilTrUserObjectsPropsTableGUI\fillRowCSV(), ilSCORM2004TrackingItemsTableGUI\fillRowExcel(), ilSCORMTrackingItemsTableGUI\fillRowExcel(), ilTrMatrixTableGUI\fillRowExcel(), ilTrObjectUsersPropsTableGUI\fillRowExcel(), ilTrUserObjectsPropsTableGUI\fillRowExcel(), ilLPObjectStatisticsLPTableGUI\getDetailItems(), ilLPObjectStatisticsLPTableGUI\getGraph(), ilLPProgressBlockGUI\getLegacyContent(), ilMyStaffGUI\getUserLpStatusAsHtml(), ilMyStaffGUI\getUserLpStatusAsText(), ilLPObjectStatisticsLPTableGUI\initFilter(), ilSCORM2004TrackingItemsTableGUI\parseValue(), ilSCORMTrackingItemsTableGUI\parseValue(), and ilLPStatusIcons\renderIconForStatus().

Here is the caller graph for this function:

◆ getMode()

ilLearningProgressBaseGUI::getMode ( )

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

                             : int
    {
        return $this->mode;
    }

References $mode.

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

Here is the caller graph for this function:

◆ getObjId()

ilLearningProgressBaseGUI::getObjId ( )

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

                              : int
    {
        return $this->obj_id;
    }

References $obj_id.

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

Here is the caller graph for this function:

◆ getRefId()

ilLearningProgressBaseGUI::getRefId ( )

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

                              : int
    {
        return $this->ref_id;
    }

References $ref_id.

Referenced by ilLPListOfObjectsGUI\__construct(), ilLearningProgressGUI\__getNextClass(), ilLPListOfObjectsGUI\__initDetails(), ilLPListOfProgressGUI\__initDetails(), __setSubTabs(), ilLPListOfProgressGUI\details(), 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 153 of file class.ilLearningProgressBaseGUI.php.

                               : int
    {
        if ($this->usr_id) {
            return $this->usr_id;
        }
        if ($this->initUserIdFromQuery()) {
            return $this->initUserIdFromQuery();
        }
        return 0;
    }

References $usr_id, and initUserIdFromQuery().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initEditUserForm()

ilLearningProgressBaseGUI::initEditUserForm	(	int	$a_user_id,
		int	$a_obj_id,
		?string	$a_cancel = `null`
	)

protected

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

     : ilPropertyFormGUI {
        $olp = ilObjectLP::getInstance($a_obj_id);
        $lp_mode = $olp->getCurrentMode();
 
        $form = new ilPropertyFormGUI();
 
        $form->setFormAction($this->ctrl->getFormAction($this, "updateUser"));
 
        $form->setTitle(
            $this->lng->txt("edit") . ": " . ilObject::_lookupTitle($a_obj_id)
        );
        $form->setDescription(
            $this->lng->txt('trac_mode') . ": " . $olp->getModeText($lp_mode)
        );
 
        $user = new ilNonEditableValueGUI($this->lng->txt("user"), '', true);
        $user->setValue(ilUserUtil::getNamePresentation($a_user_id, true));
        $form->addItem($user);
 
        $marks = new ilLPMarks($a_obj_id, $a_user_id);
 
        if (ilObjectLP::supportsMark(ilObject::_lookupType($a_obj_id))) {
            $mark = new ilTextInputGUI($this->lng->txt("trac_mark"), "mark");
            $mark->setValue($marks->getMark());
            $mark->setMaxLength(32);
            $form->addItem($mark);
        }
 
        $comm = new ilTextInputGUI($this->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) {
            $completed = ilLPStatus::_lookupStatus($a_obj_id, $a_user_id);
 
            $status = new ilCheckboxInputGUI(
                $this->lng->txt('trac_completed'),
                "completed"
            );
            $status->setChecked(
                ($completed == ilLPStatus::LP_STATUS_COMPLETED_NUM)
            );
            $form->addItem($status);
        }
 
        $form->addCommandButton("updateUser", $this->lng->txt('save'));
 
        if ($a_cancel) {
            $form->addCommandButton($a_cancel, $this->lng->txt('cancel'));
        }
 
        return $form;
    }

◆ initUserIdFromQuery()

ilLearningProgressBaseGUI::initUserIdFromQuery ( )

protected

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

                                            : int
    {
        if ($this->http->wrapper()->query()->has('user_id')) {
            return $this->http->wrapper()->query()->retrieve(
                'user_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        return 0;
    }

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

Referenced by ilLPListOfObjectsGUI\editUser(), ilLPListOfObjectsGUI\executeCommand(), getUserId(), ilLPListOfObjectsGUI\initUserIdFromRequest(), and ilLPListOfObjectsGUI\userDetails().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAnonymized()

ilLearningProgressBaseGUI::isAnonymized ( )

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

                                  : bool
    {
        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	(	int	$a_obj_id,
		string	$a_type = `''`
	)

static

Parameters

int	$a_obj_id
string	$a_type

Returns: bool

Todo:: switch to centralized offline status

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

     : bool {
        global $DIC;
 
        $objDefinition = $DIC['objDefinition'];
        $ilObjDataCache = $DIC['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";
        return (bool) $class::_isOffline($a_obj_id);
    }

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

Here is the caller graph for this function:

◆ readTypicalLearningTimeInSeconds()

ilLearningProgressBaseGUI::readTypicalLearningTimeInSeconds	(	int	$obj_id,
		int	$sub_id,
		string	$type
	)

protected

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

                                                                                               : int
    {
        $paths = $this->lom_services->paths();
        $data_helper = $this->lom_services->dataHelper();
 
        $value = $this->lom_services->read($obj_id, $sub_id, $type, $paths->firstTypicalLearningTime())
                                    ->firstData($paths->firstTypicalLearningTime())
                                    ->value();
 
        return $data_helper->durationToSeconds($value);
    }