ilLPStatusCollectionTLT Class Reference

Inheritance diagram for ilLPStatusCollectionTLT:

Collaboration diagram for ilLPStatusCollectionTLT:

Public Member Functions
	determineStatus (int $a_obj_id, int $a_usr_id, object $a_obj=null)
Public Member Functions inherited from ilLPStatus
	__construct (int $a_obj_id)
	_updateStatus (int $a_obj_id, int $a_usr_id, ?object $a_obj=null, bool $a_percentage=false, bool $a_force_raise=false)
	New status handling (st: status, nr: accesses, p: percentage, t: time spent, m: mark) Learning progress: More...
	determinePercentage (int $a_obj_id, int $a_usr_id, ?object $a_obj=null)
	determineStatus (int $a_obj_id, int $a_usr_id, object $a_obj=null)
	refreshStatus (int $a_obj_id, ?array $a_users=null)
	Refresh status. More...

Static Public Member Functions
static	_getInProgress (int $a_obj_id)
static	_getCompleted (int $a_obj_id)
static	_getStatusInfo (int $a_obj_id)
Static Public Member Functions inherited from ilLPStatus
static	_getCountNotAttempted (int $a_obj_id)
static	_getNotAttempted (int $a_obj_id)
static	_getCountInProgress (int $a_obj_id)
static	_getInProgress (int $a_obj_id)
static	_getCountCompleted (int $a_obj_id)
static	_getCompleted (int $a_obj_id)
static	_getFailed (int $a_obj_id)
static	_getCountFailed (int $a_obj_id)
static	_getStatusInfo (int $a_obj_id)
static	_getTypicalLearningTime (int $a_obj_id)
static	checkStatusForObject (int $a_obj_id, ?array $a_users=null)
	This function checks whether the status for a given number of users is dirty and must be recalculated. More...
static	writeStatus (int $a_obj_id, int $a_user_id, int $a_status, int $a_percentage=0, bool $a_force_per=false, ?int &$a_old_status=self::LP_STATUS_NOT_ATTEMPTED_NUM)
	Write status for user and object. More...
static	setInProgressIfNotAttempted (int $a_obj_id, int $a_user_id)
	This function shoudl be clalled for normal "read events". More...
static	setAllDirty ()
	Sets all status to dirty. More...
static	setDirty (int $a_obj_id)
	Sets status of an object to dirty. More...
static	_lookupStatus (int $a_obj_id, int $a_user_id, bool $a_create=true)
	Lookup status. More...
static	_lookupPercentage (int $a_obj_id, int $a_user_id)
	Lookup percentage. More...
static	_hasUserCompleted (int $a_obj_id, int $a_user_id)
	Lookup user object completion. More...
static	_lookupStatusChanged (int $a_obj_id, int $a_user_id)
	Lookup status changed. More...
static	_lookupCompletedForObject (int $a_obj_id, ?array $a_user_ids=null)
	Get completed users for object. More...
static	_lookupFailedForObject (int $a_obj_id, ?array $a_user_ids=null)
	Get failed users for object. More...
static	_lookupInProgressForObject (int $a_obj_id, ?array $a_user_ids=null)
	Get in progress users for object. More...
static	preloadListGUIData (array $a_obj_ids)
static	getListGUIStatus (int $a_obj_id, bool $a_image_only=true)
static	hasListGUIStatus (int $a_obj_id)

Additional Inherited Members
Data Fields inherited from ilLPStatus
const	LP_STATUS_NOT_ATTEMPTED = 'trac_no_attempted'
const	LP_STATUS_IN_PROGRESS = 'trac_in_progress'
const	LP_STATUS_COMPLETED = 'trac_completed'
const	LP_STATUS_FAILED = 'trac_failed'
const	LP_STATUS_NOT_ATTEMPTED_NUM = 0
const	LP_STATUS_IN_PROGRESS_NUM = 1
const	LP_STATUS_COMPLETED_NUM = 2
const	LP_STATUS_FAILED_NUM = 3
const	LP_STATUS_REGISTERED = 'trac_registered'
const	LP_STATUS_NOT_REGISTERED = 'trac_not_registered'
const	LP_STATUS_PARTICIPATED = 'trac_participated'
const	LP_STATUS_NOT_PARTICIPATED = 'trac_not_participated'
Static Public Attributes inherited from ilLPStatus
static	$list_gui_cache
Static Protected Member Functions inherited from ilLPStatus
static	raiseEvent (int $a_obj_id, int $a_usr_id, int $a_status, int $a_old_status, int $a_percentage)
static	_lookupStatusForObject (int $a_obj_id, int $a_status, ?array $a_user_ids=null)
	Get users with given status for object. More...
static	validateLPForObjects (int $a_user_id, array $a_obj_ids, int $a_parent_ref_id)
	Process given objects for lp-relevance. More...
static	checkLPModesForObjects (array $a_obj_ids, array &$a_coll_obj_ids)
	Process lp modes for given objects. More...
static	getLPStatusForObjects (int $a_user_id, array $a_obj_ids)
	Get LP status for given objects (and user) More...
