class EntityReferenceExport in Entity Export CSV 8
Defines an Entity Reference field type export plugin.
Plugin annotation
@FieldTypeExport(
id = "entity_reference_export",
label = @Translation("Entity reference export"),
description = @Translation("Entity reference export"),
weight = 0,
field_type = {
"entity_reference",
},
entity_type = {},
bundle = {},
field_name = {},
exclusive = FALSE,
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\entity_export_csv\Plugin\FieldTypeExportBase implements ContainerFactoryPluginInterface, FieldTypeExportInterface uses DependencySerializationTrait, DependencyTrait, StringTranslationTrait
- class \Drupal\entity_export_csv\Plugin\FieldTypeExport\EntityReferenceExport
- class \Drupal\entity_export_csv\Plugin\FieldTypeExportBase implements ContainerFactoryPluginInterface, FieldTypeExportInterface uses DependencySerializationTrait, DependencyTrait, StringTranslationTrait
Expanded class hierarchy of EntityReferenceExport
File
- src/
Plugin/ FieldTypeExport/ EntityReferenceExport.php, line 27
Namespace
Drupal\entity_export_csv\Plugin\FieldTypeExportView source
class EntityReferenceExport extends FieldTypeExportBase {
/**
* {@inheritdoc}
*/
public function getSummary() {
return [
'message' => [
'#markup' => $this
->t('Entity reference field type exporter.'),
],
];
}
/**
* {@inheritdoc}
*/
public function massageExportPropertyValue(FieldItemInterface $field_item, $property_name, FieldDefinitionInterface $field_definition, $options = []) {
if ($field_item
->isEmpty()) {
return NULL;
}
$configuration = $this
->getConfiguration();
if (empty($configuration['format'])) {
return $field_item
->get($property_name)
->getValue();
}
$format = $configuration['format'];
if ($format === 'entity_reference_label') {
$entity = $field_item
->get('entity')
->getValue();
if ($entity instanceof EntityInterface) {
return $entity
->label();
}
}
return $field_item
->get($property_name)
->getValue();
}
/**
* {@inheritdoc}
*/
protected function getFormatExportOptions(FieldDefinitionInterface $field_definition) {
$options = parent::getFormatExportOptions($field_definition);
$options['entity_reference_label'] = $this
->t('Label');
return $options;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. | |
EntityReferenceExport:: |
protected | function |
Get the format options to export. Overrides FieldTypeExportBase:: |
|
EntityReferenceExport:: |
public | function | ||
EntityReferenceExport:: |
public | function |
Massage the field item property value to CSV value. Overrides FieldTypeExportBase:: |
|
FieldTypeExportBase:: |
protected | property | The config factory service. | |
FieldTypeExportBase:: |
protected | property | Drupal\Core\Datetime\DateFormatterInterface definition. | |
FieldTypeExportBase:: |
protected | property | Drupal\Core\Entity\EntityFieldManagerInterface definition. | |
FieldTypeExportBase:: |
protected | property | Drupal\Core\Entity\EntityRepositoryInterface definition. | |
FieldTypeExportBase:: |
protected | property | Drupal\Core\Entity\EntityTypeManagerInterface definition. | |
FieldTypeExportBase:: |
protected | property | The language manager service. | |
FieldTypeExportBase:: |
protected | property | Drupal\Core\Extension\ModuleHandlerInterface definition. | |
FieldTypeExportBase:: |
protected | property | The field properties. | |
FieldTypeExportBase:: |
protected | function | Default method to allow to export multiple properties. | |
FieldTypeExportBase:: |
public | function |
Build the configuration form. Overrides FieldTypeExportInterface:: |
4 |
FieldTypeExportBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
FieldTypeExportBase:: |
public | function | ||
FieldTypeExportBase:: |
public | function |
Export the value of a field. Overrides FieldTypeExportInterface:: |
|
FieldTypeExportBase:: |
protected | function | Is the field is multiple ? | |
FieldTypeExportBase:: |
public | function |
Get the columns to generate during the export. Overrides FieldTypeExportInterface:: |
|
FieldTypeExportBase:: |
public | function | ||
FieldTypeExportBase:: |
public | function |
Retrieves the generator description. Overrides FieldTypeExportInterface:: |
|
FieldTypeExportBase:: |
public | function |
Gets the field's properties. Overrides FieldTypeExportInterface:: |
1 |
FieldTypeExportBase:: |
public | function |
Get the header label for a field. Overrides FieldTypeExportInterface:: |
|
FieldTypeExportBase:: |
protected | function | Get the header export options. | |
FieldTypeExportBase:: |
public | function |
Get the header columns for a field. Overrides FieldTypeExportInterface:: |
|
FieldTypeExportBase:: |
public | function |
Retrieves the label. Overrides FieldTypeExportInterface:: |
|
FieldTypeExportBase:: |
protected | function | Get the main property name of a field. | |
FieldTypeExportBase:: |
protected | function | Get the max columns for multiple fields. | |
FieldTypeExportBase:: |
protected | function | Get the field properties selected. | |
FieldTypeExportBase:: |
protected | function | Get the property separator selected. | |
FieldTypeExportBase:: |
protected | function | Get the property separator options. | |
FieldTypeExportBase:: |
protected | function | Get the properties options to export. | |
FieldTypeExportBase:: |
protected | function | Get the property header label. | |
FieldTypeExportBase:: |
protected | function | Get the separator options when exporting in a single column. | |
FieldTypeExportBase:: |
public | function |
Import a value into a field. Overrides FieldTypeExportInterface:: |
|
FieldTypeExportBase:: |
protected | function | Should properties be exported in separated columns ? | |
FieldTypeExportBase:: |
public | function | ||
FieldTypeExportBase:: |
public | function |
Provides a human readable summary of the plugin's configuration. Overrides FieldTypeExportInterface:: |
|
FieldTypeExportBase:: |
public | function |
Validates a configuration form for this plugin. Overrides FieldTypeExportInterface:: |
|
FieldTypeExportBase:: |
public | function |
LogGeneratorBase constructor. Overrides PluginBase:: |
|
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:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
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. |