This class represents a hierarchical form. More...

Inheritance diagram for ilChapterHierarchyFormGUI:

Collaboration diagram for ilChapterHierarchyFormGUI:

Public Member Functions
	__construct ($a_lm_type, $a_lang="-")
	Constructor. 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. More...

	nodeAllowsChilds ($a_node)
	Which nodes allow child nodes? More...

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

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

	getChildIconAlt ($a_item)
	Get icon alt text. More...

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

Public Member Functions inherited from ilHierarchyFormGUI
	__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...

Protected Attributes
	$user

	$page_layouts

Protected Attributes inherited from ilHierarchyFormGUI
	$lng

	$tpl

	$ctrl

Protected Attributes inherited from ilFormGUI
	$formaction

	$multipart = false

	$keepopen = false

	$opentag = true

	$id

	$name

	$prevent_double_submission = false

Additional Inherited Members
Static Public Member Functions inherited from ilHierarchyFormGUI
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...

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

Constructor & Destructor Documentation

◆ __construct()

ilChapterHierarchyFormGUI::__construct	(	$a_lm_type,
		$a_lang = `"-"`
	)

Constructor.

Parameters

Definition at line 31 of file class.ilChapterHierarchyFormGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilPageLayout\activeLayouts(), ilPageLayout\MODULE_LM, ilHierarchyFormGUI\setCheckboxName(), and user().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->user = $DIC->user();
         $this->ctrl = $DIC->ctrl();
         $this->lm_type = $a_lm_type;
 
         $this->lang = ($a_lang == "")
             ? "-"
             : $a_lang;
         parent::__construct();
         $this->setCheckboxName("id");
 
         $this->page_layouts = ilPageLayout::activeLayouts(
             false,
             ilPageLayout::MODULE_LM
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ getChildCommands()

ilChapterHierarchyFormGUI::getChildCommands ( $a_item )

Get item commands.

Parameters

array item array

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

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

References ilHierarchyFormGUI\$ctrl, $ilCtrl, and ilHierarchyFormGUI\$lng.

     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
         
         $lm_class = "ilobjlearningmodulegui";
         
         $commands = array();
         switch ($a_item["type"]) {
             case "pg":
                 $ilCtrl->setParameterByClass(
                     "illmpageobjectgui",
                     "obj_id",
                     $a_item["node_id"]
                 );
                 $commands[] = array("text" => $lng->txt("edit"),
                     "link" => $ilCtrl->getLinkTargetByClass(array($lm_class, "illmpageobjectgui"), "edit"));
                 break;
 
             case "st":
                 $ilCtrl->setParameterByClass(
                     "ilstructureobjectgui",
                     "obj_id",
                     $a_item["node_id"]
                 );
                 $commands[] = array("text" => $lng->txt("edit"),
                     "link" => $ilCtrl->getLinkTargetByClass(array($lm_class, "ilstructureobjectgui"), "view"));
                 break;
         }
         
         return $commands;
     }

◆ getChildIcon()

ilChapterHierarchyFormGUI::getChildIcon ( $a_item )

Get icon path for an item.

Parameters

array itema array

Returns: string icon path

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

References $img, $lm_set, ilPageObject\_isScheduledActivation(), ilPageObject\_lookupActive(), ilPageObject\_lookupContainsDeactivatedElements(), and ilUtil\getImagePath().

     {
         $img = "icon_" . $a_item["type"] . ".svg";
         
         if ($a_item["type"] == "pg") {
             $lm_set = new ilSetting("lm");
             $active = ilLMPage::_lookupActive(
                 $a_item["node_id"],
                 $this->lm_type,
                 $lm_set->get("time_scheduled_page_activation")
             );
                 
             // is page scheduled?
             $img_sc = ($lm_set->get("time_scheduled_page_activation") &&
                 ilLMPage::_isScheduledActivation($a_item["node_id"], $this->lm_type))
                 ? "_sc"
                 : "";
                 
             $img = "icon_pg" . $img_sc . ".svg";
 
             if (!$active) {
                 $img = "icon_pg_d" . $img_sc . ".svg";
             } else {
                 $contains_dis = ilLMPage::_lookupContainsDeactivatedElements(
                     $a_item["node_id"],
                     $this->lm_type
                 );
                 if ($contains_dis) {
                     $img = "icon_pg_del" . $img_sc . ".svg";
                 }
             }
         }
         return ilUtil::getImagePath($img);
     }

Here is the call graph for this function:

◆ getChildIconAlt()

ilChapterHierarchyFormGUI::getChildIconAlt ( $a_item )

Get icon alt text.

Parameters

array itema array

Returns: string icon alt text

Definition at line 296 of file class.ilChapterHierarchyFormGUI.php.

