1<?php
2/**
3 * Warns when function values are returned directly.
4 *
5 * PHP version 5
6 *
7 * @category  PHP
8 * @package   PHP_CodeSniffer_MySource
9 * @author    Greg Sherwood <gsherwood@squiz.net>
10 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
11 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
12 * @link      http://pear.php.net/package/PHP_CodeSniffer
13 */
14
15/**
16 * Warns when function values are returned directly.
17 *
18 * @category  PHP
19 * @package   PHP_CodeSniffer_MySource
20 * @author    Greg Sherwood <gsherwood@squiz.net>
21 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
22 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
23 * @version   Release: @package_version@
24 * @link      http://pear.php.net/package/PHP_CodeSniffer
25 */
26class MySource_Sniffs_PHP_ReturnFunctionValueSniff implements PHP_CodeSniffer_Sniff
27{
28
29
30    /**
31     * Returns an array of tokens this test wants to listen for.
32     *
33     * @return array
34     */
35    public function register()
36    {
37        return array(T_RETURN);
38
39    }//end register()
40
41
42    /**
43     * Processes this sniff, when one of its tokens is encountered.
44     *
45     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
46     * @param int                  $stackPtr  The position of the current token in
47     *                                        the stack passed in $tokens.
48     *
49     * @return void
50     */
51    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
52    {
53        $tokens = $phpcsFile->getTokens();
54
55        $functionName = $phpcsFile->findNext(T_STRING, ($stackPtr + 1), null, false, null, true);
56
57        while ($functionName !== false) {
58            // Check if this is really a function.
59            $bracket = $phpcsFile->findNext(T_WHITESPACE, ($functionName + 1), null, true);
60            if ($tokens[$bracket]['code'] !== T_OPEN_PARENTHESIS) {
61                // Not a function call.
62                $functionName = $phpcsFile->findNext(T_STRING, ($functionName + 1), null, false, null, true);
63                continue;
64            }
65
66            $error = 'The result of a function call should be assigned to a variable before being returned';
67            $phpcsFile->addWarning($error, $stackPtr, 'NotAssigned');
68            break;
69        }
70
71    }//end process()
72
73
74}//end class
75