Documentation

TextGrid
in package

Table of Contents

Properties

$columnHeaders  : bool
$columns  : array<string|int, string>
$gridDisplay  : string
$isCli  : bool
$matrix  : array<string|int, array<string|int, mixed>>
$numbersRight  : TextGridRightAlign
$rowDividers  : bool
$rowHeaders  : bool
$rows  : array<string|int, int>

Methods

__construct()  : mixed
render()  : string
setNumbersRight()  : void
getColumnWidth()  : int
getColumnWidths()  : array<string|int, int>
getString()  : string
renderCells()  : void
renderColumnHeader()  : void
renderFooter()  : void
renderRows()  : void
rightAlign()  : bool
strlen()  : int

Properties

$columnHeaders

protected bool $columnHeaders = true

$columns

protected array<string|int, string> $columns

$gridDisplay

protected string $gridDisplay

$matrix

protected array<string|int, array<string|int, mixed>> $matrix

$rowDividers

protected bool $rowDividers = false

$rowHeaders

protected bool $rowHeaders = true

$rows

protected array<string|int, int> $rows

Methods

__construct()

public __construct(array<string|int, array<string|int, mixed>> $matrix[, bool $isCli = true ][, bool $rowDividers = false ][, bool $rowHeaders = true ][, bool $columnHeaders = true ][, TextGridRightAlign $numbersRight = TextGridRightAlign::none ]) : mixed
Parameters
$matrix : array<string|int, array<string|int, mixed>>
$isCli : bool = true
$rowDividers : bool = false
$rowHeaders : bool = true
$columnHeaders : bool = true
$numbersRight : TextGridRightAlign = TextGridRightAlign::none

render()

public render() : string
Return values
string

getColumnWidth()

protected getColumnWidth(array<string|int, mixed> $columnData) : int
Parameters
$columnData : array<string|int, mixed>
Return values
int

getColumnWidths()

protected getColumnWidths() : array<string|int, int>
Return values
array<string|int, int>

getString()

protected getString(mixed $value) : string
Parameters
$value : mixed
Return values
string

renderCells()

protected renderCells(array<string|int, mixed> $rowData, array<string|int, int> $columnWidths) : void
Parameters
$rowData : array<string|int, mixed>
$columnWidths : array<string|int, int>

renderColumnHeader()

protected renderColumnHeader(int $maxRowLength, array<string|int, int> &$columnWidths) : void
Parameters
$maxRowLength : int
$columnWidths : array<string|int, int>

renderFooter()

protected renderFooter(int $maxRowLength, array<string|int, int> $columnWidths) : void
Parameters
$maxRowLength : int
$columnWidths : array<string|int, int>

renderRows()

protected renderRows(int $maxRowLength, array<string|int, int> $columnWidths) : void
Parameters
$maxRowLength : int
$columnWidths : array<string|int, int>

rightAlign()

protected rightAlign(string $displayCell[, mixed $cell = null ]) : bool
Parameters
$displayCell : string
$cell : mixed = null
Return values
bool

strlen()

protected strlen(string $value) : int
Parameters
$value : string
Return values
int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results