Configuration

The definition for the configuration of phpDocumentor.

package

Default

Methods

Initializes all settings with their default values.

__construct() 

Returns the configuration related to which files are to be parsed.

getFiles() : \phpDocumentor\Parser\Configuration\Files

Returns the settings related to logging.

getLogging() : \phpDocumentor\Configuration\Logging

Returns the configuration used by the parser.

getParser() : \phpDocumentor\Parser\Configuration

Returns all partials that can be imported in the application.

getPartials() : array<mixed,\phpDocumentor\Partials\Partial>

Response

array<mixed,\phpDocumentor\Partials\Partial>

Returns a list of all plugins that should be loaded by the application.

getPlugins() : array<mixed,\phpDocumentor\Plugin\Plugin>

Response

array<mixed,\phpDocumentor\Plugin\Plugin>

Returns the title for the generated documentation.

getTitle() : string

Response

string

Returns which templates and custom transformations need to be applied to the parsed data.

getTransformations() : \phpDocumentor\Transformer\Configuration\Transformations

Returns the settings for the transformer.

getTransformer() : \phpDocumentor\Transformer\Configuration

Returns the settings for the translator.

getTranslator() : \phpDocumentor\Translator\Configuration

Properties

The title for the generated documentation.

title : string
var

The title for the generated documentation.

Serializer\Type

("string")

Type(s)

string

The settings used during the parsing phase.

parser : \phpDocumentor\Parser\Configuration
var

The settings used during the parsing phase.

Serializer\Type

("phpDocumentor\Parser\Configuration")

Type(s)

\phpDocumentor\Parser\Configuration

The setting used for the logging of application messages and errors.

logging : \phpDocumentor\Configuration\Logging
var

The setting used for the logging of application messages and errors.

Serializer\Type

("phpDocumentor\Configuration\Logging")

Type(s)

\phpDocumentor\Configuration\Logging

The settings used during the transformation phase.

transformer : \phpDocumentor\Transformer\Configuration
var

The settings used during the transformation phase.

Serializer\Type

("phpDocumentor\Transformer\Configuration")

Type(s)

\phpDocumentor\Transformer\Configuration

contains a list of all files and directories to parse and to ignore.

files : \phpDocumentor\Parser\Configuration\Files
var

contains a list of all files and directories to parse and to ignore.

Serializer\Type

("phpDocumentor\Parser\Configuration\Files")

Type(s)

\phpDocumentor\Parser\Configuration\Files

contains a listing of all plugins that should be loaded during startup.

plugins : array<mixed,\phpDocumentor\Plugin\Plugin>
var

contains a listing of all plugins that should be loaded during startup.

Serializer\Type

("array<phpDocumentor\Plugin\Plugin>")

Serializer\XmlList

(entry = "plugin")

Merger\Replace

Type(s)

array<mixed,\phpDocumentor\Plugin\Plugin>

contains a list of all templates and custom transformations that are to be executed during the transformation process.

transformations : array<mixed,\phpDocumentor\Transformer\Configuration\Transformations>
var

contains a list of all templates and custom transformations that are to be executed during the transformation process.

Serializer\Type

("phpDocumentor\Transformer\Configuration\Transformations")

Type(s)

array<mixed,\phpDocumentor\Transformer\Configuration\Transformations>

The settings used during translation.

translator : \phpDocumentor\Translator\Configuration
var

The settings used during translation.

Serializer\Type

("phpDocumentor\Translator\Configuration")

Type(s)

\phpDocumentor\Translator\Configuration

A list of custom texts, or references thereto, that may be injected into templates.

partials : array<mixed,\phpDocumentor\Partials\Partial>
var

A list of custom texts, or references thereto, that may be injected into templates.

Serializer\Type

("array<phpDocumentor\Partials\Partial>")

Type(s)

array<mixed,\phpDocumentor\Partials\Partial>