AbstractBaseCollector.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\GlobalScreen\Collector;

abstract class AbstractBaseCollector implements Collector
{
    private bool $has_been_collected = false;

    private function setCollected(): void
    {
        $this->has_been_collected = true;
    }

    public function hasBeenCollected(): bool
    {
        return $this->has_been_collected;
    }

    public function collectOnce(): void
    {
        if (!$this->hasBeenCollected()) {
            $this->collectStructure();
            $this->prepareItemsForUIRepresentation();
            $this->filterItemsByVisibilty();
            $this->cleanupItemsForUIRepresentation();
            $this->sortItemsForUIRepresentation();
            $this->setCollected();
        }
    }

    public function collectStructure(): void
    {
    }

    public function prepareItemsForUIRepresentation(): void
    {
    }

    public function filterItemsByVisibilty(): void
    {
    }

    public function cleanupItemsForUIRepresentation(): void
    {
    }

    public function sortItemsForUIRepresentation(): void
    {
    }

}