This class represents a hierarchical form. More...

Inheritance diagram for ilHierarchyFormGUI:

Collaboration diagram for ilHierarchyFormGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	setParentCommand ($a_parent_obj, $a_parent_cmd)
	Set parent gui object/cmd. More...

	getParentObject ()
	Get Parent object. More...

	getParentCommand ()
	Get parent command. More...

	setId ($a_id)
	Set Id. More...

	getId ()
	Get Id. More...

	setTree ($a_tree)
	Set Tree Object. More...

	getTree ()
	Get Tree Object. More...

	setCurrentTopNodeId ($a_currenttopnodeid)
	Set Current Top Node ID. More...

	getCurrentTopNodeId ()
	Get Current Top Node ID. More...

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

	getTitle ()
	Get Title. More...

	setIcon ($a_icon)
	Set Icon. More...

	getIcon ()
	Get Icon. More...

	setCheckboxName ($a_checkboxname)
	Set Checkbox Name. More...

	getCheckboxName ()
	Get Checkbox Name. More...

	setDragIcon ($a_dragicon)
	Set Drag Icon Path. More...

	getDragIcon ()
	Get Drag Icon Path. More...

	setMaxDepth ($a_maxdepth)
	Set Maximum Depth. More...

	getMaxDepth ()
	Get Maximum Depth. More...

	setExplorerUpdater ($a_exp_frame, $a_exp_id, $a_exp_target_script)
	Set Explorer Updater. More...

	setTriggeredUpdateCommand ($a_triggered_update_command)
	Set Explorer Updater. More...

	addHelpItem ($a_text, $a_image="")
	Get all help items. More...

	getHelpItems ()
	Get all help items. More...

	makeDragTarget ($a_id, $a_group, $a_first_child_drop_area=false, $a_as_subitem=false, $a_diss_text="")
	Makes a nodes (following droparea) a drag target. More...

	makeDragContent ($a_id, $a_group)
	Makes a node a drag content. More...

	addMultiCommand ($a_txt, $a_cmd)
	Add a multi command (for selection of items) More...

	addCommand ($a_txt, $a_cmd)
	Add a command. More...

	setHighlightedNodes ($a_val)
	Set highlighted nodes. More...

	getHighlightedNodes ()
	Get highlighted nodes. More...

	setFocusId ($a_val)
	Set focus if. More...

	getFocusId ()
	Get focus id. More...

	setExpandVariable ($a_val)
	Set expand variable. More...

	getExpandVariable ()
	Get expand variable. More...

	setExpanded ($a_val)
	Set expanded Array. More...

	getExpanded ()
	Get expanded array. More...

	updateExpanded ()
	Update expand information in session. More...

	setTypeWhiteList ($a_val)
	Set type whitelist. More...

	getTypeWhiteList ()
	Get type whitelist. More...

	getChilds ($a_node_id=false)
	Get all childs of current node. More...

	getContent ()
	Get Form Content. More...

	getLegend ()
	Get Legend. More...

	getLevelHTML ($a_par_node, $a_depth, &$a_childs)
	Get Form HTML. More...

	renderChild ($a_tpl, $a_child, $a_depth, $next_sibling=null)
	Render a single child (including grandchilds) More...

	getChildIcon ($a_item)
	Get icon path for an item. More...

	getChildIconAlt ($a_item)
	Get icon alt text for an item. More...

	getChildCommands ($a_item)
	Get item commands. More...

	getChildTitle ($a_child)
	Get child title. More...

	getChildInfo ($a_child)
	Get child info. More...

	getMenuItems ($a_node, $a_depth, $a_first_child=false, $a_next_sibling=null, $a_childs=null)
	Get menu items for drop area of node. More...

	nodeAllowsChilds ($a_node)
	Checks, whether current nodes allows childs at all. More...

	manageDragAndDrop ($a_node, $a_depth, $a_first_child=false, $a_next_sibling=null, $a_childs=null)
	Makes nodes drag and drop content and targets. More...

	getHTML ()
	Get HTML. More...

Public Member Functions inherited from ilFormGUI
	setFormAction ($a_formaction)
	Set FormAction. More...

	getFormAction ()
	Get FormAction. More...

	setTarget ($a_target)
	Set Target. More...

	getTarget ()
	Get Target. More...

	setMultipart ($a_multipart)
	Set Enctype Multipart/Formdata true/false. More...

	getMultipart ()
	Get Enctype Multipart/Formdata true/false. More...

	setId ($a_id)
	Set Id. More...

	getId ()
	Get Id. More...

	setName ($a_name)
	Set Name. More...

	getName ()
	Get Name. More...

	setKeepOpen ($a_keepopen)
	Set Keep Form Tag Open. More...

	getKeepOpen ()
	Get Keep Form Tag Open. More...

	setOpenTag ($a_open)
	Enable/Disable Open Form Tag. More...

	getOpenTag ()
	Get Open Form Tag Enabled. More...

	setCloseTag ($a_val)
	Set close tag. More...

	getCloseTag ()
	Get close tag. More...

	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...

	getPreventDoubleSubmission ()
	Get prevent double submission. More...

	getHTML ()
	Get HTML. More...

	getContent ()
	Get Content. More...

Static Public Member Functions
static	getPostMulti ()
	Get multi number of _POST input. More...

static	getPostNodeId ()
	Get node ID of _POST input. More...

static	getPostFirstChild ()
	Should node be inserted as first child of target node (true) or as successor (false) More...

static	getPostFields ()
	Get all post fields. More...

Additional Inherited Members
Protected Attributes inherited from ilFormGUI
	$formaction

	$multipart = false

	$keepopen = false

	$opentag = true

	$id

	$name

	$prevent_double_submission = false

Detailed Description

This class represents a hierarchical form.

These forms are used for quick editing, where each node is represented by it's title.

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.ilHierarchyFormGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilHierarchyFormGUI::__construct ( )

Constructor.

Parameters

Definition at line 21 of file class.ilHierarchyFormGUI.php.

References $lng, $tpl, array, ilYuiUtil\initDragDrop(), and setCheckboxName().

         {
                 global $lng, $tpl;
                 
                 $this->maxdepth = -1;
                 $this->multi_commands = array();
                 $this->commands = array();
                 $this->drag_target[] = array();
                 $this->drag_content[] = array();
                 $lng->loadLanguageModule("form");
                 $this->setCheckboxName("cbox");
                 $this->help_items = array();
                 
                 include_once("./Services/YUI/classes/class.ilYuiUtil.php");
                 ilYuiUtil::initDragDrop();
                 $tpl->addJavascript("./Services/Form/js/ServiceFormHierarchyForm.js");
         }

Here is the call graph for this function:

