PHP Class Webmozart\Console\UI\Style\TableStyle

Since: 1.0
Author: Bernhard Schussek ([email protected])
Exibir arquivo Open project: webmozart/console Class Usage Examples

Public Methods

Method Description
asciiBorder ( ) : TableStyle A style that uses ASCII characters for drawing borders.
borderless ( ) : TableStyle A borderless style.
getBorderStyle ( ) : BorderStyle Returns the border style.
getCellFormat ( ) : string Returns the format string for rendering cells.
getCellStyle ( ) : Style Returns the style of the table cells.
getColumnAlignment ( integer $column ) : integer Returns the alignment of a given column.
getColumnAlignments ( integer $nbColumns ) : int[] Returns the alignments of the table columns.
getDefaultColumnAlignment ( ) : integer Returns the default column alignment.
getHeaderCellFormat ( ) : string Returns the format string for rendering the header cells.
getHeaderCellStyle ( ) : Style Returns the style of the header cells.
getPaddingChar ( ) : string Returns the character used to pad cells to the desired width.
setBorderStyle ( BorderStyle $borderStyle ) : static Sets the border style.
setCellFormat ( string $format ) : static Sets the format string for rendering cells.
setCellStyle ( Style $style ) : static Sets the style of the table cells.
setColumnAlignment ( integer $column, integer $alignment ) : static Sets the alignment of a given column.
setColumnAlignments ( array $alignments ) : static Sets the alignments of the table columns.
setDefaultColumnAlignment ( integer $alignment ) : static Returns the default column alignment.
setHeaderCellFormat ( string $format ) : static Sets the format string for rendering the header cells.
setHeaderCellStyle ( Style $style = null ) : static Sets the style of the header cells.
setPaddingChar ( string $char ) : static Sets the character used to pad cells to the desired width.
solidBorder ( ) : TableStyle A style that uses Unicode characters for drawing solid borders.

Method Details

asciiBorder() public static method

A style that uses ASCII characters for drawing borders.
public static asciiBorder ( ) : TableStyle
return TableStyle The style.

borderless() public static method

A borderless style.
public static borderless ( ) : TableStyle
return TableStyle The style.

getBorderStyle() public method

Returns the border style.
public getBorderStyle ( ) : BorderStyle
return BorderStyle The border style.

getCellFormat() public method

Returns the format string for rendering cells.
public getCellFormat ( ) : string
return string The format string. The string contains the substring "%s" where the cell content is inserted.

getCellStyle() public method

Returns the style of the table cells.
public getCellStyle ( ) : Style
return Webmozart\Console\Api\Formatter\Style The cell style.

getColumnAlignment() public method

Returns the alignment of a given column.
public getColumnAlignment ( integer $column ) : integer
$column integer The 0-based column key.
return integer The {@link Alignment} constant.

getColumnAlignments() public method

Returns the alignments of the table columns.
public getColumnAlignments ( integer $nbColumns ) : int[]
$nbColumns integer The number of alignments to return.
return int[] An array of {@link Alignment} constants indexed by the 0-based column keys.

getDefaultColumnAlignment() public method

Returns the default column alignment.
public getDefaultColumnAlignment ( ) : integer
return integer One of the {@link Alignment} constants.

getHeaderCellFormat() public method

Returns the format string for rendering the header cells.
public getHeaderCellFormat ( ) : string
return string The format string. The string contains the substring "%s" where the cell content is inserted.

getHeaderCellStyle() public method

Returns the style of the header cells.
public getHeaderCellStyle ( ) : Style
return Webmozart\Console\Api\Formatter\Style The header cell style.

getPaddingChar() public method

Returns the character used to pad cells to the desired width.
public getPaddingChar ( ) : string
return string The padding character.

setBorderStyle() public method

Sets the border style.
public setBorderStyle ( BorderStyle $borderStyle ) : static
$borderStyle BorderStyle The border style.
return static The current instance.

setCellFormat() public method

Sets the format string for rendering cells.
public setCellFormat ( string $format ) : static
$format string The format string. The string should contain the substring "%s" where the cell content is inserted.
return static The current instance.

setCellStyle() public method

Sets the style of the table cells.
public setCellStyle ( Style $style ) : static
$style Webmozart\Console\Api\Formatter\Style The cell style.
return static The current instance.

setColumnAlignment() public method

Sets the alignment of a given column.
public setColumnAlignment ( integer $column, integer $alignment ) : static
$column integer The 0-based column key.
$alignment integer The alignment.
return static The current instance.

setColumnAlignments() public method

Sets the alignments of the table columns.
public setColumnAlignments ( array $alignments ) : static
$alignments array An array of {@link Alignment} constants indexed by the 0-based column keys.
return static The current instance.

setDefaultColumnAlignment() public method

Returns the default column alignment.
public setDefaultColumnAlignment ( integer $alignment ) : static
$alignment integer One of the {@link Alignment} constants.
return static The current instance.

setHeaderCellFormat() public method

Sets the format string for rendering the header cells.
public setHeaderCellFormat ( string $format ) : static
$format string The format string. The string should contain the substring "%s" where the cell content is inserted.
return static The current instance.

setHeaderCellStyle() public method

Sets the style of the header cells.
public setHeaderCellStyle ( Style $style = null ) : static
$style Webmozart\Console\Api\Formatter\Style The header cell style.
return static The current instance.

setPaddingChar() public method

Sets the character used to pad cells to the desired width.
public setPaddingChar ( string $char ) : static
$char string The padding character.
return static The current instance.

solidBorder() public static method

A style that uses Unicode characters for drawing solid borders.
public static solidBorder ( ) : TableStyle
return TableStyle The style.