vendor/easycorp/easyadmin-bundle/src/Command/MakeAdminDashboardCommand.php line 27

Open in your IDE?
  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Command;
  5. use EasyCorp\Bundle\EasyAdminBundle\Maker\ClassMaker;
  6. use Symfony\Component\Console\Command\Command;
  7. use Symfony\Component\Console\Input\InputInterface;
  8. use Symfony\Component\Console\Output\OutputInterface;
  9. use Symfony\Component\Console\Style\SymfonyStyle;
  10. use Symfony\Component\Filesystem\Filesystem;
  11. use Symfony\Component\HttpKernel\Kernel;
  12. use Symfony\Component\String\Slugger\AsciiSlugger;
  13. use function Symfony\Component\String\u;
  15. /**
  16. * Generates the PHP class needed to define a Dashboard controller.
  17. *
  18. * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  19. */
  20. class MakeAdminDashboardCommand extends Command
  21. {
  22. protected static $defaultName = 'make:admin:dashboard';
  23. protected static $defaultDescription = 'Creates a new EasyAdmin Dashboard class';
  24. private $classMaker;
  25. private $projectDir;
  27. public function __construct(ClassMaker $classMaker, string $projectDir, string $name = null)
  28. {
  29. parent::__construct($name);
  30. $this->classMaker = $classMaker;
  31. $this->projectDir = $projectDir;
  32. }
  34. protected function configure()
  35. {
  36. $this
  37. ->setDescription(self::$defaultDescription)
  38. ->setHelp($this->getCommandHelp())
  39. ;
  40. }
  42. /**
  43. * @return int
  44. */
  45. protected function execute(InputInterface $input, OutputInterface $output)
  46. {
  47. $io = new SymfonyStyle($input, $output);
  48. $fs = new Filesystem();
  50. $controllerClassName = $io->ask('Which class name do you prefer for your Dashboard controller?', 'DashboardController', static function (string $className) {
  51. return u($className)->ensureEnd('Controller')->toString();
  52. });
  54. $projectDir = $this->projectDir;
  55. $controllerDir = $io->ask(
  56. sprintf('In which directory of your project do you want to generate "%s"?', $controllerClassName),
  57. 'src/Controller/Admin/',
  58. static function (string $selectedDir) use ($fs, $projectDir) {
  59. $absoluteDir = u($selectedDir)->ensureStart($projectDir.\DIRECTORY_SEPARATOR);
  60. if (null !== $absoluteDir->indexOf('..')) {
  61. throw new \RuntimeException(sprintf('The given directory path can\'t contain ".." and must be relative to the project directory (which is "%s")', $projectDir));
  62. }
  64. $fs->mkdir($absoluteDir);
  66. if (!$fs->exists($absoluteDir)) {
  67. throw new \RuntimeException('The given directory does not exist and couldn\'t be created. Type in the path of an existing directory relative to your project root (e.g. src/Controller/Admin/)');
  68. }
  70. return $absoluteDir->after($projectDir.\DIRECTORY_SEPARATOR)->trimEnd(\DIRECTORY_SEPARATOR)->toString();
  71. }
  72. );
  74. $controllerFilePath = sprintf('%s/%s.php', u($controllerDir)->ensureStart($projectDir.\DIRECTORY_SEPARATOR), $controllerClassName);
  75. if ($fs->exists($controllerFilePath)) {
  76. throw new \RuntimeException(sprintf('The "%s.php" file already exists in the given "%s" directory. Use a different controller name or generate it in a different directory.', $controllerClassName, $controllerDir));
  77. }
  79. $guessedNamespace = u($controllerDir)->equalsTo('src')
  80. ? 'App'
  81. : u($controllerDir)->replace('/', ' ')->replace('\\', ' ')->replace('src ', 'app ')->title(true)->replace(' ', '\\')->trimEnd('\\');
  83. $generatedFilePath = $this->classMaker->make(sprintf('%s/%s.php', $controllerDir, $controllerClassName), 'dashboard.tpl', [
  84. 'namespace' => $guessedNamespace,
  85. 'site_title' => $this->getSiteTitle($this->projectDir),
  86. 'use_php_attributes' => $this->canUsePhpAttributes(),
  87. ]);
  89. $io = new SymfonyStyle($input, $output);
  90. $io->success('Your dashboard class has been successfully generated.');
  91. $io->text('Next steps:');
  92. $io->listing([
  93. sprintf('Configure your Dashboard at "%s"', $generatedFilePath),
  94. 'Run "make:admin:crud" to generate CRUD controllers and link them from the Dashboard.',
  95. ]);
  97. return 0;
  98. }
  100. private function getSiteTitle(string $projectDir): string
  101. {
  102. $guessedTitle = (new AsciiSlugger())
  103. ->slug(basename($projectDir), ' ')
  104. ->title(true)
  105. ->trim()
  106. ->toString();
  108. return empty($guessedTitle) ? 'EasyAdmin' : $guessedTitle;
  109. }
  111. private function canUsePhpAttributes(): bool
  112. {
  113. return Kernel::VERSION_ID >= 50200 && version_compare($this->phpVersionRequiredByProject(), '8.0', '>=');
  114. }
  116. /**
  117. * Based on Symfony\Bundle\MakerBundle\Util\PhpCompatUtil
  118. * https://github.com/symfony/maker-bundle/blob/main/src/Util/PhpCompatUtil.php
  119. * (c) Jesse Rushlow <jr@rushlow.dev>.
  120. */
  121. private function phpVersionRequiredByProject(): string
  122. {
  123. $composerLockPath = sprintf('%s/composer.lock', $this->projectDir);
  124. if (!file_exists($composerLockPath)) {
  125. return \PHP_VERSION;
  126. }
  128. $lockFileContents = json_decode(file_get_contents($composerLockPath), true);
  130. $phpVersionRequirement = $lockFileContents['platform-overrides']['php'] ?? $lockFileContents['platform']['php'] ?? \PHP_VERSION;
  131. // e.g. $phpVersionRequirement = '>=7.2.5', $phpVersion = '7.2.5'
  132. $phpVersion = preg_replace('/[^0-9\.]/', '', $phpVersionRequirement);
  134. return $phpVersion;
  135. }
  137. private function getCommandHelp()
  138. {
  139. return <<<'HELP'
  140. The <info>%command.name%</info> command creates a new EasyAdmin Dashboard class
  141. in your application. Follow the steps shown by the command to configure the
  142. name and location of the new class.
  144. This command never changes or overwrites an existing class, so you can run it
  145. safely as many times as needed to create multiple dashboards.
  146. HELP
  147. ;
  148. }
  149. }