Support multi line cell values in \yii\console\widgets\Table

yiisoft · Jul 21, 2023 · 5b25698 · 5b25698
1 parent 6036621
commit 5b25698
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 1 deletion.
diff --git a/framework/console/widgets/Table.php b/framework/console/widgets/Table.php
@@ -252,11 +252,21 @@ protected function renderRow(array $row, $spanLeft, $spanMiddle, $spanRight)
                 if ($index !== 0) {
                     $buffer .= $spanMiddle . ' ';
                 }
+
+                $arrayFromMultilineString = false;
+                if (is_string($cell)) {
+                    $cellLines = explode(PHP_EOL, $cell);
+                    if (count($cellLines) > 1) {
+                        $cell = $cellLines;
+                        $arrayFromMultilineString = true;
+                    }
+                }
+
                 if (is_array($cell)) {
                     if (empty($renderedChunkTexts[$index])) {
                         $renderedChunkTexts[$index] = '';
                         $start = 0;
-                        $prefix = $this->listPrefix;
+                        $prefix = $arrayFromMultilineString ? '' : $this->listPrefix;
                         if (!isset($arrayPointer[$index])) {
                             $arrayPointer[$index] = 0;
                         }
@@ -339,6 +349,9 @@ protected function calculateRowsSize()
                 if (is_array($val)) {
                     return max(array_map('yii\helpers\Console::ansiStrwidth', $val)) + Console::ansiStrwidth($this->listPrefix);
                 }
+                if (is_string($val)) {
+                    return max(array_map('yii\helpers\Console::ansiStrwidth', explode(PHP_EOL, $val)));
+                }
                 return Console::ansiStrwidth($val);
             }, $column)) + 2;
             $this->columnWidths[] = $columnWidth;
@@ -388,6 +401,9 @@ protected function calculateRowHeight($row)
             if (is_array($val)) {
                 return array_map('yii\helpers\Console::ansiStrwidth', $val);
             }
+            if (is_string($val)) {
+                return array_map('yii\helpers\Console::ansiStrwidth', explode(PHP_EOL, $val));
+            }
             return Console::ansiStrwidth($val);
         }, $row));
         return max($rowsPerCell);

diff --git a/tests/framework/console/widgets/TableTest.php b/tests/framework/console/widgets/TableTest.php
@@ -58,6 +58,55 @@ public function testTable($headers, $rows)
 ║ testcontent21 │ testcontent22 │ testcontent23 ║
 ╚═══════════════╧═══════════════╧═══════════════╝
 
+EXPECTED;
+
+        $tableContent = $table
+            ->setHeaders($headers)
+            ->setRows($rows)
+            ->setScreenWidth(200)
+            ->run();
+        $this->assertEqualsWithoutLE($expected, $tableContent);
+    }
+
+    public function getMultiLineTableData()
+    {
+        return [
+            [
+                ['test1', 'test2', 'test3' . PHP_EOL . 'multiline'],
+                [
+                    ['test' . PHP_EOL . 'content1', 'testcontent2', 'test' . PHP_EOL . 'content3'],
+                    ['testcontent21', 'test' . PHP_EOL . 'content22', 'testcontent23'],
+                ]
+            ],
+            [
+                ['key1' => 'test1', 'key2' => 'test2', 'key3' => 'test3' . PHP_EOL . 'multiline'],
+                [
+                    ['key1' => 'test' . PHP_EOL . 'content1', 'key2' => 'testcontent2', 'key3' => 'test' . PHP_EOL . 'content3'],
+                    ['key1' => 'testcontent21', 'key2' => 'test' . PHP_EOL . 'content22', 'key3' => 'testcontent23'],
+                ]
+            ]
+        ];
+    }
+
+    /**
+     * @dataProvider getMultiLineTableData
+     */
+    public function testMultiLineTable($headers, $rows)
+    {
+        $table = new Table();
+
+        $expected = <<<'EXPECTED'
+╔═══════════════╤══════════════╤═══════════════╗
+║ test1         │ test2        │ test3         ║
+║               │              │ multiline     ║
+╟───────────────┼──────────────┼───────────────╢
+║ test          │ testcontent2 │ test          ║
+║ content1      │              │ content3      ║
+╟───────────────┼──────────────┼───────────────╢
+║ testcontent21 │ test         │ testcontent23 ║
+║               │ content22    │               ║
+╚═══════════════╧══════════════╧═══════════════╝
+
 EXPECTED;
 
         $tableContent = $table