Chris@0: <?php
Chris@0: /**
Chris@17:  * \DrupalPractice\Sniffs\General\VariableNameSniff
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: 
Chris@17: namespace DrupalPractice\Sniffs\General;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use Drupal\Sniffs\Semantics\FunctionCall;
Chris@17: use DrupalPractice\Project;
Chris@17: use PHP_CodeSniffer\Util\Tokens;
Chris@17: 
Chris@0: /**
Chris@0:  * Checks the usage of variable_get() in forms and the variable name.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@17: class VariableNameSniff extends FunctionCall
Chris@0: {
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns an array of function names this test wants to listen for.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function registerFunctionNames()
Chris@0:     {
Chris@0:         return array('variable_get');
Chris@0: 
Chris@0:     }//end registerFunctionNames()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes this function call.
Chris@0:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile    The file being scanned.
Chris@17:      * @param int                         $stackPtr     The position of the function call in
Chris@17:      *                                                  the stack.
Chris@17:      * @param int                         $openBracket  The position of the opening
Chris@17:      *                                                  parenthesis in the stack.
Chris@17:      * @param int                         $closeBracket The position of the closing
Chris@17:      *                                                  parenthesis in the stack.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public function processFunctionCall(
Chris@17:         File $phpcsFile,
Chris@0:         $stackPtr,
Chris@0:         $openBracket,
Chris@0:         $closeBracket
Chris@0:     ) {
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0: 
Chris@0:         // We assume that the sequence '#default_value' => variable_get(...)
Chris@0:         // indicates a variable that the module owns.
Chris@17:         $arrow = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true);
Chris@0:         if ($arrow === false || $tokens[$arrow]['code'] !== T_DOUBLE_ARROW) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@17:         $arrayKey = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($arrow - 1), null, true);
Chris@0:         if ($arrayKey === false
Chris@0:             || $tokens[$arrayKey]['code'] !== T_CONSTANT_ENCAPSED_STRING
Chris@0:             || substr($tokens[$arrayKey]['content'], 1, -1) !== '#default_value'
Chris@0:         ) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $argument = $this->getArgument(1);
Chris@0: 
Chris@0:         // Variable name is not a literal string, so we return early.
Chris@0:         if ($argument === false || $tokens[$argument['start']]['code'] !== T_CONSTANT_ENCAPSED_STRING) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@17:         $moduleName = Project::getName($phpcsFile);
Chris@0:         if ($moduleName === false) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $variableName = substr($tokens[$argument['start']]['content'], 1, -1);
Chris@0:         if (strpos($variableName, $moduleName) !== 0) {
Chris@0:             $warning = 'All variables defined by your module must be prefixed with your module\'s name to avoid name collisions with others. Expected start with "%s" but found "%s"';
Chris@0:             $data    = array(
Chris@0:                         $moduleName,
Chris@0:                         $variableName,
Chris@0:                        );
Chris@0:             $phpcsFile->addWarning($warning, $argument['start'], 'VariableName', $data);
Chris@0:         }
Chris@0: 
Chris@0:     }//end processFunctionCall()
Chris@0: 
Chris@0: 
Chris@0: }//end class