Issue #3307468 by darvanen: Improve Batch API $context['sandbox'] documentation

(cherry picked from commit 9514c30ab4)
merge-requests/2832/head
Alex Pott 2022-10-05 10:51:27 +01:00
parent a6f55dac71
commit f2edbcb391
No known key found for this signature in database
GPG Key ID: BDA67E7EE836E5CE
1 changed files with 2 additions and 3 deletions

View File

@ -34,9 +34,8 @@
* $context['sandbox'] will be there the next time this function is called * $context['sandbox'] will be there the next time this function is called
* for the current operation. For example, an operation may wish to store a * for the current operation. For example, an operation may wish to store a
* pointer in a file or an offset for a large query. The 'sandbox' array key * pointer in a file or an offset for a large query. The 'sandbox' array key
* is not initially set when this callback is first called, which makes it * is empty when this callback is first called, which makes it useful for
* useful for determining whether it is the first call of the callback or * determining whether it is the first call of the callback or not:
* not:
* @code * @code
* if (empty($context['sandbox'])) { * if (empty($context['sandbox'])) {
* // Perform set-up steps here. * // Perform set-up steps here.