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

Class: PHP_CodeSniffer_Reports_Summary

Source Location: /PHP_CodeSniffer-1.5.2/CodeSniffer/Reports/Summary.php

Class Overview


Summary report for PHP_CodeSniffer.


Author(s):

Version:

  • Release: 1.5.2

Copyright:

  • 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600)

Methods


Inherited Variables

Inherited Methods


Class Details

[line 32]
Summary report for PHP_CodeSniffer.

PHP version 5



[ Top ]


Method Detail

generate   [line 96]

void generate( string $cachedData, int $totalFiles, int $totalErrors, int $totalWarnings, [boolean $showSources = false], [int $width = 80], [boolean $toScreen = true])

Generates a summary of errors and warnings for each file processed.
  • Access: public

Parameters:

string   $cachedData   —  Any partial report data that was returned from generateFileReport during the run.
int   $totalFiles   —  Total number of files processed during the run.
int   $totalErrors   —  Total number of errors found during the run.
int   $totalWarnings   —  Total number of warnings found during the run.
boolean   $showSources   —  Show sources?
int   $width   —  Maximum allowed line width.
boolean   $toScreen   —  Is the report being printed to screen?

[ Top ]

generateFileReport   [line 49]

boolean generateFileReport( array $report, [boolean $showSources = false], [int $width = 80])

Generate a partial report for a single processed file.

If verbose output is enabled, results are shown for all files, even if they have no errors or warnings. If verbose output is disabled, we only show files that have at least one warning or error.

  • Access: public

Parameters:

array   $report   —  Prepared report data.
boolean   $showSources   —  Show sources?
int   $width   —  Maximum allowed line width.

[ Top ]


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