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

Class: Generic_Sniffs_Formatting_MultipleStatementAlignmentSniff

Source Location: /PHP_CodeSniffer-0.9.0/CodeSniffer/Standards/Generic/Sniffs/Formatting/MultipleStatementAlignmentSniff.php

Class Overview


Generic_Sniffs_Formatting_MultipleStatementAlignmentSniff.


Author(s):

Version:

  • Release: 0.9.0

Copyright:

  • 2006 Squiz Pty Ltd (ABN 77 084 670 600)

Variables

Methods


Child classes:

Squiz_Sniffs_Formatting_MultipleStatementAlignmentSniff
Squiz_Sniffs_Formatting_MultipleStatementAlignmentSniff.

Inherited Variables

Inherited Methods


Class Details

[line 33]
Generic_Sniffs_Formatting_MultipleStatementAlignmentSniff.

Checks alignment of assignments. If there are multiple adjacent assignments, it will check that the equals signs of each assignment are aligned. It will display a warning to advise that the signs should be aligned.



[ Top ]


Class Variables

$error =  false

[line 41]

If true, an error will be thrown; otherwise a warning.
  • Access: protected

Type:   bool


[ Top ]

$maxPadding =  1000

[line 52]

The maximum amount of padding before the alignment is ignore.

If the amount of padding required to align this assignment with the surrounding assignments exceeds this number, the assignment will be ignored and no errors or warnings will be thrown.

  • Access: protected

Type:   int


[ Top ]



Method Detail

process   [line 76]

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   —  The file being scanned.
int   $stackPtr   —  The position of the current token in the stack passed in $tokens.

[ Top ]

register   [line 60]

array register( )

Returns an array of tokens this test wants to listen for.
  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:09:57 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.