\phpDocumentor\Guides\HandlersRenderHandler

Summary

Methods
Properties
Constants
__construct()
handle()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
render()
initReferences()
renderDocument()
createEnvironment()
$metas
$renderer
$logger
$references
$router
$urlGenerator
$referenceRegistry
$outputFormats
N/A

Properties

$metas

$metas : \phpDocumentor\Guides\Metas

Type

\phpDocumentor\Guides\Metas —

$renderer

$renderer : \phpDocumentor\Guides\Renderer

Type

\phpDocumentor\Guides\Renderer —

$logger

$logger : \Psr\Log\LoggerInterface

Type

\Psr\Log\LoggerInterface —

$references

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

Type

Reference[]

$router

$router : \phpDocumentor\Transformer\Router\Router

Type

Router

$urlGenerator

$urlGenerator : \phpDocumentor\Guides\UrlGenerator

Type

\phpDocumentor\Guides\UrlGenerator —

$referenceRegistry

$referenceRegistry : \phpDocumentor\Guides\ReferenceBuilder

Type

\phpDocumentor\Guides\ReferenceBuilder —

$outputFormats

$outputFormats : \phpDocumentor\Guides\Formats\OutputFormats

Type

\phpDocumentor\Guides\Formats\OutputFormats —

Methods

__construct()

__construct(\phpDocumentor\Guides\Metas  $metas, \phpDocumentor\Guides\Renderer  $renderer, \Psr\Log\LoggerInterface  $logger, \IteratorAggregate<\phpDocumentor\Guides\References\Reference>  $references, \phpDocumentor\Transformer\Router\Router  $router, \phpDocumentor\Guides\UrlGenerator  $urlGenerator, \phpDocumentor\Guides\ReferenceBuilder  $referenceRegistry, \phpDocumentor\Guides\Formats\OutputFormats  $outputFormats) : mixed

Parameters

\phpDocumentor\Guides\Metas $metas
\phpDocumentor\Guides\Renderer $renderer
\Psr\Log\LoggerInterface $logger
\IteratorAggregate<\phpDocumentor\Guides\References\Reference> $references
\phpDocumentor\Transformer\Router\Router $router
\phpDocumentor\Guides\UrlGenerator $urlGenerator
\phpDocumentor\Guides\ReferenceBuilder $referenceRegistry
\phpDocumentor\Guides\Formats\OutputFormats $outputFormats

Returns

mixed —

handle()

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

Parameters

\phpDocumentor\Guides\RenderCommand $command

render()

render(\phpDocumentor\Guides\NodeRenderers\NodeRendererFactory  $nodeRendererFactory, \phpDocumentor\Descriptor\GuideSetDescriptor  $documentationSet, \phpDocumentor\Guides\Environment  $environment, \League\Flysystem\FilesystemInterface  $destination) : void

Parameters

\phpDocumentor\Guides\NodeRenderers\NodeRendererFactory $nodeRendererFactory
\phpDocumentor\Descriptor\GuideSetDescriptor $documentationSet
\phpDocumentor\Guides\Environment $environment
\League\Flysystem\FilesystemInterface $destination

initReferences()

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

Parameters

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

renderDocument()

renderDocument(\phpDocumentor\Guides\NodeRenderers\NodeRendererFactory  $nodeRendererFactory, \phpDocumentor\Descriptor\DocumentDescriptor  $descriptor, string  $destinationPath, \phpDocumentor\Guides\Environment  $environment, \phpDocumentor\Descriptor\GuideSetDescriptor  $documentationSet) : string

Parameters

\phpDocumentor\Guides\NodeRenderers\NodeRendererFactory $nodeRendererFactory
\phpDocumentor\Descriptor\DocumentDescriptor $descriptor
string $destinationPath
\phpDocumentor\Guides\Environment $environment
\phpDocumentor\Descriptor\GuideSetDescriptor $documentationSet

Returns

string —

createEnvironment()

createEnvironment(string  $outputFolder, int  $initialHeaderLevel, \League\Flysystem\FilesystemInterface  $origin) : \phpDocumentor\Guides\Environment

Parameters

string $outputFolder
int $initialHeaderLevel
\League\Flysystem\FilesystemInterface $origin

Returns

\phpDocumentor\Guides\Environment —