\phpDocumentor\ConfigurationProvideTemplateOverridePathMiddleware

Determines the path where the general template overrides are.

Since phpDocumentor 3, we now have the feature that in the subfolder '.phpdoc/template' relative to where your configuration file resides you can add twig templates with the same name as those used in a template. When you do this, that file will be used instead of the one in the template, and you can customize rendering this way.

This configuration middleware is responsible for finding the path where these overrides are, and adding this to the Twig Environment Factory so that it can be added as a template source once the Twig Environment is created.

Summary

Methods
Properties
Constants
__construct()
__invoke()
No public properties found
PATH_TO_TEMPLATE_OVERRIDES
No protected methods found
No protected properties found
N/A
normalizePath()
$environmentFactory
N/A

Constants

PATH_TO_TEMPLATE_OVERRIDES

PATH_TO_TEMPLATE_OVERRIDES = '.phpdoc/template'

Properties

$environmentFactory

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

Type

EnvironmentFactory

Methods

__construct()

__construct(\phpDocumentor\Transformer\Writer\Twig\EnvironmentFactory  $environmentFactory) : mixed

Parameters

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

Returns

mixed —

__invoke()

__invoke(\phpDocumentor\Configuration\Configuration  $configuration, ?\League\Uri\Contracts\UriInterface  $pathOfConfigFile = null) : \phpDocumentor\Configuration\Configuration

Parameters

\phpDocumentor\Configuration\Configuration $configuration
?\League\Uri\Contracts\UriInterface $pathOfConfigFile

Returns

\phpDocumentor\Configuration\Configuration —

normalizePath()

normalizePath(?\League\Uri\Contracts\UriInterface  $uri, \phpDocumentor\Path  $path) : \phpDocumentor\Path

Parameters

?\League\Uri\Contracts\UriInterface $uri
\phpDocumentor\Path $path

Returns

\phpDocumentor\Path —