ilCOPageEditGSToolProvider Class Reference

Page editing GS tool provider. More...

Inheritance diagram for ilCOPageEditGSToolProvider:

Collaboration diagram for ilCOPageEditGSToolProvider:

Public Member Functions
	isInterestedInContexts ()
	getToolsForContextStack (CalledContexts $called_contexts)
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Tool\Provider\AbstractDynamicToolProvider
	__construct (Container $dic)
	@inheritDoc More...
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (protected Container $dic)
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()
	getToolsForContextStack (CalledContexts $called_contexts)
	isInterestedInContexts ()

Data Fields
const	SHOW_EDITOR = 'copg_show_editor'

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

Page editing GS tool provider.

Author

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

Definition at line 30 of file class.ilCOPageEditGSToolProvider.php.

Member Function Documentation

getContent()

ilCOPageEditGSToolProvider::getContent ( )

private

Definition at line 79 of file class.ilCOPageEditGSToolProvider.php.

                                 : string
    {
        return "<div id='copg-editor-slate-error'></div><div id='copg-editor-slate-content'></div>";
    }

Referenced by getToolsForContextStack().

Here is the caller graph for this function:

getToolsForContextStack()

ilCOPageEditGSToolProvider::getToolsForContextStack

(

CalledContexts

$called_contexts

)

Parameters

CalledContexts

$called_contexts

Returns

Tool[] These Slates can be passed to the MainMenu dynamic for a specific location/context.

See also

DynamicProvider

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

Definition at line 40 of file class.ilCOPageEditGSToolProvider.php.

                                                                            : array
    {
        $tools = [];
        $additional_data = $called_contexts->current()->getAdditionalData();
        if ($additional_data->is(self::SHOW_EDITOR, true)) {
            $title = $this->dic->language()->txt('editor');
            $icon = $this->dic->ui()->factory()->symbol()->icon()->custom(\ilUtil::getImagePath("standard/icon_edtr.svg"), $title);
 
            $iff = function ($id) {
                return $this->identification_provider->contextAwareIdentifier($id);
            };
            $l = function (string $content) {
                return $this->dic->ui()->factory()->legacy()->content($content);
            };
            $identification = $iff("copg_editor");
            $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 "
                                 $('body').on('il-copg-editor-slate', function(){
                                    if (!il.UI.page.isSmallScreen()) {
                                        il.UI.maincontrols.mainbar.engageTool('$hashed');
                                    }
                                 });";
                        });
                    }
                    return $c;
                })
                ->withSymbol($icon)
                ->withTitle($title)
                ->withContent($l($this->getContent()));
        }
 
        return $tools;
    }

References $c, $id, ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), factory(), getContent(), ILIAS\Survey\Mode\getId(), ilUtil\getImagePath(), and ILIAS\GlobalScreen\Scope\MainMenu\Factory\withSymbol().

Here is the call graph for this function:

isInterestedInContexts()

ilCOPageEditGSToolProvider::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 35 of file class.ilCOPageEditGSToolProvider.php.

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

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

Here is the call graph for this function:

Field Documentation

SHOW_EDITOR

const ilCOPageEditGSToolProvider::SHOW_EDITOR = 'copg_show_editor'

Definition at line 33 of file class.ilCOPageEditGSToolProvider.php.

Referenced by ilPageContentGUI\setEditorToolContext(), and ilPageObjectGUI\setEditorToolContext().

---

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

• components/ILIAS/COPage/GlobalScreen/classes/class.ilCOPageEditGSToolProvider.php