PHP_CodeSniffer
[ class tree: PHP_CodeSniffer ] [ index: PHP_CodeSniffer ] [ all elements ]

Source for file Report.php

Documentation is available at Report.php

  1. <?php
  2. /**
  3.  * An interface that PHP_CodeSniffer reports must implement.
  4.  *
  5.  * @author    Greg Sherwood <gsherwood@squiz.net>
  6.  * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
  7.  * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
  8.  */
  9.  
  10. namespace PHP_CodeSniffer\Reports;
  11.  
  12. use PHP_CodeSniffer\Files\File;
  13.  
  14. interface Report
  15. {
  16.  
  17.  
  18.     /**
  19.      * Generate a partial report for a single processed file.
  20.      *
  21.      * Function should return TRUE if it printed or stored data about the file
  22.      * and FALSE if it ignored the file. Returning TRUE indicates that the file and
  23.      * its data should be counted in the grand totals.
  24.      *
  25.      * @param array                 $report      Prepared report data.
  26.      * @param \PHP_CodeSniffer\File $phpcsFile   The file being reported on.
  27.      * @param bool                  $showSources Show sources?
  28.      * @param int                   $width       Maximum allowed line width.
  29.      *
  30.      * @return bool 
  31.      */
  32.     public function generateFileReport($reportFile $phpcsFile$showSources=false$width=80);
  33.  
  34.  
  35.     /**
  36.      * Generate the actual report.
  37.      *
  38.      * @param string $cachedData    Any partial report data that was returned from
  39.      *                               generateFileReport during the run.
  40.      * @param int    $totalFiles    Total number of files processed during the run.
  41.      * @param int    $totalErrors   Total number of errors found during the run.
  42.      * @param int    $totalWarnings Total number of warnings found during the run.
  43.      * @param int    $totalFixable  Total number of problems that can be fixed.
  44.      * @param bool   $showSources   Show sources?
  45.      * @param int    $width         Maximum allowed line width.
  46.      * @param bool   $interactive   Are we running in interactive mode?
  47.      * @param bool   $toScreen      Is the report being printed to screen?
  48.      *
  49.      * @return void 
  50.      */
  51.     public function generate(
  52.         $cachedData,
  53.         $totalFiles,
  54.         $totalErrors,
  55.         $totalWarnings,
  56.         $totalFixable,
  57.         $showSources=false,
  58.         $width=80,
  59.         $interactive=false,
  60.         $toScreen=true
  61.     );
  62.  
  63.  
  64. }//end interface

Documentation generated on Mon, 11 Mar 2019 15:27:42 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.