Class ModifierServices. More...

Collaboration diagram for ILIAS\GlobalScreen\Scope\Layout\ModificationHandler:

Public Member Functions
	__construct ()
	LayoutServices constructor. More...

	modifyPageWithClosure (Closure $closure_returning_page)

	modifyContentWithClosure (Closure $closure_returning_content)

	modifyMainBarWithClosure (Closure $closure_returning_main_bar)

	modifyMetaBarWithClosure (Closure $closure_returning_meta_bar)

	modifyLogoWithClosure (Closure $closure_returning_image)

	modifyResponsiveLogoWithClosure (Closure $closure_returning_image)

	modifyBreadCrumbsWithClosure (Closure $closure_returning_breadcrumbs)

	modifyPageBuilderWithClosure (Closure $closure_returning_page)

	modifyFooterWithClosure (Closure $closure_returning_footer)

	getPageWithPagePartProviders ()

	modifyTitleWithClosure (Closure $closure_returning_title)

	modifyShortTitleWithClosure (Closure $closure_returning_short_title)

	modifyViewTitleWithClosure (Closure $closure_returning_view_title)

Private Member Functions
	replaceWithAutoWiredInstance (string $interface, Closure $closure)

Private Attributes
StandardPageBuilder DecoratedPageBuilder	$current_page_builder

StandardPagePartProvider DecoratedPagePartProvider	$current_page_part_provider

Detailed Description

Class ModifierServices.

Definition at line 41 of file ModificationHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::__construct ( )

LayoutServices constructor.

Definition at line 51 of file ModificationHandler.php.

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

Member Function Documentation

◆ getPageWithPagePartProviders()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::getPageWithPagePartProviders ( )

Returns: Page

Definition at line 146 of file ModificationHandler.php.

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

◆ modifyBreadCrumbsWithClosure()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::modifyBreadCrumbsWithClosure ( Closure $closure_returning_breadcrumbs )

Parameters

Closure $closure_returning_breadcrumbs Have a look at the README.md for an example.

Definition at line 122 of file ModificationHandler.php.

References ILIAS\GlobalScreen\Scope\Layout\ModificationHandler\replaceWithAutoWiredInstance().

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

Here is the call graph for this function:

◆ modifyContentWithClosure()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::modifyContentWithClosure ( Closure $closure_returning_content )

Parameters

Closure $closure_returning_content Have a look at the README.md for an example.

Definition at line 78 of file ModificationHandler.php.

References ILIAS\GlobalScreen\Scope\Layout\ModificationHandler\replaceWithAutoWiredInstance().

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

Here is the call graph for this function:

◆ modifyFooterWithClosure()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::modifyFooterWithClosure ( Closure $closure_returning_footer )

Parameters

Closure $closure_returning_footer

Definition at line 138 of file ModificationHandler.php.

References ILIAS\GlobalScreen\Scope\Layout\ModificationHandler\replaceWithAutoWiredInstance().

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

Here is the call graph for this function:

◆ modifyLogoWithClosure()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::modifyLogoWithClosure ( Closure $closure_returning_image )

Parameters

Closure $closure_returning_image Have a look at the README.md for an example.

Definition at line 105 of file ModificationHandler.php.

References ILIAS\GlobalScreen\Scope\Layout\Provider\PagePart\DecoratedPagePartProvider\PURPOSE_LOGO, and ILIAS\GlobalScreen\Scope\Layout\ModificationHandler\replaceWithAutoWiredInstance().

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

Here is the call graph for this function:

◆ modifyMainBarWithClosure()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::modifyMainBarWithClosure ( Closure $closure_returning_main_bar )

Parameters

Closure $closure_returning_main_bar Have a look at the README.md for an example.

Definition at line 87 of file ModificationHandler.php.

References ILIAS\GlobalScreen\Scope\Layout\ModificationHandler\replaceWithAutoWiredInstance().

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

Here is the call graph for this function:

◆ modifyMetaBarWithClosure()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::modifyMetaBarWithClosure ( Closure $closure_returning_meta_bar )

Parameters

Closure $closure_returning_meta_bar Have a look at the README.md for an example.

Definition at line 96 of file ModificationHandler.php.

References ILIAS\GlobalScreen\Scope\Layout\ModificationHandler\replaceWithAutoWiredInstance().

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