References ilHierarchyFormGUI\$lng, ilPageObject\_lookupActive(), ilPageObject\_lookupContainsDeactivatedElements(), and ilUtil\getImagePath().

     {
         $lng = $this->lng;
         
 
         if ($a_item["type"] == "pg") {
             $active = ilLMPage::_lookupActive($a_item["node_id"], $this->lm_type);
 
             if (!$active) {
                 return $lng->txt("cont_page_deactivated");
             } else {
                 $contains_dis = ilLMPage::_lookupContainsDeactivatedElements(
                     $a_item["node_id"],
                     $this->lm_type
                 );
                 if ($contains_dis) {
                     return $lng->txt("cont_page_deactivated_elements");
                 }
             }
         }
         return ilUtil::getImagePath("icon_" . $a_item["type"] . ".svg");
     }

Here is the call graph for this function:

◆ getChildInfo()

ilChapterHierarchyFormGUI::getChildInfo ( $a_child )

Get child info.

Parameters

array $a_child node array

Returns: string node title

Definition at line 73 of file class.ilChapterHierarchyFormGUI.php.

     {
         if ($this->lang != "-") {
             return $a_child["title"];
         }
         return "";
     }

◆ getChildTitle()

ilChapterHierarchyFormGUI::getChildTitle ( $a_child )

Get child title.

Parameters

Definition at line 58 of file class.ilChapterHierarchyFormGUI.php.

     {
         if ($this->lang != "-") {
             $lmobjtrans = new ilLMObjTranslation($a_child["node_id"], $this->lang);
             return $lmobjtrans->getTitle();
         }
         return $a_child["title"];
     }

◆ getMenuItems()

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

Get menu items.

Definition at line 84 of file class.ilChapterHierarchyFormGUI.php.

References $ilUser, ilHierarchyFormGUI\$lng, $user, and ilHierarchyFormGUI\getMaxDepth().

     {
         $lng = $this->lng;
         $ilUser = $this->user;
         
         $cmds = array();
 
         if ($a_childs == null) {
             $a_childs = [];
         }
         
         if (!$a_first_child) {          // drop area of node
             if ($a_node["type"] == "pg" || ($a_node["type"] == "st" && count($a_childs) == 0 && $this->getMaxDepth() != 0)) {
                 if ($a_node["type"] == "st") {
                     $cmds[] = array("text" => $lng->txt("cont_insert_page"), "cmd" => "insertPage", "multi" => 10,
                         "as_subitem" => true);
                     if (count($this->page_layouts) > 0) {
                         $cmds[] = array("text" => $lng->txt("cont_insert_pagelayout"), "cmd" => "insertTemplate", "multi" => 10,
                             "as_subitem" => true);
                     }
                     if ($ilUser->clipboardHasObjectsOfType("pg")) {
                         $cmds[] = array("text" => $lng->txt("cont_insert_page_from_clip"),
                             "cmd" => "insertPageClip", "as_subitem" => true);
                     }
                 } else {
                     $cmds[] = array("text" => $lng->txt("cont_insert_page"), "cmd" => "insertPage", "multi" => 10);
                     if (count($this->page_layouts) > 0) {
                         $cmds[] = array("text" => $lng->txt("cont_insert_pagelayout"), "cmd" => "insertTemplate", "multi" => 10);
                     }
                     if ($ilUser->clipboardHasObjectsOfType("pg")) {
                         $cmds[] = array("text" => $lng->txt("cont_insert_page_from_clip"),
                             "cmd" => "insertPageClip");
                     }
                 }
             }
             if ($a_node["type"] != "pg" && $this->getMaxDepth() != 0) {
                 $cmds[] = array("text" => $lng->txt("cont_insert_subchapter"),
                     "cmd" => "insertSubchapter", "multi" => 10);
                 if ($ilUser->clipboardHasObjectsOfType("st")) {
                     $cmds[] = array("text" => $lng->txt("cont_insert_subchapter_from_clip"),
                         "cmd" => "insertSubchapterClip");
                 }
             }
             
             if (($a_next_sibling["type"] != "pg" && ($a_depth == 0 || $a_next_sibling["type"] == "st"))
                 || $a_node["type"] == "st") {
                 $cmds[] = array("text" => $lng->txt("cont_insert_chapter"),
                     "cmd" => "insertChapter", "multi" => 10);
                 if ($ilUser->clipboardHasObjectsOfType("st")) {
                     $cmds[] = array("text" => $lng->txt("cont_insert_chapter_from_clip"),
                         "cmd" => "insertChapterClip");
                 }
             }
         } else {                                                // drop area before first child of node
             if ($a_node["type"] == "st" && $this->getMaxDepth() != 0) {
                 $cmds[] = array("text" => $lng->txt("cont_insert_page"),
                     "cmd" => "insertPage", "multi" => 10);
                 if (count($this->page_layouts) > 0) {
                     $cmds[] = array("text" => $lng->txt("cont_insert_pagelayout"), "cmd" => "insertTemplate", "multi" => 10);
                 }
                 if ($ilUser->clipboardHasObjectsOfType("pg")) {
                     $cmds[] = array("text" => $lng->txt("cont_insert_page_from_clip"),
                         "cmd" => "insertPageClip");
                 }
             }
             if ($a_childs[0]["type"] != "pg") {
                 $cmds[] = array("text" => $lng->txt("cont_insert_chapter"),
                     "cmd" => "insertChapter", "multi" => 10);
                 if ($ilUser->clipboardHasObjectsOfType("st")) {
                     $cmds[] = array("text" => $lng->txt("cont_insert_chapter_from_clip"),
                         "cmd" => "insertChapterClip");
                 }
             }
         }
 
         return $cmds;
     }

