ILIAS  release_7 Revision v7.30-3-g800a261c036
Engageable.php
Go to the documentation of this file.
1<?php
2
3/* Copyright (c) 2018 Nils Haagen <nils.haagen@concepts-and-training.de> Extended GPL, see docs/LICENSE */
4
6
8
12interface Engageable extends Component
13{
20 public function isEngageable() : bool;
21
26 public function withEngagedState(bool $state) : Engageable;
27
31 public function isEngaged() : bool;
32}
An exception for terminatinating execution or to throw for unit testing.
Engageable Components have an "engaged" state and will be displayed accordingly.
Definition: Engageable.php:13
isEngaged()
Returns whether the button is currently engaged or not.
withEngagedState(bool $state)
Get a copy of the Engageable Button with engaged state for $state=true and with disengaged state for ...
isEngageable()
Returns whether the button is stateful or not.
A component is the most general form of an entity in the UI.
Definition: Component.php:14