ADNProvider.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\AdministrativeNotification\GlobalScreen;

use ILIAS\Refinery\String\MarkdownFormattingToHTML;
use ILIAS\GlobalScreen\Helper\BasicAccessCheckClosures;
use ilADNNotification;
use ILIAS\GlobalScreen\Helper\BasicAccessCheckClosuresSingleton;
use ILIAS\GlobalScreen\Identification\IdentificationInterface;
use ILIAS\GlobalScreen\Scope\Notification\Factory\AdministrativeNotification;
use ILIAS\GlobalScreen\Scope\Notification\Provider\AbstractNotificationProvider;
use Closure;
use ILIAS\DI\Container;

class ADNProvider extends AbstractNotificationProvider
{
    protected MarkdownFormattingToHTML $markdown;
    protected BasicAccessCheckClosures $access;

    public function __construct(Container $dic)
    {
        parent::__construct($dic);
        $this->access = BasicAccessCheckClosuresSingleton::getInstance();
        $this->markdown = $dic->refinery()->string()->markdown();
    }

    protected function getSummary(ilADNNotification|\ActiveRecord $item): string
    {
        return $this->markdown->toHTML()->transform(
            $item->getBody()
        );
    }

    public function getNotifications(): array
    {
        return [];
    }

    #[\Override]
    public function getAdministrativeNotifications(): array
    {
        $adns = [];

        $i = fn(string $id): IdentificationInterface => $this->if->identifier($id);
        foreach (ilADNNotification::get() as $item) {
            $adn = $this->notification_factory->administrative($i((string) $item->getId()))->withTitle($item->getTitle())->withSummary(
                $this->getSummary($item)
            );
            $adn = $this->handleDenotation($item, $adn);

            $is_visible = static fn(): bool => true;

            // is limited to roles
            if ($item->isLimitToRoles()) {
                $is_visible = $this->combineClosure($is_visible, fn(): bool => $this->dic->rbac()->review()->isAssignedToAtLeastOneGivenRole(
                    $this->dic->user()->getId(),
                    $item->getLimitedToRoleIds()
                ));
            }

            // is dismissale
            if ($item->getDismissable() && $this->access->isUserLoggedIn()()) {
                $adn = $adn->withClosedCallable(function () use ($item): void {
                    $item->dismiss($this->dic->user());
                });
                $is_visible = $this->combineClosure($is_visible, fn(): bool => !\ilADNDismiss::hasDimissed($this->dic->user(), $item));
            }

            $is_visible = $this->combineClosure($is_visible, fn(): bool => $item->isVisibleForUser($this->dic->user()));

            $adns[] = $adn->withVisibilityCallable($is_visible);
        }
        return $adns;
    }

    private function handleDenotation(
        ilADNNotification $item,
        AdministrativeNotification $adn
    ): AdministrativeNotification {
        $settype = (static fn(int $type, AdministrativeNotification $adn): AdministrativeNotification => match ($type) {
            ilADNNotification::TYPE_ERROR => $adn->withBreakingDenotation(),
            ilADNNotification::TYPE_WARNING => $adn->withImportantDenotation(),
            default => $adn->withNeutralDenotation(),
        });

        // denotation during event
        if (!$item->isPermanent() && $item->isDuringEvent()) {
            return $settype($item->getTypeDuringEvent(), $adn);
        }
        return $settype($item->getType(), $adn);
    }

    private function combineClosure(Closure $closure, ?Closure $additional = null): Closure
    {
        if ($additional instanceof Closure) {
            return static fn(): bool => $additional() && $closure();
        }

        return $closure;
    }
}