ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions | Static Protected Member Functions
ilLPStatusObjectives Class Reference
+ Inheritance diagram for ilLPStatusObjectives:
+ Collaboration diagram for ilLPStatusObjectives:

Public Member Functions

 ilLPStatusObjectives ($a_obj_id)
 _getNotAttempted ($a_obj_id)
 _getInProgress ($a_obj_id)
 _getCompleted ($a_obj_id)
 _getStatusInfo ($a_obj_id)
 determineStatus ($a_obj_id, $a_user_id, $a_obj=null)
 Determine status.
- Public Member Functions inherited from ilLPStatus
 ilLPStatus ($a_obj_id)
 _getCountNotAttempted ($a_obj_id)
 _getCountInProgress ($a_obj_id)
 _getCountCompleted ($a_obj_id)
 _getFailed ($a_obj_id)
 _getCountFailed ()
 _getTypicalLearningTime ($a_obj_id)
 _updateStatus ($a_obj_id, $a_usr_id, $a_obj=null, $a_percentage=false, $a_no_raise=false)
 New status handling (st: status, nr: accesses, p: percentage, t: time spent, m: mark)
 determinePercentage ($a_obj_id, $a_usr_id, $a_obj=null)
 Determine percentage.
 refreshStatus ($a_obj_id, $a_users=null)
 Refresh status.
 _lookupStatus ($a_obj_id, $a_user_id)
 Lookup status.
 _lookupStatusChanged ($a_obj_id, $a_user_id)
 Lookup status changed.

Static Public Member Functions

static _lookupCompletedForObject ($a_obj_id, $a_user_ids=null)
 Get completed users for object.
static _lookupFailedForObject ($a_obj_id, $a_user_ids=null)
 Get failed users for object.
static _lookupInProgressForObject ($a_obj_id, $a_user_ids=null)
 Get in progress users for object.
- 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.
static writeStatus ($a_obj_id, $a_user_id, $a_status, $a_percentage=false, $a_force_per=false)
 Write status for user and object.
static setInProgressIfNotAttempted ($a_obj_id, $a_user_id)
 This function shoudl be clalled for normal "read events".
static setAllDirty ()
 Sets all status to dirty.
static setDirty ($a_obj_id)
 Sets status of an object to dirty.

Static Protected Member Functions

static getMembers ($a_obj_id)
 Get members for object.
- 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.

Additional Inherited Members

- Data Fields inherited from ilLPStatus
 $obj_id = null
 $db = null
- Protected Member Functions inherited from ilLPStatus
 raiseEvent ($a_obj_id, $a_usr_id, $a_status, $a_percentage)

Detailed Description

Definition at line 16 of file class.ilLPStatusObjectives.php.

Member Function Documentation

ilLPStatusObjectives::_getCompleted (   $a_obj_id)

Reimplemented from ilLPStatus.

Definition at line 59 of file class.ilLPStatusObjectives.php.

References _getStatusInfo().

{
$usr_ids = array();
$status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
foreach($status_info['objective_result'] as $user_id => $completed)
{
if(count($completed) == $status_info['num_objectives'])
{
$usr_ids[] = $user_id;
}
}
if($usr_ids)
{
// Exclude all non members
$usr_ids = array_intersect(self::getMembers($a_obj_id), (array)$usr_ids);
}
return $usr_ids ? $usr_ids : array();
}

+ Here is the call graph for this function:

ilLPStatusObjectives::_getInProgress (   $a_obj_id)

Reimplemented from ilLPStatus.

Definition at line 42 of file class.ilLPStatusObjectives.php.

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

{
include_once './Services/Tracking/classes/class.ilChangeEvent.php';
$users = ilChangeEvent::lookupUsersInProgress($a_obj_id);
// Exclude all users with status completed.
$users = array_diff((array) $users,ilLPStatusWrapper::_getCompleted($a_obj_id));
if($users)
{
// Exclude all non members
$users = array_intersect(self::getMembers($a_obj_id), (array)$users);
}
return $users;
}

+ Here is the call graph for this function:

ilLPStatusObjectives::_getNotAttempted (   $a_obj_id)

Reimplemented from ilLPStatus.

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

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

{
$users = array();
$members = self::getMembers($a_obj_id);
if($members)
{
// diff in progress and completed (use stored result in LPStatusWrapper)
$users = array_diff((array) $members, ilLPStatusWrapper::_getInProgress($a_obj_id));
$users = array_diff((array) $users, ilLPStatusWrapper::_getCompleted($a_obj_id));
}
return $users;
}

+ Here is the call graph for this function:

ilLPStatusObjectives::_getStatusInfo (   $a_obj_id)

Reimplemented from ilLPStatus.

Definition at line 82 of file class.ilLPStatusObjectives.php.

References $in, $query, $res, $row, ilCourseObjective\_getObjectiveIds(), and DB_FETCHMODE_OBJECT.

Referenced by _getCompleted().

