ilLPListOfProgressGUI Class Reference

Inheritance diagram for ilLPListOfProgressGUI:

Collaboration diagram for ilLPListOfProgressGUI:

Public Member Functions
	__construct (int $a_mode, int $a_ref_id, int $a_user_id=0)
	executeCommand ()
	execute command More...
	show ()
	details ()
	__showProgressList ()
	__initUser (int $a_usr_id=0)
	__initDetails (int $a_details_id)
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
	initDetailsIdFromQuery ()
	saveProgress ()
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
ilObjUser	$tracked_user = null
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)
	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.ilLPListOfProgressGUI.php.

Constructor & Destructor Documentation

__construct()

ilLPListOfProgressGUI::__construct	(	int	$a_mode,
		int	$a_ref_id,
		int	$a_user_id = 0
	)

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

References ILIAS\GlobalScreen\Provider\__construct(), __initDetails(), __initUser(), ILIAS\Repository\ctrl(), and initDetailsIdFromQuery().

    {
        parent::__construct($a_mode, $a_ref_id, $a_user_id);
        $this->__initUser($a_user_id);

        // Set item id for details
        $this->__initDetails($this->initDetailsIdFromQuery());
        $this->ctrl->saveParameter($this, 'details_id');
    }

Here is the call graph for this function:

Member Function Documentation

__initDetails()

ilLPListOfProgressGUI::__initDetails

(

int

$a_details_id

)

Definition at line 283 of file class.ilLPListOfProgressGUI.php.

References ilObject\_getAllReferences(), ilObjectLP\getInstance(), and ilLearningProgressBaseGUI\getRefId().

