You are here

class CommercePrice in Commerce Migrate 3.0.x

Same name in this branch
  1. 3.0.x modules/magento/src/Plugin/migrate/process/CommercePrice.php \Drupal\commerce_migrate_magento\Plugin\migrate\process\CommercePrice
  2. 3.0.x modules/csv_example/src/Plugin/migrate/process/CommercePrice.php \Drupal\commerce_migrate_csv_example\Plugin\migrate\process\CommercePrice
  3. 3.0.x modules/shopify/src/Plugin/migrate/process/CommercePrice.php \Drupal\commerce_migrate_shopify\Plugin\migrate\process\CommercePrice
  4. 3.0.x modules/commerce/src/Plugin/migrate/process/commerce1/CommercePrice.php \Drupal\commerce_migrate_commerce\Plugin\migrate\process\commerce1\CommercePrice
  5. 3.0.x modules/commerce/src/Plugin/migrate/field/commerce1/CommercePrice.php \Drupal\commerce_migrate_commerce\Plugin\migrate\field\commerce1\CommercePrice
Same name and namespace in other branches
  1. 8.2 modules/shopify/src/Plugin/migrate/process/CommercePrice.php \Drupal\commerce_migrate_shopify\Plugin\migrate\process\CommercePrice
  2. 3.1.x modules/shopify/src/Plugin/migrate/process/CommercePrice.php \Drupal\commerce_migrate_shopify\Plugin\migrate\process\CommercePrice

Creates a price array from the input value.

Build a keyed array where price is the first value in the input array and the currency code is the second. If there is no price value, an empty array is returned.

Example:


price:
  plugin: shopify_commerce_price
  source:
    - price
    - code

When price = 12.00 and code is 'CAD', a an associative array, where 'number' => 12.00 and 'currency_code => 'CAD' is returned.

Plugin annotation


@MigrateProcessPlugin(
  id = "shopify_commerce_price"
)

Hierarchy

Expanded class hierarchy of CommercePrice

1 file declares its use of CommercePrice
CommercePriceTest.php in modules/shopify/tests/src/Unit/Plugin/migrate/process/CommercePriceTest.php

File

modules/shopify/src/Plugin/migrate/process/CommercePrice.php, line 33

Namespace

Drupal\commerce_migrate_shopify\Plugin\migrate\process
View source
class CommercePrice extends ProcessPluginBase {

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if (!is_array($value)) {
      throw new MigrateException(sprintf("Input should be an array, instead it was of type '%s'", gettype($value)));
    }
    $new_value = NULL;
    $number = $value[0];
    if ($number) {
      $new_value = [
        'number' => $number,
        'currency_code' => strtoupper($value[1]),
      ];
    }
    return $new_value;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CommercePrice::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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. 98
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.