Chris@0: <?php
Chris@0: /**
Chris@17:  * \DrupalPractice\Sniffs\General\LanguageNoneSniff
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 ['und'] is not used, should be LANGUAGE_NONE.
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 LanguageNoneSniff 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(
Chris@0:                 T_OPEN_SQUARE_BRACKET,
Chris@0:                 T_OPEN_SHORT_ARRAY,
Chris@0:                );
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:         $sequence = $phpcsFile->getTokensAsString($stackPtr, 3);
Chris@0:         if ($sequence === "['und']" || $sequence === '["und"]') {
Chris@0:             $warning = "Are you accessing field values here? Then you should use LANGUAGE_NONE instead of 'und'";
Chris@0:             $phpcsFile->addWarning($warning, ($stackPtr + 1), 'Und');
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class