Mage_Sales_Model_Quote_Item Class Reference

Inheritance diagram for Mage_Sales_Model_Quote_Item:

List of all members.

Public Member Functions
	setQuote (Mage_Sales_Model_Quote $quote)
	getQuote ()
	addQty ($qty)
	setQty ($qty)
	getQtyOptions ()
	setProduct ($product)
	getProduct ()
	representProduct ($product)
	compare ($item)
	getProductType ()
	getRealProductType ()
	toArray (array $arrAttributes=array())
	setOptions ($options)
	getOptions ()
	addOption ($option)
	updateQtyOption (Varien_Object $option, $value)
	removeOption ($code)
	getOptionByCode ($code)
	__clone ()
Protected Member Functions
	_construct ()
	_beforeSave ()
	_prepareQty ($qty)
	_addOptionCode ($option)
	_afterSave ()
Protected Attributes
	$_eventPrefix = 'sales_quote_item'
	$_eventObject = 'item'
	$_quote
	$_options = array()
	$_optionsByCode = array()
	$_notRepresentOptions = array('info_buyRequest')

---

Detailed Description

Definition at line 35 of file Item.php.

---

Member Function Documentation

__clone

(

)

Clone quote item

Returns:

Mage_Sales_Model_Quote_Item

Reimplemented from Mage_Sales_Model_Quote_Item_Abstract.

Definition at line 540 of file Item.php.

    {
        parent::__clone();
        $options = $this->getOptions();
        $this->_quote           = null;
        $this->_options         = array();
        $this->_optionsByCode   = array();
        foreach ($options as $option) {
            $this->addOption(clone $option);
        }
        return $this;
    }

_addOptionCode

(

$

option

)

[protected]

Register option code

Parameters:

Mage_Sales_Model_Quote_Item_Option

$option

Returns:

Mage_Sales_Model_Quote_Item

Definition at line 490 of file Item.php.

    {
        if (!isset($this->_optionsByCode[$option->getCode()])) {
            $this->_optionsByCode[$option->getCode()] = $option;
        }
        else {
            Mage::throwException(Mage::helper('sales')->__('Item option with code %s already exist', $option->getCode()));
        }
        return $this;
    }

_afterSave

(

)

[protected]

Save item options

Returns:

Mage_Sales_Model_Quote_Item

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 520 of file Item.php.

    {
        foreach ($this->_options as $index => $option) {
            if ($option->isDeleted()) {
                $option->delete();
                unset($this->_options[$index]);
                unset($this->_optionsByCode[$option->getCode()]);
            }
            else {
                $option->save();
            }
        }
        return parent::_afterSave();
    }

_beforeSave

(

)

[protected]

Quote Item Before Save prepare data process

Returns:

Mage_Sales_Model_Quote_Item

Reimplemented from Mage_Sales_Model_Quote_Item_Abstract.

Definition at line 95 of file Item.php.

    {
        parent::_beforeSave();
        $this->setIsVirtual($this->getProduct()->getIsVirtual());
        if ($this->getQuote()) {
            $this->setQuoteId($this->getQuote()->getId());
        }
        return $this;
    }

_construct

(

)

[protected]

Initialize resource model

Reimplemented from Varien_Object.

Definition at line 85 of file Item.php.

    {
        $this->_init('sales/quote_item');
    }

_prepareQty

(

$

qty

)

[protected]

Prepare quantity

Parameters:

float|int

$qty

Returns:

int|float

Definition at line 134 of file Item.php.

    {
        $qty = Mage::app()->getLocale()->getNumber($qty);
        $qty = ($qty > 0) ? $qty : 1;
        return $qty;
    }

addOption

(

$

option

)

Add option to item

Parameters:

Mage_Sales_Model_Quote_Item_Option

$option

Returns:

Mage_Sales_Model_Quote_Item

Definition at line 416 of file Item.php.

    {
        if (is_array($option)) {
            $option = Mage::getModel('sales/quote_item_option')->setData($option)
                ->setItem($this);
        }
        elseif (($option instanceof Varien_Object) && !($option instanceof Mage_Sales_Model_Quote_Item_Option)) {
            $option = Mage::getModel('sales/quote_item_option')->setData($option->getData())
               ->setProduct($option->getProduct())
               ->setItem($this);
        }
        elseif($option instanceof Mage_Sales_Model_Quote_Item_Option) {
            $option->setItem($this);
        }
        else {
            Mage::throwException(Mage::helper('sales')->__('Invalid item option format'));
        }

        if ($exOption = $this->getOptionByCode($option->getCode())) {
            $exOption->addData($option->getData());
        }
        else {
            $this->_addOptionCode($option);
            $this->_options[] = $option;
        }
        return $this;
    }

addQty

(

$

qty

)

Adding quantity to quote item

Parameters:

float

$qty

