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

Class: FunctionCallSignatureSniff

Source Location: /PHP_CodeSniffer-3.1.1/src/Standards/PEAR/Sniffs/Functions/FunctionCallSignatureSniff.php

Class Overview


Ensures function calls are formatted correctly.


Author(s):

Copyright:

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

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 16]
Ensures function calls are formatted correctly.


[ Top ]


Class Variables

$allowMultipleArguments =  true

[line 41]

If TRUE, multiple arguments can be defined per line in a multi-line call.
  • Access: public

Type:   boolean


[ Top ]

$indent =  4

[line 34]

The number of spaces code should be indented.
  • Access: public

Type:   integer


[ Top ]

$requiredSpacesAfterOpen =  0

[line 48]

How many spaces should follow the opening bracket.
  • Access: public

Type:   integer


[ Top ]

$requiredSpacesBeforeClose =  0

[line 55]

How many spaces should precede the closing bracket.
  • Access: public

Type:   integer


[ Top ]

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

[line 24]

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

Type:   array


[ Top ]



Method Detail

isMultiLineCall   [line 181]

void isMultiLineCall( File $phpcsFile, int $stackPtr, int $openBracket, array $tokens)

Determine if this is a multi-line function call.
  • Access: public

Parameters:

\PHP_CodeSniffer\Files\File   $phpcsFile   —  The file being scanned.
int   $stackPtr   —  The position of the current token in the stack passed in $tokens.
int   $openBracket   —  The position of the opening bracket in the stack passed in $tokens.
array   $tokens   —  The stack of tokens that make up the file.

[ Top ]

process   [line 85]

void process( File $phpcsFile, int $stackPtr)

Processes this test, when one of its tokens is encountered.
  • Access: public

Parameters:

\PHP_CodeSniffer\Files\File   $phpcsFile   —  The file being scanned.
int   $stackPtr   —  The position of the current token in the stack passed in $tokens.

[ Top ]

processMultiLineCall   [line 336]

void processMultiLineCall( File $phpcsFile, int $stackPtr, int $openBracket, array $tokens)

Processes multi-line calls.
  • Access: public

Parameters:

\PHP_CodeSniffer\Files\File   $phpcsFile   —  The file being scanned.
int   $stackPtr   —  The position of the current token in the stack passed in $tokens.
int   $openBracket   —  The position of the opening bracket in the stack passed in $tokens.
array   $tokens   —  The stack of tokens that make up the file.

[ Top ]

processSingleLineCall   [line 206]

void processSingleLineCall( File $phpcsFile, int $stackPtr, int $openBracket, array $tokens)

Processes single-line calls.
  • Access: public

Parameters:

\PHP_CodeSniffer\Files\File   $phpcsFile   —  The file being scanned.
int   $stackPtr   —  The position of the current token in the stack passed in $tokens.
int   $openBracket   —  The position of the opening bracket in the stack passed in $tokens.
array   $tokens   —  The stack of tokens that make up the file.

[ Top ]

register   [line 63]

array register( )

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

[ Top ]


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