AbstractMagentoStoreConfigCommand - Code Metrics - ktomk/n98-magerun2 - Measure and Improve Code Quality continuously with Scrutinizer

AbstractMagentoStoreConfigCommand A
last analyzed 2016-05-29 11:20 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	183
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
wmc	19
c	3
b	1
f	0
lcom	1
cbo	4
dl	0
loc	183
rs	10

5 Methods

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

<?php

namespace N98\Magento\Command;

use Exception;
use N98\Util\Console\Helper\ParameterHelper;
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 InputInterface $input
     * @param 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 InputInterface $input
     * @param OutputInterface $output
     * @return mixed
     * @throws Exception
     */
    protected function _initStore(InputInterface $input, OutputInterface $output)
    {
        /** @var $parameter ParameterHelper */
        $parameter = $this->getHelper('parameter');

        return $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)

    {
    }
}


AbstractMagentoStoreConfigCommand A
last analyzed 2016-05-29 11:20 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Available Fixes

Available Fixes

1			<?php
2
3			namespace N98\Magento\Command;
4
5			use Exception;
6			use N98\Util\Console\Helper\ParameterHelper;
7			use Symfony\Component\Console\Input\ArrayInput;
8			use Symfony\Component\Console\Input\InputArgument;
9			use Symfony\Component\Console\Input\InputInterface;
10			use Symfony\Component\Console\Input\InputOption;
11			use Symfony\Component\Console\Output\OutputInterface;
12			use Symfony\Component\Console\Input\StringInput;
13			use Symfony\Component\Console\Output\NullOutput;
14
15			abstract class AbstractMagentoStoreConfigCommand extends AbstractMagentoCommand
16			{
17			/**
18			* @var string
19			*/
20			const SCOPE_STORE_VIEW = 'store';
21
22			/**
23			* @var string
24			*/
25			const SCOPE_WEBSITE = 'website';
26
27			/**
28			* @var string
29			*/
30			const SCOPE_GLOBAL = 'global';
31
32			/**
33			* Store view or global by additional option
34			*/
35			const SCOPE_STORE_VIEW_GLOBAL = 'store_view_global';
36
37			/**
38			* @var string
39			*/
40			protected $commandName = '';
41
42			/**
43			* @var string
44			*/
45			protected $commandDescription = '';
46
47			/**
48			* @var string
49			*/
50			protected $configPath = '';
51
52			/**
53			* @var string
54			*/
55			protected $toggleComment = '';
56
57			/**
58			* @var string
59			*/
60			protected $falseName = 'disabled';
61
62			/**
63			* @var string
64			*/
65			protected $trueName = 'enabled';
66
67			/**
68			* Add admin store to interactive prompt
69			*
70			* @var bool
71			*/
72			protected $withAdminStore = false;
73
74			/**
75			* @var string
76			*/
77			protected $scope = self::SCOPE_STORE_VIEW;
78
79			protected function configure()
80			{
81			$this
82			->setName($this->commandName)
83			->addOption('on', null, InputOption::VALUE_NONE, 'Switch on')
84			->addOption('off', null, InputOption::VALUE_NONE, 'Switch off')
85			->setDescription($this->commandDescription)
86			;
87
88			if ($this->scope == self::SCOPE_STORE_VIEW_GLOBAL) {
89			$this->addOption('global', null, InputOption::VALUE_NONE, 'Set value on default scope');
90			}
91
92			if ($this->scope == self::SCOPE_STORE_VIEW \|\| $this->scope == self::SCOPE_STORE_VIEW_GLOBAL) {
93			$this->addArgument('store', InputArgument::OPTIONAL, 'Store code or ID');
94			}
95			}
96
97			/**
98			* @param InputInterface $input
99			* @param OutputInterface $output
100			* @return int\|void
101			*/
102			protected function execute(InputInterface $input, OutputInterface $output)
103			{
104			$this->detectMagento($output);
105			if ($this->initMagento()) {
106			$runOnStoreView = false;
107			if ($this->scope == self::SCOPE_STORE_VIEW
108			\|\| ($this->scope == self::SCOPE_STORE_VIEW_GLOBAL && !$input->getOption('global'))
109			) {
110			$runOnStoreView = true;
111			}
112
113			if ($runOnStoreView) {
114			$store = $this->_initStore($input, $output);
115			} else {
116			$storeManager = $this->getObjectManager()->get('Magento\Store\Model\StoreManagerInterface');
117			/* @var $storeManager \Magento\Store\Model\StoreManagerInterface */
118			$store = $storeManager->getStore(\Magento\Store\Model\Store::DEFAULT_STORE_ID);
119			}
120			}
121
122			if ($input->getOption('on')) {
123			$isFalse = true;
124			} elseif ($input->getOption('off')) {
125			$isFalse = false;
126			} else {
127			$scopeConfig = $this->getObjectManager()->get('\Magento\Framework\App\Config\ScopeConfigInterface');
128			/* @var $scopeConfig \Magento\Framework\App\Config\ScopeConfigInterface */
129			$isFalse = !$scopeConfig->isSetFlag(
130			$this->configPath,
131			\Magento\Store\Model\ScopeInterface::SCOPE_STORE,
132			$store->getCode()
			0 ignored issues – show Bug introduced 2016-01-03 15:34 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...
133			);
134			}
135
136			$this->_beforeSave($store, $isFalse);
137
138
139			if ($store->getId() == \Magento\Store\Model\Store::DEFAULT_STORE_ID) {
140			$scope = 'default'; // @TODO Constant was removed in Magento2 ?
141			} else {
142			$scope = \Magento\Store\Model\ScopeInterface::SCOPE_STORES;
143			}
144
145			$configSetCommands = [
146			'command' => 'config:set',
147			'path' => $this->configPath,
148			'value' => $isFalse ? 1 : 0,
149			'--scope' => $scope,
150			'--scope-id' => $store->getId(),
151			];
152
153			$input = new ArrayInput($configSetCommands);
154			$this->getApplication()->setAutoExit(false);
155			$this->getApplication()->run($input, new NullOutput());
156
157			$comment = '<comment>' . $this->toggleComment . '</comment> '
158			. '<info>' . (!$isFalse ? $this->falseName : $this->trueName) . '</info>'
159			. ($runOnStoreView ? ' <comment>for store</comment> <info>' . $store->getCode() . '</info>' : '');
			0 ignored issues – show Bug introduced 2016-01-03 15:34 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...
160			$output->writeln($comment);
161
162			$this->_afterSave($store, $isFalse);
163
164			$input = new StringInput('cache:flush');
165			$this->getApplication()->run($input, new NullOutput());
166			}
167
168			/**
169			* @param InputInterface $input
170			* @param OutputInterface $output
171			* @return mixed
172			* @throws Exception
173			*/
174			protected function _initStore(InputInterface $input, OutputInterface $output)
175			{
176			/** @var $parameter ParameterHelper */
177			$parameter = $this->getHelper('parameter');
178
179			return $parameter->askStore($input, $output, 'store', $this->withAdminStore);
180			}
181
182			/**
183			* @param \Magento\Store\Model\Store $store
184			* @param bool $disabled
185			*/
186			protected function _beforeSave(\Magento\Store\Model\Store $store, $disabled)
			0 ignored issues – show Unused Code introduced 2016-01-03 15:34 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 2016-01-03 15:34 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...
187			{
188			}
189
190			/**
191			* @param \Magento\Store\Model\Store $store
192			* @param bool $disabled
193			*/
194			protected function _afterSave(\Magento\Store\Model\Store $store, $disabled)
			0 ignored issues – show Unused Code introduced 2016-01-03 15:34 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 2016-01-03 15:34 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...
195			{
196			}
197			}
198

ktomk / n98-magerun2

AbstractMagentoStoreConfigCommand A last analyzed 2016-05-29 11:20 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

AbstractMagentoStoreConfigCommand A
last analyzed 2016-05-29 11:20 UTC