Terminal::readln() - Code Metrics - kakserpom/phpdaemon - Measure and Improve Code Quality continuously with Scrutinizer

Terminal::readln() A
last analyzed 2021-06-02 17:17 UTC

↳ Parent: Terminal

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
namespace PHPDaemon\Utils;

/**
 * Terminal
 * @package PHPDaemon\Utils
 * @author  Vasily Zorin <[email protected]>
 */
class Terminal
{
    use \PHPDaemon\Traits\ClassWatchdog;
    use \PHPDaemon\Traits\StaticObjectWatchdog;

    /**
     * @var boolean Is color allowed in terminal?
     */
    protected $enableColor = false;

    /**
     * @var integer Maximum terminal width
     */
    protected $columns = 80;

    /**
     * Constructor
     */
    public function __construct()
    {
        $this->columns = $this->getMaxColumns();
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * Counting terminal char width
     * @return integer

     */
    protected function getMaxColumns()
    {
        if (preg_match_all("/columns.([0-9]+);/", strtolower(@exec('stty -a | grep columns')), $output)
            && sizeof($output) === 2
        ) {
            return $output[1][0];
        }

        return 80;
    }

    /**
     * Read a line from STDIN
     * @return string Line
     */
    public function readln()
    {
        return fgets(STDIN);
    }

    /**
     * Enables/disable color
     * @param  boolean $bool Enable?
     * @return void
     */
    public function enableColor($bool = true)
    {
        $this->enableColor = $bool;
    }

    /**
     * Clear the terminal with CLR
     * @return void
     */
    public function clearScreen()
    {
        echo "\x0c";
    }

    /**
     * Draw param (like in man)
     * @param string $name Param name
     * @param string $description Param description
     * @param array $values Param allowed values

     * @return void
     */
    public function drawParam($name, $description, $values = '')
    {
        $paramw = round($this->columns / 3);

        echo "\n";

        $leftcolumn = [];

        $valstr = is_array($values) ? implode('|', array_keys($values)) : $values;

        if ('' !== $valstr) {
            $valstr = '=[' . $valstr . ']';
        }

        $paramstr = "  \033[1m--" . $name . $valstr . "\033[0m";

        $pl = mb_orig_strlen($paramstr);
        if ($pl + 2 >= $paramw) {
            $paramw = $pl + 3;
        }

        $descw = $this->columns - $paramw;

        $leftcolumn[] = $paramstr;

        if (is_array($values)) {
            foreach ($values as $key => $value) {
                $leftcolumn[] = '    ' . $key . ' - ' . $value;
            }
        }

        if (strlen($description) <= $descw) {
            $rightcolumn[] = $description;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        } else {
            $m = explode(' ', $description);

            $descstr = '';

            while (sizeof($m) > 0) {
                $el = array_shift($m);

                if (strlen($descstr) + mb_orig_strlen($el) >= $descw) {
                    $rightcolumn[] = $descstr;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                    $descstr = '';
                } else {
                    $descstr .= ' ';
                }

                $descstr .= $el;
            }

            if ('' !== $descstr) {
                $rightcolumn[] = $descstr;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            }
        }

        while (sizeof($leftcolumn) > 0 || sizeof($rightcolumn) > 0) {
            if ($l = array_shift($leftcolumn)) {
                echo str_pad($l, $paramw, ' ');
            } else {
                echo str_repeat(' ', $paramw - 7);
            }

            if ($r = array_shift($rightcolumn)) {
                echo $r;
            }

            echo "\n";
        }
    }

    /**
     * Draw a table
     * @param  array Array of table's rows
     * @return void
     */
    public function drawTable($rows)
    {
        $pad = [];

        foreach ($rows as $row) {
            foreach ($row as $k => $v) {
                if (substr($k, 0, 1) === '_') {
                    continue;
                }

                if (!isset($pad[$k]) || (strlen($v) > $pad[$k])) {
                    $pad[$k] = mb_orig_strlen($v);
                }
            }
        }

        foreach ($rows as $row) {
            if (isset($row['_color'])) {
                $this->setStyle($row['_color']);
            }

            if (isset($row['_bold'])) {
                $this->setStyle('1');
            }

            if (isset($row['_'])) {
                echo $row['_'];
            } else {
                $i = 0;

                foreach ($row as $k => $v) {
                    if (substr($k, 0, 1) === '_') {
                        continue;
                    }

                    if ($i > 0) {
                        echo "\t";
                    }

                    echo str_pad($v, $pad[$k]);
                    ++$i;
                }
            }

            $this->resetStyle();
            echo "\n";
        }
    }

    /**
     * Set text style
     * @param  string $c Style
     * @return void
     */
    public function setStyle($c)
    {
        if ($this->enableColor) {
            echo "\033[" . $c . 'm';
        }
    }

    /**
     * Reset style to default
     * @return void
     */
    public function resetStyle()
    {
        if ($this->enableColor) {
            echo "\033[0m";
        }
    }
}


1			<?php
2			namespace PHPDaemon\Utils;
3
4			/**
5			* Terminal
6			* @package PHPDaemon\Utils
7			* @author Vasily Zorin <[email protected]>
8			*/
9			class Terminal
10			{
11			use \PHPDaemon\Traits\ClassWatchdog;
12			use \PHPDaemon\Traits\StaticObjectWatchdog;
13
14			/**
15			* @var boolean Is color allowed in terminal?
16			*/
17			protected $enableColor = false;
18
19			/**
20			* @var integer Maximum terminal width
21			*/
22			protected $columns = 80;
23
24			/**
25			* Constructor
26			*/
27			public function __construct()
28			{
29			$this->columns = $this->getMaxColumns();
			0 ignored issues – show Documentation Bug introduced 2015-12-06 14:42 UTC by Report Bug Copy Issue Report It seems like `$this->getMaxColumns()` can also be of type `string`. However, the property `$columns` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
30			}
31
32			/**
33			* Counting terminal char width
34			* @return integer
			0 ignored issues – show Documentation introduced 2015-12-06 14:42 UTC by Report Bug Copy Issue Report Should the return type not be `string\|integer`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
35			*/
36			protected function getMaxColumns()
37			{
38			if (preg_match_all("/columns.([0-9]+);/", strtolower(@exec('stty -a \| grep columns')), $output)
39			&& sizeof($output) === 2
40			) {
41			return $output[1][0];
42			}
43
44			return 80;
45			}
46
47			/**
48			* Read a line from STDIN
49			* @return string Line
50			*/
51			public function readln()
52			{
53			return fgets(STDIN);
54			}
55
56			/**
57			* Enables/disable color
58			* @param boolean $bool Enable?
59			* @return void
60			*/
61			public function enableColor($bool = true)
62			{
63			$this->enableColor = $bool;
64			}
65
66			/**
67			* Clear the terminal with CLR
68			* @return void
69			*/
70			public function clearScreen()
71			{
72			echo "\x0c";
73			}
74
75			/**
76			* Draw param (like in man)
77			* @param string $name Param name
78			* @param string $description Param description
79			* @param array $values Param allowed values
			0 ignored issues – show Documentation introduced 2015-12-06 14:42 UTC by Report Bug Copy Issue Report Should the type for parameter `$values` not be `string\|array`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
80			* @return void
81			*/
82			public function drawParam($name, $description, $values = '')
83			{
84			$paramw = round($this->columns / 3);
85
86			echo "\n";
87
88			$leftcolumn = [];
89
90			$valstr = is_array($values) ? implode('\|', array_keys($values)) : $values;
91
92			if ('' !== $valstr) {
93			$valstr = '=[' . $valstr . ']';
94			}
95
96			$paramstr = " \033[1m--" . $name . $valstr . "\033[0m";
97
98			$pl = mb_orig_strlen($paramstr);
99			if ($pl + 2 >= $paramw) {
100			$paramw = $pl + 3;
101			}
102
103			$descw = $this->columns - $paramw;
104
105			$leftcolumn[] = $paramstr;
106
107			if (is_array($values)) {
108			foreach ($values as $key => $value) {
109			$leftcolumn[] = ' ' . $key . ' - ' . $value;
110			}
111			}
112
113			if (strlen($description) <= $descw) {
114			$rightcolumn[] = $description;
			0 ignored issues – show Coding Style Comprehensibility introduced 2015-12-06 14:42 UTC by Report Bug Copy Issue Report `$rightcolumn` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$rightcolumn = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
115			} else {
116			$m = explode(' ', $description);
117
118			$descstr = '';
119
120			while (sizeof($m) > 0) {
121			$el = array_shift($m);
122
123			if (strlen($descstr) + mb_orig_strlen($el) >= $descw) {
124			$rightcolumn[] = $descstr;
			0 ignored issues – show Coding Style Comprehensibility introduced 2015-12-06 14:42 UTC by Report Bug Copy Issue Report `$rightcolumn` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$rightcolumn = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
125			$descstr = '';
126			} else {
127			$descstr .= ' ';
128			}
129
130			$descstr .= $el;
131			}
132
133			if ('' !== $descstr) {
134			$rightcolumn[] = $descstr;
			0 ignored issues – show Bug introduced 2015-12-06 14:42 UTC by Report Bug Copy Issue Report The variable `$rightcolumn` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
135			}
136			}
137
138			while (sizeof($leftcolumn) > 0 \|\| sizeof($rightcolumn) > 0) {
139			if ($l = array_shift($leftcolumn)) {
140			echo str_pad($l, $paramw, ' ');
141			} else {
142			echo str_repeat(' ', $paramw - 7);
143			}
144
145			if ($r = array_shift($rightcolumn)) {
146			echo $r;
147			}
148
149			echo "\n";
150			}
151			}
152
153			/**
154			* Draw a table
155			* @param array Array of table's rows
156			* @return void
157			*/
158			public function drawTable($rows)
159			{
160			$pad = [];
161
162			foreach ($rows as $row) {
163			foreach ($row as $k => $v) {
164			if (substr($k, 0, 1) === '_') {
165			continue;
166			}
167
168			if (!isset($pad[$k]) \|\| (strlen($v) > $pad[$k])) {
169			$pad[$k] = mb_orig_strlen($v);
170			}
171			}
172			}
173
174			foreach ($rows as $row) {
175			if (isset($row['_color'])) {
176			$this->setStyle($row['_color']);
177			}
178
179			if (isset($row['_bold'])) {
180			$this->setStyle('1');
181			}
182
183			if (isset($row['_'])) {
184			echo $row['_'];
185			} else {
186			$i = 0;
187
188			foreach ($row as $k => $v) {
189			if (substr($k, 0, 1) === '_') {
190			continue;
191			}
192
193			if ($i > 0) {
194			echo "\t";
195			}
196
197			echo str_pad($v, $pad[$k]);
198			++$i;
199			}
200			}
201
202			$this->resetStyle();
203			echo "\n";
204			}
205			}
206
207			/**
208			* Set text style
209			* @param string $c Style
210			* @return void
211			*/
212			public function setStyle($c)
213			{
214			if ($this->enableColor) {
215			echo "\033[" . $c . 'm';
216			}
217			}
218
219			/**
220			* Reset style to default
221			* @return void
222			*/
223			public function resetStyle()
224			{
225			if ($this->enableColor) {
226			echo "\033[0m";
227			}
228			}
229			}
230

kakserpom / phpdaemon

Terminal::readln() A last analyzed 2021-06-02 17:17 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Terminal::readln() A
last analyzed 2021-06-02 17:17 UTC