ILIAS\LTI\Screen\LtiViewLayoutProvider Class Reference

Class LtiViewLayoutProvider. More...

Inheritance diagram for ILIAS\LTI\Screen\LtiViewLayoutProvider:

Collaboration diagram for ILIAS\LTI\Screen\LtiViewLayoutProvider:

Public Member Functions
	isInterestedInContexts ()
	getPageBuilderDecorator (CalledContexts $screen_context_stack)
	getMainBarModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getMetaBarModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getTitleModification (CalledContexts $screen_context_stack)
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
	__construct (Container $dic)
	@inheritDoc More...
	getContentModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getLogoModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getResponsiveLogoModification (CalledContexts $screen_context_stack)
	getMainBarModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getMetaBarModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getBreadCrumbsModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getFooterModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getPageBuilderDecorator (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getTitleModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getShortTitleModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getViewTitleModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (Container $dic)
	@inheritDoc More...
	getFullyQualifiedClassName ()
	@inheritDoc More...
	getProviderNameForPresentation ()
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()
	getContentModification (CalledContexts $screen_context_stack)
	getLogoModification (CalledContexts $screen_context_stack)
	getResponsiveLogoModification (CalledContexts $screen_context_stack)
	getMainBarModification (CalledContexts $screen_context_stack)
	getMetaBarModification (CalledContexts $screen_context_stack)
	getBreadCrumbsModification (CalledContexts $screen_context_stack)
	getFooterModification (CalledContexts $screen_context_stack)
	getPageBuilderDecorator (CalledContexts $screen_context_stack)
	getTitleModification (CalledContexts $screen_context_stack)
	getShortTitleModification (CalledContexts $screen_context_stack)
	getViewTitleModification (CalledContexts $screen_context_stack)
	isInterestedInContexts ()

Data Fields
const	GS_EXIT_LTI = 'lti_exit_mode'

Protected Member Functions
	isLTIExitMode (CalledContexts $screen_context_stack)
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

Additional Inherited Members
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
ContextCollection	$context_collection
ILIAS GlobalScreen Scope Layout Factory ModificationFactory	$factory
Protected Attributes inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
Container	$dic

Detailed Description

Class LtiViewLayoutProvider.

Author

Stefan Schneider schne.nosp@m.ider.nosp@m.@hrz..nosp@m.uni-.nosp@m.marbu.nosp@m.rg.d.nosp@m.e

Definition at line 42 of file LtiViewLayoutProvider.php.

Member Function Documentation

getMainBarModification()

ILIAS\LTI\Screen\LtiViewLayoutProvider::getMainBarModification

(

CalledContexts

$screen_context_stack

)

@inheritDoc

Reimplemented from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider.

Definition at line 92 of file LtiViewLayoutProvider.php.

                                                                                : ?MainBarModification
    {
        $is_exit_mode = $this->isLTIExitMode($screen_context_stack);
 
        return $this->globalScreen()->layout()->factory()->mainbar()
                    ->withModification(
                        function (?MainBar $mainbar) use ($is_exit_mode): ?MainBar {
                            $tools = $mainbar->getToolEntries();
                            $mainbar = $mainbar->withClearedEntries();
                            if ($is_exit_mode) {
                                return $mainbar;
                            }
                            foreach ($tools as $id => $entry) {
                                $mainbar = $mainbar->withAdditionalToolEntry($id, $entry);
                            }
                            //$mainbar = $mainbar->withAdditionalEntry('lti_home', $lti_home);
                            return $mainbar;
                        }
                    )
                    ->withHighPriority();
    }

References $id, ILIAS\UI\Component\MainControls\MainBar\getToolEntries(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), ILIAS\LTI\Screen\LtiViewLayoutProvider\isLTIExitMode(), ILIAS\UI\Component\MainControls\MainBar\withAdditionalToolEntry(), and ILIAS\UI\Component\MainControls\MainBar\withClearedEntries().

Here is the call graph for this function:

getMetaBarModification()

ILIAS\LTI\Screen\LtiViewLayoutProvider::getMetaBarModification

(

CalledContexts

$screen_context_stack

)

@inheritDoc

Reimplemented from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider.

Definition at line 117 of file LtiViewLayoutProvider.php.

                                                                                : ?MetaBarModification
    {
        $is_exit_mode = $this->isLTIExitMode($screen_context_stack);
 
        return $this->globalScreen()->layout()->factory()->metabar()
                    ->withModification(
                        function (?MetaBar $metabar) use ($is_exit_mode, $screen_context_stack): ?Metabar {
                            $metabar = $metabar->withClearedEntries();
                            if ($is_exit_mode) {
                                return $metabar;
                            }
                            $f = $this->dic->ui()->factory();
                            $exit_symbol = $f->symbol()->glyph()->close();
                            $exit_txt = $this->dic['lti']->lng->txt('lti_exit');
                            $exit = $f->button()->bulky($exit_symbol, $exit_txt, $this->dic["lti"]->getCmdLink('exit'));
                            $metabar = $metabar->withAdditionalEntry('exit', $exit);
                            return $metabar;
                        }
                    )
                    ->withHighPriority();
    }

References Vendor\Package\$f, ILIAS\UI\examples\Symbol\Glyph\Close\close(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), ILIAS\LTI\Screen\LtiViewLayoutProvider\isLTIExitMode(), ILIAS\UI\Component\MainControls\MetaBar\withAdditionalEntry(), and ILIAS\UI\Component\MainControls\MetaBar\withClearedEntries().

Here is the call graph for this function:

getPageBuilderDecorator()

ILIAS\LTI\Screen\LtiViewLayoutProvider::getPageBuilderDecorator

(

CalledContexts

$screen_context_stack

)

Parameters

CalledContexts

$screen_context_stack

@inheritDoc

Returns

\ILIAS\GlobalScreen\Scope\Layout\Factory\ContentModification|\ILIAS\GlobalScreen\Scope\Layout\Factory\LayoutModification|null

Reimplemented from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider.

Definition at line 56 of file LtiViewLayoutProvider.php.

                                                                                 : ?PageBuilderModification
    {
        $this->globalScreen()->layout()->meta()->addCss('./Services/LTI/templates/default/lti.css');
        $is_exit_mode = $this->isLTIExitMode($screen_context_stack);
        $external_css = ($is_exit_mode) ? '' : $this->dic["lti"]->getExternalCss();
        if ($external_css !== '') {
            $this->globalScreen()->layout()->meta()->addCss($external_css);
        }
 
        return $this->factory->page()
                             ->withModification(
                                 function (PagePartProvider $parts): Page {
                                     $p = new StandardPageBuilder();
                                     $page = $p->build($parts);
 
                                     $mv_modeinfo = MemberViewLayoutProvider::getMemberViewModeInfo($this->dic);
                                     if ($mv_modeinfo) {
                                         $page = $page->withModeInfo($mv_modeinfo);
                                     }
 
                                     return $page->withNoFooter();
                                 }
                             )
                             ->withHighPriority();
    }

References $parts, ILIAS\Container\Screen\MemberViewLayoutProvider\getMemberViewModeInfo(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), and ILIAS\LTI\Screen\LtiViewLayoutProvider\isLTIExitMode().

Here is the call graph for this function:

getTitleModification()

ILIAS\LTI\Screen\LtiViewLayoutProvider::getTitleModification

(

CalledContexts

$screen_context_stack

)

Parameters

CalledContexts

$screen_context_stack

Returns

\ILIAS\GlobalScreen\Scope\Layout\Factory\ContentModification|\ILIAS\GlobalScreen\Scope\Layout\Factory\LayoutModification|null

Reimplemented from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider.

Definition at line 143 of file LtiViewLayoutProvider.php.

                                                                              : ?TitleModification
    {
        $is_exit_mode = $this->isLTIExitMode($screen_context_stack);
 
        return $this->globalScreen()->layout()->factory()->title()
                    ->withModification(
                        function (?string $content) use ($is_exit_mode): string {
                            if ($is_exit_mode) {
                                return $this->dic["lti"]->getTitleForExitPage();
                            }
                            return $this->dic["lti"]->getTitle();
                        }
                    )
                    ->withHighPriority();
    }

References ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), and ILIAS\LTI\Screen\LtiViewLayoutProvider\isLTIExitMode().

Here is the call graph for this function:

isInterestedInContexts()

ILIAS\LTI\Screen\LtiViewLayoutProvider::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 46 of file LtiViewLayoutProvider.php.

                                            : ContextCollection
    {
        return $this->context_collection->lti();
    }

References ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\lti().

Here is the call graph for this function:

isLTIExitMode()

ILIAS\LTI\Screen\LtiViewLayoutProvider::isLTIExitMode ( CalledContexts  $screen_context_stack )

protected

Definition at line 82 of file LtiViewLayoutProvider.php.

                                                                          : bool
    {
        $data_collection = $screen_context_stack->current()->getAdditionalData();
        $is_exit_mode = $data_collection->is(self::GS_EXIT_LTI, true);
        return $is_exit_mode;
    }

References ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current().

Referenced by ILIAS\LTI\Screen\LtiViewLayoutProvider\getMainBarModification(), ILIAS\LTI\Screen\LtiViewLayoutProvider\getMetaBarModification(), ILIAS\LTI\Screen\LtiViewLayoutProvider\getPageBuilderDecorator(), and ILIAS\LTI\Screen\LtiViewLayoutProvider\getTitleModification().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

GS_EXIT_LTI

const ILIAS\LTI\Screen\LtiViewLayoutProvider::GS_EXIT_LTI = 'lti_exit_mode'

Definition at line 44 of file LtiViewLayoutProvider.php.

---

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

• Services/LTI/classes/Screen/LtiViewLayoutProvider.php