feat: add ViewWithMethodsClassReflectionExtension (#1348)

larastan · Aug 28, 2022 · 3ebb0d7 · 3ebb0d7
1 parent 046ffb7
commit 3ebb0d7
Show file tree

Hide file tree

Showing 6 changed files with 184 additions and 133 deletions.
diff --git a/extension.neon b/extension.neon
@@ -89,6 +89,10 @@ services:
         class: NunoMaduro\Larastan\Methods\MacroMethodsClassReflectionExtension
         tags:
             - phpstan.broker.methodsClassReflectionExtension
+    -
+        class: NunoMaduro\Larastan\Methods\ViewWithMethodsClassReflectionExtension
+        tags:
+            - phpstan.broker.methodsClassReflectionExtension
 
     -
         class: NunoMaduro\Larastan\Properties\ModelAccessorExtension

diff --git a/src/Methods/RedirectResponseMethodsClassReflectionExtension.php b/src/Methods/RedirectResponseMethodsClassReflectionExtension.php
@@ -2,14 +2,8 @@
 
 namespace NunoMaduro\Larastan\Methods;
 
+use NunoMaduro\Larastan\Reflection\DynamicWhereMethodReflection;
 use PHPStan\Reflection;
-use PHPStan\Reflection\FunctionVariant;
-use PHPStan\Reflection\ParameterReflection;
-use PHPStan\TrinaryLogic;
-use PHPStan\Type\Generic\TemplateTypeMap;
-use PHPStan\Type\MixedType;
-use PHPStan\Type\ObjectType;
-use PHPStan\Type\Type;
 
 class RedirectResponseMethodsClassReflectionExtension implements Reflection\MethodsClassReflectionExtension
 {
@@ -19,7 +13,7 @@ public function hasMethod(Reflection\ClassReflection $classReflection, string $m
             return false;
         }
 
-        if (strpos($methodName, 'with') !== 0) {
+        if (! str_starts_with($methodName, 'with')) {
             return false;
         }
 
@@ -30,130 +24,6 @@ public function getMethod(
         Reflection\ClassReflection $classReflection,
         string $methodName
     ): Reflection\MethodReflection {
-        return new class($classReflection, $methodName) implements Reflection\MethodReflection
-        {
-            /** @var Reflection\ClassReflection */
-            private $classReflection;
-
-            /** @var string */
-            private $methodName;
-
-            public function __construct(Reflection\ClassReflection $classReflection, string $methodName)
-            {
-                $this->classReflection = $classReflection;
-                $this->methodName = $methodName;
-            }
-
-            public function getDeclaringClass(): Reflection\ClassReflection
-            {
-                return $this->classReflection;
-            }
-
-            public function isStatic(): bool
-            {
-                return false;
-            }
-
-            public function isPrivate(): bool
-            {
-                return false;
-            }
-
-            public function isPublic(): bool
-            {
-                return true;
-            }
-
-            public function getDocComment(): ?string
-            {
-                return null;
-            }
-
-            public function getName(): string
-            {
-                return $this->methodName;
-            }
-
-            public function getPrototype(): Reflection\ClassMemberReflection
-            {
-                return $this;
-            }
-
-            public function getVariants(): array
-            {
-                return [
-                    new FunctionVariant(
-                        TemplateTypeMap::createEmpty(),
-                        TemplateTypeMap::createEmpty(),
-                        [
-                            new class implements ParameterReflection
-                            {
-                                public function getName(): string
-                                {
-                                    return 'dynamic-with';
-                                }
-
-                                public function isOptional(): bool
-                                {
-                                    return false;
-                                }
-
-                                public function getType(): \PHPStan\Type\Type
-                                {
-                                    return new MixedType();
-                                }
-
-                                public function passedByReference(): \PHPStan\Reflection\PassedByReference
-                                {
-                                    return Reflection\PassedByReference::createNo();
-                                }
-
-                                public function isVariadic(): bool
-                                {
-                                    return false;
-                                }
-
-                                public function getDefaultValue(): ?\PHPStan\Type\Type
-                                {
-                                    return null;
-                                }
-                            },
-                        ],
-                        false,
-                        new ObjectType($this->classReflection->getName())
-                    ),
-                ];
-            }
-
-            public function isDeprecated(): TrinaryLogic
-            {
-                return TrinaryLogic::createNo();
-            }
-
-            public function getDeprecatedDescription(): ?string
-            {
-                return null;
-            }
-
-            public function isFinal(): TrinaryLogic
-            {
-                return TrinaryLogic::createNo();
-            }
-
-            public function isInternal(): TrinaryLogic
-            {
-                return TrinaryLogic::createNo();
-            }
-
-            public function getThrowType(): ?Type
-            {
-                return null;
-            }
-
-            public function hasSideEffects(): TrinaryLogic
-            {
-                return TrinaryLogic::createNo();
-            }
-        };
+        return new DynamicWhereMethodReflection($classReflection, $methodName);
     }
 }
diff --git a/src/Methods/ViewWithMethodsClassReflectionExtension.php b/src/Methods/ViewWithMethodsClassReflectionExtension.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace NunoMaduro\Larastan\Methods;
+
+use NunoMaduro\Larastan\Reflection\DynamicWhereMethodReflection;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\MethodsClassReflectionExtension;
+
+class ViewWithMethodsClassReflectionExtension implements MethodsClassReflectionExtension
+{
+    public function hasMethod(ClassReflection $classReflection, string $methodName): bool
+    {
+        if ($classReflection->getName() !== 'Illuminate\View\View') {
+            return false;
+        }
+
+        if (! str_starts_with($methodName, 'with')) {
+            return false;
+        }
+
+        return true;
+    }
+
+    public function getMethod(
+        ClassReflection $classReflection,
+        string $methodName
+    ): MethodReflection {
+        return new DynamicWhereMethodReflection($classReflection, $methodName);
+    }
+}
diff --git a/src/Reflection/DynamicWhereMethodReflection.php b/src/Reflection/DynamicWhereMethodReflection.php
@@ -0,0 +1,136 @@
+<?php
+
+namespace NunoMaduro\Larastan\Reflection;
+
+use PHPStan\Reflection;
+use PHPStan\Reflection\FunctionVariant;
+use PHPStan\Reflection\ParameterReflection;
+use PHPStan\TrinaryLogic;
+use PHPStan\Type\Generic\TemplateTypeMap;
+use PHPStan\Type\MixedType;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+
+final class DynamicWhereMethodReflection implements Reflection\MethodReflection
+{
+    private Reflection\ClassReflection $classReflection;
+
+    private string $methodName;
+
+    public function __construct(Reflection\ClassReflection $classReflection, string $methodName)
+    {
+        $this->classReflection = $classReflection;
+        $this->methodName = $methodName;
+    }
+
+    public function getDeclaringClass(): Reflection\ClassReflection
+    {
+        return $this->classReflection;
+    }
+
+    public function isStatic(): bool
+    {
+        return false;
+    }
+
+    public function isPrivate(): bool
+    {
+        return false;
+    }
+
+    public function isPublic(): bool
+    {
+        return true;
+    }
+
+    public function getDocComment(): ?string
+    {
+        return null;
+    }
+
+    public function getName(): string
+    {
+        return $this->methodName;
+    }
+
+    public function getPrototype(): Reflection\ClassMemberReflection
+    {
+        return $this;
+    }
+
+    public function getVariants(): array
+    {
+        return [
+            new FunctionVariant(
+                TemplateTypeMap::createEmpty(),
+                TemplateTypeMap::createEmpty(),
+                [
+                    new class implements ParameterReflection
+                    {
+                        public function getName(): string
+                        {
+                            return 'dynamic-with';
+                        }
+
+                        public function isOptional(): bool
+                        {
+                            return false;
+                        }
+
+                        public function getType(): \PHPStan\Type\Type
+                        {
+                            return new MixedType();
+                        }
+
+                        public function passedByReference(): \PHPStan\Reflection\PassedByReference
+                        {
+                            return Reflection\PassedByReference::createNo();
+                        }
+
+                        public function isVariadic(): bool
+                        {
+                            return false;
+                        }
+
+                        public function getDefaultValue(): ?\PHPStan\Type\Type
+                        {
+                            return null;
+                        }
+                    },
+                ],
+                false,
+                new ObjectType($this->classReflection->getName())
+            ),
+        ];
+    }
+
+    public function isDeprecated(): TrinaryLogic
+    {
+        return TrinaryLogic::createNo();
+    }
+
+    public function getDeprecatedDescription(): ?string
+    {
+        return null;
+    }
+
+    public function isFinal(): TrinaryLogic
+    {
+        return TrinaryLogic::createNo();
+    }
+
+    public function isInternal(): TrinaryLogic
+    {
+        return TrinaryLogic::createNo();
+    }
+
+    public function getThrowType(): ?Type
+    {
+        return null;
+    }
+
+    public function hasSideEffects(): TrinaryLogic
+    {
+        return TrinaryLogic::createNo();
+    }
+}
diff --git a/tests/Type/GeneralTypeTest.php b/tests/Type/GeneralTypeTest.php
@@ -23,6 +23,7 @@ public function dataFileAsserts(): iterable
         yield from $this->gatherAssertTypes(__DIR__.'/data/translate.php');
         yield from $this->gatherAssertTypes(__DIR__.'/data/model-factories.php');
         yield from $this->gatherAssertTypes(__DIR__.'/data/environment-helper.php');
+        yield from $this->gatherAssertTypes(__DIR__.'/data/view.php');
     }
 
     /**

diff --git a/tests/Type/data/view.php b/tests/Type/data/view.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace IlluminateView;
+
+use function PHPStan\Testing\assertType;
+
+assertType('Illuminate\View\View', view('foo'));
+assertType('Illuminate\View\View', view('foo')->with('bar', 'baz'));
+assertType('Illuminate\View\View', view('foo')->withFoo('bar'));