Inheritance diagram for TotalsItemInterface:

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)

	getExtensionAttributes ()

	getName ()

	setName ($name)

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

Data Fields
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'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Detailed Description

Interface TotalsItemInterface @api

Since: 100.0.2

Definition at line 13 of file TotalsItemInterface.php.

Member Function Documentation

◆ getBaseDiscountAmount()

getBaseDiscountAmount ( )

Returns the discount amount in base currency.

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

Implemented in Item.

◆ getBasePrice()

getBasePrice ( )

Returns the item price in base currency.

Returns: float Item price in base currency.

Implemented in Item.

◆ getBasePriceInclTax()

getBasePriceInclTax ( )

Returns the price including tax in base currency.

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

Implemented in Item.

◆ getBaseRowTotal()

getBaseRowTotal ( )

Returns the row total in base currency.

Returns: float Row total in base currency.

Implemented in Item.

◆ getBaseRowTotalInclTax()

getBaseRowTotalInclTax ( )

Returns the row total including tax in base currency.

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

Implemented in Item.

◆ getBaseTaxAmount()

getBaseTaxAmount ( )

Returns the tax amount in base currency.

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

Implemented in Item.

◆ getDiscountAmount()

getDiscountAmount ( )

Returns the discount amount in quote currency.

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

Implemented in Item.

◆ getDiscountPercent()

getDiscountPercent ( )

Returns the discount percent.

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

Implemented in Item.

◆ getExtensionAttributes()

getExtensionAttributes ( )

Retrieve existing extension attributes object or create a new one.

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

Implemented in Item.

◆ getItemId()

getItemId ( )

Get totals item id

Returns: int Item id

Implemented in Item.

◆ getName()

getName ( )

Returns the product name.

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

Implemented in Item.

◆ getOptions()

getOptions ( )

Returns the item options data.

Returns: string Item price in quote currency.

Implemented in Item.

◆ getPrice()

getPrice ( )

Returns the item price in quote currency.

Returns: float Item price in quote currency.

Implemented in Item.

◆ getPriceInclTax()

getPriceInclTax ( )

Returns the price including tax in quote currency.

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

Implemented in Item.

◆ getQty()

getQty ( )

Returns the item quantity.

Returns: float Item quantity.

Implemented in Item.

◆ getRowTotal()

getRowTotal ( )

Returns the row total in quote currency.

Returns: float Row total in quote currency.

Implemented in Item.

◆ getRowTotalInclTax()

getRowTotalInclTax ( )

Returns the row total including tax in quote currency.

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

Implemented in Item.

◆ getRowTotalWithDiscount()

getRowTotalWithDiscount ( )

Returns the row total with discount in quote currency.

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

Implemented in Item.

◆ getTaxAmount()

getTaxAmount ( )

Returns the tax amount in quote currency.

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

Implemented in Item.

◆ getTaxPercent()

getTaxPercent ( )

Returns the tax percent.

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

Implemented in Item.

◆ getWeeeTaxApplied()

getWeeeTaxApplied ( )

Returns the item weee tax applied in quote currency.

Returns: string Item weee tax applied in quote currency.

Implemented in Item.

◆ getWeeeTaxAppliedAmount()

getWeeeTaxAppliedAmount ( )

Returns the item weee tax applied amount in quote currency.

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

Implemented in Item.

◆ setBaseDiscountAmount()

setBaseDiscountAmount ( $baseDiscountAmount )

Sets the discount amount in base currency.

Parameters

float $baseDiscountAmount

Returns: $this

Implemented in Item.

◆ setBasePrice()

setBasePrice ( $basePrice )

Sets the item price in base currency.

Parameters

float $basePrice

Returns: $this

Implemented in Item.

◆ setBasePriceInclTax()

setBasePriceInclTax ( $basePriceInclTax )

Sets the price including tax in base currency.

Parameters

float $basePriceInclTax

Returns: $this

Implemented in Item.

◆ setBaseRowTotal()

setBaseRowTotal ( $baseRowTotal )

Sets the row total in base currency.

Parameters

float $baseRowTotal

Returns: $this

Implemented in Item.

◆ setBaseRowTotalInclTax()

setBaseRowTotalInclTax ( $baseRowTotalInclTax )

Sets the row total including tax in base currency.

