ilLPStatusCollectionManual Class Reference

Inheritance diagram for ilLPStatusCollectionManual:

Collaboration diagram for ilLPStatusCollectionManual:

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_obj_id)
static	_getObjectStatus ($a_obj_id, $a_user_id=null)
static	_setObjectStatus ($a_obj_id, $a_user_id, array $a_completed=null)
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=false)

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
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...

Detailed Description

Definition at line 15 of file class.ilLPStatusCollectionManual.php.

Member Function Documentation

_getCompleted()

static ilLPStatusCollectionManual::_getCompleted (   $a_obj_id )

static

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

References $counter, $users, ilLPStatusWrapper\_getStatusInfo(), and 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 ilLPStatusCollectionManual::_getInProgress (   $a_obj_id )

static

Definition at line 17 of file class.ilLPStatusCollectionManual.php.

References $users, ilLPStatusWrapper\_getCompleted(), ilLPStatusWrapper\_getStatusInfo(), and array.

    {
        $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
        
        // find any completed item
        $users = array();
        if (is_array($status_info['completed'])) {
            foreach ($status_info['completed'] as $in_progress) {
                $users = array_merge($users, $in_progress);
            }
            $users = array_unique($users);
        }
        
        // remove all users which have completed ALL items
        $users = array_diff($users, ilLPStatusWrapper::_getCompleted($a_obj_id));
        
        return $users;
    }

Here is the call graph for this function:

_getObjectStatus()

static ilLPStatusCollectionManual::_getObjectStatus (   $a_obj_id,   $a_user_id = null  )

static

Definition at line 129 of file class.ilLPStatusCollectionManual.php.

References $ilDB, $res, $row, and array.

    {
        global $ilDB;
        
        $res = array();
        
        $sql = "SELECT subitem_id, completed, usr_id, last_change" .
            " FROM ut_lp_coll_manual" .
            " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer");
        if ($a_user_id) {
            $sql .= " AND usr_id = " . $ilDB->quote($a_user_id, "integer");
        }
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            if (!$a_user_id) {
                $res[$row["subitem_id"]][$row["usr_id"]] = $row["completed"];
            } else {
                $res[$row["subitem_id"]] = array($row["completed"], $row["last_change"]);
            }
        }
        
        return $res;
    }

_getStatusInfo()

static ilLPStatusCollectionManual::_getStatusInfo (   $a_obj_id )

static

Definition at line 56 of file class.ilLPStatusCollectionManual.php.

References ilObject\_getAllReferences(), array, and ilObjectLP\getInstance().

    {
        $status_info = array();
                                        
        include_once "Services/Object/classes/class.ilObjectLP.php";
        $olp = ilObjectLP::getInstance($a_obj_id);
        $collection = $olp->getCollectionInstance();
        if ($collection) {
            $status_info["items"] = $collection->getItems($a_obj_id);
                        
            foreach ($status_info["items"] as $item_id) {
                $status_info["completed"][$item_id] = array();
            }
            
            $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) {
                $status = self::_getObjectStatus($a_obj_id);

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

                    if (isset($status[$item_id])) {
                        foreach ($status[$item_id] as $user_id => $user_status) {
                            if ($user_status) {
                                $status_info["completed"][$item_id][] = $user_id;
                            }
                        }
                    }
                }
            }
        }
        
        return $status_info;
    }

Here is the call graph for this function:

_setObjectStatus()

static ilLPStatusCollectionManual::_setObjectStatus (   $a_obj_id,   $a_user_id, array  $a_completed = null  )

static

Definition at line 153 of file class.ilLPStatusCollectionManual.php.

References $ilDB, ilLPStatusWrapper\_updateStatus(), array, ilObjectLP\getInstance(), and time.

    {
        global $ilDB;
        
        $now = time();
        
        if (!$a_completed) {
            $a_completed = array();
        }
        
        include_once './Services/Object/classes/class.ilObjectLP.php';
        $olp = ilObjectLP::getInstance($a_obj_id);
        $collection = $olp->getCollectionInstance();
        if ($collection) {
            $existing = self::_getObjectStatus($a_obj_id, $a_user_id);
            
            foreach ($collection->getItems() as $item_id) {
                if (isset($existing[$item_id])) {
                    // value changed
                    if ((!$existing[$item_id][0] && in_array($item_id, $a_completed)) ||
                        ($existing[$item_id][0] && !in_array($item_id, $a_completed))) {
                        $ilDB->manipulate("UPDATE ut_lp_coll_manual SET " .
                            " completed = " . $ilDB->quote(in_array($item_id, $a_completed), "integer") .
                            " , last_change = " . $ilDB->quote($now, "integer") .
                            " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer") .
                            " AND usr_id = " . $ilDB->quote($a_user_id, "integer") .
                            " AND subitem_id = " . $ilDB->quote($item_id, "integer"));
                    }
                } elseif (in_array($item_id, $a_completed)) {
                    $ilDB->manipulate("INSERT INTO ut_lp_coll_manual" .
                        "(obj_id,usr_id,subitem_id,completed,last_change)" .
                        " VALUES (" . $ilDB->quote($a_obj_id, "integer") .
                        " , " . $ilDB->quote($a_user_id, "integer") .
                        " , " . $ilDB->quote($item_id, "integer") .
                        " , " . $ilDB->quote(1, "integer") .
                        " , " . $ilDB->quote($now, "integer") . ")");
                }
            }
        }
        
        include_once "Services/Tracking/classes/class.ilLPStatusWrapper.php";
        ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id);
    }

Here is the call graph for this function:

determineStatus()

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

Definition at line 101 of file class.ilLPStatusCollectionManual.php.

References $info.

    {
        $info = self::_getStatusInfo($a_obj_id);
                    
        if (is_array($info["completed"])) {
            $completed = true;
            $in_progress = false;
            foreach ($info["completed"] as $user_ids) {
                // has completed at least 1 item
                if (in_array($a_user_id, $user_ids)) {
                    $in_progress = true;
                }
                // must have completed all items to complete collection
                else {
                    $completed = false;
                }
            }
            if ($completed) {
                return self::LP_STATUS_COMPLETED_NUM;
            }
            if ($in_progress) {
                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.ilLPStatusCollectionManual.php