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

Packages:
PHP_CodeSniffer
PHP_CodeSniffer_MySource

Classes:

Files:

AbstractDocElement.php
AbstractParser.php
AbstractPatternSniff.php
AbstractScopeSniff.php
AbstractVariableSniff.php
ArrayBracketSpacingSniff.php
ArrayDeclarationSniff.php
BlockCommentSniff.php
CastSpacingSniff.php
ClassCommentParser.php
ClassCommentSniff.php
ClassCommentSniff.php
ClassDeclarationSniff.php
ClassDeclarationSniff.php
ClassFileNameSniff.php
CLI.php
ClosingDeclarationCommentSniff.php
ClosingTagSniff.php
CodeAnalyzerSniff.php
CodeSniffer.php
CodingStandard.php
CommentedOutCodeSniff.php
CommentElement.php
ComparisonOperatorUsageSniff.php
ConcatenationSpacingSniff.php
ConstantCaseSniff.php
ControlSignatureSniff.php
ControlSignatureSniff.php
ControlStructureSpacingSniff.php
CyclomaticComplexitySniff.php
DisallowInlineIfSniff.php
DisallowMultipleAssignmentsSniff.php
DisallowMultipleStatementsSniff.php
DisallowObEndFlushSniff.php
DisallowShortOpenTagSniff.php
DisallowSizeFunctionsInLoopsSniff.php
DisallowTabIndentSniff.php
DocCommentAlignmentSniff.php
DocElement.php
DoubleQuoteUsageSniff.php
EchoedStringsSniff.php
ElseIfDeclarationSniff.php
EmbeddedPhpSniff.php
EmptyCatchCommentSniff.php
EmptyStatementSniff.php
EvalSniff.php
Exception.php
File.php
FileCommentSniff.php
FileCommentSniff.php
FileExtensionSniff.php
ForbiddenFunctionsSniff.php
ForbiddenFunctionsSniff.php
ForEachLoopDeclarationSniff.php
ForLoopDeclarationSniff.php
ForLoopShouldBeWhileLoopSniff.php
ForLoopWithTestFunctionCallSniff.php
FunctionCallArgumentSpacingSniff.php
FunctionCallSignatureSniff.php
FunctionClosingBraceSpaceSniff.php
FunctionCommentParser.php
FunctionCommentSniff.php
FunctionCommentSniff.php
FunctionCommentThrowTagSniff.php
FunctionDeclarationArgumentSpacingSniff.php
FunctionDeclarationSniff.php
FunctionDuplicateArgumentSniff.php
FunctionOpeningBraceSpaceSniff.php
FunctionSpacingSniff.php
Generator.php
GenericCodingStandard.php
GlobalFunctionSniff.php
GlobalKeywordSniff.php
HeredocSniff.php
HTML.php
IncludingFileSniff.php
IncorrectPatternException.php
IncrementDecrementUsageSniff.php
InlineCommentSniff.php
InlineCommentSniff.php
InlineControlStructureSniff.php
InlineControlStructureSniff.php
InlineIfDeclarationSniff.php
InnerFunctionsSniff.php
JavaScriptLintSniff.php
JS.php
JumbledIncrementerSniff.php
LanguageConstructSpacingSniff.php
LineEndingsSniff.php
LineEndingsSniff.php
LineEndingsSniff.php
LineLengthSniff.php
LineLengthSniff.php
LineLengthSniff.php
LineLengthSniff.php
LongConditionClosingCommentSniff.php
LowercaseClassKeywordsSniff.php
LowerCaseConstantSniff.php
LowercaseDeclarationSniff.php
LowercaseFunctionKeywordsSniff.php
LowercasePHPFunctionsSniff.php
MemberCommentParser.php
MemberVarScopeSniff.php
MemberVarSpacingSniff.php
MethodScopeSniff.php
MultipleStatementAlignmentSniff.php
MultipleStatementAlignmentSniff.php
NestingLevelSniff.php
NonExecutableCodeSniff.php
NoSpaceAfterCastSniff.php
ObjectInstantiationSniff.php
ObjectMemberCommaSniff.php
ObjectOperatorSpacingSniff.php
OpeningFunctionBraceBsdAllmanSniff.php
OpeningFunctionBraceKernighanRitchieSniff.php
OperatorBracketSniff.php
OperatorSpacingSniff.php
OutputBufferingIndentSniff.php
PairElement.php
ParameterElement.php
ParserException.php
PEARCodingStandard.php
PHP.php
PHPCSCodingStandard.php
PostStatementCommentSniff.php
ScopeClosingBraceSniff.php
ScopeClosingBraceSniff.php
ScopeIndentSniff.php
ScopeIndentSniff.php
ScopeIndentSniff.php
ScopeKeywordSpacingSniff.php
SelfMemberReferenceSniff.php
SemicolonSpacingSniff.php
SingleElement.php
Sniff.php
SpaceAfterCastSniff.php
SquizCodingStandard.php
StaticThisUsageSniff.php
SuperfluousWhitespaceSniff.php
SwitchDeclarationSniff.php
Text.php
Tokens.php
UnconditionalIfStatementSniff.php
UnnecessaryFinalModifierSniff.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
ZendCodingStandard.php

