Constants

TYPE_SIMPLE

TYPE_SIMPLE = 'simple'

TYPE_PRETTY

TYPE_PRETTY = 'pretty'

Properties

$classes

$classes : string[]

Type

string[]

$data

$data : \phpDocumentor\Guides\Nodes\Table\TableRow[]

Type

TableRow[]

$headers

$headers : bool[]

Type

bool[]

$type

$type : string

Type

string

$options

$options : array

Type

array

$separatorLineConfigs

$separatorLineConfigs : array<int,\phpDocumentor\Guides\RestructuredText\Parser\TableSeparatorLineConfig>

Type

TableSeparatorLineConfig>

$rawDataLines

$rawDataLines : string[]

Type

string[]

$currentLineNumber

$currentLineNumber : int

Type

int

$isCompiled

$isCompiled : bool

Type

bool

$errors

$errors : string[]

Type

string[]

Methods

__construct()

__construct(\phpDocumentor\Guides\RestructuredText\Parser\TableSeparatorLineConfig  $separatorLineConfig, string  $type) : mixed

Parameters

\phpDocumentor\Guides\RestructuredText\Parser\TableSeparatorLineConfig $separatorLineConfig
string $type

Returns

mixed —

getValue()

getValue() : \phpDocumentor\Guides\Nodes\Node|callable|string|null

Returns

\phpDocumentor\Guides\Nodes\Node|callable|string|null —

setValue()

setValue(\phpDocumentor\Guides\Nodes\Node|callable|string|null  $value) : void

Parameters

\phpDocumentor\Guides\Nodes\Node|callable|string|null $value

getClasses()

getClasses() : string[]

Returns

string[] —

getClassesString()

getClassesString() : string

Returns

string —

setClasses()

setClasses(string[]  $classes) : void

Parameters

string[] $classes

getValueString()

getValueString() : string

Returns

string —

withOptions()

withOptions(array<string,mixed>  $options) : self

Parameters

array $options

Returns

self —

getOptions()

getOptions() : array<string,mixed>

Returns

array

getOption()

getOption(string  $name, mixed|null  $default = null) : mixed|null

Parameters

string $name
mixed|null $default

Returns

mixed|null —

getCols()

getCols() : int

Returns

int —

getRows()

getRows() : int

Returns

int —

getData()

getData() : \phpDocumentor\Guides\Nodes\Table\TableRow[]

Returns

\phpDocumentor\Guides\Nodes\Table\TableRow[] —

getHeaders()

getHeaders() : bool[]

Returns an of array of which rows should be headers, where the row index is the key of the array and the value is always true.

Returns

bool[] —

pushSeparatorLine()

pushSeparatorLine(\phpDocumentor\Guides\RestructuredText\Parser\TableSeparatorLineConfig  $separatorLineConfig) : void

Parameters

\phpDocumentor\Guides\RestructuredText\Parser\TableSeparatorLineConfig $separatorLineConfig

pushContentLine()

pushContentLine(string  $line) : void

Parameters

string $line

finalize()

finalize(\phpDocumentor\Guides\RestructuredText\Parser  $parser, \phpDocumentor\Guides\RestructuredText\Parser\LineChecker  $lineChecker) : void

Parameters

\phpDocumentor\Guides\RestructuredText\Parser $parser
\phpDocumentor\Guides\RestructuredText\Parser\LineChecker $lineChecker

normalizeLines()

normalizeLines(string[]  $lines) : string

Parameters

string[] $lines

Returns

string —

compile()

compile() : void

Looks at all the raw data and finally populates the data and headers.

compileSimpleTable()

compileSimpleTable() : void

compilePrettyTable()

compilePrettyTable() : void

getTableAsString()

getTableAsString() : string

Returns

string —

addError()

addError(string  $message) : void

Parameters

string $message

findColumnInPreviousRows()

findColumnInPreviousRows(int  $columnIndex, \phpDocumentor\Guides\Nodes\Table\TableRow[]  $rows, int  $currentRowIndex) : \phpDocumentor\Guides\Nodes\Table\TableColumn

Parameters

int $columnIndex
\phpDocumentor\Guides\Nodes\Table\TableRow[] $rows
int $currentRowIndex

Returns

\phpDocumentor\Guides\Nodes\Table\TableColumn —