You are here

Home » API reference » Lingotek Translation 8.2

LingotekConfigTranslationController.php in Lingotek Translation 8.2

Same filename and directory in other branches
  1. 8 src/Controller/LingotekConfigTranslationController.php
  2. 4.0.x src/Controller/LingotekConfigTranslationController.php
  3. 3.0.x src/Controller/LingotekConfigTranslationController.php
  4. 3.1.x src/Controller/LingotekConfigTranslationController.php
  5. 3.2.x src/Controller/LingotekConfigTranslationController.php
  6. 3.3.x src/Controller/LingotekConfigTranslationController.php
  7. 3.4.x src/Controller/LingotekConfigTranslationController.php
  8. 3.5.x src/Controller/LingotekConfigTranslationController.php
  9. 3.6.x src/Controller/LingotekConfigTranslationController.php
  10. 3.7.x src/Controller/LingotekConfigTranslationController.php
  11. 3.8.x src/Controller/LingotekConfigTranslationController.php

Namespace

Drupal\lingotek\Controller

File

src/Controller/LingotekConfigTranslationController.php
View source 
<?php

namespace Drupal\lingotek\Controller;

use Drupal\config_translation\ConfigEntityMapper;
use Drupal\config_translation\ConfigMapperManagerInterface;
use Drupal\config_translation\Controller\ConfigTranslationController;
use Drupal\Core\Access\AccessManagerInterface;
use Drupal\Core\Language\Language;
use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\Language\LanguageManagerInterface;
use Drupal\Core\PathProcessor\InboundPathProcessorInterface;
use Drupal\Core\Render\RendererInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\Url;
use Drupal\field\Entity\FieldConfig;
use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\lingotek\Exception\LingotekApiException;
use Drupal\lingotek\Exception\LingotekDocumentArchivedException;
use Drupal\lingotek\Exception\LingotekDocumentLockedException;
use Drupal\lingotek\Exception\LingotekPaymentRequiredException;
use Drupal\lingotek\LanguageLocaleMapperInterface;
use Drupal\lingotek\Lingotek;
use Drupal\lingotek\LingotekConfigTranslationServiceInterface;
use Drupal\lingotek\LingotekConfigurationServiceInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
class LingotekConfigTranslationController extends ConfigTranslationController {

  /**
   * The language-locale mapper.
   *
   * @var \Drupal\lingotek\LanguageLocaleMapperInterface
   */
  protected $languageLocaleMapper;

  /**
   * The Lingotek configuration service.
   *
   * @var \Drupal\lingotek\LingotekConfigurationServiceInterface
   */
  protected $lingotekConfiguration;

  /**
   * The Lingotek config translation service.
   *
   * @var \Drupal\lingotek\LingotekConfigTranslationServiceInterface
   */
  protected $translationService;

