ILIAS\Exercise\PeerReview\PeerReviewOverviewRetrieval Class Reference

Inheritance diagram for ILIAS\Exercise\PeerReview\PeerReviewOverviewRetrieval:

Collaboration diagram for ILIAS\Exercise\PeerReview\PeerReviewOverviewRetrieval:

Public Member Functions
	__construct (protected InternalDomainService $domain, protected \ilExAssignment $assignment)
	getData (array $fields, ?Range $range=null, ?Order $order=null, array $filter=[], array $parameters=[])
	count (array $filter=[], array $parameters=[])
	isFieldNumeric (string $field)
	getPanelInfo ()
	getData (array $fields, ?Range $range=null, ?Order $order=null, array $filter=[], array $parameters=[])
	count (array $filter, array $parameters)
	isFieldNumeric (string $field)

Protected Member Functions
	collectData ()
	addPanelInfo (array $peer_review_data, string $user_ids_key, string $title_key)
	translateUserIds (array $user_ids)

Protected Attributes
array	$data = null
array	$panel_info = []

Detailed Description

Definition at line 29 of file PeerReviewOverviewRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Exercise\PeerReview\PeerReviewOverviewRetrieval::__construct	(	protected InternalDomainService	$domain,
		protected \ilExAssignment	$assignment
	)

Definition at line 36 of file PeerReviewOverviewRetrieval.php.

      {
    }

Member Function Documentation

addPanelInfo()

ILIAS\Exercise\PeerReview\PeerReviewOverviewRetrieval::addPanelInfo ( array  $peer_review_data, string  $user_ids_key, string  $title_key  )

protected

Definition at line 134 of file PeerReviewOverviewRetrieval.php.

     : void {
        if (!$peer_review_data[$user_ids_key]) {
            return;
        }
 
        $this->panel_info[] = [
            'title' => $this->domain->lng()->txt($title_key),
            'value' => $this->translateUserIds($peer_review_data[$user_ids_key])
        ];
    }

collectData()

ILIAS\Exercise\PeerReview\PeerReviewOverviewRetrieval::collectData ( )

protected

Definition at line 77 of file PeerReviewOverviewRetrieval.php.

                                    : array
    {
        if ($this->data !== null) {
            return $this->data;
        }
 
        $this->data = [];
        $this->panel_info = [];
 
        $peer_review = $this->domain->peerReview()->exPeerReview($this->assignment);
        if ($peer_review === null) {
            return $this->data;
        }
 
        $peer_review_data = $peer_review->validatePeerReviewGroups();
        if (!is_array($peer_review_data)) {
            return $this->data;
        }
 
        $id = 0;
        foreach ($peer_review_data['reviews'] as $peer_id => $reviews) {
            $peer = current($this->translateUserIds([$peer_id]));
 
            foreach ($reviews as $giver_id => $status) {
                $this->data[] = [
                    'id' => ++$id,
                    'recipient' => $peer,
                    'giver' => current($this->translateUserIds([$giver_id])),
                    'status' => $status ? $this->domain->lng()->txt('valid') : ''
                ];
            }
        }
 
        $this->addPanelInfo(
            $peer_review_data,
            'missing_user_ids',
            'exc_peer_review_missing_users'
        );
        $this->addPanelInfo(
            $peer_review_data,
            'not_returned_ids',
            'exc_peer_review_not_returned_users'
        );
        $this->addPanelInfo(
            $peer_review_data,
            'invalid_peer_ids',
            'exc_peer_review_invalid_peer_ids'
        );
        $this->addPanelInfo(
            $peer_review_data,
            'invalid_giver_ids',
            'exc_peer_review_invalid_giver_ids'
        );
 
        return $this->data;
    }

References $data, and $id.

count()

ILIAS\Exercise\PeerReview\PeerReviewOverviewRetrieval::count	(	array	$filter = [],
		array	$parameters = []
	)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 58 of file PeerReviewOverviewRetrieval.php.

     : int {
        return count($this->collectData());
    }

getData()

ILIAS\Exercise\PeerReview\PeerReviewOverviewRetrieval::getData	(	array	$fields,
		?Range	$range = null,
		?Order	$order = null,
		array	$filter = [],
		array	$parameters = []
	)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 42 of file PeerReviewOverviewRetrieval.php.

     : \Generator {
        $data = $this->collectData();
        $data = $this->applyOrder($data, $order);
        $data = $this->applyRange($data, $range);
 
        foreach ($data as $row) {
            yield $row;
        }
    }

getPanelInfo()

ILIAS\Exercise\PeerReview\PeerReviewOverviewRetrieval::getPanelInfo

(

)

Definition at line 70 of file PeerReviewOverviewRetrieval.php.

                                  : array
    {
        $this->collectData();
 
        return $this->panel_info;
    }

isFieldNumeric()

ILIAS\Exercise\PeerReview\PeerReviewOverviewRetrieval::isFieldNumeric

(

string

$field

)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 65 of file PeerReviewOverviewRetrieval.php.

                                                 : bool
    {
        return $field === 'id';
    }

translateUserIds()

ILIAS\Exercise\PeerReview\PeerReviewOverviewRetrieval::translateUserIds ( array  $user_ids )

protected

Definition at line 149 of file PeerReviewOverviewRetrieval.php.

                                                        : array
    {
        $result = [];
 
        foreach (array_unique($user_ids) as $user_id) {
            $result[] = \ilUserUtil::getNamePresentation($user_id);
        }
 
        return $result;
    }

References $user_id, and ilUserUtil\getNamePresentation().

Here is the call graph for this function:

Field Documentation

$data

array ILIAS\Exercise\PeerReview\PeerReviewOverviewRetrieval::$data = null

protected

Definition at line 33 of file PeerReviewOverviewRetrieval.php.

$panel_info

array ILIAS\Exercise\PeerReview\PeerReviewOverviewRetrieval::$panel_info = []

protected

Definition at line 34 of file PeerReviewOverviewRetrieval.php.

---

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

• components/ILIAS/Exercise/PeerReview/PeerReviewOverviewRetrieval.php