class FormatDate

Converts date/datetime from one format to another.

Available configuration keys

• from_format: The source format string as accepted by \DateTime::createFromFormat.
• to_format: The destination format.
• from_timezone: String identifying the required source time zone, see DateTimePlus::__construct().
• to_timezone: String identifying the required destination time zone, see DateTimePlus::__construct().
• settings: keyed array of settings, see DateTimePlus::__construct().

Configuration keys from_timezone and to_timezone are both optional. Possible input variants:

• Both from_timezone and to_timezone are empty. Date will not be converted and be treated as date in default timezone.
• Only from_timezone is set. Date will be converted from timezone specified in from_timezone key to the default timezone.
• Only to_timezone is set. Date will be converted from the default timezone to the timezone specified in to_timezone key.
• Both from_timezone and to_timezone are set. Date will be converted from timezone specified in from_timezone key to the timezone specified in to_timezone key.

Examples:

Example usage for date only fields (DateTimeItemInterface::DATE_STORAGE_FORMAT):

process:
  field_date:
    plugin: format_date
    from_format: 'm/d/Y'
    to_format: 'Y-m-d'
    source: event_date

If the source value was '01/05/1955' the transformed value would be 1955-01-05.

Example usage for datetime fields (DateTimeItemInterface::DATETIME_STORAGE_FORMAT):

process:
  field_time:
    plugin: format_date
    from_format: 'm/d/Y H:i:s'
    to_format: 'Y-m-d\TH:i:s'
    source: event_time

If the source value was '01/05/1955 10:43:22' the transformed value would be 1955-01-05T10:43:22.

Example usage for datetime fields with a timezone and settings:

process:
  field_time:
    plugin: format_date
    from_format: 'Y-m-d\TH:i:sO'
    to_format: 'Y-m-d\TH:i:s'
    from_timezone: 'America/Managua'
    to_timezone: 'UTC'
    settings:
      validate_format: false
    source: event_time

If the source value was '2004-12-19T10:19:42-0600' the transformed value would be 2004-12-19T10:19:42. Set validate_format to false if your source value is '0000-00-00 00:00:00'.

Plugin annotation

@MigrateProcessPlugin(
  id = "format_date"
)

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\migrate\Plugin\migrate\process\FormatDate extends \Drupal\migrate\ProcessPluginBase

Expanded class hierarchy of FormatDate

See also

\DateTime::createFromFormat()

\Drupal\Component\Datetime\DateTimePlus::__construct()

\Drupal\datetime\Plugin\Field\FieldType\DateTimeItemInterface

\Drupal\migrate\Plugin\MigrateProcessInterface

File

core/modules/migrate/src/Plugin/migrate/process/FormatDate.php, line 93

Namespace

class FormatDate extends ProcessPluginBase {
    
    /**
     * {@inheritdoc}
     */
    public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
        if (empty($value) && $value !== '0' && $value !== 0) {
            return '';
        }
        // Validate the configuration.
        if (empty($this->configuration['from_format'])) {
            throw new MigrateException('Format date plugin is missing from_format configuration.');
        }
        if (empty($this->configuration['to_format'])) {
            throw new MigrateException('Format date plugin is missing to_format configuration.');
        }
        $fromFormat = $this->configuration['from_format'];
        $toFormat = $this->configuration['to_format'];
        $system_timezone = date_default_timezone_get();
        $default_timezone = !empty($system_timezone) ? $system_timezone : 'UTC';
        $from_timezone = $this->configuration['from_timezone'] ?? $default_timezone;
        $to_timezone = $this->configuration['to_timezone'] ?? $default_timezone;
        $settings = $this->configuration['settings'] ?? [];
        // Older versions of Drupal where omitting certain granularity values (also
        // known as "collected date attributes") resulted in invalid timestamps
        // getting stored.
        if ($fromFormat === 'Y-m-d\\TH:i:s') {
            $value = str_replace([
                '-00-00T',
                '-00T',
            ], [
                '-01-01T',
                '-01T',
            ], $value);
        }
        // Attempts to transform the supplied date using the defined input format.
        // DateTimePlus::createFromFormat can throw exceptions, so we need to
        // explicitly check for problems.
        try {
            $transformed = DateTimePlus::createFromFormat($fromFormat, $value, $from_timezone, $settings)->format($toFormat, [
                'timezone' => $to_timezone,
            ]);
        } catch (\InvalidArgumentException $e) {
            throw new MigrateException(sprintf("Format date plugin could not transform '%s' using the format '%s'. Error: %s", $value, $fromFormat, $e->getMessage()), $e->getCode(), $e);
        } catch (\UnexpectedValueException $e) {
            throw new MigrateException(sprintf("Format date plugin could not transform '%s' using the format '%s'. Error: %s", $value, $fromFormat, $e->getMessage()), $e->getCode(), $e);
        }
        return $transformed;
    }

}

Members