  /**
   * Constructs a LingotekConfigTranslationController.
   *
   * @param \Drupal\lingotek\LanguageLocaleMapperInterface $language_locale_mapper
   *   The language-locale mapper.
   * @param \Drupal\lingotek\LingotekConfigTranslationServiceInterface $translation_service
   *   The Lingotek config translation service.
   * @param \Drupal\lingotek\LingotekConfigurationServiceInterface $lingotek_configuration
   *   The Lingotek configuration service.
   * @param \Drupal\config_translation\ConfigMapperManagerInterface $config_mapper_manager
   *   The configuration mapper manager.
   * @param \Drupal\Core\Access\AccessManagerInterface $access_manager
   *   The menu link access service.
   * @param \Symfony\Component\Routing\Matcher\RequestMatcherInterface $router
   *   The dynamic router service.
   * @param \Drupal\Core\PathProcessor\InboundPathProcessorInterface $path_processor
   *   The inbound path processor.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The current user.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   */
  public function __construct(LanguageLocaleMapperInterface $language_locale_mapper, LingotekConfigTranslationServiceInterface $translation_service, LingotekConfigurationServiceInterface $lingotek_configuration, ConfigMapperManagerInterface $config_mapper_manager, AccessManagerInterface $access_manager, RequestMatcherInterface $router, InboundPathProcessorInterface $path_processor, AccountInterface $account, LanguageManagerInterface $language_manager, RendererInterface $renderer) {
    parent::__construct($config_mapper_manager, $access_manager, $router, $path_processor, $account, $language_manager, $renderer);
    $this->languageLocaleMapper = $language_locale_mapper;
    $this->lingotekConfiguration = $lingotek_configuration;
    $this->translationService = $translation_service;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('lingotek.language_locale_mapper'), $container
      ->get('lingotek.config_translation'), $container
      ->get('lingotek.configuration'), $container
      ->get('plugin.manager.config_translation.mapper'), $container
      ->get('access_manager'), $container
      ->get('router'), $container
      ->get('path_processor_manager'), $container
      ->get('current_user'), $container
      ->get('language_manager'), $container
      ->get('renderer'));
  }
  public function itemPage(Request $request, RouteMatchInterface $route_match, $plugin_id) {
    $page = parent::itemPage($request, $route_match, $plugin_id);

    // If the user cannot manage translations, we don't add any actions.
    if (!\Drupal::currentUser()
      ->hasPermission('manage lingotek translations')) {
      return $page;
    }
    $entity = NULL;
    $entity_id = NULL;

    /** @var \Drupal\config_translation\ConfigMapperInterface $mapper */
    $mapper = $this->configMapperManager
      ->createInstance($plugin_id);
    $mapper
      ->populateFromRouteMatch($route_match);
    $languages = $this->languageManager
      ->getLanguages();
    $languages = array_filter($languages, function (LanguageInterface $language) {
      $configLanguage = ConfigurableLanguage::load($language
        ->getId());
      return $this->lingotekConfiguration
        ->isLanguageEnabled($configLanguage);
    });
    $original_langcode = $mapper
      ->getLangcode();
    if (!isset($languages[$original_langcode])) {

      // If the language is not configured on the site, create a dummy language
      // object for this listing only to ensure the user gets useful info.
      $language_name = $this->languageManager
        ->getLanguageName($original_langcode);
      $languages[$original_langcode] = new Language([
        'id' => $original_langcode,
        'name' => $language_name,
      ]);
    }
    if ($mapper instanceof ConfigEntityMapper) {

      /** @var $mapper ConfigEntityMapper */
      $entity = $mapper
        ->getEntity();
      $entity_id = $entity
        ->id();
    }
    if ($entity_id === NULL) {
      $entity_id = $plugin_id;
    }
    foreach ($languages as $language) {
      $langcode = $language
        ->getId();
      $locale = $this->languageLocaleMapper
        ->getLocaleForLangcode($langcode);
      if ($locale && $langcode === $original_langcode) {
        $page['languages'][$langcode]['operations']['#links']['upload'] = [
          'title' => $this
            ->t('Upload'),
          'url' => Url::fromRoute('lingotek.config.upload', [
            'entity_type' => $plugin_id,
            'entity_id' => $entity_id,
          ]),
        ];
        if ($entity && ($document_id = $this->translationService
          ->getDocumentId($entity))) {
          $page['languages'][$langcode]['operations']['#links']['check_upload'] = [
            'title' => $this
              ->t('Check upload status'),
            'url' => Url::fromRoute('lingotek.config.check_upload', [
              'entity_type' => $plugin_id,
              'entity_id' => $entity_id,
            ]),
          ];
        }
        elseif ($entity_id === $plugin_id) {
          if ($document_id = $this->translationService
            ->getConfigDocumentId($mapper)) {
            $page['languages'][$langcode]['operations']['#links']['check_upload'] = [
              'title' => $this
                ->t('Check upload status'),
              'url' => Url::fromRoute('lingotek.config.check_upload', [
                'entity_type' => $plugin_id,
                'entity_id' => $entity_id,
              ]),
            ];
          }
        }
      }
      if ($locale && $langcode !== $original_langcode) {
        if (isset($page['languages'][$langcode]['operations']['#links']['add'])) {

          // If we have a config entity and it has a document id, we want to show
          // the ability of requesting translations.
          if ($entity && ($document_id = $this->translationService
            ->getDocumentId($entity))) {
            $target_status = $this->translationService
              ->getTargetStatus($entity, $langcode);
            $this
              ->generateOperationsLinks($page, $plugin_id, $entity_id, $target_status, $langcode, $locale);
          }
          elseif ($entity_id === $plugin_id && ($document_id = $this->translationService
            ->getConfigDocumentId($mapper))) {
            $target_status = $this->translationService
              ->getConfigTargetStatus($mapper, $langcode);
            $this
              ->generateOperationsLinks($page, $plugin_id, $entity_id, $target_status, $langcode, $locale);
          }
        }
        if (isset($page['languages'][$langcode]['operations']['#links']['edit'])) {
          if ($entity && ($document_id = $this->translationService
            ->getDocumentId($entity))) {
            $target_status = $this->translationService
              ->getTargetStatus($entity, $langcode);
            $this
              ->generateOperationsLinks($page, $plugin_id, $entity_id, $target_status, $langcode, $locale);
          }
          elseif ($entity_id === $plugin_id && ($document_id = $this->translationService
            ->getConfigDocumentId($mapper))) {
            $target_status = $this->translationService
              ->getConfigTargetStatus($mapper, $langcode);
            $this
              ->generateOperationsLinks($page, $plugin_id, $entity_id, $target_status, $langcode, $locale);
          }
        }
      }
    }
    return $page;
  }
  public function upload($entity_type, $entity_id, Request $request) {
    if ($entity_type === $entity_id) {

      // It is not a config entity, but a config object.
      $definition = $this->configMapperManager
        ->getDefinition($entity_type);
      $mappers = $this->configMapperManager
        ->getMappers();
      if ($this->translationService
        ->getConfigDocumentId($mappers[$entity_type])) {
        try {
          if ($this->translationService
            ->updateConfig($entity_type)) {
            $this
              ->messenger()
              ->addStatus($this
              ->t('%label has been updated.', [
              '%label' => $definition['title'],
            ]));
          }
        } catch (LingotekDocumentArchivedException $exception) {
          $this
            ->messenger()
            ->addError($this
            ->t('Document %label has been archived. Please upload again.', [
            '%label' => $definition['title'],
          ]));
        } catch (LingotekDocumentLockedException $exception) {
          $this
            ->messenger()
            ->addError($this
            ->t('Document %label has a new version. The document id has been updated for all future interactions. Please try again.', [
            '%label' => $definition['title'],
          ]));
        } catch (LingotekPaymentRequiredException $exception) {
          $this
            ->messenger()
            ->addError($this
            ->t('Community has been disabled. Please contact support@lingotek.com to re-enable your community.'));
        } catch (LingotekApiException $e) {
          $this
            ->messenger()
            ->addError($this
            ->t('%label update failed. Please try again.', [
            '%label' => $mappers[$entity_type]
              ->getTitle(),
          ]));
        }
      }
      else {
        try {
          if ($this->translationService
            ->uploadConfig($entity_type)) {
            $this
              ->messenger()
              ->addStatus($this
              ->t('%label uploaded successfully', [
              '%label' => $definition['title'],
            ]));
          }
        } catch (LingotekDocumentArchivedException $exception) {
          $this
            ->messenger()
            ->addError($this
            ->t('Document %label has been archived. Please upload again.', [
            '%label' => $mappers[$entity_type]
              ->getTitle(),
          ]));
        } catch (LingotekDocumentLockedException $exception) {
          $this
            ->messenger()
            ->addError($this
            ->t('Document %label has a new version. The document id has been updated for all future interactions. Please try again.', [
            '%label' => $definition['title'],
          ]));
        } catch (LingotekPaymentRequiredException $exception) {
          $this
            ->messenger()
            ->addError($this
            ->t('Community has been disabled. Please contact support@lingotek.com to re-enable your community.'));
        } catch (LingotekApiException $e) {

          // Mark the document as failed.
          $this
            ->messenger()
            ->addError($this
            ->t('%label upload failed. Please try again.', [
            '%label' => $mappers[$entity_type]
              ->getTitle(),
          ]));
        }
      }
      return $this
        ->redirectToConfigTranslateOverview($entity_type);
    }

    // Check if it's a field.
    if (substr($entity_type, -7) == '_fields') {

      // Hack for fields, the entity is field config.
      $entity_type = 'field_config';
    }
    $entity = $this
      ->entityTypeManager()
      ->getStorage($entity_type)
      ->load($entity_id);
    if ($this->translationService
      ->getDocumentId($entity)) {
      try {
        if ($doc_id = $this->translationService
          ->updateDocument($entity)) {
          $this
            ->messenger()
            ->addStatus($this
            ->t('%label has been updated.', [
            '%label' => $entity
              ->label(),
          ]));
        }
      } catch (LingotekDocumentArchivedException $exception) {
        $this
          ->messenger()
          ->addError($this
          ->t('Document %label has been archived. Please upload again.', [
          '%label' => $entity
            ->label(),
        ]));
      } catch (LingotekDocumentLockedException $exception) {
        $this
          ->messenger()
          ->addError($this
          ->t('Document @entity_type %title has a new version. The document id has been updated for all future interactions. Please try again.', [
          '@entity_type' => $entity
            ->getEntityTypeId(),
          '%title' => $entity
            ->label(),
        ]));
      } catch (LingotekPaymentRequiredException $exception) {
        $this
          ->messenger()
          ->addError($this
          ->t('Community has been disabled. Please contact support@lingotek.com to re-enable your community.'));
      } catch (LingotekApiException $e) {
        $this
          ->messenger()
          ->addError($this
          ->t('%label update failed. Please try again.', [
          '%label' => $entity
            ->label(),
        ]));
      }
    }
    else {
      try {
        if ($doc_id = $this->translationService
          ->uploadDocument($entity)) {
          $this
            ->messenger()
            ->addStatus($this
            ->t('%label uploaded successfully', [
            '%label' => $entity
              ->label(),
          ]));
        }
      } catch (LingotekDocumentArchivedException $exception) {
        $this
          ->messenger()
          ->addError($this
          ->t('Document @entity_type %title has been archived. Please upload again.', [
          '@entity_type' => $entity
            ->getEntityTypeId(),
          '%title' => $entity
            ->label(),
        ]));
      } catch (LingotekDocumentLockedException $exception) {
        $this
          ->messenger()
          ->addError($this
          ->t('Document @entity_type %title has a new version. The document id has been updated for all future interactions. Please try again.', [
          '@entity_type' => $entity
            ->getEntityTypeId(),
          '%title' => $entity
            ->label(),
        ]));
      } catch (LingotekPaymentRequiredException $exception) {
        $this
          ->messenger()
          ->addError($this
          ->t('Community has been disabled. Please contact support@lingotek.com to re-enable your community.'));
      } catch (LingotekApiException $e) {
        $this
          ->messenger()
          ->addError($this
          ->t('%label upload failed. Please try again.', [
          '%label' => $entity
            ->label(),
        ]));
      }
    }
    return $this
      ->redirectToEntityTranslateOverview($entity_type, $entity_id);
  }
  public function update($entity_type, $entity_id, Request $request) {
    if ($entity_type === $entity_id) {

      // It is not a config entity, but a config object.
      $definition = $this->configMapperManager
        ->getDefinition($entity_type);
      $mappers = $this->configMapperManager
        ->getMappers();
      try {
        if ($this->translationService
          ->updateConfig($entity_type)) {
          $this
            ->messenger()
            ->addStatus($this
            ->t('%label has been updated.', [
            '%label' => $definition['title'],
          ]));
        }
      } catch (LingotekDocumentArchivedException $exception) {
        $this
          ->messenger()
          ->addError($this
          ->t('Document %label has been archived. Please upload again.', [
          '%label' => $definition['title'],
        ]));
      } catch (LingotekDocumentLockedException $exception) {
        $this
          ->messenger()
          ->addError($this
          ->t('Document %label has a new version. The document id has been updated for all future interactions. Please try again.', [
          '%label' => $definition['title'],
        ]));
      } catch (LingotekPaymentRequiredException $exception) {
        $this
          ->messenger()
          ->addError($this
          ->t('Community has been disabled. Please contact support@lingotek.com to re-enable your community.'));
      } catch (LingotekApiException $e) {
        $this
          ->messenger()
          ->addError($this
          ->t('%label update failed. Please try again.', [
          '%label' => $definition['title'],
        ]));
      }
      return $this
        ->redirectToConfigTranslateOverview($entity_type);
    }

    // Check if it's a field.
    if (substr($entity_type, -7) == '_fields') {

      // Hack for fields, the entity is field config.
      $entity_type = 'field_config';
    }
    $entity = $this
      ->entityTypeManager()
      ->getStorage($entity_type)
      ->load($entity_id);
    try {
      if ($this->translationService
        ->updateDocument($entity)) {
        $this
          ->messenger()
          ->addStatus($this
          ->t('%label has been updated.', [
          '%label' => $entity
            ->label(),
        ]));
      }
    } catch (LingotekDocumentArchivedException $exception) {
      $this
        ->messenger()
        ->addError($this
        ->t('Document @entity_type %title has been archived. Please upload again.', [
        '@entity_type' => $entity
          ->getEntityTypeId(),
        '%title' => $entity
          ->label(),
      ]));
    } catch (LingotekDocumentLockedException $exception) {
      $this
        ->messenger()
        ->addError($this
        ->t('Document @entity_type %title has a new version. The document id has been updated for all future interactions. Please try again.', [
        '@entity_type' => $entity
          ->getEntityTypeId(),
        '%title' => $entity
          ->label(),
      ]));
    } catch (LingotekPaymentRequiredException $exception) {
      $this
        ->messenger()
        ->addError($this
        ->t('Community has been disabled. Please contact support@lingotek.com to re-enable your community.'));
    } catch (LingotekApiException $e) {
      $this
        ->messenger()
        ->addError($this
        ->t('%label update failed. Please try again.', [
        '%label' => $entity
          ->label(),
      ]));
    }
    return $this
      ->redirectToEntityTranslateOverview($entity_type, $entity_id);
  }
  public function checkUpload($entity_type, $entity_id, Request $request) {
    if ($entity_type === $entity_id) {

      // It is not a config entity, but a config object.
      $definition = $this->configMapperManager
        ->getDefinition($entity_type);
      try {
        if ($this->translationService
          ->checkConfigSourceStatus($entity_type)) {
          $this
            ->messenger()
            ->addStatus($this
            ->t('%label status checked successfully', [
            '%label' => $definition['title'],
          ]));
        }
      } catch (LingotekApiException $e) {
        $this
          ->messenger()
          ->addError($this
          ->t('%label status check failed. Please try again.', [
          '%label' => $definition['title'],
        ]));
      }
      return $this
        ->redirectToConfigTranslateOverview($entity_type);
    }

    // Check if it's a field.
    if (substr($entity_type, -7) == '_fields') {

      // Hack for fields, the entity is field config.
      $entity_type = 'field_config';
    }
    $entity = $this
      ->entityTypeManager()
      ->getStorage($entity_type)
      ->load($entity_id);
    try {
      if ($this->translationService
        ->checkSourceStatus($entity)) {
        $this
          ->messenger()
          ->addStatus($this
          ->t('%label status checked successfully', [
          '%label' => $entity
            ->label(),
        ]));
      }
    } catch (LingotekApiException $e) {
      $this
        ->messenger()
        ->addError($this
        ->t('%label status check failed. Please try again.', [
        '%label' => $entity
          ->label(),
      ]));
    }
    return $this
      ->redirectToEntityTranslateOverview($entity_type, $entity_id);
  }
  public function request($entity_type, $entity_id, $locale, Request $request) {
    if ($entity_type === $entity_id) {

      // It is not a config entity, but a config object.
      $definition = $this->configMapperManager
        ->getDefinition($entity_type);
      try {
        if ($this->translationService
          ->addConfigTarget($entity_id, $locale)) {
          $this
            ->messenger()
            ->addStatus($this
            ->t('Translation to %locale requested successfully', [
            '%locale' => $locale,
          ]));
        }
      } catch (LingotekDocumentArchivedException $exception) {
        $this
          ->messenger()
          ->addError($this
          ->t('Document %label has been archived. Please upload again.', [
          '%label' => $definition['title'],
        ]));
      } catch (LingotekDocumentLockedException $exception) {
        $this
          ->messenger()
          ->addError($this
          ->t('Document %label has a new version. The document id has been updated for all future interactions. Please try again.', [
          '%label' => $definition['title'],
        ]));
      } catch (LingotekPaymentRequiredException $exception) {
        $this
          ->messenger()
          ->addError($this
          ->t('Community has been disabled. Please contact support@lingotek.com to re-enable your community.'));
      } catch (LingotekApiException $e) {
        $this
          ->messenger()
          ->addError($this
          ->t('%label @locale translation request failed. Please try again.', [
          '%label' => $definition['title'],
          '@locale' => $locale,
        ]));
      }
      return $this
        ->redirectToConfigTranslateOverview($entity_type);
    }

    // Check if it's a field.
    if (substr($entity_type, -7) == '_fields') {

      // Hack for fields, the entity is field config.
      $entity_type = 'field_config';
    }
    $entity = $this
      ->entityTypeManager()
      ->getStorage($entity_type)
      ->load($entity_id);
    try {
      if ($this->translationService
        ->addTarget($entity, $locale)) {
        $this
          ->messenger()
          ->addStatus($this
          ->t('Translation to %locale requested successfully', [
          '%locale' => $locale,
        ]));
      }
    } catch (LingotekDocumentArchivedException $exception) {
      $this
        ->messenger()
        ->addError($this
        ->t('Document @entity_type %title has been archived. Please upload again.', [
        '@entity_type' => $entity
          ->getEntityTypeId(),
        '%title' => $entity
          ->label(),
      ]));
    } catch (LingotekDocumentLockedException $exception) {
      $this
        ->messenger()
        ->addError($this
        ->t('Document @entity_type %title has a new version. The document id has been updated for all future interactions. Please try again.', [
        '@entity_type' => $entity
          ->getEntityTypeId(),
        '%title' => $entity
          ->label(),
      ]));
    } catch (LingotekPaymentRequiredException $exception) {
      $this
        ->messenger()
        ->addError($this
        ->t('Community has been disabled. Please contact support@lingotek.com to re-enable your community.'));
    } catch (LingotekApiException $e) {
      $this
        ->messenger()
        ->addError($this
        ->t('%label @locale translation request failed. Please try again.', [
        '%label' => $entity
          ->label(),
        '@locale' => $locale,
      ]));
    }
    return $this
      ->redirectToEntityTranslateOverview($entity_type, $entity_id);
  }
  public function checkDownload($entity_type, $entity_id, $locale, Request $request) {
    if ($entity_type === $entity_id) {

      // It is not a config entity, but a config object.
      $definition = $this->configMapperManager
        ->getDefinition($entity_type);
      try {
        if ($this->translationService
          ->checkConfigTargetStatus($entity_id, $locale)) {
          $this
            ->messenger()
            ->addStatus($this
            ->t('Translation to %locale checked successfully', [
            '%locale' => $locale,
          ]));
        }
      } catch (LingotekApiException $e) {
        $this
          ->messenger()
          ->addError($this
          ->t('%label @locale translation status check failed. Please try again.', [
          '%label' => $entity_id,
          '@locale' => $locale,
        ]));
      }
      return $this
        ->redirectToConfigTranslateOverview($entity_type);
    }

    // Check if it's a field.
    if (substr($entity_type, -7) == '_fields') {

      // Hack for fields, the entity is field config.
      $entity_type = 'field_config';
    }
    $entity = $this
      ->entityTypeManager()
      ->getStorage($entity_type)
      ->load($entity_id);
    try {
      if ($this->translationService
        ->checkTargetStatus($entity, $locale)) {
        $this
          ->messenger()
          ->addStatus($this
          ->t('Translation to %locale status checked successfully', [
          '%locale' => $locale,
        ]));
      }
    } catch (LingotekApiException $e) {
      $this
        ->messenger()
        ->addError($this
        ->t('%label @locale translation status check failed. Please try again.', [
        '%label' => $entity
          ->label(),
        '@locale' => $locale,
      ]));
    }
    return $this
      ->redirectToEntityTranslateOverview($entity_type, $entity_id);
  }
  public function download($entity_type, $entity_id, $locale, Request $request) {
    $drupal_language = $this->languageLocaleMapper
      ->getConfigurableLanguageForLocale($locale);
    $langcode = $drupal_language
      ->id();
    if ($entity_type === $entity_id) {

      // It is not a config entity, but a config object.
      $definition = $this->configMapperManager
        ->getDefinition($entity_type);
      try {
        $success = $this->translationService
          ->downloadConfig($entity_id, $locale);
        if ($success === TRUE) {
          $this
            ->messenger()
            ->addStatus($this
            ->t('Translation to %locale downloaded successfully', [
            '%locale' => $locale,
          ]));
        }
        elseif ($success === FALSE) {
          $mappers = $this->configMapperManager
            ->getMappers();
          $this->translationService
            ->setConfigTargetStatus($mappers[$entity_type], $langcode, Lingotek::STATUS_ERROR);
          $this
            ->messenger()
            ->addError($this
            ->t('%label @locale translation download failed. Please try again.', [
            '%label' => $definition['title'],
            '@locale' => $locale,
          ]));
        }
      } catch (LingotekApiException $e) {
        $mappers = $this->configMapperManager
          ->getMappers();
        $this->translationService
          ->setConfigTargetStatus($mappers[$entity_type], $langcode, Lingotek::STATUS_ERROR);
        $this
          ->messenger()
          ->addError($this
          ->t('%label @locale translation download failed. Please try again.', [
          '%label' => $definition['title'],
          '@locale' => $locale,
        ]));
      }
      return $this
        ->redirectToConfigTranslateOverview($entity_type);
    }

    // Check if it's a field.
    if (substr($entity_type, -7) == '_fields') {

      // Hack for fields, the entity is field config.
      $entity_type = 'field_config';
    }
    $entity = $this
      ->entityTypeManager()
      ->getStorage($entity_type)
      ->load($entity_id);
    try {
      $success = $this->translationService
        ->downloadDocument($entity, $locale);
      if ($success === TRUE) {
        $this
          ->messenger()
          ->addStatus($this
          ->t('Translation to %locale downloaded successfully', [
          '%locale' => $locale,
        ]));
      }
      elseif ($success === FALSE) {
        $this->translationService
          ->setTargetStatus($entity, $langcode, Lingotek::STATUS_ERROR);
        $this
          ->messenger()
          ->addError($this
          ->t('%label @locale translation download failed. Please try again.', [
          '%label' => $entity
            ->label(),
          '@locale' => $locale,
        ]));
      }
    } catch (LingotekApiException $e) {
      $this->translationService
        ->setTargetStatus($entity, $langcode, Lingotek::STATUS_ERROR);
      $this
        ->messenger()
        ->addError($this
        ->t('%label @locale translation download failed. Please try again.', [
        '%label' => $entity
          ->label(),
        '@locale' => $locale,
      ]));
    }
    return $this
      ->redirectToEntityTranslateOverview($entity_type, $entity_id);
  }

  /**
   * Redirect to config entity translation overview page.
   *
   * @param string $entity_type
   *   The config entity type id.
   * @param string $entity_id
   *   The config entity id.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   A redirect response.
   */
  protected function redirectToEntityTranslateOverview($entity_type, $entity_id) {
    $mappers = $this->configMapperManager
      ->getMappers();
    if ($entity_type === 'field_config') {
      $field_config = FieldConfig::load($entity_id);
      $id = $field_config
        ->getTargetEntityTypeId();
      $mapper = $mappers[$id . '_fields'];
      $mapper
        ->setEntity($field_config);
      $entity_definition = $this->entityTypeManager
        ->getDefinition($id);
      $uri = Url::fromRoute($mapper
        ->getOverviewRouteName(), [
        $entity_type => $entity_id,
        $entity_definition
          ->getBundleEntityType() => $field_config
          ->getTargetBundle(),
      ]);
    }
    else {
      $mapper = $mappers[$entity_type];
      $uri = Url::fromRoute($mapper
        ->getOverviewRouteName(), [
        $entity_type => $entity_id,
      ]);
    }
    return new RedirectResponse($uri
      ->setAbsolute(TRUE)
      ->toString());
  }

  /**
   * Redirect to config translation overview page.
   *
   * @param string $plugin_id
   *   The plugin id.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   A redirect response.
   */
  protected function redirectToConfigTranslateOverview($plugin_id) {
    $mappers = $this->configMapperManager
      ->getMappers();
    $mapper = $mappers[$plugin_id];
    $uri = Url::fromRoute($mapper
      ->getOverviewRouteName());
    return new RedirectResponse($uri
      ->setAbsolute(TRUE)
      ->toString());
  }

  /**
   * Generates the operation links for each language.
   *
   * @param array &$page
   *   The reference of the page build render array where we need to add the
   *   links to.
   * @param string $plugin_id
   *   The plugin id, which is needed for building the link. It could be the
   *   entity type id or the plugin id of the config mapper.
   * @param string $entity_id
   *   The entity id. If it's a config mapper and not an entity, it would be the
   *   plugin id.
   * @param int $target_status
   *   The target status for this language. This way we decide which link must
   *   be shown.
   * @param $langcode
   *   The langcode of the translation we are building the link to. Used for
   *   keying the link in the page array.
   * @param $locale
   *   Lingotek locale we are creating the link for. Used for building the link
   *   itself.
   */
  protected function generateOperationsLinks(&$page, $plugin_id, $entity_id, $target_status, $langcode, $locale) {
    $route_params = [
      'entity_type' => $plugin_id,
      'entity_id' => $entity_id,
      'locale' => $locale,
    ];
    if ($target_status === NULL || $target_status == Lingotek::STATUS_REQUEST || $target_status == Lingotek::STATUS_EDITED || $target_status == Lingotek::STATUS_UNTRACKED) {
      $page['languages'][$langcode]['operations']['#links']['request'] = [
        'title' => $this
          ->t('Request translation'),
        'url' => Url::fromRoute('lingotek.config.request', $route_params),
      ];
    }
    elseif ($target_status == Lingotek::STATUS_PENDING) {
      $page['languages'][$langcode]['operations']['#links']['check_download'] = [
        'title' => $this
          ->t('Check Download'),
        'url' => Url::fromRoute('lingotek.config.check_download', $route_params),
      ];
    }
    elseif ($target_status == Lingotek::STATUS_READY) {
      $page['languages'][$langcode]['operations']['#links']['download'] = [
        'title' => $this
          ->t('Download'),
        'url' => Url::fromRoute('lingotek.config.download', $route_params),
      ];
    }
  }

}

Classes

Namesort descending Description
LingotekConfigTranslationController