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

Collaboration diagram for ilRatingCategory:

Public Member Functions
	__construct (?int $a_id=null, ?\ilDBInterface $db=null)

	setId (int $a_value)

	getId ()

	setParentId (int $a_value)

	getParentId ()

	setTitle (string $a_value)

	getTitle ()

	setDescription (string $a_value)

	getDescription ()

	setPosition (int $a_value)

	getPosition ()

	update ()

	save ()

Static Public Member Functions
static	delete (int $a_id)

static	getAllForObject (int $a_parent_obj_id)

static	deleteForObject (int $a_parent_obj_id)

Protected Member Functions
	read (int $a_id)

	getDBProperties ()

Protected Attributes
ilDBInterface	$db

int	$id = 0

int	$parent_id = 0

string	$title = ""

string	$description = ""

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 ilRatingCategory

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 24 of file class.ilRatingCategory.php.

Constructor & Destructor Documentation

◆ __construct()

ilRatingCategory::__construct	(	?int	$a_id = `null`,
		?\ilDBInterface	$db = `null`
	)

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

      {
        global $DIC;
 
        $this->db = (is_null($db))
            ? $DIC->database()
            : $db;
 
        if ($a_id > 0) {
            $this->read($a_id);
        }
    }

References $db, $DIC, and read().

Here is the call graph for this function:

Member Function Documentation

◆ delete()

static ilRatingCategory::delete ( int $a_id )

static

Definition at line 167 of file class.ilRatingCategory.php.

                                            : void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if ($a_id > 0) {
            $sql = "DELETE FROM il_rating" .
                " WHERE category_id = " . $ilDB->quote($a_id, "integer");
            $ilDB->manipulate($sql);
 
            $sql = "DELETE FROM il_rating_cat" .
                " WHERE id = " . $ilDB->quote($a_id, "integer");
            $ilDB->manipulate($sql);
        }
    }

References $DIC, and $ilDB.

Referenced by ilRatingCategoryGUI\delete(), and deleteForObject().

Here is the caller graph for this function:

◆ deleteForObject()

static ilRatingCategory::deleteForObject ( int $a_parent_obj_id )

static

Definition at line 205 of file class.ilRatingCategory.php.

                                                                : void
    {
        if ($a_parent_obj_id) {
            foreach (self::getAllForObject($a_parent_obj_id) as $item) {
                self::delete($item["id"]);
            }
        }
    }

References delete().

Here is the call graph for this function:

◆ getAllForObject()

static ilRatingCategory::getAllForObject ( int $a_parent_obj_id )

static

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

                                                                : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $cats = array();
 
        $sql = "SELECT * FROM il_rating_cat" .
            " WHERE parent_id = " . $ilDB->quote($a_parent_obj_id, "integer") .
            " ORDER BY pos";
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $cats[] = $row;
        }
 
        return $cats;
    }

References $DIC, and $ilDB.

Referenced by ilObjWiki\cloneObject(), ilRatingCategoryGUI\delete(), ilRatingCategoryGUI\export(), ilRatingGUI\getBlockHTML(), and ILIAS\Rating\RatingCategoryOrderingTable\initRecords().

Here is the caller graph for this function:

◆ getDBProperties()

ilRatingCategory::getDBProperties ( )

protected

Definition at line 120 of file class.ilRatingCategory.php.

                                        : array
    {
        // parent id must not change
        $fields = array("title" => array("text", $this->getTitle()),
                "description" => array("text", $this->getDescription()),
                "pos" => array("integer", $this->getPosition()));
 
        return $fields;
    }

References getDescription(), getPosition(), and getTitle().

