tasks/ext/phpunit/PHPUnitReportTask.php

Show: inherited
Table of Contents

$Id: PHPUnitReportTask.php 1387 2011-12-10 11:05:25Z 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.

\PHPUnitReportTask

Package: phing\tasks\ext\phpunit

Transform a PHPUnit xml report using XSLT.

This transformation generates an html report in either framed or non-framed style. The non-framed style is convenient to have a concise report via mail, the framed report is much more convenient if you want to browse into different packages or testcases since it is a Javadoc like report.

Parent(s)
\Task < \ProjectComponent
Author
Michiel Rook  
Since
2.1.0  
Version
$Id: PHPUnitReportTask.php 1387 2011-12-10 11:05:25Z mrook $  

Properties

Propertyprivate  $format= '"noframes"'
Default value"noframes"Details
Type
n/a
Propertyprivate  $inFile= '"testsuites.xml"'

the directory where the results XML can be found

Default value"testsuites.xml"Details
Type
n/a
Propertyprivate  $styleDir= '""'
Default value""Details
Type
n/a
Propertyprivate  $toDir= '""'
Default value""Details
Type
n/a
Propertyprivateboolean  $useSortTable= 'false'

Whether to use the sorttable JavaScript library, defaults to false See {@link http://www.kryogenix.org/code/browser/sorttable/)}

Default valuefalseDetails
Type
boolean

Methods

methodprotectedfixDocument(  $document ) : void

Fixes DOM document tree: - adds package="default" to 'testsuite' elements without package attribute - removes outer 'testsuite' container(s)

Parameters
Name Type Description
$document
methodpublicgetDescription( ) : void

methodpublicgetLocation( ) : void

methodpublicgetOwningTarget( ) : void

methodpublicgetProject( ) : void

methodprotectedgetRegisterSlot( ) : void

methodpublicgetRuntimeConfigurableWrapper( ) : void

methodprotectedgetStyleSheet( ) : void

Returns the path to the XSL stylesheet

methodpublicgetTaskName( ) : void

methodpublicgetTaskType( ) : void

methodpublicinit( ) : void

Initialize the task

methodpubliclog( ) : void

methodpublicmain( ) : void

The main entry point

Throws
Exception Description
\BuildException
methodpublicmaybeConfigure( ) : void

methodpublicperform( ) : void

methodpublicsetDescription( ) : void

methodpublicsetFormat(  $format ) : void

Set the format of the generated report. Must be noframes or frames.

Parameters
Name Type Description
$format
methodpublicsetInFile(  $inFile ) : void

Set the filename of the XML results file to use.

Parameters
Name Type Description
$inFile
methodpublicsetLocation( ) : void

methodpublicsetOwningTarget( ) : void

methodpublicsetProject( ) : void

methodpublicsetRuntimeConfigurableWrapper( ) : void

methodpublicsetStyleDir(  $styleDir ) : void

Set the directory where the stylesheets are located.

Parameters
Name Type Description
$styleDir
methodpublicsetTaskName( ) : void

methodpublicsetTaskType( ) : void

methodpublicsetToDir(  $toDir ) : void

Set the directory where the files resulting from the transformation should be written to.

Parameters
Name Type Description
$toDir
methodpublicsetUseSortTable( boolean $useSortTable ) : void

Sets whether to use the sorttable JavaScript library, defaults to false See {@link http://www.kryogenix.org/code/browser/sorttable/)}

Parameters
Name Type Description
$useSortTable boolean
methodprotectedtransform(  $document ) : void

Transforms the DOM document

Parameters
Name Type Description
$document
Documentation was generated by DocBlox 0.17.1.