Documentation

DocumentParser
in package

Table of Contents

$buffer  : Buffer
$directive  : Directive|null
$directives  : array<string|int, Directive>
$document  : DocumentNode
$environment  : Environment
$eventManager  : EventManager
$isCode  : bool
$lastTitleNode  : TitleNode
$lineChecker  : LineChecker
$lineDataParser  : LineDataParser
$lines  : Lines
$listFlow  : bool
$listLine  : ListLine|null
$nodeBuffer  : Node|null
$openTitleNodes  : array<string|int, TitleNode>
$parser  : Parser
$specialLetter  : false|string|null
$state  : string
$tableParser  : TableParser
__construct()  : mixed
getDocument()  : DocumentNode
mergeIncludedFiles()  : string
parse()  : DocumentNode
createLines()  : Lines
endOpenSection()  : void
flush()  : void
getCurrentDirective()  : Directive|null
hasBuffer()  : bool
init()  : void
initDirective()  : bool
isDirectiveOption()  : bool
parseLine()  : bool
parseLines()  : void
parseLink()  : bool
parseListLine()  : bool
prepareCode()  : bool
prepareDocument()  : string
setState()  : void

Properties

Methods

mergeIncludedFiles()

public mergeIncludedFiles(string $document) : string
Parameters
$document : string
Return values
string —

createLines()

private createLines(string $document) : Lines
Parameters
$document : string
Return values
Lines —

initDirective()

private initDirective(string $line) : bool
Parameters
$line : string
Return values
bool —

isDirectiveOption()

private isDirectiveOption(string $line) : bool
Parameters
$line : string
Return values
bool —

parseLine()

private parseLine(string $line) : bool
Parameters
$line : string
Return values
bool —

parseLines()

private parseLines(string $document) : void
Parameters
$document : string
Return values
void —

parseLink()

private parseLink(string $line) : bool
Parameters
$line : string
Return values
bool —

parseListLine()

private parseListLine(string|null $line[, bool $flush = false ]) : bool
Parameters
$line : string|null
$flush : bool = false
Return values
bool —

prepareCode()

private prepareCode() : bool
Return values
bool —

prepareDocument()

private prepareDocument(string $document) : string
Parameters
$document : string
Return values
string —

setState()

private setState(string $state) : void
Parameters
$state : string
Return values
void —

Search results