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

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Command;
  5. use EasyCorp\Bundle\EasyAdminBundle\Maker\ClassMaker;
  6. use Symfony\Component\Console\Attribute\AsCommand;
  7. use Symfony\Component\Console\Command\Command;
  8. use Symfony\Component\Console\Input\InputInterface;
  9. use Symfony\Component\Console\Output\OutputInterface;
  10. use Symfony\Component\Console\Style\SymfonyStyle;
  11. use Symfony\Component\Filesystem\Filesystem;
  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. #[AsCommand(
  21.     name: 'make:admin:dashboard',
  22.     description: 'Creates a new EasyAdmin Dashboard class',
  23. )]
  24. class MakeAdminDashboardCommand extends Command
  25. {
  26.     private ClassMaker $classMaker;
  27.     private string $projectDir;
  29.     public function __construct(ClassMaker $classMaker, string $projectDir, string $name = null)
  30.     {
  31.         parent::__construct($name);
  32.         $this->classMaker = $classMaker;
  33.         $this->projectDir = $projectDir;
  34.     }
  36.     protected function configure()
  37.     {
  38.         $this
  39.             ->setHelp($this->getCommandHelp())
  40.         ;
  41.     }
  43.     protected function execute(InputInterface $input, OutputInterface $output): int
  44.     {
  45.         $io = new SymfonyStyle($input, $output);
  46.         $fs = new Filesystem();
  48.         $controllerClassName = $io->ask(
  49.             'Which class name do you prefer for your Dashboard controller?',
  50.             'DashboardController',
  51.             fn (string $className): string => 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.         ]);
  88.         $io = new SymfonyStyle($input, $output);
  89.         $io->success('Your dashboard class has been successfully generated.');
  90.         $io->text('Next steps:');
  91.         $io->listing([
  92.             sprintf('Configure your Dashboard at "%s"', $generatedFilePath),
  93.             'Run "make:admin:crud" to generate CRUD controllers and link them from the Dashboard.',
  94.         ]);
  96.         return Command::SUCCESS;
  97.     }
  99.     private function getSiteTitle(string $projectDir): string
  100.     {
  101.         $guessedTitle = (new AsciiSlugger())
  102.             ->slug(basename($projectDir), ' ')
  103.             ->title(true)
  104.             ->trim()
  105.             ->toString();
  107.         return '' === $guessedTitle ? 'EasyAdmin' : $guessedTitle;
  108.     }
  110.     private function getCommandHelp(): string
  111.     {
  112.         return <<<'HELP'
  113.             The <info>%command.name%</info> command creates a new EasyAdmin Dashboard class
  114.             in your application. Follow the steps shown by the command to configure the
  115.             name and location of the new class.
  117.             This command never changes or overwrites an existing class, so you can run it
  118.             safely as many times as needed to create multiple dashboards.
  119.             HELP;
  120.     }
  121. }