ILIAS\UI\HelpTextRetriever Interface Reference

This describes a facility that the UI framework can use to retrieve some help text. More...

Inheritance diagram for ILIAS\UI\HelpTextRetriever:

Collaboration diagram for ILIAS\UI\HelpTextRetriever:

Public Member Functions
	getHelpText (Help\Purpose $purpose, Help\Topic ... $topics)
	Try to find according help texts for the purpose an topics. More...

Detailed Description

This describes a facility that the UI framework can use to retrieve some help text.

The general idea is, that components can be marked with help topics. During rendering, the UI framework will try to find according help texts via this facility. There neither needs to be a guarantee, that a text exists for a certain topic, nor the guarantee that all texts that can be provided are actually used.

This will allow to move the actual retrieval of help texts out of the components that use the UI framework. Also, it will allow to implement this interface with different strategies. It is especially possible to implement this over the current learning modul mechanism. But it will also be possible to implement alternative mechanisms via plugins.

Definition at line 39 of file HelpTextRetriever.php.

Member Function Documentation

getHelpText()

ILIAS\UI\HelpTextRetriever::getHelpText	(	Help\Purpose	$purpose,
		Help\Topic ...	$topics
	)

Try to find according help texts for the purpose an topics.

The result is expected to be sorted by relevance, where more relevant texts come first.

Parameters

Help\Purpose

$purpose

of the help text that should be retrieved.

Returns

string[] of available help texts for the provided topics. May contain no entry.

---

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

• components/ILIAS/UI/src/HelpTextRetriever.php