Transaction.php

<?php

namespace Drupal\Core\Database;


/**
 * A wrapper class for creating and managing database transactions.
 *
 * Not all databases or database configurations support transactions. For
 * example, MySQL MyISAM tables do not. It is also easy to begin a transaction
 * and then forget to commit it, which can lead to connection errors when
 * another transaction is started.
 *
 * This class acts as a wrapper for transactions. To begin a transaction,
 * simply instantiate it. When the object goes out of scope and is destroyed
 * it will automatically commit. It also will check to see if the specified
 * connection supports transactions. If not, it will simply skip any transaction
 * commands, allowing user-space code to proceed normally. The only difference
 * is that rollbacks won't actually do anything.
 *
 * In the vast majority of cases, you should not instantiate this class
 * directly. Instead, call ->startTransaction(), from the appropriate connection
 * object.
 */
class Transaction {
    
    /**
     * The connection object for this transaction.
     *
     * @var \Drupal\Core\Database\Connection
     */
    protected $connection;
    
    /**
     * A boolean value to indicate whether this transaction has been rolled back.
     *
     * @var bool
     *
     * @deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. There is
     *   no replacement.
     *
     * @see https://www.drupal.org/node/3381002
     */
    protected $rolledBack = FALSE;
    
    /**
     * The name of the transaction.
     *
     * This is used to label the transaction savepoint. It will be overridden to
     * 'drupal_transaction' if there is no transaction depth.
     *
     * @var string
     */
    protected $name;
    public function __construct(Connection $connection, $name = NULL, string $id = '') {
        // Transactions rely on objects being destroyed in order to be committed.
        // PHP makes no guarantee about the order in which objects are destroyed so
        // ensure all transactions are committed on shutdown.
        Database::commitAllOnShutdown();
        if ($connection->transactionManager()) {
            $this->connection = $connection;
            $this->name = $name;
            return;
        }
        // Start of BC layer.
        $this->connection = $connection;
        // If there is no transaction depth, then no transaction has started. Name
        // the transaction 'drupal_transaction'.
        // @phpstan-ignore-next-line
        if (!($depth = $connection->transactionDepth())) {
            $this->name = 'drupal_transaction';
        }
        elseif (!$name) {
            $this->name = 'savepoint_' . $depth;
        }
        else {
            $this->name = $name;
        }
        // @phpstan-ignore-next-line
        $this->connection
            ->pushTransaction($this->name);
        // End of BC layer.
    }
    public function __destruct() {
        if ($this->connection
            ->transactionManager()) {
            $this->connection
                ->transactionManager()
                ->unpile($this->name, $this->id);
            return;
        }
        // Start of BC layer.
        // If we rolled back then the transaction would have already been popped.
        // @phpstan-ignore-next-line
        if (!$this->rolledBack) {
            // @phpstan-ignore-next-line
            $this->connection
                ->popTransaction($this->name);
        }
        // End of BC layer.
    }
    
    /**
     * Retrieves the name of the transaction or savepoint.
     */
    public function name() {
        return $this->name;
    }
    
    /**
     * Rolls back the current transaction.
     *
     * This is just a wrapper method to rollback whatever transaction stack we are
     * currently in, which is managed by the connection object itself. Note that
     * logging needs to happen after a transaction has been rolled back or the log
     * messages will be rolled back too.
     *
     * @see \Drupal\Core\Database\Connection::rollBack()
     */
    public function rollBack() {
        if ($this->connection
            ->transactionManager()) {
            $this->connection
                ->transactionManager()
                ->rollback($this->name, $this->id);
            return;
        }
        // Start of BC layer.
        // @phpstan-ignore-next-line
        $this->rolledBack = TRUE;
        // @phpstan-ignore-next-line
        $this->connection
            ->rollBack($this->name);
        // End of BC layer.
    }

}