Source for file GlobalFunctionSniff.php
Documentation is available at GlobalFunctionSniff.php
* Tests for functions outside of classes.
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\Functions;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
class GlobalFunctionSniff implements Sniff
* Returns an array of tokens this test wants to listen for.
public function register ()
return array (T_FUNCTION );
* Processes this test, when one of its tokens is encountered.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token in the
* stack passed in $tokens.
public function process (File $phpcsFile, $stackPtr)
$tokens = $phpcsFile->getTokens ();
if (empty ($tokens[$stackPtr]['conditions']) === true ) {
$functionName = $phpcsFile->getDeclarationName ($stackPtr);
if ($functionName === null ) {
// Special exception for __autoload as it needs to be global.
if ($functionName !== '__autoload') {
$error = 'Consider putting global function "%s" in a static class';
$data = array ($functionName);
$phpcsFile->addWarning ($error, $stackPtr, 'Found', $data);
Documentation generated on Mon, 11 Mar 2019 15:27:33 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|