Docs For Class Mage_Checkout_Helper

Description

Checkout default helper

author: Magento Core Team <[email protected]>

Located in /Checkout/Helper/Data.php (line 32)

Mage_Core_Helper_Abstract
   |
   --Mage_Checkout_Helper_Data

Class Constant Summary

XML_PATH_GUEST_CHECKOUT = 'checkout/options/guest_checkout'

Variable Summary

mixed $_agreements

Method Summary

bool canOnepageCheckout ()

void convertPrice ( $price, [ $format = true])

void formatPrice ( $price)

void getBasePriceInclTax ( $item)

void getBaseSubtotalInclTax ( $item)

Mage_Checkout_Model_Session getCheckout ()

float getPriceInclTax (Varien_Object $item)

Mage_Sales_Model_Quote getQuote ()

void getRequiredAgreementIds ()

float getSubtotalInclTax (Varien_Object $item)

bool isAllowedGuestCheckout ( $quote, [int|Mage_Core_Model_Store $store = null])

bool isMultishippingCheckoutAvailable ()

Mage_Checkout_Helper_Data sendPaymentFailedEmail (Mage_Sales_Model_Quote $checkout, string $message, [string $checkoutType = 'onepage'])

void _getEmails ( $configPath, $storeId)

Variables

mixed $_agreements = null (line 36)

access: protected

Inherited Variables

Inherited from Mage_Core_Helper_Abstract

Mage_Core_Helper_Abstract::$_layout
Mage_Core_Helper_Abstract::$_moduleName
Mage_Core_Helper_Abstract::$_request

Methods

canOnepageCheckout (line 88)

Get onepage checkout availability

access: public

bool canOnepageCheckout ()

convertPrice (line 63)

access: public

void convertPrice ( $price, [ $format = true])

$price
$format

formatPrice (line 58)

access: public

void formatPrice ( $price)

$price

getBasePriceInclTax (line 124)

access: public

void getBasePriceInclTax ( $item)

$item

getBaseSubtotalInclTax (line 131)

access: public

void getBaseSubtotalInclTax ( $item)

$item

getCheckout (line 43)

Retrieve checkout session model

access: public

Mage_Checkout_Model_Session getCheckout ()

getPriceInclTax (line 99)

Get sales item (quote item, order item etc) price including tax based on row total and tax amount

access: public

float getPriceInclTax (Varien_Object $item)

Varien_Object $item

getQuote (line 53)

Retrieve checkout quote model object

access: public

Mage_Sales_Model_Quote getQuote ()

getRequiredAgreementIds (line 68)

access: public

void getRequiredAgreementIds ()

getSubtotalInclTax (line 115)

Get sales item (quote item, order item etc) row total price including tax

access: public

float getSubtotalInclTax (Varien_Object $item)

Varien_Object $item

isAllowedGuestCheckout (line 265)

Check is allowed Guest Checkout Use config settings and observer

access: public

bool isAllowedGuestCheckout ( $quote, [int|Mage_Core_Model_Store $store = null])

Mage_Sales_Model_Quote $quote
int|Mage_Core_Model_Store $store

isMultishippingCheckoutAvailable (line 240)

Check if multishipping checkout is available.

There should be a valid quote in checkout session. If not, only the config value will be returned.

access: public

bool isMultishippingCheckoutAvailable ()

sendPaymentFailedEmail (line 145)

Send email id payment was failed

access: public

Mage_Checkout_Helper_Data sendPaymentFailedEmail (Mage_Sales_Model_Quote $checkout, string $message, [string $checkoutType = 'onepage'])

Mage_Sales_Model_Quote $checkout
string $message
string $checkoutType

_getEmails (line 225)

access: protected

void _getEmails ( $configPath, $storeId)

$configPath
$storeId

Inherited Methods

Inherited From Mage_Core_Helper_Abstract

Mage_Core_Helper_Abstract::escapeHtml()
Mage_Core_Helper_Abstract::escapeUrl()
Mage_Core_Helper_Abstract::getLayout()
Mage_Core_Helper_Abstract::htmlEscape()
Mage_Core_Helper_Abstract::isModuleEnabled()
Mage_Core_Helper_Abstract::isModuleOutputEnabled()
Mage_Core_Helper_Abstract::jsQuoteEscape()
Mage_Core_Helper_Abstract::setLayout()
Mage_Core_Helper_Abstract::stripTags()
Mage_Core_Helper_Abstract::translateArray()
Mage_Core_Helper_Abstract::urlDecode()
Mage_Core_Helper_Abstract::urlEncode()
Mage_Core_Helper_Abstract::urlEscape()
Mage_Core_Helper_Abstract::_cleanCache()
Mage_Core_Helper_Abstract::_getModuleName()
Mage_Core_Helper_Abstract::_getRequest()
Mage_Core_Helper_Abstract::_getUrl()
Mage_Core_Helper_Abstract::_loadCache()
Mage_Core_Helper_Abstract::_removeCache()
Mage_Core_Helper_Abstract::_saveCache()
Mage_Core_Helper_Abstract::__()

Class Constants

XML_PATH_GUEST_CHECKOUT = 'checkout/options/guest_checkout' (line 34)

Class Mage_Checkout_Helper_Data

Inherited Variables

Inherited Methods