ILIAS\Init\Provider\StartUpMetaBarProvider Class Reference

Inheritance diagram for ILIAS\Init\Provider\StartUpMetaBarProvider:

Collaboration diagram for ILIAS\Init\Provider\StartUpMetaBarProvider:

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
	isUserLoggedIn ()
	isUserOnLoginPage (UriInterface $uri)
	appendUrlParameterString (string $existing_url, string $addition)
	getBaseURL (UriInterface $uri)

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 28 of file StartUpMetaBarProvider.php.

Member Function Documentation

appendUrlParameterString()

ILIAS\Init\Provider\StartUpMetaBarProvider::appendUrlParameterString ( string  $existing_url, string  $addition  )

private

Definition at line 134 of file StartUpMetaBarProvider.php.

References $url.

Referenced by ILIAS\Init\Provider\StartUpMetaBarProvider\getMetaBarItems().

                                                                                     : string
    {
        $url = (\is_int(strpos($existing_url, '?')))
            ? $existing_url . '&' . $addition
            : $existing_url . '?' . $addition;

        $url = str_replace('?&', '?', $url);

        return $url;
    }

Here is the caller graph for this function:

getBaseURL()

ILIAS\Init\Provider\StartUpMetaBarProvider::getBaseURL ( UriInterface  $uri )

private

Definition at line 145 of file StartUpMetaBarProvider.php.

Referenced by ILIAS\Init\Provider\StartUpMetaBarProvider\getMetaBarItems().

                                                  : string
    {
        $base = substr($uri->__toString(), strrpos($uri->__toString(), '/') + 1);

        return rtrim(preg_replace('/([&?])lang=[a-z]{2}([&$])/', '$1', $base), '?&');
    }

Here is the caller graph for this function:

getMetaBarItems()

ILIAS\Init\Provider\StartUpMetaBarProvider::getMetaBarItems

(

)

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

Definition at line 33 of file StartUpMetaBarProvider.php.

References $id, ILIAS\GlobalScreen\Scope\MetaBar\Provider\AbstractStaticMetaBarProvider\$if, $ref_id, $txt, ilObject\_lookupType(), ILIAS\Init\Provider\StartUpMetaBarProvider\appendUrlParameterString(), CLIENT_ID, ILIAS\Init\Provider\StartUpMetaBarProvider\getBaseURL(), ILIAS\Repository\int(), ILIAS\Init\Provider\StartUpMetaBarProvider\isUserLoggedIn(), ILIAS\Init\Provider\StartUpMetaBarProvider\isUserOnLoginPage(), ILIAS\GlobalScreen\Scope\MetaBar\Factory\withLanguageForTargetedResource(), ILIAS\GlobalScreen\Scope\Footer\Factory\withTitle(), and ILIAS\GlobalScreen\Scope\withVisibilityCallable().

                                     : array
    {
        $factory = $this->dic->ui()->factory();
        $request = $this->dic->http()->request();
        $languages = $this->dic->language()->getInstalledLanguages();

        $if = function (string $id): IdentificationInterface {
            return $this->if->identifier($id);
        };

        $txt = function (string $id): string {
            return $this->dic->language()->txt($id);
        };

        // Login-Button
        // Only visible, if not on login-page but not logged in
        $target_str = '';
        if (isset($request->getQueryParams()['ref_id']) && $ref_id = $request->getQueryParams()['ref_id']) {
            $type = \ilObject::_lookupType((int) $ref_id, true);
            if ($type !== 'root') {  // see bug #30710
                $target_str = 'target=' . \ilObject::_lookupType((int) $ref_id, true) . '_' . (int) $ref_id . '&';
            }
        } elseif (isset($request->getQueryParams()['target']) && $target = $request->getQueryParams()['target']) {
            $target = rawurlencode($target);        // see #32789
            $target_str = 'target=' . $target . '&';
        }

        $login_glyph = $factory->symbol()->glyph()->login();

        $current_language = $this->dic->user()->getCurrentLanguage() ?: $this->dic->language()->getLangKey();

        $login = $this->meta_bar
            ->topLinkItem($if('login'))
            ->withAction(
                'login.php?' . $target_str . 'client_id=' . rawurlencode(
                    CLIENT_ID
                ) . '&cmd=force_login&lang=' . $current_language
            )
            ->withSymbol($login_glyph)
            ->withPosition(3)
            ->withTitle($txt('log_in'))
            ->withAvailableCallable(function () {
                return !$this->isUserLoggedIn();
            })
            ->withVisibilityCallable(function () use ($request) {
                return !$this->isUserOnLoginPage($request->getUri());
            });

        // Language-Selection
        $language_selection = $this->meta_bar
            ->topParentItem($if('language_selection'))
            ->withSymbol($factory->symbol()->glyph()->language())
            ->withPosition(1)
            ->withAvailableCallable(function () {
                return !$this->isUserLoggedIn();
            })
            ->withVisibilityCallable(function () use ($languages) {
                return \count($languages) > 1;
            })
            ->withTitle($txt('language'));

        $base = $this->getBaseURL($request->getUri());
        $dataFactory = new DataFactory();

        foreach ($languages as $lang_key) {
            $link = $this->appendUrlParameterString($base, 'lang=' . $lang_key);
            $language_name = $this->dic->language()->_lookupEntry($lang_key, 'meta', 'meta_l_' . $lang_key);

            $language_icon = $factory
                ->symbol()
                ->icon()
                ->standard('none', $language_name)
                ->withAbbreviation($lang_key);

            $s = $this->meta_bar
                ->linkItem($if($lang_key))
                ->withSymbol($language_icon)
                ->withAction($link)
                ->withContentLanguage($dataFactory->languageTag($lang_key))
                ->withLanguageForTargetedResource($dataFactory->languageTag($lang_key))
                ->withTitle($language_name);

            $language_selection->appendChild($s);
        }

        return [
            $login,
            $language_selection,
        ];
    }

Here is the call graph for this function:

isUserLoggedIn()

ILIAS\Init\Provider\StartUpMetaBarProvider::isUserLoggedIn ( )

private

Definition at line 124 of file StartUpMetaBarProvider.php.

Referenced by ILIAS\Init\Provider\StartUpMetaBarProvider\getMetaBarItems().

                                     : bool
    {
        return (!$this->dic->user()->isAnonymous() && $this->dic->user()->getId() !== 0);
    }

Here is the caller graph for this function:

isUserOnLoginPage()

ILIAS\Init\Provider\StartUpMetaBarProvider::isUserOnLoginPage ( UriInterface  $uri )

private

Definition at line 129 of file StartUpMetaBarProvider.php.

Referenced by ILIAS\Init\Provider\StartUpMetaBarProvider\getMetaBarItems().

                                                         : bool
    {
        return preg_match('%^.*(?:/login\.php|/)$%', $uri->getPath()) === 1;
    }

Here is the caller graph for this function:

---

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

• components/ILIAS/Init/classes/Provider/StartUpMetaBarProvider.php