Learning module editing GS tool provider. More...

Inheritance diagram for ilLMEditGSToolProvider:

Collaboration diagram for ilLMEditGSToolProvider:

Public Member Functions
	isInterestedInContexts ()

	getToolsForContextStack (CalledContexts $called_contexts)

Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Tool\Provider\AbstractDynamicToolProvider
	__construct (Container $dic)

Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (protected Container $dic)

	getFullyQualifiedClassName ()

	getProviderNameForPresentation ()

Data Fields
const	SHOW_TREE = 'show_tree'

Private Member Functions
	getContent ()

Additional Inherited Members
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Tool\Provider\AbstractDynamicToolProvider
ToolIdentificationProviderInterface	$identification_provider

ContextCollection	$context_collection

ToolFactory	$factory

Detailed Description

Learning module editing GS tool provider.

Author: Alex Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..com

Definition at line 14 of file class.ilLMEditGSToolProvider.php.

Member Function Documentation

◆ getContent()

ilLMEditGSToolProvider::getContent ( )

private

Returns: string

Definition at line 74 of file class.ilLMEditGSToolProvider.php.

References $DIC.

Referenced by getToolsForContextStack().

                                  : string
     {
         global $DIC;
         $request = $DIC->learningModule()
             ->internal()
             ->gui()
             ->editing()
             ->request();
 
         $lm = new ilObjLearningModule($request->getRefId());
 
         $exp = new ilLMEditorExplorerGUI("illmeditorgui", "showTree", $lm);
 
         return $exp->getHTML(true);
     }

Here is the caller graph for this function:

◆ getToolsForContextStack()

ilLMEditGSToolProvider::getToolsForContextStack ( CalledContexts $called_contexts )

Implements ILIAS\GlobalScreen\Scope\Tool\Provider\DynamicToolProvider.

Definition at line 31 of file class.ilLMEditGSToolProvider.php.

References $c, $id, ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), getContent(), ilUtil\getImagePath(), and ILIAS\GlobalScreen\Scope\Footer\Factory\withTitle().

                                                                             : array
     {
         $tools = [];
         $additional_data = $called_contexts->current()->getAdditionalData();
         if ($additional_data->is(self::SHOW_TREE, true)) {
             $title = $this->dic->language()->txt('objs_st');
             $icon = $this->dic->ui()->factory()->symbol()->icon()->custom(\ilUtil::getImagePath("standard/icon_chp.svg"), $title);
 
             $iff = function ($id) {
                 return $this->identification_provider->contextAwareIdentifier($id);
             };
             $l = function (string $content) {
                 return $this->dic->ui()->factory()->legacy($content);
             };
             $identification = $iff("tree");
             $hashed = $this->hash($identification->serialize());
             $tools[] = $this->factory->tool($identification)
                 ->addComponentDecorator(static function (ILIAS\UI\Component\Component $c) use ($hashed): ILIAS\UI\Component\Component {
                     if ($c instanceof LegacySlate) {
                         $signal_id = $c->getToggleSignal()->getId();
                         return $c->withAdditionalOnLoadCode(static function ($id) use ($hashed) {
                             return "document.addEventListener('il-lm-editor-tree', () => {
                                     il.UI.maincontrols.mainbar.engageTool('$hashed');
                                  });";
                         });
                     }
                     return $c;
                 })
                 ->withTitle($title)
                 ->withSymbol($icon)
                 ->withContentWrapper(function () use ($l) {
                     return $l($this->getContent());
                 });
         }
 
         return $tools;
     }

Here is the call graph for this function:

◆ isInterestedInContexts()

ilLMEditGSToolProvider::isInterestedInContexts ( )

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 22 of file class.ilLMEditGSToolProvider.php.

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

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

Here is the call graph for this function:

Field Documentation

◆ SHOW_TREE

const ilLMEditGSToolProvider::SHOW_TREE = 'show_tree'

Definition at line 17 of file class.ilLMEditGSToolProvider.php.

Referenced by ILIAS\LearningModule\Export\LMHtmlExport\__construct(), and ilLMEditorGUI\showTree().

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

components/ILIAS/LearningModule/Editing/GlobalScreen/classes/class.ilLMEditGSToolProvider.php

Public Member Functions

Data Fields

Private Member Functions