Inheritance diagram for ilExcCriteriaRating:

Collaboration diagram for ilExcCriteriaRating:

Public Member Functions
	__construct ()
	Constructor. More...

	getType ()

	addToPeerReviewForm ($a_value=null)

	importFromPeerReviewForm ()

	updateFromAjax ()

	validate ($a_value)

	hasValue ($a_value)

	getHTML ($a_value)

	resetReview ()

Public Member Functions inherited from ilExcCriteria
	__construct ()

	getTranslatedType ()

	getId ()

	getType ()

	setParent (?int $a_value)

	getParent ()

	setTitle (?string $a_value)

	getTitle ()

	setDescription (?string $a_value)

	getDescription ()

	setRequired (bool $a_value)

	isRequired ()

	setPosition (int $a_value)

	getPosition ()

	importDefinition (string $a_def, string $a_def_json)

	save ()

	update ()

	delete ()

	cloneObject (int $a_target_parent_id)

	initCustomForm (ilPropertyFormGUI $a_form)

	exportCustomForm (ilPropertyFormGUI $a_form)

	importCustomForm (ilPropertyFormGUI $a_form)

	setPeerReviewContext (ilExAssignment $a_ass, int $a_giver_id, int $a_peer_id, ?ilPropertyFormGUI $a_form=null)

	addToPeerReviewForm ($a_value=null)

	importFromPeerReviewForm ()

	updateFromAjax ()

	validate ($a_value)

	hasValue ($a_value)

	getHTML ($a_value)

	resetReview ()

Protected Member Functions
	getRatingSubType ()

	renderWidget (bool $a_read_only=false)

Protected Member Functions inherited from ilExcCriteria
	setId (?int $a_id)

	setDefinition (?array $a_value=null)

	getDefinition ()

	importFromDB (array $a_row)

	getDBProperties ()

	getLastPosition ()

Protected Attributes
ILIAS HTTP Services	$http

ilGlobalTemplateInterface	$tpl

ilCustomInputGUI	$form_item

GUIRequest	$request

Protected Attributes inherited from ilExcCriteria
ILIAS Exercise InternalGUIService	$gui

ilLanguage	$lng

ilCtrl	$ctrl

ilDBInterface	$db

int	$id = null

int	$parent = null

string	$title = ""

string	$desc = ""

bool	$required = false

int	$pos = 0

array	$def = null

ilPropertyFormGUI	$form = null

ilExAssignment	$ass

int	$giver_id = 0

int	$peer_id = 0

Additional Inherited Members
Static Public Member Functions inherited from ilExcCriteria
static	getInstanceById (int $a_id)

static	getInstancesByParentId (int $a_parent_id)

static	getTypesMap ()

static	getInstanceByType (string $a_type)

static	deleteByParent (int $a_parent_id)

Detailed Description

Class ilExcCriteriaRating.

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 27 of file class.ilExcCriteriaRating.php.

Constructor & Destructor Documentation

◆ __construct()

ilExcCriteriaRating::__construct ( )

Constructor.

Reimplemented from ilExcCriteria.

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

    {
        global $DIC;
 
        parent::__construct();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->request = $DIC->exercise()->internal()->gui()->request();
        $this->http = $DIC->http();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\FileDelivery\http().

Here is the call graph for this function:

Member Function Documentation

◆ addToPeerReviewForm()

ilExcCriteriaRating::addToPeerReviewForm ( $a_value = null )

Reimplemented from ilExcCriteria.

Definition at line 55 of file class.ilExcCriteriaRating.php.

                                                        : void
    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
 
        $tpl->addJavaScript("assets/js/ilExcPeerReview.js");
        $tpl->addOnLoadCode("il.ExcPeerReview.setAjax('" .
            $ilCtrl->getLinkTargetByClass("ilExPeerReviewGUI", "updateCritAjax", "", true, false) .
            "')");
 
        $field_id = "prccc_rating_" . $this->getId();
 
        $input = new ilCustomInputGUI($this->getTitle(), $field_id);
        $input->setInfo($this->getDescription());
        $input->setRequired($this->isRequired());
        $input->setHtml($this->renderWidget());
        $this->form->addItem($input);
 
        // #16993 - making form checkInput() work
        if ($this->hasValue("")) {
            $input->setSkipRequiredCheck(true);
        }
 
        $this->form_item = $input;
    }

