Taxonomy node <-> item assignment. More...

Collaboration diagram for ilTaxNodeAssignment:

Public Member Functions
	__construct ($a_component_id, $a_obj_id, $a_item_type, $a_tax_id)
	Constructor. More...

	getComponentId ()
	Get component id. More...

	getItemType ()
	Get item type. More...

	getTaxonomyId ()
	Get taxonomy id. More...

	setObjectId ($a_val)
	Set object id. More...

	getObjectId ()
	Get object id. More...

	getAssignmentsOfNode ($a_node_id)
	Get assignments of node. More...

	getAssignmentsOfItem ($a_item_id)
	Get assignments for item. More...

	addAssignment ($a_node_id, $a_item_id, $a_order_nr=0)
	Add assignment. More...

	deleteAssignment ($a_node_id, $a_item_id)
	Delete assignment. More...

	getMaxOrderNr ($a_node_id)
	Get maximum order number. More...

	setOrderNr ($a_node_id, $a_item_id, $a_order_nr)
	Set order nr. More...

	deleteAssignmentsOfItem ($a_item_id)
	Delete assignments of item. More...

	deleteAssignmentsOfNode ($a_node_id)
	Delete assignments of node. More...

	fixOrderNr ($a_node_id)
	Fix Order Nr. More...

Static Public Member Functions
static	deleteAllAssignmentsOfNode ($a_node_id)
	Delete assignments of node. More...

static	findObjectsByNode ($a_tax_id, array $a_node_ids, $a_item_type)
	Find object which have assigned nodes. More...

Protected Member Functions
	setComponentId ($a_val)
	Set component id. More...

	setItemType ($a_val)
	Set item type. More...

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

Protected Attributes
	$db

Detailed Description

Taxonomy node <-> item assignment.

This class allows to assign items to taxonomy nodes.

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

Version: $Id$

/

Definition at line 17 of file class.ilTaxNodeAssignment.php.

Constructor & Destructor Documentation

◆ __construct()

ilTaxNodeAssignment::__construct	(	$a_component_id,
		$a_obj_id,
		$a_item_type,
		$a_tax_id
	)

Constructor.

Parameters

string	$a_component_id	component id (e.g. "glo" for Modules/Glossary)
int	$a_obj_id	repository object id of the object that is responsible for the assignment
string	$a_item_type	item type (e.g. "term", must be unique component wide) [use "obj" if repository object wide taxonomies!]
int	$a_tax_id	taxonomy id

Exceptions

ilTaxonomyException

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

