GlobalOptionsEventListener::setGlobalOptionsPrefix() - Code Metrics - Inspection of "Load option default values from $input for all opt..." - consolidation/robo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( dcddd9...116b30 )

by Greg

created 2017-10-25 20:37 UTC

GlobalOptionsEventListener::setGlobalOptionsPrefix() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
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 Application */
    protected $application;

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

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

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

    /**
     * Stipulate the prefix to use for option injection.
     * @param string $prefix
     */
    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 `-D config.key=value` options from the commandline.
        if ($input->hasOption('define')) {
            $configDefinitions = $input->getOption('define');
            foreach ($configDefinitions as $value) {
                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.
     */
    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			namespace Robo;
3
4			use Symfony\Component\Console\ConsoleEvents;
5			use Symfony\Component\Console\Event\ConsoleCommandEvent;
6			use Symfony\Component\EventDispatcher\EventSubscriberInterface;
7			use Robo\Contract\ConfigAwareInterface;
8			use Robo\Common\ConfigAwareTrait;
9			use Robo\Config\GlobalOptionDefaultValuesInterface;
10
11			class GlobalOptionsEventListener implements EventSubscriberInterface, ConfigAwareInterface
12			{
13			use ConfigAwareTrait;
14
15			/** @var Application */
16			protected $application;
17
18			/** @var string */
19			protected $prefix;
20
21			/**
22			* GlobalOptionsEventListener listener
23			*/
24			public function __construct()
25			{
26			$this->prefix = 'options';
27			}
28
29			/**
30			* Add a reference to the Symfony Console application object.
31			*/
32			public function setApplication($application)
33			{
34			$this->application = $application;
35			return $this;
36			}
37
38			/**
39			* Stipulate the prefix to use for option injection.
40			* @param string $prefix
41			*/
42			public function setGlobalOptionsPrefix($prefix)
43			{
44			$this->prefix = $prefix;
45			return $this;
46			}
47
48			/**
49			* {@inheritdoc}
50			*/
51			public static function getSubscribedEvents()
52			{
53			return [ConsoleEvents::COMMAND => 'handleCommandEvent'];
54			}
55
56			/**
57			* Run all of our individual operations when a command event is received.
58			*/
59			public function handleCommandEvent(ConsoleCommandEvent $event)
60			{
61			$this->setGlobalOptions($event);
62			$this->setConfigurationValues($event);
63			}
64
65			/**
66			* Before a Console command runs, examine the global
67			* commandline options from the event Input, and set
68			* configuration values as appropriate.
69			*
70			* @param \Symfony\Component\Console\Event\ConsoleCommandEvent $event
71			*/
72			public function setGlobalOptions(ConsoleCommandEvent $event)
73			{
74			$config = $this->getConfig();
75			$input = $event->getInput();
76
77			$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...
78			if ($config instanceof \Consolidation\Config\GlobalOptionDefaultValuesInterface) {
79			$globalOptions += $config->getGlobalOptionDefaultValues();
80			}
81
82			$globalOptions += $this->applicationOptionDefaultValues();
83
84			// Set any config value that has a defined global option (e.g. --simulate)
85			foreach ($globalOptions as $option => $default) {
86			$value = $input->hasOption($option) ? $input->getOption($option) : null;
87			// Unfortunately, the `?:` operator does not differentate between `0` and `null`
88			if (!isset($value)) {
89			$value = $default;
90			}
91			$config->set($this->prefix . '.' . $option, $value);
92			}
93			}
94
95			/**
96			* Examine the commandline --define / -D options, and apply the provided
97			* values to the active configuration.
98			*
99			* @param \Symfony\Component\Console\Event\ConsoleCommandEvent $event
100			*/
101			public function setConfigurationValues(ConsoleCommandEvent $event)
102			{
103			$config = $this->getConfig();
104			$input = $event->getInput();
105
106			// Also set any `-D config.key=value` options from the commandline.
107			if ($input->hasOption('define')) {
108			$configDefinitions = $input->getOption('define');
109			foreach ($configDefinitions as $value) {
110			list($key, $value) = $this->splitConfigKeyValue($value);
111			$config->set($key, $value);
112			}
113			}
114			}
115
116			/**
117			* Split up the key=value config setting into its component parts. If
118			* the input string contains no '=' character, then the value will be 'true'.
119			*
120			* @param string $value
121			* @return array
122			*/
123			protected function splitConfigKeyValue($value)
124			{
125			$parts = explode('=', $value, 2);
126			$parts[] = true;
127			return $parts;
128			}
129
130			/**
131			* Get default option values from the Symfony Console application, if
132			* it is available.
133			*/
134			protected function applicationOptionDefaultValues()
135			{
136			if (!$this->application) {
137			return [];
138			}
139
140			$result = [];
141			foreach ($this->application->getDefinition()->getOptions() as $key => $option) {
142			$result[$key] = $option->acceptValue() ? $option->getDefault() : null;
143			}
144			return $result;
145			}
146			}
147

consolidation / robo

Push — master ( dcddd9...116b30 )

GlobalOptionsEventListener::setGlobalOptionsPrefix() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like