ilLMGSToolProvider Class Reference

Inheritance diagram for ilLMGSToolProvider:

Collaboration diagram for ilLMGSToolProvider:

Public Member Functions
	isInterestedInContexts ()
	getToolsForContextStack (CalledContexts $called_contexts)
	getOfflineToolIds ()
	getTocTool (Collection $additional_data)
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_TOC_TOOL = 'show_toc_tool'
const	SHOW_LINK_SLATES = 'show_link_slates'
const	LM_QUERY_PARAMS = 'lm_query_params'
const	LM_OFFLINE = 'lm_offline'

Protected Member Functions
	getLinkSlateContent (string $type)
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

Private Member Functions
	getToc (Collection $additional_data)

Additional Inherited Members
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Tool\Provider\AbstractDynamicToolProvider
ToolIdentificationProviderInterface	$identification_provider
ContextCollection	$context_collection
ToolFactory	$factory

Detailed Description

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 29 of file class.ilLMGSToolProvider.php.

Member Function Documentation

getLinkSlateContent()

ilLMGSToolProvider::getLinkSlateContent ( string  $type )

protected

Definition at line 213 of file class.ilLMGSToolProvider.php.

Referenced by getToolsForContextStack().

                                                        : string
    {
        return "<div style='height:100%; overflow:hidden;' id='" . $type . "_area'><iframe style='border:0; padding:0; height:100%; width:100%'></iframe></div>";
    }

Here is the caller graph for this function:

getOfflineToolIds()

ilLMGSToolProvider::getOfflineToolIds

(

)

Definition at line 150 of file class.ilLMGSToolProvider.php.

References $id.

                                       : array
    {
        $iff = function ($id) {
            return $this->identification_provider->contextAwareIdentifier($id);
        };
        return [
            $this->hash($iff("lm_pres_toc")->serialize()),
            $this->hash($iff("lm_glossary")->serialize()),
            $this->hash($iff("lm_media")->serialize()),
            $this->hash($iff("lm_faq")->serialize())
        ];
    }

getToc()

ilLMGSToolProvider::getToc ( Collection  $additional_data )

private

Definition at line 189 of file class.ilLMGSToolProvider.php.

References $DIC, $params, $renderer, $service, ILIAS\GlobalScreen\ScreenContext\AdditionalData\Collection\exists(), ILIAS\GlobalScreen\ScreenContext\AdditionalData\Collection\get(), and ILIAS\GlobalScreen\ScreenContext\AdditionalData\Collection\is().

