Mage_Sales_Model_Quote_Item_Abstract Class Reference

Inheritance diagram for Mage_Sales_Model_Quote_Item_Abstract:

List of all members.

Public Member Functions
	getQuote ()
	setParentItem ($parentItem)
	getParentItem ()
	getChildren ()
	addChild ($child)
	setMessage ($messages)
	addMessage ($message)
	getMessage ($string=true)
	getStore ()
	checkData ()
	calcRowTotal ()
	calcTaxAmount ()
	getCalculationPrice ()
	getBaseCalculationPrice ()
	getOriginalPrice ()
	getTaxAmount ()
	getPrice ()
	setCustomPrice ($value)
	setPrice ($value)
	__clone ()
	isChildrenCalculated ()
	isShipSeparately ()
Protected Member Functions
	_beforeSave ()
	_calculatePrice ($value, $saveTaxes=true)
Protected Attributes
	$_parentItem = null
	$_children = array()
	$_messages = array()

---

Detailed Description

Definition at line 34 of file Abstract.php.

---

Member Function Documentation

__clone

(

)

Clone quote item

Returns:

Mage_Sales_Model_Quote_Item

Reimplemented in Mage_Sales_Model_Quote_Item.

Definition at line 502 of file Abstract.php.

    {
        $this->setId(null);
        $this->_parentItem  = null;
        $this->_children    = array();
        return $this;
    }

_beforeSave

(

)

[protected]

Processing object before save data

Returns:

Mage_Core_Model_Abstract

Reimplemented from Mage_Core_Model_Abstract.

Reimplemented in Mage_Sales_Model_Quote_Address_Item, and Mage_Sales_Model_Quote_Item.

Definition at line 47 of file Abstract.php.

    {
        parent::_beforeSave();
        if ($this->getParentItem()) {
            $this->setParentItemId($this->getParentItem()->getId());
        }
        return $this;
    }

_calculatePrice	(	$	value,
		$	saveTaxes = true
	)			[protected]

Definition at line 403 of file Abstract.php.

    {
        $store = $this->getQuote()->getStore();

        if (Mage::helper('tax')->priceIncludesTax($store)) {
            $bAddress = $this->getQuote()->getBillingAddress();
            $sAddress = $this->getQuote()->getShippingAddress();

            $address = $this->getAddress();

            if ($address) {
                switch ($address->getAddressType()) {
                    case Mage_Sales_Model_Quote_Address::TYPE_BILLING:
                        $bAddress = $address;
                        break;
                    case Mage_Sales_Model_Quote_Address::TYPE_SHIPPING:
                        $sAddress = $address;
                        break;
                }
            }

            if ($this->getProduct()->getIsVirtual()) {
                $sAddress = $bAddress;
            }

            $priceExcludingTax = Mage::helper('tax')->getPrice(
                $this->getProduct()->setTaxPercent(null),
                $value,
                false,
                $sAddress,
                $bAddress,
                $this->getQuote()->getCustomerTaxClassId(),
                $store
            );

            $priceIncludingTax = Mage::helper('tax')->getPrice(
                $this->getProduct()->setTaxPercent(null),
                $value,
                true,
                $sAddress,
                $bAddress,
                $this->getQuote()->getCustomerTaxClassId(),
                $store
            );

            if ($saveTaxes) {
                $qty = $this->getQty();
                if ($this->getParentItem()) {
                    $qty = $qty*$this->getParentItem()->getQty();
                }

                if (Mage::helper('tax')->displayCartPriceInclTax($store)) {
                    $rowTotal = $value*$qty;
                    $rowTotalExcTax = Mage::helper('tax')->getPrice(
                        $this->getProduct()->setTaxPercent(null),
                        $rowTotal,
                        false,
                        $sAddress,
                        $bAddress,
                        $this->getQuote()->getCustomerTaxClassId(),
                        $store
                    );
                    $rowTotalIncTax = Mage::helper('tax')->getPrice(
                        $this->getProduct()->setTaxPercent(null),
                        $rowTotal,
                        true,
                        $sAddress,
                        $bAddress,
                        $this->getQuote()->getCustomerTaxClassId(),
                        $store
                    );
                    $totalBaseTax = $rowTotalIncTax-$rowTotalExcTax;
                    $this->setRowTotalExcTax($rowTotalExcTax);
                }
                else {
                    $taxAmount = $priceIncludingTax - $priceExcludingTax;
                    $this->setTaxPercent($this->getProduct()->getTaxPercent());
                    $totalBaseTax = $taxAmount*$qty;
                }

                $totalTax = $this->getStore()->convertPrice($totalBaseTax);
                $this->setTaxBeforeDiscount($totalTax);
                $this->setBaseTaxBeforeDiscount($totalBaseTax);

                $this->setTaxAmount($totalTax);
                $this->setBaseTaxAmount($totalBaseTax);
            }

            $value = $priceExcludingTax;
        }

        return $value;
    }

