Table::setFormatOutput() - Code Metrics - Inspection of "Don’t pollute Cli->formatOutput when calling Cli->..." - vanilla/garden-cli - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/guess-cli-format ( 6a8bbf...03b9b2 )

by Todd

created 2015-12-16 21:29 UTC

Table::setFormatOutput() A

↳ Parent: Table

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
cc	1
eloc	3
nc	1
nop	1
crap	1

<?php
namespace Garden\Cli;

/**
 * Used to write a formatted table to the console.
 */
class Table {
    /// Properties ///

    /**
     * @var array An array of column widths.
     */
    protected $columnWidths;

    /**
     * @var bool Whether or not to format the console commands.
     */
    protected $formatOutput = true;

    /**
     * @var array An array of the row data.
     */
    protected $rows;

    /**
     * @var array|null A pointer to the current row.
     */
    protected $currentRow;

    /**
     * @var int The maximum width of the table.
     */
    public $maxWidth = 80;

    /**
     * @var int The left padding on each cell.
     */
    public $padding = 3;

    /**
     * @var int The left indent on the table.
     */
    public $indent = 2;


    /// Methods ///

    /**
     * Initialize an instance of the {@link Table} class.
     */
    public function __construct() {
        $this->formatOutput = Cli::guessFormatOutput();
        $this->reset();
    }

    /**
     * Backwards compatibility for the **format** property.
     *
     * @param string $name Must be **format**.
     * @return bool|null Returns {@link getFormatOutput()} or null if {@link $name} isn't **format**.
     */
    public function __get($name) {
        if ($name === 'format') {
            trigger_error("Cli->format is deprecated. Use Cli->getFormatOutput() instead.", E_USER_DEPRECATED);
            return $this->getFormatOutput();
        }
        return null;
    }

    /**
     * Backwards compatibility for the **format** property.
     *
     * @param string $name Must be **format**.
     * @param bool $value One of **true** or **false**.
     */
    public function __set($name, $value) {
        if ($name === 'format') {
            trigger_error("Cli->format is deprecated. Use Cli->setFormatOutput() instead.", E_USER_DEPRECATED);
            $this->setFormatOutput($value);
        }
    }

    /**
     * Get whether or not output should be formatted.
     *
     * @return boolean Returns **true** if output should be formatted or **false** otherwise.
     */
    public function getFormatOutput() {
        return $this->formatOutput;
    }

    /**
     * Set whether or not output should be formatted.
     *
     * @param boolean $formatOutput Whether or not to format output.
     * @return LogFormatter Returns `$this` for fluent calls.
     */
    public function setFormatOutput($formatOutput) {
        $this->formatOutput = $formatOutput;
        return $this;
    }

    /**
     * Add a cell to the table.
     *
     * @param string $text The text of the cell.
     * @param array $wrap A two element array used to wrap the text in the cell.
     * @return $this Returns this object for fluent calls.
     */
    protected function addCell($text, $wrap = ['', '']) {
        if ($this->currentRow === null) {
            $this->row();
        }

        $i = count($this->currentRow);
        $this->columnWidths[$i] = max(strlen($text), Cli::val($i, $this->columnWidths, 0)); // max column width

        $this->currentRow[$i] = [$text, $wrap];
        return $this;
    }

    /**
     * Adds a cell.
     *
     * @param string $text The text of the cell.
     * @return $this Returns this object for fluent calls.
     */
    public function cell($text) {
        return $this->addCell($text);
    }

    /**
     * Adds a bold cell.
     *
     * @param string $text The text of the cell.
     * @return $this Returns this object for fluent calls.
     */
    public function bold($text) {
        return $this->addCell($text, ["\033[1m", "\033[0m"]);
    }

    /**
     * Adds a red cell.
     *
     * @param string $text The text of the cell.
     * @return $this Returns this object for fluent calls.
     */
    public function red($text) {
        return $this->addCell($text, ["\033[1;31m", "\033[0m"]);
    }

    /**
     * Adds a green cell.
     *
     * @param string $text The text of the cell.
     * @return $this Returns this object for fluent calls.
     */
    public function green($text) {
        return $this->addCell($text, ["\033[1;32m", "\033[0m"]);
    }

    /**
     * Adds a blue cell.
     *
     * @param string $text The text of the cell.
     * @return $this Returns this object for fluent calls.
     */
    public function blue($text) {
        return $this->addCell($text, ["\033[1;34m", "\033[0m"]);
    }

    /**
     * Adds a purple cell.
     * 
     * @param string $text The text of the cell.
     * @return $this Returns this object for fluent calls.
     */
    public function purple($text) {
        return $this->addCell($text, ["\033[0;35m", "\033[0m"]);
    }

    /**
     * Reset the table so another one can be written with the same object.
     */
    public function reset() {
        $this->columnWidths = [];
        $this->rows = [];
        $this->currentRow = null;
    }

