function locale_config_batch_build

Creates a locale batch to refresh specific configuration.

Parameters

array $names: List of configuration object names (which are strings) to update.

array $langcodes: List of language codes to refresh.

array $options: (optional) An array with options that can have the following elements:

• 'finish_feedback': Whether or not to give feedback to the user when the batch is finished. Defaults to TRUE.

Return value

array The batch definition.

See also

locale_config_batch_refresh_name()

File

drupal/core/modules/locale/locale.bulk.inc, line 786

Mass import-export and batch import functionality for Gettext .po files.

Code

function locale_config_batch_build(array $names, array $langcodes, $options = array()) {
  $options += array(
    'finish_feedback' => TRUE,
  );
  $t = get_t();
  foreach ($names as $name) {
    $operations[] = array(
      'locale_config_batch_refresh_name',
      array(
        $name,
        $langcodes,
      ),
    );
  }
  $batch = array(
    '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';
  }
  return $batch;
}