class TestSkipRowProcess

Same name 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. 10 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.

Plugin annotation


@MigrateProcessPlugin(
  id = "test_skip_row_process"
)

Hierarchy

Expanded class hierarchy of TestSkipRowProcess

File

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

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::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
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.