SystemStylesGlobalScreenToolProvider Class Reference

Provider for the Tree in the Main Bar Slate showing the UI Components. More...

Inheritance diagram for SystemStylesGlobalScreenToolProvider:

Collaboration diagram for SystemStylesGlobalScreenToolProvider:

Public Member Functions
	isInterestedInContexts ()
	@inheritDoc More...
	getToolsForContextStack (\ILIAS\GlobalScreen\ScreenContext\Stack\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 ()
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Tool\Provider\DynamicToolProvider
	getToolsForContextStack (CalledContexts $called_contexts)
	isInterestedInContexts ()

Protected Member Functions
	buildTreeAsTool ()
	getUITree ()
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

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

Detailed Description

Provider for the Tree in the Main Bar Slate showing the UI Components.

Definition at line 30 of file SystemStylesGlobalScreenToolProvider.php.

Member Function Documentation

buildTreeAsTool()

SystemStylesGlobalScreenToolProvider::buildTreeAsTool ( )

protected

@Todo, replace this with a proper Tree Slate

Definition at line 58 of file SystemStylesGlobalScreenToolProvider.php.

                                        : 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())));
    }

References $id, and ILIAS\GlobalScreen\Scope\Tool\Factory\Tool\withSymbol().

Referenced by getToolsForContextStack().

Here is the call graph for this function:

Here is the caller graph for this function:

getToolsForContextStack()

SystemStylesGlobalScreenToolProvider::getToolsForContextStack

(

\ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts

$called_contexts

)

@inheritDoc

Definition at line 43 of file SystemStylesGlobalScreenToolProvider.php.

     : 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 [];
    }

References buildTreeAsTool(), and ilSystemStyleDocumentationGUI\SHOW_TREE.

Here is the call graph for this function:

getUITree()

SystemStylesGlobalScreenToolProvider::getUITree ( )

protected

Definition at line 77 of file SystemStylesGlobalScreenToolProvider.php.

                                  : Tree
    {
        $entries = new Entries();
        $entries->addEntriesFromArray(include ilSystemStyleDocumentationGUI::DATA_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);
    }

References Vendor\Package\$f, ILIAS\Repository\$refinery, ILIAS\UI\examples\Tree\Expandable\$request_wrapper, and ilSystemStyleDocumentationGUI\DATA_PATH.

isInterestedInContexts()

SystemStylesGlobalScreenToolProvider::isInterestedInContexts

(

)

@inheritDoc

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 35 of file SystemStylesGlobalScreenToolProvider.php.

                                            : \ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection
    {
        return $this->context_collection->administration();
    }

---

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

• Services/Style/System/classes/Provider/SystemStylesGlobalScreenToolProvider.php