Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Weee\Model\Tax $weeeTax, \Magento\Weee\Model\Config $weeeConfig, \Magento\Tax\Helper\Data $taxData, \Magento\Framework\Registry $coreRegistry, \Magento\Framework\Serialize\Serializer\Json $serializer=null)
	getPriceDisplayType ($store=null)
	getListPriceDisplayType ($store=null)
	getSalesPriceDisplayType ($store=null)
	getEmailPriceDisplayType ($store=null)
	isTaxable ($store=null)
	includeInSubtotal ($store=null)
	isEnabled ($store=null)
	displayTotalsInclTax ($store=null)
	typeOfDisplay ( $compareTo=null, $zone=\Magento\Framework\Pricing\Render::ZONE_DEFAULT, $store=null)
	getProductWeeeAttributes ( $product, $shipping=null, $billing=null, $website=null, $calculateTaxes=false, $round=true)
	getWeeeTaxAppliedAmount ($item)
	getWeeeTaxAppliedRowAmount ($item)
	getBaseWeeeTaxAppliedRowAmount ($item)
	getApplied ($item)
	setApplied ($item, $value)
	getWeeeTaxInclTax ($item)
	getBaseWeeeTaxInclTax ($item)
	getRowWeeeTaxInclTax ($item)
	getBaseRowWeeeTaxInclTax ($item)
	getTotalTaxAppliedForWeeeTax ($item)
	getBaseTotalTaxAppliedForWeeeTax ($item)
	getWeeeAmountInvoiced ($orderItem)
	getBaseWeeeAmountInvoiced ($orderItem)
	getWeeeTaxAmountInvoiced ($orderItem)
	getBaseWeeeTaxAmountInvoiced ($orderItem)
	getWeeeAmountRefunded ($orderItem)
	getBaseWeeeAmountRefunded ($orderItem)
	getWeeeTaxAmountRefunded ($orderItem)
	getBaseWeeeTaxAmountRefunded ($orderItem)
	getTotalAmounts ($items, $store=null)
	getBaseTotalAmounts ($items, $store=null)
	isDisplayIncl ($storeId=null)
	isDisplayInclDesc ($storeId=null)
	isDisplayExclDescIncl ($storeId=null)
	isDisplayExcl ($storeId=null)
	getTaxDisplayConfig ($store=null)
	getWeeeAttributesForBundle ($product)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	KEY_WEEE_AMOUNT_INVOICED = 'weee_amount_invoiced'
const	KEY_BASE_WEEE_AMOUNT_INVOICED = 'base_weee_amount_invoiced'
const	KEY_WEEE_TAX_AMOUNT_INVOICED = 'weee_tax_amount_invoiced'
const	KEY_BASE_WEEE_TAX_AMOUNT_INVOICED = 'base_weee_tax_amount_invoiced'
const	KEY_WEEE_AMOUNT_REFUNDED = 'weee_amount_refunded'
const	KEY_BASE_WEEE_AMOUNT_REFUNDED = 'base_weee_amount_refunded'
const	KEY_WEEE_TAX_AMOUNT_REFUNDED = 'weee_tax_amount_refunded'
const	KEY_BASE_WEEE_TAX_AMOUNT_REFUNDED = 'base_weee_tax_amount_refunded'

Protected Member Functions
	getRecursiveNumericAmount ($item, $functionName)
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Protected Attributes
	$_storeDisplayConfig = []
	$_coreRegistry
	$_taxData
	$_weeeTax
	$_weeeConfig
	$_storeManager
	$cacheProductWeeeAmount = '_cache_product_weee_amount'
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Detailed Description

WEEE data helper

@SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since

100.0.2

Definition at line 22 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Weee\Model\Tax	$weeeTax,
		\Magento\Weee\Model\Config	$weeeConfig,
		\Magento\Tax\Helper\Data	$taxData,
		\Magento\Framework\Registry	$coreRegistry,
		\Magento\Framework\Serialize\Serializer\Json	$serializer = null
	)

Data constructor.

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Weee\Model\Tax	$weeeTax
\Magento\Weee\Model\Config	$weeeConfig
\Magento\Tax\Helper\Data	$taxData
\Magento\Framework\Registry	$coreRegistry
\Magento\Framework\Serialize\Serializer\Json | null	$serializer

Exceptions

Definition at line 99 of file Data.php.

      {
        $this->_storeManager = $storeManager;
        $this->_weeeTax = $weeeTax;
        $this->_coreRegistry = $coreRegistry;
        $this->_taxData = $taxData;
        $this->_weeeConfig = $weeeConfig;
        $this->serializer = $serializer ?: \Magento\Framework\App\ObjectManager::getInstance()
            ->get(\Magento\Framework\Serialize\Serializer\Json::class);
        parent::__construct($context);
    }

Member Function Documentation

displayTotalsInclTax()

displayTotalsInclTax

(

$store = null

)

Check if the FPT totals line(s) should be displayed with tax included

Parameters

null | string | bool | int | Store

$store

Returns

bool

Definition at line 201 of file Data.php.

    {
        // If catalog prices include tax, then display FPT totals with tax included
        return $this->_taxData->priceIncludesTax($store);
    }

getApplied()

getApplied

(

$item

)

Returns applied weee taxes

Parameters

QuoteAbstractItem

$item

Returns

array

Definition at line 385 of file Data.php.

    {
        if ($item instanceof QuoteAbstractItem) {
            if ($item->getHasChildren() && $item->isChildrenCalculated()) {
                $result = [];
                foreach ($item->getChildren() as $child) {
                    $childData = $this->getApplied($child);
                    if (is_array($childData)) {
                        $result = array_merge($result, $childData);
                    }
                }
                return $result;
            }
        }

        // if order item data is old enough then weee_tax_applied might not be valid
        $data = $item->getWeeeTaxApplied();
        if (empty($data)) {
            return [];
        }
        return $this->serializer->unserialize($item->getWeeeTaxApplied());
    }

getBaseRowWeeeTaxInclTax()

getBaseRowWeeeTaxInclTax

(

$item

)

Get the total base weee including tax by row

Parameters

QuoteAbstractItem

$item

Returns

float

Definition at line 529 of file Data.php.

    {
        $weeeTaxAppliedAmounts = $this->getApplied($item);
        $totalWeeeTaxIncTaxApplied = 0;
        foreach ($weeeTaxAppliedAmounts as $weeeTaxAppliedAmount) {
            $totalWeeeTaxIncTaxApplied += max($weeeTaxAppliedAmount['base_row_amount_incl_tax'], 0);
        }
        return $totalWeeeTaxIncTaxApplied;
    }

getBaseTotalAmounts()

getBaseTotalAmounts	(		$items,
			$store = null
	)

Returns the base total amount of FPT across all items. Used for displaying the FPT totals line item.

Parameters

	QuoteAbstractItem[]	$items
null | string | bool | int | Store	$store

Returns

float

Since

100.1.0

Definition at line 744 of file Data.php.

    {
        $baseWeeeTotal = 0;
        $displayTotalsInclTax = $this->displayTotalsInclTax($store);
        foreach ($items as $item) {
            if ($displayTotalsInclTax) {
                $baseWeeeTotal += $this->getBaseRowWeeeTaxInclTax($item);
            } else {
                $baseWeeeTotal += $item->getBaseWeeeTaxAppliedRowAmnt();
            }
        }
        return $baseWeeeTotal;
    }

getBaseTotalTaxAppliedForWeeeTax()

getBaseTotalTaxAppliedForWeeeTax

(

$item

)

Get the total tax applied on weee by unit

Parameters

QuoteAbstractItem

$item

Returns

float

Definition at line 565 of file Data.php.

    {
        $weeeTaxAppliedAmounts = $this->getApplied($item);
        $totalTaxForWeeeTax = 0;
        foreach ($weeeTaxAppliedAmounts as $weeeTaxAppliedAmount) {
            $totalTaxForWeeeTax += max(
                $weeeTaxAppliedAmount['base_amount_incl_tax']
                - $weeeTaxAppliedAmount['base_amount'],
                0
            );
        }
        return $totalTaxForWeeeTax;
    }

getBaseWeeeAmountInvoiced()

getBaseWeeeAmountInvoiced

(

$orderItem

)

Parameters

OrderItem

$orderItem

Returns

float

Definition at line 600 of file Data.php.

    {
        $weeeTaxAppliedAmounts = $this->getApplied($orderItem);
        $baseTotalAmountInvoiced = 0;
        foreach ($weeeTaxAppliedAmounts as $weeeTaxAppliedAmount) {
            if (isset($weeeTaxAppliedAmount[self::KEY_BASE_WEEE_AMOUNT_INVOICED])) {
                $baseTotalAmountInvoiced = $weeeTaxAppliedAmount[self::KEY_BASE_WEEE_AMOUNT_INVOICED];
                break;
            }
        }
        return $baseTotalAmountInvoiced;
    }

getBaseWeeeAmountRefunded()

getBaseWeeeAmountRefunded

(

$orderItem

)

Parameters

OrderItem

$orderItem

Returns

float

Definition at line 668 of file Data.php.

    {
        $weeeTaxAppliedAmounts = $this->getApplied($orderItem);
        $baseTotalAmountRefunded = 0;
        foreach ($weeeTaxAppliedAmounts as $weeeTaxAppliedAmount) {
            if (isset($weeeTaxAppliedAmount[self::KEY_BASE_WEEE_AMOUNT_REFUNDED])) {
                $baseTotalAmountRefunded = $weeeTaxAppliedAmount[self::KEY_BASE_WEEE_AMOUNT_REFUNDED];
                break;
            }
        }
        return $baseTotalAmountRefunded;
    }

getBaseWeeeTaxAmountInvoiced()

getBaseWeeeTaxAmountInvoiced

(

$orderItem

)

Parameters

OrderItem

$orderItem

Returns

float

Definition at line 634 of file Data.php.

    {
        $weeeTaxAppliedAmounts = $this->getApplied($orderItem);
        $baseTotalTaxInvoiced = 0;
        foreach ($weeeTaxAppliedAmounts as $weeeTaxAppliedAmount) {
            if (isset($weeeTaxAppliedAmount[self::KEY_BASE_WEEE_TAX_AMOUNT_INVOICED])) {
                $baseTotalTaxInvoiced = $weeeTaxAppliedAmount[self::KEY_BASE_WEEE_TAX_AMOUNT_INVOICED];
                break;
            }
        }
        return $baseTotalTaxInvoiced;
    }

getBaseWeeeTaxAmountRefunded()

getBaseWeeeTaxAmountRefunded

(

$orderItem

)

Parameters

OrderItem

$orderItem

Returns

float

Definition at line 702 of file Data.php.

    {
        $weeeTaxAppliedAmounts = $this->getApplied($orderItem);
        $baseTotalTaxRefunded = 0;
        foreach ($weeeTaxAppliedAmounts as $weeeTaxAppliedAmount) {
            if (isset($weeeTaxAppliedAmount[self::KEY_BASE_WEEE_TAX_AMOUNT_REFUNDED])) {
                $baseTotalTaxRefunded = $weeeTaxAppliedAmount[self::KEY_BASE_WEEE_TAX_AMOUNT_REFUNDED];
                break;
            }
        }
        return $baseTotalTaxRefunded;
    }

getBaseWeeeTaxAppliedRowAmount()

getBaseWeeeTaxAppliedRowAmount

(

$item

)

Returns applied base weee tax amount for the row

Parameters

QuoteAbstractItem | OrderItem

$item

Returns

float

Since

100.2.0

