You are here

Home » API reference » Commerce Core 8.2 » OrderFixedAmountOff.php

class OrderFixedAmountOff in Commerce Core 8.2

Provides the fixed amount off offer for orders.

The discount is split between order items, to simplify VAT taxes and refunds.

Plugin annotation


@CommercePromotionOffer(
  id = "order_fixed_amount_off",
  label = @Translation("Fixed amount off the order subtotal"),
  entity_type = "commerce_order",
)

Hierarchy

Expanded class hierarchy of OrderFixedAmountOff

File

modules/promotion/src/Plugin/Commerce/PromotionOffer/OrderFixedAmountOff.php, line 20

Namespace

Drupal\commerce_promotion\Plugin\Commerce\PromotionOffer
View source 
class OrderFixedAmountOff extends OrderPromotionOfferBase {
  use FixedAmountOffTrait;

  /**
   * {@inheritdoc}
   */
  public function apply(EntityInterface $entity, PromotionInterface $promotion) {
    $this
      ->assertEntity($entity);

    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
    $order = $entity;
    $subtotal_price = $order
      ->getSubTotalPrice();
    $amount = $this
      ->getAmount();
    if ($subtotal_price
      ->getCurrencyCode() != $amount
      ->getCurrencyCode()) {
      return;
    }
    $total_price = $order
      ->getTotalPrice();

    // The promotion amount can't be larger than the total, to avoid
    // potentially having a negative order total.
    if ($total_price && $amount
      ->greaterThan($total_price)) {
      $amount = $total_price;
    }

    // Skip applying the promotion if there's no amount to discount.
    if ($amount
      ->isZero()) {
      return;
    }

    // Split the amount between order items.
    $amounts = $this->splitter
      ->split($order, $amount);
    foreach ($order
      ->getItems() as $order_item) {
      if (isset($amounts[$order_item
        ->id()])) {
        $order_item
          ->addAdjustment(new Adjustment([
          'type' => 'promotion',
          'label' => $promotion
            ->getDisplayName() ?: $this
            ->t('Discount'),
          'amount' => $amounts[$order_item
            ->id()]
            ->multiply('-1'),
          'source_id' => $promotion
            ->id(),
        ]));
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::buildConfigurationForm public function
FixedAmountOffTrait::defaultConfiguration public function
FixedAmountOffTrait::getAmount protected function Gets the offer amount.
FixedAmountOffTrait::submitConfigurationForm public function
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
OrderFixedAmountOff::apply public function Applies the offer to the given entity. Overrides PromotionOfferInterface::apply
OrderPromotionOfferBase::$splitter protected property The price splitter.
OrderPromotionOfferBase::create public static function Creates an instance of the plugin. Overrides PromotionOfferBase::create 2
OrderPromotionOfferBase::__construct public function Constructs a new OrderPromotionOfferBase object. Overrides PromotionOfferBase::__construct 1
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::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
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.