{
global $ilDB;
include_once 'Modules/Course/classes/class.ilCourseObjective.php';
$status_info = array();
$status_info['objective_result'] = array();
$status_info['objectives'] = ilCourseObjective::_getObjectiveIds($a_obj_id);
$status_info['num_objectives'] = count($status_info['objectives']);
if($status_info['num_objectives'])
{
$in = $ilDB->in('objective_id',$status_info['objectives'],false,'integer');
$query = "SELECT * FROM crs_objective_status WHERE ".$in;
$res = $ilDB->query($query);
while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
{
$status_info['completed'][$row->objective_id][] = $row->user_id;
$status_info['objective_result'][$row->user_id][$row->objective_id] = $row->objective_id;
}
// Read title/description
$query = "SELECT * FROM crs_objectives WHERE ".$in;
$res = $ilDB->query($query);
while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
{
$status_info['objective_title'][$row->objective_id] = $row->title;
$status_info['objective_description'][$row->objective_id] = $row->description;
}
}
return $status_info;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilLPStatusObjectives::_lookupCompletedForObject (   $a_obj_id,
  $a_user_ids = null 
)
static

Get completed users for object.

Parameters
int$a_obj_id
array$a_user_ids
Returns
array

Reimplemented from ilLPStatus.

Definition at line 189 of file class.ilLPStatusObjectives.php.

References ilLPStatus\_lookupStatusForObject(), getMembers(), and LP_STATUS_COMPLETED_NUM.

{
if(!$a_user_ids)
{
$a_user_ids = self::getMembers($a_obj_id);
if(!$a_user_ids)
{
return array();
}
}
return self::_lookupStatusForObject($a_obj_id, LP_STATUS_COMPLETED_NUM, $a_user_ids);
}

+ Here is the call graph for this function:

static ilLPStatusObjectives::_lookupFailedForObject (   $a_obj_id,
  $a_user_ids = null 
)
static

Get failed users for object.

Parameters
int$a_obj_id
array$a_user_ids
Returns
array

Reimplemented from ilLPStatus.

Definition at line 209 of file class.ilLPStatusObjectives.php.

{
return array();
}
static ilLPStatusObjectives::_lookupInProgressForObject (   $a_obj_id,
  $a_user_ids = null 
)
static

Get in progress users for object.

Parameters
int$a_obj_id
array$a_user_ids
Returns
array

Reimplemented from ilLPStatus.

Definition at line 221 of file class.ilLPStatusObjectives.php.

References ilLPStatus\_lookupStatusForObject(), getMembers(), and LP_STATUS_IN_PROGRESS_NUM.

{
if(!$a_user_ids)
{
$a_user_ids = self::getMembers($a_obj_id);
if(!$a_user_ids)
{
return array();
}
}
return self::_lookupStatusForObject($a_obj_id, LP_STATUS_IN_PROGRESS_NUM, $a_user_ids);
}

+ Here is the call graph for this function:

ilLPStatusObjectives::determineStatus (   $a_obj_id,
  $a_user_id,
  $a_obj = null 
)

Determine status.

Parameters
integerobject id
integeruser id
objectobject (optional depends on object type)
Returns
integer status

Reimplemented from ilLPStatus.

Definition at line 126 of file class.ilLPStatusObjectives.php.

References ilCourseObjective\_getObjectiveIds(), ilChangeEvent\hasAccessed(), LP_STATUS_COMPLETED_NUM, LP_STATUS_IN_PROGRESS_NUM, and LP_STATUS_NOT_ATTEMPTED_NUM.

{
global $ilObjDataCache, $ilDB;
// the status completed depends on:
// $status_info['num_objectives'] (ilLPStatusWrapper::_getStatusInfo($a_obj_id);)
// - ilCourseObjective::_getObjectiveIds($a_obj_id);
// - table crs_objectives manipulated in
// - ilCourseObjective
// $status_info['objective_result'] (ilLPStatusWrapper::_getStatusInfo($a_obj_id);)
// table crs_objective_status (must not contain a dataset)
// ilCourseObjectiveResult -> added ilLPStatusWrapper::_updateStatus()
$status = LP_STATUS_NOT_ATTEMPTED_NUM;
switch ($ilObjDataCache->lookupType($a_obj_id))
{
case "crs":
include_once("./Services/Tracking/classes/class.ilChangeEvent.php");
if (ilChangeEvent::hasAccessed($a_obj_id, $a_user_id))
{
$status = LP_STATUS_IN_PROGRESS_NUM;
include_once 'Modules/Course/classes/class.ilCourseObjective.php';
$objectives = ilCourseObjective::_getObjectiveIds($a_obj_id);
if ($objectives)
{
$set = $ilDB->query("SELECT count(objective_id) cnt FROM crs_objective_status ".
"WHERE ".$ilDB->in('objective_id',$objectives, false,'integer').
" AND user_id = ".$ilDB->quote($a_user_id, "integer"));
if ($rec = $ilDB->fetchAssoc($set))
{
if ($rec["cnt"] == count($objectives))
{
$status = LP_STATUS_COMPLETED_NUM;
}
}
}
}
break;
}
return $status;
}

+ Here is the call graph for this function:

static ilLPStatusObjectives::getMembers (   $a_obj_id)
staticprotected

Get members for object.

Parameters
int$a_obj_id
Returns
array

Definition at line 175 of file class.ilLPStatusObjectives.php.

References ilCourseParticipants\_getInstanceByObjId().

Referenced by _getNotAttempted(), _lookupCompletedForObject(), and _lookupInProgressForObject().

{
include_once 'Modules/Course/classes/class.ilCourseParticipants.php';
$member_obj = ilCourseParticipants::_getInstanceByObjId($a_obj_id);
return $member_obj->getMembers();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilLPStatusObjectives::ilLPStatusObjectives (   $a_obj_id)

Definition at line 19 of file class.ilLPStatusObjectives.php.

References ilLPStatus\ilLPStatus().

{
global $ilDB;
parent::ilLPStatus($a_obj_id);
$this->db =& $ilDB;
}

+ Here is the call graph for this function:

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