class.ilGSProviderFactory.php

Go to the documentation of this file.

<?php
 
use ILIAS\DI\Container;
use ILIAS\GlobalScreen\Provider\Provider;
use ILIAS\GlobalScreen\Provider\ProviderCollection;
use ILIAS\GlobalScreen\Provider\ProviderFactory;
use ILIAS\GlobalScreen\Scope\Layout\Provider\ModificationProvider;
use ILIAS\GlobalScreen\Scope\MainMenu\Collector\Information\ItemInformation;
use ILIAS\GlobalScreen\Scope\MainMenu\Provider\StaticMainMenuProvider;
use ILIAS\GlobalScreen\Scope\MetaBar\Provider\StaticMetaBarProvider;
use ILIAS\GlobalScreen\Scope\Notification\Provider\NotificationProvider;
use ILIAS\GlobalScreen\Scope\Tool\Provider\DynamicToolProvider;
 
class ilGSProviderFactory implements ProviderFactory
{
 
    private $plugin_provider_collections = null;
    private $class_loader;
    private $dic;
    private $main_menu_item_information = null;
    protected $all_providers;
 
    public function __construct(Container $dic)
    {
        $this->dic                        = $dic;
        $this->main_menu_item_information = new ilMMItemInformation();
        $this->class_loader               = include "Services/GlobalScreen/artifacts/global_screen_providers.php";
    }
 
    private function initPlugins() : void
    {
        if (!is_array($this->plugin_provider_collections)) {
            $this->plugin_provider_collections = [];
            foreach (ilPluginAdmin::getGlobalScreenProviderCollections() as $collection) {
                $this->plugin_provider_collections[] = $collection;
            }
        }
    }
 
    protected function registerInternal(array $providers)
    {
        array_walk(
            $providers,
            function (Provider $item) {
                $this->all_providers[get_class($item)] = $item;
            }
        );
    }
 
    public function getMainBarProvider() : 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;
    }
 
    public function getMetaBarProvider() : 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;
    }
 
    public function getToolProvider() : 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;
    }
 
    public function getModificationProvider() : 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;
    }
 
    public function getNotificationsProvider() : 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;
    }
 
    private function appendPlugins(array &$array_of_core_providers, string $interface) : 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;
            }
        }
    }
 
    private function appendCore(array &$array_of_providers, string $interface) : 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;
                }
            }
        }
    }
 
    public function getMainBarItemInformation() : ItemInformation
    {
        return $this->main_menu_item_information;
    }
 
    public function getProviderByClassName(string $class_name) : 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];
    }
 
    public function isInstanceCreationPossible(string $class_name) : bool
    {
        try {
            return class_exists($class_name) && $class_name !== ilPluginGlobalScreenNullProvider::class;
        } catch (\Throwable $e) {
            return false;
        }
    }
 
    public function isRegistered(string $class_name) : bool
    {
        return isset($this->all_providers[$class_name]);
    }
}