ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ControlBuilder.php
Go to the documentation of this file.
1<?php
2
19declare(strict_types=1);
20
22
23use ILIAS\UI;
24
29{
36 public function exit(string $command): ControlBuilder;
37
46 public function next(string $command, ?int $parameter = null): ControlBuilder;
47
56 public function previous(string $command, ?int $parameter = null): ControlBuilder;
57
66 public function done(string $command, ?int $parameter = null): ControlBuilder;
67
74 public function generic(string $label, string $command, ?int $parameter = null): ControlBuilder;
75
80 public function genericWithSignal(string $label, UI\Component\Signal $signal): ControlBuilder;
81
85 public function toggle(string $label, string $on_command, string $off_command): ControlBuilder;
86
92 public function mode(string $command, array $labels): ControlBuilder;
93
102 public function locator(string $command): LocatorBuilder;
103
116 public function tableOfContent(string $label, string $command, ?int $parameter = null, $state = null): TOCBuilder;
117}
Definition: UI.php:24
Build controls for the view.
toggle(string $label, string $on_command, string $off_command)
A toggle can be used to switch some behaviour in the view on or of.
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 obj...
next(string $command, ?int $parameter=null)
A next control allows the user to progress to the next item in the object.
genericWithSignal(string $label, UI\Component\Signal $signal)
A genericWithSignal will trigger the Signal rather than refreshing the View.
mode(string $command, array $labels)
A mode control can be used to switch between different modes in the view.
done(string $command, ?int $parameter=null)
A done control allows the user to mark the object as done.
locator(string $command)
A locator allows the user to see the path leading to her current location and jump back to previous i...
exit(string $command)
An exit control allows the user to gracefully leave the object providing the kiosk mode.
previous(string $command, ?int $parameter=null)
A previous control allows the user to go back to the previous item in the object.
Build a locator for the view.
Build a nested table of contents for the view.
Definition: TOCBuilder.php:29
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...