ilLPStatusCourseReference Class Reference

Class ilLPStatusCourseReference. More...

Inheritance diagram for ilLPStatusCourseReference:

Collaboration diagram for ilLPStatusCourseReference:

Public Member Functions
	__construct ($a_obj_id)
	ilLPStatusCourseReference constructor. More...
	getNotAttempted ()
	getInProgress ()
	getCompleted ()
	getStatusInfo ()
	readStatusInfo ($a_obj_id)
	determineStatus ($a_obj_id, $a_usr_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	_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	_getStatusInfo ($a_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, &$a_old_status=self::LP_STATUS_NOT_ATTEMPTED_NUM)
	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)

Private Member Functions
	readTargetObjId ($a_obj_id)

Static Private Member Functions
static	getInstanceByObjId ($a_reference_obj_id)

Private Attributes
	$logger = null
	$target_obj_id = 0
	$status_info = []

Static Private Attributes
static	$instances = []

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 ($a_obj_id, $a_usr_id, $a_status, $a_old_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...
Protected Attributes inherited from ilLPStatus
	$obj_id = null
	$db = null

Detailed Description

Class ilLPStatusCourseReference.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 8 of file class.ilLPStatusCourseReference.php.

Constructor & Destructor Documentation

__construct()

ilLPStatusCourseReference::__construct

(

$a_obj_id

)

ilLPStatusCourseReference constructor.

Parameters

int

$a_obj_id

Definition at line 32 of file class.ilLPStatusCourseReference.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), readStatusInfo(), and readTargetObjId().

    {
        global $DIC;

        $this->logger = $DIC->logger()->trac();

        parent::__construct($a_obj_id);
        $this->readTargetObjId($a_obj_id);
        $this->readStatusInfo($a_obj_id);
    }

Here is the call graph for this function:

Member Function Documentation

_getCompleted()

static ilLPStatusCourseReference::_getCompleted (   $a_obj_id )

static

Definition at line 107 of file class.ilLPStatusCourseReference.php.

    {
        $self = self::getInstanceByObjId($a_obj_id);
        return $self->getCompleted();
    }

_getCountCompleted()

static ilLPStatusCourseReference::_getCountCompleted (   $a_obj_id )

static

Definition at line 98 of file class.ilLPStatusCourseReference.php.

    {
        $self = self::getInstanceByObjId($a_obj_id);
        return count($self->getCompleted());
    }

_getCountInProgress()

static ilLPStatusCourseReference::_getCountInProgress (   $a_obj_id )

static

Definition at line 72 of file class.ilLPStatusCourseReference.php.

    {
        $self = self::getInstanceByObjId($a_obj_id);
        return count($self->getInProgress());
    }

_getCountNotAttempted()

static ilLPStatusCourseReference::_getCountNotAttempted (   $a_obj_id )

static

Definition at line 46 of file class.ilLPStatusCourseReference.php.

    {
        $self = self::getInstanceByObjId($a_obj_id);
        return count($self->getNotAttempted());
    }

_getInProgress()

static ilLPStatusCourseReference::_getInProgress (   $a_obj_id )

static

Definition at line 81 of file class.ilLPStatusCourseReference.php.

    {
        $self = self::getInstanceByObjId($a_obj_id);
        return $self->getInProgress();
    }

_getNotAttempted()

static ilLPStatusCourseReference::_getNotAttempted (   $a_obj_id )

static

Definition at line 55 of file class.ilLPStatusCourseReference.php.

    {
        $self = self::getInstanceByObjId($a_obj_id);
        return $self->getNotAttempted();
    }

_getStatusInfo()

static ilLPStatusCourseReference::_getStatusInfo (   $a_obj_id )

static

Definition at line 125 of file class.ilLPStatusCourseReference.php.

    {
        $self = self::getInstanceByObjId($a_obj_id);
        return $self->getStatusInfo();
    }

determineStatus()

ilLPStatusCourseReference::determineStatus	(		$a_obj_id,
			$a_usr_id,
			$a_obj = null
	)

