Inheritance diagram for ilGSProviderFactory:

Collaboration diagram for ilGSProviderFactory:

Public Member Functions
	__construct (private readonly Container $dic)
	@inheritDoc More...

	getMainBarProvider ()

	getFooterProvider ()

	getMetaBarProvider ()

	getToolProvider ()

	getModificationProvider ()

	getNotificationsProvider ()

	getToastsProvider ()

	getMainBarItemInformation ()

	getFooterItemInformation ()

	getProviderByClassName (string $class_name)

	isInstanceCreationPossible (string $class_name)

	isRegistered (string $class_name)

	getModificationProvider ()

	getMainBarProvider ()

	getFooterProvider ()

	getMainBarItemInformation ()

	getFooterItemInformation ()

	getToolProvider ()

	getMetaBarProvider ()

	getNotificationsProvider ()

	getProviderByClassName (string $class_name)

	isInstanceCreationPossible (string $class_name)

	isRegistered (string $class_name)

Protected Member Functions
	registerInternal (array $providers)

Protected Attributes
array	$all_providers = []

ilComponentRepository	$component_repository

ilComponentFactory	$component_factory

Private Member Functions
	initPlugins ()

	appendCore (array &$array_of_providers, string $interface)

Private Attributes
array	$plugin_provider_collections = null

array	$class_loader

readonly ItemInformation	$main_menu_item_information

readonly ilFooterCustomItemInformation	$footer_item_information

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ilGSProviderFactory::__construct ( private readonly Container $dic )

@inheritDoc

@noRector

Definition at line 57 of file class.ilGSProviderFactory.php.

    {
        $this->main_menu_item_information = new ilMMItemInformation();
        $this->footer_item_information = new ilFooterCustomItemInformation($dic);
        $this->class_loader = include ilGlobalScreenBuildProviderMapObjective::PATH();
        $this->component_repository = $this->dic["component.repository"];
        $this->component_factory = $this->dic["component.factory"];
    }

References $dic, and ILIAS\Setup\Artifact\BuildArtifactObjective\PATH().

Here is the call graph for this function:

Member Function Documentation

◆ appendCore()

ilGSProviderFactory::appendCore	(	array &	$array_of_providers,
		string	$interface
	)

private

Definition at line 235 of file class.ilGSProviderFactory.php.

                                                                              : void
    {
        foreach ($this->class_loader[$interface] ?? [] as $class_name) {
            if ($this->isInstanceCreationPossible($class_name)) {
                try {
                    $array_of_providers[] = new $class_name($this->dic);
                } catch (Throwable) {
                }
            }
        }
    }

References isInstanceCreationPossible().

Referenced by getFooterProvider(), getMainBarProvider(), getMetaBarProvider(), getModificationProvider(), getNotificationsProvider(), getToastsProvider(), and getToolProvider().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFooterItemInformation()

ilGSProviderFactory::getFooterItemInformation ( )

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 252 of file class.ilGSProviderFactory.php.

                                              : \ILIAS\GlobalScreen\Scope\Footer\Collector\Information\ItemInformation
    {
        return $this->footer_item_information;
    }

References $footer_item_information.

◆ getFooterProvider()

ilGSProviderFactory::getFooterProvider ( )

Returns: StaticFooterProvider[]

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 113 of file class.ilGSProviderFactory.php.

                                       : array
    {
        $providers = [];
        // Core
        $this->appendCore($providers, StaticFooterProvider::class);
 
        // Plugins
        //        $this->initPlugins();
        //        foreach ($this->plugin_provider_collections as $collection) {
        //            $provider = $collection->getMainBarProvider();
        //            if ($provider) {
        //                $providers[] = $provider;
        //            }
        //        }
 
        $this->registerInternal($providers);
 
        return $providers;
    }

References appendCore(), and registerInternal().

Here is the call graph for this function:

◆ getMainBarItemInformation()

ilGSProviderFactory::getMainBarItemInformation ( )

Returns: ItemInformation

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 247 of file class.ilGSProviderFactory.php.

                                               : ItemInformation
    {
        return $this->main_menu_item_information;
    }

References $main_menu_item_information.

◆ getMainBarProvider()

ilGSProviderFactory::getMainBarProvider ( )

Returns: StaticMainMenuProvider[]

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

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

                                        : array
    {
        $providers = [];
        // Core
        $this->appendCore($providers, StaticMainMenuProvider::class);
 
        // Plugins
        $this->initPlugins();
        foreach ($this->plugin_provider_collections as $collection) {
            $provider = $collection->getMainBarProvider();
            if ($provider) {
                $providers[] = $provider;
            }
        }
 
        $this->registerInternal($providers);
 
        return $providers;
    }

References $provider, appendCore(), initPlugins(), and registerInternal().

Here is the call graph for this function:

◆ getMetaBarProvider()

ilGSProviderFactory::getMetaBarProvider ( )

Returns: StaticMetaBarProvider[]

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 134 of file class.ilGSProviderFactory.php.

                                        : array
    {
        $providers = [];
        // Core
        $this->appendCore($providers, StaticMetaBarProvider::class);
 
        // Plugins
        $this->initPlugins();
        foreach ($this->plugin_provider_collections as $collection) {
            $provider = $collection->getMetaBarProvider();
            if ($provider) {
                $providers[] = $provider;
            }
        }
 
        $this->registerInternal($providers);
 
        return $providers;
    }

