ILIAS\UI\Component\Item\Item Interface Reference

Common interface to all items. More...

Inheritance diagram for ILIAS\UI\Component\Item\Item:

Collaboration diagram for ILIAS\UI\Component\Item\Item:

Public Member Functions
	getTitle ()
	Gets the title of the item. More...
	withDescription (string $description)
	Create a new item with an attached description. More...
	getDescription ()
	Get the description of the item. More...
	withProperties (array $properties)
	Get a new item with the given properties as key-value pairs. More...
	getProperties ()
	Get the properties of the appointment. 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

Common interface to all items.

Definition at line 31 of file Item.php.

Member Function Documentation

getDescription()

ILIAS\UI\Component\Item\Item::getDescription

(

)

Get the description of the item.

Referenced by ILIAS\UI\Implementation\Component\Item\Renderer\renderDescription(), and ILIAS\UI\Implementation\Component\Item\Renderer\renderShy().

Here is the caller graph for this function:

getProperties()

ILIAS\UI\Component\Item\Item::getProperties

(

)

Get the properties of the appointment.

Returns

array<string,string|Shy|Icon> Title => Content

Referenced by ilAppointmentPresentationGUI\getHTML(), and ILIAS\UI\Implementation\Component\Item\Renderer\renderProperties().

Here is the caller graph for this function:

getTitle()

ILIAS\UI\Component\Item\Item::getTitle

(

)

Gets the title of the item.

Returns

string|Shy|Link

Referenced by ILIAS\UI\Implementation\Component\Item\Renderer\renderTitle().

Here is the caller graph for this function:

withDescription()

ILIAS\UI\Component\Item\Item::withDescription

(

string

$description

)

Create a new item with an attached description.

Referenced by ilBTPopOverGUI\getNotificationItem().

Here is the caller graph for this function:

withProperties()

ILIAS\UI\Component\Item\Item::withProperties

(

array

$properties

)

Get a new item with the given properties as key-value pairs.

The key is holding the title and the value is holding the content of the specific data set.

Parameters

array<string,string|Shy|Icon>

$properties Label => Content

Referenced by ilAppointmentPresentationGUI\getHTML().

Here is the caller graph for this function:

---

The documentation for this interface was generated from the following file:

• components/ILIAS/UI/src/Component/Item/Item.php