Modernize: Util\Common: use class constant for constant array

As the property was in the public API, the class constant is also public and the property has been deprecated, to be removed in PHPCS 5.0.

Includes changing the array format from a list of strings to an associative array with the key and value for each entry holding the same string to allow for using `isset()` instead of `in_array()`.

Author: jrfnl

src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php

@@ -435,7 +435,7 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
                     $suggestedTypeHint = 'callable';
                 } else if (strpos($suggestedName, 'callback') !== false) {
                     $suggestedTypeHint = 'callable';
-                } else if (in_array($suggestedName, Common::$allowedTypes, true) === false) {
+                } else if (isset(Common::ALLOWED_TYPES[$suggestedName]) === false) {
                     $suggestedTypeHint = $suggestedName;
                 }
 

src/Util/Common.php

@@ -18,20 +18,29 @@ class Common
     /**
      * An array of variable types for param/var we will check.
      *
-     * @var string[]
+     * @var array<string, string>
      */
-    public static $allowedTypes = [
-        'array',
-        'boolean',
-        'float',
-        'integer',
-        'mixed',
-        'object',
-        'string',
-        'resource',
-        'callable',
+    public const ALLOWED_TYPES = [
+        'array'    => 'array',
+        'boolean'  => 'boolean',
+        'float'    => 'float',
+        'integer'  => 'integer',
+        'mixed'    => 'mixed',
+        'object'   => 'object',
+        'string'   => 'string',
+        'resource' => 'resource',
+        'callable' => 'callable',
     ];
 
+    /**
+     * An array of variable types for param/var we will check.
+     *
+     * @var array<string, string>
+     *
+     * @deprecated 4.0.0 Use the Common::ALLOWED_TYPES constant instead.
+     */
+    public static $allowedTypes = self::ALLOWED_TYPES;
+
 
     /**
      * Return TRUE if the path is a PHAR file.
@@ -466,7 +475,7 @@ public static function suggestType($varType)
             return '';
         }
 
-        if (in_array($varType, self::$allowedTypes, true) === true) {
+        if (isset(self::ALLOWED_TYPES[$varType]) === true) {
             return $varType;
         } else {
             $lowerVarType = strtolower($varType);
@@ -512,7 +521,7 @@ public static function suggestType($varType)
                 } else {
                     return 'array';
                 }//end if
-            } else if (in_array($lowerVarType, self::$allowedTypes, true) === true) {
+            } else if (isset(self::ALLOWED_TYPES[$lowerVarType]) === true) {
                 // A valid type, but not lower cased.
                 return $lowerVarType;
             } else {

tests/Core/Util/Common/SuggestTypeTest.php

@@ -60,7 +60,7 @@ public function testSuggestTypeAllowedType($varType)
     public static function dataSuggestTypeAllowedType()
     {
         $data = [];
-        foreach (Common::$allowedTypes as $type) {
+        foreach (Common::ALLOWED_TYPES as $type) {
             $data['Type: '.$type] = [$type];
         }
 
@@ -97,7 +97,7 @@ public function testSuggestTypeAllowedTypeWrongCase($varType, $expected)
     public static function dataSuggestTypeAllowedTypeWrongCase()
     {
         $data = [];
-        foreach (Common::$allowedTypes as $type) {
+        foreach (Common::ALLOWED_TYPES as $type) {
             $data['Mixed case: '.$type] = [
                 'varType'  => ucfirst($type),
                 'expected' => $type,