Exercise peer review. More...

Collaboration diagram for ilExPeerReview:

Public Member Functions
	__construct (ilExAssignment $a_assignment)

	hasPeerReviewGroups ()

	getReviewId (int $giver_id, int $peer_id)

	initPeerReviews ()

	resetPeerReviews ()

	validatePeerReviewGroups ()

	getPeerReviewValues (int $a_giver_id, int $a_peer_id)

	getPeerReviewsByGiver (int $a_user_id)

	getPeerMaskedId (int $a_giver_id, int $a_peer_id)

	getPeerReviewsByPeerId (int $a_user_id, bool $a_only_valid=false)

	countReceivedFeedbacks (int $user_id, bool $only_valid=true)

	getAllPeerReviews (bool $a_only_valid=true)

	hasPeerReviewAccess (int $a_peer_id)

	updatePeerReviewTimestamp (int $a_peer_id)

	updatePeerReview (int $a_peer_id, array $a_values)

	countGivenFeedback (bool $a_validate=true, int $a_user_id=null)

	getNumberOfMissingFeedbacksForReceived ()

	isFeedbackValidForPassed (int $a_user_id)

Static Public Member Functions
static	lookupGiversWithPendingFeedback (int $a_ass_id)

Protected Member Functions
	getValidPeerReviewUsers ()

	validatePeerReview (array $a_data)

	getMaxPossibleFeedbacks ()

Protected Attributes
InternalDomainService	$domain

ilDBInterface	$db

ilObjUser	$user

ilExAssignment	$assignment

int	$assignment_id

ilLogger	$log

Detailed Description

Exercise peer review.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om; Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilExPeerReview::__construct ( ilExAssignment $a_assignment )

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

References $DIC, ilExAssignment\getId(), ilLoggerFactory\getLogger(), and ILIAS\Repository\user().

       {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->user = $DIC->user();
         $this->assignment = $a_assignment;
         $this->assignment_id = $a_assignment->getId();
         $this->log = ilLoggerFactory::getLogger("exc");
         $this->domain = $DIC->exercise()->internal()->domain();
     }

Here is the call graph for this function:

Member Function Documentation

◆ countGivenFeedback()

ilExPeerReview::countGivenFeedback	(	bool	$a_validate = `true`,
		int	$a_user_id = `null`
	)

Definition at line 398 of file class.ilExPeerReview.php.

References $db, $ilDB, $user, ilObject\getId(), and validatePeerReview().

