phpDocumentor

ProvideTemplateOverridePathMiddleware
in package
implements MiddlewareInterface

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.

Interfaces, Classes and Traits

MiddlewareInterface

Table of Contents

PATH_TO_TEMPLATE_OVERRIDES  = '.phpdoc/template'
$environmentFactory  : EnvironmentFactory
__construct()  : mixed
__invoke()  : array<string|int, mixed>
normalizePath()  : Path

Constants

Properties

Methods

__invoke()

public __invoke(array<string|int, mixed> $configuration[, UriInterface|null $pathOfConfigFile = null ]) : array<string|int, mixed>
Parameters
$configuration : array<string|int, mixed>
$pathOfConfigFile : UriInterface|null = null
Return values
array<string|int, mixed>

Search results