Referenced by save(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDescription()

ilRatingCategory::getDescription ( )

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

                                    : string
    {
        return $this->description;
    }

References $description.

Referenced by getDBProperties().

Here is the caller graph for this function:

◆ getId()

ilRatingCategory::getId ( )

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

                           : int
    {
        return $this->id;
    }

References $id.

Referenced by update().

Here is the caller graph for this function:

◆ getParentId()

ilRatingCategory::getParentId ( )

Definition at line 64 of file class.ilRatingCategory.php.

                                 : int
    {
        return $this->parent_id;
    }

References $parent_id.

Referenced by save().

Here is the caller graph for this function:

◆ getPosition()

ilRatingCategory::getPosition ( )

Definition at line 94 of file class.ilRatingCategory.php.

                                 : int
    {
        return $this->pos;
    }

References $pos.

Referenced by getDBProperties().

Here is the caller graph for this function:

◆ getTitle()

ilRatingCategory::getTitle ( )

Definition at line 74 of file class.ilRatingCategory.php.

                              : string
    {
        return $this->title;
    }

References $title.

Referenced by getDBProperties().

Here is the caller graph for this function:

◆ read()

ilRatingCategory::read ( int $a_id )

protected

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

                                      : void
    {
        $ilDB = $this->db;
 
        if ($a_id > 0) {
            $sql = "SELECT * FROM il_rating_cat" .
                " WHERE id = " . $ilDB->quote($a_id, "integer");
            $set = $ilDB->query($sql);
            $row = $ilDB->fetchAssoc($set);
            if ($row["id"]) {
                $this->setId($row["id"]);
                $this->setParentId($row["parent_id"]);
                $this->setTitle($row["title"]);
                $this->setDescription($row["description"]);
                $this->setPosition($row["pos"]);
            }
        }
    }

References $db, $ilDB, setDescription(), setId(), setParentId(), setPosition(), and setTitle().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilRatingCategory::save ( )

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

                          : void
    {
        $ilDB = $this->db;
 
        $id = $ilDB->nextId("il_rating_cat");
        $this->setId($id);
 
        // append
        $sql = "SELECT max(pos) pos FROM il_rating_cat" .
            " WHERE parent_id = " . $ilDB->quote($this->getParentId(), "integer");
        $set = $ilDB->query($sql);
        $pos = $ilDB->fetchAssoc($set);
        $pos = $pos["pos"];
        $this->setPosition($pos + 10);
 
        $fields = $this->getDBProperties();
        $fields["id"] = array("integer", $id);
        $fields["parent_id"] = array("integer", $this->getParentId());
 
        $ilDB->insert("il_rating_cat", $fields);
    }

References $db, $id, $ilDB, $pos, getDBProperties(), getParentId(), setId(), and setPosition().

Here is the call graph for this function:

◆ setDescription()

ilRatingCategory::setDescription ( string $a_value )

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

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

Referenced by read().

Here is the caller graph for this function:

◆ setId()

ilRatingCategory::setId ( int $a_value )

Definition at line 49 of file class.ilRatingCategory.php.

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

Referenced by read(), and save().

Here is the caller graph for this function:

◆ setParentId()

ilRatingCategory::setParentId ( int $a_value )

Definition at line 59 of file class.ilRatingCategory.php.

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

Referenced by read().

Here is the caller graph for this function:

◆ setPosition()

ilRatingCategory::setPosition ( int $a_value )

Definition at line 89 of file class.ilRatingCategory.php.

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

Referenced by read(), and save().

Here is the caller graph for this function:

◆ setTitle()

ilRatingCategory::setTitle ( string $a_value )

Definition at line 69 of file class.ilRatingCategory.php.

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

Referenced by read().

Here is the caller graph for this function:

◆ update()

ilRatingCategory::update ( )

Definition at line 130 of file class.ilRatingCategory.php.

                            : void
    {
        $ilDB = $this->db;
 
        if ($this->getId()) {
            $fields = $this->getDBProperties();
 
            $ilDB->update(
                "il_rating_cat",
                $fields,
                array("id" => array("integer", $this->getId()))
            );
        }
    }

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

Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ilRatingCategory::$db

protected

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

Referenced by __construct(), read(), save(), and update().

◆ $description

string ilRatingCategory::$description = ""

protected

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

Referenced by getDescription().

◆ $id

int ilRatingCategory::$id = 0

protected

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

Referenced by getId(), and save().

◆ $parent_id

int ilRatingCategory::$parent_id = 0

protected

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

Referenced by getParentId().

◆ $pos

int ilRatingCategory::$pos = 0

protected

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

Referenced by getPosition(), and save().

◆ $title

string ilRatingCategory::$title = ""

protected

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

Referenced by getTitle().

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

components/ILIAS/Rating/classes/class.ilRatingCategory.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ deleteForObject()

◆ getAllForObject()

◆ getDBProperties()

◆ getDescription()

◆ getId()

◆ getParentId()

◆ getPosition()

◆ getTitle()

◆ read()

◆ save()

◆ setDescription()

◆ setId()

◆ setParentId()

◆ setPosition()

◆ setTitle()

◆ update()

Field Documentation

◆ $db

◆ $description

◆ $id

◆ $parent_id

◆ $pos

◆ $title