Config::setSimulated() - Code Metrics - Inspection of "Add EnvConfig to Robo: set configuration values vi..." - consolidation/robo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#737)

by Greg

created 2018-05-26 03:21 UTC

Config::setSimulated() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php
namespace Robo\Config;

use Consolidation\Config\Util\ConfigOverlay;
use Consolidation\Config\ConfigInterface;

class Config extends ConfigOverlay implements GlobalOptionDefaultValuesInterface

{
    const PROGRESS_BAR_AUTO_DISPLAY_INTERVAL = 'options.progress-delay';
    const DEFAULT_PROGRESS_DELAY = 2;
    const SIMULATE = 'options.simulate';

    // Read-only configuration properties; changing these has no effect.
    const INTERACTIVE = 'options.interactive';
    const DECORATED = 'options.decorated';

    /**
     * Create a new configuration object, and initialize it with
     * the provided nested array containing configuration data.
     */
    public function __construct(array $data = null)
    {
        parent::__construct();

        $this->import($data);

        unset($this->contexts[ConfigOverlay::PROCESS_CONTEXT]);
        $this->defaults = $this->getGlobalOptionDefaultValues();
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * {@inheritdoc}
     */
    public function import($data)
    {
        return $this->replace($data);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @inheritdoc
     */
    public function set($key, $value)
    {
        $this->contexts[self::DEFAULT_CONTEXT]->set($key, $value);
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function addContext($name, ConfigInterface $config)
    {
        $this->contexts[$name] = $config;
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function replace($data)
    {
        $this->getContext(ConfigOverlay::DEFAULT_CONTEXT)->replace($data);
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function combine($data)
    {
        $this->getContext(ConfigOverlay::DEFAULT_CONTEXT)->combine($data);
        return $this;
    }

    /**
     * Return an associative array containing all of the global configuration
     * options and their default values.
     *
     * @return array
     */
    public function getGlobalOptionDefaultValues()
    {
        $globalOptions =
        [
            self::PROGRESS_BAR_AUTO_DISPLAY_INTERVAL => self::DEFAULT_PROGRESS_DELAY,
            self::SIMULATE => false,
        ];
        return $this->trimPrefixFromGlobalOptions($globalOptions);
    }

    /**
     * Remove the 'options.' prefix from the global options list.
     */
    protected function trimPrefixFromGlobalOptions($globalOptions)
    {
        $result = [];
        foreach ($globalOptions as $option => $value) {
            $option = str_replace('options.', '', $option);
            $result[$option] = $value;
        }
        return $result;
    }

    /**
     * @deprecated Use $config->get(Config::SIMULATE)
     *
     * @return bool
     */
    public function isSimulated()
    {
        return $this->get(self::SIMULATE);
    }

    /**
     * @deprecated Use $config->set(Config::SIMULATE, true)
     *
     * @param bool $simulated
     *
     * @return $this
     */
    public function setSimulated($simulated = true)
    {
        return $this->set(self::SIMULATE, $simulated);
    }

    /**
     * @deprecated Use $config->get(Config::INTERACTIVE)
     *
     * @return bool
     */
    public function isInteractive()
    {
        return $this->get(self::INTERACTIVE);
    }

    /**
     * @deprecated Use $config->set(Config::INTERACTIVE, true)
     *
     * @param bool $interactive
     *
     * @return $this
     */
    public function setInteractive($interactive = true)
    {
        return $this->set(self::INTERACTIVE, $interactive);
    }

    /**
     * @deprecated Use $config->get(Config::DECORATED)
     *
     * @return bool
     */
    public function isDecorated()
    {
        return $this->get(self::DECORATED);
    }

    /**
     * @deprecated Use $config->set(Config::DECORATED, true)
     *
     * @param bool $decorated
     *
     * @return $this
     */
    public function setDecorated($decorated = true)
    {
        return $this->set(self::DECORATED, $decorated);
    }

    /**
     * @deprecated Use $config->set(Config::PROGRESS_BAR_AUTO_DISPLAY_INTERVAL, $interval)
     *
     * @param int $interval
     *
     * @return $this
     */
    public function setProgressBarAutoDisplayInterval($interval)
    {
        return $this->set(self::PROGRESS_BAR_AUTO_DISPLAY_INTERVAL, $interval);
    }
}


1			<?php
2			namespace Robo\Config;
3
4			use Consolidation\Config\Util\ConfigOverlay;
5			use Consolidation\Config\ConfigInterface;
6
7			class Config extends ConfigOverlay implements GlobalOptionDefaultValuesInterface
			0 ignored issues – show Deprecated Code introduced 2018-05-26 00:12 UTC by Report Bug Copy Issue Report The interface `Robo\Config\GlobalOptionDefaultValuesInterface` has been deprecated with message: Use robo.yml instead robo.yml: options: simulated: false progress-delay: 2 etc. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
8			{
9			const PROGRESS_BAR_AUTO_DISPLAY_INTERVAL = 'options.progress-delay';
10			const DEFAULT_PROGRESS_DELAY = 2;
11			const SIMULATE = 'options.simulate';
12
13			// Read-only configuration properties; changing these has no effect.
14			const INTERACTIVE = 'options.interactive';
15			const DECORATED = 'options.decorated';
16
17			/**
18			* Create a new configuration object, and initialize it with
19			* the provided nested array containing configuration data.
20			*/
21			public function __construct(array $data = null)
22			{
23			parent::__construct();
24
25			$this->import($data);
			0 ignored issues – show Bug introduced 2018-05-26 00:12 UTC by Report Bug Copy Issue Report It seems like `$data` defined by parameter `$data` on line 21 can also be of type `null`; however, `Robo\Config\Config::import()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
26			unset($this->contexts[ConfigOverlay::PROCESS_CONTEXT]);
27			$this->defaults = $this->getGlobalOptionDefaultValues();
			0 ignored issues – show Bug introduced 2018-05-26 00:12 UTC by Report Bug Copy Issue Report The property `defaults` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
28			}
29
30			/**
31			* {@inheritdoc}
32			*/
33			public function import($data)
34			{
35			return $this->replace($data);
			0 ignored issues – show Bug Best Practice introduced 2018-05-26 00:12 UTC by Report Bug Copy Issue Report The return type of `return $this->replace($data);` (`Robo\Config\Config`) is incompatible with the return type declared by the interface `Consolidation\Config\ConfigInterface::import` of type `Consolidation\Config\Config`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
36			}
37
38			/**
39			* @inheritdoc
40			*/
41			public function set($key, $value)
42			{
43			$this->contexts[self::DEFAULT_CONTEXT]->set($key, $value);
44			return $this;
45			}
46
47			/**
48			* {@inheritdoc}
49			*/
50			public function addContext($name, ConfigInterface $config)
51			{
52			$this->contexts[$name] = $config;
53			return $this;
54			}
55
56			/**
57			* {@inheritdoc}
58			*/
59			public function replace($data)
60			{
61			$this->getContext(ConfigOverlay::DEFAULT_CONTEXT)->replace($data);
62			return $this;
63			}
64
65			/**
66			* {@inheritdoc}
67			*/
68			public function combine($data)
69			{
70			$this->getContext(ConfigOverlay::DEFAULT_CONTEXT)->combine($data);
71			return $this;
72			}
73
74			/**
75			* Return an associative array containing all of the global configuration
76			* options and their default values.
77			*
78			* @return array
79			*/
80			public function getGlobalOptionDefaultValues()
81			{
82			$globalOptions =
83			[
84			self::PROGRESS_BAR_AUTO_DISPLAY_INTERVAL => self::DEFAULT_PROGRESS_DELAY,
85			self::SIMULATE => false,
86			];
87			return $this->trimPrefixFromGlobalOptions($globalOptions);
88			}
89
90			/**
91			* Remove the 'options.' prefix from the global options list.
92			*/
93			protected function trimPrefixFromGlobalOptions($globalOptions)
94			{
95			$result = [];
96			foreach ($globalOptions as $option => $value) {
97			$option = str_replace('options.', '', $option);
98			$result[$option] = $value;
99			}
100			return $result;
101			}
102
103			/**
104			* @deprecated Use $config->get(Config::SIMULATE)
105			*
106			* @return bool
107			*/
108			public function isSimulated()
109			{
110			return $this->get(self::SIMULATE);
111			}
112
113			/**
114			* @deprecated Use $config->set(Config::SIMULATE, true)
115			*
116			* @param bool $simulated
117			*
118			* @return $this
119			*/
120			public function setSimulated($simulated = true)
121			{
122			return $this->set(self::SIMULATE, $simulated);
123			}
124
125			/**
126			* @deprecated Use $config->get(Config::INTERACTIVE)
127			*
128			* @return bool
129			*/
130			public function isInteractive()
131			{
132			return $this->get(self::INTERACTIVE);
133			}
134
135			/**
136			* @deprecated Use $config->set(Config::INTERACTIVE, true)
137			*
138			* @param bool $interactive
139			*
140			* @return $this
141			*/
142			public function setInteractive($interactive = true)
143			{
144			return $this->set(self::INTERACTIVE, $interactive);
145			}
146
147			/**
148			* @deprecated Use $config->get(Config::DECORATED)
149			*
150			* @return bool
151			*/
152			public function isDecorated()
153			{
154			return $this->get(self::DECORATED);
155			}
156
157			/**
158			* @deprecated Use $config->set(Config::DECORATED, true)
159			*
160			* @param bool $decorated
161			*
162			* @return $this
163			*/
164			public function setDecorated($decorated = true)
165			{
166			return $this->set(self::DECORATED, $decorated);
167			}
168
169			/**
170			* @deprecated Use $config->set(Config::PROGRESS_BAR_AUTO_DISPLAY_INTERVAL, $interval)
171			*
172			* @param int $interval
173			*
174			* @return $this
175			*/
176			public function setProgressBarAutoDisplayInterval($interval)
177			{
178			return $this->set(self::PROGRESS_BAR_AUTO_DISPLAY_INTERVAL, $interval);
179			}
180			}
181

consolidation / robo

Pull Request — master (#737)

Config::setSimulated() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like