Inheritance diagram for Calculator:

Public Member Functions
	__construct (CalculatorBase $calculator, AmountFactory $amountFactory, BundleSelectionFactory $bundleSelectionFactory, TaxHelper $taxHelper, PriceCurrencyInterface $priceCurrency, SelectionPriceListProviderInterface $selectionPriceListProvider=null)

	getAmount ($amount, SaleableInterface $saleableItem, $exclude=null, $context=[])

	getMinRegularAmount ($amount, Product $saleableItem, $exclude=null)

	getMaxAmount ($amount, Product $saleableItem, $exclude=null)

	getMaxRegularAmount ($amount, Product $saleableItem, $exclude=null)

	getOptionsAmount (Product $saleableItem, $exclude=null, $searchMin=true, $baseAmount=0., $useRegularPrice=false)

	getAmountWithoutOption ($amount, Product $saleableItem)

	calculateBundleAmount ($basePriceValue, $bundleProduct, $selectionPriceList, $exclude=null)

	createSelectionPriceList ($option, $bundleProduct, $useRegularPrice=false)

	processOptions ($option, $selectionPriceList, $searchMin=true)

Public Member Functions inherited from BundleCalculatorInterface
	getOptionsAmount (Product $saleableItem, $exclude=null, $searchMin=true, $bundleProductAmount=null)

Protected Member Functions
	getSelectionAmounts (Product $bundleProduct, $searchMin, $useRegularPrice=false)

	canSkipOption ($option, $canSkipRequiredOption)

	hasRequiredOption ($bundleProduct)

Protected Attributes
	$calculator

	$amountFactory

	$selectionFactory

	$taxHelper

	$priceCurrency

Detailed Description

Bundle price calculator @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 24 of file Calculator.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	CalculatorBase	$calculator,
		AmountFactory	$amountFactory,
		BundleSelectionFactory	$bundleSelectionFactory,
		TaxHelper	$taxHelper,
		PriceCurrencyInterface	$priceCurrency,
		SelectionPriceListProviderInterface	$selectionPriceListProvider = `null`
	)

Parameters

CalculatorBase	$calculator
AmountFactory	$amountFactory
BundleSelectionFactory	$bundleSelectionFactory
TaxHelper	$taxHelper
PriceCurrencyInterface	$priceCurrency
SelectionPriceListProviderInterface \| null	$selectionPriceListProvider

Definition at line 71 of file Calculator.php.

       {
         $this->calculator = $calculator;
         $this->amountFactory = $amountFactory;
         $this->selectionFactory = $bundleSelectionFactory;
         $this->taxHelper = $taxHelper;
         $this->priceCurrency = $priceCurrency;
         $this->selectionPriceListProvider = $selectionPriceListProvider;
     }

Member Function Documentation

◆ calculateBundleAmount()

calculateBundleAmount	(	$basePriceValue,
		$bundleProduct,
		$selectionPriceList,
		$exclude = `null`
	)

Calculate amount for bundle product with all selection prices

Parameters

float	$basePriceValue
Product	$bundleProduct

Implements BundleCalculatorInterface.

Definition at line 270 of file Calculator.php.

     {
         if ($bundleProduct->getPriceType() == Price::PRICE_TYPE_FIXED) {
             return $this->calculateFixedBundleAmount($basePriceValue, $bundleProduct, $selectionPriceList, $exclude);
         }
         return $this->calculateDynamicBundleAmount($basePriceValue, $bundleProduct, $selectionPriceList, $exclude);
     }

◆ canSkipOption()

canSkipOption	(	$option,
		$canSkipRequiredOption
	)

protected

Check this option if it should be skipped

Parameters

\Magento\Bundle\Model\Option	$option
bool	$canSkipRequiredOption

Returns: bool

Deprecated:: 100.2.0

Definition at line 222 of file Calculator.php.

     {
         return !$option->getSelections() || ($canSkipRequiredOption && !$option->getRequired());
     }

◆ createSelectionPriceList()

createSelectionPriceList	(	$option,
		$bundleProduct,
		$useRegularPrice = `false`
	)

Create selection price list for the retrieved options

Parameters

\Magento\Bundle\Model\Option	$option
Product	$bundleProduct
bool	$useRegularPrice

Returns: \Magento\Bundle\Pricing\Price\BundleSelectionPrice[]

Implements BundleCalculatorInterface.

Definition at line 372 of file Calculator.php.

     {
         $priceList = [];
         $selections = $option->getSelections();
         if ($selections === null) {
             return $priceList;
         }
         /* @var $selection \Magento\Bundle\Model\Selection|\Magento\Catalog\Model\Product */
         foreach ($selections as $selection) {
             if (!$selection->isSalable()) {
                 // @todo CatalogInventory Show out of stock Products
                 continue;
             }
             $priceList[] = $this->selectionFactory->create(
                 $bundleProduct,
                 $selection,
                 $selection->getSelectionQty(),
                 [
                     'useRegularPrice' => $useRegularPrice,
                 ]
             );
         }
         return $priceList;
     }

◆ getAmount()

getAmount	(		$amount,
		SaleableInterface	$saleableItem,
			$exclude = `null`,
			$context = `[]`
	)

Get amount for current product which is included price of existing options with minimal price

Parameters

float \| string	$amount
SaleableInterface	$saleableItem
null \| bool \| string \| array	$exclude
null \| array	$context

Returns: \Magento\Framework\Pricing\Amount\AmountInterface @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements CalculatorInterface.

Definition at line 97 of file Calculator.php.

     {
         return $this->getOptionsAmount($saleableItem, $exclude, true, $amount);
     }

◆ getAmountWithoutOption()

getAmountWithoutOption	(		$amount,
		Product	$saleableItem
	)

Get base amount without option

Parameters

float	$amount
Product	$saleableItem

Returns: \Magento\Framework\Pricing\Amount\AmountInterface|void

Implements BundleCalculatorInterface.

Definition at line 178 of file Calculator.php.

     {
         return $this->calculateBundleAmount(
             $amount,
             $saleableItem,
             []
         );
     }

◆ getMaxAmount()

getMaxAmount	(		$amount,
		Product	$saleableItem,
			$exclude = `null`
	)

Get amount for current product which is included price of existing options with maximal price

Parameters

float	$amount
Product	$saleableItem
null \| bool \| string \| array	$exclude

Returns: \Magento\Framework\Pricing\Amount\AmountInterface

Implements BundleCalculatorInterface.

Definition at line 123 of file Calculator.php.

     {
         return $this->getOptionsAmount($saleableItem, $exclude, false, $amount);
     }

◆ getMaxRegularAmount()

getMaxRegularAmount	(		$amount,
		Product	$saleableItem,
			$exclude = `null`
	)

Get amount for current product which is included price of existing options with maximal price

Parameters

float	$amount
Product	$saleableItem
null \| bool \| string \| array	$exclude

Returns: \Magento\Framework\Pricing\Amount\AmountInterface

Implements BundleCalculatorInterface.

Definition at line 136 of file Calculator.php.

     {
         return $this->getOptionsAmount($saleableItem, $exclude, false, $amount, true);
     }

◆ getMinRegularAmount()

getMinRegularAmount	(		$amount,
		Product	$saleableItem,
			$exclude = `null`
	)

Get amount for current product which is included price of existing options with maximal price

Parameters

float	$amount
Product	$saleableItem
null \| bool \| string \| array	$exclude

Returns: \Magento\Framework\Pricing\Amount\AmountInterface

Implements BundleCalculatorInterface.

Definition at line 110 of file Calculator.php.

     {
         return $this->getOptionsAmount($saleableItem, $exclude, true, $amount, true);
     }

◆ getOptionsAmount()

getOptionsAmount	(	Product	$saleableItem,
			$exclude = `null`,
			$searchMin = `true`,
			$baseAmount = `0.`,
			$useRegularPrice = `false`
	)

