Inheritance diagram for Item:

Public Member Functions
	setItemId ($id)

	getItemId ()

	getPrice ()

	setPrice ($price)

	getBasePrice ()

	setBasePrice ($basePrice)

	getQty ()

	setQty ($qty)

	getRowTotal ()

	setRowTotal ($rowTotal)

	getBaseRowTotal ()

	setBaseRowTotal ($baseRowTotal)

	getRowTotalWithDiscount ()

	setRowTotalWithDiscount ($rowTotalWithDiscount)

	getTaxAmount ()

	setTaxAmount ($taxAmount)

	getBaseTaxAmount ()

	setBaseTaxAmount ($baseTaxAmount)

	getTaxPercent ()

	setTaxPercent ($taxPercent)

	getDiscountAmount ()

	setDiscountAmount ($discountAmount)

	getBaseDiscountAmount ()

	setBaseDiscountAmount ($baseDiscountAmount)

	getDiscountPercent ()

	setDiscountPercent ($discountPercent)

	getPriceInclTax ()

	setPriceInclTax ($priceInclTax)

	getBasePriceInclTax ()

	setBasePriceInclTax ($basePriceInclTax)

	getRowTotalInclTax ()

	setRowTotalInclTax ($rowTotalInclTax)

	getBaseRowTotalInclTax ()

	setBaseRowTotalInclTax ($baseRowTotalInclTax)

	getOptions ()

	setOptions ($options)

	getWeeeTaxAppliedAmount ()

	setWeeeTaxAppliedAmount ($weeeTaxAppliedAmount)

	getWeeeTaxApplied ()

	setWeeeTaxApplied ($weeeTaxApplied)

	getName ()

	setName ($name)

	getExtensionAttributes ()

	setExtensionAttributes (\Magento\Quote\Api\Data\TotalsItemExtensionInterface $extensionAttributes)

Public Member Functions inherited from AbstractExtensibleObject
	__construct (\Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $attributeValueFactory, $data=[])

	getCustomAttribute ($attributeCode)

	getCustomAttributes ()

	setCustomAttributes (array $attributes)

Public Member Functions inherited from AbstractSimpleObject
	__construct (array $data=[])

	setData ($key, $value)

	__toArray ()

Public Member Functions inherited from CustomAttributesDataInterface
	setCustomAttribute ($attributeCode, $attributeValue)

Public Member Functions inherited from TotalsItemInterface
	setExtensionAttributes (\Magento\Quote\Api\Data\TotalsItemExtensionInterface $extensionAttributes)

Additional Inherited Members
Data Fields inherited from AbstractExtensibleObject
const	CUSTOM_ATTRIBUTES_KEY = 'custom_attributes'

Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Data Fields inherited from TotalsItemInterface
const	KEY_ITEM_ID = 'item_id'

const	KEY_PRICE = 'price'

const	KEY_BASE_PRICE = 'base_price'

const	KEY_QTY = 'qty'

const	KEY_ROW_TOTAL = 'row_total'

const	KEY_BASE_ROW_TOTAL = 'base_row_total'

const	KEY_ROW_TOTAL_WITH_DISCOUNT = 'row_total_with_discount'

const	KEY_DISCOUNT_AMOUNT = 'discount_amount'

const	KEY_BASE_DISCOUNT_AMOUNT = 'base_discount_amount'

const	KEY_DISCOUNT_PERCENT = 'discount_percent'

const	KEY_TAX_AMOUNT = 'tax_amount'

const	KEY_BASE_TAX_AMOUNT = 'base_tax_amount'

const	KEY_TAX_PERCENT = 'tax_percent'

const	KEY_PRICE_INCL_TAX = 'price_incl_tax'

const	KEY_BASE_PRICE_INCL_TAX = 'base_price_incl_tax'

const	KEY_ROW_TOTAL_INCL_TAX = 'row_total_incl_tax'

const	KEY_BASE_ROW_TOTAL_INCL_TAX = 'base_row_total_incl_tax'

const	KEY_OPTIONS = 'options'

const	KEY_WEEE_TAX_APPLIED_AMOUNT = 'weee_tax_applied_amount'

const	KEY_WEEE_TAX_APPLIED = 'weee_tax_applied'