Member Function Documentation

◆ addCommand()

ilHierarchyFormGUI::addCommand	(	$a_txt,
		$a_cmd
	)

Add a command.

Parameters

string	$a_txt	command text
string	$a_cmd	command

Definition at line 325 of file class.ilHierarchyFormGUI.php.

References array.

         {
                 $this->commands[] = array("text" => $a_txt, "cmd" => $a_cmd);
         }

◆ addHelpItem()

ilHierarchyFormGUI::addHelpItem	(	$a_text,
		$a_image = `""`
	)

Get all help items.

Definition at line 255 of file class.ilHierarchyFormGUI.php.

References array.

         {
                 $this->help_items[] = array("text" => $a_text,
                         "image" => $a_image);
         }

◆ addMultiCommand()

ilHierarchyFormGUI::addMultiCommand	(	$a_txt,
		$a_cmd
	)

Add a multi command (for selection of items)

Parameters

string	$a_txt	command text
string	$a_cmd	command

Definition at line 314 of file class.ilHierarchyFormGUI.php.

References array.

         {
                 $this->multi_commands[] = array("text" => $a_txt, "cmd" => $a_cmd);
         }

◆ getCheckboxName()

ilHierarchyFormGUI::getCheckboxName ( )

Get Checkbox Name.

Returns: string Checkbox Name

Definition at line 185 of file class.ilHierarchyFormGUI.php.

Referenced by renderChild().

         {
                 return $this->checkboxname;
         }

Here is the caller graph for this function:

◆ getChildCommands()

ilHierarchyFormGUI::getChildCommands ( $a_item )

Get item commands.

Parameters

array item array

Returns: array array of arrays("text", "link")

Definition at line 1070 of file class.ilHierarchyFormGUI.php.

Referenced by renderChild().

         {
                 return false;
         }

Here is the caller graph for this function:

◆ getChildIcon()

ilHierarchyFormGUI::getChildIcon ( $a_item )

Get icon path for an item.

Parameters

array item array

Returns: string icon path

Definition at line 1046 of file class.ilHierarchyFormGUI.php.

References ilUtil\getImagePath().