Parameters

float $baseRowTotalInclTax

Returns: $this

Implemented in Item.

◆ setBaseTaxAmount()

setBaseTaxAmount ( $baseTaxAmount )

Sets the tax amount in base currency.

Parameters

float $baseTaxAmount

Returns: $this

Implemented in Item.

◆ setDiscountAmount()

setDiscountAmount ( $discountAmount )

Sets the discount amount in quote currency.

Parameters

float $discountAmount

Returns: $this

Implemented in Item.

◆ setDiscountPercent()

setDiscountPercent ( $discountPercent )

Sets the discount percent.

Parameters

float $discountPercent

Returns: $this

Implemented in Item.

◆ setExtensionAttributes()

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

Set an extension attributes object.

Parameters

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

Returns: $this

◆ setItemId()

setItemId ( $id )

#- Set totals item id

Parameters

int $id

Returns: $this

Implemented in Item.

◆ setName()

setName ( $name )

Sets the product name.

Parameters

string $name

Returns: $this

Implemented in Item.

◆ setOptions()

setOptions ( $options )

Sets the item options data.

Parameters

string $options

Returns: $this

Implemented in Item.

◆ setPrice()

setPrice ( $price )

Sets the item price in quote currency.

Parameters

float $price

Returns: $this

Implemented in Item.

◆ setPriceInclTax()

setPriceInclTax ( $priceInclTax )

Sets the price including tax in quote currency.

Parameters

float $priceInclTax

Returns: $this

Implemented in Item.

◆ setQty()

setQty ( $qty )

Sets the item quantity.

Parameters

float $qty

Returns: $this

Implemented in Item.

◆ setRowTotal()

setRowTotal ( $rowTotal )

Sets the row total in quote currency.

Parameters

float $rowTotal

Returns: $this

Implemented in Item.

◆ setRowTotalInclTax()

setRowTotalInclTax ( $rowTotalInclTax )

Sets the row total including tax in quote currency.

Parameters

float $rowTotalInclTax

Returns: $this

Implemented in Item.

◆ setRowTotalWithDiscount()

setRowTotalWithDiscount ( $rowTotalWithDiscount )

Sets the row total with discount in quote currency.

Parameters

float $rowTotalWithDiscount

Returns: $this

Implemented in Item.

◆ setTaxAmount()

setTaxAmount ( $taxAmount )

Sets the tax amount in quote currency.

Parameters

float $taxAmount

Returns: $this

Implemented in Item.

◆ setTaxPercent()

setTaxPercent ( $taxPercent )

Sets the tax percent.

Parameters

float $taxPercent

Returns: $this

Implemented in Item.

◆ setWeeeTaxApplied()

setWeeeTaxApplied ( $weeeTaxApplied )

Sets the item weee tax applied in quote currency.

Parameters

string $weeeTaxApplied

Returns: $this

Implemented in Item.

◆ setWeeeTaxAppliedAmount()

setWeeeTaxAppliedAmount ( $weeeTaxAppliedAmount )

Sets the item weee tax applied amount in quote currency.

Parameters

float $weeeTaxAppliedAmount

Returns: $this

Implemented in Item.

Field Documentation

◆ KEY_BASE_DISCOUNT_AMOUNT

const KEY_BASE_DISCOUNT_AMOUNT = 'base_discount_amount'

Base discount amount.

Definition at line 62 of file TotalsItemInterface.php.

◆ KEY_BASE_PRICE

const KEY_BASE_PRICE = 'base_price'

Base price.

Definition at line 32 of file TotalsItemInterface.php.

◆ KEY_BASE_PRICE_INCL_TAX

const KEY_BASE_PRICE_INCL_TAX = 'base_price_incl_tax'

Base price including tax.

Definition at line 92 of file TotalsItemInterface.php.

◆ KEY_BASE_ROW_TOTAL

const KEY_BASE_ROW_TOTAL = 'base_row_total'

Base row total.

Definition at line 47 of file TotalsItemInterface.php.

◆ KEY_BASE_ROW_TOTAL_INCL_TAX

const KEY_BASE_ROW_TOTAL_INCL_TAX = 'base_row_total_incl_tax'

Base row total including tax.

Definition at line 102 of file TotalsItemInterface.php.

◆ KEY_BASE_TAX_AMOUNT

