ilFooterCustomGroupsProvider Class Reference

Inheritance diagram for ilFooterCustomGroupsProvider:

Collaboration diagram for ilFooterCustomGroupsProvider:

Public Member Functions
	__construct (Container $dic)
	getNewIdentification ()
	getGroupsRepository ()
	getEntriesRepository ()
	getGroups ()
	getEntries ()
	getAdditionalTexts ()
	getPermanentURI ()
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\MetaBar\Provider\AbstractStaticFooterProvider
	__construct (Container $dic)
	getAdditionalTexts ()
	getPermanentURI ()
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (protected Container $dic)
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()

Private Member Functions
	buildURI (string $from_path)
	txt (string $key)

Private Attributes
readonly GroupsRepositoryDB	$groups_repository
readonly EntriesRepositoryDB	$entries_repository

Additional Inherited Members
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\MetaBar\Provider\AbstractStaticFooterProvider
IdentificationProviderInterface	$id_factory
FooterItemFactory	$item_factory

Detailed Description

Author

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

Definition at line 32 of file class.ilFooterCustomGroupsProvider.php.

Constructor & Destructor Documentation

__construct()

ilFooterCustomGroupsProvider::__construct

(

Container

$dic

)

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

References ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\DI\Container\database().

    {
        parent::__construct($dic);
        $this->groups_repository = new GroupsRepositoryDB($dic->database(), $this);
        $this->entries_repository = new EntriesRepositoryDB($dic->database(), $this);
    }

Here is the call graph for this function:

Member Function Documentation

buildURI()

ilFooterCustomGroupsProvider::buildURI ( string  $from_path )

private

Definition at line 111 of file class.ilFooterCustomGroupsProvider.php.

                                                : URI
    {
        $request = $this->dic->http()->request()->getUri();
        return new URI($request->getScheme() . '://' . $request->getHost() . '/' . ltrim($from_path, '/'));
    }

getAdditionalTexts()

ilFooterCustomGroupsProvider::getAdditionalTexts

(

)

Implements ILIAS\GlobalScreen\Scope\Footer\Provider\StaticFooterProvider.

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

                                        : array
    {
        return [];
    }

getEntries()

ilFooterCustomGroupsProvider::getEntries

(

)

Returns

isItem[] These are Entries which will be available for configuration.

Implements ILIAS\GlobalScreen\Scope\Footer\Provider\StaticFooterProvider.

Definition at line 81 of file class.ilFooterCustomGroupsProvider.php.

References ILIAS\GlobalScreen\Scope\Footer\Factory\withParent().

                                : array
    {
        $entries = [];

        foreach ($this->entries_repository->all() as $entry) {
            if ($entry->isCore()) {
                continue;
            }
            if (!$entry->isActive()) {
                continue;
            }
            try {
                $action = new URI($entry->getAction());
            } catch (Throwable) {
                continue;
            }

            $entries[] = $this->item_factory->link(
                $this->dic->globalScreen()->identification()->fromSerializedIdentification($entry->getId()),
                $entry->getTitle(),
            )->withParent(
                $this->dic->globalScreen()->identification()->fromSerializedIdentification($entry->getParent())
            )->withAction(
                $action
            )->withOpenInNewViewport($entry->isExternal());
        }

        return $entries;
    }

Here is the call graph for this function:

getEntriesRepository()

ilFooterCustomGroupsProvider::getEntriesRepository

(

)

Definition at line 54 of file class.ilFooterCustomGroupsProvider.php.

References $entries_repository.

                                          : EntriesRepositoryDB
    {
        return $this->entries_repository;
    }

getGroups()

ilFooterCustomGroupsProvider::getGroups

(

)

Returns

TopParentItem[] These are Slates which will be available for configuration.

Implements ILIAS\GlobalScreen\Scope\Footer\Provider\StaticFooterProvider.

Definition at line 61 of file class.ilFooterCustomGroupsProvider.php.

                               : array
    {
        $groups = [];

        foreach ($this->groups_repository->all() as $group) {
            if ($group->isCore()) {
                continue;
            }
            if (!$group->isActive()) {
                continue;
            }
            $groups[] = $this->item_factory->group(
                $this->dic->globalScreen()->identification()->fromSerializedIdentification($group->getId()),
                $group->getTitle(),
            );
        }

        return $groups;
    }

getGroupsRepository()

ilFooterCustomGroupsProvider::getGroupsRepository

(

)

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

References $groups_repository.

                                         : GroupsRepositoryDB
    {
        return $this->groups_repository;
    }

getNewIdentification()

ilFooterCustomGroupsProvider::getNewIdentification

(

)

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

                                          : IdentificationInterface
    {
        return $this->id_factory->identifier(uniqid('', true));
    }

getPermanentURI()

ilFooterCustomGroupsProvider::getPermanentURI

(

)

Implements ILIAS\GlobalScreen\Scope\Footer\Provider\StaticFooterProvider.

Definition at line 122 of file class.ilFooterCustomGroupsProvider.php.

                                     : ?Permanent
    {
        return null;
    }

txt()

ilFooterCustomGroupsProvider::txt ( string  $key )

private

Definition at line 127 of file class.ilFooterCustomGroupsProvider.php.

                                     : string
    {
        return $this->dic->language()->txt($key);
    }

Field Documentation

$entries_repository

readonly EntriesRepositoryDB ilFooterCustomGroupsProvider::$entries_repository

private

Definition at line 35 of file class.ilFooterCustomGroupsProvider.php.

Referenced by getEntriesRepository().

$groups_repository

readonly GroupsRepositoryDB ilFooterCustomGroupsProvider::$groups_repository

private

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

Referenced by getGroupsRepository().

---

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

• components/ILIAS/GlobalScreen_/classes/UI/Footer/class.ilFooterCustomGroupsProvider.php