init

backend/vendor/doctrine/migrations/src/AbstractMigration.php

@@ -0,0 +1,163 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations;
+
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Exception as DBALException;
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Schema\AbstractSchemaManager;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\Exception\AbortMigration;
+use Doctrine\Migrations\Exception\FrozenMigration;
+use Doctrine\Migrations\Exception\IrreversibleMigration;
+use Doctrine\Migrations\Exception\MigrationException;
+use Doctrine\Migrations\Exception\SkipMigration;
+use Doctrine\Migrations\Query\Query;
+use Psr\Log\LoggerInterface;
+
+use function sprintf;
+
+/**
+ * The AbstractMigration class is for end users to extend from when creating migrations. Extend this class
+ * and implement the required up() and down() methods.
+ */
+abstract class AbstractMigration
+{
+    /** @var Connection */
+    protected $connection;
+
+    /** @var AbstractSchemaManager<AbstractPlatform> */
+    protected $sm;
+
+    /** @var AbstractPlatform */
+    protected $platform;
+
+    /** @var Query[] */
+    private array $plannedSql = [];
+
+    private bool $frozen = false;
+
+    public function __construct(Connection $connection, private readonly LoggerInterface $logger)
+    {
+        $this->connection = $connection;
+        $this->sm         = $this->connection->createSchemaManager();
+        $this->platform   = $this->connection->getDatabasePlatform();
+    }
+
+    /**
+     * Indicates the transactional mode of this migration.
+     *
+     * If this function returns true (default) the migration will be executed
+     * in one transaction, otherwise non-transactional state will be used to
+     * execute each of the migration SQLs.
+     *
+     * Extending class should override this function to alter the return value.
+     */
+    public function isTransactional(): bool
+    {
+        return true;
+    }
+
+    public function getDescription(): string
+    {
+        return '';
+    }
+
+    public function warnIf(bool $condition, string $message = 'Unknown Reason'): void
+    {
+        if (! $condition) {
+            return;
+        }
+
+        $this->logger->warning($message, ['migration' => $this]);
+    }
+
+    /** @throws AbortMigration */
+    public function abortIf(bool $condition, string $message = 'Unknown Reason'): void
+    {
+        if ($condition) {
+            throw new AbortMigration($message);
+        }
+    }
+
+    /** @throws SkipMigration */
+    public function skipIf(bool $condition, string $message = 'Unknown Reason'): void
+    {
+        if ($condition) {
+            throw new SkipMigration($message);
+        }
+    }
+
+    /** @throws MigrationException|DBALException */
+    public function preUp(Schema $schema): void
+    {
+    }
+
+    /** @throws MigrationException|DBALException */
+    public function postUp(Schema $schema): void
+    {
+    }
+
+    /** @throws MigrationException|DBALException */
+    public function preDown(Schema $schema): void
+    {
+    }
+
+    /** @throws MigrationException|DBALException */
+    public function postDown(Schema $schema): void
+    {
+    }
+
+    /** @throws MigrationException|DBALException */
+    abstract public function up(Schema $schema): void;
+
+    /** @throws MigrationException|DBALException */
+    public function down(Schema $schema): void
+    {
+        $this->abortIf(true, sprintf('No down() migration implemented for "%s"', static::class));
+    }
+
+    /**
+     * @param mixed[] $params
+     * @param mixed[] $types
+     */
+    protected function addSql(
+        string $sql,
+        array $params = [],
+        array $types = [],
+    ): void {
+        if ($this->frozen) {
+            throw FrozenMigration::new();
+        }
+
+        $this->plannedSql[] = new Query($sql, $params, $types);
+    }
+
+    /** @return Query[] */
+    public function getSql(): array
+    {
+        return $this->plannedSql;
+    }
+
+    public function freeze(): void
+    {
+        $this->frozen = true;
+    }
+
+    protected function write(string $message): void
+    {
+        $this->logger->notice($message, ['migration' => $this]);
+    }
+
+    /** @throws IrreversibleMigration */
+    protected function throwIrreversibleMigrationException(string|null $message = null): void
+    {
+        if ($message === null) {
+            $message = 'This migration is irreversible and cannot be reverted.';
+        }
+
+        throw new IrreversibleMigration($message);
+    }
+}