Table::setLeftMargin() - Code Metrics - o2system/kernel - Measure and Improve Code Quality continuously with Scrutinizer

Table::setLeftMargin() A
last analyzed 2019-10-02 16:44 UTC

↳ Parent: Table

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	5
rs	10

<?php
/**
 * This file is part of the O2System Framework package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author         Steeve Andrian Salim
 * @copyright      Copyright (c) Steeve Andrian Salim
 */

// ------------------------------------------------------------------------

namespace O2System\Kernel\Cli\Writers;

// ------------------------------------------------------------------------

/**
 * Class Table
 *
 * Table generator for PHP command line interface (cli).
 * Based on LucidFrame\Console\ConsoleTable class.
 *
 * @author  Sithu K. <[email protected]>
 *          Steeve Andrian Salim
 *
 * @package O2System\Kernel\Cli\Writers
 */
class Table
{
    /**
     * Table::HEADER_INDEX
     *
     * @var int
     */
    const HEADER_INDEX = -1;
    /**
     * Table::$isShowBorder
     *
     * Table show border flag.
     *
     * @var bool
     */
    public $isShowBorder = true;
    /**
     * Table::$rows
     *
     * Array of table rows.
     *
     * @var array
     */
    protected $rows = [];
    /**
     * Table::$padding
     *
     * Numbers of table padding.
     *
     * @var int
     */
    protected $padding = 1;

    /**
     * Table::$leftMargin
     *
     * Numbers of table left margin.
     *
     * @var int
     */
    protected $leftMargin = 0;

    /**
     * Table::$rowIndex
     *
     * Table row indexing numbers.
     *
     * @var int
     */
    private $rowIndex = -1;

    /**
     * Table::$columnsWidths
     *
     * Cache list of table column widths.
     *
     * @var array
     */
    private $columnWidths = [];

    // ------------------------------------------------------------------------

