Mage_Sales_Model_Quote_Item
extends Mage_Sales_Model_Quote_Item_Abstract
in package
Quote item abstract model
Table of Contents
Properties
- $_cacheTag : string|bool|array<string|int, mixed>
- Model cache tag for clear cache in after save and after delete
- $_children : array<string|int, mixed>
- Children items in bundle product, configurable product, etc.
- $_data : array<string|int, mixed>|null
- Object attributes
- $_dataSaveAllowed : bool
- Flag which can stop data saving after before save Can be used for next sequence: we check data in _beforeSave, if data are not valid - we can set this flag to false value and save process will be stopped
- $_dirty : array<string|int, mixed>
- $_errorInfos : Mage_Sales_Model_Status_List
- Array of errors associated with this quote item
- $_eventObject : string
- Parameter name in event
- $_eventPrefix : string
- Prefix of model events names
- $_flagOptionsSaved : mixed
- Flag stating that options were successfully saved
- $_hasDataChanges : bool
- Data changes flag (true after setData|unsetData call)
- $_idFieldName : string
- Name of object id field
- $_isDeleted : bool
- Object delete flag
- $_isObjectNew : bool|null
- Flag which allow detect object state: is it new object (without id) or existing one (with id)
- $_messages : array<string|int, mixed>
- $_notRepresentOptions : array<string|int, mixed>
- Not Represent options
- $_oldFieldsMap : array<string|int, mixed>
- Map short fields names to its full names
- $_options : array<string|int, mixed>
- Item options array
- $_optionsByCode : array<string|int, mixed>
- Item options by code cache
- $_origData : array<string|int, mixed>|null
- Original data that was loaded
- $_parentItem : Mage_Sales_Model_Quote_Item_Abstract|null
- Parent item for sub items for bundle product, configurable product, etc.
- $_quote : Mage_Sales_Model_Quote|null
- Quote model object
- $_resource : Mage_Core_Model_Resource_Db_Abstract
- Resource model instance
- $_resourceCollectionName : string
- Name of the resource collection model
- $_resourceName : string
- Name of the resource model
- $_syncFieldsMap : mixed
- Map of fields to sync to other fields upon changing their data
- $_underscoreCache : array<string|int, mixed>
- Setter/Getter underscore transformation cache
Methods
- __call() : mixed
- Set/Get attribute wrapper
- __clone() : mixed
- Clone quote item
- __construct() : mixed
- Constructor
- __get() : mixed
- Attribute getter (deprecated)
- __set() : mixed
- Attribute setter (deprecated)
- __toArray() : array<string|int, mixed>
- Convert object attributes to array
- _getResource() : Mage_Sales_Model_Resource_Quote_Item
- Get resource instance
- addChild() : $this
- Add child item
- addData() : $this
- Add data to the object.
- addErrorInfo() : $this
- Adds error information to the quote item.
- addMessage() : $this
- Add message of quote item to array of messages
- addOption() : $this
- Add option to item
- addQty() : $this
- Adding quantity to quote item
- afterCommitCallback() : $this
- Callback function which called after transaction commit in resource model
- afterLoad() : $this
- Object after load processing. Implemented as public interface for supporting objects after load in collections
- calcRowTotal() : $this
- Calculate item row total price
- calcTaxAmount() : $this
- Calculate item tax amount
- checkData() : $this
- Checking item data
- cleanModelCache() : $this
- Remove model object related cache
- clearInstance() : $this
- Clearing object for correct deleting by garbage collector
- clearMessage() : $this
- Clears all messages
- compare() : bool
- Compare item
- compareOptions() : bool
- Check if two options array are identical First options array is prerogative Second options array checked against first one
- dataHasChangedFor() : bool
- Compare object data with original data
- debug() : string|array<string|int, mixed>
- Present object data as string in debug mode
- delete() : $this
- Delete object from database
- flagDirty() : $this
- getAdditionalData() : string|null
- getAddress() : Mage_Sales_Model_Quote_Address|null
- getAppliedRuleIds() : string|null
- getBaseCalculationPrice() : float
- Get calculation price used for quote calculation in base currency.
- getBaseCalculationPriceOriginal() : float
- Get original calculation price used for quote calculation in base currency.
- getBaseCost() : float|null
- getBaseDiscountAmount() : float|null
- getBaseDiscountCalculationPrice() : float|null
- getBaseHiddenTaxAmount() : float|null
- getBaseOriginalDiscountAmount() : float|null
- getBaseOriginalPrice() : float|null
- getBasePrice() : float|null
- getBasePriceInclTax() : float|null
- getBaseRowTax() : float|null
- getBaseRowTotal() : float|null
- getBaseRowTotalInclTax() : float|null
- getBaseRowTotalWithDiscount() : float|null
- getBaseShippingAmount() : float|null
- getBaseTaxableAmount() : float|null
- getBaseTaxAmount() : float|null
- getBaseTaxBeforeDiscount() : float|null
- getBaseWeeeDiscount() : float|null
- getBaseWeeeTaxAppliedAmount() : float|null
- getBaseWeeeTaxAppliedRowAmount() : float|null
- getBaseWeeeTaxDisposition() : float|null
- getBaseWeeeTaxRowDisposition() : float|null
- getBillingAddress() : Mage_Customer_Model_Address_Abstract|null
- getBuyRequest() : DataObject
- Returns formatted buy request - object, holding request received from product view page with keys and options for configured product
- getCacheIdTags() : array<string|int, mixed>|false
- Get cache tags associated with object id
- getCacheTags() : array<string|int, mixed>|false
- Get list of cache tags applied to model object.
- getCalculationPrice() : float
- Get item price used for quote calculation process.
- getCalculationPriceOriginal() : float
- Get item price used for quote calculation process.
- getChildren() : array<string|int, Mage_Sales_Model_Quote_Item_Abstract>
- Get child items
- getCollection() : Mage_Sales_Model_Resource_Quote_Item_Collection
- getConvertedPrice() : float
- Get item price converted to quote currency
- getCost() : float|null
- getCreatedAt() : string|null
- getCustomPrice() : float|null
- getData() : mixed
- Object data getter
- getDataByKey() : mixed
- Get object data by particular key
- getDataByPath() : mixed
- Get object data by path
- getDataSetDefault() : mixed
- Fast get data or set default if value is not available
- getDataUsingMethod() : mixed
- Get object data by key with calling getter method
- getDescription() : string|null
- getDiscountAmount() : float|null
- Get discount amount with proper float casting DBAL returns DECIMAL as string, so we cast to float
- getDiscountCalculationPrice() : float|null
- getDiscountPercent() : float|null
- getDiscountTaxCompensation() : float|null
- getEntityId() : int
- getErrorInfos() : array<string|int, mixed>
- Retrieves all error infos, associated with this item
- getFileDownloadParams() : null|DataObject
- Returns special download params (if needed) for custom option with type = 'file' Needed to implement Mage_Catalog_Model_Product_Configuration_Item_Interface.
- getFreeShipping() : bool|float
- getGiftMessageId() : int|null
- getHasChildren() : bool|null
- getHasConfigurationUnavailableError() : bool|null
- getHasError() : bool|null
- getHiddenTaxAmount() : float|null
- getId() : int|string|null
- Retrieve model object identifier
- getIdFieldName() : string
- Retrieve identifier field name for model
- getIsPriceInclTax() : bool|null
- getIsQtyDecimal() : bool|null
- getIsVirtual() : bool|null
- getItemId() : int|null
- getMessage() : array<string|int, mixed>|string
- Get messages array of quote item
- getName() : string|null
- getNoDiscount() : bool|null
- getOptionByCode() : Mage_Sales_Model_Quote_Item_Option|null
- Get item option by code
- getOptions() : array<string|int, mixed>
- Get all item options
- getOptionsByCode() : array<string|int, mixed>
- Get all item options as array with codes in array key
- getOrigData() : mixed
- Get object loaded data (original data)
- getOriginalCustomPrice() : float|null
- getOriginalDiscountAmount() : float|null
- getOriginalPrice() : float
- Get original price (retrieved from product) for item.
- getParentItem() : Mage_Sales_Model_Quote_Item_Abstract|null
- Get parent item
- getParentItemId() : int|null
- getPrice() : float|null
- getPriceInclTax() : float|null
- getProduct() : Mage_Catalog_Model_Product
- Retrieve product model object associated with item.
- getProductId() : int|null
- getProductOrderOptions() : array<string|int, mixed>|null
- getProductType() : string|null
- Get item product type
- getQty() : float|null
- getQtyOptions() : array<string|int, mixed>
- Retrieve option product with Qty
- getQtyToAdd() : float|null
- getQuote() : Mage_Sales_Model_Quote
- Retrieve quote model object
- getQuoteId() : int|null
- getRealProductType() : string
- Return real product type of item
- getRedirectUrl() : string|null
- getResource() : Mage_Sales_Model_Resource_Quote_Item
- Retrieve model resource
- getResourceCollection() : Mage_Core_Model_Resource_Db_Collection_Abstract
- Get collection instance
- getResourceName() : string
- Retrieve model resource name
- getRowTax() : float|null
- getRowTotal() : float|null
- getRowTotalInclTax() : float|null
- getRowTotalWithDiscount() : float|null
- getRowWeight() : float|null
- getShippingAddress() : Mage_Customer_Model_Address_Abstract|null
- getSku() : string|null
- getStore() : Mage_Core_Model_Store
- Retrieve store model object
- getStoreId() : int|null
- getTaxableAmount() : float|null
- getTaxAmount() : float|null
- getTaxBeforeDiscount() : float|null
- getTaxClassId() : int|null
- getTaxPercent() : float|null
- getTotalQty() : int|float
- Get total item quantity (include parent item relation)
- getUpdatedAt() : string|null
- getUseOldQty() : bool|null
- getWeeeDiscount() : float|null
- getWeeeTaxApplied() : string|null
- getWeeeTaxAppliedAmount() : float|null
- getWeeeTaxAppliedRowAmount() : float|null
- getWeeeTaxDisposition() : float|null
- getWeeeTaxRowDisposition() : float|null
- getWeight() : float|null
- hasBaseCalculationPrice() : bool
- hasCustomPrice() : bool
- hasData() : bool
- If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.
- hasDataChanges() : bool
- Get data change status
- hasErrors() : bool
- hasOriginalCustomPrice() : bool
- isChildrenCalculated() : bool
- Checking if there children calculated or parent item when we have parent quote item and its children
- isCustomItem() : bool
- Check if the item is a custom line: it has a name and no catalog product.
- isDeleted() : bool
- Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value
- isDirty() : bool
- isEmpty() : bool
- checks whether the object is empty
- isModuleEnabled() : bool
- isObjectNew() : bool
- Check object state (true - if it is object without id on object just created) This method can help detect if object just created in _afterSave method problem is what in after save object has id and we can't detect what object was created in this transaction
- isShipSeparately() : bool
- Checking can we ship product separately (each child separately) or each parent product item can be shipped only like one item
- jsonSerialize() : array<string|int, mixed>
- Implementation of JsonSerializable::jsonSerialize()
- load() : $this
- Load object data
- offsetExists() : bool
- Implementation of ArrayAccess::offsetExists()
- offsetGet() : mixed
- Implementation of ArrayAccess::offsetGet()
- offsetSet() : void
- Implementation of ArrayAccess::offsetSet()
- offsetUnset() : void
- Implementation of ArrayAccess::offsetUnset()
- removeErrorInfosByParams() : $this
- Removes error infos, that have parameters equal to passed in $params.
- removeMessageByText() : $this
- Removes message by text
- removeOption() : $this
- Remove option from item options
- representProduct() : bool
- Check product representation in item
- save() : $this
- Save model plus its options Ensures saving options in case when resource model was not changed
- serialize() : string
- serialize object attributes
- setAdditionalData() : static
- setAddress() : static
- setAppliedRuleIds() : static
- setAttribute() : $this
- setBackorders() : static
- setBaseCalculationPrice() : static
- setBaseCost() : static
- setBaseCustomPrice() : static
- setBaseDiscountAmount() : static
- setBaseDiscountCalculationPrice() : static
- setBaseExtraRowTaxableAmount() : static
- setBaseExtraTaxableAmount() : static
- setBaseHiddenTaxAmount() : static
- setBaseOriginalDiscountAmount() : static
- setBaseOriginalPrice() : static
- setBasePrice() : static
- setBasePriceInclTax() : static
- setBaseRowTax() : static
- setBaseRowTotal() : static
- setBaseRowTotalInclTax() : static
- setBaseRowTotalWithDiscount() : static
- setBaseShippingAmount() : static
- setBaseTaxableAmount() : static
- setBaseTaxAmount() : static
- setBaseTaxBeforeDiscount() : static
- setBaseTaxCalcPrice() : static
- setBaseTaxCalcRowTotal() : static
- setBaseWeeeTaxAppliedAmount() : static
- setBaseWeeeTaxAppliedRowAmount() : static
- setBaseWeeeTaxDisposition() : static
- setBaseWeeeTaxRowDisposition() : static
- setCalculationPrice() : static
- setConvertedPrice() : $this
- Set new value for converted price
- setCreatedAt() : static
- setCustomPrice() : $this
- Specify custom item price (used in case when we have applied not product price to item)
- setData() : $this
- Overwrite data in the object.
- setDataChanges() : $this
- Clears data changes status
- setDataUsingMethod() : $this
- Set object data with calling setter method
- setDescription() : static
- setDiscountAmount() : static
- setDiscountCalculationPrice() : static
- setDiscountPercent() : static
- setDiscountTaxCompensation() : static
- setExtraRowTaxableAmount() : static
- setExtraTaxableAmount() : static
- setFreeShipping() : static
- setGiftMessage() : static
- setGiftMessageId() : static
- setHasChildren() : static
- setHasConfigurationUnavailableError() : static
- setHasError() : static
- Sets flag, whether this quote item has some error associated with it.
- setHiddenTaxAmount() : static
- setId() : $this
- Declare model object identifier value
- setIdFieldName() : $this
- set name of object id field
- setIsPriceInclTax() : static
- setIsQtyDecimal() : static
- setIsVirtual() : static
- setMessage() : $this
- Adds message(s) for quote item. Duplicated messages are not added.
- setName() : static
- setNoDiscount() : static
- setOptions() : $this
- Initialize quote item options
- setOrigData() : $this
- Initialize object original data
- setOriginalCustomPrice() : static
- setOriginalDiscountAmount() : static
- setOriginalPrice() : $this
- Set original price to item (calculation price will be refreshed too)
- setParentItem() : $this
- Set parent item
- setParentItemId() : static
- setParentProductId() : static
- setPrice() : $this
- Specify item price (base calculation price and converted price will be refreshed too)
- setPriceInclTax() : static
- setProduct() : static
- Setup product for quote item
- setProductId() : static
- setProductOrderOptions() : static
- setProductType() : static
- setQty() : static
- Declare quote item quantity
- setQtyOptions() : $this
- Set option product with Qty
- setQtyToAdd() : static
- setQuote() : $this
- Declare quote model object
- setQuoteId() : static
- setQuoteItemId() : static
- setQuoteMessage() : static
- setQuoteMessageIndex() : static
- setRedirectUrl() : static
- setRowTax() : static
- setRowTotal() : static
- setRowTotalExcTax() : static
- setRowTotalInclTax() : static
- setRowTotalWithDiscount() : static
- setRowWeight() : static
- setSku() : static
- setStoreId() : static
- setTaxableAmount() : static
- setTaxAmount() : static
- setTaxBeforeDiscount() : static
- setTaxCalcPrice() : static
- setTaxCalcRowTotal() : static
- setTaxClassId() : static
- setTaxPercent() : static
- setTaxRates() : static
- setUpdatedAt() : static
- setWeeeTaxApplied() : static
- setWeeeTaxAppliedAmount() : static
- setWeeeTaxAppliedRowAmount() : static
- setWeeeTaxDisposition() : static
- setWeeeTaxRowDisposition() : static
- setWeight() : static
- toArray() : array<string|int, mixed>
- Convert Quote Item to array
- toJson() : string
- Public wrapper for __toJson
- toString() : string
- Public wrapper for __toString
- toXml() : string
- Public wrapper for __toXml
- unsBasePriceInclTax() : $this
- unsBaseRowTotalInclTax() : $this
- unsetData() : $this
- Unset data from the object.
- unsetOldData() : $this
- Unset old fields data from the object.
- unsHasConfigurationUnavailableError() : $this
- unsMessage() : $this
- unsPriceInclTax() : $this
- unsRowTotalInclTax() : $this
- updateQtyOption() : $this
- Can specify specific actions for ability to change given quote options values Example: cataloginventory decimal qty validation may change qty to int, so need to change quote item qty option value.
- __toJson() : string
- Convert object attributes to JSON
- __toXml() : string
- Convert object attributes to XML
- _addFullNames() : mixed
- _addOptionCode() : $this
- Register option code
- _afterDelete() : $this
- Processing object after delete data
- _afterDeleteCommit() : $this
- Processing manipulation after main transaction commit
- _afterLoad() : $this
- Processing object after load data
- _afterSave() : $this
- Save item options after item saved
- _beforeDelete() : $this
- Processing object before delete data
- _beforeLoad() : $this
- Processing object before load data
- _beforeSave() : $this
- Quote Item Before Save prepare data process
- _camelize() : string
- _clearData() : $this
- Clearing object's data
- _clearErrorInfo() : $this
- Clears list of errors, associated with this quote item.
- _clearReferences() : $this
- Clearing cyclic references
- _construct() : void
- Internal constructor not depended on params. Can be used for object initialization
- _createCustomItemProduct() : Mage_Catalog_Model_Product
- Make an unsaved product from the columns of a custom line.
- _getApp() : Mage_Core_Model_App
- Get Maho App instance
- _getData() : mixed
- Get value from _data array without parse key
- _getEventData() : array<string|int, mixed>
- Get array of objects transferred to default events processing
- _hasModelChanged() : bool
- Checks that item model has data changes.
- _init() : mixed
- Standard model initialization
- _initOldFieldsMap() : $this
- Init mapping array of short fields to its full names
- _prepareArray() : array<string|int, mixed>
- Set required array elements
- _prepareQty() : int|float
- Prepare quantity
- _prepareSyncFieldsMap() : $this
- Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.
- _protectFromNonAdmin() : mixed
- Safeguard func that will check, if we are in admin area
- _saveItemOptions() : $this
- Save item options
- _setHasError() : $this
- Sets flag, whether this quote item has some error associated with it.
- _setResourceModel() : mixed
- Set resource names
- _underscore() : string
- Converts field names for setters and getters
Properties
$_cacheTag
Model cache tag for clear cache in after save and after delete
protected
string|bool|array<string|int, mixed>
$_cacheTag
= \false
When you use true - all cache will be clean
$_children
Children items in bundle product, configurable product, etc.
protected
array<string|int, mixed>
$_children
= []
$_data
Object attributes
protected
array<string|int, mixed>|null
$_data
= []
$_dataSaveAllowed
Flag which can stop data saving after before save Can be used for next sequence: we check data in _beforeSave, if data are not valid - we can set this flag to false value and save process will be stopped
protected
bool
$_dataSaveAllowed
= \true
$_dirty
protected
array<string|int, mixed>
$_dirty
$_errorInfos
Array of errors associated with this quote item
protected
Mage_Sales_Model_Status_List
$_errorInfos
= \null
$_eventObject
Parameter name in event
protected
string
$_eventObject
= 'item'
In observe method you can use $observer->getEvent()->getObject() in this case
Attributes
- #[Override]
$_eventPrefix
Prefix of model events names
protected
string
$_eventPrefix
= 'sales_quote_item'
Attributes
- #[Override]
$_flagOptionsSaved
Flag stating that options were successfully saved
protected
mixed
$_flagOptionsSaved
= \null
$_hasDataChanges
Data changes flag (true after setData|unsetData call)
protected
bool
$_hasDataChanges
= false
$_idFieldName
Name of object id field
protected
string
$_idFieldName
= null
$_isDeleted
Object delete flag
protected
bool
$_isDeleted
= false
$_isObjectNew
Flag which allow detect object state: is it new object (without id) or existing one (with id)
protected
bool|null
$_isObjectNew
= \null
$_messages
protected
array<string|int, mixed>
$_messages
= []
$_notRepresentOptions
Not Represent options
protected
array<string|int, mixed>
$_notRepresentOptions
= ['info_buyRequest']
$_oldFieldsMap
Map short fields names to its full names
protected
array<string|int, mixed>
$_oldFieldsMap
= []
$_options
Item options array
protected
array<string|int, mixed>
$_options
= []
$_optionsByCode
Item options by code cache
protected
array<string|int, mixed>
$_optionsByCode
= []
Attributes
- #[Override]
$_origData
Original data that was loaded
protected
array<string|int, mixed>|null
$_origData
$_parentItem
Parent item for sub items for bundle product, configurable product, etc.
protected
Mage_Sales_Model_Quote_Item_Abstract|null
$_parentItem
= \null
$_quote
Quote model object
protected
Mage_Sales_Model_Quote|null
$_quote
$_resource
Resource model instance
protected
Mage_Core_Model_Resource_Db_Abstract
$_resource
$_resourceCollectionName
Name of the resource collection model
protected
string
$_resourceCollectionName
$_resourceName
Name of the resource model
protected
string
$_resourceName
$_syncFieldsMap
Map of fields to sync to other fields upon changing their data
protected
mixed
$_syncFieldsMap
= []
$_underscoreCache
Setter/Getter underscore transformation cache
protected
static array<string|int, mixed>
$_underscoreCache
= []
Methods
__call()
Set/Get attribute wrapper
public
__call(string $method, array<string|int, mixed> $args) : mixed
Parameters
- $method : string
- $args : array<string|int, mixed>
__clone()
Clone quote item
public
__clone() : mixed
Attributes
- #[Override]
__construct()
Constructor
public
__construct() : mixed
By default, is looking for first argument as array and assigns it as object attributes This behaviour may change in child classes
__get()
Attribute getter (deprecated)
public
__get(string $var) : mixed
Parameters
- $var : string
__set()
Attribute setter (deprecated)
public
__set(string $var, mixed $value) : mixed
Parameters
- $var : string
- $value : mixed
__toArray()
Convert object attributes to array
public
__toArray([array<string|int, mixed> $arrAttributes = [] ]) : array<string|int, mixed>
Parameters
- $arrAttributes : array<string|int, mixed> = []
-
array of required attributes
Return values
array<string|int, mixed>_getResource()
Get resource instance
public
_getResource() : Mage_Sales_Model_Resource_Quote_Item
Return values
Mage_Sales_Model_Resource_Quote_ItemaddChild()
Add child item
public
addChild(Mage_Sales_Model_Quote_Item_Abstract $child) : $this
Parameters
- $child : Mage_Sales_Model_Quote_Item_Abstract
Return values
$thisaddData()
Add data to the object.
public
addData(array<string|int, mixed> $arr) : $this
Retains previous data in the object.
Parameters
- $arr : array<string|int, mixed>
Return values
$thisaddErrorInfo()
Adds error information to the quote item.
public
addErrorInfo([string|null $origin = null ][, int|null $code = null ][, string|null $message = null ][, DataObject|null $additionalData = null ]) : $this
Automatically sets error flag.
Parameters
- $origin : string|null = null
-
Usually a name of module, that embeds error
- $code : int|null = null
-
Error code, unique for origin, that sets it
- $message : string|null = null
-
Error message
- $additionalData : DataObject|null = null
-
Any additional data, that caller would like to store
Return values
$thisaddMessage()
Add message of quote item to array of messages
public
addMessage(string $message) : $this
Parameters
- $message : string
Return values
$thisaddOption()
Add option to item
public
addOption(Mage_Sales_Model_Quote_Item_Option|DataObject|array<string|int, mixed> $option) : $this
Parameters
- $option : Mage_Sales_Model_Quote_Item_Option|DataObject|array<string|int, mixed>
Tags
Return values
$thisaddQty()
Adding quantity to quote item
public
addQty(float $qty) : $this
Parameters
- $qty : float
Return values
$thisafterCommitCallback()
Callback function which called after transaction commit in resource model
public
afterCommitCallback() : $this
Return values
$thisafterLoad()
Object after load processing. Implemented as public interface for supporting objects after load in collections
public
afterLoad() : $this
Return values
$thiscalcRowTotal()
Calculate item row total price
public
calcRowTotal() : $this
Return values
$thiscalcTaxAmount()
Calculate item tax amount
public
calcTaxAmount() : $this
logic moved to tax totals calculation model
Return values
$thischeckData()
Checking item data
public
checkData() : $this
Return values
$thiscleanModelCache()
Remove model object related cache
public
cleanModelCache() : $this
Return values
$thisclearInstance()
Clearing object for correct deleting by garbage collector
public
final clearInstance() : $this
Return values
$thisclearMessage()
Clears all messages
public
clearMessage() : $this
Return values
$thiscompare()
Compare item
public
compare(Mage_Sales_Model_Quote_Item $item) : bool
Parameters
- $item : Mage_Sales_Model_Quote_Item
Return values
boolcompareOptions()
Check if two options array are identical First options array is prerogative Second options array checked against first one
public
compareOptions(array<string|int, mixed> $options1, array<string|int, mixed> $options2) : bool
Parameters
- $options1 : array<string|int, mixed>
- $options2 : array<string|int, mixed>
Return values
booldataHasChangedFor()
Compare object data with original data
public
dataHasChangedFor(string $field) : bool
Parameters
- $field : string
Return values
booldebug()
Present object data as string in debug mode
public
debug([mixed $data = null ][, array<string|int, mixed> &$objects = [] ]) : string|array<string|int, mixed>
Parameters
- $data : mixed = null
- $objects : array<string|int, mixed> = []
Return values
string|array<string|int, mixed>delete()
Delete object from database
public
delete() : $this
Tags
Return values
$thisflagDirty()
public
flagDirty(string $field[, bool $flag = true ]) : $this
Parameters
- $field : string
- $flag : bool = true
Return values
$thisgetAdditionalData()
public
getAdditionalData() : string|null
Return values
string|nullgetAddress()
public
getAddress() : Mage_Sales_Model_Quote_Address|null
Return values
Mage_Sales_Model_Quote_Address|nullgetAppliedRuleIds()
public
getAppliedRuleIds() : string|null
Return values
string|nullgetBaseCalculationPrice()
Get calculation price used for quote calculation in base currency.
public
getBaseCalculationPrice() : float
Return values
floatgetBaseCalculationPriceOriginal()
Get original calculation price used for quote calculation in base currency.
public
getBaseCalculationPriceOriginal() : float
Return values
floatgetBaseCost()
public
getBaseCost() : float|null
Return values
float|nullgetBaseDiscountAmount()
public
getBaseDiscountAmount() : float|null
Return values
float|nullgetBaseDiscountCalculationPrice()
public
getBaseDiscountCalculationPrice() : float|null
Return values
float|nullgetBaseHiddenTaxAmount()
public
getBaseHiddenTaxAmount() : float|null
Return values
float|nullgetBaseOriginalDiscountAmount()
public
getBaseOriginalDiscountAmount() : float|null
Return values
float|nullgetBaseOriginalPrice()
public
getBaseOriginalPrice() : float|null
Return values
float|nullgetBasePrice()
public
getBasePrice() : float|null
Return values
float|nullgetBasePriceInclTax()
public
getBasePriceInclTax() : float|null
Return values
float|nullgetBaseRowTax()
public
getBaseRowTax() : float|null
Return values
float|nullgetBaseRowTotal()
public
getBaseRowTotal() : float|null
Return values
float|nullgetBaseRowTotalInclTax()
public
getBaseRowTotalInclTax() : float|null
Return values
float|nullgetBaseRowTotalWithDiscount()
public
getBaseRowTotalWithDiscount() : float|null
Return values
float|nullgetBaseShippingAmount()
public
getBaseShippingAmount() : float|null
Return values
float|nullgetBaseTaxableAmount()
public
getBaseTaxableAmount() : float|null
Return values
float|nullgetBaseTaxAmount()
public
getBaseTaxAmount() : float|null
Return values
float|nullgetBaseTaxBeforeDiscount()
public
getBaseTaxBeforeDiscount() : float|null
Return values
float|nullgetBaseWeeeDiscount()
public
getBaseWeeeDiscount() : float|null
Return values
float|nullgetBaseWeeeTaxAppliedAmount()
public
getBaseWeeeTaxAppliedAmount() : float|null
Return values
float|nullgetBaseWeeeTaxAppliedRowAmount()
public
getBaseWeeeTaxAppliedRowAmount() : float|null
Return values
float|nullgetBaseWeeeTaxDisposition()
public
getBaseWeeeTaxDisposition() : float|null
Return values
float|nullgetBaseWeeeTaxRowDisposition()
public
getBaseWeeeTaxRowDisposition() : float|null
Return values
float|nullgetBillingAddress()
public
getBillingAddress() : Mage_Customer_Model_Address_Abstract|null
Return values
Mage_Customer_Model_Address_Abstract|nullgetBuyRequest()
Returns formatted buy request - object, holding request received from product view page with keys and options for configured product
public
getBuyRequest() : DataObject
Return values
DataObjectgetCacheIdTags()
Get cache tags associated with object id
public
getCacheIdTags() : array<string|int, mixed>|false
Return values
array<string|int, mixed>|falsegetCacheTags()
Get list of cache tags applied to model object.
public
getCacheTags() : array<string|int, mixed>|false
Return false if cache tags are not supported by model
Return values
array<string|int, mixed>|falsegetCalculationPrice()
Get item price used for quote calculation process.
public
getCalculationPrice() : float
This method get custom price (if it is defined) or original product final price
Return values
floatgetCalculationPriceOriginal()
Get item price used for quote calculation process.
public
getCalculationPriceOriginal() : float
This method get original custom price applied before tax calculation
Return values
floatgetChildren()
Get child items
public
getChildren() : array<string|int, Mage_Sales_Model_Quote_Item_Abstract>
Return values
array<string|int, Mage_Sales_Model_Quote_Item_Abstract>getCollection()
public
getCollection() : Mage_Sales_Model_Resource_Quote_Item_Collection
Return values
Mage_Sales_Model_Resource_Quote_Item_CollectiongetConvertedPrice()
Get item price converted to quote currency
public
getConvertedPrice() : float
Return values
floatgetCost()
public
getCost() : float|null
Return values
float|nullgetCreatedAt()
public
getCreatedAt() : string|null
Return values
string|nullgetCustomPrice()
public
getCustomPrice() : float|null
Return values
float|nullgetData()
Object data getter
public
getData([string $key = '' ][, string|int $index = null ]) : mixed
If $key is not defined will return all the data as an array. Otherwise, it will return value of the element specified by $key. It is possible to use keys like a/b/c for access nested array data
If $index is specified it will assume that attribute data is an array and retrieve corresponding member. If data is the string - it will be explode by new line character and converted to array.
Parameters
- $key : string = ''
- $index : string|int = null
getDataByKey()
Get object data by particular key
public
getDataByKey(string $key) : mixed
Parameters
- $key : string
getDataByPath()
Get object data by path
public
getDataByPath(string $path) : mixed
Method consider the path as chain of keys: a/b/c => ['a']['b']['c']
Parameters
- $path : string
getDataSetDefault()
Fast get data or set default if value is not available
public
getDataSetDefault(string $key, mixed $default) : mixed
Parameters
- $key : string
- $default : mixed
getDataUsingMethod()
Get object data by key with calling getter method
public
getDataUsingMethod(string $key[, mixed $args = null ]) : mixed
Parameters
- $key : string
- $args : mixed = null
getDescription()
public
getDescription() : string|null
Return values
string|nullgetDiscountAmount()
Get discount amount with proper float casting DBAL returns DECIMAL as string, so we cast to float
public
getDiscountAmount() : float|null
Attributes
- #[Override]
Return values
float|nullgetDiscountCalculationPrice()
public
getDiscountCalculationPrice() : float|null
Return values
float|nullgetDiscountPercent()
public
getDiscountPercent() : float|null
Return values
float|nullgetDiscountTaxCompensation()
public
getDiscountTaxCompensation() : float|null
Return values
float|nullgetEntityId()
public
getEntityId() : int
Return values
intgetErrorInfos()
Retrieves all error infos, associated with this item
public
getErrorInfos() : array<string|int, mixed>
Return values
array<string|int, mixed>getFileDownloadParams()
Returns special download params (if needed) for custom option with type = 'file' Needed to implement Mage_Catalog_Model_Product_Configuration_Item_Interface.
public
getFileDownloadParams() : null|DataObject
Return null, as quote item needs no additional configuration.
Attributes
- #[Override]
Return values
null|DataObjectgetFreeShipping()
public
getFreeShipping() : bool|float
Return values
bool|floatgetGiftMessageId()
public
getGiftMessageId() : int|null
Return values
int|nullgetHasChildren()
public
getHasChildren() : bool|null
Return values
bool|nullgetHasConfigurationUnavailableError()
public
getHasConfigurationUnavailableError() : bool|null
Return values
bool|nullgetHasError()
public
getHasError() : bool|null
Return values
bool|nullgetHiddenTaxAmount()
public
getHiddenTaxAmount() : float|null
Return values
float|nullgetId()
Retrieve model object identifier
public
getId() : int|string|null
Attributes
- #[Override]
Return values
int|string|nullgetIdFieldName()
Retrieve identifier field name for model
public
getIdFieldName() : string
Attributes
- #[Override]
Return values
stringgetIsPriceInclTax()
public
getIsPriceInclTax() : bool|null
Return values
bool|nullgetIsQtyDecimal()
public
getIsQtyDecimal() : bool|null
Return values
bool|nullgetIsVirtual()
public
getIsVirtual() : bool|null
Return values
bool|nullgetItemId()
public
getItemId() : int|null
Return values
int|nullgetMessage()
Get messages array of quote item
public
getMessage([bool $string = true ]) : array<string|int, mixed>|string
Parameters
- $string : bool = true
-
flag for converting messages to string
Return values
array<string|int, mixed>|stringgetName()
public
getName() : string|null
Return values
string|nullgetNoDiscount()
public
getNoDiscount() : bool|null
Return values
bool|nullgetOptionByCode()
Get item option by code
public
getOptionByCode(string $code) : Mage_Sales_Model_Quote_Item_Option|null
Parameters
- $code : string
Attributes
- #[Override]
Return values
Mage_Sales_Model_Quote_Item_Option|nullgetOptions()
Get all item options
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getOptionsByCode()
Get all item options as array with codes in array key
public
getOptionsByCode() : array<string|int, mixed>
Return values
array<string|int, mixed>getOrigData()
Get object loaded data (original data)
public
getOrigData([string $key = null ]) : mixed
Parameters
- $key : string = null
getOriginalCustomPrice()
public
getOriginalCustomPrice() : float|null
Return values
float|nullgetOriginalDiscountAmount()
public
getOriginalDiscountAmount() : float|null
Return values
float|nullgetOriginalPrice()
Get original price (retrieved from product) for item.
public
getOriginalPrice() : float
Original price value is in quote selected currency
Return values
floatgetParentItem()
Get parent item
public
getParentItem() : Mage_Sales_Model_Quote_Item_Abstract|null
Return values
Mage_Sales_Model_Quote_Item_Abstract|nullgetParentItemId()
public
getParentItemId() : int|null
Return values
int|nullgetPrice()
public
getPrice() : float|null
Return values
float|nullgetPriceInclTax()
public
getPriceInclTax() : float|null
Return values
float|nullgetProduct()
Retrieve product model object associated with item.
public
getProduct() : Mage_Catalog_Model_Product
A custom line gets a product that exists in memory only.
Attributes
- #[Override]
Return values
Mage_Catalog_Model_ProductgetProductId()
public
getProductId() : int|null
Return values
int|nullgetProductOrderOptions()
public
getProductOrderOptions() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetProductType()
Get item product type
public
getProductType() : string|null
Attributes
- #[Override]
Return values
string|nullgetQty()
public
getQty() : float|null
Return values
float|nullgetQtyOptions()
Retrieve option product with Qty
public
getQtyOptions() : array<string|int, mixed>
Return array 'qty' => the qty 'product' => the product model
Return values
array<string|int, mixed>getQtyToAdd()
public
getQtyToAdd() : float|null
Return values
float|nullgetQuote()
Retrieve quote model object
public
getQuote() : Mage_Sales_Model_Quote
Attributes
- #[Override]
Return values
Mage_Sales_Model_QuotegetQuoteId()
public
getQuoteId() : int|null
Return values
int|nullgetRealProductType()
Return real product type of item
public
getRealProductType() : string
Return values
stringgetRedirectUrl()
public
getRedirectUrl() : string|null
Return values
string|nullgetResource()
Retrieve model resource
public
getResource() : Mage_Sales_Model_Resource_Quote_Item
Return values
Mage_Sales_Model_Resource_Quote_ItemgetResourceCollection()
Get collection instance
public
getResourceCollection() : Mage_Core_Model_Resource_Db_Collection_Abstract
Tags
Return values
Mage_Core_Model_Resource_Db_Collection_AbstractgetResourceName()
Retrieve model resource name
public
getResourceName() : string
Return values
stringgetRowTax()
public
getRowTax() : float|null
Return values
float|nullgetRowTotal()
public
getRowTotal() : float|null
Return values
float|nullgetRowTotalInclTax()
public
getRowTotalInclTax() : float|null
Return values
float|nullgetRowTotalWithDiscount()
public
getRowTotalWithDiscount() : float|null
Return values
float|nullgetRowWeight()
public
getRowWeight() : float|null
Return values
float|nullgetShippingAddress()
public
getShippingAddress() : Mage_Customer_Model_Address_Abstract|null
Return values
Mage_Customer_Model_Address_Abstract|nullgetSku()
public
getSku() : string|null
Return values
string|nullgetStore()
Retrieve store model object
public
getStore() : Mage_Core_Model_Store
Return values
Mage_Core_Model_StoregetStoreId()
public
getStoreId() : int|null
Return values
int|nullgetTaxableAmount()
public
getTaxableAmount() : float|null
Return values
float|nullgetTaxAmount()
public
getTaxAmount() : float|null
Return values
float|nullgetTaxBeforeDiscount()
public
getTaxBeforeDiscount() : float|null
Return values
float|nullgetTaxClassId()
public
getTaxClassId() : int|null
Return values
int|nullgetTaxPercent()
public
getTaxPercent() : float|null
Return values
float|nullgetTotalQty()
Get total item quantity (include parent item relation)
public
getTotalQty() : int|float
Return values
int|floatgetUpdatedAt()
public
getUpdatedAt() : string|null
Return values
string|nullgetUseOldQty()
public
getUseOldQty() : bool|null
Return values
bool|nullgetWeeeDiscount()
public
getWeeeDiscount() : float|null
Return values
float|nullgetWeeeTaxApplied()
public
getWeeeTaxApplied() : string|null
Return values
string|nullgetWeeeTaxAppliedAmount()
public
getWeeeTaxAppliedAmount() : float|null
Return values
float|nullgetWeeeTaxAppliedRowAmount()
public
getWeeeTaxAppliedRowAmount() : float|null
Return values
float|nullgetWeeeTaxDisposition()
public
getWeeeTaxDisposition() : float|null
Return values
float|nullgetWeeeTaxRowDisposition()
public
getWeeeTaxRowDisposition() : float|null
Return values
float|nullgetWeight()
public
getWeight() : float|null
Return values
float|nullhasBaseCalculationPrice()
public
hasBaseCalculationPrice() : bool
Return values
boolhasCustomPrice()
public
hasCustomPrice() : bool
Return values
boolhasData()
If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.
public
hasData([string $key = '' ]) : bool
Parameters
- $key : string = ''
Return values
boolhasDataChanges()
Get data change status
public
hasDataChanges() : bool
Return values
boolhasErrors()
public
hasErrors() : bool
Return values
boolhasOriginalCustomPrice()
public
hasOriginalCustomPrice() : bool
Return values
boolisChildrenCalculated()
Checking if there children calculated or parent item when we have parent quote item and its children
public
isChildrenCalculated() : bool
Return values
boolisCustomItem()
Check if the item is a custom line: it has a name and no catalog product.
public
isCustomItem() : bool
Return values
boolisDeleted()
Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value
public
isDeleted([bool $isDeleted = null ]) : bool
Parameters
- $isDeleted : bool = null
Return values
boolisDirty()
public
isDirty([string $field = null ]) : bool
Parameters
- $field : string = null
Return values
boolisEmpty()
checks whether the object is empty
public
isEmpty() : bool
Return values
boolisModuleEnabled()
public
isModuleEnabled(string $moduleName[, string $helperAlias = 'core' ]) : bool
Parameters
- $moduleName : string
- $helperAlias : string = 'core'
Return values
boolisObjectNew()
Check object state (true - if it is object without id on object just created) This method can help detect if object just created in _afterSave method problem is what in after save object has id and we can't detect what object was created in this transaction
public
isObjectNew([bool $flag = null ]) : bool
Parameters
- $flag : bool = null
Return values
boolisShipSeparately()
Checking can we ship product separately (each child separately) or each parent product item can be shipped only like one item
public
isShipSeparately() : bool
Return values
booljsonSerialize()
Implementation of JsonSerializable::jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Prepares the object data for JSON serialization. Returns all object data as an array, with special handling for nested DataObject instances:
- If a nested DataObject has a custom jsonSerialize() implementation, it's preserved as-is
- If a nested DataObject has a custom toJson() method, it's converted to JSON string
- If a nested DataObject uses only the base implementations, it's excluded from output
This prevents infinite recursion and circular references when serializing object hierarchies.
Attributes
- #[Override]
Return values
array<string|int, mixed>load()
Load object data
public
load(string|null|int $id[, string|null $field = null ]) : $this
Parameters
- $id : string|null|int
- $field : string|null = null
Return values
$thisoffsetExists()
Implementation of ArrayAccess::offsetExists()
public
offsetExists(string $offset) : bool
Parameters
- $offset : string
Tags
Attributes
- #[Override]
Return values
booloffsetGet()
Implementation of ArrayAccess::offsetGet()
public
offsetGet(string $offset) : mixed
Parameters
- $offset : string
Tags
Attributes
- #[Override]
- #[ReturnTypeWillChange]
offsetSet()
Implementation of ArrayAccess::offsetSet()
public
offsetSet(string $offset, mixed $value) : void
Parameters
- $offset : string
- $value : mixed
Tags
Attributes
- #[Override]
offsetUnset()
Implementation of ArrayAccess::offsetUnset()
public
offsetUnset(string $offset) : void
Parameters
- $offset : string
Tags
Attributes
- #[Override]
removeErrorInfosByParams()
Removes error infos, that have parameters equal to passed in $params.
public
removeErrorInfosByParams(array<string|int, mixed> $params) : $this
$params can have following keys (if not set - then any item is good for this key): 'origin', 'code', 'message'
Parameters
- $params : array<string|int, mixed>
Return values
$thisremoveMessageByText()
Removes message by text
public
removeMessageByText(string $text) : $this
Parameters
- $text : string
Return values
$thisremoveOption()
Remove option from item options
public
removeOption(string $code) : $this
Parameters
- $code : string
Return values
$thisrepresentProduct()
Check product representation in item
public
representProduct(Mage_Catalog_Model_Product $product) : bool
Parameters
- $product : Mage_Catalog_Model_Product
Return values
boolsave()
Save model plus its options Ensures saving options in case when resource model was not changed
public
save() : $this
Attributes
- #[Override]
Return values
$thisserialize()
serialize object attributes
public
serialize([array<string|int, mixed> $attributes = [] ][, string $valueSeparator = '=' ][, string $fieldSeparator = ' ' ][, string $quote = '"' ]) : string
Parameters
- $attributes : array<string|int, mixed> = []
- $valueSeparator : string = '='
- $fieldSeparator : string = ' '
- $quote : string = '"'
Return values
stringsetAdditionalData()
public
setAdditionalData(string|null $value) : static
Parameters
- $value : string|null
Return values
staticsetAddress()
public
setAddress(Mage_Sales_Model_Quote_Address|null $value) : static
Parameters
- $value : Mage_Sales_Model_Quote_Address|null
Return values
staticsetAppliedRuleIds()
public
setAppliedRuleIds(string|null $value) : static
Parameters
- $value : string|null
Return values
staticsetAttribute()
public
setAttribute(Mage_Eav_Model_Entity_Attribute_Abstract $value) : $this
Parameters
Return values
$thissetBackorders()
public
setBackorders(int|null $value) : static
Parameters
- $value : int|null
Return values
staticsetBaseCalculationPrice()
public
setBaseCalculationPrice(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseCost()
public
setBaseCost(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseCustomPrice()
public
setBaseCustomPrice(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseDiscountAmount()
public
setBaseDiscountAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseDiscountCalculationPrice()
public
setBaseDiscountCalculationPrice(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseExtraRowTaxableAmount()
public
setBaseExtraRowTaxableAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseExtraTaxableAmount()
public
setBaseExtraTaxableAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseHiddenTaxAmount()
public
setBaseHiddenTaxAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseOriginalDiscountAmount()
public
setBaseOriginalDiscountAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseOriginalPrice()
public
setBaseOriginalPrice(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBasePrice()
public
setBasePrice(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBasePriceInclTax()
public
setBasePriceInclTax(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseRowTax()
public
setBaseRowTax(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseRowTotal()
public
setBaseRowTotal(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseRowTotalInclTax()
public
setBaseRowTotalInclTax(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseRowTotalWithDiscount()
public
setBaseRowTotalWithDiscount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseShippingAmount()
public
setBaseShippingAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseTaxableAmount()
public
setBaseTaxableAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseTaxAmount()
public
setBaseTaxAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseTaxBeforeDiscount()
public
setBaseTaxBeforeDiscount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseTaxCalcPrice()
public
setBaseTaxCalcPrice(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseTaxCalcRowTotal()
public
setBaseTaxCalcRowTotal(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseWeeeTaxAppliedAmount()
public
setBaseWeeeTaxAppliedAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseWeeeTaxAppliedRowAmount()
public
setBaseWeeeTaxAppliedRowAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseWeeeTaxDisposition()
public
setBaseWeeeTaxDisposition(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetBaseWeeeTaxRowDisposition()
public
setBaseWeeeTaxRowDisposition(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetCalculationPrice()
public
setCalculationPrice(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetConvertedPrice()
Set new value for converted price
public
setConvertedPrice(float|null $value) : $this
Parameters
- $value : float|null
Return values
$thissetCreatedAt()
public
setCreatedAt(string|null $value) : static
Parameters
- $value : string|null
Return values
staticsetCustomPrice()
Specify custom item price (used in case when we have applied not product price to item)
public
setCustomPrice(float $value) : $this
Parameters
- $value : float
Return values
$thissetData()
Overwrite data in the object.
public
setData(string|array<string|int, mixed> $key[, mixed $value = null ]) : $this
$key can be string or array. If $key is string, the attribute value will be overwritten by $value
If $key is an array, it will overwrite all the data in the object.
Parameters
- $key : string|array<string|int, mixed>
- $value : mixed = null
Return values
$thissetDataChanges()
Clears data changes status
public
setDataChanges(bool $value) : $this
Parameters
- $value : bool
Return values
$thissetDataUsingMethod()
Set object data with calling setter method
public
setDataUsingMethod(string $key[, mixed $args = [] ]) : $this
Parameters
- $key : string
- $args : mixed = []
Return values
$thissetDescription()
public
setDescription(string|null $value) : static
Parameters
- $value : string|null
Return values
staticsetDiscountAmount()
public
setDiscountAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetDiscountCalculationPrice()
public
setDiscountCalculationPrice(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetDiscountPercent()
public
setDiscountPercent(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetDiscountTaxCompensation()
public
setDiscountTaxCompensation(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetExtraRowTaxableAmount()
public
setExtraRowTaxableAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetExtraTaxableAmount()
public
setExtraTaxableAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetFreeShipping()
public
setFreeShipping(bool|float $value) : static
Parameters
- $value : bool|float
Return values
staticsetGiftMessage()
public
setGiftMessage(string|null $value) : static
Parameters
- $value : string|null
Return values
staticsetGiftMessageId()
public
setGiftMessageId(int|null $value) : static
Parameters
- $value : int|null
Return values
staticsetHasChildren()
public
setHasChildren([bool|null $value = true ]) : static
Parameters
- $value : bool|null = true
Return values
staticsetHasConfigurationUnavailableError()
public
setHasConfigurationUnavailableError([bool|null $value = true ]) : static
Parameters
- $value : bool|null = true
Return values
staticsetHasError()
Sets flag, whether this quote item has some error associated with it.
public
setHasError([bool|null $flag = true ]) : static
When TRUE - also adds 'unknown' error information to list of quote item errors. When FALSE - clears whole list of quote item errors. It's recommended to use addErrorInfo() instead - to be able to remove error statuses later.
Parameters
- $flag : bool|null = true
Tags
Attributes
- #[Override]
Return values
staticsetHiddenTaxAmount()
public
setHiddenTaxAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetId()
Declare model object identifier value
public
setId(mixed $id) : $this
Parameters
- $id : mixed
Attributes
- #[Override]
Return values
$thissetIdFieldName()
set name of object id field
public
setIdFieldName(string $name) : $this
Parameters
- $name : string
Return values
$thissetIsPriceInclTax()
public
setIsPriceInclTax([bool|null $value = true ]) : static
Parameters
- $value : bool|null = true
Return values
staticsetIsQtyDecimal()
public
setIsQtyDecimal([bool|null $value = true ]) : static
Parameters
- $value : bool|null = true
Return values
staticsetIsVirtual()
public
setIsVirtual([bool|null $value = true ]) : static
Parameters
- $value : bool|null = true
Return values
staticsetMessage()
Adds message(s) for quote item. Duplicated messages are not added.
public
setMessage(array<string|int, mixed>|string $messages) : $this
Parameters
- $messages : array<string|int, mixed>|string
Return values
$thissetName()
public
setName(string|null $value) : static
Parameters
- $value : string|null
Return values
staticsetNoDiscount()
public
setNoDiscount([bool|null $value = true ]) : static
Parameters
- $value : bool|null = true
Return values
staticsetOptions()
Initialize quote item options
public
setOptions(array<string|int, mixed> $options) : $this
Parameters
- $options : array<string|int, mixed>
Return values
$thissetOrigData()
Initialize object original data
public
setOrigData([string $key = null ][, mixed $data = null ]) : $this
Parameters
- $key : string = null
- $data : mixed = null
Return values
$thissetOriginalCustomPrice()
public
setOriginalCustomPrice(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetOriginalDiscountAmount()
public
setOriginalDiscountAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetOriginalPrice()
Set original price to item (calculation price will be refreshed too)
public
setOriginalPrice(float $price) : $this
Parameters
- $price : float
Return values
$thissetParentItem()
Set parent item
public
setParentItem(Mage_Sales_Model_Quote_Item $parentItem) : $this
Parameters
- $parentItem : Mage_Sales_Model_Quote_Item
Return values
$thissetParentItemId()
public
setParentItemId(int|null $value) : static
Parameters
- $value : int|null
Return values
staticsetParentProductId()
public
setParentProductId(int|null $value) : static
Parameters
- $value : int|null
Return values
staticsetPrice()
Specify item price (base calculation price and converted price will be refreshed too)
public
setPrice(float $value) : $this
Parameters
- $value : float
Return values
$thissetPriceInclTax()
public
setPriceInclTax(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetProduct()
Setup product for quote item
public
setProduct(Mage_Catalog_Model_Product $product) : static
Parameters
- $product : Mage_Catalog_Model_Product
Attributes
- #[Override]
Return values
staticsetProductId()
public
setProductId(int|null $value) : static
Parameters
- $value : int|null
Return values
staticsetProductOrderOptions()
public
setProductOrderOptions(array<string|int, mixed>|null $value) : static
Parameters
- $value : array<string|int, mixed>|null
Return values
staticsetProductType()
public
setProductType(string|null $value) : static
Parameters
- $value : string|null
Return values
staticsetQty()
Declare quote item quantity
public
setQty(float $qty) : static
Parameters
- $qty : float
Attributes
- #[Override]
Return values
staticsetQtyOptions()
Set option product with Qty
public
setQtyOptions(array<string|int, mixed> $qtyOptions) : $this
Parameters
- $qtyOptions : array<string|int, mixed>
Return values
$thissetQtyToAdd()
public
setQtyToAdd(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetQuote()
Declare quote model object
public
setQuote(Mage_Sales_Model_Quote $quote) : $this
Parameters
- $quote : Mage_Sales_Model_Quote
Return values
$thissetQuoteId()
public
setQuoteId(int|null $value) : static
Parameters
- $value : int|null
Return values
staticsetQuoteItemId()
public
setQuoteItemId(int|null $value) : static
Parameters
- $value : int|null
Return values
staticsetQuoteMessage()
public
setQuoteMessage(string|null $value) : static
Parameters
- $value : string|null
Return values
staticsetQuoteMessageIndex()
public
setQuoteMessageIndex(string|null $value) : static
Parameters
- $value : string|null
Return values
staticsetRedirectUrl()
public
setRedirectUrl(string|null $value) : static
Parameters
- $value : string|null
Return values
staticsetRowTax()
public
setRowTax(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetRowTotal()
public
setRowTotal(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetRowTotalExcTax()
public
setRowTotalExcTax(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetRowTotalInclTax()
public
setRowTotalInclTax(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetRowTotalWithDiscount()
public
setRowTotalWithDiscount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetRowWeight()
public
setRowWeight(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetSku()
public
setSku(string|null $value) : static
Parameters
- $value : string|null
Return values
staticsetStoreId()
public
setStoreId(int|null $value) : static
Parameters
- $value : int|null
Return values
staticsetTaxableAmount()
public
setTaxableAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetTaxAmount()
public
setTaxAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetTaxBeforeDiscount()
public
setTaxBeforeDiscount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetTaxCalcPrice()
public
setTaxCalcPrice(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetTaxCalcRowTotal()
public
setTaxCalcRowTotal(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetTaxClassId()
public
setTaxClassId(int|null $value) : static
Parameters
- $value : int|null
Return values
staticsetTaxPercent()
public
setTaxPercent(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetTaxRates()
public
setTaxRates(array<string|int, mixed>|null $value) : static
Parameters
- $value : array<string|int, mixed>|null
Return values
staticsetUpdatedAt()
public
setUpdatedAt(string|null $value) : static
Parameters
- $value : string|null
Return values
staticsetWeeeTaxApplied()
public
setWeeeTaxApplied(string|null $value) : static
Parameters
- $value : string|null
Return values
staticsetWeeeTaxAppliedAmount()
public
setWeeeTaxAppliedAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetWeeeTaxAppliedRowAmount()
public
setWeeeTaxAppliedRowAmount(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetWeeeTaxDisposition()
public
setWeeeTaxDisposition(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetWeeeTaxRowDisposition()
public
setWeeeTaxRowDisposition(float|null $value) : static
Parameters
- $value : float|null
Return values
staticsetWeight()
public
setWeight(float|null $value) : static
Parameters
- $value : float|null
Return values
statictoArray()
Convert Quote Item to array
public
toArray([array<string|int, mixed> $arrAttributes = [] ]) : array<string|int, mixed>
Parameters
- $arrAttributes : array<string|int, mixed> = []
Attributes
- #[Override]
Return values
array<string|int, mixed>toJson()
Public wrapper for __toJson
public
toJson([array<string|int, mixed> $arrAttributes = [] ]) : string
Parameters
- $arrAttributes : array<string|int, mixed> = []
Return values
stringtoString()
Public wrapper for __toString
public
toString([string $format = '' ]) : string
Will use $format as an template and substitute {{key}} for attributes
Parameters
- $format : string = ''
Return values
stringtoXml()
Public wrapper for __toXml
public
toXml([array<string|int, mixed> $arrAttributes = [] ][, string $rootName = 'item' ][, bool $addOpenTag = false ][, bool $addCdata = true ]) : string
Parameters
- $arrAttributes : array<string|int, mixed> = []
- $rootName : string = 'item'
- $addOpenTag : bool = false
- $addCdata : bool = true
Return values
stringunsBasePriceInclTax()
public
unsBasePriceInclTax() : $this
Return values
$thisunsBaseRowTotalInclTax()
public
unsBaseRowTotalInclTax() : $this
Return values
$thisunsetData()
Unset data from the object.
public
unsetData([string $key = null ]) : $this
$key can be a string only. Array will be ignored.
Parameters
- $key : string = null
Return values
$thisunsetOldData()
Unset old fields data from the object.
public
unsetOldData([string $key = null ]) : $this
$key can be a string only. Array will be ignored.
Parameters
- $key : string = null
Return values
$thisunsHasConfigurationUnavailableError()
public
unsHasConfigurationUnavailableError() : $this
Return values
$thisunsMessage()
public
unsMessage() : $this
Return values
$thisunsPriceInclTax()
public
unsPriceInclTax() : $this
Return values
$thisunsRowTotalInclTax()
public
unsRowTotalInclTax() : $this
Return values
$thisupdateQtyOption()
Can specify specific actions for ability to change given quote options values Example: cataloginventory decimal qty validation may change qty to int, so need to change quote item qty option value.
public
updateQtyOption(DataObject $option, int|float|null $value) : $this
Parameters
- $option : DataObject
- $value : int|float|null
Return values
$this__toJson()
Convert object attributes to JSON
protected
__toJson([array<string|int, mixed> $arrAttributes = [] ]) : string
Parameters
- $arrAttributes : array<string|int, mixed> = []
-
array of required attributes
Return values
string__toXml()
Convert object attributes to XML
protected
__toXml([array<string|int, mixed> $arrAttributes = [] ][, string $rootName = 'item' ][, bool $addOpenTag = false ][, bool $addCdata = true ]) : string
Parameters
- $arrAttributes : array<string|int, mixed> = []
-
array of required attributes
- $rootName : string = 'item'
-
name of the root element
- $addOpenTag : bool = false
- $addCdata : bool = true
Return values
string_addFullNames()
protected
_addFullNames() : mixed
_addOptionCode()
Register option code
protected
_addOptionCode(Mage_Sales_Model_Quote_Item_Option $option) : $this
Parameters
- $option : Mage_Sales_Model_Quote_Item_Option
Return values
$this_afterDelete()
Processing object after delete data
protected
_afterDelete() : $this
Return values
$this_afterDeleteCommit()
Processing manipulation after main transaction commit
protected
_afterDeleteCommit() : $this
Return values
$this_afterLoad()
Processing object after load data
protected
_afterLoad() : $this
Return values
$this_afterSave()
Save item options after item saved
protected
_afterSave() : $this
Attributes
- #[Override]
Return values
$this_beforeDelete()
Processing object before delete data
protected
_beforeDelete() : $this
Return values
$this_beforeLoad()
Processing object before load data
protected
_beforeLoad(int $id[, string|null $field = null ]) : $this
Parameters
- $id : int
- $field : string|null = null
Return values
$this_beforeSave()
Quote Item Before Save prepare data process
protected
_beforeSave() : $this
Attributes
- #[Override]
Return values
$this_camelize()
protected
_camelize(string $name) : string
Parameters
- $name : string
Return values
string_clearData()
Clearing object's data
protected
_clearData() : $this
Return values
$this_clearErrorInfo()
Clears list of errors, associated with this quote item.
protected
_clearErrorInfo() : $this
Also automatically removes error-flag from oneself.
Return values
$this_clearReferences()
Clearing cyclic references
protected
_clearReferences() : $this
Return values
$this_construct()
Internal constructor not depended on params. Can be used for object initialization
protected
_construct() : void
Attributes
- #[Override]
_createCustomItemProduct()
Make an unsaved product from the columns of a custom line.
protected
_createCustomItemProduct() : Mage_Catalog_Model_Product
Return values
Mage_Catalog_Model_Product_getApp()
Get Maho App instance
protected
_getApp() : Mage_Core_Model_App
Return values
Mage_Core_Model_App_getData()
Get value from _data array without parse key
protected
_getData(string $key) : mixed
Parameters
- $key : string
_getEventData()
Get array of objects transferred to default events processing
protected
_getEventData() : array<string|int, mixed>
Return values
array<string|int, mixed>_hasModelChanged()
Checks that item model has data changes.
protected
_hasModelChanged() : bool
Call save item options if model isn't need to save in DB
Attributes
- #[Override]
Return values
bool_init()
Standard model initialization
protected
_init(string $resourceModel) : mixed
Parameters
- $resourceModel : string
_initOldFieldsMap()
Init mapping array of short fields to its full names
protected
_initOldFieldsMap() : $this
Attributes
- #[Override]
Return values
$this_prepareArray()
Set required array elements
protected
_prepareArray(array<string|int, mixed> &$arr[, array<string|int, mixed> $elements = [] ]) : array<string|int, mixed>
Parameters
- $arr : array<string|int, mixed>
- $elements : array<string|int, mixed> = []
Return values
array<string|int, mixed>_prepareQty()
Prepare quantity
protected
_prepareQty(float|int $qty) : int|float
Parameters
- $qty : float|int
Return values
int|float_prepareSyncFieldsMap()
Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.
protected
_prepareSyncFieldsMap() : $this
Return values
$this_protectFromNonAdmin()
Safeguard func that will check, if we are in admin area
protected
_protectFromNonAdmin() : mixed
Tags
_saveItemOptions()
Save item options
protected
_saveItemOptions() : $this
Return values
$this_setHasError()
Sets flag, whether this quote item has some error associated with it.
protected
_setHasError(bool $flag) : $this
Parameters
- $flag : bool
Return values
$this_setResourceModel()
Set resource names
protected
_setResourceModel(string $resourceName[, string|null $resourceCollectionName = null ]) : mixed
If collection name is omitted, resource name will be used with _collection appended
Parameters
- $resourceName : string
- $resourceCollectionName : string|null = null
_underscore()
Converts field names for setters and getters
protected
_underscore(string $name) : string
$this->setMyField($value) === $this->setData('my_field', $value) Uses cache to eliminate unnecessary preg_replace
Parameters
- $name : string