diff options
| author | jerkob <jsterry@gmail.com> | 2020-01-28 17:27:27 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-28 17:27:27 +0100 |
| commit | 235f9cf2af212629d66a6227208b21ee1900aba3 (patch) | |
| tree | 592fbea4ec2a2f805d161ec1e917020e987f48a6 | |
| parent | 1cce9697265382853d9646ae3963fc20e6e97aa9 (diff) | |
Update docs for `trans_active()` function`
Per code review, update documentation from the proposed `trans_depth()` function to the replacement `trans_active()` function.
| -rw-r--r-- | user_guide_src/source/database/db_driver_reference.rst | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/user_guide_src/source/database/db_driver_reference.rst b/user_guide_src/source/database/db_driver_reference.rst index f1fbc1c87..ad53c2bfc 100644 --- a/user_guide_src/source/database/db_driver_reference.rst +++ b/user_guide_src/source/database/db_driver_reference.rst @@ -162,13 +162,12 @@ This article is intended to be a reference for them. Lets you retrieve the transaction status flag to determine if it has failed. - .. php:method:: trans_depth() + .. php:method:: trans_active() - :returns: The current transaction depth - :rtype: int + :returns: TRUE if a transaction is active, FALSE if not + :rtype: bool - Lets you retrieve the transaction depth value which - will be 1 or greater if a transaction is active. + Determines if a transaction is currently active. .. php:method:: compile_binds($sql, $binds) |