vendor/symfony/doctrine-bridge/SchemaListener/MessengerTransportDoctrineSchemaSubscriber.php line 27

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\Bridge\Doctrine\SchemaListener;
  14. use Doctrine\Common\EventSubscriber;
  15. use Doctrine\DBAL\Event\SchemaCreateTableEventArgs;
  16. use Doctrine\DBAL\Events;
  17. use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
  18. use Doctrine\ORM\Tools\ToolEvents;
  19. use Symfony\Component\Messenger\Bridge\Doctrine\Transport\DoctrineTransport;
  20. use Symfony\Component\Messenger\Transport\TransportInterface;
  22. /**
  23.  * Automatically adds any required database tables to the Doctrine Schema.
  24.  *
  25.  * @author Ryan Weaver <ryan@symfonycasts.com>
  26.  */
  27. final class MessengerTransportDoctrineSchemaSubscriber implements EventSubscriber
  28. {
  29.     private const PROCESSING_TABLE_FLAG = self::class.':processing';
  31.     private $transports;
  33.     /**
  34.      * @param iterable<mixed, TransportInterface> $transports
  35.      */
  36.     public function __construct(iterable $transports)
  37.     {
  38.         $this->transports = $transports;
  39.     }
  41.     public function postGenerateSchema(GenerateSchemaEventArgs $event): void
  42.     {
  43.         $dbalConnection = $event->getEntityManager()->getConnection();
  44.         foreach ($this->transports as $transport) {
  45.             if (!$transport instanceof DoctrineTransport) {
  46.                 continue;
  47.             }
  49.             $transport->configureSchema($event->getSchema(), $dbalConnection);
  50.         }
  51.     }
  53.     public function onSchemaCreateTable(SchemaCreateTableEventArgs $event): void
  54.     {
  55.         $table = $event->getTable();
  57.         // if this method triggers a nested create table below, allow Doctrine to work like normal
  58.         if ($table->hasOption(self::PROCESSING_TABLE_FLAG)) {
  59.             return;
  60.         }
  62.         foreach ($this->transports as $transport) {
  63.             if (!$transport instanceof DoctrineTransport) {
  64.                 continue;
  65.             }
  67.             if (!$extraSql = $transport->getExtraSetupSqlForTable($table)) {
  68.                 continue;
  69.             }
  71.             // avoid this same listener from creating a loop on this table
  72.             $table->addOption(self::PROCESSING_TABLE_FLAG, true);
  73.             $createTableSql = $event->getPlatform()->getCreateTableSQL($table);
  75.             /*
  76.              * Add all the SQL needed to create the table and tell Doctrine
  77.              * to "preventDefault" so that only our SQL is used. This is
  78.              * the only way to inject some extra SQL.
  79.              */
  80.             $event->addSql($createTableSql);
  81.             foreach ($extraSql as $sql) {
  82.                 $event->addSql($sql);
  83.             }
  84.             $event->preventDefault();
  86.             return;
  87.         }
  88.     }
  90.     public function getSubscribedEvents(): array
  91.     {
  92.         $subscribedEvents = [];
  94.         if (class_exists(ToolEvents::class)) {
  95.             $subscribedEvents[] = ToolEvents::postGenerateSchema;
  96.         }
  98.         if (class_exists(Events::class)) {
  99.             $subscribedEvents[] = Events::onSchemaCreateTable;
  100.         }
  102.         return $subscribedEvents;
  103.     }
  104. }