ilLPStatusEvent Class Reference

Inheritance diagram for ilLPStatusEvent:

Collaboration diagram for ilLPStatusEvent:

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	_getNotAttempted (int $a_obj_id)
static	_getInProgress (int $a_obj_id)
static	_getCompleted (int $a_obj_id)
static	_getStatusInfo (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 (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)

Static Protected Member Functions
static	getMembers (int $a_obj_id, bool $a_is_crs_id=false)
	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

Definition at line 24 of file class.ilLPStatusEvent.php.

Member Function Documentation

_getCompleted()

static ilLPStatusEvent::_getCompleted ( int  $a_obj_id )

static

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

References ilLPStatusWrapper\_getStatusInfo().

                                                       : array
    {
        $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
        return $status_info['participated_users'] ?: array();
    }

Here is the call graph for this function:

_getInProgress()

static ilLPStatusEvent::_getInProgress ( int  $a_obj_id )

static

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

References ilLPStatusWrapper\_getStatusInfo().

                                                        : array
    {
        $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);

        // If registration is disabled in_progress is not available
        if (!$status_info['registration']) {
            return array();
        }
        // If event has occured in_progress is impossible
        if ($status_info['starting_time'] < time()) {
            return array();
        }

        // Otherwise all users who registered will get the status in progress
        return $status_info['registered_users'] ?: array();
    }

Here is the call graph for this function:

_getNotAttempted()

static ilLPStatusEvent::_getNotAttempted ( int  $a_obj_id )

static

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

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

                                                          : array
    {
        $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);

        $users = array();

        $members = self::getMembers($status_info['crs_id'], true);
        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:

_getStatusInfo()

static ilLPStatusEvent::_getStatusInfo ( int  $a_obj_id )

static

Definition at line 71 of file class.ilLPStatusEvent.php.

References $GLOBALS, $id, $ref_id, ilObject\_getAllReferences(), ilEventParticipants\_getParticipated(), ilEventParticipants\_getRegistered(), ilSessionAppointment\_lookupAppointment(), ilObject\_lookupDescription(), ilObject\_lookupObjId(), ilObjSession\_lookupRegistrationEnabled(), ilObject\_lookupTitle(), and null.

                                                        : array
    {
        $tree = $GLOBALS['DIC']->repositoryTree();

        $references = ilObject::_getAllReferences($a_obj_id);
        $ref_id = end($references);

        $member_ref_id = null;
        if ($id = $tree->checkForParentType($ref_id, 'grp')) {
            $member_ref_id = $id;
        } elseif ($id = $tree->checkForParentType($ref_id, 'crs')) {
            $member_ref_id = $id;
        }

        $status_info = array();
        $status_info['crs_id'] = ilObject::_lookupObjId($member_ref_id);
        $status_info['registration'] = ilObjSession::_lookupRegistrationEnabled(
            $a_obj_id
        );
        $status_info['title'] = ilObject::_lookupTitle($a_obj_id);
        $status_info['description'] = ilObject::_lookupDescription($a_obj_id);

        $time_info = ilSessionAppointment::_lookupAppointment($a_obj_id);
        $status_info['starting_time'] = $time_info['start'];
        $status_info['ending_time'] = $time_info['end'];
        $status_info['fullday'] = $time_info['fullday'];

        $status_info['registered_users'] = ilEventParticipants::_getRegistered(
            $a_obj_id
        );
        $status_info['participated_users'] = ilEventParticipants::_getParticipated(
            $a_obj_id
        );

        return $status_info;
    }

Here is the call graph for this function:

_lookupCompletedForObject()

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

static

Get completed users for object.

Definition at line 182 of file class.ilLPStatusEvent.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 ilLPStatusEvent::_lookupFailedForObject ( int  $a_obj_id, ?array  $a_user_ids = null  )

static

Get failed users for object.

Definition at line 202 of file class.ilLPStatusEvent.php.

     : array {
        return array();
    }

_lookupInProgressForObject()

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

static

Get in progress users for object.

Definition at line 212 of file class.ilLPStatusEvent.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()

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

Definition at line 108 of file class.ilLPStatusEvent.php.

References $DIC, ilLPStatus\$ilObjDataCache, ilEventParticipants\_hasParticipated(), ilEventParticipants\_isRegistered(), ilSessionAppointment\_lookupAppointment(), and ilObjSession\_lookupRegistrationEnabled().

     : int {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];

        $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
        switch ($this->ilObjDataCache->lookupType($a_obj_id)) {
            case 'sess':

                $time_info = ilSessionAppointment::_lookupAppointment(
                    $a_obj_id
                );
                $registration = ilObjSession::_lookupRegistrationEnabled(
                    $a_obj_id
                );

                // If registration is disabled in_progress is not available
                // If event has occured in_progress is impossible
                if ($registration && $time_info['start'] >= time()) {
                    // is user registered -> in progress
                    if (ilEventParticipants::_isRegistered(
                        $a_usr_id,
                        $a_obj_id
                    )) {
                        $status = self::LP_STATUS_IN_PROGRESS_NUM;
                    }
                }
                if (ilEventParticipants::_hasParticipated(
                    $a_usr_id,
                    $a_obj_id
                )) {
                    $status = self::LP_STATUS_COMPLETED_NUM;
                }
                break;
        }
        return $status;
    }

Here is the call graph for this function:

getMembers()

static ilLPStatusEvent::getMembers ( int  $a_obj_id, bool  $a_is_crs_id = false  )

staticprotected

Get members for object.

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

References $GLOBALS, $id, $ref_id, ilObject\_getAllReferences(), ilObject\_lookupObjId(), ilParticipants\getInstanceByObjId(), and null.

     : array {
        if (!$a_is_crs_id) {
            $tree = $GLOBALS['DIC']->repositoryTree();
            $references = ilObject::_getAllReferences($a_obj_id);
            $ref_id = end($references);

            $member_ref_id = null;
            if ($id = $tree->checkForParentType($ref_id, 'grp')) {
                $member_ref_id = $id;
            } elseif ($id = $tree->checkForParentType($ref_id, 'crs')) {
                $member_ref_id = $id;
            } else {
                return [];
            }
            $member_obj_id = ilObject::_lookupObjId($member_ref_id);
        } else {
            $member_obj_id = $a_obj_id;
        }

        $member_obj = ilParticipants::getInstanceByObjId($member_obj_id);
        return $member_obj->getMembers();
    }

Here is the call graph for this function:

---

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

• components/ILIAS/Tracking/classes/status/class.ilLPStatusEvent.php