ilGSProviderFactory Class Reference

Inheritance diagram for ilGSProviderFactory:

Collaboration diagram for ilGSProviderFactory:

Public Member Functions
	__construct (private readonly Container $dic)
	getMainBarProvider ()
	getFooterProvider ()
	getMetaBarProvider ()
	getToolProvider ()
	getModificationProvider ()
	getNotificationsProvider ()
	getToastsProvider ()
	getMainBarItemInformation ()
	getFooterItemInformation ()
	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

)

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

References ILIAS\Setup\Artifact\BuildArtifactObjective\PATH().

    {
        $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"];
    }

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.

References isInstanceCreationPossible().

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

                                                                              : 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) {
                }
            }
        }
    }

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.

References $footer_item_information.

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

getFooterProvider()

ilGSProviderFactory::getFooterProvider

(

)

Returns

StaticFooterProvider[]

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

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

References appendCore(), and registerInternal().

                                       : 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;
    }

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.

References $main_menu_item_information.

                                               : ItemInformation
    {
        return $this->main_menu_item_information;
    }

getMainBarProvider()

ilGSProviderFactory::getMainBarProvider

(

)

Returns

StaticMainMenuProvider[]

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

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

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

                                        : 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;
    }

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.

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

                                        : 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;
    }

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.

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

                                             : 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;
    }

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.

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

                                              : 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;
    }

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.

References isInstanceCreationPossible(), and isRegistered().

                                                              : 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];
    }

Here is the call graph for this function:

getToastsProvider()

ilGSProviderFactory::getToastsProvider

(

)

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

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

                                       : 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;
    }

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.

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

                                     : 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;
    }

Here is the call graph for this function:

initPlugins()

ilGSProviderFactory::initPlugins ( )

private

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

References XapiProxy\$plugin.

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

                                  : 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();
            }
        }
    }

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.

Referenced by appendCore(), and getProviderByClassName().

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

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.

Referenced by getProviderByClassName().

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

Here is the caller graph for this function:

registerInternal()

ilGSProviderFactory::registerInternal ( array  $providers )

protected

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

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

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

Here is the caller graph for this function:

Field Documentation

$all_providers

array ilGSProviderFactory::$all_providers = []

protected

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

$class_loader

array ilGSProviderFactory::$class_loader

private

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

$component_factory

ilComponentFactory ilGSProviderFactory::$component_factory

protected

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

$component_repository

ilComponentRepository ilGSProviderFactory::$component_repository

protected

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

$footer_item_information

readonly ilFooterCustomItemInformation ilGSProviderFactory::$footer_item_information

private

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

Referenced by getFooterItemInformation().

$main_menu_item_information

readonly ItemInformation ilGSProviderFactory::$main_menu_item_information

private

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

Referenced by getMainBarItemInformation().

$plugin_provider_collections

array ilGSProviderFactory::$plugin_provider_collections = null

private

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

---

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

• components/ILIAS/GlobalScreen_/classes/class.ilGSProviderFactory.php