phpDocumentor

ParseFileHandler
in package

Table of Contents

$logger  : LoggerInterface
$metas  : Metas
$parser  : Parser
__construct()  : mixed
handle()  : void
addDocumentToDocumentationSet()  : void
buildPathOnFileSystem()  : string
createDocument()  : DocumentNode|null
getFileContents()  : string

Properties

Methods

__construct()

public __construct(Metas $metas, LoggerInterface $logger, Parser $parser) : mixed
Parameters
$metas : Metas
$logger : LoggerInterface
$parser : Parser
Return values
mixed

addDocumentToDocumentationSet()

private addDocumentToDocumentationSet(GuideSetDescriptor $documentationSet, string $file, DocumentNode $document) : void
Parameters
$documentationSet : GuideSetDescriptor
$file : string
$document : DocumentNode
Return values
void

buildPathOnFileSystem()

private buildPathOnFileSystem(string $file, string $currentDirectory, string $extension) : string
Parameters
$file : string
$currentDirectory : string
$extension : string
Return values
string

createDocument()

private createDocument(GuideSetDescriptor $documentationSet, FilesystemInterface $origin, string $documentFolder, string $fileName) : DocumentNode|null
Parameters
$documentationSet : GuideSetDescriptor
$origin : FilesystemInterface
$documentFolder : string
$fileName : string
Return values
DocumentNode|null

getFileContents()

private getFileContents(FilesystemInterface $origin, string $file) : string
Parameters
$origin : FilesystemInterface
$file : string
Return values
string

Search results