Inheritance diagram for ilLPStatusCollectionManual:

Collaboration diagram for ilLPStatusCollectionManual:

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	_getObjectStatus ( $a_obj_id, $a_user_id=null)

static	_setObjectStatus (int $a_obj_id, int $a_user_id, ?array $a_completed=null)

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)

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 24 of file class.ilLPStatusCollectionManual.php.

Member Function Documentation

◆ _getCompleted()

static ilLPStatusCollectionManual::_getCompleted ( int $a_obj_id )

static

Parameters

int $a_obj_id

Returns: int[]

Reimplemented from ilLPStatus.

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

                                                       : 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);
            }
        }
        return array_unique($users);
    }

References $counter, and ilLPStatusWrapper\_getStatusInfo().

Here is the call graph for this function:

◆ _getInProgress()

static ilLPStatusCollectionManual::_getInProgress ( int $a_obj_id )

static

Reimplemented from ilLPStatus.

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

                                                        : array
    {
        $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
 
        // find any completed item
        $users = array();
        if (isset($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
        return array_diff($users, ilLPStatusWrapper::_getCompleted($a_obj_id));
    }

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

Here is the call graph for this function:

◆ _getObjectStatus()

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

static

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

     : array {
        global $DIC;
 
        $ilDB = $DIC['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[(int) $row["subitem_id"]][(int) $row["usr_id"]] = (int) $row["completed"];
            } else {
                $res[(int) $row["subitem_id"]] = array((int) $row["completed"],
                                                       $row["last_change"]
                );
            }
        }
        return $res;
    }

Referenced by _getStatusInfo().

Here is the caller graph for this function:

◆ _getStatusInfo()

static ilLPStatusCollectionManual::_getStatusInfo ( int $a_obj_id )

static

Reimplemented from ilLPStatus.

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

                                                        : array
    {
        $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["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;
    }

References $ref_id, $user_id, ilObject\_getAllReferences(), _getObjectStatus(), and ilObjectLP\getInstance().

Here is the call graph for this function:

◆ _setObjectStatus()

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

static

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

     : void {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $now = time();
 
        if (!$a_completed) {
            $a_completed = array();
        }
 
        $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") . ")"
                    );
                }
            }
        }
 
        ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id);
    }

◆ determineStatus()

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

Reimplemented from ilLPStatus.

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

     : int {
        $info = self::_getStatusInfo($a_obj_id);
 
        if (isset($info["completed"])) {
            $completed = true;
            $in_progress = false;
            foreach ($info["completed"] as $user_ids) {
                // has completed at least 1 item
                if (in_array($a_usr_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;
    }

References $info, ilLPStatus\LP_STATUS_COMPLETED_NUM, and ilLPStatus\LP_STATUS_IN_PROGRESS_NUM.

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

components/ILIAS/Tracking/classes/status/class.ilLPStatusCollectionManual.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _getCompleted()

◆ _getInProgress()

◆ _getObjectStatus()

◆ _getStatusInfo()

◆ _setObjectStatus()

◆ determineStatus()