SystemStylesGlobalScreenToolProvider.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\GlobalScreen\Scope\Tool\Provider\AbstractDynamicToolProvider;
use  ILIAS\GlobalScreen\Scope\Tool\Factory\Tool;
use ILIAS\UI\Component\Tree\Tree;
use ILIAS\UI\Implementation\Crawler\Entry\ComponentEntries as Entries;
use ILIAS\Data\URI;

class SystemStylesGlobalScreenToolProvider extends AbstractDynamicToolProvider
{
    public function isInterestedInContexts(): \ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection
    {
        return $this->context_collection->administration();
    }

    public function getToolsForContextStack(
        \ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts $called_contexts
    ): array {
        $last_context = $called_contexts->getLast();

        if ($last_context) {
            $additional_data = $last_context->getAdditionalData();
            if ($additional_data->is(ilSystemStyleDocumentationGUI::SHOW_TREE, true)) {
                return [$this->buildTreeAsTool()];
            }
        }

        return [];
    }

    protected function buildTreeAsTool(): Tool
    {
        $id_generator = function ($id) {
            return $this->identification_provider->contextAwareIdentifier($id);
        };

        $title = $this->dic->language()->txt('documentation');
        $icon = $this->dic->ui()->factory()->symbol()->icon()->standard('stys', $title);

        return $this->factory
            ->tool($id_generator('system_styles_tree'))
            ->withTitle($title)
            ->withSymbol($icon)
            ->withContent($this->dic->ui()->factory()->legacy($this->dic->ui()->renderer()->render($this->getUITree())));
    }

    protected function getUITree(): Tree
    {
        $entries = new Entries();
        $entries->addEntriesFromArray(require ilKitchenSinkDataCollectedObjective::PATH());

        $parent_class_hierarchy = ['ilAdministrationGUI',
                                   'ilObjStyleSettingsGUI',
                                   'ilSystemStyleMainGUI',
                                   'ilSystemStyleDocumentationGUI'
        ];

        $parent_link = $this->dic->ctrl()->getLinkTargetByClass($parent_class_hierarchy, 'entries');
        $parent_uri = new URI(ILIAS_HTTP_PATH . '/' . $parent_link);

        $refinery = $this->dic->refinery();
        $request_wrapper = $this->dic->http()->wrapper()->query();
        $current_opened_node_id = '';
        if ($request_wrapper->has('node_id')) {
            $current_opened_node_id = $request_wrapper->retrieve('node_id', $refinery->kindlyTo()->string());
        }

        $recursion = new KSDocumentationTreeRecursion($entries, $parent_uri, $current_opened_node_id);
        $f = $this->dic->ui()->factory();

        return $f->tree()->expandable('Label', $recursion)
                 ->withData([$entries->getRootEntry()])
                 ->withHighlightOnNodeClick(true);
    }
}