Merge pull request #1120 from l-vo/return_json_response_when_json_met…

…hod_used [make:controller] Return a JsonResponse instead of a Response with --no-template
symfony · May 16, 2022 · 23d71ff · 23d71ff
2 parents fc9f6bc + 4aebedf
commit 23d71ff
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/src/Maker/MakeController.php b/src/Maker/MakeController.php
@@ -25,6 +25,7 @@
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\Routing\Annotation\Route;
@@ -73,13 +74,14 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
             'Controller'
         );
 
+        $withTemplate = $this->isTwigInstalled() && !$input->getOption('no-template');
+
         $useStatements = new UseStatementGenerator([
             AbstractController::class,
-            Response::class,
+            $withTemplate ? Response::class : JsonResponse::class,
             Route::class,
         ]);
 
-        $noTemplate = $input->getOption('no-template');
         $templateName = Str::asFilePath($controllerClassNameDetails->getRelativeNameWithoutSuffix()).'/index.html.twig';
         $controllerPath = $generator->generateController(
             $controllerClassNameDetails->getFullName(),
@@ -88,12 +90,12 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
                 'use_statements' => $useStatements,
                 'route_path' => Str::asRoutePath($controllerClassNameDetails->getRelativeNameWithoutSuffix()),
                 'route_name' => Str::asRouteName($controllerClassNameDetails->getRelativeNameWithoutSuffix()),
-                'with_template' => $this->isTwigInstalled() && !$noTemplate,
+                'with_template' => $withTemplate,
                 'template_name' => $templateName,
             ]
         );
 
-        if ($this->isTwigInstalled() && !$noTemplate) {
+        if ($withTemplate) {
             $generator->generateTemplate(
                 $templateName,
                 'controller/twig_template.tpl.php',

diff --git a/src/Resources/skeleton/controller/Controller.tpl.php b/src/Resources/skeleton/controller/Controller.tpl.php
@@ -7,7 +7,8 @@
 class <?= $class_name; ?> extends AbstractController
 {
 <?= $generator->generateRouteForControllerMethod($route_path, $route_name); ?>
-    public function index(): Response
+    public function index(): <?php if ($with_template) { ?>Response<?php } else { ?>JsonResponse<?php } ?>
+
     {
 <?php if ($with_template) { ?>
         return $this->render('<?= $template_name ?>', [

diff --git a/tests/fixtures/make-controller/tests/it_generates_a_controller.php b/tests/fixtures/make-controller/tests/it_generates_a_controller.php
@@ -12,5 +12,7 @@ public function testController()
         $client->request('GET', '/foo/bar');
 
         $this->assertEquals(200, $client->getResponse()->getStatusCode());
+        $this->assertSame('application/json', $client->getResponse()->headers->get('Content-Type'));
+        $this->assertSame('{"message":"Welcome to your new controller!","path":"src\/Controller\/FooBarController.php"}', $client->getResponse()->getContent());
     }
 }