ilMMItemInformation Class Reference

Class ilMMItemInformation. More...

Inheritance diagram for ilMMItemInformation:

Collaboration diagram for ilMMItemInformation:

Public Member Functions
	__construct ()
	ilMMItemInformation constructor. More...
	customPosition (isItem $item)
	isItemActive (isItem $item)
	getParent (isItem $item)
	customSymbol (hasSymbol $item)
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\MainMenu\Collector\Information\ItemInformation
	customTranslationForUser (hasTitle $item)

Private Member Functions
	getPosition (isItem $item)

Private Attributes
const	ICON_ID = 'icon_id'
Services	$storage
array	$translations
array	$items

Detailed Description

Class ilMMItemInformation.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 37 of file class.ilMMItemInformation.php.

Constructor & Destructor Documentation

__construct()

ilMMItemInformation::__construct

(

)

ilMMItemInformation constructor.

Definition at line 48 of file class.ilMMItemInformation.php.

References $DIC, ilObject\_lookupObjectId(), ilObject\_lookupTitle(), ILIAS\GlobalScreen\Scope\MainMenu\Collector\Information\ItemInformation\customTranslationForUser(), ActiveRecord\getArray(), ilMMItemTranslationStorage\getDefaultLanguage(), ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasTitle\getTitle(), and ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasTitle\withTitle().

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

Here is the call graph for this function:

Member Function Documentation

customPosition()

ilMMItemInformation::customPosition

(

isItem

$item

)

Implements ILIAS\GlobalScreen\Scope\MainMenu\Collector\Information\ItemInformation.

Definition at line 100 of file class.ilMMItemInformation.php.

References getPosition(), and ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem\withPosition().

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

Here is the call graph for this function:

customSymbol()

ilMMItemInformation::customSymbol

(

hasSymbol

$item

)

Implements ILIAS\GlobalScreen\Scope\MainMenu\Collector\Information\ItemInformation.

Definition at line 142 of file class.ilMMItemInformation.php.

References $DIC, Vendor\Package\$e, Vendor\Package\$f, $id, ILIAS\GlobalScreen\isGlobalScreenItem\getProviderIdentification(), ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasSymbol\getSymbol(), ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasSymbol\hasSymbol(), and ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasSymbol\withSymbol().

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

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

            try {
                $src = $this->storage->consume()->src($ri);
            } catch (FileNotFoundException $f) {
                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 $e) {
                return $item;
            }

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

        return $item;
    }

Here is the call graph for this function:

getParent()

ilMMItemInformation::getParent

(

isItem

$item

)

Implements ILIAS\GlobalScreen\Scope\MainMenu\Collector\Information\ItemInformation.

Definition at line 128 of file class.ilMMItemInformation.php.

References $DIC, and ILIAS\GlobalScreen\isGlobalScreenItem\getProviderIdentification().

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

Here is the call graph for this function:

getPosition()

ilMMItemInformation::getPosition ( isItem  $item )

private

Definition at line 105 of file class.ilMMItemInformation.php.

References ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem\getPosition(), and ILIAS\GlobalScreen\isGlobalScreenItem\getProviderIdentification().

Referenced by customPosition().

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

        return $item->getPosition();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isItemActive()

ilMMItemInformation::isItemActive

(

isItem

$item

)

Implements ILIAS\GlobalScreen\Scope\MainMenu\Collector\Information\ItemInformation.

Definition at line 117 of file class.ilMMItemInformation.php.

References ILIAS\GlobalScreen\isGlobalScreenItem\getProviderIdentification(), and ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem\isAvailable().

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

Here is the call graph for this function:

Field Documentation

$items

array ilMMItemInformation::$items

private

Definition at line 43 of file class.ilMMItemInformation.php.

$storage

Services ilMMItemInformation::$storage

private

Definition at line 41 of file class.ilMMItemInformation.php.

$translations

array ilMMItemInformation::$translations

private

Definition at line 42 of file class.ilMMItemInformation.php.

ICON_ID

const ilMMItemInformation::ICON_ID = 'icon_id'

private

Definition at line 39 of file class.ilMMItemInformation.php.

---

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

• components/ILIAS/MainMenu/classes/Items/class.ilMMItemInformation.php