DataProviderManager::registerPlugin() - Code Metrics - Inspection of "Refactor service names" - eXpansionPluginPack/eXpansion2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#80)

by De Cramer

created 2017-07-22 12:10 UTC

DataProviderManager::registerPlugin() A

↳ Parent: DataProviderManager

Complexity

Conditions	2
Paths	2

Size

Total Lines	17
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	17
rs	9.4285
c	0
b	0
f	0
ccs	11
cts	11
cp	1
cc	2
eloc	11
nc	2
nop	5
crap	2

<?php

namespace eXpansion\Framework\Core\Services;

use eXpansion\Framework\Core\DataProviders\AbstractDataProvider;
use eXpansion\Framework\Core\Exceptions\DataProvider\UncompatibleException;
use eXpansion\Framework\Core\Model\ProviderListener;
use eXpansion\Framework\Core\Plugins\StatusAwarePluginInterface;
use eXpansion\Framework\Core\Storage\GameDataStorage;
use oliverde8\AssociativeArraySimplified\AssociativeArray;
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerAwareTrait;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Class DataProviderManager handles all the data providers.
 *
 * @TODO handle gamemode change.
 *
 * @package eXpansion\Framework\Core\Services
 */
class DataProviderManager
{
    /** For compatibility with every title/mode/script */
    const COMPATIBLE_ALL = "ALL";

    /** @var int[][][][]  List of providers by compatibility. */
    protected $providersByCompatibility = [];

    /** @var string[] Name of the provider for a service Id. */
    protected $providerById = [];

    /** @var string[] Interface a plugin needs extend/implement to be used by a provider. */
    protected $providerInterfaces = [];

    /** @var ProviderListener[][] Providers that listen a certain event. */
    protected $providerListeners = [];

    /** @var array[][] Enabled providers that listen to certain events. */
    protected $enabledProviderListeners = [];

    /** @var ContainerInterface */
    protected $container;

    /** @var GameDataStorage */
    protected $gameDataStorage;

    /** @var Console */
    protected $console;

    /**
     * DataProviderManager constructor.
     *
     * @param ContainerInterface $container
     * @param GameDataStorage $gameDataStorage
     * @param Console $console
     */
    public function __construct(ContainerInterface $container, GameDataStorage $gameDataStorage, Console $console)
    {
        $this->container = $container;
        $this->gameDataStorage = $gameDataStorage;
        $this->console = $console;
    }

    /**
     * Initialize all the providers properly.
     * @param PluginManager $pluginManager
     */
    public function init(PluginManager $pluginManager)
    {
        $this->reset($pluginManager);
    }

    /**
     * Reset
     * @param PluginManager $pluginManager
     */
    public function reset(PluginManager $pluginManager)
    {
        $title = $this->gameDataStorage->getTitle();
        $mode = $this->gameDataStorage->getGameModeCode();
        $script = $this->gameDataStorage->getGameInfos()->scriptName;

        foreach ($this->providersByCompatibility as $provider => $data) {

            $providerId = $this->getCompatibleProviderId($provider, $title, $mode, $script);

            if ($providerId) {
                $providerService = $this->container->get($providerId);

                if ($pluginManager->isPluginEnabled($providerId)) {
                    foreach ($this->providerListeners[$providerId] as $listener) {
                        $this->enabledProviderListeners[$listener->getEventName()][] = [
                            $providerService,
                            $listener->getMethod(),
                        ];
                    }
                }
            }
        }
    }

    /**
     * Register a provider.
     *
     * @param string $id
     * @param string $provider
     * @param string $interface
     * @param string[][] $compatibilities
     * @param string[] $listeners
     */
    public function registerDataProvider($id, $provider, $interface, $compatibilities, $listeners)
    {
        foreach ($compatibilities as $compatibility) {
            $this->providersByCompatibility[$provider][$compatibility['title']][$compatibility['mode']][$compatibility['script']] = $id;
        }

        foreach ($listeners as $eventName => $method) {
            $this->providerListeners[$id][] = new ProviderListener($eventName, $provider, $method);
        }
        $this->providerInterfaces[$provider] = $interface;
        $this->providerById[$id] = $provider;
    }

    /**
     * Check of a provider is compatible
     *
     * @param string $provider
     * @param string $title
     * @param string $mode
     * @param string $script
     *
     * @return bool
     */
    public function isProviderCompatible($provider, $title, $mode, $script)
    {
        return !is_null($this->getCompatibleProviderId($provider, $title, $mode, $script));
    }

    /**
     * @param string $provider
     * @param string $title
     * @param string $mode
     * @param string $script
     *
     * @return string|null
     */
    public function getCompatibleProviderId($provider, $title, $mode, $script)
    {
        $parameters = [
            [$provider, $title, $mode, $script],
            [$provider, $title, $mode, self::COMPATIBLE_ALL],
            [$provider, $title, self::COMPATIBLE_ALL, self::COMPATIBLE_ALL],
            [$provider, self::COMPATIBLE_ALL, self::COMPATIBLE_ALL, self::COMPATIBLE_ALL],
        ];

        foreach ($parameters as $parameter) {
            $id = AssociativeArray::getFromKey($this->providersByCompatibility, $parameter);
            if (!is_null($id)) {
                return $id;
            }
        }

        return null;
    }

