class NullCoalesce in Drupal 10
Same name and namespace in other branches
- 8 core/modules/migrate/src/Plugin/migrate/process/NullCoalesce.php \Drupal\migrate\Plugin\migrate\process\NullCoalesce
- 9 core/modules/migrate/src/Plugin/migrate/process/NullCoalesce.php \Drupal\migrate\Plugin\migrate\process\NullCoalesce
Provides a Null Coalesce process plugin.
Given a set of values provided to the plugin, the plugin will return the first non-null value.
Available configuration keys:
- source: The input array.
- default_value: (optional) The value to return if all values are NULL. if not provided, NULL is returned if all values are NULL.
Example: Given source keys of foo, bar, and baz:
process_key:
plugin: null_coalesce
source:
- foo
- bar
- baz
This plugin will return the equivalent of `foo ?? bar ?? baz`
Plugin annotation
@MigrateProcessPlugin(
id = "null_coalesce"
)
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\NullCoalesce
- class \Drupal\migrate\ProcessPluginBase implements MigrateProcessInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of NullCoalesce
1 file declares its use of NullCoalesce
- NullCoalesceTest.php in core/
modules/ migrate/ tests/ src/ Unit/ process/ NullCoalesceTest.php
File
- core/
modules/ migrate/ src/ Plugin/ migrate/ process/ NullCoalesce.php, line 37
Namespace
Drupal\migrate\Plugin\migrate\processView source
class NullCoalesce extends ProcessPluginBase {
/**
* {@inheritdoc}
*/
public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
if (!is_array($value)) {
throw new MigrateException("The input value should be an array.");
}
foreach ($value as $val) {
if (NULL !== $val) {
return $val;
}
}
if (isset($this->configuration['default_value'])) {
return $this->configuration['default_value'];
}
return NULL;
}
}
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. | 18 |
MessengerTrait:: |
public | function | Gets the messenger. | 18 |
MessengerTrait:: |
public | function | Sets the messenger. | |
NullCoalesce:: |
public | function |
Performs the associated process. Overrides ProcessPluginBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
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 | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | 2 | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 53 |
ProcessPluginBase:: |
public | function |
Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface:: |
3 |
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
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. | 1 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |