interface PriceCalculatorInterface in Commerce Core 8.2

Calculates the price a purchasable entity would have if it was in an order.

Used for product listings and pages, where an order doesn't exist yet. When an order does exist, the actual calculation happens in OrderRefresh.

Hierarchy

• interface \Drupal\commerce_order\PriceCalculatorInterface

See also

\Drupal\commerce_order\OrderRefresh

1 file declares its use of PriceCalculatorInterface

PriceCalculatedFormatter.php in modules/order/src/Plugin/Field/FieldFormatter/PriceCalculatedFormatter.php

File

modules/order/src/PriceCalculatorInterface.php, line 16

Namespace

Drupal\commerce_order

interface PriceCalculatorInterface {

  /**
   * Adds an order processor for the given adjustment type.
   *
   * @param \Drupal\commerce_order\OrderProcessorInterface $processor
   *   The order processor.
   * @param string $adjustment_type
   *   The adjustment type.
   */
  public function addProcessor(OrderProcessorInterface $processor, $adjustment_type);

  /**
   * Gets all order processors for the given adjustment type.
   *
   * @param string $adjustment_type
   *   The adjustment type.
   *
   * @return \Drupal\commerce_order\OrderProcessorInterface[]
   *   The order processors.
   */
  public function getProcessors($adjustment_type);

  /**
   * Calculates a purchasable entity's price.
   *
   * @param \Drupal\commerce\PurchasableEntityInterface $purchasable_entity
   *   The purchasable entity.
   * @param string $quantity
   *   The quantity.
   * @param \Drupal\commerce\Context $context
   *   The context.
   * @param string[] $adjustment_types
   *   The adjustment types to include in the calculated price.
   *   Examples: fee, promotion, tax.
   *
   * @return \Drupal\commerce_order\PriceCalculatorResult
   *   The result.
   */
  public function calculate(PurchasableEntityInterface $purchasable_entity, $quantity, Context $context, array $adjustment_types = []);

}

Members

Name	Modifiers	Type	Description	Overrides
PriceCalculatorInterface::addProcessor	public	function	Adds an order processor for the given adjustment type.	1
PriceCalculatorInterface::calculate	public	function	Calculates a purchasable entity's price.	1
PriceCalculatorInterface::getProcessors	public	function	Gets all order processors for the given adjustment type.	1