Properties

$environment

$environment : \phpDocumentor\Guides\Environment

Type

Environment

$directives

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

Type

Directive[]

$filename

$filename : string|null

Type

string|null

$documentParser

$documentParser : \phpDocumentor\Guides\RestructuredText\Parser\DocumentParser|null

Type

DocumentParser|null

$references

$references : \phpDocumentor\Guides\References\Reference[]

Type

Reference[]

$eventManager

$eventManager : \Doctrine\Common\EventManager

Type

\Doctrine\Common\EventManager —

$format

$format : \phpDocumentor\Guides\RestructuredText\Formats\Format

Type

Format

Methods

__construct()

__construct(\phpDocumentor\Guides\RestructuredText\Formats\Format  $format, \phpDocumentor\Guides\Environment  $environment, \Doctrine\Common\EventManager  $eventManager, \phpDocumentor\Guides\RestructuredText\Directives\Directive[]  $directives, \phpDocumentor\Guides\References\Reference[]  $references) : mixed

Parameters

\phpDocumentor\Guides\RestructuredText\Formats\Format $format
\phpDocumentor\Guides\Environment $environment
\Doctrine\Common\EventManager $eventManager
\phpDocumentor\Guides\RestructuredText\Directives\Directive[] $directives
\phpDocumentor\Guides\References\Reference[] $references

Returns

mixed —

getSubParser()

getSubParser() : \phpDocumentor\Guides\RestructuredText\Parser

Returns

\phpDocumentor\Guides\RestructuredText\Parser —

initDirectives()

initDirectives(\phpDocumentor\Guides\RestructuredText\Directives\Directive[]  $directives) : void

Parameters

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

initReferences()

initReferences(\phpDocumentor\Guides\References\Reference[]  $references) : void

Parameters

\phpDocumentor\Guides\References\Reference[] $references

getEnvironment()

getEnvironment() : \phpDocumentor\Guides\Environment

Returns

\phpDocumentor\Guides\Environment —

registerDirective()

registerDirective(\phpDocumentor\Guides\RestructuredText\Directives\Directive  $directive) : void

Parameters

\phpDocumentor\Guides\RestructuredText\Directives\Directive $directive

getDocument()

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

Returns

\phpDocumentor\Guides\Nodes\DocumentNode —

getFilename()

getFilename() : string

Returns

string —

parse()

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

Parameters

string $contents

Returns

\phpDocumentor\Guides\Nodes\DocumentNode —

parseLocal()

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

Parameters

string $contents

Returns

\phpDocumentor\Guides\Nodes\DocumentNode —

parseFragment()

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

Parameters

string $contents

Returns

\phpDocumentor\Guides\Nodes\DocumentNode —

createDocumentParser()

createDocumentParser() : \phpDocumentor\Guides\RestructuredText\Parser\DocumentParser

Returns

\phpDocumentor\Guides\RestructuredText\Parser\DocumentParser —