class TextField
MigrateField Plugin for Drupal 6 text fields.
Attributes
#[MigrateField(id: 'd6_text', core: [
6,
], type_map: [
'text' => 'text',
'text_long' => 'text_long',
'text_with_summary' => 'text_with_summary',
], source_module: 'text', destination_module: 'text')]
  Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase- class \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase implements \Drupal\migrate_drupal\Plugin\MigrateFieldInterface extends \Drupal\Core\Plugin\PluginBase- class \Drupal\text\Plugin\migrate\field\d6\TextField extends \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase
 
 
- class \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase implements \Drupal\migrate_drupal\Plugin\MigrateFieldInterface extends \Drupal\Core\Plugin\PluginBase
 
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of TextField
1 file declares its use of TextField
- TextFieldTest.php in core/modules/ text/ tests/ src/ Unit/ Plugin/ migrate/ field/ d6/ TextFieldTest.php 
31 string references to 'TextField'
- ContentTranslationHandler::addTranslatabilityClue in core/modules/ content_translation/ src/ ContentTranslationHandler.php 
- Adds a clue about the form element translatability.
- ElementTest::testPlaceHolderText in core/modules/ system/ tests/ src/ Functional/ Form/ ElementTest.php 
- Tests placeholder text for elements that support placeholders.
- EntityDisplayFormBaseTest::testCopyFormValuesToEntity in core/tests/ Drupal/ KernelTests/ Core/ Entity/ EntityDisplayFormBaseTest.php 
- Tests copy form values to entity.
- EntityField::multiple_options_form in core/modules/ views/ src/ Plugin/ views/ field/ EntityField.php 
- Provide options for multiple value fields.
- FieldAttachOtherTest::testEntityFormDisplayBuildForm in core/modules/ field/ tests/ src/ Kernel/ FieldAttachOtherTest.php 
- Tests \Drupal\Core\Entity\Display\EntityFormDisplayInterface::buildForm().
File
- 
              core/modules/ text/ src/ Plugin/ migrate/ field/ d6/ TextField.php, line 14 
Namespace
Drupal\text\Plugin\migrate\field\d6View source
class TextField extends FieldPluginBase {
  
  /**
   * {@inheritdoc}
   */
  public function getFieldWidgetMap() {
    return [
      'text_textfield' => 'text_textfield',
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function getFieldFormatterMap() {
    return [
      'default' => 'text_default',
      'trimmed' => 'text_trimmed',
      'plain' => 'basic_string',
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function defineValueProcessPipeline(MigrationInterface $migration, $field_name, $field_info) {
    $widget_type = $field_info['widget_type'] ?? $field_info['widget']['type'];
    if ($widget_type == 'optionwidgets_onoff') {
      $process = [
        'value' => [
          'plugin' => 'static_map',
          'source' => 'value',
          'default_value' => 0,
        ],
      ];
      $checked_value = explode("\n", $field_info['global_settings']['allowed_values'])[1];
      if (str_contains($checked_value, '|')) {
        $checked_value = substr($checked_value, 0, strpos($checked_value, '|'));
      }
      $process['value']['map'][$checked_value] = 1;
    }
    else {
      // See \Drupal\migrate_drupal\Plugin\migrate\source\d6\User::baseFields(),
      // signature_format for an example of the YAML that represents this
      // process array.
      $process = [
        'value' => 'value',
        'format' => [
          [
            'plugin' => 'static_map',
            'bypass' => TRUE,
            'source' => 'format',
            'map' => [
              0 => NULL,
            ],
          ],
          [
            'plugin' => 'skip_on_empty',
            'method' => 'process',
          ],
          [
            'plugin' => 'migration_lookup',
            'migration' => [
              'd6_filter_format',
              'd7_filter_format',
            ],
            'source' => 'format',
          ],
        ],
      ];
    }
    $process = [
      'plugin' => 'sub_process',
      'source' => $field_name,
      'process' => $process,
    ];
    $migration->setProcessOfProperty($field_name, $process);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getFieldType(Row $row) {
    $widget_type = $row->getSourceProperty('widget_type');
    $settings = $row->getSourceProperty('global_settings');
    if ($widget_type == 'text_textfield') {
      $field_type = $settings['text_processing'] ? 'text' : 'string';
      if (empty($settings['max_length']) || $settings['max_length'] > 255) {
        $field_type .= '_long';
      }
      return $field_type;
    }
    if ($widget_type == 'text_textarea') {
      $field_type = $settings['text_processing'] ? 'text_long' : 'string_long';
      return $field_type;
    }
    switch ($widget_type) {
      case 'optionwidgets_buttons':
      case 'optionwidgets_select':
        return 'list_string';
      case 'optionwidgets_onoff':
        return 'boolean';
      default:
        return parent::getFieldType($row);
    }
  }
}Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. | |||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
| DependencySerializationTrait::__sleep | public | function | 2 | |||
| DependencySerializationTrait::__wakeup | public | function | 2 | |||
| FieldPluginBase::alterFieldFormatterMigration | public | function | Apply any custom processing to the field formatter migration. | Overrides MigrateFieldInterface::alterFieldFormatterMigration | ||
| FieldPluginBase::alterFieldInstanceMigration | public | function | Apply any custom processing to the field instance migration. | Overrides MigrateFieldInterface::alterFieldInstanceMigration | 2 | |
| FieldPluginBase::alterFieldMigration | public | function | Apply any custom processing to the field migration. | Overrides MigrateFieldInterface::alterFieldMigration | ||
| FieldPluginBase::alterFieldWidgetMigration | public | function | Apply any custom processing to the field widget migration. | Overrides MigrateFieldInterface::alterFieldWidgetMigration | ||
| FieldPluginBase::getFieldFormatterType | public | function | Get the field formatter type from the source. | Overrides MigrateFieldInterface::getFieldFormatterType | 1 | |
| FieldPluginBase::getFieldWidgetType | public | function | Get the field widget type from the source. | Overrides MigrateFieldInterface::getFieldWidgetType | 1 | |
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
| PluginBase::$pluginId | protected | property | The plugin ID. | |||
| PluginBase::create | public static | function | Instantiates a new instance of the implementing class using autowiring. | 163 | ||
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
| PluginBase::getBaseId | public | function | Overrides DerivativeInspectionInterface::getBaseId | |||
| PluginBase::getDerivativeId | public | function | Overrides DerivativeInspectionInterface::getDerivativeId | |||
| PluginBase::getPluginDefinition | public | function | Overrides PluginInspectionInterface::getPluginDefinition | 2 | ||
| PluginBase::getPluginId | public | function | Overrides PluginInspectionInterface::getPluginId | |||
| PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
| PluginBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 80 | ||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 | ||
| TextField::defineValueProcessPipeline | public | function | Apply any custom processing to the field bundle migrations. | Overrides FieldPluginBase::defineValueProcessPipeline | ||
| TextField::getFieldFormatterMap | public | function | Get a map between D6 formatters and D8 formatters for this field type. | Overrides FieldPluginBase::getFieldFormatterMap | ||
| TextField::getFieldType | public | function | Computes the destination type of a migrated field. | Overrides FieldPluginBase::getFieldType | ||
| TextField::getFieldWidgetMap | public | function | Get a map between D6 and D8 widgets for this field type. | Overrides FieldPluginBase::getFieldWidgetMap | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
