function TransactionManagerBase::push

Overrides TransactionManagerInterface::push

File

core/lib/Drupal/Core/Database/Transaction/TransactionManagerBase.php, line 221

Class

TransactionManagerBase

The database transaction manager base class.

Namespace

Code

public function push(string $name = '') : Transaction {
    if (!$this->inTransaction()) {
        // If there is no transaction active, name the transaction
        // 'drupal_transaction'.
        $name = 'drupal_transaction';
    }
    elseif (!$name) {
        // Within transactions, savepoints are used. Each savepoint requires a
        // name. So if no name is present we need to create one.
        $name = 'savepoint_' . $this->stackDepth();
    }
    if ($this->has($name)) {
        throw new TransactionNameNonUniqueException("A transaction named {$name} is already in use. Active stack: " . $this->dumpStackItemsAsString());
    }
    // Do the client-level processing.
    if ($this->stackDepth() === 0) {
        $this->beginClientTransaction();
        $type = StackItemType::Root;
        $this->setConnectionTransactionState(ClientConnectionTransactionState::Active);
    }
    else {
        // If we're already in a Drupal transaction then we want to create a
        // database savepoint, rather than try to begin another database
        // transaction.
        $this->addClientSavepoint($name);
        $type = StackItemType::Savepoint;
    }
    // Define an unique id for the transaction.
    $id = uniqid('', TRUE);
    // Add an item on the stack, increasing its depth.
    $this->addStackItem($id, new StackItem($name, $type));
    // Actually return a new Transaction object.
    return new Transaction($this->connection, $name, $id);
}