ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
isStandardItem.php
Go to the documentation of this file.
1 <?php
2 
19 declare(strict_types=1);
20 
22 
25 
30 interface isStandardItem extends isItem
31 {
32  public function getTitle(): string;
33 
34  public function withDescription(string $description): isStandardItem;
35 
36  public function getDescription(): ?string;
37 
44  public function withAdditionToastAction(ToastAction $action): isStandardItem;
45 
49  public function getAllToastActions(): array;
50 
54  public function getAdditionalToastActions(): array;
55 
56  public function withIcon(Icon $icon): isStandardItem;
57 
58  public function getIcon(): ?Icon;
59 
64  public function withShownCallable(\Closure $handle_shown): isStandardItem;
65 
69  public function getShownAction(): ToastAction;
70 
71  public function hasShownAction(): bool;
72 
77  public function withClosedCallable(\Closure $handle_closed): isStandardItem;
78 
82  public function getClosedAction(): ?ToastAction;
83 
87  public function hasClosedAction(): bool;
88 
93  public function withVanishedCallable(\Closure $handle_vanished): isStandardItem;
94 
98  public function getVanishedAction(): ?ToastAction;
99 
103  public function hasVanishedAction(): bool;
104 
105  public function withVanishTime(int $miliseconds): isStandardItem;
106 
107  public function getVanishTime(): ?int;
108 
109  public function withDelayTime(int $miliseconds): isStandardItem;
110 
111  public function getDelayTime(): ?int;
112 
113  public function getRenderer(): ToastRenderer;
114 }
This describes how an icon could be modified during construction of UI.
Definition: Icon.php:28
withAdditionToastAction(ToastAction $action)
A ToastAction leads into the rendered toast to a link that can be clicked by the user.
hasClosedAction()
Get whether there are any callables to be executed the Toast is closed.
withShownCallable(\Closure $handle_shown)
Set the callable to be executed, when the toast is shown.
getVanishedAction()
Get the callable to be executed, when this specific item has vanished.
getClosedAction()
Get the callable to be executed, when this specific item is closed.
withClosedCallable(\Closure $handle_closed)
Set the callable to be executed, when this specific item is closed by clicking the X button or after ...
hasVanishedAction()
Get whether there are any callables to be executed the Toast has vanished.
withVanishedCallable(\Closure $handle_vanished)
Set the callable to be executed, when this specific item is closed vanishing.
getShownAction()
Get the callable to be executed, when the test is shown in GUI.