\phpDocumentor\Configuration\DefinitionVersion2

Summary

Methods
Properties
Constants
__construct()
getConfigTreeBuilder()
upgrade()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
convertSingleStarPathEndingIntoGlobPattern()
$defaultTemplateName
N/A

Properties

$defaultTemplateName

$defaultTemplateName : string

Type

string — This is injected so that the name of the default template can be defined globally in the app

Methods

__construct()

__construct(string  $defaultTemplateName) : mixed

Parameters

string $defaultTemplateName

Returns

mixed —

getConfigTreeBuilder()

getConfigTreeBuilder() : \Symfony\Component\Config\Definition\Builder\TreeBuilder

Returns

\Symfony\Component\Config\Definition\Builder\TreeBuilder —

upgrade()

upgrade(array  $values) : array

Upgrades the version 2 configuration to the version 3 configuration.

Parameters

array $values

Returns

array —

convertSingleStarPathEndingIntoGlobPattern()

convertSingleStarPathEndingIntoGlobPattern(string  $path) : string

Make a `/*` ending backwards compatible for v2.

In phpDocumentor 3 we started adopting the glob pattern with globstar extension to properly define patterns matching file paths. This is incompatible with phpDocumentor 2, that interpreted a * to mean any number of characters, including the path separator.

To ensure this behaviour is properly translated, this method will detect if a path ends with /*, and if it is not a globstar pattern, we convert it to one. This matches the behaviour in phpDocumentor 2 without user interaction.

Parameters

string $path

Returns

string —