References $provider, appendCore(), initPlugins(), and registerInternal().

Here is the call graph for this function:

◆ getModificationProvider()

ilGSProviderFactory::getModificationProvider ( )

Returns: ModificationProvider[]

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 175 of file class.ilGSProviderFactory.php.

                                             : array
    {
        $providers = [];
        // Core
        $this->appendCore($providers, ModificationProvider::class);
 
        // Plugins
        $this->initPlugins();
        foreach ($this->plugin_provider_collections as $collection) {
            $provider = $collection->getModificationProvider();
            if ($provider) {
                $providers[] = $provider;
            }
        }
 
        return $providers;
    }

References $provider, appendCore(), and initPlugins().

Here is the call graph for this function:

◆ getNotificationsProvider()

ilGSProviderFactory::getNotificationsProvider ( )

Returns: NotificationProvider[]

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 193 of file class.ilGSProviderFactory.php.

                                              : array
    {
        $providers = [];
        // Core
        $this->appendCore($providers, NotificationProvider::class);
 
        // Plugins
        $this->initPlugins();
        foreach ($this->plugin_provider_collections as $collection) {
            $provider = $collection->getNotificationProvider();
            if ($provider) {
                $providers[] = $provider;
            }
        }
 
        $this->registerInternal($providers);
 
        return $providers;
    }

References $provider, appendCore(), initPlugins(), and registerInternal().

Here is the call graph for this function:

◆ getProviderByClassName()

ilGSProviderFactory::getProviderByClassName ( string $class_name )

Parameters

string $class_name

Returns: Provider

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 257 of file class.ilGSProviderFactory.php.

                                                              : Provider
    {
        if (!$this->isInstanceCreationPossible($class_name) || !$this->isRegistered($class_name)) {
            throw new LogicException("the GlobalScreen-Provider $class_name is not available");
        }
 
        return $this->all_providers[$class_name];
    }

References isInstanceCreationPossible(), and isRegistered().

Here is the call graph for this function:

◆ getToastsProvider()

ilGSProviderFactory::getToastsProvider ( )

Definition at line 214 of file class.ilGSProviderFactory.php.

                                       : array
    {
        $providers = [];
        // Core
        $this->appendCore($providers, ToastProvider::class);
 
        // Plugins
        $this->initPlugins();
        foreach ($this->plugin_provider_collections as $collection) {
            $provider = $collection->getToastProvider();
            if ($provider) {
                $providers[] = $provider;
            }
        }
 
        $this->registerInternal($providers);
 
        return $providers;
    }

References $provider, appendCore(), initPlugins(), and registerInternal().

Here is the call graph for this function:

◆ getToolProvider()

ilGSProviderFactory::getToolProvider ( )

Returns: DynamicToolProvider[]

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 155 of file class.ilGSProviderFactory.php.

                                     : array
    {
        $providers = [];
        // Core
        $this->appendCore($providers, DynamicToolProvider::class);
 
        // Plugins
        $this->initPlugins();
        foreach ($this->plugin_provider_collections as $collection) {
            $provider = $collection->getToolProvider();
            if ($provider) {
                $providers[] = $provider;
            }
        }
 
        $this->registerInternal($providers);
 
        return $providers;
    }

References $provider, appendCore(), initPlugins(), and registerInternal().

Here is the call graph for this function:

◆ initPlugins()

ilGSProviderFactory::initPlugins ( )

private

Definition at line 67 of file class.ilGSProviderFactory.php.

                                  : void
    {
        if (!is_array($this->plugin_provider_collections)) {
            $this->plugin_provider_collections = [];
            foreach ($this->component_repository->getPlugins() as $plugin) {
                if (!$plugin->isActive()) {
                    continue;
                }
                $pl = $this->component_factory->getPlugin($plugin->getId());
                $this->plugin_provider_collections[] = $pl->getGlobalScreenProviderCollection();
            }
        }
    }

References XapiProxy\$plugin.

Referenced by getMainBarProvider(), getMetaBarProvider(), getModificationProvider(), getNotificationsProvider(), getToastsProvider(), and getToolProvider().

Here is the caller graph for this function:

◆ isInstanceCreationPossible()

ilGSProviderFactory::isInstanceCreationPossible ( string $class_name )

Parameters

string $class_name

Returns: bool

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 267 of file class.ilGSProviderFactory.php.

                                                                  : bool
    {
        try {
            return class_exists($class_name);
        } catch (Throwable) {
            return false;
        }
    }

Referenced by appendCore(), and getProviderByClassName().

Here is the caller graph for this function:

◆ isRegistered()

ilGSProviderFactory::isRegistered ( string $class_name )

Parameters

string $class_name

Returns: bool

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 277 of file class.ilGSProviderFactory.php.

                                                    : bool
    {
        return isset($this->all_providers[$class_name]);
    }

Referenced by getProviderByClassName().

Here is the caller graph for this function:

◆ registerInternal()

ilGSProviderFactory::registerInternal ( array $providers )

protected

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

                                                         : void
    {
        array_walk(
            $providers,
            function (Provider $item): void {
                $this->all_providers[$item::class] = $item;
            }
        );
    }