const	KEY_NAME = 'name'

Protected Member Functions inherited from AbstractExtensibleObject
	getCustomAttributesCodes ()

	_getExtensionAttributes ()

	_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)

Protected Member Functions inherited from AbstractSimpleObject
	_get ($key)

Protected Attributes inherited from AbstractExtensibleObject
	$extensionFactory

	$attributeValueFactory

	$customAttributesCodes

Protected Attributes inherited from AbstractSimpleObject
	$_data

Detailed Description

Cart item totals.

@codeCoverageIgnore

Definition at line 16 of file Item.php.

Member Function Documentation

◆ getBaseDiscountAmount()

getBaseDiscountAmount ( )

Returns the discount amount in base currency.

Returns: float|null Discount amount in base currency. Otherwise, null.

Implements TotalsItemInterface.

Definition at line 254 of file Item.php.

     {
         return $this->_get(self::KEY_BASE_DISCOUNT_AMOUNT);
     }

◆ getBasePrice()

getBasePrice ( )

Returns the item price in base currency.

Returns: float Item price in base currency.

Implements TotalsItemInterface.

Definition at line 65 of file Item.php.

     {
         return $this->_get(self::KEY_BASE_PRICE);
     }

◆ getBasePriceInclTax()

getBasePriceInclTax ( )

Returns the price including tax in base currency.

Returns: float|null Price including tax in base currency. Otherwise, null.

Implements TotalsItemInterface.

Definition at line 317 of file Item.php.

     {
         return $this->_get(self::KEY_BASE_PRICE_INCL_TAX);
     }

◆ getBaseRowTotal()

getBaseRowTotal ( )

Returns the row total in base currency.

Returns: float Row total in base currency.

Implements TotalsItemInterface.

Definition at line 128 of file Item.php.

     {
         return $this->_get(self::KEY_BASE_ROW_TOTAL);
     }

◆ getBaseRowTotalInclTax()

getBaseRowTotalInclTax ( )

Returns the row total including tax in base currency.

Returns: float|null Row total including tax in base currency. Otherwise, null.

Implements TotalsItemInterface.

Definition at line 359 of file Item.php.

     {
         return $this->_get(self::KEY_BASE_ROW_TOTAL_INCL_TAX);
     }

◆ getBaseTaxAmount()

getBaseTaxAmount ( )

Returns the tax amount in base currency.

Returns: float|null Tax amount in base currency. Otherwise, null.

Implements TotalsItemInterface.

Definition at line 191 of file Item.php.

     {
         return $this->_get(self::KEY_BASE_TAX_AMOUNT);
     }

◆ getDiscountAmount()

getDiscountAmount ( )

Returns the discount amount in quote currency.

Returns: float|null Discount amount in quote currency. Otherwise, null.

Implements TotalsItemInterface.

Definition at line 233 of file Item.php.

     {
         return $this->_get(self::KEY_DISCOUNT_AMOUNT);
     }

◆ getDiscountPercent()

getDiscountPercent ( )

Returns the discount percent.

Returns: int|null Discount percent. Otherwise, null.

Implements TotalsItemInterface.

Definition at line 275 of file Item.php.

     {
         return $this->_get(self::KEY_DISCOUNT_PERCENT);
     }

◆ getExtensionAttributes()

getExtensionAttributes ( )

{Retrieve existing extension attributes object or create a new one.

Returns: \Magento\Quote\Api\Data\TotalsItemExtensionInterface|null

}

Returns: \Magento\Quote\Api\Data\TotalsItemExtensionInterface|null

Implements TotalsItemInterface.

Definition at line 459 of file Item.php.

     {
         return $this->_getExtensionAttributes();
     }

◆ getItemId()

getItemId ( )

Get totals item id

Returns: int Item id

Implements TotalsItemInterface.

Definition at line 34 of file Item.php.

     {
         return $this->_get(self::KEY_ITEM_ID);
     }

◆ getName()

getName ( )

{Returns the product name.

Returns: string|null Product name. Otherwise, null.

}

Implements TotalsItemInterface.

Definition at line 441 of file Item.php.

     {
         return $this->_get(self::KEY_NAME);
     }

◆ getOptions()

