Weee Class Reference

Inheritance diagram for Weee:

Public Member Functions
	__construct (\Magento\Weee\Helper\Data $weeeData, PriceCurrencyInterface $priceCurrency)
	collect (\Magento\Quote\Model\Quote $quote, \Magento\Quote\Api\Data\ShippingAssignmentInterface $shippingAssignment, \Magento\Quote\Model\Quote\Address\Total $total)
	fetch (\Magento\Quote\Model\Quote $quote, \Magento\Quote\Model\Quote\Address\Total $total)
	processConfigArray ($config, $store)
	getLabel ()
Public Member Functions inherited from AbstractTotal
	setCode ($code)
	getCode ()
	getLabel ()
	collect (\Magento\Quote\Model\Quote $quote, \Magento\Quote\Api\Data\ShippingAssignmentInterface $shippingAssignment, \Magento\Quote\Model\Quote\Address\Total $total)
	fetch (\Magento\Quote\Model\Quote $quote, \Magento\Quote\Model\Quote\Address\Total $total)
	_setTotal (\Magento\Quote\Model\Quote\Address\Total $total)
	getItemRowTotal (\Magento\Quote\Model\Quote\Item\AbstractItem $item)
	getItemBaseRowTotal (\Magento\Quote\Model\Quote\Item\AbstractItem $item)
	getIsItemRowTotalCompoundable (\Magento\Quote\Model\Quote\Item\AbstractItem $item)
	processConfigArray ($config, $store)

Data Fields
const	ITEM_CODE_WEEE_PREFIX = 'weee'
const	ITEM_TYPE = 'weee'

Protected Member Functions
	process (\Magento\Quote\Model\Quote\Address $address, \Magento\Quote\Model\Quote\Address\Total $total, $item)
	processTotalAmount ( $total, $rowValueExclTax, $baseRowValueExclTax, $rowValueInclTax, $baseRowValueInclTax)
	getNextIncrement ()
	recalculateParent (\Magento\Quote\Model\Quote\Item\AbstractItem $item)
	resetItemData ($item)
Protected Member Functions inherited from AbstractTotal
	_setAddress (\Magento\Quote\Model\Quote\Address $address)
	_getAddress ()
	_getTotal ()
	_setAmount ($amount)
	_setBaseAmount ($baseAmount)
	_addAmount ($amount)
	_addBaseAmount ($baseAmount)
	_getAddressItems (\Magento\Quote\Model\Quote\Address $address)

Protected Attributes
	$weeeData
	$_store
	$counter = 0
	$weeeCodeToItemMap
	$weeeTotalExclTax
	$weeeBaseTotalExclTax
	$priceCurrency
Protected Attributes inherited from AbstractTotal
	$_code
	$_address = null
	$_canAddAmountToAddress = true
	$_canSetAddressAmount = true
	$_itemRowTotalKey = null
	$total

Detailed Description

Definition at line 14 of file Weee.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Weee\Helper\Data	$weeeData,
		PriceCurrencyInterface	$priceCurrency
	)

Parameters

\Magento\Weee\Helper\Data	$weeeData
PriceCurrencyInterface	$priceCurrency

Definition at line 72 of file Weee.php.

      {
        $this->priceCurrency = $priceCurrency;
        $this->weeeData = $weeeData;
        $this->setCode('weee');
        $this->weeeCodeToItemMap = [];
    }

Member Function Documentation

collect()

collect	(	\Magento\Quote\Model\Quote	$quote,
		\Magento\Quote\Api\Data\ShippingAssignmentInterface	$shippingAssignment,
		\Magento\Quote\Model\Quote\Address\Total	$total
	)

Collect Weee amounts for the quote / order

Parameters

\Magento\Quote\Model\Quote	$quote
\Magento\Quote\Api\Data\ShippingAssignmentInterface	$shippingAssignment
\Magento\Quote\Model\Quote\Address\Total	$total

