Skip to content

Documented the setHeaderTitle() and setFooterTitle() methods #10392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Documented the setHeaderTitle() and setFooterTitle() methods #10392

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6baf9f
Documented the setHeaderTitle() and setFooterTitle() methods
javiereguiluz Sep 24, 2018
775f786
Keep the "continuity" of the examples
javiereguiluz Sep 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions components/console/helpers/table.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,29 @@ You can add a table separator anywhere in the output by passing an instance of
| 80-902734-1-6 | And Then There Were None | Agatha Christie |
+---------------+--------------------------+------------------+

You can optionally display titles at the top and the bottom of the table::

// ...
$table->setHeaderTitle('Books')
$table->setFooterTitle('Page 1/2')
$table->render();

.. code-block:: terminal

+---------------+----------- Books --------+------------------+
| 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 |
| 80-902734-1-6 | And Then There Were None | Agatha Christie |
+---------------+--------- Page 1/2 -------+------------------+

.. versionadded:: 4.2
The ``setHeaderTitle()`` and ``setFooterTitle()`` methods were introduced
in Symfony 4.2.

By default the width of the columns is calculated automatically based on their
contents. Use the :method:`Symfony\\Component\\Console\\Helper\\Table::setColumnWidths`
method to set the column widths explicitly::
Expand Down