Viewing file:  PHPCPDFormatterElement.php (4.43 KB) -rw-rw-rw-
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* $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>.
*/
require_once 'phing/system/io/PhingFile.php';
/**
* A wrapper for the implementations of PHPCPDResultFormatter.
*
* @package phing.tasks.ext.phpcpd
* @author Benjamin Schultz <bschultz@proqrent.de>
* @version $Id: PHPCPDFormatterElement.php 728 2010-02-13 23:21:51Z bschultz $
*/
class PHPCPDFormatterElement
{
/**
* The report result formatter.
*
* @var PHPCPDResultFormatter
*/
protected $_formatter = null;
/**
* The type of the formatter.
*
* @var string
*/
protected $_type = '';
/**
* Whether to use file (or write output to phing log).
*
* @var boolean
*/
protected $_useFile = true;
/**
* Output file for formatter.
*
* @var PhingFile
*/
protected $_outfile = null;
/**
* The parent task
*
* @var PHPCPDTask
*/
private $_parentTask;
/**
* Construct a new PHPCPDFormatterElement with parent task.
* @param PHPCPDTask $parentTask
*/
public function __construct(PHPCPDTask $parentTask)
{
$this->_parentTask = $parentTask;
}
/**
* Sets the formatter type.
*
* @param string $type Type of the formatter
*
* @return void
*/
public function setType($type)
{
$this->_type = $type;
switch ($this->_type) {
case 'pmd':
if ($this->_useFile === false) {
throw new BuildException(
"Formatter '" . $this->_type
. "' can only print the result to an file"
);
}
include_once 'phing/tasks/ext/phpcpd/formatter/PMDPHPCPDResultFormatter.php';
$this->_formatter = new PMDPHPCPDResultFormatter();
break;
case 'default':
include_once 'phing/tasks/ext/phpcpd/formatter/DefaultPHPCPDResultFormatter.php';
$this->_formatter = new DefaultPHPCPDResultFormatter();
break;
default:
throw new BuildException(
"Formatter '" . $this->_type . "' not implemented"
);
}
}
/**
* Get the formatter type
*
* @return string
*/
public function getType()
{
return $this->_type;
}
/**
* Set whether to write formatter results to file or not.
*
* @param boolean $useFile True or false.
*
* @return void
*/
public function setUseFile($useFile)
{
$this->_useFile = StringHelper::booleanValue($useFile);
}
/**
* Return whether to write formatter results to file or not.
*
* @return boolean
*/
public function getUseFile()
{
return $this->_useFile;
}
/**
* Sets the output file for the formatter results.
*
* @param PhingFile $outfile The output file
*
* @return void
*/
public function setOutfile(PhingFile $outfile)
{
$this->_outfile = $outfile;
}
/**
* Get the output file.
*
* @return PhingFile
*/
public function getOutfile()
{
return $this->_outfile;
}
/**
* Returns the report formatter.
*
* @throws BuildException When the specified renderer does not exist.
* @return PHPCPDResultFormatter
*/
public function getFormatter()
{
return $this->_formatter;
}
}
|