Application::initializeModule() - Code Metrics - Inspection of "Merge pull request #35 from roquie/added_forgotten..." - igniphp/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 22aab3...557f5d )

by Dawid

created 2018-12-08 17:55 UTC

Application::initializeModule() A

↳ Parent: Application

Complexity

Conditions	6
Paths	32

Size

Total Lines	20
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	6.2163

Importance

Changes

Metric	Value
cc	6
eloc	10
nc	32
nop	1
dl	0
loc	20
ccs	9
cts	11
cp	0.8182
crap	6.2163
rs	9.2222
c	0
b	0
f	0

<?php declare(strict_types=1);

namespace Igni\Application;

use Igni\Application\Exception\ApplicationException;
use Igni\Application\Http\MiddlewareAggregator;
use Igni\Application\Listeners\OnBootListener;
use Igni\Application\Listeners\OnErrorListener;
use Igni\Application\Listeners\OnRunListener;
use Igni\Application\Listeners\OnShutDownListener;
use Igni\Application\Providers\ConfigProvider;
use Igni\Application\Providers\ControllerProvider;
use Igni\Application\Providers\MiddlewareProvider;
use Igni\Application\Providers\ServiceProvider;
use Igni\Container\DependencyResolver;
use Igni\Container\ServiceLocator;
use Psr\Container\ContainerInterface;
use Throwable;

/**
 * Main glue between all components.
 *
 * @package Igni\Application
 */
abstract class Application
{
    /**
     * @var ServiceLocator|ContainerInterface
     */
    private $container;

    /**
     * @var Config
     */
    private $config;

    /**
     * @var bool
     */
    private $initialized = false;

    /**
     * @var object[]|class[]
     */
    protected $modules;

    /**
     * @var DependencyResolver
     */
    protected $resolver;

    /**
     * Application constructor.
     *
     * @param ContainerInterface|null $container
     */
    public function __construct(ContainerInterface $container = null)
    {
        if ($container === null) {
            $container = new ServiceLocator();
        }

        $this->container = $container;
        $this->resolver = new DependencyResolver($this->container);

        if ($this->container->has(Config::class)) {
            $this->config = $this->container->get(Config::class);
        } else {
            $this->config = new Config([]);
        }

        $this->modules = [];
    }

    /**
     * Allows for application extension by modules.
     * Module can be any valid object or class name.
     *
     * @param $module
     */
    public function extend($module): void
    {
        if (is_object($module) || class_exists($module)) {
            $this->modules[] = $module;
        } else {
            throw ApplicationException::forInvalidModule($module);
        }
    }

    /**
     * Starts the application.
     * Initialize modules. Performs tasks to generate response for the client.
     *
     * @return mixed
     */
    abstract public function run();

    /**
     * Controller aggregator is used to register application's controllers.
     * @return ControllerAggregator
     */
    abstract public function getControllerAggregator(): ControllerAggregator;

    /**
     * Middleware aggregator is used to register application's middlewares.
     * @return MiddlewareAggregator
     */
    abstract public function getMiddlewareAggregator(): MiddlewareAggregator;

    /**
     * @return Config
     */
    public function getConfig(): Config
    {
        return $this->config;
    }

    public function getContainer(): ContainerInterface
    {
        return $this->container;
    }

    protected function handleOnBootListeners(): void
    {
        foreach ($this->modules as $module) {
            if ($module instanceof OnBootListener) {
                $module->onBoot($this);
            }
        }
    }

    protected function handleOnShutDownListeners(): void
    {
        foreach ($this->modules as $module) {
            if ($module instanceof OnShutDownListener) {
                $module->onShutDown($this);
            }
        }
    }

    protected function handleOnErrorListeners(Throwable $exception): Throwable
    {
        foreach ($this->modules as $module) {
            if ($module instanceof OnErrorListener) {
                $exception = $module->onError($this, $exception);
            }
        }

        return $exception;
    }

    protected function handleOnRunListeners(): void
    {
        foreach ($this->modules as $module) {
            if ($module instanceof OnRunListener) {
                $module->onRun($this);
            }
        }
    }

    protected function initialize(): void
    {
        if ($this->initialized) {
            return;
        }

        foreach ($this->modules as &$module) {
            $this->initializeModule($module);
        }

        $this->initialized = true;
    }

    protected function initializeModule(&$module): void
    {
        if (is_string($module)) {
            $module = $this->resolver->resolve($module);
        }

        if ($module instanceof ConfigProvider) {
            $module->provideConfig($this->getConfig());
        }

        if ($module instanceof ControllerProvider) {
            $module->provideControllers($this->getControllerAggregator());
        }

        if ($module instanceof ServiceProvider) {
            $module->provideServices($this->getContainer());
        }

        if ($module instanceof MiddlewareProvider) {
            $module->provideMiddleware($this->getMiddlewareAggregator());
        }
    }
}


