Documentation

TableStyle
in package

Defines the styles for a Table.

Tags
author

Fabien Potencier fabien@symfony.com

author

Саша Стаменковић umpirsky@gmail.com

author

Dany Maillard danymaillard93b@gmail.com

Table of Contents

$borderFormat  : mixed
$cellHeaderFormat  : mixed
$cellRowContentFormat  : mixed
$cellRowFormat  : mixed
$crossingBottomLeftChar  : mixed
$crossingBottomMidChar  : mixed
$crossingBottomRightChar  : mixed
$crossingChar  : mixed
$crossingMidLeftChar  : mixed
$crossingMidRightChar  : mixed
$crossingTopLeftBottomChar  : mixed
$crossingTopLeftChar  : mixed
$crossingTopMidBottomChar  : mixed
$crossingTopMidChar  : mixed
$crossingTopRightBottomChar  : mixed
$crossingTopRightChar  : mixed
$footerTitleFormat  : mixed
$headerTitleFormat  : mixed
$horizontalInsideBorderChar  : mixed
$horizontalOutsideBorderChar  : mixed
$paddingChar  : mixed
$padType  : mixed
$verticalInsideBorderChar  : mixed
$verticalOutsideBorderChar  : mixed
getBorderFormat()  : string
Gets table border format.
getCellHeaderFormat()  : string
Gets header cell format.
getCellRowContentFormat()  : string
Gets row cell content format.
getCellRowFormat()  : string
Gets row cell format.
getCrossingChar()  : string
Gets crossing character.
getFooterTitleFormat()  : string
getHeaderTitleFormat()  : string
getPaddingChar()  : string
Gets padding character, used for cell padding.
getPadType()  : int
Gets cell padding type.
setBorderFormat()  : $this
Sets table border format.
setCellHeaderFormat()  : $this
Sets header cell format.
setCellRowContentFormat()  : $this
Sets row cell content format.
setCellRowFormat()  : $this
Sets row cell format.
setCrossingChars()  : self
Sets crossing characters.
setDefaultCrossingChar()  : self
Sets default crossing character used for each cross.
setFooterTitleFormat()  : self
setHeaderTitleFormat()  : self
setHorizontalBorderChars()  : self
Sets horizontal border characters.
setPaddingChar()  : $this
Sets padding character, used for cell padding.
setPadType()  : $this
Sets cell padding type.
setVerticalBorderChars()  : self
Sets vertical border characters.

Properties

$borderFormat

private mixed $borderFormat = '%s'

$cellHeaderFormat

private mixed $cellHeaderFormat = '<info>%s</info>'

$cellRowContentFormat

private mixed $cellRowContentFormat = ' %s '

$cellRowFormat

private mixed $cellRowFormat = '%s'

$crossingBottomLeftChar

private mixed $crossingBottomLeftChar = '+'

$crossingBottomMidChar

private mixed $crossingBottomMidChar = '+'

$crossingBottomRightChar

private mixed $crossingBottomRightChar = '+'

$crossingMidLeftChar

private mixed $crossingMidLeftChar = '+'

$crossingMidRightChar

private mixed $crossingMidRightChar = '+'

$crossingTopLeftBottomChar

private mixed $crossingTopLeftBottomChar = '+'

$crossingTopLeftChar

private mixed $crossingTopLeftChar = '+'

$crossingTopMidBottomChar

private mixed $crossingTopMidBottomChar = '+'

$crossingTopMidChar

private mixed $crossingTopMidChar = '+'

$crossingTopRightBottomChar

private mixed $crossingTopRightBottomChar = '+'

$crossingTopRightChar

private mixed $crossingTopRightChar = '+'

$footerTitleFormat

private mixed $footerTitleFormat = '<fg=black;bg=white;options=bold> %s </>'

$headerTitleFormat

private mixed $headerTitleFormat = '<fg=black;bg=white;options=bold> %s </>'

$horizontalInsideBorderChar

private mixed $horizontalInsideBorderChar = '-'

$horizontalOutsideBorderChar

private mixed $horizontalOutsideBorderChar = '-'

$verticalInsideBorderChar

private mixed $verticalInsideBorderChar = '|'

