ilCOPageEditGSToolProvider Class Reference

Page editing GS tool provider. More...

Inheritance diagram for ilCOPageEditGSToolProvider:

Collaboration diagram for ilCOPageEditGSToolProvider:

Public Member Functions
	isInterestedInContexts ()
	@inheritDoc More...
	getToolsForContextStack (CalledContexts $called_contexts)
	@inheritDoc More...
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 (Container $dic)
	@inheritDoc More...
	getFullyQualifiedClassName ()
	@inheritDoc More...
	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
	$identification_provider
	$context_collection
	$factory
Protected Attributes inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	$dic

Detailed Description

Page editing GS tool provider.

Author

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

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

Member Function Documentation

getContent()

ilCOPageEditGSToolProvider::getContent ( )

private

Parameters

int

$ref_id

Returns

string

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

                                  : string
    {
        $lng = $this->dic->language();
        $lng->loadLanguageModule("content");
        $tpl = new ilTemplate("tpl.editor_slate.html", true, true, "Services/COPage");
        $tpl->setCurrentBlock("help");
        $tpl->setVariable("TXT_ADD_EL", $lng->txt("cont_add_elements"));
        $tpl->setVariable("PLUS", ilGlyphGUI::get(ilGlyphGUI::ADD));
        $tpl->setVariable("DRAG_ARROW", ilGlyphGUI::get(ilGlyphGUI::DRAG));
        $tpl->setVariable("TXT_DRAG", $lng->txt("cont_drag_and_drop_elements"));
        $tpl->setVariable("TXT_SEL", $lng->txt("cont_double_click_to_delete"));
        $tpl->parseCurrentBlock();
        return $tpl->get();
    }

References $lng, $tpl, ilGlyphGUI\ADD, ilGlyphGUI\DRAG, and ilGlyphGUI\get().

Referenced by getToolsForContextStack().

Here is the call graph for this function:

Here is the caller graph for this function:

getToolsForContextStack()

ilCOPageEditGSToolProvider::getToolsForContextStack

(

CalledContexts

$called_contexts

)

@inheritDoc

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

Definition at line 29 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("outlined/icon_edtr.svg"), $title);
 
            $iff = function ($id) {
                return $this->identification_provider->contextAwareIdentifier($id);
            };
            $l = function (string $content) {
                return $this->dic->ui()->factory()->legacy($content);
            };
            $tools[] = $this->factory->tool($iff("copg_editor"))
                ->withSymbol($icon)
                ->withTitle($title)
                ->withContent($l($this->getContent()));
        }
 
        return $tools;
    }

References ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), getContent(), ilUtil\getImagePath(), and ILIAS\GlobalScreen\Scope\MainMenu\Factory\withSymbol().

Here is the call graph for this function:

isInterestedInContexts()

ilCOPageEditGSToolProvider::isInterestedInContexts

(

)

@inheritDoc

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 20 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 14 of file class.ilCOPageEditGSToolProvider.php.

Referenced by ilPageObjectGUI\edit(), and ilPCDataTableGUI\editData().

---

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

• Services/COPage/GlobalScreen/classes/class.ilCOPageEditGSToolProvider.php