abstract class CRMCoreDataDestinationHandler in CRM Core 7

@file Default destination handler for CRM Core Data Import

Hierarchy

• class \CRMCoreDataDestinationHandler

File

modules/crm_core_data_import/plugins/destination/CRMCoreDataDestinationHandler.inc, line 7

Default destination handler for CRM Core Data Import

abstract class CRMCoreDataDestinationHandler {

  /**
   * Type of entity.
   * @var string
   */
  public $entityType;
  public $bundle;

  /**
   * Returns MigrationDestination instance.
   *
   * @param setings $entity_bundle
   *   Entity bundle.
   *
   * @return MigrationDestination
   *   MigrationDestination for migration.
   */
  public abstract function migrateDestination($entity_bundle);

  /**
   * Returns key schema for migration.
   *
   * @return array
   *   Key schema for migration.
   */
  public abstract function migrateDestinationMap();

  /**
   * Returns available bundles and their labels.
   */
  public function getBundles() {
    return $this
      ->getEntityBundles();
  }

  /**
   * Build array of available bundles.
   *
   * @return array
   *   Available bundles.
   */
  public function getEntityBundles() {
    $bundles_result = array();
    $bundles = field_info_bundles($this->entityType);
    foreach ($bundles as $key => $bundle) {
      $bundles_result[$key] = $bundle['label'];
    }
    return $bundles_result;
  }

  /**
   * Build array of available fields.
   *
   * There you can define additional fields.
   */
  public function getFields($bundle) {
    $fields_result = array();
    $fields = migrate_handler_invoke_all('Entity', 'fields', $this->entityType, $bundle);
    foreach ($fields as $field_key => $field) {
      $fields_result[$field_key] = $field_key;
    }
    return $fields_result + $this
      ->attachFieldCollectionFields($bundle);
  }

  /**
   * Attach field collection fields to destination fields.
   */
  public function attachFieldCollectionFields($bundle) {
    $fields = array();
    $fields_info = field_info_instances($this->entityType, $bundle);
    foreach ($fields_info as $field_info) {
      if (!empty($field_info['widget']['module']) && $field_info['widget']['module'] == 'field_collection') {
        $field_collection_fields = migrate_handler_invoke_all('Entity', 'fields', 'field_collection_item', $field_info['field_name']);
        foreach ($field_collection_fields as $field_collection_field_key => $field_collection_field) {
          $label = $field_info['field_name'] . ':' . $field_collection_field_key;
          $fields[$label] = $label;
        }
      }
    }
    return $fields;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CRMCoreDataDestinationHandler::$bundle	public	property
CRMCoreDataDestinationHandler::$entityType	public	property	Type of entity.
CRMCoreDataDestinationHandler::attachFieldCollectionFields	public	function	Attach field collection fields to destination fields.
CRMCoreDataDestinationHandler::getBundles	public	function	Returns available bundles and their labels.
CRMCoreDataDestinationHandler::getEntityBundles	public	function	Build array of available bundles.
CRMCoreDataDestinationHandler::getFields	public	function	Build array of available fields.	4
CRMCoreDataDestinationHandler::migrateDestination	abstract public	function	Returns MigrationDestination instance.	4
CRMCoreDataDestinationHandler::migrateDestinationMap	abstract public	function	Returns key schema for migration.	4