class ProductDisplayType in Commerce Migrate 8.2

Gets Commerce 1 commerce_product_type data from database.

Plugin annotation

@MigrateSource(
  id = "commerce1_product_display_type",
  source_module = "commerce_product"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements RollbackAwareInterface, MigrateSourceInterface
      • class \Drupal\migrate\Plugin\migrate\source\SqlBase implements ContainerFactoryPluginInterface, RequirementsInterface
        • class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements DependentPluginInterface, ContainerFactoryPluginInterface uses DeprecatedServicePropertyTrait, DependencyTrait
          • class \Drupal\commerce_migrate_commerce\Plugin\migrate\source\commerce1\ProductDisplayType

File

modules/commerce/src/Plugin/migrate/source/commerce1/ProductDisplayType.php, line 18

Namespace

Drupal\commerce_migrate_commerce\Plugin\migrate\source\commerce1

class ProductDisplayType extends DrupalSqlBase {

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'field_name' => t('Product reference field name'),
      'type' => t('Type'),
      'name' => t('Name'),
      'description' => t('Description'),
      'help' => t('Help'),
      'data' => t('Product reference field instance data'),
      'variation_type' => t('Product variation type'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids['type']['type'] = 'string';
    $ids['type']['alias'] = 'nt';
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {
    $row
      ->setSourceProperty('data', unserialize($row
      ->getSourceProperty('data')));

    // @TODO: Remove this block of code when resolveTargetVariationType is
    // removed.
    $instance_config = $row
      ->getSourceProperty('data');
    $product_variation_type = array_filter($instance_config['settings']['referenceable_types']);
    if (count($product_variation_type) > 1) {
      $product_variation_type = $this
        ->resolveTargetVariationType($row, $product_variation_type);
    }
    else {
      $product_variation_type = reset($product_variation_type);
    }
    $row
      ->setSourceProperty('variation_type', $product_variation_type);
    return parent::prepareRow($row);
  }

  /**
   * {@inheritdoc}
   */
  public function query() {
    $query = $this
      ->select('field_config', 'fc');
    $query
      ->leftJoin('field_config_instance', 'fci', '(fci.field_id = fc.id)');
    $query
      ->leftJoin('node_type', 'nt', '(nt.type = fci.bundle)');
    $query
      ->condition('fc.type', 'commerce_product_reference')
      ->condition('fc.active', 1)
      ->condition('fci.entity_type', 'node')
      ->condition('nt.disabled', 0);
    $query
      ->fields('fc', [
      'field_name',
    ])
      ->fields('fci', [
      'data',
    ])
      ->fields('nt', [
      'type',
      'name',
      'description',
      'help',
    ]);
    return $query;
  }

  /**
   * Tries to determine a single target variation type.
   *
   * In 2.x, products can only be mapped to a single product variation type,
   * whereas in 1.x one product display node can be mapped to multiple product
   * types via the product reference field's settings.
   *
   * This function can be overwritten by custom migration classes if you need
   * different logic for determining the target variation type.
   *
   * @param \Drupal\migrate\Row $row
   *   The current row.
   * @param array $product_variation_types
   *   An array of product variation types.
   *
   * @return bool|string
   *   The product variation type matching the product, of FALSE if not found.
   *
   * @throws \Drupal\migrate\MigrateException
   *
   * @deprecated in Commerce Migrate 8.x-2.x-beta11 and will be removed before
   * Commerce Migrate 8.x-3.x. Instead, you should use the
   * ResolveProductVariationType process plugin
   * See https://www.drupal.org/node/2982007
   */
  public function resolveTargetVariationType(Row $row, array $product_variation_types) {
    @trigger_error('ProductDisplayType::resolveTargetVariationType() is deprecated in Commerce Migrate 8.x-2.x-beta11 and will be removed before Commerce Migrate 8.x-3.x. Instead, you should use the ResolveProductVariationType process plugin. See https://www.drupal.org/node/2982007', E_USER_DEPRECATED);
    $product_variation_type = FALSE;
    if (isset($this->configuration['variations']['matching'])) {

      // Try to find a variation type that matches the product type.
      $key = array_search($row
        ->getSourceProperty('type'), $product_variation_types);
      if ($key !== FALSE) {
        $product_variation_type = $product_variation_types[$key];
      }
    }
    if ($product_variation_type === FALSE) {

      // Make sure the default product type exists.
      if (!empty($this->configuration['variations']['default']) && CommerceProductType::load($this->configuration['variations']['default'])) {
        $product_variation_type = $this->configuration['variations']['default'];
      }
      else {
        $product_type = $row
          ->getSourceProperty('type');
        throw new MigrateException("A product variation type could not be determined for the product type: {$product_type}");
      }
    }
    return $product_variation_type;
  }

}

Members

Name	Modifiers	Type	Description	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		1
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.
DeprecatedServicePropertyTrait::__get	public	function	Allows to access deprecated/removed properties.
DrupalSqlBase::$deprecatedProperties	protected	property		1
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	2
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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.
ProductDisplayType::fields	public	function	Returns available fields on the source. Overrides MigrateSourceInterface::fields
ProductDisplayType::getIds	public	function	Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
ProductDisplayType::prepareRow	public	function	Adds additional data to the row. Overrides SourcePluginBase::prepareRow
ProductDisplayType::query	public	function	Overrides SqlBase::query
ProductDisplayType::resolveTargetVariationType Deprecated	public	function	Tries to determine a single target variation type.
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::current	public	function
SourcePluginBase::doCount	protected	function	Gets the source count checking if the source is countable or using the iterator_count function.	1
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.	1
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	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::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::count	public	function	Gets the source count. Overrides SourcePluginBase::count	6
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::initializeIterator	protected	function	Initializes the iterator with the source data. Overrides SourcePluginBase::initializeIterator	20
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::__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.	1
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.