[Console] added the possibility to insert a table separator anywhere in a table output

fabpot · fabpot · commit 14caaec5f6d3 · 2014-03-03T14:12:09.000+01:00
diff --git a/src/Symfony/Component/Console/Helper/Table.php b/src/Symfony/Component/Console/Helper/Table.php
@@ -158,8 +158,18 @@ public function addRows(array $rows)
         return $this;
     }
 
-    public function addRow(array $row)
+    public function addRow($row)
     {
+        if ($row instanceof TableSeparator) {
+            $this->rows[] = $row;
+
+            return;
+        }
+
+        if (!is_array($row)) {
+            throw new InvalidArgumentException('A row must be an array or a TableSeparator instance.');
+        }
+
         $this->rows[] = array_values($row);
 
         $keys = array_keys($this->rows);
@@ -217,7 +227,11 @@ public function render()
             $this->renderRowSeparator();
         }
         foreach ($this->rows as $row) {
-            $this->renderRow($row, $this->style->getCellRowFormat());
+            if ($row instanceof TableSeparator) {
+                $this->renderRowSeparator();
+            } else {
+                $this->renderRow($row, $this->style->getCellRowFormat());
+            }
         }
         if (!empty($this->rows)) {
             $this->renderRowSeparator();
@@ -337,6 +351,10 @@ private function getColumnWidth($column)
 
         $lengths = array($this->getCellWidth($this->headers, $column));
         foreach ($this->rows as $row) {
+            if ($row instanceof TableSeparator) {
+                continue;
+            }
+
             $lengths[] = $this->getCellWidth($row, $column);
         }
 
diff --git a/src/Symfony/Component/Console/Helper/TableSeparator.php b/src/Symfony/Component/Console/Helper/TableSeparator.php
@@ -0,0 +1,21 @@
+<?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;
+
+/**
+ * Marks a row as being a separator.
+ *
+ * @author Fabien Potencier <fabien@symfony.com>
+ */
+class TableSeparator
+{
+}
diff --git a/src/Symfony/Component/Console/Tests/Helper/TableTest.php b/src/Symfony/Component/Console/Tests/Helper/TableTest.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Helper\TableStyle;
+use Symfony\Component\Console\Helper\TableSeparator;
 use Symfony\Component\Console\Output\StreamOutput;
 
 class TableTest extends \PHPUnit_Framework_TestCase
@@ -306,6 +307,37 @@ public function testStyle()
 . Bar .
 .......
 
+TABLE;
+
+        $this->assertEquals($expected, $this->getOutputContent($output));
+    }
+
+    public function testRowSeparator()
+    {
+        $table = new Table($output = $this->getOutputStream());
+        $table
+            ->setHeaders(array('Foo'))
+            ->setRows(array(
+                array('Bar1'),
+                new TableSeparator(),
+                array('Bar2'),
+                new TableSeparator(),
+                array('Bar3'),
+            ));
+        $table->render();
+
+        $expected =
+<<<TABLE
++------+
+| Foo  |
++------+
+| Bar1 |
++------+
+| Bar2 |
++------+
+| Bar3 |
++------+
+
 TABLE;
 
         $this->assertEquals($expected, $this->getOutputContent($output));
