class LingotekTargetStatuses in Lingotek Translation 3.5.x
Same name and namespace in other branches
- 8.2 src/Element/LingotekTargetStatuses.php \Drupal\lingotek\Element\LingotekTargetStatuses
- 4.0.x src/Element/LingotekTargetStatuses.php \Drupal\lingotek\Element\LingotekTargetStatuses
- 3.0.x src/Element/LingotekTargetStatuses.php \Drupal\lingotek\Element\LingotekTargetStatuses
- 3.1.x src/Element/LingotekTargetStatuses.php \Drupal\lingotek\Element\LingotekTargetStatuses
- 3.2.x src/Element/LingotekTargetStatuses.php \Drupal\lingotek\Element\LingotekTargetStatuses
- 3.3.x src/Element/LingotekTargetStatuses.php \Drupal\lingotek\Element\LingotekTargetStatuses
- 3.4.x src/Element/LingotekTargetStatuses.php \Drupal\lingotek\Element\LingotekTargetStatuses
- 3.6.x src/Element/LingotekTargetStatuses.php \Drupal\lingotek\Element\LingotekTargetStatuses
- 3.7.x src/Element/LingotekTargetStatuses.php \Drupal\lingotek\Element\LingotekTargetStatuses
- 3.8.x src/Element/LingotekTargetStatuses.php \Drupal\lingotek\Element\LingotekTargetStatuses
Provides a Lingotek target status element.
Plugin annotation
@RenderElement("lingotek_target_statuses");
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\LingotekTargetStatuses
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of LingotekTargetStatuses
4 #type uses of LingotekTargetStatuses
- LingotekInterfaceTranslationForm::buildForm in src/
Form/ LingotekInterfaceTranslationForm.php - Form constructor.
- LingotekManagementFormBase::getTranslationsStatuses in src/
Form/ LingotekManagementFormBase.php - Gets the translation status of an entity in a format ready to display.
- LingotekTranslationStatusController::renderTargetStatuses in tests/
modules/ lingotek_form_test/ src/ Controller/ LingotekTranslationStatusController.php - Renders the Lingotek target statuses of the given entity.
- LingotekTranslationStatusesFormatter::view in src/
Plugin/ Field/ FieldFormatter/ LingotekTranslationStatusesFormatter.php - Builds a renderable array for a fully themed field.
File
- src/
Element/ LingotekTargetStatuses.php, line 17
Namespace
Drupal\lingotek\ElementView source
class LingotekTargetStatuses extends RenderElement {
/**
* {@inheritdoc}
*/
public function getInfo() {
return [
'#pre_render' => [
[
$this,
'preRender',
],
],
'#theme' => 'lingotek_target_statuses',
'#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) {
if (isset($element['#entity'])) {
$statuses = $this
->getTranslationsStatuses($element['#entity'], $element['#source_langcode'], $element['#statuses']);
}
elseif (isset($element['#ui_component'])) {
$statuses = $this
->getTranslationsStatusesForUI($element['#ui_component'], $element['#source_langcode'], $element['#statuses']);
}
$element['#statuses'] = $statuses;
return $element;
}
/**
* Gets the translation status of an entity in a format ready to display.
*
* @param \Drupal\Core\Entity\ContentEntityInterface $entity
* The entity.
* @param string $source_langcode
* The source language code.
* @param array $statuses
* Array of known statuses keyed by language code.
*
* @return array
* A render array.
*/
protected function getTranslationsStatuses(ContentEntityInterface &$entity, $source_langcode, array $statuses) {
$translations = [];
$languages = \Drupal::languageManager()
->getLanguages();
$languages = array_filter($languages, function (LanguageInterface $language) {
$configLanguage = ConfigurableLanguage::load($language
->getId());
return \Drupal::service('lingotek.configuration')
->isLanguageEnabled($configLanguage);
});
foreach ($statuses as $langcode => $status) {
if ($langcode !== $source_langcode && array_key_exists($langcode, $languages)) {
// We may have an existing translation already.
if ($entity
->hasTranslation($langcode) && $status == Lingotek::STATUS_REQUEST) {
$translations[$langcode] = [
'status' => Lingotek::STATUS_UNTRACKED,
'url' => $this
->getTargetActionUrl($entity, Lingotek::STATUS_UNTRACKED, $langcode),
'new_window' => FALSE,
];
}
else {
$translations[$langcode] = [
'status' => $status,
'url' => $this
->getTargetActionUrl($entity, $status, $langcode),
'new_window' => in_array($status, [
Lingotek::STATUS_CURRENT,
Lingotek::STATUS_INTERMEDIATE,
Lingotek::STATUS_EDITED,
]),
];
}
}
array_walk($languages, function ($language, $langcode) use ($entity, &$translations) {
if (!isset($translations[$langcode]) && $langcode !== $entity
->getUntranslated()
->language()
->getId()) {
$translations[$langcode] = [
'status' => Lingotek::STATUS_REQUEST,
'url' => $this
->getTargetActionUrl($entity, Lingotek::STATUS_REQUEST, $langcode),
'new_window' => FALSE,
];
}
});
}
foreach ($languages as $langcode => $language) {
// Show the untracked translations in the bulk management form, unless it's the
// source one.
if (!isset($translations[$langcode]) && $entity
->hasTranslation($langcode) && $source_langcode !== $langcode) {
$translations[$langcode] = [
'status' => Lingotek::STATUS_UNTRACKED,
'url' => NULL,
'new_window' => FALSE,
];
}
}
ksort($translations);
foreach ($translations as $langcode => &$translation) {
$translation['status_text'] = $this
->getTargetStatusText($translation['status'], $langcode);
$translation['language'] = $langcode;
}
return $translations;
}
protected function getTranslationsStatusesForUI($component, $source_langcode, array $statuses) {
$translations = [];
$languages = \Drupal::languageManager()
->getLanguages();
$languages = array_filter($languages, function (LanguageInterface $language) {
$configLanguage = ConfigurableLanguage::load($language
->getId());
return \Drupal::service('lingotek.configuration')
->isLanguageEnabled($configLanguage);
});
foreach ($statuses as $langcode => $status) {
if ($langcode !== $source_langcode && array_key_exists($langcode, $languages)) {
// We may have an existing translation already.
$translations[$langcode] = [
'status' => $status,
'url' => $this
->getTargetActionUrlForUI($component, $status, $langcode),
'new_window' => in_array($status, [
Lingotek::STATUS_CURRENT,
Lingotek::STATUS_INTERMEDIATE,
Lingotek::STATUS_EDITED,
]),
];
}
array_walk($languages, function ($language, $langcode) use ($component, &$translations) {
if (!isset($translations[$langcode]) && $langcode !== 'en') {
$translations[$langcode] = [
'status' => Lingotek::STATUS_REQUEST,
'url' => $this
->getTargetActionUrlForUI($component, Lingotek::STATUS_REQUEST, $langcode),
'new_window' => FALSE,
];
}
});
}
ksort($translations);
foreach ($translations as $langcode => &$translation) {
$translation['status_text'] = $this
->getTargetStatusText($translation['status'], $langcode);
$translation['language'] = $langcode;
}
return $translations;
}
/**
* Get the source status label.
*
* @param string $status
* The target status.
* @param string $langcode
* The language code.
*
* @return string
* The source status human-friendly label.
*/
protected function getTargetStatusText($status, $langcode) {
$language = ConfigurableLanguage::load($langcode);
switch ($status) {
case Lingotek::STATUS_DISABLED:
return $language
->label() . ' - ' . $this
->t('Disabled');
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(),
]);
}
if ($target_status == Lingotek::STATUS_DISABLED) {
$url = NULL;
}
}
return $url;
}
protected function getTargetActionUrlForUI($component, $target_status, $langcode) {
$url = NULL;
$document_id = \Drupal::service('lingotek.interface_translation')
->getDocumentId($component);
$locale = \Drupal::service('lingotek.language_locale_mapper')
->getLocaleForLangcode($langcode);
if ($document_id) {
if ($target_status == Lingotek::STATUS_REQUEST) {
$url = Url::fromRoute('lingotek.interface_translation.request_translation', [], [
'query' => [
'component' => $component,
'locale' => $locale,
] + $this
->getDestinationWithQueryArray(),
]);
}
if ($target_status == Lingotek::STATUS_PENDING) {
$url = Url::fromRoute('lingotek.interface_translation.check_translation', [], [
'query' => [
'component' => $component,
'locale' => $locale,
] + $this
->getDestinationWithQueryArray(),
]);
}
if ($target_status == Lingotek::STATUS_READY || $target_status == Lingotek::STATUS_ERROR) {
$url = Url::fromRoute('lingotek.interface_translation.download', [], [
'query' => [
'component' => $component,
'locale' => $locale,
] + $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.interface_translation.request_translation', [], [
'query' => [
'component' => $component,
'locale' => $locale,
] + $this
->getDestinationWithQueryArray(),
]);
}
if ($target_status == Lingotek::STATUS_DISABLED) {
$url = NULL;
}
}
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:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
LingotekTargetStatuses:: |
protected | function | Get a destination query with the current uri. | |
LingotekTargetStatuses:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
LingotekTargetStatuses:: |
protected | function | Get the target action url based on the source status. | |
LingotekTargetStatuses:: |
protected | function | ||
LingotekTargetStatuses:: |
protected | function | Get the source status label. | |
LingotekTargetStatuses:: |
protected | function | Gets the translation status of an entity in a format ready to display. | |
LingotekTargetStatuses:: |
protected | function | ||
LingotekTargetStatuses:: |
public | function | Calculates the url and status title and adds them to the render array. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 98 |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |