class TableHelper extends Helper

deprecated since version 2.5, to be removed in 3.0 Use {@link Table} instead.

Provides helpers to display table output.

Constants

LAYOUT_DEFAULT

LAYOUT_BORDERLESS

LAYOUT_COMPACT

Properties

protected $helperSet from Helper

Methods

setHelperSet(HelperSet $helperSet = null)

Sets the helper set associated with this helper.

from Helper
getHelperSet()

Gets the helper set associated with this helper.

from Helper
static int
strlen(string $string)

Returns the length of a string, using mb_strwidth if it is available.

from Helper
static 
formatTime($secs)

No description

from Helper
static 
formatMemory($memory)

No description

from Helper
static 
strlenWithoutDecoration(OutputFormatterInterface $formatter, $string)

No description

from Helper
static 
removeDecoration(OutputFormatterInterface $formatter, $string)

No description

from Helper
__construct($triggerDeprecationError = true)

No description

$this
setLayout(int $layout)

Sets table layout type.

setHeaders(array $headers)

No description

setRows(array $rows)

No description

addRows(array $rows)

No description

addRow(array $row)

No description

setRow($column, array $row)

No description

$this
setPaddingChar(string $paddingChar)

Sets padding character, used for cell padding.

$this
setHorizontalBorderChar(string $horizontalBorderChar)

Sets horizontal border character.

$this
setVerticalBorderChar(string $verticalBorderChar)

Sets vertical border character.

$this
setCrossingChar(string $crossingChar)

Sets crossing character.

$this
setCellHeaderFormat(string $cellHeaderFormat)

Sets header cell format.

$this
setCellRowFormat(string $cellRowFormat)

Sets row cell format.

$this
setCellRowContentFormat(string $cellRowContentFormat)

Sets row cell content format.

$this
setBorderFormat(string $borderFormat)

Sets table border format.

$this
setPadType(int $padType)

Sets cell padding type.

render(OutputInterface $output)

Renders table to output.

string
getName()

Returns the canonical name of this helper.

Details

in Helper at line 28
setHelperSet(HelperSet $helperSet = null)

Sets the helper set associated with this helper.

Parameters

HelperSet $helperSet

in Helper at line 36
HelperSet getHelperSet()

Gets the helper set associated with this helper.

Return Value

HelperSet A HelperSet instance

in Helper at line 48
static int strlen(string $string)

Returns the length of a string, using mb_strwidth if it is available.

Parameters

string $string The string to check its length

Return Value

int The length of the string

in Helper at line 57
static formatTime($secs)

Parameters

$secs

in Helper at line 86
static formatMemory($memory)

Parameters

$memory

in Helper at line 103
static strlenWithoutDecoration(OutputFormatterInterface $formatter, $string)

Parameters

OutputFormatterInterface $formatter
$string

in Helper at line 108
static removeDecoration(OutputFormatterInterface $formatter, $string)

Parameters

OutputFormatterInterface $formatter
$string

at line 35
__construct($triggerDeprecationError = true)

Parameters

$triggerDeprecationError

at line 53
$this setLayout(int $layout)

Sets table layout type.

Parameters

int $layout self::LAYOUT_*

Return Value

$this

Exceptions

InvalidArgumentException when the table layout is not known

at line 75
setHeaders(array $headers)

Parameters

array $headers

at line 82
setRows(array $rows)

Parameters

array $rows

at line 89
addRows(array $rows)

Parameters

array $rows

at line 96
addRow(array $row)

Parameters

array $row

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

Parameters

$column
array $row

at line 117
$this setPaddingChar(string $paddingChar)

Sets padding character, used for cell padding.

Parameters

string $paddingChar

Return Value

$this

at line 131
$this setHorizontalBorderChar(string $horizontalBorderChar)

Sets horizontal border character.

Parameters

string $horizontalBorderChar

Return Value

$this

at line 145
$this setVerticalBorderChar(string $verticalBorderChar)

Sets vertical border character.

Parameters

string $verticalBorderChar

Return Value

$this

at line 159
$this setCrossingChar(string $crossingChar)

Sets crossing character.

Parameters

string $crossingChar

Return Value

$this

at line 173
$this setCellHeaderFormat(string $cellHeaderFormat)

Sets header cell format.

Parameters

string $cellHeaderFormat

Return Value

$this

at line 187
$this setCellRowFormat(string $cellRowFormat)

Sets row cell format.

Parameters

string $cellRowFormat

Return Value

$this

at line 201
$this setCellRowContentFormat(string $cellRowContentFormat)

Sets row cell content format.

Parameters

string $cellRowContentFormat

Return Value

$this

at line 215
$this setBorderFormat(string $borderFormat)

Sets table border format.

Parameters

string $borderFormat

Return Value

$this

at line 229
$this setPadType(int $padType)

Sets cell padding type.

Parameters

int $padType STR_PAD_*

Return Value

$this

at line 248
render(OutputInterface $output)

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

Parameters

OutputInterface $output

at line 260
string getName()

Returns the canonical name of this helper.

Return Value

string The canonical name