Command::outputFormat() - Code Metrics - gplcart/cli - Measure and Improve Code Quality continuously with Scrutinizer

Command::outputFormat() B
last analyzed 2018-03-10 20:38 UTC

↳ Parent: Command

Complexity

Conditions	5
Paths	5

Size

Total Lines	23
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	23
rs	8.5906
c	0
b	0
f	0
cc	5
eloc	19
nc	5
nop	2

<?php

/**
 * @package CLI
 * @author Iurii Makukh <[email protected]>
 * @copyright Copyright (c) 2018, Iurii Makukh <[email protected]>
 * @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0+
 */

namespace gplcart\modules\cli\controllers;

use gplcart\core\CliController;
use gplcart\core\traits\Listing as ListingTrait;
use InvalidArgumentException;

/**
 * Parent controller
 */
class Command extends CliController
{

    use ListingTrait;

    /**
     * Output formatted data
     * @param mixed $data
     * @param null|string $default
     * @return null
     */
    protected function outputFormat($data, $default = null)
    {
        switch ($this->getParam(array('f'), $default)) {
            case 'print-r':
                $this->line(print_r($data, true));
                break;
            case 'var-export':
                $this->line(var_export($data, true));
                break;
            case 'json':
                $this->line(json_encode($data, JSON_PRETTY_PRINT));
                break;
            case 'var-dump':
                ob_start();
                var_dump($data);

                $this->line(ob_get_clean());
                break;
            default:
                return null; // Pass to table formatter
        }

        $this->output();
    }

    /**
     * Output simple table
     * @param mixed $data
     * @param array $header
     */
    protected function outputFormatTable($data, array $header)
    {
        if (!is_array($data)) {
            $this->line(print_r($data, true));
            $this->output();
        }

        foreach ($data as &$row) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }

            if (!is_array($row)) {
                $this->errorAndExit($this->text('Unexpected table row format'));
            }

            ksort($row);

            foreach ($row as &$item) {
                if (is_array($item)) {
                    $item = '-- Array ' . count($item) . ' items --';
                }
            }
        }

        if (empty($data)) {
            $this->line($this->text('No results'));
        } else {
            array_unshift($data, $header);
            $this->table($data);
        }

        $this->output();
    }

    /**
     * Returns an array of limits form the limit option or a default value
     * @param array $default_limit
     * @return array
     */
    protected function getLimit(array $default_limit = array())
    {
        if (empty($default_limit)) {
            $default_limit = $this->config->get('module_cli_limit', array(0, 100));
        }

        $limit = $this->getParam('l');

        if (!isset($limit) || !is_numeric($limit)) {
            return $default_limit;
        }

        $exploded = explode(',', $limit, 2);

        if (count($exploded) == 1) {
            array_unshift($exploded, 0);
        }

        return $exploded;
    }

    /**
     * Limits an array of items
     * @param array $array
     * @param array $default_limit
     */
    protected function limitArray(&$array, array $default_limit = array())
    {
        if (is_array($array)) {
            $this->limitList($array, $this->getLimit($default_limit));
        }
    }

    /**
     * Explode a string using a separator character
     * @param string $value
     * @param string|null $separator
     * @return array
     */
    protected function explodeList($value, $separator = null)
    {
        if (is_array($value)) {
            return $value;
        }

        if ($value === '' || !is_string($value)) {
            return array();
        }

        if (!isset($separator)) {
            $separator = $this->config->get('module_cli_list_separator', '|');
        }

        return array_map('trim', explode($separator, $value));
    }

    /**
     * Convert a submitted JSON string into an array or FALSE on error
     * @param string $field
     */
    protected function setSubmittedJson($field)
    {
        $json = $this->getSubmitted($field);

        if (isset($json)) {
            $decoded = json_decode($json, true);
            if (json_last_error() === JSON_ERROR_NONE) {
                $this->setSubmitted($field, $decoded);
            } else {
                $decoded = json_decode(base64_decode($json), true);
                if (json_last_error() !== JSON_ERROR_NONE) {
                    throw new InvalidArgumentException('Failed to decode the submitted JSON string');
                }
                $this->setSubmitted($field, $decoded);
            }
        }
    }

    /**
     * Converts a submitted string into an array using a character as an separator
     * @param $field
     */
    protected function setSubmittedList($field)
    {
        $value = $this->getSubmitted($field);

        if (isset($value)) {
            $this->setSubmitted($field, $this->explodeList($value));
        }
    }

    /**
     * Validate prompt input when dealing with multiple values separated by a list character
     * @param string $field
     * @param string $label
     * @param string $validator
     * @param null|string $default
     */
    protected function validatePromptList($field, $label, $validator, $default = null)
    {
        $input = $this->prompt($label, $default);

        if ($this->isValidInput($this->explodeList($input), $field, $validator)) {
            $this->setSubmitted($field, $input);
        } else {
            $this->errors();
            $this->validatePromptList($field, $label, $validator, $default);
        }
    }

}


