class DateField
Provides a field plugin for date and time fields.
Plugin annotation
@MigrateField(
id = "datetime",
type_map = {
"date" = "datetime",
"datestamp" = "timestamp",
"datetime" = "datetime",
},
core = {6,7},
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
2 files declare their use of DateField
- DateFieldLegacyTest.php in core/
modules/ datetime/ tests/ src/ Unit/ Plugin/ migrate/ field/ DateFieldLegacyTest.php - 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 25
Namespace
Drupal\datetime\Plugin\migrate\fieldView source
class DateField extends FieldPluginBase {
/**
* {@inheritdoc}
*/
public function getFieldFormatterMap() {
return [
'date_default' => 'datetime_default',
];
}
/**
* {@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',
],
];
$process = [
'plugin' => 'sub_process',
'source' => $field_name,
'process' => $process,
];
$migration->mergeProcessOfProperty($field_name, $process);
}
}
Members
Title Sort descending | Deprecated | 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::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 | 1 | |||
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::getFieldType | public | function | Computes the destination type of a migrated field. | Overrides MigrateFieldInterface::getFieldType | 6 | |
FieldPluginBase::getFieldWidgetType | public | function | Get the field widget type from the source. | Overrides MigrateFieldInterface::getFieldWidgetType | 1 | |
FieldPluginBase::processField | Deprecated | public | function | Alters the migration for field definitions. | ||
FieldPluginBase::processFieldFormatter | Deprecated | public | function | Alter field formatter migration. | ||
FieldPluginBase::processFieldInstance | Deprecated | public | function | Alert field instance migration. | ||
FieldPluginBase::processFieldValues | Deprecated | public | function | Defines the process pipeline for field values. | ||
FieldPluginBase::processFieldWidget | Deprecated | public | function | Alter field widget migration. | ||
MessengerTrait::$messenger | protected | property | The messenger. | 29 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 29 | ||
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 | 3 | |
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. | 78 | ||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 1 | ||
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.