Protected Attributes inherited from ilLPStatus
int	$obj_id
ilDBInterface	$db
ilObjectDataCache	$ilObjDataCache

Detailed Description

Definition at line 10 of file class.ilLPStatusCollectionTLT.php.

Member Function Documentation

_getCompleted()

static ilLPStatusCollectionTLT::_getCompleted ( int  $a_obj_id )

static

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

References ilLPStatusWrapper\_getStatusInfo().

                                                       : array
    {
        $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);

        $counter = 0;
        $users = array();
        foreach ($status_info['items'] as $item_id) {
            $tmp_users = $status_info['completed'][$item_id];

            if (!$counter++) {
                $users = $tmp_users;
            } else {
                $users = array_intersect($users, $tmp_users);
            }
        }
        $users = array_unique($users);

        return $users;
    }

Here is the call graph for this function:

_getInProgress()

static ilLPStatusCollectionTLT::_getInProgress ( int  $a_obj_id )

static

Definition at line 12 of file class.ilLPStatusCollectionTLT.php.

References ilLPStatusWrapper\_getCompleted(), and ilLPStatusWrapper\_getStatusInfo().

                                                        : array
    {
        $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);

        $users = array();
        if (isset($status_info['in_progress'])) {
            foreach ($status_info['in_progress'] as $in_progress) {
                $users = array_merge($users, $in_progress);
            }
            $users = array_unique($users);
        }

        $users = array_diff(
            $users,
            ilLPStatusWrapper::_getCompleted($a_obj_id)
        );

        return $users;
    }

Here is the call graph for this function:

_getStatusInfo()

static ilLPStatusCollectionTLT::_getStatusInfo ( int  $a_obj_id )

static

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

References $DIC, $ilDB, $ref_id, ilObject\_getAllReferences(), ilMDEducational\_getTypicalLearningTimeSeconds(), and ilObjectLP\getInstance().

                                                        : array
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $status_info = array();
        $olp = ilObjectLP::getInstance($a_obj_id);
        $collection = $olp->getCollectionInstance();
        if ($collection) {
            // @todo check if obj_id can be removed
            $status_info["items"] = $collection->getItems($a_obj_id);

            foreach ($status_info["items"] as $item_id) {
                $status_info["in_progress"][$item_id] = array();
                $status_info["completed"][$item_id] = array();

                $status_info["tlt"][$item_id] = ilMDEducational::_getTypicalLearningTimeSeconds(
                    $a_obj_id,
                    $item_id
                );
            }

            $ref_ids = ilObject::_getAllReferences($a_obj_id);
            $ref_id = end($ref_ids);
            $possible_items = $collection->getPossibleItems($ref_id);
            $chapter_ids = array_intersect(
                array_keys($possible_items),
                $status_info["items"]
            );

            // fix order (adapt from possible items)
            $status_info["items"] = $chapter_ids;

            if ($chapter_ids) {
                foreach ($chapter_ids as $item_id) {
                    $status_info["item_titles"][$item_id] = $possible_items[$item_id]["title"];
                }

                $set = $ilDB->query(
                    "SELECT obj_id,usr_id,spent_seconds" .
                    " FROM lm_read_event" .
                    " WHERE " . $ilDB->in("obj_id", $chapter_ids, "", "integer")
                );
                while ($row = $ilDB->fetchAssoc($set)) {
                    if ($row["spent_seconds"] < $status_info["tlt"][$row["obj_id"]]) {
                        $status_info["in_progress"][$row["obj_id"]][] = $row["usr_id"];
                    } else {
                        $status_info["completed"][$row["obj_id"]][] = $row["usr_id"];
                    }
                }
            }
        }
        return $status_info;
    }

Here is the call graph for this function:

determineStatus()

ilLPStatusCollectionTLT::determineStatus	(	int	$a_obj_id,
		int	$a_usr_id,
		object	$a_obj = null
	)

Definition at line 107 of file class.ilLPStatusCollectionTLT.php.

     : int {
        $info = self::_getStatusInfo($a_obj_id);

        $completed_once = false;

        if (isset($info["completed"])) {
            $completed = true;
            foreach ($info["completed"] as $user_ids) {
                // must have completed all items to complete collection
                if (!in_array($a_usr_id, $user_ids)) {
                    $completed = false;
                    break;
                } else {
                    $completed_once = true;
                }
            }
            if ($completed) {
                return self::LP_STATUS_COMPLETED_NUM;
            }
        }

        // #14997
        if ($completed_once) {
            return self::LP_STATUS_IN_PROGRESS_NUM;
        }

        if (isset($info["in_progress"])) {
            foreach ($info["in_progress"] as $user_ids) {
                if (in_array($a_usr_id, $user_ids)) {
                    return self::LP_STATUS_IN_PROGRESS_NUM;
                }
            }
        }

        return self::LP_STATUS_NOT_ATTEMPTED_NUM;
    }

---

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

• Services/Tracking/classes/status/class.ilLPStatusCollectionTLT.php