Merge pull request #62 from johnbillion/_get_list_table

Author: szepeviktor

extension.neon

@@ -7,6 +7,10 @@ services:
         class: SzepeViktor\PHPStan\WordPress\WpThemeMagicPropertiesClassReflectionExtension
         tags:
             - phpstan.broker.propertiesClassReflectionExtension
+    -
+        class: SzepeViktor\PHPStan\WordPress\GetListTableDynamicFunctionReturnTypeExtension
+        tags:
+            - phpstan.broker.dynamicFunctionReturnTypeExtension
     -
         class: SzepeViktor\PHPStan\WordPress\RedirectCanonicalDynamicFunctionReturnTypeExtension
         tags:

src/GetListTableDynamicFunctionReturnTypeExtension.php

@@ -0,0 +1,52 @@
+<?php
+
+/**
+ * Set return type of get_post().
+ */
+
+declare(strict_types=1);
+
+namespace SzepeViktor\PHPStan\WordPress;
+
+use PhpParser\Node\Expr\FuncCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+use PHPStan\Type\Type;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Constant\ConstantBooleanType;
+use PHPStan\Type\TypeCombinator;
+use PHPStan\Type\Constant\ConstantStringType;
+
+class GetListTableDynamicFunctionReturnTypeExtension implements \PHPStan\Type\DynamicFunctionReturnTypeExtension
+{
+    public function isFunctionSupported(FunctionReflection $functionReflection): bool
+    {
+        return $functionReflection->getName() === '_get_list_table';
+    }
+
+    // phpcs:ignore SlevomatCodingStandard.Functions.UnusedParameter
+    public function getTypeFromFunctionCall(FunctionReflection $functionReflection, FuncCall $functionCall, Scope $scope): Type
+    {
+        // Called without $class argument
+        if (count($functionCall->args) < 1) {
+            return new ConstantBooleanType(false);
+        }
+
+        $argumentType = $scope->getType($functionCall->args[0]->value);
+
+        // When called with a $class that isn't a constant string, return default return type
+        if (! $argumentType instanceof ConstantStringType) {
+            return ParametersAcceptorSelector::selectFromArgs(
+                $scope,
+                $functionCall->args,
+                $functionReflection->getVariants()
+            )->getReturnType();
+        }
+
+        return TypeCombinator::union(
+            new ObjectType($argumentType->getValue()),
+            new ConstantBooleanType(false)
+        );
+    }
+}

tests/data/_get_list_table.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SzepeViktor\PHPStan\WordPress\Tests;
+
+use function PHPStan\Testing\assertType;
+
+// Known class name
+assertType('WP_Posts_List_Table|false', _get_list_table('WP_Posts_List_Table'));
+assertType('Unknown_Table|false', _get_list_table('Unknown_Table'));
+
+// Unknown class name
+assertType('\WP_List_Table|false', _get_list_table(_GET['foo']));

tests/testTest.php

@@ -15,6 +15,7 @@ class DynamicReturnTypeExtensionTests extends TypeInferenceTestCase
     public function dataFileAsserts(): iterable
     {
         // path to a file with actual asserts of expected types:
+        yield from $this->gatherAssertTypes(__DIR__ . '/data/_get_list_table.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/current_time.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/get_comment.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/get_object_taxonomies.php');