You are here

class Field in Commerce Migrate 3.0.x

Same name in this branch
  1. 3.0.x modules/ubercart/src/Plugin/migrate/source/uc7/Field.php \Drupal\commerce_migrate_ubercart\Plugin\migrate\source\uc7\Field
  2. 3.0.x modules/commerce/src/Plugin/migrate/source/commerce1/Field.php \Drupal\commerce_migrate_commerce\Plugin\migrate\source\commerce1\Field
Same name and namespace in other branches
  1. 8.2 modules/ubercart/src/Plugin/migrate/source/uc7/Field.php \Drupal\commerce_migrate_ubercart\Plugin\migrate\source\uc7\Field
  2. 3.1.x modules/ubercart/src/Plugin/migrate/source/uc7/Field.php \Drupal\commerce_migrate_ubercart\Plugin\migrate\source\uc7\Field

Ubercart 7 field source from database.

Add an initializeIterator() method so that rows can be added when a field exists on a product node and any other entity. The added rows are solely to create such a field on a Commerce 2 commerce_product entity.

Plugin annotation


@MigrateSource(
  id = "uc7_field",
  source_module = "field_sql_storage"
)

Hierarchy

Expanded class hierarchy of Field

1 file declares its use of Field
commerce_migrate_ubercart.module in modules/ubercart/commerce_migrate_ubercart.module
Contains commerce_migrate_ubercart.module.

File

modules/ubercart/src/Plugin/migrate/source/uc7/Field.php, line 19

Namespace

Drupal\commerce_migrate_ubercart\Plugin\migrate\source\uc7
View source
class Field extends D7Field {
  use ProductTypeTrait;

