ilHelpMetaBarProvider Class Reference

Inheritance diagram for ilHelpMetaBarProvider:

Collaboration diagram for ilHelpMetaBarProvider:

Public Member Functions
	getMetaBarItems ()
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\MetaBar\Provider\AbstractStaticMetaBarProvider
	__construct (Container $dic)
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (protected Container $dic)
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\MetaBar\Provider\MetaBarProviderInterface
	getProviderNameForPresentation ()

Private Member Functions
	getId ()

Additional Inherited Members
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\MetaBar\Provider\AbstractStaticMetaBarProvider
Container	$dic
IdentificationProviderInterface	$if
MetaBarItemFactory	$meta_bar

Detailed Description

Definition at line 25 of file class.ilHelpMetaBarProvider.php.

Member Function Documentation

getId()

ilHelpMetaBarProvider::getId ( )

private

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

Referenced by getMetaBarItems().

                            : IdentificationInterface
    {
        return $this->if->identifier('help');
    }

Here is the caller graph for this function:

getMetaBarItems()

ilHelpMetaBarProvider::getMetaBarItems

(

)

Returns

isItem[]

Implements ILIAS\GlobalScreen\Scope\MetaBar\Provider\StaticMetaBarProvider.

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

References $c, $DIC, Vendor\Package\$f, $id, getId(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), null, ILIAS\GlobalScreen\Scope\MainMenu\Factory\withSymbol(), and ILIAS\GlobalScreen\Scope\Footer\Factory\withTitle().

                                     : array
    {
        global $DIC;

        $mb = $this->globalScreen()->metaBar();

        $f = $DIC->ui()->factory();

        $title = $DIC->language()->txt("help");

        if ($this->showHelpTool()) {
            // position should be 0, see bug #26794
            $item = $mb->topLinkItem($this->getId())
                       ->addComponentDecorator(static function (ILIAS\UI\Component\Component $c): ?ILIAS\UI\Component\Component {
                           if ($c instanceof BulkyButton || $c instanceof BulkyLink) {
                               return $c->withAdditionalOnLoadCode(static function (string $id): string {
                                   return "$('#$id').on('click', function() {
                                    $('body').trigger('il-help-toggle-slate');
                                    return false;
                                })";
                               });
                           }
                           return null;
                       })
                       ->withSymbol($f->symbol()->glyph()->help())
                       ->withTitle($title)
                       ->withPosition(0);

            return [$item];
        }

        return [];
    }

Here is the call graph for this function:

---

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

• components/ILIAS/Help/GlobalScreen/classes/class.ilHelpMetaBarProvider.php