Collaboration diagram for ilLPMarks:

Public Member Functions
	__construct ($a_obj_id, $a_usr_id)

	getUserId ()

	setMark ($a_mark)

	getMark ()

	setComment ($a_comment)

	getComment ()

	setCompleted ($a_status)

	getCompleted ()

	getStatusChanged ()

	getObjId ()

	update ()

	__read ()

	__add ()

Static Public Member Functions
static	deleteObject ($a_obj_id)
	Delete object. More...

static	_hasCompleted ($a_usr_id, $a_obj_id)

static	getCompletionsOfUser ($user_id, $from, $to)
	Get completions of user. More...

static	_lookupMark ($a_usr_id, $a_obj_id)

static	_lookupComment ($a_usr_id, $a_obj_id)

static	_deleteForUsers ($a_obj_id, array $a_user_ids)

static	_getAllUserIds ($a_obj_id)

Data Fields
	$db = null

	$obj_id = null

	$usr_id = null

	$obj_type = null

	$completed = false

	$comment = ''

	$mark = ''

	$status_changed = ''

	$has_entry = false

Detailed Description

Definition at line 36 of file class.ilLPMarks.php.

Constructor & Destructor Documentation

◆ __construct()

ilLPMarks::__construct	(	$a_obj_id,
		$a_usr_id
	)

Definition at line 53 of file class.ilLPMarks.php.

References $DIC, $ilDB, and __read().

     {
         global $DIC;
 
         $ilObjDataCache = $DIC['ilObjDataCache'];
         $ilDB = $DIC['ilDB'];
 
         $this->db = $ilDB;
 
         $this->obj_id = $a_obj_id;
         $this->usr_id = $a_usr_id;
         $this->obj_type = $ilObjDataCache->lookupType($this->obj_id);
 
         $this->__read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ __add()

ilLPMarks::__add ( )

Definition at line 249 of file class.ilLPMarks.php.

References $DIC, $ilDB, $query, $res, getComment(), getCompleted(), getMark(), getObjId(), and getUserId().

Referenced by update().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         $query = "INSERT INTO ut_lp_marks (mark,u_comment, completed,obj_id,usr_id) " .
             "VALUES( " .
             $ilDB->quote($this->getMark(), 'text') . ", " .
             $ilDB->quote($this->getComment(), 'text') . ", " .
             $ilDB->quote($this->getCompleted(), 'integer') . ", " .
             $ilDB->quote($this->getObjId(), 'integer') . ", " .
             $ilDB->quote($this->getUserId(), 'integer') . " " .
             ")";
         $res = $ilDB->manipulate($query);
         $this->has_entry = true;
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __read()

ilLPMarks::__read ( )

Definition at line 227 of file class.ilLPMarks.php.

References $DIC, $ilDB, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by __construct().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         $res = $this->db->query("SELECT * FROM ut_lp_marks " .
                                 "WHERE obj_id = " . $this->db->quote($this->obj_id, 'integer') . " " .
                                 "AND usr_id = " . $ilDB->quote($this->usr_id, 'integer'));
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->has_entry = true;
             $this->completed = (int) $row->completed;
             $this->comment = $row->u_comment;
             $this->mark = $row->mark;
             $this->status_changed = $row->status_changed;
 
             return true;
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ _deleteForUsers()

static ilLPMarks::_deleteForUsers	(		$a_obj_id,
		array	$a_user_ids
	)

static

Definition at line 269 of file class.ilLPMarks.php.

References $DIC, and $ilDB.

Referenced by ilObjectLP\resetLPDataForUserIds().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         $ilDB->manipulate("DELETE FROM ut_lp_marks" .
             " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer") .
             " AND " . $ilDB->in("usr_id", $a_user_ids, "", "integer"));
     }

Here is the caller graph for this function:

◆ _getAllUserIds()

static ilLPMarks::_getAllUserIds ( $a_obj_id )

static

Definition at line 280 of file class.ilLPMarks.php.

References $DIC, $ilDB, $res, and $row.

Referenced by ilObjectLP\gatherLPUsers().

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

Here is the caller graph for this function:

◆ _hasCompleted()

static ilLPMarks::_hasCompleted	(	$a_usr_id,
		$a_obj_id
	)

