Documentation

Source
in package
implements Report

Interfaces, Classes and Traits

Report

Table of Contents

generate()  : void
Prints the source of all errors and warnings.
generateFileReport()  : bool
Generate a partial report for a single processed file.
makeFriendlyName()  : string
Converts a camel caps name into a readable string.

Methods

generate()

Prints the source of all errors and warnings.

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

Any partial report data that was returned from generateFileReport during the run.

$totalFiles : int

Total number of files processed during the run.

$totalErrors : int

Total number of errors found during the run.

$totalWarnings : int

Total number of warnings found during the run.

$totalFixable : int

Total number of problems that can be fixed.

$showSources : bool = false

Show sources?

$width : int = 80

Maximum allowed line width.

$interactive : bool = false

Are we running in interactive mode?

$toScreen : bool = true

Is the report being printed to screen?

Return values
void —

generateFileReport()

Generate a partial report for a single processed file.

public generateFileReport(array<string|int, mixed> $report, File $phpcsFile[, bool $showSources = false ][, int $width = 80 ]) : bool

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.

Parameters
$report : array<string|int, mixed>

Prepared report data.

$phpcsFile : File

The file being reported on.

$showSources : bool = false

Show sources?

$width : int = 80

Maximum allowed line width.

Return values
bool —

makeFriendlyName()

Converts a camel caps name into a readable string.

public makeFriendlyName(string $name) : string
Parameters
$name : string

The camel caps name to convert.

Return values
string —

Search results