AbstractMagentoStoreConfigCommand - Code Metrics - Inspection of "Merge branch 'release/1.1.11'" - netz98/n98-magerun2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ad0611...abd676 )

by Tom

created 2016-05-18 16:01 UTC

AbstractMagentoStoreConfigCommand A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	180
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
wmc	19
c	1
b	1
f	0
lcom	1
cbo	8
dl	0
loc	180
rs	10

5 Methods

Rating	Name	Size	Complexity
A	configure()	17	4
A	_initStore()	4	1
A	_beforeSave()	3	1
A	_afterSave()	3	1
D	execute()	65	12

<?php

namespace N98\Magento\Command;

use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\StringInput;
use Symfony\Component\Console\Output\NullOutput;

abstract class AbstractMagentoStoreConfigCommand extends AbstractMagentoCommand
{
    /**
     * @var string
     */
    const SCOPE_STORE_VIEW = 'store';

    /**
     * @var string
     */
    const SCOPE_WEBSITE = 'website';

    /**
     * @var string
     */
    const SCOPE_GLOBAL = 'global';

    /**
     * Store view or global by additional option
     */
    const SCOPE_STORE_VIEW_GLOBAL = 'store_view_global';

    /**
     * @var string
     */
    protected $commandName = '';

    /**
     * @var string
     */
    protected $commandDescription = '';

    /**
     * @var string
     */
    protected $configPath = '';

    /**
     * @var string
     */
    protected $toggleComment = '';

    /**
     * @var string
     */
    protected $falseName = 'disabled';

    /**
     * @var string
     */
    protected $trueName = 'enabled';

    /**
     * Add admin store to interactive prompt
     *
     * @var bool
     */
    protected $withAdminStore = false;

    /**
     * @var string
     */
    protected $scope = self::SCOPE_STORE_VIEW;

    protected function configure()
    {
        $this
            ->setName($this->commandName)
            ->addOption('on', null, InputOption::VALUE_NONE, 'Switch on')
            ->addOption('off', null, InputOption::VALUE_NONE, 'Switch off')
            ->setDescription($this->commandDescription)
        ;

        if ($this->scope == self::SCOPE_STORE_VIEW_GLOBAL) {
            $this->addOption('global', null, InputOption::VALUE_NONE, 'Set value on default scope');
        }

        if ($this->scope == self::SCOPE_STORE_VIEW || $this->scope == self::SCOPE_STORE_VIEW_GLOBAL) {
            $this->addArgument('store', InputArgument::OPTIONAL, 'Store code or ID');
        }
    }

    /**
     * @param \Symfony\Component\Console\Input\InputInterface $input
     * @param \Symfony\Component\Console\Output\OutputInterface $output
     * @return int|void
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $this->detectMagento($output);
        if ($this->initMagento()) {
            $runOnStoreView = false;
            if ($this->scope == self::SCOPE_STORE_VIEW
                || ($this->scope == self::SCOPE_STORE_VIEW_GLOBAL && !$input->getOption('global'))
            ) {
                $runOnStoreView = true;
            }

            if ($runOnStoreView) {
                $store = $this->_initStore($input, $output);
            } else {
                $storeManager = $this->getObjectManager()->get('Magento\Store\Model\StoreManagerInterface');
                /* @var $storeManager \Magento\Store\Model\StoreManagerInterface */
                $store = $storeManager->getStore(\Magento\Store\Model\Store::DEFAULT_STORE_ID);
            }
        }

        if ($input->getOption('on')) {
            $isFalse = true;
        } elseif ($input->getOption('off')) {
            $isFalse = false;
        } else {
            $scopeConfig = $this->getObjectManager()->get('\Magento\Framework\App\Config\ScopeConfigInterface');
            /* @var $scopeConfig \Magento\Framework\App\Config\ScopeConfigInterface */
            $isFalse = !$scopeConfig->isSetFlag(
                $this->configPath,
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                $store->getCode()
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            );
        }

        $this->_beforeSave($store, $isFalse);


        if ($store->getId() == \Magento\Store\Model\Store::DEFAULT_STORE_ID) {
            $scope = 'default'; // @TODO Constant was removed in Magento2 ?
        } else {
            $scope = \Magento\Store\Model\ScopeInterface::SCOPE_STORES;
        }

        $configSetCommands = [
            'command'    => 'config:set',
            'path'       => $this->configPath,
            'value'      => $isFalse ? 1 : 0,
            '--scope'    => $scope,
            '--scope-id' => $store->getId(),
        ];

        $input = new ArrayInput($configSetCommands);
        $this->getApplication()->setAutoExit(false);
        $this->getApplication()->run($input, new NullOutput());

        $comment = '<comment>' . $this->toggleComment . '</comment> '
                 . '<info>' . (!$isFalse ? $this->falseName : $this->trueName) . '</info>'
                 . ($runOnStoreView ? ' <comment>for store</comment> <info>' . $store->getCode() . '</info>' : '');
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        $output->writeln($comment);

        $this->_afterSave($store, $isFalse);

        $input = new StringInput('cache:flush');
        $this->getApplication()->run($input, new NullOutput());
    }

    /**
     * @param \Symfony\Component\Console\Input\InputInterface $input
     * @param \Symfony\Component\Console\Output\OutputInterface $output
     * @return mixed
     * @throws \Exception
     */
    protected function _initStore($input, $output)
    {
        return $this->getHelperSet()->get('parameter')->askStore($input, $output, 'store', $this->withAdminStore);
    }

    /**
     * @param \Magento\Store\Model\Store $store
     * @param bool $disabled
     */
    protected function _beforeSave(\Magento\Store\Model\Store $store, $disabled)

    {
    }

    /**
     * @param \Magento\Store\Model\Store $store
     * @param bool $disabled
     */
    protected function _afterSave(\Magento\Store\Model\Store $store, $disabled)

    {
    }
}


