Packages:
PHP_CodeSniffer

Classes:

Files:

AbstractDocElement.php
AbstractParser.php
AbstractPatternSniff.php
AbstractScopeSniff.php
AbstractVariableSniff.php
ArrayDeclarationSniff.php
BlockCommentSniff.php
CastSpacingSniff.php
ClassCommentParser.php
ClassCommentSniff.php
ClassCommentSniff.php
ClassDeclarationSniff.php
ClassDeclarationSniff.php
ClassFileNameSniff.php
ClosingDeclarationCommentSniff.php
CodeSniffer.php
CodingStandard.php
CommentElement.php
ComparisonOperatorUsageSniff.php
ConcatenationSpacingSniff.php
ControlSignatureSniff.php
ControlSignatureSniff.php
ControlStructureSpacingSniff.php
DisallowObEndFlushSniff.php
DisallowShortOpenTagSniff.php
DocCommentAlignmentSniff.php
DocElement.php
DoubleQuoteUsageSniff.php
EchoedStringsSniff.php
ElseIfDeclarationSniff.php
EmbeddedPhpSniff.php
EmptyCatchCommentSniff.php
EvalSniff.php
Exception.php
File.php
FileCommentSniff.php
FileCommentSniff.php
FileExtensionSniff.php
ForbiddenFunctionsSniff.php
ForbiddenFunctionsSniff.php
ForEachLoopDeclarationSniff.php
ForLoopDeclarationSniff.php
FunctionCallArgumentSpacingSniff.php
FunctionCallSignatureSniff.php
FunctionClosingBraceSpaceSniff.php
FunctionCommentParser.php
FunctionCommentSniff.php
FunctionCommentSniff.php
FunctionCommentThrowTagSniff.php
FunctionDeclarationArgumentSpacingSniff.php
FunctionDeclarationSniff.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
InlineIfDeclarationSniff.php
InnerFunctionsSniff.php
LineEndingsSniff.php
LineEndingsSniff.php
LineEndingsSniff.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
NonExecutableCodeSniff.php
NoSpaceAfterCastSniff.php
OpeningFunctionBraceBsdAllmanSniff.php
OpeningFunctionBraceKernighanRitchieSniff.php
OperatorBracketSniff.php
OperatorSpacingSniff.php
OutputBufferingIndentSniff.php
PairElement.php
ParameterElement.php
ParserException.php
PEARCodingStandard.php
PostStatementCommentSniff.php
ScopeClosingBraceSniff.php
ScopeClosingBraceSniff.php
ScopeIndentSniff.php
ScopeIndentSniff.php
ScopeIndentSniff.php
SelfMemberReferenceSniff.php
SingleElement.php
Sniff.php
SniffException.php
SpaceAfterCastSniff.php
SquizCodingStandard.php
StaticThisUsageSniff.php
SuperfluousWhitespaceSniff.php
SwitchDeclarationSniff.php
Text.php
Tokens.php
UpperCaseConstantNameSniff.php
UpperCaseConstantSniff.php
ValidClassNameSniff.php
ValidClassNameSniff.php
ValidDefaultValueSniff.php
ValidFunctionNameSniff.php
ValidFunctionNameSniff.php
ValidInterfaceNameSniff.php
ValidLogicalOperatorsSniff.php
ValidVariableNameSniff.php
VariableCommentSniff.php

Class: Generic_Sniffs_WhiteSpace_ScopeIndentSniff

Source Location: /PHP_CodeSniffer-0.7.0/CodeSniffer/Standards/Generic/Sniffs/WhiteSpace/ScopeIndentSniff.php

Class Overview

Generic_Sniffs_Whitespace_ScopeIndentSniff.

Author(s):

Marc McIntyre <mmcintyre at squiz.net>
Greg Sherwood <gsherwood at squiz.net>

Version:

Release: 0.7.0

Copyright:

2006 Squiz Pty Ltd (ABN 77 084 670 600)

Variables

Methods

Child classes:

Squiz_Sniffs_WhiteSpace_ScopeIndentSniff: Squiz_Sniffs_Whitespace_ScopeIndentSniff.

PEAR_Sniffs_WhiteSpace_ScopeIndentSniff: PEAR_Sniffs_Whitespace_ScopeIndentSniff.

Inherited Variables

Inherited Methods

Class Details

[line 34]
Generic_Sniffs_Whitespace_ScopeIndentSniff.

Checks that control structures are structured correctly, and their content is indented correctly.

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

[ Top ]

Class Variables

$indent = 4

[line 42]

The number of spaces code should be indented.

Access: protected

Type:

int

[ Top ]

$nonIndentingScopes = array()

[line 49]

Any scope openers that should not cause an indent.

Access: protected

Type:

array(int)

[ Top ]

Method Detail

calculateExpectedIndent [line 255]

int calculateExpectedIndent(
array
$tokens, int
$stackPtr)

Calculates the expected indent of a token.

Access: protected

Overridden in child classes as:

Squiz_Sniffs_WhiteSpace_ScopeIndentSniff::calculateExpectedIndent(): Calculates the expected indent of a token.

Parameters:

array	`$tokens`	—	The stack of tokens for this file.
int	`$stackPtr`	—	The position of the token to get indent for.

[ Top ]

process [line 73]

void process(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes this test, when one of its tokens is encountered.

Access: public

Parameters:

PHP_CodeSniffer_File	`$phpcsFile`	—	All the tokens found in the document.
int	`$stackPtr`	—	The position of the current token in the stack passed in $tokens.

[ Top ]

register [line 57]

array register(
)

Returns an array of tokens this test wants to listen for.

Access: public

[ Top ]