ApplicationPackage::setupViewEngine() - Code Metrics - Inspection of "Adding Downloads controller" - delboy1978uk/bone - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev-master ( ee40ad...39856d )

by Derek Stephen

created 2019-11-05 18:40 UTC

ApplicationPackage::setupViewEngine() B

↳ Parent: ApplicationPackage

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	27
Ratio	45 %

Code Coverage

Tests	40
CRAP Score	2

Importance

Changes

Metric	Value
dl	27
loc	60
ccs	40
cts	40
cp	1
rs	8.8727
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	2

How to fix Long Method

<?php

namespace Bone\Mvc;

use Barnacle\Container;
use Barnacle\RegistrationInterface;
use Bone\I18n\I18nRegistrationInterface;
use Bone\Mvc\Controller\DownloadController;
use Bone\Mvc\Router\Decorator\ExceptionDecorator;
use Bone\Mvc\Router\Decorator\NotAllowedDecorator;
use Bone\Mvc\Router\Decorator\NotFoundDecorator;
use Bone\Mvc\Router\PlatesStrategy;
use Bone\Mvc\Router\RouterConfigInterface;
use Bone\Mvc\View\Extension\Plates\AlertBox;
use Bone\Mvc\View\Extension\Plates\LocaleLink;
use Bone\Mvc\View\Extension\Plates\Translate;
use Bone\View\Helper\Paginator;
use Bone\Mvc\View\PlatesEngine;
use Bone\Service\TranslatorFactory;
use League\Route\Router;
use League\Route\Strategy\ApplicationStrategy;
use League\Route\Strategy\JsonStrategy;
use Locale;
use PDO;
use Zend\Diactoros\ResponseFactory;
use Zend\I18n\Translator\Loader\Gettext;
use Zend\I18n\Translator\Translator;

class ApplicationPackage implements RegistrationInterface
{
    /** @var array $config */
    private $config;

    /** @var Router $router */
    private $router;

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

    /** @var array $supportedLocales */
    private $supportedLocales = [];

    /**
     * ApplicationPackage constructor.
     * @param array $config
     * @param \League\Route\Router $router
     */
    public function __construct(array $config, Router $router)
    {
        $this->config = $config;
        $this->router = $router;
    }

    /**
     * @param Container $c
     */
    public function addToContainer(Container $c)
    {
        $this->setConfigArray($c);
        $this->setLocale($c);
        $this->setupLogs($c);
        $this->setupPdoConnection($c);
        $this->setupViewEngine($c);
        $this->setupTranslator($c);
        $this->setupModules($c);
        $this->setupDownloadController($c);
    }

    /**
     * @param Container $c
     */
    private function setConfigArray(Container $c)
    {
        foreach ($this->config as $key => $value) {
            $c[$key] = $value;
        }
    }

    /**
     * @param Container $c
     */
    private function setLocale(Container $c)
    {
        $i18n = $c->get('i18n');
        $this->i18nEnabledSite = $i18n['enabled'];
        $this->supportedLocales = $i18n['supported_locales'];
        $defaultLocale = $i18n['default_locale'];
        Locale::setDefault($defaultLocale);
    }