Returns:

Mage_Sales_Model_Quote_Item

We can't modify quontity of existing items which have parent This qty declared just once duering add process and is not editable

Definition at line 147 of file Item.php.

    {
        $oldQty = $this->getQty();
        $qty = $this->_prepareQty($qty);

        /**
         * We can't modify quontity of existing items which have parent
         * This qty declared just once duering add process and is not editable
         */
        if (!$this->getParentItem() || !$this->getId()) {
            $this->setQtyToAdd($qty);
            $this->setQty($oldQty+$qty);
        }
        return $this;
    }

compare

(

$

item

)

Compare item

Parameters:

Mage_Sales_Model_Quote_Item

$item

Returns:

bool

Definition at line 311 of file Item.php.

    {
        if ($this->getProductId() != $item->getProductId()) {
            return false;
        }
        foreach ($this->getOptions() as $option) {
            if ($itemOption = $item->getOptionByCode($option->getCode())) {
                $itemOptionValue = $itemOption->getValue();
                $optionValue     = $option->getValue();

                // dispose of some options params, that can cramp comparing of arrays
                if (is_string($itemOptionValue) && is_string($optionValue)) {
                    $_itemOptionValue = @unserialize($itemOptionValue);
                    $_optionValue     = @unserialize($optionValue);
                    if (is_array($_itemOptionValue) && is_array($_optionValue)) {
                        $itemOptionValue = $_itemOptionValue;
                        $optionValue     = $_optionValue;
                        // looks like it does not break bundle selection qty
                        unset($itemOptionValue['qty'], $itemOptionValue['uenc'], $optionValue['qty'], $optionValue['uenc']);
                    }
                }

                if ($itemOptionValue != $optionValue) {
                    return false;
                }
            }
            else {
                return false;
            }
        }
        return true;
    }

getOptionByCode

(

$

code

)

Get item option by code

Parameters:

string

$code

Returns:

Mage_Sales_Model_Quote_Item_Option || null

Definition at line 507 of file Item.php.

    {
        if (isset($this->_optionsByCode[$code]) && !$this->_optionsByCode[$code]->isDeleted()) {
            return $this->_optionsByCode[$code];
        }
        return null;
    }

getOptions

(

)

Get all item options

Returns:

array

Definition at line 405 of file Item.php.

    {
        return $this->_options;
    }

getProduct

(

)

Retrieve product model object associated with item

Returns:

Mage_Catalog_Model_Product

Reset product final price because it related to custom options

Definition at line 257 of file Item.php.

    {
        $product = $this->_getData('product');
        if (($product === null) && $this->getProductId()) {
            $product = Mage::getModel('catalog/product')
                ->setStoreId($this->getQuote()->getStoreId())
                ->load($this->getProductId());
            $this->setProduct($product);
        }

        /**
         * Reset product final price because it related to custom options
         */
        $product->setFinalPrice(null);
        $product->setCustomOptions($this->_optionsByCode);
        return $product;
    }

getProductType

(

)

Get item product type

Returns:

string

Definition at line 349 of file Item.php.

    {
        if ($option = $this->getOptionByCode('product_type')) {
            return $option->getValue();
        }
        if ($product = $this->getProduct()) {
            return $product->getTypeId();
        }
        return $this->_getData('product_type');
    }

getQtyOptions

(

)

Retrieve option product with Qty

Return array 'qty' => the qty 'product' => the product model

Returns:

array

Definition at line 197 of file Item.php.

    {
        $productIds = array();
        $return     = array();
        foreach ($this->getOptions() as $option) {
            /* @var $option Mage_Sales_Model_Quote_Item_Option */
            if (is_object($option->getProduct()) && $option->getProduct()->getId() != $this->getProduct()->getId()
                && !isset($productIds[$option->getProduct()->getId()])) {
                $productIds[$option->getProduct()->getId()] = $option->getProduct()->getId();
            }
        }

        foreach ($productIds as $productId) {
            if ($option = $this->getOptionByCode('product_qty_' . $productId)) {
                $return[$productId] = $option;
            }
        }

        return $return;
    }

getQuote

(

)

Retrieve quote model object

Returns:

Mage_Sales_Model_Quote

Reimplemented from Mage_Sales_Model_Quote_Item_Abstract.

Definition at line 123 of file Item.php.

    {
        return $this->_quote;
    }

getRealProductType

(

)

Return real product type of item

Returns:

unknown

Definition at line 365 of file Item.php.

    {
        return $this->_getData('product_type');
    }

removeOption

(

$

code

)

Remove option from item options

Parameters:

string

$code

Returns:

Mage_Sales_Model_Quote_Item

Definition at line 476 of file Item.php.

    {
        if ($option = $this->getOptionByCode($code)) {
            $option->isDeleted(true);
        }
        return $this;
    }

representProduct

