Packages:
PHP_CodeSniffer
PHP_CodeSniffer_MySource

Classes:

Files:

Class: PEAR_Sniffs_Functions_FunctionCallSignatureSniff

Source Location: /PHP_CodeSniffer-2.7.1/CodeSniffer/Standards/PEAR/Sniffs/Functions/FunctionCallSignatureSniff.php

Class Overview

PEAR_Sniffs_Functions_FunctionCallSignatureSniff.

Author(s):

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

Version:

Release: 2.7.1

Copyright:

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

Variables

Methods

Child classes:

PSR2_Sniffs_Methods_FunctionCallSignatureSniff: PSR2_Sniffs_Methods_FunctionCallSignatureSniff.

Inherited Variables

Inherited Methods

Class Details

[line 28]
PEAR_Sniffs_Functions_FunctionCallSignatureSniff.

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

[ Top ]

Class Variables

$allowMultipleArguments = true

[line 53]

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

Access: public

Type:

bool

[ Top ]

$indent = 4

[line 46]

The number of spaces code should be indented.

Access: public

Type:

int

[ Top ]

$requiredSpacesAfterOpen = 0

[line 60]

How many spaces should follow the opening bracket.

Access: public

Type:

int

[ Top ]

$requiredSpacesBeforeClose = 0

[line 67]

How many spaces should precede the closing bracket.

Access: public

Type:

int

[ Top ]

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

[line 36]

A list of tokenizers this sniff supports.

Access: public

Type:

array

[ Top ]

Method Detail

isMultiLineCall [line 180]

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

Determine if this is a multi-line function call.

Access: public

Overridden in child classes as:

PSR2_Sniffs_Methods_FunctionCallSignatureSniff::isMultiLineCall(): Processes single-line calls.

Parameters:

PHP_CodeSniffer_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 91]

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 ]

processMultiLineCall [line 290]

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

Processes multi-line calls.

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.
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 205]

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

Processes single-line calls.

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.
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 75]

array register(
)

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

Access: public

[ Top ]

Class: PEAR_Sniffs_Functions_FunctionCallSignatureSniff

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$allowMultipleArguments = true

$indent = 4

$requiredSpacesAfterOpen = 0

$requiredSpacesBeforeClose = 0

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

Method Detail

isMultiLineCall [line 180]

Parameters:

process [line 91]

Parameters:

processMultiLineCall [line 290]

Parameters:

processSingleLineCall [line 205]

Parameters:

register [line 75]

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