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

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\Response;
  29. use Symfony\Component\HttpKernel\Kernel;
  30. use Symfony\Component\Routing\Annotation\Route;
  32. /**
  33. * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  34. * @author Ryan Weaver <weaverryan@gmail.com>
  35. */
  36. final class MakeController extends AbstractMaker
  37. {
  38. private $phpCompatUtil;
  40. public function __construct(PhpCompatUtil $phpCompatUtil = null)
  41. {
  42. if (null === $phpCompatUtil) {
  43. @trigger_error(sprintf('Passing a "%s" instance is mandatory since version 1.42.0', PhpCompatUtil::class), \E_USER_DEPRECATED);
  44. }
  46. $this->phpCompatUtil = $phpCompatUtil;
  47. }
  49. public static function getCommandName(): string
  50. {
  51. return 'make:controller';
  52. }
  54. public static function getCommandDescription(): string
  55. {
  56. return 'Creates a new controller class';
  57. }
  59. public function configureCommand(Command $command, InputConfiguration $inputConfig): void
  60. {
  61. $command
  62. ->addArgument('controller-class', InputArgument::OPTIONAL, sprintf('Choose a name for your controller class (e.g. <fg=yellow>%sController</>)', Str::asClassName(Str::getRandomTerm())))
  63. ->addOption('no-template', null, InputOption::VALUE_NONE, 'Use this option to disable template generation')
  64. ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeController.txt'))
  65. ;
  66. }
  68. public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
  69. {
  70. $controllerClassNameDetails = $generator->createClassNameDetails(
  71. $input->getArgument('controller-class'),
  72. 'Controller\\',
  73. 'Controller'
  74. );
  76. $useStatements = new UseStatementGenerator([
  77. AbstractController::class,
  78. Response::class,
  79. Route::class,
  80. ]);
  82. $noTemplate = $input->getOption('no-template');
  83. $templateName = Str::asFilePath($controllerClassNameDetails->getRelativeNameWithoutSuffix()).'/index.html.twig';
  84. $controllerPath = $generator->generateController(
  85. $controllerClassNameDetails->getFullName(),
  86. 'controller/Controller.tpl.php',
  87. [
  88. 'use_statements' => $useStatements,
  89. 'route_path' => Str::asRoutePath($controllerClassNameDetails->getRelativeNameWithoutSuffix()),
  90. 'route_name' => Str::asRouteName($controllerClassNameDetails->getRelativeNameWithoutSuffix()),
  91. 'with_template' => $this->isTwigInstalled() && !$noTemplate,
  92. 'template_name' => $templateName,
  93. ]
  94. );
  96. if ($this->isTwigInstalled() && !$noTemplate) {
  97. $generator->generateTemplate(
  98. $templateName,
  99. 'controller/twig_template.tpl.php',
  100. [
  101. 'controller_path' => $controllerPath,
  102. 'root_directory' => $generator->getRootDirectory(),
  103. 'class_name' => $controllerClassNameDetails->getShortName(),
  104. ]
  105. );
  106. }
  108. $generator->writeChanges();
  110. $this->writeSuccessMessage($io);
  111. $io->text('Next: Open your new controller class and add some pages!');
  112. }
  114. public function configureDependencies(DependencyBuilder $dependencies): void
  115. {
  116. // @legacy - Remove method when support for Symfony 5.4 is dropped
  117. if (null !== $this->phpCompatUtil && 60000 <= Kernel::VERSION_ID && $this->phpCompatUtil->canUseAttributes()) {
  118. return;
  119. }
  121. $dependencies->addClassDependency(
  122. Annotation::class,
  123. 'doctrine/annotations'
  124. );
  125. }
  127. private function isTwigInstalled(): bool
  128. {
  129. return class_exists(TwigBundle::class);
  130. }
  131. }