Class: PHP_CodeSniffer_CLI

Source Location: /PHP_CodeSniffer-1.1.0/CodeSniffer/CLI.php

Class Overview

A class to process command line phpcs scripts.

Author(s):

Greg Sherwood <gsherwood at squiz.net>

Version:

Release: 1.1.0

Copyright:

2006 Squiz Pty Ltd (ABN 77 084 670 600)

Methods

Inherited Variables

Inherited Methods

Class Details

[line 33]
A class to process command line phpcs scripts.

Author: Greg Sherwood <gsherwood@squiz.net>
Version: Release: 1.1.0
Copyright: 2006 Squiz Pty Ltd (ABN 77 084 670 600)
Link: http://pear.php.net/package/PHP_CodeSniffer
License: BSD Licence

[ Top ]

Method Detail

checkRequirements [line 42]

array checkRequirements(
)

Exits if the minimum requirements of PHP_CodSniffer are not met.

Access: public

[ Top ]

getCommandLineValues [line 103]

array getCommandLineValues(
)

Process the command line arguments and returns the values.

Access: public

[ Top ]

getDefaults [line 63]

array getDefaults(
)

Get a list of default values for all possible command line arguments.

Access: public

[ Top ]

printErrorReport [line 350]

int printErrorReport(
PHP_CodeSniffer
$phpcs, string
$report, bool
$showWarnings)

Prints the error report.

Return: The number of error and warning messages shown.
Access: public

Parameters:

PHP_CodeSniffer $phpcs — The PHP_CodeSniffer object containing the errors.

string $report — The type of report to print.

bool $showWarnings — TRUE if warnings should also be printed.

[ Top ]

printInstalledStandards [line 451]

void printInstalledStandards(
)

Prints out a list of installed coding standards.

Access: public

[ Top ]

printUsage [line 417]

void printUsage(
)

Prints out the usage information for this script.

Access: public

[ Top ]

process [line 294]

int process(
[array
$values = array()])

Runs PHP_CodeSniffer over files are directories.

Return: The number of error and warning messages shown.
See: PHP_CodeSniffer_CLI::getCommandLineValues()
Access: public

Parameters:

array $values — An array of values determined from CLI args.

[ Top ]

processLongArgument [line 184]

array processLongArgument(
string
$arg, int
$pos, array
$values)

Processes a long (--example) command line argument.

Return: The updated CLI values.
See: PHP_CodeSniffer_CLI::getCommandLineValues()
Access: public

Parameters:

string $arg — The command line argument.

int $pos — The position of the argument on the command line.

array $values — An array of values determined from CLI args.

[ Top ]

processShortArgument [line 141]

array processShortArgument(
string
$arg, array
$values)

Processes a sort (-e) command line argument.

Return: The updated CLI values.
See: PHP_CodeSniffer_CLI::getCommandLineValues()
Access: public

Parameters:

string $arg — The command line argument.

array $values — An array of values determined from CLI args.

[ Top ]

processUnknownArgument [line 263]

array processUnknownArgument(
string
$arg, int
$pos, array
$values)

Processes an unknown command line argument.

Assumes all unknown arguments are files and folders to check.

Return: The updated CLI values.
See: PHP_CodeSniffer_CLI::getCommandLineValues()
Access: public

Parameters:

string $arg — The command line argument.

int $pos — The position of the argument on the command line.

array $values — An array of values determined from CLI args.

[ Top ]

validateStandard [line 384]

string validateStandard(
string
$standard)

Convert the passed standard into a valid standard.

Checks things like default values and case.

Access: public

Parameters:

string $standard — The standard to validate.

[ Top ]