This class represents a hierarchical form. More...

Inheritance diagram for ilHierarchyFormGUI:

Collaboration diagram for ilHierarchyFormGUI:

Public Member Functions
	__construct ()

	setParentCommand (object $a_parent_obj, string $a_parent_cmd)

	getParentObject ()

	getParentCommand ()

	setId (string $a_id)

	getId ()

	setTree (ilTree $a_tree)

	getTree ()

	setCurrentTopNodeId (int $a_currenttopnodeid)

	getCurrentTopNodeId ()

	setTitle (string $a_title)

	getTitle ()

	setIcon (string $a_icon)

	getIcon ()

	setCheckboxName (string $a_checkboxname)

	getCheckboxName ()

	setDragIcon (string $a_dragicon)

	getDragIcon ()

	setMaxDepth (int $a_maxdepth)

	getMaxDepth ()

	setExplorerUpdater (string $a_exp_frame, string $a_exp_id, string $a_exp_target_script)

	setTriggeredUpdateCommand (string $a_triggered_update_command)

	addHelpItem (string $a_text, string $a_image="")

	getHelpItems ()

	makeDragTarget (string $a_id, string $a_group, bool $a_first_child_drop_area=false, bool $a_as_subitem=false, string $a_diss_text="")

	makeDragContent (string $a_id, string $a_group)

	addMultiCommand (string $a_txt, string $a_cmd)

	addCommand (string $a_txt, string $a_cmd)

	setHighlightedNodes (array $a_val)

	getHighlightedNodes ()

	setFocusId (string $a_val)

	getFocusId ()

	setExpandVariable (string $a_val)

	getExpandVariable ()

	setExpanded (array $a_val)

	getExpanded ()

	updateExpanded ()

	setTypeWhiteList (array $a_val)

	getTypeWhiteList ()

	getChilds (?int $a_node_id=null)
	Get all childs of current node. More...

	getContent ()

	getLegend ()

	getLevelHTML (array $a_par_node, int $a_depth, array &$a_childs)

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

	getChildIcon (array $a_item)

	getChildIconAlt (array $a_item)

	getChildCommands (array $a_item)

	getChildTitle (array $a_child)

	getChildInfo (array $a_child)

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

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

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

	getHTML ()

Public Member Functions inherited from ilFormGUI
	setFormAction (string $a_formaction)

	getFormAction ()

	setTarget (string $a_target)

	getTarget ()

	setMultipart (bool $a_multipart)

	getMultipart ()

	setId (string $a_id)

	getId ()

	setName (string $a_name)

	getName ()

	setKeepOpen (bool $a_keepopen)

	getKeepOpen ()

	setOpenTag (bool $a_open)

	getOpenTag ()

	setCloseTag (bool $a_val)

	getCloseTag ()

	setPreventDoubleSubmission (bool $a_val)

	getPreventDoubleSubmission ()

	getHTML ()

	getContent ()

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 ()

Protected Member Functions
	str ($key)

Static Protected Member Functions
static	_str ($key)

Protected Attributes
ilGlobalTemplateInterface	$main_tpl

string	$exp_target_script = ""

string	$icon = ""

string	$exp_id = ""

ilLanguage	$lng

ilCtrl	$ctrl

string	$expand_variable = ""

array	$white_list = null

array	$highlighted_nodes = []

string	$focus_id = ""

string	$exp_frame = ""

string	$triggered_update_command = ""

array	$drag_target = []

array	$drag_content = []

object	$parent_obj

string	$parent_cmd = ""

ilTree	$tree

int	$currenttopnodeid = 0

string	$title = ""

string	$checkboxname = ""

string	$dragicon = ""

int	$maxdepth = 0

array	$help_items = []

array	$diss_menues = []

array	$multi_commands = []

array	$commands = []

array	$expanded = []

HTTP Services	$http

Refinery Factory	$refinery

Protected Attributes inherited from ilFormGUI
string	$formaction = ""

bool	$multipart = false

bool	$keepopen = false

bool	$opentag = true

string	$id = ''

string	$name = ''

string	$target = ''

