phpDocumentor

ConfigurationFactory
in package

The ConfigurationFactory converts the configuration xml from a Uri into an array.

Tags
psalm-import-type

ConfigurationMap from Version3 as Version3ConfigurationMap

psalm-type

ConfigurationMap = array{ phpdocumentor: Version3ConfigurationMap }

Table of Contents

$defaultFiles  : array<string|int, string>
$middlewares  : array<int, MiddlewareInterface>
A series of callables that take the configuration array as parameter and should return that array or a modified version of it.
$symfonyConfigFactory  : SymfonyConfigFactory
__construct()  : mixed
Initializes the ConfigurationFactory.
addMiddleware()  : void
Adds a middleware callback that allows the consumer to alter the configuration array when it is constructed.
createDefault()  : Configuration
fromDefault()  : Configuration
fromDefaultLocations()  : Configuration
Attempts to load a configuration from the default locations for phpDocumentor
fromUri()  : Configuration
Converts the phpDocumentor configuration xml to an array.
applyMiddleware()  : Configuration
Applies all middleware callbacks onto the configuration.
createConfigurationFromArray()  : Configuration

Properties

$middlewares

A series of callables that take the configuration array as parameter and should return that array or a modified version of it.

private array<int, MiddlewareInterface> $middlewares = []
Tags

Methods

__construct()

Initializes the ConfigurationFactory.

public __construct(array<string|int, string> $defaultFiles, SymfonyConfigFactory $symfonyConfigFactory) : mixed
Parameters
$defaultFiles : array<string|int, string>
$symfonyConfigFactory : SymfonyConfigFactory
Tags
Return values
mixed

        

Search results