ilLPStatusCollectionMobs Class Reference

Inheritance diagram for ilLPStatusCollectionMobs:

Collaboration diagram for ilLPStatusCollectionMobs:

Public Member Functions
	determineStatus (int $a_obj_id, int $a_usr_id, ?object $a_obj=null)
	determinePercentage (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 (string $type, int $obj_id, int $sub_id=0)
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)

Static Protected Member Functions
static	getCollectionItems ( $a_obj_id, $a_include_titles=false)
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...

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
Protected Attributes inherited from ilLPStatus
int	$obj_id
ilDBInterface	$db
ilObjectDataCache	$ilObjDataCache

Detailed Description

Definition at line 24 of file class.ilLPStatusCollectionMobs.php.

Member Function Documentation

_getCompleted()

static ilLPStatusCollectionMobs::_getCompleted ( int  $a_obj_id )

static

Parameters

int

$a_obj_id

Returns

int[]

Reimplemented from ilLPStatus.

Definition at line 37 of file class.ilLPStatusCollectionMobs.php.

                                                       : array
    {
        $users = array();
 
        $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
        if (isset($status_info["user_status"]["completed"])) {
            $users = $status_info["user_status"]["completed"];
        }
 
        return $users;
    }

References ilLPStatusWrapper\_getStatusInfo().

Here is the call graph for this function:

_getInProgress()

static ilLPStatusCollectionMobs::_getInProgress ( int  $a_obj_id )

static

Reimplemented from ilLPStatus.

Definition at line 26 of file class.ilLPStatusCollectionMobs.php.

                                                        : array
    {
        $users = array();
 
        $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
        if (isset($status_info["user_status"]["in_progress"])) {
            $users = $status_info["user_status"]["in_progress"];
        }
        return $users;
    }

References ilLPStatusWrapper\_getStatusInfo().

Here is the call graph for this function:

_getStatusInfo()

static ilLPStatusCollectionMobs::_getStatusInfo ( int  $a_obj_id )

static

Reimplemented from ilLPStatus.

Definition at line 49 of file class.ilLPStatusCollectionMobs.php.

                                                        : array
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $res = array();
 
        $coll_items = self::getCollectionItems($a_obj_id, true);
 
        $res["items"] = array_keys($coll_items);
        if (sizeof($res["items"])) {
            // titles
            foreach ($coll_items as $mob_id => $item) {
                $res["item_titles"][$mob_id] = $item["title"];
            }
 
            // status per item
            foreach ($res["items"] as $mob_id) {
                $res["completed"][$mob_id] = array();
                $res["in_progress"][$mob_id] = array();
            }
 
            $set = $ilDB->query(
                "SELECT obj_id, usr_id FROM read_event" .
                " WHERE " . $ilDB->in("obj_id", $res["items"], "", "integer")
            );
            while ($row = $ilDB->fetchAssoc($set)) {
                $res["completed"][(int) $row["obj_id"]][] = (int) $row["usr_id"];
            }
 
            // status per user
            $tmp = array();
            foreach ($res["items"] as $mob_id) {
                foreach ($res["completed"][$mob_id] as $user_id) {
                    $tmp[$user_id][] = (int) $mob_id;
                }
            }
            foreach ($tmp as $user_id => $completed_items) {
                if (sizeof($completed_items) == sizeof($res["items"])) {
                    $res["user_status"]["completed"][] = (int) $user_id;
                } else {
                    $res["user_status"]["in_progress"][] = (int) $user_id;
                }
            }
        }
 
        $users = ilChangeEvent::lookupUsersInProgress($a_obj_id);
        foreach ($users as $user_id) {
            if ((!isset($res["user_status"]["in_progress"]) || !in_array(
                $user_id,
                $res["user_status"]["in_progress"]
            )) &&
                (!isset($res["user_status"]["completed"]) || !in_array(
                    $user_id,
                    $res["user_status"]["completed"]
                ))) {
                $res["user_status"]["in_progress"][] = (int) $user_id;
            }
        }
 
        return $res;
    }

References $DIC, $ilDB, $res, $user_id, getCollectionItems(), ILIAS\Repository\int(), and ilChangeEvent\lookupUsersInProgress().

Here is the call graph for this function:

determinePercentage()

ilLPStatusCollectionMobs::determinePercentage	(	int	$a_obj_id,
		int	$a_usr_id,
		?object	$a_obj = null
	)

Reimplemented from ilLPStatus.

Definition at line 178 of file class.ilLPStatusCollectionMobs.php.

     : int {
        $per = 0;
 
        // an empty collection is always not attempted
        $items = self::getCollectionItems($a_obj_id);
        if (count($items) > 0) {
            // process mob status for user
 
            $found = array();
            $set = $this->db->query(
                "SELECT obj_id FROM read_event" .
                " WHERE usr_id = " . $this->db->quote($a_usr_id, "integer") .
                " AND " . $this->db->in("obj_id", $items, false, "integer")
            );
            while ($row = $this->db->fetchAssoc($set)) {
                $found[] = (int) $row["obj_id"];
            }
 
            if (count($found) > 0 && count($items) > 0) {
                $per = (int) round(100 / count($items) * count($found));
            }
        }
 
        return $per;
    }

determineStatus()

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

Reimplemented from ilLPStatus.

Definition at line 141 of file class.ilLPStatusCollectionMobs.php.

     : int {
        $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
        if (ilChangeEvent::hasAccessed($a_obj_id, $a_usr_id)) {
            $status = self::LP_STATUS_IN_PROGRESS_NUM;
        }
 
        // an empty collection is always not attempted
        $items = self::getCollectionItems($a_obj_id);
        if (count($items) > 0) {
            // process mob status for user
 
            $found = array();
 
            $set = $this->db->query(
                "SELECT obj_id FROM read_event" .
                " WHERE usr_id = " . $this->db->quote($a_usr_id, "integer") .
                " AND " . $this->db->in("obj_id", $items, false, "integer")
            );
            while ($row = $this->db->fetchAssoc($set)) {
                $found[] = (int) $row["obj_id"];
            }
 
            if (count($found) > 0) {
                $status = self::LP_STATUS_IN_PROGRESS_NUM;
 
                if (count($found) == count($items)) {
                    $status = self::LP_STATUS_COMPLETED_NUM;
                }
            }
        }
        return $status;
    }

References ilLPStatus\LP_STATUS_IN_PROGRESS_NUM.

getCollectionItems()

static ilLPStatusCollectionMobs::getCollectionItems (   $a_obj_id,   $a_include_titles = false  )

staticprotected

Definition at line 113 of file class.ilLPStatusCollectionMobs.php.

      {
        $res = array();
 
        $olp = ilObjectLP::getInstance($a_obj_id);
        $collection = $olp->getCollectionInstance();
        if ($collection) {
            $possible = $collection->getPossibleItems();
 
            // there could be invalid items in the selection
            $valid = array_intersect(
                $collection->getItems(),
                array_keys($possible)
            );
 
            if ($a_include_titles) {
                foreach ($valid as $item_id) {
                    $res[$item_id] = $possible[$item_id];
                }
            } else {
                $res = $valid;
            }
        }
        return $res;
    }

References $res, $valid, and ilObjectLP\getInstance().

Referenced by _getStatusInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/Tracking/classes/status/class.ilLPStatusCollectionMobs.php