ilObjStudyProgrammeTreeExplorerGUI Class Reference

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

Inheritance diagram for ilObjStudyProgrammeTreeExplorerGUI:

Collaboration diagram for ilObjStudyProgrammeTreeExplorerGUI:

Public Member Functions
	__construct (int $tree_root_id, string $modal_id, string $expl_id, $parent_obj, string $parent_cmd)
	getNodeContent ($a_node)
	Return node element. More...
	getRootNode ()
	Return root node of tree. More...
	getNodeIcon ($node)
	Get node icon path. More...
	getNodeHref ($node)
	Get href for node. More...
	getChildsOfNode ($a_parent_node_id)
	Get children of node. More...
	getNodeId ($a_node)
	Get id of a node. More...
	listItemStart (ilTemplate $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 (string $key, string $value)
	Adds configuration to the study-programme-tree jquery plugin. More...
	getJsConf (string $key)
	Returns setting of the study-programme-tree. More...
Public Member Functions inherited from ilExplorerBaseGUI
	setChildLimit (int $a_val)
	getChildLimit ()
	setSearchTerm (string $a_val)
	getSearchTerm ()
	setMainTemplate (ilGlobalTemplateInterface $a_main_tpl=null)
	getRootNode ()
	Get root node. More...
	getChildsOfNode ($a_parent_node_id)
	Get children 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 children Please note that this standard method may not be optimal depending on what a derived class does in isNodeVisible. More...
	sortChilds (array $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 (bool $a_val)
	getSkipRootNode ()
	setAjax (bool $a_val)
	getAjax ()
	setSecondaryHighlightedNodes (array $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 (string $a_postvar, bool $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 (bool $a_val)
	getOfflineMode ()
	handleCommand ()
	Handle explorer internal command. More...
	getContainerId ()
	openNode ()
	Open node. More...
	closeNode ()
	Close node. More...
	getNodeAsync ()
	Get node asynchronously. More...
	beforeRendering ()
	Before rendering. More...
	getOnLoadCode ()
	Get on load code. More...
	getHTML ()
	renderNode ($a_node, ilTemplate $tpl)
	Render node. More...
	renderChilds ($a_node_id, ilTemplate $tpl)
	Render childs. More...
	getDomNodeIdForNodeId ($a_node_id)
	Get DOM node id for node id. More...
	getNodeIdForDomNodeId (string $a_dom_node_id)
	Get node id for dom node id. More...
	listItemStart (ilTemplate $tpl, $a_node)
	List item start. More...
	listItemEnd (ilTemplate $tpl)
	listStart (ilTemplate $tpl)
	listEnd (ilTemplate $tpl)
	isNodeOnclickEnabled ()
	setNodeOnclickEnabled (bool $nodeOnclickEnabled)
	isEnableDnd ()
	setEnableDnd (bool $enable_dnd)

Protected Member Functions
	getNodeTitleClasses (array $node_config)
	Returns array with all css classes of the title node element. More...
	parseStudyProgrammeNodeButtons (ilObjStudyProgramme $node, array $node_config, ilTemplate $tpl)
	Generates the buttons for a study-programme node. More...
	parseLeafNodeButtons (ilObject $node, array $node_config, ilTemplate $tpl)
	Generates the buttons for a study programme leaf. More...
	getNodeTemplateInstance ()
	Factory method for a new instance of a node template. More...
	formatPointValue (int $points)
	Returns formatted point value. More...
	getNodeButtonActionLink (string $target_class, string $cmd, array $params, string $content, bool $async=true)
	Generate link-element. More...
	checkAccess (string $permission, int $ref_id)
	Checks permission of current tree or certain child of it. More...
	checkAccessOrFail (string $permission, int $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 ()
	isNodeRequested (string $a_node_id)

Protected Attributes
ilAccessHandler	$access
ilLanguage	$lng
ilToolbarGUI	$toolbar
ILIAS HTTP Wrapper RequestWrapper	$request_wrapper
ILIAS Refinery Factory	$refinery
int	$tree_root_id
string	$modal_id
array	$js_conf
array	$class_configuration
	default classes of the tree [key=>class_name] More...
string	$js_study_programme_path = "./Modules/StudyProgramme/templates/js/ilStudyProgramme.js"
string	$css_study_programme_path = "./Modules/StudyProgramme/templates/css/ilStudyProgrammeTree.css"
Protected Attributes inherited from ilExplorerBaseGUI
string	$node_parameter_name
ilLogger	$log
ilCtrl	$ctrl
ilGlobalTemplateInterface	$tpl
bool	$skip_root_node = false
bool	$ajax = false
array	$custom_open_nodes = array()
array	$selected_nodes = array()
string	$select_postvar = ""
bool	$offline_mode = false
array	$sec_highl_nodes = array()
bool	$enable_dnd = false
string	$search_term = ""
array	$open_nodes = []
ilSessionIStorage	$store
bool	$select_multi = false
	$parent_obj
int	$child_limit = 0
string	$parent_cmd = ''
string	$requested_exp_cmd = ""
string	$requested_exp_cont = ""
string	$requested_searchterm = ""
string	$requested_node_id = ""
string	$id

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()
static	getLocalJsTreeJsPath ()
static	getLocalJsTreeCssPath ()
static	createHTMLExportDirs (string $a_target_dir)
static	init (ilGlobalTemplateInterface $a_main_tpl=null)
Static Protected Attributes inherited from ilExplorerBaseGUI
static string	$js_tree_path = "./node_modules/jstree/dist/jstree.js"
static string	$js_tree_path_css = "./node_modules/jstree/dist/themes/default/style.min.css"
static string	$js_expl_path = "./Services/UIComponent/Explorer2/js/Explorer2.js"

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 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 29 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjStudyProgrammeTreeExplorerGUI::__construct	(	int	$tree_root_id,
		string	$modal_id,
		string	$expl_id,
			$parent_obj,
		string	$parent_cmd
	)

Parameters

$parent_obj

string|object|array

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

    {
        parent::__construct($expl_id, $parent_obj, $parent_cmd);
 
        global $DIC;
        $this->access = $DIC['ilAccess'];
        $this->lng = $DIC['lng'];
        $this->tpl = $DIC['tpl'];
        $this->toolbar = $DIC['ilToolbar'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->request_wrapper = $DIC->http()->wrapper()->query();
        $this->refinery = $DIC->refinery();
 
        $this->tree_root_id = $tree_root_id;
        $this->modal_id = $modal_id;
 
        $this->js_conf = array();
 
        $this->lng->loadLanguageModule("prg");
 
        $this->setAjax(true);
 
        if ($this->checkAccess('write', $tree_root_id)) {
            $this->setEnableDnd(true);
        }
    }

References $DIC, $modal_id, ilExplorerBaseGUI\$parent_cmd, ilExplorerBaseGUI\$parent_obj, $tree_root_id, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), checkAccess(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilExplorerBaseGUI\setAjax(), ilExplorerBaseGUI\setEnableDnd(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

addJsConf()

ilObjStudyProgrammeTreeExplorerGUI::addJsConf	(	string	$key,
		string	$value
	)

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

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

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

References ILIAS\LTI\ToolProvider\$key.

checkAccess()

ilObjStudyProgrammeTreeExplorerGUI::checkAccess ( string  $permission, int  $ref_id  )

protected

Checks permission of current tree or certain child of it.

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

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

References $ref_id, and ILIAS\Repository\access().

Referenced by __construct(), and getNodeContent().

Here is the call graph for this function:

Here is the caller graph for this function:

checkAccessOrFail()

ilObjStudyProgrammeTreeExplorerGUI::checkAccessOrFail ( string  $permission, int  $ref_id  )

protected

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

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

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

References $ref_id.

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

mixed

$node_id

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

                                              : void
    {
        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 ( int  $points )

protected

Returns formatted point value.

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

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

References ILIAS\Repository\lng().

Referenced by getNodeContent().

Here is the call graph for this function:

Here is the caller graph for this function:

getChildsOfNode()

ilObjStudyProgrammeTreeExplorerGUI::getChildsOfNode

(

$a_parent_node_id

)

Get children of node.

Parameters

string

$a_parent_node_id

Returns

array

Reimplemented from ilExplorerBaseGUI.

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

                                                      : array
    {
        $parent_obj = ilObjectFactoryWrapper::singleton()->getInstanceByRefId((int) $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;
    }

References ilObjectFactoryWrapper\singleton().

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

Reimplemented from ilExplorerBaseGUI.

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

                             : string
    {
        $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,
                JSON_THROW_ON_ERROR
            ) . ');'
        );
 
        return parent::getHTML();
    }

getJsConf()

ilObjStudyProgrammeTreeExplorerGUI::getJsConf

(

string

$key

)

Returns setting of the study-programme-tree.

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

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

References ILIAS\LTI\ToolProvider\$key.

getNodeButtonActionLink()

ilObjStudyProgrammeTreeExplorerGUI::getNodeButtonActionLink ( string  $target_class, string  $cmd, array  $params, string  $content, bool  $async = true  )

protected

Generate link-element.

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

     : string {
        foreach ($params as $param_name => $param_value) {
            $this->ctrl->setParameterByClass($target_class, $param_name, $param_value);
        }
 
        $tpl = $this->getNodeTemplateInstance();
        $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);
 
        return $tpl->get();
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

getNodeContent()

ilObjStudyProgrammeTreeExplorerGUI::getNodeContent

(

$a_node

)

Return node element.

Parameters

ilObjStudyProgramme | ilObject

$a_node

Returns

string

Reimplemented from ilExplorerBaseGUI.

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

                                           : string
    {
        $current_ref_id = -1;
        if ($this->request_wrapper->has("ref_id")) {
            $current_ref_id = $this->request_wrapper->retrieve("ref_id", $this->refinery->kindlyTo()->int());
        }
 
        $is_current_node = ($a_node->getRefId() == $current_ref_id);
        $is_study_programme = ($a_node instanceof ilObjStudyProgramme);
        $is_root_node = ($is_study_programme && $a_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', $a_node->getRefId())) {
            if ($is_study_programme) {
                $this->parseStudyProgrammeNodeButtons($a_node, $node_config, $tpl);
            } else {
                $this->parseLeafNodeButtons($a_node, $node_config, $tpl);
            }
        }
 
        $tpl->setCurrentBlock('node-content-block');
        $tpl->setVariable('NODE_TITLE_CLASSES', implode(' ', $this->getNodeTitleClasses($node_config)));
        $tpl->setVariable('NODE_TITLE', $a_node->getTitle());
 
        if ($is_study_programme) {
            $tpl->setVariable('NODE_POINT_CLASSES', $this->class_configuration['node']['node_point']);
            $tpl->setVariable('NODE_POINTS', $this->formatPointValue($a_node->getPoints()));
        }
 
        $tpl->parseCurrentBlock('node-content-block');
 
        return $tpl->get();
    }

References ilExplorerBaseGUI\$tpl, checkAccess(), formatPointValue(), ilGlobalTemplateInterface\get(), getNodeTemplateInstance(), getNodeTitleClasses(), ilGlobalTemplateInterface\parseCurrentBlock(), parseLeafNodeButtons(), parseStudyProgrammeNodeButtons(), ILIAS\Repository\refinery(), ilGlobalTemplateInterface\setCurrentBlock(), and ilGlobalTemplateInterface\setVariable().

Here is the call graph for this function:

getNodeHref()

ilObjStudyProgrammeTreeExplorerGUI::getNodeHref

(

$a_node

)

Get href for node.

Parameters

object | array

$a_node

Returns

string href attribute

Reimplemented from ilExplorerBaseGUI.

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

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

References $DIC, and ilObject\getRefId().

Here is the call graph for this function:

getNodeIcon()

ilObjStudyProgrammeTreeExplorerGUI::getNodeIcon

(

$a_node

)

Get node icon path.

Parameters

object | array

$a_node

Returns

string image file path

Reimplemented from ilExplorerBaseGUI.

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

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

References $DIC, ilObject\_getIcon(), ilObject\_lookupObjId(), and ilObject\getRefId().

Here is the call graph for this function:

getNodeId()

ilObjStudyProgrammeTreeExplorerGUI::getNodeId

(

$a_node

)

Get id of a node.

Parameters

object | array

$a_node

node array or object

Returns

string id of node

Reimplemented from ilExplorerBaseGUI.

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

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

getNodeTemplateInstance()

ilObjStudyProgrammeTreeExplorerGUI::getNodeTemplateInstance ( )

protected

Factory method for a new instance of a node template.

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

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

Referenced by getNodeContent().

Here is the caller graph for this function:

getNodeTitleClasses()

ilObjStudyProgrammeTreeExplorerGUI::getNodeTitleClasses ( array  $node_config )

protected

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

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

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

Referenced by getNodeContent().

Here is the caller graph for this function:

getRootNode()

ilObjStudyProgrammeTreeExplorerGUI::getRootNode

(

)

Return root node of tree.

Reimplemented from ilExplorerBaseGUI.

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

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

References ilObjStudyProgramme\getInstanceByRefId().

Here is the call graph for this function:

listItemStart()

ilObjStudyProgrammeTreeExplorerGUI::listItemStart	(	ilTemplate	$tpl,
			$a_node
	)

List item start.

Parameters

object | array

$a_node

Reimplemented from ilExplorerBaseGUI.

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

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

References $tpl, and ilObjStudyProgramme\getParent().

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

mixed

$node_id

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

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

References $id.

parseLeafNodeButtons()

ilObjStudyProgrammeTreeExplorerGUI::parseLeafNodeButtons ( ilObject  $node, array  $node_config, ilTemplate  $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 225 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

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

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

Referenced by getNodeContent().

Here is the call graph for this function:

Here is the caller graph for this function:

parseStudyProgrammeNodeButtons()

ilObjStudyProgrammeTreeExplorerGUI::parseStudyProgrammeNodeButtons ( ilObjStudyProgramme  $node, array  $node_config, ilTemplate  $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 177 of file class.ilObjStudyProgrammeTreeExplorerGUI.php.

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

Referenced by getNodeContent().

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilObjStudyProgrammeTreeExplorerGUI::$access

protected

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

$class_configuration

array ilObjStudyProgrammeTreeExplorerGUI::$class_configuration

protected

Initial value:

= [
        'node' => [
            'node_title' => 'title',
            'node_point' => 'points',
            'node_current' => 'ilHighlighted current_node',
            'node_buttons' => 'tree_button'
        ],
        'lp_object' => 'lp-object',
    ]

default classes of the tree [key=>class_name]

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

$css_study_programme_path

string ilObjStudyProgrammeTreeExplorerGUI::$css_study_programme_path = "./Modules/StudyProgramme/templates/css/ilStudyProgrammeTree.css"

protected

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

$js_conf

array ilObjStudyProgrammeTreeExplorerGUI::$js_conf

protected

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

$js_study_programme_path

string ilObjStudyProgrammeTreeExplorerGUI::$js_study_programme_path = "./Modules/StudyProgramme/templates/js/ilStudyProgramme.js"

protected

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

$lng

ilLanguage ilObjStudyProgrammeTreeExplorerGUI::$lng

protected

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

$modal_id

string ilObjStudyProgrammeTreeExplorerGUI::$modal_id

protected

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

Referenced by __construct().

$refinery

ILIAS Refinery Factory ilObjStudyProgrammeTreeExplorerGUI::$refinery

protected

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

$request_wrapper

ILIAS HTTP Wrapper RequestWrapper ilObjStudyProgrammeTreeExplorerGUI::$request_wrapper

protected

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

$toolbar

ilToolbarGUI ilObjStudyProgrammeTreeExplorerGUI::$toolbar

protected

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

$tree_root_id

int ilObjStudyProgrammeTreeExplorerGUI::$tree_root_id

protected

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

Referenced by __construct().

---

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

• Modules/StudyProgramme/classes/class.ilObjStudyProgrammeTreeExplorerGUI.php