Properties
$middlewares Line 33
private$middlewares : callable[]
A series of callables that take the configuration array as parameter and should return that array or a modified version of it.
$defaultFiles Line 36
private$defaultFiles : string[]
$symfonyConfigFactory Line 39
private$symfonyConfigFactory : \phpDocumentor\Configuration\SymfonyConfigFactory
Methods
__construct() Line 46
Initializes the ConfigurationFactory.
public__construct(string[] $defaultFiles, SymfonyConfigFactory $symfonyConfigFactory) : mixed
addMiddleware() Line 55
Adds a middleware callback that allows the consumer to alter the configuration array when it is constructed.
publicaddMiddleware(callable $middleware) : void
Parameters
fromDefaultLocations() Line 63
Attempts to load a configuration from the default locations for phpDocumentor
publicfromDefaultLocations() : Configuration
createDefault() Line 76
publiccreateDefault() : Configuration
fromUri() Line 88
Converts the phpDocumentor configuration xml to an array.
publicfromUri(UriInterface $uri) : Configuration
Parameters
The location of the file to be loaded.
Throws
- \phpDocumentor\Configuration\Exception\InvalidConfigPathException
If $uri points to an inexistent file.
Returns
Configuration —
fromDefault() Line 101
publicfromDefault() : Configuration
applyMiddleware() Line 113
Applies all middleware callbacks onto the configuration.
privateapplyMiddleware(array$configuration, UriInterface|null $uri) : array