PHP_CodeSniffer

[ ] [ ] [ ]

Packages:
PHP_CodeSniffer
PHP_CodeSniffer_MySource

Classes:

Generic_Sniffs_Classes_DuplicateClassNameSniff
Generic_Sniffs_CodeAnalysis_EmptyStatementSniff
Generic_Sniffs_CodeAnalysis_ForLoopShouldBeWhileLoopSniff
Generic_Sniffs_CodeAnalysis_ForLoopWithTestFunctionCallSniff
Generic_Sniffs_CodeAnalysis_JumbledIncrementerSniff
Generic_Sniffs_CodeAnalysis_UnconditionalIfStatementSniff
Generic_Sniffs_CodeAnalysis_UnnecessaryFinalModifierSniff
Generic_Sniffs_CodeAnalysis_UnusedFunctionParameterSniff
Generic_Sniffs_CodeAnalysis_UselessOverridingMethodSniff
Generic_Sniffs_Commenting_FixmeSniff
Generic_Sniffs_Commenting_TodoSniff
Generic_Sniffs_ControlStructures_InlineControlStructureSniff
Generic_Sniffs_Debug_ClosureLinterSniff
Generic_Sniffs_Debug_JSHintSniff
Generic_Sniffs_Files_ByteOrderMarkSniff
Generic_Sniffs_Files_LineEndingsSniff
Generic_Sniffs_Files_LineLengthSniff
Generic_Sniffs_Formatting_DisallowMultipleStatementsSniff
Generic_Sniffs_Formatting_MultipleStatementAlignmentSniff
Generic_Sniffs_Formatting_NoSpaceAfterCastSniff
Generic_Sniffs_Formatting_SpaceAfterCastSniff
Generic_Sniffs_Functions_CallTimePassByReferenceSniff
Generic_Sniffs_Functions_FunctionCallArgumentSpacingSniff
Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff
Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff
Generic_Sniffs_Metrics_CyclomaticComplexitySniff
Generic_Sniffs_Metrics_NestingLevelSniff
Generic_Sniffs_NamingConventions_ConstructorNameSniff
Generic_Sniffs_NamingConventions_UpperCaseConstantNameSniff
Generic_Sniffs_PHP_DeprecatedFunctionsSniff
Generic_Sniffs_PHP_DisallowShortOpenTagSniff
Generic_Sniffs_PHP_ForbiddenFunctionsSniff
Generic_Sniffs_PHP_LowerCaseConstantSniff
Generic_Sniffs_PHP_NoSilencedErrorsSniff
Generic_Sniffs_PHP_UpperCaseConstantSniff
Generic_Sniffs_Strings_UnnecessaryStringConcatSniff
Generic_Sniffs_VersionControl_SubversionPropertiesSniff
Generic_Sniffs_WhiteSpace_DisallowTabIndentSniff
Generic_Sniffs_WhiteSpace_ScopeIndentSniff
MySource_Sniffs_Commenting_FunctionCommentSniff
MySource_Sniffs_CSS_BrowserSpecificStylesSniff
PEAR_Sniffs_Classes_ClassDeclarationSniff
PEAR_Sniffs_Commenting_ClassCommentSniff
PEAR_Sniffs_Commenting_FileCommentSniff
PEAR_Sniffs_Commenting_FunctionCommentSniff
PEAR_Sniffs_Commenting_InlineCommentSniff
PEAR_Sniffs_ControlStructures_ControlSignatureSniff
PEAR_Sniffs_ControlStructures_MultiLineConditionSniff
PEAR_Sniffs_Files_IncludingFileSniff
PEAR_Sniffs_Formatting_MultiLineAssignmentSniff
PEAR_Sniffs_Functions_FunctionCallSignatureSniff
PEAR_Sniffs_Functions_FunctionDeclarationSniff
PEAR_Sniffs_Functions_ValidDefaultValueSniff
PEAR_Sniffs_NamingConventions_ValidClassNameSniff
PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff
PEAR_Sniffs_NamingConventions_ValidVariableNameSniff
PEAR_Sniffs_WhiteSpace_ObjectOperatorIndentSniff
PEAR_Sniffs_WhiteSpace_ScopeClosingBraceSniff
PEAR_Sniffs_WhiteSpace_ScopeIndentSniff
PHP_CodeSniffer
PHP_CodeSniffer_CLI
PHP_CodeSniffer_CommentParser_AbstractDocElement
PHP_CodeSniffer_CommentParser_AbstractParser
PHP_CodeSniffer_CommentParser_ClassCommentParser
PHP_CodeSniffer_CommentParser_CommentElement
PHP_CodeSniffer_CommentParser_FunctionCommentParser
PHP_CodeSniffer_CommentParser_MemberCommentParser
PHP_CodeSniffer_CommentParser_PairElement
PHP_CodeSniffer_CommentParser_ParameterElement
PHP_CodeSniffer_CommentParser_ParserException
PHP_CodeSniffer_CommentParser_SingleElement
PHP_CodeSniffer_DocGenerators_Generator
PHP_CodeSniffer_DocGenerators_HTML
PHP_CodeSniffer_DocGenerators_Text
PHP_CodeSniffer_Exception
PHP_CodeSniffer_File
PHP_CodeSniffer_Reporting
PHP_CodeSniffer_Reports_Checkstyle
PHP_CodeSniffer_Reports_Csv
PHP_CodeSniffer_Reports_Emacs
PHP_CodeSniffer_Reports_Full
PHP_CodeSniffer_Reports_Gitblame
PHP_CodeSniffer_Reports_Hgblame
PHP_CodeSniffer_Reports_Source
PHP_CodeSniffer_Reports_Summary
PHP_CodeSniffer_Reports_Svnblame
PHP_CodeSniffer_Reports_VersionControl
PHP_CodeSniffer_Reports_Xml
PHP_CodeSniffer_Standards_AbstractPatternSniff
PHP_CodeSniffer_Standards_AbstractScopeSniff
PHP_CodeSniffer_Standards_AbstractVariableSniff
PHP_CodeSniffer_Standards_IncorrectPatternException
PHP_CodeSniffer_Tokenizers_CSS
PHP_CodeSniffer_Tokenizers_JS
PHP_CodeSniffer_Tokenizers_PHP
PHP_CodeSniffer_Tokens
Squiz_Sniffs_Arrays_ArrayBracketSpacingSniff
Squiz_Sniffs_Arrays_ArrayDeclarationSniff
Squiz_Sniffs_Classes_ClassDeclarationSniff
Squiz_Sniffs_Classes_ClassFileNameSniff
Squiz_Sniffs_Classes_DuplicatePropertySniff
Squiz_Sniffs_Classes_LowercaseClassKeywordsSniff
Squiz_Sniffs_Classes_SelfMemberReferenceSniff
Squiz_Sniffs_Classes_ValidClassNameSniff
Squiz_Sniffs_CodeAnalysis_EmptyStatementSniff
Squiz_Sniffs_Commenting_BlockCommentSniff
Squiz_Sniffs_Commenting_ClassCommentSniff
Squiz_Sniffs_Commenting_ClosingDeclarationCommentSniff
Squiz_Sniffs_Commenting_DocCommentAlignmentSniff
Squiz_Sniffs_Commenting_EmptyCatchCommentSniff
Squiz_Sniffs_Commenting_FileCommentSniff
Squiz_Sniffs_Commenting_FunctionCommentSniff
Squiz_Sniffs_Commenting_FunctionCommentThrowTagSniff
Squiz_Sniffs_Commenting_InlineCommentSniff
Squiz_Sniffs_Commenting_LongConditionClosingCommentSniff
Squiz_Sniffs_Commenting_PostStatementCommentSniff
Squiz_Sniffs_Commenting_VariableCommentSniff
Squiz_Sniffs_ControlStructures_ControlSignatureSniff
Squiz_Sniffs_ControlStructures_ElseIfDeclarationSniff
Squiz_Sniffs_ControlStructures_ForEachLoopDeclarationSniff
Squiz_Sniffs_ControlStructures_ForLoopDeclarationSniff
Squiz_Sniffs_ControlStructures_InlineIfDeclarationSniff
Squiz_Sniffs_ControlStructures_LowercaseDeclarationSniff
Squiz_Sniffs_ControlStructures_SwitchDeclarationSniff
Squiz_Sniffs_CSS_ClassDefinitionClosingBraceSpaceSniff
Squiz_Sniffs_CSS_ClassDefinitionNameSpacingSniff
Squiz_Sniffs_CSS_ClassDefinitionOpeningBraceSpaceSniff
Squiz_Sniffs_CSS_ColonSpacingSniff
Squiz_Sniffs_CSS_ColourDefinitionSniff
Squiz_Sniffs_CSS_DisallowMultipleStyleDefinitionsSniff
Squiz_Sniffs_CSS_DuplicateClassDefinitionSniff
Squiz_Sniffs_CSS_DuplicateStyleDefinitionSniff
Squiz_Sniffs_CSS_EmptyClassDefinitionSniff
Squiz_Sniffs_CSS_EmptyStyleDefinitionSniff
Squiz_Sniffs_CSS_IndentationSniff
Squiz_Sniffs_CSS_LowercaseStyleDefinitionSniff
Squiz_Sniffs_CSS_MissingColonSniff
Squiz_Sniffs_CSS_OpacitySniff
Squiz_Sniffs_CSS_SemicolonSpacingSniff
Squiz_Sniffs_Debug_JavaScriptLintSniff
Squiz_Sniffs_Debug_JSLintSniff
Squiz_Sniffs_Files_FileExtensionSniff
Squiz_Sniffs_Formatting_OperatorBracketSniff
Squiz_Sniffs_Functions_FunctionDeclarationArgumentSpacingSniff
Squiz_Sniffs_Functions_FunctionDeclarationSniff
Squiz_Sniffs_Functions_FunctionDuplicateArgumentSniff
Squiz_Sniffs_Functions_GlobalFunctionSniff
Squiz_Sniffs_Functions_LowercaseFunctionKeywordsSniff
Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff
Squiz_Sniffs_NamingConventions_ConstantCaseSniff
Squiz_Sniffs_NamingConventions_ValidFunctionNameSniff
Squiz_Sniffs_NamingConventions_ValidVariableNameSniff
Squiz_Sniffs_Objects_DisallowObjectStringIndexSniff
Squiz_Sniffs_Objects_ObjectInstantiationSniff
Squiz_Sniffs_Objects_ObjectMemberCommaSniff
Squiz_Sniffs_Operators_ComparisonOperatorUsageSniff
Squiz_Sniffs_Operators_IncrementDecrementUsageSniff
Squiz_Sniffs_Operators_ValidLogicalOperatorsSniff
Squiz_Sniffs_PHP_CommentedOutCodeSniff
Squiz_Sniffs_PHP_DisallowComparisonAssignmentSniff
Squiz_Sniffs_PHP_DisallowInlineIfSniff
Squiz_Sniffs_PHP_DisallowMultipleAssignmentsSniff
Squiz_Sniffs_PHP_DisallowObEndFlushSniff
Squiz_Sniffs_PHP_DisallowSizeFunctionsInLoopsSniff
Squiz_Sniffs_PHP_DiscouragedFunctionsSniff
Squiz_Sniffs_PHP_EmbeddedPhpSniff
Squiz_Sniffs_PHP_EvalSniff
Squiz_Sniffs_PHP_ForbiddenFunctionsSniff
Squiz_Sniffs_PHP_GlobalKeywordSniff
Squiz_Sniffs_PHP_HeredocSniff
Squiz_Sniffs_PHP_InnerFunctionsSniff
Squiz_Sniffs_PHP_LowercasePHPFunctionsSniff
Squiz_Sniffs_PHP_NonExecutableCodeSniff
Squiz_Sniffs_Scope_MemberVarScopeSniff
Squiz_Sniffs_Scope_MethodScopeSniff
Squiz_Sniffs_Scope_StaticThisUsageSniff
Squiz_Sniffs_Strings_ConcatenationSpacingSniff
Squiz_Sniffs_Strings_DoubleQuoteUsageSniff
Squiz_Sniffs_Strings_EchoedStringsSniff
Squiz_Sniffs_WhiteSpace_CastSpacingSniff
Squiz_Sniffs_WhiteSpace_ControlStructureSpacingSniff
Squiz_Sniffs_WhiteSpace_FunctionClosingBraceSpaceSniff
Squiz_Sniffs_WhiteSpace_FunctionOpeningBraceSpaceSniff
Squiz_Sniffs_WhiteSpace_FunctionSpacingSniff
Squiz_Sniffs_WhiteSpace_LanguageConstructSpacingSniff
Squiz_Sniffs_WhiteSpace_LogicalOperatorSpacingSniff
Squiz_Sniffs_WhiteSpace_MemberVarSpacingSniff
Squiz_Sniffs_WhiteSpace_ObjectOperatorSpacingSniff
Squiz_Sniffs_WhiteSpace_OperatorSpacingSniff
Squiz_Sniffs_WhiteSpace_PropertyLabelSpacingSniff
Squiz_Sniffs_WhiteSpace_ScopeClosingBraceSniff
Squiz_Sniffs_WhiteSpace_ScopeKeywordSpacingSniff
Squiz_Sniffs_WhiteSpace_SemicolonSpacingSniff
Squiz_Sniffs_WhiteSpace_SuperfluousWhitespaceSniff
Zend_Sniffs_Debug_CodeAnalyzerSniff
Zend_Sniffs_Files_ClosingTagSniff
Zend_Sniffs_NamingConventions_ValidVariableNameSniff

