class SkipRowIfNotSet in Drupal 9
Same name and namespace in other branches
- 8 core/modules/migrate/src/Plugin/migrate/process/SkipRowIfNotSet.php \Drupal\migrate\Plugin\migrate\process\SkipRowIfNotSet
Skips processing the current row when a source value is not set.
The skip_row_if_not_set process plugin checks whether a value is set. If the value is set, it is returned. Otherwise, a MigrateSkipRowException is thrown.
Available configuration keys:
- index: The source property to check for.
- message: (optional) A message to be logged in the {migrate_message_*} table for this row. If not set, nothing is logged in the message table.
Example:
process:
settings:
# Check if the "contact" key exists in the "data" array.
plugin: skip_row_if_not_set
index: contact
source: data
message: "Missed the 'data' key"
This will return $data['contact'] if it exists. Otherwise, the row will be skipped and the message "Missed the 'data' key" will be logged in the message table.
Plugin annotation
@MigrateProcessPlugin(
id = "skip_row_if_not_set",
handle_multiples = TRUE
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\migrate\ProcessPluginBase implements MigrateProcessInterface
- class \Drupal\migrate\Plugin\migrate\process\SkipRowIfNotSet
- class \Drupal\migrate\ProcessPluginBase implements MigrateProcessInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of SkipRowIfNotSet
See also
\Drupal\migrate\Plugin\MigrateProcessInterface
1 file declares its use of SkipRowIfNotSet
- SkipRowIfNotSetTest.php in core/
modules/ migrate/ tests/ src/ Unit/ process/ SkipRowIfNotSetTest.php
File
- core/
modules/ migrate/ src/ Plugin/ migrate/ process/ SkipRowIfNotSet.php, line 45
Namespace
Drupal\migrate\Plugin\migrate\processView source
class SkipRowIfNotSet extends ProcessPluginBase {
/**
* {@inheritdoc}
*/
public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
if (!isset($value[$this->configuration['index']])) {
$message = !empty($this->configuration['message']) ? $this->configuration['message'] : '';
throw new MigrateSkipRowException($message);
}
return $value[$this->configuration['index']];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 98 |
ProcessPluginBase:: |
public | function |
Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface:: |
3 |
SkipRowIfNotSet:: |
public | function |
Performs the associated process. Overrides ProcessPluginBase:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |