class Order in Commerce Migrate 3.0.x
Same name in this branch
- 3.0.x modules/commerce/src/Plugin/migrate/Order.php \Drupal\commerce_migrate_commerce\Plugin\migrate\Order
- 3.0.x modules/ubercart/src/Plugin/migrate/source/Order.php \Drupal\commerce_migrate_ubercart\Plugin\migrate\source\Order
- 3.0.x modules/commerce/src/Plugin/migrate/source/commerce1/Order.php \Drupal\commerce_migrate_commerce\Plugin\migrate\source\commerce1\Order
Same name and namespace in other branches
- 8.2 modules/commerce/src/Plugin/migrate/source/commerce1/Order.php \Drupal\commerce_migrate_commerce\Plugin\migrate\source\commerce1\Order
- 3.1.x modules/commerce/src/Plugin/migrate/source/commerce1/Order.php \Drupal\commerce_migrate_commerce\Plugin\migrate\source\commerce1\Order
Gets Commerce 1 commerce_order data from database.
Plugin annotation
@MigrateSource(
id = "commerce1_order",
source_module = "commerce_order"
)
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 uses DependencyTrait
- class \Drupal\migrate_drupal\Plugin\migrate\source\d7\FieldableEntity
- class \Drupal\commerce_migrate_commerce\Plugin\migrate\source\commerce1\Order
- class \Drupal\migrate_drupal\Plugin\migrate\source\d7\FieldableEntity
- class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements DependentPluginInterface uses DependencyTrait
- class \Drupal\migrate\Plugin\migrate\source\SqlBase implements ContainerFactoryPluginInterface, RequirementsInterface
- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements RollbackAwareInterface, MigrateSourceInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Order
File
- modules/
commerce/ src/ Plugin/ migrate/ source/ commerce1/ Order.php, line 24
Namespace
Drupal\commerce_migrate_commerce\Plugin\migrate\source\commerce1View source
class Order extends FieldableEntity {
/**
* The default store resolver.
*
* @var \Drupal\commerce_store\Resolver\DefaultStoreResolver
*/
protected $defaultStoreResolver;
/**
* {@inheritdoc}
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, StateInterface $state, EntityTypeManagerInterface $entity_type_manager, DefaultStoreResolver $default_store_resolver) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $state, $entity_type_manager);
$this->defaultStoreResolver = $default_store_resolver;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
return new static($configuration, $plugin_id, $plugin_definition, $migration, $container
->get('state'), $container
->get('entity_type.manager'), $container
->get('commerce_store.default_store_resolver'));
}
/**
* {@inheritdoc}
*/
public function fields() {
return [
'order_id' => $this
->t('Order ID'),
'commerce_order_total' => $this
->t('Order Number'),
'revision_id' => $this
->t('Revision ID'),
'type' => $this
->t('Type'),
'uid' => $this
->t('User ID'),
'mail' => $this
->t('Email'),
'status' => $this
->t('Status'),
'created' => $this
->t('Created'),
'changed' => $this
->t('Changed'),
'default_store_id' => $this
->t('Default store id'),
'refresh_state' => $this
->t('Order refresh state'),
'hostname' => $this
->t('Hostname'),
'data' => $this
->t('Data'),
];
}
/**
* {@inheritdoc}
*/
public function getIds() {
$ids['order_id']['type'] = 'integer';
return $ids;
}
/**
* {@inheritdoc}
*/
public function query() {
return $this
->select('commerce_order', 'ord')
->fields('ord');
}
/**
* {@inheritdoc}
*/
public function prepareRow(Row $row) {
// Fail early if a store does not exist on the destination.
// Add refresh skip value to the row.
$row
->setSourceProperty('refresh_state', OrderInterface::REFRESH_SKIP);
$default_store = $this->defaultStoreResolver
->resolve();
if ($default_store) {
$row
->setSourceProperty('default_store_id', $default_store
->id());
}
else {
throw new MigrateException('You must have a store saved in order to import orders.');
}
// Get Field API field values.
$order_id = $row
->getSourceProperty('order_id');
$revision_id = $row
->getSourceProperty('revision_id');
foreach (array_keys($this
->getFields('commerce_order', $row
->getSourceProperty('type'))) as $field) {
$row
->setSourceProperty($field, $this
->getFieldValues('commerce_order', $field, $order_id, $revision_id));
}
// Include the number of currency fraction digits in commerce_order_total.
$currencyRepository = new CurrencyRepository();
$value = $row
->getSourceProperty('commerce_order_total');
$currency_code = $value[0]['currency_code'];
$value[0]['fraction_digits'] = $currencyRepository
->get($currency_code)
->getFractionDigits();
$row
->setSourceProperty('commerce_order_total', $value);
$row
->setSourceProperty('data', unserialize($row
->getSourceProperty('data')));
// Get shipping line items for this order.
$query = $this
->select('commerce_line_item', 'cli')
->fields('cli')
->condition('cli.order_id', $order_id)
->condition('cli.type', 'shipping');
$shipping_line_items = $query
->execute()
->fetchAll();
foreach ($shipping_line_items as $key => $shipping_line_item) {
// Get Field API field values.
$line_item_id = $shipping_line_item['line_item_id'];
foreach (array_keys($this
->getFields('commerce_line_item', 'shipping')) as $field) {
$shipping_line_items[$key][$field] = $this
->getFieldValues('commerce_line_item', $field, $line_item_id, $line_item_id);
}
$shipping_line_items[$key]['data'] = unserialize($shipping_line_item['data']);
$currency_code = $shipping_line_items[$key]['commerce_total'][0]['currency_code'];
$shipping_line_items[$key]['commerce_total'][0]['fraction_digits'] = $currencyRepository
->get($currency_code)
->getFractionDigits();
}
$row
->setSourceProperty('shipping_line_items', $shipping_line_items);
return parent::prepareRow($row);
}
/**
* {@inheritdoc}
*/
public function getFieldValues($entity_type, $field, $entity_id, $revision_id = NULL, $language = NULL) {
$values = parent::getFieldValues($entity_type, $field, $entity_id, $revision_id, $language);
// Unserialize any data blob in these fields.
foreach ($values as $key => &$value) {
if (isset($value['data'])) {
$values[$key]['data'] = unserialize($value['data']);
}
}
return $values;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. | |
DrupalSqlBase:: |
protected | property | The entity type manager. | |
DrupalSqlBase:: |
protected | property | If the source provider is missing. | |
DrupalSqlBase:: |
protected | property | The contents of the system table. | |
DrupalSqlBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
1 |
DrupalSqlBase:: |
public | function |
Checks if requirements for this plugin are OK. Overrides SqlBase:: |
4 |
DrupalSqlBase:: |
protected | function | Retrieves a module schema_version from the source Drupal database. | |
DrupalSqlBase:: |
public | function | Retrieves all system data information from the source Drupal database. | |
DrupalSqlBase:: |
protected | function | Checks if a given module is enabled in the source Drupal database. | |
DrupalSqlBase:: |
protected | function | Reads a variable from a source Drupal database. | |
FieldableEntity:: |
protected | function | Gets an entity source language from the 'entity_translation' table. | |
FieldableEntity:: |
protected | function | Returns all non-deleted field instances attached to a specific entity type. | |
FieldableEntity:: |
protected | function | Checks if an entity type uses Entity Translation. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
MigrateSourceInterface:: |
constant | Indicates that the source is not countable. | ||
Order:: |
protected | property | The default store resolver. | |
Order:: |
public static | function |
Creates an instance of the plugin. Overrides DrupalSqlBase:: |
|
Order:: |
public | function |
Returns available fields on the source. Overrides MigrateSourceInterface:: |
|
Order:: |
public | function |
Retrieves field values for a single field of a single entity. Overrides FieldableEntity:: |
|
Order:: |
public | function |
Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface:: |
|
Order:: |
public | function |
Adds additional data to the row. Overrides SourcePluginBase:: |
|
Order:: |
public | function |
Overrides SqlBase:: |
|
Order:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides DrupalSqlBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
SourcePluginBase:: |
protected | property | The backend cache. | |
SourcePluginBase:: |
protected | property | Whether this instance should cache the source count. | 1 |
SourcePluginBase:: |
protected | property | Key to use for caching counts. | |
SourcePluginBase:: |
protected | property | The current row from the query. | |
SourcePluginBase:: |
protected | property | The primary key of the current row. | |
SourcePluginBase:: |
protected | property | Information on the property used as the high-water mark. | |
SourcePluginBase:: |
protected | property | The key-value storage for the high-water value. | |
SourcePluginBase:: |
protected | property | The migration ID map. | |
SourcePluginBase:: |
protected | property | The iterator to iterate over the source rows. | |
SourcePluginBase:: |
protected | property | Flags whether source plugin will read the map row and add to data row. | |
SourcePluginBase:: |
protected | property | The entity migration object. | |
SourcePluginBase:: |
protected | property | The module handler service. | 2 |
SourcePluginBase:: |
protected | property | The high water mark at the beginning of the import operation. | |
SourcePluginBase:: |
protected | property | Whether this instance should not attempt to count the source. | 1 |
SourcePluginBase:: |
protected | property | Flags whether to track changes to incoming data. | 1 |
SourcePluginBase:: |
protected | function | Check if the incoming data is newer than what we've previously imported. | |
SourcePluginBase:: |
public | function | Gets the source count. | 9 |
SourcePluginBase:: |
public | function | ||
SourcePluginBase:: |
protected | function | Gets the cache object. | |
SourcePluginBase:: |
public | function | Gets the currentSourceIds data member. | |
SourcePluginBase:: |
protected | function | The current value of the high water mark. | |
SourcePluginBase:: |
protected | function | Get the name of the field used as the high watermark. | |
SourcePluginBase:: |
protected | function | Get information on the property used as the high watermark. | |
SourcePluginBase:: |
protected | function | Get the high water storage object. | |
SourcePluginBase:: |
protected | function | Returns the iterator that will yield the row arrays to be processed. | |
SourcePluginBase:: |
protected | function | Gets the module handler. | |
SourcePluginBase:: |
public | function |
Gets the source module providing the source data. Overrides MigrateSourceInterface:: |
|
SourcePluginBase:: |
public | function | Gets the iterator key. | |
SourcePluginBase:: |
public | function | ||
SourcePluginBase:: |
public | function |
Performs post-rollback tasks. Overrides RollbackAwareInterface:: |
|
SourcePluginBase:: |
public | function |
Performs pre-rollback tasks. Overrides RollbackAwareInterface:: |
|
SourcePluginBase:: |
public | function | Rewinds the iterator. | |
SourcePluginBase:: |
protected | function | Checks if the incoming row has changed since our last import. | |
SourcePluginBase:: |
protected | function | Save the new high water mark. | |
SourcePluginBase:: |
public | function | Checks whether the iterator is currently valid. | |
SqlBase:: |
protected | property | The count of the number of batches run. | |
SqlBase:: |
protected | property | Number of records to fetch from the database during each batch. | |
SqlBase:: |
protected | property | The database object. | 1 |
SqlBase:: |
protected | property | The query string. | |
SqlBase:: |
protected | property | State service for retrieving database info. | |
SqlBase:: |
protected | function |
Gets the source count using countQuery(). Overrides SourcePluginBase:: |
|
SqlBase:: |
protected | function | Prepares query for the next set of data from the source database. | |
SqlBase:: |
protected | function |
Position the iterator to the following row. Overrides SourcePluginBase:: |
|
SqlBase:: |
public | function | Gets the database connection object. | 2 |
SqlBase:: |
protected | function |
Initializes the iterator with the source data. Overrides SourcePluginBase:: |
18 |
SqlBase:: |
protected | function | Checks if we can join against the map table. | 1 |
SqlBase:: |
protected | function | Adds tags and metadata to the query. | |
SqlBase:: |
protected | function | Wrapper for database select. | |
SqlBase:: |
protected | function | Gets a connection to the referenced database. | |
SqlBase:: |
public | function |
Overrides DependencySerializationTrait:: |
|
SqlBase:: |
public | function |
Prints the query string when the object is used as a string. Overrides MigrateSourceInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |