Module::init() - Code Metrics - Inspection of "Fixing debugger aware support" - webino/WebinoDebug - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 79e753...179711 )

by Peter

created 2018-06-08 16:13 UTC

Module::init() D

↳ Parent: Module

Complexity

Conditions	13
Paths	4

Size

Total Lines	90
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	90
rs	4.9922
cc	13
eloc	40
nc	4
nop	1

How to fix Long Method Complexity

<?php
/**
 * Webino (http://webino.sk/)
 *
 * @link        https://github.com/webino/WebinoDebug/ for the canonical source repository
 * @copyright   Copyright (c) 2014-2018 Webino, s. r. o. (http://webino.sk/)
 * @license     BSD-3-Clause
 */

namespace WebinoDebug;

use WebinoDebug\Factory\DebuggerFactory;
use WebinoDebug\Factory\ModuleOptionsFactory;
use WebinoDebug\Options\ModuleOptions;
use WebinoDebug\Service\NullDebugger;
use Zend\Http\PhpEnvironment\Request;
use Zend\ModuleManager\Feature;
use Zend\ModuleManager\ModuleEvent;
use Zend\ModuleManager\ModuleManagerInterface;
use Zend\ServiceManager\ServiceManager;

/**
 * WebinoDebug module
 */
class Module implements Feature\InitProviderInterface
{
    /**
     * @param ModuleManagerInterface $modules
     */
    public function init(ModuleManagerInterface $modules)
    {
        /** @var \Zend\ModuleManager\ModuleManager $modules */
        /** @var ServiceManager $services */
        $services = $modules->getEvent()->getParam('ServiceManager');

        $services->setFactory(ModuleOptions::class, ModuleOptionsFactory::class);
        $services->setFactory(DebuggerFactory::SERVICE, DebuggerFactory::class);

        /** @var ModuleOptions $options */
        $options = $services->get(ModuleOptions::class);

        // set error log path
        ini_set('error_log', $options->getPhpErrorLog());

        // return early when disabled
        if ($options->isDisabled()) {
            return;
        }

        // init debugger
        $this->sessionStart();
        /** @var Service\Debugger $debugger */
        $debugger = $services->get(DebuggerFactory::SERVICE);

        // add a service initializer
        // TODO something better
        $modules->getEventManager()->attach(
            ModuleEvent::EVENT_LOAD_MODULES_POST,
            function () use ($services, $debugger) {

                $initializer = function ($obj) use ($debugger) {
                    if ($obj instanceof Service\DebuggerAwareInterface) {
                        /** @var Service\Debugger $debugger */
                        $obj->setDebugger($debugger);
                    }
                };

                $services->addInitializer($initializer);
                foreach ($services->getRegisteredServices()['instances'] as $name) {
                    $instance = $services->get($name);
                    ($instance instanceof ServiceManager) and $instance->addInitializer($initializer);
                }
            }
        );

        // return early on null debugger
        if ($debugger instanceof NullDebugger) {
            return;
        }

        // create bar panels
        $showBar   = $options->showBar();
        $barPanels = $options->getBarPanels();

        if ($showBar) {
            // set core bar panels
            foreach ($barPanels as $id => $barPanel) {
                $debugger->setBarPanel(new $barPanel($modules), $id);
            }
        }

        // finish debugger init
        $modules->getEventManager()->attach(
            ModuleEvent::EVENT_LOAD_MODULES_POST,
            function () use ($services, $debugger, $options, $showBar, $barPanels) {

                // update module options
                /** @var ModuleOptions $newOptions */
                $newOptions = $services->create(ModuleOptions::class);
                $options->setFromArray($newOptions->toArray());

                if ($showBar) {
                    // set additional bar panels
                    $newBarPanels = array_diff($options->getBarPanels(), $barPanels);
                    foreach ($newBarPanels as $id => $barPanel) {
                        $debugger->setBarPanel($services->get($barPanel), $id);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    }

                    // init bar panels
                    foreach ($debugger->getBarPanels() as $barPanel) {
                        ($barPanel instanceof Debugger\PanelInitInterface) and $barPanel->init($services);
                    }
                }

                // debugger templates
                $templateMap = $options->getTemplateMap();
                empty($templateMap) or $services->get('ViewTemplateMapResolver')->merge($templateMap);
            }
        );
    }

    /**
     * Start session for Ajax debug support
     *
     * Simplified session start with cookie path support at least.
     *
     * @return void
     */
    private function sessionStart()
    {
        if (session_status() !== PHP_SESSION_ACTIVE) {
            session_set_cookie_params(0, (new Request)->getBasePath());
            session_start();
        }
    }
}


1			<?php
2			/**
3			* Webino (http://webino.sk/)
4			*
5			* @link https://github.com/webino/WebinoDebug/ for the canonical source repository
6			* @copyright Copyright (c) 2014-2018 Webino, s. r. o. (http://webino.sk/)
7			* @license BSD-3-Clause
8			*/
9
10			namespace WebinoDebug;
11
12			use WebinoDebug\Factory\DebuggerFactory;
13			use WebinoDebug\Factory\ModuleOptionsFactory;
14			use WebinoDebug\Options\ModuleOptions;
15			use WebinoDebug\Service\NullDebugger;
16			use Zend\Http\PhpEnvironment\Request;
17			use Zend\ModuleManager\Feature;
18			use Zend\ModuleManager\ModuleEvent;
19			use Zend\ModuleManager\ModuleManagerInterface;
20			use Zend\ServiceManager\ServiceManager;
21
22			/**
23			* WebinoDebug module
24			*/
25			class Module implements Feature\InitProviderInterface
26			{
27			/**
28			* @param ModuleManagerInterface $modules
29			*/
30			public function init(ModuleManagerInterface $modules)
31			{
32			/** @var \Zend\ModuleManager\ModuleManager $modules */
33			/** @var ServiceManager $services */
34			$services = $modules->getEvent()->getParam('ServiceManager');
			0 ignored issues – show Bug introduced 2016-02-15 09:55 UTC by Report Bug Copy Issue Report The method `getEvent()` does not exist on `Zend\ModuleManager\ModuleManagerInterface`. Did you maybe mean `getEventManager()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
35			$services->setFactory(ModuleOptions::class, ModuleOptionsFactory::class);
36			$services->setFactory(DebuggerFactory::SERVICE, DebuggerFactory::class);
37
38			/** @var ModuleOptions $options */
39			$options = $services->get(ModuleOptions::class);
40
41			// set error log path
42			ini_set('error_log', $options->getPhpErrorLog());
43
44			// return early when disabled
45			if ($options->isDisabled()) {
46			return;
47			}
48
49			// init debugger
50			$this->sessionStart();
51			/** @var Service\Debugger $debugger */
52			$debugger = $services->get(DebuggerFactory::SERVICE);
53
54			// add a service initializer
55			// TODO something better
56			$modules->getEventManager()->attach(
57			ModuleEvent::EVENT_LOAD_MODULES_POST,
58			function () use ($services, $debugger) {
59
60			$initializer = function ($obj) use ($debugger) {
61			if ($obj instanceof Service\DebuggerAwareInterface) {
62			/** @var Service\Debugger $debugger */
63			$obj->setDebugger($debugger);
64			}
65			};
66
67			$services->addInitializer($initializer);
68			foreach ($services->getRegisteredServices()['instances'] as $name) {
69			$instance = $services->get($name);
70			($instance instanceof ServiceManager) and $instance->addInitializer($initializer);
71			}
72			}
73			);
74
75			// return early on null debugger
76			if ($debugger instanceof NullDebugger) {
77			return;
78			}
79
80			// create bar panels
81			$showBar = $options->showBar();
82			$barPanels = $options->getBarPanels();
83
84			if ($showBar) {
85			// set core bar panels
86			foreach ($barPanels as $id => $barPanel) {
87			$debugger->setBarPanel(new $barPanel($modules), $id);
88			}
89			}
90
91			// finish debugger init
92			$modules->getEventManager()->attach(
93			ModuleEvent::EVENT_LOAD_MODULES_POST,
94			function () use ($services, $debugger, $options, $showBar, $barPanels) {
95
96			// update module options
97			/** @var ModuleOptions $newOptions */
98			$newOptions = $services->create(ModuleOptions::class);
99			$options->setFromArray($newOptions->toArray());
100
101			if ($showBar) {
102			// set additional bar panels
103			$newBarPanels = array_diff($options->getBarPanels(), $barPanels);
104			foreach ($newBarPanels as $id => $barPanel) {
105			$debugger->setBarPanel($services->get($barPanel), $id);
			0 ignored issues – show Documentation introduced 2018-05-25 13:17 UTC by Report Bug Copy Issue Report `$services->get($barPanel)` is of type `object\|array`, but the function expects a `null\|object<WebinoDebug\Debugger\PanelInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
106			}
107
108			// init bar panels
109			foreach ($debugger->getBarPanels() as $barPanel) {
110			($barPanel instanceof Debugger\PanelInitInterface) and $barPanel->init($services);
111			}
112			}
113
114			// debugger templates
115			$templateMap = $options->getTemplateMap();
116			empty($templateMap) or $services->get('ViewTemplateMapResolver')->merge($templateMap);
117			}
118			);
119			}
120
121			/**
122			* Start session for Ajax debug support
123			*
124			* Simplified session start with cookie path support at least.
125			*
126			* @return void
127			*/
128			private function sessionStart()
129			{
130			if (session_status() !== PHP_SESSION_ACTIVE) {
131			session_set_cookie_params(0, (new Request)->getBasePath());
132			session_start();
133			}
134			}
135			}
136

webino / WebinoDebug

Push — develop ( 79e753...179711 )

Module::init() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like