ILIAS\KioskMode\ControlBuilder Interface Reference

Build controls for the view. More...

Inheritance diagram for ILIAS\KioskMode\ControlBuilder:

Collaboration diagram for ILIAS\KioskMode\ControlBuilder:

Public Member Functions
	exit (string $command)
	An exit control allows the user to gracefully leave the object providing the kiosk mode. More...
	next (string $command, int $parameter=null)
	A next control allows the user to progress to the next item in the object. More...
	previous (string $command, int $parameter=null)
	A previous control allows the user to go back to the previous item in the object. More...
	done (string $command, int $parameter=null)
	A done control allows the user to mark the object as done. More...
	generic (string $label, string $command, int $parameter=null)
	A generic control needs to have a label that tells what it does. More...
	toggle (string $label, string $on_command, string $off_command)
	A toggle can be used to switch some behaviour in the view on or of. More...
	mode (string $command, array $labels)
	A mode control can be used to switch between different modes in the view. More...
	locator (string $command)
	A locator allows the user to see the path leading to her current location and jump back to previous items on that path. More...
	tableOfContent (string $label, string $command, int $parameter=null, $state=null)
	A table of content allows the user to get an overview over the generally available content in the object. More...

Detailed Description

Build controls for the view.

Definition at line 11 of file ControlBuilder.php.

Member Function Documentation

done()

ILIAS\KioskMode\ControlBuilder::done	(	string	$command,
		int	$parameter = null
	)

A done control allows the user to mark the object as done.

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

Exceptions

Implemented in LSControlBuilder.

exit()

ILIAS\KioskMode\ControlBuilder::exit

(

string

$command

)

An exit control allows the user to gracefully leave the object providing the kiosk mode.

Exceptions

Implemented in LSControlBuilder.

generic()

ILIAS\KioskMode\ControlBuilder::generic	(	string	$label,
		string	$command,
		int	$parameter = null
	)

A generic control needs to have a label that tells what it does.

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

Implemented in LSControlBuilder.

Referenced by ilContentPageKioskModeView\builtLearningProgressToggleControl().

Here is the caller graph for this function:

locator()

ILIAS\KioskMode\ControlBuilder::locator

(

string

$command

)

A locator allows the user to see the path leading to her current location and jump back to previous items on that path.

The command will be enhanced with a parameter defined in the locator builder.

Exceptions

Implemented in LSControlBuilder.

mode()

ILIAS\KioskMode\ControlBuilder::mode	(	string	$command,
		array	$labels
	)

A mode control can be used to switch between different modes in the view.

Uses the indizes of the labels in the array as parameter for the command.

Implemented in LSControlBuilder.

Referenced by LSControlBuilder\mode().

Here is the caller graph for this function:

next()

ILIAS\KioskMode\ControlBuilder::next	(	string	$command,
		int	$parameter = null
	)

A next control allows the user to progress to the next item in the object.

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

Exceptions

Implemented in LSControlBuilder.

previous()

ILIAS\KioskMode\ControlBuilder::previous	(	string	$command,
		int	$parameter = null
	)

A previous control allows the user to go back to the previous item in the object.

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

Exceptions

Implemented in LSControlBuilder.

tableOfContent()

ILIAS\KioskMode\ControlBuilder::tableOfContent	(	string	$label,
		string	$command,
		int	$parameter = null,
			$state = null
	)

A table of content allows the user to get an overview over the generally available content in the object.

The command will be enhanced with a parameter defined here on in the locator builder.

If a parameter is defined here, the view provides an overview-page.

Exceptions

Implemented in LSControlBuilder.

Referenced by ilLegacyKioskModeView\debugBuildAllControls().

Here is the caller graph for this function:

toggle()

ILIAS\KioskMode\ControlBuilder::toggle	(	string	$label,
		string	$on_command,
		string	$off_command
	)

A toggle can be used to switch some behaviour in the view on or of.

Implemented in LSControlBuilder.

---

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

• src/KioskMode/ControlBuilder.php