vendor/symfony/maker-bundle/src/Maker/MakeController.php line 41

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony MakerBundle package.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Symfony\Bundle\MakerBundle\Maker;
  14. use Doctrine\Common\Annotations\Annotation;
  15. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  16. use Symfony\Bundle\MakerBundle\ConsoleStyle;
  17. use Symfony\Bundle\MakerBundle\DependencyBuilder;
  18. use Symfony\Bundle\MakerBundle\Generator;
  19. use Symfony\Bundle\MakerBundle\InputConfiguration;
  20. use Symfony\Bundle\MakerBundle\Str;
  21. use Symfony\Bundle\MakerBundle\Util\PhpCompatUtil;
  22. use Symfony\Bundle\MakerBundle\Util\UseStatementGenerator;
  23. use Symfony\Bundle\TwigBundle\TwigBundle;
  24. use Symfony\Component\Console\Command\Command;
  25. use Symfony\Component\Console\Input\InputArgument;
  26. use Symfony\Component\Console\Input\InputInterface;
  27. use Symfony\Component\Console\Input\InputOption;
  28. use Symfony\Component\HttpFoundation\JsonResponse;
  29. use Symfony\Component\HttpFoundation\Response;
  30. use Symfony\Component\HttpKernel\Kernel;
  31. use Symfony\Component\Routing\Annotation\Route;
  33. /**
  34. * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  35. * @author Ryan Weaver <weaverryan@gmail.com>
  36. */
  37. final class MakeController extends AbstractMaker
  38. {
  39. private $phpCompatUtil;
  41. public function __construct(PhpCompatUtil $phpCompatUtil = null)
  42. {
  43. if (null === $phpCompatUtil) {
  44. @trigger_error(sprintf('Passing a "%s" instance is mandatory since version 1.42.0', PhpCompatUtil::class), \E_USER_DEPRECATED);
  45. }
  47. $this->phpCompatUtil = $phpCompatUtil;
  48. }
  50. public static function getCommandName(): string
  51. {
  52. return 'make:controller';
  53. }
  55. public static function getCommandDescription(): string
  56. {
  57. return 'Creates a new controller class';
  58. }
  60. public function configureCommand(Command $command, InputConfiguration $inputConfig): void
  61. {
  62. $command
  63. ->addArgument('controller-class', InputArgument::OPTIONAL, sprintf('Choose a name for your controller class (e.g. <fg=yellow>%sController</>)', Str::asClassName(Str::getRandomTerm())))
  64. ->addOption('no-template', null, InputOption::VALUE_NONE, 'Use this option to disable template generation')
  65. ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeController.txt'))
  66. ;
  67. }
  69. public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
  70. {
  71. $controllerClassNameDetails = $generator->createClassNameDetails(
  72. $input->getArgument('controller-class'),
  73. 'Controller\\',
  74. 'Controller'
  75. );
  77. $withTemplate = $this->isTwigInstalled() && !$input->getOption('no-template');
  79. $useStatements = new UseStatementGenerator([
  80. AbstractController::class,
  81. $withTemplate ? Response::class : JsonResponse::class,
  82. Route::class,
  83. ]);
  85. $templateName = Str::asFilePath($controllerClassNameDetails->getRelativeNameWithoutSuffix()).'/index.html.twig';
  86. $controllerPath = $generator->generateController(
  87. $controllerClassNameDetails->getFullName(),
  88. 'controller/Controller.tpl.php',
  89. [
  90. 'use_statements' => $useStatements,
  91. 'route_path' => Str::asRoutePath($controllerClassNameDetails->getRelativeNameWithoutSuffix()),
  92. 'route_name' => Str::asRouteName($controllerClassNameDetails->getRelativeNameWithoutSuffix()),
  93. 'with_template' => $withTemplate,
  94. 'template_name' => $templateName,
  95. ]
  96. );
  98. if ($withTemplate) {
  99. $generator->generateTemplate(
  100. $templateName,
  101. 'controller/twig_template.tpl.php',
  102. [
  103. 'controller_path' => $controllerPath,
  104. 'root_directory' => $generator->getRootDirectory(),
  105. 'class_name' => $controllerClassNameDetails->getShortName(),
  106. ]
  107. );
  108. }
  110. $generator->writeChanges();
  112. $this->writeSuccessMessage($io);
  113. $io->text('Next: Open your new controller class and add some pages!');
  114. }
  116. public function configureDependencies(DependencyBuilder $dependencies): void
  117. {
  118. // @legacy - Remove method when support for Symfony 5.4 is dropped
  119. if (null !== $this->phpCompatUtil && 60000 <= Kernel::VERSION_ID && $this->phpCompatUtil->canUseAttributes()) {
  120. return;
  121. }
  123. $dependencies->addClassDependency(
  124. Annotation::class,
  125. 'doctrine/annotations'
  126. );
  127. }
  129. private function isTwigInstalled(): bool
  130. {
  131. return class_exists(TwigBundle::class);
  132. }
  133. }