ilTaxonomyNode 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 ilTaxonomyNode:

Public Member Functions
	__construct ($a_id=0)
	Constructor public. More...
	setTitle (string $a_title)
	getTitle ()
	setType (string $a_type)
	getType ()
	setId (int $a_id)
	getId ()
	setOrderNr (int $a_val)
	getOrderNr ()
	setTaxonomyId (int $a_val)
	getTaxonomyId ()
	read ()
	create ()
	update ()
	delete ()
	copy (int $a_tax_id=0)

Static Public Member Functions
static	_lookupTitle (int $a_obj_id)
static	putInTree (int $a_tax_id, ilTaxonomyNode $a_node, int $a_parent_id=0, int $a_target_node_id=0, int $a_order_nr=0)
static	writeOrderNr (int $a_node_id, int $a_order_nr)
static	writeTitle (int $a_node_id, string $a_title)
	Write title. More...
static	getNextOrderNr (int $a_tax_id, int $a_parent_id)
	Put this node into the taxonomy tree. More...
static	fixOrderNumbers (int $a_tax_id, int $a_parent_id)

Data Fields
string	$type
int	$id
string	$title

Static Protected Member Functions
static	_lookup (int $a_obj_id, string $a_field)

Protected Attributes
ilDBInterface	$db
int	$order_nr = 0
int	$taxonomy_id

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 Taxonomy node

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilTaxonomyNode::__construct

(

$a_id = 0

)

Constructor public.

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

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

    {
        global $DIC;

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

        if ($a_id != 0) {
            $this->read();
        }

        $this->setType("taxn");
    }

Here is the call graph for this function:

Member Function Documentation

_lookup()

static ilTaxonomyNode::_lookup ( int  $a_obj_id, string  $a_field  )

staticprotected

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

References $DIC, $ilDB, and $query.

                                                                     : string
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT $a_field FROM tax_node WHERE obj_id = " .
            $ilDB->quote($a_obj_id, "integer");
        $obj_set = $ilDB->query($query);
        if ($obj_rec = $ilDB->fetchAssoc($obj_set)) {
            return $obj_rec[$a_field];
        }
        return "";
    }

_lookupTitle()

static ilTaxonomyNode::_lookupTitle ( int  $a_obj_id )

static

Definition at line 195 of file class.ilTaxonomyNode.php.

Referenced by ilObjTaxonomyGUI\deleteItems(), and ilTaxSelectInputGUI\getTitleForNodeId().

                                                      : string
    {
        return self::_lookup($a_obj_id, "title");
    }

Here is the caller graph for this function:

copy()

ilTaxonomyNode::copy

(

int

$a_tax_id = 0

)

Definition at line 163 of file class.ilTaxonomyNode.php.

References getOrderNr(), getTaxonomyId(), getTitle(), and getType().

                                           : ilTaxonomyNode
    {
        $taxn = new ilTaxonomyNode();
        $taxn->setTitle($this->getTitle());
        $taxn->setType($this->getType());
        $taxn->setOrderNr($this->getOrderNr());
        if ($a_tax_id == 0) {
            $taxn->setTaxonomyId($this->getTaxonomyId());
        } else {
            $taxn->setTaxonomyId($a_tax_id);
        }

        $taxn->create();

        return $taxn;
    }

Here is the call graph for this function:

create()

ilTaxonomyNode::create

(

)

Definition at line 116 of file class.ilTaxonomyNode.php.

References $db, $ilDB, $query, getOrderNr(), getTaxonomyId(), getTitle(), getType(), and setId().

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

        if ($this->getTaxonomyId() <= 0) {
            die("ilTaxonomyNode->create: No taxonomy ID given");
        }

        // insert object data
        $id = $ilDB->nextId("tax_node");
        $query = "INSERT INTO tax_node (obj_id, title, type, create_date, order_nr, tax_id) " .
            "VALUES (" .
            $ilDB->quote($id, "integer") . "," .
            $ilDB->quote($this->getTitle(), "text") . "," .
            $ilDB->quote($this->getType(), "text") . ", " .
            $ilDB->now() . ", " .
            $ilDB->quote((int) $this->getOrderNr(), "integer") . ", " .
            $ilDB->quote((int) $this->getTaxonomyId(), "integer") .
            ")";
        $ilDB->manipulate($query);
        $this->setId($id);
    }

Here is the call graph for this function:

delete()

ilTaxonomyNode::delete

(

)

