diff --git a/src/Plugin/migrate/process/SkipOnValue.php b/src/Plugin/migrate/process/SkipOnValue.php index bd79c7cfdcd2e3aaa0871eaa1f517dc810d8cb77..74ee63f747cbce0b849be35a99b73a1d5fbb047f 100644 --- a/src/Plugin/migrate/process/SkipOnValue.php +++ b/src/Plugin/migrate/process/SkipOnValue.php @@ -70,7 +70,24 @@ class SkipOnValue extends ProcessPluginBase { } /** - * {@inheritdoc} + * Skips the current row when input value evaluates to a configured value. + * + * @param mixed $value + * The input value. + * @param \Drupal\migrate\MigrateExecutableInterface $migrate_executable + * The migration in which this process is being executed. + * @param \Drupal\migrate\Row $row + * The row from the source to process. + * @param string $destination_property + * The destination property currently worked on. This is only used together + * with the $row above. + * + * @return mixed + * The input value, $value, if it doesn't evaluate to a configured value. + * + * @throws \Drupal\migrate\MigrateSkipRowException + * Thrown if the source property evaluates to a configured value and the + * row should be skipped, records with STATUS_IGNORED status in the map. */ public function row($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) { if (is_array($this->configuration['value'])) { @@ -93,7 +110,25 @@ class SkipOnValue extends ProcessPluginBase { } /** - * {@inheritdoc} + * Stops processing the current property when input value evaluates to a + * configured value. + * + * @param mixed $value + * The input value. + * @param \Drupal\migrate\MigrateExecutableInterface $migrate_executable + * The migration in which this process is being executed. + * @param \Drupal\migrate\Row $row + * The row from the source to process. + * @param string $destination_property + * The destination property currently worked on. This is only used together + * with the $row above. + * + * @return mixed + * The input value, $value, if it doesn't evaluate to a configured value. + * + * @throws \Drupal\migrate\MigrateSkipProcessException + * Thrown if the source property evaluates to a configured value and rest + * of the process should be skipped. */ public function process($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) { if (is_array($this->configuration['value'])) {