Definition at line 343 of file Data.php.

    {
        return $this->getRecursiveNumericAmount($item, 'getBaseWeeeTaxAppliedRowAmnt');
    }

getBaseWeeeTaxInclTax()

getBaseWeeeTaxInclTax

(

$item

)

Get the total base weee tax

Parameters

QuoteAbstractItem

$item

Returns

float

Definition at line 497 of file Data.php.

    {
        $weeeTaxAppliedAmounts = $this->getApplied($item);
        $totalBaseWeeeTaxIncTaxApplied = 0;
        foreach ($weeeTaxAppliedAmounts as $weeeTaxAppliedAmount) {
            $totalBaseWeeeTaxIncTaxApplied += max($weeeTaxAppliedAmount['base_amount_incl_tax'], 0);
        }
        return $totalBaseWeeeTaxIncTaxApplied;
    }

getEmailPriceDisplayType()

getEmailPriceDisplayType

(

$store = null

)

Get weee amount display type in email templates

Parameters

null | string | bool | int | Store

$store

Returns

int

Definition at line 157 of file Data.php.

    {
        return $this->_weeeConfig->getEmailPriceDisplayType($store);
    }

getListPriceDisplayType()

getListPriceDisplayType

(

$store = null

)

Get weee amount display type on product list page

Parameters

null | string | bool | int | Store

$store

Returns

int

Definition at line 135 of file Data.php.

    {
        return $this->_weeeConfig->getListPriceDisplayType($store);
    }

getPriceDisplayType()

getPriceDisplayType

(

$store = null

)

Get weee amount display type on product view page

Parameters

null | string | bool | int | Store

$store

Returns

int

Definition at line 124 of file Data.php.

    {
        return $this->_weeeConfig->getPriceDisplayType($store);
    }

getProductWeeeAttributes()

getProductWeeeAttributes	(		$product,
			$shipping = null,
			$billing = null,
			$website = null,
			$calculateTaxes = false,
			$round = true
	)

Proxy for \Magento\Weee\Model\Tax::getProductWeeeAttributes()

Parameters

\Magento\Catalog\Model\Product	$product
null | false | \Magento\Framework\DataObject	$shipping
null | false | \Magento\Framework\DataObject	$billing
Website	$website
bool	$calculateTaxes
bool	$round

Returns

\Magento\Framework\DataObject[]

Definition at line 296 of file Data.php.

      {
        return $this->_weeeTax->getProductWeeeAttributes(
            $product,
            $shipping,
            $billing,
            $website,
            $calculateTaxes,
            $round
        );
    }

getRecursiveNumericAmount()

getRecursiveNumericAmount (   $item,   $functionName  )

protected

Returns accumulated amounts for the item

Parameters

QuoteAbstractItem | OrderItem	$item
string	$functionName

Returns

float

Definition at line 355 of file Data.php.

    {
        if ($item instanceof QuoteAbstractItem || $item instanceof OrderItem) {
            if ($item->getHasChildren() && $item->isChildrenCalculated()) {
                $result = 0;
                $children = $item instanceof OrderItem ? $item->getChildrenItems() : $item->getChildren();
                foreach ($children as $child) {
                    $childData = $this->getRecursiveNumericAmount($child, $functionName);
                    if (!empty($childData)) {
                        $result += $childData;
                    }
                }

                return $result;
            }
        }

        $data = $item->$functionName();
        if (empty($data)) {
            return 0;
        }
        return $data;
    }

getRowWeeeTaxInclTax()

getRowWeeeTaxInclTax

(

$item

)

Get the total weee including tax by row

Parameters

QuoteAbstractItem

$item

Returns

float

Definition at line 513 of file Data.php.

    {
        $weeeTaxAppliedAmounts = $this->getApplied($item);
        $totalWeeeTaxIncTaxApplied = 0;
        foreach ($weeeTaxAppliedAmounts as $weeeTaxAppliedAmount) {
            $totalWeeeTaxIncTaxApplied += max($weeeTaxAppliedAmount['row_amount_incl_tax'], 0);
        }
        return $totalWeeeTaxIncTaxApplied;
    }

