Subversion Repositories Applications.framework

<?php

/**

 * A class to find T_VARIABLE tokens.

 *

 * PHP version 5

 *

 * @category  PHP

 * @package   PHP_CodeSniffer

 * @author    Greg Sherwood <gsherwood@squiz.net>

 * @author    Marc McIntyre <mmcintyre@squiz.net>

 * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)

 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence

 * @version   CVS: $Id: AbstractVariableSniff.php,v 1.15 2008/12/01 05:41:28 squiz Exp $

 * @link      http://pear.php.net/package/PHP_CodeSniffer

 */

if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) {

    $error = 'Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found';

    throw new PHP_CodeSniffer_Exception($error);

}

/**

 * A class to find T_VARIABLE tokens.

 *

 * This class can distingush between normal T_VARIABLE tokens, and those tokens

 * that represent class members. If a class member is encountered, then then

 * processMemberVar method is called so the extending class can process it. If

 * the token is found to be a normal T_VARIABLE token, then processVariable is

 * called.

 *

 * @category  PHP

 * @package   PHP_CodeSniffer

 * @author    Greg Sherwood <gsherwood@squiz.net>

 * @author    Marc McIntyre <mmcintyre@squiz.net>

 * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)

 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence

 * @version   Release: 1.2.0RC1

 * @link      http://pear.php.net/package/PHP_CodeSniffer

 */

abstract class PHP_CodeSniffer_Standards_AbstractVariableSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff

{

    /**

     * The end token of the current function that we are in.

     *

     * @var int

     */

    private $_endFunction = -1;

    /**

     * true if a function is currently open.

     *

     * @var boolean

     */

    private $_functionOpen = false;

    /**

     * The current PHP_CodeSniffer file that we are processing.

     *

     * @var PHP_CodeSniffer_File

     */

    protected $currentFile = null;

    /**

     * Constructs an AbstractVariableTest.

     */

    public function __construct()

    {

        $listen = array(

                   T_CLASS,

                   T_INTERFACE,

                  );

        $scopes = array(

                   T_FUNCTION,

                   T_VARIABLE,

                   T_DOUBLE_QUOTED_STRING,

                  );

        parent::__construct($listen, $scopes, true);

    }//end __construct()

    /**

     * Processes the token in the specified PHP_CodeSniffer_File.

     *

     * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this

     *                                        token was found.

     * @param int                  $stackPtr  The position where the token was found.

     * @param array                $currScope The current scope opener token.

     *

     * @return void

     */

    protected final function processTokenWithinScope(

        PHP_CodeSniffer_File $phpcsFile,

        $stackPtr,

        $currScope

    ) {

        if ($this->currentFile !== $phpcsFile) {

            $this->currentFile   = $phpcsFile;

            $this->_functionOpen = false;

            $this->_endFunction  = -1;

        }

        $tokens = $phpcsFile->getTokens();

        if ($stackPtr > $this->_endFunction) {

            $this->_functionOpen = false;

        }

        if ($tokens[$stackPtr]['code'] === T_FUNCTION

            && $this->_functionOpen === false

        ) {

            $this->_functionOpen = true;

            $methodProps = $phpcsFile->getMethodProperties($stackPtr);

            // If the function is abstract, or is in an interface,

            // then set the end of the function to it's closing semicolon.

            if ($methodProps['is_abstract'] === true

                || $tokens[$currScope]['code'] === T_INTERFACE

            ) {

                $this->_endFunction

                    = $phpcsFile->findNext(array(T_SEMICOLON), $stackPtr);

            } else {

                if (isset($tokens[$stackPtr]['scope_closer']) === false) {

                    $error = 'Possible parse error: non-abstract method defined as abstract';

                    $phpcsFile->addWarning($error, $stackPtr);

                    return;

                }

                $this->_endFunction = $tokens[$stackPtr]['scope_closer'];

            }

        }

        if ($this->_functionOpen === true) {

            if ($tokens[$stackPtr]['code'] === T_VARIABLE) {

                $this->processVariable($phpcsFile, $stackPtr);

            } else if ($tokens[$stackPtr]['code'] === T_DOUBLE_QUOTED_STRING) {

                // Check to see if this string has a variable in it.

                $pattern = '|[^\\\]\$[a-zA-Z0-9_]+|';

                if (preg_match($pattern, $tokens[$stackPtr]['content']) !== 0) {

                    $this->processVariableInString($phpcsFile, $stackPtr);

                }

            }

            return;

        } else {

            // What if we assign a member variable to another?

            // ie. private $_count = $this->_otherCount + 1;.

            $this->processMemberVar($phpcsFile, $stackPtr);

        }

    }//end processTokenWithinScope()

    /**

     * Processes the token outside the scope in the file.

     *

     * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this

     *                                        token was found.

     * @param int                  $stackPtr  The position where the token was found.

     *

     * @return void

     */

    protected final function processTokenOutsideScope(

        PHP_CodeSniffer_File $phpcsFile,

        $stackPtr

    ) {

        $tokens = $phpcsFile->getTokens();

        // These variables are not member vars.

        if ($tokens[$stackPtr]['code'] === T_VARIABLE) {

            $this->processVariable($phpcsFile, $stackPtr);

        } else {

            $this->processVariableInString($phpcsFile, $stackPtr);

        }

    }//end processTokenOutsideScope()

    /**

     * Called to process class member vars.

     *

     * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this

     *                                        token was found.

     * @param int                  $stackPtr  The position where the token was found.

     *

     * @return void

     */

    abstract protected function processMemberVar(

        PHP_CodeSniffer_File $phpcsFile,

        $stackPtr

    );

    /**

     * Called to process normal member vars.

     *

     * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this

     *                                        token was found.

     * @param int                  $stackPtr  The position where the token was found.

     *

     * @return void

     */

    abstract protected function processVariable(

        PHP_CodeSniffer_File $phpcsFile,

        $stackPtr

    );

    /**

     * Called to process variables found in duoble quoted strings.

     *

     * Note that there may be more than one variable in the string, which will

     * result only in one call for the string.

     *

     * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this

     *                                        token was found.

     * @param int                  $stackPtr  The position where the double quoted

     *                                        string was found.

     *

     * @return void

     */

    abstract protected function processVariableInString(

        PHP_CodeSniffer_File

        $phpcsFile,

        $stackPtr

    );

}//end class

?>