getOptions ( )

Returns the item options data.

Returns: string[] Item price in quote currency.

Implements TotalsItemInterface.

Definition at line 380 of file Item.php.

     {
         return $this->_get(self::KEY_OPTIONS);
     }

◆ getPrice()

getPrice ( )

Returns the item price in quote currency.

Returns: float Item price in quote currency.

Implements TotalsItemInterface.

Definition at line 44 of file Item.php.

     {
         return $this->_get(self::KEY_PRICE);
     }

◆ getPriceInclTax()

getPriceInclTax ( )

Returns the price including tax in quote currency.

Returns: float|null Price including tax in quote currency. Otherwise, null.

Implements TotalsItemInterface.

Definition at line 296 of file Item.php.

     {
         return $this->_get(self::KEY_PRICE_INCL_TAX);
     }

◆ getQty()

getQty ( )

Returns the item quantity.

Returns: int Item quantity.

Implements TotalsItemInterface.

Definition at line 86 of file Item.php.

     {
         return $this->_get(self::KEY_QTY);
     }

◆ getRowTotal()

getRowTotal ( )

Returns the row total in quote currency.

Returns: float Row total in quote currency.

Implements TotalsItemInterface.

Definition at line 107 of file Item.php.

     {
         return $this->_get(self::KEY_ROW_TOTAL);
     }

◆ getRowTotalInclTax()

getRowTotalInclTax ( )

Returns the row total including tax in quote currency.

Returns: float|null Row total including tax in quote currency. Otherwise, null.

Implements TotalsItemInterface.

Definition at line 338 of file Item.php.

     {
         return $this->_get(self::KEY_ROW_TOTAL_INCL_TAX);
     }

◆ getRowTotalWithDiscount()

getRowTotalWithDiscount ( )

Returns the row total with discount in quote currency.

Returns: float|null Row total with discount in quote currency. Otherwise, null.

Implements TotalsItemInterface.

Definition at line 149 of file Item.php.

     {
         return $this->_get(self::KEY_ROW_TOTAL_WITH_DISCOUNT);
     }

◆ getTaxAmount()

getTaxAmount ( )

Returns the tax amount in quote currency.

Returns: float|null Tax amount in quote currency. Otherwise, null.

Implements TotalsItemInterface.

Definition at line 170 of file Item.php.

     {
         return $this->_get(self::KEY_TAX_AMOUNT);
     }

◆ getTaxPercent()

getTaxPercent ( )

Returns the tax percent.

Returns: int|null Tax percent. Otherwise, null.

Implements TotalsItemInterface.

Definition at line 212 of file Item.php.

     {
         return $this->_get(self::KEY_TAX_PERCENT);
     }

◆ getWeeeTaxApplied()

getWeeeTaxApplied ( )

Returns the item weee tax applied in quote currency.

Returns: string[] Item weee tax applied in quote currency.

Implements TotalsItemInterface.

Definition at line 422 of file Item.php.

     {
         return $this->_get(self::KEY_WEEE_TAX_APPLIED);
     }

◆ getWeeeTaxAppliedAmount()

getWeeeTaxAppliedAmount ( )

Returns the item weee tax applied amount in quote currency.

Returns: float Item weee tax applied amount in quote currency.

Implements TotalsItemInterface.

Definition at line 401 of file Item.php.

     {
         return $this->_get(self::KEY_WEEE_TAX_APPLIED_AMOUNT);
     }

◆ setBaseDiscountAmount()

setBaseDiscountAmount ( $baseDiscountAmount )

Sets the discount amount in base currency.

Parameters

float $baseDiscountAmount

Returns: $this

Implements TotalsItemInterface.

Definition at line 265 of file Item.php.

     {
         return $this->setData(self::KEY_BASE_DISCOUNT_AMOUNT, $baseDiscountAmount);
     }

◆ setBasePrice()

setBasePrice ( $basePrice )

Sets the item price in base currency.

Parameters

float $basePrice

Returns: $this

Implements TotalsItemInterface.

Definition at line 76 of file Item.php.

     {
         return $this->setData(self::KEY_BASE_PRICE, $basePrice);
     }

◆ setBasePriceInclTax()

setBasePriceInclTax ( $basePriceInclTax )

