Inheritance diagram for ilLPStatusCmiXapiAbstract:

Collaboration diagram for ilLPStatusCmiXapiAbstract:

Public Member Functions
	getCmixUserResult ($objId, $usrId)

	determineStatus ($a_obj_id, $a_usr_id, $a_obj=null)
	Determine status. More...

	determinePercentage ($a_obj_id, $a_usr_id, $a_obj=null)
	Determine percentage. More...

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	_getNotAttempted ($a_obj_id)

static	_getInProgress ($a_obj_id)

static	_getCompleted ($a_obj_id)

static	_getFailed ($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)

Protected Member Functions
	ensureObject ($objId, $object=null)

	resultSatisfyCompleted (ilCmiXapiResult $result)

	resultSatisfyFailed (ilCmiXapiResult $result)

Static Protected Member Functions
static	_resultSatisfyCompleted (ilCmiXapiResult $result, $a_obj_id)

static	_resultSatisfyFailed (ilCmiXapiResult $result, $a_obj_id)

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
	$cmixUserResult = array()

Protected Attributes inherited from ilLPStatus
	$obj_id = null

	$db = null

Static Private Member Functions
static	getUserIdsByLpStatusNum ($objId, $lpStatusNum)

static	loadStatusInfo ($a_obj_id)

Static Private Attributes
static	$statusInfoCache = array()

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

Detailed Description

Definition at line 14 of file class.ilLPStatusCmiXapiAbstract.php.

Member Function Documentation

◆ _getCompleted()

static ilLPStatusCmiXapiAbstract::_getCompleted ( $a_obj_id )

static

Reimplemented from ilLPStatus.

Definition at line 73 of file class.ilLPStatusCmiXapiAbstract.php.

    {
        return self::getUserIdsByLpStatusNum(
            $a_obj_id,
            ilLPStatus::LP_STATUS_COMPLETED_NUM
        );
    }

References getUserIdsByLpStatusNum(), and ilLPStatus\LP_STATUS_COMPLETED_NUM.

Here is the call graph for this function:

◆ _getFailed()

static ilLPStatusCmiXapiAbstract::_getFailed ( $a_obj_id )

static

Reimplemented from ilLPStatus.

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

    {
        return self::getUserIdsByLpStatusNum(
            $a_obj_id,
            ilLPStatus::LP_STATUS_FAILED_NUM
        );
    }

References getUserIdsByLpStatusNum(), and ilLPStatus\LP_STATUS_FAILED_NUM.

Here is the call graph for this function:

◆ _getInProgress()

static ilLPStatusCmiXapiAbstract::_getInProgress ( $a_obj_id )

static

Reimplemented from ilLPStatus.

Definition at line 65 of file class.ilLPStatusCmiXapiAbstract.php.

    {
        return self::getUserIdsByLpStatusNum(
            $a_obj_id,
            ilLPStatus::LP_STATUS_IN_PROGRESS_NUM
        );
    }

References getUserIdsByLpStatusNum(), and ilLPStatus\LP_STATUS_IN_PROGRESS_NUM.

Here is the call graph for this function:

◆ _getNotAttempted()

static ilLPStatusCmiXapiAbstract::_getNotAttempted ( $a_obj_id )

static

Reimplemented from ilLPStatus.

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

    {
        return self::getUserIdsByLpStatusNum(
            $a_obj_id,
            ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM
        );
    }

References getUserIdsByLpStatusNum(), and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

Here is the call graph for this function:

◆ _getStatusInfo()

static ilLPStatusCmiXapiAbstract::_getStatusInfo ( $a_obj_id )

static

Reimplemented from ilLPStatus.

Definition at line 95 of file class.ilLPStatusCmiXapiAbstract.php.

    {
        if (self::$statusInfoCache[$a_obj_id] === null) {
            self::$statusInfoCache[$a_obj_id] = self::loadStatusInfo($a_obj_id);
        }
        
        return self::$statusInfoCache[$a_obj_id];
    }

References loadStatusInfo().

Referenced by getUserIdsByLpStatusNum().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _resultSatisfyCompleted()

static ilLPStatusCmiXapiAbstract::_resultSatisfyCompleted	(	ilCmiXapiResult	$result,
			$a_obj_id
	)

staticprotected

Parameters

ilObjCmiXapi	$object
ilCmiXapiResult	$result

Returns: bool

Definition at line 182 of file class.ilLPStatusCmiXapiAbstract.php.

    {
        $lpStatusDetermination = new static($a_obj_id);
        return $lpStatusDetermination->resultSatisfyCompleted($result);
    }

References $result.

◆ _resultSatisfyFailed()

static ilLPStatusCmiXapiAbstract::_resultSatisfyFailed	(	ilCmiXapiResult	$result,
			$a_obj_id
	)

staticprotected

Parameters

ilObjCmiXapi	$object
ilCmiXapiResult	$result

Returns: bool

Definition at line 199 of file class.ilLPStatusCmiXapiAbstract.php.

    {
        $lpStatusDetermination = new static($a_obj_id);
        return $lpStatusDetermination->resultSatisfyFailed($result);
    }

References $result.

◆ determinePercentage()

