\phpDocumentor\Guides\RestructuredText\ParserTableParser

Summary

Methods
Properties
Constants
parseTableSeparatorLine()
guessTableType()
No public properties found
SIMPLE_TABLE_LETTER
SIMPLE_TABLE_LETTER_ALT
PRETTY_TABLE_LETTER
PRETTY_TABLE_HEADER
PRETTY_TABLE_JOINT
No protected methods found
No protected properties found
N/A
findTableChars()
No private properties found
N/A

Constants

SIMPLE_TABLE_LETTER

SIMPLE_TABLE_LETTER = '='

SIMPLE_TABLE_LETTER_ALT

SIMPLE_TABLE_LETTER_ALT = '-'

PRETTY_TABLE_LETTER

PRETTY_TABLE_LETTER = '-'

PRETTY_TABLE_HEADER

PRETTY_TABLE_HEADER = '='

PRETTY_TABLE_JOINT

PRETTY_TABLE_JOINT = '+'

Methods

parseTableSeparatorLine()

parseTableSeparatorLine(string  $line) : ?\phpDocumentor\Guides\RestructuredText\Parser\TableSeparatorLineConfig

Parses a line from a table to see if it is a separator line.

Returns TableSeparatorLineConfig if it is a separator, null otherwise.

Parameters

string $line

Returns

?\phpDocumentor\Guides\RestructuredText\Parser\TableSeparatorLineConfig —

guessTableType()

guessTableType(string  $line) : string

Parameters

string $line

Returns

string —

findTableChars()

findTableChars(string  $line) : string[]|null

A "line" separator always has only two characters.

This method returns those two characters.

This returns null if this is not a separator line or it's malformed in any way.

Parameters

string $line

Returns

string[]|null —