class DateField
Same name in other branches
- 9 core/modules/datetime/src/Plugin/migrate/field/DateField.php \Drupal\datetime\Plugin\migrate\field\DateField
- 8.9.x core/modules/datetime/src/Plugin/migrate/field/DateField.php \Drupal\datetime\Plugin\migrate\field\DateField
- 8.9.x core/modules/datetime/src/Plugin/migrate/field/d6/DateField.php \Drupal\datetime\Plugin\migrate\field\d6\DateField
- 11.x core/modules/datetime/src/Plugin/migrate/field/DateField.php \Drupal\datetime\Plugin\migrate\field\DateField
Provides a field plugin for date and time fields.
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_drupal\Plugin\migrate\field\FieldPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate_drupal\Plugin\MigrateFieldInterface
- class \Drupal\datetime\Plugin\migrate\field\DateField extends \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase
- class \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate_drupal\Plugin\MigrateFieldInterface
- 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 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 | |
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 |
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 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.