ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider Class Reference

Inheritance diagram for ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider:

Collaboration diagram for ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider:

Public Member Functions
	__construct (Container $dic)
	isInterestedInContexts ()
	getMetaBarModification (CalledContexts $screen_context_stack)
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
	__construct (Container $dic)
	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)
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (protected Container $dic)
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()

Data Fields
const	EMBEDDED_APPLICATION = 'embedded_application'

Protected Member Functions
	buildCloseButton (EmbeddedApplication $embedded_application,)
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

Private Attributes
const	USE_METABAR = 1
const	USE_MODE_INFO = 2
int	$display_mode = self::USE_MODE_INFO
readonly SignalGeneratorInterface	$signal_generator

Additional Inherited Members
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
ContextCollection	$context_collection
DataFactory	$data
ModificationFactory	$factory

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 41 of file EmbeddedApplicationGSProvider.php.

Constructor & Destructor Documentation

__construct()

ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider::__construct

(

Container

$dic

)

Definition at line 55 of file EmbeddedApplicationGSProvider.php.

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

    {
        parent::__construct($dic);
        global $DIC;
        $this->signal_generator = $DIC["ui.signal_generator"];
    }

Here is the call graph for this function:

Member Function Documentation

buildCloseButton()

ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider::buildCloseButton ( EmbeddedApplication  $embedded_application )

protected

Definition at line 147 of file EmbeddedApplicationGSProvider.php.

References $id, and ILIAS\components\WOPI\Embed\EmbeddedApplication\getBackTarget().

Referenced by ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider\getMetaBarModification().

     : Bulky {
        $uif = $this->dic->ui()->factory();
        $back_target = $embedded_application->getBackTarget();
        $signal = $this->signal_generator->create();
        $signal->addOption('target_url', (string) $back_target);
        return $uif->button()->bulky(
            $uif->symbol()->glyph()->close(),
            $this->dic->language()->txt('close'),
            (string) $back_target
        )->withOnClick(
            $signal
        )->withOnLoadCode(fn($id): string => "il.WOPI.bindCloseSignal('$id', '{$signal->getId()}');");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMetaBarModification()

ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider::getMetaBarModification

(

CalledContexts

$screen_context_stack

)

Parameters

CalledContexts

$screen_context_stack

Returns

MetaBarModification|null

Implements ILIAS\GlobalScreen\Scope\Layout\Provider\ModificationProvider.

Definition at line 114 of file EmbeddedApplicationGSProvider.php.

References ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider\buildCloseButton(), ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), factory(), null, and ILIAS\UI\Component\MainControls\MetaBar\withClearedEntries().

                                                                                : ?MetaBarModification
    {
        if ($this->display_mode !== self::USE_METABAR) {
            return null;
        }
        if (!$screen_context_stack->current()->getAdditionalData()->exists(self::EMBEDDED_APPLICATION)) {
            return null;
        }

        $embedded_application = $screen_context_stack->current()->getAdditionalData()->get(
            self::EMBEDDED_APPLICATION
        );
        if (!$embedded_application instanceof EmbeddedApplication) {
            return null;
        }

        if ($embedded_application->isInline()) {
            return null;
        }

        $button = $this->buildCloseButton($embedded_application);

        return $this->factory->metabar()->withHighPriority()->withModification(
            fn(?MetaBar $metabar): ?Metabar => $metabar !== null
                ? $metabar->withClearedEntries()
                          ->withAdditionalEntry(
                              'close_editor',
                              $button
                          )
                : null
        );
    }

Here is the call graph for this function:

isInterestedInContexts()

ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 62 of file EmbeddedApplicationGSProvider.php.

References ilWOPIEmbeddedApplicationGUI\CMD_RETURN, ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), factory(), ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider\getPageBuilderDecorator(), null, and ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\repository().

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

Here is the call graph for this function:

Field Documentation

$display_mode

int ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider::$display_mode = self::USE_MODE_INFO

private

Definition at line 51 of file EmbeddedApplicationGSProvider.php.

$signal_generator

readonly SignalGeneratorInterface ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider::$signal_generator

private

Definition at line 53 of file EmbeddedApplicationGSProvider.php.

EMBEDDED_APPLICATION

const ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider::EMBEDDED_APPLICATION = 'embedded_application'

Definition at line 52 of file EmbeddedApplicationGSProvider.php.

USE_METABAR

const ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider::USE_METABAR = 1

private

Definition at line 46 of file EmbeddedApplicationGSProvider.php.

USE_MODE_INFO

const ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider::USE_MODE_INFO = 2

private

Definition at line 50 of file EmbeddedApplicationGSProvider.php.

---

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

• components/ILIAS/WOPI/classes/Embed/EmbeddedApplicationGSProvider.php