tasks/ext/phpcpd/PHPCPDFormatterElement.php
Show:
inherited
inherited
Classes
\PHPCPDFormatterElement
Package: phing\tasks\ext\phpcpd
A wrapper for the implementations of PHPCPDResultFormatter.
- Author
- Benjamin Schultz
- Version
- $Id: dece05e79e883b4d5e95f2215e36ce4f2f72ed2e $
Properties
\PHPCPDResultFormatter
$_formatter= 'null'
The report result formatter.
Default value
nullDetails
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
__construct(
\PHPCPDTask $parentTask
)
:
voidConstruct a new PHPCPDFormatterElement with parent task.
Parameters
| Name | Type | Description |
|---|---|---|
| $parentTask | \PHPCPDTask |
getFormatter(
)
:
\PHPCPDResultFormatterReturns the report formatter.
Returns
Throws
| Type | Description |
|---|---|
| \PHPCPDResultFormatter |
| 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. |