MainNotificationCollector.php

Go to the documentation of this file.

<?php

declare(strict_types=1);
namespace ILIAS\GlobalScreen\Scope\Notification\Collector;

use ILIAS\GlobalScreen\Collector\AbstractBaseCollector;
use ILIAS\GlobalScreen\Collector\ItemCollector;
use ILIAS\GlobalScreen\Scope\MainMenu\Collector\Renderer\Hasher;
use ILIAS\GlobalScreen\Scope\Notification\Factory\AdministrativeNotification;
use ILIAS\GlobalScreen\Scope\Notification\Factory\isItem;
use ILIAS\GlobalScreen\Scope\Notification\Factory\StandardNotificationGroup;
use ILIAS\GlobalScreen\Scope\Notification\Provider\NotificationProvider;
use Iterator;
use Generator;

class MainNotificationCollector extends AbstractBaseCollector implements ItemCollector
{
    use Hasher;

    private $providers;
    private $notifications = [];
    private $administrative_notifications = [];

    public function __construct(array $providers)
    {
        $this->providers = $providers;
        $this->collectOnce();
    }

    private function returnNotificationsFromProviders() : Iterator
    {
        foreach ($this->providers as $provider) {
            yield $provider->getNotifications();
        }
    }

    private function returnAdministrativeNotificationsFromProviders() : Iterator
    {
        foreach ($this->providers as $provider) {
            yield $provider->getAdministrativeNotifications();
        }
    }

    public function collectStructure() : void
    {
        $this->notifications = array_merge([], ...iterator_to_array($this->returnNotificationsFromProviders()));
        $this->administrative_notifications = array_merge([], ...iterator_to_array($this->returnAdministrativeNotificationsFromProviders()));
    }

    public function filterItemsByVisibilty(bool $async_only = false) : void
    {
        $this->administrative_notifications = array_filter($this->administrative_notifications, static function (AdministrativeNotification $n) : bool {
            return $n->isVisible();
        });
    }

    public function prepareItemsForUIRepresentation() : void
    {
        // TODO: Implement prepareItemsForUIRepresentation() method.
    }

    public function cleanupItemsForUIRepresentation() : void
    {
        // TODO: Implement cleanupItemsForUIRepresentation() method.
    }

    public function sortItemsForUIRepresentation() : void
    {
        // TODO: Implement sortItemsForUIRepresentation() method.
    }

    public function getItemsForUIRepresentation() : Generator
    {
        yield from $this->notifications;
    }


    public function hasItems() : bool
    {
        return (is_array($this->notifications) && count($this->notifications) > 0);
    }


    public function hasVisibleItems() : bool
    {
        return $this->hasItems();
    }


    public function getAmountOfOldNotifications() : int
    {
        if (is_array($this->notifications)) {
            $count = 0;
            foreach ($this->notifications as $notification) {
                if ($notification instanceof StandardNotificationGroup) {
                    foreach ($notification->getNotifications() as $s_notification) {
                        if ($s_notification->getOldAmount() > 0) {
                            $count++;
                        }
                    }
                } else {
                    if ($notification->getOldAmount() > 0) {
                        $count++;
                    }
                }
            }

            return $count;
        }

        return 0;
    }

    public function getAmountOfNewNotifications() : int
    {
        if (is_array($this->notifications)) {
            $count = 0;
            foreach ($this->notifications as $notification) {
                if ($notification instanceof StandardNotificationGroup) {
                    foreach ($notification->getNotifications() as $s_notification) {
                        if ($s_notification->getNewAmount() > 0) {
                            $count++;
                        }
                    }
                } else {
                    if ($notification->getNewAmount() > 0) {
                        $count++;
                    }
                }
            }

            return $count;
        }

        return 0;
    }

    public function getNotifications() : array
    {
        return $this->notifications;
    }

    public function getAdministrativeNotifications() : array
    {
        return $this->administrative_notifications;
    }

    public function getNotificationsIdentifiersAsArray(bool $hashed = false) : array
    {
        $identifiers = [];
        foreach ($this->notifications as $notification) {
            if ($notification instanceof StandardNotificationGroup) {
                foreach ($notification->getNotifications() as $item) {
                    if ($hashed) {
                        $identifiers[] = $this->hash($item->getProviderIdentification()->serialize());
                    } else {
                        $identifiers[] = $item->getProviderIdentification()->serialize();
                    }
                }
            }
            if ($hashed) {
                $identifiers[] = $this->hash($notification->getProviderIdentification()->serialize());
            } else {
                $identifiers[] = $notification->getProviderIdentification()->serialize();
            }
        }

        return $identifiers;
    }
}