Skip to content

[WCM][Console] add documentation for the new method added for table dividers #3269

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 1 commit into from
Closed

[WCM][Console] add documentation for the new method added for table dividers #3269

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion components/console/helpers/tablehelper.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ When building a console application it may be useful to display tabular data:
.. image:: /images/components/console/table.png

To display table, use the :class:`Symfony\\Component\\Console\\Helper\\TableHelper`,
set headers, rows and render::
set headers, rows, optional dividers, and render::

$table = $app->getHelperSet()->get('table');
$table
Expand All @@ -23,6 +23,7 @@ set headers, rows and render::
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'),
))
->setDividersAt(array(2))
Copy link
Member

@wouterj wouterj Dec 3, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if I like this, because they don't really no what this exactly does

;
$table->render($output);

Expand Down Expand Up @@ -52,8 +53,10 @@ You can also control table rendering by setting custom rendering option values:

* :method:`Symfony\\Component\\Console\\Helper\\TableHelper::setPaddingChar`
* :method:`Symfony\\Component\\Console\\Helper\\TableHelper::setHorizontalBorderChar`
* :method:`Symfony\\Component\\Console\\Helper\\TableHelper::setHorizontalDividerChar`
* :method:`Symfony\\Component\\Console\\Helper\\TableHelper::setVerticalBorderChar`
* :method:`Symfony\\Component\\Console\\Helper\\TableHelper::setCrossingChar`
* :method:`Symfony\\Component\\Console\\Helper\\TableHelper::setCrossingDividerChar`
* :method:`Symfony\\Component\\Console\\Helper\\TableHelper::setCellHeaderFormat`
* :method:`Symfony\\Component\\Console\\Helper\\TableHelper::setCellRowFormat`
* :method:`Symfony\\Component\\Console\\Helper\\TableHelper::setBorderFormat`
Expand Down