Merge pull request #236 from kotfire/master

Support custom validator method on laravel FormRequest

Author: shalvah

src/Mpociot/ApiDoc/Generators/LaravelGenerator.php

@@ -11,6 +11,7 @@
 use Illuminate\Support\Facades\Request;
 use League\Fractal\Resource\Collection;
 use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Contracts\Validation\Factory as ValidationFactory;
 
 class LaravelGenerator extends AbstractGenerator
 {
@@ -278,7 +279,9 @@ protected function getRouteRules($route, $bindings)
                     $parameterReflection->request->add($bindings);
 
                     if (method_exists($parameterReflection, 'validator')) {
-                        return app()->call([$parameterReflection, 'validator'])
+                        $factory = app()->make(ValidationFactory::class);
+
+                        return app()->call([$parameterReflection, 'validator'], [$factory])
                             ->getRules();
                     } else {
                         return app()->call([$parameterReflection, 'rules']);

tests/ApiDocGeneratorTest.php

@@ -337,6 +337,16 @@ public function testCanParseFormRequestRules()
         }
     }
 
+    public function testCustomFormRequestValidatorIsSupported()
+    {
+        RouteFacade::post('/post', TestController::class.'@customFormRequestValidator');
+        $route = new Route(['POST'], '/post', ['uses' => TestController::class.'@customFormRequestValidator']);
+        $parsed = $this->generator->processRoute($route);
+        $parameters = $parsed['parameters'];
+
+        $this->assertNotEmpty($parameters);
+    }
+
     public function testCanParseResponseTag()
     {
         RouteFacade::post('/responseTag', TestController::class.'@responseTag');

tests/Fixtures/CustomValidatorRequest.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Mpociot\ApiDoc\Tests\Fixtures;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class CustomValidatorRequest extends FormRequest
+{
+    /**
+     * Validate the input.
+     *
+     * @param \Illuminate\Validation\Factory $factory
+     *
+     * @return \Illuminate\Validation\Validator
+     */
+    public function validator($factory)
+    {
+        return $factory->make(
+            $this->validationData(), $this->container->call([$this, 'foo']),
+            $this->messages(), $this->attributes()
+        );
+    }
+
+    public function foo()
+    {
+        return [
+            'required' => 'required',
+        ];
+    }
+}

tests/Fixtures/TestController.php

@@ -27,6 +27,11 @@ public function parseFormRequestRules(TestRequest $request)
         return '';
     }
 
+    public function customFormRequestValidator(CustomValidatorRequest $request)
+    {
+        return '';
+    }
+
     public function addRouteBindingsToRequestClass(DynamicRequest $request)
     {
         return '';