Issue #3307468 by darvanen: Improve Batch API $context['sandbox'] documentation
(cherry picked from commit 9514c30ab4
)
merge-requests/2832/head
parent
a6f55dac71
commit
f2edbcb391
|
@ -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.
|
||||||
|
|
Loading…
Reference in New Issue