class Flatten in Drupal 10
Same name and namespace in other branches
- 8 core/modules/migrate/src/Plugin/migrate/process/Flatten.php \Drupal\migrate\Plugin\migrate\process\Flatten
- 9 core/modules/migrate/src/Plugin/migrate/process/Flatten.php \Drupal\migrate\Plugin\migrate\process\Flatten
Flattens the source value.
The flatten process plugin converts a nested array into a flat array. For example [[1, 2, [3, 4]], [5], 6] becomes [1, 2, 3, 4, 5, 6]. During some types of processing (e.g. user permission splitting), what was once a one-dimensional array gets transformed into a multidimensional array. This plugin will flatten them back down to one-dimensional arrays again.
Example:
process:
tags:
-
plugin: default_value
source: foo
default_value: [bar, [alpha, beta]]
-
plugin: flatten
In this example, the default_value process returns [bar, [alpha, beta]] (given a NULL value of foo). At this point, Migrate would try to import two items: bar and [alpha, beta]. The latter is not a valid one and won't be imported. We need to pass the values through the flatten processor to obtain a three items array [bar, alpha, beta], suitable for import.
Plugin annotation
@MigrateProcessPlugin(
id = "flatten",
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\Flatten
- class \Drupal\migrate\ProcessPluginBase implements MigrateProcessInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Flatten
See also
\Drupal\migrate\Plugin\MigrateProcessInterface
1 file declares its use of Flatten
- FlattenTest.php in core/
modules/ migrate/ tests/ src/ Unit/ process/ FlattenTest.php
File
- core/
modules/ migrate/ src/ Plugin/ migrate/ process/ Flatten.php, line 45
Namespace
Drupal\migrate\Plugin\migrate\processView source
class Flatten extends ProcessPluginBase {
/**
* Flatten nested array values to single array values.
*
* For example, [[1, 2, [3, 4]]] becomes [1, 2, 3, 4].
*/
public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
if (!is_array($value) && !is_object($value)) {
$type = gettype($value);
throw new MigrateException(sprintf("Input should be an array or an object, instead it was of type '%s'", $type));
}
return iterator_to_array(new \RecursiveIteratorIterator(new \RecursiveArrayIterator($value)), FALSE);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
Flatten:: |
public | function |
Flatten nested array values to single array values. Overrides ProcessPluginBase:: |
|
MessengerTrait:: |
protected | property | The messenger. | 18 |
MessengerTrait:: |
public | function | Gets the messenger. | 18 |
MessengerTrait:: |
public | function | Sets the messenger. | |
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. |