tasks/ext/phpcpd/PHPCPDFormatterElement.php

Show: inherited
Table of Contents

\PHPCPDFormatterElement

Package: phing\tasks\ext\phpcpd

A wrapper for the implementations of PHPCPDResultFormatter.

Author
Benjamin Schultz  
Version
$Id: dece05e79e883b4d5e95f2215e36ce4f2f72ed2e $  

Properties

Propertyprotected\PHPCPDResultFormatter  $_formatter= 'null'

The report result formatter.

Default valuenullDetails
Type
\PHPCPDResultFormatter
Propertyprotected\PhingFile  $_outfile= 'null'

Output file for formatter.

Default valuenullDetails
Type
\PhingFile
Propertyprivate\PHPCPDTask  $_parentTask= ''

The parent task

Details
Type
\PHPCPDTask
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

methodpublic__construct( \PHPCPDTask $parentTask ) : void

Construct a new PHPCPDFormatterElement with parent task.

Parameters
Name Type Description
$parentTask \PHPCPDTask
methodpublicgetFormatter( ) : \PHPCPDResultFormatter

Returns the report formatter.

Returns
Type Description
\PHPCPDResultFormatter
Throws
Exception Description
\BuildException When the specified renderer does not exist.
methodpublicgetOutfile( ) : \PhingFile

Get the output file.

Returns
Type Description
\PhingFile
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.