ILIAS\KioskMode\View Interface Reference

A kiosk mode view on a certain object. More...

Inheritance diagram for ILIAS\KioskMode\View:

Collaboration diagram for ILIAS\KioskMode\View:

Public Member Functions
	buildInitialState (State $empty_state)
	Build an initial state based on the Provided empty state. More...
	buildControls (State $state, ControlBuilder $builder)
	Construct the controls for the view based on the current state. More...
	updateGet (State $state, string $command, int $parameter=null)
	Update the state based on the provided command. More...
	updatePost (State $state, string $command, array $post)
	Update the state and the object based on the provided command and post-data. More...
	render (State $state, UI\Factory $factory, URLBuilder $url_builder, array $post=null)
	Render a state using the ui-factory and URLs from the builder. More...

Detailed Description

A kiosk mode view on a certain object.

See README/Architecture for further details and README/Implementing a Provider for further directions about implementation.

Definition at line 16 of file View.php.

Member Function Documentation

buildControls()

ILIAS\KioskMode\View::buildControls	(	State	$state,
		ControlBuilder	$builder
	)

Construct the controls for the view based on the current state.

The interaction with the controls build via the ControlBuilder will always be delegated to updateGet.

Implemented in ilLearningModuleKioskModeView, ilContentPageKioskModeView, ilLegacyKioskModeView, and ilDummyKioskModeView.

buildInitialState()

ILIAS\KioskMode\View::buildInitialState

(

State

$empty_state

)

Build an initial state based on the Provided empty state.

Implemented in ilLearningModuleKioskModeView, ilContentPageKioskModeView, ilLegacyKioskModeView, and ilDummyKioskModeView.

Referenced by ilLSLearnerItemsQueries\getStateFor().

Here is the caller graph for this function:

render()

ILIAS\KioskMode\View::render	(	State	$state,
		UI\Factory	$factory,
		URLBuilder	$url_builder,
		array	$post = null
	)

Render a state using the ui-factory and URLs from the builder.

Links inside the content that should lead to kiosk-mode-view again (forms) must be created via the URLBuilder.

If data was POSTed to the kiosk-mode-view, it will be passed via $post.

updateGet()

ILIAS\KioskMode\View::updateGet	(	State	$state,
		string	$command,
		int	$parameter = null
	)

Update the state based on the provided command.

If the update was caused by a control with a $parameter (see ControlBuilder) that value is passed to $parameter here.

Commands and parameters are defined by the view in buildControl.

Implemented in ilContentPageKioskModeView, ilLegacyKioskModeView, ilLearningModuleKioskModeView, and ilDummyKioskModeView.

updatePost()

ILIAS\KioskMode\View::updatePost	(	State	$state,
		string	$command,
		array	$post
	)

Update the state and the object based on the provided command and post-data.

Commands are defined via the url-builder provided to render.

The POSTed data will be passed via $post.

Implemented in ilLearningModuleKioskModeView, ilContentPageKioskModeView, ilLegacyKioskModeView, and ilDummyKioskModeView.

---

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

• src/KioskMode/View.php