References ilExcCriteria\$ctrl, $tpl, ILIAS\UICore\GlobalTemplate\addJavaScript(), ILIAS\UICore\GlobalTemplate\addOnLoadCode(), ILIAS\Repository\form(), ilExcCriteria\getDescription(), ilExcCriteria\getId(), ilExcCriteria\getTitle(), hasValue(), ilExcCriteria\isRequired(), and renderWidget().

Here is the call graph for this function:

◆ getHTML()

ilExcCriteriaRating::getHTML ( $a_value )

Reimplemented from ilExcCriteria.

Definition at line 159 of file class.ilExcCriteriaRating.php.

                                     : string
    {
        return $this->renderWidget(true);
    }

References renderWidget().

Here is the call graph for this function:

◆ getRatingSubType()

ilExcCriteriaRating::getRatingSubType ( )

protected

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

                                         : string
    {
        return $this->getId()
            ? "peer_" . $this->getId()
            : "peer"; // no catalogue / v1
    }

References ilExcCriteria\getId().

Here is the call graph for this function:

◆ getType()

ilExcCriteriaRating::getType ( )

Reimplemented from ilExcCriteria.

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

                             : string
    {
        return "rating";
    }

◆ hasValue()

ilExcCriteriaRating::hasValue ( $a_value )

Reimplemented from ilExcCriteria.

Definition at line 148 of file class.ilExcCriteriaRating.php.

                                      : bool
    {
        return (bool) ilRating::getRatingForUserAndObject(
            $this->ass->getId(),
            "ass",
            $this->peer_id,
            $this->getRatingSubType(),
            $this->giver_id
        );
    }

References ilRating\getRatingForUserAndObject().

Referenced by addToPeerReviewForm(), and validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importFromPeerReviewForm()

ilExcCriteriaRating::importFromPeerReviewForm ( )

Reimplemented from ilExcCriteria.

Definition at line 112 of file class.ilExcCriteriaRating.php.

                                              : void
    {
        // see updateFromAjax()
    }

◆ renderWidget()

ilExcCriteriaRating::renderWidget ( bool $a_read_only = false )

protected

Definition at line 88 of file class.ilExcCriteriaRating.php.

                                                              : string
    {
        $rating = new ilRatingGUI();
        $rating->setObject(
            $this->ass->getId(),
            "ass",
            $this->peer_id,
            $this->getRatingSubType()
        );
        $rating->setUserId($this->giver_id);
 
        $ajax_id = $this->getId()
            ?: "rating";
 
        if (!$a_read_only) {
            $html = '<div class="crit_widget" data-crit-id="' . $ajax_id . '">' .
                $rating->getHTML(false, true, "il.ExcPeerReview.saveCrit(this, " . $this->peer_id . ", '" . $ajax_id . "', %rating%)") .
            '</div>';
        } else {
            $html = $rating->getHTML(false, false);
        }
        return $html;
    }

References ilExcCriteria\getId().

Referenced by addToPeerReviewForm(), getHTML(), and updateFromAjax().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetReview()

ilExcCriteriaRating::resetReview ( )

Reimplemented from ilExcCriteria.

Definition at line 164 of file class.ilExcCriteriaRating.php.

                                 : void
    {
        ilRating::resetRatingForUserAndObject(
            $this->ass->getId(),
            "ass",
            $this->peer_id,
            $this->getRatingSubType(),
            $this->giver_id
        );
    }

References ilRating\resetRatingForUserAndObject().

Here is the call graph for this function:

◆ updateFromAjax()

ilExcCriteriaRating::updateFromAjax ( )

Reimplemented from ilExcCriteria.

Definition at line 117 of file class.ilExcCriteriaRating.php.

                                    : string
    {
        // save rating
        ilRating::writeRatingForUserAndObject(
            $this->ass->getId(),
            "ass",
            $this->peer_id,
            $this->getRatingSubType(),
            $this->giver_id,
            $this->request->getRatingValue()
        );
 
        // render current rating
        return $this->renderWidget();
    }

References renderWidget(), and ilRating\writeRatingForUserAndObject().

Here is the call graph for this function:

◆ validate()

ilExcCriteriaRating::validate ( $a_value )

Reimplemented from ilExcCriteria.

Definition at line 133 of file class.ilExcCriteriaRating.php.

                                      : bool
    {
        $lng = $this->lng;
 
        if ($this->isRequired()) {
            if (!$this->hasValue($a_value)) {
                if ($this->form) {
                    $this->form->getItemByPostVar("prccc_rating_" . $this->getId())->setAlert($lng->txt("msg_input_is_required"));
                }
                return false;
            }
        }
        return true;
    }