1			<?php
2
3			/**
4			* @package CLI
5			* @author Iurii Makukh <[email protected]>
6			* @copyright Copyright (c) 2018, Iurii Makukh <[email protected]>
7			* @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0+
8			*/
9
10			namespace gplcart\modules\cli\controllers;
11
12			use gplcart\core\CliController;
13			use gplcart\core\traits\Listing as ListingTrait;
14			use InvalidArgumentException;
15
16			/**
17			* Parent controller
18			*/
19			class Command extends CliController
20			{
21
22			use ListingTrait;
23
24			/**
25			* Output formatted data
26			* @param mixed $data
27			* @param null\|string $default
28			* @return null
29			*/
30			protected function outputFormat($data, $default = null)
31			{
32			switch ($this->getParam(array('f'), $default)) {
33			case 'print-r':
34			$this->line(print_r($data, true));
35			break;
36			case 'var-export':
37			$this->line(var_export($data, true));
38			break;
39			case 'json':
40			$this->line(json_encode($data, JSON_PRETTY_PRINT));
41			break;
42			case 'var-dump':
43			ob_start();
44			var_dump($data);
			0 ignored issues – show Security Debugging Code introduced 2018-01-14 21:16 UTC by Report Bug Copy Issue Report `var_dump($data);` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
45			$this->line(ob_get_clean());
46			break;
47			default:
48			return null; // Pass to table formatter
49			}
50
51			$this->output();
52			}
53
54			/**
55			* Output simple table
56			* @param mixed $data
57			* @param array $header
58			*/
59			protected function outputFormatTable($data, array $header)
60			{
61			if (!is_array($data)) {
62			$this->line(print_r($data, true));
63			$this->output();
64			}
65
66			foreach ($data as &$row) {
			0 ignored issues – show Bug introduced 2018-01-14 21:16 UTC by Report Bug Copy Issue Report The expression `$data` of type `object\|integer\|double\|string\|null\|boolean\|array` 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...
67
68			if (!is_array($row)) {
69			$this->errorAndExit($this->text('Unexpected table row format'));
70			}
71
72			ksort($row);
73
74			foreach ($row as &$item) {
75			if (is_array($item)) {
76			$item = '-- Array ' . count($item) . ' items --';
77			}
78			}
79			}
80
81			if (empty($data)) {
82			$this->line($this->text('No results'));
83			} else {
84			array_unshift($data, $header);
85			$this->table($data);
86			}
87
88			$this->output();
89			}
90
91			/**
92			* Returns an array of limits form the limit option or a default value
93			* @param array $default_limit
94			* @return array
95			*/
96			protected function getLimit(array $default_limit = array())
97			{
98			if (empty($default_limit)) {
99			$default_limit = $this->config->get('module_cli_limit', array(0, 100));
100			}
101
102			$limit = $this->getParam('l');
103
104			if (!isset($limit) \|\| !is_numeric($limit)) {
105			return $default_limit;
106			}
107
108			$exploded = explode(',', $limit, 2);
109
110			if (count($exploded) == 1) {
111			array_unshift($exploded, 0);
112			}
113
114			return $exploded;
115			}
116
117			/**
118			* Limits an array of items
119			* @param array $array
120			* @param array $default_limit
121			*/
122			protected function limitArray(&$array, array $default_limit = array())
123			{
124			if (is_array($array)) {
125			$this->limitList($array, $this->getLimit($default_limit));
126			}
127			}
128
129			/**
130			* Explode a string using a separator character
131			* @param string $value
132			* @param string\|null $separator
133			* @return array
134			*/
135			protected function explodeList($value, $separator = null)
136			{
137			if (is_array($value)) {
138			return $value;
139			}
140
141			if ($value === '' \|\| !is_string($value)) {
142			return array();
143			}
144
145			if (!isset($separator)) {
146			$separator = $this->config->get('module_cli_list_separator', '\|');
147			}
148
149			return array_map('trim', explode($separator, $value));
150			}
151
152			/**
153			* Convert a submitted JSON string into an array or FALSE on error
154			* @param string $field
155			*/
156			protected function setSubmittedJson($field)
157			{
158			$json = $this->getSubmitted($field);
159
160			if (isset($json)) {
161			$decoded = json_decode($json, true);
162			if (json_last_error() === JSON_ERROR_NONE) {
163			$this->setSubmitted($field, $decoded);
164			} else {
165			$decoded = json_decode(base64_decode($json), true);
166			if (json_last_error() !== JSON_ERROR_NONE) {
167			throw new InvalidArgumentException('Failed to decode the submitted JSON string');
168			}
169			$this->setSubmitted($field, $decoded);
170			}
171			}
172			}
173
174			/**
175			* Converts a submitted string into an array using a character as an separator
176			* @param $field
177			*/
178			protected function setSubmittedList($field)
179			{
180			$value = $this->getSubmitted($field);
181
182			if (isset($value)) {
183			$this->setSubmitted($field, $this->explodeList($value));
184			}
185			}
186
187			/**
188			* Validate prompt input when dealing with multiple values separated by a list character
189			* @param string $field
190			* @param string $label
191			* @param string $validator
192			* @param null\|string $default
193			*/
194			protected function validatePromptList($field, $label, $validator, $default = null)
195			{
196			$input = $this->prompt($label, $default);
197
198			if ($this->isValidInput($this->explodeList($input), $field, $validator)) {
199			$this->setSubmitted($field, $input);
200			} else {
201			$this->errors();
202			$this->validatePromptList($field, $label, $validator, $default);
203			}
204			}
205
206			}
207

gplcart / cli

Command::outputFormat() B last analyzed 2018-03-10 20:38 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Command::outputFormat() B
last analyzed 2018-03-10 20:38 UTC