MetaBarMainCollector.php

Go to the documentation of this file.

<?php

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

use ILIAS\GlobalScreen\Collector\AbstractBaseCollector;
use ILIAS\GlobalScreen\Collector\ItemCollector;
use ILIAS\GlobalScreen\Scope\MetaBar\Factory\isItem;
use ILIAS\GlobalScreen\Scope\MetaBar\Factory\isParent;
use ILIAS\GlobalScreen\Scope\MetaBar\Provider\StaticMetaBarProvider;
use Generator;

class MetaBarMainCollector extends AbstractBaseCollector implements ItemCollector
{
    private array $providers;
    private array $items = [];

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

    public function collectStructure(): void
    {
        $items_to_merge = [];
        foreach ($this->providers as $provider) {
            $items_to_merge[] = $provider->getMetaBarItems();
        }
        $this->items = array_merge([], ...$items_to_merge);
    }

    public function filterItemsByVisibilty(bool $async_only = false): void
    {
        $this->items = array_filter($this->items, $this->getVisibleFilter());
    }

    public function prepareItemsForUIRepresentation(): void
    {
        // noting to do here
    }

    public function cleanupItemsForUIRepresentation(): void
    {
        // noting to do here
    }

    public function sortItemsForUIRepresentation(): void
    {
        $this->sortItems($this->items);
        array_walk($this->items, $this->getChildSorter());
    }

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

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

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

    private function sortItems(&$items)
    {
        usort($items, $this->getItemSorter());
    }

    private function getItemSorter(): callable
    {
        return static function (isItem $a, isItem $b): int {
            return $a->getPosition() - $b->getPosition();
        };
    }

    private function getChildSorter(): callable
    {
        return function (isItem &$item): void {
            if ($item instanceof isParent) {
                $children = $item->getChildren();
                $this->sortItems($children);
                $item = $item->withChildren($children);
            }
        };
    }

    protected function getVisibleFilter(): callable
    {
        return static function (isItem $item): bool {
            return ($item->isAvailable() && $item->isVisible());
        };
    }
}