Referenced by renderChild().

         {
                 return ilUtil::getImagePath("icon_".$a_item["type"].".svg");
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildIconAlt()

ilHierarchyFormGUI::getChildIconAlt ( $a_item )

Get icon alt text for an item.

Parameters

array item array

Returns: string icon alt text

Definition at line 1057 of file class.ilHierarchyFormGUI.php.

References $lng.

Referenced by renderChild().

         {
                 global $lng;
                 
                 return $lng->txt($a_item["type"]);
         }

Here is the caller graph for this function:

◆ getChildInfo()

ilHierarchyFormGUI::getChildInfo ( $a_child )

Get child info.

Parameters

array $a_child node array

Returns: string node title

Definition at line 1092 of file class.ilHierarchyFormGUI.php.

Referenced by renderChild().

         {
                 return "";
         }               

Here is the caller graph for this function:

◆ getChilds()

ilHierarchyFormGUI::getChilds ( $a_node_id = false )

Get all childs of current node.

Standard implementation uses tree object.

Definition at line 477 of file class.ilHierarchyFormGUI.php.

References array, getCurrentTopNodeId(), and getTree().

Referenced by getLevelHTML().

         {
                 if ($a_node_id == false)
                 {
                         $a_node_id = $this->getCurrentTopNodeId();
                 }
                 
                 $tree_childs = $this->getTree()->getChilds($a_node_id);
                 $childs = array();
                 foreach($tree_childs as $tree_child)
                 {
                         
                         if (!is_array($this->white_list) || in_array($tree_child["type"], $this->white_list))
                         {
                                 $childs[] = array("node_id" => $tree_child["child"],
                                         "title" => $tree_child["title"],
                                         "type" => $tree_child["type"],
                                         "depth" => $tree_child["depth"]
                                         );
                         }
                 }
                 
                 return $childs;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildTitle()

ilHierarchyFormGUI::getChildTitle ( $a_child )

Get child title.

Parameters

array $a_child node array

Returns: string node title

Definition at line 1081 of file class.ilHierarchyFormGUI.php.

Referenced by renderChild().

         {
                 return $a_child["title"];
         }       

Here is the caller graph for this function:

◆ getContent()

ilHierarchyFormGUI::getContent ( )

Get Form Content.

Definition at line 505 of file class.ilHierarchyFormGUI.php.

References $a_type, $cmd, $lng, array, getCurrentTopNodeId(), getExpandVariable(), ilUtil\getImagePath(), getLevelHTML(), getTitle(), getTree(), and updateExpanded().

         {
                 global $lng;
                 
                 if ($this->getExpandVariable() != "")
                 {
                         $this->updateExpanded();
                 }
                 
                 $ttpl = new ilTemplate("tpl.hierarchy_form.html", true, true, "Services/Form");
                 $ttpl->setVariable("TXT_SAVING", $lng->txt("saving"));
                 $top_node_data = $this->getTree()->getNodeData($this->getCurrentTopNodeId());
                 $top_node = array("node_id" => $top_node_data["child"],
                                 "title" => $top_node_data["title"],
                                 "type" => $top_node_data["type"]);
 
                 $childs = null;
                 $nodes_html = $this->getLevelHTML($top_node, 0, $childs);
 
 
                 // commands
                 $secs = array("1", "2");
                 foreach ($secs as $sec)
                 {
                         reset($this->commands);
                         reset($this->multi_commands);
                         if (count($this->multi_commands) > 0 || count($this->commands) > 0)
                         {
                                 if (count($childs) > 0)
                                 {
                                         $single = false;
                                         foreach($this->commands as $cmd)
                                         {
                                                 $ttpl->setCurrentBlock("cmd".$sec);
                                                 $ttpl->setVariable("CMD", $cmd["cmd"]);
                                                 $ttpl->setVariable("CMD_TXT", $cmd["text"]);
                                                 $ttpl->parseCurrentBlock();
                                                 $single = true;
                                         }
         
                                         $multi = false;
                                         foreach($this->multi_commands as $cmd)
                                         {
                                                 $ttpl->setCurrentBlock("multi_cmd".$sec);
                                                 $ttpl->setVariable("MULTI_CMD", $cmd["cmd"]);
                                                 $ttpl->setVariable("MULTI_CMD_TXT", $cmd["text"]);
                                                 $ttpl->parseCurrentBlock();
                                                 $multi = true;
                                         }
                                         if ($multi)
                                         {
                                                 $ttpl->setCurrentBlock("multi_cmds".$sec);
                                                 $ttpl->setVariable("MCMD_ALT", $lng->txt("commands"));
                                                 if ($sec == "1")
                                                 {
                                                         $ttpl->setVariable("MCMD_IMG", ilUtil::getImagePath("arrow_downright.svg"));
                                                 }
                                                 else
                                                 {
                                                         $ttpl->setVariable("MCMD_IMG", ilUtil::getImagePath("arrow_upright.svg"));
                                                 }
                                                 $ttpl->parseCurrentBlock();
                                         }
                                 }
                                 
                                 if ($single || $multi)
                                 {
                                         $ttpl->setCurrentBlock("commands".$sec);
                                         $ttpl->parseCurrentBlock();
                                 }
                                 $single = true;
                         }
                 }
 
                 // explorer updater
                 if ($this->exp_frame != "")
                 {
                         $ttpl->setCurrentBlock("updater");
                         $ttpl->setVariable("UPDATER_FRAME", $this->exp_frame);
                         $ttpl->setVariable("EXP_ID_UPDATER", $this->exp_id);
                         $ttpl->setVariable("HREF_UPDATER", $this->exp_target_script);
                         $ttpl->parseCurrentBlock();
                 }
 
                 // drag and drop initialisation
                 foreach($this->drag_target as $drag_target)
                 {
                         $ttpl->setCurrentBlock("dragtarget");
                         $ttpl->setVariable("EL_ID", $drag_target["id"]);
                         $ttpl->setVariable("GROUP", $drag_target["group"]);
                         $ttpl->parseCurrentBlock();
                 }
                 foreach($this->drag_content as $drag_content)
                 {
                         $ttpl->setCurrentBlock("dragcontent");
                         $ttpl->setVariable("EL_ID", $drag_content["id"]);
                         $ttpl->setVariable("GROUP", $drag_content["group"]);
                         $ttpl->parseCurrentBlock();
                 }
                 
                 // disambiguation menues and "insert as first child" flags
                 if (is_array($this->diss_menues))
                 {
                         foreach($this->diss_menues as $node_id => $d_menu)
                         {
                                 foreach($d_menu as $group => $menu)
                                 {
                                         if (count($menu) > 1)
                                         {
                                                 foreach($menu as $menu_item)
                                                 {
                                                         $ttpl->setCurrentBlock("dmenu_cmd");
                                                         $ttpl->setVariable("SUBITEM", (int) $menu_item["subitem"]);
                                                         $ttpl->setVariable("TXT_MENU_CMD", $menu_item["text"]);
                                                         $ttpl->parseCurrentBlock();
                                                 }
                                                 
                                                 $ttpl->setCurrentBlock("disambiguation_menu");
                                                 $ttpl->setVariable("DNODE_ID", $node_id);
                                                 $ttpl->setVariable("GRP", $group);
                                                 $ttpl->parseCurrentBlock();
                                         }
                                         else if (count($menu) == 1)
                                         {
                                                 // set first child flag
                                                 $ttpl->setCurrentBlock("as_subitem_flag");
                                                 $ttpl->setVariable("SI_NODE_ID", $node_id);
                                                 $ttpl->setVariable("SI_GRP", $group);
                                                 $ttpl->setVariable("SI_SI", (int) $menu[0]["subitem"]);
                                                 $ttpl->parseCurrentBlock();
                                                 
                                         }
                                 }
                         }
                 }
                 $this->diss_menues[$a_id][$a_group][] = array("type" => $a_type, "text" => $a_diss_text);
 
 
                 if ($this->triggered_update_command != "")
                 {
                         $ttpl->setCurrentBlock("tr_update");
                         $ttpl->setVariable("UPDATE_CMD", $this->triggered_update_command);
                         $ttpl->parseCurrentBlock();
                 }
 
                 // disambiguation menues and "insert as first child" flags
                 if (is_array($this->diss_menues))
                 {
                         foreach($this->diss_menues as $node_id => $d_menu)
                         {
                                 foreach($d_menu as $group => $menu)
                                 {
                                         if (count($menu) > 1)
                                         {
                                                 foreach($menu as $menu_item)
                                                 {
                                                         $ttpl->setCurrentBlock("dmenu_cmd");
                                                         $ttpl->setVariable("SUBITEM", (int) $menu_item["subitem"]);
                                                         $ttpl->setVariable("TXT_MENU_CMD", $menu_item["text"]);
                                                         $ttpl->parseCurrentBlock();
                                                 }
                                                 
                                                 $ttpl->setCurrentBlock("disambiguation_menu");
                                                 $ttpl->setVariable("DNODE_ID", $node_id);
                                                 $ttpl->setVariable("GRP", $group);
                                                 $ttpl->parseCurrentBlock();
                                         }
                                         else if (count($menu) == 1)
                                         {
                                                 // set first child flag
                                                 $ttpl->setCurrentBlock("as_subitem_flag");
                                                 $ttpl->setVariable("SI_NODE_ID", $node_id);
                                                 $ttpl->setVariable("SI_GRP", $group);
                                                 $ttpl->setVariable("SI_SI", (int) $menu[0]["subitem"]);
                                                 $ttpl->parseCurrentBlock();
                                                 
                                         }
                                 }
                         }
                 }
                 $this->diss_menues[$a_id][$a_group][] = array("type" => $a_type, "text" => $a_diss_text);
                 
                 // nodes
                 $ttpl->setVariable("NODES", $nodes_html);
                 
                 // title
 //echo "<br>".htmlentities($this->getTitle())." --- ".htmlentities(ilUtil::prepareFormOutput($this->getTitle()));
                 $ttpl->setVariable("TITLE", $this->getTitle());
                 
                 
                 return $ttpl->get();
         }

Here is the call graph for this function:

◆ getCurrentTopNodeId()

ilHierarchyFormGUI::getCurrentTopNodeId ( )

Get Current Top Node ID.

Returns: string Current Top Node ID

Definition at line 125 of file class.ilHierarchyFormGUI.php.

Referenced by getChilds(), and getContent().

         {
                 return $this->currenttopnodeid;
         }

Here is the caller graph for this function:

◆ getDragIcon()

ilHierarchyFormGUI::getDragIcon ( )

Get Drag Icon Path.

Returns: string Drag Icon Path

Definition at line 205 of file class.ilHierarchyFormGUI.php.

Referenced by getLegend().

         {
                 return $this->dragicon;
         }

Here is the caller graph for this function:

◆ getExpanded()

ilHierarchyFormGUI::getExpanded ( )

Get expanded array.

Returns: array expanded array

Definition at line 405 of file class.ilHierarchyFormGUI.php.

Referenced by renderChild().

         {
                 return $this->expanded;
         }

Here is the caller graph for this function:

◆ getExpandVariable()

ilHierarchyFormGUI::getExpandVariable ( )

Get expand variable.

Returns

Definition at line 385 of file class.ilHierarchyFormGUI.php.

Referenced by getContent(), renderChild(), and updateExpanded().

         {
                 return $this->expand_variable;
         }

Here is the caller graph for this function:

◆ getFocusId()

ilHierarchyFormGUI::getFocusId ( )

Get focus id.

Returns: int node id

Definition at line 365 of file class.ilHierarchyFormGUI.php.

Referenced by renderChild().

         {
                 return $this->focus_id;
         }

Here is the caller graph for this function:

◆ getHelpItems()

ilHierarchyFormGUI::getHelpItems ( )

Get all help items.

Definition at line 264 of file class.ilHierarchyFormGUI.php.

Referenced by getLegend().

         {
                 return $this->help_items;
         }

Here is the caller graph for this function:

◆ getHighlightedNodes()

ilHierarchyFormGUI::getHighlightedNodes ( )

Get highlighted nodes.

Returns: array highlighted nodes

Definition at line 345 of file class.ilHierarchyFormGUI.php.

Referenced by renderChild().

         {
                 return $this->highlighted_nodes;
         }

Here is the caller graph for this function:

◆ getHTML()

ilHierarchyFormGUI::getHTML ( )

Get HTML.

Parameters

Definition at line 1167 of file class.ilHierarchyFormGUI.php.

         {
                 return parent::getHTML().$this->getLegend();
         }

◆ getIcon()

ilHierarchyFormGUI::getIcon ( )

Get Icon.

Returns: string Icon

Definition at line 165 of file class.ilHierarchyFormGUI.php.

         {
                 return $this->icon;
         }

◆ getId()

ilHierarchyFormGUI::getId ( )

Get Id.

Returns: string Id

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

         {
                 return "hform";
         }

◆ getLegend()

ilHierarchyFormGUI::getLegend ( )

Get Legend.

Returns: string legend html

Definition at line 703 of file class.ilHierarchyFormGUI.php.

References $lng, ilGlyphGUI\ADD, ilGlyphGUI\DRAG, ilGlyphGUI\get(), getDragIcon(), and getHelpItems().

         {
                 global $lng;
 
                 include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
 
                 $ttpl = new ilTemplate("tpl.hierarchy_form_legend.html", true, true, "Services/Form");
                 if ($this->getDragIcon() != "")
                 {
                         $ttpl->setCurrentBlock("help_drag");
                         $ttpl->setVariable("IMG_DRAG", $this->getDragIcon());
                         $ttpl->setVariable("DRAG_ARROW",
                                 ilGlyphGUI::get(ilGlyphGUI::DRAG));
                         $ttpl->setVariable("TXT_DRAG",
                                 $lng->txt("form_hierarchy_drag_drop_help"));
                         $ttpl->setVariable("PLUS", ilGlyphGUI::get(ilGlyphGUI::ADD));
                         $ttpl->parseCurrentBlock();
                 }
 
                 // additional help items
                 foreach ($this->getHelpItems() as $help)
                 {
                         if ($help["image"] != "")
                         {
                                 $ttpl->setCurrentBlock("help_img");
                                 $ttpl->setVariable("IMG_HELP", $help["image"]);
                                 $ttpl->parseCurrentBlock();
                         }
                         $ttpl->setCurrentBlock("help_item");
                         $ttpl->setVariable("TXT_HELP", $help["text"]);
                         $ttpl->parseCurrentBlock();
                 }
 
                 $ttpl->setVariable("TXT_ADD_EL",
                         $lng->txt("form_hierarchy_add_elements"));
                 $ttpl->setVariable("PLUS2", ilGlyphGUI::get(ilGlyphGUI::ADD));
 
                 return $ttpl->get();
         }

Here is the call graph for this function:

◆ getLevelHTML()

ilHierarchyFormGUI::getLevelHTML	(		$a_par_node,
			$a_depth,
		&	$a_childs
	)

Get Form HTML.

Definition at line 747 of file class.ilHierarchyFormGUI.php.

References $html, $lng, getChilds(), ilUtil\getImagePath(), getMaxDepth(), getMenuItems(), manageDragAndDrop(), nodeAllowsChilds(), and renderChild().

Referenced by getContent(), and renderChild().

         {
                 global $lng;
                 
                 if ($this->getMaxDepth() > -1 && $this->getMaxDepth() < $a_depth)
                 {
                         return "";
                 }
 
                 $childs = $this->getChilds($a_par_node["node_id"]);
                 $a_childs = $childs;
                 $html = "";
                 $last_child = null;
                 $ttpl = new ilTemplate("tpl.hierarchy_form_nodes.html", true, true, "Services/Form");
 
                 // prepended drop area
                 if ($this->nodeAllowsChilds($a_par_node) && (count($childs) > 0 || $a_depth == 0))
                 {
                         $ttpl->setCurrentBlock("drop_area");
                         $ttpl->setVariable("DNODE_ID", $a_par_node["node_id"]."fc");            // fc means "first child"
                         $ttpl->setVariable("IMG_BLANK", ilUtil::getImagePath("spacer.png"));
                         if (count($childs) == 0)
                         {
                                 $ttpl->setVariable("NO_CONTENT_CLASS", "ilCOPGNoPageContent");
                                 $ttpl->setVariable("NO_CONTENT_TXT", " &nbsp;".$lng->txt("form_hier_click_to_add"));
                         }
                         $ttpl->parseCurrentBlock();
         
                         $this->manageDragAndDrop($a_par_node, $a_depth, true, null, $childs);
                         $menu_items = $this->getMenuItems($a_par_node, $a_depth, true, null, $childs);
 //var_dump($menu_items);
                         if (count($menu_items) > 0)
                         {
                                 // determine maximum of multi add numbers
                                 $max = 1;
                                 foreach($menu_items as $menu_item)
                                 {
                                         if ($menu_item["multi"] > $max)
                                         {
                                                 $max = $menu_item["multi"];
                                         }
                                 }
                                 
                                 reset($menu_items);
                                 $mcnt = 1;
                                 foreach($menu_items as $menu_item)
                                 {
                                         if ($menu_item["multi"] > 1)
                                         {
                                                 for($i = 1; $i <= $menu_item["multi"]; $i++)
                                                 {
                                                         $ttpl->setCurrentBlock("multi_add");
                                                         $ttpl->setVariable("MA_NUM", $i);
                                                         $ttpl->setVariable("MENU_CMD", $menu_item["cmd"]);
                                                         $ttpl->setVariable("FC", "1");
                                                         $ttpl->setVariable("CMD_NODE", $a_par_node["node_id"]);
                                                         $ttpl->setVariable("MCNT", $mcnt."fc");
                                                         $ttpl->parseCurrentBlock();
                                                 }
                                         }
                                         
                                         // buffer td for lower multis
                                         if ($max > $menu_item["multi"])
                                         {
                                                 $ttpl->setCurrentBlock("multi_buffer");
                                                 $ttpl->setVariable("BUF_SPAN", $max - $menu_item["multi"]);
                                                 $ttpl->parseCurrentBlock();
                                         }
                                         $ttpl->setCurrentBlock("menu_cmd");
                                         $ttpl->setVariable("TXT_MENU_CMD", $menu_item["text"]);
                                         $ttpl->setVariable("MENU_CMD", $menu_item["cmd"]);
                                         $ttpl->setVariable("CMD_NODE", $a_par_node["node_id"]);
                                         $ttpl->setVariable("FC", "1");
                                         $ttpl->setVariable("MCNT", $mcnt."fc");
                                         $ttpl->parseCurrentBlock();
                                         $mcnt++;
                                 }
                                 $ttpl->setCurrentBlock("drop_area_menu");
                                 $ttpl->setVariable("MNODE_ID", $a_par_node["node_id"]."fc");
                                 $ttpl->parseCurrentBlock();
         
                                 $ttpl->setCurrentBlock("element");
                                 $ttpl->parseCurrentBlock();
                         }
                 }
                 
                 // insert childs
                 if (count($childs) > 0)
                 {
                         for($i = 0; $i < count($childs); $i++)
                         {
                                 $next_sibling = ($i < (count($childs) - 1))
                                         ? $next_sibling = $childs[$i+1]
                                         : null;
 
                                 $this->renderChild($ttpl, $childs[$i], $a_depth, $next_sibling);
                                 $last_child = $child;
                         }
                 }
 
                 $html = $ttpl->get();
                 unset($ttpl);
                 
                 return $html;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaxDepth()

ilHierarchyFormGUI::getMaxDepth ( )

Get Maximum Depth.

Returns: int Maximum Depth

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

Referenced by getLevelHTML(), ilChapterHierarchyFormGUI\getMenuItems(), and ilChapterHierarchyFormGUI\manageDragAndDrop().

         {
                 return $this->maxdepth;
         }

Here is the caller graph for this function:

◆ getMenuItems()

ilHierarchyFormGUI::getMenuItems	(	$a_node,
		$a_depth,
		$a_first_child = `false`,
		$a_next_sibling = `null`,
		$a_childs = `null`
	)

Get menu items for drop area of node.

This function will be most likely overwritten by sub class

Parameters

array	$a_child	node array ("title", "node_id", "type")
boolean	$a_first_child	if false, the menu of the drop area right after the node (same level) is set if true, the menu of the drop area before the first child (if nodes are allowed) of the node is set

Definition at line 1109 of file class.ilHierarchyFormGUI.php.

References array.

Referenced by getLevelHTML(), and renderChild().

         {
                 return array();
         }

Here is the caller graph for this function:

◆ getParentCommand()

ilHierarchyFormGUI::getParentCommand ( )

Get parent command.

Returns: string parent command

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

Referenced by renderChild().

         {
                 return $this->parent_cmd;
         }

Here is the caller graph for this function:

◆ getParentObject()

ilHierarchyFormGUI::getParentObject ( )

Get Parent object.

Returns: object parent gui object

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

Referenced by renderChild().

         {
                 return $this->parent_obj;
         }

Here is the caller graph for this function:

◆ getPostFields()

static ilHierarchyFormGUI::getPostFields ( )

static

Get all post fields.

Definition at line 1175 of file class.ilHierarchyFormGUI.php.

References $_POST, and array.

Referenced by ilObjSCORM2004LearningModuleGUI\insertLMChapterClip().

         {
                 return array (
                         "il_hform_node" => $_POST["il_hform_node"],
                         "il_hform_fc" => $_POST["il_hform_fc"],
                         "il_hform_as_subitem" => $_POST["il_hform_as_subitem"],
                         "il_hform_multi" => $_POST["il_hform_multi"],
                         "il_hform_source_id" => $_POST["il_hform_source_id"],
                         "il_hform_target_id" => $_POST["il_hform_target_id"]
                 );
         }

Here is the caller graph for this function:

◆ getPostFirstChild()

static ilHierarchyFormGUI::getPostFirstChild ( )

static

Should node be inserted as first child of target node (true) or as successor (false)

Definition at line 1156 of file class.ilHierarchyFormGUI.php.

References $_POST.

         {
                 return (((int) $_POST["il_hform_fc"]) == 1);
         }

Here is the caller graph for this function:

◆ getPostMulti()

static ilHierarchyFormGUI::getPostMulti ( )

static

Get multi number of _POST input.

Definition at line 1138 of file class.ilHierarchyFormGUI.php.

References $_POST.

Referenced by ilObjSCORM2004LearningModuleGUI\insertAsset(), ilStructureObjectGUI\insertChapter(), ilObjSCORM2004LearningModuleGUI\insertChapter(), ilObjContentObjectGUI\insertChapter(), ilStructureObjectGUI\insertPage(), ilObjSCORM2004LearningModuleGUI\insertPage(), ilObjSCORM2004LearningModuleGUI\insertSco(), and ilObjSCORM2004LearningModuleGUI\insertTemplateGUI().

         {
                 return (int) ($_POST["il_hform_multi"] > 1
                         ? $_POST["il_hform_multi"]
                         : 1);
         }

Here is the caller graph for this function:

◆ getPostNodeId()

static ilHierarchyFormGUI::getPostNodeId ( )

static

Get node ID of _POST input.

Definition at line 1148 of file class.ilHierarchyFormGUI.php.

References $_POST.

         {
                 return $_POST["il_hform_node"];
         }

Here is the caller graph for this function:

◆ getTitle()

ilHierarchyFormGUI::getTitle ( )

Get Title.

Returns: string Title

Definition at line 145 of file class.ilHierarchyFormGUI.php.

References $title.

Referenced by getContent().

         {
                 return $this->title;
         }

Here is the caller graph for this function:

◆ getTree()

ilHierarchyFormGUI::getTree ( )

Get Tree Object.

Returns: object Tree Object

Definition at line 105 of file class.ilHierarchyFormGUI.php.

Referenced by getChilds(), getContent(), and updateExpanded().

         {
                 return $this->tree;
         }

Here is the caller graph for this function:

◆ getTypeWhiteList()

ilHierarchyFormGUI::getTypeWhiteList ( )

Get type whitelist.

Returns: array white list of types

Definition at line 468 of file class.ilHierarchyFormGUI.php.

         {
                 return $this->white_list;
         }

◆ makeDragContent()

ilHierarchyFormGUI::makeDragContent	(	$a_id,
		$a_group
	)

Makes a node a drag content.

Parameters

string	$a_id	node ID
string	$a_group	drag and drop group

Definition at line 300 of file class.ilHierarchyFormGUI.php.

References array.

Referenced by ilChapterHierarchyFormGUI\manageDragAndDrop(), and ilSCORM2004OrganizationHFormGUI\manageDragAndDrop().

         {
                 if ($a_id != "")
                 {
                         $this->drag_content[] = array("id" => $a_id, "group" => $a_group);
                 }
         }

Here is the caller graph for this function:

◆ makeDragTarget()

ilHierarchyFormGUI::makeDragTarget	(	$a_id,
		$a_group,
		$a_first_child_drop_area = `false`,
		$a_as_subitem = `false`,
		$a_diss_text = `""`
	)

Makes a nodes (following droparea) a drag target.

Parameters

string	$a_id	node ID
string	$a_group	drag and drop group

Definition at line 275 of file class.ilHierarchyFormGUI.php.

References array.

Referenced by ilChapterHierarchyFormGUI\manageDragAndDrop(), and ilSCORM2004OrganizationHFormGUI\manageDragAndDrop().

         {
                 if ($a_first_child_drop_area == true)           // first child drop areas only insert as subitems
                 {
                         $a_as_subitem = true;
                 }
                 
                 if ($a_id != "")
                 {
                         if ($a_first_child_drop_area)
                         {
                                 $a_id.= "fc";
                         }
                         
                         $this->drag_target[] = array("id" => $a_id, "group" => $a_group);
                         $this->diss_menues[$a_id][$a_group][] = array("subitem" => $a_as_subitem, "text" => $a_diss_text);
                 }
         }

Here is the caller graph for this function:

◆ manageDragAndDrop()

ilHierarchyFormGUI::manageDragAndDrop	(	$a_node,
		$a_depth,
		$a_first_child = `false`,
		$a_next_sibling = `null`,
		$a_childs = `null`
	)

Makes nodes drag and drop content and targets.

Must be overwritten to support drag and drop.

Parameters

object $a_node node array

Definition at line 1129 of file class.ilHierarchyFormGUI.php.

Referenced by getLevelHTML(), and renderChild().

         {
                 //$this->makeDragTarget($a_node["id"], $a_group);
                 //$this->makeDragTarget($a_node["id"], $a_group);
         }

Here is the caller graph for this function:

◆ nodeAllowsChilds()

ilHierarchyFormGUI::nodeAllowsChilds ( $a_node )

Checks, whether current nodes allows childs at all.

Should be overwritten.

Definition at line 1118 of file class.ilHierarchyFormGUI.php.

Referenced by getLevelHTML().

         {
                 return true;
         }

Here is the caller graph for this function:

◆ renderChild()

ilHierarchyFormGUI::renderChild	(	$a_tpl,
		$a_child,
		$a_depth,
		$next_sibling = `null`
	)

Render a single child (including grandchilds)

Definition at line 856 of file class.ilHierarchyFormGUI.php.

References $ilCtrl, $info, getCheckboxName(), getChildCommands(), getChildIcon(), getChildIconAlt(), getChildInfo(), getChildTitle(), getExpanded(), getExpandVariable(), getFocusId(), getHighlightedNodes(), ilUtil\getImagePath(), getLevelHTML(), getMenuItems(), getParentCommand(), getParentObject(), manageDragAndDrop(), and ilUtil\prepareFormOutput().

Referenced by getLevelHTML().

         {
                 global $ilCtrl;
                 
                 // image
                 $a_tpl->setCurrentBlock("img");
                 $a_tpl->setVariable("IMGPATH", $this->getChildIcon($a_child));
                 $a_tpl->setVariable("IMGALT", $this->getChildIconAlt($a_child));
                 $a_tpl->setVariable("IMG_NODE", $a_child["node_id"]);
                 $a_tpl->setVariable("NODE_ID", $a_child["node_id"]);
                 $a_tpl->setVariable("TYPE", $a_child["type"]);
                 $a_tpl->parseCurrentBlock();
                 
                 // checkbox
                 $a_tpl->setCurrentBlock("cbox");
                 $a_tpl->setVariable("CNODE_ID", $a_child["node_id"]);
                 $a_tpl->setVariable("CBOX_NAME", $this->getCheckboxName());
                 $a_tpl->parseCurrentBlock();
                 
                 // node info
                 if (($info = $this->getChildInfo($a_child)) != "")
                 {
                         $a_tpl->setCurrentBlock("node_info");
                         $a_tpl->setVariable("NODE_INFO", $info);
                         $a_tpl->parseCurrentBlock();
                 }
                 
                 // commands of child node
                 $child_commands = $this->getChildCommands($a_child);
                 if (is_array($child_commands))
                 {
                         foreach($child_commands as $command)
                         {
                                 $a_tpl->setCurrentBlock("node_cmd");
                                 $a_tpl->setVariable("HREF_NODE_CMD", $command["link"]);
                                 $a_tpl->setVariable("TXT_NODE_CMD", $command["text"]);
                                 $a_tpl->parseCurrentBlock();
                         }
                 }
                 
                 // title
                 $a_tpl->setCurrentBlock("text");
                 $hl = $this->getHighlightedNodes();
                 if (is_array($hl) && in_array($a_child["node_id"], $hl))
                 {
                         $a_tpl->setVariable("CLASS", ' class="ilHFormHighlighted" ');
                 }
                 $a_tpl->setVariable("VAL_TITLE", ilUtil::prepareFormOutput($this->getChildTitle($a_child)));
                 $a_tpl->setVariable("TNODE_ID", $a_child["node_id"]);
                 $a_tpl->parseCurrentBlock();
                 $grandchilds = null;
                 $grandchilds_html = $this->getLevelHTML($a_child, $a_depth + 1, $grandchilds);
                 
                 // focus
                 if ($this->getFocusId() == $a_child["node_id"])
                 {
                         $a_tpl->setCurrentBlock("focus");
                         $a_tpl->setVariable("FNODE_ID", $a_child["node_id"]);
                         $a_tpl->parseCurrentBlock();
                 }
                 
                 // expander
                 if ($this->getExpandVariable() != "")
                 {
                         $a_tpl->setCurrentBlock("expand_icon");
                         if (!is_null($grandchilds) && count($grandchilds) > 0)
                         {
                                 if (!in_array($a_child["node_id"],$this->getExpanded()))
                                 {
                                         $ilCtrl->setParameter($this->getParentObject(), $this->getExpandVariable(), $a_child["node_id"]);
                                         $a_tpl->setVariable("IMG_EXPAND", ilUtil::getImagePath("browser/plus.png"));
                                         $a_tpl->setVariable("HREF_NAME", "n".$a_child["node_id"]);
                                         $a_tpl->setVariable("HREF_EXPAND",
                                                 $ilCtrl->getLinkTarget($this->getParentObject(), $this->getParentCommand(), "n".$a_child["node_id"]));
                                         $grandchilds_html = "";
                                 }
                                 else
                                 {
                                         $ilCtrl->setParameter($this->getParentObject(), $this->getExpandVariable(), -$a_child["node_id"]);
                                         $a_tpl->setVariable("IMG_EXPAND", ilUtil::getImagePath("browser/minus.png"));
                                         $a_tpl->setVariable("HREF_NAME", "n".$a_child["node_id"]);
                                         $a_tpl->setVariable("HREF_EXPAND",
                                                 $ilCtrl->getLinkTarget($this->getParentObject(), $this->getParentCommand(), "n".$a_child["node_id"]));
                                 }
                                 $ilCtrl->setParameter($this->getParentObject(), $this->getExpandVariable(), "");
                         }
                         else
                         {
                                 $a_tpl->setVariable("IMG_EXPAND", ilUtil::getImagePath("spacer.png"));
                         }
                         $a_tpl->parseCurrentBlock();
                 }
                 
                 // childs
                 $a_tpl->setCurrentBlock("list_item");
                 $a_tpl->setVariable("CHILDS", $grandchilds_html);
                 $a_tpl->parseCurrentBlock();
                 
                 $a_tpl->setCurrentBlock("element");
                 $a_tpl->parseCurrentBlock();
                 
                 // drop area after child
                 $a_tpl->setCurrentBlock("drop_area");
                 $a_tpl->setVariable("DNODE_ID", $a_child["node_id"]);
                 $a_tpl->setVariable("IMG_BLANK", ilUtil::getImagePath("spacer.png"));
                 $a_tpl->parseCurrentBlock();
 
                 // manage drag and drop areas
                 $this->manageDragAndDrop($a_child, $a_depth, false, $next_sibling, $grandchilds);
                 
                 // drop area menu
                 $menu_items = $this->getMenuItems($a_child, $a_depth, false, $next_sibling, $grandchilds);
                 if (count($menu_items) > 0)
                 {
                         // determine maximum of multi add numbers
                         $max = 1;
                         foreach($menu_items as $menu_item)
                         {
                                 if ($menu_item["multi"] > $max)
                                 {
                                         $max = $menu_item["multi"];
                                 }
                         }
                         
                         reset($menu_items);
                         $mcnt = 1;
                         foreach($menu_items as $menu_item)
                         {
                                 if ($menu_item["multi"] > 1 )
                                 {
                                         for($i = 1; $i <= $menu_item["multi"]; $i++)
                                         {
                                                 $a_tpl->setCurrentBlock("multi_add");
                                                 $a_tpl->setVariable("MA_NUM", $i);
                                                 $a_tpl->setVariable("MENU_CMD", $menu_item["cmd"]);
                                                 if ($menu_item["as_subitem"])
                                                 {
                                                         $a_tpl->setVariable("FC", "1");
                                                         $a_tpl->setVariable("MCNT", $mcnt."fc");
                                                 }
                                                 else
                                                 {
                                                         $a_tpl->setVariable("FC", "0");
                                                         $a_tpl->setVariable("MCNT", $mcnt);
                                                 }
                                                 $a_tpl->setVariable("CMD_NODE", $a_child["node_id"]);
                                                 $a_tpl->parseCurrentBlock();
                                         }
                                 }
                                 
                                 // buffer td for lower multis
                                 if ($max > $menu_item["multi"])
                                 {
                                         $a_tpl->setCurrentBlock("multi_buffer");
                                         $a_tpl->setVariable("BUF_SPAN", $max - $menu_item["multi"]);
                                         $a_tpl->parseCurrentBlock();
                                 }
                                 
                                 $a_tpl->setCurrentBlock("menu_cmd");
                                 $a_tpl->setVariable("TXT_MENU_CMD", $menu_item["text"]);
                                 $a_tpl->setVariable("MENU_CMD", $menu_item["cmd"]);
                                 if ($menu_item["as_subitem"])
                                 {
                                         $a_tpl->setVariable("FC", "1");
                                         $a_tpl->setVariable("MCNT", $mcnt."fc");
                                 }
                                 else
                                 {
                                         $a_tpl->setVariable("FC", "0");
                                         $a_tpl->setVariable("MCNT", $mcnt);
                                 }
                                 $a_tpl->setVariable("CMD_NODE", $a_child["node_id"]);
                                 $a_tpl->parseCurrentBlock();
                                 $mcnt++;
                         }
                         $a_tpl->setCurrentBlock("drop_area_menu");
                         $a_tpl->setVariable("MNODE_ID", $a_child["node_id"]);
                         $a_tpl->parseCurrentBlock();
                 }
                 
                 $a_tpl->setCurrentBlock("element");
                 $a_tpl->parseCurrentBlock();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCheckboxName()

ilHierarchyFormGUI::setCheckboxName ( $a_checkboxname )

Set Checkbox Name.

Parameters

string $a_checkboxname Checkbox Name

Definition at line 175 of file class.ilHierarchyFormGUI.php.

Referenced by ilSCORM2004OrganizationHFormGUI\__construct(), __construct(), and ilChapterHierarchyFormGUI\__construct().

         {
                 $this->checkboxname = $a_checkboxname;
         }

Here is the caller graph for this function:

◆ setCurrentTopNodeId()

ilHierarchyFormGUI::setCurrentTopNodeId ( $a_currenttopnodeid )

Set Current Top Node ID.

Parameters

string $a_currenttopnodeid Current Top Node ID

Definition at line 115 of file class.ilHierarchyFormGUI.php.

         {
                 $this->currenttopnodeid = $a_currenttopnodeid;
         }

◆ setDragIcon()

ilHierarchyFormGUI::setDragIcon ( $a_dragicon )

Set Drag Icon Path.

Parameters

string $a_dragicon Drag Icon Path

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

         {
                 $this->dragicon = $a_dragicon;
         }

◆ setExpanded()

ilHierarchyFormGUI::setExpanded ( $a_val )

Set expanded Array.

Parameters

array expanded array

Definition at line 395 of file class.ilHierarchyFormGUI.php.

Referenced by updateExpanded().

         {
                 $this->expanded = $a_val;
         }

Here is the caller graph for this function:

◆ setExpandVariable()

ilHierarchyFormGUI::setExpandVariable ( $a_val )

Set expand variable.

Parameters

Definition at line 375 of file class.ilHierarchyFormGUI.php.

Referenced by ilSCORM2004OrganizationHFormGUI\__construct().

         {
                 $this->expand_variable = $a_val;
         }

Here is the caller graph for this function:

◆ setExplorerUpdater()

ilHierarchyFormGUI::setExplorerUpdater	(	$a_exp_frame,
		$a_exp_id,
		$a_exp_target_script
	)

Set Explorer Updater.

Parameters

object $a_tree Tree Object

Definition at line 235 of file class.ilHierarchyFormGUI.php.

         {
                 $this->exp_frame = $a_exp_frame;
                 $this->exp_id = $a_exp_id;
                 $this->exp_target_script = $a_exp_target_script;
         }

◆ setFocusId()

ilHierarchyFormGUI::setFocusId ( $a_val )

Set focus if.

Parameters

int node id

Definition at line 355 of file class.ilHierarchyFormGUI.php.

         {
                 $this->focus_id = $a_val;
         }

◆ setHighlightedNodes()

ilHierarchyFormGUI::setHighlightedNodes ( $a_val )

Set highlighted nodes.

Parameters

array highlighted nodes

Definition at line 335 of file class.ilHierarchyFormGUI.php.

         {
                 $this->highlighted_nodes = $a_val;
         }

◆ setIcon()

ilHierarchyFormGUI::setIcon ( $a_icon )

Set Icon.

Parameters

string $a_icon Icon

Definition at line 155 of file class.ilHierarchyFormGUI.php.

         {
                 $this->icon = $a_icon;
         }

◆ setId()

ilHierarchyFormGUI::setId ( $a_id )

Set Id.

Currently not possible, due to js handling (ID must always be "hform")

Parameters

string $a_id Id

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

         {
                 die("ilHierarchyFormGUI does currently not support multiple forms (multiple IDs). ID is always hform.");
         }

◆ setMaxDepth()

ilHierarchyFormGUI::setMaxDepth ( $a_maxdepth )

Set Maximum Depth.

Parameters

int $a_maxdepth Maximum Depth

Definition at line 215 of file class.ilHierarchyFormGUI.php.

         {
                 $this->maxdepth = $a_maxdepth;
         }

◆ setParentCommand()

ilHierarchyFormGUI::setParentCommand	(	$a_parent_obj,
		$a_parent_cmd
	)

Set parent gui object/cmd.

This is needed, if the expand feature is used.

Definition at line 44 of file class.ilHierarchyFormGUI.php.

         {
                 $this->parent_obj = $a_parent_obj;
                 $this->parent_cmd = $a_parent_cmd;
         }

◆ setTitle()

ilHierarchyFormGUI::setTitle ( $a_title )

Set Title.

Parameters

string $a_title Title

Definition at line 135 of file class.ilHierarchyFormGUI.php.

         {
                 $this->title = $a_title;
         }

◆ setTree()

ilHierarchyFormGUI::setTree ( $a_tree )

Set Tree Object.

Parameters

object $a_tree Tree Object

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

         {
                 $this->tree = $a_tree;
         }

◆ setTriggeredUpdateCommand()

ilHierarchyFormGUI::setTriggeredUpdateCommand ( $a_triggered_update_command )

Set Explorer Updater.

Parameters

object $a_tree Tree Object

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

         {
                 $this->triggered_update_command = $a_triggered_update_command;
         }

◆ setTypeWhiteList()

ilHierarchyFormGUI::setTypeWhiteList ( $a_val )

Set type whitelist.

Parameters

array $a_val white list of types

Definition at line 458 of file class.ilHierarchyFormGUI.php.

         {
                 $this->white_list = $a_val;
         }

◆ updateExpanded()

ilHierarchyFormGUI::updateExpanded ( )

Update expand information in session.

Parameters

string node id

Definition at line 415 of file class.ilHierarchyFormGUI.php.

References $_GET, $_POST, $_SESSION, array, getExpandVariable(), getTree(), and setExpanded().

Referenced by getContent().

         {
                 $ev = $this->getExpandVariable();
 
                 if ($ev == "")
                 {
                         return;
                 }
                 
                 // init empty session
                 if (!is_array($_SESSION[$ev]))
                 {
                         $_SESSION[$ev] = array($this->getTree()->getRootId());
                 }
 
                 if ($_POST["il_hform_expand"] != "")
                 {
                         $node_id = $_POST["il_hform_expand"];
                 }
                 if ($_GET[$ev] != "")
                 {
                         $node_id = $_GET[$ev];
                 }
                 
                 // if positive => expand this node
                 if ($node_id > 0 && !in_array($node_id,$_SESSION[$ev]))
                 {
                         array_push($_SESSION[$ev], $node_id);
                 }
                 // if negative => compress this node
                 if ($node_id < 0)
                 {
                         $key = array_keys($_SESSION[$ev],-(int) $node_id);
                         unset($_SESSION[$ev][$key[0]]);
                 }
                 $this->setExpanded($_SESSION[$ev]);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

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

Services/Form/classes/class.ilHierarchyFormGUI.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCommand()

◆ addHelpItem()

◆ addMultiCommand()

◆ getCheckboxName()

◆ getChildCommands()

◆ getChildIcon()

◆ getChildIconAlt()

◆ getChildInfo()

◆ getChilds()

◆ getChildTitle()

◆ getContent()

◆ getCurrentTopNodeId()

◆ getDragIcon()

◆ getExpanded()

◆ getExpandVariable()

◆ getFocusId()

◆ getHelpItems()

◆ getHighlightedNodes()

◆ getHTML()

◆ getIcon()

◆ getId()

◆ getLegend()

◆ getLevelHTML()

◆ getMaxDepth()

◆ getMenuItems()

◆ getParentCommand()

◆ getParentObject()

◆ getPostFields()

◆ getPostFirstChild()

◆ getPostMulti()

◆ getPostNodeId()

◆ getTitle()

◆ getTree()

◆ getTypeWhiteList()

◆ makeDragContent()

◆ makeDragTarget()

◆ manageDragAndDrop()

◆ nodeAllowsChilds()

◆ renderChild()

◆ setCheckboxName()

◆ setCurrentTopNodeId()

◆ setDragIcon()

◆ setExpanded()

◆ setExpandVariable()

◆ setExplorerUpdater()

◆ setFocusId()

◆ setHighlightedNodes()

◆ setIcon()

◆ setId()

◆ setMaxDepth()

◆ setParentCommand()

◆ setTitle()

◆ setTree()

◆ setTriggeredUpdateCommand()

◆ setTypeWhiteList()

◆ updateExpanded()