lochmueller / ink

Classes/Rendering/Table.php

<?php
/**
 * Render a table
 *
 * @author Tim Lochmüller
 */

namespace FRUIT\Ink\Rendering;

use FRUIT\Ink\Configuration;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Render a table
 */
class Table extends AbstractRendering
{

    /**
     * Table settings
     *
     * @var array
     */
    protected $tableSettings = array(
        'default'       => array(
            'join'           => '+',
            'xChar'          => '-',
            'xCharHeader'    => '-',
            'yChar'          => '|',
            'yCharHeader'    => '|',
            'xSpace'         => 1,
            'ySpace'         => 0,
            'separateData'   => false,
            'separateHeader' => true,
            'outerTop'       => true,
            'outerBottom'    => true,
            'outerLeft'      => true,
            'outerRight'     => true,
        ),
        'ascii_old'     => array(
            'join'           => '+',
            'xChar'          => '-',
            'xCharHeader'    => '=',
            'yChar'          => '|',
            'yCharHeader'    => '|',
            'xSpace'         => 1,
            'ySpace'         => 0,
            'separateData'   => true,
            'separateHeader' => true,
            'outerTop'       => true,
            'outerBottom'    => true,
            'outerLeft'      => true,
            'outerRight'     => true,
        ),
        'ascii_compact' => array(
            'join'           => ' ',
            'xChar'          => ' ',
            'xCharHeader'    => '=',
            'yChar'          => ' ',
            'yCharHeader'    => ' ',
            'xSpace'         => 0,
            'ySpace'         => 0,
            'separateData'   => false,
            'separateHeader' => true,
            'outerTop'       => false,
            'outerBottom'    => false,
            'outerLeft'      => false,
            'outerRight'     => false,
        ),
        'unicode'       => array(
            'join'           => '╬',
            'xChar'          => '═',
            'xCharHeader'    => '═',
            'yChar'          => '║',
            'yCharHeader'    => '║',
            'xSpace'         => 1,
            'ySpace'         => 0,
            'separateData'   => false,
            'separateHeader' => true,
            'outerTop'       => true,
            'outerBottom'    => true,
            'outerLeft'      => true,
            'outerRight'     => true,
        ),
        'markdown'      => array(
            'join'           => ' ',
            'xChar'          => ' ',
            'xCharHeader'    => '-',
            'yChar'          => '|',
            'yCharHeader'    => '|',
            'xSpace'         => 1,
            'ySpace'         => 0,
            'separateData'   => false,
            'separateHeader' => true,
            'outerTop'       => false,
            'outerBottom'    => false,
            'outerLeft'      => true,
            'outerRight'     => true,
        ),
    );

    /**
     * Render mode
     *
     * @var string
     */
    protected $renderMode = 'markdown';

    /**
     * @return array
     */
    public function renderInternal()
    {
        $controller = GeneralUtility::makeInstance('TYPO3\\CMS\\CssStyledContent\\Controller\\CssStyledContentController');
        $controller->cObj = $this->contentObject;
        $this->renderMode = Configuration::getTableMode();
        $htmlTable = $controller->render_table();
        $tableData = $this->parseHtmlTable($htmlTable);
        return $this->getTable($tableData);
    }

    /**
     * @param $html
     *
     * @return array
     */
    protected function parseHtmlTable($html)
    {
        $dom = new \DOMDocument();

        //load the html
        $html = $dom->loadHTML(utf8_decode($html));

$html is not used, you could remove the assignment.

        //discard white space
        $dom->preserveWhiteSpace = false;

        //the table by its tag name
        $tables = $dom->getElementsByTagName('table');

        //get all rows from the table
        $rows = $tables->item(0)
            ->getElementsByTagName('tr');
        // get each column by tag name
        $cols = $rows->item(0)
            ->getElementsByTagName('th');
        $row_headers = null;
        foreach ($cols as $node) {
            //print $node->nodeValue."\n";
            $row_headers[] = $node->nodeValue;
        }

        $table = array();
        //get all rows from the table
        $rows = $tables->item(0)
            ->getElementsByTagName('tr');
        foreach ($rows as $row) {
            // get each column by tag name
            $cols = $row->getElementsByTagName('td');
            $row = array();
            $i = 0;
            foreach ($cols as $node) {
                # code...
                //print $node->nodeValue."\n";
                if ($row_headers == null) {
                    $row[] = $node->nodeValue;
                } else {
                    $row[$row_headers[$i]] = $node->nodeValue;
                }
                $i++;
            }
            $table[] = $row;
        }

        return $table;
    }

    /**
     * Get the table
     *
     * @param $table
     *
     * @return string
     */
    public function getTable($table)
    {
        $lines = array();
        $columnsHeaders = $this->columnsHeaders($table);
        $columns_lengths = $this->columnsLengths($table, $columnsHeaders);

        $topLine = $this->renderLine($columns_lengths, 'top', 'CharHeader');
        if ($topLine) {

The expression $topLine of type false|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

            $lines[] = $topLine;
        }
        $lines[] = $this->renderHeader($columns_lengths, $columnsHeaders);
        if ($this->tableSettings[$this->renderMode]['separateHeader']) {
            $lines[] = $this->renderLine($columns_lengths, 'default', 'CharHeader');
        }
        foreach ($table as $row_cells) {
            $lines[] = $this->renderCell($row_cells, $columnsHeaders, $columns_lengths);
            if ($this->tableSettings[$this->renderMode]['separateData']) {
                $lines[] = $this->renderLine($columns_lengths);
            }
        }

        $bottomLine = $this->renderLine($columns_lengths, 'bottom');
        if ($bottomLine) {

The expression $bottomLine of type false|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

            $lines[] = $bottomLine;
        }
        return $lines;
    }

