src/EventSubscriber/CheckRequirementsSubscriber.php line 58

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 App\EventSubscriber;
  14. use Doctrine\DBAL\Exception\DriverException;
  15. use Doctrine\ORM\EntityManagerInterface;
  16. use Symfony\Component\Console\ConsoleEvents;
  17. use Symfony\Component\Console\Event\ConsoleErrorEvent;
  18. use Symfony\Component\Console\Style\SymfonyStyle;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  20. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  21. use Symfony\Component\HttpKernel\KernelEvents;
  23. /**
  24.  * This application uses by default an SQLite database to store its information.
  25.  * That's why the 'sqlite3' extension must be enabled in PHP. This event
  26.  * subscriber listens to console events and in case of an exception caused by
  27.  * a disabled 'sqlite3' extension, it displays a meaningful error message.
  28.  *
  29.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  30.  */
  31. class CheckRequirementsSubscriber implements EventSubscriberInterface
  32. {
  33.     public function __construct(
  34.         private EntityManagerInterface $entityManager
  35.     ) {
  36.     }
  38.     // Event Subscribers must define this method to declare the events they
  39.     // listen to. You can listen to several events, execute more than one method
  40.     // for each event and set the priority of each event too.
  41.     // See https://symfony.com/doc/current/event_dispatcher.html#creating-an-event-subscriber
  42.     public static function getSubscribedEvents(): array
  43.     {
  44.         return [
  45.             // Errors are one of the events defined by the Console. See the
  46.             // rest here: https://symfony.com/doc/current/components/console/events.html
  47.             ConsoleEvents::ERROR => 'handleConsoleError',
  48.             // See: https://symfony.com/doc/current/components/http_kernel.html#component-http-kernel-event-table
  49.             KernelEvents::EXCEPTION => 'handleKernelException',
  50.         ];
  51.     }
  53.     /**
  54.      * This method checks if there has been an error in a command related to
  55.      * the database and then, it checks if the 'sqlite3' PHP extension is enabled
  56.      * or not to display a better error message.
  57.      */
  58.     public function handleConsoleError(ConsoleErrorEvent $event): void
  59.     {
  60.         $commandNames = ['doctrine:fixtures:load', 'doctrine:database:create', 'doctrine:schema:create', 'doctrine:database:drop'];
  62.         if ($event->getCommand() && \in_array($event->getCommand()->getName(), $commandNames, true)) {
  63.             if ($this->isSQLitePlatform() && !\extension_loaded('sqlite3')) {
  64.                 $io = new SymfonyStyle($event->getInput(), $event->getOutput());
  65.                 $io->error('This command requires to have the "sqlite3" PHP extension enabled because, by default, the Symfony Demo application uses SQLite to store its information.');
  66.             }
  67.         }
  68.     }
  70.     /**
  71.      * This method checks if the triggered exception is related to the database
  72.      * and then, it checks if the required 'sqlite3' PHP extension is enabled.
  73.      */
  74.     public function handleKernelException(ExceptionEvent $event): void
  75.     {
  76.         $exception = $event->getThrowable();
  77.         // Since any exception thrown during a Twig template rendering is wrapped
  78.         // in a Twig_Error_Runtime, we must get the original exception.
  79.         $previousException = $exception->getPrevious();
  81.         // Driver exception may happen in controller or in twig template rendering
  82.         $isDriverException = ($exception instanceof DriverException || $previousException instanceof DriverException);
  84.         // Check if SQLite is enabled
  85.         if ($isDriverException && $this->isSQLitePlatform() && !\extension_loaded('sqlite3')) {
  86.             $event->setThrowable(new \Exception('PHP extension "sqlite3" must be enabled because, by default, the Symfony Demo application uses SQLite to store its information.'));
  87.         }
  88.     }
  90.     /**
  91.      * Checks if the application is using SQLite as its database.
  92.      */
  93.     private function isSQLitePlatform(): bool
  94.     {
  95.         $databasePlatform = $this->entityManager->getConnection()->getDatabasePlatform();
  97.         return $databasePlatform ? 'sqlite' === $databasePlatform->getName() : false;
  98.     }
  99. }