getSalesPriceDisplayType()

getSalesPriceDisplayType

(

$store = null

)

Get weee amount display type in sales modules

Parameters

null | string | bool | int | Store

$store

Returns

int

Definition at line 146 of file Data.php.

    {
        return $this->_weeeConfig->getSalesPriceDisplayType($store);
    }

getTaxDisplayConfig()

getTaxDisplayConfig

(

$store = null

)

Get tax price display settings

Parameters

null | string | bool | int | Store

$store

Returns

int

Definition at line 824 of file Data.php.

    {
        return $this->_taxData->getPriceDisplayType($store);
    }

getTotalAmounts()

getTotalAmounts	(		$items,
			$store = null
	)

Returns the total amount of FPT across all items. Used for displaying the FPT totals line item.

Parameters

	QuoteAbstractItem[]	$items
null | string | bool | int | Store	$store

Returns

float

Definition at line 722 of file Data.php.

    {
        $weeeTotal = 0;
        $displayTotalsInclTax = $this->displayTotalsInclTax($store);
        foreach ($items as $item) {
            if ($displayTotalsInclTax) {
                $weeeTotal += $this->getRowWeeeTaxInclTax($item);
            } else {
                $weeeTotal += $item->getWeeeTaxAppliedRowAmount();
            }
        }
        return $weeeTotal;
    }

getTotalTaxAppliedForWeeeTax()

getTotalTaxAppliedForWeeeTax

(

$item

)

Get the total tax applied on weee by unit

Parameters

QuoteAbstractItem

$item

Returns

float

Definition at line 545 of file Data.php.

    {
        $weeeTaxAppliedAmounts = $this->getApplied($item);
        $totalTaxForWeeeTax = 0;
        foreach ($weeeTaxAppliedAmounts as $weeeTaxAppliedAmount) {
            $totalTaxForWeeeTax += max(
                $weeeTaxAppliedAmount['amount_incl_tax']
                - $weeeTaxAppliedAmount['amount'],
                0
            );
        }
        return $totalTaxForWeeeTax;
    }

getWeeeAmountInvoiced()

getWeeeAmountInvoiced

(

$orderItem

)

Parameters

OrderItem

$orderItem

Returns

float

Definition at line 583 of file Data.php.

    {
        $weeeTaxAppliedAmounts = $this->getApplied($orderItem);
        $totalAmountInvoiced = 0;
        foreach ($weeeTaxAppliedAmounts as $weeeTaxAppliedAmount) {
            if (isset($weeeTaxAppliedAmount[self::KEY_WEEE_AMOUNT_INVOICED])) {
                $totalAmountInvoiced = $weeeTaxAppliedAmount[self::KEY_WEEE_AMOUNT_INVOICED];
                break;
            }
        }
        return $totalAmountInvoiced;
    }

getWeeeAmountRefunded()

getWeeeAmountRefunded

(

$orderItem

)

Parameters

OrderItem

$orderItem

Returns

float

Definition at line 651 of file Data.php.

    {
        $weeeTaxAppliedAmounts = $this->getApplied($orderItem);
        $totalAmountRefunded = 0;
        foreach ($weeeTaxAppliedAmounts as $weeeTaxAppliedAmount) {
            if (isset($weeeTaxAppliedAmount[self::KEY_WEEE_AMOUNT_REFUNDED])) {
                $totalAmountRefunded = $weeeTaxAppliedAmount[self::KEY_WEEE_AMOUNT_REFUNDED];
                break;
            }
        }
        return $totalAmountRefunded;
    }

getWeeeAttributesForBundle()

getWeeeAttributesForBundle

(

$product

)

Return an array of FPT attributes for a bundle product

Parameters

\Magento\Catalog\Model\Product

$product

Returns

array

