class SkipRowIfNotSet in Drupal 10

Skips processing the current row when a source value is not set.

The skip_row_if_not_set process plugin checks whether a value is set. If the value is set, it is returned. Otherwise, a MigrateSkipRowException is thrown.

Available configuration keys:

• index: The source property to check for.
• message: (optional) A message to be logged in the {migrate_message_*} table for this row. If not set, nothing is logged in the message table.

Example:

 process:
   settings:
     # Check if the "contact" key exists in the "data" array.
     plugin: skip_row_if_not_set
     index: contact
     source: data
     message: "Missed the 'data' key"

This will return $data['contact'] if it exists. Otherwise, the row will be skipped and the message "Missed the 'data' key" will be logged in the message table.

Plugin annotation

@MigrateProcessPlugin(
  id = "skip_row_if_not_set",
  handle_multiples = TRUE
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate\ProcessPluginBase implements MigrateProcessInterface
      • class \Drupal\migrate\Plugin\migrate\process\SkipRowIfNotSet

See also

\Drupal\migrate\Plugin\MigrateProcessInterface

1 file declares its use of SkipRowIfNotSet

SkipRowIfNotSetTest.php in core/modules/migrate/tests/src/Unit/process/SkipRowIfNotSetTest.php

File

core/modules/migrate/src/Plugin/migrate/process/SkipRowIfNotSet.php, line 45

Namespace

Drupal\migrate\Plugin\migrate\process

class SkipRowIfNotSet extends ProcessPluginBase {

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if (!isset($value[$this->configuration['index']])) {
      $message = !empty($this->configuration['message']) ? $this->configuration['message'] : '';
      throw new MigrateSkipRowException($message);
    }
    return $value[$this->configuration['index']];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	18
MessengerTrait::messenger	public	function	Gets the messenger.	18
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.
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
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		2
PluginBase::getPluginId	public	function
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	53
ProcessPluginBase::multiple	public	function	Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple	3
SkipRowIfNotSet::transform	public	function	Performs the associated process. Overrides ProcessPluginBase::transform
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	3
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.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.