function _batch_do in Drupal 7

Same name and namespace in other branches

1. 8 core/includes/batch.inc \_batch_do()
2. 6 includes/batch.inc \_batch_do()
3. 9 core/includes/batch.inc \_batch_do()
4. 10 core/includes/batch.inc \_batch_do()

Does one execution pass with JavaScript and returns progress to the browser.

See also

_batch_progress_page_js()

_batch_process()

1 call to _batch_do()

_batch_page in includes/batch.inc

Renders the batch processing page based on the current state of the batch.

File

includes/batch.inc, line 152

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

Code

function _batch_do() {

  // HTTP POST required.
  if ($_SERVER['REQUEST_METHOD'] != 'POST') {
    drupal_set_message(t('HTTP POST is required.'), 'error');
    drupal_set_title(t('Error'));
    return '';
  }

  // Perform actual processing.
  list($percentage, $message) = _batch_process();
  drupal_json_output(array(
    'status' => TRUE,
    'percentage' => $percentage,
    'message' => $message,
  ));
}