diff --git a/src/Plugin/migrate/process/SkipOnValue.php b/src/Plugin/migrate/process/SkipOnValue.php index f25b1a47ffb86c923a12c2fce1a673642b31c0e8..ff5a0578c421b0b205ef518f80ebe051da759e3f 100644 --- a/src/Plugin/migrate/process/SkipOnValue.php +++ b/src/Plugin/migrate/process/SkipOnValue.php @@ -15,6 +15,43 @@ use Drupal\migrate\Row; * @MigrateProcessPlugin( * id = "skip_on_value" * ) + * + * Available configuration keys: + * - value: An single value or array of values against which the source value + * should be compared. + * - not_equals: (optional) If set, skipping occurs when values are not equal. + * - method: (optional) What to do if the input value is empty. Possible values: + * - row: Skips the entire row when an empty value is encountered. + * - process: Prevents further processing of the input property when the value + * is empty. + * + * Examples: + * + * Example usage with minimal configuration: + * @code + * type: + * plugin: skip_on_value + * source: content_type + * value: blog + * @endcode + * + * The above example will skip processing the input property if the content_type + * source field equals "blog". + * + * Example usage with full configuration: + * @code + * type: + * plugin: skip_on_value + * not_equals: true + * source: content_type + * method: row + * value: + * - article + * - testimonial + * @endcode + * + * The above example will skip processing any row for which the source row's + * content type field is not "article" or "testimonial". */ class SkipOnValue extends ProcessPluginBase {