Inheritance diagram for ilExcCriteriaRating:

Collaboration diagram for ilExcCriteriaRating:

Public Member Functions
	getType ()

	addToPeerReviewForm ($a_value=null)

	importFromPeerReviewForm ()

	updateFromAjax ()

	validate ($a_value)

	hasValue ($a_value)

	getHTML ($a_value)

	resetReview ()

Public Member Functions inherited from ilExcCriteria
	getTranslatedType ()

	getId ()

	getType ()

	setParent ($a_value)

	getParent ()

	setTitle ($a_value)

	getTitle ()

	setDescription ($a_value)

	getDescription ()

	setRequired ($a_value)

	isRequired ()

	setPosition ($a_value)

	getPosition ()

	importDefinition ($a_def)

	save ()

	update ()

	delete ()

	cloneObject ($a_target_parent_id)

	initCustomForm (ilPropertyFormGUI $a_form)

	exportCustomForm (ilPropertyFormGUI $a_form)

	importCustomForm (ilPropertyFormGUI $a_form)

	setPeerReviewContext (ilExAssignment $a_ass, $a_giver_id, $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 ($a_read_only=false)

Protected Member Functions inherited from ilExcCriteria
	__construct ()

	setId ($a_id)

	setDefinition (array $a_value=null)

	getDefinition ()

	importFromDB (array $a_row)

	getDBProperties ()

	getLastPosition ()

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

static	getInstancesByParentId ($a_parent_id)

static	getTypesMap ()

static	getInstanceByType ($a_type)

static	deleteByParent ($a_parent_id)

Protected Attributes inherited from ilExcCriteria
	$id

	$parent

	$title

	$desc

	$required

	$pos

	$def

	$form

	$ass

	$giver_id

	$peer_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

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

Member Function Documentation

◆ addToPeerReviewForm()

ilExcCriteriaRating::addToPeerReviewForm ( $a_value = null )

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

References $_POST, $ilCtrl, $tpl, ilExcCriteria\getDescription(), ilExcCriteria\getTitle(), hasValue(), ilExcCriteria\isRequired(), and renderWidget().

         {
                 global $tpl, $ilCtrl;
                         
                 $tpl->addJavaScript("Modules/Exercise/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(is_array($_POST) && 
                         array_key_exists("cmd", $_POST))
                 {
                         $_POST[$field_id] = $this->hasValue($a_value);
                 }
                 
                 $this->form_item = $input;
         }

Here is the call graph for this function:

◆ getHTML()

ilExcCriteriaRating::getHTML ( $a_value )

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

References renderWidget().

         {                               
                 return $this->renderWidget($this->ass, $this->giver_id, $this->peer_id, true);  
         }

Here is the call graph for this function:

◆ getRatingSubType()

ilExcCriteriaRating::getRatingSubType ( )

protected

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

References ilExcCriteria\getId().

Referenced by hasValue(), renderWidget(), resetReview(), and updateFromAjax().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilExcCriteriaRating::getType ( )

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

         {
                 return "rating";
         }

◆ hasValue()

ilExcCriteriaRating::hasValue ( $a_value )

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

References ilExcCriteria\$giver_id, ilExcCriteria\$peer_id, ilRating\getRatingForUserAndObject(), and getRatingSubType().

Referenced by addToPeerReviewForm(), and validate().

         {
                 include_once './Services/Rating/classes/class.ilRating.php';
                 return (bool)ilRating::getRatingForUserAndObject(
                         $this->ass->getId(), 
                         "ass", 
                         $this->peer_id, 
                         $this->getRatingSubType(),
                         $this->giver_id
                 );                                      
         }               

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importFromPeerReviewForm()

ilExcCriteriaRating::importFromPeerReviewForm ( )

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

         {
                 // see updateFromAjax()
         }

◆ renderWidget()

ilExcCriteriaRating::renderWidget ( $a_read_only = false )

protected

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

References $html, ilExcCriteria\$peer_id, ilExcCriteria\getId(), and getRatingSubType().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetReview()

ilExcCriteriaRating::resetReview ( )

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

References ilExcCriteria\$giver_id, ilExcCriteria\$peer_id, getRatingSubType(), and ilRating\resetRatingForUserAndObject().

         {
                 include_once './Services/Rating/classes/class.ilRating.php';
                 ilRating::resetRatingForUserAndObject(
                         $this->ass->getId(), 
                         "ass", 
                         $this->peer_id, 
                         $this->getRatingSubType(),
                         $this->giver_id
                 );
         }

Here is the call graph for this function:

◆ updateFromAjax()

ilExcCriteriaRating::updateFromAjax ( )

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

References $_POST, ilExcCriteria\$giver_id, ilExcCriteria\$peer_id, getRatingSubType(), renderWidget(), and ilRating\writeRatingForUserAndObject().

         {                                               
                 // save rating
                 include_once './Services/Rating/classes/class.ilRating.php';
                 ilRating::writeRatingForUserAndObject(
                         $this->ass->getId(), 
                         "ass", 
                         $this->peer_id, 
                         $this->getRatingSubType(),
                         $this->giver_id, 
                         $_POST["value"]
                 );
                                 
                 // render current rating                
                 // $ilCtrl->setParameter($this->parent_obj, "peer_id", $peer_id);                               
                 return $this->renderWidget($a_ass, $a_giver_id, $a_peer_id);                                    
         }

Here is the call graph for this function:

◆ validate()

ilExcCriteriaRating::validate ( $a_value )

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

References $lng, ilExcCriteria\getId(), hasValue(), and ilExcCriteria\isRequired().

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

Here is the call graph for this function:

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

Modules/Exercise/classes/class.ilExcCriteriaRating.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addToPeerReviewForm()

◆ getHTML()

◆ getRatingSubType()

◆ getType()

◆ hasValue()

◆ importFromPeerReviewForm()

◆ renderWidget()

◆ resetReview()

◆ updateFromAjax()

◆ validate()