SpecialPrice Class Reference

Inheritance diagram for SpecialPrice:

Public Member Functions
	getDiscountPercent ()
	getValue ()
	isPercentageDiscount ()
Public Member Functions inherited from SpecialPrice
	__construct (Product $saleableItem, $quantity, CalculatorInterface $calculator, \Magento\Framework\Pricing\PriceCurrencyInterface $priceCurrency, TimezoneInterface $localeDate)
	getValue ()
	getSpecialPrice ()
	getSpecialFromDate ()
	getSpecialToDate ()
	isScopeDateInInterval ()
	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 ()

Protected Member Functions
	getRegularPrice ()

Protected Attributes
	$percent
Protected Attributes inherited from SpecialPrice
	$localeDate
Protected Attributes inherited from AbstractPrice
	$amount
	$calculator
	$product
	$priceType
	$quantity
	$priceInfo
	$value
	$priceCurrency

Additional Inherited Members
Data Fields inherited from SpecialPrice
const	PRICE_CODE = 'special_price'
Data Fields inherited from AbstractPrice
const	PRICE_CODE = 'abstract_price'

Detailed Description

Special price model

Definition at line 14 of file SpecialPrice.php.

Member Function Documentation

getDiscountPercent()

getDiscountPercent

(

)

Returns discount percent

Returns

bool|float

Implements DiscountProviderInterface.

Definition at line 26 of file SpecialPrice.php.

    {
        if ($this->percent === null) {
            $this->percent = parent::getValue();
        }
        return $this->percent;
    }

getRegularPrice()

getRegularPrice ( )

protected

Returns regular price

Returns

bool|float

Definition at line 60 of file SpecialPrice.php.

    {
        return $this->priceInfo->getPrice(RegularPrice::PRICE_CODE)->getValue();
    }

getValue()

getValue

(

)

Returns price value

Returns

bool|float

Implements PriceInterface.

Definition at line 39 of file SpecialPrice.php.

    {
        if ($this->value !== null) {
            return $this->value;
        }

        $specialPrice = $this->getDiscountPercent();
        if ($specialPrice) {
            $regularPrice = $this->getRegularPrice();
            $this->value = $regularPrice * ($specialPrice / 100);
        } else {
            $this->value = false;
        }
        return $this->value;
    }

isPercentageDiscount()

isPercentageDiscount

(

)

Returns

bool

Implements SpecialPriceInterface.

Definition at line 68 of file SpecialPrice.php.

    {
        return true;
    }

Field Documentation

$percent

$percent

protected

Definition at line 19 of file SpecialPrice.php.

---

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

• vendor/magento/module-bundle/Pricing/Price/SpecialPrice.php