ilExPeerReviewGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilExPeerReviewGUI:

Public Member Functions
	executeCommand ()
	returnToParentObject ()
	showGivenPeerReviewObject ()
	showReceivedPeerReviewObject ()
	editPeerReviewObject ()
	editPeerReviewItemObject (ilPropertyFormGUI $a_form=null)
	updateCritAjaxObject ()
	updatePeerReviewObject ()
	downloadPeerReviewObject ()
	showPeerReviewOverviewObject ()
	confirmResetPeerReviewObject ()
	resetPeerReviewObject ()

Static Public Member Functions
static	getOverviewContent (ilInfoScreenGUI $a_info, ilExSubmission $a_submission)

Protected Member Functions
	canGive ()
	canView ()
	renderInfoWidget (ilInfoScreenGUI $a_info_widget, array $a_peer_items, bool $a_by_peer=false)
	getLateSubmissionInfo (ilExSubmission $a_submission)
	isValidPeer (int $a_peer_id)
	getSubmissionContent (ilExSubmission $a_submission)
	initPeerReviewItemForm (int $a_peer_id)
	handlePeerReviewChange ()

Protected Attributes
ilCtrl	$ctrl
ilTabsGUI	$tabs_gui
ilLanguage	$lng
ilGlobalPageTemplate	$tpl
ilObjUser	$user
ilExAssignment	$ass
ilExSubmission	$submission
int	$requested_review_giver_id = 0
int	$requested_review_peer_id = 0
string	$requested_review_crit_id = ""
int	$requested_peer_id = 0
string	$requested_crit_id = ""

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilExPeerReviewGUI

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 ilExPeerReviewGUI: ilFileSystemGUI, ilRatingGUI, ilExSubmissionTextGUI, ilInfoScreenGUI

Definition at line 26 of file class.ilExPeerReviewGUI.php.

Member Function Documentation

canGive()

ilExPeerReviewGUI::canGive ( )

protected

Definition at line 273 of file class.ilExPeerReviewGUI.php.

Referenced by downloadPeerReviewObject(), editPeerReviewItemObject(), editPeerReviewObject(), executeCommand(), updateCritAjaxObject(), and updatePeerReviewObject().

                                : bool
    {
        return ($this->submission->isOwner() &&
            $this->ass->afterDeadlineStrict() &&
            (!$this->ass->getPeerReviewDeadline() ||
                $this->ass->getPeerReviewDeadline() > time()));
    }

Here is the caller graph for this function:

canView()

ilExPeerReviewGUI::canView ( )

protected

Definition at line 281 of file class.ilExPeerReviewGUI.php.

Referenced by downloadPeerReviewObject(), showGivenPeerReviewObject(), and showReceivedPeerReviewObject().

                                : bool
    {
        return ($this->submission->isTutor() ||
            ($this->submission->isOwner() &&
            $this->ass->afterDeadlineStrict() &&
            (!$this->ass->getPeerReviewDeadline() ||
                $this->ass->getPeerReviewDeadline() < time())));
    }

Here is the caller graph for this function:

confirmResetPeerReviewObject()

ilExPeerReviewGUI::confirmResetPeerReviewObject

(

)

Definition at line 820 of file class.ilExPeerReviewGUI.php.

References $ctrl, $tabs_gui, $tpl, ILIAS\Repository\lng(), returnToParentObject(), and ilGlobalPageTemplate\setContent().

                                                  : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs_gui;

        if (!$this->ass ||
            !$this->ass->getPeerReview()) {
            $this->returnToParentObject();
        }

        $ilTabs->clearTargets();

        $cgui = new ilConfirmationGUI();
        $cgui->setFormAction($ilCtrl->getFormAction($this));
        $cgui->setHeaderText(sprintf($this->lng->txt("exc_peer_review_reset_sure"), $this->ass->getTitle()));
        $cgui->setCancel($this->lng->txt("cancel"), "showPeerReviewOverview");
        $cgui->setConfirm($this->lng->txt("delete"), "resetPeerReview");

        $tpl->setContent($cgui->getHTML());
    }

Here is the call graph for this function:

downloadPeerReviewObject()

ilExPeerReviewGUI::downloadPeerReviewObject

(

)

Definition at line 746 of file class.ilExPeerReviewGUI.php.

