Properties

$parser

$parser : \phpDocumentor\Guides\RestructuredText\Parser

Type

Parser

$environment

$environment : \phpDocumentor\Guides\Environment

Type

Environment

$eventManager

$eventManager : \Doctrine\Common\EventManager

Type

\Doctrine\Common\EventManager —

$directives

$directives : \phpDocumentor\Guides\RestructuredText\Directives\Directive[]

Type

Directive[]

$document

$document : \phpDocumentor\Guides\Nodes\DocumentNode

Type

DocumentNode

$directive

$directive : \phpDocumentor\Guides\RestructuredText\Parser\Directive|null

Type

Directive|null

$lineDataParser

$lineDataParser : \phpDocumentor\Guides\RestructuredText\Parser\LineDataParser

Type

LineDataParser

$lineChecker

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

Type

LineChecker

$tableParser

$tableParser : \phpDocumentor\Guides\RestructuredText\Parser\TableParser

Type

TableParser

$buffer

$buffer : \phpDocumentor\Guides\RestructuredText\Parser\Buffer

Type

Buffer

$nodeBuffer

$nodeBuffer : \phpDocumentor\Guides\Nodes\Node|null

Type

Node|null

$isCode

$isCode : bool

Type

bool

$lines

$lines : \phpDocumentor\Guides\RestructuredText\Parser\Lines

Type

Lines

$state

$state : string

Type

string

$listLine

$listLine : \phpDocumentor\Guides\RestructuredText\Parser\ListLine|null

Type

ListLine|null

$listFlow

$listFlow : bool

Type

bool

$lastTitleNode

$lastTitleNode : \phpDocumentor\Guides\Nodes\TitleNode

Type

TitleNode

$openTitleNodes

$openTitleNodes : \phpDocumentor\Guides\Nodes\TitleNode[]

Type

TitleNode[]

Methods

__construct()

__construct(\phpDocumentor\Guides\RestructuredText\Parser  $parser, \Doctrine\Common\EventManager  $eventManager, \phpDocumentor\Guides\RestructuredText\Directives\Directive[]  $directives) : mixed

Parameters

\phpDocumentor\Guides\RestructuredText\Parser $parser
\Doctrine\Common\EventManager $eventManager
\phpDocumentor\Guides\RestructuredText\Directives\Directive[] $directives

Returns

mixed —

getDocument()

getDocument() : \phpDocumentor\Guides\Nodes\DocumentNode

Returns

\phpDocumentor\Guides\Nodes\DocumentNode —

parse()

parse(string  $contents) : \phpDocumentor\Guides\Nodes\DocumentNode

Parameters

string $contents

Returns

\phpDocumentor\Guides\Nodes\DocumentNode —

mergeIncludedFiles()

mergeIncludedFiles(string  $document) : string

Parameters

string $document

Returns

string —

init()

init() : void

setState()

setState(string  $state) : void

Parameters

string $state

prepareDocument()

prepareDocument(string  $document) : string

Parameters

string $document

Returns

string —

createLines()

createLines(string  $document) : \phpDocumentor\Guides\RestructuredText\Parser\Lines

Parameters

string $document

Returns

\phpDocumentor\Guides\RestructuredText\Parser\Lines —

parseLines()

parseLines(string  $document) : void

Parameters

string $document

parseLine()

parseLine(string  $line) : bool

Parameters

string $line

Returns

bool —

flush()

flush() : void

hasBuffer()

hasBuffer() : bool

Returns

bool —

getCurrentDirective()

getCurrentDirective() : ?\phpDocumentor\Guides\RestructuredText\Directives\Directive

Returns

?\phpDocumentor\Guides\RestructuredText\Directives\Directive —

isDirectiveOption()

isDirectiveOption(string  $line) : bool

Parameters

string $line

Returns

bool —

initDirective()

initDirective(string  $line) : bool

Parameters

string $line

Returns

bool —

prepareCode()

prepareCode() : bool

Returns

bool —

parseLink()

parseLink(string  $line) : bool

Parameters

string $line

Returns

bool —

parseListLine()

parseListLine(?string  $line, bool  $flush = false) : bool

Parameters

?string $line
bool $flush

Returns

bool —

endOpenSection()

endOpenSection(\phpDocumentor\Guides\Nodes\TitleNode  $titleNode) : void

Parameters

\phpDocumentor\Guides\Nodes\TitleNode $titleNode