ConfigurationFactory

in package

Properties

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.

private$defaultFiles  : string[]                

private$symfonyConfigFactory  : \phpDocumentor\Configuration\SymfonyConfigFactory                

Methods

Initializes the ConfigurationFactory.

public__construct(string[] $defaultFiles, SymfonyConfigFactory $symfonyConfigFactory) : mixed

Parameters

$defaultFiles : string[]
$symfonyConfigFactory : SymfonyConfigFactory

Returns

mixed

Adds a middleware callback that allows the consumer to alter the configuration array when it is constructed.

publicaddMiddleware(callable $middleware) : void

Parameters

$middleware : callable

Attempts to load a configuration from the default locations for phpDocumentor

publicfromDefaultLocations() : Configuration

Returns

Configuration

Returns

Configuration

Converts the phpDocumentor configuration xml to an array.

publicfromUri(UriInterface $uri) : Configuration

Parameters

$uri : UriInterface

The location of the file to be loaded.

Throws

\phpDocumentor\Configuration\Exception\InvalidConfigPathException

If $uri points to an inexistent file.

Returns

Configuration

Returns

Configuration

Applies all middleware callbacks onto the configuration.

privateapplyMiddleware(array $configuration, UriInterface|null $uri) : array

Parameters

$configuration : array
$uri : UriInterface|null

Returns

array