\phpDocumentor\TransformerConfiguration

Configuration definition for the transformer.

Summary

Methods
Properties
Constants
getSource()
setSource()
getTarget()
getExternalClassDocumentation()
setExternalClassDocumentation()
No public properties found
No constants found
No protected methods found
$source
$target
$externalClassDocumentation
N/A
No private methods found
No private properties found
N/A

Properties

$source

$source : string|null

Type

string|null — the location of the product created by the Parser that is used as input for the transformation process, or when null the transformer will determine the location by reading the parser's `target` setting.

$target

$target : string

Type

string — destination location for the transformer's output

$externalClassDocumentation

$externalClassDocumentation : array<mixed,\phpDocumentor\Transformer\Configuration\ExternalClassDocumentation>

Type

array<mixed,\phpDocumentor\Transformer\Configuration\ExternalClassDocumentation> — A series of references to external API documentation sites where classes with a specific prefix can link to.

Methods

getSource()

getSource() : string|null

Returns the location where the output of the parser is located.

Returns

string|null

setSource()

setSource(string  $source) : void

Set the source location where the parser's output can be found.

This might, for example, be used in the Run command to read the parser's output location from the target setting in the configuration of the parser and then, by using this method, be set.

Parameters

string $source

getTarget()

getTarget() : string

Returns the destination location where the output of the transformation process should be written to.

Returns

string

getExternalClassDocumentation()

getExternalClassDocumentation() : array<mixed,\phpDocumentor\Transformer\Configuration\ExternalClassDocumentation>

Returns the references to external documentation sites for classes not found in the parsed contents.

Returns

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

setExternalClassDocumentation()

setExternalClassDocumentation(array<mixed,\phpDocumentor\Transformer\Configuration\ExternalClassDocumentation>  $externalClassDocumentation) : void

Sets references to external documentation sites for classes not found in the parsed contents.

Parameters

array<mixed,\phpDocumentor\Transformer\Configuration\ExternalClassDocumentation> $externalClassDocumentation