Files:

AbstractDocElement.php
AbstractParser.php
AbstractPatternSniff.php
AbstractScopeSniff.php
AbstractVariableSniff.php
ArrayBracketSpacingSniff.php
ArrayDeclarationSniff.php
BlockCommentSniff.php
BrowserSpecificStylesSniff.php
ByteOrderMarkSniff.php
CallTimePassByReferenceSniff.php
CastSpacingSniff.php
Checkstyle.php
ClassCommentParser.php
ClassCommentSniff.php
ClassCommentSniff.php
ClassDeclarationSniff.php
ClassDeclarationSniff.php
ClassDefinitionClosingBraceSpaceSniff.php
ClassDefinitionNameSpacingSniff.php
ClassDefinitionOpeningBraceSpaceSniff.php
ClassFileNameSniff.php
CLI.php
ClosingDeclarationCommentSniff.php
ClosingTagSniff.php
ClosureLinterSniff.php
CodeAnalyzerSniff.php
CodeSniffer.php
ColonSpacingSniff.php
ColourDefinitionSniff.php
CommentedOutCodeSniff.php
CommentElement.php
ComparisonOperatorUsageSniff.php
ConcatenationSpacingSniff.php
ConstantCaseSniff.php
ConstructorNameSniff.php
ControlSignatureSniff.php
ControlSignatureSniff.php
ControlStructureSpacingSniff.php
CSS.php
Csv.php
CyclomaticComplexitySniff.php
DeprecatedFunctionsSniff.php
DisallowComparisonAssignmentSniff.php
DisallowInlineIfSniff.php
DisallowMultipleAssignmentsSniff.php
DisallowMultipleStatementsSniff.php
DisallowMultipleStyleDefinitionsSniff.php
DisallowObEndFlushSniff.php
DisallowShortOpenTagSniff.php
DisallowSizeFunctionsInLoopsSniff.php
DisallowTabIndentSniff.php
DiscouragedFunctionsSniff.php
DocCommentAlignmentSniff.php
DocElement.php
DoubleQuoteUsageSniff.php
DuplicateClassDefinitionSniff.php
DuplicateClassNameSniff.php
DuplicatePropertySniff.php
DuplicateStyleDefinitionSniff.php
EchoedStringsSniff.php
ElseIfDeclarationSniff.php
Emacs.php
EmbeddedPhpSniff.php
EmptyCatchCommentSniff.php
EmptyClassDefinitionSniff.php
EmptyStatementSniff.php
EmptyStatementSniff.php
EmptyStyleDefinitionSniff.php
EvalSniff.php
Exception.php
File.php
FileCommentSniff.php
FileCommentSniff.php
FileExtensionSniff.php
FixmeSniff.php
ForbiddenFunctionsSniff.php
ForbiddenFunctionsSniff.php
ForEachLoopDeclarationSniff.php
ForLoopDeclarationSniff.php
ForLoopShouldBeWhileLoopSniff.php
ForLoopWithTestFunctionCallSniff.php
Full.php
FunctionCallArgumentSpacingSniff.php
FunctionCallSignatureSniff.php
FunctionClosingBraceSpaceSniff.php
FunctionCommentParser.php
FunctionCommentSniff.php
FunctionCommentSniff.php
FunctionCommentSniff.php
FunctionCommentThrowTagSniff.php
FunctionDeclarationArgumentSpacingSniff.php
FunctionDeclarationSniff.php
FunctionDeclarationSniff.php
FunctionDuplicateArgumentSniff.php
FunctionOpeningBraceSpaceSniff.php
FunctionSpacingSniff.php
Generator.php
Gitblame.php
GlobalFunctionSniff.php
GlobalKeywordSniff.php
HeredocSniff.php
Hgblame.php
HTML.php
IncludingFileSniff.php
IncorrectPatternException.php
IncrementDecrementUsageSniff.php
IndentationSniff.php
InlineCommentSniff.php
InlineCommentSniff.php
InlineControlStructureSniff.php
InlineIfDeclarationSniff.php
InnerFunctionsSniff.php
JavaScriptLintSniff.php
JS.php
JSHintSniff.php
JSLintSniff.php
JumbledIncrementerSniff.php
LanguageConstructSpacingSniff.php
LineEndingsSniff.php
LineLengthSniff.php
LogicalOperatorSpacingSniff.php
LongConditionClosingCommentSniff.php
LowercaseClassKeywordsSniff.php
LowerCaseConstantSniff.php
LowercaseDeclarationSniff.php
LowercaseFunctionKeywordsSniff.php
LowercasePHPFunctionsSniff.php
LowercaseStyleDefinitionSniff.php
MemberCommentParser.php
MemberVarScopeSniff.php
MemberVarSpacingSniff.php
MethodScopeSniff.php
MissingColonSniff.php
MultiFileSniff.php
MultiLineAssignmentSniff.php
MultiLineConditionSniff.php
MultiLineFunctionDeclarationSniff.php
MultipleStatementAlignmentSniff.php
NestingLevelSniff.php
NonExecutableCodeSniff.php
NoSilencedErrorsSniff.php
NoSpaceAfterCastSniff.php
ObjectInstantiationSniff.php
ObjectMemberCommaSniff.php
ObjectOperatorIndentSniff.php
ObjectOperatorSpacingSniff.php
OpacitySniff.php
OpeningFunctionBraceBsdAllmanSniff.php
OpeningFunctionBraceKernighanRitchieSniff.php
OperatorBracketSniff.php
OperatorSpacingSniff.php
PairElement.php
ParameterElement.php
ParserException.php
PHP.php
PostStatementCommentSniff.php
PropertyLabelSpacingSniff.php
Report.php
Reporting.php
ScopeClosingBraceSniff.php
ScopeClosingBraceSniff.php
ScopeIndentSniff.php
ScopeIndentSniff.php
ScopeKeywordSpacingSniff.php
SelfMemberReferenceSniff.php
SemicolonSpacingSniff.php
SemicolonSpacingSniff.php
SingleElement.php
Sniff.php
Source.php
SpaceAfterCastSniff.php
StaticThisUsageSniff.php
SubversionPropertiesSniff.php
Summary.php
SuperfluousWhitespaceSniff.php
Svnblame.php
SwitchDeclarationSniff.php
Text.php
TodoSniff.php
Tokens.php
UnconditionalIfStatementSniff.php
UnnecessaryFinalModifierSniff.php
UnnecessaryStringConcatSniff.php
UnusedFunctionParameterSniff.php
UpperCaseConstantNameSniff.php
UpperCaseConstantSniff.php
UselessOverridingMethodSniff.php
ValidClassNameSniff.php
ValidClassNameSniff.php
ValidDefaultValueSniff.php
ValidFunctionNameSniff.php
ValidFunctionNameSniff.php
ValidLogicalOperatorsSniff.php
ValidVariableNameSniff.php
ValidVariableNameSniff.php
ValidVariableNameSniff.php
VariableCommentSniff.php
VersionControl.php
Xml.php

