AdministrativeNotification.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
namespace ILIAS\GlobalScreen\Scope\Notification\Factory;
 
use ILIAS\GlobalScreen\Identification\IdentificationInterface;
use ILIAS\GlobalScreen\Scope\Notification\Collector\Renderer\AdministrativeNotificationRenderer;
use ILIAS\GlobalScreen\Scope\Notification\Collector\Renderer\NotificationRenderer;
use ILIAS\UI\Factory as UIFactory;
use Closure;
 
class AdministrativeNotification extends AbstractBaseNotification implements isItem, hasTitle
{
    public const DENOTATION_NEUTRAL = 'neutral';
    public const DENOTATION_IMPORTANT = 'important';
    public const DENOTATION_BREAKING = 'breaking';
 
    private bool $is_visible_static;
 
    protected IdentificationInterface $provider_identification;
 
    protected string $title;
 
    protected string $summary;
 
    protected ?Closure  $available_callable = null;
    protected ?Closure $visiblility_callable = null;
    protected bool $is_always_available = false;
    protected string $denotation = self::DENOTATION_NEUTRAL;
 
    public function getRenderer(UIFactory $factory): NotificationRenderer
    {
        return new AdministrativeNotificationRenderer($factory);
    }
 
    public function withTitle(string $title): hasTitle
    {
        $clone = clone $this;
        $clone->title = $title;
 
        return $clone;
    }
 
    public function getTitle(): string
    {
        return $this->title;
    }
 
    public function withSummary(string $summary): isItem
    {
        $clone = clone $this;
        $clone->summary = $summary;
 
        return $clone;
    }
 
    public function getSummary(): string
    {
        return $this->summary;
    }
 
    public function withVisibilityCallable(callable $is_visible): self
    {
        $clone = clone($this);
        $clone->visiblility_callable = $is_visible;
 
        return $clone;
    }
 
    public function isVisible(): bool
    {
        if (isset($this->is_visible_static)) {
            return $this->is_visible_static;
        }
        if (!$this->isAvailable()) {
            return $this->is_visible_static = false;
        }
        if (is_callable($this->visiblility_callable)) {
            $callable = $this->visiblility_callable;
 
            $value = $callable();
 
            return $this->is_visible_static = $value;
        }
 
        return $this->is_visible_static = true;
    }
 
    public function isAvailable(): bool
    {
        if (is_callable($this->available_callable)) {
            $callable = $this->available_callable;
 
            return $callable();
        }
 
        return true;
    }
 
    public function withAvailableCallable(callable $is_available): self
    {
        $clone = clone($this);
        $clone->available_callable = $is_available;
 
        return $clone;
    }
 
    public function withNeutralDenotation(): self
    {
        $clone = clone($this);
        $clone->denotation = self::DENOTATION_NEUTRAL;
 
        return $clone;
    }
 
    public function withImportantDenotation(): self
    {
        $clone = clone($this);
        $clone->denotation = self::DENOTATION_IMPORTANT;
 
        return $clone;
    }
 
    public function withBreakingDenotation(): self
    {
        $clone = clone($this);
        $clone->denotation = self::DENOTATION_BREAKING;
 
        return $clone;
    }
 
    public function getDenotation(): string
    {
        return $this->denotation ?? self::DENOTATION_NEUTRAL;
    }
}