Option amount calculation for bundle product

Parameters

Product	$saleableItem
null \| bool \| string \| array	$exclude
bool	$searchMin
float	$baseAmount
bool	$useRegularPrice

Returns: \Magento\Framework\Pricing\Amount\AmountInterface

Definition at line 151 of file Calculator.php.

       {
         $cacheKey = implode('-', [$saleableItem->getId(), $exclude, $searchMin, $baseAmount, $useRegularPrice]);
         if (!isset($this->optionAmount[$cacheKey])) {
             $this->optionAmount[$cacheKey] = $this->calculateBundleAmount(
                 $baseAmount,
                 $saleableItem,
                 $this->getSelectionAmounts($saleableItem, $searchMin, $useRegularPrice),
                 $exclude
             );
         }
 
         return $this->optionAmount[$cacheKey];
     }

◆ getSelectionAmounts()

getSelectionAmounts	(	Product	$bundleProduct,
			$searchMin,
			$useRegularPrice = `false`
	)

protected

Filter all options for bundle product

Parameters

Product	$bundleProduct
bool	$searchMin
bool	$useRegularPrice

Returns: array

Definition at line 195 of file Calculator.php.

     {
         return $this->getSelectionPriceListProvider()->getPriceList($bundleProduct, $searchMin, $useRegularPrice);
     }

◆ hasRequiredOption()

hasRequiredOption ( $bundleProduct )

protected

Check the bundle product for availability of required options

Parameters

Product $bundleProduct

Returns: bool

Deprecated:: 100.2.0

Definition at line 234 of file Calculator.php.

     {
         $options = array_filter(
             $this->getBundleOptions($bundleProduct),
             function ($item) {
                 return $item->getRequired();
             }
         );
         return !empty($options);
     }

◆ processOptions()

processOptions	(	$option,
		$selectionPriceList,
		$searchMin = `true`
	)

Find minimal or maximal price for existing options

Parameters

\Magento\Bundle\Model\Option	$option

Implements BundleCalculatorInterface.

Definition at line 406 of file Calculator.php.

     {
         $result = [];
         foreach ($selectionPriceList as $current) {
             $qty = $current->getQuantity();
             $currentValue = $current->getAmount()->getValue() * $qty;
             if (empty($result)) {
                 $result = [$current];
             } else {
                 $lastSelectionPrice = end($result);
                 $lastValue = $lastSelectionPrice->getAmount()->getValue() * $lastSelectionPrice->getQuantity();
                 if ($searchMin && $lastValue > $currentValue) {
                     $result = [$current];
                 } elseif (!$searchMin && $option->isMultiSelection()) {
                     $result[] = $current;
                 } elseif (!$searchMin
                     && !$option->isMultiSelection()
                     && $lastValue < $currentValue
                 ) {
                     $result = [$current];
                 }
             }
         }
         return $result;
     }

Field Documentation

◆ $amountFactory

$amountFactory

protected

Definition at line 34 of file Calculator.php.

◆ $calculator

$calculator

protected

Definition at line 29 of file Calculator.php.

◆ $priceCurrency

$priceCurrency

protected

Definition at line 51 of file Calculator.php.

◆ $selectionFactory

$selectionFactory

protected

Definition at line 39 of file Calculator.php.

◆ $taxHelper

$taxHelper

protected

Definition at line 46 of file Calculator.php.

The documentation for this class was generated from the following file:

vendor/magento/module-bundle/Pricing/Adjustment/Calculator.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ calculateBundleAmount()

◆ canSkipOption()

◆ createSelectionPriceList()

◆ getAmount()

◆ getAmountWithoutOption()

◆ getMaxAmount()

◆ getMaxRegularAmount()

◆ getMinRegularAmount()

◆ getOptionsAmount()

◆ getSelectionAmounts()

◆ hasRequiredOption()

◆ processOptions()

Field Documentation

◆ $amountFactory

◆ $calculator

◆ $priceCurrency

◆ $selectionFactory

◆ $taxHelper