Inheritance diagram for ilLPStatusVisitedPages:

Collaboration diagram for ilLPStatusVisitedPages:

Public Member Functions
	_getInProgress ($a_obj_id)

	_getCompleted ($a_obj_id)

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

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

Public Member Functions inherited from ilLPStatus
	ilLPStatus ($a_obj_id)

	_getCountNotAttempted ($a_obj_id)

	_getNotAttempted ($a_obj_id)

	_getCountInProgress ($a_obj_id)

	_getInProgress ($a_obj_id)

	_getCountCompleted ($a_obj_id)

	_getCompleted ($a_obj_id)

	_getFailed ($a_obj_id)

	_getCountFailed ()

	_getStatusInfo ($a_obj_id)

	_getTypicalLearningTime ($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...

	_lookupStatusChanged ($a_obj_id, $a_user_id)
	Lookup status changed. More...

Static Protected Member Functions
static	hasVisitedAllPages ($a_obj_id, $a_user_id)

static	getLMPages ($a_obj_id)

static	getVisitedPages ($a_obj_id, $a_user_id=null)

Static Protected Member Functions inherited from ilLPStatus
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...

Additional Inherited Members
Static Public Member Functions inherited from ilLPStatus
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)
	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	_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)

Data Fields inherited from ilLPStatus
	$obj_id = null

	$db = null

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 Member Functions inherited from ilLPStatus
	raiseEvent ($a_obj_id, $a_usr_id, $a_status, $a_percentage)

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 15 of file class.ilLPStatusVisitedPages.php.

Member Function Documentation

◆ _getCompleted()

ilLPStatusVisitedPages::_getCompleted ( $a_obj_id )

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

         {
                 $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()

ilLPStatusVisitedPages::_getInProgress ( $a_obj_id )

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

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

         {               
                 include_once './Services/Tracking/classes/class.ilChangeEvent.php';
                 $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	(	$a_obj_id,
		$a_user_id,
		$a_obj = `null`
	)

Determine percentage.

Parameters

integer	object id
integer	user id
object	object (optional depends on object type)

Returns: integer percentage

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

         {               
                 /* once completed will not be changed anymore
                 if(ilLPStatus::_hasUserCompleted($a_obj_id, $a_user_id))
                 {
                         return 100;
                 }
                 */
                 
                 $all_page_ids = sizeof(self::getLMPages($a_obj_id));                            
                 if(!sizeof($all_page_ids))
                 {
                         return 0;
                 }
                 
                 $user_page_ids = sizeof(self::getVisitedPages($a_obj_id, $a_user_id));
                                         
                 return floor($user_page_ids/$all_page_ids*100);
         }

◆ determineStatus()

ilLPStatusVisitedPages::determineStatus	(	$a_obj_id,
		$a_user_id,
		$a_obj = `null`
	)

Determine status.

Parameters

integer	object id
integer	user id
object	object (optional depends on object type)

Returns: integer status

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

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

         {               
                 /* once completed will not be changed anymore
                 if(ilLPStatus::_hasUserCompleted($a_obj_id, $a_user_id))
                 {
                         return self::LP_STATUS_COMPLETED_NUM;
                 }
                 */
                 
                 $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
                 switch(ilObject::_lookupType($a_obj_id))
                 {
                         case 'lm':
                                 if(ilChangeEvent::hasAccessed($a_obj_id, $a_user_id))
                                 {
                                         $status = self::LP_STATUS_IN_PROGRESS_NUM;
                                 
                                         if(self::hasVisitedAllPages($a_obj_id, $a_user_id))
                                         {
                                                 $status = self::LP_STATUS_COMPLETED_NUM;
                                         }
                                 }
                                 break;                  
                 }
                 
                 return $status;         
         }               

Here is the call graph for this function:

◆ getLMPages()

static ilLPStatusVisitedPages::getLMPages ( $a_obj_id )

staticprotected

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

References $ilDB, $res, $row, and ilPageObject\_lookupActive().

         {
                 global $ilDB;
                 
                 $res = array();
                 
                 include_once "Services/COPage/classes/class.ilPageObject.php";
                 
                 $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[] = $row["obj_id"];
                         }
                 }
                 
                 return $res;
         }       

Here is the call graph for this function:

◆ getVisitedPages()

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

staticprotected

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

References $ilDB, $res, and $row.

         {
                 global $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[$row["usr_id"]][] = $row["obj_id"];                                        
                 }       
                 
                 if($a_user_id)
                 {
                         $res = (array)$res[$a_user_id];
                 }
                 
                 return $res;
         }       

◆ hasVisitedAllPages()

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

staticprotected

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

         {
                 $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)sizeof(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

Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _getCompleted()

◆ _getInProgress()

◆ determinePercentage()

◆ determineStatus()

◆ getLMPages()

◆ getVisitedPages()

◆ hasVisitedAllPages()