$serializer
$serializer : \JMS\Serializer\Serializer
Loads the template and user-defined configuration file from disk and creates a Configuration object from it.
This class will merge the template file and the user-defined configuration file together and serialize it into a
configuration object (defaults to phpDocumentor\Configuration
).
$merger : \phpDocumentor\Configuration\Merger
__construct(\JMS\Serializer\Serializer $serializer, \phpDocumentor\Configuration\Merger $merger)
Registers the dependencies with the loader.
\JMS\Serializer\Serializer | $serializer | Object used to serialize configuration files to objects. |
\phpDocumentor\Configuration\Merger | $merger | Object that merges variables, including objects. |
load(string $templatePath, string $userConfigurationPath, string $class = 'phpDocumentor\Configuration') : object
Loads the configuration from the provided paths and returns a populated configuration object.
string | $templatePath | Path to configuration file containing default settings. |
string | $userConfigurationPath | Path to a file containing user overrides. |
string | $class | The class to instantiate and populate with these options. |
createConfigurationObject(string $templatePath, string $defaultUserConfigPath, null|boolean|string $customUserConfigPath, string $class) : null|object
Combines the given configuration files and serializes a new Configuration object from them.
string | $templatePath | Path to the template configuration file. |
string | $defaultUserConfigPath | Path to the phpdoc.xml or phpdoc,dist.xml in the current working directory. |
null|boolean|string | $customUserConfigPath | Path to the user-defined config file given using the command-line. |
string | $class | Base Configuration class name to construct and populate. |