function SkipOnEmpty::row

Same name in other branches
  1. 9 core/modules/migrate/src/Plugin/migrate/process/SkipOnEmpty.php \Drupal\migrate\Plugin\migrate\process\SkipOnEmpty::row()
  2. 8.9.x core/modules/migrate/src/Plugin/migrate/process/SkipOnEmpty.php \Drupal\migrate\Plugin\migrate\process\SkipOnEmpty::row()
  3. 10 core/modules/migrate/src/Plugin/migrate/process/SkipOnEmpty.php \Drupal\migrate\Plugin\migrate\process\SkipOnEmpty::row()

Skips the current row when value is not set.

Parameters

mixed $value: The input value.

\Drupal\migrate\MigrateExecutableInterface $migrate_executable: The migration in which this process is being executed.

\Drupal\migrate\Row $row: The row from the source to process.

string $destination_property: The destination property currently worked on. This is only used together with the $row above.

Return value

mixed The input value, $value, if it is not empty.

Throws

\Drupal\migrate\MigrateSkipRowException Thrown if the source property is not set and the row should be skipped, records with STATUS_IGNORED status in the map.

File

core/modules/migrate/src/Plugin/migrate/process/SkipOnEmpty.php, line 101

Class

SkipOnEmpty
Skips processing the current row when the input value is empty.

Namespace

Drupal\migrate\Plugin\migrate\process

Code

public function row($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if (!$value) {
        $message = !empty($this->configuration['message']) ? $this->configuration['message'] : '';
        throw new MigrateSkipRowException($message);
    }
    return $value;
}

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