[9.x] Improves $request->enum() type API (laravel#44370)

* improve input enum method * type test for input enum method * Apply fixes from StyleCI * Fixes types tests and improves wording of generics Co-authored-by: SupunKavinda <[email protected]> Co-authored-by: StyleCI Bot <[email protected]>
brenjt · Sep 29, 2022 · 22e85eb · 22e85eb
1 parent 678da30
commit 22e85eb
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/src/Illuminate/Http/Concerns/InteractsWithInput.php b/src/Illuminate/Http/Concerns/InteractsWithInput.php
@@ -372,9 +372,11 @@ public function date($key, $format = null, $tz = null)
     /**
      * Retrieve input from the request as an enum.
      *
+     * @template TEnum
+     *
      * @param  string  $key
-     * @param  string  $enumClass
-     * @return mixed|null
+     * @param  class-string<TEnum>  $enumClass
+     * @return TEnum|null
      */
     public function enum($key, $enumClass)
     {

diff --git a/types/Http/Request.php b/types/Http/Request.php
@@ -0,0 +1,14 @@
+<?php
+
+use Illuminate\Http\Request;
+use function PHPStan\Testing\assertType;
+
+class TestEnum
+{
+}
+
+$request = Request::create('/', 'GET', [
+    'key' => 'test',
+]);
+
+assertType('TestEnum|null', $request->enum('key', TestEnum::class));