1. 8.5.x core/modules/migrate_drupal/src/Plugin/migrate/source/d7/FieldableEntity.php FieldableEntity
  2. 8.0.x core/modules/migrate_drupal/src/Plugin/migrate/source/d7/FieldableEntity.php FieldableEntity
  3. 8.1.x core/modules/migrate_drupal/src/Plugin/migrate/source/d7/FieldableEntity.php FieldableEntity
  4. 8.2.x core/modules/migrate_drupal/src/Plugin/migrate/source/d7/FieldableEntity.php FieldableEntity
  5. 8.3.x core/modules/migrate_drupal/src/Plugin/migrate/source/d7/FieldableEntity.php FieldableEntity
  6. 8.4.x core/modules/migrate_drupal/src/Plugin/migrate/source/d7/FieldableEntity.php FieldableEntity
  7. 8.6.x core/modules/migrate_drupal/src/Plugin/migrate/source/d7/FieldableEntity.php FieldableEntity

Base class for D7 source plugins which need to collect field values from the Field API.


Expanded class hierarchy of FieldableEntity

3 files declare their use of FieldableEntity
Comment.php in core/modules/comment/src/Plugin/migrate/source/d7/Comment.php
Contains \Drupal\comment\Plugin\migrate\source\d7\Comment.
Node.php in core/modules/node/src/Plugin/migrate/source/d7/Node.php
Contains \Drupal\node\Plugin\migrate\source\d7\Node.
User.php in core/modules/user/src/Plugin/migrate/source/d7/User.php
Contains \Drupal\user\Plugin\migrate\source\d7\User.


core/modules/migrate_drupal/src/Plugin/migrate/source/d7/FieldableEntity.php, line 16
Contains \Drupal\migrate_drupal\Plugin\migrate\source\d7\FieldableEntity.


View source
abstract class FieldableEntity extends DrupalSqlBase {

   * Returns all non-deleted field instances attached to a specific entity type.
   * @param string $entity_type
   *   The entity type ID.
   * @param string|NULL $bundle
   *   (optional) The bundle.
   * @return array[]
   *   The field instances, keyed by field name.
  protected function getFields($entity_type, $bundle = NULL) {
    return $this
      ->select('field_config_instance', 'fci')
      ->condition('entity_type', $entity_type)
      ->condition('bundle', isset($bundle) ? $bundle : $entity_type)
      ->condition('deleted', 0)

   * Retrieves field values for a single field of a single entity.
   * @param string $entity_type
   *   The entity type.
   * @param string $field
   *   The field name.
   * @param int $entity_id
   *   The entity ID.
   * @param int|null $revision_id
   *   (optional) The entity revision ID.
   * @return array
   *   The raw field values, keyed by delta.
   * @todo Support multilingual field values.
  protected function getFieldValues($entity_type, $field, $entity_id, $revision_id = NULL) {
    $table = (isset($revision_id) ? 'field_revision_' : 'field_data_') . $field;
    $query = $this
      ->select($table, 't')
      ->condition('entity_type', $entity_type)
      ->condition('entity_id', $entity_id)
      ->condition('deleted', 0);
    if (isset($revision_id)) {
        ->condition('revision_id', $revision_id);
    $values = [];
    foreach ($query
      ->execute() as $row) {
      foreach ($row as $key => $value) {
        $delta = $row['delta'];
        if (strpos($key, $field) === 0) {
          $column = substr($key, strlen($field) + 1);
          $values[$delta][$column] = $value;
    return $values;



Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function
DependencySerializationTrait::__wakeup public function
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
DrupalSqlBase::$entityManager protected property The entity manager.
DrupalSqlBase::$requirements protected property If the source provider is missing.
DrupalSqlBase::$systemData protected property The contents of the system table.
DrupalSqlBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
DrupalSqlBase::checkRequirements public function Checks if requirements for this plugin are OK. Overrides RequirementsInterface::checkRequirements
DrupalSqlBase::create public static function Creates an instance of the plugin. Overrides SqlBase::create
DrupalSqlBase::getModuleSchemaVersion protected function Get a module schema_version value in the source installation.
DrupalSqlBase::getSystemData public function Retrieves all system data information from origin system.
DrupalSqlBase::moduleExists protected function Check to see if a given module is enabled in the source installation.
DrupalSqlBase::variableGet protected function Read a variable from a Drupal database.
DrupalSqlBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct
FieldableEntity::getFields protected function Returns all non-deleted field instances attached to a specific entity type.
FieldableEntity::getFieldValues protected function Retrieves field values for a single field of a single entity.
MigrateSourceInterface::fields public function Returns available fields on the source.
MigrateSourceInterface::getIds public function Defines the source fields uniquely identifying a source row.
PluginBase::$configuration protected property Configuration information passed into the plugin.
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
SourcePluginBase::$cache protected property The backend cache.
SourcePluginBase::$cacheCounts protected property Whether this instance should cache the source count.
SourcePluginBase::$cacheKey protected property Key to use for caching counts.
SourcePluginBase::$currentRow protected property The current row from the query.
SourcePluginBase::$currentSourceIds protected property The primary key of the current row.
SourcePluginBase::$highWaterProperty protected property The name and type of the highwater property in the source.
SourcePluginBase::$idMap protected property The migration ID map.
SourcePluginBase::$iterator protected property The iterator to iterate over the source rows.
SourcePluginBase::$mapRowAdded protected property Flags whether source plugin will read the map row and add to data row.
SourcePluginBase::$migration protected property The entity migration object.
SourcePluginBase::$moduleHandler protected property The module handler service.
SourcePluginBase::$originalHighWater protected property The high water mark at the beginning of the import operation.
SourcePluginBase::$skipCount protected property Whether this instance should not attempt to count the source.
SourcePluginBase::$trackChanges protected property Flags whether to track changes to incoming data.
SourcePluginBase::aboveHighwater protected function Checks if the incoming data is newer than what we've previously imported.
SourcePluginBase::current public function
SourcePluginBase::getCache protected function Gets the cache object.
SourcePluginBase::getCurrentIds public function Gets the currentSourceIds data member.
SourcePluginBase::getIterator protected function Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::getModuleHandler protected function Gets the module handler.
SourcePluginBase::key public function Gets the iterator key.
SourcePluginBase::next public function The migration iterates over rows returned by the source plugin. This method determines the next row which will be processed and imported into the system.
SourcePluginBase::prepareRow public function Adds additional data to the row. Overrides MigrateSourceInterface::prepareRow
SourcePluginBase::rewind public function Rewinds the iterator.
SourcePluginBase::rowChanged protected function Checks if the incoming row has changed since our last import.
SourcePluginBase::valid public function Checks whether the iterator is currently valid.
SqlBase::$database protected property The database object.
SqlBase::$query protected property The query string.
SqlBase::$state protected property State service for retrieving database info.
SqlBase::count public function Gets the source count. Overrides SourcePluginBase::count
SqlBase::getDatabase public function Gets the database connection object.
SqlBase::initializeIterator protected function Implementation of MigrateSource::performRewind(). Overrides SourcePluginBase::initializeIterator
SqlBase::mapJoinable protected function Checks if we can join against the map table.
SqlBase::prepareQuery protected function Adds tags and metadata to the query.
SqlBase::query abstract public function
SqlBase::select protected function Wrapper for database select.
SqlBase::setUpDatabase protected function Gets a connection to the referenced database.
SqlBase::__toString public function Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString
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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.