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

  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.         'make' => [
  36.             '_default' => ['MakerBundle', 'symfony/maker-bundle --dev'],
  37.         ],
  38.         'server' => [
  39.             '_default' => ['Debug Bundle', 'symfony/debug-bundle --dev'],
  40.         ],
  41.     ];
  43.     public function onConsoleError(ConsoleErrorEvent $event): void
  44.     {
  45.         if (!$event->getError() instanceof CommandNotFoundException) {
  46.             return;
  47.         }
  49.         [$namespace, $command] = explode(':', $event->getInput()->getFirstArgument()) + [1 => ''];
  51.         if (!isset(self::PACKAGES[$namespace])) {
  52.             return;
  53.         }
  55.         if (isset(self::PACKAGES[$namespace][$command])) {
  56.             $suggestion = self::PACKAGES[$namespace][$command];
  57.             $exact = true;
  58.         } else {
  59.             $suggestion = self::PACKAGES[$namespace]['_default'];
  60.             $exact = false;
  61.         }
  63.         $error = $event->getError();
  65.         if ($error->getAlternatives() && !$exact) {
  66.             return;
  67.         }
  69.         $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]);
  70.         $event->setError(new CommandNotFoundException($message));
  71.     }
  73.     public static function getSubscribedEvents(): array
  74.     {
  75.         return [
  76.             ConsoleEvents::ERROR => ['onConsoleError', 0],
  77.         ];
  78.     }
  79. }