SpecialPrice Class Reference

Inheritance diagram for SpecialPrice:

Public Member Functions
	__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 ()

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

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

Detailed Description

Special price model

Definition at line 18 of file SpecialPrice.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Product	$saleableItem,
			$quantity,
		CalculatorInterface	$calculator,
		\Magento\Framework\Pricing\PriceCurrencyInterface	$priceCurrency,
		TimezoneInterface	$localeDate
	)

Parameters

Product	$saleableItem
float	$quantity
CalculatorInterface	$calculator
\Magento\Framework\Pricing\PriceCurrencyInterface	$priceCurrency
TimezoneInterface	$localeDate

Definition at line 37 of file SpecialPrice.php.

      {
        parent::__construct($saleableItem, $quantity, $calculator, $priceCurrency);
        $this->localeDate = $localeDate;
    }

Member Function Documentation

getSpecialFromDate()

getSpecialFromDate

(

)

Returns starting date of the special price

Returns

mixed

Implements SpecialPriceInterface.

Definition at line 83 of file SpecialPrice.php.

    {
        return $this->product->getSpecialFromDate();
    }

getSpecialPrice()

getSpecialPrice

(

)

Returns special price

Returns

float

Implements SpecialPriceInterface.

Definition at line 69 of file SpecialPrice.php.

    {
        $specialPrice = $this->product->getSpecialPrice();
        if ($specialPrice !== null && $specialPrice !== false && !$this->isPercentageDiscount()) {
            $specialPrice = $this->priceCurrency->convertAndRound($specialPrice);
        }
        return $specialPrice;
    }

getSpecialToDate()

getSpecialToDate

(

)

Returns end date of the special price

Returns

mixed

Implements SpecialPriceInterface.

Definition at line 93 of file SpecialPrice.php.

    {
        return $this->product->getSpecialToDate();
    }

getValue()

getValue

(

)

Returns

bool|float

Implements PriceInterface.

Definition at line 51 of file SpecialPrice.php.

    {
        if (null === $this->value) {
            $this->value = false;
            $specialPrice = $this->getSpecialPrice();
            if ($specialPrice !== null && $specialPrice !== false && $this->isScopeDateInInterval()) {
                $this->value = (float) $specialPrice;
            }
        }

        return $this->value;
    }

isPercentageDiscount()

isPercentageDiscount

(

)

Returns

bool

Implements SpecialPriceInterface.

Definition at line 113 of file SpecialPrice.php.

    {
        return false;
    }

isScopeDateInInterval()

isScopeDateInInterval

(

)

Returns

bool

Implements SpecialPriceInterface.

Definition at line 101 of file SpecialPrice.php.

    {
        return $this->localeDate->isScopeDateInInterval(
            $this->product->getStore(),
            $this->getSpecialFromDate(),
            $this->getSpecialToDate()
        );
    }

Field Documentation

$localeDate

$localeDate

protected

Definition at line 28 of file SpecialPrice.php.

PRICE_CODE

const PRICE_CODE = 'special_price'

Price type special

Definition at line 23 of file SpecialPrice.php.

---

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

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