Tree-GUI for ToC. More...

Inheritance diagram for ilLSTOCGUI:

Collaboration diagram for ilLSTOCGUI:

Public Member Functions

__construct (LSUrlBuilder $url_builder, ilCtrl $il_ctrl)

withStructure (string $json_structure)

getRootNode ()

Get root node.Please note that the class does not make any requirements how nodes are represented (array or object)

Returns: mixed root node object/array

More...

getChildsOfNode ($a_parent_node_id)

Get childs of node.

Parameters

string $a_parent_id parent node id

Returns: array childs

More...

getNodeContent ($a_node)

Get content of a node.

Parameters

mixed $a_node node array or object

Returns: string content of the node

More...

getNodeIcon ($a_node)

Get node icon path.

Parameters

mixed $a_node node object/array

Returns: string image file path

More...

getNodeId ($a_node)

Get id of a node.

Parameters

mixed $a_node node array or object

Returns: string id of node

More...

getNodeHref ($a_node)

Get href for node.

Parameters

mixed $a_node node object/array

Returns: string href attribute

More...

isNodeClickable ($a_node)

Is node clickable?

Parameters

mixed $a_node node object/array

Returns: boolean node clickable true/false

More...

isNodeHighlighted ($a_node)

Is node highlighted?

Parameters

mixed $a_node node object/array

Returns: boolean node highlighted true/false

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 ($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...

Data Fields
const	NODE_ICONS

Protected Member Functions
	addIds (array $node)

	buildLookup (array $node)

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
	$id = 'ls_toc'

	$structure

	$nodes = []

	$url_builder

	$node_icons

	$counter = 0

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 = ""

	$open_nodes = []

	$store

	$parent_obj

	$child_limit = 0

	$parent_cmd = ''

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 = "./node_modules/jstree/dist/jstree.js"

static	$js_tree_path_css = "./node_modules/jstree/dist/themes/default/style.min.css"

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

Detailed Description

Tree-GUI for ToC.

Author: Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

Definition at line 13 of file class.ilLSTOCGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilLSTOCGUI::__construct	(	LSUrlBuilder	$url_builder,
		ilCtrl	$il_ctrl
	)

Definition at line 43 of file class.ilLSTOCGUI.php.

      {
        parent::__construct("lsq_toc", null, "");
        $this->url_builder = $url_builder;
        $this->ctrl = $il_ctrl; //ilExplorerBaseGUI needs ctrl...
        $this->setSkipRootNode(false);
        $this->setNodeOnclickEnabled(true);
 
        //get the image paths to the node icons
        $lp_icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_SHORT);
        $this->node_icons[TOCBuilder::LP_NOT_STARTED] = $lp_icons->getImagePathNotAttempted();
        $this->node_icons[TOCBuilder::LP_COMPLETED] = $lp_icons->getImagePathCompleted();
        $this->node_icons[TOCBuilder::LP_IN_PROGRESS] = $lp_icons->getImagePathInProgress();
        $this->node_icons[TOCBuilder::LP_FAILED] = $lp_icons->getImagePathFailed();
    }

References $url_builder, ILIAS\GlobalScreen\Provider\__construct(), ilLPStatusIcons\getInstance(), ilLPStatusIcons\ICON_VARIANT_SHORT, ilExplorerBaseGUI\setNodeOnclickEnabled(), and ilExplorerBaseGUI\setSkipRootNode().

Here is the call graph for this function:

Member Function Documentation

◆ addIds()

ilLSTOCGUI::addIds ( array $node )

protected

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

                                           : array
    {
        $node['_id'] = $this->counter;
        $this->counter++;
        if (array_key_exists('childs', $node)) {
            foreach ($node['childs'] as $idx => $child) {
                $node['childs'][$idx] = $this->addIds($child);
            }
        }
        return $node;
    }

References $counter, and addIds().

Referenced by addIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildLookup()

ilLSTOCGUI::buildLookup ( array $node )

protected

Definition at line 85 of file class.ilLSTOCGUI.php.

    {
        $this->nodes[$node['_id']] = $node;
        if (array_key_exists('childs', $node)) {
            foreach ($node['childs'] as $child) {
                $this->buildLookup($child);
            }
        }
    }

References buildLookup().

Referenced by buildLookup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildsOfNode()

ilLSTOCGUI::getChildsOfNode ( $a_parent_node_id )

Get childs of node.

Parameters

string $a_parent_id parent node id

Returns: array childs

Reimplemented from ilExplorerBaseGUI.

Definition at line 106 of file class.ilLSTOCGUI.php.

    {
        $parent_node = $this->nodes[$a_parent_node_id];
        return (array) $parent_node['childs'];
    }

◆ getNodeContent()

ilLSTOCGUI::getNodeContent ( $a_node )

Get content of a node.

Parameters

mixed $a_node node array or object

Returns: string content of the node

Reimplemented from ilExplorerBaseGUI.

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

    {
        return $a_node['label'];
    }

