ModificationHandler.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\GlobalScreen\Scope\Layout;

use Closure;
use ILIAS\GlobalScreen\Scope\Layout\Builder\DecoratedPageBuilder;
use ILIAS\GlobalScreen\Scope\Layout\Builder\StandardPageBuilder;
use ILIAS\GlobalScreen\Scope\Layout\Provider\PagePart\DecoratedPagePartProvider;
use ILIAS\GlobalScreen\Scope\Layout\Provider\PagePart\StandardPagePartProvider;
use ILIAS\GlobalScreen\SingletonTrait;
use ILIAS\UI\Component\Breadcrumbs\Breadcrumbs;
use ILIAS\UI\Component\Layout\Page\Page;
use ILIAS\UI\Component\Legacy\Content;
use ILIAS\UI\Component\MainControls\Footer;
use ILIAS\UI\Component\MainControls\MainBar;
use ILIAS\UI\Component\MainControls\MetaBar;

class ModificationHandler
{
    use SingletonTrait;

    private StandardPageBuilder|DecoratedPageBuilder $current_page_builder;
    private StandardPagePartProvider|DecoratedPagePartProvider $current_page_part_provider;

    public function __construct()
    {
        $this->current_page_builder = new StandardPageBuilder();
        $this->current_page_part_provider = new StandardPagePartProvider();
    }




    //
    // Modifiers
    //
    public function modifyPageWithClosure(Closure $closure_returning_page): void
    {
        $this->current_page_builder = new DecoratedPageBuilder($this->current_page_builder, $closure_returning_page);
    }

    public function modifyContentWithClosure(Closure $closure_returning_content): void
    {
        $this->replaceWithAutoWiredInstance(Content::class, $closure_returning_content);
    }

    public function modifyMainBarWithClosure(Closure $closure_returning_main_bar): void
    {
        $this->replaceWithAutoWiredInstance(MainBar::class, $closure_returning_main_bar);
    }

    public function modifyMetaBarWithClosure(Closure $closure_returning_meta_bar): void
    {
        $this->replaceWithAutoWiredInstance(MetaBar::class, $closure_returning_meta_bar);
    }

    public function modifyLogoWithClosure(Closure $closure_returning_image): void
    {
        $this->replaceWithAutoWiredInstance(DecoratedPagePartProvider::PURPOSE_LOGO, $closure_returning_image);
    }

    public function modifyResponsiveLogoWithClosure(Closure $closure_returning_image): void
    {
        $this->replaceWithAutoWiredInstance(
            DecoratedPagePartProvider::PURPOSE_RESPONSIVE_LOGO,
            $closure_returning_image
        );
    }

    public function modifyBreadCrumbsWithClosure(Closure $closure_returning_breadcrumbs): void
    {
        $this->replaceWithAutoWiredInstance(Breadcrumbs::class, $closure_returning_breadcrumbs);
    }

    public function modifyPageBuilderWithClosure(Closure $closure_returning_page): void
    {
        $this->current_page_builder = new DecoratedPageBuilder($this->current_page_builder, $closure_returning_page);
    }

    public function modifyFooterWithClosure(Closure $closure_returning_footer): void
    {
        $this->replaceWithAutoWiredInstance(Footer::class, $closure_returning_footer);
    }

    public function getPageWithPagePartProviders(): Page
    {
        return $this->current_page_builder->build($this->current_page_part_provider);
    }

    public function modifyTitleWithClosure(Closure $closure_returning_title): void
    {
        $this->replaceWithAutoWiredInstance(
            DecoratedPagePartProvider::PURPOSE_TITLE,
            $closure_returning_title
        );
    }

    public function modifyShortTitleWithClosure(Closure $closure_returning_short_title): void
    {
        $this->replaceWithAutoWiredInstance(
            DecoratedPagePartProvider::PURPOSE_SHORTTITLE,
            $closure_returning_short_title
        );
    }

    public function modifyViewTitleWithClosure(Closure $closure_returning_view_title): void
    {
        $this->replaceWithAutoWiredInstance(
            DecoratedPagePartProvider::PURPOSE_VIEWTITLE,
            $closure_returning_view_title
        );
    }

    private function replaceWithAutoWiredInstance(string $interface, Closure $closure): void
    {
        $this->current_page_part_provider = new DecoratedPagePartProvider($this->current_page_part_provider, $closure, $interface);
    }
}