WP.DiscouragedConstants: Trigger for const defined in the global na…

…mespace

Distinguished between `const` defines in the global namespace and class constants.

To this end, two more utility functions I previously write for PHPCompatibility have been ported over.

WordPress/Sniff.php

@@ -2220,4 +2220,62 @@ public function has_html_open_tag( $tag_name, $stackPtr = null, $content = false
 		return false;
 	}
 
+	/**
+	 * Check whether a T_CONST token is a class constant declaration.
+	 *
+	 * @since 0.14.0
+	 *
+	 * @param int $stackPtr  The position in the stack of the T_CONST token to verify.
+	 *
+	 * @return bool
+	 */
+	public function is_class_constant( $stackPtr ) {
+		if ( ! isset( $this->tokens[ $stackPtr ] ) || T_CONST !== $this->tokens[ $stackPtr ]['code'] ) {
+			return false;
+		}
+
+		// Note: traits can not declare constants.
+		$valid_scopes = array(
+			'T_CLASS'      => true,
+			'T_ANON_CLASS' => true,
+			'T_INTERFACE'  => true,
+		);
+
+		return $this->valid_direct_scope( $stackPtr, $valid_scopes );
+	}
+
+	/**
+	 * Check whether the direct wrapping scope of a token is within a limited set of
+	 * acceptable tokens.
+	 *
+	 * Used to check, for instance, if a T_CONST is a class constant.
+	 *
+	 * @since 0.14.0
+	 *
+	 * @param int   $stackPtr     The position in the stack of the token to verify.
+	 * @param array $valid_scopes Array of token types.
+	 *                            Keys should be the token types in string format
+	 *                            to allow for newer token types.
+	 *                            Value is irrelevant.
+	 *
+	 * @return bool
+	 */
+	protected function valid_direct_scope( $stackPtr, array $valid_scopes ) {
+		if ( empty( $this->tokens[ $stackPtr ]['conditions'] ) ) {
+			return false;
+		}
+
+		/*
+		 * Check only the direct wrapping scope of the token.
+		 */
+		$conditions = array_keys( $this->tokens[ $stackPtr ]['conditions'] );
+		$ptr        = array_pop( $conditions );
+
+		if ( ! isset( $this->tokens[ $ptr ] ) ) {
+			return false;
+		}
+
+		return isset( $valid_scopes[ $this->tokens[ $ptr ]['type'] ] );
+	}
+
 }

WordPress/Sniffs/WP/DiscouragedConstantsSniff.php

@@ -68,7 +68,6 @@ class DiscouragedConstantsSniff extends AbstractFunctionParameterSniff {
 		T_IMPLEMENTS      => true,
 		T_NEW             => true,
 		T_FUNCTION        => true,
-		T_CONST           => true,
 		T_DOUBLE_COLON    => true,
 		T_OBJECT_OPERATOR => true,
 		T_INSTANCEOF      => true,
@@ -134,6 +133,14 @@ public function process_arbitrary_tstring( $stackPtr ) {
 			return;
 		}
 
+		if ( false !== $prev
+			&& T_CONST === $this->tokens[ $prev ]['code']
+			&& true === $this->is_class_constant( $prev )
+		) {
+			// Class constant of the same name.
+			return;
+		}
+
 		/*
 		 * Deal with a number of variations of use statements.
 		 */

WordPress/Tests/WP/DiscouragedConstantsUnitTest.inc

@@ -5,7 +5,7 @@
  *
  * The below are all ok.
  */
-// Ok, not a constant.
+// Ok, not a (global) constant.
 namespace STYLESHEETPATH {}
 namespace MY\OTHER\STYLESHEETPATH\NAMESPACE {}
 use STYLESHEETPATH;
@@ -18,7 +18,6 @@ class ABC extends STYLESHEETPATH {}
 class DEF implements STYLESHEETPATH {}
 interface STYLESHEETPATH {}
 trait STYLESHEETPATH {}
-const STYLESHEETPATH = 'something';
 $a = new STYLESHEETPATH;
 $a = new STYLESHEETPATH();
 function STYLESHEETPATH() {}
@@ -32,7 +31,6 @@ goto STYLESHEETPATH;
 STYLESHEETPATH:
 // Something.
 
-// Ok, not a global constant.
 echo \mynamespace\STYLESHEETPATH;
 echo My_Class::STYLESHEETPATH;
 echo $this->STYLESHEETPATH;
@@ -71,3 +69,4 @@ switch(	STYLESHEETPATH ) {
 }
 
 define( 'STYLESHEETPATH', 'something' );
+const STYLESHEETPATH = 'something';

WordPress/Tests/WP/DiscouragedConstantsUnitTest.php

@@ -35,6 +35,8 @@ public function getErrorList() {
 	 */
 	public function getWarningList() {
 		return array(
+			50 => 1,
+			51 => 1,
 			52 => 1,
 			53 => 1,
 			54 => 1,
@@ -45,13 +47,12 @@ public function getWarningList() {
 			59 => 1,
 			60 => 1,
 			61 => 1,
-			62 => 1,
 			63 => 1,
-			65 => 1,
+			64 => 1,
 			66 => 1,
-			68 => 1,
-			69 => 1,
-			73 => 1,
+			67 => 1,
+			71 => 1,
+			72 => 1,
 		);
 	}