Permalink
Browse files

[Console] deprecated TableHelper in favor of Table

  • Loading branch information...
fabpot committed Mar 3, 2014
1 parent 091a779 commit e26f6047403a494afb64d378921fae0e38732d41
Showing with 998 additions and 276 deletions.
  1. +1 −0 CHANGELOG.md
  2. +391 −0 Helper/Table.php
  3. +30 −276 Helper/TableHelper.php
  4. +251 −0 Helper/TableStyle.php
  5. +325 −0 Tests/Helper/TableTest.php
View
@@ -4,6 +4,7 @@ CHANGELOG
2.5.0
-----
+ * deprecated TableHelper in favor of Table
* deprecated ProgressHelper in favor of ProgressBar
* added a way to set a default command instead of `ListCommand`
* added a way to set the process name of a command
View
@@ -0,0 +1,391 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Console\Helper;
+
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Provides helpers to display a table.
+ *
+ * @author Fabien Potencier <fabien@symfony.com>
+ * @author Саша Стаменковић <umpirsky@gmail.com>
+ */
+class Table
+{
+ /**
+ * Table headers.
+ *
+ * @var array
+ */
+ private $headers = array();
+
+ /**
+ * Table rows.
+ *
+ * @var array
+ */
+ private $rows = array();
+
+ /**
+ * Column widths cache.
+ *
+ * @var array
+ */
+ private $columnWidths = array();
+
+ /**
+ * Number of columns cache.
+ *
+ * @var array
+ */
+ private $numberOfColumns;
+
+ /**
+ * @var OutputInterface
+ */
+ private $output;
+
+ /**
+ * @var TableStyle
+ */
+ private $style;
+
+ private static $styles;
+
+ public function __construct(OutputInterface $output)
+ {
+ $this->output = $output;
+
+ if (!self::$styles) {
+ self::$styles = self::initStyles();
+ }
+
+ $this->setStyle('default');
+ }
+
+ /**
+ * Sets a style definition.
+ *
+ * @param string $name The style name
+ * @param TableStyle $style A TableStyle instance
+ */
+ public static function setStyleDefinition($name, TableStyle $style)
+ {
+ if (!self::$styles) {
+ self::$styles = self::initStyles();
+ }
+
+ self::$styles[$name] = $style;
+ }
+
+ /**
+ * Gets a style definition by name.
+ *
+ * @param string $name The style name
+ *
+ * @return TableStyle A TableStyle instance
+ */
+ public static function getStyleDefinition($name)
+ {
+ if (!self::$styles) {
+ self::$styles = self::initStyles();
+ }
+
+ if (!self::$styles[$name]) {
+ throw new \InvalidArgumentException(sprintf('Style "%s" is not defined.', $name));
+ }
+
+ return self::$styles[$name];
+ }
+
+ /**
+ * Sets table style.
+ *
+ * @param string $name The style name
+ *
+ * @return Table
+ */
+ public function setStyle($name)
+ {
+ if (isset(self::$styles[$name])) {
+ $this->style = self::$styles[$name];
+
+ return $this;
+ }
+
+ throw new \InvalidArgumentException(sprintf('Style "%s" is not defined.', $name));
+ }
+
+ /**
+ * Gets the current table style.
+ *
+ * @return TableStyle
+ */
+ public function getStyle()
+ {
+ return $this->style;
+ }
+
+ public function setHeaders(array $headers)
+ {
+ $this->headers = array_values($headers);
+
+ return $this;
+ }
+
+ public function setRows(array $rows)
+ {
+ $this->rows = array();
+
+ return $this->addRows($rows);
+ }
+
+ public function addRows(array $rows)
+ {
+ foreach ($rows as $row) {
+ $this->addRow($row);
+ }
+
+ return $this;
+ }
+
+ public function addRow(array $row)
+ {
+ $this->rows[] = array_values($row);
+
+ $keys = array_keys($this->rows);
+ $rowKey = array_pop($keys);
+
+ foreach ($row as $key => $cellValue) {
+ if (!strstr($cellValue, "\n")) {
+ continue;
+ }
+
+ $lines = explode("\n", $cellValue);
+ $this->rows[$rowKey][$key] = $lines[0];
+ unset($lines[0]);
+
+ foreach ($lines as $lineKey => $line) {
+ $nextRowKey = $rowKey + $lineKey + 1;
+
+ if (isset($this->rows[$nextRowKey])) {
+ $this->rows[$nextRowKey][$key] = $line;
+ } else {
+ $this->rows[$nextRowKey] = array($key => $line);
+ }
+ }
+ }
+
+ return $this;
+ }
+
+ public function setRow($column, array $row)
+ {
+ $this->rows[$column] = $row;
+
+ return $this;
+ }
+
+ /**
+ * Renders table to output.
+ *
+ * Example:
+ * +---------------+-----------------------+------------------+
+ * | ISBN | Title | Author |
+ * +---------------+-----------------------+------------------+
+ * | 99921-58-10-7 | Divine Comedy | Dante Alighieri |
+ * | 9971-5-0210-0 | A Tale of Two Cities | Charles Dickens |
+ * | 960-425-059-0 | The Lord of the Rings | J. R. R. Tolkien |
+ * +---------------+-----------------------+------------------+
+ *
+ * @param OutputInterface $output
+ */
+ public function render()
+ {
+ $this->renderRowSeparator();
+ $this->renderRow($this->headers, $this->style->getCellHeaderFormat());
+ if (!empty($this->headers)) {
+ $this->renderRowSeparator();
+ }
+ foreach ($this->rows as $row) {
+ $this->renderRow($row, $this->style->getCellRowFormat());
+ }
+ if (!empty($this->rows)) {
+ $this->renderRowSeparator();
+ }
+
+ $this->cleanup();
+ }
+
+ /**
+ * Renders horizontal header separator.
+ *
+ * Example: +-----+-----------+-------+
+ */
+ private function renderRowSeparator()
+ {
+ if (0 === $count = $this->getNumberOfColumns()) {
+ return;
+ }
+
+ if (!$this->style->getHorizontalBorderChar() && !$this->style->getCrossingChar()) {
+ return;
+ }
+
+ $markup = $this->style->getCrossingChar();
+ for ($column = 0; $column < $count; $column++) {
+ $markup .= str_repeat($this->style->getHorizontalBorderChar(), $this->getColumnWidth($column)).$this->style->getCrossingChar();
+ }
+
+ $this->output->writeln(sprintf($this->style->getBorderFormat(), $markup));
+ }
+
+ /**
+ * Renders vertical column separator.
+ */
+ private function renderColumnSeparator()
+ {
+ $this->output->write(sprintf($this->style->getBorderFormat(), $this->style->getVerticalBorderChar()));
+ }
+
+ /**
+ * Renders table row.
+ *
+ * Example: | 9971-5-0210-0 | A Tale of Two Cities | Charles Dickens |
+ *
+ * @param array $row
+ * @param string $cellFormat
+ */
+ private function renderRow(array $row, $cellFormat)
+ {
+ if (empty($row)) {
+ return;
+ }
+
+ $this->renderColumnSeparator();
+ for ($column = 0, $count = $this->getNumberOfColumns(); $column < $count; $column++) {
+ $this->renderCell($row, $column, $cellFormat);
+ $this->renderColumnSeparator();
+ }
+ $this->output->writeln('');
+ }
+
+ /**
+ * Renders table cell with padding.
+ *
+ * @param array $row
+ * @param integer $column
+ * @param string $cellFormat
+ */
+ private function renderCell(array $row, $column, $cellFormat)
+ {
+ $cell = isset($row[$column]) ? $row[$column] : '';
+ $width = $this->getColumnWidth($column);
+
+ // str_pad won't work properly with multi-byte strings, we need to fix the padding
+ if (function_exists('mb_strlen') && false !== $encoding = mb_detect_encoding($cell)) {
+ $width += strlen($cell) - mb_strlen($cell, $encoding);
+ }
+
+ $width += Helper::strlen($cell) - Helper::strlenWithoutDecoration($this->output->getFormatter(), $cell);
+
+ $content = sprintf($this->style->getCellRowContentFormat(), $cell);
+
+ $this->output->write(sprintf($cellFormat, str_pad($content, $width, $this->style->getPaddingChar(), $this->style->getPadType())));
+ }
+
+ /**
+ * Gets number of columns for this table.
+ *
+ * @return integer
+ */
+ private function getNumberOfColumns()
+ {
+ if (null !== $this->numberOfColumns) {
+ return $this->numberOfColumns;
+ }
+
+ $columns = array(count($this->headers));
+ foreach ($this->rows as $row) {
+ $columns[] = count($row);
+ }
+
+ return $this->numberOfColumns = max($columns);
+ }
+
+ /**
+ * Gets column width.
+ *
+ * @param integer $column
+ *
+ * @return integer
+ */
+ private function getColumnWidth($column)
+ {
+ if (isset($this->columnWidths[$column])) {
+ return $this->columnWidths[$column];
+ }
+
+ $lengths = array($this->getCellWidth($this->headers, $column));
+ foreach ($this->rows as $row) {
+ $lengths[] = $this->getCellWidth($row, $column);
+ }
+
+ return $this->columnWidths[$column] = max($lengths) + strlen($this->style->getCellRowContentFormat()) - 2;
+ }
+
+ /**
+ * Gets cell width.
+ *
+ * @param array $row
+ * @param integer $column
+ *
+ * @return integer
+ */
+ private function getCellWidth(array $row, $column)
+ {
+ return isset($row[$column]) ? Helper::strlenWithoutDecoration($this->output->getFormatter(), $row[$column]) : 0;
+ }
+
+ /**
+ * Called after rendering to cleanup cache data.
+ */
+ private function cleanup()
+ {
+ $this->columnWidths = array();
+ $this->numberOfColumns = null;
+ }
+
+ private static function initStyles()
+ {
+ $borderless = new TableStyle();
+ $borderless
+ ->setHorizontalBorderChar('=')
+ ->setVerticalBorderChar(' ')
+ ->setCrossingChar(' ')
+ ;
+
+ $compact = new TableStyle();
+ $compact
+ ->setHorizontalBorderChar('')
+ ->setVerticalBorderChar(' ')
+ ->setCrossingChar('')
+ ->setCellRowContentFormat('%s')
+ ;
+
+ return array(
+ 'default' => new TableStyle(),
+ 'borderless' => $borderless,
+ 'compact' => $compact,
+ );
+ }
+}
Oops, something went wrong.

0 comments on commit e26f604

Please sign in to comment.