Class ilStudyProgrammeTreeGUI ilObjStudyProgrammeTreeExplorerGUI generates the tree output for StudyProgrammes This class builds the tree with drag & drop functionality and some additional buttons which triggers bootstrap-modals. More...

Inheritance diagram for ilObjStudyProgrammeTreeExplorerGUI:

Collaboration diagram for ilObjStudyProgrammeTreeExplorerGUI:

Public Member Functions
	__construct ($a_tree_root_id, $modal_id, $a_expl_id, $a_parent_obj, $a_parent_cmd)

	getNodeContent ($node)
	Return node element. More...

	getRootNode ()
	Return root node of tree. More...

	getNodeIcon ($a_node)
	Get node icon Return custom icon of OrgUnit type if existing. More...

	getNodeHref ($node)
	Returns node link target. More...

	getChildsOfNode ($a_parent_node_id)
	Get childs of node. More...

	isNodeClickable ($a_node)
	Is node clickable? More...

	getNodeId ($a_node)
	Get id of a node. More...

	listItemStart ($tpl, $a_node)
	List item start. More...

	getHTML ()
	Returns the output of the complete tree There are added some additional javascripts before output the parent::getHTML() More...

	closeCertainNode ($node_id)
	Closes certain node in the tree session The open nodes of a tree are stored in a session. More...

	openCertainNode ($node_id)
	Open certain node in the tree session The open nodes of a tree are stored in a session. More...

	addJsConf ($key, $value)
	Adds configuration to the study-programme-tree jquery plugin. More...

	getJsConf ($key)
	Returns setting of the study-programme-tree. More...

Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor. More...

	setChildLimit ($a_val)
	Set child limit. More...

	getChildLimit ()
	Get child limit. More...

	setSearchTerm ($a_val)
	Set search term. More...

	getSearchTerm ()
	Get search term. More...

	setMainTemplate (ilTemplate $a_main_tpl=null)
	Set main template (that is responsible for adding js/css) More...

	getRootNode ()
	Get root node. More...

	getChildsOfNode ($a_parent_node_id)
	Get childs of node. More...

	getNodeContent ($a_node)
	Get content of a node. More...

	getNodeId ($a_node)
	Get id of a node. More...

	getNodeHref ($a_node)
	Get href for node. More...

	nodeHasVisibleChilds ($a_node)
	Node has childs? More...

	sortChilds ($a_childs, $a_parent_node_id)
	Sort childs. More...

	getNodeIcon ($a_node)
	Get node icon path. More...

	getNodeIconAlt ($a_node)
	Get node icon alt attribute. More...

	getNodeTarget ($a_node)
	Get node target (frame) attribute. More...

	getNodeOnClick ($a_node)
	Get node onclick attribute. More...

	isNodeVisible ($a_node)
	Is node visible? More...

	isNodeHighlighted ($a_node)
	Is node highlighted? More...

	isNodeClickable ($a_node)
	Is node clickable? More...

	getId ()
	Get id of explorer element. More...

	setSkipRootNode ($a_val)
	Set skip root node. More...

	getSkipRootNode ()
	Get skip root node. More...

	setAjax ($a_val)
	Set ajax. More...

	getAjax ()
	Get ajax. More...

	setSecondaryHighlightedNodes ($a_val)
	Set secondary (background) highlighted nodes. More...

	getSecondaryHighlightedNodes ()
	Get secondary (background) highlighted nodes. More...

	setNodeOpen ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour) More...

	setSelectMode ($a_postvar, $a_multi=false)
	Set select mode (to deactivate, pass an empty string as postvar) More...

	setNodeSelected ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour) More...

	setOfflineMode ($a_val)
	Set offline mode. More...

	getOfflineMode ()
	Get offline mode. More...

	handleCommand ()
	Handle explorer internal command. More...

	getContainerId ()
	Get container id. More...

	openNode ()
	Open node. More...

	closeNode ()
	Close node. More...

	getNodeAsync ()
	Get node asynchronously. More...

	beforeRendering ()
	Before rendering. More...

	getOnLoadCode ()
	Get on load code. More...

	getHTML ()
	Get HTML. More...

	renderNode ($a_node, $tpl)
	Render node. More...

	renderChilds ($a_node_id, $tpl)
	Render childs. More...

	getDomNodeIdForNodeId ($a_node_id)
	Get DOM node id for node id. More...

	getNodeIdForDomNodeId ($a_dom_node_id)
	Get node id for dom node id. More...

	listItemStart ($tpl, $a_node)
	List item start. More...

	listItemEnd ($tpl)
	List item end. More...

	listStart ($tpl)
	List start. More...

	listEnd ($tpl)
	List end. More...

	isNodeOnclickEnabled ()

	setNodeOnclickEnabled ($nodeOnclickEnabled)

	isEnableDnd ()

	setEnableDnd ($enable_dnd)
	Enable Drag & Drop functionality. More...

