tasks/ext/phpmd/PHPMDFormatterElement.php
Show:
inherited
inherited
Classes
\PHPMDFormatterElement
Package: phing\tasks\ext\phpmd
A wrapper for the implementations of PHPMDResultFormatter.
- Author
- Benjamin Schultz
- Since
- 2.4.1
- Version
- $Id: 69fc758899446b96312ac12f26b461969eb41b6e $
Properties
\PHPMDResultFormatter
$formatter= 'null'
Default value
nullDetails- Type
- \PHPMDResultFormatter
string
$type= '""'
The type of the formatter.
Default value
""Details- Type
- string
boolean
$useFile= 'true'
Whether to use file (or write output to phing log).
Default value
trueDetails- Type
- boolean
Methods
getRenderer(
)
:
\PHP_PMD_AbstractRendererCreates a report renderer instance based on the formatter type.
Returns
Throws
| Type | Description |
|---|---|
| \PHP_PMD_AbstractRenderer |
| Exception | Description |
|---|---|
| \BuildException | When the specified renderer does not exist. |
getType(
)
:
stringGet the formatter type
Returns
| Type | Description |
|---|---|
| string |
getUseFile(
)
:
booleanReturn whether to write formatter results to file or not.
Returns
| Type | Description |
|---|---|
| boolean |
setOutfile(
\PhingFile $outfile
)
:
voidSets the output file for the formatter results.
Parameters
| Name | Type | Description |
|---|---|---|
| $outfile | \PhingFile | The output file |
setType(
string $type
)
:
voidSets the formatter type.
Parameters
| Name | Type | Description |
|---|---|---|
| $type | string | Type of the formatter |
setUseFile(
boolean $useFile
)
:
voidSet whether to write formatter results to file or not.
Parameters
| Name | Type | Description |
|---|---|---|
| $useFile | boolean | True or false. |