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

Class: PHP_CodeSniffer_Reporting

Source Location: /PHP_CodeSniffer-1.5.2/CodeSniffer/Reporting.php

Class Overview


A class to manage reporting.


Author(s):

Version:

  • Release: 1.5.2

Copyright:

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

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 36]
A class to manage reporting.


[ Top ]


Class Variables

$totalErrors =  0

[line 51]

Total number of errors found during the run.
  • Access: public

Type:   int


[ Top ]

$totalFiles =  0

[line 44]

Total number of files that contain errors or warnings.
  • Access: public

Type:   int


[ Top ]

$totalWarnings =  0

[line 58]

Total number of warnings found during the run.
  • Access: public

Type:   int


[ Top ]



Method Detail

cacheFileReport   [line 115]

void cacheFileReport( PHP_CodeSniffer_File $phpcsFile, array $cliValues)

Actually generates the report.
  • Access: public

Parameters:

PHP_CodeSniffer_File   $phpcsFile   —  The file that has been processed.
array   $cliValues   —  An array of command line arguments.

[ Top ]

factory   [line 83]

PHP_CodeSniffer_Report factory( string $type)

Produce the appropriate report object based on $type parameter.
  • Throws: PHP_CodeSniffer_Exception If report is not available.
  • Access: public

Parameters:

string   $type   —  The type of the report.

[ Top ]

prepareFileReport   [line 237]

array prepareFileReport( PHP_CodeSniffer_File $phpcsFile)

Pre-process and package violations for all files.

Used by error reports to get a packaged list of all errors in each file.

  • Access: public

Parameters:

PHP_CodeSniffer_File   $phpcsFile   —  The file that has been processed.

[ Top ]

printReport   [line 176]

integer printReport( string $report, boolean $showSources, [string $reportFile = ''], [integer $reportWidth = 80])

Actually generates the report.
  • Access: public

Parameters:

string   $report   —  Report type.
boolean   $showSources   —  Show sources?
string   $reportFile   —  Report file to generate.
integer   $reportWidth   —  Report max width.

[ Top ]


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