Class: PHP_CodeSniffer_Reports_VersionControl

Source Location: /PHP_CodeSniffer-1.3.4/CodeSniffer/Reports/VersionControl.php

Class Overview

Version control report base class for PHP_CodeSniffer.

Author(s):

Ben Selby <benmatselby at gmail.com>

Version:

Release: 1.2.2

Copyright:

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

Variables

$reportName

Methods

Child classes:

PHP_CodeSniffer_Reports_Svnblame: Svnblame report for PHP_CodeSniffer.

PHP_CodeSniffer_Reports_Hgblame: Mercurial report for PHP_CodeSniffer.

PHP_CodeSniffer_Reports_Gitblame: Gitblame report for PHP_CodeSniffer.

Inherited Variables

Inherited Methods

Class Details

[line 30]
Version control report base class for PHP_CodeSniffer.

PHP version 5

Author: Ben Selby <benmatselby@gmail.com>
Version: Release: 1.2.2
Copyright: 2009 SQLI <www.sqli.com>
Copyright: 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
Link: http://pear.php.net/package/PHP_CodeSniffer
Abstract:
License: BSD Licence

[ Top ]

Class Variables

$reportName = 'VERSION CONTROL'

[line 38]

The name of the report we want in the output.

Access: protected

Type:

string

[ Top ]

