Notification.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Item;

use ILIAS\UI\Component\Item\Notification as INotification;
use ILIAS\UI\Component\Legacy\Legacy;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;
use ILIAS\UI\Component\JavaScriptBindable as IJavaScriptBindable;
use ILIAS\UI\Component\Symbol\Icon\Icon;
use ILIAS\UI\Component\Button\Shy;
use ILIAS\UI\Component\Link;
use ILIAS\UI\Component as C;

class Notification extends Item implements INotification, IJavaScriptBindable
{
    use JavaScriptBindable;

    protected ?Legacy $additional_content = null;
    protected Icon $lead_icon;
    protected ?string $close_action = null;

    protected array $aggregate_notifications = [];

    public function __construct($title, Icon $icon)
    {
        $this->lead_icon = $icon;
        parent::__construct($title);
    }

    public function withAdditionalContent(Legacy $additional_content): INotification
    {
        $clone = clone $this;
        $clone->additional_content = $additional_content;
        return $clone;
    }

    public function getAdditionalContent(): ?Legacy
    {
        return $this->additional_content;
    }

    public function withCloseAction(string $url): INotification
    {
        $clone = clone $this;
        $clone->close_action = $url;
        return $clone;
    }

    public function getCloseAction(): ?string
    {
        return $this->close_action;
    }

    public function withAggregateNotifications(array $aggregate_notifications): INotification
    {
        $classes = [
            INotification::class
        ];
        $this->checkArgListElements("Notification Item", $aggregate_notifications, $classes);
        $clone = clone $this;
        $clone->aggregate_notifications = $aggregate_notifications;
        return $clone;
    }

    public function getAggregateNotifications(): array
    {
        return $this->aggregate_notifications;
    }

    public function withLeadIcon(Icon $icon): INotification
    {
        $clone = clone $this;
        $clone->lead_icon = $icon;
        return $clone;
    }

    public function getLeadIcon(): Icon
    {
        return $this->lead_icon;
    }

    public function withActions(C\Dropdown\Standard $actions): C\Item\Notification
    {
        $clone = clone $this;
        $clone->actions = $actions;
        return $clone;
    }

    public function getActions(): ?C\Dropdown\Standard
    {
        return $this->actions;
    }
}