DatabaseTransactionsManager
class DatabaseTransactionsManager extends DatabaseTransactionsManager
Testing-aware transaction manager that properly handles RefreshDatabase's wrapper transaction.
When RefreshDatabase wraps tests in a transaction, this manager ensures that afterCommit callbacks execute at the appropriate time (when returning to the wrapper level) rather than waiting for level 0 which never happens during wrapped tests.
Properties
| protected array<int, null|string> | $connectionsTransacting | The names of the connections transacting during tests. |
|
| protected DatabaseTransactionRecord> | $wrappingTransactions | The transaction records owned by the test wrappers. |
Methods
Get all committed transactions for the current coroutine.
Get all pending transactions for the current coroutine.
Get current transaction for a connection.
Start a new database transaction.
Commit the root database transaction and execute callbacks.
Move relevant pending transactions to a committed state.
Rollback the active database transaction.
Remove all pending, completed, and current transactions for the given connection name.
Remove and return all committed descendants of the given transaction.
Execute commit callbacks for every detached transaction.
Execute rollback callbacks for every detached transaction.
Register a transaction callback.
Register a callback for transaction rollback.
Determine whether a callback would wait for an open transaction.
Get the latest applicable transaction, optionally limited to a connection.
Get the transactions that are applicable to callbacks.
Determine if after commit callbacks should be executed for the given transaction level.
Get all of the pending transactions.
Get all of the committed transactions.
Check whether there are pending transactions in non-coroutine storage.
Copy transaction state from the current coroutine to non-coroutine storage.
Restore the test lifecycle's transaction state in the current coroutine.
Clear all transaction state from non-coroutine storage.
Create a new database transaction manager instance.
Begin the test wrappers and remember their transaction records.
Details
in
DatabaseTransactionsManager at line 26
protected Collection
getCommittedTransactionsInternal()
Get all committed transactions for the current coroutine.
in
DatabaseTransactionsManager at line 36
protected Collection
getPendingTransactionsInternal()
Get all pending transactions for the current coroutine.
in
DatabaseTransactionsManager at line 44
protected DatabaseTransactionRecord|null
getCurrentTransactionForConnection(string $connection)
Get current transaction for a connection.
in
DatabaseTransactionsManager at line 52
void
begin(string $connection, int $level)
Start a new database transaction.
in
DatabaseTransactionsManager at line 71
Collection
commit(string $connection, int $levelBeingCommitted, int $newTransactionLevel)
Commit the root database transaction and execute callbacks.
in
DatabaseTransactionsManager at line 107
void
stageTransactions(string $connection, int $levelBeingCommitted)
Move relevant pending transactions to a committed state.
in
DatabaseTransactionsManager at line 127
void
rollback(string $connection, int $newTransactionLevel)
Rollback the active database transaction.
in
DatabaseTransactionsManager at line 174
protected void
removeAllTransactionsForConnection(string $connection)
Remove all pending, completed, and current transactions for the given connection name.
in
DatabaseTransactionsManager at line 211
protected Collection
removeCommittedTransactionsThatAreChildrenOf(DatabaseTransactionRecord $transaction)
Remove and return all committed descendants of the given transaction.
in
DatabaseTransactionsManager at line 237
protected void
executeCommitCallbacks(Collection $transactions)
Execute commit callbacks for every detached transaction.
in
DatabaseTransactionsManager at line 263
protected void
executeRollbackCallbacks(Collection $transactions)
Execute rollback callbacks for every detached transaction.
in
DatabaseTransactionsManager at line 289
void
addCallback(callable $callback, string|null $connection = null)
Register a transaction callback.
A null connection selects the most recently started applicable transaction on any connection. The callback runs when that transaction and its enclosing stack on the same connection commit.
in
DatabaseTransactionsManager at line 308
void
addCallbackForRollback(callable $callback, string|null $connection = null)
Register a callback for transaction rollback.
A null connection selects the most recently started applicable transaction on any connection. The callback runs when that transaction and its enclosing stack on the same connection roll back.
in
DatabaseTransactionsManager at line 318
bool
hasApplicableTransaction(string|null $connection = null)
Determine whether a callback would wait for an open transaction.
in
DatabaseTransactionsManager at line 326
protected DatabaseTransactionRecord|null
latestApplicableTransaction(string|null $connection)
Get the latest applicable transaction, optionally limited to a connection.
at line 77
Collection
callbackApplicableTransactions()
Get the transactions that are applicable to callbacks.
Only actual wrapper records are excluded: pooled child sessions can have level-one application transactions on the same connection name.
at line 90
bool
afterCommitCallbacksShouldBeExecuted(int $level)
Determine if after commit callbacks should be executed for the given transaction level.
Returns true at level 1 (the RefreshDatabase wrapper level) instead of level 0, since the wrapper transaction is never committed during tests.
in
DatabaseTransactionsManager at line 368
Collection
getPendingTransactions()
Get all of the pending transactions.
in
DatabaseTransactionsManager at line 378
Collection
getCommittedTransactions()
Get all of the committed transactions.
in
DatabaseTransactionsManager at line 386
static bool
hasNonCoroutinePendingTransactions()
Check whether there are pending transactions in non-coroutine storage.
in
DatabaseTransactionsManager at line 400
static void
copyToNonCoroutineState()
Copy transaction state from the current coroutine to non-coroutine storage.
This copies coroutine-local transaction state into worker-global storage, so request-time use can leak or race across concurrent requests.
in
DatabaseTransactionsManager at line 415
static void
copyFromNonCoroutineState()
Restore the test lifecycle's transaction state in the current coroutine.
This deliberately shares transaction ownership across setup, test and teardown; normal child coroutines must own separate transactions.
in
DatabaseTransactionsManager at line 431
static void
clearNonCoroutineState()
Clear all transaction state from non-coroutine storage.
This mutates worker-global transaction state, so request-time use can race with concurrent requests using the same storage.
at line 41
__construct(array $connectionsTransacting)
Create a new database transaction manager instance.
at line 49
void
beginTransactions(DatabaseManager $database)
Begin the test wrappers and remember their transaction records.