Here is the call graph for this function:

◆ modifyPageBuilderWithClosure()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::modifyPageBuilderWithClosure ( Closure $closure_returning_page )

Parameters

Closure $closure_returning_page

Definition at line 130 of file ModificationHandler.php.

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

◆ modifyPageWithClosure()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::modifyPageWithClosure ( Closure $closure_returning_page )

Parameters

Closure $closure_returning_page You can pass a Closure which will get the Page as the first argument and MUST return a Page as well. Have a look at the README.md for an example.

Definition at line 69 of file ModificationHandler.php.

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

◆ modifyResponsiveLogoWithClosure()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::modifyResponsiveLogoWithClosure ( Closure $closure_returning_image )

Definition at line 110 of file ModificationHandler.php.

References ILIAS\GlobalScreen\Scope\Layout\Provider\PagePart\DecoratedPagePartProvider\PURPOSE_RESPONSIVE_LOGO, and ILIAS\GlobalScreen\Scope\Layout\ModificationHandler\replaceWithAutoWiredInstance().

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

Here is the call graph for this function:

◆ modifyShortTitleWithClosure()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::modifyShortTitleWithClosure ( Closure $closure_returning_short_title )

Definition at line 159 of file ModificationHandler.php.

References ILIAS\GlobalScreen\Scope\Layout\Provider\PagePart\DecoratedPagePartProvider\PURPOSE_SHORTTITLE, and ILIAS\GlobalScreen\Scope\Layout\ModificationHandler\replaceWithAutoWiredInstance().

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

Here is the call graph for this function:

◆ modifyTitleWithClosure()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::modifyTitleWithClosure ( Closure $closure_returning_title )

Definition at line 151 of file ModificationHandler.php.

References ILIAS\GlobalScreen\Scope\Layout\Provider\PagePart\DecoratedPagePartProvider\PURPOSE_TITLE, and ILIAS\GlobalScreen\Scope\Layout\ModificationHandler\replaceWithAutoWiredInstance().

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

Here is the call graph for this function:

◆ modifyViewTitleWithClosure()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::modifyViewTitleWithClosure ( Closure $closure_returning_view_title )

Definition at line 167 of file ModificationHandler.php.

References ILIAS\GlobalScreen\Scope\Layout\Provider\PagePart\DecoratedPagePartProvider\PURPOSE_VIEWTITLE, and ILIAS\GlobalScreen\Scope\Layout\ModificationHandler\replaceWithAutoWiredInstance().

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

Here is the call graph for this function:

◆ replaceWithAutoWiredInstance()

ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::replaceWithAutoWiredInstance	(	string	$interface,
		Closure	$closure
	)

private

Parameters

string	$interface
Closure	$closure

Definition at line 179 of file ModificationHandler.php.

                                                                                       : void
     {
         $this->current_page_part_provider = new DecoratedPagePartProvider($this->current_page_part_provider, $closure, $interface);
     }

Here is the caller graph for this function:

Field Documentation

◆ $current_page_builder

StandardPageBuilder DecoratedPageBuilder ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::$current_page_builder

private

Definition at line 45 of file ModificationHandler.php.

◆ $current_page_part_provider

StandardPagePartProvider DecoratedPagePartProvider ILIAS\GlobalScreen\Scope\Layout\ModificationHandler::$current_page_part_provider

private

Definition at line 46 of file ModificationHandler.php.

The documentation for this class was generated from the following file:

components/ILIAS/GlobalScreen/src/Scope/Layout/ModificationHandler.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getPageWithPagePartProviders()

◆ modifyBreadCrumbsWithClosure()

◆ modifyContentWithClosure()

◆ modifyFooterWithClosure()

◆ modifyLogoWithClosure()

◆ modifyMainBarWithClosure()

◆ modifyMetaBarWithClosure()

◆ modifyPageBuilderWithClosure()

◆ modifyPageWithClosure()

◆ modifyResponsiveLogoWithClosure()

◆ modifyShortTitleWithClosure()

◆ modifyTitleWithClosure()

◆ modifyViewTitleWithClosure()

◆ replaceWithAutoWiredInstance()

Field Documentation

◆ $current_page_builder

◆ $current_page_part_provider