Referenced by getNumberOfMissingFeedbacksForReceived(), and isFeedbackValidForPassed().

      : int {
         $ilDB = $this->db;
         $ilUser = $this->user;
 
         if (!$a_user_id) {
             $a_user_id = $ilUser->getId();
         }
 
         $cnt = 0;
 
         $set = $ilDB->query("SELECT *" .
             " FROM exc_assignment_peer" .
             " WHERE ass_id = " . $ilDB->quote($this->assignment_id, "integer") .
             " AND giver_id = " . $ilDB->quote($a_user_id, "integer"));
         while ($row = $ilDB->fetchAssoc($set)) {
             if (!$a_validate ||
                 $this->validatePeerReview($row)) {
                 $cnt++;
             }
         }
 
         return $cnt;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ countReceivedFeedbacks()

ilExPeerReview::countReceivedFeedbacks	(	int	$user_id,
		bool	$only_valid = `true`
	)

Definition at line 316 of file class.ilExPeerReview.php.

References getPeerReviewsByPeerId().

      : int {
         return count($this->getPeerReviewsByPeerId($user_id, $only_valid));
     }

Here is the call graph for this function:

◆ getAllPeerReviews()

ilExPeerReview::getAllPeerReviews ( bool $a_only_valid = true )

Definition at line 323 of file class.ilExPeerReview.php.

References $db, $ilDB, $res, $valid, and validatePeerReview().

Referenced by resetPeerReviews(), and validatePeerReviewGroups().

      : array {
         $ilDB = $this->db;
 
         $res = array();
 
         $set = $ilDB->query("SELECT *" .
             " FROM exc_assignment_peer" .
             " WHERE ass_id = " . $ilDB->quote($this->assignment_id, "integer") .
             " ORDER BY peer_id");
         while ($row = $ilDB->fetchAssoc($set)) {
             $valid = $this->validatePeerReview($row);
             if (!$a_only_valid ||
                 $valid) {
                 $res[$row["peer_id"]][$row["giver_id"]] = $valid;
             }
         }
 
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaxPossibleFeedbacks()

ilExPeerReview::getMaxPossibleFeedbacks ( )

protected

Definition at line 425 of file class.ilExPeerReview.php.

Referenced by getNumberOfMissingFeedbacksForReceived(), and isFeedbackValidForPassed().

                                                 : int
     {
         return (count($this->domain->submission($this->assignment_id)->getUsersWithSubmission()) - 1);
     }

Here is the caller graph for this function:

◆ getNumberOfMissingFeedbacksForReceived()

ilExPeerReview::getNumberOfMissingFeedbacksForReceived ( )

Definition at line 430 of file class.ilExPeerReview.php.

References countGivenFeedback(), and getMaxPossibleFeedbacks().

                                                             : int
     {
         $max = $this->getMaxPossibleFeedbacks();
 
         // #16160 - forever alone
         if ($max === 0) {
             return 0;
         }
 
         // are all required or just 1?
         if ($this->assignment->getPeerReviewSimpleUnlock() == 2) {
             $needed = 0;
         } elseif ($this->assignment->getPeerReviewSimpleUnlock() == 0) {
             $needed = $this->assignment->getPeerReviewMin();
         } else {
             $needed = 1;
         }
         // there could be less participants than stated in the min required setting
         $min = min($max, $needed);
         return max(0, $min - $this->countGivenFeedback());
     }

Here is the call graph for this function:

◆ getPeerMaskedId()

ilExPeerReview::getPeerMaskedId	(	int	$a_giver_id,
		int	$a_peer_id
	)

Definition at line 240 of file class.ilExPeerReview.php.

References getPeerReviewsByGiver().

      : int {
         foreach ($this->getPeerReviewsByGiver($a_giver_id) as $peer) {
             if ($peer["peer_id"] == $a_peer_id) {
                 return (int) $peer["seq"];
             }
         }
         return 0;
     }

Here is the call graph for this function:

◆ getPeerReviewsByGiver()

ilExPeerReview::getPeerReviewsByGiver ( int $a_user_id )

Definition at line 218 of file class.ilExPeerReview.php.

References $db, $ilDB, $res, and initPeerReviews().

Referenced by getPeerMaskedId(), and getPeerReviewValues().

                                                          : array
     {
         $ilDB = $this->db;
 
         $res = array();
 
         if ($this->initPeerReviews()) {
             $idx = 0;
             $set = $ilDB->query("SELECT *" .
                 " FROM exc_assignment_peer" .
                 " WHERE giver_id = " . $ilDB->quote($a_user_id, "integer") .
                 " AND ass_id = " . $ilDB->quote($this->assignment_id, "integer") .
                 " ORDER BY peer_id");
             while ($row = $ilDB->fetchAssoc($set)) {
                 $row["seq"] = ++$idx;
                 $res[] = $row;
             }
         }
 
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPeerReviewsByPeerId()

ilExPeerReview::getPeerReviewsByPeerId	(	int	$a_user_id,
		bool	$a_only_valid = `false`
	)

Definition at line 289 of file class.ilExPeerReview.php.

References $db, $ilDB, $res, and validatePeerReview().

Referenced by countReceivedFeedbacks().

      : array {
         $ilDB = $this->db;
 
         $res = array();
 
         $idx = 0;
         $set = $ilDB->query("SELECT *" .
             " FROM exc_assignment_peer" .
             " WHERE peer_id = " . $ilDB->quote($a_user_id, "integer") .
             " AND ass_id = " . $ilDB->quote($this->assignment_id, "integer") .
             " ORDER BY peer_id");
         while ($row = $ilDB->fetchAssoc($set)) {
             if (!$a_only_valid ||
                 $this->validatePeerReview($row)) {
                 // this would be correct but rather senseless
                 // $row["seq"] = $this->getPeerMaskedId($row["giver_id"], $a_user_id);
                 $row["seq"] = ++$idx;
                 $res[] = $row;
             }
         }
 
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPeerReviewValues()

ilExPeerReview::getPeerReviewValues	(	int	$a_giver_id,
		int	$a_peer_id
	)

Definition at line 193 of file class.ilExPeerReview.php.

References $data, and getPeerReviewsByGiver().

      : array {
         $peer = null;
         foreach ($this->getPeerReviewsByGiver($a_giver_id) as $item) {
             if ($item["peer_id"] == $a_peer_id) {
                 $peer = $item;
             }
         }
         if (!$peer) {
             return [];
         }
         $data = $peer["pcomment"];
         if ($data) {
             $items = unserialize($data, ['allowed_classes' => false]);
             if (!is_array($items)) {
                 // v1 - pcomment == text
                 $items = array("text" => $data);
             }
             return $items;
         }
         return [];
     }

Here is the call graph for this function:

◆ getReviewId()

ilExPeerReview::getReviewId	(	int	$giver_id,
		int	$peer_id
	)

Definition at line 61 of file class.ilExPeerReview.php.

                                                             : int
     {
         $set = $this->db->queryF(
             "SELECT id FROM exc_assignment_peer " .
             " WHERE ass_id = %s AND giver_id = %s  AND peer_id = %s",
             ["integer","integer","integer"],
             [$this->assignment_id, $giver_id, $peer_id]
         );
         $rec = $this->db->fetchAssoc($set);
         return $rec["id"] ?? 0;
     }

◆ getValidPeerReviewUsers()

ilExPeerReview::getValidPeerReviewUsers ( )

protected

Returns: int[]

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

Referenced by initPeerReviews(), and validatePeerReviewGroups().

                                                 : array
     {
         return $this->domain->submission($this->assignment_id)->getUsersWithSubmission();
     }

Here is the caller graph for this function:

◆ hasPeerReviewAccess()

ilExPeerReview::hasPeerReviewAccess ( int $a_peer_id )

Definition at line 345 of file class.ilExPeerReview.php.

References $db, $ilDB, and $user.

      : bool {
         $ilDB = $this->db;
         $ilUser = $this->user;
 
         $set = $ilDB->query("SELECT ass_id" .
             " FROM exc_assignment_peer" .
             " WHERE giver_id = " . $ilDB->quote($ilUser->getId(), "integer") .
             " AND peer_id = " . $ilDB->quote($a_peer_id, "integer") .
             " AND ass_id = " . $ilDB->quote($this->assignment_id, "integer"));
         $row = $ilDB->fetchAssoc($set);
         return ((int) ($row["ass_id"] ?? 0) > 0);
     }

◆ hasPeerReviewGroups()

ilExPeerReview::hasPeerReviewGroups ( )

Definition at line 50 of file class.ilExPeerReview.php.

References $db, and $ilDB.

Referenced by initPeerReviews(), resetPeerReviews(), and validatePeerReviewGroups().

                                          : bool
     {
         $ilDB = $this->db;
 
         $set = $ilDB->query("SELECT count(*) cnt" .
             " FROM exc_assignment_peer" .
             " WHERE ass_id = " . $ilDB->quote($this->assignment_id, "integer"));
         $cnt = $ilDB->fetchAssoc($set);
         return (bool) $cnt["cnt"];
     }

Here is the caller graph for this function:

◆ initPeerReviews()

ilExPeerReview::initPeerReviews ( )

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

References $db, $ilDB, getValidPeerReviewUsers(), and hasPeerReviewGroups().

Referenced by getPeerReviewsByGiver().

                                      : bool
     {
         $ilDB = $this->db;
 
         // see #22246
         if (!$this->assignment->afterDeadlineStrict()) {
             return false;
         }
 
         if (!$this->hasPeerReviewGroups()) {
             $user_ids = $this->getValidPeerReviewUsers();
 
             $distribution = new ExcPeerReviewDistribution($user_ids, $this->assignment->getPeerReviewMin());
 
             foreach ($user_ids as $rater_id) {
                 foreach ($distribution->getPeersOfRater($rater_id) as $peer_id) {
                     $next_id = $ilDB->nextId("exc_assignment_peer");
                     $ilDB->manipulate("INSERT INTO exc_assignment_peer" .
                         " (id, ass_id, giver_id, peer_id)" .
                         " VALUES (" . $ilDB->quote($next_id, "integer") .
                         ", " . $ilDB->quote($this->assignment_id, "integer") .
                         ", " . $ilDB->quote($rater_id, "integer") .
                         ", " . $ilDB->quote($peer_id, "integer") . ")");
                 }
             }
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isFeedbackValidForPassed()

ilExPeerReview::isFeedbackValidForPassed ( int $a_user_id )

Definition at line 452 of file class.ilExPeerReview.php.

References countGivenFeedback(), getMaxPossibleFeedbacks(), ilExAssignment\PEER_REVIEW_VALID_ALL, ilExAssignment\PEER_REVIEW_VALID_NONE, and ilExAssignment\PEER_REVIEW_VALID_ONE.

                                                             : bool
     {
         // peer feedback is not required for passing
         if ($this->assignment->getPeerReviewValid() == ilExAssignment::PEER_REVIEW_VALID_NONE) {
             return true;
         }
 
         // #16227 - no processing before reaching the peer review period
         if (!$this->assignment->afterDeadlineStrict()) {
             return false;
         }
 
         // forever alone - should be valid
         $max = $this->getMaxPossibleFeedbacks();
         if ($max === 0) {
             return true;
         }
 
         $no_of_feedbacks = $this->countGivenFeedback(true, $a_user_id);
 
         switch ($this->assignment->getPeerReviewValid()) {
             case ilExAssignment::PEER_REVIEW_VALID_ONE:
                 return (bool) $no_of_feedbacks;
 
             case ilExAssignment::PEER_REVIEW_VALID_ALL:
                 // there could be less participants than stated in the min required setting
                 $min = min($max, $this->assignment->getPeerReviewMin());
 
                 return (($min - $no_of_feedbacks) < 1);
         }
         return false;
     }

Here is the call graph for this function:

◆ lookupGiversWithPendingFeedback()

static ilExPeerReview::lookupGiversWithPendingFeedback ( int $a_ass_id )

static

Definition at line 485 of file class.ilExPeerReview.php.

References $DIC, and $ilDB.

Referenced by ilExAssignmentReminder\parsePeerReminders().

                                                                          : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $user_ids = array();
 
         $set = $ilDB->query(
             "SELECT DISTINCT(giver_id) FROM exc_assignment_peer " .
             " WHERE ass_id = " . $ilDB->quote($a_ass_id, "integer") .
             " AND tstamp is NULL"
         );
 
         while ($row = $ilDB->fetchAssoc($set)) {
             $user_ids[] = $row["giver_id"];
         }
 
         return $user_ids;
     }

Here is the caller graph for this function:

◆ resetPeerReviews()

ilExPeerReview::resetPeerReviews ( )

Returns: int[]|string[]

Definition at line 113 of file class.ilExPeerReview.php.

References $db, $ilDB, getAllPeerReviews(), and hasPeerReviewGroups().

                                       : array
     {
         $ilDB = $this->db;
 
         $all = array();
 
         if ($this->hasPeerReviewGroups()) {
             foreach ($this->getAllPeerReviews(false) as $peer_id => $reviews) {
                 foreach (array_keys($reviews) as $giver_id) {
                     $all[] = $giver_id;
 
                     foreach ($this->assignment->getPeerReviewCriteriaCatalogueItems() as $crit) {
                         $crit->setPeerReviewContext($this->assignment, $giver_id, $peer_id);
                         $crit->resetReview();
                     }
                 }
             }
 
             // peer groups
             $ilDB->manipulate("DELETE FROM exc_assignment_peer" .
                 " WHERE ass_id = " . $ilDB->quote($this->assignment_id, "integer"));
         }
 
         return $all;
     }

Here is the call graph for this function:

◆ updatePeerReview()

ilExPeerReview::updatePeerReview	(	int	$a_peer_id,
		array	$a_values
	)

Definition at line 373 of file class.ilExPeerReview.php.

References $data, $db, $ilDB, $user, $valid, ilUtil\now(), and validatePeerReview().

      : void {
         $ilDB = $this->db;
         $ilUser = $this->user;
 
         $data = [
             "pcomment" => serialize($a_values),
             "peer_id" => $a_peer_id,
             "giver_id" => $ilUser->getId()
         ];
         $valid = $this->validatePeerReview($data);
 
         $sql = "UPDATE exc_assignment_peer" .
             " SET tstamp = " . $ilDB->quote(ilUtil::now(), "timestamp") .
             ",pcomment  = " . $ilDB->quote(serialize($a_values), "text") .
             ",is_valid = " . $ilDB->quote((int) $valid, "integer") .
             " WHERE giver_id = " . $ilDB->quote($ilUser->getId(), "integer") .
             " AND peer_id = " . $ilDB->quote($a_peer_id, "integer") .
             " AND ass_id = " . $ilDB->quote($this->assignment_id, "integer");
 
         $ilDB->manipulate($sql);
     }

Here is the call graph for this function:

◆ updatePeerReviewTimestamp()

ilExPeerReview::updatePeerReviewTimestamp ( int $a_peer_id )

Definition at line 360 of file class.ilExPeerReview.php.

References $db, $ilDB, $user, and ilUtil\now().

      : void {
         $ilDB = $this->db;
         $ilUser = $this->user;
 
         $ilDB->manipulate("UPDATE exc_assignment_peer" .
             " SET tstamp = " . $ilDB->quote(ilUtil::now(), "timestamp") .
             " WHERE giver_id = " . $ilDB->quote($ilUser->getId(), "integer") .
             " AND peer_id = " . $ilDB->quote($a_peer_id, "integer") .
             " AND ass_id = " . $ilDB->quote($this->assignment_id, "integer"));
     }

Here is the call graph for this function:

◆ validatePeerReview()

ilExPeerReview::validatePeerReview ( array $a_data )

protected

Definition at line 252 of file class.ilExPeerReview.php.

References $data, and Vendor\Package\$e.

Referenced by countGivenFeedback(), getAllPeerReviews(), getPeerReviewsByPeerId(), and updatePeerReview().

                                                         : bool
     {
         $all_empty = true;
         // see getPeerReviewValues()
         $values = null;
         $data = $a_data["pcomment"];
         if ($data) {
             try {
                 $values = unserialize($data, ['allowed_classes' => false]);
             } catch (Exception $e) {
             }
             if (!is_array($values)) {
                 // v1 - pcomment == text
                 $values = array("text" => $data);
             }
         }
 
         foreach ($this->assignment->getPeerReviewCriteriaCatalogueItems() as $crit) {
             $crit_id = $crit->getId()
                 ? $crit->getId()
                 : $crit->getType();
             $crit->setPeerReviewContext(
                 $this->assignment,
                 $a_data["giver_id"],
                 $a_data["peer_id"]
             );
             if (!$crit->validate($values[$crit_id] ?? null)) {
                 return false;
             }
             if ($crit->hasValue($values[$crit_id] ?? null)) {
                 $all_empty = false;
             }
         }
 
         return !$all_empty;
     }

Here is the caller graph for this function:

◆ validatePeerReviewGroups()

ilExPeerReview::validatePeerReviewGroups ( )

Definition at line 139 of file class.ilExPeerReview.php.

References $user_id, $valid, ilExerciseMembers\_getMembers(), getAllPeerReviews(), getValidPeerReviewUsers(), and hasPeerReviewGroups().

                                               : ?array
     {
         if ($this->hasPeerReviewGroups()) {
             $all_exc = ilExerciseMembers::_getMembers($this->assignment->getExerciseId());
             $all_valid = $this->getValidPeerReviewUsers(); // only returned
 
             $peer_ids = $invalid_peer_ids = $invalid_giver_ids = $all_reviews = array();
             foreach ($this->getAllPeerReviews(false) as $peer_id => $reviews) {
                 $peer_ids[] = $peer_id;
 
                 if (!in_array($peer_id, $all_valid) ||
                     !in_array($peer_id, $all_exc)) {
                     $invalid_peer_ids[] = $peer_id;
                 }
                 foreach ($reviews as $giver_id => $valid) {
                     if (!in_array($giver_id, $all_valid) ||
                         !in_array($peer_id, $all_exc)) {
                         $invalid_giver_ids[] = $giver_id;
                     } else {
                         $all_reviews[$peer_id][$giver_id] = $valid;
                     }
                 }
             }
             $invalid_giver_ids = array_unique($invalid_giver_ids);
 
             $missing_user_ids = array();
             foreach ($all_valid as $user_id) {
                 // a missing peer is also a missing giver
                 if (!in_array($user_id, $peer_ids)) {
                     $missing_user_ids[] = $user_id;
                 }
             }
 
             $not_returned_ids = array();
             foreach ($all_exc as $user_id) {
                 if (!in_array($user_id, $all_valid)) {
                     $not_returned_ids[] = $user_id;
                 }
             }
 
             return array(
                 "invalid" => (count($missing_user_ids) ||
                     count($invalid_peer_ids) ||
                     count($invalid_giver_ids)),
                 "missing_user_ids" => $missing_user_ids,
                 "not_returned_ids" => $not_returned_ids,
                 "invalid_peer_ids" => $invalid_peer_ids,
                 "invalid_giver_ids" => $invalid_giver_ids,
                 "reviews" => $all_reviews);
         }
 
         return null;
     }

Here is the call graph for this function:

Field Documentation

◆ $assignment

ilExAssignment ilExPeerReview::$assignment

protected

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

◆ $assignment_id

int ilExPeerReview::$assignment_id

protected

Definition at line 34 of file class.ilExPeerReview.php.

◆ $db

ilDBInterface ilExPeerReview::$db

protected

Definition at line 31 of file class.ilExPeerReview.php.

Referenced by countGivenFeedback(), getAllPeerReviews(), getPeerReviewsByGiver(), getPeerReviewsByPeerId(), hasPeerReviewAccess(), hasPeerReviewGroups(), initPeerReviews(), resetPeerReviews(), updatePeerReview(), and updatePeerReviewTimestamp().

◆ $domain

InternalDomainService ilExPeerReview::$domain

protected

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

◆ $log

ilLogger ilExPeerReview::$log

protected

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

◆ $user

ilObjUser ilExPeerReview::$user

protected

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

Referenced by countGivenFeedback(), hasPeerReviewAccess(), updatePeerReview(), and updatePeerReviewTimestamp().

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

components/ILIAS/Exercise/PeerReview/class.ilExPeerReview.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ countGivenFeedback()

◆ countReceivedFeedbacks()

◆ getAllPeerReviews()

◆ getMaxPossibleFeedbacks()

◆ getNumberOfMissingFeedbacksForReceived()

◆ getPeerMaskedId()

◆ getPeerReviewsByGiver()

◆ getPeerReviewsByPeerId()

◆ getPeerReviewValues()

◆ getReviewId()

◆ getValidPeerReviewUsers()

◆ hasPeerReviewAccess()

◆ hasPeerReviewGroups()

◆ initPeerReviews()

◆ isFeedbackValidForPassed()

◆ lookupGiversWithPendingFeedback()

◆ resetPeerReviews()

◆ updatePeerReview()

◆ updatePeerReviewTimestamp()

◆ validatePeerReview()

◆ validatePeerReviewGroups()

Field Documentation

◆ $assignment

◆ $assignment_id

◆ $db

◆ $domain

◆ $log

◆ $user