Taxonomy node. More...

Collaboration diagram for ilTaxonomyNode:

Public Member Functions
	__construct ($a_id=0)
	Constructor @access public. More...

	setTitle ($a_title)
	Set title. More...

	getTitle ()
	Get title. More...

	setType ($a_type)
	Set type. More...

	getType ()
	Get type. More...

	setId ($a_id)
	Set Node ID. More...

	getId ()
	Get Node ID. More...

	setOrderNr ($a_val)
	Set order nr. More...

	getOrderNr ()
	Get order nr. More...

	setTaxonomyId ($a_val)
	Set taxonomy id. More...

	getTaxonomyId ()
	Get taxonomy id. More...

	read ()
	Read data from database. More...

	create ()
	Create taxonomy node. More...

	update ()
	Update Node. More...

	delete ()
	Delete taxonomy node. More...

	copy ($a_tax_id=0)
	Copy taxonomy node. More...

Static Public Member Functions
static	_lookupTitle ($a_obj_id)
	Lookup Title. More...

static	putInTree ( $a_tax_id, $a_node, $a_parent_id="", $a_target_node_id="", $a_order_nr=0)
	Put this node into the taxonomy tree. More...

static	writeOrderNr ($a_node_id, $a_order_nr)
	Write order nr. More...

static	writeTitle ($a_node_id, $a_title)
	Write title. More...

static	getNextOrderNr ($a_tax_id, $a_parent_id)
	Put this node into the taxonomy tree. More...

static	fixOrderNumbers ($a_tax_id, $a_parent_id)
	Fix order numbers. More...

Data Fields
	$type

	$id

	$title

Static Protected Member Functions
static	_lookup ($a_obj_id, $a_field)
	Lookup. More...

Protected Attributes
	$db

Detailed Description

Taxonomy node.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilTaxonomyNode::__construct ( $a_id = 0 )

Constructor @access public.

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

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->id = $a_id;
        
        //              include_once("./Services/Taxonomy/classes/class.ilTaxonomyTree.php");
        //              $this->taxonomy_tree = new ilTaxonomyTree();
 
        if ($a_id != 0) {
            $this->read();
        }
 
        $this->setType("taxn");
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ _lookup()

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

staticprotected

Lookup.

Parameters

int Node ID

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

    {
        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);
        $obj_rec = $ilDB->fetchAssoc($obj_set);
 
        return $obj_rec[$a_field];
    }

References $DIC, $ilDB, and $query.

Referenced by _lookupTitle().

Here is the caller graph for this function:

◆ _lookupTitle()

static ilTaxonomyNode::_lookupTitle ( $a_obj_id )

static

Lookup Title.

Parameters

int node ID

Returns: string title

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        return self::_lookup($a_obj_id, "title");
    }

References $DIC, $ilDB, and _lookup().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copy()

ilTaxonomyNode::copy ( $a_tax_id = 0 )

Copy taxonomy node.

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

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

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

Here is the call graph for this function:

◆ create()

ilTaxonomyNode::create ( )

Create taxonomy node.

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

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

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

Here is the call graph for this function:

◆ delete()

ilTaxonomyNode::delete ( )

Delete taxonomy node.

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

    {
        $ilDB = $this->db;
        
        // delete all assignments of the node
        include_once("./Services/Taxonomy/classes/class.ilTaxNodeAssignment.php");
        ilTaxNodeAssignment::deleteAllAssignmentsOfNode($this->getId());
        
        $query = "DELETE FROM tax_node WHERE obj_id= " .
            $ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($query);
    }

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

Here is the call graph for this function:

◆ fixOrderNumbers()

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

static

Fix order numbers.

Parameters

return

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

    {
        include_once("./Services/Taxonomy/classes/class.ilTaxonomyTree.php");
        $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 = ilUtil::sortArray($childs, "order_nr", "asc", true);
 
        $cnt = 10;
        foreach ($childs as $c) {
            self::writeOrderNr($c["child"], $cnt);
            $cnt += 10;
        }
    }

References Vendor\Package\$c, ilUtil\sortArray(), and writeOrderNr().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilTaxonomyNode::getId ( )

Get Node ID.

Parameters

int Node ID

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

    {
        return $this->id;
    }

References $id.

Referenced by delete(), and update().

Here is the caller graph for this function:

◆ getNextOrderNr()

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

static

Put this node into the taxonomy tree.

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

    {
        include_once("./Services/Taxonomy/classes/class.ilTaxonomyTree.php");
        $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 ($c["order_nr"] > $max) {
                $max = $c["order_nr"] + 10;
            }
        }
 
        return $max;
    }

