Inheritance diagram for ilGSProviderFactory:

Collaboration diagram for ilGSProviderFactory:

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

	getMainBarProvider ()
	@inheritDoc More...

	getMetaBarProvider ()
	@inheritDoc More...

	getToolProvider ()
	@inheritDoc More...

	getModificationProvider ()
	@inheritDoc More...

	getNotificationsProvider ()
	@inheritDoc More...

	getToastsProvider ()
	@inheritDoc More...

	getMainBarItemInformation ()
	@inheritDoc More...

	getProviderByClassName (string $class_name)
	@inheritDoc More...

	isInstanceCreationPossible (string $class_name)
	@inheritDoc More...

	isRegistered (string $class_name)
	@inheritDoc More...

	getModificationProvider ()

	getMainBarProvider ()

	getMainBarItemInformation ()

	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

Container	$dic

ItemInformation	$main_menu_item_information

Detailed Description

Class ilGSProviderFactory.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilGSProviderFactory::__construct ( Container $dic )

@inheritDoc

@noRector

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

    {
        $this->dic = $dic;
        $this->main_menu_item_information = new ilMMItemInformation();
        $this->class_loader = include "Services/GlobalScreen/artifacts/global_screen_providers.php";
        $this->component_repository = $dic["component.repository"];
        $this->component_factory = $dic["component.factory"];
    }

References $dic.

Member Function Documentation

◆ appendCore()

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

private

Parameters

array	$array_of_providers
string	$interface

Definition at line 234 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 $e) {
                }
            }
        }
    }

References Vendor\Package\$e, and isInstanceCreationPossible().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMainBarItemInformation()

ilGSProviderFactory::getMainBarItemInformation ( )

@inheritDoc

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

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

                                               : ItemInformation
    {
        return $this->main_menu_item_information;
    }

References $main_menu_item_information.

◆ getMainBarProvider()

ilGSProviderFactory::getMainBarProvider ( )

@inheritDoc

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 97 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 ( )

@inheritDoc

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 120 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 ( )

@inheritDoc

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 166 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 ( )

@inheritDoc

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 187 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 )

@inheritDoc

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 ( )

@inheritDoc

Definition at line 210 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 ( )

@inheritDoc

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 143 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 )

@inheritDoc

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

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

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

References Vendor\Package\$e.

Referenced by appendCore(), and getProviderByClassName().

Here is the caller graph for this function:

◆ isRegistered()

ilGSProviderFactory::isRegistered ( string $class_name )

@inheritDoc

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 281 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

Parameters

array $providers

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

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