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

GlobalOptionsEventListener::splitConfigKeyValue() A
last analyzed 2020-08-27 17:44 UTC

↳ Parent: GlobalOptionsEventListener

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace Robo;

use Symfony\Component\Console\ConsoleEvents;
use Symfony\Component\Console\Event\ConsoleCommandEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Robo\Contract\ConfigAwareInterface;
use Robo\Common\ConfigAwareTrait;
use Robo\Config\GlobalOptionDefaultValuesInterface;

class GlobalOptionsEventListener implements EventSubscriberInterface, ConfigAwareInterface
{
    use ConfigAwareTrait;

    /**
     * @var \Robo\Application
     */
    protected $application;

    /**
     * @var string
     */
    protected $prefix;

    /**
     * GlobalOptionsEventListener listener
     */
    public function __construct()
    {
        $this->prefix = 'options';
    }

    /**
     * Add a reference to the Symfony Console application object.
     *
     * @param \Robo\Application $application
     *
     * @return $this
     */
    public function setApplication($application)
    {
        $this->application = $application;
        return $this;
    }

    /**
     * Stipulate the prefix to use for option injection.
     *
     * @param string $prefix
     *
     * @return $this
     */
    public function setGlobalOptionsPrefix($prefix)
    {
        $this->prefix = $prefix;
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents()
    {
        return [ConsoleEvents::COMMAND => 'handleCommandEvent'];
    }

    /**
     * Run all of our individual operations when a command event is received.
     */
    public function handleCommandEvent(ConsoleCommandEvent $event)
    {
        $this->setGlobalOptions($event);
        $this->setConfigurationValues($event);
    }

    /**
     * Before a Console command runs, examine the global
     * commandline options from the event Input, and set
     * configuration values as appropriate.
     *
     * @param \Symfony\Component\Console\Event\ConsoleCommandEvent $event
     */
    public function setGlobalOptions(ConsoleCommandEvent $event)
    {
        $config = $this->getConfig();
        $input = $event->getInput();

        $globalOptions = $config->get($this->prefix, []);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if ($config instanceof \Consolidation\Config\GlobalOptionDefaultValuesInterface) {
            $globalOptions += $config->getGlobalOptionDefaultValues();
        }

        $globalOptions += $this->applicationOptionDefaultValues();

        // Set any config value that has a defined global option (e.g. --simulate)
        foreach ($globalOptions as $option => $default) {
            $value = $input->hasOption($option) ? $input->getOption($option) : null;
            // Unfortunately, the `?:` operator does not differentate between `0` and `null`
            if (!isset($value)) {
                $value = $default;
            }
            $config->set($this->prefix . '.' . $option, $value);
        }
    }

    /**
     * Examine the commandline --define / -D options, and apply the provided
     * values to the active configuration.
     *
     * @param \Symfony\Component\Console\Event\ConsoleCommandEvent $event
     */
    public function setConfigurationValues(ConsoleCommandEvent $event)
    {
        $config = $this->getConfig();
        $input = $event->getInput();

        // Also set any `-Dconfig.key=value` options from the commandline.
        if ($input->hasOption('define')) {
            $configDefinitions = $input->getOption('define');
            foreach ($configDefinitions as $value) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                list($key, $value) = $this->splitConfigKeyValue($value);
                $config->set($key, $value);
            }
        }
    }

    /**
     * Split up the key=value config setting into its component parts. If
     * the input string contains no '=' character, then the value will be 'true'.
     *
     * @param string $value
     *
     * @return array
     */
    protected function splitConfigKeyValue($value)
    {
        $parts = explode('=', $value, 2);
        $parts[] = true;
        return $parts;
    }

    /**
     * Get default option values from the Symfony Console application, if
     * it is available.
     *
     * @return array
     */
    protected function applicationOptionDefaultValues()
    {
        if (!$this->application) {
            return [];
        }

        $result = [];
        foreach ($this->application->getDefinition()->getOptions() as $key => $option) {
            $result[$key] = $option->acceptValue() ? $option->getDefault() : null;
        }
        return $result;
    }
}