1		<?php declare(strict_types=1);
2
3		namespace Igni\Application;
4
5		use Igni\Application\Exception\ApplicationException;
6		use Igni\Application\Http\MiddlewareAggregator;
7		use Igni\Application\Listeners\OnBootListener;
8		use Igni\Application\Listeners\OnErrorListener;
9		use Igni\Application\Listeners\OnRunListener;
10		use Igni\Application\Listeners\OnShutDownListener;
11		use Igni\Application\Providers\ConfigProvider;
12		use Igni\Application\Providers\ControllerProvider;
13		use Igni\Application\Providers\MiddlewareProvider;
14		use Igni\Application\Providers\ServiceProvider;
15		use Igni\Container\DependencyResolver;
16		use Igni\Container\ServiceLocator;
17		use Psr\Container\ContainerInterface;
18		use Throwable;
19
20		/**
21		* Main glue between all components.
22		*
23		* @package Igni\Application
24		*/
25		abstract class Application
26		{
27		/**
28		* @var ServiceLocator\|ContainerInterface
29		*/
30		private $container;
31
32		/**
33		* @var Config
34		*/
35		private $config;
36
37		/**
38		* @var bool
39		*/
40		private $initialized = false;
41
42		/**
43		* @var object[]\|class[]
44		*/
45		protected $modules;
46
47		/**
48		* @var DependencyResolver
49		*/
50		protected $resolver;
51
52		/**
53		* Application constructor.
54		*
55		* @param ContainerInterface\|null $container
56		*/
57	23	public function __construct(ContainerInterface $container = null)
58		{
59	23	if ($container === null) {
60	20	$container = new ServiceLocator();
61		}
62
63	23	$this->container = $container;
64	23	$this->resolver = new DependencyResolver($this->container);
65
66	23	if ($this->container->has(Config::class)) {
67		$this->config = $this->container->get(Config::class);
68		} else {
69	23	$this->config = new Config([]);
70		}
71
72	23	$this->modules = [];
73	23	}
74
75		/**
76		* Allows for application extension by modules.
77		* Module can be any valid object or class name.
78		*
79		* @param $module
80		*/
81	4	public function extend($module): void
82		{
83	4	if (is_object($module) \|\| class_exists($module)) {
84	3	$this->modules[] = $module;
85		} else {
86	1	throw ApplicationException::forInvalidModule($module);
87		}
88	3	}
89
90		/**
91		* Starts the application.
92		* Initialize modules. Performs tasks to generate response for the client.
93		*
94		* @return mixed
95		*/
96		abstract public function run();
97
98		/**
99		* Controller aggregator is used to register application's controllers.
100		* @return ControllerAggregator
101		*/
102		abstract public function getControllerAggregator(): ControllerAggregator;
103
104		/**
105		* Middleware aggregator is used to register application's middlewares.
106		* @return MiddlewareAggregator
107		*/
108		abstract public function getMiddlewareAggregator(): MiddlewareAggregator;
109
110		/**
111		* @return Config
112		*/
113	1	public function getConfig(): Config
114		{
115	1	return $this->config;
116		}
117
118	20	public function getContainer(): ContainerInterface
119		{
120	20	return $this->container;
121		}
122
123	9	protected function handleOnBootListeners(): void
124		{
125	9	foreach ($this->modules as $module) {
126	2	if ($module instanceof OnBootListener) {
127	2	$module->onBoot($this);
128		}
129		}
130	9	}
131
132	2	protected function handleOnShutDownListeners(): void
133		{
134	2	foreach ($this->modules as $module) {
135	2	if ($module instanceof OnShutDownListener) {
136	2	$module->onShutDown($this);
137		}
138		}
139	2	}
140
141	3	protected function handleOnErrorListeners(Throwable $exception): Throwable
142		{
143	3	foreach ($this->modules as $module) {
144	2	if ($module instanceof OnErrorListener) {
145	2	$exception = $module->onError($this, $exception);
146		}
147		}
148
149	3	return $exception;
150		}
151
152	9	protected function handleOnRunListeners(): void
153		{
154	9	foreach ($this->modules as $module) {
155	2	if ($module instanceof OnRunListener) {
156	2	$module->onRun($this);
157		}
158		}
159	9	}
160
161	9	protected function initialize(): void
162		{
163	9	if ($this->initialized) {
164		return;
165		}
166
167	9	foreach ($this->modules as &$module) {
168	2	$this->initializeModule($module);
169		}
170
171	9	$this->initialized = true;
172	9	}
173
174	2	protected function initializeModule(&$module): void
175		{
176	2	if (is_string($module)) {
177	1	$module = $this->resolver->resolve($module);
178		}
179
180	2	if ($module instanceof ConfigProvider) {
181		$module->provideConfig($this->getConfig());
182		}
183
184	2	if ($module instanceof ControllerProvider) {
185	1	$module->provideControllers($this->getControllerAggregator());
186		}
187
188	2	if ($module instanceof ServiceProvider) {
189		$module->provideServices($this->getContainer());
190		}
191
192	2	if ($module instanceof MiddlewareProvider) {
193	1	$module->provideMiddleware($this->getMiddlewareAggregator());
194		}
195	2	}
196		}
197

igniphp / framework

Push — master ( 22aab3...557f5d )

Application::initializeModule() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like