class FieldPluginBase
Same name in this branch
- 8.9.x core/modules/views/src/Plugin/views/field/FieldPluginBase.php \Drupal\views\Plugin\views\field\FieldPluginBase
Same name and namespace in other branches
- 9 core/modules/migrate_drupal/src/Plugin/migrate/field/FieldPluginBase.php \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase
- 9 core/modules/views/src/Plugin/views/field/FieldPluginBase.php \Drupal\views\Plugin\views\field\FieldPluginBase
- 10 core/modules/migrate_drupal/src/Plugin/migrate/field/FieldPluginBase.php \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase
- 10 core/modules/views/src/Plugin/views/field/FieldPluginBase.php \Drupal\views\Plugin\views\field\FieldPluginBase
- 11.x core/modules/migrate_drupal/src/Plugin/migrate/field/FieldPluginBase.php \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase
- 11.x core/modules/views/src/Plugin/views/field/FieldPluginBase.php \Drupal\views\Plugin\views\field\FieldPluginBase
The base class for all field plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase extends \Drupal\migrate_drupal\Plugin\MigrateFieldInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of FieldPluginBase
See also
\Drupal\migrate\Plugin\MigratePluginManager
\Drupal\migrate_drupal\Annotation\MigrateField
\Drupal\migrate_drupal\Plugin\MigrateFieldInterface
Related topics
20 files declare their use of FieldPluginBase
- CckFieldPluginBase.php in core/
modules/ migrate_drupal/ src/ Plugin/ migrate/ cckfield/ CckFieldPluginBase.php - D6FileField.php in core/
modules/ migrate_drupal/ tests/ modules/ migrate_field_plugin_manager_test/ src/ Plugin/ migrate/ field/ D6FileField.php - D6NoCoreVersionSpecified.php in core/
modules/ migrate_drupal/ tests/ modules/ migrate_field_plugin_manager_test/ src/ Plugin/ migrate/ field/ D6NoCoreVersionSpecified.php - DateField.php in core/
modules/ datetime/ src/ Plugin/ migrate/ field/ d6/ DateField.php - DateField.php in core/
modules/ datetime/ src/ Plugin/ migrate/ field/ DateField.php
File
-
core/
modules/ migrate_drupal/ src/ Plugin/ migrate/ field/ FieldPluginBase.php, line 20
Namespace
Drupal\migrate_drupal\Plugin\migrate\fieldView source
abstract class FieldPluginBase extends PluginBase implements MigrateFieldInterface {
/**
* Alters the migration for field definitions.
*
* @deprecated in drupal:8.6.0 and is removed from drupal:9.0.0. Use
* alterFieldMigration() instead.
*
* @see https://www.drupal.org/node/2944598
* @see ::alterFieldMigration()
*/
public function processField(MigrationInterface $migration) {
@trigger_error('Deprecated in Drupal 8.6.0, to be removed before Drupal 9.0.0. Use alterFieldMigration() instead. See https://www.drupal.org/node/2944598.', E_USER_DEPRECATED);
$this->alterFieldMigration($migration);
}
/**
* {@inheritdoc}
*/
public function alterFieldMigration(MigrationInterface $migration) {
$process[0]['map'][$this->pluginId][$this->pluginId] = $this->pluginId;
$migration->mergeProcessOfProperty('type', $process);
}
/**
* Alert field instance migration.
*
* @deprecated in drupal:8.6.0 and is removed from drupal:9.0.0. Use
* alterFieldInstanceMigration() instead.
*
* @see https://www.drupal.org/node/2944598
* @see ::alterFieldInstanceMigration()
*/
public function processFieldInstance(MigrationInterface $migration) {
@trigger_error('Deprecated in Drupal 8.6.0, to be removed before Drupal 9.0.0. Use alterFieldInstanceMigration() instead. See https://www.drupal.org/node/2944598.', E_USER_DEPRECATED);
$this->alterFieldInstanceMigration($migration);
}
/**
* {@inheritdoc}
*/
public function alterFieldInstanceMigration(MigrationInterface $migration) {
// Nothing to do by default with field instances.
}
/**
* Alter field widget migration.
*
* @deprecated in drupal:8.6.0 and is removed from drupal:9.0.0. Use
* alterFieldWidgetMigration() instead.
*
* @see https://www.drupal.org/node/2944598
* @see ::alterFieldWidgetMigration()
*/
public function processFieldWidget(MigrationInterface $migration) {
@trigger_error('Deprecated in Drupal 8.6.0, to be removed before Drupal 9.0.0. Use alterFieldWidgetMigration() instead. See https://www.drupal.org/node/2944598.', E_USER_DEPRECATED);
$this->alterFieldWidgetMigration($migration);
}
/**
* {@inheritdoc}
*/
public function alterFieldWidgetMigration(MigrationInterface $migration) {
$process = [];
foreach ($this->getFieldWidgetMap() as $source_widget => $destination_widget) {
$process['type']['map'][$source_widget] = $destination_widget;
}
$migration->mergeProcessOfProperty('options/type', $process);
}
/**
* {@inheritdoc}
*/
public function getFieldFormatterType(Row $row) {
return $row->getSourceProperty('formatter/type');
}
/**
* {@inheritdoc}
*/
public function getFieldFormatterMap() {
return [];
}
/**
* {@inheritdoc}
*/
public function getFieldWidgetType(Row $row) {
return $row->getSourceProperty('widget/type');
}
/**
* {@inheritdoc}
*/
public function getFieldWidgetMap() {
// By default, use the plugin ID for the widget types.
return [
$this->pluginId => $this->pluginId . '_default',
];
}
/**
* Alter field formatter migration.
*
* @deprecated in drupal:8.6.0 and is removed from drupal:9.0.0. Use
* alterFieldFormatterMigration() instead.
*
* @see https://www.drupal.org/node/2944598
* @see ::processFieldFormatter()
*/
public function processFieldFormatter(MigrationInterface $migration) {
@trigger_error('Deprecated in Drupal 8.6.0, to be removed before Drupal 9.0.0. Use alterFieldFormatterMigration() instead. See https://www.drupal.org/node/2944598.', E_USER_DEPRECATED);
$this->alterFieldFormatterMigration($migration);
}
/**
* {@inheritdoc}
*/
public function alterFieldFormatterMigration(MigrationInterface $migration) {
$process = [];
// Some migrate field plugin IDs are prefixed with 'd6_' or 'd7_'. Since the
// plugin ID is used in the static map as the module name, we have to remove
// this prefix from the plugin ID.
$plugin_id = preg_replace('/d[67]_/', '', $this->pluginId);
foreach ($this->getFieldFormatterMap() as $source_format => $destination_format) {
$process[0]['map'][$plugin_id][$source_format] = $destination_format;
}
$migration->mergeProcessOfProperty('options/type', $process);
}
/**
* Defines the process pipeline for field values.
*
* @deprecated in drupal:8.6.0 and is removed from drupal:9.0.0. Use
* defineValueProcessPipeline() instead.
*
* @see https://www.drupal.org/node/2944598
* @see ::defineValueProcessPipeline()
*/
public function processFieldValues(MigrationInterface $migration, $field_name, $data) {
@trigger_error('Deprecated in Drupal 8.6.0, to be removed before Drupal 9.0.0. Use defineValueProcessPipeline() instead. See https://www.drupal.org/node/2944598.', E_USER_DEPRECATED);
return $this->defineValueProcessPipeline($migration, $field_name, $data);
}
/**
* {@inheritdoc}
*/
public function defineValueProcessPipeline(MigrationInterface $migration, $field_name, $data) {
$process = [
'plugin' => 'get',
'source' => $field_name,
];
$migration->mergeProcessOfProperty($field_name, $process);
}
/**
* {@inheritdoc}
*/
public function getFieldType(Row $row) {
$field_type = $row->getSourceProperty('type');
if (isset($this->pluginDefinition['type_map'][$field_type])) {
return $this->pluginDefinition['type_map'][$field_type];
}
else {
return $field_type;
}
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
DependencySerializationTrait::__sleep | public | function | 1 | |||
DependencySerializationTrait::__wakeup | public | function | 2 | |||
FieldPluginBase::alterFieldFormatterMigration | public | function | Apply any custom processing to the field formatter migration. | Overrides MigrateFieldInterface::alterFieldFormatterMigration | ||
FieldPluginBase::alterFieldInstanceMigration | public | function | Apply any custom processing to the field instance migration. | Overrides MigrateFieldInterface::alterFieldInstanceMigration | 2 | |
FieldPluginBase::alterFieldMigration | public | function | Apply any custom processing to the field migration. | Overrides MigrateFieldInterface::alterFieldMigration | ||
FieldPluginBase::alterFieldWidgetMigration | public | function | Apply any custom processing to the field widget migration. | Overrides MigrateFieldInterface::alterFieldWidgetMigration | ||
FieldPluginBase::defineValueProcessPipeline | public | function | Apply any custom processing to the field bundle migrations. | Overrides MigrateFieldInterface::defineValueProcessPipeline | 11 | |
FieldPluginBase::getFieldFormatterMap | public | function | Get a map between D6 formatters and D8 formatters for this field type. | Overrides MigrateFieldInterface::getFieldFormatterMap | 12 | |
FieldPluginBase::getFieldFormatterType | public | function | Get the field formatter type from the source. | Overrides MigrateFieldInterface::getFieldFormatterType | 1 | |
FieldPluginBase::getFieldType | public | function | Computes the destination type of a migrated field. | Overrides MigrateFieldInterface::getFieldType | 6 | |
FieldPluginBase::getFieldWidgetMap | public | function | Get a map between D6 and D8 widgets for this field type. | Overrides MigrateFieldInterface::getFieldWidgetMap | 10 | |
FieldPluginBase::getFieldWidgetType | public | function | Get the field widget type from the source. | Overrides MigrateFieldInterface::getFieldWidgetType | 1 | |
FieldPluginBase::processField | Deprecated | public | function | Alters the migration for field definitions. | ||
FieldPluginBase::processFieldFormatter | Deprecated | public | function | Alter field formatter migration. | ||
FieldPluginBase::processFieldInstance | Deprecated | public | function | Alert field instance migration. | ||
FieldPluginBase::processFieldValues | Deprecated | public | function | Defines the process pipeline for field values. | ||
FieldPluginBase::processFieldWidget | Deprecated | public | function | Alter field widget migration. | ||
MessengerTrait::$messenger | protected | property | The messenger. | 29 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 29 | ||
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 | 3 | |
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. | 78 | ||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 1 | ||
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.