  /**
   * {@inheritdoc}
   */
  public function initializeIterator() {
    $this->productTypes = $this
      ->getProductTypes();
    $results = $this
      ->prepareQuery()
      ->execute();
    $rows = [];
    foreach ($results as $result) {

      // Get all the instances of this field.
      $field_name = $result['field_name'];

      // Get all the instances of this field.
      $query = $this
        ->select('field_config_instance', 'fci')
        ->fields('fci', [
        'bundle',
      ])
        ->condition('fc.active', 1)
        ->condition('fc.storage_active', 1)
        ->condition('fc.deleted', 0)
        ->condition('fci.deleted', 0)
        ->condition('fci.entity_type', 'node');
      $query
        ->join('field_config', 'fc', 'fci.field_id = fc.id');
      $query
        ->condition('fci.field_name', $field_name);
      $node_bundles = $query
        ->execute()
        ->fetchCol();

      // Determine if the field is on both a product type and node, or just one
      // of product type or node.
      $product_node_count = 0;
      foreach ($node_bundles as $bundle) {
        if (in_array($bundle, $this->productTypes)) {
          $product_node_count++;
        }
      }
      $node_count = 0;
      foreach ($node_bundles as $bundle) {
        if ($bundle === 'node') {
          $node_count++;
        }
      }
      $result['commerce_product'] = 0;
      if ($product_node_count > 0) {

        // If all bundles for this field are product types, then add the
        // commerce product flag to indicate this is a product node.
        if ($product_node_count == count($node_bundles)) {
          $result['commerce_product'] = 1;
        }
        else {

          // This field is on both a product node and a non product node so add
          // a new row to create the field storage on the commerce_product
          // entity.
          $add_row = $result;
          $add_row['commerce_product'] = 1;
          $rows[] = $add_row;
        }
      }
      $rows[] = $result;
    }
    return new \ArrayIterator($rows);
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    $fields = parent::fields();
    $fields['commerce_product'] = $this
      ->t('Product node flag');
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids = parent::getIds();
    return $ids + [
      // Add a flag to indicate a commerce product node. This third source id
      // is not required for existing migration_lookups on d7_field to work
      // correctly.
      'commerce_product' => [
        'type' => 'integer',
      ],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
DrupalSqlBase::$entityTypeManager protected property The entity type 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 1
DrupalSqlBase::checkRequirements public function Checks if requirements for this plugin are OK. Overrides SqlBase::checkRequirements 4
DrupalSqlBase::create public static function Creates an instance of the plugin. Overrides SqlBase::create 3
DrupalSqlBase::getModuleSchemaVersion protected function Retrieves a module schema_version from the source Drupal database.
DrupalSqlBase::getSystemData public function Retrieves all system data information from the source Drupal database.
DrupalSqlBase::moduleExists protected function Checks if a given module is enabled in the source Drupal database.
DrupalSqlBase::variableGet protected function Reads a variable from a source Drupal database.
DrupalSqlBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct 6
Field::fields public function Returns available fields on the source. Overrides Field::fields
Field::getIds public function Defines the source fields uniquely identifying a source row. Overrides Field::getIds
Field::initializeIterator public function Initializes the iterator with the source data. Overrides SqlBase::initializeIterator
Field::prepareRow public function Adds additional data to the row. Overrides SourcePluginBase::prepareRow
Field::query public function Overrides SqlBase::query
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
MigrateSourceInterface::NOT_COUNTABLE constant Indicates that the source is not countable.
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.
ProductTypeTrait::$productTypes protected property Product node types.
ProductTypeTrait::getProductTypes protected function Helper to get the product types from the source database.
SourcePluginBase::$cache protected property The backend cache.
SourcePluginBase::$cacheCounts protected property Whether this instance should cache the source count. 1
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 Information on the property used as the high-water mark.
SourcePluginBase::$highWaterStorage protected property The key-value storage for the high-water value.
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. 2
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. 1
SourcePluginBase::$trackChanges protected property Flags whether to track changes to incoming data. 1
SourcePluginBase::aboveHighwater protected function Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::count public function Gets the source count. 9
SourcePluginBase::current public function
SourcePluginBase::getCache protected function Gets the cache object.
SourcePluginBase::getCurrentIds public function Gets the currentSourceIds data member.
SourcePluginBase::getHighWater protected function The current value of the high water mark.
SourcePluginBase::getHighWaterField protected function Get the name of the field used as the high watermark.
SourcePluginBase::getHighWaterProperty protected function Get information on the property used as the high watermark.
SourcePluginBase::getHighWaterStorage protected function Get the high water storage object.
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::getSourceModule public function Gets the source module providing the source data. Overrides MigrateSourceInterface::getSourceModule
SourcePluginBase::key public function Gets the iterator key.
SourcePluginBase::next public function
SourcePluginBase::postRollback public function Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::preRollback public function Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::rewind public function Rewinds the iterator.
SourcePluginBase::rowChanged protected function Checks if the incoming row has changed since our last import.
SourcePluginBase::saveHighWater protected function Save the new high water mark.
SourcePluginBase::valid public function Checks whether the iterator is currently valid.
SqlBase::$batch protected property The count of the number of batches run.
SqlBase::$batchSize protected property Number of records to fetch from the database during each batch.
SqlBase::$database protected property The database object. 1
SqlBase::$query protected property The query string.
SqlBase::$state protected property State service for retrieving database info.
SqlBase::doCount protected function Gets the source count using countQuery(). Overrides SourcePluginBase::doCount
SqlBase::fetchNextBatch protected function Prepares query for the next set of data from the source database.
SqlBase::fetchNextRow protected function Position the iterator to the following row. Overrides SourcePluginBase::fetchNextRow
SqlBase::getDatabase public function Gets the database connection object. 2
SqlBase::mapJoinable protected function Checks if we can join against the map table. 1
SqlBase::prepareQuery protected function Adds tags and metadata to the query.
SqlBase::select protected function Wrapper for database select.
SqlBase::setUpDatabase protected function Gets a connection to the referenced database.
SqlBase::__sleep public function Overrides DependencySerializationTrait::__sleep
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. 4
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.