tasks/ext/phpmd/PHPMDFormatterElement.php

Show: inherited
Table of Contents

\PHPMDFormatterElement

Package: phing\tasks\ext\phpmd

A wrapper for the implementations of PHPMDResultFormatter.

Author
Benjamin Schultz  
Since
2.4.1  
Version
$Id: 69fc758899446b96312ac12f26b461969eb41b6e $  

Properties

Propertyprotected\PHPMDResultFormatter  $formatter= 'null'

Default valuenullDetails
Type
\PHPMDResultFormatter
Propertyprotected\PhingFile  $outfile= 'null'

Output file for formatter.

Default valuenullDetails
Type
\PhingFile
Propertyprotectedstring  $type= '""'

The type of the formatter.

Default value""Details
Type
string
Propertyprotectedboolean  $useFile= 'true'

Whether to use file (or write output to phing log).

Default valuetrueDetails
Type
boolean

Methods

methodpublicgetOutfile( ) : \PhingFile

Get the output file.

Returns
Type Description
\PhingFile
methodpublicgetRenderer( ) : \PHP_PMD_AbstractRenderer

Creates a report renderer instance based on the formatter type.

Returns
Type Description
\PHP_PMD_AbstractRenderer
Throws
Exception Description
\BuildException When the specified renderer does not exist.
methodpublicgetType( ) : string

Get the formatter type

Returns
Type Description
string
methodpublicgetUseFile( ) : boolean

Return whether to write formatter results to file or not.

Returns
Type Description
boolean
methodpublicsetOutfile( \PhingFile $outfile ) : void

Sets the output file for the formatter results.

Parameters
Name Type Description
$outfile \PhingFile

The output file

methodpublicsetType( string $type ) : void

Sets the formatter type.

Parameters
Name Type Description
$type string

Type of the formatter

methodpublicsetUseFile( boolean $useFile ) : void

Set whether to write formatter results to file or not.

Parameters
Name Type Description
$useFile boolean

True or false.

Documentation was generated by DocBlox 0.18.1.