Class: Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff

Source Location: /PHP_CodeSniffer-2.7.1/CodeSniffer/Standards/Squiz/Sniffs/Functions/MultiLineFunctionDeclarationSniff.php

Class Overview

PEAR_Sniffs_Functions_FunctionDeclarationSniff
   |
   --Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff

Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff.

Author(s):

Greg Sherwood <gsherwood at squiz.net>

Version:

Release: 2.7.1

Copyright:

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

Variables

$supportedTokenizers

Methods

Inherited Variables

Class: PEAR_Sniffs_Functions_FunctionDeclarationSniff

PEAR_Sniffs_Functions_FunctionDeclarationSniff::$indent

Inherited Methods

Class: PEAR_Sniffs_Functions_FunctionDeclarationSniff

PEAR_Sniffs_Functions_FunctionDeclarationSniff::isMultiLineDeclaration(): Determine if this is a multi-line function declaration.
PEAR_Sniffs_Functions_FunctionDeclarationSniff::process(): Processes this test, when one of its tokens is encountered.
PEAR_Sniffs_Functions_FunctionDeclarationSniff::processMultiLineDeclaration(): Processes multi-line declarations.
PEAR_Sniffs_Functions_FunctionDeclarationSniff::processSingleLineDeclaration(): Processes single-line declarations.
PEAR_Sniffs_Functions_FunctionDeclarationSniff::register(): Returns an array of tokens this test wants to listen for.

Class Details

[line 33]
Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff.

Ensure single and multi-line function declarations are defined correctly.

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

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

[line 41]

A list of tokenizers this sniff supports.

Access: public

Type:

array

[ Top ]

Method Detail

isMultiLineDeclaration [line 60]

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

Determine if this is a multi-line function declaration.

Access: public

Overrides PEAR_Sniffs_Functions_FunctionDeclarationSniff::isMultiLineDeclaration() (Determine if this is a multi-line function declaration.)

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 ]

processBracket [line 168]

void processBracket(
PHP_CodeSniffer_File
$phpcsFile, int
$openBracket, array
$tokens, [string
$type = 'function'])

Processes the contents of a single set of brackets.

Access: public

Parameters:

PHP_CodeSniffer_File	`$phpcsFile`	—	The file being scanned.
int	`$openBracket`	—	The position of the open bracket in the stack passed in $tokens.
array	`$tokens`	—	The stack of tokens that make up the file.
string	`$type`	—	The type of the token the brackets belong to (function or use).

[ Top ]

processMultiLineDeclaration [line 125]

void processMultiLineDeclaration(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr, array
$tokens)

Processes multi-line declarations.

Access: public

Overrides PEAR_Sniffs_Functions_FunctionDeclarationSniff::processMultiLineDeclaration() (Processes multi-line declarations.)

Parameters:

PHP_CodeSniffer_File	`$phpcsFile`	—	The file being scanned.
int	`$stackPtr`	—	The position of the current token in the stack passed in $tokens.
array	`$tokens`	—	The stack of tokens that make up the file.

[ Top ]

Class: Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: PEAR_Sniffs_Functions_FunctionDeclarationSniff

Inherited Methods

Class: PEAR_Sniffs_Functions_FunctionDeclarationSniff

Class Details

Class Variables

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

Method Detail

isMultiLineDeclaration [line 60]

Parameters:

processBracket [line 168]

Parameters:

processMultiLineDeclaration [line 125]

Parameters:

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