ApplicationExtension extends Extension implements PrependExtensionInterface
Table of Contents
Interfaces
- PrependExtensionInterface
Constants
- DEFAULT_CONFIG_FILES : mixed = ['phpdoc.xml', 'phpdoc.dist.xml', 'phpdoc.xml.d...
- The six candidate filenames that phpDocumentor looks for by default, in order of preference.
Properties
- $configFile : string|null
Methods
- __construct() : mixed
- load() : void
- prepend() : void
- createSymfonyConfigFactory() : SymfonyConfigFactory
- Builds a SymfonyConfigFactory instance that can be used before the DI container is available. Version2 and Version3 are plain PHP objects and can be instantiated directly. The template name is set to the same constant default used by {@see Configuration}; the actual runtime default is resolved later by the service-layer ConfigurationFactory.
- hasMarkdownGuides() : bool
- Returns true when at least one guide entry in any version uses the Markdown format.
- resolveConfigFile() : string|null
- Returns the absolute path to the configuration file to use.
Constants
DEFAULT_CONFIG_FILES
The six candidate filenames that phpDocumentor looks for by default, in order of preference.
private
mixed
DEFAULT_CONFIG_FILES
= ['phpdoc.xml', 'phpdoc.dist.xml', 'phpdoc.xml.dist', '.phpdoc.xml.dist', '.phpdoc.xml', '.phpdoc.dist.xml']
Properties
$configFile read-only
private
string|null
$configFile
= null
Methods
__construct()
public
__construct([string|null $configFile = null ]) : mixed
Parameters
- $configFile : string|null = null
-
Absolute path to the configuration file passed via --config/-c on the command line. When null the extension searches the default file candidates in the current working directory.
load()
public
load(array<string|int, mixed> $configs, ContainerBuilder $container) : void
Parameters
- $configs : array<string|int, mixed>
- $container : ContainerBuilder
prepend()
public
prepend(ContainerBuilder $container) : void
Parameters
- $container : ContainerBuilder
createSymfonyConfigFactory()
Builds a SymfonyConfigFactory instance that can be used before the DI container is available. Version2 and Version3 are plain PHP objects and can be instantiated directly. The template name is set to the same constant default used by {@see Configuration}; the actual runtime default is resolved later by the service-layer ConfigurationFactory.
private
createSymfonyConfigFactory() : SymfonyConfigFactory
Return values
SymfonyConfigFactoryhasMarkdownGuides()
Returns true when at least one guide entry in any version uses the Markdown format.
private
hasMarkdownGuides(array<string|int, mixed> $phpdocConfig) : bool
Parameters
- $phpdocConfig : array<string|int, mixed>
-
The parsed phpdocumentor config array (without the outer 'phpdocumentor' key).
Return values
boolresolveConfigFile()
Returns the absolute path to the configuration file to use.
private
resolveConfigFile() : string|null
Uses the explicit --config path when provided, otherwise searches the default candidate filenames in the current working directory.