Class: PEAR_Sniffs_Functions_FunctionDeclarationSniff

Source Location: /PHP_CodeSniffer-2.8.0/CodeSniffer/Standards/PEAR/Sniffs/Functions/FunctionDeclarationSniff.php

Class Overview

PEAR_Sniffs_Functions_FunctionDeclarationSniff.

Author(s):

Greg Sherwood <gsherwood at squiz.net>

Version:

Release: 2.8.0

Copyright:

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

Variables

$indent

Methods

Child classes:

Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff: Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff.

Inherited Variables

Inherited Methods

Class Details

[line 28]
PEAR_Sniffs_Functions_FunctionDeclarationSniff.

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

Author: Greg Sherwood <gsherwood@squiz.net>
Version: Release: 2.8.0
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

$indent = 4

[line 36]

The number of spaces code should be indented.

Access: public

Type: int

[ Top ]

Method Detail

isMultiLineDeclaration [line 192]

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

Determine if this is a multi-line function declaration.

Access: public

Overridden in child classes as:

Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff::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 ]

process [line 63]

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 ]

processMultiLineDeclaration [line 264]

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

Processes multi-line declarations.

Access: public

Overridden in child classes as:

Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff::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 ]

processSingleLineDeclaration [line 231]

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

Processes single-line declarations.

Just uses the Generic BSD-Allman brace sniff.

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.

array $tokens — The stack of tokens that make up the file.

[ Top ]

register [line 44]

array register(
)

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

Access: public

[ Top ]