Method Detail

generate [line 51]

string generate(
array
$report, [boolean
$showSources = false], [integer
$width = 80], [boolean
$toScreen = true])

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

Access: public

Parameters:

array	`$report`	—	Prepared report.
boolean	`$showSources`	—	Show sources?
integer	`$width`	—	Maximum allowed lne width.
boolean	`$toScreen`	—	Is the report being printed to screen?

[ Top ]

getAuthor [line 201]

mixed getAuthor(
string
$line)

Extract the author from a blame line.

Return: string or false if impossible to recover.
Abstract:
Access: protected

Overridden in child classes as:

PHP_CodeSniffer_Reports_Svnblame::getAuthor(): Extract the author from a blame line.

PHP_CodeSniffer_Reports_Hgblame::getAuthor(): Extract the author from a blame line.

PHP_CodeSniffer_Reports_Gitblame::getAuthor(): Extract the author from a blame line.

Parameters:

string $line — Line to parse.

[ Top ]

getBlameContent [line 211]

array getBlameContent(
string
$filename)

Gets the blame output.

Abstract:
Access: protected

Overridden in child classes as:

PHP_CodeSniffer_Reports_Svnblame::getBlameContent(): Gets the blame output.

PHP_CodeSniffer_Reports_Hgblame::getBlameContent(): Gets the blame output.

PHP_CodeSniffer_Reports_Gitblame::getBlameContent(): Gets the blame output.

Parameters:

string $filename — File to blame.

[ Top ]

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