Symfony News

New in Symfony 3.1: Explicit Column Widths in Console Tables

Contributed by
Arjan Keeman in #17761.

The Console component makes displaying tables in your commands a breeze:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

use Symfony\Component\Console\Helper\Table;

$table = new Table($output);
$table
    ->setHeaders(array('ISBN', 'Title', 'Author', 'Price'))
    ->setRows(array(
        array('99921-58-10-7', 'Divine Comedy', 'Dante Alighieri', '9.95'),
        array('9971-5-0210-0', 'A Tale of Two Cities', 'Charles Dickens', '139.25'),
    ))
;
$table->render();

By default, the widths of the columns are calculated automatically based on their contents. This is the commonly expected behavior, but some applications may need a more explicit control over the table design.

In Symfony 3.1, the Table helper lets you define the width of any or all the table columns. First, the new setColumnWidth($columnIndex, $columnWidth) method defines the width of the given column (column indexes start at 0):

1
2
3
4
5
6
7
8

// ...
$table
    ->setHeaders(...)
    ->setRows(array(...))
    ->setColumnWidth(0, 15)
    ->setColumnWidth(3, 10)
;
$table->render();

This example sets the width of the first column (index 0) to 15 chars and the width of the fourth column (index 3) to 10 chars. The output of the command would be the following:

1
2
3
4
5
6

+-----------------+----------------------+-----------------+------------+
| ISBN            | Title                | Author          | Price      |
+-----------------+----------------------+-----------------+------------+
| 99921-58-10-7   | Divine Comedy        | Dante Alighieri | 9.95       |
| 9971-5-0210-0   | A Tale of Two Cities | Charles Dickens | 139.25     |
+-----------------+----------------------+-----------------+------------+

The given column widths are always considered the minimum column widths. If the contents don't fit, the column widths are increased up to the longest content length.

You can also set all column widths at once with the setColumnWidths(array $widths) method. Use 0 as the width of the columns you don't want to set explicitly:

1
2
3
4
5
6
7

// ...
$table
    ->setHeaders(...)
    ->setRows(array(...))
    ->setColumnWidths(array(15, 0, 0, 10))
;
$table->render();

In this example, the first column width is set at 15 chars, the last column to 10 and the second and third columns define their width automatically because of the 0 value, so the output will be the same as the previous example.