Collaboration diagram for ilLPMarks:

Public Member Functions
	__construct (int $a_obj_id, int $a_usr_id)

	getUserId ()

	setMark (string $a_mark)

	getMark ()

	setComment (string $a_comment)

	getComment ()

	setCompleted (bool $a_status)

	getCompleted ()

	getStatusChanged ()

	getObjId ()

	update ()

	__read ()

	__add ()

Static Public Member Functions
static	deleteObject (int $a_obj_id)

static	_hasCompleted (int $a_usr_id, int $a_obj_id)

static	getCompletionsOfUser (int $user_id, string $from, string $to)

static	_lookupMark (int $a_usr_id, int $a_obj_id)

static	_lookupComment (int $a_usr_id, int $a_obj_id)

static	_deleteForUsers (int $a_obj_id, array $a_user_ids)

static	_getAllUserIds (int $a_obj_id)

Protected Attributes
ilDBInterface	$db

ilObjectDataCache	$ilObjectDataCache

int	$obj_id

int	$usr_id

string	$obj_type

bool	$completed = false

string	$comment = ''

string	$mark = ''

string	$status_changed = ''

	$has_entry = false

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilLPMarks::__construct	(	int	$a_obj_id,
		int	$a_usr_id
	)

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

References $DIC, __read(), and ilObjectDataCache\lookupType().

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

Here is the call graph for this function:

Member Function Documentation

◆ __add()

ilLPMarks::__add ( )

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

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

Referenced by update().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __read()

ilLPMarks::__read ( )

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

References $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _deleteForUsers()

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

static

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

References $DIC, and $ilDB.

Referenced by ilObjectLP\resetLPDataForUserIds().

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

static

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

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

Referenced by ilObjectLP\gatherLPUsers().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _hasCompleted()

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

static

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

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

Referenced by ilLearningProgressBaseGUI\__appendLPDetails(), ilContentPageKioskModeView\buildLearningProgressToggleControl(), and ilLearningModuleKioskModeView\maybeBuildLearningProgressToggleControl().

                                                                       : bool
     {
         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	(	int	$a_usr_id,
		int	$a_obj_id
	)

static

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

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

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

                                                                        : string
     {
         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 (string) $row->u_comment;
         }
         return '';
     }

Here is the caller graph for this function:

◆ _lookupMark()

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

static

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

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

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

                                                                     : string
     {
         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 (string) $row->mark;
         }
         return '';
     }

Here is the caller graph for this function:

◆ deleteObject()

static ilLPMarks::deleteObject ( int $a_obj_id )

static

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

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

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

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

Here is the caller graph for this function:

◆ getComment()

ilLPMarks::getComment ( )

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

References $comment.

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

                                 : string
     {
         return $this->comment;
     }

Here is the caller graph for this function:

◆ getCompleted()

ilLPMarks::getCompleted ( )

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

References $completed.

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

                                   : bool
     {
         return $this->completed;
     }

Here is the caller graph for this function:

◆ getCompletionsOfUser()

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

static

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

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

Referenced by ilTrackingLearningHistoryProvider\getEntries().

      : array {
         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)) {
             $completion = [
                 'obj_id' => (int) $rec['obj_id'],
                 'usr_id' => (int) $rec['usr_id'],
                 'completed' => (bool) $rec['completed'],
                 'mark' => (string) $rec['mark'],
                 'comment' => (string) $rec['u_comment'],
                 'status' => (int) $rec['status'],
                 'status_changed' => (string) $rec['status_changed'],
                 'status_dirty' => (int) $rec['status_changed'],
                 'percentage' => (int) $rec['percentage']
             ];
             $completions[] = $completion;
         }
         return $completions;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMark()

ilLPMarks::getMark ( )

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

References $mark.

Referenced by __add(), and update().

                              : string
     {
         return $this->mark;
     }

Here is the caller graph for this function:

◆ getObjId()

ilLPMarks::getObjId ( )

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

References $obj_id.

Referenced by __add(), and update().

                               : int
     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getStatusChanged()

ilLPMarks::getStatusChanged ( )

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

References $status_changed.

                                       : string
     {
         return $this->status_changed;
     }

◆ getUserId()

ilLPMarks::getUserId ( )

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

References $usr_id.

Referenced by __add(), and update().

                                : int
     {
         return $this->usr_id;
     }

Here is the caller graph for this function:

◆ setComment()

ilLPMarks::setComment ( string $a_comment )

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

References ILIAS\UI\examples\Symbol\Glyph\Comment\comment().

                                                  : void
     {
         $this->comment = $a_comment;
     }

Here is the call graph for this function:

◆ setCompleted()

ilLPMarks::setCompleted ( bool $a_status )

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

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

                                                 : void
     {
         $this->completed = $a_status;
     }

Here is the caller graph for this function:

◆ setMark()

ilLPMarks::setMark ( string $a_mark )

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

                                            : void
     {
         $this->mark = $a_mark;
     }

◆ update()

ilLPMarks::update ( )

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

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

                             : void
     {
         if (!$this->has_entry) {
             $this->__add();
         }
         $query = "UPDATE ut_lp_marks " .
             "SET mark = " . $this->db->quote($this->getMark(), 'text') . ", " .
             "u_comment = " . $this->db->quote(
                 $this->getComment(),
                 'text'
             ) . ", " .
             "completed = " . $this->db->quote(
                 $this->getCompleted(),
                 'integer'
             ) . " " .
             "WHERE obj_id = " . $this->db->quote(
                 $this->getObjId(),
                 'integer'
             ) . " " .
             "AND usr_id = " . $this->db->quote($this->getUserId(), 'integer');
         $res = $this->db->manipulate($query);
     }

Here is the call graph for this function:

Field Documentation

◆ $comment

string ilLPMarks::$comment = ''

protected

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

Referenced by getComment().

◆ $completed

bool ilLPMarks::$completed = false

protected

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

Referenced by getCompleted().

◆ $db

ilDBInterface ilLPMarks::$db

protected

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

◆ $has_entry

ilLPMarks::$has_entry = false

protected

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

◆ $ilObjectDataCache

ilObjectDataCache ilLPMarks::$ilObjectDataCache

protected

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

◆ $mark

string ilLPMarks::$mark = ''

protected

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

Referenced by getMark().

◆ $obj_id

int ilLPMarks::$obj_id

protected

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

Referenced by getObjId().

◆ $obj_type

string ilLPMarks::$obj_type

protected

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

◆ $status_changed

string ilLPMarks::$status_changed = ''

protected

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

Referenced by getStatusChanged().

◆ $usr_id

int ilLPMarks::$usr_id

protected

Definition at line 36 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

Protected Attributes

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

◆ $ilObjectDataCache

◆ $mark

◆ $obj_id

◆ $obj_type

◆ $status_changed

◆ $usr_id