Inheritance diagram for ilLPListOfObjectsGUI:

Collaboration diagram for ilLPListOfObjectsGUI:

Public Member Functions
	__construct (int $a_mode, int $a_ref_id)

	executeCommand ()

	updateUser ()

	editUser ()

	details ()

	__showUsersList ($a_print_view=false)

	userDetails ()

	show ()

	__listObjects ()

	__initDetails (int $a_details_id)

	showObjectSummary ()
	Show object-based summarized tracking data. More...

	showUserObjectMatrix ()
	Show object user matrix. More...

Public Member Functions inherited from ilLearningProgressBaseGUI
	__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)

Protected Member Functions
	initUserDetailsIdFromQuery ()

	initUserIdFromRequest ()

	initDetailsIdFromRequest (int $default_id)

Protected Member Functions inherited from ilLearningProgressBaseGUI
	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
int	$details_id = 0

int	$details_obj_id = 0

string	$details_type = ''

int	$details_mode = 0

Protected Attributes inherited from ilLearningProgressBaseGUI
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

Additional Inherited Members
Static Public Member Functions inherited from ilLearningProgressBaseGUI
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 inherited from ilLearningProgressBaseGUI
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

Detailed Description

Definition at line 27 of file class.ilLPListOfObjectsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilLPListOfObjectsGUI::__construct	(	int	$a_mode,
		int	$a_ref_id
	)

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

    {
        parent::__construct($a_mode, $a_ref_id);
        $this->__initDetails(
            $this->initDetailsIdFromRequest($this->getRefId())
        );
    }

References ILIAS\GlobalScreen\Provider\__construct(), __initDetails(), ilLearningProgressBaseGUI\getRefId(), and initDetailsIdFromRequest().

Here is the call graph for this function:

Member Function Documentation

◆ __initDetails()

ilLPListOfObjectsGUI::__initDetails ( int $a_details_id )

Definition at line 370 of file class.ilLPListOfObjectsGUI.php.

                                                    : void
    {
        if (!$a_details_id) {
            $a_details_id = $this->getRefId();
        }
        if ($a_details_id) {
            $this->details_id = $a_details_id;
            $this->details_obj_id = $this->ilObjectDataCache->lookupObjId(
                $this->details_id
            );
            $this->details_type = $this->ilObjectDataCache->lookupType(
                $this->details_obj_id
            );
 
            $olp = ilObjectLP::getInstance($this->details_obj_id);
            $this->details_mode = $olp->getCurrentMode();
        }
    }

References ilObjectLP\getInstance(), ilLearningProgressBaseGUI\getRefId(), ilObjectDataCache\lookupObjId(), and ilObjectDataCache\lookupType().

Referenced by __construct(), editUser(), show(), and updateUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __listObjects()

ilLPListOfObjectsGUI::__listObjects ( )

Definition at line 353 of file class.ilLPListOfObjectsGUI.php.

                                   : void
    {
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.lp_list_objects.html',
            'components/ILIAS/Tracking'
        );
 
        $lp_table = new ilTrSummaryTableGUI($this, "", ROOT_FOLDER_ID);
 
        $this->tpl->setVariable("LP_OBJECTS", $lp_table->getHTML());
        if ($lp_table->isStatusShown()) {
            $this->tpl->setVariable('LEGEND', $this->__getLegendHTML(ilLPStatusIcons::ICON_VARIANT_SHORT));
        }
    }

References ilLearningProgressBaseGUI\__getLegendHTML(), ilLPStatusIcons\ICON_VARIANT_SHORT, and ROOT_FOLDER_ID.

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __showUsersList()

ilLPListOfObjectsGUI::__showUsersList ( $a_print_view = false )

Definition at line 260 of file class.ilLPListOfObjectsGUI.php.

                                                          : void
    {
        if ($this->isAnonymized()) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('permission_denied')
            );
            return;
        }
        $this->ctrl->setParameter($this, "details_id", $this->details_id);
        $gui = new ilTrObjectUsersPropsTableGUI(
            $this,
            "details",
            $this->details_obj_id,
            $this->details_id,
            $a_print_view
        );
 
        $this->tpl->setVariable("LP_OBJECTS", $gui->getHTML());
        $this->tpl->setVariable("LEGEND", $this->__getLegendHTML());
    }

