class EntityFieldStorageConfig in Zircon Profile 8

Destination with Drupal specific config dependencies.

Plugin annotation

@MigrateDestination(
  id = "md_entity:field_storage_config"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements MigrateDestinationInterface, RequirementsInterface
      • class \Drupal\migrate\Plugin\migrate\destination\Entity implements DependentPluginInterface, ContainerFactoryPluginInterface uses DependencyTrait
        • class \Drupal\migrate\Plugin\migrate\destination\EntityConfigBase
          • class \Drupal\migrate\Plugin\migrate\destination\EntityFieldStorageConfig
            • class \Drupal\migrate_drupal\Plugin\migrate\destination\EntityFieldStorageConfig

File

core/modules/migrate_drupal/src/Plugin/migrate/destination/EntityFieldStorageConfig.php, line 23

Contains \Drupal\migrate_drupal\Plugin\migrate\destination\EntityFieldStorageConfig.

Namespace

Drupal\migrate_drupal\Plugin\migrate\destination

class EntityFieldStorageConfig extends BaseEntityFieldStorageConfig {

  /**
   * The field type plugin manager.
   *
   * @var \Drupal\Core\Field\FieldTypePluginManagerInterface
   */
  protected $fieldTypePluginManager;

  /**
   * Construct a new plugin.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param MigrationInterface $migration
   *   The migration.
   * @param EntityStorageInterface $storage
   *   The storage for this entity type.
   * @param array $bundles
   *   The list of bundles this entity type has.
   * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_plugin_manager
   *   The field type plugin manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EntityStorageInterface $storage, array $bundles, FieldTypePluginManagerInterface $field_type_plugin_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $storage, $bundles);
    $this->fieldTypePluginManager = $field_type_plugin_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
    $entity_type_id = static::getEntityTypeId($plugin_id);
    return new static($configuration, $plugin_id, $plugin_definition, $migration, $container
      ->get('entity.manager')
      ->getStorage($entity_type_id), array_keys($container
      ->get('entity.manager')
      ->getBundleInfo($entity_type_id)), $container
      ->get('plugin.manager.field.field_type'));
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $this->dependencies = parent::calculateDependencies();

    // Add a dependency on the module that provides the field type using the
    // source plugin configuration.
    $source_configuration = $this->migration
      ->get('source');
    if (isset($source_configuration['constants']['type'])) {
      $field_type = $this->fieldTypePluginManager
        ->getDefinition($source_configuration['constants']['type']);
      $this
        ->addDependency('module', $field_type['provider']);
    }
    return $this->dependencies;
  }

  /**
   * {@inheritdoc}
   */
  protected static function getEntityTypeId($plugin_id) {
    return 'field_storage_config';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.	1
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
DestinationBase::$migration	protected	property	The migration.
DestinationBase::$rollbackAction	protected	property	The rollback action to be saved for the last imported item.
DestinationBase::$supportsRollback	protected	property	Indicates whether the destination can be rolled back.
DestinationBase::checkRequirements	public	function	Checks if requirements for this plugin are OK. Overrides RequirementsInterface::checkRequirements
DestinationBase::rollbackAction	public	function	The rollback action for the last imported item. Overrides MigrateDestinationInterface::rollbackAction
DestinationBase::setRollbackAction	protected	function	For a destination item being updated, set the appropriate rollback action.
DestinationBase::supportsRollback	public	function	Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface::supportsRollback
Entity::$bundles	protected	property	The list of the bundles of this entity type.
Entity::$storage	protected	property	The entity storage.	1
Entity::fields	public	function	Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
Entity::getEntity	protected	function	Creates or loads an entity.	5
Entity::getEntityId	protected	function	Get the entity id of the row.	2
Entity::getKey	protected	function	Returns a specific entity key.
Entity::rollback	public	function	Delete the specified destination object from the target Drupal. Overrides DestinationBase::rollback
EntityConfigBase::generateId	protected	function	Generate an entity id.
EntityConfigBase::import	public	function	Import the row. Overrides MigrateDestinationInterface::import	3
EntityConfigBase::updateEntity	protected	function	Updates an entity with the contents of a row.	1
EntityConfigBase::updateEntityProperty	protected	function	Updates a (possible nested) entity property with a value.	1
EntityFieldStorageConfig::$fieldTypePluginManager	protected	property	The field type plugin manager.
EntityFieldStorageConfig::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides Entity::calculateDependencies
EntityFieldStorageConfig::create	public static	function	Creates an instance of the plugin. Overrides Entity::create
EntityFieldStorageConfig::getEntityTypeId	protected static	function	Finds the entity type from configuration or plugin id. Overrides Entity::getEntityTypeId
EntityFieldStorageConfig::getIds	public	function	Get the destination ids. Overrides EntityConfigBase::getIds
EntityFieldStorageConfig::__construct	public	function	Construct a new plugin. Overrides Entity::__construct
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.