Symfony\Component\Console\Helper\TableHelper
Provides helpers to display table output.
- Author: Саша Стаменковић <umpirsky@gmail.com>
Synopsis
class TableHelper
extends Helper
{
- // constants
- const LAYOUT_DEFAULT = 0;
- const LAYOUT_BORDERLESS = 1;
- // members
- private array $headers;
- private array $rows;
- private $paddingChar;
- private $horizontalBorderChar;
- private $verticalBorderChar;
- private $crossingChar;
- private $cellHeaderFormat;
- private $cellRowFormat;
- private $borderFormat;
- private $padType;
- private array $columnWidths;
- private array $numberOfColumns;
- private OutputInterface $output;
- // Inherited members from Helper
- protected $helperSet;
- // methods
- public void __construct()
- public TableHelper setLayout()
- public void setHeaders()
- public void setRows()
- public void addRows()
- public void addRow()
- public void setRow()
- public TableHelper setPaddingChar()
- public TableHelper setHorizontalBorderChar()
- public TableHelper setVerticalBorderChar()
- public TableHelper setCrossingChar()
- public TableHelper setCellHeaderFormat()
- public TableHelper setCellRowFormat()
- public TableHelper setBorderFormat()
- public TableHelper setPadType()
- public void render()
- private void renderRowSeparator()
- private void renderColumnSeparator()
- private void renderRow()
- private void renderCell()
- private int getNumberOfColumns()
- private int getColumnWidth()
- private int getCellWidth()
- private void cleanup()
- public void getName()
- // Inherited methods from Helper
- public void setHelperSet()
- public HelperSet getHelperSet()
- protected integer strlen()
Hierarchy
Constants
Name | Value |
---|---|
LAYOUT_DEFAULT | 0 |
LAYOUT_BORDERLESS | 1 |
Members
private
- $borderFormat
- $cellHeaderFormat
- $cellRowFormat
- $columnWidths
—
array
Column widths cache. - $crossingChar
- $headers
—
array
Table headers. - $horizontalBorderChar
- $numberOfColumns
—
array
Number of columns cache. - $output — Symfony\Component\Console\Output\OutputInterface
- $padType
- $paddingChar
- $rows
—
array
Table rows. - $verticalBorderChar
protected
- $helperSet
Methods
private
- cleanup() — Called after rendering to cleanup cache data.
- getCellWidth() — Gets cell width.
- getColumnWidth() — Gets column width.
- getNumberOfColumns() — Gets number of columns for this table.
- renderCell() — Renders table cell with padding.
- renderColumnSeparator() — Renders vertical column separator.
- renderRow() — Renders table row.
- renderRowSeparator() — Renders horizontal header separator.
public
- __construct()
- addRow()
- addRows()
- getName() — {@inheritDoc}
- render() — Renders table to output.
- setBorderFormat() — Sets table border format.
- setCellHeaderFormat() — Sets header cell format.
- setCellRowFormat() — Sets row cell format.
- setCrossingChar() — Sets crossing character.
- setHeaders()
- setHorizontalBorderChar() — Sets horizontal border character.
- setLayout() — Sets table layout type.
- setPadType() — Sets cell padding type.
- setPaddingChar() — Sets padding character, used for cell padding.
- setRow()
- setRows()
- setVerticalBorderChar() — Sets vertical border character.
Inherited from Symfony\Component\Console\Helper\Helper
protected
- strlen() — Returns the length of a string, using mb_strlen if it is available.
public
- getHelperSet() — Gets the helper set associated with this helper.
- setHelperSet() — Sets the helper set associated with this helper.