# tasks/ext/phpunit/FormatterElement.php

$Id: FormatterElement.php 794 2010-06-24 14:16:00Z mrook $

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.

## \FormatterElement
jump to top

Package: phing\tasks\ext\phpunit

A wrapper for the implementations of PHPUnit2ResultFormatter.

Children
  \SimpleTestFormatterElement
Author
  Michiel Rook
Since
  2.1.0
Version
  $Id: FormatterElement.php 794 2010-06-24 14:16:00Z mrook $

### Properties

`$formatter= 'NULL'`
Default value `NULL` Details

Type
  n/a

`$outfile= '""'`
Default value`""`Details

Type
  n/a

`$parent= 'NULL'`
Default value `NULL` Details

Type
  n/a

`$toDir= '"."'`
Default value`"."`Details

Type
  n/a

`$type= '""'`
Default value`""`Details

Type
  n/a

`$useFile= 'true'`
Default value `true` Details

Type
  n/a

### Methods

`getExtension( ) : string`

Returns extension

Returns

Type | Description
--- | ---
string |

`getFormatter( ) : \PHPUnitResultFormatter`

Returns formatter object

Returns

Type | Description
--- | ---
\PHPUnitResultFormatter |

`getOutfile( ) : string`

Returns output filename

Returns

Type | Description
--- | ---
string |

`getToDir( ) : string`

Returns output directory

Returns

Type | Description
--- | ---
string |

`getUseFile( ) : void`

Returns whether to store formatting results in a file

`setClassName( $className ) : void`

Loads a specific formatter class

Parameters

Name | Type | Description
--- | --- | ---
$className |  |

`setOutfile( string $outfile ) : void`

Sets output filename

Parameters

Name | Type | Description
--- | --- | ---
$outfile | string |

`setParent( \Task $parent ) : void`

Sets parent task

Parameters

Name | Type | Description
--- | --- | ---
$parent | \Task | Calling Task

`setToDir( string $toDir ) : void`

Sets output directory

Parameters

Name | Type | Description
--- | --- | ---
$toDir | string |

`setType( string $type ) : void`

Loads a specific formatter type

Parameters

Name | Type | Description
--- | --- | ---
$type | string |

`setUseFile( $useFile ) : void`

Sets whether to store formatting results in a file

Parameters

Name | Type | Description
--- | --- | ---
$useFile |  |

Documentation was generated by DocBlox 0.17.1.