\phpDocumentor\GuidesRenderer

Summary

Methods
Properties
Constants
__construct()
initialize()
render()
setDestination()
setGuidesEnvironment()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$environmentFactory
$templateRenderer
$environment
$logger
$plantumlRenderer
N/A

Properties

$environmentFactory

$environmentFactory : \phpDocumentor\Transformer\Writer\Twig\EnvironmentFactory

Type

EnvironmentFactory

$templateRenderer

$templateRenderer : \phpDocumentor\Guides\TemplateRenderer|null

Type

TemplateRenderer|null

$logger

$logger : \Psr\Log\LoggerInterface

Type

\Psr\Log\LoggerInterface —

$plantumlRenderer

$plantumlRenderer : \phpDocumentor\Transformer\Writer\Graph\PlantumlRenderer

Type

PlantumlRenderer

Methods

__construct()

__construct(\phpDocumentor\Transformer\Writer\Twig\EnvironmentFactory  $environmentFactory, \Psr\Log\LoggerInterface  $logger, \phpDocumentor\Transformer\Writer\Graph\PlantumlRenderer  $plantumlRenderer) : mixed

Parameters

\phpDocumentor\Transformer\Writer\Twig\EnvironmentFactory $environmentFactory
\Psr\Log\LoggerInterface $logger
\phpDocumentor\Transformer\Writer\Graph\PlantumlRenderer $plantumlRenderer

Returns

mixed —

initialize()

initialize(\phpDocumentor\Descriptor\ProjectDescriptor  $project, \phpDocumentor\Descriptor\DocumentationSetDescriptor  $documentationSet, \phpDocumentor\Transformer\Transformation  $transformation) : void

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $project
\phpDocumentor\Descriptor\DocumentationSetDescriptor $documentationSet
\phpDocumentor\Transformer\Transformation $transformation

render()

render(string  $template, array<string,mixed>  $context = []) : string

Parameters

string $template
array $context

Returns

string —

setDestination()

setDestination(string  $destination) : void

Parameters

string $destination

setGuidesEnvironment()

setGuidesEnvironment(\phpDocumentor\Guides\Environment  $environment) : void

Parameters

\phpDocumentor\Guides\Environment $environment