Class Mage_Paypal_Model_Cart

PayPal-specific model for shopping cart items and totals The main idea is to accommodate all possible totals into PayPal-compatible 4 totals and line items

Package: Mage\Paypal
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Located at code/core/Mage/Paypal/Model/Cart.php

Methods summary
`public`	# `__construct( array $params = array() )` Require instance of an order or a quote Require instance of an order or a quote Parameters `$params` `array` $params
`public Mage_Sales_Model_Order`	# `getSalesEntity( )` Getter for the current sales entity Getter for the current sales entity Returns `Mage_Sales_Model_Order` `Mage_Sales_Model_Quote`
`public array\|false`	# `getItems( boolean $bypassValidation = false )` Render and get line items By default returns false if the items are invalid Render and get line items By default returns false if the items are invalid Parameters `$bypassValidation` `boolean` $bypassValidation Returns `array\|false`
`public array`	# `getTotals( boolean $mergeDiscount = false )` Render and get totals If the totals are invalid for any reason, they will be merged into one amount (subtotal is utilized for it) An option to substract discount from the subtotal is available Render and get totals If the totals are invalid for any reason, they will be merged into one amount (subtotal is utilized for it) An option to substract discount from the subtotal is available Parameters `$mergeDiscount` `boolean` $mergeDiscount Returns `array`
`public Varien_Object`	# `addItem( string $name, numeric $qty, float $amount, string $identifier = null )` Add a line item Add a line item Parameters `$name` `string` $name `$qty` `numeric` $qty `$amount` `float` $amount `$identifier` `string` $identifier Returns `Varien_Object`
`public boolean`	# `removeItem( string $identifier )` Remove item from cart by identifier Remove item from cart by identifier Parameters `$identifier` `string` $identifier Returns `boolean`
`public Mage_Paypal_Model_Cart`	# `updateTotal( string $code, float $amount, string $lineItemDescription = null )` Compound the specified amount with the specified total Compound the specified amount with the specified total Parameters `$code` `string` $code `$amount` `float` $amount `$lineItemDescription` `string` $lineItemDescription Returns `Mage_Paypal_Model_Cart`
`public boolean\|Mage_Paypal_Model_Cart`	# `isDiscountAsItem( mixed $setValue = null )` Get/Set whether to render the discount total as a line item Get/Set whether to render the discount total as a line item Parameters `$setValue` `mixed` $setValue Returns `boolean\|Mage_Paypal_Model_Cart`
`public boolean\|Mage_Paypal_Model_Cart`	# `isShippingAsItem( mixed $setValue = null )` Get/Set whether to render the discount total as a line item Get/Set whether to render the discount total as a line item Parameters `$setValue` `mixed` $setValue Returns `boolean\|Mage_Paypal_Model_Cart`
`protected`	# `_render( )` (re)Render all items and totals (re)Render all items and totals
`protected string`	# `_renderTotalLineItemDescriptions( string $code, string $prepend = '', string $append = '', string $glue = '; ' )` Merge multiple descriptions by a total code into a string Merge multiple descriptions by a total code into a string Parameters `$code` `string` $code `$prepend` `string` $prepend `$append` `string` $append `$glue` `string` $glue Returns `string`
`protected`	# `_validate( )` Check the line items and totals according to PayPal business logic limitations Check the line items and totals according to PayPal business logic limitations
`protected Varien_Object`	# `_addRegularItem( Varien_Object $salesItem )` Add a usual line item with amount and qty Add a usual line item with amount and qty Parameters `$salesItem` `Varien_Object` $salesItem Returns `Varien_Object`
`private boolean\|Mage_Paypal_Model_Cart`	# `_totalAsItem( string $var, mixed $setValue = null )` Get/Set for the specified variable. If the value changes, the re-rendering is commenced Get/Set for the specified variable. If the value changes, the re-rendering is commenced Parameters `$var` `string` $var `$setValue` `mixed` $setValue Returns `boolean\|Mage_Paypal_Model_Cart`
`private`	# `_applyHiddenTaxWorkaround( Mage_Core_Model_Abstract $salesEntity )` Add "hidden" discount and shipping tax Add "hidden" discount and shipping tax Go ahead, try to understand ]:-> Tax settings for getting "discount tax": Catalog Prices = Including Tax Apply Customer Tax = After Discount Apply Discount on Prices = Including Tax Test case for getting "hidden shipping tax": Make sure shipping is taxable (set shipping tax class) Catalog Prices = Including Tax Shipping Prices = Including Tax Apply Customer Tax = After Discount Create a shopping cart price rule with % discount applied to the Shipping Amount run shopping cart and estimate shipping go to PayPal Parameters `$salesEntity` `Mage_Core_Model_Abstract` $salesEntity

Constants summary
`string`	`TOTAL_SUBTOTAL`	`'subtotal'`	# Totals that PayPal suppports when passing shopping cart Totals that PayPal suppports when passing shopping cart
`string`	`TOTAL_DISCOUNT`	`'discount'`	#
`string`	`TOTAL_TAX`	`'tax'`	#
`string`	`TOTAL_SHIPPING`	`'shipping'`	#

Properties summary
`protected Mage_Sales_Model_Order`	`$_salesEntity`	`null`	# Order or quote instance Order or quote instance
`protected array`	`$_items`	`array()`	# Rendered cart items Array of Varien_Objects Rendered cart items Array of Varien_Objects
`protected array`	`$_totals`	`array()`	# Rendered cart totals Associative array with the keys from constants above Rendered cart totals Associative array with the keys from constants above
`protected array`	`$_totalLineItemDescriptions`	`array()`	# Set of optional descriptions for the item that may replace a total and composed of several amounts Array of strings Set of optional descriptions for the item that may replace a total and composed of several amounts Array of strings
`protected boolean`	`$_shouldRender`	`true`	# Lazy initialization indicator for rendering Lazy initialization indicator for rendering
`protected boolean`	`$_areItemsValid`	`false`	# Validation result for the rendered cart items Validation result for the rendered cart items
`protected boolean`	`$_areTotalsValid`	`false`	# Validation result for the rendered totals Validation result for the rendered totals
`protected boolean`	`$_isDiscountAsItem`	`false`	# Whether to render discount total as a line item Use case: WPP Whether to render discount total as a line item Use case: WPP
`protected boolean`	`$_isShippingAsItem`	`false`	# Whether to render shipping total as a line item Use case: WPS Whether to render shipping total as a line item Use case: WPS

Packages

Classes

Exceptions

Class Mage_Paypal_Model_Cart

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters