phpDocumentor

Version3 implements ConfigurationInterface, Normalizable

FinalYes
Tags
psalm-type

BaseConfiguration = array

ConfigurationApiMap = array{ ignore-tags: list, extensions: non-empty-array, markers: list, visibility: non-empty-array, source: array{dsn: Dsn, paths: array<array-key, Path>}, ignore: array{ hidden: bool, symlinks: bool, paths: list }, ignore-tags: list, encoding: string, output: string, format: string, default-package-name: string, examples?: array{dsn: string, paths: array}, include-source: bool, validate: bool, visibility: non-empty-array<array-key, string>, ignore-packages: bool }

ConfigurationMap = array{ configVersion: string, title?: string, paths: array{output: Dsn, cache: Path}, versions: array< string, array{ number: string, folder: string, api: list<ConfigurationApiMap>, guides: list< array{ source: array{dsn: Dsn, paths: array<array-key, Path>}, output: string, format: string, } > } >, use_cache: bool, settings: array<string, mixed>, extensions: array<string, mixed>, templates: non-empty-array< array{ name: string, location: ?Path, parameters: array<string, mixed> } > }

Table of Contents

Interfaces

ConfigurationInterface
Normalizable

Properties

$defaultTemplateName  : string

Methods

__construct()  : mixed
getConfigTreeBuilder()  : TreeBuilder
normalize()  : array
apiSection()  : ArrayNodeDefinition
guideSection()  : ArrayNodeDefinition
paths()  : ArrayNodeDefinition
source()  : ArrayNodeDefinition

Properties

$defaultTemplateName read-only

private string $defaultTemplateName

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

Methods

__construct()

public __construct(string $defaultTemplateName) : mixed
Parameters
$defaultTemplateName : string

getConfigTreeBuilder()

public getConfigTreeBuilder() : TreeBuilder
Return values
TreeBuilder

normalize()

public normalize(array $configuration) : array
Parameters
$configuration : array
Return values
array

apiSection()

private apiSection() : ArrayNodeDefinition
Return values
ArrayNodeDefinition

guideSection()

private guideSection() : ArrayNodeDefinition
Return values
ArrayNodeDefinition

paths()

private paths([string[] $defaultValue = [] ]) : ArrayNodeDefinition
Parameters
$defaultValue : string[] = []
Return values
ArrayNodeDefinition

source()

private source([string[] $defaultPaths = [] ]) : ArrayNodeDefinition
Parameters
$defaultPaths : string[] = []
Return values
ArrayNodeDefinition 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results