MaintenanceShell - Code Metrics - Inspection of "Add a Maintenance shell" - XetaIO/Xeta - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#207)

by Fèvre

created 2016-12-12 01:17 UTC

MaintenanceShell A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	120
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	9
c	1
b	0
f	0
lcom	1
cbo	3
dl	0
loc	120
rs	10

6 Methods

Rating	Name	Size	Complexity
A	initialize()	5	1
A	getOptionParser()	13	1
A	down()	4	1
A	up()	4	1
B	handleMaintenance()	29	3
A	checkKey()	15	2

<?php
namespace App\Shell;

use Cake\Cache\Cache;
use Cake\Console\ConsoleOptionParser;
use Cake\Console\Shell;
use Cake\Utility\Inflector;

class MaintenanceShell extends Shell
{
    /**
     * The setting key to modify.
     *
     * @var string
     */
    protected $settingKey = 'Site.maintenance';

    /**
     * Initialize method.
     *
     * @return void
     */
    public function initialize()
    {
        parent::initialize();
        $this->loadModel('Settings');
    }

    /**
     * Display help for this console.
     *
     * @return ConsoleOptionParser
     */
    public function getOptionParser()
    {
        $parser = parent::getOptionParser();
        $parser->description(
            'This shell is used with the maintenance mode in the application.'
        )->addSubcommand('down', [
            'help' => 'Put the website in maintenance mode.'
        ])->addSubcommand('up', [
            'help' => 'Remove the website from the maintenance mode.'
        ]);

        return $parser;
    }

    /**
     * Put the application in maintenance mode.
     *
     * @return bool
     */
    public function down()
    {
        return $this->handleMaintenance('down', '1');
    }

    /**
     * Remove the application from the maintenance mode.
     *
     * @return bool
     */
    public function up()
    {
        return $this->handleMaintenance('up', '0');
    }

    /**
     * Handle the maintenance.
     *
     * @param string $type The type of the maintenance; up, down.
     * @param string $value The value of the setting key.
     *
     * @return bool
     */
    protected function handleMaintenance($type, $value)
    {
        $setting = $this->Settings->find()
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->where(['name' => $this->settingKey])
            ->first();

        if ($this->checkKey($setting) === false) {
            return false;
        }

        $data = [
            'value_int' => null,
            'value_str' => null,
            'value_bool' => $value
        ];

        $this->Settings->patchEntity($setting, $data);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        if ($this->Settings->save($setting)) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            Cache::clear(false, 'database');
            $this->out('<success>The</success> "<info>maintenance ' . $type . '</info>" <success>command has been executed successfully !</success>', 2);

            return true;
        } else {
            $this->out('<error>The</error> "<info>maintenance ' . $type . '</info>" <error>has failed while saving the setting key !</error>', 2);

            return false;
        }
    }

    /**
     * Check if the setting key exist in the database.
     *
     * @param null|App\Model\Entity\Setting $setting The setting to check.
     *
     * @return bool
     */
    protected function checkKey($setting)
    {
        if (is_null($setting)) {
            $msg = sprintf(
                'The setting key "%s" can not be found in the database, ' .
                'please add it to use this command shell.',
                $this->settingKey
            );
            $this->error($msg);


            return false;
        }

        return true;
    }
}


1			<?php
2			namespace App\Shell;
3
4			use Cake\Cache\Cache;
5			use Cake\Console\ConsoleOptionParser;
6			use Cake\Console\Shell;
7			use Cake\Utility\Inflector;
8
9			class MaintenanceShell extends Shell
10			{
11			/**
12			* The setting key to modify.
13			*
14			* @var string
15			*/
16			protected $settingKey = 'Site.maintenance';
17
18			/**
19			* Initialize method.
20			*
21			* @return void
22			*/
23			public function initialize()
24			{
25			parent::initialize();
26			$this->loadModel('Settings');
27			}
28
29			/**
30			* Display help for this console.
31			*
32			* @return ConsoleOptionParser
33			*/
34			public function getOptionParser()
35			{
36			$parser = parent::getOptionParser();
37			$parser->description(
38			'This shell is used with the maintenance mode in the application.'
39			)->addSubcommand('down', [
40			'help' => 'Put the website in maintenance mode.'
41			])->addSubcommand('up', [
42			'help' => 'Remove the website from the maintenance mode.'
43			]);
44
45			return $parser;
46			}
47
48			/**
49			* Put the application in maintenance mode.
50			*
51			* @return bool
52			*/
53			public function down()
54			{
55			return $this->handleMaintenance('down', '1');
56			}
57
58			/**
59			* Remove the application from the maintenance mode.
60			*
61			* @return bool
62			*/
63			public function up()
64			{
65			return $this->handleMaintenance('up', '0');
66			}
67
68			/**
69			* Handle the maintenance.
70			*
71			* @param string $type The type of the maintenance; up, down.
72			* @param string $value The value of the setting key.
73			*
74			* @return bool
75			*/
76			protected function handleMaintenance($type, $value)
77			{
78			$setting = $this->Settings->find()
			0 ignored issues – show Documentation introduced 2016-12-11 20:49 UTC by Report Bug Copy Issue Report The property `Settings` does not exist on `object<App\Shell\MaintenanceShell>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
79			->where(['name' => $this->settingKey])
80			->first();
81
82			if ($this->checkKey($setting) === false) {
83			return false;
84			}
85
86			$data = [
87			'value_int' => null,
88			'value_str' => null,
89			'value_bool' => $value
90			];
91
92			$this->Settings->patchEntity($setting, $data);
			0 ignored issues – show Documentation introduced 2016-12-11 20:49 UTC by Report Bug Copy Issue Report The property `Settings` does not exist on `object<App\Shell\MaintenanceShell>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
93
94			if ($this->Settings->save($setting)) {
			0 ignored issues – show Documentation introduced 2016-12-11 20:49 UTC by Report Bug Copy Issue Report The property `Settings` does not exist on `object<App\Shell\MaintenanceShell>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
95			Cache::clear(false, 'database');
96			$this->out('<success>The</success> "<info>maintenance ' . $type . '</info>" <success>command has been executed successfully !</success>', 2);
97
98			return true;
99			} else {
100			$this->out('<error>The</error> "<info>maintenance ' . $type . '</info>" <error>has failed while saving the setting key !</error>', 2);
101
102			return false;
103			}
104			}
105
106			/**
107			* Check if the setting key exist in the database.
108			*
109			* @param null\|App\Model\Entity\Setting $setting The setting to check.
110			*
111			* @return bool
112			*/
113			protected function checkKey($setting)
114			{
115			if (is_null($setting)) {
116			$msg = sprintf(
117			'The setting key "%s" can not be found in the database, ' .
118			'please add it to use this command shell.',
119			$this->settingKey
120			);
121			$this->error($msg);
			0 ignored issues – show Deprecated Code introduced 2016-12-11 20:49 UTC by Report Bug Copy Issue Report The method `Cake\Console\Shell::error()` has been deprecated with message: Since 3.2.0. Use Shell::abort() instead. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
122
123			return false;
124			}
125
126			return true;
127			}
128			}
129

XetaIO / Xeta

Pull Request — master (#207)

MaintenanceShell A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

Duplication Side-by-Side

Filter issues like