PluginModule::lock() - Code Metrics - Inspection of "Update PHPUnit tests + fixed issue in Configuratio..." - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 15.x ( d82ad5...f4a7f0 )

by Tim

created 2019-10-16 12:20 UTC

PluginModule::lock() A

↳ Parent: PluginModule

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

/**
 * TechDivision\Import\Modules\PluginModule
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2019 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Modules;

use TechDivision\Import\ApplicationInterface;
use TechDivision\Import\ConfigurationManagerInterface;
use TechDivision\Import\Plugins\PluginExecutorInterface;

/**
 * A module implementation that provides plug-in functionality.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2019 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 */
class PluginModule implements ModuleInterface
{

    /**
     * The application instance.
     *
     * @var \TechDivision\Import\ApplicationInterface
     */
    protected $application;

    /**
     * The plugin executor instance.
     *
     * @var \TechDivision\Import\Plugins\PluginExecutorInterface
     */
    protected $pluginExecutor;

    /**
     * The configuration manager instance.
     *
     * @var \TechDivision\Import\ConfigurationInterface
     */
    protected $configurationManager;

    /**
     * Initializes the module with the application, configuration and plug-in executor instance.
     *
     * @param \TechDivision\Import\ApplicationInterface            $application          The application instance
     * @param \TechDivision\Import\ConfigurationManagerInterface   $configurationManager The configuration manager instance
     * @param \TechDivision\Import\Plugins\PluginExecutorInterface $pluginExecutor       The plug-in executor instance
     */
    public function __construct(
        ApplicationInterface $application,
        ConfigurationManagerInterface $configurationManager,
        PluginExecutorInterface $pluginExecutor
    ) {

        // initialize the application, the configuration and the plugin executor
        $this->application = $application;
        $this->configurationManager = $configurationManager;

        $this->pluginExecutor = $pluginExecutor;
    }

    /**
     * Return's the application instance.
     *
     * @return \TechDivision\Import\ApplicationInterface The application instance
     */
    protected function getApplication()
    {
        return $this->application;
    }

    /**
     * Return's the configuration manager instance.
     *
     * @return \TechDivision\Import\ConfigurationInterface The configuration manager instance
     */
    protected function getConfigurationManager()
    {
        return $this->configurationManager;
    }

    /**
     * Return's the plug-in executor instance.
     *
     * @return \TechDivision\Import\Plugins\PluginExecutorInterface The plug-in executor instance
     */
    protected function getPluginExecutor()
    {
        return $this->pluginExecutor;
    }

    /**
     * Persist the UUID of the actual import process to the PID file.
     *
     * @return void
     * @throws \Exception Is thrown, if the PID can not be added
     */
    protected function lock()
    {
        $this->getApplication()->lock();
    }

    /**
     * Remove's the UUID of the actual import process from the PID file.
     *
     * @return void
     * @throws \Exception Is thrown, if the PID can not be removed
     */
    protected function unlock()
    {
        $this->getApplication()->unlock();
    }

    /**
     * Inovkes the plug-in functionality.
     *
     * @return void
     */
    public function process()
    {
        try {
            // immediately add the PID to lock this import process
            $this->lock();
            // process the plugins defined in the configuration
            /** @var \TechDivision\Import\Configuration\PluginConfigurationInterface $pluginConfiguration */
            foreach ($this->getConfigurationManager()->getPlugins() as $pluginConfiguration) {

                // query whether or not the operation has been stopped
                if ($this->getApplication()->isStopped()) {
                    break;
                }

                // execute the plugin instance
                $this->getPluginExecutor()->execute($pluginConfiguration);
             }
        } catch (\Exception $e) {
            // re-throw the exception
             throw $e;
        } finally {
            // finally, if a PID has been set, remove it
            // from the PID file to unlock the importer
            $this->unlock();
        }
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Modules\PluginModule
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 2019 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link https://github.com/techdivision/import
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Modules;
22
23			use TechDivision\Import\ApplicationInterface;
24			use TechDivision\Import\ConfigurationManagerInterface;
25			use TechDivision\Import\Plugins\PluginExecutorInterface;
26
27			/**
28			* A module implementation that provides plug-in functionality.
29			*
30			* @author Tim Wagner <[email protected]>
31			* @copyright 2019 TechDivision GmbH <[email protected]>
32			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
33			* @link https://github.com/techdivision/import
34			* @link http://www.techdivision.com
35			*/
36			class PluginModule implements ModuleInterface
37			{
38
39			/**
40			* The application instance.
41			*
42			* @var \TechDivision\Import\ApplicationInterface
43			*/
44			protected $application;
45
46			/**
47			* The plugin executor instance.
48			*
49			* @var \TechDivision\Import\Plugins\PluginExecutorInterface
50			*/
51			protected $pluginExecutor;
52
53			/**
54			* The configuration manager instance.
55			*
56			* @var \TechDivision\Import\ConfigurationInterface
57			*/
58			protected $configurationManager;
59
60			/**
61			* Initializes the module with the application, configuration and plug-in executor instance.
62			*
63			* @param \TechDivision\Import\ApplicationInterface $application The application instance
64			* @param \TechDivision\Import\ConfigurationManagerInterface $configurationManager The configuration manager instance
65			* @param \TechDivision\Import\Plugins\PluginExecutorInterface $pluginExecutor The plug-in executor instance
66			*/
67			public function __construct(
68			ApplicationInterface $application,
69			ConfigurationManagerInterface $configurationManager,
70			PluginExecutorInterface $pluginExecutor
71			) {
72
73			// initialize the application, the configuration and the plugin executor
74			$this->application = $application;
75			$this->configurationManager = $configurationManager;
			0 ignored issues – show Documentation Bug introduced 2019-10-05 19:51 UTC by Report Bug Copy Issue Report It seems like `$configurationManager` of type `object<TechDivision\Impo...rationManagerInterface>` is incompatible with the declared type `object<TechDivision\Impo...ConfigurationInterface>` of property `$configurationManager`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
76			$this->pluginExecutor = $pluginExecutor;
77			}
78
79			/**
80			* Return's the application instance.
81			*
82			* @return \TechDivision\Import\ApplicationInterface The application instance
83			*/
84			protected function getApplication()
85			{
86			return $this->application;
87			}
88
89			/**
90			* Return's the configuration manager instance.
91			*
92			* @return \TechDivision\Import\ConfigurationInterface The configuration manager instance
93			*/
94			protected function getConfigurationManager()
95			{
96			return $this->configurationManager;
97			}
98
99			/**
100			* Return's the plug-in executor instance.
101			*
102			* @return \TechDivision\Import\Plugins\PluginExecutorInterface The plug-in executor instance
103			*/
104			protected function getPluginExecutor()
105			{
106			return $this->pluginExecutor;
107			}
108
109			/**
110			* Persist the UUID of the actual import process to the PID file.
111			*
112			* @return void
113			* @throws \Exception Is thrown, if the PID can not be added
114			*/
115			protected function lock()
116			{
117			$this->getApplication()->lock();
118			}
119
120			/**
121			* Remove's the UUID of the actual import process from the PID file.
122			*
123			* @return void
124			* @throws \Exception Is thrown, if the PID can not be removed
125			*/
126			protected function unlock()
127			{
128			$this->getApplication()->unlock();
129			}
130
131			/**
132			* Inovkes the plug-in functionality.
133			*
134			* @return void
135			*/
136			public function process()
137			{
138			try {
139			// immediately add the PID to lock this import process
140			$this->lock();
141			// process the plugins defined in the configuration
142			/** @var \TechDivision\Import\Configuration\PluginConfigurationInterface $pluginConfiguration */
143			foreach ($this->getConfigurationManager()->getPlugins() as $pluginConfiguration) {
			0 ignored issues – show Bug introduced 2019-10-05 19:51 UTC by Report Bug Copy Issue Report The method `getPlugins()` does not seem to exist on `object<TechDivision\Impo...ConfigurationInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
144			// query whether or not the operation has been stopped
145			if ($this->getApplication()->isStopped()) {
146			break;
147			}
148
149			// execute the plugin instance
150			$this->getPluginExecutor()->execute($pluginConfiguration);
151			}
152			} catch (\Exception $e) {
153			// re-throw the exception
154			throw $e;
155			} finally {
156			// finally, if a PID has been set, remove it
157			// from the PID file to unlock the importer
158			$this->unlock();
159			}
160			}
161			}
162

techdivision / import

Push — 15.x ( d82ad5...f4a7f0 )

PluginModule::lock() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like