ILIAS\KioskMode\TOCBuilder Interface Reference

Build a nested table of contents for the view. More...

Inheritance diagram for ILIAS\KioskMode\TOCBuilder:

Collaboration diagram for ILIAS\KioskMode\TOCBuilder:

Public Member Functions
	end ()
	Finish building the TOC. More...
	node (string $label, ?int $parameter=null, ?int $lp=null)
	Build a sub tree in the TOC. More...
	item (string $label, int $parameter, $state=null, bool $current=false)
	Build an entry in the TOC. More...

Data Fields
const	LP_NOT_STARTED = 0
const	LP_IN_PROGRESS = 1
const	LP_COMPLETED = 2
const	LP_FAILED = 3

Detailed Description

Build a nested table of contents for the view.

Definition at line 28 of file TOCBuilder.php.

Member Function Documentation

end()

ILIAS\KioskMode\TOCBuilder::end

(

)

Finish building the TOC.

Returns

ControlBuilder|TOCBuilder depending on the nesting level.

Implemented in LSTOCBuilder.

item()

ILIAS\KioskMode\TOCBuilder::item	(	string	$label,
		int	$parameter,
			$state = null,
		bool	$current = false
	)

Build an entry in the TOC.

The parameter will be appended to the command when updating the state.

The $parameter can be used to pass additional information to View::updateGet if required, e.g. about a chapter in the content.

Parameters

mixed	$state	one of the LP_ constants from TOCBuilder
bool	$current	is this the currently active item?

Implemented in LSTOCBuilder.

node()

ILIAS\KioskMode\TOCBuilder::node	(	string	$label,
		?int	$parameter = null,
		?int	$lp = null
	)

Build a sub tree in the TOC.

If a parameter is provided, the node in the TOC can be accessed itself.

The $parameter can be used to pass additional information to View::updateGet if required, e.g. about a chapter in the content.

Parameters

mixed

$state

one of the LP_ constants from TOCBuilder

Implemented in LSTOCBuilder.

Field Documentation

LP_COMPLETED

const ILIAS\KioskMode\TOCBuilder::LP_COMPLETED = 2

Definition at line 32 of file TOCBuilder.php.

Referenced by ilLMTOCExplorerGUI\renderLSTocNode().

LP_FAILED

const ILIAS\KioskMode\TOCBuilder::LP_FAILED = 3

Definition at line 33 of file TOCBuilder.php.

LP_IN_PROGRESS

const ILIAS\KioskMode\TOCBuilder::LP_IN_PROGRESS = 1

Definition at line 31 of file TOCBuilder.php.

Referenced by ilLMTOCExplorerGUI\renderLSTocNode().

LP_NOT_STARTED

const ILIAS\KioskMode\TOCBuilder::LP_NOT_STARTED = 0

Definition at line 30 of file TOCBuilder.php.

---

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

• components/ILIAS/KioskMode/src/TOCBuilder.php