class Get

Gets the source value.

Available configuration keys:

• source: Source property.

The get plugin returns the value of the property given by the "source" configuration key.

Examples:

process:
  bar:
    plugin: get
    source: foo

This copies the source value of foo to the destination property "bar".

Since get is the default process plugin, it can be shorthanded like this:

process:
bar:
foo;

Get also supports a list of source properties.

Example:

process:
  bar:
    plugin: get
    source:
      - foo1
      - foo2

This copies the array of source values [foo1, foo2] to the destination property "bar".

If the list of source properties contains an empty element then the current value will be used. This makes it impossible to reach a source property with an empty string as its name.

Get also supports copying destination values. These are indicated by a starting @ sign. Values using @ must be wrapped in quotes.

process:
  foo:
    plugin: machine_name
    source: baz
  bar:
    plugin: get
    source: '@foo'

This will simply copy the destination value of foo to the destination property bar. foo configuration is included for illustration purposes.

Because of this, if the source or destination property actually starts with a "@", that character must be escaped with "@@". The referenced property becomes, for example, "@@@foo".

process:
  '@foo':
    plugin: machine_name
    source: baz
  bar:
    plugin: get
    source: '@@@foo'

This should occur extremely rarely.

Plugin annotation

@MigrateProcessPlugin(
  id = "get"
)

Hierarchy

Expanded class hierarchy of Get

See also

\Drupal\migrate\Plugin\MigrateProcessInterface

File

core/modules/migrate/src/Plugin/migrate/process/Get.php, line 94

Namespace

class Get extends ProcessPluginBase {

  /**
   * Flag indicating whether there are multiple values.
   *
   * @var bool
   */
  protected $multiple;

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    $source = $this->configuration['source'];
    $properties = is_string($source) ? [
      $source,
    ] : $source;
    $return = [];
    foreach ($properties as $property) {
      if ($property || (string) $property === '0') {
        $return[] = $row
          ->get($property);
      }
      else {
        $return[] = $value;
      }
    }
    if (is_string($source)) {
      $this->multiple = is_array($return[0]);
      return $return[0];
    }
    return $return;
  }

  /**
   * {@inheritdoc}
   */
  public function multiple() {
    return $this->multiple;
  }

}

Members

Name contains

Name does not contain

Type

Name	Modifiers	Type	Description	Overrides
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	97
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
MessengerTrait::setMessenger	public	function	Sets the messenger.
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::$messenger	protected	property	The messenger.	29
Get::transform	public	function	Performs the associated process. Overrides ProcessPluginBase::transform
Get::multiple	public	function	Indicates whether the returned value requires multiple handling. Overrides ProcessPluginBase::multiple
Get::$multiple	protected	property	Flag indicating whether there are multiple values.
DependencySerializationTrait::__wakeup	public	function		2
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.