TierPrice Class Reference

Inheritance diagram for TierPrice:

Public Member Functions
	__construct (Product $saleableItem, $quantity, CalculatorInterface $calculator, \Magento\Framework\Pricing\PriceCurrencyInterface $priceCurrency, Session $customerSession, GroupManagementInterface $groupManagement, CustomerGroupRetrieverInterface $customerGroupRetriever=null)
	getValue ()
	getTierPriceCount ()
	getTierPriceList ()
	getSavePercent (AmountInterface $amount)
	isPercentageDiscount ()
Public Member Functions inherited from AbstractPrice
	__construct (SaleableInterface $saleableItem, $quantity, CalculatorInterface $calculator, \Magento\Framework\Pricing\PriceCurrencyInterface $priceCurrency)
	getValue ()
	getAmount ()
	getCustomAmount ($amount=null, $exclude=null, $context=[])
	getPriceCode ()
	getProduct ()
	getQuantity ()

Data Fields
const	PRICE_CODE = 'tier_price'
Data Fields inherited from AbstractPrice
const	PRICE_CODE = 'abstract_price'

Protected Member Functions
	isFirstPriceBetter ($firstPrice, $secondPrice)
	filterTierPrices (array $priceList)
	applyAdjustment ($price)
	canApplyTierPrice (array $currentTierPrice, $prevPriceGroup, $prevQty)

Protected Attributes
	$customerSession
	$customerGroup
	$rawPriceList
	$priceList
	$groupManagement
Protected Attributes inherited from AbstractPrice
	$amount
	$calculator
	$product
	$priceType
	$quantity
	$priceInfo
	$value
	$priceCurrency

Detailed Description

@api

Since

100.0.2

Definition at line 23 of file TierPrice.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Product	$saleableItem,
			$quantity,
		CalculatorInterface	$calculator,
		\Magento\Framework\Pricing\PriceCurrencyInterface	$priceCurrency,
		Session	$customerSession,
		GroupManagementInterface	$groupManagement,
		CustomerGroupRetrieverInterface	$customerGroupRetriever = null
	)

Parameters

Product	$saleableItem
float	$quantity
CalculatorInterface	$calculator
\Magento\Framework\Pricing\PriceCurrencyInterface	$priceCurrency
Session	$customerSession
GroupManagementInterface	$groupManagement
CustomerGroupRetrieverInterface | null	$customerGroupRetriever

Definition at line 74 of file TierPrice.php.

      {
        $quantity = (float)$quantity ? $quantity : 1;
        parent::__construct($saleableItem, $quantity, $calculator, $priceCurrency);
        $this->customerSession = $customerSession;
        $this->groupManagement = $groupManagement;
        $this->customerGroupRetriever = $customerGroupRetriever
            ?? \Magento\Framework\App\ObjectManager::getInstance()->get(CustomerGroupRetrieverInterface::class);
        if ($saleableItem->hasCustomerGroupId()) {
            $this->customerGroup = (int) $saleableItem->getCustomerGroupId();
        } else {
            $this->customerGroup = (int) $this->customerGroupRetriever->getCustomerGroupId();
        }
    }

Member Function Documentation

applyAdjustment()

applyAdjustment (   $price )

protected

Parameters

float | string

$price

Returns

\Magento\Framework\Pricing\Amount\AmountInterface

Definition at line 238 of file TierPrice.php.

    {
        return $this->calculator->getAmount($price, $this->product);
    }

canApplyTierPrice()

canApplyTierPrice ( array  $currentTierPrice,   $prevPriceGroup,   $prevQty  )

protected

Can apply tier price

Parameters

array	$currentTierPrice
int	$prevPriceGroup
float | string	$prevQty

Returns

bool

Definition at line 251 of file TierPrice.php.

    {
        $custGroupAllId = (int)$this->groupManagement->getAllCustomersGroup()->getId();
        // Tier price can be applied, if:
        // tier price is for current customer group or is for all groups
        if ((int)$currentTierPrice['cust_group'] !== $this->customerGroup
            && (int)$currentTierPrice['cust_group'] !== $custGroupAllId
        ) {
            return false;
        }
        // and tier qty is lower than product qty
        if ($this->quantity < $currentTierPrice['price_qty']) {
            return false;
        }
        // and tier qty is bigger than previous qty
        if ($currentTierPrice['price_qty'] < $prevQty) {
            return false;
        }
        // and found tier qty is same as previous tier qty, but current tier group isn't ALL_GROUPS
        if ($currentTierPrice['price_qty'] == $prevQty
            && $prevPriceGroup !== $custGroupAllId
            && $currentTierPrice['cust_group'] === $custGroupAllId
        ) {
            return false;
        }
        return true;
    }

filterTierPrices()

filterTierPrices ( array  $priceList )

protected

Parameters

array

$priceList

Returns

array

Definition at line 170 of file TierPrice.php.

    {
        $qtyCache = [];
        $allCustomersGroupId = $this->groupManagement->getAllCustomersGroup()->getId();
        foreach ($priceList as $priceKey => &$price) {
            if ($price['price'] >= $this->priceInfo->getPrice(FinalPrice::PRICE_CODE)->getValue()) {
                unset($priceList[$priceKey]);
                continue;
            }

            if (isset($price['price_qty']) && $price['price_qty'] == 1) {
                unset($priceList[$priceKey]);
                continue;
            }
            /* filter price by customer group */
            if ($price['cust_group'] != $this->customerGroup &&
                $price['cust_group'] != $allCustomersGroupId) {
                unset($priceList[$priceKey]);
                continue;
            }
            /* select a lower price for each quantity */
            if (isset($qtyCache[$price['price_qty']])) {
                $priceQty = $qtyCache[$price['price_qty']];
                if ($this->isFirstPriceBetter($price['website_price'], $priceList[$priceQty]['website_price'])) {
                    unset($priceList[$priceQty]);
                    $qtyCache[$price['price_qty']] = $priceKey;
                } else {
                    unset($priceList[$priceKey]);
                }
            } else {
                $qtyCache[$price['price_qty']] = $priceKey;
            }
        }
        return array_values($priceList);
    }

getSavePercent()

getSavePercent

(

AmountInterface

$amount

)

Calculates savings percentage according to the given tier price amount and related product price amount.

Parameters

AmountInterface

$amount

Returns

float

Definition at line 223 of file TierPrice.php.

    {
        $productPriceAmount = $this->priceInfo->getPrice(
            FinalPrice::PRICE_CODE
        )->getAmount();

        return round(
            100 - ((100 / $productPriceAmount->getValue()) * $amount->getValue())
        );
    }

getTierPriceCount()

getTierPriceCount

(

)

Returns

int

Implements TierPriceInterface.

Definition at line 141 of file TierPrice.php.

    {
        return count($this->getTierPriceList());
    }

getTierPriceList()

getTierPriceList

(

)

Returns

array

Implements TierPriceInterface.

Definition at line 149 of file TierPrice.php.

    {
        if (null === $this->priceList) {
            $priceList = $this->getStoredTierPrices();
            $this->priceList = $this->filterTierPrices($priceList);
            array_walk(
                $this->priceList,
                function (&$priceData) {
                    /* convert string value to float */
                    $priceData['price_qty'] = $priceData['price_qty'] * 1;
                    $priceData['price'] = $this->applyAdjustment($priceData['price']);
                }
            );
        }
        return $this->priceList;
    }

getValue()

getValue

(

)

Get price value

Returns

bool|float

Implements PriceInterface.

Definition at line 101 of file TierPrice.php.

    {
        if (null === $this->value) {
            $prices = $this->getStoredTierPrices();
            $prevQty = PriceInfoInterface::PRODUCT_QUANTITY_DEFAULT;
            $this->value = $prevPrice = $tierPrice = false;
            $priceGroup = $this->groupManagement->getAllCustomersGroup()->getId();

            foreach ($prices as $price) {
                if (!$this->canApplyTierPrice($price, $priceGroup, $prevQty)) {
                    continue;
                }
                if (false === $prevPrice || $this->isFirstPriceBetter($price['website_price'], $prevPrice)) {
                    $tierPrice = $prevPrice = $price['website_price'];
                    $prevQty = $price['price_qty'];
                    $priceGroup = $price['cust_group'];
                    $this->value = (float)$tierPrice;
                }
            }
        }
        return $this->value;
    }

isFirstPriceBetter()

isFirstPriceBetter (   $firstPrice,   $secondPrice  )

protected

Returns true if first price is better

Method filters tiers price values, lower tier price value is better

Parameters

float	$firstPrice
float	$secondPrice

Returns

bool

Definition at line 133 of file TierPrice.php.

    {
        return $firstPrice < $secondPrice;
    }

isPercentageDiscount()

isPercentageDiscount

(

)

Returns

bool

Implements TierPriceInterface.

Definition at line 319 of file TierPrice.php.

    {
        return false;
    }

Field Documentation

$customerGroup

$customerGroup

protected

Definition at line 39 of file TierPrice.php.

$customerSession

$customerSession

protected

Definition at line 34 of file TierPrice.php.

$groupManagement

$groupManagement

protected

Definition at line 58 of file TierPrice.php.

$priceList

$priceList

protected

Definition at line 53 of file TierPrice.php.

$rawPriceList

$rawPriceList

protected

Definition at line 46 of file TierPrice.php.

PRICE_CODE

const PRICE_CODE = 'tier_price'

Price type tier

Definition at line 28 of file TierPrice.php.

---

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

• vendor/magento/module-catalog/Pricing/Price/TierPrice.php