Definition at line 166 of file class.ilLPStatusCourseReference.php.

References ilLPStatus\_lookupStatus().

    {
        $status = \ilLPStatus::_lookupStatus($this->target_obj_id, $a_usr_id, false);
        if ($status) {
            return $status;
        }
        return \ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
    }

Here is the call graph for this function:

getCompleted()

ilLPStatusCourseReference::getCompleted

(

)

Returns

int[]

Definition at line 116 of file class.ilLPStatusCourseReference.php.

References ilLPStatus\LP_STATUS_COMPLETED_NUM.

    {
        return $this->status_info[\ilLPStatus::LP_STATUS_COMPLETED_NUM];
    }

getInProgress()

ilLPStatusCourseReference::getInProgress

(

)

Returns

int[]

Definition at line 90 of file class.ilLPStatusCourseReference.php.

References ilLPStatus\LP_STATUS_IN_PROGRESS_NUM.

    {
        return $this->status_info[\ilLPStatus::LP_STATUS_IN_PROGRESS_NUM];
    }

getInstanceByObjId()

static ilLPStatusCourseReference::getInstanceByObjId (   $a_reference_obj_id )

staticprivate

Parameters

$a_reference_obj_id

Returns

Definition at line 180 of file class.ilLPStatusCourseReference.php.

    {
        if (!isset(self::$instances[$a_reference_obj_id])) {
            self::$instances[$a_reference_obj_id] = new self($a_reference_obj_id);
        }
        return self::$instances[$a_reference_obj_id];
    }

getNotAttempted()

ilLPStatusCourseReference::getNotAttempted

(

)

Returns

int[]

Definition at line 64 of file class.ilLPStatusCourseReference.php.

References ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

    {
        return $this->status_info[\ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM];
    }

getStatusInfo()

ilLPStatusCourseReference::getStatusInfo

(

)

Definition at line 131 of file class.ilLPStatusCourseReference.php.

References $status_info.

    {
        return $this->status_info;
    }

readStatusInfo()

ilLPStatusCourseReference::readStatusInfo

(

$a_obj_id

)

Definition at line 139 of file class.ilLPStatusCourseReference.php.

References $DIC, $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, and ilDBConstants\T_INTEGER.

Referenced by __construct().

    {
        global $DIC;

        $database = $DIC->database();
        $query = 'select status,usr_id from ut_lp_marks ' .
            'where obj_id = ' . $database->quote($this->target_obj_id, \ilDBConstants::T_INTEGER);
        $res = $database->query($query);

        $info = [
            \ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM => [],
            \ilLPStatus::LP_STATUS_IN_PROGRESS_NUM => [],
            \ilLPStatus::LP_STATUS_COMPLETED_NUM => [],
            \ilLPStatus::LP_STATUS_FAILED_NUM => []
        ];
        while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
            if (array_key_exists((int) $row->status, $info)) {
                $info[(int) $row->status][] = (int) $row->usr_id;
            }
        }
        $this->status_info = $info;
    }

Here is the caller graph for this function:

readTargetObjId()

ilLPStatusCourseReference::readTargetObjId (   $a_obj_id )

private

Parameters

$a_obj_id

Definition at line 191 of file class.ilLPStatusCourseReference.php.

References ilObject\_lookupObjId(), and ilContainerReference\_lookupTargetRefId().

Referenced by __construct().

    {
        $this->target_obj_id = ilObject::_lookupObjId(ilObjCourseReference::_lookupTargetRefId($a_obj_id));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$instances

ilLPStatusCourseReference::$instances = []

staticprivate

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

$logger

ilLPStatusCourseReference::$logger = null

private

Definition at line 18 of file class.ilLPStatusCourseReference.php.

$status_info

ilLPStatusCourseReference::$status_info = []

private

Definition at line 25 of file class.ilLPStatusCourseReference.php.

Referenced by getStatusInfo().

$target_obj_id

ilLPStatusCourseReference::$target_obj_id = 0

private

Definition at line 23 of file class.ilLPStatusCourseReference.php.

---

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

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