Sets the price including tax in base currency.

Parameters

float $basePriceInclTax

Returns: $this

Implements TotalsItemInterface.

Definition at line 328 of file Item.php.

     {
         return $this->setData(self::KEY_BASE_PRICE_INCL_TAX, $basePriceInclTax);
     }

◆ setBaseRowTotal()

setBaseRowTotal ( $baseRowTotal )

Sets the row total in base currency.

Parameters

float $baseRowTotal

Returns: $this

Implements TotalsItemInterface.

Definition at line 139 of file Item.php.

     {
         return $this->setData(self::KEY_BASE_ROW_TOTAL, $baseRowTotal);
     }

◆ setBaseRowTotalInclTax()

setBaseRowTotalInclTax ( $baseRowTotalInclTax )

Sets the row total including tax in base currency.

Parameters

float $baseRowTotalInclTax

Returns: $this

Implements TotalsItemInterface.

Definition at line 370 of file Item.php.

     {
         return $this->setData(self::KEY_BASE_ROW_TOTAL_INCL_TAX, $baseRowTotalInclTax);
     }

◆ setBaseTaxAmount()

setBaseTaxAmount ( $baseTaxAmount )

Sets the tax amount in base currency.

Parameters

float $baseTaxAmount

Returns: $this

Implements TotalsItemInterface.

Definition at line 202 of file Item.php.

     {
         return $this->setData(self::KEY_BASE_TAX_AMOUNT, $baseTaxAmount);
     }

◆ setDiscountAmount()

setDiscountAmount ( $discountAmount )

Sets the discount amount in quote currency.

Parameters

float $discountAmount

Returns: $this

Implements TotalsItemInterface.

Definition at line 244 of file Item.php.

     {
         return $this->setData(self::KEY_DISCOUNT_AMOUNT, $discountAmount);
     }

◆ setDiscountPercent()

setDiscountPercent ( $discountPercent )

Sets the discount percent.

Parameters

int $discountPercent

Returns: $this

Implements TotalsItemInterface.

Definition at line 286 of file Item.php.

     {
         return $this->setData(self::KEY_DISCOUNT_PERCENT, $discountPercent);
     }

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Quote\Api\Data\TotalsItemExtensionInterface $extensionAttributes )

{}

Parameters

\Magento\Quote\Api\Data\TotalsItemExtensionInterface $extensionAttributes

Returns: $this

Definition at line 470 of file Item.php.

     {
         return $this->_setExtensionAttributes($extensionAttributes);
     }

◆ setItemId()

setItemId ( $id )

Set totals item id

Parameters

int $id

Returns: $this

Implements TotalsItemInterface.

Definition at line 24 of file Item.php.

     {
         return $this->setData(self::KEY_ITEM_ID, $id);
     }

◆ setName()

setName ( $name )

{Sets the product name.

Parameters

string $name

Returns: $this

}

Implements TotalsItemInterface.

Definition at line 449 of file Item.php.

     {
         return $this->setData(self::KEY_NAME, $name);
     }

◆ setOptions()

setOptions ( $options )

Sets the item options data.

Parameters

string $options

Returns: $this

Implements TotalsItemInterface.

Definition at line 391 of file Item.php.

     {
         return $this->setData(self::KEY_OPTIONS, $options);
     }

◆ setPrice()

setPrice ( $price )

Sets the item price in quote currency.

Parameters

float $price

Returns: $this

Implements TotalsItemInterface.

Definition at line 55 of file Item.php.

     {
         return $this->setData(self::KEY_PRICE, $price);
     }

◆ setPriceInclTax()

setPriceInclTax ( $priceInclTax )

Sets the price including tax in quote currency.

Parameters

float $priceInclTax

Returns: $this

Implements TotalsItemInterface.

Definition at line 307 of file Item.php.

     {
         return $this->setData(self::KEY_PRICE_INCL_TAX, $priceInclTax);
     }

◆ setQty()

setQty ( $qty )

Sets the item quantity.

Parameters

int $qty

Returns: $this

Implements TotalsItemInterface.

Definition at line 97 of file Item.php.

     {
         return $this->setData(self::KEY_QTY, $qty);
     }

◆ setRowTotal()