Definition at line 835 of file Data.php.

    {
        if ($product->getTypeId() == \Magento\Catalog\Model\Product\Type::TYPE_BUNDLE) {
            $typeInstance = $product->getTypeInstance();
            $typeInstance->setStoreFilter($product->getStoreId(), $product);

            $selectionCollection = $typeInstance->getSelectionsCollection(
                $typeInstance->getOptionsIds($product),
                $product
            );
            $insertedWeeeCodesArray = [];
            foreach ($selectionCollection as $selectionItem) {
                $weeeAttributes = $this->getProductWeeeAttributes(
                    $selectionItem,
                    null,
                    null,
                    $product->getStore()->getWebsiteId(),
                    true,
                    false
                );
                $priceTaxDisplay = $this->getTaxDisplayConfig();
                $priceIncludesTax = $this->displayTotalsInclTax();
                foreach ($weeeAttributes as $weeeAttribute) {
                    if ($priceTaxDisplay == \Magento\Tax\Model\Config::DISPLAY_TYPE_INCLUDING_TAX ||
                        $priceTaxDisplay == \Magento\Tax\Model\Config::DISPLAY_TYPE_BOTH) {
                        if ($priceIncludesTax == false) {
                            $weeeAttribute['amount'] = $weeeAttribute['amount_excl_tax'] + $weeeAttribute['tax_amount'];
                        }
                    } elseif ($priceTaxDisplay == \Magento\Tax\Model\Config::DISPLAY_TYPE_EXCLUDING_TAX) {
                        if ($priceIncludesTax == true) {
                            $weeeAttribute['amount'] = $weeeAttribute['amount_excl_tax'];
                        }
                    }
                    $insertedWeeeCodesArray[$selectionItem->getId()][$weeeAttribute->getCode()] = $weeeAttribute;
                }
            }
            return $insertedWeeeCodesArray;
        }
        return [];
    }

getWeeeTaxAmountInvoiced()

getWeeeTaxAmountInvoiced

(

$orderItem

)

Parameters

OrderItem

$orderItem

Returns

float

Definition at line 617 of file Data.php.

    {
        $weeeTaxAppliedAmounts = $this->getApplied($orderItem);
        $totalTaxInvoiced = 0;
        foreach ($weeeTaxAppliedAmounts as $weeeTaxAppliedAmount) {
            if (isset($weeeTaxAppliedAmount[self::KEY_WEEE_TAX_AMOUNT_INVOICED])) {
                $totalTaxInvoiced = $weeeTaxAppliedAmount[self::KEY_WEEE_TAX_AMOUNT_INVOICED];
                break;
            }
        }
        return $totalTaxInvoiced;
    }

getWeeeTaxAmountRefunded()

getWeeeTaxAmountRefunded

(

$orderItem

)

Parameters

OrderItem

$orderItem

Returns

float

Definition at line 685 of file Data.php.

    {
        $weeeTaxAppliedAmounts = $this->getApplied($orderItem);
        $totalTaxRefunded = 0;
        foreach ($weeeTaxAppliedAmounts as $weeeTaxAppliedAmount) {
            if (isset($weeeTaxAppliedAmount[self::KEY_WEEE_TAX_AMOUNT_REFUNDED])) {
                $totalTaxRefunded = $weeeTaxAppliedAmount[self::KEY_WEEE_TAX_AMOUNT_REFUNDED];
                break;
            }
        }
        return $totalTaxRefunded;
    }

getWeeeTaxAppliedAmount()

getWeeeTaxAppliedAmount

(

$item

)

Returns applied weee tax amount

Parameters

QuoteAbstractItem

$item

Returns

float

Definition at line 320 of file Data.php.

    {
        return $this->getRecursiveNumericAmount($item, 'getWeeeTaxAppliedAmount');
    }

getWeeeTaxAppliedRowAmount()

getWeeeTaxAppliedRowAmount

(

$item

)

Returns applied weee tax amount for the row

Parameters

QuoteAbstractItem

$item

Returns

float