References ilLearningProgressBaseGUI\__getLegendHTML(), ILIAS\Repository\ctrl(), ilLearningProgressBaseGUI\isAnonymized(), and ILIAS\Repository\lng().

Referenced by details().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ details()

ilLPListOfObjectsGUI::details ( )

Definition at line 241 of file class.ilLPListOfObjectsGUI.php.

                             : void
    {
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.lp_loo.html',
            'components/ILIAS/Tracking'
        );
 
        $info = new ilInfoScreenGUI($this);
        $info->setFormAction($this->ctrl->getFormAction($this));
        if ($this->__showObjectDetails($info, $this->details_obj_id, $this->details_type)) {
            $this->tpl->setCurrentBlock("info");
            $this->tpl->setVariable("INFO_TABLE", $info->getHTML());
            $this->tpl->parseCurrentBlock();
        }
        $this->__showUsersList();
    }

References $info, ilLearningProgressBaseGUI\__showObjectDetails(), __showUsersList(), and ILIAS\Repository\ctrl().

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editUser()

ilLPListOfObjectsGUI::editUser ( )

Definition at line 199 of file class.ilLPListOfObjectsGUI.php.

                              : void
    {
        $cancel = '';
        $parent_id = $this->details_id;
        $details_id = $this->initUserDetailsIdFromQuery();
        if ($details_id) {
            $this->__initDetails($details_id);
            $sub_id = $this->details_id;
            $cancel = "userdetails";
        } else {
            $sub_id = null;
            $cancel = "details";
        }
 
        if (!ilLearningProgressAccess::checkPermission(
            'edit_learning_progress',
            $this->details_id
        )) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt("permission_denied"),
                true
            );
            $this->ctrl->returnToParent($this);
        }
 
        $info = new ilInfoScreenGUI($this);
        $info->setFormAction($this->ctrl->getFormAction($this));
        $this->__showObjectDetails($info, $this->details_obj_id, $this->details_type);
 
        $user_id = $this->initUserIdFromQuery();
        $this->tpl->setVariable(
            "ADM_CONTENT",
            $this->__showEditUser(
                $user_id,
                $parent_id,
                strlen($cancel) > 0 ? $cancel : null,
                $sub_id ?? 0
            ) . "<br />" . $info->getHTML()
        );
    }

