Config::setSimulated() - Code Metrics - consolidation/robo - Measure and Improve Code Quality continuously with Scrutinizer

Config::setSimulated() A
last analyzed 2020-08-27 17:44 UTC

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
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);

        $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 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.
     *
     * @param array $globalOptions
     *
     * @return array
     */
    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
3			namespace Robo\Config;
4
5			use Consolidation\Config\Util\ConfigOverlay;
6			use Consolidation\Config\ConfigInterface;
7
8			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...
9			{
10			const PROGRESS_BAR_AUTO_DISPLAY_INTERVAL = 'options.progress-delay';
11			const DEFAULT_PROGRESS_DELAY = 2;
12			const SIMULATE = 'options.simulate';
13
14			// Read-only configuration properties; changing these has no effect.
15			const INTERACTIVE = 'options.interactive';
16			const DECORATED = 'options.decorated';
17
18			/**
19			* Create a new configuration object, and initialize it with
20			* the provided nested array containing configuration data.
21			*/
22			public function __construct(array $data = null)
23			{
24			parent::__construct();
25
26			$this->import($data);
			0 ignored issues – show Bug introduced 2018-06-11 16:20 UTC by Report Bug Copy Issue Report It seems like `$data` defined by parameter `$data` on line 22 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...
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 replace($data)
42			{
43			$this->getContext(ConfigOverlay::DEFAULT_CONTEXT)->replace($data);
44			return $this;
45			}
46
47			/**
48			* {@inheritdoc}
49			*/
50			public function combine($data)
51			{
52			$this->getContext(ConfigOverlay::DEFAULT_CONTEXT)->combine($data);
53			return $this;
54			}
55
56			/**
57			* Return an associative array containing all of the global configuration
58			* options and their default values.
59			*
60			* @return array
61			*/
62			public function getGlobalOptionDefaultValues()
63			{
64			$globalOptions =
65			[
66			self::PROGRESS_BAR_AUTO_DISPLAY_INTERVAL => self::DEFAULT_PROGRESS_DELAY,
67			self::SIMULATE => false,
68			];
69			return $this->trimPrefixFromGlobalOptions($globalOptions);
70			}
71
72			/**
73			* Remove the 'options.' prefix from the global options list.
74			*
75			* @param array $globalOptions
76			*
77			* @return array
78			*/
79			protected function trimPrefixFromGlobalOptions($globalOptions)
80			{
81			$result = [];
82			foreach ($globalOptions as $option => $value) {
83			$option = str_replace('options.', '', $option);
84			$result[$option] = $value;
85			}
86			return $result;
87			}
88
89			/**
90			* @deprecated Use $config->get(Config::SIMULATE)
91			*
92			* @return bool
93			*/
94			public function isSimulated()
95			{
96			return $this->get(self::SIMULATE);
97			}
98
99			/**
100			* @deprecated Use $config->set(Config::SIMULATE, true)
101			*
102			* @param bool $simulated
103			*
104			* @return $this
105			*/
106			public function setSimulated($simulated = true)
107			{
108			return $this->set(self::SIMULATE, $simulated);
109			}
110
111			/**
112			* @deprecated Use $config->get(Config::INTERACTIVE)
113			*
114			* @return bool
115			*/
116			public function isInteractive()
117			{
118			return $this->get(self::INTERACTIVE);
119			}
120
121			/**
122			* @deprecated Use $config->set(Config::INTERACTIVE, true)
123			*
124			* @param bool $interactive
125			*
126			* @return $this
127			*/
128			public function setInteractive($interactive = true)
129			{
130			return $this->set(self::INTERACTIVE, $interactive);
131			}
132
133			/**
134			* @deprecated Use $config->get(Config::DECORATED)
135			*
136			* @return bool
137			*/
138			public function isDecorated()
139			{
140			return $this->get(self::DECORATED);
141			}
142
143			/**
144			* @deprecated Use $config->set(Config::DECORATED, true)
145			*
146			* @param bool $decorated
147			*
148			* @return $this
149			*/
150			public function setDecorated($decorated = true)
151			{
152			return $this->set(self::DECORATED, $decorated);
153			}
154
155			/**
156			* @deprecated Use $config->set(Config::PROGRESS_BAR_AUTO_DISPLAY_INTERVAL, $interval)
157			*
158			* @param int $interval
159			*
160			* @return $this
161			*/
162			public function setProgressBarAutoDisplayInterval($interval)
163			{
164			return $this->set(self::PROGRESS_BAR_AUTO_DISPLAY_INTERVAL, $interval);
165			}
166			}
167

consolidation / robo

Config::setSimulated() A last analyzed 2020-08-27 17:44 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Config::setSimulated() A
last analyzed 2020-08-27 17:44 UTC