    /**
     * Start a new row.
     * 
     * @return $this Returns this object for fluent calls.
     */
    public function row() {
        $this->rows[] = [];
        $this->currentRow =& $this->rows[count($this->rows) - 1];
        return $this;
    }

    /**
     * Writes the final table.
     */
    public function write() {
        // Determine the width of the last column.
        $columnWidths = array_sum($this->columnWidths);
        $totalWidth = $this->indent + $columnWidths + $this->padding * (count($this->columnWidths) - 1);

        $lastWidth = end($this->columnWidths) + $this->maxWidth - $totalWidth;
        $lastWidth = max($lastWidth, 10); // min width of 10
        $this->columnWidths[count($this->columnWidths) - 1] = $lastWidth;

        // Loop through each row and write it.
        foreach ($this->rows as $row) {
            $rowLines = [];
            $lineCount = 0;

            // Split the cells into lines.
            foreach ($row as $i => $cell) {
                list($text,) = $cell;
                $width = $this->columnWidths[$i];

                $lines = Cli::breakLines($text, $width, $i < count($this->columnWidths) - 1);
                $rowLines[] = $lines;
                $lineCount = max($lineCount, count($lines));
            }

            // Write all of the lines.
            for ($i = 0; $i < $lineCount; $i++) {
                foreach ($rowLines as $j => $lines) {
                    $padding = $j === 0 ? $this->indent : $this->padding;

                    if (isset($lines[$i])) {
                        if(isset($row[$i])) {
                            $wrap = $row[$i][1];
                        } else {
                            // if we're out of array, use the latest wraps
                            $wrap = $row[count($row)-1][1];
                        }

                        if ($this->formatOutput) {
                            echo str_repeat(' ', $padding).$wrap[0].$lines[$i].$wrap[1];
                        } else {
                            echo str_repeat(' ', $padding).$lines[$i];
                        }
                    } elseif ($j < count($this->columnWidths) - 1) {
                        // This is an empty line. Write the spaces.
                        echo str_repeat(' ', $padding + $this->columnWidths[$j]);
                    }
                }
                echo PHP_EOL;
            }
        }
    }
}


