Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\Semantics\RemoteAddressSniff.
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 PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: 
Chris@0: /**
Chris@0:  * Make sure that the function ip_address() is used instead of
Chris@0:  * $_SERVER['REMOTE_ADDR'].
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 RemoteAddressSniff 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_VARIABLE);
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 \HP_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:         $string = $phpcsFile->getTokensAsString($stackPtr, 4);
Chris@0:         if ($string === '$_SERVER["REMOTE_ADDR"]' || $string === '$_SERVER[\'REMOTE_ADDR\']') {
Chris@0:             $error = 'Use the function ip_address() instead of $_SERVER[\'REMOTE_ADDR\']';
Chris@0:             $phpcsFile->addError($error, $stackPtr, 'RemoteAddress');
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class