Source for file ReturnFunctionValueSniff.php
Documentation is available at ReturnFunctionValueSniff.php
* Warns when function values are returned directly.
* @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\MySource\Sniffs\PHP;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
class ReturnFunctionValueSniff implements Sniff
* Returns an array of tokens this test wants to listen for.
public function register ()
* Processes this sniff, 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 ();
$functionName = $phpcsFile->findNext (T_STRING , ($stackPtr + 1 ), null , false , null , true );
while ($functionName !== false ) {
// Check if this is really a function.
$bracket = $phpcsFile->findNext (T_WHITESPACE , ($functionName + 1 ), null , true );
$functionName = $phpcsFile->findNext (T_STRING , ($functionName + 1 ), null , false , null , true );
$error = 'The result of a function call should be assigned to a variable before being returned';
$phpcsFile->addWarning ($error, $stackPtr, 'NotAssigned');
Documentation generated on Mon, 11 Mar 2019 15:27:42 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|