    /**
     * Render a separation line
     *
     * @param        $columnsLengths
     * @param string $specialLine
     * @param string $charMode
     *
     * @return string
     */
    protected function renderLine($columnsLengths, $specialLine = 'default', $charMode = 'Char')
    {
        if (isset($this->tableSettings[$this->renderMode]['outer' . ucfirst($specialLine)]) && $this->tableSettings[$this->renderMode]['outer' . ucfirst($specialLine)] === false) {
            return false;
        }
        $row = '';
        foreach ($columnsLengths as $key => $column_length) {
            if ($key !== 0 || $this->tableSettings[$this->renderMode]['outerLeft']) {
                $row .= $this->tableSettings[$this->renderMode]['join'];
            }
            $row .= str_repeat($this->tableSettings[$this->renderMode]['x' . $charMode], ($this->tableSettings[$this->renderMode]['xSpace'] * 2) + $column_length);
        }
        if ($this->tableSettings[$this->renderMode]['outerRight']) {
            $row .= $this->tableSettings[$this->renderMode]['join'];
        }
        return $row;
    }

    /**
     * @param $columnsLengths
     * @param $columnsHeaders
     *
     * @return string
     */
    protected function renderHeader($columnsLengths, $columnsHeaders)
    {
        $row = '';
        foreach ($columnsHeaders as $key => $header) {
            if ($key !== 0 || $this->tableSettings[$this->renderMode]['outerLeft']) {
                $row .= $this->tableSettings[$this->renderMode]['yChar'];
            }
            $row .= str_pad($header, ($this->tableSettings[$this->renderMode]['xSpace'] * 2) + $columnsLengths[$header], ' ', STR_PAD_BOTH);
        }
        if ($this->tableSettings[$this->renderMode]['outerRight']) {
            $row .= $this->tableSettings[$this->renderMode]['yChar'];
        }
        return $row;
    }

    /**
     * @param $row_cells
     * @param $columns_headers
     * @param $columns_lengths
     *
     * @return string
     */
    public function renderCell($row_cells, $columns_headers, $columns_lengths)
    {
        $row = '';
        foreach ($columns_headers as $key => $header) {
            $line = array();
            $stringLength = mb_strlen(utf8_decode($row_cells[$header]));
            if ($key !== 0 || $this->tableSettings[$this->renderMode]['outerLeft']) {
                $line[] = $this->tableSettings[$this->renderMode]['yChar'];
            }
            $line[] = str_repeat(' ', $this->tableSettings[$this->renderMode]['xSpace']);
            $line[] = $row_cells[$header];
            $line[] = str_repeat(' ', $columns_lengths[$header] - $stringLength + $this->tableSettings[$this->renderMode]['xSpace']);

            $row .= implode('', $line);
        }
        if ($this->tableSettings[$this->renderMode]['outerRight']) {
            $row .= $this->tableSettings[$this->renderMode]['yChar'];
        }
        return $row;
    }

    /**
     * @param $table
     *
     * @return array
     */
    public function columnsHeaders($table)
    {
        return array_keys(reset($table));
    }

    /**
     * @param $table
     * @param $columns_headers
     *
     * @return array
     */
    public function columnsLengths($table, $columns_headers)
    {
        $lengths = array();
        foreach ($columns_headers as $header) {
            $header_length = mb_strlen($header);
            $max = $header_length;
            foreach ($table as $row) {
                $length = mb_strlen($row[$header]);
                if ($length > $max) {
                    $max = $length;
                }
            }

            if (($max % 2) != ($header_length % 2)) {
                $max += 1;
            }

            $lengths[$header] = $max;
        }

        return $this->increaseLengthToo100Percent($lengths);
    }

    /**
     * @param $lengths
     *
     * @return mixed
     */
    protected function increaseLengthToo100Percent($lengths)
    {
        if (!Configuration::isPlainTable100()) {
            return $lengths;
        }
        $fullWidth = Configuration::getPlainTextWith();

        // Calc
        $rowCount = sizeof($lengths) + 1;
        $yCount = $rowCount - 2;
        $currentWidth = array_sum($lengths);
        if ($this->tableSettings[$this->renderMode]['outerLeft']) {
            $yCount++;
        }
        if ($this->tableSettings[$this->renderMode]['outerRight']) {
            $yCount++;
        }
        $currentWidth += strlen($this->tableSettings[$this->renderMode]['yChar']) * $yCount;
        $currentWidth += $this->tableSettings[$this->renderMode]['xSpace'] * $rowCount;

        if ($fullWidth < $currentWidth) {
            return $lengths;
        }

        $moreChars = $fullWidth - $currentWidth;
        while ($moreChars > 0) {
            foreach ($lengths as $key => $value) {
                if ($moreChars <= 0) {
                    break;
                }
                $lengths[$key]++;
                $moreChars--;
            }
        }

        return $lengths;
    }
}