References $ctrl, $requested_review_crit_id, $requested_review_giver_id, $requested_review_peer_id, canGive(), canView(), ilFileDelivery\deliverFileLegacy(), ilExcCriteria\getInstanceById(), ilExcCriteria\getInstanceByType(), and returnToParentObject().

                                              : void
    {
        $ilCtrl = $this->ctrl;

        if (!$this->canView() &&
            !$this->canGive()) {
            $this->returnToParentObject();
        }

        $giver_id = $this->requested_review_giver_id;
        $peer_id = $this->requested_review_peer_id;
        $crit_id = $this->requested_review_crit_id;

        if (!is_numeric($crit_id)) {
            $crit = ilExcCriteria::getInstanceByType($crit_id);
        } else {
            $crit = ilExcCriteria::getInstanceById($crit_id);
        }

        $crit->setPeerReviewContext($this->ass, $giver_id, $peer_id);
        $file = $crit->getFileByHash();
        if ($file) {
            ilFileDelivery::deliverFileLegacy($file, basename($file));
        }

        $ilCtrl->redirect($this, "returnToParent");
    }

Here is the call graph for this function:

editPeerReviewItemObject()

ilExPeerReviewGUI::editPeerReviewItemObject

(

ilPropertyFormGUI

$a_form = null

)

Definition at line 519 of file class.ilExPeerReviewGUI.php.

References $tpl, canGive(), initPeerReviewItemForm(), isValidPeer(), returnToParentObject(), and ilGlobalPageTemplate\setContent().

Referenced by updatePeerReviewObject().

     : void {
        $tpl = $this->tpl;

        if (!$this->canGive() ||
            !$this->isValidPeer($this->requested_peer_id)) {
            $this->returnToParentObject();
        }

        if ($a_form === null) {
            $a_form = $this->initPeerReviewItemForm($this->requested_peer_id);
        }

        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editPeerReviewObject()

ilExPeerReviewGUI::editPeerReviewObject

(

)

Exceptions

ilDateTimeException

Definition at line 481 of file class.ilExPeerReviewGUI.php.

References $tpl, canGive(), ilDatePresentation\formatDate(), IL_CAL_UNIX, ILIAS\Repository\lng(), returnToParentObject(), and ilGlobalPageTemplate\setContent().

                                          : void
    {
        $tpl = $this->tpl;

        if (!$this->canGive()) {
            $this->returnToParentObject();
        }

        $peer_items = $this->submission->getPeerReview()->getPeerReviewsByGiver($this->submission->getUserId());
        if ($peer_items === []) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("exc_peer_review_no_peers"), true);
            $this->returnToParentObject();
        }

        $missing = $this->submission->getPeerReview()->getNumberOfMissingFeedbacksForReceived();
        if ($missing !== 0) {
            $dl = $this->ass->getPeerReviewDeadline();
            if (!$dl || $dl < time()) {
                $this->tpl->setOnScreenMessage('info', sprintf($this->lng->txt("exc_peer_review_missing_info"), $missing));
            } else {
                $this->tpl->setOnScreenMessage('info', sprintf(
                    $this->lng->txt("exc_peer_review_missing_info_deadline"),
                    $missing,
                    ilDatePresentation::formatDate(new ilDateTime($dl, IL_CAL_UNIX))
                ));
            }
        }

        $tbl = new ilExAssignmentPeerReviewTableGUI(
            $this,
            "editPeerReview",
            $this->ass,
            $this->submission->getUserId(),
            $peer_items
        );
        $tpl->setContent($tbl->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilExPeerReviewGUI::executeCommand

(

)

Exceptions

ilCtrlException

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

References $ctrl, $lng, $requested_peer_id, $requested_review_giver_id, $requested_review_peer_id, $tabs_gui, $valid, canGive(), ilFSStorageExercise\create(), ILIAS\Repository\ctrl(), returnToParentObject(), ilFileSystemGUI\setTableId(), and ilLanguage\txt().

                                    : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilTabs = $this->tabs_gui;

        if (!$this->ass->getPeerReview()) {
            $this->returnToParentObject();
        }

        $class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd("showpeerreviewoverview");

        switch ($class) {
            case "ilfilesystemgui":
                $ilCtrl->saveParameter($this, array("fu"));

                // see self::downloadPeerReview()
                $giver_id = $this->requested_review_giver_id;
                $peer_id = $this->requested_review_peer_id;

                if (!$this->canGive()) {
                    $this->returnToParentObject();
                }

                $valid = false;
                $peer_items = $this->submission->getPeerReview()->getPeerReviewsByPeerId($peer_id, true);
                if (is_array($peer_items)) {
                    foreach ($peer_items as $item) {
                        if ($item["giver_id"] == $giver_id) {
                            $valid = true;
                        }
                    }
                }
                if (!$valid) {
                    $ilCtrl->redirect($this, "editPeerReview");
                }

                $ilTabs->clearTargets();
                $ilTabs->setBackTarget(
                    $lng->txt("back"),
                    $ilCtrl->getLinkTarget($this, "editPeerReview")
                );

                $fstorage = new ilFSStorageExercise($this->ass->getExerciseId(), $this->ass->getId());
                $fstorage->create();

                $fs_gui = new ilFileSystemGUI($fstorage->getPeerReviewUploadPath($peer_id, $giver_id));
                $fs_gui->setTableId("excfbpeer");
                $fs_gui->setAllowDirectories(false);
                $fs_gui->setTitle($this->ass->getTitle() . ": " .
                    $lng->txt("exc_peer_review") . " - " .
                    $lng->txt("exc_peer_review_give"));
                $this->ctrl->forwardCommand($fs_gui);
                break;

            case "ilratinggui":
                $peer_review = new ilExPeerReview($this->ass);
                $peer_review->updatePeerReviewTimestamp($this->requested_peer_id);

                $rating_gui = new ilRatingGUI();
                $rating_gui->setObject(
                    $this->ass->getId(),
                    "ass",
                    $this->requested_peer_id,
                    "peer"
                );
                $this->ctrl->forwardCommand($rating_gui);
                $ilCtrl->redirect($this, "editPeerReview");
                break;

            case "ilexsubmissiontextgui":
                $ilTabs->clearTargets();
                if (!$this->submission->isTutor()) {
                    $ilTabs->setBackTarget(
                        $lng->txt("back"),
                        $ilCtrl->getLinkTarget($this, "editPeerReview")
                    );
                    $this->ctrl->setReturn($this, "editPeerReview");
                } else {
                    $ilTabs->setBackTarget(
                        $lng->txt("back"),
                        $ilCtrl->getLinkTarget($this, "showGivenPeerReview")
                    );
                    $this->ctrl->setReturn($this, "showGivenPeerReview");
                }
                $gui = new ilExSubmissionTextGUI(new ilObjExercise($this->ass->getExerciseId(), false), $this->submission);
                $ilCtrl->forwardCommand($gui);
                break;

            default:
                $this->{$cmd . "Object"}();
                break;
        }
    }

