class SkipRowIfNotSet

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.

Hierarchy

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

Expanded class hierarchy of SkipRowIfNotSet

See also

\Drupal\migrate\Plugin\MigrateProcessInterface

File

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

Namespace

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