EntityConfigBase.php in Zircon Profile 8

Contains \Drupal\migrate\Plugin\migrate\destination\EntityConfigBase.

Namespace

Drupal\migrate\Plugin\migrate\destination

File

core/modules/migrate/src/Plugin/migrate/destination/EntityConfigBase.php

<?php

/**
 * @file
 * Contains \Drupal\migrate\Plugin\migrate\destination\EntityConfigBase.
 */
namespace Drupal\migrate\Plugin\migrate\destination;

use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Entity\EntityInterface;
use Drupal\migrate\MigrateException;
use Drupal\migrate\Plugin\MigrateIdMapInterface;
use Drupal\migrate\Row;

/**
 * Class for importing configuration entities.
 *
 * This class serves as the import class for most configuration entities.
 * It can be necessary to provide a specific entity class if the configuration
 * entity has a compound id (see EntityFieldEntity) or it has specific setter
 * methods (see EntityDateFormat). When implementing an entity destination for
 * the latter case, make sure to add a test not only for importing but also
 * for re-importing (if that is supported).
 */
class EntityConfigBase extends Entity {

  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = array()) {
    if ($row
      ->isStub()) {
      throw new MigrateException('Config entities can not be stubbed.');
    }
    $this->rollbackAction = MigrateIdMapInterface::ROLLBACK_DELETE;
    $ids = $this
      ->getIds();
    $id_key = $this
      ->getKey('id');
    if (count($ids) > 1) {

      // Ids is keyed by the key name so grab the keys.
      $id_keys = array_keys($ids);
      if (!$row
        ->getDestinationProperty($id_key)) {

        // Set the id into the destination in for form "val1.val2.val3".
        $row
          ->setDestinationProperty($id_key, $this
          ->generateId($row, $id_keys));
      }
    }
    $entity = $this
      ->getEntity($row, $old_destination_id_values);
    $entity
      ->save();
    if (count($ids) > 1) {

      // This can only be a config entity, content entities have their id key
      // and that's it.
      $return = array();
      foreach ($id_keys as $id_key) {
        $return[] = $entity
          ->get($id_key);
      }
      return $return;
    }
    return array(
      $entity
        ->id(),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $id_key = $this
      ->getKey('id');
    $ids[$id_key]['type'] = 'string';
    return $ids;
  }

  /**
   * Updates an entity with the contents of a row.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to update.
   * @param \Drupal\migrate\Row $row
   *   The row object to update from.
   */
  protected function updateEntity(EntityInterface $entity, Row $row) {
    foreach ($row
      ->getRawDestination() as $property => $value) {
      $this
        ->updateEntityProperty($entity, explode(Row::PROPERTY_SEPARATOR, $property), $value);
    }
    $this
      ->setRollbackAction($row
      ->getIdMap());
  }

  /**
   * Updates a (possible nested) entity property with a value.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The config entity.
   * @param array $parents
   *   The array of parents.
   * @param string|object $value
   *   The value to update to.
   */
  protected function updateEntityProperty(EntityInterface $entity, array $parents, $value) {
    $top_key = array_shift($parents);
    $entity_value = $entity
      ->get($top_key);
    if (is_array($entity_value)) {
      NestedArray::setValue($entity_value, $parents, $value);
    }
    else {
      $entity_value = $value;
    }
    $entity
      ->set($top_key, $entity_value);
  }

  /**
   * Generate an entity id.
   *
   * @param \Drupal\migrate\Row $row
   *   The current row.
   * @param array $ids
   *   The destination ids.
   *
   * @return string
   *   The generated entity id.
   */
  protected function generateId(Row $row, array $ids) {
    $id_values = array();
    foreach ($ids as $id) {
      $id_values[] = $row
        ->getDestinationProperty($id);
    }
    return implode('.', $id_values);
  }

}

Classes

Name	Description
EntityConfigBase	Class for importing configuration entities.