summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Pott2018-06-11 17:30:09 (GMT)
committerAlex Pott2018-06-11 17:30:09 (GMT)
commit15946fea4304af6ddeac8319b12d62c54f103e19 (patch)
treea884525c1dde1f4fb6fcd06072b6c747ed04d5b2
parentc02384042a322edb6fcedf9c2bdbb979c361708d (diff)
Issue #2936821 by msankhala, joachim, lomasr, marxjohnson: unclear docs in MigrateProcessInterface
-rw-r--r--core/modules/migrate/src/Plugin/MigrateProcessInterface.php15
1 files changed, 10 insertions, 5 deletions
diff --git a/core/modules/migrate/src/Plugin/MigrateProcessInterface.php b/core/modules/migrate/src/Plugin/MigrateProcessInterface.php
index 8677e66..8fef305 100644
--- a/core/modules/migrate/src/Plugin/MigrateProcessInterface.php
+++ b/core/modules/migrate/src/Plugin/MigrateProcessInterface.php
@@ -9,11 +9,16 @@ use Drupal\migrate\Row;
/**
* An interface for migrate process plugins.
*
- * A process plugin can use any number of methods instead of (but not in
- * addition to) transform with the same arguments and then the plugin
- * configuration needs to provide the name of the method to be called via the
- * "method" key. See \Drupal\migrate\Plugin\migrate\process\SkipOnEmpty and
- * migrate.migration.d6_field_instance_widget_settings.yml for examples.
+ * A process plugin will typically implement the transform() method to perform
+ * its work. However, it is possible instead for a process plugin to use any
+ * number of methods, thus offering different alternatives ways of processing.
+ * In this case, the transform() method should not be implemented, and the
+ * plugin configuration must provide the name of the method to be called via the
+ * "method" key. Each method must have the same signature as transform().
+ * The base class \Drupal\migrate\ProcessPluginBase takes care of implementing
+ * transform() and calling the configured method. See
+ * \Drupal\migrate\Plugin\migrate\process\SkipOnEmpty and
+ * d6_field_instance_widget_settings.yml for examples.
*
* @see \Drupal\migrate\Plugin\MigratePluginManager
* @see \Drupal\migrate\ProcessPluginBase