tasks/ext/phpcpd/PHPCPDFormatterElement.php
inherited
Classes
$Id: PHPCPDFormatterElement.php 728 2010-02-13 23:21:51Z bschultz $
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals and is licensed under the LGPL. For more information please see http://phing.info.
\PHPCPDFormatterElement
A wrapper for the implementations of PHPCPDResultFormatter.
- Author
- Benjamin Schultz
- Version
- $Id: PHPCPDFormatterElement.php 728 2010-02-13 23:21:51Z bschultz $
Properties
\PHPCPDResultFormatter
$_formatter= 'null'
The report result formatter.
nullDetails
string
$_type= ''''
The type of the formatter.
''Details- Type
- string
boolean
$_useFile= 'true'
Whether to use file (or write output to phing log).
trueDetails- Type
- boolean
Methods
__construct(
\PHPCPDTask $parentTask
)
:
voidConstruct a new PHPCPDFormatterElement with parent task.
| Name | Type | Description |
|---|---|---|
| $parentTask | \PHPCPDTask |
getFormatter(
)
:
\PHPCPDResultFormatterReturns the report formatter.
| Type | Description |
|---|---|
| \PHPCPDResultFormatter |
| Exception | Description |
|---|---|
| \BuildException | When the specified renderer does not exist. |
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. |