Returns

$this

Definition at line 90 of file Weee.php.

      {
        AbstractTotal::collect($quote, $shippingAssignment, $total);
        $this->_store = $quote->getStore();
        if (!$this->weeeData->isEnabled($this->_store)) {
            return $this;
        }

        $address = $shippingAssignment->getShipping()->getAddress();
        $items = $shippingAssignment->getItems();
        if (!count($items)) {
            return $this;
        }

        $this->weeeTotalExclTax = 0;
        $this->weeeBaseTotalExclTax = 0;
        foreach ($items as $item) {
            if ($item->getParentItem()) {
                continue;
            }
            $this->resetItemData($item);
            if ($item->getHasChildren() && $item->isChildrenCalculated()) {
                foreach ($item->getChildren() as $child) {
                    $this->resetItemData($child);
                    $this->process($address, $total, $child);
                }
                $this->recalculateParent($item);
            } else {
                $this->process($address, $total, $item);
            }
        }
        $total->setWeeeCodeToItemMap($this->weeeCodeToItemMap);
        $total->setWeeeTotalExclTax($this->weeeTotalExclTax);
        $total->setWeeeBaseTotalExclTax($this->weeeBaseTotalExclTax);
        return $this;
    }

fetch()

fetch	(	\Magento\Quote\Model\Quote	$quote,
		\Magento\Quote\Model\Quote\Address\Total	$total
	)

Parameters

\Magento\Quote\Model\Quote	$quote
\Magento\Quote\Model\Quote\Address\Total	$total

Returns

array|null @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 340 of file Weee.php.

    {
        return null;
    }

getLabel()

getLabel

(

)

No aggregated label for fixed product tax

TODO: fix

Returns

string

Definition at line 366 of file Weee.php.

    {
        return '';
    }

getNextIncrement()

getNextIncrement ( )

protected

Increment and return counter. This function is intended to be used to generate temporary id for an item.

Returns

int

Definition at line 287 of file Weee.php.

    {
        return ++$this->counter;
    }

process()

process ( \Magento\Quote\Model\Quote\Address  $address, \Magento\Quote\Model\Quote\Address\Total  $total,   $item  )

protected

Calculate item fixed tax and prepare information for discount and regular taxation

Parameters

\Magento\Quote\Model\Quote\Address	$address
\Magento\Quote\Model\Quote\Address\Total	$total
\Magento\Quote\Model\Quote\Item\AbstractItem	$item

Returns

void|$this @SuppressWarnings(PHPMD.ExcessiveMethodLength) @SuppressWarnings(PHPMD.UnusedLocalVariable)

