ILIAS  trunk Revision v13.0_alpha-62-g3b72d83f2e5
Entity.php
Go to the documentation of this file.
1<?php
2
19declare(strict_types=1);
20
22
25use ILIAS\UI\Component\Button\Standard as StandardButton;
29use ILIAS\UI\Component\Listing\Property as PropertyListing;
30use ILIAS\UI\Component\Link\Standard as StandardLink;
32
36interface Entity extends Component
37{
41 public function getId(): string|int;
42
43 //Priority Areas
44
50 PropertyListing | StandardLink | Content ...$blocking_conditions
51 ): self;
52
59 public function withFeaturedProperties(
60 PropertyListing | StandardLink | Content ...$featured_props
61 ): self;
62
67 public function withMainDetails(
68 PropertyListing | Content ...$main_details
69 ): self;
70
78 public function withPrioritizedReactions(Glyph | Tag | StandardButton | Shy ...$prio_reactions): self;
79
80 //Further Areas
81
85 public function withReactions(Glyph | Tag | Shy | StandardButton ...$reactions): self;
86
92 public function withAvailability(
93 PropertyListing | StandardLink | Content ...$availability
94 ): self;
95
100 public function withDetails(
101 PropertyListing | Content ...$details
102 ): self;
103
108 public function withManagingActions(Shy ...$managing_actions): static;
109
113 public function withActions(Shy ...$actions): self;
114
120 public function withPersonalStatus(
121 PropertyListing | Content ...$personal_status
122 ): self;
123
129 public function withWorkflow(Workflow\Linear $workflow): static;
130}
This describes a standard button.
Definition: Standard.php:27
This describes a tag(-button).
Definition: Tag.php:29
A component is the most general form of an entity in the UI.
Definition: Component.php:28
This describes an Entity.
Definition: Entity.php:37
withMainDetails(PropertyListing|Content ... $main_details)
Main Details should provide a quick differentiation or choice on the entity.
withWorkflow(Workflow\Linear $workflow)
This Workflow is used to create buttons on the entity.
withFeaturedProperties(PropertyListing|StandardLink|Content ... $featured_props)
Some Properties may be of higher relevance than others, be it as very significant properties of the e...
getId()
Returns the technical identifier of this entity.
withPersonalStatus(PropertyListing|Content ... $personal_status)
Personal Status properties indicate the status of a relation between the current user and the object.
withPrioritizedReactions(Glyph|Tag|StandardButton|Shy ... $prio_reactions)
Users may directly react to the entity, e.g.
withAvailability(PropertyListing|StandardLink|Content ... $availability)
Properties that could potentially limit a users access to the object belong to this group.
withManagingActions(Shy ... $managing_actions)
ManagingActions are the things an owner or admin can actually do with the entity, e....
withBlockingAvailabilityConditions(PropertyListing|StandardLink|Content ... $blocking_conditions)
Set (and maybe explain) Blocking Availability Conditions when there is some access restriction for th...
withReactions(Glyph|Tag|Shy|StandardButton ... $reactions)
Reactions that are less prominent than Prioritized Reactions go here.
withDetails(PropertyListing|Content ... $details)
Details provide further information about the entity - worth knowing and helpful, but not as signific...
This describes a Linear Workflow.
Definition: Linear.php:27