Exercise peer review. More...

Collaboration diagram for ilExPeerReview:

Public Member Functions
	__construct (ilExAssignment $a_assignment)

	hasPeerReviewGroups ()

	initPeerReviews ()

	resetPeerReviews ()

	validatePeerReviewGroups ()

	getPeerReviewValues ($a_giver_id, $a_peer_id)

	getPeerReviewsByGiver ($a_user_id)

	getPeerMaskedId ($a_giver_id, $a_peer_id)

	getPeerReviewsByPeerId ($a_user_id, $a_only_valid=false)

	getAllPeerReviews ($a_only_valid=true)

	hasPeerReviewAccess ($a_peer_id)

	updatePeerReviewTimestamp ($a_peer_id)

	updatePeerReview ($a_peer_id, array $a_values)

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

	getNumberOfMissingFeedbacksForReceived ()

	isFeedbackValidForPassed ($a_user_id)

Static Public Member Functions
static	lookupGiversWithPendingFeedback ($a_ass_id)

Protected Member Functions
	getValidPeerReviewUsers ()

	validatePeerReview (array $a_data)

	getMaxPossibleFeedbacks ()

Protected Attributes
	$db

	$user

	$assignment

	$assignment_id

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

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

Constructor & Destructor Documentation

◆ __construct()

ilExPeerReview::__construct ( ilExAssignment $a_assignment )

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ countGivenFeedback()

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

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

    {
        $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 (!(bool) $a_validate ||
                $this->validatePeerReview($row)) {
                $cnt++;
            }
        }
        
        return $cnt;
    }

References $db, $ilDB, $ilUser, $user, and validatePeerReview().

Referenced by getNumberOfMissingFeedbacksForReceived(), and isFeedbackValidForPassed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllPeerReviews()

ilExPeerReview::getAllPeerReviews ( $a_only_valid = true )

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

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

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

Referenced by resetPeerReviews(), and validatePeerReviewGroups().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaxPossibleFeedbacks()

ilExPeerReview::getMaxPossibleFeedbacks ( )

protected

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

    {
        $ilDB = $this->db;
        
        // check if number of returned assignments is lower than assignment peer min
        $set = $ilDB->query("SELECT COUNT(DISTINCT(user_id)) cnt" .
            " FROM exc_returned" .
            " WHERE ass_id = " . $ilDB->quote($this->assignment_id, "integer"));
        $cnt = $ilDB->fetchAssoc($set);
        $cnt = (int) $cnt["cnt"];
        return $cnt - 1;
    }

References $db, and $ilDB.

Referenced by getNumberOfMissingFeedbacksForReceived(), and isFeedbackValidForPassed().

Here is the caller graph for this function:

◆ getNumberOfMissingFeedbacksForReceived()

ilExPeerReview::getNumberOfMissingFeedbacksForReceived ( )

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

    {
        $max = $this->getMaxPossibleFeedbacks();
        
        // #16160 - forever alone
        if (!$max) {
            return;
        }
        
        // are all required or just 1?
        if (!$this->assignment->getPeerReviewSimpleUnlock()) {
            $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());
    }

References countGivenFeedback(), and getMaxPossibleFeedbacks().

Here is the call graph for this function:

◆ getPeerMaskedId()

ilExPeerReview::getPeerMaskedId	(	$a_giver_id,
		$a_peer_id
	)

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

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

References getPeerReviewsByGiver().

Here is the call graph for this function:

◆ getPeerReviewsByGiver()

ilExPeerReview::getPeerReviewsByGiver ( $a_user_id )

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

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

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

Referenced by getPeerMaskedId(), and getPeerReviewValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPeerReviewsByPeerId()

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

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

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

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

Here is the call graph for this function:

◆ getPeerReviewValues()

ilExPeerReview::getPeerReviewValues	(	$a_giver_id,
		$a_peer_id
	)

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

    {
        $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);
            if (!is_array($items)) {
                // v1 - pcomment == text
                $items = array("text" => $data);
            }
            return $items;
        }
    }

References $data, and getPeerReviewsByGiver().

Here is the call graph for this function:

◆ getValidPeerReviewUsers()

ilExPeerReview::getValidPeerReviewUsers ( )

protected

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

    {
        $ilDB = $this->db;
        
        $user_ids = array();
        
        // returned / assigned ?!
        $set = $ilDB->query("SELECT DISTINCT(user_id)" .
            " FROM exc_returned" .
            " WHERE ass_id = " . $ilDB->quote($this->assignment_id, "integer") .
            " AND (filename IS NOT NULL OR atext IS NOT NULL)");
        while ($row = $ilDB->fetchAssoc($set)) {
            $user_ids[] = $row["user_id"];
        }
        
        return $user_ids;
    }

References $db, and $ilDB.

Referenced by initPeerReviews(), and validatePeerReviewGroups().