Here is the call graph for this function:

getLateSubmissionInfo()

ilExPeerReviewGUI::getLateSubmissionInfo ( ilExSubmission  $a_submission )

protected

Definition at line 464 of file class.ilExPeerReviewGUI.php.

References $lng, ilExSubmission\getFiles(), and ilLanguage\txt().

Referenced by initPeerReviewItemForm(), and renderInfoWidget().

     : string {
        $lng = $this->lng;

        // #18966 - late files info
        foreach ($a_submission->getFiles() as $file) {
            if ($file["late"]) {
                return '<div class="warning">' . $lng->txt("exc_late_submission") . '</div>';
            }
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOverviewContent()

static ilExPeerReviewGUI::getOverviewContent ( ilInfoScreenGUI  $a_info, ilExSubmission  $a_submission  )

static

Exceptions

ilDateTimeException

Definition at line 178 of file class.ilExPeerReviewGUI.php.

References $DIC, ilInfoScreenGUI\addProperty(), ilExSubmission\getAssignment(), ilLinkButton\getInstance(), ilExcAssMemberState\getInstanceByIds(), ilExSubmission\getPeerReview(), ilExSubmission\getUserId(), and ilLanguage\txt().

Referenced by ilExAssignmentGUI\addSubmission().

     : void {
        global $DIC;

        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();

        $state = ilExcAssMemberState::getInstanceByIds($a_submission->getAssignment()->getId(), $a_submission->getUserId());

        $ass = $a_submission->getAssignment();

        $view_pc = "";
        $edit_pc = "";


        //if($ass->afterDeadlineStrict() &&
        //      $ass->getPeerReview())
        if ($state->hasSubmissionEndedForAllUsers() &&
            $ass->getPeerReview()) {
            $ilCtrl->setParameterByClass("ilExPeerReviewGUI", "ass_id", $a_submission->getAssignment()->getId());

            $nr_missing_fb = $a_submission->getPeerReview()->getNumberOfMissingFeedbacksForReceived();

            // before deadline (if any)
            // if(!$ass->getPeerReviewDeadline() ||
            //          $ass->getPeerReviewDeadline() > time())
            if ($state->isPeerReviewAllowed()) {
                $dl_info = "";
                if ($ass->getPeerReviewDeadline()) {
                    $dl_info = " (" . sprintf(
                        $lng->txt("exc_peer_review_deadline_info_button"),
                        $state->getPeerReviewDeadlinePresentation()
                    ) . ")";
                }

                $button = ilLinkButton::getInstance();                          // edit peer review
                $button->setPrimary($nr_missing_fb);
                $button->setCaption($lng->txt("exc_peer_review_give") . $dl_info, false);
                $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExPeerReviewGUI"), "editPeerReview"));
                $edit_pc = $button->render();
            } elseif ($ass->getPeerReviewDeadline()) {
                $edit_pc = $lng->txt("exc_peer_review_deadline_reached");
            }

            // after deadline (if any)
            if ((!$ass->getPeerReviewDeadline() ||
                $ass->getPeerReviewDeadline() < time())) {
                // given peer review should be accessible at all times (read-only when not editable - see above)
                if ($ass->getPeerReviewDeadline() &&
                    $a_submission->getPeerReview()->countGivenFeedback(false)) {
                    $button = ilLinkButton::getInstance();
                    $button->setCaption("exc_peer_review_given");
                    $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExPeerReviewGUI"), "showGivenPeerReview"));
                    $view_pc = $button->render() . " ";
                }

                // did give enough feedback
                if (!$nr_missing_fb) {
                    // received any?
                    $received = (bool) sizeof($a_submission->getPeerReview()->getPeerReviewsByPeerId($a_submission->getUserId(), true));
                    if ($received) {
                        $button = ilLinkButton::getInstance();
                        $button->setCaption("exc_peer_review_show");
                        $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExPeerReviewGUI"), "showReceivedPeerReview"));
                        $view_pc .= $button->render();
                    }
                    // received none
                    else {
                        $view_pc .= $lng->txt("exc_peer_review_show_received_none");
                    }
                }
                // did not give enough
                else {
                    $view_pc .= $lng->txt("exc_peer_review_show_missing");
                }
            }
            /* must give before showing received
            else
            {
                $view_pc = $lng->txt("exc_peer_review_show_not_rated_yet");
            }
            */

            $sep = ($edit_pc != "" && $view_pc != "")
                ? "<br><br>"
                : "";

            $a_info->addProperty($lng->txt("exc_peer_review"), $edit_pc . $sep . $view_pc);

            $ilCtrl->setParameterByClass("ilExPeerReviewGUI", "ass_id", "");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubmissionContent()

ilExPeerReviewGUI::getSubmissionContent ( ilExSubmission  $a_submission )

protected

Definition at line 547 of file class.ilExPeerReviewGUI.php.

References ilRTE\_replaceMediaObjectImageSrc(), ilExSubmission\getFiles(), and ilExAssignment\TYPE_TEXT.

Referenced by initPeerReviewItemForm(), and renderInfoWidget().

     : string {
        if ($this->ass->getType() != ilExAssignment::TYPE_TEXT) {
            return "";
        }

        $text = $a_submission->getFiles();
        if ($text !== []) {
            $text = array_shift($text);
            if (trim($text["atext"]) !== '' && trim($text["atext"]) !== '0') {
                // mob id to mob src
                return nl2br(ilRTE::_replaceMediaObjectImageSrc($text["atext"], 1));
            }
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handlePeerReviewChange()

ilExPeerReviewGUI::handlePeerReviewChange ( )

protected

Definition at line 734 of file class.ilExPeerReviewGUI.php.

References $exercise.

Referenced by updateCritAjaxObject(), and updatePeerReviewObject().

                                               : void
    {
        // (in)valid peer reviews could change assignment status
        $exercise = new ilObjExercise($this->ass->getExerciseId(), false);
        $exercise->processExerciseStatus(
            $this->ass,
            $this->submission->getUserIds(),
            $this->submission->hasSubmitted(),
            $this->submission->validatePeerReviews()
        );
    }

Here is the caller graph for this function:

initPeerReviewItemForm()

ilExPeerReviewGUI::initPeerReviewItemForm ( int  $a_peer_id )

protected

Exceptions

ilDateTimeException

Definition at line 568 of file class.ilExPeerReviewGUI.php.

References $ctrl, $id, $lng, ilExSubmission\getDownloadedFilesInfoForTableGUIS(), getLateSubmissionInfo(), ilUserUtil\getNamePresentation(), getSubmissionContent(), ilNonEditableValueGUI\setValue(), and ilLanguage\txt().

Referenced by editPeerReviewItemObject(), and updatePeerReviewObject().

     : ilPropertyFormGUI {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        // get peer data
        $peer_items = $this->submission->getPeerReview()->getPeerReviewsByGiver($this->submission->getUserId());
        $peer = [];
        foreach ($peer_items as $item) {
            if ($item["peer_id"] == $a_peer_id) {
                $peer = $item;
                break;
            }
        }

        $ilCtrl->saveParameter($this, "peer_id");

        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this, "updatePeerReview"));

        $form->setTitle($this->ass->getTitle() . ": " . $lng->txt("exc_peer_review_give"));

        // peer info
        if (!$this->ass->hasPeerReviewPersonalized()) {
            $id_title = $lng->txt("id");
            $id_value = $peer["seq"];
        } else {
            $id_title = $lng->txt("exc_peer_review_recipient");
            $id_value = ilUserUtil::getNamePresentation($peer["peer_id"]);
        }
        $id = new ilNonEditableValueGUI($id_title);
        $id->setValue($id_value);
        $form->addItem($id);

        // submission info

        $submission = new ilExSubmission($this->ass, $peer["peer_id"]);
        $file_info = $submission->getDownloadedFilesInfoForTableGUIS();

        $last_sub = new ilNonEditableValueGUI($file_info["last_submission"]["txt"], "", true);
        $last_sub->setValue($file_info["last_submission"]["value"] .
            $this->getLateSubmissionInfo($submission));
        $form->addItem($last_sub);

        $sub_data = $this->getSubmissionContent($submission);
        if (($sub_data === '' || $sub_data === '0') && isset($file_info["files"]["download_url"])) {
            $sub_data = '<a href="' . $file_info["files"]["download_url"] . '">' . $lng->txt("download") . '</a>';
        }

        $sub = new ilNonEditableValueGUI($lng->txt("exc_submission"), "", true);
        $sub->setValue($sub_data);
        $form->addItem($sub);

        // peer review items

        $input = new ilFormSectionHeaderGUI();
        $input->setTitle($lng->txt("exc_peer_review"));
        $form->addItem($input);

        $values = $this->submission->getPeerReview()->getPeerReviewValues($this->submission->getUserId(), $a_peer_id);

        foreach ($this->ass->getPeerReviewCriteriaCatalogueItems() as $item) {
            $crit_id = $item->getId()
                ? $item->getId()
                : $item->getType();

            $item->setPeerReviewContext(
                $this->ass,
                $this->submission->getUserId(),
                $peer["peer_id"],
                $form
            );
            $item->addToPeerReviewForm($values[$crit_id] ?? null);
        }

        $form->addCommandButton("updatePeerReview", $lng->txt("save"));
        $form->addCommandButton("editPeerReview", $lng->txt("cancel"));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isValidPeer()

ilExPeerReviewGUI::isValidPeer ( int  $a_peer_id )

protected

Definition at line 536 of file class.ilExPeerReviewGUI.php.

Referenced by editPeerReviewItemObject(), and updatePeerReviewObject().

                                                  : bool
    {
        $peer_items = $this->submission->getPeerReview()->getPeerReviewsByGiver($this->submission->getUserId());
        foreach ($peer_items as $item) {
            if ($item["peer_id"] == $a_peer_id) {
                return true;
            }
        }
        return false;
    }

Here is the caller graph for this function:

renderInfoWidget()

ilExPeerReviewGUI::renderInfoWidget ( ilInfoScreenGUI  $a_info_widget, array  $a_peer_items, bool  $a_by_peer = false  )

protected

Definition at line 357 of file class.ilExPeerReviewGUI.php.

References $lng, ilInfoScreenGUI\addProperty(), ilInfoScreenGUI\addSection(), ilExSubmission\getDownloadedFilesInfoForTableGUIS(), getLateSubmissionInfo(), ilUserUtil\getNamePresentation(), getSubmissionContent(), and ilLanguage\txt().

Referenced by showGivenPeerReviewObject(), and showReceivedPeerReviewObject().

     : void {
        $lng = $this->lng;

        if ($this->submission->isTutor()) {
            $user_title = $a_by_peer
                ? $lng->txt("exc_peer_review_recipient")
                : $lng->txt("exc_peer_review_giver");
            $a_info_widget->addSection($user_title);
            $a_info_widget->addProperty(
                $lng->txt("name"),
                ilUserUtil::getNamePresentation($this->submission->getUserId(), false, false, "", true)
            );
        }

        if ($a_by_peer) {
            // submission

            $a_info_widget->addSection($lng->txt("exc_submission"));

            $submission = new ilExSubmission($this->ass, $this->submission->getUserId());
            $file_info = $submission->getDownloadedFilesInfoForTableGUIS();

            $a_info_widget->addProperty(
                $file_info["last_submission"]["txt"],
                $file_info["last_submission"]["value"] .
                $this->getLateSubmissionInfo($submission)
            );

            $sub_data = $this->getSubmissionContent($submission);
            if ($sub_data === '' || $sub_data === '0') {
                $sub_data = '<a href="' . $file_info["files"]["download_url"] . '">' . $lng->txt("download") . '</a>';
            }
            $a_info_widget->addProperty($lng->txt("exc_submission"), $sub_data);
        }

        foreach ($a_peer_items as $peer) {
            if (!$a_by_peer) {
                $giver_id = $this->submission->getUserId();
                $peer_id = $peer["peer_id"];
                $id_title = $lng->txt("exc_peer_review_recipient");
                $user_id = $peer_id;
            } else {
                $giver_id = $peer["giver_id"];
                $peer_id = $this->submission->getUserId();
                $id_title = $lng->txt("exc_peer_review_giver");
                $user_id = $giver_id;
            }

            // peer info
            if ($this->submission->isTutor()) {
                $id_value = ilUserUtil::getNamePresentation($user_id, "", "", false, true);
            } elseif (!$this->ass->hasPeerReviewPersonalized()) {
                $id_value = $peer["seq"];
            } else {
                $id_value = ilUserUtil::getNamePresentation($user_id);
            }
            $a_info_widget->addSection($id_title . ": " . $id_value);


            // submission info

            if (!$a_by_peer) {
                $submission = new ilExSubmission($this->ass, $peer_id);
                $file_info = $submission->getDownloadedFilesInfoForTableGUIS();

                $a_info_widget->addProperty(
                    $file_info["last_submission"]["txt"],
                    $file_info["last_submission"]["value"] .
                    $this->getLateSubmissionInfo($submission)
                );

                $sub_data = $this->getSubmissionContent($submission);
                if ($sub_data === '' || $sub_data === '0') {
                    if (isset($file_info["files"]["download_url"])) {
                        $sub_data = '<a href="' . $file_info["files"]["download_url"] . '">' . $lng->txt("download") . '</a>';
                    }
                }
                $a_info_widget->addProperty($lng->txt("exc_submission"), $sub_data);
            }


            // peer review items

            $values = $this->submission->getPeerReview()->getPeerReviewValues($giver_id, $peer_id);

            foreach ($this->ass->getPeerReviewCriteriaCatalogueItems() as $item) {
                $crit_id = $item->getId()
                    ? $item->getId()
                    : $item->getType();

                $item->setPeerReviewContext(
                    $this->ass,
                    $giver_id,
                    $peer_id
                );

                $title = $item->getTitle();
                $html = $item->getHTML($values[$crit_id] ?? null);
                $a_info_widget->addProperty($title ?: "&nbsp;", $html ?: "&nbsp;");
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetPeerReviewObject()

ilExPeerReviewGUI::resetPeerReviewObject

(

)

Definition at line 842 of file class.ilExPeerReviewGUI.php.

References $ass, $ctrl, $exercise, $submission, ILIAS\Repository\lng(), ilExAssignment\PEER_REVIEW_VALID_NONE, and returnToParentObject().

                                           : void
    {
        $ilCtrl = $this->ctrl;

        if (!$this->ass ||
            !$this->ass->getPeerReview()) {
            $this->returnToParentObject();
        }

        $peer_review = new ilExPeerReview($this->ass);
        $all_giver_ids = $peer_review->resetPeerReviews();

        if (is_array($all_giver_ids)) {
            // if peer review is valid for completion, we have to re-calculate all assignment members
            $exercise = new ilObjExercise($this->ass->getExerciseId(), false);
            if ($exercise->isCompletionBySubmissionEnabled() &&
                $this->ass->getPeerReviewValid() != ilExAssignment::PEER_REVIEW_VALID_NONE) {
                foreach ($all_giver_ids as $user_id) {
                    $submission = new ilExSubmission($this->ass, $user_id);
                    $pgui = new self($this->ass, $submission);
                    $pgui->handlePeerReviewChange();
                }
            }
        }

        $this->tpl->setOnScreenMessage('success', $this->lng->txt("exc_peer_review_reset_done"), true);
        $ilCtrl->redirect($this, "showPeerReviewOverview");
    }

Here is the call graph for this function:

returnToParentObject()

ilExPeerReviewGUI::returnToParentObject

(

)

Definition at line 170 of file class.ilExPeerReviewGUI.php.

References ILIAS\Repository\ctrl().

Referenced by confirmResetPeerReviewObject(), downloadPeerReviewObject(), editPeerReviewItemObject(), editPeerReviewObject(), executeCommand(), resetPeerReviewObject(), showGivenPeerReviewObject(), showPeerReviewOverviewObject(), showReceivedPeerReviewObject(), and updatePeerReviewObject().

                                          : void
    {
        $this->ctrl->returnToParent($this);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showGivenPeerReviewObject()

ilExPeerReviewGUI::showGivenPeerReviewObject

(

)

Exceptions

ilObjectNotFoundException
ilCtrlException
ilDatabaseException
ilDateTimeException

Definition at line 296 of file class.ilExPeerReviewGUI.php.

References $lng, $tpl, canView(), ILIAS\Repository\lng(), renderInfoWidget(), returnToParentObject(), ilGlobalPageTemplate\setContent(), ilGlobalPageTemplate\setTitle(), and ilLanguage\txt().

                                               : void
    {
        $tpl = $this->tpl;
        $lng = $this->lng;

        if (!$this->canView()) {
            $this->returnToParentObject();
        }

        $peer_items = $this->submission->getPeerReview()->getPeerReviewsByGiver($this->submission->getUserId());
        if ($peer_items === []) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("exc_peer_review_no_peers"), true);
            $this->returnToParentObject();
        }

        $tpl->setTitle($this->ass->getTitle() . ": " . $lng->txt("exc_peer_review_given"));

        $info_widget = new ilInfoScreenGUI($this);

        $this->renderInfoWidget($info_widget, $peer_items);

        $tpl->setContent($info_widget->getHTML());
    }

Here is the call graph for this function:

showPeerReviewOverviewObject()

ilExPeerReviewGUI::showPeerReviewOverviewObject

(

)

Definition at line 780 of file class.ilExPeerReviewGUI.php.

References $panel, $tpl, ilPanelGUI\getInstance(), ILIAS\Repository\lng(), returnToParentObject(), and ilGlobalPageTemplate\setContent().

                                                  : void
    {
        $tpl = $this->tpl;

        if (!$this->ass ||
            !$this->ass->getPeerReview()) {
            $this->returnToParentObject();
        }

        $tbl = new ilExAssignmentPeerReviewOverviewTableGUI(
            $this,
            "showPeerReviewOverview",
            $this->ass
        );

        $panel = "";
        $panel_data = $tbl->getPanelInfo();
        if (is_array($panel_data) && count($panel_data) > 0) {
            $ptpl = new ilTemplate("tpl.exc_peer_review_overview_panel.html", true, true, "Modules/Exercise");
            foreach ($panel_data as $item) {
                $ptpl->setCurrentBlock("user_bl");
                foreach ($item["value"] as $user) {
                    $ptpl->setVariable("USER", $user);
                    $ptpl->parseCurrentBlock();
                }

                $ptpl->setCurrentBlock("item_bl");
                $ptpl->setVariable("TITLE", $item["title"]);
                $ptpl->parseCurrentBlock();
            }

            $panel = ilPanelGUI::getInstance();
            $panel->setHeading($this->lng->txt("exc_peer_review_overview_invalid_users"));
            $panel->setBody($ptpl->get());
            $panel = $panel->getHTML();
        }

        $tpl->setContent($tbl->getHTML() . $panel);
    }

Here is the call graph for this function:

showReceivedPeerReviewObject()

ilExPeerReviewGUI::showReceivedPeerReviewObject

(

)

Exceptions

ilObjectNotFoundException
ilCtrlException
ilDatabaseException
ilDateTimeException

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

References $ctrl, $lng, $tpl, canView(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), renderInfoWidget(), returnToParentObject(), ilGlobalPageTemplate\setContent(), ilGlobalPageTemplate\setTitle(), and ilLanguage\txt().

                                                  : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;

        if (!$this->canView() ||
            (!$this->submission->isTutor() &&
            $this->submission->getPeerReview()->getNumberOfMissingFeedbacksForReceived())) {
            $this->returnToParentObject();
        }

        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget($this->lng->txt("back"), $this->ctrl->getLinkTarget($this, "returnToParent"));

        $peer_items = $this->submission->getPeerReview()->getPeerReviewsByPeerId($this->submission->getUserId(), !$this->submission->isTutor());
        if ($peer_items === []) {
            // #11373
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("exc_peer_review_no_peers_reviewed_yet"), true);
            $ilCtrl->redirect($this, "returnToParent");
        }

        $tpl->setTitle($this->ass->getTitle() . ": " . $lng->txt("exc_peer_review_show"));

        $info_widget = new ilInfoScreenGUI($this);

        $this->renderInfoWidget($info_widget, $peer_items, true);

        $tpl->setContent($info_widget->getHTML());
    }

Here is the call graph for this function:

updateCritAjaxObject()

ilExPeerReviewGUI::updateCritAjaxObject

(

)

Definition at line 650 of file class.ilExPeerReviewGUI.php.

References $ctrl, $ilUser, $requested_crit_id, $requested_peer_id, $tpl, $user, canGive(), exit, ilExcCriteria\getInstanceById(), ilExcCriteria\getInstanceByType(), ilGlobalPageTemplate\getOnLoadCodeForAsynch(), and handlePeerReviewChange().

                                          : void
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        $tpl = $this->tpl;

        if (!$this->canGive() ||
            !$this->requested_peer_id ||
            !$this->requested_crit_id ||
            !$ilCtrl->isAsynch()) {
            exit();
        }

        $peer_id = $this->requested_peer_id;
        $crit_id = $this->requested_crit_id;
        $giver_id = $ilUser->getId();

        if (!is_numeric($crit_id)) {
            $crit = ilExcCriteria::getInstanceByType($crit_id);
        } else {
            $crit = ilExcCriteria::getInstanceById($crit_id);
        }
        $crit->setPeerReviewContext($this->ass, $giver_id, $peer_id);
        $html = $crit->updateFromAjax();

        $this->handlePeerReviewChange();

        echo $html;
        echo $tpl->getOnLoadCodeForAsynch();
        exit();
    }

Here is the call graph for this function:

updatePeerReviewObject()

ilExPeerReviewGUI::updatePeerReviewObject

(

)

Definition at line 682 of file class.ilExPeerReviewGUI.php.

References $ctrl, $lng, $requested_peer_id, $valid, canGive(), editPeerReviewItemObject(), handlePeerReviewChange(), initPeerReviewItemForm(), isValidPeer(), ILIAS\Repository\lng(), returnToParentObject(), and ilLanguage\txt().

                                            : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        if (!$this->canGive() ||
            !$this->isValidPeer($this->requested_peer_id)) {
            $this->returnToParentObject();
        }

        $peer_id = $this->requested_peer_id;

        $form = $this->initPeerReviewItemForm($peer_id);
        if ($form->checkInput()) {
            $valid = true;

            $values = array();
            foreach ($this->ass->getPeerReviewCriteriaCatalogueItems() as $item) {
                $item->setPeerReviewContext(
                    $this->ass,
                    $this->submission->getUserId(),
                    $peer_id,
                    $form
                );
                $value = $item->importFromPeerReviewForm();
                if ($value !== null) {
                    $crit_id = $item->getId()
                        ? $item->getId()
                        : $item->getType();
                    $values[$crit_id] = $value;
                }
                if (!$item->validate($value)) {
                    $valid = false;
                }
            }

            if ($valid) {
                $this->submission->getPeerReview()->updatePeerReview($peer_id, $values);

                $this->handlePeerReviewChange();

                $this->tpl->setOnScreenMessage('success', $this->lng->txt("exc_peer_review_updated"), true);
                $ilCtrl->redirect($this, "editPeerReview");
            } else {
                $this->tpl->setOnScreenMessage('failure', $lng->txt("form_input_not_valid"));
            }
        }

        $form->setValuesByPost();
        $this->editPeerReviewItemObject($form);
    }

Here is the call graph for this function:

Field Documentation

$ass

ilExAssignment ilExPeerReviewGUI::$ass

protected

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

Referenced by resetPeerReviewObject().

$ctrl

ilCtrl ilExPeerReviewGUI::$ctrl

protected

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

Referenced by confirmResetPeerReviewObject(), downloadPeerReviewObject(), executeCommand(), initPeerReviewItemForm(), resetPeerReviewObject(), showReceivedPeerReviewObject(), updateCritAjaxObject(), and updatePeerReviewObject().

$lng

ilLanguage ilExPeerReviewGUI::$lng

protected

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

Referenced by executeCommand(), getLateSubmissionInfo(), initPeerReviewItemForm(), renderInfoWidget(), showGivenPeerReviewObject(), showReceivedPeerReviewObject(), and updatePeerReviewObject().

$requested_crit_id

string ilExPeerReviewGUI::$requested_crit_id = ""

protected

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

Referenced by updateCritAjaxObject().

$requested_peer_id

int ilExPeerReviewGUI::$requested_peer_id = 0

protected

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

Referenced by executeCommand(), updateCritAjaxObject(), and updatePeerReviewObject().

$requested_review_crit_id

string ilExPeerReviewGUI::$requested_review_crit_id = ""

protected

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

Referenced by downloadPeerReviewObject().

$requested_review_giver_id

int ilExPeerReviewGUI::$requested_review_giver_id = 0

protected

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

Referenced by downloadPeerReviewObject(), and executeCommand().

$requested_review_peer_id

int ilExPeerReviewGUI::$requested_review_peer_id = 0

protected

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

Referenced by downloadPeerReviewObject(), and executeCommand().

$submission

ilExSubmission ilExPeerReviewGUI::$submission

protected

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

Referenced by resetPeerReviewObject().

$tabs_gui

ilTabsGUI ilExPeerReviewGUI::$tabs_gui

protected

Definition at line 29 of file class.ilExPeerReviewGUI.php.

Referenced by confirmResetPeerReviewObject(), and executeCommand().

$tpl

ilGlobalPageTemplate ilExPeerReviewGUI::$tpl

protected

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

Referenced by confirmResetPeerReviewObject(), editPeerReviewItemObject(), editPeerReviewObject(), showGivenPeerReviewObject(), showPeerReviewOverviewObject(), showReceivedPeerReviewObject(), and updateCritAjaxObject().

$user

ilObjUser ilExPeerReviewGUI::$user

protected

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

Referenced by updateCritAjaxObject().

---

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

• Modules/Exercise/PeerReview/class.ilExPeerReviewGUI.php