(

$

product

)

Check product representation in item

Parameters:

Mage_Catalog_Model_Product

$product

Returns:

bool

Definition at line 281 of file Item.php.

    {
        $itemProduct = $this->getProduct();
        if ($itemProduct->getId() != $product->getId()) {
            return false;
        }

        $itemOptions    = $this->getOptions();
        $productOptions = $product->getCustomOptions();

        foreach ($itemOptions as $option) {
            $code = $option->getCode();
            if (in_array($code, $this->_notRepresentOptions )) {
                continue;
            }
            if ( !isset($productOptions[$code])
                || ($productOptions[$code]->getValue() === null)
                || $productOptions[$code]->getValue() != $option->getValue()) {
                return false;
            }
        }
        return true;
    }

setOptions

(

$

options

)

Initialize quote item options

Parameters:

array

$options

Returns:

Mage_Sales_Model_Quote_Item

Definition at line 392 of file Item.php.

    {
        foreach ($options as $option) {
            $this->addOption($option);
        }
        return $this;
    }

setProduct

(

$

product

)

Setup product for quote item

Parameters:

Mage_Catalog_Model_Product

$product

Returns:

Mage_Sales_Model_Quote_Item

Definition at line 224 of file Item.php.

    {
        if ($this->getQuote()) {
            $product->setStoreId($this->getQuote()->getStoreId());
        }
        $this->setData('product', $product)
            ->setProductId($product->getId())
            ->setProductType($product->getTypeId())
            ->setSku($this->getProduct()->getSku())
            ->setName($product->getName())
            ->setWeight($this->getProduct()->getWeight())
            ->setTaxClassId($product->getTaxClassId())
            ->setCost($product->getCost())
            ->setIsQtyDecimal($product->getIsQtyDecimal());

        Mage::dispatchEvent('sales_quote_item_set_product', array(
            'product' => $product,
            'quote_item'=>$this
        ));

//        if ($options = $product->getCustomOptions()) {
//            foreach ($options as $option) {
//                $this->addOption($option);
//            }
//        }
        return $this;
    }

setQty

(

$

qty

)

Declare quote item quantity

Parameters:

float

$qty

Returns:

Mage_Sales_Model_Quote_Item

Definition at line 169 of file Item.php.

    {
        $qty    = $this->_prepareQty($qty);


        $oldQty = $this->_getData('qty');
        $this->setData('qty', $qty);

        Mage::dispatchEvent('sales_quote_item_qty_set_after', array('item'=>$this));

        if ($this->getQuote() && $this->getQuote()->getIgnoreOldQty()) {
            return $this;
        }
        if ($this->getUseOldQty()) {
            $this->setData('qty', $oldQty);
        }
        return $this;
    }

setQuote

(

Mage_Sales_Model_Quote $

quote

)

Declare quote model object

Parameters:

Mage_Sales_Model_Quote

$quote

Returns:

Mage_Sales_Model_Quote_Item

Definition at line 111 of file Item.php.

    {
        $this->_quote = $quote;
        $this->setQuoteId($quote->getId());
        return $this;
    }

toArray

(

array $

arrAttributes = array()

)

Convert Quote Item to array

Parameters:

array

$arrAttributes

Returns:

array

Reimplemented from Varien_Object.

Definition at line 376 of file Item.php.

    {
        $data = parent::toArray($arrAttributes);

        if ($product = $this->getProduct()) {
            $data['product'] = $product->toArray();
        }
        return $data;
    }

updateQtyOption	(	Varien_Object $	option,
		$	value
	)

Can specify specific actions for ability to change given quote options values Exemple: cataloginventory decimal qty validation may change qty to int, so need to change quote item qty option value.

Parameters:

	array	$options
	Varien_Object	$option
	mixed	$value

Returns:

object Mage_Catalog_Model_Product_Type_Abstract

Definition at line 455 of file Item.php.

    {
        $optionProduct = $option->getProduct();

        $options = $this->getQtyOptions();
        if (isset($options[$optionProduct->getId()])) {
            $options[$optionProduct->getId()]->setValue($value);
        }

        $this->getProduct()->getTypeInstance(true)
            ->updateQtyOption($this->getOptions(), $option, $value, $this->getProduct());

        return $this;
    }

---

Member Data Documentation

$_eventObject = 'item' [protected]

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 51 of file Item.php.

$_eventPrefix = 'sales_quote_item' [protected]

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 42 of file Item.php.

$_notRepresentOptions = array('info_buyRequest') [protected]

Definition at line 79 of file Item.php.

$_options = array() [protected]

Definition at line 65 of file Item.php.

$_optionsByCode = array() [protected]

Definition at line 72 of file Item.php.

$_quote [protected]

Definition at line 58 of file Item.php.

---

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

• app/code/core/Mage/Sales/Model/Quote/Item.php