Here is the caller graph for this function:

◆ hasPeerReviewAccess()

ilExPeerReview::hasPeerReviewAccess ( $a_peer_id )

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

    {
        $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 (bool) $row["ass_id"];
    }

References $db, $ilDB, $ilUser, and $user.

◆ hasPeerReviewGroups()

ilExPeerReview::hasPeerReviewGroups ( )

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

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

References $db, and $ilDB.

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

Here is the caller graph for this function:

◆ initPeerReviews()

ilExPeerReview::initPeerReviews ( )

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

    {
        $ilDB = $this->db;
                
        // see #22246
        if (!$this->assignment->afterDeadlineStrict()) {
            return false;
        }
 
        if (!$this->hasPeerReviewGroups()) {
            $user_ids = $this->getValidPeerReviewUsers();
 
            include_once("./Modules/Exercise/PeerReview/class.ExcPeerReviewDistribution.php");
            $distribution = new \ILIAS\Exercise\PeerReview\ExcPeerReviewDistribution($user_ids, $this->assignment->getPeerReviewMin());
 
            foreach ($user_ids as $rater_id) {
                foreach ($distribution->getPeersOfRater($rater_id) as $peer_id) {
                    $ilDB->manipulate("INSERT INTO exc_assignment_peer" .
                        " (ass_id, giver_id, peer_id)" .
                        " VALUES (" . $ilDB->quote($this->assignment_id, "integer") .
                        ", " . $ilDB->quote($rater_id, "integer") .
                        ", " . $ilDB->quote($peer_id, "integer") . ")");
                }
            }
        }
        return true;
    }

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

Referenced by getPeerReviewsByGiver().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isFeedbackValidForPassed()

ilExPeerReview::isFeedbackValidForPassed ( $a_user_id )

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

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

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

Here is the call graph for this function:

◆ lookupGiversWithPendingFeedback()

static ilExPeerReview::lookupGiversWithPendingFeedback ( $a_ass_id )

static

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

    {
        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)) {
            array_push($user_ids, $row["giver_id"]);
        }
 
        return $user_ids;
    }

References $DIC, and $ilDB.

Referenced by ilExAssignmentReminder\parsePeerReminders().

Here is the caller graph for this function:

◆ resetPeerReviews()

ilExPeerReview::resetPeerReviews ( )

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

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

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

Here is the call graph for this function:

◆ updatePeerReview()

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

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

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

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

Here is the call graph for this function:

◆ updatePeerReviewTimestamp()

ilExPeerReview::updatePeerReviewTimestamp ( $a_peer_id )

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

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

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

Here is the call graph for this function:

◆ validatePeerReview()

ilExPeerReview::validatePeerReview ( array $a_data )

protected

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

    {
        $all_empty = true;
        
        // see getPeerReviewValues()
        $values = null;
        $data = $a_data["pcomment"];
        if ($data) {
            $values = @unserialize($data);
            if (!is_array($values)) {
                // v1 - pcomment == text
                $values = array("text" => $data);
            }
        }
        
        /* #18491 - values can be empty, text is optional (rating/file values are handled internally in criteria)
        if(!$values)
        {
            return false;
        }
        */
        
        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])) {
                return false;
            }
            if ($crit->hasValue($values[$crit_id])) {
                $all_empty = false;
            }
        }
        
        return !$all_empty;
    }

References $data.

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

Here is the caller graph for this function:

◆ validatePeerReviewGroups()

ilExPeerReview::validatePeerReviewGroups ( )

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

    {
        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" => (sizeof($missing_user_ids) ||
                    sizeof($invalid_peer_ids) ||
                    sizeof($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);
        }
    }

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

Here is the call graph for this function:

Field Documentation

◆ $assignment

ilExPeerReview::$assignment

protected

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

◆ $assignment_id

ilExPeerReview::$assignment_id

protected

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

◆ $db

ilExPeerReview::$db

protected

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

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

◆ $user

ilExPeerReview::$user

protected

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

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

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

Modules/Exercise/classes/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()

◆ getAllPeerReviews()

◆ getMaxPossibleFeedbacks()

◆ getNumberOfMissingFeedbacksForReceived()

◆ getPeerMaskedId()

◆ getPeerReviewsByGiver()

◆ getPeerReviewsByPeerId()

◆ getPeerReviewValues()

◆ getValidPeerReviewUsers()

◆ hasPeerReviewAccess()

◆ hasPeerReviewGroups()

◆ initPeerReviews()

◆ isFeedbackValidForPassed()

◆ lookupGiversWithPendingFeedback()

◆ resetPeerReviews()

◆ updatePeerReview()

◆ updatePeerReviewTimestamp()

◆ validatePeerReview()

◆ validatePeerReviewGroups()

Field Documentation

◆ $assignment

◆ $assignment_id

◆ $db

◆ $user