ILIAS\UI\Component\Card\Card Interface Reference
Inheritance diagram for ILIAS\UI\Component\Card\Card:
Collaboration diagram for ILIAS\UI\Component\Card\Card:
Public Member Functions | |
| withTitle ($title) | |
| Sets the title in the heading section of the card. More... | |
| getTitle () | |
| Get the title in the heading section of the card. More... | |
| withTitleAction ($action) | |
| Get a Card like this with a title action. More... | |
| getTitleAction () | |
| Returns the title action if given, otherwise null. More... | |
| withSections (array $sections) | |
| Set multiple sections of the card as array. More... | |
| getSections () | |
| Get the multiple sections of the card as array. More... | |
| withHiddenSections (array $sections) | |
| getHiddenSections () | |
| withImage (Image $image) | |
| Set the image of the card. More... | |
| getImage () | |
| Get the image of the card. More... | |
| withHighlight (bool $status) | |
| Get a Card like this with a highlight. More... | |
| isHighlighted () | |
| Returns whether the Card is highlighted. 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... | |
| Public Member Functions inherited from ILIAS\UI\Component\JavaScriptBindable | |
| withOnLoadCode (Closure $binder) | |
| withAdditionalOnLoadCode (Closure $binder) | |
| Add some onload-code to the component instead of replacing the existing one. More... | |
| getOnLoadCode () | |
| Get the currently bound on load code. More... | |
| Public Member Functions inherited from ILIAS\UI\Component\Clickable | |
| withOnClick (Signal $signal) | |
| Get a component like this, triggering a signal of another component on click. More... | |
| appendOnClick (Signal $signal) | |
| Get a component like this, triggering a signal of another component on click. More... | |
| Public Member Functions inherited from ILIAS\UI\Component\Triggerer | |
| withResetTriggeredSignals () | |
| Get a component like this but reset any triggered signals of other components. More... | |
| getTriggeredSignals () | |
| Get all triggered signals of this component. More... | |
Detailed Description
Member Function Documentation
◆ getHiddenSections()
| ILIAS\UI\Component\Card\Card::getHiddenSections | ( | ) |
- Returns
- [] $sections
◆ getImage()
| ILIAS\UI\Component\Card\Card::getImage | ( | ) |
Get the image of the card.
Referenced by ilECSUserConsentModalGUI\addConsentModalToCard().
Here is the caller graph for this function:
◆ getSections()
| ILIAS\UI\Component\Card\Card::getSections | ( | ) |
Get the multiple sections of the card as array.
- Returns
- []
◆ getTitle()
| ILIAS\UI\Component\Card\Card::getTitle | ( | ) |
Get the title in the heading section of the card.
- Returns
- string|Shy
◆ getTitleAction()
| ILIAS\UI\Component\Card\Card::getTitleAction | ( | ) |
Returns the title action if given, otherwise null.
- Returns
- string|Signal[]|null
◆ isHighlighted()
| ILIAS\UI\Component\Card\Card::isHighlighted | ( | ) |
Returns whether the Card is highlighted.
◆ withHiddenSections()
| ILIAS\UI\Component\Card\Card::withHiddenSections | ( | array | $sections | ) |
- Parameters
-
◆ withHighlight()
| ILIAS\UI\Component\Card\Card::withHighlight | ( | bool | $status | ) |
Get a Card like this with a highlight.
◆ withImage()
| ILIAS\UI\Component\Card\Card::withImage | ( | Image | $image | ) |
Set the image of the card.
Referenced by ilECSUserConsentModalGUI\addConsentModalToCard().
Here is the caller graph for this function:
◆ withSections()
| ILIAS\UI\Component\Card\Card::withSections | ( | array | $sections | ) |
Set multiple sections of the card as array.
- Parameters
-
◆ withTitle()
| ILIAS\UI\Component\Card\Card::withTitle | ( | $title | ) |
Sets the title in the heading section of the card.
- Parameters
-
string | Shy $title
◆ withTitleAction()
| ILIAS\UI\Implementation\Component\Card\Card::withTitleAction | ( | $action | ) |
The documentation for this interface was generated from the following file:
- components/ILIAS/UI/src/Component/Card/Card.php