bool	$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: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilHierarchyFormGUI::__construct ( )

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $lng = $DIC->language();
        $this->main_tpl = $DIC->ui()->mainTemplate();
 
        $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();
 
        ilYuiUtil::initDragDrop();
        $this->main_tpl->addJavascript("./Services/Form/js/ServiceFormHierarchyForm.js");
 
 
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
    }

References $DIC, $lng, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ilYuiUtil\initDragDrop(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ILIAS\Repository\refinery(), and setCheckboxName().

Here is the call graph for this function:

Member Function Documentation

◆ _str()

static ilHierarchyFormGUI::_str ( $key )

staticprotected

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

                                        : string
    {
        global $DIC;
 
        $w = $DIC->http()->wrapper();
        $t = $DIC->refinery()->kindlyTo()->string();
 
        if (!$w->post()->has($key) && !$w->query()->has($key)) {
            return "";
        }
 
        $val = (string) ($w->post()->retrieve($key, $t) ?? "");
 
        if ($val == "") {
            $val = (string) ($w->query()->retrieve($key, $t) ?? "");
        }
        return ilUtil::stripSlashes($val);
    }

References $DIC, ILIAS\LTI\ToolProvider\$key, and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ addCommand()

ilHierarchyFormGUI::addCommand	(	string	$a_txt,
		string	$a_cmd
	)

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

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

◆ addHelpItem()

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

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

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

◆ addMultiCommand()

ilHierarchyFormGUI::addMultiCommand	(	string	$a_txt,
		string	$a_cmd
	)

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

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

◆ getCheckboxName()

ilHierarchyFormGUI::getCheckboxName ( )

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

                                     : string
    {
        return $this->checkboxname;
    }

◆ getChildCommands()

ilHierarchyFormGUI::getChildCommands ( array $a_item )

Reimplemented in ilChapterHierarchyFormGUI.

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

◆ getChildIcon()

ilHierarchyFormGUI::getChildIcon ( array $a_item )

Reimplemented in ilChapterHierarchyFormGUI.

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

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

References ilUtil\getImagePath().

Here is the call graph for this function:

◆ getChildIconAlt()

ilHierarchyFormGUI::getChildIconAlt ( array $a_item )

Reimplemented in ilChapterHierarchyFormGUI.

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

                                                  : string
    {
        $lng = $this->lng;
 
        return $lng->txt($a_item["type"]);
    }

References $lng.

◆ getChildInfo()

ilHierarchyFormGUI::getChildInfo ( array $a_child )

Reimplemented in ilChapterHierarchyFormGUI.

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

                                                : string
    {
        return "";
    }

◆ getChilds()

ilHierarchyFormGUI::getChilds ( ?int $a_node_id = null )

Get all childs of current node.

Standard implementation uses tree object.

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

                                                     : array
    {
        if ($a_node_id == null) {
            $a_node_id = $this->getCurrentTopNodeId();
        }
 
        $tree_childs = $this->getTree()->getChilds($a_node_id);
        $childs = array();
        foreach ($tree_childs as $tree_child) {
            if (!isset($this->white_list) || !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;
    }

◆ getChildTitle()

ilHierarchyFormGUI::getChildTitle ( array $a_child )

Reimplemented in ilChapterHierarchyFormGUI.

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

                                                 : string
    {
        return $a_child["title"];
    }

◆ getContent()

ilHierarchyFormGUI::getContent ( )

Reimplemented from ilFormGUI.

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

                                : string
    {
        $lng = $this->lng;
        $single = false;
        $multi = false;
 
        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"] ?? 0,
                "title" => $top_node_data["title"] ?? "",
                "type" => $top_node_data["type"] ?? "");
 
        $childs = [];
        $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) {
            $this->main_tpl->addOnLoadCode('d = new ilDragTarget("droparea_" + "'.($drag_target["id"] ?? "").
            '", "'.($drag_target["group"] ?? "").'");');
        }
        foreach ($this->drag_content as $drag_content) {
            $this->main_tpl->addOnLoadCode('d = new ilDragContent("il_img_" + "'.($drag_content["id"] ?? "").
                '", "'.($drag_content["group"] ?? "").'");');
        }
 
        // 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();
                    } elseif (count($menu) == 1) {
                        // set first child flag
                        $this->main_tpl->addOnLoadCode('as_subitem["'.$node_id.'" + "_" + "'.$group.'"] = "'.(int) $menu[0]["subitem"].'";');
                    }
                }
            }
        }
