Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\Semantics\ConstantNameSniff
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 Drupal\Sniffs\Semantics;
Chris@17: 
Chris@17: use Drupal\Sniffs\Semantics\FunctionCall;
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: 
Chris@0: /**
Chris@0:  * Checks that constants introduced with define() in module or install files start
Chris@0:  * with the module's 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 ConstantNameSniff 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('define');
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:         $nameParts     = explode('.', basename($phpcsFile->getFilename()));
Chris@0:         $fileExtension = end($nameParts);
Chris@0:         // Only check in *.module files.
Chris@0:         if ($fileExtension !== 'module' && $fileExtension !== 'install') {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $tokens   = $phpcsFile->getTokens();
Chris@0:         $argument = $this->getArgument(1);
Chris@0:         if ($tokens[$argument['start']]['code'] !== T_CONSTANT_ENCAPSED_STRING) {
Chris@0:             // Not a string literal, so this is some obscure constant that we ignore.
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $moduleName    = reset($nameParts);
Chris@0:         $expectedStart = strtoupper($moduleName);
Chris@0:         // Remove the quotes around the string litral.
Chris@0:         $constant = substr($tokens[$argument['start']]['content'], 1, -1);
Chris@0:         if (strpos($constant, $expectedStart) !== 0) {
Chris@0:             $warning = 'All constants defined by a module must be prefixed with the module\'s name, expected "%s" but found "%s"';
Chris@0:             $data    = array(
Chris@0:                         $expectedStart."_$constant",
Chris@0:                         $constant,
Chris@0:                        );
Chris@0:             $phpcsFile->addWarning($warning, $stackPtr, 'ConstantStart', $data);
Chris@0:         }
Chris@0: 
Chris@0:     }//end processFunctionCall()
Chris@0: 
Chris@0: 
Chris@0: }//end class