ILIAS  Release_4_4_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Protected Member Functions
ilLPStatusPlugin Class Reference
+ Inheritance diagram for ilLPStatusPlugin:
+ Collaboration diagram for ilLPStatusPlugin:

Public Member Functions

 _getNotAttempted ($a_obj_id)
 _getInProgress ($a_obj_id)
 _getCompleted ($a_obj_id)
 _getFailed ($a_obj_id)
 determineStatus ($a_obj_id, $a_user_id, $a_obj=null)
 Determine status.
 determinePercentage ($a_obj_id, $a_user_id, $a_obj=null)
 Determine percentage.
- Public Member Functions inherited from ilLPStatus
 ilLPStatus ($a_obj_id)
 _getCountNotAttempted ($a_obj_id)
 _getCountInProgress ($a_obj_id)
 _getCountCompleted ($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_no_raise=false, $a_force_raise=false)
 New status handling (st: status, nr: accesses, p: percentage, t: time spent, m: mark)
 refreshStatus ($a_obj_id, $a_users=null)
 Refresh status.
 _lookupStatusChanged ($a_obj_id, $a_user_id)
 Lookup status changed.

Static Protected Member Functions

static initPluginObj ($a_obj_id)
 Get ilObjectPlugin for object id.
static getLPStatusData ($a_obj_id, $a_status)
 Read existing LP status data.
static getLPDataForUser ($a_obj_id, $a_user_id)
 Read existing LP status data for user.
static getPercentageForUser ($a_obj_id, $a_user_id)
- 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

- 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 _lookupStatus ($a_obj_id, $a_user_id)
 Lookup status.
static _hasUserCompleted ($a_obj_id, $a_user_id)
 Lookup user object completion.
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 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

Definition at line 13 of file class.ilLPStatusPlugin.php.

Member Function Documentation

ilLPStatusPlugin::_getCompleted (   $a_obj_id)

Reimplemented from ilLPStatus.

Definition at line 64 of file class.ilLPStatusPlugin.php.

References getLPStatusData(), ilPluginLP\INACTIVE_PLUGIN, and initPluginObj().

{
$plugin = self::initPluginObj($a_obj_id);
if($plugin)
{
if($plugin !== ilPluginLP::INACTIVE_PLUGIN)
{
return (array)$plugin->getLPCompleted();
}
else
{
// re-use existing data for inactive plugin
return self::getLPStatusData($a_obj_id, self::LP_STATUS_COMPLETED_NUM);
}
}
return array();
}

+ Here is the call graph for this function:

ilLPStatusPlugin::_getFailed (   $a_obj_id)

Reimplemented from ilLPStatus.

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

References getLPStatusData(), ilPluginLP\INACTIVE_PLUGIN, and initPluginObj().

{
$plugin = self::initPluginObj($a_obj_id);
if($plugin)
{
if($plugin !== ilPluginLP::INACTIVE_PLUGIN)
{
return (array)$plugin->getLPFailed();
}
else
{
// re-use existing data for inactive plugin
return self::getLPStatusData($a_obj_id, self::LP_STATUS_FAILED_NUM);
}
}
return array();
}

+ Here is the call graph for this function:

ilLPStatusPlugin::_getInProgress (   $a_obj_id)

Reimplemented from ilLPStatus.

Definition at line 46 of file class.ilLPStatusPlugin.php.

References getLPStatusData(), ilPluginLP\INACTIVE_PLUGIN, and initPluginObj().

{
$plugin = self::initPluginObj($a_obj_id);
if($plugin)
{
if($plugin !== ilPluginLP::INACTIVE_PLUGIN)
{
return (array)$plugin->getLPInProgress();
}
else
{
// re-use existing data for inactive plugin
return self::getLPStatusData($a_obj_id, self::LP_STATUS_IN_PROGRESS_NUM);
}
}
return array();
}

+ Here is the call graph for this function:

ilLPStatusPlugin::_getNotAttempted (   $a_obj_id)

Reimplemented from ilLPStatus.

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

References getLPStatusData(), ilPluginLP\INACTIVE_PLUGIN, and initPluginObj().

{
$plugin = self::initPluginObj($a_obj_id);
if($plugin)
{
if($plugin !== ilPluginLP::INACTIVE_PLUGIN)
{
return (array)$plugin->getLPNotAttempted();
}
else
{
// re-use existing data for inactive plugin
return self::getLPStatusData($a_obj_id, self::LP_STATUS_NOT_ATTEMPTED_NUM);
}
}
return array();
}