Definition at line 331 of file Data.php.

    {
        return $this->getRecursiveNumericAmount($item, 'getWeeeTaxAppliedRowAmount');
    }

getWeeeTaxInclTax()

getWeeeTaxInclTax

(

$item

)

Get the weee tax including tax

Parameters

QuoteAbstractItem

$item

Returns

float

Definition at line 481 of file Data.php.

    {
        $weeeTaxAppliedAmounts = $this->getApplied($item);
        $totalWeeeTaxIncTaxApplied = 0;
        foreach ($weeeTaxAppliedAmounts as $weeeTaxAppliedAmount) {
            $totalWeeeTaxIncTaxApplied += max($weeeTaxAppliedAmount['amount_incl_tax'], 0);
        }
        return $totalWeeeTaxIncTaxApplied;
    }

includeInSubtotal()

includeInSubtotal

(

$store = null

)

Check if weee tax amount should be included to subtotal

Parameters

null | string | bool | int | Store

$store

Returns

bool

Definition at line 179 of file Data.php.

    {
        return $this->_weeeConfig->includeInSubtotal($store);
    }

isDisplayExcl()

isDisplayExcl

(

$storeId = null

)

Get FPT DISPLAY_EXCL setting

Parameters

int | null

$storeId

Returns

bool

Definition at line 809 of file Data.php.

    {
        return $this->typeOfDisplay(
            WeeeDisplayConfig::DISPLAY_EXCL,
            \Magento\Framework\Pricing\Render::ZONE_ITEM_VIEW,
            $storeId
        );
    }

isDisplayExclDescIncl()

isDisplayExclDescIncl

(

$storeId = null

)

Get FPT DISPLAY_EXCL_DESCR_INCL setting

Parameters

int | null

$storeId

Returns

bool

Definition at line 794 of file Data.php.

    {
        return $this->typeOfDisplay(
            WeeeDisplayConfig::DISPLAY_EXCL_DESCR_INCL,
            \Magento\Framework\Pricing\Render::ZONE_ITEM_VIEW,
            $storeId
        );
    }

isDisplayIncl()

isDisplayIncl

(

$storeId = null

)

Get FPT DISPLAY_INCL setting

Parameters

int | null

$storeId

Returns

bool

Definition at line 764 of file Data.php.

    {
        return $this->typeOfDisplay(
            WeeeDisplayConfig::DISPLAY_INCL,
            \Magento\Framework\Pricing\Render::ZONE_ITEM_VIEW,
            $storeId
        );
    }

isDisplayInclDesc()

isDisplayInclDesc

(

$storeId = null

)

Get FPT DISPLAY_INCL_DESCR setting

Parameters

int | null

$storeId

Returns

bool

Definition at line 779 of file Data.php.

    {
        return $this->typeOfDisplay(
            WeeeDisplayConfig::DISPLAY_INCL_DESCR,
            \Magento\Framework\Pricing\Render::ZONE_ITEM_VIEW,
            $storeId
        );
    }

isEnabled()

isEnabled

(

$store = null

)

Check if fixed taxes are used in system

Parameters

null | string | bool | int | Store

$store

Returns

bool

Definition at line 190 of file Data.php.

    {
        return $this->_weeeConfig->isEnabled($store);
    }

isTaxable()

isTaxable

(

$store = null

)

Check if weee tax amount should be taxable

Parameters

null | string | bool | int | Store

$store

Returns

bool

Definition at line 168 of file Data.php.

    {
        return $this->_weeeConfig->isTaxable($store);
    }

setApplied()

setApplied	(		$item,
			$value
	)

Sets applied weee taxes

Parameters

QuoteAbstractItem	$item
array	$value

Returns

$this

Definition at line 415 of file Data.php.

    {
        $item->setWeeeTaxApplied($this->serializer->serialize($value));
        return $this;
    }

typeOfDisplay()

typeOfDisplay	(		$compareTo = null,
			$zone = \Magento\Framework\Pricing\Render::ZONE_DEFAULT,
			$store = null
	)

