Symfony\Component\Console\Helper\TableStyle

class TableStyle

Defines the styles for a Table.

Methods

$this

setPaddingChar(string $paddingChar)

Sets padding character, used for cell padding.

string

getPaddingChar()

Gets padding character, used for cell padding.

TableStyle

setHorizontalBorderChars(string $outside, string $inside = null)

Sets horizontal border characters.

$this

setHorizontalBorderChar(string $horizontalBorderChar) ^deprecated

Sets horizontal border character.

string

getHorizontalBorderChar() ^deprecated

Gets horizontal border character.

TableStyle

setVerticalBorderChars(string $outside, string $inside = null)

Sets vertical border characters.

$this

setVerticalBorderChar(string $verticalBorderChar) ^deprecated

Sets vertical border character.

string

getVerticalBorderChar() ^deprecated

Gets vertical border character.

getBorderChars()

Gets border characters.

TableStyle

setCrossingChars(string $cross, string $topLeft, string $topMid, string $topRight, string $midRight, string $bottomRight, string $bottomMid, string $bottomLeft, string $midLeft, string $topLeftBottom = null, string $topMidBottom = null, string $topRightBottom = null)

Sets crossing characters.

TableStyle

setDefaultCrossingChar(string $char)

Sets default crossing character used for each cross.

$this

setCrossingChar(string $crossingChar) ^deprecated

Sets crossing character.

string

getCrossingChar()

Gets crossing character.

array

getCrossingChars()

Gets crossing characters.

$this

setCellHeaderFormat(string $cellHeaderFormat)

Sets header cell format.

string

getCellHeaderFormat()

Gets header cell format.

$this

setCellRowFormat(string $cellRowFormat)

Sets row cell format.

string

getCellRowFormat()

Gets row cell format.

$this

setCellRowContentFormat(string $cellRowContentFormat)

Sets row cell content format.

string

getCellRowContentFormat()

Gets row cell content format.

$this

setBorderFormat(string $borderFormat)

Sets table border format.

string

getBorderFormat()

Gets table border format.

$this

setPadType(int $padType)

Sets cell padding type.

int

getPadType()

Gets cell padding type.

string

getHeaderTitleFormat()

No description

TableStyle

setHeaderTitleFormat(string $format)

No description

string

getFooterTitleFormat()

No description

TableStyle

setFooterTitleFormat(string $format)

No description

Details

`$this setPaddingChar(string $paddingChar)`

Sets padding character, used for cell padding.

Parameters

string

$paddingChar

Return Value

$this

`string getPaddingChar()`

Gets padding character, used for cell padding.

Return Value

string

`TableStyle setHorizontalBorderChars(string $outside, string $inside = null)`

Sets horizontal border characters.

╔═══════════════╤══════════════════════════╤══════════════════╗ 1 ISBN 2 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 ║ ╚═══════════════╧══════════════════════════╧══════════════════╝

Parameters

