You are here

class LingotekTargetStatus in Lingotek Translation 3.6.x

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

Provides a Lingotek target status element.

Plugin annotation

@RenderElement("lingotek_target_status");

Hierarchy

Expanded class hierarchy of 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 14

Namespace

Drupal\lingotek\Element
View source
class LingotekTargetStatus extends RenderElement {
  use LingotekTargetTrait;

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#pre_render' => [
        [
          $this,
          'preRender',
        ],
      ],
      '#theme' => 'lingotek_target_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) {
    $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['#status'], $element['#language']);
    $element['#actions'] = $this
      ->getSecondaryTargetActionUrls($element['#entity'], $element['#status'], $element['#language']);
    return $element;
  }

}

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
LingotekTargetStatus::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
LingotekTargetStatus::preRender public function Calculates the url and status title and adds them to the render array.
LingotekTargetTrait::getDestinationWithQueryArray protected function Get a destination query with the current uri.
LingotekTargetTrait::getSecondaryTargetActionUrls protected function Get secondary target actions, which will be shown when expanded.
LingotekTargetTrait::getTargetActionUrl protected function Get the target action url based on the source status.
LingotekTargetTrait::getTargetStatusText protected function Get the target status label.
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.