You are here

Home » API reference » Fieldable Panels Panes (FPP) 7 » fieldable_panels_pane.migrate.inc

class MigrateDestinationFieldablePanelsPanes in Fieldable Panels Panes (FPP) 7

Destination class implementing migration into fieldable panels panes.

Hierarchy

Expanded class hierarchy of MigrateDestinationFieldablePanelsPanes

File

includes/fieldable_panels_pane.migrate.inc, line 16
Support for fieldable_panels_pane destinations.

View source 
class MigrateDestinationFieldablePanelsPanes extends MigrateDestinationEntity {

  /**
   * {@inheritdoc}
   */
  public static function getKeySchema() {
    return array(
      'fpid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'description' => 'The primary identifier for the entity.',
      ),
    );
  }

  /**
   * Return an options array for fieldable panels pane destinations.
   *
   * @param string $language
   *   Default language for fieldable panels panes created via this destination
   *   class.
   * @param string $text_format
   *   Default text format for fieldable panels panes created via this
   *   destination class.
   */
  public static function options($language, $text_format) {
    return compact('language', 'text_format');
  }

  /**
   * {@inheritdoc}
   */
  public function __construct($bundle, array $options = array()) {
    parent::__construct('fieldable_panels_pane', $bundle, $options);
  }

  /**
   * Returns a list of fields available to be mapped for the FPP type (bundle).
   *
   * @param Migration $migration
   *   Optionally, the migration containing this destination.
   *
   * @return array
   *   Keys: machine names of the fields (to be passed to addFieldMapping)
   *   Values: Human-friendly descriptions of the fields.
   */
  public function fields(Migration $migration = NULL) {
    $fields = array();

    // First the core (fieldable_panels_panes table) properties.
    $fields['fpid'] = t('The primary identifier for the entity.');
    $fields['vid'] = t('The current version in use for this entity.');
    $fields['bundle'] = t('The bundle of the entity.');
    $fields['title'] = t('The title of the entity.');
    $fields['link'] = t('Whether or not this entity title will link to another page.');
    $fields['path'] = t('The path the title should link to.');
    $fields['reusable'] = t('Whether or not this entity will appear in the Add Content dialog.');
    $fields['admin_title'] = t('The title it will appear in the Add Content dialog as.');
    $fields['admin_description'] = t('The description it will appear in the Add Content dialog with.');
    $fields['category'] = t('The category it will appear in the Add Content dialog under.');
    $fields['view_access'] = t('Access rules to describe if the user has view access to this entity.');
    $fields['edit_access'] = t('Access rules to describe if the user has view access to this entity.');
    $fields['created'] = t('The Unix timestamp when the entity was created.');
    $fields['changed'] = t('The Unix timestamp when the entity was most recently saved.');
    $fields['uuid'] = t('The Universally Unique Identifier.');
    $fields['language'] = t('The languages.language of this entity.');

    // Then add in anything provided by handlers.
    $fields += migrate_handler_invoke_all('Entity', 'fields', $this->entityType, $this->bundle, $migration);
    $fields += migrate_handler_invoke_all('FieldablePanelsPanes', 'fields', $this->entityType, $this->bundle, $migration);
    return $fields;
  }

  /**
   * Delete a batch of fieldable panels panes at once.
   *
   * @param array $fpids
   *   Array of fieldable panels pane IDs to be deleted.
   */
  public function bulkRollback(array $fpids) {
    migrate_instrument_start('entity_delete_multiple');
    $this
      ->prepareRollback($fpids);
    entity_delete_multiple('fieldable_panels_pane', $fpids);
    $this
      ->completeRollback($fpids);
    migrate_instrument_stop('entity_delete_multiple');
  }

  /**
   * Import a single fieldable panels pane.
   *
   * @param object $fieldable_panels_pane
   *   Fieldable panels pane object to build. Prefilled with any fields mapped
   *   in the Migration.
   * @param object $row
   *   Raw source data object - passed through to prepare/complete handlers.
   *
   * @return array
   *   Array of key fields (fpid only in this case) of the fieldable panels pane
   *   that was saved if successful. FALSE on failure.
   */
  public function import(stdClass $fieldable_panels_pane, stdClass $row) {

    // Updating previously-migrated content?
    $migration = Migration::currentMigration();
    if (isset($row->migrate_map_destid1)) {

      // Make sure is_new is off.
      $fieldable_panels_pane->is_new = FALSE;
      if (isset($fieldable_panels_pane->fpid)) {
        if ($fieldable_panels_pane->fpid != $row->migrate_map_destid1) {
          throw new MigrateException(t("Incoming fpid !fpid and map destination fpid !destid1 don't match", array(
            '!fpid' => $fieldable_panels_pane->fpid,
            '!destid1' => $row->migrate_map_destid1,
          )));
        }
      }
      else {
        $fieldable_panels_pane->fpid = $row->migrate_map_destid1;
      }

      // Get the existing vid, tnid so updates don't generate notices.
      $values = db_select('fieldable_panels_panes', 'fpp')
        ->fields('fpp', array(
        'vid',
      ))
        ->condition('fpid', $fieldable_panels_pane->fpid)
        ->execute()
        ->fetchAssoc();
      if (empty($values)) {
        throw new MigrateException(t("Incoming fieldable panels pane ID !fpid no longer exists", array(
          '!fpid' => $fieldable_panels_pane->fpid,
        )));
      }
      $fieldable_panels_pane->vid = $values['vid'];
    }
    if ($migration
      ->getSystemOfRecord() == Migration::DESTINATION) {
      if (!isset($fieldable_panels_pane->fpid)) {
        throw new MigrateException(t('System-of-record is DESTINATION, but no destination fpid provided'));
      }
      $old_fieldable_panels_panes = entity_load_single('fieldable_panels_pane', $fieldable_panels_pane->fpid);
      if (empty($old_fieldable_panels_panes)) {
        throw new MigrateException(t('System-of-record is DESTINATION, but fieldable panels pane !fpid does not exist', array(
          '!fpid' => $fieldable_panels_pane->fpid,
        )));
      }
      if (!isset($fieldable_panels_pane->created)) {
        $fieldable_panels_pane->created = $old_fieldable_panels_panes->created;
      }
      if (!isset($fieldable_panels_pane->vid)) {
        $fieldable_panels_pane->vid = $old_fieldable_panels_panes->vid;
      }
    }
    if (!isset($fieldable_panels_pane->bundle)) {

      // Default the type to our designated destination bundle (by doing this
      // conditionally, we permit some flexibility in terms of implementing
      // migrations which can affect more than one type).
      $fieldable_panels_pane->bundle = $this->bundle;
    }

    // Set some required properties.
    if ($migration
      ->getSystemOfRecord() == Migration::SOURCE) {
      if (empty($fieldable_panels_pane->language)) {
        $fieldable_panels_pane->language = $this->language;
      }
      if (empty($fieldable_panels_pane->created)) {
        $fieldable_panels_pane->created = REQUEST_TIME;
      }
      if (empty($fieldable_panels_pane->updated)) {
        $fieldable_panels_pane->updated = $fieldable_panels_pane->created;
      }
    }

    // Invoke migration prepare handlers.
    $this
      ->prepare($fieldable_panels_pane, $row);
    if (!isset($fieldable_panels_pane->revision)) {

      // Saves disk space and writes. Can be overridden.
      $fieldable_panels_pane->revision = 0;
    }

    // Trying to update an existing fieldable panels panes.
    if ($migration
      ->getSystemOfRecord() == Migration::DESTINATION) {

      // Incoming data overrides existing data, so only copy non-existent
      // fields.
      if (!empty($old_fieldable_panels_panes)) {
        foreach ($old_fieldable_panels_panes as $field => $value) {

          // An explicit NULL in the source data means to wipe to old value
          // (i.e. don't copy it over from $old_fieldable_panels_panes).
          if (property_exists($fieldable_panels_pane, $field) && $fieldable_panels_pane->{$field} === NULL) {

            // Ignore this field.
          }
          elseif (!isset($fieldable_panels_pane->{$field})) {
            $fieldable_panels_pane->{$field} = $old_fieldable_panels_panes->{$field};
          }
        }
      }
    }
    if (isset($fieldable_panels_pane->fpid) && !(isset($fieldable_panels_pane->is_new) && $fieldable_panels_pane->is_new)) {
      $updating = TRUE;
    }
    else {
      $updating = FALSE;
    }
    migrate_instrument_start('fieldable_panels_panes_save');
    entity_save('fieldable_panels_pane', $fieldable_panels_pane);
    migrate_instrument_stop('fieldable_panels_panes_save');
    if (isset($fieldable_panels_pane->fpid)) {
      if ($updating) {
        $this->numUpdated++;
      }
      else {
        $this->numCreated++;
      }

      // Unfortunately, http://drupal.org/node/722688 was not accepted, so fix
      // the changed timestamp.
      if (isset($changed)) {
        db_update('fieldable_panels_panes')
          ->fields(array(
          'changed' => $changed,
        ))
          ->condition('fpid', $fieldable_panels_pane->fpid)
          ->execute();
        $fieldable_panels_pane->changed = $changed;
      }

      // Potentially fix timestamp in fieldable_panels_panes_revision.
      $query = db_update('fieldable_panels_panes_revision')
        ->condition('vid', $fieldable_panels_pane->vid);
      if (isset($changed)) {
        $fields['timestamp'] = $changed;
      }
      if (!empty($fields)) {

        // We actually have something to update.
        $query
          ->fields($fields);
        $query
          ->execute();
        if (isset($changed)) {
          $fieldable_panels_pane->timestamp = $changed;
        }
      }
      $return = array(
        $fieldable_panels_pane->fpid,
      );
    }
    else {
      $return = FALSE;
    }
    $this
      ->complete($fieldable_panels_pane, $row);
    return $return;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
MigrateDestination::$numCreated protected property Maintain stats on the number of destination objects created or updated.
MigrateDestination::$numUpdated protected property
MigrateDestination::getCreated public function
MigrateDestination::getUpdated public function
MigrateDestination::resetStats public function Reset numCreated and numUpdated back to 0.
MigrateDestinationEntity::$bundle protected property The bundle (node type, vocabulary, etc.) of the destination.
MigrateDestinationEntity::$entityType protected property The entity type (node, user, taxonomy_term, etc.) of the destination.
MigrateDestinationEntity::$language protected property Default language for text fields in this destination.
MigrateDestinationEntity::$textFormat protected property Default input format for text fields in this destination.
MigrateDestinationEntity::array_flatten public static function Flattens an array of allowed values.
MigrateDestinationEntity::complete public function Give handlers a shot at modifying the object (or taking additional action) after saving it.
MigrateDestinationEntity::completeRollback public function Give handlers a shot at cleaning up after an entity has been rolled back.
MigrateDestinationEntity::fieldAttachValidate public static function Perform field validation against the field data in an entity. Wraps field_attach_validate to handle exceptions cleanly and provide maximum information for identifying the cause of validation errors.
MigrateDestinationEntity::getBundle public function
MigrateDestinationEntity::getEntityType public function
MigrateDestinationEntity::getLanguage public function
MigrateDestinationEntity::getTextFormat public function
MigrateDestinationEntity::prepare public function Give handlers a shot at modifying the object before saving it.
MigrateDestinationEntity::prepareRollback public function Give handlers a shot at cleaning up before an entity has been rolled back.
MigrateDestinationEntity::__toString public function Derived classes must implement __toString(). Overrides MigrateDestination::__toString
MigrateDestinationFieldablePanelsPanes::bulkRollback public function Delete a batch of fieldable panels panes at once.
MigrateDestinationFieldablePanelsPanes::fields public function Returns a list of fields available to be mapped for the FPP type (bundle). Overrides MigrateDestination::fields
MigrateDestinationFieldablePanelsPanes::getKeySchema public static function
MigrateDestinationFieldablePanelsPanes::import public function Import a single fieldable panels pane. Overrides MigrateDestination::import
MigrateDestinationFieldablePanelsPanes::options public static function Return an options array for fieldable panels pane destinations.
MigrateDestinationFieldablePanelsPanes::__construct public function Simply save the key schema. Overrides MigrateDestinationEntity::__construct