ProcessField
class ProcessField extends ProcessPluginBase implements ContainerFactoryPluginInterface (View source)
Get the value from a method call on a field plugin instance.
This process plugin will instantiate a field plugin based on the given field type and then call the given method on it for the return value.
Available configuration keys:
- source: The source field type to use to instantiate a field plugin.
- method: The method to be called on the field plugin instance.
If no field plugin for the given field type is found, NULL will be returned.
Example:
Traits
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Provides a trait for the messenger service.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
| protected MigrateFieldPluginManagerInterface | $fieldPluginManager | The field plugin manager. |
|
| protected MigrationInterface | $migration | The migration being run. |
Methods
Constructs a ProcessField plugin.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Performs the associated process.
Indicates whether the returned value requires multiple handling.
Creates an instance of the plugin.
Instantiate a field plugin and call a method on it.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition, MigrateFieldPluginManagerInterface $field_plugin_manager, MigrationInterface $migration = NULL)
Constructs a ProcessField plugin.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
bool
isConfigurable()
Determines if the plugin is configurable.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
string|array
transform(mixed $value, MigrateExecutableInterface $migrate_executable, Row $row, string $destination_property)
Performs the associated process.
bool
multiple()
Indicates whether the returned value requires multiple handling.
static ContainerFactoryPluginInterface
create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition, MigrationInterface $migration = NULL)
Creates an instance of the plugin.
protected mixed
callMethodOnFieldPlugin(MigrateFieldPluginManagerInterface $field_plugin_manager, string $field_type, string $method, Row $row)
Instantiate a field plugin and call a method on it.