addChild

(

$

child

)

Add child item

Parameters:

Mage_Sales_Model_Quote_Item_Abstract

$child

Returns:

Mage_Sales_Model_Quote_Item_Abstract

Definition at line 98 of file Abstract.php.

    {
        $this->setHasChildren(true);
        $this->_children[] = $child;
        return $this;
    }

addMessage

(

$

message

)

Add message of quote item to array of messages

Parameters:

string

$message

Returns:

Mage_Sales_Model_Quote_Item_Abstract

Definition at line 127 of file Abstract.php.

    {
        $this->_messages[] = $message;
        return $this;
    }

calcRowTotal

(

)

Calculate item row total price

Returns:

Mage_Sales_Model_Quote_Item

Definition at line 201 of file Abstract.php.

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

        if ($this->getParentItem()) {
            $qty = $qty*$this->getParentItem()->getQty();
        }

        if ($rowTotal = $this->getRowTotalExcTax()) {
            $baseTotal = $rowTotal;
            $total = $this->getStore()->convertPrice($baseTotal);
        }
        else {
            $total      = $this->getCalculationPrice()*$qty;
            $baseTotal  = $this->getBaseCalculationPrice()*$qty;
        }

        $this->setRowTotal($this->getStore()->roundPrice($total));
        $this->setBaseRowTotal($this->getStore()->roundPrice($baseTotal));

        return $this;
    }

calcTaxAmount

(

)

Calculate item tax amount

Returns:

Mage_Sales_Model_Quote_Item

Definition at line 229 of file Abstract.php.

    {
        $store = $this->getStore();

        if (!Mage::helper('tax')->priceIncludesTax($store)) {
            if (Mage::helper('tax')->applyTaxAfterDiscount($store)) {
                $rowTotal       = $this->getRowTotalWithDiscount();
                $rowBaseTotal   = $this->getBaseRowTotalWithDiscount();
            } else {
                $rowTotal       = $this->getRowTotal();
                $rowBaseTotal   = $this->getBaseRowTotal();
            }

            $taxPercent = $this->getTaxPercent()/100;

            $this->setTaxAmount($store->roundPrice($rowTotal * $taxPercent));
            $this->setBaseTaxAmount($store->roundPrice($rowBaseTotal * $taxPercent));

            $rowTotal       = $this->getRowTotal();
            $rowBaseTotal   = $this->getBaseRowTotal();
            $this->setTaxBeforeDiscount($store->roundPrice($rowTotal * $taxPercent));
            $this->setBaseTaxBeforeDiscount($store->roundPrice($rowBaseTotal * $taxPercent));
        } else {
            if (Mage::helper('tax')->applyTaxAfterDiscount($store)) {
                $totalBaseTax = $this->getBaseTaxAmount();
                $totalTax = $this->getTaxAmount();

                if ($totalTax && $totalBaseTax) {
                    $totalTax -= $this->getDiscountAmount()*($this->getTaxPercent()/100);
                    $totalBaseTax -= $this->getBaseDiscountAmount()*($this->getTaxPercent()/100);

                    $this->setBaseTaxAmount($store->roundPrice($totalBaseTax));
                    $this->setTaxAmount($store->roundPrice($totalTax));
                }
            }
        }

        if (Mage::helper('tax')->discountTax($store) && !Mage::helper('tax')->applyTaxAfterDiscount($store)) {
            if ($this->getDiscountPercent()) {
                $baseTaxAmount =  $this->getBaseTaxBeforeDiscount();
                $taxAmount = $this->getTaxBeforeDiscount();

                $baseDiscountDisposition = $baseTaxAmount/100*$this->getDiscountPercent();
                $discountDisposition = $taxAmount/100*$this->getDiscountPercent();

                $this->setDiscountAmount($this->getDiscountAmount()+$discountDisposition);
                $this->setBaseDiscountAmount($this->getBaseDiscountAmount()+$baseDiscountDisposition);
            }
        }

        return $this;
    }

