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

Class: Generic_Sniffs_Formatting_MultipleStatementAlignmentSniff

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

Class Overview


Generic_Sniffs_Formatting_MultipleStatementAlignmentSniff.


Author(s):

Version:

  • Release: 2.7.1

Copyright:

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

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 30]
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 48]

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

Type:   bool


[ Top ]

$maxPadding =  1000

[line 59]

The maximum amount of padding before the alignment is ignored.

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: public

Type:   int


[ Top ]

$supportedTokenizers = array(
                                   'PHP',
                                   'JS',
                                  )

[line 38]

A list of tokenizers this sniff supports.
  • Access: public

Type:   array


[ Top ]



Method Detail

checkAlignment   [line 113]

int checkAlignment( 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 ]

process   [line 85]

int 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 67]

array register( )

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

[ Top ]


Documentation generated on Mon, 11 Mar 2019 14:50:48 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.