class FieldInstanceSettings

Same name in other branches

9 core/modules/field/src/Plugin/migrate/process/d6/FieldInstanceSettings.php \Drupal\field\Plugin\migrate\process\d6\FieldInstanceSettings
9 core/modules/field/src/Plugin/migrate/process/d7/FieldInstanceSettings.php \Drupal\field\Plugin\migrate\process\d7\FieldInstanceSettings
8.9.x core/modules/field/src/Plugin/migrate/process/d6/FieldInstanceSettings.php \Drupal\field\Plugin\migrate\process\d6\FieldInstanceSettings
8.9.x core/modules/field/src/Plugin/migrate/process/d7/FieldInstanceSettings.php \Drupal\field\Plugin\migrate\process\d7\FieldInstanceSettings
11.x core/modules/field/src/Plugin/migrate/process/d6/FieldInstanceSettings.php \Drupal\field\Plugin\migrate\process\d6\FieldInstanceSettings
11.x core/modules/field/src/Plugin/migrate/process/d7/FieldInstanceSettings.php \Drupal\field\Plugin\migrate\process\d7\FieldInstanceSettings

Determines the field instance settings.

Attributes

#[MigrateProcess('d6_field_field_settings')]
#[MigrateProcess(id: "d7_field_instance_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\d7\FieldInstanceSettings extends \Drupal\migrate\ProcessPluginBase

Expanded class hierarchy of FieldInstanceSettings

1 file declares its use of FieldInstanceSettings

FieldInstanceSettingsTest.php in core/modules/field/tests/src/Unit/Plugin/migrate/process/d7/FieldInstanceSettingsTest.php

File

core/modules/field/src/Plugin/migrate/process/d7/FieldInstanceSettings.php, line 15

Namespace

Drupal\field\Plugin\migrate\process\d7

View source

class FieldInstanceSettings extends ProcessPluginBase {
    
    /**
     * {@inheritdoc}
     */
    public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
        [
            $instance_settings,
            $widget_settings,
            $field_definition,
        ] = $value;
        $widget_type = $widget_settings['type'];
        $field_data = unserialize($field_definition['data']);
        // Get taxonomy term reference handler settings from allowed values.
        if ($row->getSourceProperty('type') == 'taxonomy_term_reference') {
            $instance_settings['handler_settings']['sort'] = [
                'field' => '_none',
            ];
            $allowed_values = $row->get('@allowed_values');
            foreach ($allowed_values as $allowed_value) {
                foreach ($allowed_value as $vocabulary) {
                    $instance_settings['handler_settings']['target_bundles'][$vocabulary] = $vocabulary;
                }
            }
        }
        // Get entityreference handler settings from source field configuration.
        if ($row->getSourceProperty('type') == "entityreference") {
            $field_settings = $field_data['settings'];
            $instance_settings['handler'] = 'default:' . $field_settings['target_type'];
            // Transform the sort settings to D8 structure.
            $sort = [
                'field' => '_none',
                'direction' => 'ASC',
            ];
            if (!empty(array_filter($field_settings['handler_settings']['sort']))) {
                if ($field_settings['handler_settings']['sort']['type'] == "property") {
                    $sort = [
                        'field' => $field_settings['handler_settings']['sort']['property'],
                        'direction' => $field_settings['handler_settings']['sort']['direction'],
                    ];
                }
                elseif ($field_settings['handler_settings']['sort']['type'] == "field") {
                    $sort = [
                        'field' => $field_settings['handler_settings']['sort']['field'],
                        'direction' => $field_settings['handler_settings']['sort']['direction'],
                    ];
                }
            }
            if (empty($field_settings['handler_settings']['target_bundles'])) {
                $field_settings['handler_settings']['target_bundles'] = NULL;
            }
            $field_settings['handler_settings']['sort'] = $sort;
            $instance_settings['handler_settings'] = $field_settings['handler_settings'];
        }
        if ($row->getSourceProperty('type') == 'node_reference') {
            $instance_settings['handler'] = 'default:node';
            $instance_settings['handler_settings'] = [
                'sort' => [
                    'field' => '_none',
                    'direction' => 'ASC',
                ],
                'target_bundles' => array_filter($field_data['settings']['referenceable_types'] ?? []),
            ];
        }
        if ($row->getSourceProperty('type') == 'user_reference') {
            $instance_settings['handler'] = 'default:user';
            $instance_settings['handler_settings'] = [
                'include_anonymous' => TRUE,
                'filter' => [
                    'type' => '_none',
                ],
                'sort' => [
                    'field' => '_none',
                    'direction' => 'ASC',
                ],
                'auto_create' => FALSE,
            ];
            if ($row->hasSourceProperty('roles')) {
                $instance_settings['handler_settings']['filter']['type'] = 'role';
                foreach ($row->get('roles') as $role) {
                    $instance_settings['handler_settings']['filter']['role'] = [
                        $role['name'] => $role['name'],
                    ];
                }
            }
        }
        // Get the labels for the list_boolean type.
        if ($row->getSourceProperty('type') === 'list_boolean') {
            if (isset($field_data['settings']['allowed_values'][1])) {
                $instance_settings['on_label'] = $field_data['settings']['allowed_values'][1];
            }
            if (isset($field_data['settings']['allowed_values'][0])) {
                $instance_settings['off_label'] = $field_data['settings']['allowed_values'][0];
            }
        }
        switch ($widget_type) {
            case 'image_image':
            case 'image_miw':
                $settings = $instance_settings;
                $settings['default_image'] = [
                    'alt' => '',
                    'title' => '',
                    'width' => NULL,
                    'height' => NULL,
                    'uuid' => '',
                ];
                break;
            default:
                $settings = $instance_settings;
        }
        return $settings;
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
FieldInstanceSettings::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::$stopPipeline	protected	property	Determines if processing of the pipeline is stopped.
ProcessPluginBase::isPipelineStopped	public	function	Determines if the pipeline should stop processing.	Overrides MigrateProcessInterface::isPipelineStopped
ProcessPluginBase::multiple	public	function	Indicates whether the returned value requires multiple handling.	Overrides MigrateProcessInterface::multiple	3
ProcessPluginBase::reset	public	function	Resets the internal data of a plugin.	Overrides MigrateProcessInterface::reset
ProcessPluginBase::stopPipeline	protected	function	Stops pipeline processing after this plugin finishes.

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

Breadcrumb