ilLPStatusCollectionMobs Class Reference

Inheritance diagram for ilLPStatusCollectionMobs:

Collaboration diagram for ilLPStatusCollectionMobs:

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

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

Static Protected Member Functions
static	getCollectionItems ($a_obj_id, $a_include_titles=false)
Static Protected Member Functions inherited from ilLPStatus
static	raiseEvent ($a_obj_id, $a_usr_id, $a_status, $a_percentage)
static	_lookupStatusForObject ($a_obj_id, $a_status, $a_user_ids=null)
	Get users with given status for object. More...
static	validateLPForObjects ($a_user_id, $a_obj_ids, $a_parent_ref_id)
	Process given objects for lp-relevance. More...
static	checkLPModesForObjects ($a_obj_ids, array &$a_coll_obj_ids)
	Process lp modes for given objects. More...
static	getLPStatusForObjects ($a_user_id, $a_obj_ids)
	Get LP status for given objects (and user) More...

Additional Inherited Members
Data Fields inherited from ilLPStatus
	$obj_id = null
	$db = null
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

Detailed Description

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

Member Function Documentation

_getCompleted()

static ilLPStatusCollectionMobs::_getCompleted (   $a_obj_id )

static

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

References $users, and ilLPStatusWrapper\_getStatusInfo().

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

Here is the call graph for this function:

_getInProgress()

static ilLPStatusCollectionMobs::_getInProgress (   $a_obj_id )

static

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

References $users, and ilLPStatusWrapper\_getStatusInfo().

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

Here is the call graph for this function:

_getStatusInfo()

static ilLPStatusCollectionMobs::_getStatusInfo (   $a_parent_obj_id )

static

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

References $DIC, $ilDB, $res, $row, $users, and ilChangeEvent\lookupUsersInProgress().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $res = array();
        
        $coll_items = self::getCollectionItems($a_parent_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"][$row["obj_id"]][] = $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][] = $mob_id;
                }
            }
            foreach ($tmp as $user_id => $completed_items) {
                if (sizeof($completed_items) == sizeof($res["items"])) {
                    $res["user_status"]["completed"][] = $user_id;
                } else {
                    $res["user_status"]["in_progress"][] = $user_id;
                }
            }
        }

        include_once './Services/Tracking/classes/class.ilChangeEvent.php';
        $users = ilChangeEvent::lookupUsersInProgress($a_parent_obj_id);
        foreach ($users as $user_id) {
            if ((!is_array($res["user_status"]["in_progress"]) || !in_array($user_id, $res["user_status"]["in_progress"])) &&
                (!is_array($res["user_status"]["completed"]) || !in_array($user_id, $res["user_status"]["completed"]))) {
                $res["user_status"]["in_progress"][] = $user_id;
            }
        }

        return $res;
    }

Here is the call graph for this function:

determineStatus()

ilLPStatusCollectionMobs::determineStatus	(		$a_obj_id,
			$a_user_id,
			$a_obj = null
	)

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

References $DIC, $ilDB, $row, and ilChangeEvent\hasAccessed().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;

        if (ilChangeEvent::hasAccessed($a_obj_id, $a_user_id)) {
            $status = self::LP_STATUS_IN_PROGRESS_NUM;
        }

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

Here is the call graph for this function:

getCollectionItems()

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

staticprotected

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

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

    {
        $res = array();
        
        include_once './Services/Object/classes/class.ilObjectLP.php';
        $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;
    }

Here is the call graph for this function:

---

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

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