\phpDocumentor\Transformer\Writer\TwigEnvironmentFactory

Summary

Methods
Properties
Constants
__construct()
withTemplateOverridesAt()
create()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
addPhpDocumentorExtension()
enableDebug()
$renderer
$templateOverridesAt
$markDownConverter
N/A

Properties

$renderer

$renderer : \phpDocumentor\Transformer\Writer\Twig\LinkRenderer

Type

LinkRenderer

$templateOverridesAt

$templateOverridesAt : ?\phpDocumentor\Path

Type

Path

$markDownConverter

$markDownConverter : \League\CommonMark\MarkdownConverterInterface

Type

\League\CommonMark\MarkdownConverterInterface —

Methods

__construct()

__construct(\phpDocumentor\Transformer\Writer\Twig\LinkRenderer  $renderer, \League\CommonMark\MarkdownConverterInterface  $markDownConverter) : mixed

Parameters

\phpDocumentor\Transformer\Writer\Twig\LinkRenderer $renderer
\League\CommonMark\MarkdownConverterInterface $markDownConverter

Returns

mixed —

withTemplateOverridesAt()

withTemplateOverridesAt(\phpDocumentor\Path  $path) : void

Parameters

\phpDocumentor\Path $path

create()

create(\phpDocumentor\Descriptor\ProjectDescriptor  $project, \phpDocumentor\Transformer\Template  $template) : \Twig\Environment

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $project
\phpDocumentor\Transformer\Template $template

Returns

\Twig\Environment —

addPhpDocumentorExtension()

addPhpDocumentorExtension(\phpDocumentor\Descriptor\ProjectDescriptor  $project, \Twig\Environment  $twigEnvironment) : void

Adds the phpDocumentor base extension to the Twig Environment.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $project
\Twig\Environment $twigEnvironment

enableDebug()

enableDebug(\Twig\Environment  $twigEnvironment) : void

Parameters

\Twig\Environment $twigEnvironment