PHP 클래스 PHP_CodeSniffer_Reports_VersionControl, PHP_CodeSniffer

PHP version 5

링크 보기: http://pear.php.net/package/PHP_CodeSniffer

저자: Ben Selby ([email protected])

상속: implements PHP_CodeSniffer_Report

파일 보기 프로젝트 열기: squizlabs/php_codesniffer

보호된 프로퍼티들

프로퍼티	타입	설명
$reportName	string	The name of the report we want in the output.

공개 메소드들

메소드	설명
generate ( string $cachedData, integer $totalFiles, integer $totalErrors, integer $totalWarnings, integer $totalFixable, boolean $showSources = false, integer $width = 80, boolean $toScreen = true ) : void	Prints the author of all errors and warnings, as given by "version control blame".
generateFileReport ( array $report, PHP_CodeSniffer_File $phpcsFile, boolean $showSources = false, integer $width = 80 ) : boolean	Generate a partial report for a single processed file.

보호된 메소드들

메소드	설명
getAuthor ( string $line ) : mixed	Extract the author from a blame line.
getBlameContent ( string $filename ) : array	Gets the blame output.

메소드 상세

generate() 공개 메소드

Prints the author of all errors and warnings, as given by "version control blame".

public generate ( string $cachedData, integer $totalFiles, integer $totalErrors, integer $totalWarnings, integer $totalFixable, boolean $showSources = false, integer $width = 80, boolean $toScreen = true ) : void
$cachedData	string	Any partial report data that was returned from generateFileReport during the run.
$totalFiles	integer	Total number of files processed during the run.
$totalErrors	integer	Total number of errors found during the run.
$totalWarnings	integer	Total number of warnings found during the run.
$totalFixable	integer	Total number of problems that can be fixed.
$showSources	boolean	Show sources?
$width	integer	Maximum allowed line width.
$toScreen	boolean	Is the report being printed to screen?
리턴	void

generateFileReport() 공개 메소드

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.

public generateFileReport ( array $report, PHP_CodeSniffer_File $phpcsFile, boolean $showSources = false, integer $width = 80 ) : boolean
$report	array	Prepared report data.
$phpcsFile	PHP_CodeSniffer_File	The file being reported on.
$showSources	boolean	Show sources?
$width	integer	Maximum allowed line width.
리턴	boolean

getAuthor() 추상적인 보호된 메소드

Extract the author from a blame line.

abstract protected getAuthor ( string $line ) : mixed
$line	string	Line to parse.
리턴	mixed	string or false if impossible to recover.

getBlameContent() 추상적인 보호된 메소드

Gets the blame output.

abstract protected getBlameContent ( string $filename ) : array
$filename	string	File to blame.
리턴	array

프로퍼티 상세

$reportName 보호되어 있는 프로퍼티

The name of the report we want in the output.

protected string $reportName
리턴	string