DataProviderManager::init() - Code Metrics - Inspection of "Merge branch 'odev'" - eXpansionPluginPack/eXpansion2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fff0f0...89663a )

by De Cramer

created 2017-05-13 11:22 UTC

DataProviderManager::init() B

↳ Parent: DataProviderManager

Complexity

Conditions	5
Paths	5

Size

Total Lines	26
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	5

Importance

Changes

Metric	Value
dl	0
loc	26
rs	8.439
c	0
b	0
f	0
ccs	14
cts	14
cp	1
cc	5
eloc	13
nc	5
nop	1
crap	5

<?php

namespace eXpansion\Framework\Core\Services;

use eXpansion\Framework\Core\DataProviders\AbstractDataProvider;
use eXpansion\Framework\Core\Exceptions\DataProvider\UncompatibleException;
use eXpansion\Framework\Core\Model\ProviderListner;
use eXpansion\Framework\Core\Plugins\StatusAwarePluginInterface;
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 ProviderListner[][] Providers that listen a certain event. */
    protected $providerListeners = [];

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

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

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

    /**
     * Initialize all the providers properly.
     */
    public function init(PluginManager $pluginManager)
    {
        // TODO run check in order not  to have same providers multiple times.
        // TODO get this data from the dedicated!
        $title = 'TMStadium@nadeo';
        $mode = 'script';
        $script = 'TimeAttack.script.txt';

        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 ProviderListner($eventName, $provider, $method);
        }
        $this->providerInterfaces[$provider] = $interface;
        $this->providerById[$id] = $provider;
    }

    /**
     * Checl 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)
    {
        /** @var AbstractDataProvider $providerService */
        $providerService = $this->container->get($this->getCompatibleProviderId($provider, $title, $mode, $script));
        $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");
        }
    }

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

eXpansionPluginPack / eXpansion2

Push — master ( fff0f0...89663a )

DataProviderManager::init() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like