setRowTotal ( $rowTotal )

Sets the row total in quote currency.

Parameters

float $rowTotal

Returns: $this

Implements TotalsItemInterface.

Definition at line 118 of file Item.php.

     {
         return $this->setData(self::KEY_ROW_TOTAL, $rowTotal);
     }

◆ setRowTotalInclTax()

setRowTotalInclTax ( $rowTotalInclTax )

Sets the row total including tax in quote currency.

Parameters

float $rowTotalInclTax

Returns: $this

Implements TotalsItemInterface.

Definition at line 349 of file Item.php.

     {
         return $this->setData(self::KEY_ROW_TOTAL_INCL_TAX, $rowTotalInclTax);
     }

◆ setRowTotalWithDiscount()

setRowTotalWithDiscount ( $rowTotalWithDiscount )

Sets the row total with discount in quote currency.

Parameters

float $rowTotalWithDiscount

Returns: $this

Implements TotalsItemInterface.

Definition at line 160 of file Item.php.

     {
         return $this->setData(self::KEY_ROW_TOTAL_WITH_DISCOUNT, $rowTotalWithDiscount);
     }

◆ setTaxAmount()

setTaxAmount ( $taxAmount )

Sets the tax amount in quote currency.

Parameters

float $taxAmount

Returns: $this

Implements TotalsItemInterface.

Definition at line 181 of file Item.php.

     {
         return $this->setData(self::KEY_TAX_AMOUNT, $taxAmount);
     }

◆ setTaxPercent()

setTaxPercent ( $taxPercent )

Sets the tax percent.

Parameters

int $taxPercent

Returns: $this

Implements TotalsItemInterface.

Definition at line 223 of file Item.php.

     {
         return $this->setData(self::KEY_TAX_PERCENT, $taxPercent);
     }

◆ setWeeeTaxApplied()

setWeeeTaxApplied ( $weeeTaxApplied )

Sets the item weee tax applied in quote currency.

Parameters

string $weeeTaxApplied

Returns: $this

Implements TotalsItemInterface.

Definition at line 433 of file Item.php.

     {
         return $this->setData(self::KEY_WEEE_TAX_APPLIED, $weeeTaxApplied);
     }

◆ setWeeeTaxAppliedAmount()

setWeeeTaxAppliedAmount ( $weeeTaxAppliedAmount )

Sets the item weee tax applied amount in quote currency.

Parameters

float $weeeTaxAppliedAmount

Returns: $this

Implements TotalsItemInterface.

Definition at line 412 of file Item.php.

     {
         return $this->setData(self::KEY_WEEE_TAX_APPLIED_AMOUNT, $weeeTaxAppliedAmount);
     }

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

vendor/magento/module-quote/Model/Cart/Totals/Item.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getBaseDiscountAmount()

◆ getBasePrice()

◆ getBasePriceInclTax()

◆ getBaseRowTotal()

◆ getBaseRowTotalInclTax()

◆ getBaseTaxAmount()

◆ getDiscountAmount()

◆ getDiscountPercent()

◆ getExtensionAttributes()

◆ getItemId()

◆ getName()

◆ getOptions()

◆ getPrice()

◆ getPriceInclTax()

◆ getQty()

◆ getRowTotal()

◆ getRowTotalInclTax()

◆ getRowTotalWithDiscount()

◆ getTaxAmount()

◆ getTaxPercent()

◆ getWeeeTaxApplied()

◆ getWeeeTaxAppliedAmount()

◆ setBaseDiscountAmount()

◆ setBasePrice()

◆ setBasePriceInclTax()

◆ setBaseRowTotal()

◆ setBaseRowTotalInclTax()

◆ setBaseTaxAmount()

◆ setDiscountAmount()

◆ setDiscountPercent()

◆ setExtensionAttributes()

◆ setItemId()

◆ setName()

◆ setOptions()

◆ setPrice()

◆ setPriceInclTax()

◆ setQty()

◆ setRowTotal()

◆ setRowTotalInclTax()

◆ setRowTotalWithDiscount()

◆ setTaxAmount()

◆ setTaxPercent()

◆ setWeeeTaxApplied()

◆ setWeeeTaxAppliedAmount()