Referenced by __construct(), and show().

                                                    : void
    {
        if (!$a_details_id) {
            $a_details_id = $this->getRefId();
        }
        if ($a_details_id) {
            $ref_ids = ilObject::_getAllReferences($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();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__initUser()

ilLPListOfProgressGUI::__initUser

(

int

$a_usr_id = 0

)

Todo:

check the access checks.

Definition at line 237 of file class.ilLPListOfProgressGUI.php.

References ilLearningProgressBaseGUI\$user, ilObjOrgUnitAccess\_checkAccessToUserLearningProgress(), ILIAS\Repository\ctrl(), ilObjectFactory\getInstanceByObjId(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and SYSTEM_ROLE_ID.

Referenced by __construct(), and show().

                                                 : bool
    {
        if ($this->http->wrapper()->post()->has('user_id')) {
            $a_usr_id = $this->http->wrapper()->post()->retrieve(
                'user_id',
                $this->refinery->kindlyTo()->int()
            );
            $this->ctrl->setParameter($this, 'user_id', $a_usr_id);
        }
        if ($a_usr_id) {
            $user = ilObjectFactory::getInstanceByObjId($a_usr_id);
            if (!$user instanceof ilObjUser) {
                throw new ilObjectNotFoundException(
                    'Invalid user id given: ' . $a_usr_id
                );
            }
            $this->tracked_user = $user;
        } else {
            $this->tracked_user = $this->user;
        }

        // #8762: see ilObjUserGUI->getTabs()
        if ($this->mode == self::LP_CONTEXT_USER_FOLDER &&
            $this->rbacsystem->checkAccess('read', $this->ref_id)) {
            return false;
        }

        if ($this->mode == self::LP_CONTEXT_ORG_UNIT &&
            ilObjOrgUnitAccess::_checkAccessToUserLearningProgress(
                $this->ref_id,
                $a_usr_id
            )) {
            return false;
        }

        // Check access
        if (!$this->rbacreview->isAssigned(
            $this->user->getId(),
            SYSTEM_ROLE_ID
        )) {
            $this->tracked_user = $this->user;
            return false;
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__showProgressList()

ilLPListOfProgressGUI::__showProgressList

(

)

Definition at line 205 of file class.ilLPListOfProgressGUI.php.

References ilLearningProgressBaseGUI\__getLegendHTML(), ILIAS\Repository\ctrl(), ilLearningProgressBaseGUI\getMode(), and null.

Referenced by show().

                                        : void
    {
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.lp_list_progress.html',
            'components/ILIAS/Tracking'
        );

        // User info
        $info = new ilInfoScreenGUI($this);
        $info->setFormAction($this->ctrl->getFormAction($this));
        $lp_table = new ilLPProgressTableGUI(
            $this,
            "",
            $this->tracked_user,
            null,
            false,
            null,
            false,
            null,
            null,
            $this->getMode()
        );
        $this->tpl->setVariable("LP_OBJECTS", $lp_table->getHTML());

        $this->tpl->setVariable("LEGEND", $this->__getLegendHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

details()

ilLPListOfProgressGUI::details

(

)

Definition at line 112 of file class.ilLPListOfProgressGUI.php.

References ilLearningProgressBaseGUI\$obj_id, ilLearningProgressBaseGUI\__appendLPDetails(), ilLearningProgressBaseGUI\__getLegendHTML(), ilLearningProgressBaseGUI\__showObjectDetails(), ilObject\_lookupObjectId(), ILIAS\Repository\access(), ilLearningProgressAccess\checkPermission(), ILIAS\Repository\ctrl(), ilObjectLP\getInstance(), ilLearningProgressBaseGUI\getMode(), ilLearningProgressBaseGUI\getRefId(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\toolbar().

Referenced by show().

                             : void
    {
        // Show back button to crs if called from crs. Otherwise if called from personal desktop or administration
        // show back to list
        $crs_id = 0;
        if ($this->http->wrapper()->query()->has('crs_id')) {
            $crs_id = $this->http->wrapper()->query()->retrieve(
                'crs_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        if ($crs_id) {
            $this->ctrl->setParameter($this, 'details_id', $crs_id);
            $this->toolbar->addButton(
                $this->lng->txt('trac_view_crs'),
                $this->ctrl->getLinkTarget($this, 'details')
            );
        } elseif ($this->getMode() == self::LP_CONTEXT_PERSONAL_DESKTOP or
            $this->getMode() == self::LP_CONTEXT_USER_FOLDER) {
            $this->toolbar->addButton(
                $this->lng->txt('trac_view_list'),
                $this->ctrl->getLinkTarget($this, 'show')
            );
        }

        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.lp_progress_container.html',
            'components/ILIAS/Tracking'
        );

        $info = new ilInfoScreenGUI($this);
        $info->setContextRefId($this->details_id);
        $info->setContextObjId($this->details_obj_id);
        $info->setContentObjType((string) $this->obj_type);
        $info->enableLearningProgress(true);
        $info->setFormAction($this->ctrl->getFormAction($this));
        $this->__appendLPDetails(
            $info,
            $this->details_obj_id,
            $this->tracked_user->getId()
        );
        $this->__showObjectDetails($info, $this->details_obj_id, $this->details_type, false);

        // Finally set template variable
        $this->tpl->setVariable("LM_INFO", $info->getHTML());

        $olp = ilObjectLP::getInstance($this->details_obj_id);
        $collection = $olp->getCollectionInstance();
        $obj_ids = array();
        if ($collection) {
            foreach ($collection->getItems() as $item_id) {
                if ($collection instanceof ilLPCollectionOfRepositoryObjects) {
                    $obj_id = ilObject::_lookupObjectId($item_id);
                    if ($this->access->checkAccessOfUser(
                        $this->tracked_user->getId(),
                        'visible',
                        '',
                        $item_id
                    )) {
                        $obj_ids[$obj_id] = array($item_id);
                    }
                } else {
                    $obj_ids[] = $item_id;
                }
            }
        }

        // #15247
        if (count($obj_ids) > 0) {
            // seems obsolete
            $personal_only = !ilLearningProgressAccess::checkPermission(
                'read_learning_progress',
                $this->getRefId()
            );
            $lp_table = new ilLPProgressTableGUI(
                $this,
                "details",
                $this->tracked_user,
                $obj_ids,
                true,
                $this->details_mode,
                $personal_only,
                $this->details_obj_id,
                $this->details_id
            );
            $this->tpl->setVariable("LP_OBJECTS", $lp_table->getHTML());
        }

        $this->tpl->setVariable("LEGEND", $this->__getLegendHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilLPListOfProgressGUI::executeCommand

(

)

execute command

Definition at line 59 of file class.ilLPListOfProgressGUI.php.

References ilLearningProgressBaseGUI\__getDefaultCommand(), ILIAS\Repository\ctrl(), and ilLearningProgressBaseGUI\getUserId().

                                    : void
    {
        $this->ctrl->setReturn($this, "show");
        $this->ctrl->setParameter($this, 'user_id', $this->getUserId());
        switch ($this->ctrl->getNextClass()) {
            case 'illpprogresstablegui':
                $table_gui = new ilLPProgressTableGUI(
                    $this,
                    "",
                    $this->tracked_user
                );
                $this->ctrl->setReturn($this, 'show');
                $this->ctrl->forwardCommand($table_gui);
                break;

            default:
                $cmd = $this->__getDefaultCommand();
                $this->$cmd();
        }
    }

Here is the call graph for this function:

initDetailsIdFromQuery()

ilLPListOfProgressGUI::initDetailsIdFromQuery ( )

protected

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

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

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

saveProgress()

ilLPListOfProgressGUI::saveProgress ( )

protected

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

References ILIAS\Repository\ctrl().

                                     : void
    {
        $info = new ilInfoScreenGUI($this);
        $info->setContextRefId($this->ref_id);
        $info->setContextObjId($this->details_obj_id);
        $info->setContentObjType((string) $this->obj_type);
        $info->saveProgress(false);
        $this->ctrl->redirect($this);
    }

Here is the call graph for this function:

show()

ilLPListOfProgressGUI::show

(

)

Definition at line 80 of file class.ilLPListOfProgressGUI.php.

References __initDetails(), __initUser(), __showProgressList(), details(), ilLearningProgressBaseGUI\getMode(), ilLearningProgressBaseGUI\getRefId(), and ilLearningProgressBaseGUI\getUserId().

                          : void
    {
        switch ($this->getMode()) {
            // Show only detail of current repository item if called from repository
            case self::LP_CONTEXT_REPOSITORY:
                $this->__initDetails($this->getRefId());
                $this->details();
                return;

            case self::LP_CONTEXT_USER_FOLDER:
            case self::LP_CONTEXT_ORG_UNIT:
                // if called from user folder obj_id is id of current user
                $this->__initUser($this->getUserId());
                break;
        }
        // not called from repository
        $this->__showProgressList();
    }

Here is the call graph for this function:

Field Documentation

$details_id

int ilLPListOfProgressGUI::$details_id = 0

protected

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

$details_mode

int ilLPListOfProgressGUI::$details_mode = 0

protected

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

$details_obj_id

int ilLPListOfProgressGUI::$details_obj_id = 0

protected

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

$details_type

string ilLPListOfProgressGUI::$details_type = ''

protected

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

$tracked_user

ilObjUser ilLPListOfProgressGUI::$tracked_user = null

protected

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

---

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

• components/ILIAS/Tracking/classes/repository_statistics/class.ilLPListOfProgressGUI.php