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

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

Public Member Functions
	withAdditionalContent (Content $component)
	Get a Notification Item like this but with additional content bellow the description. More...

	getAdditionalContent ()
	Get the additional content of the item or null. More...

	withCloseAction (string $url)
	Get an Item like this with an url to consulted async, when to close button is pressed. More...

	getCloseAction ()
	Get the url attached to this Notification Item. More...

	withAggregateNotifications (array $aggregate_notifications)
	Get an Notification Item like this, but with a set of Notifications, this Notification Item will aggregate. More...

	getAggregateNotifications ()
	Get the list of Notification Items, this Notification Item aggregates or an empty list. More...

	withLeadIcon (Icon $lead)
	Set icon as lead. More...

	getLeadIcon ()
	Get icon as lead. More...

	withActions (DropdownStandard $actions)
	Create a new appointment item with a set of actions to perform on it. More...

	getActions ()
	Get the actions of the item. More...

Public Member Functions inherited from ILIAS\UI\Component\Item\Item
	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

Definition at line 31 of file Notification.php.

Member Function Documentation

◆ getActions()

ILIAS\UI\Component\Item\Notification::getActions ( )

Get the actions of the item.

Implemented in ILIAS\UI\Implementation\Component\Item\Notification.

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

Here is the caller graph for this function:

◆ getAdditionalContent()

ILIAS\UI\Component\Item\Notification::getAdditionalContent ( )

Get the additional content of the item or null.

Implemented in ILIAS\UI\Implementation\Component\Item\Notification.

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

Here is the caller graph for this function:

◆ getAggregateNotifications()

ILIAS\UI\Component\Item\Notification::getAggregateNotifications ( )

Get the list of Notification Items, this Notification Item aggregates or an empty list.

Returns: Notification[] $sub

Implemented in ILIAS\UI\Implementation\Component\Item\Notification.

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

Here is the caller graph for this function:

◆ getCloseAction()

ILIAS\UI\Component\Item\Notification::getCloseAction ( )

Get the url attached to this Notification Item.

Implemented in ILIAS\UI\Implementation\Component\Item\Notification.

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

Here is the caller graph for this function:

◆ getLeadIcon()

ILIAS\UI\Component\Item\Notification::getLeadIcon ( )

Get icon as lead.

Note that Notifications only accept Icons as lead, this is different from the standard Item.

Implemented in ILIAS\UI\Implementation\Component\Item\Notification.

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

Here is the caller graph for this function:

◆ withActions()

ILIAS\UI\Component\Item\Notification::withActions ( DropdownStandard $actions )

Create a new appointment item with a set of actions to perform on it.

◆ withAdditionalContent()

ILIAS\UI\Component\Item\Notification::withAdditionalContent ( Content $component )

Get a Notification Item like this but with additional content bellow the description.

Note this should only be used, if the content section needs to hold legacy content that currently does not have a place in the UI components.

Implemented in ILIAS\UI\Implementation\Component\Item\Notification.

◆ withAggregateNotifications()

ILIAS\UI\Component\Item\Notification::withAggregateNotifications ( array $aggregate_notifications )

Get an Notification Item like this, but with a set of Notifications, this Notification Item will aggregate.

Parameters

Notification[] $aggregate_notifications

Implemented in ILIAS\UI\Implementation\Component\Item\Notification.

◆ withCloseAction()

ILIAS\UI\Component\Item\Notification::withCloseAction ( string $url )

Get an Item like this with an url to consulted async, when to close button is pressed.

With this url, information may be stored persistently in the DB without interrupting the workflow of the user (e.g. setting a flag, that the message was consulted).

Implemented in ILIAS\UI\Implementation\Component\Item\Notification.

Referenced by ILIAS\GlobalScreen\Scope\Notification\Collector\Renderer\StandardNotificationRenderer\attachJSCloseEvent().

Here is the caller graph for this function: