\phpDocumentor\Guides\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()
getFileContents()
createDocument()
addDocumentToDocumentationSet()
$metas
$logger
$parser
N/A

Properties

$metas

$metas : \phpDocumentor\Guides\Metas

Type

\phpDocumentor\Guides\Metas —

$logger

$logger : \Psr\Log\LoggerInterface

Type

\Psr\Log\LoggerInterface —

$parser

$parser : \phpDocumentor\Guides\Parser

Type

\phpDocumentor\Guides\Parser —

Methods

__construct()

__construct(\phpDocumentor\Guides\Metas  $metas, \Psr\Log\LoggerInterface  $logger, \phpDocumentor\Guides\Parser  $parser) : mixed

Parameters

\phpDocumentor\Guides\Metas $metas
\Psr\Log\LoggerInterface $logger
\phpDocumentor\Guides\Parser $parser

Returns

mixed —

handle()

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

Parameters

\phpDocumentor\Guides\ParseFileCommand $command

buildPathOnFileSystem()

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

Parameters

string $file
string $currentDirectory
string $extension

Returns

string —

getFileContents()

getFileContents(\League\Flysystem\FilesystemInterface  $origin, string  $file) : string

Parameters

\League\Flysystem\FilesystemInterface $origin
string $file

Returns

string —

createDocument()

createDocument(\phpDocumentor\Descriptor\GuideSetDescriptor  $documentationSet, \League\Flysystem\FilesystemInterface  $origin, string  $documentFolder, string  $fileName) : ?\phpDocumentor\Guides\Nodes\DocumentNode

Parameters

\phpDocumentor\Descriptor\GuideSetDescriptor $documentationSet
\League\Flysystem\FilesystemInterface $origin
string $documentFolder
string $fileName

Returns

?\phpDocumentor\Guides\Nodes\DocumentNode —

addDocumentToDocumentationSet()

addDocumentToDocumentationSet(\phpDocumentor\Descriptor\GuideSetDescriptor  $documentationSet, string  $file, \phpDocumentor\Guides\Nodes\DocumentNode  $document) : void

Parameters

\phpDocumentor\Descriptor\GuideSetDescriptor $documentationSet
string $file
\phpDocumentor\Guides\Nodes\DocumentNode $document