//        $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();
                    } elseif (count($menu) == 1) {
                        // set first child flag
                        $this->main_tpl->addOnLoadCode('as_subitem["'.$node_id.'" + "_" + "'.$group.'"] = "'.(int) $menu[0]["subitem"].'";');
                    }
                }
            }
        }
        //$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();
    }

References $lng, and ilUtil\getImagePath().

Here is the call graph for this function:

◆ getCurrentTopNodeId()

ilHierarchyFormGUI::getCurrentTopNodeId ( )

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

                                         : int
    {
        return $this->currenttopnodeid;
    }

◆ getDragIcon()

ilHierarchyFormGUI::getDragIcon ( )

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

                                 : string
    {
        return $this->dragicon;
    }

◆ getExpanded()

ilHierarchyFormGUI::getExpanded ( )

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

                                 : array
    {
        return $this->expanded;
    }

◆ getExpandVariable()

ilHierarchyFormGUI::getExpandVariable ( )

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

                                       : string
    {
        return $this->expand_variable;
    }

◆ getFocusId()

ilHierarchyFormGUI::getFocusId ( )

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

                                : string
    {
        return $this->focus_id;
    }

◆ getHelpItems()

ilHierarchyFormGUI::getHelpItems ( )

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

                                  : array
    {
        return $this->help_items;
    }

◆ getHighlightedNodes()

ilHierarchyFormGUI::getHighlightedNodes ( )

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

                                         : array
    {
        return $this->highlighted_nodes;
    }

◆ getHTML()

ilHierarchyFormGUI::getHTML ( )

Reimplemented from ilFormGUI.

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

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

◆ getIcon()

ilHierarchyFormGUI::getIcon ( )

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

                             : string
    {
        return $this->icon;
    }

◆ getId()

ilHierarchyFormGUI::getId ( )

Reimplemented from ilFormGUI.

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

                           : string
    {
        return "hform";
    }

◆ getLegend()

ilHierarchyFormGUI::getLegend ( )

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

                               : string
    {
        $lng = $this->lng;
 
        $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();
    }

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

Here is the call graph for this function:

◆ getLevelHTML()

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

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

     : string {
        $lng = $this->lng;
 
        if ($this->getMaxDepth() > -1 && $this->getMaxDepth() < $a_depth) {
            return "";
        }
 
        $childs = $this->getChilds((int) $a_par_node["node_id"]);
        $a_childs = $childs;
        $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, $iMax = count($childs); $i < $iMax; $i++) {
                $next_sibling = ($i < (count($childs) - 1))
                    ? $childs[$i + 1]
                    : null;
 
                $this->renderChild($ttpl, $childs[$i], $a_depth, $next_sibling);
            }
        }
 
        $html = $ttpl->get();
        unset($ttpl);
 
        return $html;
    }

◆ getMaxDepth()

ilHierarchyFormGUI::getMaxDepth ( )

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

                                 : int
    {
        return $this->maxdepth;
    }

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

Here is the caller graph for this function:

◆ getMenuItems()

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

Get menu items for drop area of node.

This function will be most likely overwritten by sub class

Parameters

array	$a_node	node array ("title", "node_id", "type")
bool	$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

Reimplemented in ilChapterHierarchyFormGUI.

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

     : array {
        return array();
    }

◆ getParentCommand()

ilHierarchyFormGUI::getParentCommand ( )

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

                                      : string
    {
        return $this->parent_cmd;
    }

◆ getParentObject()

ilHierarchyFormGUI::getParentObject ( )

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

                                     : object
    {
        return $this->parent_obj;
    }

◆ getPostFields()

static ilHierarchyFormGUI::getPostFields ( )

