class CommercePrice in Commerce Migrate 8.2

Commerce price migrate field plugin.

Plugin annotation

@MigrateField(
  id = "commerce_price",
  core = {7},
  source_module = "commerce_price",
  destination_module = "commerce_price"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase implements MigrateFieldInterface
      • class \Drupal\commerce_migrate_commerce\Plugin\migrate\field\commerce1\CommercePrice

File

modules/commerce/src/Plugin/migrate/field/commerce1/CommercePrice.php, line 19

Namespace

Drupal\commerce_migrate_commerce\Plugin\migrate\field\commerce1

class CommercePrice extends FieldPluginBase {

  /**
   * Field name map.
   *
   * @var array
   *   The field names on orders are different in Commerce 2 than Commerce 1.
   */
  public $fieldNameMap = [
    // The order total is now an Order total_price.
    'commerce_order_total' => 'total_price',
    // Line item total is now an Order Item total_price.
    'commerce_total' => 'total_price',
    'commerce_unit_price' => 'unit_price',
  ];

  /**
   * {@inheritdoc}
   */
  public function getFieldType(Row $row) {
    return 'commerce_price';
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldFormatterMap() {
    return [
      'commerce_price_formatted_amount' => 'commerce_price_default',
      'commerce_price_prefix_suffix' => 'commerce_price_default',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldWidgetMap() {
    return [
      'commerce_price_full' => 'commerce_price_default',
      'commerce_price_simple' => 'commerce_price_default',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function defineValueProcessPipeline(MigrationInterface $migration, $field_name, $data) {
    $destination_field_name = isset($this->fieldNameMap[$field_name]) ? $this->fieldNameMap[$field_name] : $field_name;
    $process = [
      'plugin' => 'commerce1_migrate_commerce_price',
      'source' => $field_name,
    ];
    $migration
      ->setProcessOfProperty($destination_field_name, $process);
  }

  /**
   * {@inheritdoc}
   */
  public function processFieldValues(MigrationInterface $migration, $field_name, $data) {
    $this
      ->defineValueProcessPipeline($migration, $field_name, $data);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CommercePrice::$fieldNameMap	public	property	Field name map.
CommercePrice::defineValueProcessPipeline	public	function	Apply any custom processing to the field bundle migrations. Overrides FieldPluginBase::defineValueProcessPipeline
CommercePrice::getFieldFormatterMap	public	function	Get a map between D6 formatters and D8 formatters for this field type. Overrides FieldPluginBase::getFieldFormatterMap
CommercePrice::getFieldType	public	function	Computes the destination type of a migrated field. Overrides FieldPluginBase::getFieldType
CommercePrice::getFieldWidgetMap	public	function	Get a map between D6 and D8 widgets for this field type. Overrides FieldPluginBase::getFieldWidgetMap
CommercePrice::processFieldValues	public	function	Defines the process pipeline for field values. Overrides FieldPluginBase::processFieldValues
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
FieldPluginBase::alterFieldFormatterMigration	public	function	Apply any custom processing to the field formatter migration. Overrides MigrateFieldInterface::alterFieldFormatterMigration
FieldPluginBase::alterFieldInstanceMigration	public	function	Apply any custom processing to the field instance migration. Overrides MigrateFieldInterface::alterFieldInstanceMigration	2
FieldPluginBase::alterFieldMigration	public	function	Apply any custom processing to the field migration. Overrides MigrateFieldInterface::alterFieldMigration
FieldPluginBase::alterFieldWidgetMigration	public	function	Apply any custom processing to the field widget migration. Overrides MigrateFieldInterface::alterFieldWidgetMigration
FieldPluginBase::getFieldFormatterType	public	function	Get the field formatter type from the source. Overrides MigrateFieldInterface::getFieldFormatterType	1
FieldPluginBase::getFieldWidgetType	public	function	Get the field widget type from the source. Overrides MigrateFieldInterface::getFieldWidgetType	1
FieldPluginBase::processField Deprecated	public	function	Alters the migration for field definitions.
FieldPluginBase::processFieldFormatter Deprecated	public	function	Alter field formatter migration.
FieldPluginBase::processFieldInstance Deprecated	public	function	Alert field instance migration.
FieldPluginBase::processFieldWidget Deprecated	public	function	Alter field widget migration.
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.