\phpDocumentor\Guides\RestructuredText\HandlersParseFileHandler

Summary

Methods
Properties
Constants
__construct()
handle()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
buildPathOnFileSystem()
buildDocumentUrl()
parseRestructuredText()
parseMarkdown()
getFileContents()
$metas
$logger
$directives
$references
$eventManager
$renderer
N/A

Properties

$metas

$metas : \phpDocumentor\Guides\Metas

Type

Metas

$logger

$logger : \Psr\Log\LoggerInterface

Type

\Psr\Log\LoggerInterface —

$directives

$directives : \IteratorAggregate<\phpDocumentor\Guides\RestructuredText\Directives\Directive>

Type

Directive>

$references

$references : \IteratorAggregate<\phpDocumentor\Guides\References\Reference>

Type

Reference>

$eventManager

$eventManager : \Doctrine\Common\EventManager

Type

\Doctrine\Common\EventManager —

$renderer

$renderer : \phpDocumentor\Guides\Renderer

Type

Renderer

Methods

__construct()

__construct(\phpDocumentor\Guides\Metas  $metas, \phpDocumentor\Guides\Renderer  $renderer, \Psr\Log\LoggerInterface  $logger, \Doctrine\Common\EventManager  $eventManager, \IteratorAggregate<\phpDocumentor\Guides\RestructuredText\Directives\Directive>  $directives, \IteratorAggregate<\phpDocumentor\Guides\References\Reference>  $references) : mixed

Parameters

\phpDocumentor\Guides\Metas $metas
\phpDocumentor\Guides\Renderer $renderer
\Psr\Log\LoggerInterface $logger
\Doctrine\Common\EventManager $eventManager
\IteratorAggregate<\phpDocumentor\Guides\RestructuredText\Directives\Directive> $directives
\IteratorAggregate<\phpDocumentor\Guides\References\Reference> $references

Returns

mixed —

handle()

handle(\phpDocumentor\Guides\RestructuredText\ParseFileCommand  $command) : void

Parameters

\phpDocumentor\Guides\RestructuredText\ParseFileCommand $command

buildPathOnFileSystem()

buildPathOnFileSystem(string  $file, string  $currentDirectory, string  $extension) : string

Parameters

string $file
string $currentDirectory
string $extension

Returns

string —

buildDocumentUrl()

buildDocumentUrl(\phpDocumentor\Guides\Environment  $environment, string  $extension) : string

Parameters

\phpDocumentor\Guides\Environment $environment
string $extension

Returns

string —

parseRestructuredText()

parseRestructuredText(\phpDocumentor\Guides\Configuration  $configuration, \phpDocumentor\Guides\Environment  $environment, string  $fileAbsolutePath) : \phpDocumentor\Guides\Nodes\DocumentNode

Parameters

\phpDocumentor\Guides\Configuration $configuration
\phpDocumentor\Guides\Environment $environment
string $fileAbsolutePath

Returns

\phpDocumentor\Guides\Nodes\DocumentNode —

parseMarkdown()

parseMarkdown(\phpDocumentor\Guides\Configuration  $configuration, \phpDocumentor\Guides\Environment  $environment, string  $fileAbsolutePath) : \phpDocumentor\Guides\Nodes\DocumentNode

Parameters

\phpDocumentor\Guides\Configuration $configuration
\phpDocumentor\Guides\Environment $environment
string $fileAbsolutePath

Returns

\phpDocumentor\Guides\Nodes\DocumentNode —

getFileContents()

getFileContents(\phpDocumentor\Guides\Environment  $environment, string  $file) : string

Parameters

\phpDocumentor\Guides\Environment $environment
string $file

Returns

string —