class Table

Provides helpers to display a table.

Methods

__construct(OutputInterface $output)

No description

static 
setStyleDefinition(string $name, TableStyle $style)

Sets a style definition.

static TableStyle
getStyleDefinition(string $name)

Gets a style definition by name.

$this
setStyle(TableStyle|string $name)

Sets table style.

getStyle()

Gets the current table style.

$this
setColumnStyle(int $columnIndex, TableStyle|string $name)

Sets table column style.

getColumnStyle(int $columnIndex)

Gets the current style for a column.

$this
setColumnWidth(int $columnIndex, int $width)

Sets the minimum width of a column.

$this
setColumnWidths(array $widths)

Sets the minimum width of all columns.

setHeaders(array $headers)

No description

setRows(array $rows)

No description

addRows(array $rows)

No description

addRow($row)

No description

setRow($column, array $row)

No description

render()

Renders table to output.

Details

at line line 73
__construct(OutputInterface $output)

Parameters

OutputInterface $output

at line line 90
static setStyleDefinition(string $name, TableStyle $style)

Sets a style definition.

Parameters

string $name The style name
TableStyle $style A TableStyle instance

at line line 106
static TableStyle getStyleDefinition(string $name)

Gets a style definition by name.

Parameters

string $name The style name

Return Value

TableStyle

at line line 126
$this setStyle(TableStyle|string $name)

Sets table style.

Parameters

TableStyle|string $name The style name or a TableStyle instance

Return Value

$this

at line line 138
TableStyle getStyle()

Gets the current table style.

Return Value

TableStyle

at line line 151
$this setColumnStyle(int $columnIndex, TableStyle|string $name)

Sets table column style.

Parameters

int $columnIndex Column index
TableStyle|string $name The style name or a TableStyle instance

Return Value

$this

at line line 169
TableStyle getColumnStyle(int $columnIndex)

Gets the current style for a column.

If style was not set, it returns the global table style.

Parameters

int $columnIndex Column index

Return Value

TableStyle

at line line 186
$this setColumnWidth(int $columnIndex, int $width)

Sets the minimum width of a column.

Parameters

int $columnIndex Column index
int $width Minimum column width in characters

Return Value

$this

at line line 200
$this setColumnWidths(array $widths)

Sets the minimum width of all columns.

Parameters

array $widths

Return Value

$this

at line line 210
setHeaders(array $headers)

Parameters

array $headers

at line line 222
setRows(array $rows)

Parameters

array $rows

at line line 229
addRows(array $rows)

Parameters

array $rows

at line line 238
addRow($row)

Parameters

$row

at line line 255
setRow($column, array $row)

Parameters

$column
array $row

at line line 276
render()

Renders table to output.

Example: +---------------+-----------------------+------------------+ | 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 | +---------------+-----------------------+------------------+