ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
Tree.php
Go to the documentation of this file.
1<?php
2declare(strict_types=1);
3
4/* Copyright (c) 2019 Nils Haagen <nils.haagen@concepts-and-training.de> Extended GPL, see docs/LICENSE */
5
7
8use \ILIAS\UI\Component\Component;
9
13interface Tree extends Component
14{
19 public function withEnvironment($environment) : Tree;
20
26 public function getLabel() : string;
27
31 public function withData($data) : Tree;
32
36 public function getEnvironment();
37
41 public function getData();
42
46 public function getRecursion() : TreeRecursion;
47
51 public function withHighlightOnNodeClick(bool $highlight) : Tree;
52
56 public function getHighlightOnNodeClick() : bool;
57}
An exception for terminatinating execution or to throw for unit testing.
A component is the most general form of an entity in the UI.
Definition: Component.php:14
Interface for mapping data-structures to the Tree.
This describes a Tree Control.
Definition: Tree.php:14
getRecursion()
Get the mapping-class.
withEnvironment($environment)
Configure the Tree with additional information that will be relayed to TreeRecursion.
withHighlightOnNodeClick(bool $highlight)
Should a clicked node be highlighted?
withData($data)
Apply data to the Tree.
getEnvironment()
Get the environment.
getLabel()
Get the (aria-)label.
getHighlightOnNodeClick()
Is the tree configured to highlight a clicked node?
$data
Definition: storeScorm.php:23