static

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

                                          : array
    {
        return array(
            "il_hform_node" => self::_str("il_hform_node"),
            "il_hform_fc" => self::_str("il_hform_fc"),
            "il_hform_as_subitem" => self::_str("il_hform_as_subitem"),
            "il_hform_multi" => self::_str("il_hform_multi"),
            "il_hform_source_id" => self::_str("il_hform_source_id"),
            "il_hform_target_id" => self::_str("il_hform_target_id")
        );
    }

◆ getPostFirstChild()

static ilHierarchyFormGUI::getPostFirstChild ( )

static

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

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

                                              : bool
    {
        return ((int) self::_str("il_hform_fc") == 1);
    }

Referenced by ilObjContentObjectGUI\insertChapter(), ilObjContentObjectGUI\insertChapterClip(), ilStructureObjectGUI\insertPage(), ilStructureObjectGUI\insertPageClip(), and ilStructureObjectGUI\insertTemplate().

Here is the caller graph for this function:

◆ getPostMulti()

static ilHierarchyFormGUI::getPostMulti ( )

static

Get multi number of _POST input.

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

                                         : int
    {
        return max(1, (int) self::_str("il_hform_multi"));
    }

Referenced by ilObjContentObjectGUI\insertChapter(), ilStructureObjectGUI\insertPage(), and ilStructureObjectGUI\insertTemplate().

Here is the caller graph for this function:

◆ getPostNodeId()

static ilHierarchyFormGUI::getPostNodeId ( )

static

Get node ID of _POST input.

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

                                          : string
    {
        return self::_str("il_hform_node");
    }

Referenced by ilObjContentObjectGUI\insertChapter(), ilObjContentObjectGUI\insertChapterClip(), ilStructureObjectGUI\insertPage(), ilStructureObjectGUI\insertPageClip(), and ilStructureObjectGUI\insertTemplate().

Here is the caller graph for this function:

◆ getTitle()

ilHierarchyFormGUI::getTitle ( )

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

                              : string
    {
        return $this->title;
    }

◆ getTree()

ilHierarchyFormGUI::getTree ( )

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

                             : ilTree
    {
        return $this->tree;
    }

◆ getTypeWhiteList()

ilHierarchyFormGUI::getTypeWhiteList ( )

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

                                      : array
    {
        return $this->white_list;
    }

◆ makeDragContent()

ilHierarchyFormGUI::makeDragContent	(	string	$a_id,
		string	$a_group
	)

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

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

Referenced by ilChapterHierarchyFormGUI\manageDragAndDrop().

Here is the caller graph for this function:

◆ makeDragTarget()

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

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

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

Referenced by ilChapterHierarchyFormGUI\manageDragAndDrop().

Here is the caller graph for this function:

◆ manageDragAndDrop()

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

Makes nodes drag and drop content and targets.

Must be overwritten to support drag and drop.

Parameters

array $a_node node array

Reimplemented in ilChapterHierarchyFormGUI.

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

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

◆ nodeAllowsChilds()

ilHierarchyFormGUI::nodeAllowsChilds ( array $a_node )

Checks, whether current nodes allows childs at all.

Should be overwritten.

Reimplemented in ilChapterHierarchyFormGUI.

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

                                                   : bool
    {
        return true;
    }

◆ renderChild()

ilHierarchyFormGUI::renderChild	(	ilTemplate	$a_tpl,
		array	$a_child,
		int	$a_depth,
		?array	$next_sibling = `null`
	)

Render a single child (including grandchilds)

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

      {
        $ilCtrl = $this->ctrl;
 
        // 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", ilLegacyFormElementsUtil::prepareFormOutput($this->getChildTitle($a_child)));
        $a_tpl->setVariable("TNODE_ID", $a_child["node_id"]);
        $a_tpl->parseCurrentBlock();
        $grandchilds = [];
        $grandchilds_html = $this->getLevelHTML($a_child, $a_depth + 1, $grandchilds);
 
        // focus
        if ($this->getFocusId() == $a_child["node_id"]) {
            $this->main_tpl->addOnLoadCode('document.getElementById("inp'.$a_child["node_id"].'").focus();');
        }
 
        // 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"] ?? false) {
                            $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"] ?? false) {
                    $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();
    }

