Chris@0: <?php
Chris@0: /**
Chris@0:  * Represents a PHP_CodeSniffer report.
Chris@0:  *
Chris@0:  * PHP version 5.
Chris@0:  *
Chris@0:  * @category  PHP
Chris@0:  * @package   PHP_CodeSniffer
Chris@0:  * @author    Gabriele Santini <gsantini@sqli.com>
Chris@0:  * @author    Greg Sherwood <gsherwood@squiz.net>
Chris@0:  * @copyright 2009-2014 SQLI <www.sqli.com>
Chris@0:  * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Chris@0:  * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
Chris@0:  * @link      http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * Represents a PHP_CodeSniffer report.
Chris@0:  *
Chris@0:  * @category  PHP
Chris@0:  * @package   PHP_CodeSniffer
Chris@0:  * @author    Gabriele Santini <gsantini@sqli.com>
Chris@0:  * @author    Greg Sherwood <gsherwood@squiz.net>
Chris@0:  * @copyright 2009-2014 SQLI <www.sqli.com>
Chris@0:  * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Chris@0:  * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
Chris@0:  * @version   Release: @package_version@
Chris@0:  * @link      http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: interface PHP_CodeSniffer_Report
Chris@0: {
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Generate a partial report for a single processed file.
Chris@0:      *
Chris@0:      * Function should return TRUE if it printed or stored data about the file
Chris@0:      * and FALSE if it ignored the file. Returning TRUE indicates that the file and
Chris@0:      * its data should be counted in the grand totals.
Chris@0:      *
Chris@0:      * @param array                $report      Prepared report data.
Chris@0:      * @param PHP_CodeSniffer_File $phpcsFile   The file being reported on.
Chris@0:      * @param boolean              $showSources Show sources?
Chris@0:      * @param int                  $width       Maximum allowed line width.
Chris@0:      *
Chris@0:      * @return boolean
Chris@0:      */
Chris@0:     public function generateFileReport(
Chris@0:         $report,
Chris@0:         PHP_CodeSniffer_File $phpcsFile,
Chris@0:         $showSources=false,
Chris@0:         $width=80
Chris@0:     );
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Generate the actual report.
Chris@0:      *
Chris@0:      * @param string  $cachedData    Any partial report data that was returned from
Chris@0:      *                               generateFileReport during the run.
Chris@0:      * @param int     $totalFiles    Total number of files processed during the run.
Chris@0:      * @param int     $totalErrors   Total number of errors found during the run.
Chris@0:      * @param int     $totalWarnings Total number of warnings found during the run.
Chris@0:      * @param int     $totalFixable  Total number of problems that can be fixed.
Chris@0:      * @param boolean $showSources   Show sources?
Chris@0:      * @param int     $width         Maximum allowed line width.
Chris@0:      * @param boolean $toScreen      Is the report being printed to screen?
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public function generate(
Chris@0:         $cachedData,
Chris@0:         $totalFiles,
Chris@0:         $totalErrors,
Chris@0:         $totalWarnings,
Chris@0:         $totalFixable,
Chris@0:         $showSources=false,
Chris@0:         $width=80,
Chris@0:         $toScreen=true
Chris@0:     );
Chris@0: 
Chris@0: 
Chris@0: }//end interface