class ProfileBilling in Commerce Migrate 8.2
Same name in this branch
- 8.2 modules/ubercart/src/Plugin/migrate/source/ProfileBilling.php \Drupal\commerce_migrate_ubercart\Plugin\migrate\source\ProfileBilling
- 8.2 modules/ubercart/src/Plugin/migrate/source/uc6/ProfileBilling.php \Drupal\commerce_migrate_ubercart\Plugin\migrate\source\uc6\ProfileBilling
Same name and namespace in other branches
- 3.1.x modules/ubercart/src/Plugin/migrate/source/ProfileBilling.php \Drupal\commerce_migrate_ubercart\Plugin\migrate\source\ProfileBilling
- 3.0.x modules/ubercart/src/Plugin/migrate/source/ProfileBilling.php \Drupal\commerce_migrate_ubercart\Plugin\migrate\source\ProfileBilling
Ubercart billing profile source.
Plugin annotation
@MigrateSource(
id = "uc_profile_billing",
source_module = "uc_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, ContainerFactoryPluginInterface uses DeprecatedServicePropertyTrait, DependencyTrait
- class \Drupal\commerce_migrate_ubercart\Plugin\migrate\source\ProfileBilling
- class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements DependentPluginInterface, ContainerFactoryPluginInterface uses DeprecatedServicePropertyTrait, 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 ProfileBilling
2 files declare their use of ProfileBilling
- PreRowSave.php in modules/
ubercart/ src/ EventSubscriber/ PreRowSave.php - ProfileBilling.php in modules/
ubercart/ src/ Plugin/ migrate/ source/ uc6/ ProfileBilling.php
File
- modules/
ubercart/ src/ Plugin/ migrate/ source/ ProfileBilling.php, line 16
Namespace
Drupal\commerce_migrate_ubercart\Plugin\migrate\sourceView source
class ProfileBilling extends DrupalSqlBase {
/**
* The join options between the uc_orders and uc_countries table.
*/
const JOIN_COUNTRY = 'uc.country_id = uo.billing_country';
/**
* The join options between the uc_orders and uc_zones table.
*/
const JOIN_ZONE = 'uz.zone_id = uo.billing_zone';
/**
* {@inheritdoc}
*/
public function query() {
// Gets every order sorted by created date so the revisioning of the
// billing profile is in the correct order.
$query = $this
->select('uc_orders', 'uo')
->fields('uo')
->orderBy('uo.created');
$query
->leftJoin('uc_countries', 'uc', static::JOIN_COUNTRY);
$query
->addField('uc', 'country_iso_code_2');
$query
->leftJoin('uc_zones', 'uz', static::JOIN_ZONE);
$query
->addField('uz', 'zone_code');
return $query;
}
/**
* {@inheritdoc}
*/
public function fields() {
$fields = [
'order_id' => $this
->t('Order ID'),
'uid' => $this
->t('User ID of order'),
'order_status' => $this
->t('Order status'),
'order_total' => $this
->t('Order total'),
'product_count' => $this
->t('Product count'),
'primary_email' => $this
->t('Email associated with order'),
'delivery_first_name' => $this
->t('Delivery first name'),
'delivery_last_name' => $this
->t('Delivery last name'),
'delivery_phone' => $this
->t('Delivery phone name'),
'delivery_company' => $this
->t('Delivery company name'),
'delivery_street1' => $this
->t('Delivery street address line 1'),
'delivery_street2' => $this
->t('Delivery street address line 2'),
'delivery_city' => $this
->t('Delivery city'),
'delivery_zone' => $this
->t('Delivery State'),
'delivery_postal_code' => $this
->t('delivery postal code'),
'delivery_country' => $this
->t('delivery country'),
'billing_first_name' => $this
->t('Billing first name'),
'billing_last_name' => $this
->t('Billing last name'),
'billing_phone' => $this
->t('Billing phone name'),
'billing_company' => $this
->t('Billing company name'),
'billing_street1' => $this
->t('Billing street address line 1'),
'billing_street2' => $this
->t('Billing street address line 2'),
'billing_city' => $this
->t('Billing city'),
'billing_zone' => $this
->t('Billing State'),
'billing_postal_code' => $this
->t('Billing postal code'),
'billing_country' => $this
->t('Billing country'),
'payment_method' => $this
->t('Payment method'),
'data' => $this
->t('Order attributes'),
'created' => $this
->t('Date/time of order creation'),
'modified' => $this
->t('Date/time of last order modification'),
'host' => $this
->t('IP address of customer'),
'currency' => $this
->t('Currency'),
'status' => $this
->t('Profile active.'),
'is_default' => $this
->t('Profile default.'),
];
return $fields;
}
/**
* {@inheritdoc}
*/
public function prepareRow(Row $row) {
$row
->setSourceProperty('data', unserialize($row
->getSourceProperty('data')));
// Determine if this is the last revision.
$modified = (int) $row
->getSourceProperty('modified');
$uid = (int) $row
->getSourceProperty('uid');
$query = $this
->select('uc_orders', 'uo')
->condition('uid', $uid)
->condition('modified', $modified, '>');
$query
->addExpression('COUNT(uo.uid)', 'count');
$results = $query
->execute()
->fetchField();
// If there are no more revisions then mark as active and as default.
if ($results === '0') {
$row
->setSourceProperty('status', 1);
$row
->setSourceProperty('is_default', TRUE);
}
else {
$row
->setSourceProperty('status', 0);
$row
->setSourceProperty('is_default', NULL);
}
return parent::prepareRow($row);
}
/**
* {@inheritdoc}
*/
public function getIds() {
return [
'order_id' => [
'type' => 'integer',
'alias' => 'uo',
],
];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. | |
DeprecatedServicePropertyTrait:: |
public | function | Allows to access deprecated/removed properties. | |
DrupalSqlBase:: |
protected | property | 1 | |
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:: |
2 |
DrupalSqlBase:: |
public static | function |
Creates an instance of the plugin. Overrides SqlBase:: |
3 |
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. | |
DrupalSqlBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides SqlBase:: |
6 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
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:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
ProfileBilling:: |
public | function |
Returns available fields on the source. Overrides MigrateSourceInterface:: |
|
ProfileBilling:: |
public | function |
Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface:: |
|
ProfileBilling:: |
constant | The join options between the uc_orders and uc_countries table. | ||
ProfileBilling:: |
constant | The join options between the uc_orders and uc_zones table. | ||
ProfileBilling:: |
public | function |
Adds additional data to the row. Overrides SourcePluginBase:: |
|
ProfileBilling:: |
public | function |
Overrides SqlBase:: |
|
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 | ||
SourcePluginBase:: |
protected | function | Gets the source count checking if the source is countable or using the iterator_count function. | 1 |
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. | 1 |
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 | 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:: |
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:: |
public | function |
Gets the source count. Overrides SourcePluginBase:: |
6 |
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:: |
20 |
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 |
Prints the query string when the object is used as a string. Overrides MigrateSourceInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
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. |