1			<?php
2
3			namespace N98\Magento\Command;
4
5			use Symfony\Component\Console\Input\ArrayInput;
6			use Symfony\Component\Console\Input\InputArgument;
7			use Symfony\Component\Console\Input\InputInterface;
8			use Symfony\Component\Console\Input\InputOption;
9			use Symfony\Component\Console\Output\OutputInterface;
10			use Symfony\Component\Console\Input\StringInput;
11			use Symfony\Component\Console\Output\NullOutput;
12
13			abstract class AbstractMagentoStoreConfigCommand extends AbstractMagentoCommand
14			{
15			/**
16			* @var string
17			*/
18			const SCOPE_STORE_VIEW = 'store';
19
20			/**
21			* @var string
22			*/
23			const SCOPE_WEBSITE = 'website';
24
25			/**
26			* @var string
27			*/
28			const SCOPE_GLOBAL = 'global';
29
30			/**
31			* Store view or global by additional option
32			*/
33			const SCOPE_STORE_VIEW_GLOBAL = 'store_view_global';
34
35			/**
36			* @var string
37			*/
38			protected $commandName = '';
39
40			/**
41			* @var string
42			*/
43			protected $commandDescription = '';
44
45			/**
46			* @var string
47			*/
48			protected $configPath = '';
49
50			/**
51			* @var string
52			*/
53			protected $toggleComment = '';
54
55			/**
56			* @var string
57			*/
58			protected $falseName = 'disabled';
59
60			/**
61			* @var string
62			*/
63			protected $trueName = 'enabled';
64
65			/**
66			* Add admin store to interactive prompt
67			*
68			* @var bool
69			*/
70			protected $withAdminStore = false;
71
72			/**
73			* @var string
74			*/
75			protected $scope = self::SCOPE_STORE_VIEW;
76
77			protected function configure()
78			{
79			$this
80			->setName($this->commandName)
81			->addOption('on', null, InputOption::VALUE_NONE, 'Switch on')
82			->addOption('off', null, InputOption::VALUE_NONE, 'Switch off')
83			->setDescription($this->commandDescription)
84			;
85
86			if ($this->scope == self::SCOPE_STORE_VIEW_GLOBAL) {
87			$this->addOption('global', null, InputOption::VALUE_NONE, 'Set value on default scope');
88			}
89
90			if ($this->scope == self::SCOPE_STORE_VIEW \|\| $this->scope == self::SCOPE_STORE_VIEW_GLOBAL) {
91			$this->addArgument('store', InputArgument::OPTIONAL, 'Store code or ID');
92			}
93			}
94
95			/**
96			* @param \Symfony\Component\Console\Input\InputInterface $input
97			* @param \Symfony\Component\Console\Output\OutputInterface $output
98			* @return int\|void
99			*/
100			protected function execute(InputInterface $input, OutputInterface $output)
101			{
102			$this->detectMagento($output);
103			if ($this->initMagento()) {
104			$runOnStoreView = false;
105			if ($this->scope == self::SCOPE_STORE_VIEW
106			\|\| ($this->scope == self::SCOPE_STORE_VIEW_GLOBAL && !$input->getOption('global'))
107			) {
108			$runOnStoreView = true;
109			}
110
111			if ($runOnStoreView) {
112			$store = $this->_initStore($input, $output);
113			} else {
114			$storeManager = $this->getObjectManager()->get('Magento\Store\Model\StoreManagerInterface');
115			/* @var $storeManager \Magento\Store\Model\StoreManagerInterface */
116			$store = $storeManager->getStore(\Magento\Store\Model\Store::DEFAULT_STORE_ID);
117			}
118			}
119
120			if ($input->getOption('on')) {
121			$isFalse = true;
122			} elseif ($input->getOption('off')) {
123			$isFalse = false;
124			} else {
125			$scopeConfig = $this->getObjectManager()->get('\Magento\Framework\App\Config\ScopeConfigInterface');
126			/* @var $scopeConfig \Magento\Framework\App\Config\ScopeConfigInterface */
127			$isFalse = !$scopeConfig->isSetFlag(
128			$this->configPath,
129			\Magento\Store\Model\ScopeInterface::SCOPE_STORE,
130			$store->getCode()
			0 ignored issues – show Bug introduced 2015-11-23 11:00 UTC by Report Bug Copy Issue Report The variable `$store` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
131			);
132			}
133
134			$this->_beforeSave($store, $isFalse);
135
136
137			if ($store->getId() == \Magento\Store\Model\Store::DEFAULT_STORE_ID) {
138			$scope = 'default'; // @TODO Constant was removed in Magento2 ?
139			} else {
140			$scope = \Magento\Store\Model\ScopeInterface::SCOPE_STORES;
141			}
142
143			$configSetCommands = [
144			'command' => 'config:set',
145			'path' => $this->configPath,
146			'value' => $isFalse ? 1 : 0,
147			'--scope' => $scope,
148			'--scope-id' => $store->getId(),
149			];
150
151			$input = new ArrayInput($configSetCommands);
152			$this->getApplication()->setAutoExit(false);
153			$this->getApplication()->run($input, new NullOutput());
154
155			$comment = '<comment>' . $this->toggleComment . '</comment> '
156			. '<info>' . (!$isFalse ? $this->falseName : $this->trueName) . '</info>'
157			. ($runOnStoreView ? ' <comment>for store</comment> <info>' . $store->getCode() . '</info>' : '');
			0 ignored issues – show Bug introduced 2015-11-23 11:00 UTC by Report Bug Copy Issue Report The variable `$runOnStoreView` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
158			$output->writeln($comment);
159
160			$this->_afterSave($store, $isFalse);
161
162			$input = new StringInput('cache:flush');
163			$this->getApplication()->run($input, new NullOutput());
164			}
165
166			/**
167			* @param \Symfony\Component\Console\Input\InputInterface $input
168			* @param \Symfony\Component\Console\Output\OutputInterface $output
169			* @return mixed
170			* @throws \Exception
171			*/
172			protected function _initStore($input, $output)
173			{
174			return $this->getHelperSet()->get('parameter')->askStore($input, $output, 'store', $this->withAdminStore);
175			}
176
177			/**
178			* @param \Magento\Store\Model\Store $store
179			* @param bool $disabled
180			*/
181			protected function _beforeSave(\Magento\Store\Model\Store $store, $disabled)
			0 ignored issues – show Unused Code introduced 2015-11-23 11:00 UTC by Report Bug Copy Issue Report The parameter `$store` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2015-11-23 11:00 UTC by Report Bug Copy Issue Report The parameter `$disabled` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
182			{
183			}
184
185			/**
186			* @param \Magento\Store\Model\Store $store
187			* @param bool $disabled
188			*/
189			protected function _afterSave(\Magento\Store\Model\Store $store, $disabled)
			0 ignored issues – show Unused Code introduced 2015-11-23 11:00 UTC by Report Bug Copy Issue Report The parameter `$store` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2015-11-23 11:00 UTC by Report Bug Copy Issue Report The parameter `$disabled` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
190			{
191			}
192			}
193

netz98 / n98-magerun2

Push — master ( ad0611...abd676 )

AbstractMagentoStoreConfigCommand A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like