ilLPStatusCmiXapiAbstract::determinePercentage	(	$a_obj_id,
		$a_usr_id,
		$a_obj = `null`
	)

Determine percentage.

Parameters

return

Reimplemented from ilLPStatus.

Definition at line 160 of file class.ilLPStatusCmiXapiAbstract.php.

    {
        $cmixResult = $this->getCmixUserResult($a_obj_id, $a_usr_id);
        
        if ($cmixResult instanceof ilCmiXapiResult) {
            return 100 * (float) $cmixResult->getScore();
        }
        
        return 0;
    }

References getCmixUserResult().

Here is the call graph for this function:

◆ determineStatus()

ilLPStatusCmiXapiAbstract::determineStatus	(	$a_obj_id,
		$a_usr_id,
		$a_obj = `null`
	)

Determine status.

Parameters

return

Reimplemented from ilLPStatus.

Definition at line 137 of file class.ilLPStatusCmiXapiAbstract.php.

    {
        $cmixUserResult = $this->getCmixUserResult($a_obj_id, $a_usr_id);
        
        if ($cmixUserResult instanceof ilCmiXapiResult) {
            if ($this->resultSatisfyCompleted($cmixUserResult)) {
                return self::LP_STATUS_COMPLETED_NUM;
            }
            
            if ($this->resultSatisfyFailed($cmixUserResult)) {
                return self::LP_STATUS_FAILED_NUM;
            }
            
            return self::LP_STATUS_IN_PROGRESS_NUM;
        }
        
        if (ilCmiXapiUser::exists($a_obj_id, $a_usr_id)) {
            return self::LP_STATUS_IN_PROGRESS_NUM;
        }
        
        return self::LP_STATUS_NOT_ATTEMPTED_NUM;
    }

References $cmixUserResult, ilCmiXapiUser\exists(), getCmixUserResult(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, resultSatisfyCompleted(), and resultSatisfyFailed().

Here is the call graph for this function:

◆ ensureObject()

ilLPStatusCmiXapiAbstract::ensureObject	(	$objId,
		$object = `null`
	)

protected

Parameters

$objId
$object

Returns: ilObjCmiXapi

Definition at line 48 of file class.ilLPStatusCmiXapiAbstract.php.

    {
        if (!($object instanceof ilObjCmiXapi)) {
            $object = ilObjectFactory::getInstanceByObjId($objId);
        }
        
        return $object;
    }

References $objId, and ilObjectFactory\getInstanceByObjId().

Here is the call graph for this function:

◆ getCmixUserResult()

ilLPStatusCmiXapiAbstract::getCmixUserResult	(	$objId,
		$usrId
	)

Parameters

$objId
$usrId

Returns: ilCmiXapiResult

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

    {
        if (!isset($this->cmixUserResult[$objId])) {
            $this->cmixUserResult[$objId] = array();
        }
        
        if (!isset($this->cmixUserResult[$objId][$usrId])) {
            try {
                $cmixUserResult = ilCmiXapiResult::getInstanceByObjIdAndUsrId($objId, $usrId);
                $this->cmixUserResult[$objId][$usrId] = $cmixUserResult;
            } catch (ilCmiXapiException $e) {
                $this->cmixUserResult[$objId][$usrId] = null;
            }
        }
        
        return $this->cmixUserResult[$objId][$usrId];
    }

References $cmixUserResult, Vendor\Package\$e, $objId, and ilCmiXapiResult\getInstanceByObjIdAndUsrId().

Referenced by determinePercentage(), and determineStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserIdsByLpStatusNum()

static ilLPStatusCmiXapiAbstract::getUserIdsByLpStatusNum	(	$objId,
		$lpStatusNum
	)

staticprivate

Definition at line 89 of file class.ilLPStatusCmiXapiAbstract.php.

    {
        $statusInfo = self::_getStatusInfo($objId);
        return $statusInfo[$lpStatusNum];
    }

References $objId, and _getStatusInfo().

Referenced by _getCompleted(), _getFailed(), _getInProgress(), and _getNotAttempted().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadStatusInfo()

static ilLPStatusCmiXapiAbstract::loadStatusInfo ( $a_obj_id )

staticprivate

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

    {
        $statusInfo = [
            ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM => [],
            ilLPStatus::LP_STATUS_IN_PROGRESS_NUM => [],
            ilLPStatus::LP_STATUS_COMPLETED_NUM => [],
            ilLPStatus::LP_STATUS_FAILED_NUM => []
        ];
        
        $cmixUsers = ilCmiXapiUser::getUsersForObject($a_obj_id);
        $userResults = ilCmiXapiResult::getResultsForObject($a_obj_id);
        
        foreach ($cmixUsers as $cmixUser) {
            $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
            
            if (isset($userResults[$cmixUser->getUsrId()])) {
                $userResult = $userResults[$cmixUser->getUsrId()];
                
                if (self::_resultSatisfyCompleted($userResult, $a_obj_id)) {
                    $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
                }
                
                if (self::_resultSatisfyFailed($userResult, $a_obj_id)) {
                    $status = ilLPStatus::LP_STATUS_FAILED_NUM;
                }
            }
            
            $statusInfo[$status][] = $cmixUser->getUsrId();
        }
        
        return $statusInfo;
    }