class FieldSettings
Same name in this branch
- 9 core/modules/field/src/Plugin/migrate/process/d7/FieldSettings.php \Drupal\field\Plugin\migrate\process\d7\FieldSettings
Same name in other branches
- 8.9.x core/modules/field/src/Plugin/migrate/process/d6/FieldSettings.php \Drupal\field\Plugin\migrate\process\d6\FieldSettings
- 8.9.x core/modules/field/src/Plugin/migrate/process/d7/FieldSettings.php \Drupal\field\Plugin\migrate\process\d7\FieldSettings
- 10 core/modules/field/src/Plugin/migrate/process/d6/FieldSettings.php \Drupal\field\Plugin\migrate\process\d6\FieldSettings
- 10 core/modules/field/src/Plugin/migrate/process/d7/FieldSettings.php \Drupal\field\Plugin\migrate\process\d7\FieldSettings
- 11.x core/modules/field/src/Plugin/migrate/process/d6/FieldSettings.php \Drupal\field\Plugin\migrate\process\d6\FieldSettings
- 11.x core/modules/field/src/Plugin/migrate/process/d7/FieldSettings.php \Drupal\field\Plugin\migrate\process\d7\FieldSettings
Get the field settings.
Plugin annotation
@MigrateProcessPlugin(
id = "field_settings"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\migrate\ProcessPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateProcessInterface
- class \Drupal\field\Plugin\migrate\process\d6\FieldSettings extends \Drupal\migrate\ProcessPluginBase
- class \Drupal\migrate\ProcessPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateProcessInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of FieldSettings
1 file declares its use of FieldSettings
- FieldSettingsTest.php in core/
modules/ field/ tests/ src/ Unit/ Plugin/ migrate/ process/ d6/ FieldSettingsTest.php
File
-
core/
modules/ field/ src/ Plugin/ migrate/ process/ d6/ FieldSettings.php, line 16
Namespace
Drupal\field\Plugin\migrate\process\d6View source
class FieldSettings extends ProcessPluginBase {
/**
* {@inheritdoc}
*
* Get the field default/mapped settings.
*/
public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
// To maintain backwards compatibility, ensure that $value contains at least
// three elements.
if (count($value) == 2) {
$value[] = NULL;
}
[
$field_type,
$global_settings,
$original_field_type,
] = $value;
return $this->getSettings($field_type, $global_settings, $original_field_type);
}
/**
* Merge the default D8 and specified D6 settings.
*
* @param string $field_type
* The destination field type.
* @param array $global_settings
* The field settings.
* @param string $original_field_type
* (optional) The original field type before migration.
*
* @return array
* A valid array of settings.
*/
public function getSettings($field_type, $global_settings, $original_field_type = NULL) {
$max_length = $global_settings['max_length'] ?? '';
$max_length = empty($max_length) ? 255 : $max_length;
$allowed_values = [];
if (isset($global_settings['allowed_values'])) {
$list = explode("\n", $global_settings['allowed_values']);
$list = array_map('trim', $list);
$list = array_filter($list, 'strlen');
switch ($field_type) {
case 'list_string':
case 'list_integer':
case 'list_float':
foreach ($list as $value) {
$value = explode("|", $value);
$allowed_values[$value[0]] = $value[1] ?? $value[0];
}
break;
default:
$allowed_values = $list;
}
}
$settings = [
'text' => [
'max_length' => $max_length,
],
'datetime' => [
'datetime_type' => 'datetime',
],
'list_string' => [
'allowed_values' => $allowed_values,
],
'list_integer' => [
'allowed_values' => $allowed_values,
],
'list_float' => [
'allowed_values' => $allowed_values,
],
'boolean' => [
'allowed_values' => $allowed_values,
],
];
if ($original_field_type == 'userreference') {
return [
'target_type' => 'user',
];
}
else {
return $settings[$field_type] ?? [];
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
FieldSettings::getSettings | public | function | Merge the default D8 and specified D6 settings. | ||
FieldSettings::transform | public | function | Get the field default/mapped settings. | 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.