You are here

Home » API reference » Migrate Extras 7.2 » profile2.inc

class MigrateDestinationProfile2 in Migrate Extras 7.2

Destination class implementing migration into nodes.

Hierarchy

Expanded class hierarchy of MigrateDestinationProfile2

File

./profile2.inc, line 14
Support for profile2 destinations.

View source 
class MigrateDestinationProfile2 extends MigrateDestinationEntity {
  var $entity_type = 'profile2';
  var $entity_info = NULL;
  var $entity_key = NULL;
  public static function getKeySchema() {
    $key = 'pid';

    // Hard coded since $this->entity_key not in object context.
    return array(
      $key => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
    );
  }

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

  /**
   * Basic initialization
   *
   * @param string $bundle
   *  A.k.a. the profile type.
   * @param array $options
   *  Options applied to profiles.
   */
  public function __construct($bundle, array $options = array()) {
    parent::__construct($this->entity_type, $bundle, $options);
    $this->entity_info = entity_get_info('profile2');
    $this->entity_key = $this->entity_info['entity keys']['id'];
  }

  /**
   * Returns a list of fields available to be mapped for the node type (bundle)
   *
   * @return array
   *  Keys: machine names of the fields (to be passed to addFieldMapping)
   *  Values: Human-friendly descriptions of the fields.
   */
  public function fields() {
    $fields = array();
    $type = ucfirst($this->entity_type) . ': ';

    // First the core (node table) properties
    $fields[$this->entity_key] = $type . t('Existing profile ID');
    $fields['uid'] = $type . t('Authored by (uid)');
    $fields['revision_uid'] = $type . t('Modified (uid)');

    //$fields['created'] = $type . t('Created timestamp');

    //$fields['changed'] = $type . t('Modified timestamp');

    //$fields['status'] = $type . t('Published');

    //$fields['revision'] = $type . t('Create new revision');
    $fields['language'] = $type . t('Language (fr, en, ...)');

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

  /**
   * Delete a batch of profiles at once.
   *
   * @param $ids
   *  Array of profile IDs to be deleted.
   */
  public function bulkRollback(array $ids) {
    migrate_instrument_start('profile2_delete_multiple');
    $this
      ->prepareRollback($ids);
    entity_delete_multiple($this->entity_type, $ids);
    $this
      ->completeRollback($ids);
    migrate_instrument_stop('profile2_delete_multiple');
  }

  /**
   * Import a single entity.
   *
   * @param $entity
   *  Entity object to build. Prefilled with any fields mapped in the Migration.
   * @param $row
   *  Raw source data object - passed through to prepare/complete handlers.
   * @return array
   *  Array of key fields of the entity that was saved if
   *  successful. FALSE on failure.
   */
  public function import(stdClass $entity, stdClass $row) {
    $migration = Migration::currentMigration();
    $type = $this->entity_info['entity keys']['bundle'];
    $entity->{$type} = $this->bundle;
    list($id, $vid, $bundle) = entity_extract_ids($this->entity_type, $entity);

    // Updating previously-migrated content?
    if (isset($row->migrate_map_destid1)) {

      // Make sure is_new is off
      $entity->is_new = FALSE;
      if (!empty($id)) {
        if ($id != $row->migrate_map_destid1) {
          throw new MigrateException(t("Incoming id !id and map destination id !destid1 don't match", array(
            '!id' => $id,
            '!destid1' => $row->migrate_map_destid1,
          )));
        }
      }
      else {
        $entity->{$this->entity_key} = $row->migrate_map_destid1;
      }
    }
    if ($migration
      ->getSystemOfRecord() == Migration::DESTINATION) {
      if (empty($id)) {
        throw new MigrateException(t('System-of-record is DESTINATION, but no destination id provided'));
      }
      $old_entity = entity_load_single($this->entity_type, $id);
      if (!isset($entity->created)) {
        $entity->created = $old_entity->created;
      }
      if (!isset($entity->uid)) {
        $entity->uid = $old_entity->uid;
      }
    }

    // Invoke migration prepare handlers
    $this
      ->prepare($entity, $row);

    // Trying to update an existing entity
    if ($migration
      ->getSystemOfRecord() == Migration::DESTINATION) {

      // Incoming data overrides existing data.
      foreach ($entity as $field => $value) {
        $old_entity->{$field} = $value;
      }

      // Use the loaded entity from now on.
      $entity = $old_entity;
    }
    else {

      // Create a full profile class.
      $entity = entity_create($this->entity_type, (array) $entity);
    }
    if (empty($id) && !(isset($entity->is_new) && $entity->is_new)) {
      $updating = TRUE;
    }
    else {
      $updating = FALSE;
    }
    migrate_instrument_start('entity_save');
    entity_save($this->entity_type, $entity);
    migrate_instrument_stop('entity_save');
    list($id, $vid, $bundle) = entity_extract_ids($this->entity_type, $entity);
    if (isset($id)) {
      if ($updating) {
        $this->numUpdated++;
      }
      else {
        $this->numCreated++;
      }
      $return = array(
        $id,
      );
    }
    else {
      $return = FALSE;
    }
    $this
      ->complete($entity, $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
MigrateDestinationProfile2::$entity_info property
MigrateDestinationProfile2::$entity_key property
MigrateDestinationProfile2::$entity_type property
MigrateDestinationProfile2::bulkRollback public function Delete a batch of profiles at once.
MigrateDestinationProfile2::fields public function Returns a list of fields available to be mapped for the node type (bundle) Overrides MigrateDestination::fields
MigrateDestinationProfile2::getKeySchema public static function
MigrateDestinationProfile2::import public function Import a single entity. Overrides MigrateDestination::import
MigrateDestinationProfile2::options public static function Return an options array for profile2 destinations.
MigrateDestinationProfile2::__construct public function Basic initialization Overrides MigrateDestinationEntity::__construct