ilExcCriteriaCatalogue Class Reference

Class ilExcCriteriaCatalogue. More...

Collaboration diagram for ilExcCriteriaCatalogue:

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

Static Public Member Functions
static	getInstancesByParentId ($a_parent_id)
static	deleteByParent ($a_parent_id)

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

Protected Attributes
	$db
	$id
	$parent
	$title
	$pos

Detailed Description

Class ilExcCriteriaCatalogue.

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.ilExcCriteriaCatalogue.php.

Constructor & Destructor Documentation

__construct()

ilExcCriteriaCatalogue::__construct

(

$a_id = null

)

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

(

$a_target_parent_id

)

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

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

    {
        $new_obj = new self();
        $new_obj->setParent($a_target_parent_id);
        $new_obj->setTitle($this->getTitle());
        $new_obj->setPosition($this->getPosition());
        $new_obj->save();
        
        include_once "Modules/Exercise/classes/class.ilExcCriteria.php";
        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 182 of file class.ilExcCriteriaCatalogue.php.

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

    {
        $ilDB = $this->db;
        
        if (!$this->id) {
            return;
        }
        
        include_once "Modules/Exercise/classes/class.ilExcCriteria.php";
        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:

deleteByParent()

static ilExcCriteriaCatalogue::deleteByParent (   $a_parent_id )

static

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

References $DIC, and $ilDB.

Referenced by ilObjExercise\delete().

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

Here is the caller graph for this function:

getDBProperties()

ilExcCriteriaCatalogue::getDBProperties ( )

protected

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

References getPosition(), and getTitle().

Referenced by save(), and update().

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

References $id.

Referenced by cloneObject().

    {
        return $this->id;
    }

Here is the caller graph for this function:

getInstancesByParentId()

static ilExcCriteriaCatalogue::getInstancesByParentId (   $a_parent_id )

static

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

References $DIC, $ilDB, $res, and $row.

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

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

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

Referenced by save().

    {
        $ilDB = $this->db;
        
        if (!$this->getParent()) {
            return;
        }
        
        $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 74 of file class.ilExcCriteriaCatalogue.php.

References $parent.

Referenced by getLastPosition(), and save().

    {
        return $this->parent;
    }

Here is the caller graph for this function:

getPosition()

ilExcCriteriaCatalogue::getPosition

(

)

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

References $pos.

Referenced by cloneObject(), and getDBProperties().

    {
        return $this->pos;
    }

Here is the caller graph for this function:

getTitle()

ilExcCriteriaCatalogue::getTitle

(

)

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

References $title.

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

    {
        return $this->title;
    }

Here is the caller graph for this function:

importFromDB()

ilExcCriteriaCatalogue::importFromDB ( array  $a_row )

protected

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

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

Referenced by read().

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

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilExcCriteriaCatalogue::read (   $a_id )

protected

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

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

Referenced by __construct().

    {
        $ilDB = $this->db;
        
        $a_id = (int) $a_id;
        if ($a_id) {
            $set = $ilDB->query("SELECT *" .
                " FROM exc_crit_cat" .
                " WHERE id = " . $ilDB->quote($a_id, "integer"));
            if ($ilDB->numRows($set)) {
                $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 152 of file class.ilExcCriteriaCatalogue.php.

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

Referenced by update().

    {
        $ilDB = $this->db;
        
        if ($this->id) {
            return $this->update();
        }
        
        $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 (   $a_id )

protected

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

Referenced by importFromDB().

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

Here is the caller graph for this function:

setParent()

ilExcCriteriaCatalogue::setParent

(

$a_value

)

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

Referenced by importFromDB().

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

Here is the caller graph for this function:

setPosition()

ilExcCriteriaCatalogue::setPosition

(

$a_value

)

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

Referenced by importFromDB().

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

Here is the caller graph for this function:

setTitle()

ilExcCriteriaCatalogue::setTitle

(

$a_value

)

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

Referenced by importFromDB().

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

Here is the caller graph for this function:

update()

ilExcCriteriaCatalogue::update

(

)

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

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

Referenced by save().

    {
        $ilDB = $this->db;
        
        if (!$this->id) {
            return $this->save();
        }
        
        $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

ilExcCriteriaCatalogue::$db

protected

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

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

$id

ilExcCriteriaCatalogue::$id

protected

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

Referenced by getId().

$parent

ilExcCriteriaCatalogue::$parent

protected

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

Referenced by getParent().

$pos

ilExcCriteriaCatalogue::$pos

protected

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

Referenced by getPosition().

$title

ilExcCriteriaCatalogue::$title

protected

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

Referenced by getTitle().

---

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

• Modules/Exercise/classes/class.ilExcCriteriaCatalogue.php