1. Home
  2. Documentation
  3. Components
  4. Console
  5. Helpers
  6. Table Helper
WARNING: You are browsing the documentation for Symfony 2.3 which is not maintained anymore. Consider upgrading your projects to Symfony 5.0.

Table Helper

2.3 version
Unmaintained
2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2

Table Helper

New in version 2.3: The table helper was introduced in Symfony 2.3.

When building a console application it may be useful to display tabular data:

../../../_images/table.png

To display a table, use the TableHelper, set headers, rows and render:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
$table = $this->getHelper('table');
$table
    ->setHeaders(array('ISBN', 'Title', 'Author'))
    ->setRows(array(
        array('99921-58-10-7', 'Divine Comedy', 'Dante Alighieri'),
        array('9971-5-0210-0', 'A Tale of Two Cities', 'Charles Dickens'),
        array('960-425-059-0', 'The Lord of the Rings', 'J. R. R. Tolkien'),
        array('80-902734-1-6', 'And Then There Were None', 'Agatha Christie'),
    ))
;
$table->render($output);

The table layout can be customized as well. There are two ways to customize table rendering: using named layouts or by customizing rendering options.

Customize Table Layout using Named Layouts

The Table helper ships with two preconfigured table layouts:

  • TableHelper::LAYOUT_DEFAULT
  • TableHelper::LAYOUT_BORDERLESS

Layout can be set using setLayout() method.

Customize Table Layout using Rendering Options

You can also control table rendering by setting custom rendering option values:

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.