function LocaleFetch::batchUpdateBuild

Same name and namespace in other branches
  1. main core/modules/locale/src/LocaleFetch.php \Drupal\locale\LocaleFetch::batchUpdateBuild()

Builds a batch to check, download and import project translations.

Parameters

array $projects: Array of project names for which to update the translations. Defaults to all translatable projects.

array $langcodes: Array of language codes. Defaults to all translatable languages.

array $options: Array of import options. See locale_translate_batch_build().

Return value

array Batch definition array.

File

core/modules/locale/src/LocaleFetch.php, line 35

Class

LocaleFetch
Provides the locale source services.

Namespace

Drupal\locale

Code

public function batchUpdateBuild(array $projects = [], array $langcodes = [], array $options = []) : array {
  \Drupal::moduleHandler()->loadInclude('locale', 'inc', 'locale.compare');
  $projects = $projects ?: array_keys($this->projectStorage
    ->getProjects());
  $langcodes = $langcodes ?: array_keys(locale_translatable_language_list());
  $status_options = $options;
  $status_options['finish_feedback'] = FALSE;
  $batch_builder = (new BatchBuilder())->setFile($this->moduleExtensionList
    ->getPath('locale') . '/locale.batch.inc')
    ->setTitle($this->t('Updating translations'))
    ->setErrorMessage($this->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, $this->fetchOperations($projects, $langcodes, $options));
  array_walk($operations, function ($operation) use ($batch_builder) {
    call_user_func_array([
      $batch_builder,
      'addOperation',
    ], $operation);
  });
  return $batch_builder->toArray();
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.