function TransactionManagerBase::addPostTransactionCallback

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Database/Transaction/TransactionManagerBase.php \Drupal\Core\Database\Transaction\TransactionManagerBase::addPostTransactionCallback()

Adds a root transaction end callback.

These callbacks are invoked immediately after the client transaction has been committed or rolled back.

It can for example be used to avoid deadlocks on write-heavy tables that do not need to be part of the transaction, like cache tag invalidations.

Another use case is that services using alternative backends like Redis and Memcache cache implementations can replicate the transaction-behavior of the database cache backend and avoid race conditions.

An argument is passed to the callbacks that indicates whether the transaction was successful or not.

Parameters

callable $callback: The callback to invoke.

Overrides TransactionManagerInterface::addPostTransactionCallback

File

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

Class

TransactionManagerBase
The database transaction manager base class.

Namespace

Drupal\Core\Database\Transaction

Code

public function addPostTransactionCallback(callable $callback) : void {
    if (!$this->inTransaction()) {
        throw new \LogicException('Root transaction end callbacks can only be added when there is an active transaction.');
    }
    $this->postTransactionCallbacks[] = $callback;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.