class DateField
Provides a field plugin for date and time fields.
Attributes
#[MigrateField(id: 'datetime', core: [
6,
7,
], type_map: [
'date' => 'datetime',
'datestamp' => 'timestamp',
'datetime' => 'datetime',
], source_module: 'date', destination_module: 'datetime')]
  Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface- class \Drupal\Core\Plugin\PluginBase uses \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\datetime\Plugin\migrate\field\DateField 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\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of DateField
1 file declares its use of DateField
- DateFieldTest.php in core/modules/ datetime/ tests/ src/ Unit/ Plugin/ migrate/ field/ DateFieldTest.php 
File
- 
              core/modules/ datetime/ src/ Plugin/ migrate/ field/ DateField.php, line 17 
Namespace
Drupal\datetime\Plugin\migrate\fieldView source
class DateField extends FieldPluginBase {
  
  /**
   * {@inheritdoc}
   */
  public function getFieldFormatterMap() {
    return [
      'date_default' => 'datetime_default',
      'format_interval' => 'datetime_time_ago',
      // The date_plain formatter exists in Drupal 7 but not Drupal 6. It is
      // added here because this plugin is declared for Drupal 6 and Drupal 7.
'date_plain' => 'datetime_plain',
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function getFieldWidgetMap() {
    return [
      'date' => 'datetime_default',
      'datetime' => 'datetime_default',
      'datestamp' => 'datetime_timestamp',
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function defineValueProcessPipeline(MigrationInterface $migration, $field_name, $data) {
    $to_format = DateTimeItemInterface::DATETIME_STORAGE_FORMAT;
    if (isset($data['field_definition']['data'])) {
      $field_data = unserialize($data['field_definition']['data']);
      if (isset($field_data['settings']['granularity'])) {
        $granularity = $field_data['settings']['granularity'];
        $collected_date_attributes = is_numeric(array_keys($granularity)[0]) ? $granularity : array_keys(array_filter($granularity));
        if (empty(array_intersect($collected_date_attributes, [
          'hour',
          'minute',
          'second',
        ]))) {
          $to_format = DateTimeItemInterface::DATE_STORAGE_FORMAT;
        }
      }
    }
    switch ($data['type']) {
      case 'date':
        $from_format = 'Y-m-d\\TH:i:s';
        break;
      case 'datestamp':
        $from_format = 'U';
        $to_format = 'U';
        break;
      case 'datetime':
        $from_format = 'Y-m-d H:i:s';
        break;
      default:
        throw new MigrateException(sprintf('Field %s of type %s is an unknown date field type.', $field_name, var_export($data['type'], TRUE)));
    }
    $process = [
      'value' => [
        'plugin' => 'format_date',
        'from_format' => $from_format,
        'to_format' => $to_format,
        'source' => 'value',
      ],
    ];
    // If the 'todate' setting is specified the field is now a 'daterange' and
    // so set the end value. If the datetime_range module is not enabled on the
    // destination then end_value is ignored and a message is logged in the
    // relevant migrate message table.
    if (!empty($field_data['settings']['todate'])) {
      $process['end_value'] = $process['value'];
      $process['end_value']['source'] = 'value2';
    }
    $process = [
      'plugin' => 'sub_process',
      'source' => $field_name,
      'process' => $process,
    ];
    $migration->mergeProcessOfProperty($field_name, $process);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getFieldType(Row $row) {
    $field_type = parent::getFieldType($row);
    // If the 'todate' setting is specified then change the field type to
    // 'daterange' so we can migrate the end date.
    if ($field_type === 'datetime' && !empty($row->get('settings/todate'))) {
      if (\Drupal::service('module_handler')->moduleExists('datetime_range')) {
        return 'daterange';
      }
      else {
        throw new MigrateException(sprintf("Can't migrate field '%s' with 'todate' settings. Enable the datetime_range module. See https://www.drupal.org/docs/8/upgrade/known-issues-when-upgrading-from-drupal-6-or-7-to-drupal-8#datetime", $row->get('field_name')));
      }
    }
    return $field_type;
  }
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| DateField::defineValueProcessPipeline | public | function | Apply any custom processing to the field bundle migrations. | Overrides FieldPluginBase::defineValueProcessPipeline | |
| DateField::getFieldFormatterMap | public | function | Get a map between D6 formatters and D8 formatters for this field type. | Overrides FieldPluginBase::getFieldFormatterMap | |
| DateField::getFieldType | public | function | Computes the destination type of a migrated field. | Overrides FieldPluginBase::getFieldType | |
| DateField::getFieldWidgetMap | public | function | Get a map between D6 and D8 widgets for this field type. | Overrides FieldPluginBase::getFieldWidgetMap | |
| 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 | #[\ReturnTypeWillChange] | 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::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | |||
| PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | |
| PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | |
| PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 | 
| PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
| PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
| PluginBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 86 | |
| 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. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