1			<?php
2
3			namespace Robo;
4
5			use Symfony\Component\Console\ConsoleEvents;
6			use Symfony\Component\Console\Event\ConsoleCommandEvent;
7			use Symfony\Component\EventDispatcher\EventSubscriberInterface;
8			use Robo\Contract\ConfigAwareInterface;
9			use Robo\Common\ConfigAwareTrait;
10			use Robo\Config\GlobalOptionDefaultValuesInterface;
11
12			class GlobalOptionsEventListener implements EventSubscriberInterface, ConfigAwareInterface
13			{
14			use ConfigAwareTrait;
15
16			/**
17			* @var \Robo\Application
18			*/
19			protected $application;
20
21			/**
22			* @var string
23			*/
24			protected $prefix;
25
26			/**
27			* GlobalOptionsEventListener listener
28			*/
29			public function __construct()
30			{
31			$this->prefix = 'options';
32			}
33
34			/**
35			* Add a reference to the Symfony Console application object.
36			*
37			* @param \Robo\Application $application
38			*
39			* @return $this
40			*/
41			public function setApplication($application)
42			{
43			$this->application = $application;
44			return $this;
45			}
46
47			/**
48			* Stipulate the prefix to use for option injection.
49			*
50			* @param string $prefix
51			*
52			* @return $this
53			*/
54			public function setGlobalOptionsPrefix($prefix)
55			{
56			$this->prefix = $prefix;
57			return $this;
58			}
59
60			/**
61			* {@inheritdoc}
62			*/
63			public static function getSubscribedEvents()
64			{
65			return [ConsoleEvents::COMMAND => 'handleCommandEvent'];
66			}
67
68			/**
69			* Run all of our individual operations when a command event is received.
70			*/
71			public function handleCommandEvent(ConsoleCommandEvent $event)
72			{
73			$this->setGlobalOptions($event);
74			$this->setConfigurationValues($event);
75			}
76
77			/**
78			* Before a Console command runs, examine the global
79			* commandline options from the event Input, and set
80			* configuration values as appropriate.
81			*
82			* @param \Symfony\Component\Console\Event\ConsoleCommandEvent $event
83			*/
84			public function setGlobalOptions(ConsoleCommandEvent $event)
85			{
86			$config = $this->getConfig();
87			$input = $event->getInput();
88
89			$globalOptions = $config->get($this->prefix, []);
			0 ignored issues – show Documentation introduced 2017-10-25 06:19 UTC by Report Bug Copy Issue Report `array()` is of type `array`, but the function expects a `string\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
90			if ($config instanceof \Consolidation\Config\GlobalOptionDefaultValuesInterface) {
91			$globalOptions += $config->getGlobalOptionDefaultValues();
92			}
93
94			$globalOptions += $this->applicationOptionDefaultValues();
95
96			// Set any config value that has a defined global option (e.g. --simulate)
97			foreach ($globalOptions as $option => $default) {
98			$value = $input->hasOption($option) ? $input->getOption($option) : null;
99			// Unfortunately, the `?:` operator does not differentate between `0` and `null`
100			if (!isset($value)) {
101			$value = $default;
102			}
103			$config->set($this->prefix . '.' . $option, $value);
104			}
105			}
106
107			/**
108			* Examine the commandline --define / -D options, and apply the provided
109			* values to the active configuration.
110			*
111			* @param \Symfony\Component\Console\Event\ConsoleCommandEvent $event
112			*/
113			public function setConfigurationValues(ConsoleCommandEvent $event)
114			{
115			$config = $this->getConfig();
116			$input = $event->getInput();
117
118			// Also set any `-Dconfig.key=value` options from the commandline.
119			if ($input->hasOption('define')) {
120			$configDefinitions = $input->getOption('define');
121			foreach ($configDefinitions as $value) {
			0 ignored issues – show Bug introduced 2018-10-03 16:19 UTC by Report Bug Copy Issue Report The expression `$configDefinitions` of type `string\|array<integer,string>\|boolean\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
122			list($key, $value) = $this->splitConfigKeyValue($value);
123			$config->set($key, $value);
124			}
125			}
126			}
127
128			/**
129			* Split up the key=value config setting into its component parts. If
130			* the input string contains no '=' character, then the value will be 'true'.
131			*
132			* @param string $value
133			*
134			* @return array
135			*/
136			protected function splitConfigKeyValue($value)
137			{
138			$parts = explode('=', $value, 2);
139			$parts[] = true;
140			return $parts;
141			}
142
143			/**
144			* Get default option values from the Symfony Console application, if
145			* it is available.
146			*
147			* @return array
148			*/
149			protected function applicationOptionDefaultValues()
150			{
151			if (!$this->application) {
152			return [];
153			}
154
155			$result = [];
156			foreach ($this->application->getDefinition()->getOptions() as $key => $option) {
157			$result[$key] = $option->acceptValue() ? $option->getDefault() : null;
158			}
159			return $result;
160			}
161			}
162

consolidation / robo

GlobalOptionsEventListener::splitConfigKeyValue() A last analyzed 2020-08-27 17:44 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

GlobalOptionsEventListener::splitConfigKeyValue() A
last analyzed 2020-08-27 17:44 UTC