class DateMigrateFieldHandler in Date 8

Hierarchy

• class \DateMigrateFieldHandler extends \MigrateFieldHandler

File

date_migrate/date.migrate.inc, line 10

Support for migration into Date fields.

class DateMigrateFieldHandler extends MigrateFieldHandler {

  /**
   * Declares the types of fields used.
   */
  public function __construct() {
    $this
      ->registerTypes(array(
      'date',
    ));
  }

  /**
   * Arguments for a date field migration.
   *
   * @param string $timezone
   *   Timezone (such as UTC, America/New_York, etc.) to apply.
   * @param string $timezone_db
   *   Timezone_db value for the field.
   * @param string $rrule
   *   Rule string for a repeating date field.
   * @param string $language
   *   Language of the text (defaults to destination language)
   *
   * @return array
   *   An array of the defined variables in this scope.
   */
  static function arguments($timezone = 'UTC', $timezone_db = 'UTC', $rrule = NULL, $language = NULL) {
    return get_defined_vars();
  }

  /**
   * Converts incoming data into the proper field arrays for Date fields.
   *
   * @param object $entity
   *   The destination entity which will hold the field arrays.
   * @param array $field_info
   *   Metadata for the date field being populated.
   * @param array $instance
   *   Metadata for this instance of the date field being populated.
   * @param array $values
   *   Array of date values to be fielded.
   *
   * @return array|null
   *   An array of date fields.
   */
  public function prepare($entity, array $field_info, array $instance, array $values) {
    if (isset($values['arguments'])) {
      $arguments = $values['arguments'];
      unset($values['arguments']);
    }
    else {
      $arguments = array();
    }
    if (isset($arguments['timezone'])) {
      $default_timezone = $arguments['timezone'];
    }
    else {
      $default_timezone = 'UTC';
    }
    if (isset($arguments['timezone_db'])) {
      $default_timezone_db = $arguments['timezone_db'];
    }
    else {
      $default_timezone_db = NULL;
    }
    if (isset($arguments['rrule'])) {
      $default_rrule = $arguments['rrule'];
    }
    else {
      $default_rrule = NULL;
    }
    $language = $this
      ->getFieldLanguage($entity, $field_info, $arguments);

    // Setup the standard Field API array for saving.
    $delta = 0;
    foreach ($values as $from) {

      // Set defaults.
      $to = NULL;
      $timezone = $default_timezone;
      $timezone_db = $default_timezone_db;
      $rrule = $default_rrule;

      // Is the value a straight datetime value, or JSON containing a set of
      // properties?
      if (!empty($from) && $from[0] == '{') {
        $properties = drupal_json_decode($from);
        $from = $properties['from'];

        // Properties passed in with the date override any set via arguments.
        if (!empty($properties['to'])) {
          $to = $properties['to'];
        }
        if (!empty($properties['timezone'])) {
          $timezone = $properties['timezone'];
        }
        if (!empty($properties['timezone_db'])) {
          $timezone_db = $properties['timezone_db'];
        }
        if (!empty($properties['rrule'])) {
          $rrule = $properties['rrule'];
        }
      }

      // Missing data? Create an empty value and return;
      // Don't try to turn the empty value into a bogus
      // timestamp for 'now'.
      if (empty($from)) {
        $return[$language][$delta]['value'] = NULL;
        if (!empty($field_info['settings']['todate'])) {
          $return[$language][$delta]['value2'] = NULL;
        }
        return $return;
      }

      // If there is no 'to' date, just use the 'from' date.
      if (!empty($field_info['settings']['todate']) && empty($to)) {
        $to = $from;
      }

      // If we have a value, work from a timestamp.
      $from = MigrationBase::timestamp($from);
      if ($to) {
        $to = MigrationBase::timestamp($to);
      }

      // What does the destination field expect?
      switch ($field_info['type']) {
        case 'date':

          // ISO date: YYYY-MM-DDTHH:MM:SS.
          $from = format_date($from, 'custom', 'Y-m-d\\TH:i:s', $timezone);
          if ($to) {
            $to = format_date($to, 'custom', 'Y-m-d\\TH:i:s', $timezone);
          }
          break;
        default:
          break;
      }

      // Handle repeats, coming in as RRULEs. Many field instances may be
      // created.
      if (function_exists('date_repeat_build_dates') && !empty($field_info['settings']['repeat']) && $rrule) {
        $item = array(
          'value' => $from,
          'value2' => $to,
          'timezone' => $timezone,
        );

        // Can be de-uglified when http://drupal.org/node/1159404 is committed.
        $return[$language] = date_repeat_build_dates(NULL, DateiCalParse::parse_rrule($rrule, $field_info), $field_info, $item);
      }
      else {
        $return[$language][$delta]['value'] = $from;
        if (!empty($to)) {
          $return[$language][$delta]['value2'] = $to;
        }
      }
      $delta++;
    }
    if (!isset($return)) {
      $return = NULL;
    }
    return $return;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DateMigrateFieldHandler::arguments	static	function	Arguments for a date field migration.
DateMigrateFieldHandler::prepare	public	function	Converts incoming data into the proper field arrays for Date fields.
DateMigrateFieldHandler::__construct	public	function	Declares the types of fields used.