1		<?php
2		namespace Garden\Cli;
3
4		/**
5		* Used to write a formatted table to the console.
6		*/
7		class Table {
8		/// Properties ///
9
10		/**
11		* @var array An array of column widths.
12		*/
13		protected $columnWidths;
14
15		/**
16		* @var bool Whether or not to format the console commands.
17		*/
18		protected $formatOutput = true;
19
20		/**
21		* @var array An array of the row data.
22		*/
23		protected $rows;
24
25		/**
26		* @var array\|null A pointer to the current row.
27		*/
28		protected $currentRow;
29
30		/**
31		* @var int The maximum width of the table.
32		*/
33		public $maxWidth = 80;
34
35		/**
36		* @var int The left padding on each cell.
37		*/
38		public $padding = 3;
39
40		/**
41		* @var int The left indent on the table.
42		*/
43		public $indent = 2;
44
45
46		/// Methods ///
47
48		/**
49		* Initialize an instance of the {@link Table} class.
50		*/
51	6	public function __construct() {
52	6	$this->formatOutput = Cli::guessFormatOutput();
53	6	$this->reset();
54	6	}
55
56		/**
57		* Backwards compatibility for the format property.
58		*
59		* @param string $name Must be format.
60		* @return bool\|null Returns {@link getFormatOutput()} or null if {@link $name} isn't format.
61		*/
62		public function __get($name) {
63		if ($name === 'format') {
64		trigger_error("Cli->format is deprecated. Use Cli->getFormatOutput() instead.", E_USER_DEPRECATED);
65		return $this->getFormatOutput();
66		}
67		return null;
68		}
69
70		/**
71		* Backwards compatibility for the format property.
72		*
73		* @param string $name Must be format.
74		* @param bool $value One of true or false.
75		*/
76		public function __set($name, $value) {
77		if ($name === 'format') {
78		trigger_error("Cli->format is deprecated. Use Cli->setFormatOutput() instead.", E_USER_DEPRECATED);
79		$this->setFormatOutput($value);
80		}
81		}
82
83		/**
84		* Get whether or not output should be formatted.
85		*
86		* @return boolean Returns true if output should be formatted or false otherwise.
87		*/
88		public function getFormatOutput() {
89		return $this->formatOutput;
90		}
91
92		/**
93		* Set whether or not output should be formatted.
94		*
95		* @param boolean $formatOutput Whether or not to format output.
96		* @return LogFormatter Returns `$this` for fluent calls.
97		*/
98	4	public function setFormatOutput($formatOutput) {
99	4	$this->formatOutput = $formatOutput;
100	4	return $this;
101		}
102
103		/**
104		* Add a cell to the table.
105		*
106		* @param string $text The text of the cell.
107		* @param array $wrap A two element array used to wrap the text in the cell.
108		* @return $this Returns this object for fluent calls.
109		*/
110	6	protected function addCell($text, $wrap = ['', '']) {
111	6	if ($this->currentRow === null) {
112		$this->row();
113		}
114
115	6	$i = count($this->currentRow);
116	6	$this->columnWidths[$i] = max(strlen($text), Cli::val($i, $this->columnWidths, 0)); // max column width
117
118	6	$this->currentRow[$i] = [$text, $wrap];
119	6	return $this;
120		}
121
122		/**
123		* Adds a cell.
124		*
125		* @param string $text The text of the cell.
126		* @return $this Returns this object for fluent calls.
127		*/
128	6	public function cell($text) {
129	6	return $this->addCell($text);
130		}
131
132		/**
133		* Adds a bold cell.
134		*
135		* @param string $text The text of the cell.
136		* @return $this Returns this object for fluent calls.
137		*/
138	3	public function bold($text) {
139	3	return $this->addCell($text, ["\033[1m", "\033[0m"]);
140		}
141
142		/**
143		* Adds a red cell.
144		*
145		* @param string $text The text of the cell.
146		* @return $this Returns this object for fluent calls.
147		*/
148		public function red($text) {
149		return $this->addCell($text, ["\033[1;31m", "\033[0m"]);
150		}
151
152		/**
153		* Adds a green cell.
154		*
155		* @param string $text The text of the cell.
156		* @return $this Returns this object for fluent calls.
157		*/
158		public function green($text) {
159		return $this->addCell($text, ["\033[1;32m", "\033[0m"]);
160		}
161
162		/**
163		* Adds a blue cell.
164		*
165		* @param string $text The text of the cell.
166		* @return $this Returns this object for fluent calls.
167		*/
168		public function blue($text) {
169		return $this->addCell($text, ["\033[1;34m", "\033[0m"]);
170		}
171
172		/**
173		* Adds a purple cell.
174		*
175		* @param string $text The text of the cell.
176		* @return $this Returns this object for fluent calls.
177		*/
178		public function purple($text) {
179		return $this->addCell($text, ["\033[0;35m", "\033[0m"]);
180		}
181
182		/**
183		* Reset the table so another one can be written with the same object.
184		*/
185	6	public function reset() {
186	6	$this->columnWidths = [];
187	6	$this->rows = [];
188	6	$this->currentRow = null;
189	6	}
190
191		/**
192		* Start a new row.
193		*
194		* @return $this Returns this object for fluent calls.
195		*/
196	6	public function row() {
197	6	$this->rows[] = [];
198	6	$this->currentRow =& $this->rows[count($this->rows) - 1];
199	6	return $this;
200		}
201
202		/**
203		* Writes the final table.
204		*/
205	6	public function write() {
206		// Determine the width of the last column.
207	6	$columnWidths = array_sum($this->columnWidths);
208	6	$totalWidth = $this->indent + $columnWidths + $this->padding * (count($this->columnWidths) - 1);
209
210	6	$lastWidth = end($this->columnWidths) + $this->maxWidth - $totalWidth;
211	6	$lastWidth = max($lastWidth, 10); // min width of 10
212	6	$this->columnWidths[count($this->columnWidths) - 1] = $lastWidth;
213
214		// Loop through each row and write it.
215	6	foreach ($this->rows as $row) {
216	6	$rowLines = [];
217	6	$lineCount = 0;
218
219		// Split the cells into lines.
220	6	foreach ($row as $i => $cell) {
221	6	list($text,) = $cell;
222	6	$width = $this->columnWidths[$i];
223
224	6	$lines = Cli::breakLines($text, $width, $i < count($this->columnWidths) - 1);
225	6	$rowLines[] = $lines;
226	6	$lineCount = max($lineCount, count($lines));
227	6	}
228
229		// Write all of the lines.
230	6	for ($i = 0; $i < $lineCount; $i++) {
231	6	foreach ($rowLines as $j => $lines) {
232	6	$padding = $j === 0 ? $this->indent : $this->padding;
233
234	6	if (isset($lines[$i])) {
235	6	if(isset($row[$i])) {
236	6	$wrap = $row[$i][1];
237	6	} else {
238		// if we're out of array, use the latest wraps
239	2	$wrap = $row[count($row)-1][1];
240		}
241
242	6	if ($this->formatOutput) {
243	2	echo str_repeat(' ', $padding).$wrap[0].$lines[$i].$wrap[1];
244	2	} else {
245	4	echo str_repeat(' ', $padding).$lines[$i];
246		}
247	6	} elseif ($j < count($this->columnWidths) - 1) {
248		// This is an empty line. Write the spaces.
249	2	echo str_repeat(' ', $padding + $this->columnWidths[$j]);
250	2	}
251	6	}
252	6	echo PHP_EOL;
253	6	}
254	6	}
255	6	}
256		}
257

vanilla / garden-cli

Push — feature/guess-cli-format ( 6a8bbf...03b9b2 )

Table::setFormatOutput() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like