Protected Member Functions
	getNodeTitleClasses ($node_config)
	Returns array with all css classes of the title node element. More...

	parseStudyProgrammeNodeButtons ($node, $node_config, $tpl)
	Generates the buttons for a study-programme node. More...

	parseLeafNodeButtons ($node, $node_config, $tpl)
	Generates the buttons for a study programme leaf. More...

	getNodeTemplateInstance ()
	Factory method for a new instance of a node template. More...

	formatPointValue ($points)
	Returns formatted point value. More...

	getNodeButtonActionLink ($target_class, $cmd, $params, $content, $async=true)
	Generate link-element. More...

	checkAccess ($permission, $ref_id)
	Checks permission of current tree or certain child of it. More...

	checkAccessOrFail ($permission, $ref_id)
	Checks permission of a object and throws an exception if they are not granted. More...

Protected Member Functions inherited from ilExplorerBaseGUI
	isNodeSelectable ($a_node)
	Is node selectable? More...

	getNodeToggleOnClick ($a_node)
	Get onclick attribute for node toggling. More...

	getSelectOnClick ($a_node)
	Get onclick attribute for selecting radio/checkbox. More...

	isNodeOpen ($node_id)
	Get all open nodes. More...

	getJSTreePlugins ()

Protected Attributes
	$js_study_programme_path = "./Modules/StudyProgramme/templates/js/ilStudyProgramme.js"

	$css_study_programme_path = "./Modules/StudyProgramme/templates/css/ilStudyProgrammeTree.css"

	$tree_root_id

	$access

	$lng

	$tpl

	$toolbar

	$ctrl

	$modal_id

	$js_conf

	$class_configuration

	$node_template

Protected Attributes inherited from ilExplorerBaseGUI
	$log

	$ctrl

	$tpl

	$skip_root_node = false

	$ajax = false

	$custom_open_nodes = array()

	$selected_nodes = array()

	$select_postvar = ""

	$offline_mode = false

	$sec_highl_nodes = array()

	$enable_dnd = false

	$search_term = ""

	$child_limit = 0

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()
	Get local path of explorer js. More...

static	getLocalJsTreeJsPath ()
	Get local path of jsTree js. More...

static	getLocalJsTreeCssPath ()
	Get local path of jsTree js. More...

static	createHTMLExportDirs ($a_target_dir)
	Create html export directories. More...

static	init ($a_main_tpl=null)
	Init JS. More...

Static Protected Attributes inherited from ilExplorerBaseGUI
static	$js_tree_path = "./libs/bower/bower_components/jstree/dist/jstree.js"

static	$js_tree_path_css = "./libs/bower/bower_components/jstree/dist/themes/default/style.min.css"

static	$js_expl_path = "./Services/UIComponent/Explorer2/js/Explorer2.js"

Detailed Description

Class ilStudyProgrammeTreeGUI ilObjStudyProgrammeTreeExplorerGUI generates the tree output for StudyProgrammes This class builds the tree with drag & drop functionality and some additional buttons which triggers bootstrap-modals.

Author: Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: 1.0.0

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

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgrammeTreeExplorerGUI::__construct	(	$a_tree_root_id,
		$modal_id,
		$a_expl_id,
		$a_parent_obj,
		$a_parent_cmd
	)

Parameters

$a_expl_id
$a_parent_obj
$a_parent_cmd
$a_tree

Definition at line 87 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

