You are here

class LingotekSourceStatus in Lingotek Translation 3.8.x

Same name and namespace in other branches
  1. 8.2 src/Element/LingotekSourceStatus.php \Drupal\lingotek\Element\LingotekSourceStatus
  2. 4.0.x src/Element/LingotekSourceStatus.php \Drupal\lingotek\Element\LingotekSourceStatus
  3. 3.0.x src/Element/LingotekSourceStatus.php \Drupal\lingotek\Element\LingotekSourceStatus
  4. 3.1.x src/Element/LingotekSourceStatus.php \Drupal\lingotek\Element\LingotekSourceStatus
  5. 3.2.x src/Element/LingotekSourceStatus.php \Drupal\lingotek\Element\LingotekSourceStatus
  6. 3.3.x src/Element/LingotekSourceStatus.php \Drupal\lingotek\Element\LingotekSourceStatus
  7. 3.4.x src/Element/LingotekSourceStatus.php \Drupal\lingotek\Element\LingotekSourceStatus
  8. 3.5.x src/Element/LingotekSourceStatus.php \Drupal\lingotek\Element\LingotekSourceStatus
  9. 3.6.x src/Element/LingotekSourceStatus.php \Drupal\lingotek\Element\LingotekSourceStatus
  10. 3.7.x src/Element/LingotekSourceStatus.php \Drupal\lingotek\Element\LingotekSourceStatus

Provides a Lingotek source status element.

Plugin annotation

@RenderElement("lingotek_source_status");

Hierarchy

Expanded class hierarchy of LingotekSourceStatus

5 #type uses of LingotekSourceStatus
LingotekConfigManagementForm::getSourceStatus in src/Form/LingotekConfigManagementForm.php
Gets the source status of an config in a format ready to display.
LingotekInterfaceTranslationForm::buildForm in src/Form/LingotekInterfaceTranslationForm.php
Form constructor.
LingotekManagementFormBase::getSourceStatus in src/Form/LingotekManagementFormBase.php
Gets the source status of an entity in a format ready to display.
LingotekSourceStatusFormatter::viewValue in src/Plugin/Field/FieldFormatter/LingotekSourceStatusFormatter.php
Generate the output appropriate for one field item.
LingotekTranslationStatusController::renderSource in tests/modules/lingotek_form_test/src/Controller/LingotekTranslationStatusController.php
Renders the Lingotek source status of the given entity.

File

src/Element/LingotekSourceStatus.php, line 15

Namespace

Drupal\lingotek\Element
View source
class LingotekSourceStatus extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#pre_render' => [
        [
          $this,
          'preRender',
        ],
      ],
      '#theme' => 'lingotek_source_status',
      '#attached' => [
        'library' => [
          'lingotek/lingotek',
          'lingotek/lingotek.target_actions',
        ],
      ],
      '#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) {
    if (isset($element['#entity'])) {
      $element['#url'] = $this
        ->getSourceActionUrl($element['#entity'], $element['#status']);
      $element['#status_title'] = $this
        ->getSourceStatusText($element['#entity'], $element['#status']);
      $element['#actions'] = $this
        ->getSecondarySourceActionUrls($element['#entity'], $element['#status'], $element['#language']);
    }
    elseif (isset($element['#ui_component'])) {
      $element['#url'] = $this
        ->getSourceActionUrlForUI($element['#ui_component'], $element['#status']);
      $element['#status_title'] = $this
        ->getSourceStatusTextForUI($element['#ui_component'], $element['#status']);
    }
    return $element;
  }

  /**
   * Get the source action url based on the source status.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The entity.
   * @param string $source_status
   *   The source status.
   *
   * @return \Drupal\Core\Url
   *   An url object.
   */
  protected function getSourceActionUrl(ContentEntityInterface &$entity, $source_status) {
    $url = NULL;
    if ($source_status == Lingotek::STATUS_IMPORTING) {
      $url = Url::fromRoute('lingotek.entity.check_upload', [
        'doc_id' => \Drupal::service('lingotek.content_translation')
          ->getDocumentId($entity),
      ], [
        'query' => $this
          ->getDestinationWithQueryArray(),
      ]);
    }
    if (in_array($source_status, [
      Lingotek::STATUS_EDITED,
      Lingotek::STATUS_UNTRACKED,
      Lingotek::STATUS_ERROR,
      Lingotek::STATUS_CANCELLED,
      Lingotek::STATUS_ARCHIVED,
      Lingotek::STATUS_DELETED,
    ])) {
      if ($doc_id = \Drupal::service('lingotek.content_translation')
        ->getDocumentId($entity)) {
        $url = Url::fromRoute('lingotek.entity.update', [
          'doc_id' => $doc_id,
        ], [
          'query' => $this
            ->getDestinationWithQueryArray(),
        ]);
      }
      else {
        $url = Url::fromRoute('lingotek.entity.upload', [
          'entity_type' => $entity
            ->getEntityTypeId(),
          'entity_id' => $entity
            ->id(),
        ], [
          'query' => $this
            ->getDestinationWithQueryArray(),
        ]);
      }
    }
    return $url;
  }
  protected function getSecondarySourceActionUrls(ContentEntityInterface &$entity, $source_status, $language) {
    $actions = [];
    $langcode = $language
      ->getId();
    if ($entity
      ->hasLinkTemplate('canonical') && $entity
      ->hasTranslation($langcode)) {
      $actions[] = [
        'title' => $this
          ->t('View'),
        'url' => $entity
          ->getTranslation($langcode)
          ->toUrl(),
        'new_window' => FALSE,
      ];
    }
    $content_translation_service = \Drupal::service('lingotek.content_translation');
    if ($source_status == Lingotek::STATUS_IMPORTING) {
      $actions[] = [
        'title' => $this
          ->t('Check upload status'),
        'url' => Url::fromRoute('lingotek.entity.check_upload', [
          'doc_id' => $content_translation_service
            ->getDocumentId($entity),
        ], [
          'query' => $this
            ->getDestinationWithQueryArray(),
        ]),
        'new_window' => FALSE,
      ];
    }
    if (in_array($source_status, [
      Lingotek::STATUS_EDITED,
      Lingotek::STATUS_UNTRACKED,
      Lingotek::STATUS_ERROR,
      Lingotek::STATUS_CANCELLED,
      Lingotek::STATUS_ARCHIVED,
      Lingotek::STATUS_DELETED,
    ])) {
      if ($doc_id = $content_translation_service
        ->getDocumentId($entity)) {
        $actions[] = [
          'title' => $this
            ->t('Update document'),
          'url' => Url::fromRoute('lingotek.entity.update', [
            'doc_id' => $doc_id,
          ], [
            'query' => $this
              ->getDestinationWithQueryArray(),
          ]),
          'new_window' => FALSE,
        ];
      }
      else {
        $actions[] = [
          'title' => $this
            ->t('Upload document'),
          'url' => Url::fromRoute('lingotek.entity.upload', [
            'entity_type' => $entity
              ->getEntityTypeId(),
            'entity_id' => $entity
              ->id(),
          ], [
            'query' => $this
              ->getDestinationWithQueryArray(),
          ]),
          'new_window' => FALSE,
        ];
      }
    }
    return $actions;
  }
  protected function getSourceActionUrlForUI($component, $source_status) {
    $url = NULL;
    if ($source_status == Lingotek::STATUS_IMPORTING) {
      $url = Url::fromRoute('lingotek.interface_translation.check_upload', [], [
        'query' => [
          'component' => $component,
        ] + $this
          ->getDestinationWithQueryArray(),
      ]);
    }
    if (in_array($source_status, [
      Lingotek::STATUS_EDITED,
      Lingotek::STATUS_UNTRACKED,
      Lingotek::STATUS_ERROR,
      Lingotek::STATUS_CANCELLED,
      Lingotek::STATUS_ARCHIVED,
      Lingotek::STATUS_DELETED,
    ])) {
      if ($doc_id = \Drupal::service('lingotek.interface_translation')
        ->getDocumentId($component)) {
        $url = Url::fromRoute('lingotek.interface_translation.update', [], [
          'query' => [
            'component' => $component,
          ] + $this
            ->getDestinationWithQueryArray(),
        ]);
      }
      else {
        $url = Url::fromRoute('lingotek.interface_translation.upload', [], [
          'query' => [
            'component' => $component,
          ] + $this
            ->getDestinationWithQueryArray(),
        ]);
      }
    }
    return $url;
  }

  /**
   * Get the source status label.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The entity.
   * @param string $source_status
   *   The source status
   *
   * @return string
   *   The source status human-friendly label.
   */
  protected function getSourceStatusText(ContentEntityInterface $entity, $source_status) {
    switch ($source_status) {
      case Lingotek::STATUS_UNTRACKED:
      case Lingotek::STATUS_REQUEST:
        return t('Upload');
      case Lingotek::STATUS_DISABLED:
        return t('Disabled, cannot request translation');
      case Lingotek::STATUS_EDITED:
        return \Drupal::service('lingotek.content_translation')
          ->getDocumentId($entity) ? t('Re-upload (content has changed since last upload)') : t('Upload');
      case Lingotek::STATUS_IMPORTING:
        return t('Source importing');
      case Lingotek::STATUS_CURRENT:
        return t('Source uploaded');
      case Lingotek::STATUS_ERROR:
        return t('Error');
      case Lingotek::STATUS_CANCELLED:
        return $this
          ->t('Cancelled by user');
      case Lingotek::STATUS_ARCHIVED:
        return $this
          ->t('This document was archived in Lingotek. Re-upload to translate.');
      case Lingotek::STATUS_DELETED:
        return $this
          ->t('This document was deleted in Lingotek. Re-upload to translate.');
      default:
        return ucfirst(strtolower($source_status));
    }
  }
  protected function getSourceStatusTextForUI($component, $source_status) {
    switch ($source_status) {
      case Lingotek::STATUS_UNTRACKED:
      case Lingotek::STATUS_REQUEST:
        return t('Upload');
      case Lingotek::STATUS_DISABLED:
        return t('Disabled, cannot request translation');
      case Lingotek::STATUS_EDITED:
        return \Drupal::service('lingotek.interface_translation')
          ->getDocumentId($component) ? t('Re-upload (content has changed since last upload)') : t('Upload');
      case Lingotek::STATUS_IMPORTING:
        return t('Source importing');
      case Lingotek::STATUS_CURRENT:
        return t('Source uploaded');
      case Lingotek::STATUS_ERROR:
        return t('Error');
      case Lingotek::STATUS_CANCELLED:
        return $this
          ->t('Cancelled by user');
      case Lingotek::STATUS_ARCHIVED:
        return $this
          ->t('This document was archived in Lingotek. Re-upload to translate.');
      case Lingotek::STATUS_DELETED:
        return $this
          ->t('This document was deleted in Lingotek. Re-upload to translate.');
      default:
        return ucfirst(strtolower($source_status));
    }
  }

  /**
   * 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

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
LingotekSourceStatus::getDestinationWithQueryArray protected function Get a destination query with the current uri.
LingotekSourceStatus::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
LingotekSourceStatus::getSecondarySourceActionUrls protected function
LingotekSourceStatus::getSourceActionUrl protected function Get the source action url based on the source status.
LingotekSourceStatus::getSourceActionUrlForUI protected function
LingotekSourceStatus::getSourceStatusText protected function Get the source status label.
LingotekSourceStatus::getSourceStatusTextForUI protected function
LingotekSourceStatus::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.