static

Definition at line 145 of file class.ilLPMarks.php.

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilContentPageKioskModeView\builtLearningProgressToggleControl(), and ilInfoScreenGUI\showLearningProgress().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "SELECT * FROM ut_lp_marks " .
             "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
             "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer');
 
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return (bool) $row->completed;
         }
         return false;
     }

Here is the caller graph for this function:

◆ _lookupComment()

static ilLPMarks::_lookupComment	(	$a_usr_id,
		$a_obj_id
	)

static

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

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilLearningProgressBaseGUI\__appendLPDetails(), ilWikiContributorsTableGUI\fillRow(), ilExGradesTableGUI\fillRow(), ilObjWikiGUI\infoScreen(), ilObjExerciseGUI\infoScreen(), and ilTrackingTest\testLPMarks().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "SELECT * FROM ut_lp_marks " .
             "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
             "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer');
 
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return $row->u_comment;
         }
         return '';
     }

Here is the caller graph for this function:

◆ _lookupMark()

static ilLPMarks::_lookupMark	(	$a_usr_id,
		$a_obj_id
	)

static

Definition at line 191 of file class.ilLPMarks.php.

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilLearningProgressBaseGUI\__appendLPDetails(), ilObjExercise\exportGradesExcel(), ilWikiContributorsTableGUI\fillRow(), ilExGradesTableGUI\fillRow(), ilExerciseCertificateAdapter\getCertificateVariablesForPresentation(), ilScormMailTemplateLPContext\getDescription(), ilCourseMailTemplateTutorContext\getDescription(), ilObjWikiGUI\infoScreen(), ilObjExerciseGUI\infoScreen(), and ilCertificateLPMarksHelper\lookUpMark().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "SELECT * FROM ut_lp_marks " .
             "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
             "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer');
 
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return $row->mark;
         }
         return '';
     }

Here is the caller graph for this function:

◆ deleteObject()

static ilLPMarks::deleteObject ( $a_obj_id )

static

Delete object.

Definition at line 74 of file class.ilLPMarks.php.

References $DIC, $ilDB, $query, and $res.

Referenced by ilEventParticipants\_deleteByEvent(), ilObjectLP\handleDelete(), and ilTrackingTest\testLPMarks().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         $query = "DELETE FROM ut_lp_marks " .
             "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer');
         $res = $ilDB->manipulate($query);
         return true;
     }

Here is the caller graph for this function:

◆ getComment()

ilLPMarks::getComment ( )

Definition at line 103 of file class.ilLPMarks.php.

References $comment.

Referenced by __add(), ilObjWikiGUI\saveGradingObject(), and update().

     {
         return $this->comment;
     }

Here is the caller graph for this function:

◆ getCompleted()

ilLPMarks::getCompleted ( )

Definition at line 111 of file class.ilLPMarks.php.

References $completed.

Referenced by __add(), ilContentPageKioskModeView\toggleLearningProgress(), and update().

     {
         return $this->completed;
     }

Here is the caller graph for this function:

◆ getCompletionsOfUser()

static ilLPMarks::getCompletionsOfUser	(	$user_id,
		$from,
		$to
	)

static

Get completions of user.

Parameters

$user_id
$from
$to

Returns: array

Definition at line 169 of file class.ilLPMarks.php.

References $DIC, $from, $ilDB, $query, and ilLPStatus\LP_STATUS_COMPLETED_NUM.

Referenced by ilTrackingLearningHistoryProvider\getEntries().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "SELECT * FROM ut_lp_marks " .
             "WHERE usr_id = " . $ilDB->quote($user_id, 'integer') .
             " AND status = " . $ilDB->quote(ilLPStatus::LP_STATUS_COMPLETED_NUM, 'integer') .
             " AND status_changed >= " . $ilDB->quote($from, "timestamp") .
             " AND status_changed <= " . $ilDB->quote($to, "timestamp");
 
         $set = $ilDB->query($query);
         $completions = array();
         while ($rec = $ilDB->fetchAssoc($set)) {
             $completions[] = $rec;
         }
 
         return $completions;
     }

Here is the caller graph for this function:

◆ getMark()

ilLPMarks::getMark ( )