    /**
     * Register a plugin to the DataProviders.
     *
     * @param string $provider The provider to register the plugin to.
     * @param string $pluginId The id of the plugin to be registered.
     * @param string $title The title to register it for.
     * @param string $mode The mode to register it for.
     * @param string $script The script to register it for.
     *
     * @throws UncompatibleException
     */
    public function registerPlugin($provider, $pluginId, $title, $mode, $script)
    {
        $providerId = $this->getCompatibleProviderId($provider, $title, $mode, $script);
        /** @var AbstractDataProvider $providerService */
        $providerService = $this->container->get($providerId);
        $pluginService = $this->container->get($pluginId);
        $interface = $this->providerInterfaces[$provider];

        if ($pluginService instanceof $interface) {
            $this->deletePlugin($provider, $pluginId);
            $providerService->registerPlugin($pluginId, $pluginService);
        } else {
            throw new UncompatibleException("Plugin $pluginId isn't compatible with $provider. Should be instance of $interface");
        }

        $this->console->getConsoleOutput()->writeln("\t<info>- $provider : $providerId</info>");
    }

    /**
     * Provider to delete a plugin from.
     *
     * @param $provider
     * @param $pluginId
     *
     */
    public function deletePlugin($provider, $pluginId)
    {
        foreach ($this->providersByCompatibility[$provider] as $titleProviders) {
            foreach ($titleProviders as $modeProviders) {
                foreach ($modeProviders as $providerId) {
                    $providerService = $this->container->get($providerId);
                    $providerService->deletePlugin($pluginId);
                }
            }
        }
    }

    /**
     * Dispatch event to the data providers.
     *
     * @param $eventName
     * @param $params
     */
    public function dispatch($eventName, $params)
    {
        if (isset($this->enabledProviderListeners[$eventName])) {
            foreach ($this->enabledProviderListeners[$eventName] as $callback) {
                call_user_func_array($callback, $params);
            }
        }
    }
}


