class NullCoalesce

Same name in other branches
  1. 8.9.x core/modules/migrate/src/Plugin/migrate/process/NullCoalesce.php \Drupal\migrate\Plugin\migrate\process\NullCoalesce
  2. 10 core/modules/migrate/src/Plugin/migrate/process/NullCoalesce.php \Drupal\migrate\Plugin\migrate\process\NullCoalesce
  3. 11.x 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

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\process
View 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

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
NullCoalesce::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3

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