phpDocumentor

RenderHandler
in package

Table of Contents

$logger  : LoggerInterface
$metas  : Metas
$outputFormats  : OutputFormats
$referenceRegistry  : ReferenceBuilder
$references  : array<string|int, Reference>
$renderer  : Renderer
$router  : Router
$urlGenerator  : UrlGenerator
__construct()  : mixed
handle()  : void
createEnvironment()  : Environment
initReferences()  : void
render()  : void
renderDocument()  : string

Properties

$referenceRegistry

private ReferenceBuilder $referenceRegistry

$references

private array<string|int, Reference> $references

Methods

__construct()

public __construct(Metas $metas, Renderer $renderer, LoggerInterface $logger, IteratorAggregate<string|int, Reference$references, Router $router, UrlGenerator $urlGenerator, ReferenceBuilder $referenceRegistry, OutputFormats $outputFormats) : mixed
Parameters
$metas : Metas
$renderer : Renderer
$logger : LoggerInterface
$references : IteratorAggregate<string|int, Reference>
$router : Router
$urlGenerator : UrlGenerator
$referenceRegistry : ReferenceBuilder
$outputFormats : OutputFormats
Return values
mixed

createEnvironment()

private createEnvironment(string $outputFolder, int $initialHeaderLevel, FilesystemInterface $origin) : Environment
Parameters
$outputFolder : string
$initialHeaderLevel : int
$origin : FilesystemInterface
Return values
Environment

initReferences()

private initReferences(array<string|int, Reference$references) : void
Parameters
$references : array<string|int, Reference>
Return values
void

render()

private render(NodeRendererFactory $nodeRendererFactory, GuideSetDescriptor $documentationSet, Environment $environment, FilesystemInterface $destination) : void
Parameters
$nodeRendererFactory : NodeRendererFactory
$documentationSet : GuideSetDescriptor
$environment : Environment
$destination : FilesystemInterface
Return values
void

renderDocument()

private renderDocument(NodeRendererFactory $nodeRendererFactory, DocumentDescriptor $descriptor, string $destinationPath, Environment $environment, GuideSetDescriptor $documentationSet) : string
Parameters
$nodeRendererFactory : NodeRendererFactory
$descriptor : DocumentDescriptor
$destinationPath : string
$environment : Environment
$documentationSet : GuideSetDescriptor
Return values
string

Search results