Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\NamingConventions\ValidGlobalSniff.
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\NamingConventions;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: use PHP_CodeSniffer\Util\Tokens;
Chris@17: 
Chris@0: /**
Chris@0:  * Ensures that global variables start with an underscore.
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 ValidGlobalSniff implements Sniff
Chris@0: {
Chris@0: 
Chris@0:     public $coreGlobals = array(
Chris@0:                            '$argc',
Chris@0:                            '$argv',
Chris@0:                            '$base_insecure_url',
Chris@0:                            '$base_path',
Chris@0:                            '$base_root',
Chris@0:                            '$base_secure_url',
Chris@0:                            '$base_theme_info',
Chris@0:                            '$base_url',
Chris@0:                            '$channel',
Chris@0:                            '$conf',
Chris@18:                            '$config',
Chris@0:                            '$config_directories',
Chris@0:                            '$cookie_domain',
Chris@0:                            '$databases',
Chris@0:                            '$db_prefix',
Chris@0:                            '$db_type',
Chris@0:                            '$db_url',
Chris@0:                            '$drupal_hash_salt',
Chris@0:                            '$drupal_test_info',
Chris@0:                            '$element',
Chris@0:                            '$forum_topic_list_header',
Chris@0:                            '$image',
Chris@0:                            '$install_state',
Chris@0:                            '$installed_profile',
Chris@0:                            '$is_https',
Chris@0:                            '$is_https_mock',
Chris@0:                            '$item',
Chris@0:                            '$items',
Chris@0:                            '$language',
Chris@0:                            '$language_content',
Chris@0:                            '$language_url',
Chris@0:                            '$locks',
Chris@0:                            '$menu_admin',
Chris@0:                            '$multibyte',
Chris@0:                            '$pager_limits',
Chris@0:                            '$pager_page_array',
Chris@0:                            '$pager_total',
Chris@0:                            '$pager_total_items',
Chris@0:                            '$tag',
Chris@0:                            '$theme',
Chris@0:                            '$theme_engine',
Chris@0:                            '$theme_info',
Chris@0:                            '$theme_key',
Chris@0:                            '$theme_path',
Chris@0:                            '$timers',
Chris@0:                            '$update_free_access',
Chris@0:                            '$update_rewrite_settings',
Chris@0:                            '$user',
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_GLOBAL);
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 current file being processed.
Chris@17:      * @param int                         $stackPtr  The position of the current token
Chris@17:      *                                               in the stack passed in $tokens.
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: 
Chris@0:         $varToken = $stackPtr;
Chris@0:         // Find variable names until we hit a semicolon.
Chris@17:         $ignore   = Tokens::$emptyTokens;
Chris@0:         $ignore[] = T_SEMICOLON;
Chris@0:         while (($varToken = $phpcsFile->findNext($ignore, ($varToken + 1), null, true, null, true)) !== false) {
Chris@0:             if ($tokens[$varToken]['code'] === T_VARIABLE
Chris@0:                 && in_array($tokens[$varToken]['content'], $this->coreGlobals) === false
Chris@0:                 && $tokens[$varToken]['content']{1} !== '_'
Chris@0:             ) {
Chris@0:                 $error = 'global variables should start with a single underscore followed by the module and another underscore';
Chris@0:                 $phpcsFile->addError($error, $varToken, 'GlobalUnderScore');
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class