class.ilMMItemInformation.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Filesystem\Exception\FileNotFoundException;
use ILIAS\GlobalScreen\Identification\IdentificationInterface;
use ILIAS\GlobalScreen\Scope\MainMenu\Collector\Information\ItemInformation;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasSymbol;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasTitle;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem;
use ILIAS\ResourceStorage\Services;
use ILIAS\UI\Component\Symbol\Glyph\Glyph;
use ILIAS\UI\Component\Symbol\Icon\Icon;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\Item\RepositoryLink;

class ilMMItemInformation implements ItemInformation
{
    private const ICON_ID = 'icon_id';

    private Services $storage;
    private array $translations;
    private array $items;

    public function __construct()
    {
        global $DIC;
        $this->items = ilMMItemStorage::getArray('identification');
        $this->translations = ilMMItemTranslationStorage::getArray('id', 'translation');
        $this->storage = $DIC['resource_storage'];
    }

    public function customTranslationForUser(hasTitle $item): hasTitle
    {
        global $DIC;
        static $usr_language_key;
        static $default_language;

        // see https://mantis.ilias.de/view.php?id=32276
        if (!isset($usr_language_key) && ($DIC->user()->getId() === 0 || $DIC->user()->isAnonymous())) {
            $usr_language_key = $DIC->http()->wrapper()->query()->has('lang')
                ? $DIC->http()->wrapper()->query()->retrieve('lang', $DIC->refinery()->to()->string())
                : null;
        }

        if (!isset($usr_language_key)) {
            $usr_language_key = $DIC->language()->getUserLanguage() ?: $DIC->language()->getDefaultLanguage();
        }
        if (!isset($default_language)) {
            $default_language = ilMMItemTranslationStorage::getDefaultLanguage();
        }
        if ($item instanceof RepositoryLink && empty($item->getTitle())) {
            $item = $item->withTitle(
                ($item->getRefId() > 0) ?
                \ilObject2::_lookupTitle(\ilObject2::_lookupObjectId($item->getRefId())) :
                ""
            );
        }
        if ($item instanceof hasTitle && isset($this->translations["{$item->getProviderIdentification()->serialize()}|$usr_language_key"])
            && $this->translations["{$item->getProviderIdentification()->serialize()}|$usr_language_key"] !== '') {
            return $item->withTitle((string) $this->translations["{$item->getProviderIdentification()->serialize()}|$usr_language_key"]);
        }

        return $item;
    }

    public function customPosition(isItem $item): isItem
    {
        return $item->withPosition($this->getPosition($item));
    }

    private function getPosition(isItem $item): int
    {
        if (isset($this->items[$item->getProviderIdentification()->serialize()]['position'])) {
            return (int) $this->items[$item->getProviderIdentification()->serialize()]['position'];
        }

        return $item->getPosition();
    }

    public function isItemActive(isItem $item): bool
    {
        if (!isset($this->items[$item->getProviderIdentification()->serialize()]['active'])) {
            return $item->isAvailable();
        }
        return ((int) ($this->items[$item->getProviderIdentification()->serialize()]['active'] ?? 0) === 1);
    }

    public function getParent(isItem $item): IdentificationInterface
    {
        global $DIC;
        $serialized = $item->getProviderIdentification()->serialize();
        if (isset($this->items[$serialized]['parent_identification'])) {
            return $DIC->globalScreen()->identification()->fromSerializedIdentification($this->items[$serialized]['parent_identification']);
        }

        return $item->getParent();
    }

    public function customSymbol(hasSymbol $item): hasSymbol
    {
        $id = $item->getProviderIdentification()->serialize();
        if (isset($this->items[$id][self::ICON_ID]) && strlen((string) $this->items[$id][self::ICON_ID]) > 1) {
            global $DIC;

            $ri = $this->storage->manage()->find($this->items[$id][self::ICON_ID]);
            if ($ri === null) {
                return $item;
            }

            try {
                $src = $this->storage->consume()->src($ri);
            } catch (FileNotFoundException) {
                return $item;
            }

            $old_symbol = $item->hasSymbol() ? $item->getSymbol() : null;
            if ($old_symbol instanceof Glyph) {
                $aria_label = $old_symbol->getAriaLabel();
            } elseif ($old_symbol instanceof Icon) {
                $aria_label = $old_symbol->getLabel();
            } elseif ($item instanceof hasTitle) {
                $aria_label = $item->getTitle();
            }

            $aria_label = empty($aria_label) ? $id : $aria_label;
            try {
                $symbol = $DIC->ui()->factory()->symbol()->icon()->custom($src->getSrc(), $aria_label);
            } catch (Exception) {
                return $item;
            }

            return $item->withSymbol($symbol);
        }

        return $item;
    }
}