DashboardLayoutProvider.php

Go to the documentation of this file.

<?php

use ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider;
use ILIAS\GlobalScreen\Scope\Layout\Provider\ModificationProvider;
use ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection;
use ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts;
use ILIAS\GlobalScreen\Scope\Layout\Factory\MainBarModification;
use ILIAS\UI\Component\MainControls\MainBar;
use ILIAS\GlobalScreen\ScreenContext\AdditionalData\Collection;

class DashboardLayoutProvider extends AbstractModificationProvider implements ModificationProvider
{
    protected ?Collection $data_collection;

    public function isInterestedInContexts(): ContextCollection
    {
        return $this->context_collection->desktop();
    }

    public function getMainBarModification(CalledContexts $screen_context_stack): ?MainBarModification
    {
        $this->data_collection = $screen_context_stack->current()->getAdditionalData();
        if (!$this->data_collection->is(\ilDashboardGUI::DISENGAGE_MAINBAR, true)) {
            return null;
        }

        return $this->globalScreen()->layout()->factory()->mainbar()
            ->withModification(
                function (?MainBar $mainbar): ?MainBar {
                    return $mainbar !== null ? $mainbar->withActive($mainbar::NONE_ACTIVE) : null;
                }
            )
            ->withLowPriority();
    }
}