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

Class: Info

Source Location: /PHP_CodeSniffer-3.1.1/src/Reports/Info.php

Class Overview


Info report for PHP_CodeSniffer.


Author(s):

Copyright:

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

Methods


Inherited Variables

Inherited Methods


Class Details

[line 15]
Info report for PHP_CodeSniffer.


[ Top ]


Method Detail

generate   [line 63]

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

Prints the source of all errors and warnings.
  • 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.
int   $totalFixable   —  Total number of problems that can be fixed.
bool   $showSources   —  Show sources?
int   $width   —  Maximum allowed line width.
bool   $interactive   —  Are we running in interactive mode?
bool   $toScreen   —  Is the report being printed to screen?

[ Top ]

generateFileReport   [line 33]

bool generateFileReport( array $report, File $phpcsFile, [bool $showSources = false], [int $width = 80])

Generate a partial report for a single processed file.

Function should return TRUE if it printed or stored data about the file and FALSE if it ignored the file. Returning TRUE indicates that the file and its data should be counted in the grand totals.

  • Access: public

Parameters:

array   $report   —  Prepared report data.
\PHP_CodeSniffer\File   $phpcsFile   —  The file being reported on.
bool   $showSources   —  Show sources?
int   $width   —  Maximum allowed line width.

[ Top ]


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