ilExcCriteria Class Reference

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

Inheritance diagram for ilExcCriteria:

Collaboration diagram for ilExcCriteria:

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

Static Public Member Functions
static	getInstanceById (int $a_id)
static	getInstancesByParentId (int $a_parent_id)
static	getTypesMap ()
static	getInstanceByType (string $a_type)
static	deleteByParent (int $a_parent_id)

Protected Member Functions
	setId (?int $a_id)
	setDefinition (?array $a_value=null)
	getDefinition ()
	importFromDB (array $a_row)
	getDBProperties ()
	getLastPosition ()

Protected Attributes
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

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 ilExcCriteria.

Note: This class does stuff on application and gui layer and should be divided in multiple interfaces.

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

Constructor & Destructor Documentation

__construct()

ilExcCriteria::__construct

(

)

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

References $DIC, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
    }

Here is the call graph for this function:

Member Function Documentation

addToPeerReviewForm()

ilExcCriteria::addToPeerReviewForm (   $a_value = null )

abstract

Referenced by setPeerReviewContext().

Here is the caller graph for this function:

cloneObject()

ilExcCriteria::cloneObject

(

int

$a_target_parent_id

)

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

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

                                                        : ?int
    {
        $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 308 of file class.ilExcCriteria.php.

References $db, and $ilDB.

                            : void
    {
        $ilDB = $this->db;

        if (!$this->id) {
            return;
        }

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

deleteByParent()

static ilExcCriteria::deleteByParent ( int  $a_parent_id )

static

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

References $DIC, and $ilDB.

Referenced by ilExcCriteriaCatalogue\delete().

                                                           : void
    {
        global $DIC;

        $ilDB = $DIC->database();

        if (!$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 358 of file class.ilExcCriteria.php.

Referenced by ilExcCriteriaGUI\exportForm().

                                                               : void
    {
        // type-specific
    }

Here is the caller graph for this function:

getDBProperties()

ilExcCriteria::getDBProperties ( )

protected

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

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

Referenced by save(), and update().

                                        : array
    {
        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 201 of file class.ilExcCriteria.php.

References $def.

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

                                      : ?array
    {
        return $this->def;
    }

Here is the caller graph for this function:

getDescription()

ilExcCriteria::getDescription

(

)

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

References $desc.

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

                                    : string
    {
        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 134 of file class.ilExcCriteria.php.

References $id.

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

                           : ?int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getInstanceById()

static ilExcCriteria::getInstanceById ( int  $a_id )

static

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

References $DIC, $ilDB, and null.

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

                                                     : ?ilExcCriteria
    {
        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;
        }

        return null;
    }

Here is the caller graph for this function:

getInstanceByType()

static ilExcCriteria::getInstanceByType ( string  $a_type )

static

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

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

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

Here is the caller graph for this function:

getInstancesByParentId()

static ilExcCriteria::getInstancesByParentId ( int  $a_parent_id )

static

Parameters

int

$a_parent_id

Returns

ilExcCriteria[]

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

References $DIC, $ilDB, and $res.

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

                                                                   : array
    {
        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;
    }

Here is the caller graph for this function:

getLastPosition()

ilExcCriteria::getLastPosition ( )

protected

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

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

Referenced by save().

                                        : int
    {
        $ilDB = $this->db;

        if (!$this->getParent()) {
            return 0;
        }

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

References $parent.

Referenced by getLastPosition(), and save().

                               : ?int
    {
        return $this->parent;
    }

Here is the caller graph for this function:

getPosition()

ilExcCriteria::getPosition

(

)

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

References $pos.

Referenced by cloneObject(), and getDBProperties().

                                 : int
    {
        return $this->pos;
    }

Here is the caller graph for this function:

getTitle()

ilExcCriteria::getTitle

(

)

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

References $title.

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

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getTranslatedType()

ilExcCriteria::getTranslatedType

(

)

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

References getType(), and getTypesMap().

Referenced by ilExcCriteriaGUI\initForm().

                                       : string
    {
        $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 103 of file class.ilExcCriteria.php.

References $DIC, and ilLanguage\txt().

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

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

Here is the call graph for this function:

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

Referenced by ilExcCriteriaGUI\importForm().

                                                               : void
    {
        // type-specific
    }

Here is the caller graph for this function:

importDefinition()

ilExcCriteria::importDefinition	(	string	$a_def,
		string	$a_def_json
	)

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

References setDefinition().

                                                                       : void
    {
        // 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, ['allowed_classes' => false]);
            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 232 of file class.ilExcCriteria.php.

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

    {
        $this->setId((int) $a_row["id"]);
        $this->setParent((int) $a_row["parent"]);
        $this->setTitle((string) $a_row["title"]);
        $this->setDescription((string) $a_row["descr"]);
        $this->setRequired((bool) $a_row["required"]);
        $this->setPosition((int) $a_row["pos"]);
        $this->setDefinition((string) $a_row["def"]
                ? unserialize((string) $a_row["def"], ['allowed_classes' => false])
                : 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 353 of file class.ilExcCriteria.php.

Referenced by ilExcCriteriaGUI\initForm().

                                                             : void
    {
        // type-specific
    }

Here is the caller graph for this function:

isRequired()

ilExcCriteria::isRequired

(

)

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

References $required.

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

                                : bool
    {
        return $this->required;
    }

Here is the caller graph for this function:

resetReview()

ilExcCriteria::resetReview

(

)

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

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

save()

ilExcCriteria::save

(

)

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

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

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

                          : void
    {
        $ilDB = $this->db;

        if ($this->id) {
            $this->update();
            return;
        }

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

(

?string

$a_value

)

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

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

                                                    : void
    {
        $this->desc = $a_value;
    }

Here is the caller graph for this function:

setId()

ilExcCriteria::setId ( ?int  $a_id )

protected

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

References getType().

Referenced by importFromDB().

                                        : void
    {
        $this->id = $a_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setParent()

ilExcCriteria::setParent

(

?int

$a_value

)

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

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

                                            : void
    {
        $this->parent = $a_value;
    }

Here is the caller graph for this function:

setPeerReviewContext()

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

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

References addToPeerReviewForm(), ILIAS\Repository\form(), importFromPeerReviewForm(), and null.

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

(

int

$a_value

)

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

Referenced by importFromDB().

                                             : void
    {
        $this->pos = $a_value;
    }

Here is the caller graph for this function:

setRequired()

ilExcCriteria::setRequired

(

bool

$a_value

)

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

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

                                              : void
    {
        $this->required = $a_value;
    }

Here is the caller graph for this function:

setTitle()

ilExcCriteria::setTitle

(

?string

$a_value

)

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

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

                                              : void
    {
        $this->title = $a_value;
    }

Here is the caller graph for this function:

update()

ilExcCriteria::update

(

)

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

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

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

                            : void
    {
        $ilDB = $this->db;

        if (!$this->id) {
            $this->save();
            return;
        }

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

                                    : string
    {
        return "";
    }

validate()

ilExcCriteria::validate

(

$a_value

)

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

References getHTML(), and hasValue().

                                      : bool
    {
        return true;
    }

Here is the call graph for this function:

Field Documentation

$ass

ilExAssignment ilExcCriteria::$ass

protected

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

$ctrl

ilCtrl ilExcCriteria::$ctrl

protected

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

Referenced by ilExcCriteriaRating\addToPeerReviewForm(), and ilExcCriteriaFile\getHTML().

$db

ilDBInterface ilExcCriteria::$db

protected

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

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

$def

array ilExcCriteria::$def = null

protected

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

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

$desc

string ilExcCriteria::$desc = ""

protected

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

Referenced by getDescription().

$form

ilPropertyFormGUI ilExcCriteria::$form = null

protected

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

$giver_id

int ilExcCriteria::$giver_id = 0

protected

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

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

$id

int ilExcCriteria::$id = null

protected

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

Referenced by getId().

$lng

ilLanguage ilExcCriteria::$lng

protected

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

Referenced by ilExcCriteriaBool\addToPeerReviewForm(), ilExcCriteriaText\addToPeerReviewForm(), ilExcCriteriaBool\getHTML(), ilExcCriteriaText\initCustomForm(), ilExcCriteriaFile\validate(), ilExcCriteriaText\validate(), and ilExcCriteriaRating\validate().

$parent

int ilExcCriteria::$parent = null

protected

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

Referenced by getParent().

$peer_id

int ilExcCriteria::$peer_id = 0

protected

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

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

$pos

int ilExcCriteria::$pos = 0

protected

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

Referenced by getPosition().

$required

bool ilExcCriteria::$required = false

protected

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

Referenced by isRequired().

$title

string ilExcCriteria::$title = ""

protected

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

Referenced by getTitle().

---

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

• components/ILIAS/Exercise/PeerReview/Criteria/class.ilExcCriteria.php