class TaxTypeBase in Commerce Migrate 3.0.x
Same name and namespace in other branches
- 8.2 modules/ubercart/src/Plugin/migrate/source/TaxTypeBase.php \Drupal\commerce_migrate_ubercart\Plugin\migrate\source\TaxTypeBase
- 3.1.x modules/ubercart/src/Plugin/migrate/source/TaxTypeBase.php \Drupal\commerce_migrate_ubercart\Plugin\migrate\source\TaxTypeBase
Base class for Ubercart tax type source plugins.
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\commerce_migrate_ubercart\Plugin\migrate\source\TaxTypeBase
- 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 TaxTypeBase
2 files declare their use of TaxTypeBase
- TaxType.php in modules/
ubercart/ src/ Plugin/ migrate/ source/ uc7/ TaxType.php - TaxType.php in modules/
ubercart/ src/ Plugin/ migrate/ source/ uc6/ TaxType.php
File
- modules/
ubercart/ src/ Plugin/ migrate/ source/ TaxTypeBase.php, line 11
Namespace
Drupal\commerce_migrate_ubercart\Plugin\migrate\sourceView source
class TaxTypeBase extends DrupalSqlBase {
/**
* {@inheritdoc}
*/
public function query() {
return $this
->select('uc_taxes', 'ut')
->fields('ut');
}
/**
* {@inheritdoc}
*/
public function fields() {
return [
'id' => $this
->t('TaxType ID'),
'name' => $this
->t('TaxType Name'),
'rate' => $this
->t('TaxType Rate'),
'shippable' => $this
->t('Shippable'),
'taxed_product_types' => $this
->t('Taxed product types'),
'taxed_line_item' => $this
->t('Taxed line item'),
'weight' => $this
->t('Weight'),
'country_iso_code_2' => $this
->t('Country 2 character code'),
];
}
/**
* {@inheritdoc}
*/
public function prepareRow(Row $row) {
$row
->setSourceProperty('taxed_product_types', unserialize($row
->getSourceProperty('taxed_product_types')));
$row
->setSourceProperty('taxed_line_items', unserialize($row
->getSourceProperty('taxed_line_items')));
$country = $this
->variableGet('uc_store_country', NULL);
// Get the country iso code 2 for this country.
$query = $this
->select('uc_countries', 'ucc')
->fields('ucc', [
'country_iso_code_2',
])
->condition('country_id', $country);
$country_iso_code_2 = $query
->execute()
->fetchField();
$row
->setSourceProperty('country_iso_code_2', $country_iso_code_2);
return parent::prepareRow($row);
}
/**
* {@inheritdoc}
*/
public function getIds() {
return [
'id' => [
'type' => 'integer',
'alias' => 'ut',
],
];
}
}
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:: |
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. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
MigrateSourceInterface:: |
constant | Indicates that the source is not countable. | ||
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. | |
TaxTypeBase:: |
public | function |
Returns available fields on the source. Overrides MigrateSourceInterface:: |
1 |
TaxTypeBase:: |
public | function |
Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface:: |
|
TaxTypeBase:: |
public | function |
Adds additional data to the row. Overrides SourcePluginBase:: |
|
TaxTypeBase:: |
public | function |
Overrides SqlBase:: |