ConsoleTable

Complexity

Total Complexity

15

Size/Duplication

Total Lines	101
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	buildHeader()	0	20	3
A	buildRow()	0	9	2
A	detectColumnSize()	0	23	6
A	__construct()	0	23	4

<?php

/**
 * This is just a simple helper class which displays the result set as a nice console table.
 *
 * Class ConsoleTable
 * @phpstan-type DataType array<int|string, string|int|array<string|int, array<mixed>|int|string>>
 */
class ConsoleTable
{
    /**
     * @var array<string,int>
     */
    protected array $columns = [];

    /**
     * @param DataType $data

The type DataType was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @return void
     */
    protected function detectColumnSize(array $data): void
    {
        // Find the longest string in each column
        $columns = [];
        foreach ($data as $row) {
            $row = (array)$row;
            foreach ($row as $cellKey => $cell) {
                if (is_array($cell)) {
                    $cell = implode(', ', $cell);
                }

                $valueLength = strlen(strval($cell));
                $nameLength  = strlen(strval($cellKey));

                $length = max($nameLength, $valueLength);

                if (empty($columns[$cellKey]) || $columns[$cellKey] < $length) {
                    $columns[strval($cellKey)] = $length;
                }
            }
        }

        $this->columns = $columns;
    }

    protected function buildRow(): string
    {
        $table = '+';
        foreach ($this->columns as $length) {
            $table .= str_repeat('-', $length + 1) . '-+';
        }
        $table .= PHP_EOL;

        return $table;
    }

    /**
     * @param DataType $data
     *
     * @return string
     */
    protected function buildHeader(array $data): string
    {
        $table = $this->buildRow();

        // Build the header
        foreach ($data as $row) {
            $table .= '| ';
            $row = (array)$row;
            foreach ($row as $cellKey => $cell) {
                $cellKey = strval($cellKey);
                $table .= str_pad($cellKey, $this->columns[$cellKey]) . ' | ';
            }
            $table .= PHP_EOL;

            break;
        }

        $table .= $this->buildRow();

        return $table;
    }

    /**
     * @param DataType $data
     */
    public function __construct(array $data)
    {
        $this->detectColumnSize($data);

        $table = $this->buildHeader($data);

        // Output table, padding columns
        foreach ($data as $row) {
            $table .= '| ';

            foreach ($this->columns as $column => $length) {
                $value = $row[$column] ?? '';
                if (is_array($value)) {
                    $value = implode(', ', $value);
                }
                $table .= str_pad((string)($value), $length) . ' | ';
            }
            $table .= PHP_EOL;
        }

        $table .= $this->buildRow();

        echo $table;
    }
}