$verticalOutsideBorderChar

private mixed $verticalOutsideBorderChar = '|'

Methods

getBorderFormat()

Gets table border format.

public getBorderFormat() : string
Return values
string —

getCellHeaderFormat()

Gets header cell format.

public getCellHeaderFormat() : string
Return values
string —

getCellRowContentFormat()

Gets row cell content format.

public getCellRowContentFormat() : string
Return values
string —

getCellRowFormat()

Gets row cell format.

public getCellRowFormat() : string
Return values
string —

getCrossingChar()

Gets crossing character.

public getCrossingChar() : string
Return values
string —

getFooterTitleFormat()

public getFooterTitleFormat() : string
Return values
string —

getHeaderTitleFormat()

public getHeaderTitleFormat() : string
Return values
string —

getPaddingChar()

Gets padding character, used for cell padding.

public getPaddingChar() : string
Return values
string —

getPadType()

Gets cell padding type.

public getPadType() : int
Return values
int —

setBorderFormat()

Sets table border format.

public setBorderFormat(string $borderFormat) : $this
Parameters
$borderFormat : string
Return values
$this —

setCellHeaderFormat()

Sets header cell format.

public setCellHeaderFormat(string $cellHeaderFormat) : $this
Parameters
$cellHeaderFormat : string
Return values
$this —

setCellRowContentFormat()

Sets row cell content format.

public setCellRowContentFormat(string $cellRowContentFormat) : $this
Parameters
$cellRowContentFormat : string
Return values
$this —

setCellRowFormat()

Sets row cell format.

public setCellRowFormat(string $cellRowFormat) : $this
Parameters
$cellRowFormat : string
Return values
$this —

setCrossingChars()

Sets crossing characters.

public setCrossingChars(string $cross, string $topLeft, string $topMid, string $topRight, string $midRight, string $bottomRight, string $bottomMid, string $bottomLeft, string $midLeft[, string|null $topLeftBottom = null ][, string|null $topMidBottom = null ][, string|null $topRightBottom = null ]) : self

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
$cross : string

Crossing char (see #0 of example)

$topLeft : string

Top left char (see #1 of example)

$topMid : string

Top mid char (see #2 of example)

$topRight : string

Top right char (see #3 of example)

$midRight : string

Mid right char (see #4 of example)

$bottomRight : string

Bottom right char (see #5 of example)

$bottomMid : string

Bottom mid char (see #6 of example)

$bottomLeft : string

Bottom left char (see #7 of example)

$midLeft : string

Mid left char (see #8 of example)

$topLeftBottom : string|null = null

Top left bottom char (see #8' of example), equals to $midLeft if null

$topMidBottom : string|null = null

Top mid bottom char (see #0' of example), equals to $cross if null

$topRightBottom : string|null = null

Top right bottom char (see #4' of example), equals to $midRight if null

Return values
self —

setDefaultCrossingChar()

Sets default crossing character used for each cross.

public setDefaultCrossingChar(string $char) : self
Parameters
$char : string
Tags
see

{@link setCrossingChars()} for setting each crossing individually.

Return values
self —

setFooterTitleFormat()

public setFooterTitleFormat(string $format) : self
Parameters
$format : string
Return values
self —

setHeaderTitleFormat()

public setHeaderTitleFormat(string $format) : self
Parameters
$format : string
Return values
self —

setHorizontalBorderChars()

Sets horizontal border characters.

public setHorizontalBorderChars(string $outside[, string $inside = null ]) : self
╔═══════════════╤══════════════════════════╤══════════════════╗ 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
$outside : string
$inside : string = null
Return values
self —

setPaddingChar()

Sets padding character, used for cell padding.

public setPaddingChar(string $paddingChar) : $this
Parameters
$paddingChar : string
Return values
$this —

setPadType()

Sets cell padding type.

public setPadType(int $padType) : $this
Parameters
$padType : int
Return values
$this —

setVerticalBorderChars()

Sets vertical border characters.

public setVerticalBorderChars(string $outside[, string $inside = null ]) : self
╔═══════════════╤══════════════════════════╤══════════════════╗ ║ 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
$outside : string
$inside : string = null
Return values
self —

Search results