Returns display type for price accordingly to current zone

Parameters

	int|int[]|null	$compareTo
string	$zone
Store | int | string	$store

Returns

bool|int @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 243 of file Data.php.

      {
        if (!$this->isEnabled($store)) {
            return false;
        }
        switch ($zone) {
            case \Magento\Framework\Pricing\Render::ZONE_ITEM_VIEW:
                $type = $this->getPriceDisplayType($store);
                break;
            case \Magento\Framework\Pricing\Render::ZONE_ITEM_LIST:
                $type = $this->getListPriceDisplayType($store);
                break;
            case \Magento\Framework\Pricing\Render::ZONE_SALES:
            case \Magento\Framework\Pricing\Render::ZONE_CART:
                $type = $this->getSalesPriceDisplayType($store);
                break;
            case \Magento\Framework\Pricing\Render::ZONE_EMAIL:
                $type = $this->getEmailPriceDisplayType($store);
                break;
            default:
                if ($this->_coreRegistry->registry('current_product')) {
                    $type = $this->getPriceDisplayType($store);
                } else {
                    $type = $this->getListPriceDisplayType($store);
                }
                break;
        }

        if ($compareTo === null) {
            return $type;
        } else {
            if (is_array($compareTo)) {
                return in_array($type, $compareTo);
            } else {
                return $type == $compareTo;
            }
        }
    }

Field Documentation

$_coreRegistry

$_coreRegistry

protected

Definition at line 53 of file Data.php.

$_storeDisplayConfig

$_storeDisplayConfig = []

protected

#- #-

Definition at line 46 of file Data.php.

$_storeManager

$_storeManager

protected

Definition at line 75 of file Data.php.

$_taxData

$_taxData

protected

Definition at line 60 of file Data.php.

$_weeeConfig

$_weeeConfig

protected

Definition at line 70 of file Data.php.

$_weeeTax

$_weeeTax

protected

Definition at line 65 of file Data.php.

$cacheProductWeeeAmount

$cacheProductWeeeAmount = '_cache_product_weee_amount'

protected

Definition at line 80 of file Data.php.

KEY_BASE_WEEE_AMOUNT_INVOICED

const KEY_BASE_WEEE_AMOUNT_INVOICED = 'base_weee_amount_invoiced'

Definition at line 29 of file Data.php.

KEY_BASE_WEEE_AMOUNT_REFUNDED

const KEY_BASE_WEEE_AMOUNT_REFUNDED = 'base_weee_amount_refunded'

Definition at line 37 of file Data.php.

KEY_BASE_WEEE_TAX_AMOUNT_INVOICED

const KEY_BASE_WEEE_TAX_AMOUNT_INVOICED = 'base_weee_tax_amount_invoiced'

Definition at line 33 of file Data.php.

KEY_BASE_WEEE_TAX_AMOUNT_REFUNDED

const KEY_BASE_WEEE_TAX_AMOUNT_REFUNDED = 'base_weee_tax_amount_refunded'

Definition at line 41 of file Data.php.

KEY_WEEE_AMOUNT_INVOICED

const KEY_WEEE_AMOUNT_INVOICED = 'weee_amount_invoiced'

#+ Constants defined for keys of array, makes typos less likely

Definition at line 27 of file Data.php.

KEY_WEEE_AMOUNT_REFUNDED

const KEY_WEEE_AMOUNT_REFUNDED = 'weee_amount_refunded'

Definition at line 35 of file Data.php.

KEY_WEEE_TAX_AMOUNT_INVOICED

const KEY_WEEE_TAX_AMOUNT_INVOICED = 'weee_tax_amount_invoiced'

Definition at line 31 of file Data.php.

KEY_WEEE_TAX_AMOUNT_REFUNDED

const KEY_WEEE_TAX_AMOUNT_REFUNDED = 'weee_tax_amount_refunded'

Definition at line 39 of file Data.php.

---

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

• vendor/magento/module-weee/Helper/Data.php