Here is the call graph for this function:

◆ manageDragAndDrop()

ilChapterHierarchyFormGUI::manageDragAndDrop	(	$a_node,
		$a_depth,
		$a_first_child_drop_area = `false`,
		$a_next_sibling = `null`,
		$a_childs = `null`
	)

Makes nodes drag and drop content and targets.

Parameters

object $a_node node array

Definition at line 178 of file class.ilChapterHierarchyFormGUI.php.

References ilHierarchyFormGUI\$lng, ilHierarchyFormGUI\getMaxDepth(), ilHierarchyFormGUI\makeDragContent(), and ilHierarchyFormGUI\makeDragTarget().

     {
         $lng = $this->lng;
         
         $this->makeDragContent($a_node["node_id"], "grp_" . $a_node["type"]);
 
         if ($a_childs == null) {
             $a_childs = [];
         }
 
         if (!$a_first_child_drop_area) {
             if ($a_node["type"] == "pg" || ($a_node["type"] == "st" && count($a_childs) == 0 && $this->getMaxDepth() != 0)) {
                 if ($a_node["type"] == "st") {
                     $this->makeDragTarget(
                         $a_node["node_id"],
                         "grp_pg",
                         $a_first_child_drop_area,
                         true,
                         ""
                     );
                 } else {
                     $this->makeDragTarget(
                         $a_node["node_id"],
                         "grp_pg",
                         $a_first_child_drop_area,
                         false,
                         ""
                     );
                 }
             }
             
             if ($a_node["type"] != "pg" && $this->getMaxDepth() != 0) {
                 $this->makeDragTarget(
                     $a_node["node_id"],
                     "grp_st",
                     $a_first_child_drop_area,
                     true,
                     $lng->txt("cont_insert_as_subchapter")
                 );
             }
             
             if (($a_next_sibling["type"] != "pg" && ($a_depth == 0 || $a_next_sibling["type"] == "st"))
                 || $a_node["type"] == "st") {
                 $this->makeDragTarget(
                     $a_node["node_id"],
                     "grp_st",
                     $a_first_child_drop_area,
                     false,
                     $lng->txt("cont_insert_as_chapter")
                 );
             }
         } else {
             if ($a_node["type"] == "st" && $this->getMaxDepth() != 0) {
                 $this->makeDragTarget(
                     $a_node["node_id"],
                     "grp_pg",
                     $a_first_child_drop_area,
                     true
                 );
             }
             if ($a_childs[0]["type"] != "pg") {
                 $this->makeDragTarget(
                     $a_node["node_id"],
                     "grp_st",
                     $a_first_child_drop_area,
                     true
                 );
             }
         }
     }

Here is the call graph for this function:

◆ nodeAllowsChilds()

ilChapterHierarchyFormGUI::nodeAllowsChilds ( $a_node )

Which nodes allow child nodes?

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

     {
         if ($a_node["type"] == "pg") {
             return false;
         }
         return true;
     }

Field Documentation

◆ $page_layouts

ilChapterHierarchyFormGUI::$page_layouts

protected

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

◆ $user

ilChapterHierarchyFormGUI::$user

protected

Definition at line 19 of file class.ilChapterHierarchyFormGUI.php.

Referenced by getMenuItems().

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

Modules/LearningModule/classes/class.ilChapterHierarchyFormGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getChildCommands()

◆ getChildIcon()

◆ getChildIconAlt()

◆ getChildInfo()

◆ getChildTitle()

◆ getMenuItems()

◆ manageDragAndDrop()

◆ nodeAllowsChilds()

Field Documentation

◆ $page_layouts

◆ $user