+ Here is the call graph for this function:

ilLPStatusPlugin::determinePercentage (   $a_obj_id,
  $a_usr_id,
  $a_obj = null 
)

Determine percentage.

Parameters
@return

Reimplemented from ilLPStatus.

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

References getPercentageForUser(), ilPluginLP\INACTIVE_PLUGIN, and initPluginObj().

{
$plugin = self::initPluginObj($a_obj_id);
if($plugin)
{
if($plugin !== ilPluginLP::INACTIVE_PLUGIN)
{
if (method_exists($plugin, "getPercentageForUser"))
{
return $plugin->getPercentageForUser($a_user_id);
}
}
// re-use existing data for inactive plugin
return self::getPercentageForUser($a_obj_id, $a_user_id);
}
// #11368
return 0;
}

+ Here is the call graph for this function:

ilLPStatusPlugin::determineStatus (   $a_obj_id,
  $a_usr_id,
  $a_obj = null 
)

Determine status.

Parameters
@return

Reimplemented from ilLPStatus.

Definition at line 100 of file class.ilLPStatusPlugin.php.

References getLPDataForUser(), ilPluginLP\INACTIVE_PLUGIN, initPluginObj(), and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

{
$plugin = self::initPluginObj($a_obj_id);
if($plugin)
{
if($plugin !== ilPluginLP::INACTIVE_PLUGIN)
{
// :TODO: create read_event here to make sure?
return $plugin->getLPStatusForUser($a_user_id);
}
else
{
// re-use existing data for inactive plugin
return self::getLPDataForUser($a_obj_id, $a_user_id);
}
}
// #11368
return self::LP_STATUS_NOT_ATTEMPTED_NUM;
}

+ Here is the call graph for this function:

static ilLPStatusPlugin::getLPDataForUser (   $a_obj_id,
  $a_user_id 
)
staticprotected

Read existing LP status data for user.

Parameters
int$a_obj_id
int$a_user_id
Returns
int

Definition at line 170 of file class.ilLPStatusPlugin.php.

References $row, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

Referenced by determineStatus().

{
global $ilDB;
$set = $ilDB->query("SELECT status".
" FROM ut_lp_marks".
" WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer").
" AND usr_id = ".$ilDB->quote($a_user_id, "integer"));
$row = $ilDB->fetchAssoc($set);
$status = $row["status"];
if(!$status)
{
$status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
}
return $status;
}

+ Here is the caller graph for this function:

static ilLPStatusPlugin::getLPStatusData (   $a_obj_id,
  $a_status 
)
staticprotected

Read existing LP status data.

Parameters
int$a_obj_id
int$a_status
Returns
array user ids

Definition at line 146 of file class.ilLPStatusPlugin.php.

References $row.

Referenced by _getCompleted(), _getFailed(), _getInProgress(), and _getNotAttempted().

{
global $ilDB;
$all = array();
$set = $ilDB->query("SELECT usr_id".
" FROM ut_lp_marks".
" WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer").
" AND status = ".$ilDB->quote($a_status, "integer"));
while($row = $ilDB->fetchAssoc($set))
{
$all[] = $row["usr_id"];
}
return $all;
}

+ Here is the caller graph for this function:

static ilLPStatusPlugin::getPercentageForUser (   $a_obj_id,
  $a_user_id 
)
staticprotected

Definition at line 187 of file class.ilLPStatusPlugin.php.

References $row.

Referenced by determinePercentage().

{
global $ilDB;
$set = $ilDB->query("SELECT percentage".
" FROM ut_lp_marks".
" WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer").
" AND usr_id = ".$ilDB->quote($a_user_id, "integer"));
$row = $ilDB->fetchAssoc($set);
return (int) $row["percentage"];
}

+ Here is the caller graph for this function:

static ilLPStatusPlugin::initPluginObj (   $a_obj_id)
staticprotected

Get ilObjectPlugin for object id.

Parameters
int$a_obj_id
Returns
ilObjectPlugin

Definition at line 21 of file class.ilLPStatusPlugin.php.

References ilObjectLP\getInstance().

Referenced by _getCompleted(), _getFailed(), _getInProgress(), _getNotAttempted(), determinePercentage(), and determineStatus().

{
include_once "Services/Object/classes/class.ilObjectLP.php";
$olp = ilObjectLP::getInstance($a_obj_id);
return $olp->getPluginInstance();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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