Class: PHP_CodeSniffer_Reporting

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

Class Overview

A class to manage reporting.

Author(s):

Greg Sherwood <gsherwood at squiz.net>
Gabriele Santini <gsantini at sqli.com>

Version:

Release: 2.0.0

Copyright:

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

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 30]
A class to manage reporting.

Author: Greg Sherwood <gsherwood@squiz.net>
Author: Gabriele Santini <gsantini@sqli.com>
Version: Release: 2.0.0
Copyright: 2009-2014 SQLI <www.sqli.com>
Copyright: 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Link: http://pear.php.net/package/PHP_CodeSniffer
License: BSD Licence

[ Top ]

Class Variables

$startTime = 0

[line 66]

When the PHPCS run started.

Access: public

Type: float

[ Top ]

$totalErrors = 0

[line 45]

Total number of errors found during the run.

Access: public

Type: int

[ Top ]

$totalFiles = 0

[line 38]

Total number of files that contain errors or warnings.

Access: public

Type: int

[ Top ]

$totalFixable = 0

[line 59]

Total number of errors/warnings that can be fixed.

Access: public

Type: int

[ Top ]

$totalWarnings = 0

[line 52]

Total number of warnings found during the run.

Access: public

Type: int

[ Top ]

Method Detail

cacheFileReport [line 142]

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 98]

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 290]

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 216]

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

Generates and prints a final report.

Returns an array with the number of errors and the number of warnings, in the form ['errors' => int, 'warnings' => int].

Access: public

Parameters:

string $report — Report type.

boolean $showSources — Show sources?

string $reportFile — Report file to generate.

integer $reportWidth — Report max width.

[ Top ]

printRunTime [line 390]

void printRunTime(
)

Print information about the run.

Access: public

[ Top ]

startTiming [line 377]

void startTiming(
)

Start recording time for the run.

Access: public

[ Top ]