class TestSkipRowProcess

Same name and namespace in other branches
  1. 9 core/modules/migrate/tests/modules/migrate_prepare_row_test/src/Plugin/migrate/process/TestSkipRowProcess.php \Drupal\migrate_prepare_row_test\Plugin\migrate\process\TestSkipRowProcess
  2. 8.9.x core/modules/migrate/tests/modules/migrate_prepare_row_test/src/Plugin/migrate/process/TestSkipRowProcess.php \Drupal\migrate_prepare_row_test\Plugin\migrate\process\TestSkipRowProcess
  3. 11.x core/modules/migrate/tests/modules/migrate_prepare_row_test/src/Plugin/migrate/process/TestSkipRowProcess.php \Drupal\migrate_prepare_row_test\Plugin\migrate\process\TestSkipRowProcess

Provides a testing process plugin that skips rows.

Hierarchy

Expanded class hierarchy of TestSkipRowProcess

File

core/modules/migrate/tests/modules/migrate_prepare_row_test/src/Plugin/migrate/process/TestSkipRowProcess.php, line 14

Namespace

Drupal\migrate_prepare_row_test\Plugin\migrate\process
View source
class TestSkipRowProcess extends ProcessPluginBase {
  
  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    // Test both options for save_to_map.
    $data = $row->getSourceProperty('data');
    if ($data == 'skip_and_record (use plugin)') {
      throw new MigrateSkipRowException('', TRUE);
    }
    elseif ($data == 'skip_and_do_not_record (use plugin)') {
      throw new MigrateSkipRowException('', FALSE);
    }
    return $value;
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
ProcessPluginBase::$stopPipeline protected property Determines if processing of the pipeline is stopped.
ProcessPluginBase::isPipelineStopped public function Determines if the pipeline should stop processing. Overrides MigrateProcessInterface::isPipelineStopped
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
ProcessPluginBase::reset public function Resets the internal data of a plugin. Overrides MigrateProcessInterface::reset
ProcessPluginBase::stopPipeline protected function Stops pipeline processing after this plugin finishes.
TestSkipRowProcess::transform public function Performs the associated process. Overrides ProcessPluginBase::transform

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.