checkData

(

)

Checking item data

Returns:

Mage_Sales_Model_Quote_Item_Abstract

Definition at line 161 of file Abstract.php.

    {
        $this->setHasError(false);
        $this->unsMessage();

        $qty = $this->getData('qty');
        try {
            $this->setQty($qty);
        }
        catch (Mage_Core_Exception $e){
            $this->setHasError(true);
            $this->setMessage($e->getMessage());
        }
        catch (Exception $e){
            $this->setHasError(true);
            $this->setMessage(Mage::helper('sales')->__('Item qty declare error'));
        }

        try {
            $this->getProduct()->getTypeInstance(true)->checkProductBuyState($this->getProduct());
        } catch (Mage_Core_Exception $e) {
            $this->setHasError(true);
            $this->setMessage($e->getMessage());
            $this->getQuote()->setHasError(true);
            $this->getQuote()->addMessage(Mage::helper('sales')->__('Some of the products below don\'t have all the required options. Please remove them and add again with all the required options.'));
        } catch (Exception $e) {
            $this->setHasError(true);
            $this->setMessage(Mage::helper('sales')->__('Item options declare error'));
            $this->getQuote()->setHasError(true);
            $this->getQuote()->addMessage(Mage::helper('sales')->__('Items options declare error.'));
        }

        return $this;
    }

getBaseCalculationPrice

(

)

Retrieve calculation price in base currency

Returns:

unknown

Definition at line 307 of file Abstract.php.

    {
        if (!$this->hasBaseCalculationPrice()) {
            if ($this->hasCustomPrice()) {
                if ($price = (float) $this->getCustomPrice()) {
                    $rate = $this->getStore()->convertPrice($price) / $price;
                    $price = $price / $rate;
                }
                else {
                    $price = $this->getCustomPrice();
                }
            } else {
                $price = $this->getPrice();
            }
            $this->setBaseCalculationPrice($price);
        }
        return $this->getData('base_calculation_price');
    }

getCalculationPrice

(

)

Retrieve item price used for calculation

Returns:

unknown

Definition at line 287 of file Abstract.php.

    {
        $price = $this->getData('calculation_price');
        if (is_null($price)) {
            if ($this->hasCustomPrice()) {
                $price = $this->getCustomPrice();
            }
            else {
                $price = $this->getOriginalPrice();
            }
            $this->setData('calculation_price', $price);
        }
        return $price;
    }

getChildren

(

)

Get chil items

Returns:

array

Definition at line 87 of file Abstract.php.

    {
        return $this->_children;
    }

getMessage

(

$

string = true

)

Get messages array of quote item

Returns:

array

Definition at line 138 of file Abstract.php.

    {
        if ($string) {
            return join("\n", $this->_messages);
        }
        return $this->_messages;
    }

getOriginalPrice

(

)

Retrieve original price (retrieved from product) for item

Returns:

float

Definition at line 331 of file Abstract.php.

    {
        $price = $this->getData('original_price');
        if (is_null($price)) {
            $price = $this->getStore()->convertPrice($this->getPrice());
            $this->setData('original_price', $price);
        }
        return $price;
    }

getParentItem

(

)

Get parent item

Returns:

Mage_Sales_Model_Quote_Item

Definition at line 77 of file Abstract.php.

    {
        return $this->_parentItem;
    }

getPrice

(

)

Get item price (item price always exclude price)

Returns:

decimal

Definition at line 366 of file Abstract.php.

    {
        $priceType = $this->getProduct()->getPriceType();
        if ($this->getHasChildren() && (null !== $priceType) && (int)$priceType === Mage_Catalog_Model_Product_Type_Abstract::CALCULATE_CHILD) {
            $price = $this->_getData('price');
            /*
            foreach ($this->getChildren() as $child) {
                $price+= $child->getPrice()*$child->getQty();
            }
            */
            return $price;
        }
        else {
            return $this->_getData('price');
        }
    }

