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, $a_def_json)

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

	$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

Reimplemented in ilExcCriteriaBool, ilExcCriteriaFile, ilExcCriteriaRating, and ilExcCriteriaText.

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

    {
        global $DIC;
 
        $this->db = $DIC->database();
    }

References $DIC.

Member Function Documentation

◆ addToPeerReviewForm()

ilExcCriteria::addToPeerReviewForm ( $a_value = null )

abstract

Reimplemented in ilExcCriteriaBool, ilExcCriteriaFile, ilExcCriteriaRating, and ilExcCriteriaText.

◆ cloneObject()

ilExcCriteria::cloneObject ( $a_target_parent_id )

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

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

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

Here is the call graph for this function:

◆ delete()

ilExcCriteria::delete ( )

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

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

References $db, and $ilDB.

◆ deleteByParent()

static ilExcCriteria::deleteByParent ( $a_parent_id )

static

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

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

References $DIC, and $ilDB.

Referenced by ilExcCriteriaCatalogue\delete().

Here is the caller graph for this function:

◆ exportCustomForm()

ilExcCriteria::exportCustomForm ( ilPropertyFormGUI $a_form )

Reimplemented in ilExcCriteriaText.

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

    {
        // type-specific
    }

Referenced by ilExcCriteriaGUI\exportForm().

Here is the caller graph for this function:

◆ getDBProperties()

ilExcCriteria::getDBProperties ( )

protected

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

    {
        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)
        );
    }

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

Referenced by save(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefinition()

ilExcCriteria::getDefinition ( )

protected

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

    {
        return $this->def;
    }

References $def.

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

Here is the caller graph for this function:

◆ getDescription()

ilExcCriteria::getDescription ( )

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

    {
        return $this->desc;
    }

References $desc.

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

Here is the caller graph for this function:

◆ getHTML()

ilExcCriteria::getHTML ( $a_value )

abstract

Reimplemented in ilExcCriteriaBool, ilExcCriteriaFile, ilExcCriteriaRating, and ilExcCriteriaText.

◆ getId()

ilExcCriteria::getId ( )

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

    {
        return $this->id;
    }

References $id.

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

Here is the caller graph for this function:

◆ getInstanceById()

static ilExcCriteria::getInstanceById ( $a_id )

static

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        $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;
        }
    }

References $DIC, $ilDB, and getInstanceByType().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstanceByType()

static ilExcCriteria::getInstanceByType ( $a_type )

static

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

    {
        $class = "ilExcCriteria" . ucfirst($a_type);
        return new $class;
    }

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

Here is the caller graph for this function:

◆ getInstancesByParentId()

static ilExcCriteria::getInstancesByParentId ( $a_parent_id )

static

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        $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;
    }

References $DIC, $ilDB, $res, and getInstanceByType().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastPosition()

ilExcCriteria::getLastPosition ( )

protected

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

    {
        $ilDB = $this->db;
        
        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"];
    }

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

Referenced by save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParent()

ilExcCriteria::getParent ( )

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

    {
        return $this->parent;
    }

References $parent.

Referenced by getLastPosition(), and save().

Here is the caller graph for this function:

◆ getPosition()

ilExcCriteria::getPosition ( )

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

    {
        return $this->pos;
    }

References $pos.

Referenced by cloneObject(), and getDBProperties().

Here is the caller graph for this function:

◆ getTitle()

ilExcCriteria::getTitle ( )

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

    {
        return $this->title;
    }

References $title.

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

Here is the caller graph for this function:

◆ getTranslatedType()

ilExcCriteria::getTranslatedType ( )

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

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

References getType(), and getTypesMap().

Referenced by ilExcCriteriaGUI\initForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilExcCriteria::getType ( )

abstract

Reimplemented in ilExcCriteriaBool, ilExcCriteriaFile, ilExcCriteriaRating, and ilExcCriteriaText.

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

Here is the caller graph for this function:

◆ getTypesMap()

static ilExcCriteria::getTypesMap ( )

static

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

    {
        global $DIC;
 
        $lng = $DIC->language();
        
        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")
        );
    }

References $DIC, and $lng.

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

Here is the caller graph for this function:

◆ hasValue()

ilExcCriteria::hasValue ( $a_value )

abstract

Reimplemented in ilExcCriteriaBool, ilExcCriteriaFile, ilExcCriteriaRating, and ilExcCriteriaText.

◆ importCustomForm()