References $DIC, setComponentId(), setItemType(), setObjectId(), and setTaxonomyId().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         if ($a_component_id == "") {
             throw new ilTaxonomyException('No component ID passed to ilTaxNodeAssignment.');
         }
         
         if ($a_item_type == "") {
             throw new ilTaxonomyException('No item type passed to ilTaxNodeAssignment.');
         }
 
         if ((int) $a_tax_id == 0) {
             throw new ilTaxonomyException('No taxonomy ID passed to ilTaxNodeAssignment.');
         }
 
         $this->setComponentId($a_component_id);
         $this->setItemType($a_item_type);
         $this->setTaxonomyId($a_tax_id);
         $this->setObjectId($a_obj_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ addAssignment()

ilTaxNodeAssignment::addAssignment	(	$a_node_id,
		$a_item_id,
		$a_order_nr = `0`
	)

Add assignment.

Parameters

int	$a_node_id	node id
int	$a_item_id	item id
int	$a_order_nr	order nr

Exceptions

ilTaxonomyException

Definition at line 208 of file class.ilTaxNodeAssignment.php.

References $db, $ilDB, array, getComponentId(), getItemType(), getMaxOrderNr(), getObjectId(), and getTaxonomyId().

Referenced by ilObjCategory\cloneDependencies(), and ilTaxonomyDataSet\importRecord().

     {
         $ilDB = $this->db;
         
         // nothing to do, if not both IDs are greater 0
         if ((int) $a_node_id == 0 || (int) $a_item_id == 0) {
             return;
         }
         
         // sanity check: does the node belong to the given taxonomy?
         $set = $ilDB->query(
             "SELECT tax_tree_id FROM tax_tree " .
             " WHERE child = " . $ilDB->quote($a_node_id, "integer")
         );
         $rec = $ilDB->fetchAssoc($set);
         if ($rec["tax_tree_id"] != $this->getTaxonomyId()) {
             throw new ilTaxonomyException('addAssignment: Node ID does not belong to current taxonomy.');
         }
 
         // do not re-assign, if assignment already exists
         // order number should be kept in this case
         $set2 = $ilDB->query(
             $q = "SELECT item_id FROM tax_node_assignment " .
             " WHERE component = " . $ilDB->quote($this->getComponentId(), "text") .
             " AND item_type = " . $ilDB->quote($this->getItemType(), "text") .
             " AND obj_id = " . $ilDB->quote($this->getObjectId(), "integer") .
             " AND node_id = " . $ilDB->quote($a_node_id, "integer") .
             " AND tax_id = " . $ilDB->quote($this->getTaxonomyId(), "integer") .
             " AND item_id = " . $ilDB->quote($a_item_id, "integer")
         );
         if ($rec2 = $ilDB->fetchAssoc($set2)) {
             return;
         }
 
         if ($a_order_nr == 0) {
             $a_order_nr = $this->getMaxOrderNr($a_node_id) + 10;
         }
         
         $ilDB->replace(
             "tax_node_assignment",
             array(
                 "node_id" => array("integer", $a_node_id),
                 "component" => array("text", $this->getComponentId()),
                 "item_type" => array("text", $this->getItemType()),
                 "obj_id" => array("integer", $this->getObjectId()),
                 "item_id" => array("integer", $a_item_id)
                 ),
             array(
                 "tax_id" => array("integer", $this->getTaxonomyId()),
                 "order_nr" => array("integer", $a_order_nr)
                 )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteAllAssignmentsOfNode()

static ilTaxNodeAssignment::deleteAllAssignmentsOfNode ( $a_node_id )

static

Delete assignments of node.

Parameters

int $a_node_id node id

Definition at line 387 of file class.ilTaxNodeAssignment.php.

References $DIC, and $ilDB.

Referenced by ilTaxonomyNode\delete().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $ilDB->manipulate(
             "DELETE FROM tax_node_assignment WHERE " .
             " node_id = " . $ilDB->quote($a_node_id, "integer")
         );
     }

Here is the caller graph for this function:

◆ deleteAssignment()

ilTaxNodeAssignment::deleteAssignment	(	$a_node_id,
		$a_item_id
	)

Delete assignment.

Parameters

int	$a_node_id	node id
int	$a_item_id	item id

Exceptions

ilTaxonomyException

Definition at line 269 of file class.ilTaxNodeAssignment.php.

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

     {
         $ilDB = $this->db;
 
         // nothing to do, if not both IDs are greater 0
         if ((int) $a_node_id == 0 || (int) $a_item_id == 0) {
             return;
         }
 
         // sanity check: does the node belong to the given taxonomy?
         $set = $ilDB->query(
             "SELECT tax_tree_id FROM tax_tree " .
             " WHERE child = " . $ilDB->quote($a_node_id, "integer")
         );
         $rec = $ilDB->fetchAssoc($set);
         if ($rec["tax_tree_id"] != $this->getTaxonomyId()) {
             throw new ilTaxonomyException('addAssignment: Node ID does not belong to current taxonomy.');
         }
 
         $ilDB->manipulate(
             "DELETE FROM tax_node_assignment WHERE " .
             " component = " . $ilDB->quote($this->getComponentId(), "text") .
             " AND item_type = " . $ilDB->quote($this->getItemType(), "text") .
             " AND obj_id = " . $ilDB->quote($this->getObjectId(), "integer") .
             " AND item_id = " . $ilDB->quote($a_item_id, "integer") .
             " AND node_id = " . $ilDB->quote($a_node_id, "integer") .
             " AND tax_id = " . $ilDB->quote($this->getTaxonomyId(), "integer")
         );
     }

Here is the call graph for this function:

◆ deleteAssignmentsOfItem()

ilTaxNodeAssignment::deleteAssignmentsOfItem ( $a_item_id )

Delete assignments of item.

Parameters

int $a_item_id item id

Definition at line 350 of file class.ilTaxNodeAssignment.php.

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

Referenced by ilGlossaryTermGUI\updateTerm().

     {
         $ilDB = $this->db;
 
         $ilDB->manipulate(
             "DELETE FROM tax_node_assignment WHERE " .
             " component = " . $ilDB->quote($this->getComponentId(), "text") .
             " AND item_type = " . $ilDB->quote($this->getItemType(), "text") .
             " AND obj_id = " . $ilDB->quote($this->getObjectId(), "integer") .
             " AND item_id = " . $ilDB->quote($a_item_id, "integer") .
             " AND tax_id = " . $ilDB->quote($this->getTaxonomyId(), "integer")
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteAssignmentsOfNode()

ilTaxNodeAssignment::deleteAssignmentsOfNode ( $a_node_id )

Delete assignments of node.

Parameters

int $a_node_id node id

Definition at line 369 of file class.ilTaxNodeAssignment.php.

References $db, $ilDB, getComponentId(), getItemType(), and getObjectId().

     {
         $ilDB = $this->db;
 
         $ilDB->manipulate(
             "DELETE FROM tax_node_assignment WHERE " .
             " node_id = " . $ilDB->quote($a_node_id, "integer") .
             " AND component = " . $ilDB->quote($this->getComponentId(), "text") .
             " AND obj_id = " . $ilDB->quote($this->getObjectId(), "integer") .
             " AND item_type = " . $ilDB->quote($this->getItemType(), "text")
         );
     }

Here is the call graph for this function:

◆ findObjectsByNode()

static ilTaxNodeAssignment::findObjectsByNode	(		$a_tax_id,
		array	$a_node_ids,
			$a_item_type
	)

static

Find object which have assigned nodes.

Parameters

int	$a_item_type
int	$a_tax_id
array	$a_node_ids

Returns: array

Definition at line 441 of file class.ilTaxNodeAssignment.php.

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

Referenced by ilTaxonomyClassificationProvider\getFilteredObjects().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $res = array();
     
         $set = $ilDB->query(
             "SELECT * FROM tax_node_assignment" .
             " WHERE " . $ilDB->in("node_id", $a_node_ids, "", "integer") .
             " AND tax_id = " . $ilDB->quote($a_tax_id, "integer") .
             " AND item_type = " . $ilDB->quote($a_item_type, "text") .
             " ORDER BY order_nr ASC"
         );
         while ($row = $ilDB->fetchAssoc($set)) {
             $res[] = $row["obj_id"];
         }
         
         return $res;
     }

Here is the caller graph for this function:

◆ fixOrderNr()

ilTaxNodeAssignment::fixOrderNr ( $a_node_id )

Fix Order Nr.

Definition at line 402 of file class.ilTaxNodeAssignment.php.

References $db, $ilDB, getComponentId(), getItemType(), getObjectId(), and getTaxonomyId().

     {
         $ilDB = $this->db;
 
         $set = $ilDB->query(
             "SELECT * FROM tax_node_assignment " .
             " WHERE component = " . $ilDB->quote($this->getComponentId(), "text") .
             " AND item_type = " . $ilDB->quote($this->getItemType(), "text") .
             " AND obj_id = " . $ilDB->quote($this->getObjectId(), "integer") .
             " AND node_id = " . $ilDB->quote($a_node_id, "integer") .
             " AND tax_id = " . $ilDB->quote($this->getTaxonomyId(), "integer") .
             " ORDER BY order_nr ASC"
         );
         $cnt = 10;
         while ($rec = $ilDB->fetchAssoc($set)) {
             $ilDB->manipulate(
                 "UPDATE tax_node_assignment SET " .
                 " order_nr = " . $ilDB->quote($cnt, "integer") .
                 " WHERE component = " . $ilDB->quote($this->getComponentId(), "text") .
                 " AND item_type = " . $ilDB->quote($this->getItemType(), "text") .
                 " AND obj_id = " . $ilDB->quote($this->getObjectId(), "integer") .
                 " AND node_id = " . $ilDB->quote($a_node_id, "integer") .
                 " AND tax_id = " . $ilDB->quote($this->getTaxonomyId(), "integer") .
                 " AND item_id = " . $ilDB->quote($rec["item_id"], "integer")
             );
             $cnt+= 10;
         }
     }

Here is the call graph for this function:

◆ getAssignmentsOfItem()

ilTaxNodeAssignment::getAssignmentsOfItem ( $a_item_id )

final

Get assignments for item.

Parameters

int $a_item_id item id

Returns: array array of tax node assignments arrays

Definition at line 181 of file class.ilTaxNodeAssignment.php.

References $db, $ilDB, array, getObjectId(), and getTaxonomyId().

Referenced by ilObjGlossary\cloneObject(), ilTestRandomQuestionSetPoolDeriver\filterForQuestionRelatedTaxonomies(), ilGlossaryTermGUI\getEditTermForm(), and assQuestionGUI\populateTaxonomyFormSection().

     {
         $ilDB = $this->db;
 
         $set = $ilDB->query(
             "SELECT * FROM tax_node_assignment" .
             " WHERE component = " . $ilDB->quote($this->getComponentId(), "text") .
             " AND item_type = " . $ilDB->quote($this->getItemType(), "text") .
             " AND item_id = " . $ilDB->quote($a_item_id, "integer") .
             " AND obj_id = " . $ilDB->quote($this->getObjectId(), "integer") .
             " AND tax_id = " . $ilDB->quote($this->getTaxonomyId(), "integer")
         );
         $ass = array();
         while ($rec  = $ilDB->fetchAssoc($set)) {
             $ass[] = $rec;
         }
         return $ass;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignmentsOfNode()

ilTaxNodeAssignment::getAssignmentsOfNode ( $a_node_id )

final

Get assignments of node.

Parameters

int $a_node_id node id

Returns: array array of tax node assignments arrays

Definition at line 142 of file class.ilTaxNodeAssignment.php.

References $db, $ilDB, array, getComponentId(), getItemType(), getObjectId(), and getTaxonomyId().

     {
         $ilDB = $this->db;
 
         if (is_array($a_node_id)) {
             $set = $ilDB->query(
                 "SELECT * FROM tax_node_assignment " .
                 " WHERE " . $ilDB->in("node_id", $a_node_id, false, "integer") .
                 " AND tax_id = " . $ilDB->quote($this->getTaxonomyId(), "integer") .
                 " AND component = " . $ilDB->quote($this->getComponentId(), "text") .
                 " AND obj_id = " . $ilDB->quote($this->getObjectId(), "integer") .
                 " AND item_type = " . $ilDB->quote($this->getItemType(), "text") .
                 " ORDER BY order_nr ASC"
             );
         } else {
             $set = $ilDB->query(
                 "SELECT * FROM tax_node_assignment " .
                 " WHERE node_id = " . $ilDB->quote($a_node_id, "integer") .
                 " AND tax_id = " . $ilDB->quote($this->getTaxonomyId(), "integer") .
                 " AND component = " . $ilDB->quote($this->getComponentId(), "text") .
                 " AND obj_id = " . $ilDB->quote($this->getObjectId(), "integer") .
                 " AND item_type = " . $ilDB->quote($this->getItemType(), "text") .
                 " ORDER BY order_nr ASC"
             );
         }
         $ass = array();
         while ($rec  = $ilDB->fetchAssoc($set)) {
             $ass[] = $rec;
         }
         
         return $ass;
     }

Here is the call graph for this function:

◆ getComponentId()

ilTaxNodeAssignment::getComponentId ( )

Get component id.

Returns: string component id

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

Referenced by addAssignment(), deleteAssignmentsOfNode(), fixOrderNr(), getAssignmentsOfNode(), and setOrderNr().

     {
         return $this->component_id;
     }

Here is the caller graph for this function:

◆ getItemType()

ilTaxNodeAssignment::getItemType ( )

Get item type.

Returns: string item type

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

Referenced by addAssignment(), deleteAssignmentsOfNode(), fixOrderNr(), getAssignmentsOfNode(), and setOrderNr().

     {
         return $this->item_type;
     }

Here is the caller graph for this function:

◆ getMaxOrderNr()

ilTaxNodeAssignment::getMaxOrderNr ( $a_node_id )

Get maximum order number.

Parameters

Definition at line 305 of file class.ilTaxNodeAssignment.php.

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

Referenced by addAssignment().

     {
         $ilDB = $this->db;
         
         $set = $ilDB->query(
             "SELECT max(order_nr) mnr FROM tax_node_assignment " .
             " WHERE component = " . $ilDB->quote($this->getComponentId(), "text") .
             " AND item_type = " . $ilDB->quote($this->getItemType(), "text") .
             " AND obj_id = " . $ilDB->quote($this->getObjectId(), "integer") .
             " AND node_id = " . $ilDB->quote($a_node_id, "integer") .
             " AND tax_id = " . $ilDB->quote($this->getTaxonomyId(), "integer")
         );
         $rec = $ilDB->fetchAssoc($set);
         
         return (int) $rec["mnr"];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjectId()

ilTaxNodeAssignment::getObjectId ( )

Get object id.

Returns: int object id

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

Referenced by addAssignment(), deleteAssignmentsOfNode(), fixOrderNr(), getAssignmentsOfItem(), getAssignmentsOfNode(), and setOrderNr().

     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getTaxonomyId()

ilTaxNodeAssignment::getTaxonomyId ( )

Get taxonomy id.

Returns: int taxonomy id

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

Referenced by addAssignment(), deleteAssignment(), deleteAssignmentsOfItem(), fixOrderNr(), getAssignmentsOfItem(), getAssignmentsOfNode(), getMaxOrderNr(), and setOrderNr().

     {
         return $this->taxonomy_id;
     }

Here is the caller graph for this function:

◆ setComponentId()

ilTaxNodeAssignment::setComponentId ( $a_val )

protected

Set component id.

Parameters

string $a_val component id

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

Referenced by __construct().

     {
         $this->component_id = $a_val;
     }

Here is the caller graph for this function:

◆ setItemType()

ilTaxNodeAssignment::setItemType ( $a_val )

protected

Set item type.

Parameters

string $a_val item type

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

Referenced by __construct().

     {
         $this->item_type = $a_val;
     }

Here is the caller graph for this function:

◆ setObjectId()

ilTaxNodeAssignment::setObjectId ( $a_val )

Set object id.

Parameters

int $a_val object id

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

Referenced by __construct().

     {
         $this->obj_id = $a_val;
     }

Here is the caller graph for this function:

◆ setOrderNr()

ilTaxNodeAssignment::setOrderNr	(	$a_node_id,
		$a_item_id,
		$a_order_nr
	)

Set order nr.

Parameters

Definition at line 328 of file class.ilTaxNodeAssignment.php.

References $db, $ilDB, getComponentId(), getItemType(), getObjectId(), and getTaxonomyId().

     {
         $ilDB = $this->db;
         
         $ilDB->manipulate(
             "UPDATE tax_node_assignment SET " .
             " order_nr = " . $ilDB->quote($a_order_nr, "integer") .
             " WHERE component = " . $ilDB->quote($this->getComponentId(), "text") .
             " AND item_type = " . $ilDB->quote($this->getItemType(), "text") .
             " AND obj_id = " . $ilDB->quote($this->getObjectId(), "integer") .
             " AND node_id = " . $ilDB->quote($a_node_id, "integer") .
             " AND item_id = " . $ilDB->quote($a_item_id, "integer") .
             " AND tax_id = " . $ilDB->quote($this->getTaxonomyId(), "integer")
         );
     }

Here is the call graph for this function:

◆ setTaxonomyId()

ilTaxNodeAssignment::setTaxonomyId ( $a_val )

protected

Set taxonomy id.

Parameters

int $a_val taxonomy id

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

Referenced by __construct().

     {
         $this->taxonomy_id = $a_val;
     }

Here is the caller graph for this function:

Field Documentation

◆ $db

ilTaxNodeAssignment::$db

protected

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

Referenced by addAssignment(), deleteAssignment(), deleteAssignmentsOfItem(), deleteAssignmentsOfNode(), fixOrderNr(), getAssignmentsOfItem(), getAssignmentsOfNode(), getMaxOrderNr(), and setOrderNr().

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

Services/Taxonomy/classes/class.ilTaxNodeAssignment.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAssignment()

◆ deleteAllAssignmentsOfNode()

◆ deleteAssignment()

◆ deleteAssignmentsOfItem()

◆ deleteAssignmentsOfNode()

◆ findObjectsByNode()

◆ fixOrderNr()

◆ getAssignmentsOfItem()

◆ getAssignmentsOfNode()

◆ getComponentId()

◆ getItemType()

◆ getMaxOrderNr()

◆ getObjectId()

◆ getTaxonomyId()

◆ setComponentId()

◆ setItemType()

◆ setObjectId()

◆ setOrderNr()

◆ setTaxonomyId()

Field Documentation

◆ $db