class OrderPercentageOff in Commerce Core 8.2
Provides the percentage off offer for orders.
The discount is split between order items, to simplify VAT taxes and refunds.
Plugin annotation
@CommercePromotionOffer(
id = "order_percentage_off",
label = @Translation("Percentage off the order subtotal"),
entity_type = "commerce_order",
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\commerce_promotion\Plugin\Commerce\PromotionOffer\PromotionOfferBase implements PromotionOfferInterface, ContainerFactoryPluginInterface
- class \Drupal\commerce_promotion\Plugin\Commerce\PromotionOffer\OrderPromotionOfferBase implements OrderPromotionOfferInterface
- class \Drupal\commerce_promotion\Plugin\Commerce\PromotionOffer\OrderPercentageOff uses PercentageOffTrait
- class \Drupal\commerce_promotion\Plugin\Commerce\PromotionOffer\OrderPromotionOfferBase implements OrderPromotionOfferInterface
- class \Drupal\commerce_promotion\Plugin\Commerce\PromotionOffer\PromotionOfferBase implements PromotionOfferInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of OrderPercentageOff
File
- modules/
promotion/ src/ Plugin/ Commerce/ PromotionOffer/ OrderPercentageOff.php, line 20
Namespace
Drupal\commerce_promotion\Plugin\Commerce\PromotionOfferView source
class OrderPercentageOff extends OrderPromotionOfferBase {
use PercentageOffTrait;
/**
* {@inheritdoc}
*/
public function apply(EntityInterface $entity, PromotionInterface $promotion) {
$this
->assertEntity($entity);
/** @var \Drupal\commerce_order\Entity\OrderInterface $order */
$order = $entity;
$percentage = $this
->getPercentage();
// Calculate the order-level discount and split it between order items.
$amount = $order
->getSubtotalPrice()
->multiply($percentage);
$amount = $this->rounder
->round($amount);
$total_price = $order
->getTotalPrice();
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;
}
$amounts = $this->splitter
->split($order, $amount, $percentage);
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'),
'percentage' => $percentage,
'source_id' => $promotion
->id(),
]));
}
}
}
}
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 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
OrderPercentageOff:: |
public | function |
Applies the offer to the given entity. Overrides PromotionOfferInterface:: |
|
OrderPromotionOfferBase:: |
protected | property | The price splitter. | |
OrderPromotionOfferBase:: |
public static | function |
Creates an instance of the plugin. Overrides PromotionOfferBase:: |
2 |
OrderPromotionOfferBase:: |
public | function |
Constructs a new OrderPromotionOfferBase object. Overrides PromotionOfferBase:: |
1 |
PercentageOffTrait:: |
public | function | ||
PercentageOffTrait:: |
public | function | ||
PercentageOffTrait:: |
protected | function | Gets the percentage. | |
PercentageOffTrait:: |
public | function | ||
PercentageOffTrait:: |
public | function | ||
PercentageOffTrait:: |
public | function | ||
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. | |
PromotionOfferBase:: |
protected | property | The rounder. | |
PromotionOfferBase:: |
protected | function | Asserts that the given entity is of the expected type. | |
PromotionOfferBase:: |
public | function |
Allows an offer to clean up any modifications done to the given entity. Overrides PromotionOfferInterface:: |
1 |
PromotionOfferBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
PromotionOfferBase:: |
public | function |
Gets the offer entity type ID. Overrides PromotionOfferInterface:: |
|
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. |