1		<?php
2
3		namespace eXpansion\Framework\Core\Services;
4
5		use eXpansion\Framework\Core\DataProviders\AbstractDataProvider;
6		use eXpansion\Framework\Core\Exceptions\DataProvider\UncompatibleException;
7		use eXpansion\Framework\Core\Model\ProviderListener;
8		use eXpansion\Framework\Core\Plugins\StatusAwarePluginInterface;
9		use eXpansion\Framework\Core\Storage\GameDataStorage;
10		use oliverde8\AssociativeArraySimplified\AssociativeArray;
11		use Symfony\Component\DependencyInjection\ContainerAwareInterface;
12		use Symfony\Component\DependencyInjection\ContainerAwareTrait;
13		use Symfony\Component\DependencyInjection\ContainerInterface;
14
15		/**
16		* Class DataProviderManager handles all the data providers.
17		*
18		* @TODO handle gamemode change.
19		*
20		* @package eXpansion\Framework\Core\Services
21		*/
22		class DataProviderManager
23		{
24		/** For compatibility with every title/mode/script */
25		const COMPATIBLE_ALL = "ALL";
26
27		/** @var int[][][][] List of providers by compatibility. */
28		protected $providersByCompatibility = [];
29
30		/** @var string[] Name of the provider for a service Id. */
31		protected $providerById = [];
32
33		/** @var string[] Interface a plugin needs extend/implement to be used by a provider. */
34		protected $providerInterfaces = [];
35
36		/** @var ProviderListener[][] Providers that listen a certain event. */
37		protected $providerListeners = [];
38
39		/** @var array[][] Enabled providers that listen to certain events. */
40		protected $enabledProviderListeners = [];
41
42		/** @var ContainerInterface */
43		protected $container;
44
45		/** @var GameDataStorage */
46		protected $gameDataStorage;
47
48		/** @var Console */
49		protected $console;
50
51		/**
52		* DataProviderManager constructor.
53		*
54		* @param ContainerInterface $container
55		* @param GameDataStorage $gameDataStorage
56		* @param Console $console
57		*/
58	52	public function __construct(ContainerInterface $container, GameDataStorage $gameDataStorage, Console $console)
59		{
60	52	$this->container = $container;
61	52	$this->gameDataStorage = $gameDataStorage;
62	52	$this->console = $console;
63	52	}
64
65		/**
66		* Initialize all the providers properly.
67		* @param PluginManager $pluginManager
68		*/
69	1	public function init(PluginManager $pluginManager)
70		{
71	1	$this->reset($pluginManager);
72	1	}
73
74		/**
75		* Reset
76		* @param PluginManager $pluginManager
77		*/
78	1	public function reset(PluginManager $pluginManager)
79		{
80	1	$title = $this->gameDataStorage->getTitle();
81	1	$mode = $this->gameDataStorage->getGameModeCode();
82	1	$script = $this->gameDataStorage->getGameInfos()->scriptName;
83
84	1	foreach ($this->providersByCompatibility as $provider => $data) {
85
86	1	$providerId = $this->getCompatibleProviderId($provider, $title, $mode, $script);
87
88	1	if ($providerId) {
89	1	$providerService = $this->container->get($providerId);
90
91	1	if ($pluginManager->isPluginEnabled($providerId)) {
92	1	foreach ($this->providerListeners[$providerId] as $listener) {
93	1	$this->enabledProviderListeners[$listener->getEventName()][] = [
94	1	$providerService,
95	1	$listener->getMethod(),
96		];
97		}
98		}
99		}
100		}
101	1	}
102
103		/**
104		* Register a provider.
105		*
106		* @param string $id
107		* @param string $provider
108		* @param string $interface
109		* @param string[][] $compatibilities
110		* @param string[] $listeners
111		*/
112	52	public function registerDataProvider($id, $provider, $interface, $compatibilities, $listeners)
113		{
114	52	foreach ($compatibilities as $compatibility) {
115	52	$this->providersByCompatibility[$provider][$compatibility['title']][$compatibility['mode']][$compatibility['script']] = $id;
116		}
117
118	52	foreach ($listeners as $eventName => $method) {
119	52	$this->providerListeners[$id][] = new ProviderListener($eventName, $provider, $method);
120		}
121	52	$this->providerInterfaces[$provider] = $interface;
122	52	$this->providerById[$id] = $provider;
123	52	}
124
125		/**
126		* Check of a provider is compatible
127		*
128		* @param string $provider
129		* @param string $title
130		* @param string $mode
131		* @param string $script
132		*
133		* @return bool
134		*/
135	1	public function isProviderCompatible($provider, $title, $mode, $script)
136		{
137	1	return !is_null($this->getCompatibleProviderId($provider, $title, $mode, $script));
138		}
139
140		/**
141		* @param string $provider
142		* @param string $title
143		* @param string $mode
144		* @param string $script
145		*
146		* @return string\|null
147		*/
148	4	public function getCompatibleProviderId($provider, $title, $mode, $script)
149		{
150		$parameters = [
151	4	[$provider, $title, $mode, $script],
152	4	[$provider, $title, $mode, self::COMPATIBLE_ALL],
153	4	[$provider, $title, self::COMPATIBLE_ALL, self::COMPATIBLE_ALL],
154	4	[$provider, self::COMPATIBLE_ALL, self::COMPATIBLE_ALL, self::COMPATIBLE_ALL],
155		];
156
157	4	foreach ($parameters as $parameter) {
158	4	$id = AssociativeArray::getFromKey($this->providersByCompatibility, $parameter);
159	4	if (!is_null($id)) {
160	4	return $id;
161		}
162		}
163
164	2	return null;
165		}
166
167		/**
168		* Register a plugin to the DataProviders.
169		*
170		* @param string $provider The provider to register the plugin to.
171		* @param string $pluginId The id of the plugin to be registered.
172		* @param string $title The title to register it for.
173		* @param string $mode The mode to register it for.
174		* @param string $script The script to register it for.
175		*
176		* @throws UncompatibleException
177		*/
178	2	public function registerPlugin($provider, $pluginId, $title, $mode, $script)
179		{
180	2	$providerId = $this->getCompatibleProviderId($provider, $title, $mode, $script);
181		/** @var AbstractDataProvider $providerService */
182	2	$providerService = $this->container->get($providerId);
183	2	$pluginService = $this->container->get($pluginId);
184	2	$interface = $this->providerInterfaces[$provider];
185
186	2	if ($pluginService instanceof $interface) {
187	1	$this->deletePlugin($provider, $pluginId);
188	1	$providerService->registerPlugin($pluginId, $pluginService);
189		} else {
190	1	throw new UncompatibleException("Plugin $pluginId isn't compatible with $provider. Should be instance of $interface");
191		}
192
193	1	$this->console->getConsoleOutput()->writeln("\t<info>- $provider : $providerId</info>");
194	1	}
195
196		/**
197		* Provider to delete a plugin from.
198		*
199		* @param $provider
200		* @param $pluginId
201		*
202		*/
203	1	public function deletePlugin($provider, $pluginId)
204		{
205	1	foreach ($this->providersByCompatibility[$provider] as $titleProviders) {
206	1	foreach ($titleProviders as $modeProviders) {
207	1	foreach ($modeProviders as $providerId) {
208	1	$providerService = $this->container->get($providerId);
209	1	$providerService->deletePlugin($pluginId);
210		}
211		}
212		}
213	1	}
214
215		/**
216		* Dispatch event to the data providers.
217		*
218		* @param $eventName
219		* @param $params
220		*/
221	1	public function dispatch($eventName, $params)
222		{
223	1	if (isset($this->enabledProviderListeners[$eventName])) {
224	1	foreach ($this->enabledProviderListeners[$eventName] as $callback) {
225	1	call_user_func_array($callback, $params);
226		}
227		}
228	1	}
229		}
230

eXpansionPluginPack / eXpansion2

Pull Request — master (#80)

DataProviderManager::registerPlugin() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like