References $DIC, $ilCtrl, $lng, $modal_id, $tpl, checkAccess(), ilExplorerBaseGUI\setAjax(), and ilExplorerBaseGUI\setEnableDnd().

     {
         global $DIC;
         $ilAccess = $DIC['ilAccess'];
         $lng = $DIC['lng'];
         $tpl = $DIC['tpl'];
         $ilToolbar = $DIC['ilToolbar'];
         $ilCtrl = $DIC['ilCtrl'];
 
         parent::__construct($a_expl_id, $a_parent_obj, $a_parent_cmd);
 
         $this->tree_root_id = $a_tree_root_id;
 
         $this->access = $ilAccess;
         $this->lng = $lng;
         $this->tpl = $tpl;
         $this->toolbar = $ilToolbar;
         $this->ctrl = $ilCtrl;
         $this->modal_id = $modal_id;
         $this->js_conf = array();
 
         $lng->loadLanguageModule("prg");
 
         $this->setAjax(true);
 
         if ($this->checkAccess('write', $a_tree_root_id)) {
             $this->setEnableDnd(true);
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ addJsConf()

ilObjStudyProgrammeTreeExplorerGUI::addJsConf	(	$key,
		$value
	)

Adds configuration to the study-programme-tree jquery plugin.

Parameters

array $js_conf

Definition at line 536 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

References $key.

     {
         $this->js_conf[$key] = $value;
     }

◆ checkAccess()

ilObjStudyProgrammeTreeExplorerGUI::checkAccess	(	$permission,
		$ref_id
	)

protected

Checks permission of current tree or certain child of it.

Parameters

string	$permission
null	$ref_id

Returns: bool

Definition at line 508 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

Referenced by __construct(), checkAccessOrFail(), getChildsOfNode(), and getNodeContent().

     {
         $checker = $this->access->checkAccess($permission, '', $ref_id);
 
         return $checker;
     }

Here is the caller graph for this function:

◆ checkAccessOrFail()

ilObjStudyProgrammeTreeExplorerGUI::checkAccessOrFail	(	$permission,
		$ref_id
	)

protected

Checks permission of a object and throws an exception if they are not granted.

Parameters

string	$permission
null	$ref_id

Exceptions

ilException

Definition at line 524 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

References checkAccess().

     {
         if (!$this->checkAccess($permission, $ref_id)) {
             throw new ilException("You have no permission for " . $permission . " Object with ref_id " . $ref_id . "!");
         }
     }

Here is the call graph for this function:

◆ closeCertainNode()

ilObjStudyProgrammeTreeExplorerGUI::closeCertainNode ( $node_id )

Closes certain node in the tree session The open nodes of a tree are stored in a session.

This function closes a certain node by its id.

Parameters

int $node_id

Definition at line 475 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

     {
         if (in_array($node_id, $this->open_nodes)) {
             $k = array_search($node_id, $this->open_nodes);
             unset($this->open_nodes[$k]);
         }
         $this->store->set("on_" . $this->id, serialize($this->open_nodes));
     }

◆ formatPointValue()

ilObjStudyProgrammeTreeExplorerGUI::formatPointValue ( $points )

protected

Returns formatted point value.

Parameters

$points

Returns: string

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

Referenced by getNodeContent().

     {
         return '(' . $points . " " . $this->lng->txt('prg_points') . ')';
     }

Here is the caller graph for this function:

◆ getChildsOfNode()

ilObjStudyProgrammeTreeExplorerGUI::getChildsOfNode ( $a_parent_node_id )

Get childs of node.

Parameters

$a_parent_node_id ilAccess

Definition at line 376 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

References $DIC, checkAccess(), and ilObjectFactoryWrapper\singleton().

     {
         global $DIC;
         $ilAccess = $DIC['ilAccess'];
 
         $parent_obj = ilObjectFactoryWrapper::singleton()->getInstanceByRefId($a_parent_node_id);
 
         $children_with_permission = array();
 
         // its currently only possible to have children on StudyProgrammes
         if ($parent_obj instanceof ilObjStudyProgramme) {
             $children = ($parent_obj->hasChildren())? $parent_obj->getChildren() : $parent_obj->getLPChildren();
 
             if (is_array($children)) {
                 foreach ($children as $node) {
                     if ($this->checkAccess('visible', $node->getRefId())) {
                         $children_with_permission[] = $node;
                     }
                 }
             }
         }
 
         return $children_with_permission;
     }

Here is the call graph for this function:

◆ getHTML()

ilObjStudyProgrammeTreeExplorerGUI::getHTML ( )

Returns the output of the complete tree There are added some additional javascripts before output the parent::getHTML()

Returns: string

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

References ilExplorerBaseGUI\getContainerId().

     {
         $this->tpl->addJavascript($this->js_study_programme_path);
         $this->tpl->addCss($this->css_study_programme_path);
 
         $this->tpl->addOnLoadCode('$("#' . $this->getContainerId() . '").study_programme_tree(' . json_encode($this->js_conf) . ');');
 
         return parent::getHTML();
     }

Here is the call graph for this function:

◆ getJsConf()

ilObjStudyProgrammeTreeExplorerGUI::getJsConf ( $key )

Returns setting of the study-programme-tree.

Parameters

array $js_conf

Definition at line 546 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

References $key.

     {
         return $this->js_conf[$key];
     }

◆ getNodeButtonActionLink()

ilObjStudyProgrammeTreeExplorerGUI::getNodeButtonActionLink	(	$target_class,
		$cmd,
		$params,
		$content,
		$async = `true`
	)

protected

Generate link-element.

Parameters

	$target_class
	$cmd
	$params	url-params send to the
	$content
bool	$async

Returns: string

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

References PHPMailer\PHPMailer\$params, $tpl, and getNodeTemplateInstance().

Referenced by parseLeafNodeButtons(), and parseStudyProgrammeNodeButtons().

     {
         foreach ($params as $param_name => $param_value) {
             $this->ctrl->setParameterByClass($target_class, $param_name, $param_value);
         }
 
         $tpl = $this->getNodeTemplateInstance();
         //$tpl->free();
         $tpl->setCurrentBlock('tree-button-block');
 
         $classes = array($this->class_configuration['node']['node_buttons']);
         $classes[] = 'cmd_' . $cmd;
 
         $tpl->setVariable('LINK_HREF', $this->ctrl->getLinkTargetByClass($target_class, $cmd, '', true, false));
         $tpl->setVariable('LINK_CLASSES', implode(' ', $classes));
 
         if ($async) {
             $tpl->touchBlock('enable-async-link');
             $tpl->setVariable('LINK_DATA_TARGET', '#' . $this->modal_id);
         }
 
         $tpl->setVariable('LINK_CONTENT', $content);
 
         //$tpl->parseCurrentBlock('tree-button-block');
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNodeContent()

ilObjStudyProgrammeTreeExplorerGUI::getNodeContent ( $node )

Return node element.

Parameters

ilObjStudyProgramme | ilObject $node

Returns: string

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

References $_GET, $DIC, $lng, $tpl, checkAccess(), formatPointValue(), getNodeTemplateInstance(), getNodeTitleClasses(), parseLeafNodeButtons(), and parseStudyProgrammeNodeButtons().

     {
         global $DIC;
         $lng = $DIC['lng'];
         $ilAccess = $DIC['ilAccess'];
 
         $current_ref_id = (isset($_GET["ref_id"]))? $_GET["ref_id"] : -1;
 
         $is_current_node = ($node->getRefId() == $current_ref_id);
         $is_study_programme = ($node instanceof ilObjStudyProgramme);
         $is_root_node = ($is_study_programme && $node->getRoot() == null);
 
         // show delete only on not current elements and not root
         $is_delete_enabled = ($is_study_programme && ($is_current_node || $is_root_node))? false : $this->checkAccess("delete", $current_ref_id);
 
         $is_creation_enabled = ($this->checkAccess("create", $current_ref_id));
 
         $node_config = array(
             'current_ref_id' => $current_ref_id,
             'is_current_node' => $is_current_node,
             'is_delete_enabled' => $is_delete_enabled,
             'is_creation_enabled' => $is_creation_enabled,
             'is_study_programme' => $is_study_programme,
             'is_root_node' => $is_root_node
         );
 
         // TODO: find way to remove a-tag around the content, to create valid html
         $tpl = $this->getNodeTemplateInstance();
 
         // add the tree buttons
         if ($this->checkAccess('write', $node->getRefId())) {
             if ($is_study_programme) {
                 $this->parseStudyProgrammeNodeButtons($node, $node_config, $tpl);
             } else {
                 $this->parseLeafNodeButtons($node, $node_config, $tpl);
             }
         }
 
         $tpl->setCurrentBlock('node-content-block');
         $tpl->setVariable('NODE_TITLE_CLASSES', implode(' ', $this->getNodeTitleClasses($node_config)));
         $tpl->setVariable('NODE_TITLE', $node->getTitle());
 
         if ($is_study_programme) {
             $tpl->setVariable('NODE_POINT_CLASSES', $this->class_configuration['node']['node_point']);
             $tpl->setVariable('NODE_POINTS', $this->formatPointValue($node->getPoints()));
         }
 
         $tpl->parseCurrentBlock('node-content-block');
 
         return $tpl->get();
     }

Here is the call graph for this function:

◆ getNodeHref()

ilObjStudyProgrammeTreeExplorerGUI::getNodeHref ( $node )

Returns node link target.

Parameters

mixed $node

Returns: string

Definition at line 353 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

References $DIC, and $ilCtrl.

     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
 
         if ($ilCtrl->getCmd() == "performPaste") {
             $ilCtrl->setParameterByClass("ilObjStudyProgrammeGUI", "target_node", $node->getRefId());
         }
 
         $ilCtrl->setParameterByClass("ilObjStudyProgrammeGUI", "ref_id", $node->getRefId());
 
         return '#';
     }

◆ getNodeIcon()

ilObjStudyProgrammeTreeExplorerGUI::getNodeIcon ( $a_node )

Get node icon Return custom icon of OrgUnit type if existing.

Parameters

array $a_node

Returns: string

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

References $DIC, and ilObject\_lookupObjId().

     {
         global $DIC;
         $ilias = $DIC['ilias'];
 
         $obj_id = ilObject::_lookupObjId($a_node->getRefId());
         if ($ilias->getSetting('custom_icons')) {
             //TODO: implement custom icon functionality
         }
 
         return ilObject::_getIcon($obj_id, "tiny");
     }

Here is the call graph for this function:

◆ getNodeId()

ilObjStudyProgrammeTreeExplorerGUI::getNodeId ( $a_node )

Get id of a node.

Parameters

mixed $a_node node array or object

Returns: string id of node

Definition at line 422 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

Referenced by listItemStart().

     {
         if (!is_null($a_node)) {
             return $a_node->getRefId();
         }
         return null;
     }

Here is the caller graph for this function:

◆ getNodeTemplateInstance()

ilObjStudyProgrammeTreeExplorerGUI::getNodeTemplateInstance ( )

protected

Factory method for a new instance of a node template.

Returns: ilTemplate

Definition at line 254 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

Referenced by getNodeButtonActionLink(), and getNodeContent().

     {
         return new ilTemplate("tpl.tree_node_content.html", true, true, "Modules/StudyProgramme");
     }

Here is the caller graph for this function:

◆ getNodeTitleClasses()

ilObjStudyProgrammeTreeExplorerGUI::getNodeTitleClasses ( $node_config )

protected

Returns array with all css classes of the title node element.

Parameters

array $node_config

Returns: array

Definition at line 184 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

Referenced by getNodeContent().

     {
         $node_title_classes = array($this->class_configuration['node']['node_title']);
         if ($node_config['is_study_programme']) {
             if ($node_config['is_current_node']) {
                 array_push($node_title_classes, $this->class_configuration['node']['node_current']);
             }
         } else {
             array_push($node_title_classes, $this->class_configuration['lp_object']);
         }
 
         return $node_title_classes;
     }

Here is the caller graph for this function:

◆ getRootNode()

ilObjStudyProgrammeTreeExplorerGUI::getRootNode ( )

Return root node of tree.

Returns: mixed

Definition at line 315 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

References ilObjStudyProgramme\getInstanceByRefId().

     {
         $node = ilObjStudyProgramme::getInstanceByRefId($this->tree_root_id);
         if ($node->getRoot() != null) {
             return $node->getRoot();
         }
         return $node;
     }

Here is the call graph for this function:

◆ isNodeClickable()

ilObjStudyProgrammeTreeExplorerGUI::isNodeClickable ( $a_node )

Is node clickable?

Parameters

mixed $a_node node object/array

ilAccessHandler $ilAccess

Returns: boolean node clickable true/false

Definition at line 409 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

     {
         return true;
     }

◆ listItemStart()

ilObjStudyProgrammeTreeExplorerGUI::listItemStart	(	$tpl,
		$a_node
	)

List item start.

Parameters

Definition at line 436 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

References $tpl, ilExplorerBaseGUI\getAjax(), ilExplorerBaseGUI\getDomNodeIdForNodeId(), getNodeId(), and ilExplorerBaseGUI\nodeHasVisibleChilds().

     {
         $tpl->setCurrentBlock("list_item_start");
 
         if ($this->getAjax() && $this->nodeHasVisibleChilds($a_node) || ($a_node instanceof ilStudyProgramme && $a_node->getParent() === null)) {
             $tpl->touchBlock("li_closed");
         }
         $tpl->setVariable(
             "DOM_NODE_ID",
             $this->getDomNodeIdForNodeId($this->getNodeId($a_node))
         );
         $tpl->parseCurrentBlock();
         $tpl->touchBlock("tag");
     }

Here is the call graph for this function:

◆ openCertainNode()

ilObjStudyProgrammeTreeExplorerGUI::openCertainNode ( $node_id )

Open certain node in the tree session The open nodes of a tree are stored in a session.

This function opens a certain node by its id.

Parameters

int $node_id

Definition at line 490 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

References $id, and ilExplorerBaseGUI\getNodeIdForDomNodeId().

     {
         $id = $this->getNodeIdForDomNodeId($node_id);
         if (!in_array($id, $this->open_nodes)) {
             $this->open_nodes[] = $id;
         }
         $this->store->set("on_" . $this->id, serialize($this->open_nodes));
     }

Here is the call graph for this function:

◆ parseLeafNodeButtons()

ilObjStudyProgrammeTreeExplorerGUI::parseLeafNodeButtons	(	$node,
		$node_config,
		$tpl
	)

protected

Generates the buttons for a study programme leaf.

Parameters

ilObject	$node	parsed node
array	$node_config	configuration of current node
ilTemplate	$tpl	current node template

Definition at line 236 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

References $tpl, ilGlyphGUI\get(), getNodeButtonActionLink(), and ilGlyphGUI\REMOVE.

Referenced by getNodeContent().

     {
         $tpl->setCurrentBlock('enable-tree-buttons');
 
         // only show delete button when its not the current node
         if ($node_config['is_delete_enabled']) {
             $delete_button = $this->getNodeButtonActionLink('ilObjStudyProgrammeTreeGUI', 'delete', array('ref_id' => $node->getRefId(), 'item_ref_id' => $node_config['current_ref_id']), ilGlyphGUI::get(ilGlyphGUI::REMOVE));
             $tpl->setVariable('NODE_DELETE_BUTTON', $delete_button);
         }
 
         $tpl->parseCurrentBlock('enable-tree-buttons');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseStudyProgrammeNodeButtons()

ilObjStudyProgrammeTreeExplorerGUI::parseStudyProgrammeNodeButtons	(	$node,
		$node_config,
		$tpl
	)

protected

Generates the buttons for a study-programme node.

Parameters

ilObjStudyProgramme	$node	parsed node
array	$node_config	configuration of current node
ilTemplate	$tpl	current node template

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

References $tpl, ilGlyphGUI\ADD, ilGlyphGUI\get(), getNodeButtonActionLink(), ilGlyphGUI\INFO, and ilGlyphGUI\REMOVE.

Referenced by getNodeContent().

     {
         $tpl->setCurrentBlock('enable-tree-buttons');
 
         // show info button only when it not the current node
         $info_button = $this->getNodeButtonActionLink('ilObjStudyProgrammeSettingsGUI', 'view', array('ref_id' => $node->getRefId(), 'currentNode' => $node_config['is_current_node']), ilGlyphGUI::get(ilGlyphGUI::INFO));
         $tpl->setVariable('NODE_INFO_BUTTON', $info_button);
 
         // only show add button when create permission is set
         if ($node_config['is_creation_enabled']) {
             $create_button = $this->getNodeButtonActionLink('ilObjStudyProgrammeTreeGUI', 'create', array('ref_id' => $node->getRefId()), ilGlyphGUI::get(ilGlyphGUI::ADD));
             $tpl->setVariable('NODE_CREATE_BUTTON', $create_button);
         }
 
         // only show delete button when its not the current node, not the root-node and delete permissions are set
         if ($node_config['is_delete_enabled']) {
             $delete_button = $this->getNodeButtonActionLink('ilObjStudyProgrammeTreeGUI', 'delete', array('ref_id' => $node->getRefId(), 'item_ref_id' => $node_config['current_ref_id']), ilGlyphGUI::get(ilGlyphGUI::REMOVE));
             $tpl->setVariable('NODE_DELETE_BUTTON', $delete_button);
         }
 
         $tpl->parseCurrentBlock('enable-tree-buttons');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $access

ilObjStudyProgrammeTreeExplorerGUI::$access

protected

Definition at line 34 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

◆ $class_configuration

ilObjStudyProgrammeTreeExplorerGUI::$class_configuration

protected

Initial value:

= array(
        'node' => array(
            'node_title' => 'title',
            'node_point' => 'points',
            'node_current' => 'ilHighlighted current_node',
            'node_buttons' => 'tree_button'
        ),
        'lp_object' => 'lp-object',
    )