vendor/symfony/framework-bundle/EventListener/SuggestMissingPackageSubscriber.php line 46

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony 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\FrameworkBundle\EventListener;
  14. use Symfony\Component\Console\ConsoleEvents;
  15. use Symfony\Component\Console\Event\ConsoleErrorEvent;
  16. use Symfony\Component\Console\Exception\CommandNotFoundException;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  19. /**
  20. * Suggests a package, that should be installed (via composer),
  21. * if the package is missing, and the input command namespace can be mapped to a Symfony bundle.
  22. *
  23. * @author Przemysław Bogusz <przemyslaw.bogusz@tubotax.pl>
  24. *
  25. * @internal
  26. */
  27. final class SuggestMissingPackageSubscriber implements EventSubscriberInterface
  28. {
  29. private const PACKAGES = [
  30. 'doctrine' => [
  31. 'fixtures' => ['DoctrineFixturesBundle', 'doctrine/doctrine-fixtures-bundle --dev'],
  32. 'mongodb' => ['DoctrineMongoDBBundle', 'doctrine/mongodb-odm-bundle'],
  33. '_default' => ['Doctrine ORM', 'symfony/orm-pack'],
  34. ],
  35. 'generate' => [
  36. '_default' => ['SensioGeneratorBundle', 'sensio/generator-bundle'],
  37. ],
  38. 'make' => [
  39. '_default' => ['MakerBundle', 'symfony/maker-bundle --dev'],
  40. ],
  41. 'server' => [
  42. '_default' => ['Debug Bundle', 'symfony/debug-bundle --dev'],
  43. ],
  44. ];
  46. public function onConsoleError(ConsoleErrorEvent $event): void
  47. {
  48. if (!$event->getError() instanceof CommandNotFoundException) {
  49. return;
  50. }
  52. [$namespace, $command] = explode(':', $event->getInput()->getFirstArgument()) + [1 => ''];
  54. if (!isset(self::PACKAGES[$namespace])) {
  55. return;
  56. }
  58. if (isset(self::PACKAGES[$namespace][$command])) {
  59. $suggestion = self::PACKAGES[$namespace][$command];
  60. $exact = true;
  61. } else {
  62. $suggestion = self::PACKAGES[$namespace]['_default'];
  63. $exact = false;
  64. }
  66. $error = $event->getError();
  68. if ($error->getAlternatives() && !$exact) {
  69. return;
  70. }
  72. $message = sprintf("%s\n\nYou may be looking for a command provided by the \"%s\" which is currently not installed. Try running \"composer require %s\".", $error->getMessage(), $suggestion[0], $suggestion[1]);
  73. $event->setError(new CommandNotFoundException($message));
  74. }
  76. public static function getSubscribedEvents(): array
  77. {
  78. return [
  79. ConsoleEvents::ERROR => ['onConsoleError', 0],
  80. ];
  81. }
  82. }