Input GUI class for taxonomy assignments. More...

Inheritance diagram for ilTaxAssignInputGUI:

Collaboration diagram for ilTaxAssignInputGUI:

Public Member Functions
	__construct ($a_taxonomy_id, $a_multi=true, $a_title="", $a_postvar="", $a_include_please_select=true)
	Constructor. More...

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

	getTaxonomyId ()
	Get taxonomy id. More...

	setOptions ($a_options)
	Set Options. More...

	getOptions ()
	Get Options. More...

	saveInput ($a_component_id, $a_obj_id, $a_item_type, $a_item_id)
	Save input. More...

	setCurrentValues ($a_component_id, $a_obj_id, $a_item_type, $a_item_id)
	Set current values. More...

Public Member Functions inherited from ilSelectInputGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setOptions ($a_options)
	Set Options. More...

	getOptions ()
	Get Options. More...

	setValue ($a_value)
	Set Value. More...

	getValue ()
	Get Value. More...

	setValueByArray ($a_values)
	Set value by array. More...

	checkInput ()
	Check input, strip slashes etc. More...

	addCustomAttribute ($a_attr)

	getCustomAttributes ()

	render ($a_mode="")
	Render item. More...

	insert (&$a_tpl)
	Insert property html. More...

	getTableFilterHTML ()
	Get HTML for table filter. More...

	getToolbarHTML ()
	Get HTML for toolbar. More...

	setHideSubForm ($a_value, $a_condition=null)
	Set initial sub form visibility, optionally add dynamic value-based condition. More...

	hideSubForm ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...

	getSubItems ()
	Get Subitems. More...

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()
	Get sub form html. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

&	executeCommand ()
	Execute command. More...

	getType ()
	Get Type. More...

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

	getTitle ()
	Get Title. More...

	setPostVar ($a_postvar)
	Set Post Variable. More...

	getPostVar ()
	Get Post Variable. More...

	getFieldId ()
	Get Post Variable. More...

	setInfo ($a_info)
	Set Information Text. More...

	getInfo ()
	Get Information Text. More...

	setAlert ($a_alert)
	Set Alert Text. More...

	getAlert ()
	Get Alert Text. More...

	setRequired ($a_required)
	Set Required. More...

	getRequired ()
	Get Required. More...

	setDisabled ($a_disabled)
	Set Disabled. More...

	getDisabled ()
	Get Disabled. More...

	checkInput ()
	Check input, strip slashes etc. More...

	setParentForm ($a_parentform)
	Set Parent Form. More...

	getParentForm ()
	Get Parent Form. More...

	setParent ($a_val)
	Set Parent GUI object. More...

	getParent ()
	Get Parent GUI object. More...

	getSubForm ()
	Get sub form html. More...

	hideSubForm ()
	Sub form hidden on init? More...

	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...

	getHiddenTitle ()
	Get hidden title. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	writeToSession ()
	Write to session. More...

	clearFromSession ()
	Clear session value. More...

	readFromSession ()
	Read from session. More...

	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...

	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...

	getMulti ()
	Get Multi. More...

	setMultiValues (array $a_values)
	Set multi values. More...

	getMultiValues ()
	Get multi values. More...

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

Additional Inherited Members
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Protected Attributes inherited from ilSelectInputGUI
	$cust_attr = array()

	$options = array()

	$value

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Detailed Description

Input GUI class for taxonomy assignments.

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

Version: $Id$

