Chris@0: <?php
Chris@0: /**
Chris@17:  * ThemeSniff
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\FunctionCalls;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use Drupal\Sniffs\Semantics\FunctionCall;
Chris@17: 
Chris@0: /**
Chris@17:  * \DrupalPractice\Sniffs\FunctionCalls\Checks that theme functions are not directly called.
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 ThemeSniff extends FunctionCall
Chris@0: {
Chris@0: 
Chris@0:     /**
Chris@0:      * List of functions starting with "theme_" that don't generate theme output.
Chris@0:      *
Chris@0:      * @var array
Chris@0:      */
Chris@0:     protected $reservedFunctions = array(
Chris@0:                                     'theme_get_registry',
Chris@0:                                     'theme_get_setting',
Chris@0:                                     'theme_render_template',
Chris@0:                                     'theme_enable',
Chris@0:                                     'theme_disable',
Chris@0:                                     'theme_get_suggestions',
Chris@0:                                    );
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@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0:         $tokens       = $phpcsFile->getTokens();
Chris@0:         $functionName = $tokens[$stackPtr]['content'];
Chris@0:         if (strpos($functionName, 'theme_') !== 0
Chris@0:             || in_array($functionName, $this->reservedFunctions) === true
Chris@0:             || $this->isFunctionCall($phpcsFile, $stackPtr) === false
Chris@0:         ) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $themeName = substr($functionName, 6);
Chris@0:         $warning   = "Do not call theme functions directly, use theme('%s', ...) instead";
Chris@0:         $phpcsFile->addWarning($warning, $stackPtr, 'ThemeFunctionDirect', array($themeName));
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class