References $details_id, $info, $user_id, __initDetails(), ilLearningProgressBaseGUI\__showEditUser(), ilLearningProgressBaseGUI\__showObjectDetails(), ilLearningProgressAccess\checkPermission(), ILIAS\Repository\ctrl(), initUserDetailsIdFromQuery(), ilLearningProgressBaseGUI\initUserIdFromQuery(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ executeCommand()

ilLPListOfObjectsGUI::executeCommand ( )

Definition at line 84 of file class.ilLPListOfObjectsGUI.php.

                                    : void
    {
        $this->ctrl->setReturn($this, "");
 
        switch ($this->ctrl->getNextClass()) {
            case 'iltruserobjectspropstablegui':
                $user_id = $this->initUserIdFromQuery();
                $this->ctrl->setParameter($this, "user_id", $user_id);
 
                $this->ctrl->setParameter(
                    $this,
                    "details_id",
                    $this->details_id
                );
 
                $table_gui = new ilTrUserObjectsPropsTableGUI(
                    $this,
                    "userDetails",
                    $user_id,
                    $this->details_obj_id,
                    $this->details_id
                );
                $this->ctrl->forwardCommand($table_gui);
                break;
 
            case 'iltrsummarytablegui':
                $cmd = "showObjectSummary";
                if (!$this->details_id) {
                    $this->details_id = ROOT_FOLDER_ID;
                    $cmd = "show";
                }
                $table_gui = new ilTrSummaryTableGUI(
                    $this,
                    $cmd,
                    $this->details_id
                );
                $this->ctrl->forwardCommand($table_gui);
                break;
 
            case 'iltrmatrixtablegui':
                $table_gui = new ilTrMatrixTableGUI(
                    $this,
                    "showUserObjectMatrix",
                    $this->details_id
                );
                $this->ctrl->forwardCommand($table_gui);
                break;
 
            case 'iltrobjectuserspropstablegui':
                $this->ctrl->setParameter(
                    $this,
                    "details_id",
                    $this->details_id
                );
 
                $table_gui = new ilTrObjectUsersPropsTableGUI(
                    $this,
                    "details",
                    $this->details_obj_id,
                    $this->details_id
                );
                $this->ctrl->forwardCommand($table_gui);
                break;
 
            default:
                $cmd = $this->__getDefaultCommand();
                $this->$cmd();
        }
    }

References $user_id, ilLearningProgressBaseGUI\__getDefaultCommand(), ILIAS\Repository\ctrl(), ilLearningProgressBaseGUI\initUserIdFromQuery(), and ROOT_FOLDER_ID.

Here is the call graph for this function:

◆ initDetailsIdFromRequest()

ilLPListOfObjectsGUI::initDetailsIdFromRequest ( int $default_id )

protected

Definition at line 67 of file class.ilLPListOfObjectsGUI.php.

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

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUserDetailsIdFromQuery()

ilLPListOfObjectsGUI::initUserDetailsIdFromQuery ( )

protected

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

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

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

Referenced by editUser(), and updateUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUserIdFromRequest()

ilLPListOfObjectsGUI::initUserIdFromRequest ( )

protected

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

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

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

Referenced by updateUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ show()

ilLPListOfObjectsGUI::show ( )

Definition at line 339 of file class.ilLPListOfObjectsGUI.php.

                          : void
    {
        $this->ctrl->setParameter($this, 'offset', 0);
 
        // Show only detail of current repository item if called from repository
        switch ($this->getMode()) {
            case self::LP_CONTEXT_REPOSITORY:
                $this->__initDetails($this->getRefId());
                $this->details();
                return;
        }
        $this->__listObjects();
    }

References __initDetails(), __listObjects(), ILIAS\Repository\ctrl(), details(), ilLearningProgressBaseGUI\getMode(), ilLearningProgressBaseGUI\getRefId(), and ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY.

Here is the call graph for this function:

◆ showObjectSummary()

ilLPListOfObjectsGUI::showObjectSummary ( )

Show object-based summarized tracking data.

Definition at line 392 of file class.ilLPListOfObjectsGUI.php.

                                       : void
    {
        $table = new ilTrSummaryTableGUI(
            $this,
            "showObjectSummary",
            $this->getRefId(),
            false
        );
        $content = $table->getHTML();
        if ($table->isStatusShown()) {
            $content .= $this->__getLegendHTML(ilLPStatusIcons::ICON_VARIANT_SHORT);
        }
        $this->tpl->setContent($content);
    }

References ilLearningProgressBaseGUI\__getLegendHTML(), ilLearningProgressBaseGUI\getRefId(), and ilLPStatusIcons\ICON_VARIANT_SHORT.

Here is the call graph for this function:

◆ showUserObjectMatrix()

ilLPListOfObjectsGUI::showUserObjectMatrix ( )

Show object user matrix.

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

                                          : void
    {
        if ($this->isAnonymized()) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('permission_denied')
            );
            return;
        }
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.lp_loo.html',
            'components/ILIAS/Tracking'
        );
        $info = new ilInfoScreenGUI($this);
        $info->setFormAction($this->ctrl->getFormAction($this));
        if ($this->__showObjectDetails($info, $this->details_obj_id, $this->details_type)) {
            $this->tpl->setCurrentBlock("info");
            $this->tpl->setVariable("INFO_TABLE", $info->getHTML());
            $this->tpl->parseCurrentBlock();
        }
 
        $table = new ilTrMatrixTableGUI(
            $this,
            "showUserObjectMatrix",
            $this->getRefId()
        );
        $this->tpl->setVariable('LP_OBJECTS', $table->getHTML());
        $this->tpl->setVariable('LEGEND', $this->__getLegendHTML());
    }

