ilLPStatusManualByTutor Class Reference

Inheritance diagram for ilLPStatusManualByTutor:

Collaboration diagram for ilLPStatusManualByTutor:

Public Member Functions
	determineStatus (int $a_obj_id, int $a_usr_id, object $a_obj=null)
	Determine status. More...
	refreshStatus (int $a_obj_id, ?array $a_users=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	_getNotAttempted (int $a_obj_id)
	get not attempted More...
static	_getInProgress (int $a_obj_id)
	get in progress public More...
static	_getCompleted (int $a_obj_id)
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 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)

Static Protected Member Functions
static	getMembers (int $a_obj_id)
	Get members for object. More...
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

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Member Function Documentation

_getCompleted()

static ilLPStatusManualByTutor::_getCompleted ( int  $a_obj_id )

static

Definition at line 75 of file class.ilLPStatusManualByTutor.php.

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

                                                       : array
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $usr_ids = array();

        $query = "SELECT DISTINCT(usr_id) user_id FROM ut_lp_marks " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
            "AND completed = '1' ";

        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $usr_ids[] = (int) $row->user_id;
        }

        if ($usr_ids) {
            // Exclude all non members
            $usr_ids = array_intersect(self::getMembers($a_obj_id), $usr_ids);
        }
        return $usr_ids;
    }

Here is the call graph for this function:

_getInProgress()

static ilLPStatusManualByTutor::_getInProgress ( int  $a_obj_id )

static

get in progress public

Parameters

int

object id

Returns

array int Array of user ids

Definition at line 57 of file class.ilLPStatusManualByTutor.php.

References ilLPStatusWrapper\_getCompleted(), and ilChangeEvent\lookupUsersInProgress().

                                                        : array
    {
        $users = ilChangeEvent::lookupUsersInProgress($a_obj_id);

        // Exclude all users with status completed.
        $users = array_diff(
            $users,
            ilLPStatusWrapper::_getCompleted($a_obj_id)
        );

        if ($users) {
            // Exclude all non members
            $users = array_intersect(self::getMembers($a_obj_id), $users);
        }

        return $users;
    }

Here is the call graph for this function:

_getNotAttempted()

static ilLPStatusManualByTutor::_getNotAttempted ( int  $a_obj_id )

static

get not attempted

Definition at line 31 of file class.ilLPStatusManualByTutor.php.

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

                                                          : array
    {
        $users = array();

        $members = self::getMembers($a_obj_id);
        if ($members) {
            // diff in progress and completed (use stored result in LPStatusWrapper)
            $users = array_diff(
                $members,
                ilLPStatusWrapper::_getInProgress($a_obj_id)
            );
            $users = array_diff(
                $users,
                ilLPStatusWrapper::_getCompleted($a_obj_id)
            );
        }

        return $users;
    }

Here is the call graph for this function:

_lookupCompletedForObject()

static ilLPStatusManualByTutor::_lookupCompletedForObject ( int  $a_obj_id, ?array  $a_user_ids = null  )

static

Get completed users for object.

Definition at line 189 of file class.ilLPStatusManualByTutor.php.

     : array {
        if (!$a_user_ids) {
            $a_user_ids = self::getMembers($a_obj_id);
            if (!$a_user_ids) {
                return array();
            }
        }
        return self::_lookupStatusForObject(
            $a_obj_id,
            self::LP_STATUS_COMPLETED_NUM,
            $a_user_ids
        );
    }

_lookupFailedForObject()

static ilLPStatusManualByTutor::_lookupFailedForObject ( int  $a_obj_id, ?array  $a_user_ids = null  )

static

Get failed users for object.

Definition at line 209 of file class.ilLPStatusManualByTutor.php.

     : array {
        return array();
    }

_lookupInProgressForObject()

static ilLPStatusManualByTutor::_lookupInProgressForObject ( int  $a_obj_id, ?array  $a_user_ids = null  )

static

Get in progress users for object.

Definition at line 219 of file class.ilLPStatusManualByTutor.php.

     : array {
        if (!$a_user_ids) {
            $a_user_ids = self::getMembers($a_obj_id);
            if (!$a_user_ids) {
                return array();
            }
        }
        return self::_lookupStatusForObject(
            $a_obj_id,
            self::LP_STATUS_IN_PROGRESS_NUM,
            $a_user_ids
        );
    }

determineStatus()

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

Determine status.

Definition at line 102 of file class.ilLPStatusManualByTutor.php.

References $DIC, ilLPStatus\$ilObjDataCache, and ilChangeEvent\hasAccessed().

     : int {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];

        $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
        switch ($this->ilObjDataCache->lookupType($a_obj_id)) {
            case "crs":
            case "grp":
                // completed?
                $set = $this->db->query(
                    $q = "SELECT usr_id FROM ut_lp_marks " .
                        "WHERE obj_id = " . $this->db->quote(
                            $a_obj_id,
                            'integer'
                        ) . " " .
                        "AND usr_id = " . $this->db->quote(
                            $a_usr_id,
                            'integer'
                        ) . " " .
                        "AND completed = '1' "
                );
                if ($rec = $this->db->fetchAssoc($set)) {
                    $status = self::LP_STATUS_COMPLETED_NUM;
                } else {
                    if (ilChangeEvent::hasAccessed($a_obj_id, $a_usr_id)) {
                        $status = self::LP_STATUS_IN_PROGRESS_NUM;
                    }
                }
                break;
        }
        return $status;
    }

Here is the call graph for this function:

getMembers()

static ilLPStatusManualByTutor::getMembers ( int  $a_obj_id )

staticprotected

Get members for object.

Definition at line 169 of file class.ilLPStatusManualByTutor.php.

References $DIC, ilLPStatus\$ilObjDataCache, ilParticipants\getInstanceByObjId(), and ilObjectDataCache\lookupType().

                                                       : array
    {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];

        switch ($ilObjDataCache->lookupType($a_obj_id)) {
            case 'crs':
            case 'grp':
                return ilParticipants::getInstanceByObjId(
                    $a_obj_id
                )->getMembers();
        }

        return array();
    }

Here is the call graph for this function:

refreshStatus()

ilLPStatusManualByTutor::refreshStatus	(	int	$a_obj_id,
		?array	$a_users = null
	)

Definition at line 140 of file class.ilLPStatusManualByTutor.php.

References ilLPStatusWrapper\_getCompleted(), ilLPStatusWrapper\_getFailed(), ilLPStatusWrapper\_getInProgress(), ilLPStatusWrapper\_getNotAttempted(), ilParticipants\_hasPassed(), and ilObject\_lookupType().

                                                                        : void
    {
        parent::refreshStatus($a_obj_id, $a_users);

        if (ilObject::_lookupType($a_obj_id) !== 'crs') {
            return;
        }

        $course_gui = new ilObjCourseGUI('', $a_obj_id, false);

        $in_progress = ilLPStatusWrapper::_getInProgress($a_obj_id);
        $completed = ilLPStatusWrapper::_getCompleted($a_obj_id);
        $failed = ilLPStatusWrapper::_getFailed($a_obj_id);
        $not_attempted = ilLPStatusWrapper::_getNotAttempted($a_obj_id);
        $all_active_users = array_unique(
            array_merge($in_progress, $completed, $failed, $not_attempted)
        );

        foreach ($all_active_users as $usr_id) {
            $course_gui->updateLPFromStatus(
                $usr_id,
                ilParticipants::_hasPassed($a_obj_id, $usr_id)
            );
        }
    }

Here is the call graph for this function:

---

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

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