class LingotekTargetStatus in Lingotek Translation 3.1.x

Provides a Lingotek target status element.

Plugin annotation

@RenderElement("lingotek_target_status");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\lingotek\Element\LingotekTargetStatus

2 #type uses of LingotekTargetStatus

LingotekTranslationStatusController::renderTargetStatus in tests/modules/lingotek_form_test/src/Controller/LingotekTranslationStatusController.php

Renders the Lingotek target status of the given entity.

LingotekTranslationStatusFormatter::viewElements in src/Plugin/Field/FieldFormatter/LingotekTranslationStatusFormatter.php

Builds a renderable array for a field value.

File

src/Element/LingotekTargetStatus.php, line 16

Namespace

Drupal\lingotek\Element

class LingotekTargetStatus extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#pre_render' => [
        [
          $this,
          'preRender',
        ],
      ],
      '#theme' => 'lingotek_target_status',
      '#attached' => [
        'library' => [
          'lingotek/lingotek',
        ],
      ],
      '#cache' => [
        'max-age' => 0,
      ],
    ];
  }

  /**
   * Calculates the url and status title and adds them to the render array.
   *
   * @param array $element
   *   The element as a render array.
   *
   * @return array
   *   The element as a render array.
   */
  public function preRender(array $element) {
    $isSourceLanguage = $element['#entity']
      ->language()
      ->getId() === $element['#language'];
    if ($isSourceLanguage) {
      return [];
    }
    if (NULL === ConfigurableLanguage::load($element['#language'])) {
      return [];
    }
    $element['#url'] = $this
      ->getTargetActionUrl($element['#entity'], $element['#status'], $element['#language']);
    $element['#new_window'] = !($element['#entity']
      ->hasTranslation($element['#language']) && $element['#status'] == Lingotek::STATUS_REQUEST) && in_array($element['#status'], [
      Lingotek::STATUS_CURRENT,
      Lingotek::STATUS_INTERMEDIATE,
      Lingotek::STATUS_EDITED,
    ]);
    $element['#status_text'] = $this
      ->getTargetStatusText($element['#entity'], $element['#status'], $element['#language']);
    return $element;
  }

  /**
   * Get the source status label.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The entity.
   * @param string $status
   *   The target status.
   * @param string $langcode
   *   The language code.
   *
   * @return string
   *   The source status human-friendly label.
   */
  protected function getTargetStatusText(ContentEntityInterface $entity, $status, $langcode) {
    $language = ConfigurableLanguage::load($langcode);
    switch ($status) {
      case Lingotek::STATUS_UNTRACKED:
        return $language
          ->label() . ' - ' . $this
          ->t('Translation exists, but it is not being tracked by Lingotek');
      case Lingotek::STATUS_REQUEST:
        return $language
          ->label() . ' - ' . $this
          ->t('Request translation');
      case Lingotek::STATUS_PENDING:
        return $language
          ->label() . ' - ' . $this
          ->t('In-progress');
      case Lingotek::STATUS_READY:
        return $language
          ->label() . ' - ' . $this
          ->t('Ready for Download');
      case Lingotek::STATUS_INTERMEDIATE:
        return $language
          ->label() . ' - ' . $this
          ->t('In-progress (interim translation downloaded)');
      case Lingotek::STATUS_CURRENT:
        return $language
          ->label() . ' - ' . $this
          ->t('Current');
      case Lingotek::STATUS_EDITED:
        return $language
          ->label() . ' - ' . $this
          ->t('Not current');
      case Lingotek::STATUS_ERROR:
        return $language
          ->label() . ' - ' . $this
          ->t('Error');
      case Lingotek::STATUS_CANCELLED:
        return $language
          ->label() . ' - ' . $this
          ->t('Cancelled by user');
      default:
        return $language
          ->label() . ' - ' . ucfirst(strtolower($status));
    }
  }

  /**
   * Get the target action url based on the source status.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The entity.
   * @param string $target_status
   *   The target status.
   * @param string $langcode
   *   The language code.
   *
   * @return \Drupal\Core\Url
   *   An url object.
   */
  protected function getTargetActionUrl(ContentEntityInterface &$entity, $target_status, $langcode) {
    $url = NULL;
    $document_id = \Drupal::service('lingotek.content_translation')
      ->getDocumentId($entity);
    $locale = \Drupal::service('lingotek.language_locale_mapper')
      ->getLocaleForLangcode($langcode);
    if ($document_id) {
      if ($target_status == Lingotek::STATUS_REQUEST) {
        $url = Url::fromRoute('lingotek.entity.request_translation', [
          'doc_id' => $document_id,
          'locale' => $locale,
        ], [
          'query' => $this
            ->getDestinationWithQueryArray(),
        ]);
      }
      if ($target_status == Lingotek::STATUS_PENDING) {
        $url = Url::fromRoute('lingotek.entity.check_target', [
          'doc_id' => $document_id,
          'locale' => $locale,
        ], [
          'query' => $this
            ->getDestinationWithQueryArray(),
        ]);
      }
      if ($target_status == Lingotek::STATUS_READY || $target_status == Lingotek::STATUS_ERROR) {
        $url = Url::fromRoute('lingotek.entity.download', [
          'doc_id' => $document_id,
          'locale' => $locale,
        ], [
          'query' => $this
            ->getDestinationWithQueryArray(),
        ]);
      }
      if ($target_status == Lingotek::STATUS_CURRENT || $target_status == Lingotek::STATUS_INTERMEDIATE || $target_status == Lingotek::STATUS_EDITED) {
        $url = Url::fromRoute('lingotek.workbench', [
          'doc_id' => $document_id,
          'locale' => $locale,
        ]);
      }
      if ($target_status == Lingotek::STATUS_UNTRACKED) {
        $url = Url::fromRoute('lingotek.entity.request_translation', [
          'doc_id' => $document_id,
          'locale' => $locale,
        ], [
          'query' => $this
            ->getDestinationWithQueryArray(),
        ]);
      }
    }
    return $url;
  }

  /**
   * Get a destination query with the current uri.
   *
   * @return array
   *   A valid query array for the Url construction.
   */
  protected function getDestinationWithQueryArray() {
    return [
      'destination' => \Drupal::request()
        ->getRequestUri(),
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
LingotekTargetStatus::getDestinationWithQueryArray	protected	function	Get a destination query with the current uri.
LingotekTargetStatus::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
LingotekTargetStatus::getTargetActionUrl	protected	function	Get the target action url based on the source status.
LingotekTargetStatus::getTargetStatusText	protected	function	Get the source status label.
LingotekTargetStatus::preRender	public	function	Calculates the url and status title and adds them to the render array.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
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
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.