This describes an Entity. More...
Inheritance diagram for ILIAS\UI\Component\Entity\Entity:
Collaboration diagram for ILIAS\UI\Component\Entity\Entity:
Public Member Functions | |
| withBlockingAvailabilityConditions (PropertyListing|StandardLink|Content ... $blocking_conditions) | |
| Set (and maybe explain) Blocking Availability Conditions when there is some access restriction for the user on this object. More... | |
| withFeaturedProperties (PropertyListing|StandardLink|Content ... $featured_props) | |
| Some Properties may be of higher relevance than others, be it as very significant properties of the entity itself or of greater importance within the context; you may "feature" them, i.e. More... | |
| withMainDetails (PropertyListing|Content ... $main_details) | |
| Main Details should provide a quick differentiation or choice on the entity. More... | |
| withPrioritizedReactions (Glyph|Tag ... $prio_reactions) | |
| Users may directly react to the entity, e.g. More... | |
| withReactions (Glyph|Tag ... $reactions) | |
| Reactions that are less prominent than Prioritized Reactions go here. More... | |
| withAvailability (PropertyListing|StandardLink|Content ... $availability) | |
| Properties that could potentially limit a users access to the object belong to this group. More... | |
| withDetails (PropertyListing|Content ... $details) | |
| Details provide further information about the entity - worth knowing and helpful, but not as significantly important than Main Details or Featured Properties. More... | |
| withActions (Shy ... $actions) | |
| Actions are the things you can actually do with the entity, e.g. More... | |
| withPersonalStatus (PropertyListing|Content ... $personal_status) | |
| Personal Status properties indicate the status of a relation between the current user and the object. More... | |
| Public Member Functions inherited from ILIAS\UI\Component\Component | |
| getCanonicalName () | |
| Get the canonical name of the component. More... | |
| reduceWith (\Closure $fn) | |
| The scheme starts at the leaves of the structure and applies the function to each leave and moves up the tree recursively. More... | |
Detailed Description
This describes an Entity.
Definition at line 36 of file Entity.php.
Member Function Documentation
◆ withActions()
| ILIAS\UI\Component\Entity\Entity::withActions | ( | Shy ... | $actions | ) |
Actions are the things you can actually do with the entity, e.g.
in context of repository items: view, copy, delete, etc.
◆ withAvailability()
| ILIAS\UI\Component\Entity\Entity::withAvailability | ( | PropertyListing|StandardLink|Content ... | $availability | ) |
Properties that could potentially limit a users access to the object belong to this group.
If they are actually blocking access, then you should place them into Blocking Availability Conditions.
◆ withBlockingAvailabilityConditions()
| ILIAS\UI\Component\Entity\Entity::withBlockingAvailabilityConditions | ( | PropertyListing|StandardLink|Content ... | $blocking_conditions | ) |
Set (and maybe explain) Blocking Availability Conditions when there is some access restriction for the user on this object.
◆ withDetails()
| ILIAS\UI\Component\Entity\Entity::withDetails | ( | PropertyListing|Content ... | $details | ) |
Details provide further information about the entity - worth knowing and helpful, but not as significantly important than Main Details or Featured Properties.
◆ withFeaturedProperties()
| ILIAS\UI\Component\Entity\Entity::withFeaturedProperties | ( | PropertyListing|StandardLink|Content ... | $featured_props | ) |
Some Properties may be of higher relevance than others, be it as very significant properties of the entity itself or of greater importance within the context; you may "feature" them, i.e.
put them in a prominent place.
◆ withMainDetails()
| ILIAS\UI\Component\Entity\Entity::withMainDetails | ( | PropertyListing|Content ... | $main_details | ) |
Main Details should provide a quick differentiation or choice on the entity.
"Description" would be one of the most prominent examples.
Referenced by ILIAS\UI\Examples\Listing\Entity\Standard\base().
Here is the caller graph for this function:
◆ withPersonalStatus()
| ILIAS\UI\Component\Entity\Entity::withPersonalStatus | ( | PropertyListing|Content ... | $personal_status | ) |
◆ withPrioritizedReactions()
Users may directly react to the entity, e.g.
comment or tag it. When there are multiple possible reactions, split them e.g. into more common ones (here) and less often used ones. Another way of distinguishing Reactions might be the availability/significance for everybody in contrast to the current user (e.g. rating vs. my favorite)
◆ withReactions()
Reactions that are less prominent than Prioritized Reactions go here.
The documentation for this interface was generated from the following file:
- components/ILIAS/UI/src/Component/Entity/Entity.php