    /**
     * @param Container $c
     */
    private function setupViewEngine(Container $c)
    {
        // set up the view engine dependencies
        $viewEngine = new PlatesEngine($c->get('viewFolder'));
        $viewEngine->loadExtension(new AlertBox());

        $c[PlatesEngine::class] = $viewEngine;

        $c[NotFoundDecorator::class] = $c->factory(function (Container $c) {

            $layout = $c->get('default_layout');
            $templates = $c->get('error_pages');
            $viewEngine = $c->get(PlatesEngine::class);
            $notFoundDecorator = new NotFoundDecorator($viewEngine, $templates);
            $notFoundDecorator->setLayout($layout);

            return $notFoundDecorator;
        });

        $c[NotAllowedDecorator::class] = $c->factory(function (Container $c) {

            $layout = $c->get('default_layout');
            $templates = $c->get('error_pages');
            $viewEngine = $c->get(PlatesEngine::class);
            $notAllowedDecorator = new NotAllowedDecorator($viewEngine, $templates);
            $notAllowedDecorator->setLayout($layout);

            return $notAllowedDecorator;
        });

        $c[ExceptionDecorator::class] = $c->factory(function (Container $c) {

            $viewEngine = $c->get(PlatesEngine::class);
            $layout = $c->get('default_layout');
            $templates = $c->get('error_pages');
            $decorator = new ExceptionDecorator($viewEngine, $templates);
            $decorator->setLayout($layout);

            return $decorator;
        });

        $c[PlatesStrategy::class] = $c->factory(function (Container $c) {
            $viewEngine = $c->get(PlatesEngine::class);
            $notFoundDecorator = $c->get(NotFoundDecorator::class);
            $notAllowedDecorator = $c->get(NotAllowedDecorator::class);
            $exceptionDecorator = $c->get(ExceptionDecorator::class);
            $layout = $c->get('default_layout');
            $strategy = new PlatesStrategy($viewEngine, $notFoundDecorator, $notAllowedDecorator, $layout, $exceptionDecorator);

            return $strategy;
        });

        /** @var PlatesStrategy $strategy */
        $strategy = $c->get(PlatesStrategy::class);
        $strategy->setContainer($c);

        if ($this->i18nEnabledSite === true) {
            $strategy->setI18nEnabled(true);
            $strategy->setSupportedLocales($this->supportedLocales);
        }

        $this->router->setStrategy($strategy);
    }

    /**
     * @param Container $c
     */
    private function setupModules(Container $c)
    {
        // set up the modules and vendor package modules
        $packages = $c->get('packages');
        $i18n = $c->get('i18n');
        /** @var Translator $translator */
        $translator = $c->get(Translator::class);

        foreach ($packages as $packageName) {
            if (class_exists($packageName)) {
                /** @var RegistrationInterface $package */
                $package = new $packageName();

                if ($package->hasEntityPath()) {
                    $paths = $c['entity_paths'];
                    $paths[] = $package->getEntityPath();
                    $c['entity_paths'] = $paths;
                }
            }
        }
        reset($packages);
        foreach ($packages as $packageName) {
            if (class_exists($packageName)) {
                /** @var RegistrationInterface $package */
                $package = new $packageName();
                $package->addToContainer($c);

                if ($package instanceof RouterConfigInterface) {
                    $package->addRoutes($c, $this->router);
                }

                if ($package instanceof I18nRegistrationInterface) {
                    foreach ($i18n['supported_locales'] as $locale) {
                        $factory = new TranslatorFactory();
                        $factory->addPackageTranslations($translator, $package, $locale);
                    }
                }
            }
        }
    }

    /**
     * @param Container $c
     */
    private function setupTranslator(Container $c)
    {
        $config = $c->get('i18n');
        $engine = $c->get(PlatesEngine::class);
        if (is_array($config)) {
            $factory = new TranslatorFactory();
            $translator = $factory->createTranslator($config);
            $engine->loadExtension(new Translate($translator));
            $engine->loadExtension(new LocaleLink());
            $defaultLocale = $config['default_locale'] ?: 'en_GB';
//            if (!in_array($locale, $config['supported_locales'])) {
//                $locale = $defaultLocale;
//            }
            $translator->setLocale($defaultLocale);
            $c[Translator::class] = $translator;
        }
    }


    /**
     * @param Container $c
     */
    private function setupPdoConnection(Container $c)
    {
        // set up a db connection
        $c[PDO::class] = $c->factory(function (Container $c): PDO {
            $credentials = $c->get('db');
            $host = $credentials['host'];
            $db = $credentials['database'];
            $user = $credentials['user'];
            $pass = $credentials['pass'];

            $dbConnection = new PDO('mysql:host=' . $host . ';dbname=' . $db, $user, $pass, [
                PDO::ATTR_EMULATE_PREPARES => false,
                PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
            ]);

            return $dbConnection;
        });
    }

