PHPFUI/InstaDoc

Defines the styles for a Table.

CloneableInstantiable

Public
Private

Methods

public displayOutsideBorder() : bool

public getBorderChars() : array

Gets border characters.

internal

public getBorderFormat() : string

Gets table border format.

public getCellHeaderFormat() : string

Gets header cell format.

public getCellRowContentFormat() : string

Gets row cell content format.

public getCellRowFormat() : string

Gets row cell format.

public getCrossingChar() : string

Gets crossing character.

public getCrossingChars() : array

Gets crossing characters.

internal

public getFooterTitleFormat() : string

public getHeaderTitleFormat() : string

public getPaddingChar() : string

Gets padding character, used for cell padding.

public getPadType() : int

Gets cell padding type.

public setBorderFormat(string $borderFormat) : static

Sets table border format.

return $this

public setCellHeaderFormat(string $cellHeaderFormat) : static

Sets header cell format.

return $this

public setCellRowContentFormat(string $cellRowContentFormat) : static

Sets row cell content format.

return $this

public setCellRowFormat(string $cellRowFormat) : static

Sets row cell format.

return $this

public 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) : static

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

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

public setDefaultCrossingChar(string $char) : Symfony\Component\Console\Helper\TableStyle

Sets default crossing character used for each cross.

public setDisplayOutsideBorder( $displayOutSideBorder) : static

public setFooterTitleFormat(string $format) : static

return $this

public setHeaderTitleFormat(string $format) : static

return $this

public setHorizontalBorderChars(string $outside, ?string $inside = NULL) : static

Sets horizontal border characters.

return $this

public setPaddingChar(string $paddingChar) : static

Sets padding character, used for cell padding.

return $this

public setPadType(int $padType) : static

Sets cell padding type.

return $this

public setVerticalBorderChars(string $outside, ?string $inside = NULL) : static

Sets vertical border characters.

return $this

Properties

private string $borderFormat = '%s'

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

private string $cellRowContentFormat = ' %s '

private string $cellRowFormat = '%s'

private string $crossingBottomLeftChar = '+'

private string $crossingBottomMidChar = '+'

private string $crossingBottomRightChar = '+'

private string $crossingChar = '+'

private string $crossingMidLeftChar = '+'

private string $crossingMidRightChar = '+'

private string $crossingTopLeftBottomChar = '+'

private string $crossingTopLeftChar = '+'

private string $crossingTopMidBottomChar = '+'

private string $crossingTopMidChar = '+'

private string $crossingTopRightBottomChar = '+'

private string $crossingTopRightChar = '+'

private bool $displayOutsideBorder = true

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

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

private string $horizontalInsideBorderChar = '-'

private string $horizontalOutsideBorderChar = '-'

private string $paddingChar = ' '

private int $padType = 1

private string $verticalInsideBorderChar = '|'

private string $verticalOutsideBorderChar = '|'

ConfigurationCode Formating StyleTab Stop SpacesNumbers (0-9.) only