class BiblioMigrateDestinationFieldCollection in Bibliography Module 7.3

Destination class implementing migration into field_collection.

Hierarchy

• class \MigrateDestination
  • class \MigrateDestinationEntity
    • class \BiblioMigrateDestinationFieldCollection

File

includes/migrate/plugins/destinations/biblio_field_collection.inc, line 9

class BiblioMigrateDestinationFieldCollection extends MigrateDestinationEntity {

  /**
   * The type of entity hosting this collection field (e.g., node).
   *
   * @var string
   */
  protected $hostEntityType;
  public static function getKeySchema() {
    return array(
      'cid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'ID of field collection item',
      ),
    );
  }

  /**
   * Basic initialization.
   *
   * @param array $options
   *  Options applied to collections.
   */
  public function __construct($bundle, array $options = array()) {
    parent::__construct('field_collection_item', $bundle, $options);
    $this->hostEntityType = $options['host_entity_type'];
  }

  /**
   * Returns a list of fields available to be mapped for this collection (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 = migrate_handler_invoke_all('Entity', 'fields', $this->entityType, $this->bundle);
    $fields['host_entity_id'] = t('Field collection host ID');
    return $fields;
  }

  /**
   * Import a single term.
   *
   * @param $collection
   *  Collection object to build. Pre-filled 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 (item_id only in this case) of the collection that was saved if
   *  successful. FALSE on failure.
   */
  public function import(stdClass $collection, stdClass $row) {
    $entity = entity_create('field_collection_item', array(
      'field_name' => $this->bundle,
    ));
    $updating = FALSE;

    // The host entity cannot be reset - we only set it on initial insert
    $host_entity = entity_load_single($this->hostEntityType, $collection->host_entity_id);
    $entity
      ->setHostEntity($this->hostEntityType, $host_entity);
    unset($collection->host_entity_id);
    foreach ((array) $collection as $field => $value) {
      $entity->{$field} = $value;
    }
    $this
      ->prepare($entity, $row);
    migrate_instrument_start('field_collection_save');
    $status = $entity
      ->save();
    migrate_instrument_stop('field_collection_save');

    // TODO: status doesn't return correct value, so just check the
    // entity was created.
    if ($entity->item_id) {
      $this
        ->complete($entity, $row);
      if ($updating) {
        $this->numUpdated++;
      }
      else {
        $this->numCreated++;
      }
      return array(
        $entity->item_id,
      );
    }
    else {
      return FALSE;
    }
  }

  /**
   * Delete a migrated collection.
   *
   * @param $key
   *  Array of fields representing the key.
   */
  public function rollback(array $key) {
    $item_id = reset($key);
    $this
      ->prepareRollback($item_id);
    $field_collection_item = field_collection_item_load($item_id);

    // If the collection wasn't imported we can't roll it back so check if the
    // loaded object matches the fieldcollection item class.
    if ($field_collection_item instanceof FieldCollectionItemEntity) {
      $field_collection_item
        ->delete();
    }
    $this
      ->completeRollback($item_id);
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BiblioMigrateDestinationFieldCollection::$hostEntityType	protected	property	The type of entity hosting this collection field (e.g., node).
BiblioMigrateDestinationFieldCollection::fields	public	function	Returns a list of fields available to be mapped for this collection (bundle). Overrides MigrateDestination::fields
BiblioMigrateDestinationFieldCollection::getKeySchema	public static	function
BiblioMigrateDestinationFieldCollection::import	public	function	Import a single term. Overrides MigrateDestination::import
BiblioMigrateDestinationFieldCollection::rollback	public	function	Delete a migrated collection.
BiblioMigrateDestinationFieldCollection::__construct	public	function	Basic initialization. Overrides MigrateDestinationEntity::__construct
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