ILIAS  release_8 Revision v8.24
ControlBuilder.php
Go to the documentation of this file.
1<?php
2
3declare(strict_types=1);
4
5/* Copyright (c) 2018 - Richard Klees <richard.klees@concepts-and-training.de> - Extended GPL, see LICENSE */
6
8
9use ILIAS\UI;
10
15{
22 public function exit(string $command): ControlBuilder;
23
32 public function next(string $command, int $parameter = null): ControlBuilder;
33
42 public function previous(string $command, int $parameter = null): ControlBuilder;
43
52 public function done(string $command, int $parameter = null): ControlBuilder;
53
60 public function generic(string $label, string $command, int $parameter = null): ControlBuilder;
61
66 public function genericWithSignal(string $label, UI\Component\Signal $signal): ControlBuilder;
67
71 public function toggle(string $label, string $on_command, string $off_command): ControlBuilder;
72
78 public function mode(string $command, array $labels): ControlBuilder;
79
88 public function locator(string $command): LocatorBuilder;
89
102 public function tableOfContent(string $label, string $command, int $parameter = null, $state = null): TOCBuilder;
103}
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.
done(string $command, int $parameter=null)
A done control allows the user to mark the object as done.
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.
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.
next(string $command, int $parameter=null)
A next control allows the user to progress to the next item in the object.
previous(string $command, int $parameter=null)
A previous control allows the user to go back to the previous item in the object.
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...
Build a locator for the view.
Build a nested table of contents for the view.
Definition: TOCBuilder.php:15
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Class Factory.