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

Class: Generic_Sniffs_PHP_ForbiddenFunctionsSniff

Source Location: /PHP_CodeSniffer-0.7.0/CodeSniffer/Standards/Generic/Sniffs/PHP/ForbiddenFunctionsSniff.php

Class Overview


Generic_Sniffs_PHP_ForbiddenFunctionsSniff.


Author(s):

Version:

  • Release: 0.7.0

Copyright:

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

Variables

Methods


Child classes:

Squiz_Sniffs_PHP_ForbiddenFunctionsSniff
Squiz_Sniffs_PHP_ForbiddenFunctionsSniff.

Inherited Variables

Inherited Methods


Class Details

[line 34]
Generic_Sniffs_PHP_ForbiddenFunctionsSniff.

Discourages the use of alias functions that are kept in PHP for compatibility with older versions. Can be used to forbid the use of any function.



[ Top ]


Class Variables

$forbiddenFunctions = array(
                                     'sizeof' => 'count',
                                     'delete' => 'unset',
                                    )

[line 45]

A list of forbidden functions with their alternatives.

The value is NULL if no alternative exists. IE, the function should just not be used.

  • Var: => string|null)
  • Access: protected

Type:   array(string


[ Top ]



Method Detail

process   [line 74]

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 ]

register   [line 56]

array register( )

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

[ Top ]


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