EnvironmentFactory
Table of Contents
Properties
- $extensions : iterable<string|int, mixed>
- $extensionTemplates : array
- $globalTemplatesPath : string
- $guidesTemplateBasePath : array
- $logger : LoggerInterface
- $markDownConverter : ConverterInterface
- $pathBuilder : PathBuilder
- $relativePathToRootConverter : RelativePathToRootConverter
- $renderer : LinkRenderer
- $templateOverridesAt : Path|null
Methods
- __construct() : mixed
- create() : Environment
- withTemplateOverridesAt() : void
- addPhpDocumentorExtension() : void
- Adds the phpDocumentor base extension to the Twig Environment.
- createExtensionTemplatesLoader() : FilesystemLoader|null
- enableDebug() : void
Properties
$extensions
private
iterable<string|int, mixed>
$extensions
$extensionTemplates read-only
private
array
$extensionTemplates
= []
$globalTemplatesPath read-only
private
string
$globalTemplatesPath
$guidesTemplateBasePath read-only
private
array
$guidesTemplateBasePath
$logger read-only
private
LoggerInterface
$logger
= new NullLogger()
$markDownConverter read-only
private
ConverterInterface
$markDownConverter
$pathBuilder read-only
private
PathBuilder
$pathBuilder
$relativePathToRootConverter read-only
private
RelativePathToRootConverter
$relativePathToRootConverter
$renderer read-only
private
LinkRenderer
$renderer
$templateOverridesAt
private
Path|null
$templateOverridesAt
= null
Methods
__construct()
public
__construct(LinkRenderer $renderer, ConverterInterface $markDownConverter, RelativePathToRootConverter $relativePathToRootConverter, PathBuilder $pathBuilder, iterable<string|int, ExtensionInterface> $extensions, string[] $guidesTemplateBasePath, string $globalTemplatesPath[, array<string, array{path: string, keys: string[]}> $extensionTemplates = [] ][, LoggerInterface $logger = new NullLogger() ]) : mixed
Parameters
- $renderer : LinkRenderer
- $markDownConverter : ConverterInterface
- $relativePathToRootConverter : RelativePathToRootConverter
- $pathBuilder : PathBuilder
- $extensions : iterable<string|int, ExtensionInterface>
- $guidesTemplateBasePath : string[]
-
,
- $globalTemplatesPath : string
- $extensionTemplates : array<string, array{path: string, keys: string[]}> = []
-
indexed by the alias of the extension that provides them
- $logger : LoggerInterface = new NullLogger()
create()
public
create(ProjectInterface $project, DocumentationSetInterface $documentationSet, Template $template) : Environment
Parameters
- $project : ProjectInterface
- $documentationSet : DocumentationSetInterface
- $template : Template
Return values
EnvironmentwithTemplateOverridesAt()
public
withTemplateOverridesAt(Path $path) : void
Parameters
- $path : Path
addPhpDocumentorExtension()
Adds the phpDocumentor base extension to the Twig Environment.
private
addPhpDocumentorExtension(ProjectInterface $project, DocumentationSetInterface $documentationSet, Environment $twigEnvironment) : void
Parameters
- $project : ProjectInterface
- $documentationSet : DocumentationSetInterface
- $twigEnvironment : Environment
createExtensionTemplatesLoader()
private
createExtensionTemplatesLoader() : FilesystemLoader|null
Return values
FilesystemLoader|nullenableDebug()
private
enableDebug(Environment $twigEnvironment) : void
Parameters
- $twigEnvironment : Environment