class LingotekTranslationStatusesFormatter in Lingotek Translation 3.1.x
Same name and namespace in other branches
- 8.2 src/Plugin/Field/FieldFormatter/LingotekTranslationStatusesFormatter.php \Drupal\lingotek\Plugin\Field\FieldFormatter\LingotekTranslationStatusesFormatter
- 4.0.x src/Plugin/Field/FieldFormatter/LingotekTranslationStatusesFormatter.php \Drupal\lingotek\Plugin\Field\FieldFormatter\LingotekTranslationStatusesFormatter
- 3.0.x src/Plugin/Field/FieldFormatter/LingotekTranslationStatusesFormatter.php \Drupal\lingotek\Plugin\Field\FieldFormatter\LingotekTranslationStatusesFormatter
- 3.2.x src/Plugin/Field/FieldFormatter/LingotekTranslationStatusesFormatter.php \Drupal\lingotek\Plugin\Field\FieldFormatter\LingotekTranslationStatusesFormatter
- 3.3.x src/Plugin/Field/FieldFormatter/LingotekTranslationStatusesFormatter.php \Drupal\lingotek\Plugin\Field\FieldFormatter\LingotekTranslationStatusesFormatter
- 3.4.x src/Plugin/Field/FieldFormatter/LingotekTranslationStatusesFormatter.php \Drupal\lingotek\Plugin\Field\FieldFormatter\LingotekTranslationStatusesFormatter
- 3.5.x src/Plugin/Field/FieldFormatter/LingotekTranslationStatusesFormatter.php \Drupal\lingotek\Plugin\Field\FieldFormatter\LingotekTranslationStatusesFormatter
- 3.6.x src/Plugin/Field/FieldFormatter/LingotekTranslationStatusesFormatter.php \Drupal\lingotek\Plugin\Field\FieldFormatter\LingotekTranslationStatusesFormatter
- 3.7.x src/Plugin/Field/FieldFormatter/LingotekTranslationStatusesFormatter.php \Drupal\lingotek\Plugin\Field\FieldFormatter\LingotekTranslationStatusesFormatter
- 3.8.x src/Plugin/Field/FieldFormatter/LingotekTranslationStatusesFormatter.php \Drupal\lingotek\Plugin\Field\FieldFormatter\LingotekTranslationStatusesFormatter
Plugin implementation of the 'lingotek_translation_statuses' formatter.
Plugin annotation
@FieldFormatter(
id = "lingotek_translation_statuses",
label = @Translation("Lingotek translation statuses"),
field_types = {
"lingotek_language_key_value",
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\lingotek\Plugin\Field\FieldFormatter\LingotekTranslationStatusesFormatter implements ContainerFactoryPluginInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of LingotekTranslationStatusesFormatter
File
- src/
Plugin/ Field/ FieldFormatter/ LingotekTranslationStatusesFormatter.php, line 23
Namespace
Drupal\lingotek\Plugin\Field\FieldFormatterView source
class LingotekTranslationStatusesFormatter extends FormatterBase implements ContainerFactoryPluginInterface {
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings']);
}
/**
* {@inheritdoc}
*/
public function view(FieldItemListInterface $items, $langcode = NULL) {
$entity = $items
->getEntity();
if ($entity instanceof LingotekContentMetadata) {
// $entity is the metadata of another entity. Let's get the source.
$entity = \Drupal::entityTypeManager()
->getStorage($entity
->getContentEntityTypeId())
->load($entity
->getContentEntityId());
}
$statuses = [];
foreach ($items as $delta => $item) {
$value = $item
->getValue();
$langcode = $value['language'];
$status = $value['value'];
$statuses[$langcode] = $status;
}
return [
'0' => [
'#type' => 'lingotek_target_statuses',
'#entity' => $entity,
'#source_langcode' => $entity
->language()
->getId(),
'#statuses' => $statuses,
],
'#items' => [
'0' => [
'#type' => 'lingotek_target_statuses',
'#entity' => $entity,
'#source_langcode' => $entity
->language()
->getId(),
'#statuses' => $statuses,
],
],
'#attached' => [
'library' => [
'lingotek/lingotek',
],
],
'#cache' => [
'max-age' => 0,
],
];
}
/**
* {@inheritdoc}
*/
public static function isApplicable(FieldDefinitionInterface $field_definition) {
return $field_definition
->getType() === 'lingotek_language_key_value';
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
// We need to implement this, but the ::view() method itself is hacking its
// way around so this is never called.
return FALSE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
FormatterBase:: |
public | function |
Allows formatters to load information for field values being displayed. Overrides FormatterInterface:: |
2 |
FormatterBase:: |
public | function |
Returns a form to configure settings for the formatter. Overrides FormatterInterface:: |
24 |
FormatterBase:: |
public | function |
Returns a short summary for the current formatter settings. Overrides FormatterInterface:: |
22 |
FormatterBase:: |
public | function |
Constructs a FormatterBase object. Overrides PluginBase:: |
12 |
LingotekTranslationStatusesFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
|
LingotekTranslationStatusesFormatter:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterBase:: |
|
LingotekTranslationStatusesFormatter:: |
public | function |
Builds a renderable array for a fully themed field. Overrides FormatterBase:: |
|
LingotekTranslationStatusesFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides FormatterInterface:: |
|
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. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsInterface:: |
42 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
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. |