Inheritance diagram for ilExcCriteria:

Collaboration diagram for ilExcCriteria:

Public Member Functions
	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 ()

Static Public Member Functions
static	getInstanceById ($a_id)

static	getInstancesByParentId ($a_parent_id)

static	getTypesMap ()

static	getInstanceByType ($a_type)

static	deleteByParent ($a_parent_id)

Protected Member Functions
	__construct ()

	setId ($a_id)

	setDefinition (array $a_value=null)

	getDefinition ()

	importFromDB (array $a_row)

	getDBProperties ()

	getLastPosition ()

Protected Attributes
	$id

	$parent

	$title

	$desc

	$required

	$pos

	$def

	$form

	$ass

	$giver_id

	$peer_id

Detailed Description

Class ilExcCriteria.

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 11 of file class.ilExcCriteria.php.

Constructor & Destructor Documentation

◆ __construct()

ilExcCriteria::__construct ( )

protected

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

         {       
                 
         }

Member Function Documentation

◆ addToPeerReviewForm()

ilExcCriteria::addToPeerReviewForm ( $a_value = null )

abstract

Referenced by setPeerReviewContext().

Here is the caller graph for this function:

◆ cloneObject()

ilExcCriteria::cloneObject ( $a_target_parent_id )

Definition at line 299 of file class.ilExcCriteria.php.

References getDefinition(), getDescription(), getInstanceByType(), getPosition(), getTitle(), getType(), and isRequired().

         {
                 $new_obj = ilExcCriteria::getInstanceByType($this->getType());
                 $new_obj->setParent($a_target_parent_id);
                 $new_obj->setTitle($this->getTitle());
                 $new_obj->setDescription($this->getDescription());
                 $new_obj->setRequired($this->isRequired());
                 $new_obj->setPosition($this->getPosition());
                 $new_obj->setDefinition($this->getDefinition());
                 $new_obj->save();       
                 
                 return $new_obj->getId();
         }

Here is the call graph for this function:

◆ delete()

ilExcCriteria::delete ( )

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

References $ilDB.

         {
                 global $ilDB;
                 
                 if(!$this->id)
                 {
                         return;
                 }
                                 
                 $ilDB->manipulate("DELETE FROM exc_crit".
                         " WHERE id = ".$ilDB->quote($this->id, "integer"));
         }

◆ deleteByParent()

static ilExcCriteria::deleteByParent ( $a_parent_id )

static

Definition at line 286 of file class.ilExcCriteria.php.

References $ilDB.

Referenced by ilExcCriteriaCatalogue\delete().

         {
                 global $ilDB;
                 
                 if(!(int)$a_parent_id)
                 {
                         return;
                 }
                 
                 $ilDB->manipulate("DELETE FROM exc_crit".
                         " WHERE parent = ".$ilDB->quote($a_parent_id, "integer"));      
         }

Here is the caller graph for this function:

◆ exportCustomForm()

ilExcCriteria::exportCustomForm ( ilPropertyFormGUI $a_form )

Definition at line 323 of file class.ilExcCriteria.php.

Referenced by ilExcCriteriaGUI\exportForm().

         {
                 // type-specific
         }

Here is the caller graph for this function:

◆ getDBProperties()

ilExcCriteria::getDBProperties ( )

protected

Definition at line 210 of file class.ilExcCriteria.php.

References getDefinition(), getDescription(), getPosition(), getTitle(), getType(), and isRequired().

Referenced by save(), and update().

         {
                 return array(
                         "type" => array("text", $this->getType())
                         ,"title" => array("text", $this->getTitle())
                         ,"descr" => array("text", $this->getDescription())
                         ,"required" => array("integer", $this->isRequired())
                         ,"pos" => array("integer", $this->getPosition())
                         ,"def" => array("text", is_array($this->getDefinition())
                                 ? serialize($this->getDefinition())
                                 : null)
                 );              
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefinition()

ilExcCriteria::getDefinition ( )

protected

Definition at line 175 of file class.ilExcCriteria.php.

References $def.

Referenced by cloneObject(), getDBProperties(), and ilExcCriteriaText\getMinChars().

         {
                 return $this->def;
         }

Here is the caller graph for this function:

◆ getDescription()

ilExcCriteria::getDescription ( )

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

References $desc.

Referenced by ilExcCriteriaBool\addToPeerReviewForm(), ilExcCriteriaRating\addToPeerReviewForm(), ilExcCriteriaFile\addToPeerReviewForm(), ilExcCriteriaText\addToPeerReviewForm(), cloneObject(), ilExcCriteriaGUI\exportForm(), and getDBProperties().

         {
                 return $this->desc;
         }

Here is the caller graph for this function:

◆ getHTML()

ilExcCriteria::getHTML ( $a_value )

abstract

Referenced by validate().

Here is the caller graph for this function:

◆ getId()

ilExcCriteria::getId ( )

Definition at line 102 of file class.ilExcCriteria.php.

References $id.

Referenced by ilExcCriteriaBool\addToPeerReviewForm(), ilExcCriteriaFile\addToPeerReviewForm(), ilExcCriteriaText\addToPeerReviewForm(), ilExcCriteriaFile\getHTML(), ilExcCriteriaRating\getRatingSubType(), ilExcCriteriaGUI\importForm(), ilExcCriteriaBool\importFromPeerReviewForm(), ilExcCriteriaFile\importFromPeerReviewForm(), ilExcCriteriaGUI\initForm(), ilExcCriteriaFile\initStorage(), ilExcCriteriaRating\renderWidget(), ilExcCriteriaFile\validate(), ilExcCriteriaText\validate(), and ilExcCriteriaRating\validate().

         {
                 return $this->id;
         }

Here is the caller graph for this function:

◆ getInstanceById()

static ilExcCriteria::getInstanceById ( $a_id )

static

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

References $ilDB, and $row.

Referenced by ilExPeerReviewGUI\downloadPeerReviewObject(), ilExcCriteriaGUI\getCurrentCritera(), and ilExPeerReviewGUI\updateCritAjaxObject().

         {
                 global $ilDB;
                 
                 $set = $ilDB->query("SELECT *".
                         " FROM exc_crit".
                         " WHERE id = ".$ilDB->quote($a_id, "integer"));
                 if($ilDB->numRows($set))
                 {
                         $row = $ilDB->fetchAssoc($set);
                         $obj = self::getInstanceByType($row["type"]);
                         $obj->importFromDB($row);
                         return $obj;
                 }
         }               

Here is the caller graph for this function:

◆ getInstanceByType()

static ilExcCriteria::getInstanceByType ( $a_type )

static

Definition at line 90 of file class.ilExcCriteria.php.

Referenced by ilExcCriteriaGUI\add(), cloneObject(), ilExcCriteriaGUI\create(), ilExPeerReviewGUI\downloadPeerReviewObject(), ilExAssignment\getPeerReviewCriteriaCatalogueItems(), ilExerciseDataSet\importRecord(), and ilExPeerReviewGUI\updateCritAjaxObject().

         {
                 $class = "ilExcCriteria".ucfirst($a_type);
                 include_once "Modules/Exercise/classes/class.".$class.".php";
                 return new $class;
         }

Here is the caller graph for this function:

◆ getInstancesByParentId()

static ilExcCriteria::getInstancesByParentId ( $a_parent_id )

static

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

References $ilDB, $res, and $row.

Referenced by ilExcCriteriaCatalogue\cloneObject(), ilExcCriteriaGUI\confirmDeletion(), ilExcCriteriaGUI\delete(), ilExcCriteriaTableGUI\getItems(), ilExcCriteriaCatalogueTableGUI\getItems(), ilExAssignment\getPeerReviewCriteriaCatalogueItems(), ilExAssignmentEditorGUI\initPeerReviewForm(), and ilExcCriteriaGUI\saveOrder().

         {
                 global $ilDB;
                 
                 $res = array();
                 
                 $set = $ilDB->query("SELECT *".
                         " FROM exc_crit".
                         " WHERE parent = ".$ilDB->quote($a_parent_id, "integer").
                         " ORDER BY pos");
                 while($row = $ilDB->fetchAssoc($set))
                 {
                         $obj = self::getInstanceByType($row["type"]);
                         $obj->importFromDB($row);
                         $res[$obj->getId()] = $obj;
                 }       
                 
                 return $res;
         }

Here is the caller graph for this function:

◆ getLastPosition()

ilExcCriteria::getLastPosition ( )

protected

Definition at line 223 of file class.ilExcCriteria.php.

References $ilDB, $row, and getParent().

Referenced by save().

         {
                 global $ilDB;
                 
                 if(!$this->getParent())
                 {
                         return;
                 }
                 
                 $set = $ilDB->query("SELECT MAX(pos) pos".
                         " FROM exc_crit".
                         " WHERE parent = ".$ilDB->quote($this->getParent(), "integer"));
                 $row = $ilDB->fetchAssoc($set);         
                 return (int)$row["pos"];
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParent()

ilExcCriteria::getParent ( )

Definition at line 121 of file class.ilExcCriteria.php.

References $parent.

Referenced by getLastPosition(), and save().

         {
                 return $this->parent;
         }

Here is the caller graph for this function:

◆ getPosition()

ilExcCriteria::getPosition ( )

Definition at line 165 of file class.ilExcCriteria.php.

References $pos.

Referenced by cloneObject(), and getDBProperties().

         {
                 return $this->pos;
         }

Here is the caller graph for this function:

◆ getTitle()

ilExcCriteria::getTitle ( )

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

References $title.

Referenced by ilExcCriteriaBool\addToPeerReviewForm(), ilExcCriteriaRating\addToPeerReviewForm(), ilExcCriteriaFile\addToPeerReviewForm(), ilExcCriteriaText\addToPeerReviewForm(), cloneObject(), ilExcCriteriaGUI\exportForm(), and getDBProperties().

         {
                 return $this->title;
         }

Here is the caller graph for this function:

◆ getTranslatedType()

ilExcCriteria::getTranslatedType ( )

Definition at line 84 of file class.ilExcCriteria.php.

References getType(), and getTypesMap().

Referenced by ilExcCriteriaGUI\initForm().

         {
                 $map = $this->getTypesMap();
                 return $map[$this->getType()];
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilExcCriteria::getType ( )

abstract

Referenced by cloneObject(), getDBProperties(), getTranslatedType(), save(), and setId().

Here is the caller graph for this function:

◆ getTypesMap()

static ilExcCriteria::getTypesMap ( )

static

Definition at line 72 of file class.ilExcCriteria.php.

References $lng.

Referenced by getTranslatedType(), and ilExcCriteriaGUI\view().

         {
                 global $lng;
                 
                 return array(
                         "bool" => $lng->txt("exc_criteria_type_bool")
                         ,"rating" => $lng->txt("exc_criteria_type_rating")
                         ,"text" => $lng->txt("exc_criteria_type_text")
                         ,"file" => $lng->txt("exc_criteria_type_file")                  
                 );
         }

Here is the caller graph for this function:

◆ hasValue()

ilExcCriteria::hasValue ( $a_value )

abstract

Referenced by validate().

Here is the caller graph for this function:

◆ importCustomForm()

ilExcCriteria::importCustomForm ( ilPropertyFormGUI $a_form )

Definition at line 328 of file class.ilExcCriteria.php.

Referenced by ilExcCriteriaGUI\importForm().

         {
                 // type-specific
         }       

Here is the caller graph for this function:

◆ importDefinition()

ilExcCriteria::importDefinition ( $a_def )

Definition at line 180 of file class.ilExcCriteria.php.

References setDefinition().

         {
                 if($a_def)
                 {
                         $a_def = @unserialize($a_def);
                         if(is_array($a_def))
                         {
                                 $this->setDefinition($a_def);
                         }
                 }               
         }

Here is the call graph for this function:

◆ importFromDB()

ilExcCriteria::importFromDB ( array $a_row )

protected

Definition at line 197 of file class.ilExcCriteria.php.

References setDefinition(), setDescription(), setId(), setParent(), setPosition(), setRequired(), and setTitle().

         {               
                 $this->setId($a_row["id"]);
                 $this->setParent($a_row["parent"]);
                 $this->setTitle($a_row["title"]);
                 $this->setDescription($a_row["descr"]);
                 $this->setRequired($a_row["required"]);
                 $this->setPosition($a_row["pos"]);
                 $this->setDefinition($a_row["def"] 
                                 ? unserialize($a_row["def"]) 
                                 : null);
         }

Here is the call graph for this function:

◆ importFromPeerReviewForm()

ilExcCriteria::importFromPeerReviewForm ( )

abstract

Referenced by setPeerReviewContext().

Here is the caller graph for this function:

◆ initCustomForm()

ilExcCriteria::initCustomForm ( ilPropertyFormGUI $a_form )

Definition at line 318 of file class.ilExcCriteria.php.

Referenced by ilExcCriteriaGUI\initForm().

         {
                 // type-specific
         }

Here is the caller graph for this function:

◆ isRequired()

ilExcCriteria::isRequired ( )

Definition at line 155 of file class.ilExcCriteria.php.

References $required.

Referenced by ilExcCriteriaBool\addToPeerReviewForm(), ilExcCriteriaRating\addToPeerReviewForm(), ilExcCriteriaFile\addToPeerReviewForm(), ilExcCriteriaText\addToPeerReviewForm(), cloneObject(), ilExcCriteriaGUI\exportForm(), getDBProperties(), ilExcCriteriaBool\getHTML(), ilExcCriteriaFile\validate(), ilExcCriteriaText\validate(), and ilExcCriteriaRating\validate().

         {
                 return $this->required;
         }

Here is the caller graph for this function:

◆ resetReview()

ilExcCriteria::resetReview ( )

Definition at line 362 of file class.ilExcCriteria.php.

         {
                 // type-specific (only needed for data not kept in exc_assignment_peer)
         }

◆ save()

ilExcCriteria::save ( )

Definition at line 239 of file class.ilExcCriteria.php.

References $ilDB, getDBProperties(), getLastPosition(), getParent(), getType(), and update().

Referenced by ilExcCriteriaGUI\importForm(), and update().

         {
                 global $ilDB;
                 
                 if($this->id)
                 {
                         return $this->update();
                 }
                 
                 $this->id = $ilDB->nextId("exc_crit");
                 
                 $fields = $this->getDBProperties();             
                 
                 $fields["id"] = array("integer", $this->id);
                 $fields["type"] = array("text", $this->getType());
                 $fields["parent"] = array("integer", $this->getParent());
                 $fields["pos"] = array("integer", $this->getLastPosition()+10);
                 
                 $ilDB->insert("exc_crit", $fields);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefinition()

ilExcCriteria::setDefinition ( array $a_value = null )

protected

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

Referenced by ilExcCriteriaText\importCustomForm(), importDefinition(), importFromDB(), and ilExcCriteriaText\setMinChars().

         {
                 $this->def = $a_value;
         }

Here is the caller graph for this function:

◆ setDescription()

ilExcCriteria::setDescription ( $a_value )

Definition at line 138 of file class.ilExcCriteria.php.

Referenced by ilExcCriteriaGUI\importForm(), and importFromDB().

         {
                 $this->desc = ($a_value !== null)
                         ? trim($a_value)
                         : null;
         }

Here is the caller graph for this function:

◆ setId()

ilExcCriteria::setId ( $a_id )

protected

Definition at line 107 of file class.ilExcCriteria.php.

References getType().

Referenced by importFromDB().

         {
                 $this->id = (int)$a_id;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setParent()

ilExcCriteria::setParent ( $a_value )

Definition at line 114 of file class.ilExcCriteria.php.

Referenced by ilExcCriteriaGUI\importForm(), and importFromDB().

         {
                 $this->parent = ($a_value !== null)
                         ? (int)$a_value
                         : null;
         }

Here is the caller graph for this function:

◆ setPeerReviewContext()

ilExcCriteria::setPeerReviewContext	(	ilExAssignment	$a_ass,
			$a_giver_id,
			$a_peer_id,
		ilPropertyFormGUI	$a_form = `null`
	)

Definition at line 336 of file class.ilExcCriteria.php.

References addToPeerReviewForm(), and importFromPeerReviewForm().

         {
                 $this->form = $a_form;
                 $this->ass = $a_ass;
                 $this->giver_id = $a_giver_id;
                 $this->peer_id = $a_peer_id;
         }

Here is the call graph for this function:

◆ setPosition()

ilExcCriteria::setPosition ( $a_value )

Definition at line 160 of file class.ilExcCriteria.php.

Referenced by importFromDB().

         {
                 $this->pos = (int)$a_value;
         }

Here is the caller graph for this function:

◆ setRequired()

ilExcCriteria::setRequired ( $a_value )

Definition at line 150 of file class.ilExcCriteria.php.

Referenced by ilExcCriteriaGUI\importForm(), and importFromDB().

         {
                 $this->required = (bool)$a_value;
         }

Here is the caller graph for this function:

◆ setTitle()

ilExcCriteria::setTitle ( $a_value )

Definition at line 126 of file class.ilExcCriteria.php.

Referenced by ilExcCriteriaGUI\importForm(), and importFromDB().

         {
                 $this->title = ($a_value !== null)
                         ? trim($a_value)
                         : null;
         }

Here is the caller graph for this function:

◆ update()

ilExcCriteria::update ( )

Definition at line 260 of file class.ilExcCriteria.php.

References $ilDB, getDBProperties(), and save().

Referenced by ilExcCriteriaGUI\importForm(), and save().

         {
                 global $ilDB;
                 
                 if(!$this->id)
                 {
                         return $this->save();
                 }
                 
                 $primary = array("id"=>array("integer", $this->id));            
                 $ilDB->update("exc_crit", $this->getDBProperties(), $primary);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateFromAjax()

ilExcCriteria::updateFromAjax ( )

Definition at line 348 of file class.ilExcCriteria.php.

         {
                 // type-specific
         }               

◆ validate()

ilExcCriteria::validate ( $a_value )

Definition at line 353 of file class.ilExcCriteria.php.

References getHTML(), and hasValue().

         {
                 return true;
         }

Here is the call graph for this function:

Field Documentation

◆ $ass

ilExcCriteria::$ass

protected

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

◆ $def

ilExcCriteria::$def

protected

Definition at line 19 of file class.ilExcCriteria.php.

Referenced by getDefinition(), and ilExcCriteriaText\getMinChars().

◆ $desc

ilExcCriteria::$desc

protected

Definition at line 16 of file class.ilExcCriteria.php.

Referenced by getDescription().

◆ $form

ilExcCriteria::$form

protected

Definition at line 21 of file class.ilExcCriteria.php.

◆ $giver_id

ilExcCriteria::$giver_id

protected

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

Referenced by ilExcCriteriaRating\hasValue(), ilExcCriteriaRating\resetReview(), and ilExcCriteriaRating\updateFromAjax().

◆ $id

ilExcCriteria::$id

protected

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

Referenced by getId().

◆ $parent

ilExcCriteria::$parent

protected

Definition at line 14 of file class.ilExcCriteria.php.

Referenced by getParent().

◆ $peer_id

ilExcCriteria::$peer_id

protected

Definition at line 24 of file class.ilExcCriteria.php.

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

◆ $pos

ilExcCriteria::$pos

protected

Definition at line 18 of file class.ilExcCriteria.php.

Referenced by getPosition().

◆ $required

ilExcCriteria::$required

protected

Definition at line 17 of file class.ilExcCriteria.php.

Referenced by isRequired().

◆ $title

ilExcCriteria::$title

protected

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

Referenced by getTitle().

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

Modules/Exercise/classes/class.ilExcCriteria.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addToPeerReviewForm()

◆ cloneObject()

◆ delete()

◆ deleteByParent()

◆ exportCustomForm()

◆ getDBProperties()

◆ getDefinition()

◆ getDescription()

◆ getHTML()

◆ getId()

◆ getInstanceById()

◆ getInstanceByType()

◆ getInstancesByParentId()

◆ getLastPosition()

◆ getParent()

◆ getPosition()

◆ getTitle()

◆ getTranslatedType()

◆ getType()

◆ getTypesMap()

◆ hasValue()

◆ importCustomForm()

◆ importDefinition()

◆ importFromDB()

◆ importFromPeerReviewForm()

◆ initCustomForm()

◆ isRequired()

◆ resetReview()

◆ save()

◆ setDefinition()

◆ setDescription()

◆ setId()

◆ setParent()

◆ setPeerReviewContext()

◆ setPosition()

◆ setRequired()

◆ setTitle()

◆ update()

◆ updateFromAjax()

◆ validate()

Field Documentation

◆ $ass

◆ $def

◆ $desc

◆ $form

◆ $giver_id

◆ $id

◆ $parent

◆ $peer_id

◆ $pos

◆ $required

◆ $title