ilGSProviderFactory Class Reference

Class ilGSProviderFactory. More...

Inheritance diagram for ilGSProviderFactory:

Collaboration diagram for ilGSProviderFactory:

Public Member Functions
	__construct (Container $dic)
	getMainBarProvider ()
	getMetaBarProvider ()
	getToolProvider ()
	getModificationProvider ()
	getNotificationsProvider ()
	getMainBarItemInformation ()
	getProviderByClassName (string $class_name)
	isInstanceCreationPossible (string $class_name)
	isRegistered (string $class_name)

Protected Member Functions
	registerInternal (array $providers)

Protected Attributes
	$all_providers

Private Member Functions
	initPlugins ()
	appendPlugins (array &$array_of_core_providers, string $interface)
	appendCore (array &$array_of_providers, string $interface)

Private Attributes
	$plugin_provider_collections = null
	$class_loader
	$dic
	$main_menu_item_information = null

Detailed Description

Class ilGSProviderFactory.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilGSProviderFactory::__construct

(

Container

$dic

)

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

References $dic.

    {
        $this->dic                        = $dic;
        $this->main_menu_item_information = new ilMMItemInformation();
        $this->class_loader               = include "Services/GlobalScreen/artifacts/global_screen_providers.php";
    }

Member Function Documentation

appendCore()

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

private

Parameters

array	$array_of_providers
string	$interface

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

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

Referenced by getMainBarProvider(), getMetaBarProvider(), getModificationProvider(), getNotificationsProvider(), 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 $e) {
                    $i = $e;
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

appendPlugins()

ilGSProviderFactory::appendPlugins ( array &  $array_of_core_providers, string  $interface  )

private

Parameters

array	$array_of_core_providers
string	$interface

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

References ilPluginAdmin\getAllGlobalScreenProviders().

                                                                                       : void
    {
        // Plugins
        static $plugin_providers;

        $plugin_providers = $plugin_providers ?? ilPluginAdmin::getAllGlobalScreenProviders();

        foreach ($plugin_providers as $provider) {
            if (is_a($provider, $interface)) {
                $array_of_core_providers[] = $provider;
            }
        }
    }

Here is the call graph for this function:

getMainBarItemInformation()

ilGSProviderFactory::getMainBarItemInformation

(

)

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

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

References $main_menu_item_information.

                                                : ItemInformation
    {
        return $this->main_menu_item_information;
    }

getMainBarProvider()

ilGSProviderFactory::getMainBarProvider

(

)

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

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

References 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

(

)

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

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

References 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

(

)

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

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

References 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

(

)

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

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

References 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

)

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

Definition at line 234 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:

getToolProvider()

ilGSProviderFactory::getToolProvider

(

)

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

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

References 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 52 of file class.ilGSProviderFactory.php.

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

                                   : void
    {
        if (!is_array($this->plugin_provider_collections)) {
            $this->plugin_provider_collections = [];
            foreach (ilPluginAdmin::getGlobalScreenProviderCollections() as $collection) {
                $this->plugin_provider_collections[] = $collection;
            }
        }
    }

Here is the caller graph for this function:

isInstanceCreationPossible()

ilGSProviderFactory::isInstanceCreationPossible

(

string

$class_name

)

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

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

References Vendor\Package\$e.

Referenced by appendCore(), and getProviderByClassName().

                                                                   : bool
    {
        try {
            return class_exists($class_name) && $class_name !== ilPluginGlobalScreenNullProvider::class;
        } catch (\Throwable $e) {
            return false;
        }
    }

Here is the caller graph for this function:

isRegistered()

ilGSProviderFactory::isRegistered

(

string

$class_name

)

Implements ILIAS\GlobalScreen\Provider\ProviderFactory.

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

Parameters

array

$providers

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

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

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

Here is the caller graph for this function:

Field Documentation

$all_providers

ilGSProviderFactory::$all_providers

protected

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

$class_loader

ilGSProviderFactory::$class_loader

private

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

$dic

ilGSProviderFactory::$dic

private

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

Referenced by __construct().

$main_menu_item_information

ilGSProviderFactory::$main_menu_item_information = null

private

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

Referenced by getMainBarItemInformation().

$plugin_provider_collections

ilGSProviderFactory::$plugin_provider_collections = null

private

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

---

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

• Services/GlobalScreen/classes/class.ilGSProviderFactory.php