class EntityFile
Provides migrate destination plugin for File entities.
Attributes
#[MigrateDestination('entity:file')]
  Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements \Drupal\migrate\Plugin\MigrateDestinationInterface, \Drupal\migrate\Plugin\RequirementsInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\migrate\Plugin\migrate\destination\Entity implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait, \Drupal\migrate\EntityFieldDefinitionTrait extends \Drupal\migrate\Plugin\migrate\destination\DestinationBase
- class \Drupal\migrate\Plugin\migrate\destination\EntityContentBase implements \Drupal\migrate\Audit\HighestIdInterface, \Drupal\migrate\Plugin\MigrateValidatableEntityInterface extends \Drupal\migrate\Plugin\migrate\destination\Entity
- class \Drupal\file\Plugin\migrate\destination\EntityFile extends \Drupal\migrate\Plugin\migrate\destination\EntityContentBase
 
 
 - class \Drupal\migrate\Plugin\migrate\destination\EntityContentBase implements \Drupal\migrate\Audit\HighestIdInterface, \Drupal\migrate\Plugin\MigrateValidatableEntityInterface extends \Drupal\migrate\Plugin\migrate\destination\Entity
 
 - class \Drupal\migrate\Plugin\migrate\destination\Entity implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait, \Drupal\migrate\EntityFieldDefinitionTrait extends \Drupal\migrate\Plugin\migrate\destination\DestinationBase
 
 - class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements \Drupal\migrate\Plugin\MigrateDestinationInterface, \Drupal\migrate\Plugin\RequirementsInterface extends \Drupal\Core\Plugin\PluginBase
 
 - class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
 
Expanded class hierarchy of EntityFile
File
- 
              core/
modules/ file/ src/ Plugin/ migrate/ destination/ EntityFile.php, line 14  
Namespace
Drupal\file\Plugin\migrate\destinationView source
class EntityFile extends EntityContentBase {
  
  /**
   * {@inheritdoc}
   */
  protected function getEntity(Row $row, array $old_destination_id_values) {
    // For stub rows, there is no real file to deal with, let the stubbing
    // process take its default path.
    if ($row->isStub()) {
      return parent::getEntity($row, $old_destination_id_values);
    }
    // By default the entity key (fid) would be used, but we want to make sure
    // we're loading the matching URI.
    $destination = $row->getDestinationProperty('uri');
    if (empty($destination)) {
      throw new MigrateException('Destination property uri not provided');
    }
    $entity = $this->storage
      ->loadByProperties([
      'uri' => $destination,
    ]);
    if ($entity) {
      return reset($entity);
    }
    else {
      return parent::getEntity($row, $old_destination_id_values);
    }
  }
  
  /**
   * {@inheritdoc}
   */
  protected function processStubRow(Row $row) {
    // We stub the uri value ourselves so we can create a real stub file for it.
    if (!$row->getDestinationProperty('uri')) {
      $field_definitions = $this->entityFieldManager
        ->getFieldDefinitions($this->storage
        ->getEntityTypeId(), $this->getKey('bundle'));
      $value = UriItem::generateSampleValue($field_definitions['uri']);
      if (empty($value)) {
        throw new MigrateException('Stubbing failed, unable to generate value for field uri');
      }
      // generateSampleValue() wraps the value in an array.
      $value = reset($value);
      // Make it into a proper public file uri, stripping off the existing
      // scheme if present.
      $value = 'public://' . preg_replace('|^[a-z]+://|i', '', $value);
      $value = mb_substr($value, 0, $field_definitions['uri']->getSetting('max_length'));
      // Create a real file, so File::preSave() can do filesize() on it.
      touch($value);
      $row->setDestinationProperty('uri', $value);
    }
    parent::processStubRow($row);
  }
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
| DependencySerializationTrait::__sleep | public | function | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| DependencyTrait::$dependencies | protected | property | The object's dependencies. | ||
| 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::getDestinationModule | public | function | Gets the destination module handling the destination data. | Overrides MigrateDestinationInterface::getDestinationModule | 1 | 
| 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::$entityFieldManager | protected | property | The entity field manager. | ||
| Entity::$storage | protected | property | The entity storage. | ||
| Entity::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | |
| Entity::fields | public | function | Returns an array of destination fields. | Overrides MigrateDestinationInterface::fields | |
| Entity::getBundle | public | function | Gets the bundle for the row taking into account the default. | ||
| Entity::getEntityId | protected | function | Gets the entity ID of the row. | 2 | |
| Entity::getKey | protected | function | Returns a specific entity key. | ||
| EntityContentBase::$accountSwitcher | protected | property | The account switcher service. | ||
| EntityContentBase::$fieldTypeManager | protected | property | Field type plugin manager. | ||
| EntityContentBase::create | public static | function | Creates an instance of the plugin. | Overrides Entity::create | 2 | 
| EntityContentBase::getHighestId | public | function | Returns the highest ID tracked by the implementing plugin. | Overrides HighestIdInterface::getHighestId | 2 | 
| EntityContentBase::getIds | public | function | Gets the destination IDs. | Overrides MigrateDestinationInterface::getIds | 2 | 
| EntityContentBase::import | public | function | Overrides MigrateDestinationInterface::import | 2 | |
| EntityContentBase::isEntityValidationRequired | public | function | Returns a state of whether an entity needs to be validated before saving. | Overrides MigrateValidatableEntityInterface::isEntityValidationRequired | |
| EntityContentBase::isTranslationDestination | public | function | |||
| EntityContentBase::rollback | public | function | Delete the specified destination object from the target Drupal. | Overrides Entity::rollback | 1 | 
| EntityContentBase::save | protected | function | Saves the entity. | 3 | |
| EntityContentBase::updateEntity | protected | function | Updates an entity with the new values from row. | Overrides Entity::updateEntity | 3 | 
| EntityContentBase::validateEntity | public | function | Validates the entity. | Overrides MigrateValidatableEntityInterface::validateEntity | |
| EntityContentBase::__construct | public | function | Constructs a content entity. | Overrides Entity::__construct | 3 | 
| EntityFieldDefinitionTrait::getDefinitionFromEntity | protected | function | Gets the field definition from a specific entity base field. | ||
| EntityFieldDefinitionTrait::getEntityTypeId | protected static | function | Finds the entity type from configuration or plugin ID. | 3 | |
| EntityFile::getEntity | protected | function | Creates or loads an entity. | Overrides Entity::getEntity | |
| EntityFile::processStubRow | protected | function | Populates as much of the stub row as possible. | Overrides EntityContentBase::processStubRow | |
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | |
| 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 | 2 | 
| PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
| PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
| 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. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.