Inheritance diagram for ilLPStatusPlugin:

Collaboration diagram for ilLPStatusPlugin:

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	_getNotAttempted (int $a_obj_id)

static	_getInProgress (int $a_obj_id)

static	_getCompleted (int $a_obj_id)

static	_getFailed (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 (string $type, int $obj_id, int $sub_id=0)

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	initPluginObj (int $a_obj_id)
	Get ilObjectPlugin for object id. More...

static	getLPStatusData (int $a_obj_id, int $a_status)
	Read existing LP status data. More...

static	getLPDataForUser (int $a_obj_id, int $a_user_id)
	Read existing LP status data for user. More...

static	getPercentageForUser (int $a_obj_id, int $a_user_id)

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

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

Member Function Documentation

◆ _getCompleted()

static ilLPStatusPlugin::_getCompleted ( int $a_obj_id )

static

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

References XapiProxy\$plugin, and ilPluginLP\INACTIVE_PLUGIN.

                                                        : array
     {
         $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 ( int $a_obj_id )

static

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

References XapiProxy\$plugin, and ilPluginLP\INACTIVE_PLUGIN.

                                                     : array
     {
         $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 ( int $a_obj_id )

static

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

References XapiProxy\$plugin, and ilPluginLP\INACTIVE_PLUGIN.

                                                         : array
     {
         $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 ( int $a_obj_id )

static

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

References XapiProxy\$plugin, and ilPluginLP\INACTIVE_PLUGIN.

                                                           : array
     {
         $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	(	int	$a_obj_id,
		int	$a_usr_id,
		?object	$a_obj = `null`
	)

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

References XapiProxy\$plugin, and ilPluginLP\INACTIVE_PLUGIN.

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

◆ determineStatus()

ilLPStatusPlugin::determineStatus	(	int	$a_obj_id,
		int	$a_usr_id,
		?object	$a_obj = `null`
	)

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

References XapiProxy\$plugin, and ilPluginLP\INACTIVE_PLUGIN.

      : int {
         $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_usr_id);
             } else {
                 // re-use existing data for inactive plugin
                 return self::getLPDataForUser($a_obj_id, $a_usr_id);
             }
         }
         // #11368
         return self::LP_STATUS_NOT_ATTEMPTED_NUM;
     }

◆ getLPDataForUser()

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

staticprotected

Read existing LP status data for user.

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

References $DIC, and $ilDB.

      : int {
         global $DIC;
 
         $ilDB = $DIC['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	(	int	$a_obj_id,
		int	$a_status
	)

staticprotected

Read existing LP status data.

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

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

      : array {
         global $DIC;
 
         $ilDB = $DIC['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[] = (int) $row["usr_id"];
         }
         return $all;
     }

Here is the call graph for this function:

◆ getPercentageForUser()

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

staticprotected

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

References $DIC, and $ilDB.

      : int {
         global $DIC;
 
         $ilDB = $DIC['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"] ?? 0);
     }

◆ initPluginObj()

static ilLPStatusPlugin::initPluginObj ( int $a_obj_id )

staticprotected

Get ilObjectPlugin for object id.

Parameters

int $a_obj_id

Returns: ilObjectPlugin|int

Todo:: refactor return type

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

References ilObjectLP\getInstance().

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

components/ILIAS/Tracking/classes/status/class.ilLPStatusPlugin.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _getCompleted()

◆ _getFailed()

◆ _getInProgress()

◆ _getNotAttempted()

◆ determinePercentage()

◆ determineStatus()

◆ getLPDataForUser()

◆ getLPStatusData()

◆ getPercentageForUser()

◆ initPluginObj()