Referenced by getTocTool().

                                                        : string
    {
        global $DIC;

        // get params via additional_data, set query params
        $params = null;
        if ($additional_data->exists(self::LM_QUERY_PARAMS)) {
            $params = $additional_data->get(self::LM_QUERY_PARAMS);
        }
        $offline = $additional_data->is(self::LM_OFFLINE, true);

        if (!is_array($params)) {
            $params = null;
        }
        //try {
        $service = new ilLMPresentationService($DIC->user(), $params, $offline);
        $renderer = new ilLMSlateTocRendererGUI($service);

        return $renderer->render();
        //} catch (Exception $e) {
        //    return $e->getMessage();
        //}
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTocTool()

ilLMGSToolProvider::getTocTool

(

Collection

$additional_data

)

Definition at line 163 of file class.ilLMGSToolProvider.php.

References $DIC, $id, $lng, ilUtil\getImagePath(), getToc(), and ILIAS\GlobalScreen\Scope\MainMenu\Factory\withSymbol().

Referenced by getToolsForContextStack().

     : Tool {
        global $DIC;

        $lng = $DIC->language();

        $iff = function ($id) {
            return $this->identification_provider->contextAwareIdentifier($id);
        };
        $l = function (string $content) {
            return $this->dic->ui()->factory()->legacy($content);
        };

        $title = $lng->txt("cont_toc");
        $icon = $DIC->ui()->factory()->symbol()->icon()->custom(\ilUtil::getImagePath("standard/icon_chp.svg"), $title);
        return $this->factory->tool($iff("lm_pres_toc"))
            ->withTitle($title)
            ->withContentWrapper(function () use ($l, $additional_data) {
                return $l($this->getToc($additional_data));
            })
            ->withSymbol($icon)
            ->withPosition(10);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getToolsForContextStack()

ilLMGSToolProvider::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 43 of file class.ilLMGSToolProvider.php.

References $c, $DIC, $id, $lng, $ref_id, ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), ilUtil\getImagePath(), getLinkSlateContent(), getTocTool(), and ILIAS\GlobalScreen\Scope\MainMenu\Factory\withSymbol().

     : array {
        global $DIC;
        $lng = $DIC->language();
        $access = $DIC->access();

        $lng->loadLanguageModule("content");

        $tools = [];
        $additional_data = $called_contexts->current()->getAdditionalData();
        $iff = function ($id) {
            return $this->identification_provider->contextAwareIdentifier($id);
        };
        $l = function (string $content) {
            return $this->dic->ui()->factory()->legacy($content);
        };

        if ($additional_data->is(self::SHOW_TOC_TOOL, true)) {
            $ref_id = $called_contexts->current()->getReferenceId()->toInt();

            if (!$access->checkAccess("read", "", $ref_id)) {
                return $tools;
            }

            $tools[] = $this->getTocTool($additional_data);
        }

        if ($additional_data->is(self::SHOW_LINK_SLATES, true)) {
            $title = $lng->txt("obj_glo");
            $icon = $DIC->ui()->factory()->symbol()->icon()->custom(\ilUtil::getImagePath("standard/icon_glo.svg"), $title);
            $identification = $iff("lm_glossary");
            $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-show-glossary-slate', function(){
                                                     il.UI.maincontrols.mainbar.engageTool('$hashed');
                                                 });";
                        });
                    }
                    return $c;
                })
                ->withInitiallyHidden(true)
                ->withTitle($title)
                ->withContentWrapper(function () use ($l) {
                    return $l($this->getLinkSlateContent("glossary"));
                })
                ->withSymbol($icon)
                ->withPosition(11);

            $title = $lng->txt("cont_tool_media");
            $icon = $DIC->ui()->factory()->symbol()->icon()->custom(\ilUtil::getImagePath("standard/icon_mdia.svg"), $title);
            $identification = $iff("lm_media");
            $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-show-media-slate', function(){
                                                     il.UI.maincontrols.mainbar.engageTool('$hashed');
                                                 });";
                        });
                    }
                    return $c;
                })
                ->withInitiallyHidden(true)
                ->withTitle($title)
                ->withContentWrapper(function () use ($l) {
                    return $l($this->getLinkSlateContent("media"));
                })
                ->withSymbol($icon)
                ->withPosition(12);

            $title = $lng->txt("cont_tool_faq");
            $icon = $DIC->ui()->factory()->symbol()->icon()->custom(\ilUtil::getImagePath("standard/icon_faq.svg"), $title);
            $identification = $iff("lm_faq");
            $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-show-faq-slate', function(){
                                                     il.UI.maincontrols.mainbar.engageTool('$hashed');
                                                 });";
                        });
                    }
                    return $c;
                })
                ->withInitiallyHidden(true)
                ->withTitle($title)
                ->withContentWrapper(function () use ($l) {
                    return $l($this->getLinkSlateContent("faq"));
                })
                ->withSymbol($icon)
                ->withPosition(13);
        }
        return $tools;
    }

Here is the call graph for this function:

isInterestedInContexts()

ilLMGSToolProvider::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 38 of file class.ilLMGSToolProvider.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

LM_OFFLINE

const ilLMGSToolProvider::LM_OFFLINE = 'lm_offline'

Definition at line 36 of file class.ilLMGSToolProvider.php.

Referenced by ILIAS\LearningModule\Export\LMHtmlExport\initScreen().

LM_QUERY_PARAMS

const ilLMGSToolProvider::LM_QUERY_PARAMS = 'lm_query_params'

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

Referenced by ilLMPresentationGUI\__construct(), and ILIAS\LearningModule\Export\LMHtmlExport\initScreen().

SHOW_LINK_SLATES

const ilLMGSToolProvider::SHOW_LINK_SLATES = 'show_link_slates'

Definition at line 34 of file class.ilLMGSToolProvider.php.

Referenced by ilLMPresentationGUI\__construct().

SHOW_TOC_TOOL

const ilLMGSToolProvider::SHOW_TOC_TOOL = 'show_toc_tool'

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

Referenced by ilLMPresentationGUI\__construct().

---

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

• components/ILIAS/LearningModule/Presentation/GlobalScreen/classes/class.ilLMGSToolProvider.php