ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
Entity.php
Go to the documentation of this file.
1<?php
2
19declare(strict_types=1);
20
22
30use ILIAS\UI\Component\Listing\Property as PropertyListing;
31use ILIAS\UI\Component\Link\Standard as StandardLink;
32
36interface Entity extends Component
37{
38 //Priority Areas
39
45 PropertyListing | StandardLink | Content ...$blocking_conditions
46 ): self;
47
54 public function withFeaturedProperties(
55 PropertyListing | StandardLink | Content ...$featured_props
56 ): self;
57
62 public function withMainDetails(
63 PropertyListing | Content ...$main_details
64 ): self;
65
73 public function withPrioritizedReactions(Glyph | Tag ...$prio_reactions): self;
74
75
76 //Further Areas
77
81 public function withReactions(Glyph | Tag ...$reactions): self;
82
88 public function withAvailability(
89 PropertyListing | StandardLink | Content ...$availability
90 ): self;
91
96 public function withDetails(
97 PropertyListing | Content ...$details
98 ): self;
99
104 public function withActions(Shy ...$actions): self;
105
111 public function withPersonalStatus(
112 PropertyListing | Content ...$personal_status
113 ): self;
114}
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
withReactions(Glyph|Tag ... $reactions)
Reactions that are less prominent than Prioritized Reactions go here.
withMainDetails(PropertyListing|Content ... $main_details)
Main Details should provide a quick differentiation or choice on the entity.
withPrioritizedReactions(Glyph|Tag ... $prio_reactions)
Users may directly react to the entity, e.g.
withFeaturedProperties(PropertyListing|StandardLink|Content ... $featured_props)
Some Properties may be of higher relevance than others, be it as very significant properties of the e...
withActions(Shy ... $actions)
Actions are the things you can actually do with the entity, e.g.
withPersonalStatus(PropertyListing|Content ... $personal_status)
Personal Status properties indicate the status of a relation between the current user and the object.
withAvailability(PropertyListing|StandardLink|Content ... $availability)
Properties that could potentially limit a users access to the object belong to this group.
withBlockingAvailabilityConditions(PropertyListing|StandardLink|Content ... $blocking_conditions)
Set (and maybe explain) Blocking Availability Conditions when there is some access restriction for th...
withDetails(PropertyListing|Content ... $details)
Details provide further information about the entity - worth knowing and helpful, but not as signific...
This describes a symbol.
Definition: Symbol.php:30