ilFooterCustomItemInformation Class Reference

Inheritance diagram for ilFooterCustomItemInformation:

Collaboration diagram for ilFooterCustomItemInformation:

Public Member Functions
	__construct (private readonly Container $dic)
	isItemActive (isItem $item)
	customPosition (isItem $item)
	customTranslationForUser (hasTitle $item)
	getParent (isItem $item)
	isItemActive (isItem $item)
	customPosition (isItem $item)
	customTranslationForUser (hasTitle $item)
	getParent (isItem $item)

Private Member Functions
	translations ()
	userLanguage ()
	groups ()
	entries ()
	id ()
	maybeGetItem (isItem $item)

Private Attributes
GroupsRepositoryDB	$groups_repository = null
EntriesRepositoryDB	$entries_repository = null
IdentificationFactory	$identifications = null
TranslationsRepositoryDB	$translations_repository = null
string	$user_language = null

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

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

Constructor & Destructor Documentation

__construct()

ilFooterCustomItemInformation::__construct

(

private readonly Container

$dic

)

Definition at line 49 of file class.ilFooterCustomItemInformation.php.

    {
    }

Member Function Documentation

customPosition()

ilFooterCustomItemInformation::customPosition

(

isItem

$item

)

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

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

                                                : isItem
    {
        $d = $this->maybeGetItem($item);
        if ($d === null) {
            return $item;
        }
 
        return $item->withPosition($d->getPosition());
    }

References Vendor\Package\$d, maybeGetItem(), and ILIAS\GlobalScreen\Scope\Footer\Factory\isItem\withPosition().

Here is the call graph for this function:

customTranslationForUser()

ilFooterCustomItemInformation::customTranslationForUser

(

hasTitle

$item

)

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

Definition at line 130 of file class.ilFooterCustomItemInformation.php.

                                                            : hasTitle
    {
        $d = $this->maybeGetItem($item);
        if ($d === null) {
            return $item;
        }
 
        if ($d->isCore()) {
            return $item->withIsCore();
        }
 
        if (
            (($translation = $this->translations()->get($d)->getLanguageCode($this->userLanguage())) !== null)
            && $translation->getTranslation() !== ''
        ) {
            return $item->withTitle($translation->getTranslation());
        }
 
        return $item->withTitle($d->getTitle());
    }

References Vendor\Package\$d, maybeGetItem(), translations(), userLanguage(), ILIAS\GlobalScreen\Scope\Footer\Factory\isItem\withIsCore(), and ILIAS\GlobalScreen\Scope\Footer\Factory\hasTitle\withTitle().

Here is the call graph for this function:

entries()

ilFooterCustomItemInformation::entries ( )

private

Definition at line 82 of file class.ilFooterCustomItemInformation.php.

                              : EntriesRepository
    {
        if ($this->entries_repository !== null) {
            return $this->entries_repository;
        }
 
        $this->entries_repository = new EntriesRepositoryDB($this->dic->database());
        $this->entries_repository->preload();
        return $this->entries_repository;
    }

References $entries_repository.

Referenced by getParent(), and maybeGetItem().

Here is the caller graph for this function:

getParent()

ilFooterCustomItemInformation::getParent

(

isItem

$item

)

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

Definition at line 151 of file class.ilFooterCustomItemInformation.php.

                                           : IdentificationInterface
    {
        $entry = $this->entries()->get($item->getProviderIdentification()->serialize());
 
        if ($entry === null) {
            return $item->getProviderIdentification();
        }
 
        return $this->id()->fromSerializedIdentification($entry->getParent());
    }

References entries(), ILIAS\GlobalScreen\isGlobalScreenItem\getProviderIdentification(), and id().

Here is the call graph for this function:

groups()

ilFooterCustomItemInformation::groups ( )

private

Definition at line 71 of file class.ilFooterCustomItemInformation.php.

                             : GroupsRepository
    {
        if ($this->groups_repository !== null) {
            return $this->groups_repository;
        }
 
        $this->groups_repository = new GroupsRepositoryDB($this->dic->database());
        $this->groups_repository->preload();
        return $this->groups_repository;
    }

References $groups_repository.

Referenced by maybeGetItem().

Here is the caller graph for this function:

id()

ilFooterCustomItemInformation::id ( )

private

Definition at line 93 of file class.ilFooterCustomItemInformation.php.

                         : IdentificationFactory
    {
        return $this->identifications ?? $this->dic->globalScreen()->identification();
    }

Referenced by getParent().

Here is the caller graph for this function:

isItemActive()

ilFooterCustomItemInformation::isItemActive

(

isItem

$item

)

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

Definition at line 110 of file class.ilFooterCustomItemInformation.php.

                                              : bool
    {
        $d = $this->maybeGetItem($item);
        if ($d === null) {
            return $item->isAvailable();
        }
 
        return $d->isActive();
    }

References Vendor\Package\$d, ILIAS\GlobalScreen\Scope\Footer\Factory\isItem\isAvailable(), and maybeGetItem().

Here is the call graph for this function:

maybeGetItem()

ilFooterCustomItemInformation::maybeGetItem ( isItem  $item )

private

Definition at line 98 of file class.ilFooterCustomItemInformation.php.

                                               : Group|Entry|null
    {
        if ($item instanceof canHaveParent) {
            return $this->entries()->get($item->getProviderIdentification()->serialize());
        }
 
        if ($item instanceof isGroup) {
            return $this->groups()->get($item->getProviderIdentification()->serialize());
        }
        return null;
    }

References entries(), ILIAS\GlobalScreen\isGlobalScreenItem\getProviderIdentification(), and groups().

Referenced by customPosition(), customTranslationForUser(), and isItemActive().

Here is the call graph for this function:

Here is the caller graph for this function:

translations()

ilFooterCustomItemInformation::translations ( )

private

Definition at line 53 of file class.ilFooterCustomItemInformation.php.

                                   : TranslationsRepository
    {
        if ($this->translations_repository !== null) {
            return $this->translations_repository;
        }
 
        $this->translations_repository = new TranslationsRepositoryDB($this->dic->database());
        return $this->translations_repository;
    }

References $translations_repository.

Referenced by customTranslationForUser().

Here is the caller graph for this function:

userLanguage()

ilFooterCustomItemInformation::userLanguage ( )

private

Definition at line 63 of file class.ilFooterCustomItemInformation.php.

                                   : string
    {
        if ($this->user_language !== null) {
            return $this->user_language;
        }
        return $this->user_language = $this->dic->user()->getLanguage();
    }

References $user_language.

Referenced by customTranslationForUser().

Here is the caller graph for this function:

Field Documentation

$entries_repository

EntriesRepositoryDB ilFooterCustomItemInformation::$entries_repository = null

private

Definition at line 44 of file class.ilFooterCustomItemInformation.php.

Referenced by entries().

$groups_repository

GroupsRepositoryDB ilFooterCustomItemInformation::$groups_repository = null

private

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

Referenced by groups().

$identifications

IdentificationFactory ilFooterCustomItemInformation::$identifications = null

private

Definition at line 45 of file class.ilFooterCustomItemInformation.php.

$translations_repository

TranslationsRepositoryDB ilFooterCustomItemInformation::$translations_repository = null

private

Definition at line 46 of file class.ilFooterCustomItemInformation.php.

Referenced by translations().

$user_language

string ilFooterCustomItemInformation::$user_language = null

private

Definition at line 47 of file class.ilFooterCustomItemInformation.php.

Referenced by userLanguage().

---

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

• components/ILIAS/GlobalScreen/classes/UI/Footer/class.ilFooterCustomItemInformation.php