annotate vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Semantics/RemoteAddressSniff.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2 /**
Chris@17 3 * \Drupal\Sniffs\Semantics\RemoteAddressSniff.
Chris@0 4 *
Chris@0 5 * @category PHP
Chris@0 6 * @package PHP_CodeSniffer
Chris@0 7 * @link http://pear.php.net/package/PHP_CodeSniffer
Chris@0 8 */
Chris@0 9
Chris@17 10 namespace Drupal\Sniffs\Semantics;
Chris@17 11
Chris@17 12 use PHP_CodeSniffer\Files\File;
Chris@17 13 use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17 14
Chris@0 15 /**
Chris@0 16 * Make sure that the function ip_address() is used instead of
Chris@0 17 * $_SERVER['REMOTE_ADDR'].
Chris@0 18 *
Chris@0 19 * @category PHP
Chris@0 20 * @package PHP_CodeSniffer
Chris@0 21 * @link http://pear.php.net/package/PHP_CodeSniffer
Chris@0 22 */
Chris@17 23 class RemoteAddressSniff implements Sniff
Chris@0 24 {
Chris@0 25
Chris@0 26
Chris@0 27 /**
Chris@0 28 * Returns an array of tokens this test wants to listen for.
Chris@0 29 *
Chris@0 30 * @return array
Chris@0 31 */
Chris@0 32 public function register()
Chris@0 33 {
Chris@0 34 return array(T_VARIABLE);
Chris@0 35
Chris@0 36 }//end register()
Chris@0 37
Chris@0 38
Chris@0 39 /**
Chris@0 40 * Processes this test, when one of its tokens is encountered.
Chris@0 41 *
Chris@17 42 * @param \HP_CodeSniffer\Files\File $phpcsFile The current file being processed.
Chris@17 43 * @param int $stackPtr The position of the current token
Chris@17 44 * in the stack passed in $tokens.
Chris@0 45 *
Chris@0 46 * @return void
Chris@0 47 */
Chris@17 48 public function process(File $phpcsFile, $stackPtr)
Chris@0 49 {
Chris@0 50 $string = $phpcsFile->getTokensAsString($stackPtr, 4);
Chris@0 51 if ($string === '$_SERVER["REMOTE_ADDR"]' || $string === '$_SERVER[\'REMOTE_ADDR\']') {
Chris@0 52 $error = 'Use the function ip_address() instead of $_SERVER[\'REMOTE_ADDR\']';
Chris@0 53 $phpcsFile->addError($error, $stackPtr, 'RemoteAddress');
Chris@0 54 }
Chris@0 55
Chris@0 56 }//end process()
Chris@0 57
Chris@0 58
Chris@0 59 }//end class