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

Inheritance diagram for ilChapterHierarchyFormGUI:

Collaboration diagram for ilChapterHierarchyFormGUI:

Public Member Functions
	__construct (string $a_lm_type, string $a_lang="-")

	getChildTitle (array $a_child)

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

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

	nodeAllowsChilds (array $a_node)
	Which nodes allow child nodes? 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...

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

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

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

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

Protected Attributes
ilObjUser	$user

array	$page_layouts

string	$lang

string	$lm_type

Protected Attributes inherited from ilHierarchyFormGUI
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

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

Protected Member Functions inherited from ilHierarchyFormGUI
	str ($key)

Static Protected Member Functions inherited from ilHierarchyFormGUI
static	_str ($key)

Detailed Description

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

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 25 of file class.ilChapterHierarchyFormGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilPageLayout\activeLayouts(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilPageLayout\MODULE_LM, ilHierarchyFormGUI\setCheckboxName(), and ILIAS\Repository\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(
             ilPageLayout::MODULE_LM
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ getChildCommands()

ilChapterHierarchyFormGUI::getChildCommands ( array $a_item )

Get item commands.

Parameters

array $a_item

Returns: array

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

References ilHierarchyFormGUI\$commands, ilHierarchyFormGUI\$ctrl, ilHierarchyFormGUI\$lng, and ilLanguage\txt().

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

Here is the call graph for this function:

◆ getChildIcon()

ilChapterHierarchyFormGUI::getChildIcon ( array $a_item )

Get icon path for an item.

Parameters

array $a_item itema array

Returns: string icon path

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

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

                                                : string
     {
         $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,
                 (bool) $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 ( array $a_item )

Get icon alt text.

Parameters

array $a_item itema array

Returns: string icon alt text

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

References ilHierarchyFormGUI\$lng, ilPageObject\_lookupActive(), ilPageObject\_lookupContainsDeactivatedElements(), and ilLanguage\txt().

                                                   : string
     {
         $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 $lng->txt("pg");
         }
         return $lng->txt("st");
         ;
     }

Here is the call graph for this function:

◆ getChildInfo()

ilChapterHierarchyFormGUI::getChildInfo ( array $a_child )

Get child info.

Parameters

array $a_child node array

Returns: string node title

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

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

◆ getChildTitle()

ilChapterHierarchyFormGUI::getChildTitle ( array $a_child )

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

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

◆ getMenuItems()

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

Get menu items.

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

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

                                                                                                                                                   : array
     {
         $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"), "multi" => 0,
                             "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"), "multi" => 0,
                             "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"), "multi" => 0,
                         "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", "multi" => 0
                     );
                 }
             }
         } 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"),"multi" => 0,
                         "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"),"multi" => 0,
                         "cmd" => "insertChapterClip");
                 }
             }
         }
 
         return $cmds;
     }

Here is the call graph for this function:

◆ manageDragAndDrop()

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

Parameters

array $a_node node array

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

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

                                                                                                                                                        : void
     {
         $lng = $this->lng;
 
         $this->makeDragContent($a_node["node_id"], "grp_" . $a_node["type"]);
 
         if ($a_childs == null) {
             $a_childs = [];
         }
 
         if (!$a_first_child) {
             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,
                         true,
                         ""
                     );
                 } else {
                     $this->makeDragTarget(
                         $a_node["node_id"],
                         "grp_pg",
                         $a_first_child,
                         false,
                         ""
                     );
                 }
             }
 
             if ($a_node["type"] != "pg" && $this->getMaxDepth() != 0) {
                 $this->makeDragTarget(
                     $a_node["node_id"],
                     "grp_st",
                     $a_first_child,
                     true,
                     $lng->txt("cont_insert_as_subchapter")
                 );
             }
 
             if ($a_next_sibling) {
                 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,
                         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,
                     true
                 );
             }
             if (($a_childs[0]["type"] ?? "") != "pg") {
                 $this->makeDragTarget(
                     $a_node["node_id"],
                     "grp_st",
                     $a_first_child,
                     true
                 );
             }
         }
     }

Here is the call graph for this function:

◆ nodeAllowsChilds()

ilChapterHierarchyFormGUI::nodeAllowsChilds ( array $a_node )

Which nodes allow child nodes?

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

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

Field Documentation

◆ $lang

string ilChapterHierarchyFormGUI::$lang

protected

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

◆ $lm_type

string ilChapterHierarchyFormGUI::$lm_type

protected

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

◆ $page_layouts

array ilChapterHierarchyFormGUI::$page_layouts

protected

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

◆ $user

ilObjUser ilChapterHierarchyFormGUI::$user

protected

Definition at line 27 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

◆ $lang

◆ $lm_type

◆ $page_layouts

◆ $user