Definition at line 140 of file Weee.php.

      {
        $attributes = $this->weeeData->getProductWeeeAttributes(
            $item->getProduct(),
            $address,
            $address->getQuote()->getBillingAddress(),
            $this->_store->getWebsiteId()
        );

        $productTaxes = [];

        $totalValueInclTax = 0;
        $baseTotalValueInclTax = 0;
        $totalRowValueInclTax = 0;
        $baseTotalRowValueInclTax = 0;

        $totalValueExclTax = 0;
        $baseTotalValueExclTax = 0;
        $totalRowValueExclTax = 0;
        $baseTotalRowValueExclTax = 0;

        $associatedTaxables = $item->getAssociatedTaxables();
        if (!$associatedTaxables) {
            $associatedTaxables = [];
        } else {
            // remove existing weee associated taxables
            foreach ($associatedTaxables as $iTaxable => $taxable) {
                if ($taxable[CommonTaxCollector::KEY_ASSOCIATED_TAXABLE_TYPE] == self::ITEM_TYPE) {
                    unset($associatedTaxables[$iTaxable]);
                }
            }
        }

        foreach ($attributes as $key => $attribute) {
            $title = $attribute->getName();

            $baseValueExclTax = $baseValueInclTax = $attribute->getAmount();
            $valueExclTax = $valueInclTax = $this->priceCurrency->round(
                $this->priceCurrency->convert($baseValueExclTax, $this->_store)
            );

            $rowValueInclTax = $rowValueExclTax = $this->priceCurrency->round($valueInclTax * $item->getTotalQty());
            $baseRowValueInclTax = $this->priceCurrency->round($baseValueInclTax * $item->getTotalQty());
            $baseRowValueExclTax = $baseRowValueInclTax;

            $totalValueInclTax += $valueInclTax;
            $baseTotalValueInclTax += $baseValueInclTax;
            $totalRowValueInclTax += $rowValueInclTax;
            $baseTotalRowValueInclTax += $baseRowValueInclTax;

            $totalValueExclTax += $valueExclTax;
            $baseTotalValueExclTax += $baseValueExclTax;
            $totalRowValueExclTax += $rowValueExclTax;
            $baseTotalRowValueExclTax += $baseRowValueExclTax;

            $productTaxes[] = [
                'title' => $title,
                'base_amount' => $baseValueExclTax,
                'amount' => $valueExclTax,
                'row_amount' => $rowValueExclTax,
                'base_row_amount' => $baseRowValueExclTax,
                'base_amount_incl_tax' => $baseValueInclTax,
                'amount_incl_tax' => $valueInclTax,
                'row_amount_incl_tax' => $rowValueInclTax,
                'base_row_amount_incl_tax' => $baseRowValueInclTax,
            ];

            if ($this->weeeData->isTaxable($this->_store)) {
                $weeeItemCode = self::ITEM_CODE_WEEE_PREFIX . $this->getNextIncrement();
                $weeeItemCode .= '-' . $title;

                $associatedTaxables[] = [
                    CommonTaxCollector::KEY_ASSOCIATED_TAXABLE_TYPE => self::ITEM_TYPE,
                    CommonTaxCollector::KEY_ASSOCIATED_TAXABLE_CODE => $weeeItemCode,
                    CommonTaxCollector::KEY_ASSOCIATED_TAXABLE_UNIT_PRICE => $valueExclTax,
                    CommonTaxCollector::KEY_ASSOCIATED_TAXABLE_BASE_UNIT_PRICE => $baseValueExclTax,
                    CommonTaxCollector::KEY_ASSOCIATED_TAXABLE_QUANTITY => $item->getTotalQty(),
                    CommonTaxCollector::KEY_ASSOCIATED_TAXABLE_TAX_CLASS_ID => $item->getProduct()->getTaxClassId(),
                ];
                $this->weeeCodeToItemMap[$weeeItemCode] = $item;
            }
        }
        $item->setAssociatedTaxables($associatedTaxables);

        $item->setWeeeTaxAppliedAmount($totalValueExclTax)
            ->setBaseWeeeTaxAppliedAmount($baseTotalValueExclTax)
            ->setWeeeTaxAppliedRowAmount($totalRowValueExclTax)
            ->setBaseWeeeTaxAppliedRowAmnt($baseTotalRowValueExclTax);

        $item->setWeeeTaxAppliedAmountInclTax($totalValueInclTax)
            ->setBaseWeeeTaxAppliedAmountInclTax($baseTotalValueInclTax)
            ->setWeeeTaxAppliedRowAmountInclTax($totalRowValueInclTax)
            ->setBaseWeeeTaxAppliedRowAmntInclTax($baseTotalRowValueInclTax);

        $this->processTotalAmount(
            $total,
            $totalRowValueExclTax,
            $baseTotalRowValueExclTax,
            $totalRowValueInclTax,
            $baseTotalRowValueInclTax
        );

        $this->weeeData->setApplied($item, array_merge($this->weeeData->getApplied($item), $productTaxes));
    }

processConfigArray()

processConfigArray	(		$config,
			$store
	)

Process model configuration array. This method can be used for changing totals collect sort order

Parameters

