ILIAS  release_7 Revision v7.30-3-g800a261c036
Notification.php
Go to the documentation of this file.
1<?php
2/* Copyright (c) 2019 Timon Amstutz <timon.amstutz@ilub.unibe.ch> Extended GPL, see docs/LICENSE */
3
5
6use \ILIAS\UI\Component\Legacy\Legacy;
7
12interface Notification extends Item
13{
20 public function withAdditionalContent(Legacy $component) : Notification;
21
25 public function getAdditionalContent() : ?Legacy;
26
32 public function withCloseAction(string $url) : Notification;
33
37 public function getCloseAction() : ?string;
38
44 public function withAggregateNotifications(array $aggregate_notifications) : Notification;
45
51 public function getAggregateNotifications() : array;
52
56 public function withLeadIcon(\ILIAS\UI\Component\Symbol\Icon\Icon $lead) : Notification;
57
62 public function getLeadIcon() : \ILIAS\UI\Component\Symbol\Icon\Icon;
63}
An exception for terminatinating execution or to throw for unit testing.
A component is the most general form of an entity in the UI.
Definition: Component.php:14
Common interface to all items.
Definition: Item.php:11
getAggregateNotifications()
Get the list of Notification Items, this Notification Item aggregates or an empty list.
getAdditionalContent()
Get the additional content of the item or null.
getCloseAction()
Get the url attached to this Notification Item.
withLeadIcon(\ILIAS\UI\Component\Symbol\Icon\Icon $lead)
Set icon as lead.
withCloseAction(string $url)
Get an Item like this with an url to consulted async, when to close button is pressed.
withAdditionalContent(Legacy $component)
Get a Notification Item like this but with additional content bellow the description.
withAggregateNotifications(array $aggregate_notifications)
Get an Notification Item like this, but with a set of Notifications, this Notification Item will aggr...
This describes how an icon could be modified during construction of UI.
Definition: Icon.php:10
Class ChatMainBarProvider \MainMenu\Provider.
Class Factory.
$url