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

Class: PHP_CodeSniffer_Reporting

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

Class Overview


A class to manage reporting.


Author(s):

Version:

  • Release: 1.3.4

Copyright:

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

Methods


Inherited Variables

Inherited Methods


Class Details

[line 36]
A class to manage reporting.


[ Top ]


Method Detail

factory   [line 48]

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     Demanded report type.

[ Top ]

prepare   [line 136]

array prepare( $filesViolations)

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:

array   $filesViolations     List of found violations.

[ Top ]

printReport   [line 78]

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

Actually generates the report.
  • Access: public

Parameters:

string   $report     Report type.
array   $filesViolations     Collected violations.
boolean   $showSources     Show sources?
string   $reportFile     Report file to generate.
integer   $reportWidth     Report max width.

[ Top ]


Documentation generated on Thu, 17 May 2012 05:01:10 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.