class LingotekDownloaderQueueWorker in Lingotek Translation 3.2.x

Provides base functionality for the Lingotek Queue Workers.

Plugin annotation

@QueueWorker(
  id = "lingotek_downloader_queue_worker",
  title = @Translation("Lingotek Download Queue"),
  cron = {"time" = 60}
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Queue\QueueWorkerBase implements QueueWorkerInterface
    • class \Drupal\lingotek\Plugin\QueueWorker\LingotekDownloaderQueueWorker

1 file declares its use of LingotekDownloaderQueueWorker

LingotekQueueWorkerTest.php in tests/src/Unit/LingotekQueueWorkerTest.php

File

src/Plugin/QueueWorker/LingotekDownloaderQueueWorker.php, line 20

Namespace

Drupal\lingotek\Plugin\QueueWorker

class LingotekDownloaderQueueWorker extends QueueWorkerBase {

  /**
   * {@inheritdoc}
   */
  public function processItem($data) {
    $locale = $data['locale'];
    $entity_type_id = $data['entity_type_id'];
    $entity_id = $data['entity_id'];
    $document_id = $data['document_id'];
    $entity = \Drupal::entityTypeManager()
      ->getStorage($entity_type_id)
      ->load($entity_id);
    if ($entity instanceof ConfigEntityInterface) {

      /** @var \Drupal\lingotek\LingotekConfigTranslationServiceInterface $translation_service */
      $translation_service = \Drupal::service('lingotek.config_translation');
    }
    elseif ($entity instanceof ContentEntityInterface) {

      /** @var \Drupal\lingotek\LingotekContentTranslationServiceInterface $translation_service */
      $translation_service = \Drupal::service('lingotek.content_translation');
    }
    if (empty($translation_service)) {
      $message = new FormattableMarkup('Can not download - entity (@instance) is not supported instance of a class', [
        '@instance' => gettype($entity),
      ]);
      \Drupal::logger('lingotek')
        ->error($message);
      throw new \Exception($message);
    }
    $translation_service
      ->setTargetStatus($entity, $locale, Lingotek::STATUS_READY);
    $download = $translation_service
      ->downloadDocument($entity, $locale);
    if ($download === FALSE || $download === NULL) {
      $message = new FormattableMarkup('No download for target @locale happened in document @document on @entity @bundle @id.', [
        '@locale' => $locale,
        '@document' => $document_id,
        '@entity' => $entity
          ->label(),
        '@id' => $entity
          ->id(),
        '@bundle' => $entity
          ->bundle(),
      ]);
      \Drupal::logger('lingotek')
        ->error($message);
      throw new \Exception($message);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LingotekDownloaderQueueWorker::processItem	public	function	Works on a single queue item. Overrides QueueWorkerInterface::processItem
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	98