    /**
     * @param Container $c
     */
    private function setupDownloadController(Container $c): void
    {
        $uploadDirectory = $c->get('uploads_dir');
        $c[DownloadController::class] = new DownloadController($uploadDirectory);
        $strategy = new JsonStrategy(new ResponseFactory());
        $strategy->setContainer($c);
        $this->router->map('GET', '/download', [DownloadController::class, 'downloadAction'])->setStrategy($strategy);
    }

    /**
     * @param Container $c
     */
    private function setupLogs(Container $c)
    {
        if ($c->has('display_errors')) {
            ini_set('display_errors', $c->get('display_errors'));
        }

        if ($c->has('error_reporting')) {
            error_reporting($c->get('error_reporting'));
        }

        if ($c->has('error_log')) {
            $errorLog = $c->get('error_log');
            if (!file_exists($errorLog)) {
                file_put_contents($errorLog, '');
                chmod($errorLog, 0775);
            }
            ini_set($c->get('error_log'), $errorLog);
        }
    }

    /**
     * @return string
     */
    public function getEntityPath(): string
    {
        return '';
    }

    /**
     * @return bool
     */
    public function hasEntityPath(): bool
    {
        return false;
    }
}

1			<?php
2
3			namespace Bone\Mvc;
4
5			use Barnacle\Container;
6			use Barnacle\RegistrationInterface;
7			use Bone\I18n\I18nRegistrationInterface;
8			use Bone\Mvc\Controller\DownloadController;
9			use Bone\Mvc\Router\Decorator\ExceptionDecorator;
10			use Bone\Mvc\Router\Decorator\NotAllowedDecorator;
11			use Bone\Mvc\Router\Decorator\NotFoundDecorator;
12			use Bone\Mvc\Router\PlatesStrategy;
13			use Bone\Mvc\Router\RouterConfigInterface;
14			use Bone\Mvc\View\Extension\Plates\AlertBox;
15			use Bone\Mvc\View\Extension\Plates\LocaleLink;
16			use Bone\Mvc\View\Extension\Plates\Translate;
17			use Bone\View\Helper\Paginator;
18			use Bone\Mvc\View\PlatesEngine;
19			use Bone\Service\TranslatorFactory;
20			use League\Route\Router;
21			use League\Route\Strategy\ApplicationStrategy;
22			use League\Route\Strategy\JsonStrategy;
23			use Locale;
24			use PDO;
25			use Zend\Diactoros\ResponseFactory;
26			use Zend\I18n\Translator\Loader\Gettext;
27			use Zend\I18n\Translator\Translator;
28
29			class ApplicationPackage implements RegistrationInterface
30			{
31			/** @var array $config */
32			private $config;
33
34			/** @var Router $router */
35			private $router;
36
37			/** @var bool $i18nEnabledSite */
38			private $i18nEnabledSite = false;
39
40			/** @var array $supportedLocales */
41			private $supportedLocales = [];
42
43			/**
44			* ApplicationPackage constructor.
45			* @param array $config
46			* @param \League\Route\Router $router
47			*/
48	9		public function __construct(array $config, Router $router)
49			{
50	9		$this->config = $config;
51	9		$this->router = $router;
52	9		}
53
54			/**
55			* @param Container $c
56			*/
57	9		public function addToContainer(Container $c)
58			{
59	9		$this->setConfigArray($c);
60	9		$this->setLocale($c);
61	9		$this->setupLogs($c);
62	9		$this->setupPdoConnection($c);
63	9		$this->setupViewEngine($c);
64	9		$this->setupTranslator($c);
65	9		$this->setupModules($c);
66	9		$this->setupDownloadController($c);
67			}
68
69			/**
70			* @param Container $c
71			*/
72	9		private function setConfigArray(Container $c)
73			{
74	9		foreach ($this->config as $key => $value) {
75	9		$c[$key] = $value;
76			}
77	9		}
78
79			/**
80			* @param Container $c
81			*/
82	9		private function setLocale(Container $c)
83			{
84	9		$i18n = $c->get('i18n');
85	9		$this->i18nEnabledSite = $i18n['enabled'];
86	9		$this->supportedLocales = $i18n['supported_locales'];
87	9		$defaultLocale = $i18n['default_locale'];
88	9		Locale::setDefault($defaultLocale);
89	9		}
90
91			/**
92			* @param Container $c
93			*/
94	9		private function setupViewEngine(Container $c)
95			{
96			// set up the view engine dependencies
97	9		$viewEngine = new PlatesEngine($c->get('viewFolder'));
98	9		$viewEngine->loadExtension(new AlertBox());
99
100	9		$c[PlatesEngine::class] = $viewEngine;
101
102		View Code Duplication	$c[NotFoundDecorator::class] = $c->factory(function (Container $c) {
			0 ignored issues – show Duplication introduced 2019-09-16 01:21 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
103	9		$layout = $c->get('default_layout');
104	9		$templates = $c->get('error_pages');
105	9		$viewEngine = $c->get(PlatesEngine::class);
106	9		$notFoundDecorator = new NotFoundDecorator($viewEngine, $templates);
107	9		$notFoundDecorator->setLayout($layout);
108
109	9		return $notFoundDecorator;
110	9		});
111
112		View Code Duplication	$c[NotAllowedDecorator::class] = $c->factory(function (Container $c) {
			0 ignored issues – show Duplication introduced 2019-09-16 01:21 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
113	9		$layout = $c->get('default_layout');
114	9		$templates = $c->get('error_pages');
115	9		$viewEngine = $c->get(PlatesEngine::class);
116	9		$notAllowedDecorator = new NotAllowedDecorator($viewEngine, $templates);
117	9		$notAllowedDecorator->setLayout($layout);
118
119	9		return $notAllowedDecorator;
120	9		});
121
122		View Code Duplication	$c[ExceptionDecorator::class] = $c->factory(function (Container $c) {
			0 ignored issues – show Duplication introduced 2019-10-26 21:19 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
123	9		$viewEngine = $c->get(PlatesEngine::class);
124	9		$layout = $c->get('default_layout');
125	9		$templates = $c->get('error_pages');
126	9		$decorator = new ExceptionDecorator($viewEngine, $templates);
127	9		$decorator->setLayout($layout);
128
129	9		return $decorator;
130	9		});
131
132			$c[PlatesStrategy::class] = $c->factory(function (Container $c) {
133	9		$viewEngine = $c->get(PlatesEngine::class);
134	9		$notFoundDecorator = $c->get(NotFoundDecorator::class);
135	9		$notAllowedDecorator = $c->get(NotAllowedDecorator::class);
136	9		$exceptionDecorator = $c->get(ExceptionDecorator::class);
137	9		$layout = $c->get('default_layout');
138	9		$strategy = new PlatesStrategy($viewEngine, $notFoundDecorator, $notAllowedDecorator, $layout, $exceptionDecorator);
139
140	9		return $strategy;
141	9		});
142
143			/** @var PlatesStrategy $strategy */
144	9		$strategy = $c->get(PlatesStrategy::class);
145	9		$strategy->setContainer($c);
146
147	9		if ($this->i18nEnabledSite === true) {
148	8		$strategy->setI18nEnabled(true);
149	8		$strategy->setSupportedLocales($this->supportedLocales);
150			}
151
152	9		$this->router->setStrategy($strategy);
153	9		}
154
155			/**
156			* @param Container $c
157			*/
158	9		private function setupModules(Container $c)
159			{
160			// set up the modules and vendor package modules
161	9		$packages = $c->get('packages');
162	9		$i18n = $c->get('i18n');
163			/** @var Translator $translator */
164	9		$translator = $c->get(Translator::class);
165
166	9		foreach ($packages as $packageName) {
167	9		if (class_exists($packageName)) {
168			/** @var RegistrationInterface $package */
169	9		$package = new $packageName();
170
171	9		if ($package->hasEntityPath()) {
172	9		$paths = $c['entity_paths'];
173	9		$paths[] = $package->getEntityPath();
174	9		$c['entity_paths'] = $paths;
175			}
176			}
177			}
178	9		reset($packages);
179	9		foreach ($packages as $packageName) {
180	9		if (class_exists($packageName)) {
181			/** @var RegistrationInterface $package */
182	9		$package = new $packageName();
183	9		$package->addToContainer($c);
184
185	9		if ($package instanceof RouterConfigInterface) {
186	9		$package->addRoutes($c, $this->router);
187			}
188
189	9		if ($package instanceof I18nRegistrationInterface) {
190			foreach ($i18n['supported_locales'] as $locale) {
191			$factory = new TranslatorFactory();
192			$factory->addPackageTranslations($translator, $package, $locale);
193			}
194			}
195			}
196			}
197	9		}
198
199			/**
200			* @param Container $c
201			*/
202	9		private function setupTranslator(Container $c)
203			{
204	9		$config = $c->get('i18n');
205	9		$engine = $c->get(PlatesEngine::class);
206	9		if (is_array($config)) {
207	9		$factory = new TranslatorFactory();
208	9		$translator = $factory->createTranslator($config);
209	9		$engine->loadExtension(new Translate($translator));
210	9		$engine->loadExtension(new LocaleLink());
211	9		$defaultLocale = $config['default_locale'] ?: 'en_GB';
212			// if (!in_array($locale, $config['supported_locales'])) {
213			// $locale = $defaultLocale;
214			// }
215	9		$translator->setLocale($defaultLocale);
216	9		$c[Translator::class] = $translator;
217			}
218	9		}
219
220
221			/**
222			* @param Container $c
223			*/
224	9		private function setupPdoConnection(Container $c)
225			{
226			// set up a db connection
227			$c[PDO::class] = $c->factory(function (Container $c): PDO {
228			$credentials = $c->get('db');
229			$host = $credentials['host'];
230			$db = $credentials['database'];
231			$user = $credentials['user'];
232			$pass = $credentials['pass'];
233
234			$dbConnection = new PDO('mysql:host=' . $host . ';dbname=' . $db, $user, $pass, [
235			PDO::ATTR_EMULATE_PREPARES => false,
236			PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
237			]);
238
239			return $dbConnection;
240	9		});
241	9		}
242
243			/**
244			* @param Container $c
245			*/
246	9		private function setupDownloadController(Container $c): void
247			{
248	9		$uploadDirectory = $c->get('uploads_dir');
249	9		$c[DownloadController::class] = new DownloadController($uploadDirectory);
250			$strategy = new JsonStrategy(new ResponseFactory());
251			$strategy->setContainer($c);
252			$this->router->map('GET', '/download', [DownloadController::class, 'downloadAction'])->setStrategy($strategy);
253			}
254
255			/**
256			* @param Container $c
257			*/
258	9		private function setupLogs(Container $c)
259			{
260	9		if ($c->has('display_errors')) {
261			ini_set('display_errors', $c->get('display_errors'));
262			}
263
264	9		if ($c->has('error_reporting')) {
265			error_reporting($c->get('error_reporting'));
266			}
267
268	9		if ($c->has('error_log')) {
269			$errorLog = $c->get('error_log');
270			if (!file_exists($errorLog)) {
271			file_put_contents($errorLog, '');
272			chmod($errorLog, 0775);
273			}
274			ini_set($c->get('error_log'), $errorLog);
275			}
276	9		}
277
278			/**
279			* @return string
280			*/
281	1		public function getEntityPath(): string
282			{
283	1		return '';
284			}
285
286			/**
287			* @return bool
288			*/
289	1		public function hasEntityPath(): bool
290			{
291	1		return false;
292			}
293			}

delboy1978uk / bone

Push — dev-master ( ee40ad...39856d )

ApplicationPackage::setupViewEngine() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like