ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
isItem.php
Go to the documentation of this file.
2
6
12interface isItem
13{
14
19
20
29 public function withVisibilityCallable(callable $is_visible) : isItem;
30
31
35 public function isVisible() : bool;
36
37
47 public function withActiveCallable(callable $is_active) : isItem;
48
49
53 public function isActive() : bool;
54
55
65 public function withAvailableCallable(callable $is_avaiable) : isItem;
66
67
71 public function isAvailable() : bool;
72
73
85 public function withNonAvailableReason(Legacy $element) : isItem;
86
87
91 public function getNonAvailableReason() : Legacy;
92
93
100 public function getPosition() : int;
101
102
108 public function withPosition(int $position) : isItem;
109
110
114 public function isAlwaysAvailable() : bool;
115
116
122 public function withAlwaysAvailable(bool $always_active) : isItem;
123
124
130 public function setTypeInformation(TypeInformation $information) : isItem;
131
132
137}
An exception for terminatinating execution or to throw for unit testing.
withActiveCallable(callable $is_active)
Pass a callable which can decide whether your element is in a active state (e.g.
getPosition()
Return the default position for installation, this will be overridden by the configuration later.
setTypeInformation(TypeInformation $information)
withNonAvailableReason(Legacy $element)
If your provider or the service which provides the Item does not allow to activate the item (.
withVisibilityCallable(callable $is_visible)
Pass a callable which can decide whether your element is visible for the current user.
withAvailableCallable(callable $is_avaiable)
Pass a callable which can decide wheter your element is available in general, e.g.