References $info, ilLearningProgressBaseGUI\__getLegendHTML(), ilLearningProgressBaseGUI\__showObjectDetails(), ILIAS\Repository\ctrl(), ilLearningProgressBaseGUI\getRefId(), ilLearningProgressBaseGUI\isAnonymized(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ updateUser()

ilLPListOfObjectsGUI::updateUser ( )

Definition at line 154 of file class.ilLPListOfObjectsGUI.php.

    {
        $details_id = $this->initUserDetailsIdFromQuery();
        if ($details_id) {
            $parent = $this->details_id;
            $this->__initDetails($details_id);
        }
 
        if (!ilLearningProgressAccess::checkPermission(
            'edit_learning_progress',
            $this->details_id
        )) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt("permission_denied"),
                true
            );
            $this->ctrl->returnToParent($this);
        }
 
        $this->__updateUser(
            $this->initUserIdFromRequest(),
            $this->details_obj_id
        );
        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt('trac_update_edit_user'),
            true
        );
 
        $this->ctrl->setParameter(
            $this,
            "details_id",
            $this->details_id
        ); // #15043
 
        // #14993
        if (!$details_id) {
            $this->ctrl->redirect($this, "details");
        } else {
            $this->ctrl->setParameter($this, "userdetails_id", $details_id);
            $this->ctrl->redirect($this, "userdetails");
        }
    }

References $details_id, __initDetails(), ilLearningProgressBaseGUI\__updateUser(), ilLearningProgressAccess\checkPermission(), ILIAS\Repository\ctrl(), initUserDetailsIdFromQuery(), initUserIdFromRequest(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ userDetails()

ilLPListOfObjectsGUI::userDetails ( )

Definition at line 282 of file class.ilLPListOfObjectsGUI.php.

                                 : void
    {
        if ($this->isAnonymized()) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('permission_denied')
            );
            return;
        }
 
        $this->ctrl->setParameter($this, "details_id", $this->details_id);
 
        $print_view = false;
        if ($this->http->wrapper()->query()->has('prt')) {
            $print_view = $this->http->wrapper()->query()->retrieve(
                'prt',
                $this->refinery->kindlyTo()->bool()
            );
        }
        if (!$print_view) {
            // Show back button
            $this->toolbar->addButton(
                $this->lng->txt('trac_view_list'),
                $this->ctrl->getLinkTarget(
                    $this,
                    'details'
                )
            );
        }
 
        $user_id = $this->initUserIdFromQuery();
        $this->ctrl->setParameter($this, "user_id", $user_id);
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.lp_loo.html',
            'components/ILIAS/Tracking'
        );
 
        $info = new ilInfoScreenGUI($this);
        $info->setFormAction($this->ctrl->getFormAction($this));
        $this->__showObjectDetails($info, $this->details_obj_id, $this->details_type);
        // $this->__appendLPDetails($info,$this->details_obj_id,$user_id);
        $this->tpl->setVariable("INFO_TABLE", $info->getHTML());
 
        $table = new ilTrUserObjectsPropsTableGUI(
            $this,
            "userDetails",
            $user_id,
            $this->details_obj_id,
            $this->details_id,
            $print_view
        );
        $this->tpl->setVariable('LP_OBJECTS', $table->getHTML());
        $this->tpl->setVariable('LEGEND', $this->__getLegendHTML());
    }

References $info, $user_id, ilLearningProgressBaseGUI\__getLegendHTML(), ilLearningProgressBaseGUI\__showObjectDetails(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ilLearningProgressBaseGUI\initUserIdFromQuery(), ilLearningProgressBaseGUI\isAnonymized(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Field Documentation

◆ $details_id

int ilLPListOfObjectsGUI::$details_id = 0

protected

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

Referenced by editUser(), and updateUser().

◆ $details_mode

int ilLPListOfObjectsGUI::$details_mode = 0

protected

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

◆ $details_obj_id

int ilLPListOfObjectsGUI::$details_obj_id = 0

protected

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

◆ $details_type

string ilLPListOfObjectsGUI::$details_type = ''

protected

Definition at line 31 of file class.ilLPListOfObjectsGUI.php.

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

components/ILIAS/Tracking/classes/repository_statistics/class.ilLPListOfObjectsGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __initDetails()

◆ __listObjects()

◆ __showUsersList()

◆ details()

◆ editUser()

◆ executeCommand()

◆ initDetailsIdFromRequest()

◆ initUserDetailsIdFromQuery()

◆ initUserIdFromRequest()

◆ show()

◆ showObjectSummary()

◆ showUserObjectMatrix()

◆ updateUser()

◆ userDetails()

Field Documentation

◆ $details_id

◆ $details_mode

◆ $details_obj_id

◆ $details_type