◆ getNodeHref()

ilLSTOCGUI::getNodeHref ( $a_node )

Get href for node.

Parameters

mixed $a_node node object/array

Returns: string href attribute

Reimplemented from ilExplorerBaseGUI.

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

    {
        return $this->url_builder->getHref($a_node['command'], $a_node['parameter']);
    }

◆ getNodeIcon()

ilLSTOCGUI::getNodeIcon ( $a_node )

Get node icon path.

Parameters

mixed $a_node node object/array

Returns: string image file path

Reimplemented from ilExplorerBaseGUI.

Definition at line 123 of file class.ilLSTOCGUI.php.

    {
        $state = $a_node['state'] ?? TOCBuilder::LP_NOT_STARTED;
        return $this->node_icons[$state];
    }

◆ getNodeId()

ilLSTOCGUI::getNodeId ( $a_node )

Get id of a node.

Parameters

mixed $a_node node array or object

Returns: string id of node

Reimplemented from ilExplorerBaseGUI.

Definition at line 132 of file class.ilLSTOCGUI.php.

    {
        return $a_node['_id'];
    }

◆ getRootNode()

ilLSTOCGUI::getRootNode ( )

Get root node.Please note that the class does not make any requirements how nodes are represented (array or object)

Returns: mixed root node object/array

Reimplemented from ilExplorerBaseGUI.

Definition at line 98 of file class.ilLSTOCGUI.php.

    {
        return reset($this->nodes);
    }

◆ isNodeClickable()

ilLSTOCGUI::isNodeClickable ( $a_node )

Is node clickable?

Parameters

mixed $a_node node object/array

Returns: boolean node clickable true/false

Reimplemented from ilExplorerBaseGUI.

Definition at line 148 of file class.ilLSTOCGUI.php.

    {
        return !is_null($a_node['parameter']);
    }

◆ isNodeHighlighted()

ilLSTOCGUI::isNodeHighlighted ( $a_node )

Is node highlighted?

Parameters

mixed $a_node node object/array

Returns: boolean node highlighted true/false

Reimplemented from ilExplorerBaseGUI.

Definition at line 156 of file class.ilLSTOCGUI.php.

    {
        return $a_node['current'];
    }

◆ withStructure()

ilLSTOCGUI::withStructure ( string $json_structure )

Definition at line 61 of file class.ilLSTOCGUI.php.

    {
        $clone = clone $this;
        $clone->structure = $clone->addIds(
            json_decode($json_structure, true)
        );
        $clone->buildLookup($clone->structure); //sets $this->nodes
        $clone->open_nodes = array_keys($clone->nodes); //all open
        return $clone;
    }

Field Documentation

◆ $counter

ilLSTOCGUI::$counter = 0

protected

Definition at line 72 of file class.ilLSTOCGUI.php.

Referenced by addIds().

◆ $id

ilLSTOCGUI::$id = 'ls_toc'

protected

Definition at line 25 of file class.ilLSTOCGUI.php.

◆ $node_icons

ilLSTOCGUI::$node_icons

protected

Initial value:

= [
        TOCBuilder::LP_NOT_STARTED => '',
        TOCBuilder::LP_IN_PROGRESS => '',
        TOCBuilder::LP_COMPLETED => '',
        TOCBuilder::LP_FAILED => ''
    ]

Definition at line 36 of file class.ilLSTOCGUI.php.

◆ $nodes

ilLSTOCGUI::$nodes = []

protected

Definition at line 27 of file class.ilLSTOCGUI.php.

◆ $structure

ilLSTOCGUI::$structure

protected

Definition at line 26 of file class.ilLSTOCGUI.php.

◆ $url_builder

ilLSTOCGUI::$url_builder

protected

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

Referenced by __construct().

◆ NODE_ICONS

const ilLSTOCGUI::NODE_ICONS

Initial value:

= [
        TOCBuilder::LP_NOT_STARTED => "./templates/default/images/scorm/not_attempted.svg",
        TOCBuilder::LP_IN_PROGRESS => "./templates/default/images/scorm/incomplete.svg",
        TOCBuilder::LP_COMPLETED => "./templates/default/images/scorm/completed.svg",
        TOCBuilder::LP_FAILED => "./templates/default/images/scorm/failed.svg"
    ]

Deprecated:: will be deleted with R8

Definition at line 18 of file class.ilLSTOCGUI.php.

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

Modules/LearningSequence/classes/Player/class.ilLSTOCGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addIds()

◆ buildLookup()

◆ getChildsOfNode()

◆ getNodeContent()

◆ getNodeHref()

◆ getNodeIcon()

◆ getNodeId()

◆ getRootNode()

◆ isNodeClickable()

◆ isNodeHighlighted()

◆ withStructure()

Field Documentation

◆ $counter

◆ $id

◆ $node_icons

◆ $nodes

◆ $structure

◆ $url_builder

◆ NODE_ICONS