Definition at line 16 of file class.ilTaxAssignInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTaxAssignInputGUI::__construct	(	$a_taxonomy_id,
		$a_multi = `true`,
		$a_title = `""`,
		$a_postvar = `""`,
		$a_include_please_select = `true`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

References $lng, ilFormPropertyGUI\setMulti(), setTaxonomyId(), and ilFormPropertyGUI\setType().

         {
                 global $lng;
                 
                 $lng->loadLanguageModule("tax");
                 $this->setMulti($a_multi);
                 $this->include_please_select = $a_include_please_select;
                 
                 if ($a_title == "")
                 {
                         $a_title = $lng->txt("tax_taxonomy");
                 }
                 
                 if ($a_postvar == "")
                 {
                         $a_postvar = "tax_node_assign";
                 }
                 
                 parent::__construct($a_title, $a_postvar);
                 $this->setType("tax_assign");
                 
                 if ((int) $a_taxonomy_id == 0)
                 {
                         throw new ilTaxonomyExceptions("No taxonomy ID passed to ilTaxAssignInputGUI.");
                 }
                 
                 $this->setTaxonomyId((int) $a_taxonomy_id);
         }

Here is the call graph for this function:

Member Function Documentation

◆ getOptions()

ilTaxAssignInputGUI::getOptions ( )

Get Options.

Returns: array Options. Array ("value" => "option_text")

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

References $lng, $n, ilSelectInputGUI\$options, and getTaxonomyId().

         {
                 global $lng;
                 
                 if ($this->include_please_select)
                 {
                         $options = array("" => $lng->txt("please_select"));
                 }
                 
                 include_once("./Services/Taxonomy/classes/class.ilTaxonomyTree.php");
                 $tax_tree = new ilTaxonomyTree($this->getTaxonomyId());
                 
                 $nodes = $tax_tree->getSubtree($tax_tree->getNodeData($tax_tree->readRootId()));
                 foreach ($nodes as $n)
                 {
                         if ($n["type"] == "taxn")
                         {
                                 $options[$n["child"]] = str_repeat("&nbsp;", ($n["depth"] - 2) * 2).$n["title"];
                         }
                 }
                 
                 return $options;
         }

Here is the call graph for this function:

◆ getTaxonomyId()

ilTaxAssignInputGUI::getTaxonomyId ( )

Get taxonomy id.

Returns: int taxonomy id

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

Referenced by getOptions(), saveInput(), and setCurrentValues().

         {
                 return $this->taxononmy_id;
         }

Here is the caller graph for this function:

◆ saveInput()

ilTaxAssignInputGUI::saveInput	(	$a_component_id,
		$a_obj_id,
		$a_item_type,
		$a_item_id
	)

Save input.

Parameters

Definition at line 119 of file class.ilTaxAssignInputGUI.php.

References $_POST, ilFormPropertyGUI\getMulti(), ilFormPropertyGUI\getPostVar(), getTaxonomyId(), and ilUtil\stripSlashes().

         {
                 include_once("./Services/Taxonomy/classes/class.ilTaxNodeAssignment.php");
                 $tax_node_ass = new ilTaxNodeAssignment($a_component_id, $a_obj_id, $a_item_type, $this->getTaxonomyId());
                 //$tax_node_ass->deleteAssignmentsOfItem($a_item_id);
 
                 $post = $_POST[$this->getPostVar()];
                 if (!$this->getMulti())
                 {
                         $post = array($post);
                 }
                 elseif( !is_array($post) )
                 {
                         // BH: when multi values are ENABLED and $form->checkInput is NOT called
                         // there is no post parameter available WHEN the selection is left empty
                         // - fixed mantis #22186 - the followup issue
                         $post = array();
                 }
 
                 $current_ass = $tax_node_ass->getAssignmentsOfItem($a_item_id);
                 $exising = array();
                 foreach ($current_ass as $ca)
                 {
                         if (!in_array($ca["node_id"], $post))
                         {
                                 $tax_node_ass->deleteAssignment($ca["node_id"], $a_item_id);
                         }
                         else
                         {
                                 $exising[] = $ca["node_id"];
                         }
                 }
 
                 foreach ($post as $p)
                 {
                         if (!in_array($p, $exising))
                         {
                                 $tax_node_ass->addAssignment(ilUtil::stripSlashes($p), $a_item_id);
                         }
                 }
         }

Here is the call graph for this function:

◆ setCurrentValues()

ilTaxAssignInputGUI::setCurrentValues	(	$a_component_id,
		$a_obj_id,
		$a_item_type,
		$a_item_id
	)

Set current values.

Parameters

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

References ilFormPropertyGUI\getMulti(), getTaxonomyId(), and ilSelectInputGUI\setValue().

Referenced by assQuestionGUI\populateTaxonomyFormSection().

         {
                 include_once("./Services/Taxonomy/classes/class.ilTaxNodeAssignment.php");
                 $tax_node_ass = new ilTaxNodeAssignment($a_component_id, $a_obj_id, $a_item_type, $this->getTaxonomyId());
                 $ass = $tax_node_ass->getAssignmentsOfItem($a_item_id);
                 
                 $nodes = array();
                 foreach ($ass as $a)
                 {
                         $nodes[] = $a["node_id"];
                 }
                 if ($this->getMulti())
                 {
                         $this->setValue($nodes);
                 }
                 else
                 {
                         $this->setValue($nodes[0]);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOptions()

ilTaxAssignInputGUI::setOptions ( $a_options )

Set Options.

Parameters

array $a_options Options. Array ("value" => "option_text")

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

         {
                 throw new ilTaxonomyExceptions("setOptions: Not supported for ilTaxAssignInputGUI.");
         }

◆ setTaxonomyId()

ilTaxAssignInputGUI::setTaxonomyId ( $a_val )

Set taxonomy id.

Parameters

int $a_val taxonomy id

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

Referenced by __construct().

         {
                 $this->taxononmy_id = $a_val;
         }

Here is the caller graph for this function:

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

Services/Taxonomy/classes/class.ilTaxAssignInputGUI.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getOptions()

◆ getTaxonomyId()

◆ saveInput()

◆ setCurrentValues()

◆ setOptions()

◆ setTaxonomyId()