    /**
     * Table::setHeaders
     *
     * Adds the headers for the columns
     *
     * @param  array $headers of header cell content
     *
     * @return static
     */
    public function setHeaders(array $headers)
    {
        $this->rows[ self::HEADER_INDEX ] = $headers;

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Table::addHeader
     *
     * Adds a column to the table header
     *
     * @param mixed $content Table column cell content.
     *
     * @return static
     */
    public function addHeader($content = '')
    {
        $this->rows[ self::HEADER_INDEX ][] = $content;

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Table::getHeaders
     *
     * Get the row of header.
     *
     * @return mixed
     */
    public function getHeaders()
    {
        return isset($this->rows[ self::HEADER_INDEX ])
            ? $this->rows[ self::HEADER_INDEX ]
            : null;
    }

    // ------------------------------------------------------------------------

    /**
     * Table::addRow
     *
     * Adds a row to the table.
     *
     * @param  array $data The row data to add
     *
     * @return static
     */
    public function addRow($data = null)
    {
        $this->rowIndex++;
        if (is_array($data)) {
            foreach ($data as $column => $content) {
                $this->rows[ $this->rowIndex ][ $column ] = $content;
            }
        }

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Adds a column to the table
     *
     * @param  mixed $content     The data of the column
     * @param  int   $columnIndex The column index to populate
     * @param  int   $rowIndex    The row index, if the row isn't starting from zero, specify it here.
     *
     * @return static
     */
    public function addColumn($content, $columnIndex = null, $rowIndex = null)
    {
        $rowIndex = $rowIndex === null
            ? $this->rowIndex
            : $rowIndex;
        if ($columnIndex === null) {
            $columnIndex = isset($this->rows[ $rowIndex ])
                ? count($this->rows[ $rowIndex ])
                : 0;
        }
        $this->rows[ $rowIndex ][ $columnIndex ] = $content;

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Table::setPadding
     *
     * Set padding for each cell.
     *
     * @param  int $numbers The numbers of padding, the default numbers is 1.
     *
     * @return static
     */
    public function setPadding($numbers = 1)
    {
        $this->padding = $numbers;

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Table::setLeftMargin
     *
     * Set left indentation for the table.
     *
     * @param  int $numbers The numbers of left margin, the default numbers is 0.
     *
     * @return static
     */
    public function setLeftMargin($numbers = 0)
    {
        $this->leftMargin = $numbers;

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Table::__toString
     *
     * Implementation __toString magic method so that when the class is converted to a string
     * automatically performs the rendering process.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->render();
    }

    // ------------------------------------------------------------------------

    /**
     * Table::render
     *
     * Render the table.
     *
     * @return string
     */
    public function render()
    {
        $this->calculateColumnWidth();
        $output = $this->isShowBorder
            ? $this->renderBorder()
            : '';
        foreach ($this->rows as $rowIndex => $row) {
            foreach ($row as $cellIndex => $cell) {
                $output .= $this->renderCell($cellIndex, $row);
            }
            $output .= "\n";
            if ($rowIndex === self::HEADER_INDEX) {
                $output .= $this->renderBorder();
            }
        }
        $output .= $this->isShowBorder
            ? $this->renderBorder()
            : '';

        return $output;
    }

    // ------------------------------------------------------------------------

    /**
     * Table::calculateColumnWidth
     *
     * Calculate maximum width of each column
     *
     * @return array
     */
    private function calculateColumnWidth()
    {
        foreach ($this->rows as $rowIndex => $row) {
            foreach ($row as $columnIndex => $column) {
                if ( ! isset($this->columnWidths[ $columnIndex ])) {
                    $this->columnWidths[ $columnIndex ] = strlen($column);
                } else {
                    if (strlen($column) > $this->columnWidths[ $columnIndex ]) {
                        $this->columnWidths[ $columnIndex ] = strlen($column);
                    }
                }
            }
        }

        return $this->columnWidths;
    }

    // ------------------------------------------------------------------------

    /**
     * Table::renderBorder
     *
     * Render the table border.
     *
     * @return string
     */
    private function renderBorder()
    {
        $output = '';
        $columnCount = count($this->rows[ 0 ]);
        for ($col = 0; $col < $columnCount; $col++) {
            $output .= $this->renderCell($col);
        }
        if ($this->isShowBorder) {
            $output .= '+';
        }
        $output .= "\n";

        return $output;
    }

    // ------------------------------------------------------------------------

    /**
     * Table::renderCell
     *
     * Render the table cell content.
     *
     * @param int   $index The column index.
     * @param array $row   The table row.
     *
     * @return string
     */
    private function renderCell($index, $row = null)
    {
        $cell = $row
            ? $row[ $index ]
            : '-';
        $width = $this->columnWidths[ $index ];
        $pad = $row

            ? $width - strlen($cell)
            : $width;
        $padding = str_repeat(
            $row
                ? ' '
                : '-',
            $this->padding
        );
        $output = '';
        if ($index === 0) {
            $output .= str_repeat(' ', $this->leftMargin);
        }
        if ($this->isShowBorder) {
            $output .= $row
                ? '|'
                : '+';
        }
        $output .= $padding; # left padding
        $output .= str_pad(
            $cell,
            $width,
            $row
                ? ' '
                : '-'
        ); # cell content
        $output .= $padding; # right padding

        $row = is_array($row) ? $row : [];
        if ($index == count($row) - 1 && $this->isShowBorder) {
            $output .= $row
                ? '|'
                : '+';
        }

        return $output;
    }
}

1			<?php
2			/**
3			* This file is part of the O2System Framework package.
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*
8			* @author Steeve Andrian Salim
9			* @copyright Copyright (c) Steeve Andrian Salim
10			*/
11
12			// ------------------------------------------------------------------------
13
14			namespace O2System\Kernel\Cli\Writers;
15
16			// ------------------------------------------------------------------------
17
18			/**
19			* Class Table
20			*
21			* Table generator for PHP command line interface (cli).
22			* Based on LucidFrame\Console\ConsoleTable class.
23			*
24			* @author Sithu K. <[email protected]>
25			* Steeve Andrian Salim
26			*
27			* @package O2System\Kernel\Cli\Writers
28			*/
29			class Table
30			{
31			/**
32			* Table::HEADER_INDEX
33			*
34			* @var int
35			*/
36			const HEADER_INDEX = -1;
37			/**
38			* Table::$isShowBorder
39			*
40			* Table show border flag.
41			*
42			* @var bool
43			*/
44			public $isShowBorder = true;
45			/**
46			* Table::$rows
47			*
48			* Array of table rows.
49			*
50			* @var array
51			*/
52			protected $rows = [];
53			/**
54			* Table::$padding
55			*
56			* Numbers of table padding.
57			*
58			* @var int
59			*/
60			protected $padding = 1;
61
62			/**
63			* Table::$leftMargin
64			*
65			* Numbers of table left margin.
66			*
67			* @var int
68			*/
69			protected $leftMargin = 0;
70
71			/**
72			* Table::$rowIndex
73			*
74			* Table row indexing numbers.
75			*
76			* @var int
77			*/
78			private $rowIndex = -1;
79
80			/**
81			* Table::$columnsWidths
82			*
83			* Cache list of table column widths.
84			*
85			* @var array
86			*/
87			private $columnWidths = [];
88
89			// ------------------------------------------------------------------------
90
91			/**
92			* Table::setHeaders
93			*
94			* Adds the headers for the columns
95			*
96			* @param array $headers of header cell content
97			*
98			* @return static
99			*/
100			public function setHeaders(array $headers)
101			{
102			$this->rows[ self::HEADER_INDEX ] = $headers;
103
104			return $this;
105			}
106
107			// ------------------------------------------------------------------------
108
109			/**
110			* Table::addHeader
111			*
112			* Adds a column to the table header
113			*
114			* @param mixed $content Table column cell content.
115			*
116			* @return static
117			*/
118			public function addHeader($content = '')
119			{
120			$this->rows[ self::HEADER_INDEX ][] = $content;
121
122			return $this;
123			}
124
125			// ------------------------------------------------------------------------
126
127			/**
128			* Table::getHeaders
129			*
130			* Get the row of header.
131			*
132			* @return mixed
133			*/
134			public function getHeaders()
135			{
136			return isset($this->rows[ self::HEADER_INDEX ])
137			? $this->rows[ self::HEADER_INDEX ]
138			: null;
139			}
140
141			// ------------------------------------------------------------------------
142
143			/**
144			* Table::addRow
145			*
146			* Adds a row to the table.
147			*
148			* @param array $data The row data to add
149			*
150			* @return static
151			*/
152			public function addRow($data = null)
153			{
154			$this->rowIndex++;
155			if (is_array($data)) {
156			foreach ($data as $column => $content) {
157			$this->rows[ $this->rowIndex ][ $column ] = $content;
158			}
159			}
160
161			return $this;
162			}
163
164			// ------------------------------------------------------------------------
165
166			/**
167			* Adds a column to the table
168			*
169			* @param mixed $content The data of the column
170			* @param int $columnIndex The column index to populate
171			* @param int $rowIndex The row index, if the row isn't starting from zero, specify it here.
172			*
173			* @return static
174			*/
175			public function addColumn($content, $columnIndex = null, $rowIndex = null)
176			{
177			$rowIndex = $rowIndex === null
178			? $this->rowIndex
179			: $rowIndex;
180			if ($columnIndex === null) {
181			$columnIndex = isset($this->rows[ $rowIndex ])
182			? count($this->rows[ $rowIndex ])
183			: 0;
184			}
185			$this->rows[ $rowIndex ][ $columnIndex ] = $content;
186
187			return $this;
188			}
189
190			// ------------------------------------------------------------------------
191
192			/**
193			* Table::setPadding
194			*
195			* Set padding for each cell.
196			*
197			* @param int $numbers The numbers of padding, the default numbers is 1.
198			*
199			* @return static
200			*/
201			public function setPadding($numbers = 1)
202			{
203			$this->padding = $numbers;
204
205			return $this;
206			}
207
208			// ------------------------------------------------------------------------
209
210			/**
211			* Table::setLeftMargin
212			*
213			* Set left indentation for the table.
214			*
215			* @param int $numbers The numbers of left margin, the default numbers is 0.
216			*
217			* @return static
218			*/
219			public function setLeftMargin($numbers = 0)
220			{
221			$this->leftMargin = $numbers;
222
223			return $this;
224			}
225
226			// ------------------------------------------------------------------------
227
228			/**
229			* Table::__toString
230			*
231			* Implementation __toString magic method so that when the class is converted to a string
232			* automatically performs the rendering process.
233			*
234			* @return string
235			*/
236			public function __toString()
237			{
238			return $this->render();
239			}
240
241			// ------------------------------------------------------------------------
242
243			/**
244			* Table::render
245			*
246			* Render the table.
247			*
248			* @return string
249			*/
250			public function render()
251			{
252			$this->calculateColumnWidth();
253			$output = $this->isShowBorder
254			? $this->renderBorder()
255			: '';
256			foreach ($this->rows as $rowIndex => $row) {
257			foreach ($row as $cellIndex => $cell) {
258			$output .= $this->renderCell($cellIndex, $row);
259			}
260			$output .= "\n";
261			if ($rowIndex === self::HEADER_INDEX) {
262			$output .= $this->renderBorder();
263			}
264			}
265			$output .= $this->isShowBorder
266			? $this->renderBorder()
267			: '';
268
269			return $output;
270			}
271
272			// ------------------------------------------------------------------------
273
274			/**
275			* Table::calculateColumnWidth
276			*
277			* Calculate maximum width of each column
278			*
279			* @return array
280			*/
281			private function calculateColumnWidth()
282			{
283			foreach ($this->rows as $rowIndex => $row) {
284			foreach ($row as $columnIndex => $column) {
285			if ( ! isset($this->columnWidths[ $columnIndex ])) {
286			$this->columnWidths[ $columnIndex ] = strlen($column);
287			} else {
288			if (strlen($column) > $this->columnWidths[ $columnIndex ]) {
289			$this->columnWidths[ $columnIndex ] = strlen($column);
290			}
291			}
292			}
293			}
294
295			return $this->columnWidths;
296			}
297
298			// ------------------------------------------------------------------------
299
300			/**
301			* Table::renderBorder
302			*
303			* Render the table border.
304			*
305			* @return string
306			*/
307			private function renderBorder()
308			{
309			$output = '';
310			$columnCount = count($this->rows[ 0 ]);
311			for ($col = 0; $col < $columnCount; $col++) {
312			$output .= $this->renderCell($col);
313			}
314			if ($this->isShowBorder) {
315			$output .= '+';
316			}
317			$output .= "\n";
318
319			return $output;
320			}
321
322			// ------------------------------------------------------------------------
323
324			/**
325			* Table::renderCell
326			*
327			* Render the table cell content.
328			*
329			* @param int $index The column index.
330			* @param array $row The table row.
331			*
332			* @return string
333			*/
334			private function renderCell($index, $row = null)
335			{
336			$cell = $row
337			? $row[ $index ]
338			: '-';
339			$width = $this->columnWidths[ $index ];
340			$pad = $row
			0 ignored issues – show Unused Code introduced 2019-01-16 12:19 UTC by Report Bug Copy Issue Report The assignment to `$pad` is dead and can be removed. Loading history...
341			? $width - strlen($cell)
342			: $width;
343			$padding = str_repeat(
344			$row
345			? ' '
346			: '-',
347			$this->padding
348			);
349			$output = '';
350			if ($index === 0) {
351			$output .= str_repeat(' ', $this->leftMargin);
352			}
353			if ($this->isShowBorder) {
354			$output .= $row
355			? '\|'
356			: '+';
357			}
358			$output .= $padding; # left padding
359			$output .= str_pad(
360			$cell,
361			$width,
362			$row
363			? ' '
364			: '-'
365			); # cell content
366			$output .= $padding; # right padding
367
368			$row = is_array($row) ? $row : [];
369			if ($index == count($row) - 1 && $this->isShowBorder) {
370			$output .= $row
371			? '\|'
372			: '+';
373			}
374
375			return $output;
376			}
377			}

o2system / kernel

GitHub Access Token became invalid

Table::setLeftMargin() A last analyzed 2019-10-02 16:44 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Table::setLeftMargin() A
last analyzed 2019-10-02 16:44 UTC