fix(FunctionComment): stdclass is auto-corrected to object but it should not be (#3313246)

Author: klausi

coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php

@@ -37,8 +37,6 @@ class FunctionCommentSniff implements Sniff
         'Boolean'   => 'bool',
         'integer'   => 'int',
         'str'       => 'string',
-        'stdClass'  => 'object',
-        '\stdClass' => 'object',
         'number'    => 'int',
         'String'    => 'string',
         'type'      => 'mixed',

tests/Drupal/Commenting/FunctionCommentUnitTest.inc

@@ -245,7 +245,7 @@ function test21($arg1, $arg2, $arg3) {
  *
  * @param array|bool|float|int|mixed|object|string|resource|callable $arg1
  *   All of the above types are valid.
- * @param Array|boolean|integer|str|stdClass|NULL $arg2
+ * @param Array|boolean|integer|str|NULL $arg2
  *   All of the above types are invalid.
  * @param array()|Boolean|number|String $arg3
  *   All of the above types are invalid.
@@ -443,7 +443,7 @@ function test34($a, $b) {
 }
 
 /**
- * Using \stdClass as type hint is ok, but not in the documentation.
+ * Using \stdClass as type hint and doc type is ok.
  *
  * @param object $name
  *   Some description.

tests/Drupal/Commenting/FunctionCommentUnitTest.inc.fixed

@@ -257,7 +257,7 @@ function test21($arg1, $arg2, $arg3) {
  *
  * @param array|bool|float|int|mixed|object|string|resource|callable $arg1
  *   All of the above types are valid.
- * @param array|bool|int|string|object|null $arg2
+ * @param array|bool|int|string|null $arg2
  *   All of the above types are invalid.
  * @param array|bool|int|string $arg3
  *   All of the above types are invalid.
@@ -383,7 +383,7 @@ class Test2 extends AbstractTest {
   /**
    * Run method with missing described variable.
    *
-   * @param object $start
+   * @param \stdClass $start
    *   Start point.
    *
    * @return bool
@@ -469,11 +469,11 @@ function test34($a, $b) {
 }
 
 /**
- * Using \stdClass as type hint is ok, but not in the documentation.
+ * Using \stdClass as type hint and doc type is ok.
  *
  * @param object $name
  *   Some description.
- * @param object $param2
+ * @param \stdClass $param2
  *   Some description.
  */
 function test35(\stdClass $name, \stdClass $param2) {
@@ -483,7 +483,7 @@ function test35(\stdClass $name, \stdClass $param2) {
 /**
  * Allow "object" as real type hint (PHP 7.2).
  *
- * @param object $arg
+ * @param \stdClass $arg
  *   Something here.
  * @param object $blarg
  *   Another thing.

tests/Drupal/Commenting/FunctionCommentUnitTest.php

@@ -64,16 +64,14 @@ protected function getErrorList(string $testFile): array
                 357 => 1,
                 360 => 1,
                 371 => 1,
-                374 => 1,
                 389 => 2,
                 390 => 2,
                 401 => 1,
                 414 => 1,
                 416 => 1,
                 426 => 2,
                 427 => 2,
-                450 => 1,
-                460 => 1,
+                465 => 1,
                 538 => 1,
                 540 => 1,
             ];

tests/Drupal/Commenting/VariableCommentUnitTest.inc

@@ -27,7 +27,7 @@ class Test {
   /**
    * Test for some common misspellings.
    *
-   * @var Boolean|stdClass|NULL|FALSE|TRUE|[]
+   * @var Boolean|NULL|FALSE|TRUE|[]
    */
   protected $someVar;
 

tests/Drupal/Commenting/VariableCommentUnitTest.inc.fixed

@@ -27,7 +27,7 @@ class Test {
   /**
    * Test for some common misspellings.
    *
-   * @var bool|object|null|false|true|array
+   * @var bool|null|false|true|array
    */
   protected $someVar;