Definition at line 95 of file class.ilLPMarks.php.

References $mark.

Referenced by __add(), and update().

     {
         return $this->mark;
     }

Here is the caller graph for this function:

◆ getObjId()

ilLPMarks::getObjId ( )

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

References $obj_id.

Referenced by __add(), and update().

     {
         return (int) $this->obj_id;
     }

Here is the caller graph for this function:

◆ getStatusChanged()

ilLPMarks::getStatusChanged ( )

Definition at line 115 of file class.ilLPMarks.php.

References $status_changed.

     {
         return $this->status_changed;
     }

◆ getUserId()

ilLPMarks::getUserId ( )

Definition at line 86 of file class.ilLPMarks.php.

References $usr_id.

Referenced by __add(), and update().

     {
         return $this->usr_id;
     }

Here is the caller graph for this function:

◆ setComment()

ilLPMarks::setComment ( $a_comment )

Definition at line 99 of file class.ilLPMarks.php.

References comment().

     {
         $this->comment = $a_comment;
     }

Here is the call graph for this function:

◆ setCompleted()

ilLPMarks::setCompleted ( $a_status )

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

Referenced by ilInfoScreenGUI\saveProgress(), and ilObjCourseGUI\updateLPFromStatus().

     {
         $this->completed = (bool) $a_status;
     }

Here is the caller graph for this function:

◆ setMark()

ilLPMarks::setMark ( $a_mark )

Definition at line 91 of file class.ilLPMarks.php.

     {
         $this->mark = $a_mark;
     }

◆ update()

ilLPMarks::update ( )

Definition at line 125 of file class.ilLPMarks.php.

References $DIC, $ilDB, $query, $res, __add(), getComment(), getCompleted(), getMark(), getObjId(), and getUserId().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         
         if (!$this->has_entry) {
             $this->__add();
         }
         $query = "UPDATE ut_lp_marks " .
             "SET mark = " . $ilDB->quote($this->getMark(), 'text') . ", " .
             "u_comment = " . $ilDB->quote($this->getComment(), 'text') . ", " .
             "completed = " . $ilDB->quote($this->getCompleted(), 'integer') . " " .
             "WHERE obj_id = " . $ilDB->quote($this->getObjId(), 'integer') . " " .
             "AND usr_id = " . $ilDB->quote($this->getUserId(), 'integer');
         $res = $ilDB->manipulate($query);
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $comment

ilLPMarks::$comment = ''

Definition at line 45 of file class.ilLPMarks.php.

Referenced by getComment().

◆ $completed

ilLPMarks::$completed = false

Definition at line 44 of file class.ilLPMarks.php.

Referenced by getCompleted().

◆ $db

ilLPMarks::$db = null

Definition at line 38 of file class.ilLPMarks.php.

◆ $has_entry

ilLPMarks::$has_entry = false

Definition at line 49 of file class.ilLPMarks.php.

◆ $mark

ilLPMarks::$mark = ''

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

Referenced by getMark().

◆ $obj_id

ilLPMarks::$obj_id = null

Definition at line 40 of file class.ilLPMarks.php.

Referenced by getObjId().

◆ $obj_type

ilLPMarks::$obj_type = null

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

◆ $status_changed

ilLPMarks::$status_changed = ''

Definition at line 47 of file class.ilLPMarks.php.

Referenced by getStatusChanged().

◆ $usr_id

ilLPMarks::$usr_id = null

Definition at line 41 of file class.ilLPMarks.php.

Referenced by getUserId().

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

Services/Tracking/classes/class.ilLPMarks.php

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __add()

◆ __read()

◆ _deleteForUsers()

◆ _getAllUserIds()

◆ _hasCompleted()

◆ _lookupComment()

◆ _lookupMark()

◆ deleteObject()

◆ getComment()

◆ getCompleted()

◆ getCompletionsOfUser()

◆ getMark()

◆ getObjId()

◆ getStatusChanged()

◆ getUserId()

◆ setComment()

◆ setCompleted()

◆ setMark()

◆ update()

Field Documentation

◆ $comment

◆ $completed

◆ $db

◆ $has_entry

◆ $mark

◆ $obj_id

◆ $obj_type

◆ $status_changed

◆ $usr_id