Chris@0: <?php
Chris@0: /**
Chris@17:  * \DrupalPractice\Sniffs\General\DescriptionTSniff
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 PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: 
Chris@0: /**
Chris@0:  * Checks that string values for #description in render arrays are translated.
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 DescriptionTSniff implements Sniff
Chris@0: {
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns an array of tokens this test wants to listen for.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function register()
Chris@0:     {
Chris@0:         return array(T_CONSTANT_ENCAPSED_STRING);
Chris@0: 
Chris@0:     }//end register()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes this test, when one of its tokens is encountered.
Chris@0:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
Chris@17:      * @param int                         $stackPtr  The position of the function
Chris@17:      *                                               name in the stack.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0:         // Look for the string "#description".
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0:         if ($tokens[$stackPtr]['content'] !== '"#description"' && $tokens[$stackPtr]['content'] !== "'#description'") {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         // Look for an array pattern that starts to define #description values.
Chris@0:         $statementEnd = $phpcsFile->findNext(T_SEMICOLON, ($stackPtr + 1));
Chris@0:         $arrayString  = $phpcsFile->getTokensAsString(($stackPtr + 1), ($statementEnd - $stackPtr));
Chris@0:         // Cut out all the white space.
Chris@0:         $arrayString = preg_replace('/\s+/', '', $arrayString);
Chris@0: 
Chris@0:         if (strpos($arrayString, '=>"') !== 0 && strpos($arrayString, ']="') !== 0
Chris@0:             && strpos($arrayString, "=>'") !== 0 && strpos($arrayString, "]='") !== 0
Chris@0:         ) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $stringToken = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($stackPtr + 1));
Chris@0:         $content     = strip_tags($tokens[$stringToken]['content']);
Chris@0: 
Chris@0:         if (strlen($content) > 5) {
Chris@0:             $warning = '#description values usually have to run through t() for translation';
Chris@17:             $phpcsFile->addWarning($warning, $stringToken, 'DescriptionT');
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class