string	$outside	Outside border char (see #1 of example)
string	$inside	Inside border char (see #2 of example), equals $outside if null

Return Value

TableStyle

`$this setHorizontalBorderChar(string $horizontalBorderChar) ^deprecated`

^deprecated since Symfony 4.1, use {@link setHorizontalBorderChars()} instead.

Sets horizontal border character.

Parameters

string

$horizontalBorderChar

Return Value

$this

`string getHorizontalBorderChar() ^deprecated`

^deprecated since Symfony 4.1, use {@link getBorderChars()} instead.

Gets horizontal border character.

Return Value

string

`TableStyle setVerticalBorderChars(string $outside, string $inside = null)`

Sets vertical border characters.

╔═══════════════╤══════════════════════════╤══════════════════╗ ║ ISBN │ Title │ Author ║ ╠═══════1═══════╪══════════════════════════╪══════════════════╣ ║ 99921-58-10-7 │ Divine Comedy │ Dante Alighieri ║ ║ 9971-5-0210-0 │ A Tale of Two Cities │ Charles Dickens ║ ╟───────2───────┼──────────────────────────┼──────────────────╢ ║ 960-425-059-0 │ The Lord of the Rings │ J. R. R. Tolkien ║ ║ 80-902734-1-6 │ And Then There Were None │ Agatha Christie ║ ╚═══════════════╧══════════════════════════╧══════════════════╝

Parameters

string	$outside	Outside border char (see #1 of example)
string	$inside	Inside border char (see #2 of example), equals $outside if null

Return Value

TableStyle

`$this setVerticalBorderChar(string $verticalBorderChar) ^deprecated`

^deprecated since Symfony 4.1, use {@link setVerticalBorderChars()} instead.

Sets vertical border character.

Parameters

string

$verticalBorderChar

Return Value

$this

`string getVerticalBorderChar() ^deprecated`

^deprecated since Symfony 4.1, use {@link getBorderChars()} instead.

Gets vertical border character.

Return Value

string

`getBorderChars()`

Gets border characters.

`TableStyle setCrossingChars(string $cross, string $topLeft, string $topMid, string $topRight, string $midRight, string $bottomRight, string $bottomMid, string $bottomLeft, string $midLeft, string $topLeftBottom = null, string $topMidBottom = null, string $topRightBottom = null)`

Sets crossing characters.

Example: 1═══════════════2══════════════════════════2══════════════════3 ║ ISBN │ Title │ Author ║ 8'══════════════0'═════════════════════════0'═════════════════4' ║ 99921-58-10-7 │ Divine Comedy │ Dante Alighieri ║ ║ 9971-5-0210-0 │ A Tale of Two Cities │ Charles Dickens ║ 8───────────────0──────────────────────────0──────────────────4 ║ 960-425-059-0 │ The Lord of the Rings │ J. R. R. Tolkien ║ ║ 80-902734-1-6 │ And Then There Were None │ Agatha Christie ║ 7═══════════════6══════════════════════════6══════════════════5

Parameters

string	$cross	Crossing char (see #0 of example)
string	$topLeft	Top left char (see #1 of example)
string	$topMid	Top mid char (see #2 of example)
string	$topRight	Top right char (see #3 of example)
string	$midRight	Mid right char (see #4 of example)
string	$bottomRight	Bottom right char (see #5 of example)
string	$bottomMid	Bottom mid char (see #6 of example)
string	$bottomLeft	Bottom left char (see #7 of example)
string	$midLeft	Mid left char (see #8 of example)
string	$topLeftBottom	Top left bottom char (see #8' of example), equals to $midLeft if null
string	$topMidBottom	Top mid bottom char (see #0' of example), equals to $cross if null
string	$topRightBottom	Top right bottom char (see #4' of example), equals to $midRight if null

Return Value

TableStyle

`TableStyle setDefaultCrossingChar(string $char)`

Sets default crossing character used for each cross.

Parameters

int

$padType

STR_PAD_*

Return Value

$this

`int getPadType()`

Gets cell padding type.

Return Value

TableStyle

TableStyle

Methods

Details

$this setPaddingChar(string $paddingChar)

Parameters

Return Value

string getPaddingChar()

Return Value

TableStyle setHorizontalBorderChars(string $outside, string $inside = null)

Parameters

Return Value

$this setHorizontalBorderChar(string $horizontalBorderChar) deprecated

Parameters

Return Value

string getHorizontalBorderChar() deprecated

Return Value

TableStyle setVerticalBorderChars(string $outside, string $inside = null)

Parameters

Return Value

$this setVerticalBorderChar(string $verticalBorderChar) deprecated

Parameters

Return Value

string getVerticalBorderChar() deprecated

Return Value

getBorderChars()

TableStyle setCrossingChars(string $cross, string $topLeft, string $topMid, string $topRight, string $midRight, string $bottomRight, string $bottomMid, string $bottomLeft, string $midLeft, string $topLeftBottom = null, string $topMidBottom = null, string $topRightBottom = null)

Parameters

Return Value

TableStyle setDefaultCrossingChar(string $char)

Parameters

Return Value

See also

$this setCrossingChar(string $crossingChar) deprecated

Parameters

Return Value

string getCrossingChar()

Return Value

array getCrossingChars()

Return Value

$this setCellHeaderFormat(string $cellHeaderFormat)

Parameters

Return Value

string getCellHeaderFormat()

Return Value

$this setCellRowFormat(string $cellRowFormat)

Parameters

Return Value

string getCellRowFormat()

Return Value

$this setCellRowContentFormat(string $cellRowContentFormat)

Parameters

Return Value

string getCellRowContentFormat()

Return Value

$this setBorderFormat(string $borderFormat)

Parameters

Return Value

string getBorderFormat()

Return Value

$this setPadType(int $padType)

Parameters

Return Value

int getPadType()

Return Value

string getHeaderTitleFormat()

Return Value

TableStyle setHeaderTitleFormat(string $format)

Parameters

Return Value

string getFooterTitleFormat()

Return Value

TableStyle setFooterTitleFormat(string $format)

Parameters

Return Value

`$this setPaddingChar(string $paddingChar)`

`string getPaddingChar()`

`TableStyle setHorizontalBorderChars(string $outside, string $inside = null)`

`$this setHorizontalBorderChar(string $horizontalBorderChar) ^deprecated`

`string getHorizontalBorderChar() ^deprecated`

`TableStyle setVerticalBorderChars(string $outside, string $inside = null)`

`$this setVerticalBorderChar(string $verticalBorderChar) ^deprecated`

`string getVerticalBorderChar() ^deprecated`

`getBorderChars()`

`TableStyle setCrossingChars(string $cross, string $topLeft, string $topMid, string $topRight, string $midRight, string $bottomRight, string $bottomMid, string $bottomLeft, string $midLeft, string $topLeftBottom = null, string $topMidBottom = null, string $topRightBottom = null)`

`TableStyle setDefaultCrossingChar(string $char)`

`$this setCrossingChar(string $crossingChar) ^deprecated`

`string getCrossingChar()`

`array getCrossingChars()`

`$this setCellHeaderFormat(string $cellHeaderFormat)`

`string getCellHeaderFormat()`

`$this setCellRowFormat(string $cellRowFormat)`

`string getCellRowFormat()`

`$this setCellRowContentFormat(string $cellRowContentFormat)`

`string getCellRowContentFormat()`

`$this setBorderFormat(string $borderFormat)`

`string getBorderFormat()`

`$this setPadType(int $padType)`

`int getPadType()`

`string getHeaderTitleFormat()`

`TableStyle setHeaderTitleFormat(string $format)`

`string getFooterTitleFormat()`

`TableStyle setFooterTitleFormat(string $format)`