References $i, ilUtil\getImagePath(), ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

◆ setCheckboxName()

ilHierarchyFormGUI::setCheckboxName ( string $a_checkboxname )

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

                                                           : void
    {
        $this->checkboxname = $a_checkboxname;
    }

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

Here is the caller graph for this function:

◆ setCurrentTopNodeId()

ilHierarchyFormGUI::setCurrentTopNodeId ( int $a_currenttopnodeid )

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

                                                                : void
    {
        $this->currenttopnodeid = $a_currenttopnodeid;
    }

◆ setDragIcon()

ilHierarchyFormGUI::setDragIcon ( string $a_dragicon )

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

                                                   : void
    {
        $this->dragicon = $a_dragicon;
    }

◆ setExpanded()

ilHierarchyFormGUI::setExpanded ( array $a_val )

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

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

◆ setExpandVariable()

ilHierarchyFormGUI::setExpandVariable ( string $a_val )

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

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

◆ setExplorerUpdater()

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

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

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

◆ setFocusId()

ilHierarchyFormGUI::setFocusId ( string $a_val )

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

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

◆ setHighlightedNodes()

ilHierarchyFormGUI::setHighlightedNodes ( array $a_val )

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

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

◆ setIcon()

ilHierarchyFormGUI::setIcon ( string $a_icon )

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

                                           : void
    {
        $this->icon = $a_icon;
    }

◆ setId()

ilHierarchyFormGUI::setId ( string $a_id )

Exceptions

ilException

Reimplemented from ilFormGUI.

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

                                       : void
    {
        throw new ilException("ilHierarchyFormGUI does currently not support multiple forms (multiple IDs). ID is always hform.");
    }

◆ setMaxDepth()

ilHierarchyFormGUI::setMaxDepth ( int $a_maxdepth )

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

                                                : void
    {
        $this->maxdepth = $a_maxdepth;
    }

◆ setParentCommand()

ilHierarchyFormGUI::setParentCommand	(	object	$a_parent_obj,
		string	$a_parent_cmd
	)

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

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

◆ setTitle()

ilHierarchyFormGUI::setTitle ( string $a_title )

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

                                             : void
    {
        $this->title = $a_title;
    }

◆ setTree()

ilHierarchyFormGUI::setTree ( ilTree $a_tree )

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

                                           : void
    {
        $this->tree = $a_tree;
    }

◆ setTriggeredUpdateCommand()

ilHierarchyFormGUI::setTriggeredUpdateCommand ( string $a_triggered_update_command )

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

     : void {
        $this->triggered_update_command = $a_triggered_update_command;
    }

◆ setTypeWhiteList()

ilHierarchyFormGUI::setTypeWhiteList ( array $a_val )

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

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

◆ str()

ilHierarchyFormGUI::str ( $key )

protected

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

                                : string
    {
        return self::_str($key);
    }

References ILIAS\LTI\ToolProvider\$key.

◆ updateExpanded()

ilHierarchyFormGUI::updateExpanded ( )

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

                                    : void
    {
        $ev = $this->getExpandVariable();
        $node_id = 0;
        if ($ev == "") {
            return;
        }
 
        // init empty session
        if (!is_array(ilSession::get($ev))) {
            ilSession::set($ev, array($this->getTree()->getRootId()));
        }
 
        if ($this->str("il_hform_expand") != "") {
            $node_id = $this->str("il_hform_expand");
        }
        if ($this->str($ev) != "") {
            $node_id = $this->str($ev);
        }
 
        // if positive => expand this node
        if ($node_id > 0 && !in_array($node_id, ilSession::get($ev))) {
            $nodes = ilSession::get($ev);
            $nodes[] = $node_id;
            ilSession::set($ev, $nodes);
        }
        // if negative => compress this node
        if ($node_id < 0) {
            $key = array_keys(ilSession::get($ev), -(int) $node_id);
            $nodes = ilSession::get($ev);
            unset($nodes[$ev][$key[0]]);
            ilSession::set($ev, $nodes);
        }
        $this->setExpanded(ilSession::get($ev));
    }