ilLPStatusPlugin Class Reference

Inheritance diagram for ilLPStatusPlugin:

Collaboration diagram for ilLPStatusPlugin:

Public Member Functions
	determineStatus ($a_obj_id, $a_user_id, $a_obj=null)
	determinePercentage ($a_obj_id, $a_user_id, $a_obj=null)
Public Member Functions inherited from ilLPStatus
	__construct ($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...

Static Public Member Functions
static	_getNotAttempted ($a_obj_id)
static	_getInProgress ($a_obj_id)
static	_getCompleted ($a_obj_id)
static	_getFailed ($a_obj_id)
Static Public Member Functions inherited from ilLPStatus
static	_getCountNotAttempted ($a_obj_id)
static	_getNotAttempted ($a_obj_id)
static	_getCountInProgress ($a_obj_id)
static	_getInProgress ($a_obj_id)
static	_getCountCompleted ($a_obj_id)
static	_getCompleted ($a_obj_id)
static	_getFailed ($a_obj_id)
static	_getCountFailed ()
static	_getStatusInfo ($a_obj_id)
static	_getTypicalLearningTime ($a_obj_id)
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	_lookupStatusChanged ($a_obj_id, $a_user_id)
	Lookup status changed. 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, $a_image_only=false)

Static Protected Member Functions
static	initPluginObj ($a_obj_id)
	Get ilObjectPlugin for object id. More...
static	getLPStatusData ($a_obj_id, $a_status)
	Read existing LP status data. More...
static	getLPDataForUser ($a_obj_id, $a_user_id)
	Read existing LP status data for user. More...
static	getPercentageForUser ($a_obj_id, $a_user_id)
Static Protected Member Functions inherited from ilLPStatus
static	raiseEvent ($a_obj_id, $a_usr_id, $a_status, $a_percentage)
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
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

Detailed Description

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

Member Function Documentation

_getCompleted()

static ilLPStatusPlugin::_getCompleted (   $a_obj_id )

static

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

References array, and ilPluginLP\INACTIVE_PLUGIN.

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

_getFailed()

static ilLPStatusPlugin::_getFailed (   $a_obj_id )

static

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

References array, and ilPluginLP\INACTIVE_PLUGIN.

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

_getInProgress()

static ilLPStatusPlugin::_getInProgress (   $a_obj_id )

static

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

References array, and ilPluginLP\INACTIVE_PLUGIN.

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

_getNotAttempted()

static ilLPStatusPlugin::_getNotAttempted (   $a_obj_id )

static

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

References array, and ilPluginLP\INACTIVE_PLUGIN.

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

determinePercentage()

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

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

References ilPluginLP\INACTIVE_PLUGIN.

    {
        $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;
    }

determineStatus()

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

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

References ilPluginLP\INACTIVE_PLUGIN.

    {
        $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;
    }

getLPDataForUser()

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 146 of file class.ilLPStatusPlugin.php.

References $ilDB, and $row.

    {
        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;
    }

getLPStatusData()

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 123 of file class.ilLPStatusPlugin.php.

References $ilDB, $row, and array.

    {
        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;
    }

getPercentageForUser()

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

staticprotected

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

References $ilDB, and $row.

    {
        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"];
    }

initPluginObj()

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().

    {
        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:

---

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

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