array	$config
Store	$store

Returns

array

@SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 355 of file Weee.php.

    {
        return $config;
    }

processTotalAmount()

processTotalAmount (   $total,   $rowValueExclTax,   $baseRowValueExclTax,   $rowValueInclTax,   $baseRowValueInclTax  )

protected

Process row amount based on FPT total amount configuration setting

Parameters

\Magento\Quote\Model\Quote\Address\Total	$total
float	$rowValueExclTax
float	$baseRowValueExclTax
float	$rowValueInclTax
float	$baseRowValueInclTax

Returns

$this

Definition at line 258 of file Weee.php.

      {
        if (!$this->weeeData->isTaxable($this->_store)) {
            //Accumulate the values.  Will be used later in the 'weee tax' collector
            $this->weeeTotalExclTax += $this->priceCurrency->round($rowValueExclTax);
            $this->weeeBaseTotalExclTax += $this->priceCurrency->round($baseRowValueExclTax);
        }

        //This value is used to calculate shipping cost; it will be overridden by tax collector
        $total->setSubtotalInclTax(
            $total->getSubtotalInclTax() + $this->priceCurrency->round($rowValueInclTax)
        );
        $total->setBaseSubtotalInclTax(
            $total->getBaseSubtotalInclTax() + $this->priceCurrency->round($baseRowValueInclTax)
        );
        return $this;
    }

recalculateParent()

recalculateParent ( \Magento\Quote\Model\Quote\Item\AbstractItem  $item )

protected

Recalculate parent item amounts based on children results

Parameters

\Magento\Quote\Model\Quote\Item\AbstractItem

$item

Returns

void

@SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 300 of file Weee.php.

    {
        $associatedTaxables = [];
        foreach ($item->getChildren() as $child) {
            $associatedTaxables = array_merge($associatedTaxables, $child->getAssociatedTaxables());
        }
        $item->setAssociatedTaxables($associatedTaxables);
    }

resetItemData()

resetItemData (   $item )

protected

Reset information about Tax and Wee on FPT for shopping cart item

Parameters

\Magento\Quote\Model\Quote\Item\AbstractItem

$item

Returns

void

Definition at line 315 of file Weee.php.

    {
        $this->weeeData->setApplied($item, []);

        $item->setAssociatedTaxables([]);

        $item->setBaseWeeeTaxDisposition(0);
        $item->setWeeeTaxDisposition(0);

        $item->setBaseWeeeTaxRowDisposition(0);
        $item->setWeeeTaxRowDisposition(0);

        $item->setBaseWeeeTaxAppliedAmount(0);
        $item->setBaseWeeeTaxAppliedRowAmnt(0);

        $item->setWeeeTaxAppliedAmount(0);
        $item->setWeeeTaxAppliedRowAmount(0);
    }

Field Documentation

$_store

$_store

protected

Definition at line 33 of file Weee.php.

$counter

$counter = 0

protected

Definition at line 40 of file Weee.php.

$priceCurrency

$priceCurrency

protected

Definition at line 66 of file Weee.php.

$weeeBaseTotalExclTax

$weeeBaseTotalExclTax

protected

Definition at line 61 of file Weee.php.

$weeeCodeToItemMap

$weeeCodeToItemMap

protected

Definition at line 47 of file Weee.php.

$weeeData

$weeeData

protected

Definition at line 28 of file Weee.php.

$weeeTotalExclTax

$weeeTotalExclTax

protected

Definition at line 54 of file Weee.php.

ITEM_CODE_WEEE_PREFIX

const ITEM_CODE_WEEE_PREFIX = 'weee'

Constant for weee item code prefix

Definition at line 19 of file Weee.php.

ITEM_TYPE

const ITEM_TYPE = 'weee'

Constant for weee item type

Definition at line 23 of file Weee.php.

---

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

• vendor/magento/module-weee/Model/Total/Quote/Weee.php