Version 1

[yaffs-website] / web / core / modules / migrate / src / Plugin / migrate / process / FormatDate.php

diff --git a/web/core/modules/migrate/src/Plugin/migrate/process/FormatDate.php b/web/core/modules/migrate/src/Plugin/migrate/process/FormatDate.php
new file mode 100644 (file)
index 0000000..b197f17
--- /dev/null
+++ b/web/core/modules/migrate/src/Plugin/migrate/process/FormatDate.php
@@ -0,0 +1,113 @@
+<?php
+
+namespace Drupal\migrate\Plugin\migrate\process;
+
+use Drupal\Component\Datetime\DateTimePlus;
+use Drupal\migrate\MigrateException;
+use Drupal\migrate\MigrateExecutableInterface;
+use Drupal\migrate\ProcessPluginBase;
+use Drupal\migrate\Row;
+
+/**
+ * Converts date/datetime from one format to another.
+ *
+ * Available configuration keys
+ * - from_format: The source format string as accepted by
+ *   @link http://php.net/manual/datetime.createfromformat.php \DateTime::createFromFormat. @endlink
+ * - to_format: The destination format.
+ * - timezone: String identifying the required time zone, see
+ *   DateTimePlus::__construct().
+ * - settings: keyed array of settings, see DateTimePlus::__construct().
+ *
+ * Examples:
+ *
+ * Example usage for date only fields (DATETIME_DATE_STORAGE_FORMAT):
+ * @code
+ * process:
+ *   field_date:
+ *     plugin: format_date
+ *     from_format: 'm/d/Y'
+ *     to_format: 'Y-m-d'
+ *     source: event_date
+ * @endcode
+ *
+ * If the source value was '01/05/1955' the transformed value would be
+ * 1955-01-05.
+ *
+ * Example usage for datetime fields (DATETIME_DATETIME_STORAGE_FORMAT):
+ * @code
+ * 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
+ * @endcode
+ *
+ * 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:
+ * @code
+ * process:
+ *   field_time:
+ *     plugin: format_date
+ *     from_format: 'Y-m-d\TH:i:sO'
+ *     to_format: 'Y-m-d\TH:i:s'
+ *     timezone: 'America/Managua'
+ *     settings:
+ *       validate_format: false
+ *     source: event_time
+ * @endcode
+ *
+ * If the source value was '2004-12-19T10:19:42-0600' the transformed value
+ * would be 2004-12-19T10:19:42.
+ *
+ * @see \DateTime::createFromFormat()
+ * @see \Drupal\Component\Datetime\DateTimePlus::__construct()
+ * @see \Drupal\migrate\Plugin\MigrateProcessInterface
+ *
+ * @MigrateProcessPlugin(
+ *   id = "format_date"
+ * )
+ */
+class FormatDate extends ProcessPluginBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
+    if (empty($value)) {
+      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'];
+    $timezone = isset($this->configuration['timezone']) ? $this->configuration['timezone'] : NULL;
+    $settings = isset($this->configuration['settings']) ? $this->configuration['settings'] : [];
+
+    // 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, $timezone, $settings)->format($toFormat);
+    }
+    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;
+  }
+
+}