diff --git a/core/modules/config/src/Form/ConfigSingleImportForm.php b/core/modules/config/src/Form/ConfigSingleImportForm.php
index bf6d650d5f60a46831e92e32c5893a8e0ac3c524..88be9a58db9dd64f0f965e0145e44e3f7a2a8f3b 100644
--- a/core/modules/config/src/Form/ConfigSingleImportForm.php
+++ b/core/modules/config/src/Form/ConfigSingleImportForm.php
@@ -4,6 +4,7 @@
use Drupal\Component\Serialization\Exception\InvalidDataTypeException;
use Drupal\config\StorageReplaceDataWrapper;
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Config\ConfigImporter;
use Drupal\Core\Config\ConfigImporterException;
use Drupal\Core\Config\ConfigManagerInterface;
@@ -411,19 +412,16 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
else {
try {
$sync_steps = $config_importer->initialize();
- $batch = [
- 'operations' => [],
- 'finished' => [ConfigImporterBatch::class, 'finish'],
- 'title' => $this->t('Importing configuration'),
- 'init_message' => $this->t('Starting configuration import.'),
- 'progress_message' => $this->t('Completed @current step of @total.'),
- 'error_message' => $this->t('Configuration import has encountered an error.'),
- ];
+ $batch_builder = (new BatchBuilder())
+ ->setTitle($this->t('Importing configuration'))
+ ->setFinishCallback([ConfigImporterBatch::class, 'finish'])
+ ->setInitMessage($this->t('Starting configuration import.'))
+ ->setProgressMessage($this->t('Completed @current step of @total.'))
+ ->setErrorMessage($this->t('Configuration import has encountered an error.'));
foreach ($sync_steps as $sync_step) {
- $batch['operations'][] = [[ConfigImporterBatch::class, 'process'], [$config_importer, $sync_step]];
+ $batch_builder->addOperation([ConfigImporterBatch::class, 'process'], [$config_importer, $sync_step]);
}
-
- batch_set($batch);
+ batch_set($batch_builder->toArray());
}
catch (ConfigImporterException $e) {
// There are validation errors.
diff --git a/core/modules/config/src/Form/ConfigSync.php b/core/modules/config/src/Form/ConfigSync.php
index 1f3d22f76a3a619cc32b6c5bcbb9ef85e7b35c24..e1efb7620dec035ec84fdb5e1cd1962fb9076817 100644
--- a/core/modules/config/src/Form/ConfigSync.php
+++ b/core/modules/config/src/Form/ConfigSync.php
@@ -2,6 +2,7 @@
namespace Drupal\config\Form;
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Config\ConfigImporterException;
use Drupal\Core\Config\ConfigImporter;
use Drupal\Core\Config\Importer\ConfigImporterBatch;
@@ -364,19 +365,17 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
else {
try {
$sync_steps = $config_importer->initialize();
- $batch = [
- 'operations' => [],
- 'finished' => [ConfigImporterBatch::class, 'finish'],
- 'title' => $this->t('Synchronizing configuration'),
- 'init_message' => $this->t('Starting configuration synchronization.'),
- 'progress_message' => $this->t('Completed step @current of @total.'),
- 'error_message' => $this->t('Configuration synchronization has encountered an error.'),
- ];
+ $batch_builder = (new BatchBuilder())
+ ->setTitle($this->t('Synchronizing configuration'))
+ ->setFinishCallback([ConfigImporterBatch::class, 'finish'])
+ ->setInitMessage($this->t('Starting configuration synchronization.'))
+ ->setProgressMessage($this->t('Completed step @current of @total.'))
+ ->setErrorMessage($this->t('Configuration synchronization has encountered an error.'));
foreach ($sync_steps as $sync_step) {
- $batch['operations'][] = [[ConfigImporterBatch::class, 'process'], [$config_importer, $sync_step]];
+ $batch_builder->addOperation([ConfigImporterBatch::class, 'process'], [$config_importer, $sync_step]);
}
- batch_set($batch);
+ batch_set($batch_builder->toArray());
}
catch (ConfigImporterException $e) {
// There are validation errors.
diff --git a/core/modules/locale/locale.bulk.inc b/core/modules/locale/locale.bulk.inc
index 3e38f88484136776609f7d3eab5a037461f78466..e67ad4edcf27d71248555ae07976e8334316391f 100644
--- a/core/modules/locale/locale.bulk.inc
+++ b/core/modules/locale/locale.bulk.inc
@@ -5,6 +5,7 @@
* Mass import-export and batch import functionality for Gettext .po files.
*/
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Url;
use Drupal\Core\File\Exception\FileException;
use Drupal\Core\Language\LanguageInterface;
@@ -143,28 +144,24 @@ function locale_translate_batch_build(array $files, array $options) {
'finish_feedback' => TRUE,
];
if (count($files)) {
- $operations = [];
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'locale') . '/locale.bulk.inc')
+ ->setTitle(t('Importing interface translations'))
+ ->setErrorMessage(t('Error importing interface translations'));
foreach ($files as $file) {
// We call locale_translate_batch_import for every batch operation.
- $operations[] = ['locale_translate_batch_import', [$file, $options]];
+ $batch_builder->addOperation('locale_translate_batch_import', [$file, $options]);
}
// Save the translation status of all files.
- $operations[] = ['locale_translate_batch_import_save', []];
+ $batch_builder->addOperation('locale_translate_batch_import_save', []);
// Add a final step to refresh JavaScript and configuration strings.
- $operations[] = ['locale_translate_batch_refresh', []];
-
- $batch = [
- 'operations' => $operations,
- 'title' => t('Importing interface translations'),
- 'progress_message' => '',
- 'error_message' => t('Error importing interface translations'),
- 'file' => drupal_get_path('module', 'locale') . '/locale.bulk.inc',
- ];
+ $batch_builder->addOperation('locale_translate_batch_refresh', []);
+
if ($options['finish_feedback']) {
- $batch['finished'] = 'locale_translate_batch_finished';
+ $batch_builder->setFinishCallback('locale_translate_batch_finished');
}
- return $batch;
+ return $batch_builder->toArray();
}
return FALSE;
}
@@ -569,9 +566,13 @@ function locale_config_batch_update_components(array $options, array $langcodes
*/
function locale_config_batch_build(array $names, array $langcodes, array $options = []) {
$options += ['finish_feedback' => TRUE];
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'locale') . '/locale.bulk.inc')
+ ->setTitle(t('Updating configuration translations'))
+ ->setInitMessage(t('Starting configuration update'))
+ ->setErrorMessage(t('Error updating configuration translations'));
$i = 0;
$batch_names = [];
- $operations = [];
foreach ($names as $name) {
$batch_names[] = $name;
$i++;
@@ -580,24 +581,17 @@ function locale_config_batch_build(array $names, array $langcodes, array $option
// request. We batch a small number of configuration object upgrades
// together to improve the overall performance of the process.
if ($i % 20 == 0) {
- $operations[] = ['locale_config_batch_refresh_name', [$batch_names, $langcodes]];
+ $batch_builder->addOperation('locale_config_batch_refresh_name', [$batch_names, $langcodes]);
$batch_names = [];
}
}
if (!empty($batch_names)) {
- $operations[] = ['locale_config_batch_refresh_name', [$batch_names, $langcodes]];
+ $batch_builder->addOperation('locale_config_batch_refresh_name', [$batch_names, $langcodes]);
}
- $batch = [
- 'operations' => $operations,
- 'title' => t('Updating configuration translations'),
- 'init_message' => t('Starting configuration update'),
- 'error_message' => t('Error updating configuration translations'),
- 'file' => drupal_get_path('module', 'locale') . '/locale.bulk.inc',
- ];
if (!empty($options['finish_feedback'])) {
- $batch['completed'] = 'locale_config_batch_finished';
+ $batch_builder->setFinishCallback('locale_config_batch_finished');
}
- return $batch;
+ return $batch_builder->toArray();
}
/**
diff --git a/core/modules/locale/locale.compare.inc b/core/modules/locale/locale.compare.inc
index 6100473ec3da47ddf7040e6a2e267d33d23ae304..7321b55159cc9e28377faff152d608ca46fedd71 100644
--- a/core/modules/locale/locale.compare.inc
+++ b/core/modules/locale/locale.compare.inc
@@ -5,6 +5,7 @@
* The API for comparing project translation status with available translation.
*/
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Utility\ProjectInfo;
/**
@@ -238,15 +239,17 @@ function locale_translation_batch_status_build($projects = [], $langcodes = [])
$operations = _locale_translation_batch_status_operations($projects, $langcodes, $options);
- $batch = [
- 'operations' => $operations,
- 'title' => t('Checking translations'),
- 'progress_message' => '',
- 'finished' => 'locale_translation_batch_status_finished',
- 'error_message' => t('Error checking translation updates.'),
- 'file' => drupal_get_path('module', 'locale') . '/locale.batch.inc',
- ];
- return $batch;
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'locale') . '/locale.batch.inc')
+ ->setTitle(t('Checking translations'))
+ ->setErrorMessage(t('Error checking translation updates.'))
+ ->setFinishCallback('locale_translation_batch_status_finished');
+
+ array_walk($operations, function ($operation) use ($batch_builder) {
+ call_user_func_array([$batch_builder, 'addOperation'], $operation);
+ });
+
+ return $batch_builder->toArray();
}
/**
diff --git a/core/modules/locale/locale.fetch.inc b/core/modules/locale/locale.fetch.inc
index 1de693447349b1435adac1d463ceaa8221e7b6f9..ecaa48c47f034e99730196324f1219772bafea0b 100644
--- a/core/modules/locale/locale.fetch.inc
+++ b/core/modules/locale/locale.fetch.inc
@@ -5,6 +5,8 @@
* The API for download and import of translations from remote and local sources.
*/
+use Drupal\Core\Batch\BatchBuilder;
+
/**
* Load the common translation API.
*/
@@ -33,20 +35,20 @@ function locale_translation_batch_update_build($projects = [], $langcodes = [],
$status_options = $options;
$status_options['finish_feedback'] = FALSE;
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'locale') . '/locale.batch.inc')
+ ->setTitle(t('Updating translations'))
+ ->setErrorMessage(t('Error importing translation files'))
+ ->setFinishCallback('locale_translation_batch_fetch_finished');
// Check status of local and remote translation files.
$operations = _locale_translation_batch_status_operations($projects, $langcodes, $status_options);
// Download and import translations.
$operations = array_merge($operations, _locale_translation_fetch_operations($projects, $langcodes, $options));
+ array_walk($operations, function ($operation) use ($batch_builder) {
+ call_user_func_array([$batch_builder, 'addOperation'], $operation);
+ });
- $batch = [
- 'operations' => $operations,
- 'title' => t('Updating translations'),
- 'progress_message' => '',
- 'error_message' => t('Error importing translation files'),
- 'finished' => 'locale_translation_batch_fetch_finished',
- 'file' => drupal_get_path('module', 'locale') . '/locale.batch.inc',
- ];
- return $batch;
+ return $batch_builder->toArray();
}
/**
@@ -67,15 +69,16 @@ function locale_translation_batch_fetch_build($projects = [], $langcodes = [], $
$projects = $projects ? $projects : array_keys(locale_translation_get_projects());
$langcodes = $langcodes ? $langcodes : array_keys(locale_translatable_language_list());
- $batch = [
- 'operations' => _locale_translation_fetch_operations($projects, $langcodes, $options),
- 'title' => t('Updating translations.'),
- 'progress_message' => '',
- 'error_message' => t('Error importing translation files'),
- 'finished' => 'locale_translation_batch_fetch_finished',
- 'file' => drupal_get_path('module', 'locale') . '/locale.batch.inc',
- ];
- return $batch;
+ $batch_builder = (new BatchBuilder())
+ ->setTitle(t('Updating translations.'))
+ ->setErrorMessage(t('Error importing translation files'))
+ ->setFile(drupal_get_path('module', 'locale') . '/locale.batch.inc')
+ ->setFinishCallback('locale_translation_batch_fetch_finished');
+ $operations = _locale_translation_fetch_operations($projects, $langcodes, $options);
+ array_walk($operations, function ($operation) use ($batch_builder) {
+ call_user_func_array([$batch_builder, 'addOperation'], $operation);
+ });
+ return $batch_builder->toArray();
}
/**
diff --git a/core/modules/migrate_drupal_ui/src/Form/ReviewForm.php b/core/modules/migrate_drupal_ui/src/Form/ReviewForm.php
index 14ff137f5aad636cee77655f48435e9ba45298cc..ccc1eb076fdd2bb3989697c5a157ca73a2215e07 100644
--- a/core/modules/migrate_drupal_ui/src/Form/ReviewForm.php
+++ b/core/modules/migrate_drupal_ui/src/Form/ReviewForm.php
@@ -2,6 +2,7 @@
namespace Drupal\migrate_drupal_ui\Form;
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Extension\Exception\UnknownExtensionException;
use Drupal\Core\Extension\ModuleHandlerInterface;
@@ -241,20 +242,15 @@ public function buildForm(array $form, FormStateInterface $form_state) {
public function submitForm(array &$form, FormStateInterface $form_state) {
$config['source_base_path'] = $this->store->get('source_base_path');
$config['source_private_file_path'] = $this->store->get('source_private_file_path');
- $batch = [
- 'title' => $this->t('Running upgrade'),
- 'progress_message' => '',
- 'operations' => [
- [
- [MigrateUpgradeImportBatch::class, 'run'],
- [array_keys($this->migrations), $config],
- ],
- ],
- 'finished' => [
- MigrateUpgradeImportBatch::class, 'finished',
- ],
- ];
- batch_set($batch);
+ $batch_builder = (new BatchBuilder())
+ ->setTitle($this->t('Running upgrade'))
+ ->setProgressMessage('')
+ ->addOperation([
+ MigrateUpgradeImportBatch::class,
+ 'run',
+ ], [array_keys($this->migrations), $config])
+ ->setFinishCallback([MigrateUpgradeImportBatch::class, 'finished']);
+ batch_set($batch_builder->toArray());
$form_state->setRedirect('<front>');
$this->store->set('step', 'overview');
$this->state->set('migrate_drupal_ui.performed', REQUEST_TIME);
diff --git a/core/modules/node/node.admin.inc b/core/modules/node/node.admin.inc
index bcdb5d6714d092efe79bdf956b87c64156c988b0..a0588584461ebcc34f5f045cd9a79f915ad63317 100644
--- a/core/modules/node/node.admin.inc
+++ b/core/modules/node/node.admin.inc
@@ -5,6 +5,7 @@
* Content administration and module settings user interface.
*/
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Link;
use Drupal\node\NodeInterface;
@@ -34,21 +35,18 @@ function node_mass_update(array $nodes, array $updates, $langcode = NULL, $load
// We use batch processing to prevent timeout when updating a large number
// of nodes.
if (count($nodes) > 10) {
- $batch = [
- 'operations' => [
- ['_node_mass_update_batch_process', [$nodes, $updates, $langcode, $load, $revisions]],
- ],
- 'finished' => '_node_mass_update_batch_finished',
- 'title' => t('Processing'),
- // We use a single multi-pass operation, so the default
- // 'Remaining x of y operations' message will be confusing here.
- 'progress_message' => '',
- 'error_message' => t('The update has encountered an error.'),
+ $batch_builder = (new BatchBuilder())
// The operations do not live in the .module file, so we need to
// tell the batch engine which file to load before calling them.
- 'file' => drupal_get_path('module', 'node') . '/node.admin.inc',
- ];
- batch_set($batch);
+ ->setFile(drupal_get_path('module', 'node') . '/node.admin.inc')
+ ->addOperation('_node_mass_update_batch_process', [$nodes, $updates, $langcode, $load, $revisions])
+ ->setFinishCallback('_node_mass_update_batch_finished')
+ ->setTitle(t('Processing'))
+ ->setErrorMessage(t('The update has encountered an error.'))
+ // We use a single multi-pass operation, so the default
+ // 'Remaining x of y operations' message will be confusing here.
+ ->setProgressMessage('');
+ batch_set($batch_builder->toArray());
}
else {
$storage = \Drupal::entityTypeManager()->getStorage('node');
diff --git a/core/modules/node/node.module b/core/modules/node/node.module
index 9099b4e12e0184d5cc1d39f247355028920fbe22..7a40ca534904c37236724302adc75f3a9f30cb1e 100644
--- a/core/modules/node/node.module
+++ b/core/modules/node/node.module
@@ -11,6 +11,7 @@
use Drupal\Component\Utility\Environment;
use Drupal\Component\Utility\Xss;
use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Database\Query\AlterableInterface;
use Drupal\Core\Database\Query\SelectInterface;
@@ -1046,14 +1047,11 @@ function node_access_rebuild($batch_mode = FALSE) {
// Only recalculate if the site is using a node_access module.
if (count(\Drupal::moduleHandler()->getImplementations('node_grants'))) {
if ($batch_mode) {
- $batch = [
- 'title' => t('Rebuilding content access permissions'),
- 'operations' => [
- ['_node_access_rebuild_batch_operation', []],
- ],
- 'finished' => '_node_access_rebuild_batch_finished',
- ];
- batch_set($batch);
+ $batch_builder = (new BatchBuilder())
+ ->setTitle(t('Rebuilding content access permissions'))
+ ->addOperation('_node_access_rebuild_batch_operation', [])
+ ->setFinishCallback('_node_access_rebuild_batch_finished');
+ batch_set($batch_builder->toArray());
}
else {
// Try to allocate enough time to rebuild node grants
diff --git a/core/modules/system/src/Controller/DbUpdateController.php b/core/modules/system/src/Controller/DbUpdateController.php
index 1732660b24cf2b1e4f1777cce232e7be7821a6c7..8111de2471aaba6a0c58c5d760728859a937749a 100644
--- a/core/modules/system/src/Controller/DbUpdateController.php
+++ b/core/modules/system/src/Controller/DbUpdateController.php
@@ -2,6 +2,7 @@
namespace Drupal\system\Controller;
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\Extension\ModuleHandlerInterface;
@@ -582,7 +583,12 @@ protected function triggerBatch(Request $request) {
$this->state->set('system.maintenance_mode', TRUE);
}
- $operations = [];
+ /** @var \Drupal\Core\Batch\BatchBuilder $batch_builder */
+ $batch_builder = (new BatchBuilder())
+ ->setTitle($this->t('Updating'))
+ ->setInitMessage($this->t('Starting updates'))
+ ->setErrorMessage($this->t('An unrecoverable error has occurred. You can find the error message below. It is advised to copy it to the clipboard for reference.'))
+ ->setFinishCallback([DbUpdateController::class, 'batchFinished']);
// Resolve any update dependencies to determine the actual updates that will
// be run and the order they will be run in.
@@ -608,7 +614,7 @@ protected function triggerBatch(Request $request) {
\Drupal::service('update.update_hook_registry')->setInstalledVersion($update['module'], $update['number'] - 1);
unset($start[$update['module']]);
}
- $operations[] = ['update_do_one', [$update['module'], $update['number'], $dependency_map[$function]]];
+ $batch_builder->addOperation('update_do_one', [$update['module'], $update['number'], $dependency_map[$function]]);
}
}
@@ -617,20 +623,13 @@ protected function triggerBatch(Request $request) {
if ($post_updates) {
// Now we rebuild all caches and after that execute the hook_post_update()
// functions.
- $operations[] = ['drupal_flush_all_caches', []];
+ $batch_builder->addOperation('drupal_flush_all_caches', []);
foreach ($post_updates as $function) {
- $operations[] = ['update_invoke_post_update', [$function]];
+ $batch_builder->addOperation('update_invoke_post_update', [$function]);
}
}
- $batch['operations'] = $operations;
- $batch += [
- 'title' => $this->t('Updating'),
- 'init_message' => $this->t('Starting updates'),
- 'error_message' => $this->t('An unrecoverable error has occurred. You can find the error message below. It is advised to copy it to the clipboard for reference.'),
- 'finished' => ['\Drupal\system\Controller\DbUpdateController', 'batchFinished'],
- ];
- batch_set($batch);
+ batch_set($batch_builder->toArray());
// @todo Revisit once https://www.drupal.org/node/2548095 is in.
return batch_process(Url::fromUri('base://results'), Url::fromUri('base://start'));
diff --git a/core/modules/system/src/Form/PrepareModulesEntityUninstallForm.php b/core/modules/system/src/Form/PrepareModulesEntityUninstallForm.php
index 07fb35dcd9df2e28457caa7a8c856c12065c4563..bc061bfbd0f475d7958b45289f6b90f4aed0ac20 100644
--- a/core/modules/system/src/Form/PrepareModulesEntityUninstallForm.php
+++ b/core/modules/system/src/Form/PrepareModulesEntityUninstallForm.php
@@ -2,6 +2,7 @@
namespace Drupal\system\Form;
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Form\ConfirmFormBase;
use Drupal\Core\Form\FormStateInterface;
@@ -183,19 +184,12 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
$entity_type_id = $form_state->getValue('entity_type_id');
$entity_type_plural = $this->entityTypeManager->getDefinition($entity_type_id)->getPluralLabel();
- $batch = [
- 'title' => $this->t('Deleting @entity_type_plural', [
- '@entity_type_plural' => $entity_type_plural,
- ]),
- 'operations' => [
- [
- [__CLASS__, 'deleteContentEntities'], [$entity_type_id],
- ],
- ],
- 'finished' => [__CLASS__, 'moduleBatchFinished'],
- 'progress_message' => '',
- ];
- batch_set($batch);
+ $batch_builder = (new BatchBuilder())
+ ->setTitle($this->t('Deleting @entity_type_plural', ['@entity_type_plural' => $entity_type_plural]))
+ ->setProgressMessage('')
+ ->setFinishCallback([__CLASS__, 'moduleBatchFinished'])
+ ->addOperation([__CLASS__, 'deleteContentEntities'], [$entity_type_id]);
+ batch_set($batch_builder->toArray());
}
/**
diff --git a/core/modules/system/tests/modules/batch_test/batch_test.module b/core/modules/system/tests/modules/batch_test/batch_test.module
index 03d1e8e287515454b8d24d20bae505177f203c8a..ba5923df2fa9f5812ad8900619c0edacb476667d 100644
--- a/core/modules/system/tests/modules/batch_test/batch_test.module
+++ b/core/modules/system/tests/modules/batch_test/batch_test.module
@@ -5,6 +5,7 @@
* Helper module for the Batch API tests.
*/
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Form\FormState;
/**
@@ -20,13 +21,10 @@ function _batch_test_nested_drupal_form_submit_callback($value) {
* Batch 0: Does nothing.
*/
function _batch_test_batch_0() {
- $batch = [
- 'operations' => [],
- 'finished' => '_batch_test_finished_0',
- 'file' => drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc',
- 'batch_test_id' => 'batch_0',
- ];
- return $batch;
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc')
+ ->setFinishCallback('_batch_test_finished_0');
+ return $batch_builder->toArray() + ['batch_test_id' => 'batch_0'];
}
/**
@@ -39,17 +37,15 @@ function _batch_test_batch_1() {
$total = 10;
$sleep = (1000000 / $total) * 2;
- $operations = [];
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc')
+ ->setFinishCallback('_batch_test_finished_1');
+
for ($i = 1; $i <= $total; $i++) {
- $operations[] = ['_batch_test_callback_1', [$i, $sleep]];
+ $batch_builder->addOperation('_batch_test_callback_1', [$i, $sleep]);
}
- $batch = [
- 'operations' => $operations,
- 'finished' => '_batch_test_finished_1',
- 'file' => drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc',
- 'batch_test_id' => 'batch_1',
- ];
- return $batch;
+
+ return $batch_builder->toArray() + ['batch_test_id' => 'batch_1'];
}
/**
@@ -62,16 +58,12 @@ function _batch_test_batch_2() {
$total = 10;
$sleep = (1000000 / $total) * 2;
- $operations = [
- ['_batch_test_callback_2', [1, $total, $sleep]],
- ];
- $batch = [
- 'operations' => $operations,
- 'finished' => '_batch_test_finished_2',
- 'file' => drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc',
- 'batch_test_id' => 'batch_2',
- ];
- return $batch;
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc')
+ ->addOperation('_batch_test_callback_2', [1, $total, $sleep])
+ ->setFinishCallback('_batch_test_finished_2');
+
+ return $batch_builder->toArray() + ['batch_test_id' => 'batch_2'];
}
/**
@@ -88,22 +80,19 @@ function _batch_test_batch_3() {
$total = 10;
$sleep = (1000000 / $total) * 2;
- $operations = [];
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc')
+ ->setFinishCallback('_batch_test_finished_3');
for ($i = 1; $i <= round($total / 2); $i++) {
- $operations[] = ['_batch_test_callback_1', [$i, $sleep]];
+ $batch_builder->addOperation('_batch_test_callback_1', [$i, $sleep]);
}
- $operations[] = ['_batch_test_callback_2', [1, $total / 2, $sleep]];
+ $batch_builder->addOperation('_batch_test_callback_2', [1, $total / 2, $sleep]);
for ($i = round($total / 2) + 1; $i <= $total; $i++) {
- $operations[] = ['_batch_test_callback_1', [$i, $sleep]];
+ $batch_builder->addOperation('_batch_test_callback_1', [$i, $sleep]);
}
- $operations[] = ['_batch_test_callback_2', [6, $total / 2, $sleep]];
- $batch = [
- 'operations' => $operations,
- 'finished' => '_batch_test_finished_3',
- 'file' => drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc',
- 'batch_test_id' => 'batch_3',
- ];
- return $batch;
+ $batch_builder->addOperation('_batch_test_callback_2', [6, $total / 2, $sleep]);
+
+ return $batch_builder->toArray() + ['batch_test_id' => 'batch_3'];
}
/**
@@ -119,21 +108,18 @@ function _batch_test_batch_4() {
$total = 10;
$sleep = (1000000 / $total) * 2;
- $operations = [];
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc')
+ ->setFinishCallback('_batch_test_finished_4');
for ($i = 1; $i <= round($total / 2); $i++) {
- $operations[] = ['_batch_test_callback_1', [$i, $sleep]];
+ $batch_builder->addOperation('_batch_test_callback_1', [$i, $sleep]);
}
- $operations[] = ['_batch_test_nested_batch_callback', [[2]]];
+ $batch_builder->addOperation('_batch_test_nested_batch_callback', [[2]]);
for ($i = round($total / 2) + 1; $i <= $total; $i++) {
- $operations[] = ['_batch_test_callback_1', [$i, $sleep]];
+ $batch_builder->addOperation('_batch_test_callback_1', [$i, $sleep]);
}
- $batch = [
- 'operations' => $operations,
- 'finished' => '_batch_test_finished_4',
- 'file' => drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc',
- 'batch_test_id' => 'batch_4',
- ];
- return $batch;
+
+ return $batch_builder->toArray() + ['batch_test_id' => 'batch_4'];
}
/**
@@ -146,17 +132,14 @@ function _batch_test_batch_5() {
$total = 10;
$sleep = (1000000 / $total) * 2;
- $operations = [];
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc')
+ ->setFinishCallback('_batch_test_finished_5');
for ($i = 1; $i <= $total; $i++) {
- $operations[] = ['_batch_test_callback_5', [$i, $sleep]];
+ $batch_builder->addOperation('_batch_test_callback_5', [$i, $sleep]);
}
- $batch = [
- 'operations' => $operations,
- 'finished' => '_batch_test_finished_5',
- 'file' => drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc',
- 'batch_test_id' => 'batch_5',
- ];
- return $batch;
+
+ return $batch_builder->toArray() + ['batch_test_id' => 'batch_5'];
}
/**
@@ -169,17 +152,14 @@ function _batch_test_batch_6() {
$total = 10;
$sleep = (1000000 / $total) * 2;
- $operations = [];
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc')
+ ->setFinishCallback('_batch_test_finished_6');
for ($i = 1; $i <= $total; $i++) {
- $operations[] = ['_batch_test_callback_6', [$i, $sleep]];
+ $batch_builder->addOperation('_batch_test_callback_6', [$i, $sleep]);
}
- $batch = [
- 'operations' => $operations,
- 'finished' => '_batch_test_finished_6',
- 'file' => drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc',
- 'batch_test_id' => 'batch_6',
- ];
- return $batch;
+
+ return $batch_builder->toArray() + ['batch_test_id' => 'batch_6'];
}
/**
@@ -196,21 +176,18 @@ function _batch_test_batch_7() {
$total = 10;
$sleep = (1000000 / $total) * 2;
- $operations = [];
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc')
+ ->setFinishCallback('_batch_test_finished_7');
for ($i = 1; $i <= $total / 2; $i++) {
- $operations[] = ['_batch_test_callback_7', [$i, $sleep]];
+ $batch_builder->addOperation('_batch_test_callback_7', [$i, $sleep]);
}
- $operations[] = ['_batch_test_nested_batch_callback', [[6, 5]]];
+ $batch_builder->addOperation('_batch_test_nested_batch_callback', [[6, 5]]);
for ($i = ($total / 2) + 1; $i <= $total; $i++) {
- $operations[] = ['_batch_test_callback_7', [$i, $sleep]];
+ $batch_builder->addOperation('_batch_test_callback_7', [$i, $sleep]);
}
- $batch = [
- 'operations' => $operations,
- 'finished' => '_batch_test_finished_7',
- 'file' => drupal_get_path('module', 'batch_test') . '/batch_test.callbacks.inc',
- 'batch_test_id' => 'batch_7',
- ];
- return $batch;
+
+ return $batch_builder->toArray() + ['batch_test_id' => 'batch_7'];
}
/**
diff --git a/core/modules/system/tests/modules/batch_test/src/Controller/BatchTestController.php b/core/modules/system/tests/modules/batch_test/src/Controller/BatchTestController.php
index 9a5951e6d3968750c825caadfb6a28172d243336..d55bf7b0eb26b454bdae0c290832408fe2c657c1 100644
--- a/core/modules/system/tests/modules/batch_test/src/Controller/BatchTestController.php
+++ b/core/modules/system/tests/modules/batch_test/src/Controller/BatchTestController.php
@@ -2,6 +2,7 @@
namespace Drupal\batch_test\Controller;
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Form\FormState;
/**
@@ -47,10 +48,9 @@ public function testLargePercentage() {
*/
public function testNestedDrupalFormSubmit($value = 1) {
// Set the batch and process it.
- $batch['operations'] = [
- ['_batch_test_nested_drupal_form_submit_callback', [$value]],
- ];
- batch_set($batch);
+ $batch_builder = (new BatchBuilder())
+ ->addOperation('_batch_test_nested_drupal_form_submit_callback', [$value]);
+ batch_set($batch_builder->toArray());
return batch_process('batch-test/redirect');
}
diff --git a/core/modules/update/src/Controller/UpdateController.php b/core/modules/update/src/Controller/UpdateController.php
index bf0f1684ecf6d54eb164abb2eb169d1f587bf89f..aba3c1ed25ad2f5de471d9c04d0dfd5486ddc871 100644
--- a/core/modules/update/src/Controller/UpdateController.php
+++ b/core/modules/update/src/Controller/UpdateController.php
@@ -2,6 +2,7 @@
namespace Drupal\update\Controller;
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\Render\RendererInterface;
use Drupal\update\UpdateFetcherInterface;
@@ -90,16 +91,13 @@ public function updateStatus() {
*/
public function updateStatusManually() {
$this->updateManager->refreshUpdateData();
- $batch = [
- 'operations' => [
- [[$this->updateManager, 'fetchDataBatch'], []],
- ],
- 'finished' => 'update_fetch_data_finished',
- 'title' => t('Checking available update data'),
- 'progress_message' => t('Trying to check available update data ...'),
- 'error_message' => t('Error checking available update data.'),
- ];
- batch_set($batch);
+ $batch_builder = (new BatchBuilder())
+ ->setTitle(t('Checking available update data'))
+ ->addOperation([$this->updateManager, 'fetchDataBatch'], [])
+ ->setProgressMessage(t('Trying to check available update data ...'))
+ ->setErrorMessage(t('Error checking available update data.'))
+ ->setFinishCallback('update_fetch_data_finished');
+ batch_set($batch_builder->toArray());
return batch_process('admin/reports/updates');
}
diff --git a/core/modules/update/src/Form/UpdateManagerUpdate.php b/core/modules/update/src/Form/UpdateManagerUpdate.php
index 13a15abf8566f98354a35878c4ef74bb04a3a296..67a8827cbe1db7c6967dcf395fbb554d2bfeceb4 100644
--- a/core/modules/update/src/Form/UpdateManagerUpdate.php
+++ b/core/modules/update/src/Form/UpdateManagerUpdate.php
@@ -2,6 +2,7 @@
namespace Drupal\update\Form;
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
@@ -380,24 +381,18 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
$projects = array_merge($projects, array_keys(array_filter($form_state->getValue($type))));
}
}
- $operations = [];
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'update') . '/update.manager.inc')
+ ->setTitle($this->t('Downloading updates'))
+ ->setInitMessage($this->t('Preparing to download selected updates'))
+ ->setFinishCallback('update_manager_download_batch_finished');
foreach ($projects as $project) {
- $operations[] = [
- 'update_manager_batch_project_get',
- [
- $project,
- $form_state->getValue(['project_downloads', $project]),
- ],
- ];
+ $batch_builder->addOperation('update_manager_batch_project_get', [
+ $project,
+ $form_state->getValue(['project_downloads', $project]),
+ ]);
}
- $batch = [
- 'title' => $this->t('Downloading updates'),
- 'init_message' => $this->t('Preparing to download selected updates'),
- 'operations' => $operations,
- 'finished' => 'update_manager_download_batch_finished',
- 'file' => drupal_get_path('module', 'update') . '/update.manager.inc',
- ];
- batch_set($batch);
+ batch_set($batch_builder->toArray());
}
}
diff --git a/core/modules/update/update.authorize.inc b/core/modules/update/update.authorize.inc
index 7f2162c58ab8a2ed29d729df7f0dc5af53b97970..86ecda3b89a082a0ea306f544a239e0235a4c2be 100644
--- a/core/modules/update/update.authorize.inc
+++ b/core/modules/update/update.authorize.inc
@@ -10,6 +10,7 @@
* the Update Manager module.
*/
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Updater\UpdaterException;
use Drupal\Core\Url;
@@ -36,26 +37,21 @@
* should use that response for the current page request.
*/
function update_authorize_run_update($filetransfer, $projects) {
- $operations = [];
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'update') . '/update.authorize.inc')
+ ->setInitMessage(t('Preparing to update your site'))
+ ->setFinishCallback('update_authorize_update_batch_finished');
+
foreach ($projects as $project_info) {
- $operations[] = [
- 'update_authorize_batch_copy_project',
- [
- $project_info['project'],
- $project_info['updater_name'],
- $project_info['local_url'],
- $filetransfer,
- ],
- ];
+ $batch_builder->addOperation('update_authorize_batch_copy_project', [
+ $project_info['project'],
+ $project_info['updater_name'],
+ $project_info['local_url'],
+ $filetransfer,
+ ]);
}
- $batch = [
- 'init_message' => t('Preparing to update your site'),
- 'operations' => $operations,
- 'finished' => 'update_authorize_update_batch_finished',
- 'file' => drupal_get_path('module', 'update') . '/update.authorize.inc',
- ];
- batch_set($batch);
+ batch_set($batch_builder->toArray());
// Since authorize.php has its own method for setting the page title, set it
// manually here rather than passing it in to batch_set() as would normally
@@ -91,25 +87,19 @@ function update_authorize_run_update($filetransfer, $projects) {
* should use that response for the current page request.
*/
function update_authorize_run_install($filetransfer, $project, $updater_name, $local_url) {
- $operations[] = [
- 'update_authorize_batch_copy_project',
- [
+ // @todo Instantiate our Updater to set the human-readable title?
+ $batch_builder = (new BatchBuilder())
+ ->setFile(drupal_get_path('module', 'update') . '/update.authorize.inc')
+ ->setInitMessage(t('Preparing to install'))
+ ->addOperation('update_authorize_batch_copy_project', [
$project,
$updater_name,
$local_url,
$filetransfer,
- ],
- ];
-
- // @todo Instantiate our Updater to set the human-readable title?
- $batch = [
- 'init_message' => t('Preparing to add'),
- 'operations' => $operations,
+ ])
// @todo Use a different finished callback for different messages?
- 'finished' => 'update_authorize_install_batch_finished',
- 'file' => drupal_get_path('module', 'update') . '/update.authorize.inc',
- ];
- batch_set($batch);
+ ->setFinishCallback('update_authorize_install_batch_finished');
+ batch_set($batch_builder->toArray());
// Since authorize.php has its own method for setting the page title, set it
// manually here rather than passing it in to batch_set() as would normally
diff --git a/core/modules/user/user.module b/core/modules/user/user.module
index f21829bfec34f9c0349f011879961c61d3d905cb..5206957f947062ad1cbc4b773681b94d3f50d25f 100644
--- a/core/modules/user/user.module
+++ b/core/modules/user/user.module
@@ -10,6 +10,7 @@
use Drupal\Component\Utility\Unicode;
use Drupal\Core\Access\AccessibleInterface;
use Drupal\Core\Asset\AttachedAssetsInterface;
+use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Form\FormStateInterface;
@@ -612,11 +613,9 @@ function user_cancel($edit, $uid, $method) {
}
// Initialize batch (to set title).
- $batch = [
- 'title' => t('Cancelling account'),
- 'operations' => [],
- ];
- batch_set($batch);
+ $batch_builder = (new BatchBuilder())
+ ->setTitle(t('Cancelling account'));
+ batch_set($batch_builder->toArray());
// When the 'user_cancel_delete' method is used, user_delete() is called,
// which invokes hook_ENTITY_TYPE_predelete() and hook_ENTITY_TYPE_delete()
@@ -628,21 +627,18 @@ function user_cancel($edit, $uid, $method) {
}
// Finish the batch and actually cancel the account.
- $batch = [
- 'title' => t('Cancelling user account'),
- 'operations' => [
- ['_user_cancel', [$edit, $account, $method]],
- ],
- ];
+ $batch_builder = (new BatchBuilder())
+ ->setTitle(t('Cancelling user account'))
+ ->addOperation('_user_cancel', [$edit, $account, $method]);
// After cancelling account, ensure that user is logged out.
if ($account->id() == \Drupal::currentUser()->id()) {
// Batch API stores data in the session, so use the finished operation to
// manipulate the current user's session id.
- $batch['finished'] = '_user_cancel_session_regenerate';
+ $batch_builder->setFinishCallback('_user_cancel_session_regenerate');
}
- batch_set($batch);
+ batch_set($batch_builder->toArray());
// Batch processing is either handled via Form API or has to be invoked
// manually.