References Vendor\Package\$c.

Referenced by ilObjTaxonomyGUI\saveTaxNode().

Here is the caller graph for this function:

◆ getOrderNr()

ilTaxonomyNode::getOrderNr ( )

Get order nr.

Returns: int order nr

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

    {
        return $this->order_nr;
    }

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

Here is the caller graph for this function:

◆ getTaxonomyId()

ilTaxonomyNode::getTaxonomyId ( )

Get taxonomy id.

Returns: int taxonomy id

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

    {
        return $this->taxonomy_id;
    }

Referenced by copy(), and create().

Here is the caller graph for this function:

◆ getTitle()

ilTaxonomyNode::getTitle ( )

Get title.

Returns: string title

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

    {
        return $this->title;
    }

References $title.

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

Here is the caller graph for this function:

◆ getType()

ilTaxonomyNode::getType ( )

Get type.

Returns: string Type

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

    {
        return $this->type;
    }

References $type.

Referenced by copy(), and create().

Here is the caller graph for this function:

◆ putInTree()

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

static

Put this node into the taxonomy tree.

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

      {
        include_once("./Services/Taxonomy/classes/class.ilTaxonomyTree.php");
        $tax_tree = new ilTaxonomyTree($a_tax_id);
 
        // determine parent
        $parent_id = ($a_parent_id != "")
            ? $a_parent_id
            : $tax_tree->readRootId();
 
        // determine target
        if ($a_target_node_id != "") {
            $target = $a_target_node_id;
        } else {
            // determine last child that serves as predecessor
            $childs = $tax_tree->getChilds($parent_id);
 
            if (count($childs) == 0) {
                $target = IL_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);
        }
    }

References IL_FIRST_NODE.

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

Here is the caller graph for this function:

◆ read()

ilTaxonomyNode::read ( )

Read data from database.

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

    {
        $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($this->data_record["order_nr"]);
        $this->setTaxonomyId($this->data_record["tax_id"]);
    }

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setId()

ilTaxonomyNode::setId ( $a_id )

Set Node ID.

Parameters

int Node ID

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

    {
        $this->id = $a_id;
    }

Referenced by create().

Here is the caller graph for this function:

◆ setOrderNr()

ilTaxonomyNode::setOrderNr ( $a_val )

Set order nr.

Parameters

int $a_val order nr

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

    {
        $this->order_nr = $a_val;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setTaxonomyId()

ilTaxonomyNode::setTaxonomyId ( $a_val )

Set taxonomy id.

Parameters

int $a_val taxonomy id

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

    {
        $this->taxonomy_id = $a_val;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setTitle()

ilTaxonomyNode::setTitle ( $a_title )

Set title.

Parameters

string $a_title title

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

    {
        $this->title = $a_title;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setType()

ilTaxonomyNode::setType ( $a_type )

Set type.

Parameters

string Type

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

    {
        $this->type = $a_type;
    }

References $a_type.

Referenced by __construct(), and read().

Here is the caller graph for this function:

◆ update()

ilTaxonomyNode::update ( )

Update Node.

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

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

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

Here is the call graph for this function:

◆ writeOrderNr()

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

static

Write order nr.

Parameters

return

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

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

References $DIC, and $ilDB.

Referenced by fixOrderNumbers(), and ilObjTaxonomyGUI\saveSorting().

Here is the caller graph for this function:

◆ writeTitle()

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

static

Write title.

Parameters

return

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

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

References $DIC, and $ilDB.

Referenced by ilObjTaxonomyGUI\saveSorting().

Here is the caller graph for this function:

Field Documentation

◆ $db

ilTaxonomyNode::$db

protected

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

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

◆ $id

ilTaxonomyNode::$id

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

Referenced by create(), and getId().

◆ $title

ilTaxonomyNode::$title

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

Referenced by getTitle().

◆ $type

ilTaxonomyNode::$type

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

Public Member Functions

Static Public Member Functions

Data Fields

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _lookup()

◆ _lookupTitle()

◆ copy()

◆ create()

◆ delete()

◆ fixOrderNumbers()

◆ getId()

◆ getNextOrderNr()

◆ getOrderNr()

◆ getTaxonomyId()

◆ getTitle()

◆ getType()

◆ putInTree()

◆ read()

◆ setId()

◆ setOrderNr()

◆ setTaxonomyId()

◆ setTitle()

◆ setType()

◆ update()

◆ writeOrderNr()

◆ writeTitle()

Field Documentation

◆ $db

◆ $id

◆ $title

◆ $type