ilExcCriteriaCatalogue Class Reference

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

Collaboration diagram for ilExcCriteriaCatalogue:

Public Member Functions
	__construct (int $a_id=null)
	getId ()
	setParent (?int $a_value)
	getParent ()
	setTitle (?string $a_value)
	getTitle ()
	setPosition (int $a_value)
	getPosition ()
	save ()
	update ()
	delete ()
	cloneObject (int $a_target_parent_id)

Static Public Member Functions
static	getInstancesByParentId (int $a_parent_id)

Protected Member Functions
	setId (int $a_id)
	importFromDB (array $a_row)
	getDBProperties ()
	getLastPosition ()
	read (?int $a_id)

Protected Attributes
ilDBInterface	$db
int	$id = null
int	$parent = null
string	$title = null
int	$pos = 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 ilExcCriteriaCatalogue

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 25 of file class.ilExcCriteriaCatalogue.php.

Constructor & Destructor Documentation

__construct()

ilExcCriteriaCatalogue::__construct

(

int

$a_id = null

)

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

References $DIC, and read().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->read($a_id);
    }

Here is the call graph for this function:

Member Function Documentation

cloneObject()

ilExcCriteriaCatalogue::cloneObject

(

int

$a_target_parent_id

)

Definition at line 207 of file class.ilExcCriteriaCatalogue.php.

References getId(), ilExcCriteria\getInstancesByParentId(), getPosition(), and getTitle().

                                                        : int
    {
        $new_obj = new self();
        $new_obj->setParent($a_target_parent_id);
        $new_obj->setTitle($this->getTitle());
        $new_obj->setPosition($this->getPosition());
        $new_obj->save();

        foreach (ilExcCriteria::getInstancesByParentId($this->getId()) as $crit) {
            $crit->cloneObject($new_obj->getId());
        }

        return $new_obj->getId();
    }

Here is the call graph for this function:

delete()

ilExcCriteriaCatalogue::delete

(

)

Definition at line 193 of file class.ilExcCriteriaCatalogue.php.

References $db, $ilDB, and ilExcCriteria\deleteByParent().

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

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

        ilExcCriteria::deleteByParent($this->id);

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

Here is the call graph for this function:

getDBProperties()

ilExcCriteriaCatalogue::getDBProperties ( )

protected

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

References getPosition(), and getTitle().

Referenced by save(), and update().

                                        : array
    {
        return array(
            "title" => array("text", $this->getTitle())
            ,"pos" => array("integer", $this->getPosition())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getId()

ilExcCriteriaCatalogue::getId

(

)

Definition at line 70 of file class.ilExcCriteriaCatalogue.php.

References $id.

Referenced by cloneObject().

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

Here is the caller graph for this function:

getInstancesByParentId()

static ilExcCriteriaCatalogue::getInstancesByParentId ( int  $a_parent_id )

static

Returns

self[]

Definition at line 44 of file class.ilExcCriteriaCatalogue.php.

References $DIC, $ilDB, and $res.

Referenced by ilExcCriteriaCatalogueGUI\confirmDeletion(), ilExcCriteriaCatalogueGUI\delete(), ilObjExercise\delete(), ilExcCriteriaCatalogueTableGUI\getItems(), ilExAssignmentEditorGUI\initPeerReviewForm(), ilObjExercise\saveData(), and ilExcCriteriaCatalogueGUI\saveOrder().

                                                                   : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $res = array();

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

        return $res;
    }

Here is the caller graph for this function:

getLastPosition()

ilExcCriteriaCatalogue::getLastPosition ( )

protected

Definition at line 131 of file class.ilExcCriteriaCatalogue.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_cat" .
            " 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()

ilExcCriteriaCatalogue::getParent

(

)

Definition at line 85 of file class.ilExcCriteriaCatalogue.php.

References $parent.

Referenced by getLastPosition(), and save().

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

Here is the caller graph for this function:

getPosition()

ilExcCriteriaCatalogue::getPosition

(

)

Definition at line 105 of file class.ilExcCriteriaCatalogue.php.

References $pos.

Referenced by cloneObject(), and getDBProperties().

                                 : int
    {
        return $this->pos;
    }

Here is the caller graph for this function:

getTitle()

ilExcCriteriaCatalogue::getTitle

(

)

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

References $title.

Referenced by cloneObject(), ilExcCriteriaCatalogueGUI\exportForm(), and getDBProperties().

                              : ?string
    {
        return $this->title;
    }

Here is the caller graph for this function:

importFromDB()

ilExcCriteriaCatalogue::importFromDB ( array  $a_row )

protected

Definition at line 115 of file class.ilExcCriteriaCatalogue.php.

References setId(), setParent(), setPosition(), and setTitle().

Referenced by read().

                                                 : void
    {
        $this->setId((int) $a_row["id"]);
        $this->setParent((int) $a_row["parent"]);
        $this->setTitle((string) $a_row["title"]);
        $this->setPosition((int) $a_row["pos"]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilExcCriteriaCatalogue::read ( ?int  $a_id )

protected

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

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

Referenced by __construct().

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

        if ($a_id > 0) {
            $set = $ilDB->query("SELECT *" .
                " FROM exc_crit_cat" .
                " WHERE id = " . $ilDB->quote($a_id, "integer"));
            if ($ilDB->numRows($set) !== 0) {
                $row = $ilDB->fetchAssoc($set);
                $this->importFromDB($row);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilExcCriteriaCatalogue::save

(

)

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

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

Referenced by update().

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

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

        $this->id = $ilDB->nextId("exc_crit_cat");

        $fields = $this->getDBProperties();
        $fields["parent"] = array("integer", $this->getParent());
        $fields["pos"] = array("integer", $this->getLastPosition() + 10);
        $fields["id"] = array("integer", $this->id);

        $ilDB->insert("exc_crit_cat", $fields);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setId()

ilExcCriteriaCatalogue::setId ( int  $a_id )

protected

Definition at line 75 of file class.ilExcCriteriaCatalogue.php.

Referenced by importFromDB().

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

Here is the caller graph for this function:

setParent()

ilExcCriteriaCatalogue::setParent

(

?int

$a_value

)

Definition at line 80 of file class.ilExcCriteriaCatalogue.php.

Referenced by importFromDB().

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

Here is the caller graph for this function:

setPosition()

ilExcCriteriaCatalogue::setPosition

(

int

$a_value

)

Definition at line 100 of file class.ilExcCriteriaCatalogue.php.

Referenced by importFromDB().

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

Here is the caller graph for this function:

setTitle()

ilExcCriteriaCatalogue::setTitle

(

?string

$a_value

)

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

Referenced by importFromDB().

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

Here is the caller graph for this function:

update()

ilExcCriteriaCatalogue::update

(

)

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

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

Referenced by save().

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

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

        $primary = array("id" => array("integer", $this->id));
        $ilDB->update("exc_crit_cat", $this->getDBProperties(), $primary);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$db

ilDBInterface ilExcCriteriaCatalogue::$db

protected

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

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

$id

int ilExcCriteriaCatalogue::$id = null

protected

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

Referenced by getId().

$parent

int ilExcCriteriaCatalogue::$parent = null

protected

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

Referenced by getParent().

$pos

int ilExcCriteriaCatalogue::$pos = 0

protected

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

Referenced by getPosition().

$title

string ilExcCriteriaCatalogue::$title = null

protected

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

Referenced by getTitle().

---

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

• Modules/Exercise/PeerReview/Criteria/class.ilExcCriteriaCatalogue.php