classes/phing/tasks/ext/phpcpd/PHPCPDFormatterElement.php
Classes
\PHPCPDFormatterElement
A wrapper for the implementations of PHPCPDResultFormatter.
- author
- Benjamin Schultz
- package
- phing.tasks.ext.phpcpd
- version
- $Id: PHPCPDFormatterElement.php 728 2010-02-13 23:21:51Z bschultz $
Properties
\PHPCPDResultFormatter
$_formatter= 'null'
The report result formatter.
\PhingFile
$_outfile= 'null'
Output file for formatter.
nullDetails- Type
- \PhingFile
\PHPCPDTask
$_parentTask= ''
The parent task
- Type
- \PHPCPDTask
string
$_type= ''
The type of the formatter.
- Type
- string
boolean
$_useFile= 'true'
Whether to use file (or write output to phing log).
trueDetails- Type
- boolean
Methods
__construct(
\PHPCPDTask $parentTask
)
:
Construct a new PHPCPDFormatterElement with parent task.
| Name | Type | Description |
|---|---|---|
| $parentTask | \PHPCPDTask |
getFormatter(
)
:
\PHPCPDResultFormatterReturns the report formatter.
| Type | Description |
|---|---|
| \PHPCPDResultFormatter |
- throws
- When the specified renderer does not exist.
getOutfile(
)
:
\PhingFileGet the output file.
| Type | Description |
|---|---|
| \PhingFile |
getType(
)
:
stringGet the formatter type
| Type | Description |
|---|---|
| string |
getUseFile(
)
:
booleanReturn whether to write formatter results to file or not.
| Type | Description |
|---|---|
| boolean |
setOutfile(
\PhingFile $outfile
)
:
voidSets the output file for the formatter results.
| Name | Type | Description |
|---|---|---|
| $outfile | \PhingFile | The output file |
setType(
string $type
)
:
voidSets the formatter type.
| Name | Type | Description |
|---|---|---|
| $type | string | Type of the formatter |
setUseFile(
boolean $useFile
)
:
voidSet whether to write formatter results to file or not.
| Name | Type | Description |
|---|---|---|
| $useFile | boolean | True or false. |