batch.inc

Version 1.46 (checked in on 2009/11/03 at 06:47:22 by webchick)

Batch processing API for processes to run in multiple HTTP requests.

Please note that batches are usually invoked by form submissions, which is why the core interaction functions of the batch processing API live in form.inc.

See also

form.inc

@see batch_set()

See also

batch_process()

@see batch_get()

Functions

NameDescription
batch_loadLoads a batch from the database.
_batch_api_percentageHelper function for _batch_process(): returns the formatted percentage.
_batch_current_setReturn the batch set being currently processed.
_batch_doDo one pass of execution in JavaScript-mode and return progress to the browser.
_batch_finishedEnd the batch processing.
_batch_next_setRetrieve the next set in a batch.
_batch_pageState-based dispatcher for the batch processing page.
_batch_processProcess sets in a batch.
_batch_progress_page_jsOutput a batch processing page with JavaScript support.
_batch_progress_page_nojsOutput a batch processing page without JavaScript support.
_batch_shutdownShutdown function; store the current batch data for the next request.
_batch_startInitialize the batch processing.
Login or register to post comments
 
 

All source code and documentation on this site is released under the terms of the GNU General Public License, version 2 and later. Drupal is a registered trademark of Dries Buytaert.