ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
Launcher.php
Go to the documentation of this file.
1<?php
2
19declare(strict_types=1);
20
22
28use Psr\Http\Message\ServerRequestInterface;
29
30interface Launcher extends Component
31{
32 public function withDescription(string $description): self;
33
51 public function withInputs(Group $fields, \Closure $evaluation, ?MessageBox\MessageBox $instruction = null): self;
52
53 public function withStatusIcon(null | Icon | ProgressMeter $status_icon): self;
54 public function withStatusMessageBox(?MessageBox\MessageBox $status_message): self;
55
62 public function withButtonLabel(string $label, bool $launchable = true): self;
63
64 public function withRequest(ServerRequestInterface $request): self;
65
66 public function withModalSubmitLabel(?string $label): self;
67
68 public function withModalCancelLabel(?string $label): self;
69}
A component is the most general form of an entity in the UI.
Definition: Component.php:28
Describes the monoid operation of grouping form inputs.
Definition: Group.php:32
withRequest(ServerRequestInterface $request)
withDescription(string $description)
withButtonLabel(string $label, bool $launchable=true)
Labels the button that launches the process; if the process is not launchable for the user,...
withStatusIcon(null|Icon|ProgressMeter $status_icon)
withStatusMessageBox(?MessageBox\MessageBox $status_message)
withInputs(Group $fields, \Closure $evaluation, ?MessageBox\MessageBox $instruction=null)
If the Launcher is configured with Inputs, an Roundtrip Modal is shown with these Inputs.
This describes how an icon could be modified during construction of UI.
Definition: Icon.php:29