Definition at line 151 of file class.ilTaxonomyNode.php.

References $db, $ilDB, $query, ilTaxNodeAssignment\deleteAllAssignmentsOfNode(), and getId().

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

        // delete all assignments of the node
        ilTaxNodeAssignment::deleteAllAssignmentsOfNode($this->getId());

        $query = "DELETE FROM tax_node WHERE obj_id= " .
            $ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($query);
    }

Here is the call graph for this function:

fixOrderNumbers()

static ilTaxonomyNode::fixOrderNumbers ( int  $a_tax_id, int  $a_parent_id  )

static

Definition at line 285 of file class.ilTaxonomyNode.php.

References $c, and ilArrayUtil\sortArray().

Referenced by ilObjTaxonomyGUI\confirmedDelete(), ilObjTaxonomyGUI\pasteItems(), ilObjTaxonomyGUI\saveSorting(), and ilObjTaxonomyGUI\saveTaxNode().

                                                                           : void
    {
        $tax_tree = new ilTaxonomyTree($a_tax_id);
        if ($a_parent_id == 0) {
            $a_parent_id = $tax_tree->readRootId();
        }
        $childs = $tax_tree->getChilds($a_parent_id);
        $childs = ilArrayUtil::sortArray($childs, "order_nr", "asc", true);

        $cnt = 10;
        foreach ($childs as $c) {
            self::writeOrderNr((int) $c["child"], $cnt);
            $cnt += 10;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getId()

ilTaxonomyNode::getId

(

)

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

References $id.

Referenced by delete(), putInTree(), and update().

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getNextOrderNr()

static ilTaxonomyNode::getNextOrderNr ( int  $a_tax_id, int  $a_parent_id  )

static

Put this node into the taxonomy tree.

Definition at line 266 of file class.ilTaxonomyNode.php.

References $c, and ILIAS\Repository\int().

Referenced by ilObjTaxonomyGUI\saveTaxNode().

                                                                          : int
    {
        $tax_tree = new ilTaxonomyTree($a_tax_id);
        if ($a_parent_id == 0) {
            $a_parent_id = $tax_tree->readRootId();
        }
        $childs = $tax_tree->getChilds($a_parent_id);
        $max = 0;

        foreach ($childs as $c) {
            if ((int) $c["order_nr"] > $max) {
                $max = (int) $c["order_nr"] + 10;
            }
        }

        return $max;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOrderNr()

ilTaxonomyNode::getOrderNr

(

)

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

References $order_nr.

Referenced by copy(), create(), and update().

                                : int
    {
        return $this->order_nr;
    }

Here is the caller graph for this function:

getTaxonomyId()

ilTaxonomyNode::getTaxonomyId

(

)

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

References $taxonomy_id.

Referenced by copy(), and create().

                                   : int
    {
        return $this->taxonomy_id;
    }

Here is the caller graph for this function:

getTitle()

ilTaxonomyNode::getTitle

(

)

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

References $title.

Referenced by copy(), create(), and update().

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getType()

ilTaxonomyNode::getType

(

)

Definition at line 65 of file class.ilTaxonomyNode.php.

References $type.

Referenced by copy(), and create().

                             : string
    {
        return $this->type;
    }

Here is the caller graph for this function:

putInTree()

static ilTaxonomyNode::putInTree ( int  $a_tax_id, ilTaxonomyNode  $a_node, int  $a_parent_id = 0, int  $a_target_node_id = 0, int  $a_order_nr = 0  )

static

Definition at line 200 of file class.ilTaxonomyNode.php.

References getId(), and ilTree\POS_FIRST_NODE.

Referenced by ilObjTaxonomy\cloneNodes(), ilTaxonomyDataSet\importRecord(), and ilObjTaxonomyGUI\saveTaxNode().

     : void {
        $tax_tree = new ilTaxonomyTree($a_tax_id);

        // determine parent
        $parent_id = ($a_parent_id != 0)
            ? $a_parent_id
            : $tax_tree->readRootId();

        // determine target
        if ($a_target_node_id != 0) {
            $target = $a_target_node_id;
        } else {
            // determine last child that serves as predecessor
            $childs = $tax_tree->getChilds($parent_id);

            if (count($childs) == 0) {
                $target = ilTree::POS_FIRST_NODE;
            } else {
                $target = $childs[count($childs) - 1]["obj_id"];
            }
        }

        if ($tax_tree->isInTree($parent_id) && !$tax_tree->isInTree($a_node->getId())) {
            $tax_tree->insertNode($a_node->getId(), $parent_id, $target);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilTaxonomyNode::read

(

)

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

References $db, $ilDB, $query, setOrderNr(), setTaxonomyId(), setTitle(), and setType().

Referenced by __construct().

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

        if (!isset($this->data_record)) {
            $query = "SELECT * FROM tax_node WHERE obj_id = " .
                $ilDB->quote($this->id, "integer");
            $obj_set = $ilDB->query($query);
            $this->data_record = $ilDB->fetchAssoc($obj_set);
        }
        $this->setType($this->data_record["type"]);
        $this->setTitle($this->data_record["title"]);
        $this->setOrderNr((int) $this->data_record["order_nr"]);
        $this->setTaxonomyId((int) $this->data_record["tax_id"]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setId()

ilTaxonomyNode::setId

(

int

$a_id

)

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

Referenced by create().

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

Here is the caller graph for this function:

setOrderNr()

ilTaxonomyNode::setOrderNr

(

int

$a_val

)

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

Referenced by read().

                                          : void
    {
        $this->order_nr = $a_val;
    }

Here is the caller graph for this function:

setTaxonomyId()

ilTaxonomyNode::setTaxonomyId

(

int

$a_val

)

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

Referenced by read().

                                             : void
    {
        $this->taxonomy_id = $a_val;
    }

Here is the caller graph for this function:

setTitle()

ilTaxonomyNode::setTitle

(

string

$a_title

)

Definition at line 50 of file class.ilTaxonomyNode.php.

Referenced by read().

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

Here is the caller graph for this function:

setType()

ilTaxonomyNode::setType

(

string

$a_type

)

Definition at line 60 of file class.ilTaxonomyNode.php.

Referenced by __construct(), and read().

                                           : void
    {
        $this->type = $a_type;
    }

Here is the caller graph for this function:

update()

ilTaxonomyNode::update

(

)

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

References $db, $ilDB, $query, getId(), getOrderNr(), and getTitle().

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

        $query = "UPDATE tax_node SET " .
            " title = " . $ilDB->quote($this->getTitle(), "text") .
            " ,order_nr = " . $ilDB->quote((int) $this->getOrderNr(), "integer") .
            " WHERE obj_id = " . $ilDB->quote($this->getId(), "integer");

        $ilDB->manipulate($query);
    }

Here is the call graph for this function:

writeOrderNr()

static ilTaxonomyNode::writeOrderNr ( int  $a_node_id, int  $a_order_nr  )

static

Definition at line 234 of file class.ilTaxonomyNode.php.

References $DIC, and $ilDB.

Referenced by ilObjTaxonomyGUI\saveSorting().

                                                                        : void
    {
        global $DIC;

        $ilDB = $DIC->database();

        $ilDB->manipulate(
            "UPDATE tax_node SET " .
            " order_nr = " . $ilDB->quote($a_order_nr, "integer") .
            " WHERE obj_id = " . $ilDB->quote($a_node_id, "integer")
        );
    }

Here is the caller graph for this function:

writeTitle()

static ilTaxonomyNode::writeTitle ( int  $a_node_id, string  $a_title  )

static

Write title.

Definition at line 250 of file class.ilTaxonomyNode.php.

References $DIC, and $ilDB.

Referenced by ilObjTaxonomyGUI\saveSorting().

                                                                      : void
    {
        global $DIC;

        $ilDB = $DIC->database();

        $ilDB->manipulate(
            "UPDATE tax_node SET " .
            " title = " . $ilDB->quote($a_title, "text") .
            " WHERE obj_id = " . $ilDB->quote($a_node_id, "integer")
        );
    }

Here is the caller graph for this function:

Field Documentation

$db

ilDBInterface ilTaxonomyNode::$db

protected

Definition at line 25 of file class.ilTaxonomyNode.php.

Referenced by create(), delete(), read(), and update().

$id

int ilTaxonomyNode::$id

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

Referenced by getId().

$order_nr

int ilTaxonomyNode::$order_nr = 0

protected

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

Referenced by getOrderNr().

$taxonomy_id

int ilTaxonomyNode::$taxonomy_id

protected

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

Referenced by getTaxonomyId().

$title

string ilTaxonomyNode::$title

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

Referenced by getTitle().

$type

string ilTaxonomyNode::$type

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

Referenced by getType().

---

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

• Services/Taxonomy/classes/class.ilTaxonomyNode.php