ilExcCriteria::importCustomForm ( ilPropertyFormGUI $a_form )

Reimplemented in ilExcCriteriaText.

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

    {
        // type-specific
    }

Referenced by ilExcCriteriaGUI\importForm().

Here is the caller graph for this function:

◆ importDefinition()

ilExcCriteria::importDefinition	(	$a_def,
		$a_def_json
	)

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

    {
        // see #23711
        // use json, if given
        if ($a_def_json != "") {
            $def = json_decode($a_def_json, true);
            if (is_array($def)) {
                $this->setDefinition($def);
            }
            return;
        }
 
        // use unserialize only if php > 7
        if ($a_def != "" && version_compare(PHP_VERSION, '7.0.0') >= 0) {
            $a_def = @unserialize($a_def, false);
            if (is_array($a_def)) {
                $this->setDefinition($a_def);
            }
        }
    }

References $def, and setDefinition().

Here is the call graph for this function:

◆ importFromDB()

ilExcCriteria::importFromDB ( array $a_row )

protected

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

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

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

Here is the call graph for this function:

◆ importFromPeerReviewForm()

ilExcCriteria::importFromPeerReviewForm ( )

abstract

Reimplemented in ilExcCriteriaBool, ilExcCriteriaFile, ilExcCriteriaRating, and ilExcCriteriaText.

◆ initCustomForm()

ilExcCriteria::initCustomForm ( ilPropertyFormGUI $a_form )

Reimplemented in ilExcCriteriaText.

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

    {
        // type-specific
    }

Referenced by ilExcCriteriaGUI\initForm().

Here is the caller graph for this function:

◆ isRequired()

ilExcCriteria::isRequired ( )

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

    {
        return $this->required;
    }

References $required.

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

Here is the caller graph for this function:

◆ resetReview()

ilExcCriteria::resetReview ( )

Reimplemented in ilExcCriteriaFile, and ilExcCriteriaRating.

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

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

◆ save()

ilExcCriteria::save ( )

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

    {
        $ilDB = $this->db;
        
        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);
    }

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

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

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

    {
        $this->def = $a_value;
    }

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

Here is the caller graph for this function:

◆ setDescription()

ilExcCriteria::setDescription ( $a_value )

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

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

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

Here is the caller graph for this function:

◆ setId()

ilExcCriteria::setId ( $a_id )

protected

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

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

Referenced by importFromDB().

Here is the caller graph for this function:

◆ setParent()

ilExcCriteria::setParent ( $a_value )

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

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

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

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

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

◆ setPosition()

ilExcCriteria::setPosition ( $a_value )

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

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

Referenced by importFromDB().

Here is the caller graph for this function:

◆ setRequired()

ilExcCriteria::setRequired ( $a_value )

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

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

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

Here is the caller graph for this function:

◆ setTitle()

ilExcCriteria::setTitle ( $a_value )

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

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

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

Here is the caller graph for this function:

◆ update()

ilExcCriteria::update ( )

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateFromAjax()

ilExcCriteria::updateFromAjax ( )

Reimplemented in ilExcCriteriaRating.

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

    {
        // type-specific
    }

◆ validate()

ilExcCriteria::validate ( $a_value )

Reimplemented in ilExcCriteriaFile, ilExcCriteriaRating, and ilExcCriteriaText.

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

    {
        return true;
    }

Field Documentation

◆ $ass

ilExcCriteria::$ass

protected

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

◆ $db

ilExcCriteria::$db

protected

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

Referenced by delete(), getLastPosition(), save(), and update().

◆ $def

ilExcCriteria::$def

protected

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

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

◆ $desc

ilExcCriteria::$desc

protected

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

Referenced by getDescription().

◆ $form

ilExcCriteria::$form

protected

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

◆ $giver_id

ilExcCriteria::$giver_id

protected

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

◆ $id

ilExcCriteria::$id

protected

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

Referenced by getId().

◆ $parent

ilExcCriteria::$parent

protected

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

Referenced by getParent().

◆ $peer_id

ilExcCriteria::$peer_id

protected

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

◆ $pos

ilExcCriteria::$pos

protected

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

Referenced by getPosition().

◆ $required

ilExcCriteria::$required

protected

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

Referenced by isRequired().

◆ $title

ilExcCriteria::$title

protected

Definition at line 20 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

◆ $db

◆ $def

◆ $desc

◆ $form

◆ $giver_id

◆ $id

◆ $parent

◆ $peer_id

◆ $pos

◆ $required

◆ $title