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

Collaboration diagram for ilTaxNodeAssignment:

Public Member Functions
	__construct (string $a_component_id, int $a_obj_id, string $a_item_type, int $a_tax_id, ilDBInterface $db=null)
	Constructor. More...

	getComponentId ()

	getItemType ()

	getTaxonomyId ()

	setObjectId (int $a_val)

	getObjectId ()

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

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

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

	deleteAssignment (int $a_node_id, int $a_item_id)

	getMaxOrderNr (int $a_node_id)

	setOrderNr (int $a_node_id, int $a_item_id, int $a_order_nr)

	deleteAssignmentsOfItem (int $a_item_id)

	deleteAssignmentsOfNode (int $a_node_id)

	fixOrderNr (int $a_node_id)

Static Public Member Functions
static	deleteAllAssignmentsOfNode (int $a_node_id)

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

Protected Member Functions
	setComponentId (string $a_val)

	setItemType (string $a_val)

	setTaxonomyId (int $a_val)

Protected Attributes
ilDBInterface	$db

string	$component_id

int	$taxonomy_id

string	$item_type

int	$obj_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 <-> item assignment This class allows to assign items to taxonomy nodes.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilTaxNodeAssignment::__construct	(	string	$a_component_id,
		int	$a_obj_id,
		string	$a_item_type,
		int	$a_tax_id,
		ilDBInterface	$db = `null`
	)

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
ilDBInterface \| null	$db

Exceptions

ilTaxonomyException

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

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

       {
         global $DIC;
 
         $this->db = (is_null($db))
             ? $DIC->database()
             : $db;
 
         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 ($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	(	int	$a_node_id,
		int	$a_item_id,
		int	$a_order_nr = `0`
	)

Add assignment.

Exceptions

ilTaxonomyException

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

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

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

                                                                                       : void
     {
         $ilDB = $this->db;
 
         // nothing to do, if not both IDs are greater 0
         if ($a_node_id == 0 || $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 ( int $a_node_id )

static

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

References $DIC, and $ilDB.

Referenced by ilTaxonomyNode\delete().

                                                                      : void
     {
         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	(	int	$a_node_id,
		int	$a_item_id
	)

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

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

                                                                     : void
     {
         $ilDB = $this->db;
 
         // nothing to do, if not both IDs are greater 0
         if ($a_node_id == 0 || $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 ((int) $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 ( int $a_item_id )

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

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

Referenced by ilGlossaryTermGUI\updateTerm().

                                                            : void
     {
         $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 ( int $a_node_id )

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

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

                                                            : void
     {
         $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	(	int	$a_tax_id,
		array	$a_node_ids,
		string	$a_item_type
	)

static

Find object which have assigned nodes.

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

References $DIC, $ilDB, $res, and ILIAS\Repository\int().

Referenced by ilTaxonomyClassificationProvider\getFilteredObjects().

                                                                                                    : array
     {
         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[] = (int) $row["obj_id"];
         }
 
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fixOrderNr()

ilTaxNodeAssignment::fixOrderNr ( int $a_node_id )

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

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

                                               : void
     {
         $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 ( int $a_item_id )

final

Get assignments for item.

Returns: array array of tax node assignments arrays

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

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

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

                                                               : array
     {
         $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

string | array $a_node_id node id

Returns: array array of tax node assignments arrays

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

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

                                                           : array
     {
         $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 ( )

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

References $component_id.

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

                                     : string
     {
         return $this->component_id;
     }

Here is the caller graph for this function:

◆ getItemType()

ilTaxNodeAssignment::getItemType ( )

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

References $item_type.

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

                                  : string
     {
         return $this->item_type;
     }

Here is the caller graph for this function:

◆ getMaxOrderNr()

ilTaxNodeAssignment::getMaxOrderNr ( int $a_node_id )

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

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

Referenced by addAssignment().

                                                  : int
     {
         $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 ( )

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

References $obj_id.

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

                                  : int
     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getTaxonomyId()

ilTaxNodeAssignment::getTaxonomyId ( )

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

References $taxonomy_id.

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

                                    : int
     {
         return $this->taxonomy_id;
     }

Here is the caller graph for this function:

◆ setComponentId()

ilTaxNodeAssignment::setComponentId ( string $a_val )

protected

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

Referenced by __construct().

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

Here is the caller graph for this function:

◆ setItemType()

ilTaxNodeAssignment::setItemType ( string $a_val )

protected

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

Referenced by __construct().

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

Here is the caller graph for this function:

◆ setObjectId()

ilTaxNodeAssignment::setObjectId ( int $a_val )

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

Referenced by __construct().

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

Here is the caller graph for this function:

◆ setOrderNr()

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

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

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

                                                                                : void
     {
         $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 ( int $a_val )

protected

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

Referenced by __construct().

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

Here is the caller graph for this function:

Field Documentation

◆ $component_id

string ilTaxNodeAssignment::$component_id

protected

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

Referenced by getComponentId().

◆ $db

ilDBInterface ilTaxNodeAssignment::$db

protected

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

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

◆ $item_type

string ilTaxNodeAssignment::$item_type

protected

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

Referenced by getItemType().

◆ $obj_id

int ilTaxNodeAssignment::$obj_id

protected

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

Referenced by getObjectId().

◆ $taxonomy_id

int ilTaxNodeAssignment::$taxonomy_id

protected

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

Referenced by getTaxonomyId().

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

◆ $component_id

◆ $db

◆ $item_type

◆ $obj_id

◆ $taxonomy_id