const KEY_BASE_TAX_AMOUNT = 'base_tax_amount'

Base tax amount.

Definition at line 77 of file TotalsItemInterface.php.

◆ KEY_DISCOUNT_AMOUNT

const KEY_DISCOUNT_AMOUNT = 'discount_amount'

Discount amount.

Definition at line 57 of file TotalsItemInterface.php.

◆ KEY_DISCOUNT_PERCENT

const KEY_DISCOUNT_PERCENT = 'discount_percent'

Discount percent.

Definition at line 67 of file TotalsItemInterface.php.

◆ KEY_ITEM_ID

const KEY_ITEM_ID = 'item_id'

#+ Constants defined for keys of array, makes typos less likelyItem id.

Definition at line 22 of file TotalsItemInterface.php.

◆ KEY_NAME

const KEY_NAME = 'name'

Item name.

Definition at line 122 of file TotalsItemInterface.php.

◆ KEY_OPTIONS

const KEY_OPTIONS = 'options'

Item options data.

Definition at line 107 of file TotalsItemInterface.php.

◆ KEY_PRICE

const KEY_PRICE = 'price'

Price.

Definition at line 27 of file TotalsItemInterface.php.

◆ KEY_PRICE_INCL_TAX

const KEY_PRICE_INCL_TAX = 'price_incl_tax'

Price including tax.

Definition at line 87 of file TotalsItemInterface.php.

◆ KEY_QTY

const KEY_QTY = 'qty'

Quantity.

Definition at line 37 of file TotalsItemInterface.php.

◆ KEY_ROW_TOTAL

const KEY_ROW_TOTAL = 'row_total'

Row total.

Definition at line 42 of file TotalsItemInterface.php.

◆ KEY_ROW_TOTAL_INCL_TAX

const KEY_ROW_TOTAL_INCL_TAX = 'row_total_incl_tax'

Row total including tax.

Definition at line 97 of file TotalsItemInterface.php.

◆ KEY_ROW_TOTAL_WITH_DISCOUNT

const KEY_ROW_TOTAL_WITH_DISCOUNT = 'row_total_with_discount'

Row total with discount.

Definition at line 52 of file TotalsItemInterface.php.

◆ KEY_TAX_AMOUNT

const KEY_TAX_AMOUNT = 'tax_amount'

Tax amount.

Definition at line 72 of file TotalsItemInterface.php.

◆ KEY_TAX_PERCENT

const KEY_TAX_PERCENT = 'tax_percent'

Tax percent.

Definition at line 82 of file TotalsItemInterface.php.

◆ KEY_WEEE_TAX_APPLIED

const KEY_WEEE_TAX_APPLIED = 'weee_tax_applied'

Item Weee Tax Applied Amount.

Definition at line 117 of file TotalsItemInterface.php.

◆ KEY_WEEE_TAX_APPLIED_AMOUNT

const KEY_WEEE_TAX_APPLIED_AMOUNT = 'weee_tax_applied_amount'

Item Weee Tax Applied Amount.

Definition at line 112 of file TotalsItemInterface.php.

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

vendor/magento/module-quote/Api/Data/TotalsItemInterface.php

Public Member Functions

Data Fields

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()

Field Documentation

◆ KEY_BASE_DISCOUNT_AMOUNT

◆ KEY_BASE_PRICE

◆ KEY_BASE_PRICE_INCL_TAX

◆ KEY_BASE_ROW_TOTAL

◆ KEY_BASE_ROW_TOTAL_INCL_TAX

◆ KEY_BASE_TAX_AMOUNT

◆ KEY_DISCOUNT_AMOUNT

◆ KEY_DISCOUNT_PERCENT

◆ KEY_ITEM_ID

◆ KEY_NAME

◆ KEY_OPTIONS

◆ KEY_PRICE

◆ KEY_PRICE_INCL_TAX

◆ KEY_QTY

◆ KEY_ROW_TOTAL

◆ KEY_ROW_TOTAL_INCL_TAX

◆ KEY_ROW_TOTAL_WITH_DISCOUNT

◆ KEY_TAX_AMOUNT

◆ KEY_TAX_PERCENT

◆ KEY_WEEE_TAX_APPLIED

◆ KEY_WEEE_TAX_APPLIED_AMOUNT