Merge pull request #236 from humanmade/isset-sniff

#142 - Add new Isset sniff

Author: tfrommen

HM/Sniffs/PHP/IssetSniff.php

@@ -0,0 +1,29 @@
+<?php
+namespace HM\Sniffs\PHP;
+
+use PHP_CodeSniffer\Exceptions\RuntimeException;
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+/**
+ * Sniff to check for isset() usage.
+ */
+class IssetSniff implements Sniff {
+	public function register() {
+		return array( T_ISSET );
+	}
+
+	public function process( File $phpcsFile, $stackPtr ) {
+		$tokens = $phpcsFile->getTokens();
+
+		$open_parenthesis_token = $phpcsFile->findNext( T_OPEN_PARENTHESIS, $stackPtr + 1 );
+		if ( $open_parenthesis_token === false ) {
+			throw new RuntimeException( '$stackPtr was not a valid T_ISSET' );
+		}
+
+		$comma_token = $phpcsFile->findNext( T_COMMA, $open_parenthesis_token + 1 );
+		if ( $comma_token !== false && $comma_token < $tokens[ $open_parenthesis_token ]['parenthesis_closer'] ) {
+			$phpcsFile->addWarning( 'Only one argument should be used per ISSET call', $stackPtr, 'MultipleArguments' );
+		}
+	}
+}

tests/FixtureTests.php

@@ -106,6 +106,7 @@ public function setUp() {
 			'HM.Namespaces.NoLeadingSlashOnUse',
 			'HM.Performance.SlowMetaQuery',
 			'HM.Performance.SlowOrderBy',
+			'HM.PHP.Isset',
 			'HM.Security.EscapeOutput',
 			'HM.Security.NonceVerification',
 			'HM.Security.ValidatedSanitizedInput',

tests/fixtures/fail/isset.php

@@ -0,0 +1,7 @@
+<?php
+
+isset( $a, $b );
+isset(
+	$a,
+	$b
+);

tests/fixtures/fail/isset.php.json

@@ -0,0 +1,14 @@
+{
+	"3": [
+		{
+			"source": "HM.PHP.Isset.MultipleArguments",
+			"type": "warning"
+		}
+	],
+	"4": [
+		{
+			"source": "HM.PHP.Isset.MultipleArguments",
+			"type": "warning"
+		}
+	]
+}

tests/fixtures/pass/isset.php

@@ -0,0 +1,6 @@
+<?php
+
+isset( $a );
+isset(
+	$a
+);