getQuote

(

)

[abstract]

Retrieve Quote instance

Returns:

Mage_Sales_Model_Quote

Reimplemented in Mage_Sales_Model_Quote_Address_Item, and Mage_Sales_Model_Quote_Item.

getStore

(

)

Retrieve store model object

Returns:

Mage_Core_Model_Store

Definition at line 151 of file Abstract.php.

    {
        return $this->getQuote()->getStore();
    }

getTaxAmount

(

)

Get item tax amount

Returns:

decimal

Definition at line 346 of file Abstract.php.

    {
        $priceType = $this->getProduct()->getPriceType();
        if ($this->getHasChildren() && (null !== $priceType) && (int)$priceType === Mage_Catalog_Model_Product_Type_Abstract::CALCULATE_CHILD) {
            $amount = 0;
            foreach ($this->getChildren() as $child) {
                $amount+= $child->getTaxAmount();
            }
            return $amount;
        }
        else {
            return $this->_getData('tax_amount');
        }
    }

isChildrenCalculated

(

)

Checking if there children calculated or parent item when we have parent quote item and its children

Returns:

bool

Definition at line 516 of file Abstract.php.

                                           {
        if ($this->getParentItem()) {
            $calculate = $this->getParentItem()->getProduct()->getPriceType();
        } else {
            $calculate = $this->getProduct()->getPriceType();
        }

        if ((null !== $calculate) && (int)$calculate === Mage_Catalog_Model_Product_Type_Abstract::CALCULATE_CHILD) {
            return true;
        }
        return false;
    }

isShipSeparately

(

)

Checking can we ship product separatelly (each child separately) or each parent product item can be shipped only like one item

Returns:

bool

Definition at line 536 of file Abstract.php.

                                       {
        if ($this->getParentItem()) {
            $shipmentType = $this->getParentItem()->getProduct()->getShipmentType();
        } else {
            $shipmentType = $this->getProduct()->getShipmentType();
        }

        if ((null !== $shipmentType) && (int)$shipmentType === Mage_Catalog_Model_Product_Type_Abstract::SHIPMENT_SEPARATELY) {
            return true;
        }
        return false;
    }

setCustomPrice

(

$

value

)

Definition at line 383 of file Abstract.php.

    {
        if (is_null($value)) {
            return $this->setData('custom_price', $value);
        }

        $excludingTax = $this->_calculatePrice($value, Mage::helper('tax')->applyTaxOnCustomPrice());
        $this->setData('original_custom_price', $value);
        return $this->setData('custom_price', $excludingTax);
    }

setMessage

(

$

messages

)

Set masseges for quote item

Parameters:

mixed

$messages

Returns:

Mage_Sales_Model_Quote_Item_Abstract

Definition at line 111 of file Abstract.php.

                                          {
        if (!is_array($messages)) {
            $messages = array($messages);
        }
        foreach ($messages as $message) {
            $this->addMessage($message);
        }
        return $this;
    }

setParentItem

(

$

parentItem

)

Set parent item

Parameters:

Mage_Sales_Model_Quote_Item

$parentItem

Returns:

Mage_Sales_Model_Quote_Item

Definition at line 63 of file Abstract.php.

    {
        if ($parentItem) {
            $this->_parentItem = $parentItem;
            $parentItem->addChild($this);
        }
        return $this;
    }

setPrice

(

$

value

)

Definition at line 394 of file Abstract.php.

    {
        $saveTaxes = true;
        if (Mage::helper('tax')->applyTaxOnCustomPrice() && $this->hasCustomPrice()) {
            $saveTaxes = false;
        }
        return $this->setData('price', $this->_calculatePrice($value, $saveTaxes));
    }

---

Member Data Documentation

$_children = array() [protected]

Definition at line 37 of file Abstract.php.

$_messages = array() [protected]

Definition at line 38 of file Abstract.php.

$_parentItem = null [protected]

Definition at line 36 of file Abstract.php.

---

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

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