ilLPStatusVisitedPages Class Reference

Inheritance diagram for ilLPStatusVisitedPages:

Collaboration diagram for ilLPStatusVisitedPages:

Public Member Functions
	determineStatus (int $a_obj_id, int $a_usr_id, object $a_obj=null)
	determinePercentage (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	_getInProgress (int $a_obj_id)
static	_getCompleted (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 (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	hasVisitedAllPages (int $a_obj_id, int $a_user_id)
static	getLMPages (int $a_obj_id)
static	getVisitedPages (int $a_obj_id, ?int $a_user_id=null)
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

Version

$Id$

Definition at line 12 of file class.ilLPStatusVisitedPages.php.

Member Function Documentation

_getCompleted()

static ilLPStatusVisitedPages::_getCompleted ( int  $a_obj_id )

static

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

                                                       : array
    {
        $users = array();

        $all_page_ids = self::getLMPages($a_obj_id);
        foreach (self::getVisitedPages(
            $a_obj_id
        ) as $user_id => $user_page_ids) {
            if (!(bool) sizeof(array_diff($all_page_ids, $user_page_ids))) {
                $users[] = $user_id;
            }
        }

        return $users;
    }

_getInProgress()

static ilLPStatusVisitedPages::_getInProgress ( int  $a_obj_id )

static

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

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

                                                        : array
    {
        $users = ilChangeEvent::lookupUsersInProgress($a_obj_id);
        $users = array_diff(
            $users,
            ilLPStatusWrapper::_getCompleted($a_obj_id)
        );
        return $users;
    }

Here is the call graph for this function:

determinePercentage()

ilLPStatusVisitedPages::determinePercentage	(	int	$a_obj_id,
		int	$a_usr_id,
		?object	$a_obj = null
	)

Definition at line 61 of file class.ilLPStatusVisitedPages.php.

     : int {
        $all_page_ids = sizeof(self::getLMPages($a_obj_id));
        if (!$all_page_ids) {
            return 0;
        }
        $user_page_ids = sizeof(self::getVisitedPages($a_obj_id, $a_usr_id));
        return (int) floor($user_page_ids / $all_page_ids * 100);
    }

determineStatus()

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

Definition at line 40 of file class.ilLPStatusVisitedPages.php.

References ilObject\_lookupType(), and ilChangeEvent\hasAccessed().

     : int {
        $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
        switch (ilObject::_lookupType($a_obj_id)) {
            case 'lm':
                if (ilChangeEvent::hasAccessed($a_obj_id, $a_usr_id)) {
                    $status = self::LP_STATUS_IN_PROGRESS_NUM;

                    if (self::hasVisitedAllPages($a_obj_id, $a_usr_id)) {
                        $status = self::LP_STATUS_COMPLETED_NUM;
                    }
                }
                break;
        }

        return $status;
    }

Here is the call graph for this function:

getLMPages()

static ilLPStatusVisitedPages::getLMPages ( int  $a_obj_id )

staticprotected

Definition at line 86 of file class.ilLPStatusVisitedPages.php.

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

                                                       : array
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $res = array();

        $set = $ilDB->query(
            "SELECT lm_data.obj_id" .
            " FROM lm_data" .
            " JOIN lm_tree ON (lm_tree.child = lm_data.obj_id)" .
            " WHERE lm_tree.lm_id = " . $ilDB->quote($a_obj_id, "integer") .
            " AND lm_data.type = " . $ilDB->quote("pg", "text")
        );
        while ($row = $ilDB->fetchAssoc($set)) {
            // only active pages (time-based activation not supported)
            if (ilPageObject::_lookupActive($row["obj_id"], "lm")) {
                $res[] = (int) $row["obj_id"];
            }
        }
        return $res;
    }

Here is the call graph for this function:

getVisitedPages()

static ilLPStatusVisitedPages::getVisitedPages ( int  $a_obj_id, ?int  $a_user_id = null  )

staticprotected

Definition at line 110 of file class.ilLPStatusVisitedPages.php.

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

     : array {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $res = array();

        $all_page_ids = self::getLMPages($a_obj_id);
        if (!sizeof($all_page_ids)) {
            return $res;
        }

        $sql = "SELECT obj_id, usr_id" .
            " FROM lm_read_event" .
            " WHERE " . $ilDB->in("obj_id", $all_page_ids, "", "integer");

        if ($a_user_id) {
            $sql .= " AND usr_id = " . $ilDB->quote($a_user_id, "integer");
        }

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

        if ($a_user_id) {
            $res = $res[$a_user_id] ?? [];
        }

        return $res;
    }

Here is the call graph for this function:

hasVisitedAllPages()

static ilLPStatusVisitedPages::hasVisitedAllPages ( int  $a_obj_id, int  $a_user_id  )

staticprotected

Definition at line 74 of file class.ilLPStatusVisitedPages.php.

     : bool {
        $all_page_ids = self::getLMPages($a_obj_id);
        if (!sizeof($all_page_ids)) {
            return false;
        }
        $user_page_ids = self::getVisitedPages($a_obj_id, $a_user_id);
        return !(bool) array_diff($all_page_ids, $user_page_ids);
    }

---

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

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