ilLPStatusSurveyFinished Class Reference

Inheritance diagram for ilLPStatusSurveyFinished:

Collaboration diagram for ilLPStatusSurveyFinished:

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	getParticipants (int $a_obj_id, bool $a_only_finished=false)
static	getInvitations (int $a_obj_id)
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	getSurveyId (int $a_obj_id)
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

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Member Function Documentation

_getCompleted()

static ilLPStatusSurveyFinished::_getCompleted ( int  $a_obj_id )

static

Definition at line 50 of file class.ilLPStatusSurveyFinished.php.

                                                       : array
    {
        return self::getParticipants($a_obj_id, true);
    }

_getInProgress()

static ilLPStatusSurveyFinished::_getInProgress ( int  $a_obj_id )

static

Definition at line 45 of file class.ilLPStatusSurveyFinished.php.

                                                        : array
    {
        return self::getParticipants($a_obj_id);
    }

_getNotAttempted()

static ilLPStatusSurveyFinished::_getNotAttempted ( int  $a_obj_id )

static

Definition at line 28 of file class.ilLPStatusSurveyFinished.php.

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

                                                          : array
    {
        $invited = self::getInvitations($a_obj_id);
        if ($invited === []) {
            return [];
        }
        $users = array_diff(
            (array) $invited,
            ilLPStatusWrapper::_getInProgress($a_obj_id)
        );
        $users = array_diff(
            $users,
            ilLPStatusWrapper::_getCompleted($a_obj_id)
        );
        return $users;
    }

Here is the call graph for this function:

determineStatus()

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

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

References ilObjSurveyAccess\_isSurveyParticipant(), ilObjSurveyAccess\_lookupFinished(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

     : int {
        $survey_id = self::getSurveyId($a_obj_id);
        if (!$survey_id) {
            return ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
        }
        $status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;

        if (ilObjSurveyAccess::_isSurveyParticipant($a_usr_id, $survey_id)) {
            $status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;

            if (ilObjSurveyAccess::_lookupFinished($a_obj_id, $a_usr_id)) {
                $status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
            }
        }
        return $status;
    }

Here is the call graph for this function:

getInvitations()

static ilLPStatusSurveyFinished::getInvitations ( int  $a_obj_id )

static

Parameters

int

$a_obj_id

Returns

int[]

Definition at line 120 of file class.ilLPStatusSurveyFinished.php.

References ilLPStatus\$db, $DIC, $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), ilDBInterface\query(), ilDBInterface\quote(), and ilDBConstants\T_INTEGER.

                                                        : array
    {
        global $DIC;

        $db = $DIC->database();
        $query = 'select user_id from svy_invitation si ' .
            'join svy_svy ss on ss.survey_id = si.survey_id ' .
            'where obj_fi = ' . $db->quote($a_obj_id, ilDBConstants::T_INTEGER);
        $res = $db->query($query);
        $invited = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $invited[] = (int) $row->user_id;
        }
        return $invited;
    }

Here is the call graph for this function:

getParticipants()

static ilLPStatusSurveyFinished::getParticipants ( int  $a_obj_id, bool  $a_only_finished = false  )

static

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

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

     : array {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $res = array();
        $survey_id = self::getSurveyId($a_obj_id);
        if (!$survey_id) {
            return $res;
        }

        $sql = "SELECT user_fi FROM svy_finished fin" .
            " WHERE fin.survey_fi = " . $ilDB->quote($survey_id, "integer");

        if ($a_only_finished) {
            $sql .= " AND fin.state = " . $ilDB->quote(1, "integer");
        }

        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = (int) $row["user_fi"];
        }
        return $res;
    }

Here is the call graph for this function:

getSurveyId()

static ilLPStatusSurveyFinished::getSurveyId ( int  $a_obj_id )

staticprotected

Definition at line 76 of file class.ilLPStatusSurveyFinished.php.

References $DIC, and $ilDB.

                                                        : int
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $set = $ilDB->query(
            "SELECT survey_id FROM svy_svy" .
            " WHERE obj_fi = " . $ilDB->quote($a_obj_id)
        );
        $row = $ilDB->fetchAssoc($set);
        return (int) ($row["survey_id"] ?? 0);
    }

---

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

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