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 (isChild $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'
	$ui_factory
	$storage
	$translations = []
	$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 20 of file class.ilMMItemInformation.php.

Constructor & Destructor Documentation

__construct()

ilMMItemInformation::__construct

(

)

ilMMItemInformation constructor.

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

References $DIC, ilObject2\_lookupObjectId(), ilObject2\_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().

    {
        $this->items        = ilMMItemStorage::getArray('identification');
        $this->translations = ilMMItemTranslationStorage::getArray('id', 'translation');
        $this->storage      = new Services();
    }

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 91 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 134 of file class.ilMMItemInformation.php.

References $data, $DIC, ILIAS\GlobalScreen\Scope\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->find($this->items[$id][self::ICON_ID]);
            if (!$ri) {
                return $item;
            }
            $stream     = $this->storage->stream($ri)->getStream();
            $data       = 'data:' . $this->storage->getRevision($ri)->getInformation()->getMimeType() . ';base64,' . base64_encode($stream->getContents());
            $old_symbol = $item->hasSymbol() ? $item->getSymbol() : null;
            if ($old_symbol instanceof Glyph || $old_symbol instanceof Icon) {
                $aria_label = $old_symbol->getAriaLabel();
            } elseif ($item instanceof hasTitle) {
                $aria_label = $item->getTitle();
            } else {
                $aria_label = 'Custom icon';
            }

            $symbol = $DIC->ui()->factory()->symbol()->icon()->custom($data, $aria_label);

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

        return $item;
    }

Here is the call graph for this function:

getParent()

ilMMItemInformation::getParent

(

isChild

$item

)

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

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

References $DIC, ILIAS\GlobalScreen\Scope\MainMenu\Factory\isChild\getParent(), and ILIAS\GlobalScreen\Scope\isGlobalScreenItem\getProviderIdentification().

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

        return $item->getParent();
    }

Here is the call graph for this function:

getPosition()

ilMMItemInformation::getPosition ( isItem  $item )

private

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

References ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem\getPosition(), and ILIAS\GlobalScreen\Scope\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 108 of file class.ilMMItemInformation.php.

References ILIAS\GlobalScreen\Scope\isGlobalScreenItem\getProviderIdentification().

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

Here is the call graph for this function:

Field Documentation

$items

ilMMItemInformation::$items = []

private

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

$storage

ilMMItemInformation::$storage

private

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

$translations

ilMMItemInformation::$translations = []

private

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

$ui_factory

ilMMItemInformation::$ui_factory

private

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

ICON_ID

const ilMMItemInformation::ICON_ID = 'icon_id'

private

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

---

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

• Services/MainMenu/classes/Items/class.ilMMItemInformation.php