You are here

Home » API reference » Commerce Currency Resolver 8 » OrderItemFixedAmountOff.php

class OrderItemFixedAmountOff in Commerce Currency Resolver 8

Provides the percentage off offer for order items with multicurrency support.

Hierarchy

Expanded class hierarchy of OrderItemFixedAmountOff

See also

\Drupal\commerce_promotion\Plugin\Commerce\PromotionOffer\OrderItemFixedAmountOff

1 file declares its use of OrderItemFixedAmountOff
commerce_currency_resolver.module in ./commerce_currency_resolver.module
Main module file.

File

src/Plugin/Commerce/PromotionOffer/OrderItemFixedAmountOff.php, line 16

Namespace

Drupal\commerce_currency_resolver\Plugin\Commerce\PromotionOffer
View source 
class OrderItemFixedAmountOff extends CommerceOrderItemFixedAmountOff {
  use CommerceCurrencyResolverAmountTrait;

  /**
   * {@inheritdoc}
   */
  public function apply(EntityInterface $entity, PromotionInterface $promotion) {

    // Nothing to do. Go to parent.
    if (!$this
      ->shouldCurrencyRefresh($this
      ->getAmount()
      ->getCurrencyCode())) {
      return parent::apply($entity, $promotion);
    }
    $this
      ->assertEntity($entity);

    /** @var \Drupal\commerce_order\Entity\OrderItemInterface $order_item */
    $order_item = $entity;
    $total_price = $order_item
      ->getTotalPrice();

    // Convert prices.
    $amount = $this
      ->getPrice($this
      ->getAmount());
    if ($this->configuration['display_inclusive']) {

      // Display-inclusive promotions must first be applied to the unit price.
      $unit_price = $order_item
        ->getUnitPrice();
      if ($amount
        ->greaterThan($unit_price)) {

        // Don't reduce the unit price past zero.
        $amount = $unit_price;
      }
      $new_unit_price = $unit_price
        ->subtract($amount);
      $order_item
        ->setUnitPrice($new_unit_price);
      $adjustment_amount = $amount
        ->multiply($order_item
        ->getQuantity());
      $adjustment_amount = $this->rounder
        ->round($adjustment_amount);
    }
    else {
      $adjustment_amount = $amount
        ->multiply($order_item
        ->getQuantity());
      $adjustment_amount = $this->rounder
        ->round($adjustment_amount);
      if ($adjustment_amount
        ->greaterThan($total_price)) {

        // Don't reduce the order item total price past zero.
        $adjustment_amount = $total_price;
      }
    }
    $order_item
      ->addAdjustment(new Adjustment([
      'type' => 'promotion',
      'label' => $promotion
        ->getDisplayName() ?: $this
        ->t('Discount'),
      'amount' => $adjustment_amount
        ->multiply('-1'),
      'source_id' => $promotion
        ->id(),
      'included' => $this->configuration['display_inclusive'],
    ]));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CommerceCurrencyResolverAmountTrait::buildConfigurationForm public function
CommerceCurrencyResolverAmountTrait::currentCurrency public function Get resolved currency.
CommerceCurrencyResolverAmountTrait::getPrice public function Get price based on currency price and target currency.
CommerceCurrencyResolverAmountTrait::shouldCurrencyRefresh public function Do not run conditions currency conversion on specific conditions.
CommerceCurrencyResolverAmountTrait::submitConfigurationForm public function
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
FixedAmountOffTrait::defaultConfiguration public function
FixedAmountOffTrait::getAmount protected function Gets the offer amount.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
OrderItemFixedAmountOff::apply public function Applies the offer to the given entity. Overrides OrderItemFixedAmountOff::apply
OrderItemPromotionOfferBase::getConditionOperator public function Gets the condition operator. Overrides OrderItemPromotionOfferInterface::getConditionOperator
OrderItemPromotionOfferBase::getConditions public function Gets the conditions. Overrides OrderItemPromotionOfferInterface::getConditions
OrderItemPromotionOfferBase::setConditions public function Sets the conditions. Overrides OrderItemPromotionOfferInterface::setConditions
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.
PromotionOfferBase::$rounder protected property The rounder.
PromotionOfferBase::assertEntity protected function Asserts that the given entity is of the expected type.
PromotionOfferBase::clear public function Allows an offer to clean up any modifications done to the given entity. Overrides PromotionOfferInterface::clear 1
PromotionOfferBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
PromotionOfferBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PromotionOfferBase::getEntityTypeId public function Gets the offer entity type ID. Overrides PromotionOfferInterface::getEntityTypeId
PromotionOfferBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
PromotionOfferBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 2
PromotionOfferBase::__construct public function Constructs a new PromotionOfferBase object. Overrides PluginBase::__construct 1
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.