function TransactionManagerInterface::addPostTransactionCallback
Same name in other branches
- 10 core/lib/Drupal/Core/Database/Transaction/TransactionManagerInterface.php \Drupal\Core\Database\Transaction\TransactionManagerInterface::addPostTransactionCallback()
Adds a root transaction end callback.
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.
These callbacks are invoked during the destruction of the root Transaction object.
The callback should have the following signature:
callback(
bool $success,
): void
When callbacks are executed, the $success parameter passed to the callbacks is a boolean that indicates
- if TRUE, that the complete transaction was successfully committed, or in the edge case of a transaction that was auto-committed after a DDL statement, that no rollbacks were attempted after the DDL statement;
- if FALSE, that the complete transaction was rolled back, or that the transaction processing failed for any other reason.
Parameters
callable $callback: The callback to invoke.
Throws
\LogicException When a callback addition is attempted but no transaction is active.
1 method overrides TransactionManagerInterface::addPostTransactionCallback()
- TransactionManagerBase::addPostTransactionCallback in core/
lib/ Drupal/ Core/ Database/ Transaction/ TransactionManagerBase.php
File
-
core/
lib/ Drupal/ Core/ Database/ Transaction/ TransactionManagerInterface.php, line 149
Class
- TransactionManagerInterface
- Interface for the database transaction manager classes.
Namespace
Drupal\Core\Database\TransactionCode
public function addPostTransactionCallback(callable $callback) : void;
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.