Mage_Checkout_Helper_Data Class Reference

Inheritance diagram for Mage_Checkout_Helper_Data:

List of all members.

Public Member Functions
	getCheckout ()
	getQuote ()
	formatPrice ($price)
	convertPrice ($price, $format=true)
	getRequiredAgreementIds ()
	canOnepageCheckout ()
	getPriceInclTax ($item)
	getSubtotalInclTax ($item)
	getBasePriceInclTax ($item)
	getBaseSubtotalInclTax ($item)
	sendPaymentFailedEmail ($checkout, $message, $checkoutType= 'onepage')
	isMultishippingCheckoutAvailable ()
	isAllowedGuestCheckout (Mage_Sales_Model_Quote $quote, $store=null)
Public Attributes
const	XML_PATH_GUEST_CHECKOUT = 'checkout/options/guest_checkout'
Protected Member Functions
	_getEmails ($configPath, $storeId)
Protected Attributes
	$_agreements = null

---

Detailed Description

Checkout default helper

Author:

Magento Core Team <core@magentocommerce.com>

Definition at line 32 of file Data.php.

---

Member Function Documentation

_getEmails	(	$	configPath,
		$	storeId
	)			[protected]

Definition at line 231 of file Data.php.

    {
        $data = Mage::getStoreConfig($configPath, $storeId);
        if (!empty($data)) {
            return explode(',', $data);
        }
        return false;
    }

canOnepageCheckout

(

)

Get onepage checkout availability

Returns:

bool

Definition at line 88 of file Data.php.

    {
        if (Mage::getStoreConfig('checkout/options/onepage_checkout_disabled')) {
            return false;
        }
        return true;
    }

convertPrice	(	$	price,
		$	format = true
	)

Definition at line 63 of file Data.php.

    {
        return $this->getQuote()->getStore()->convertPrice($price, $format);
    }

formatPrice

(

$

price

)

Definition at line 58 of file Data.php.

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

getBasePriceInclTax

(

$

item

)

Definition at line 127 of file Data.php.

    {
        //$price = ($item->getCalculationPrice() ? $item->getCalculationPrice() : $item->getPrice());
        $qty = ($item->getQty() ? $item->getQty() : ($item->getQtyOrdered() ? $item->getQtyOrdered() : 1));
        //$tax = ($item->getTaxBeforeDiscount() ? $item->getTaxBeforeDiscount() : $item->getTaxAmount());
        //$price = Mage::app()->getStore()->roundPrice($price+($tax/$qty));
        $price = Mage::app()->getStore()->roundPrice(($item->getBaseRowTotal()+$item->getBaseTaxAmount())/$qty);
        return $price;
    }

getBaseSubtotalInclTax

(

$

item

)

Definition at line 137 of file Data.php.

    {
        $tax = ($item->getBaseTaxBeforeDiscount() ? $item->getBaseTaxBeforeDiscount() : $item->getBaseTaxAmount());
        return $item->getBaseRowTotal()+$tax;
    }

getCheckout

(

)

Retrieve checkout session model

Returns:

Mage_Checkout_Model_Session

Definition at line 43 of file Data.php.

    {
        return Mage::getSingleton('checkout/session');
    }

getPriceInclTax

(

$

item

)

Definition at line 96 of file Data.php.

    {
        //$price = ($item->getCalculationPrice() ? $item->getCalculationPrice() : $item->getPrice());
        $qty = ($item->getQty() ? $item->getQty() : ($item->getQtyOrdered() ? $item->getQtyOrdered() : 1));
        //$tax = ($item->getTaxBeforeDiscount() ? $item->getTaxBeforeDiscount() : $item->getTaxAmount());
        //$price = Mage::app()->getStore()->roundPrice($price+($tax/$qty));
        $price = Mage::app()->getStore()->roundPrice(($item->getRowTotal()+$item->getTaxAmount())/$qty);
        return $price;
    }

getQuote

(

)

Retrieve checkout quote model object

Returns:

Mage_Sales_Model_Quote

Definition at line 53 of file Data.php.

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

getRequiredAgreementIds

(

)

Definition at line 68 of file Data.php.

    {
        if (is_null($this->_agreements)) {
            if (!Mage::getStoreConfigFlag('checkout/options/enable_agreements')) {
                $this->_agreements = array();
            } else {
                $this->_agreements = Mage::getModel('checkout/agreement')->getCollection()
                    ->addStoreFilter(Mage::app()->getStore()->getId())
                    ->addFieldToFilter('is_active', 1)
                    ->getAllIds();
            }
        }
        return $this->_agreements;
    }

getSubtotalInclTax

(

$

item

)

Definition at line 106 of file Data.php.

    {
        if ($item instanceof Mage_Sales_Model_Order_Item) {
            $store = $item->getOrder()->getStore();
        } elseif($item instanceof Mage_Sales_Model_Order_Invoice_Item) {
            $store = $item->getInvoice()->getOrder()->getStore();
        } elseif($item instanceof Mage_Sales_Model_Order_Shipment_Item) {
            $store = $item->getShipment()->getOrder()->getStore();
        } elseif($item instanceof Mage_Sales_Model_Order_Creditmemo_Item) {
            $store = $item->getCreditmemo()->getOrder()->getStore();
        } else {
            $store = $item->getQuote()->getStore();
        }
        if (!Mage::helper('tax')->applyTaxAfterDiscount($store) and $item->getTaxBeforeDiscount()) {
            $tax = $item->getTaxBeforeDiscount();
        } else {
            $tax = $item->getTaxAmount();
        }
        return $item->getRowTotal() + $tax;
    }

isAllowedGuestCheckout	(	Mage_Sales_Model_Quote $	quote,
		$	store = null
	)

Check is allowed Guest Checkout Use config settings and observer

Parameters:

	Mage_Sales_Model_Quote	$quote
	int|Mage_Core_Model_Store	$store

Returns:

bool

Definition at line 270 of file Data.php.

    {
        $guestCheckout = Mage::getStoreConfigFlag(self::XML_PATH_GUEST_CHECKOUT, $store);

        if ($guestCheckout == true) {
            $result = new Varien_Object();
            $result->setIsAllowed($guestCheckout);
            Mage::dispatchEvent('checkout_allow_guest', array(
                'quote'  => $quote,
                'store'  => $store,
                'result' => $result
            ));

            $guestCheckout = $result->getIsAllowed();
        }

        return $guestCheckout;
    }

isMultishippingCheckoutAvailable

(

)

Check if multishipping checkout is available. There should be a valid quote in checkout session. If not, only the config value will be returned.

Returns:

bool

Definition at line 246 of file Data.php.

    {
        $quote = $this->getQuote();
        $isMultiShipping = (bool)(int)Mage::getStoreConfig('shipping/option/checkout_multiple');
        if ((!$quote) || !$quote->hasItems()) {
            return $isMultiShipping;
        }
        $maximunQty = (int)Mage::getStoreConfig('shipping/option/checkout_multiple_maximum_qty');
        return $isMultiShipping
            && !$quote->hasItemsWithDecimalQty()
            && $quote->validateMinimumAmount(true)
            && (($quote->getItemsSummaryQty() - $quote->getItemVirtualQty()) > 0)
            && ($quote->getItemsSummaryQty() <= $maximunQty)
        ;
    }

sendPaymentFailedEmail	(	$	checkout,
		$	message,
		$	checkoutType = 'onepage'
	)

Send email id payment was failed

Parameters:

	Mage_Sales_Model_Quote	$checkout
	string	$message
	string	$checkoutType

Returns:

Mage_Checkout_Helper_Data

Definition at line 151 of file Data.php.

    {
        $translate = Mage::getSingleton('core/translate');
        /* @var $translate Mage_Core_Model_Translate */
        $translate->setTranslateInline(false);

        $mailTemplate = Mage::getModel('core/email_template');
        /* @var $mailTemplate Mage_Core_Model_Email_Template */

        $template = Mage::getStoreConfig('checkout/payment_failed/template', $checkout->getStoreId());

        $copyTo = $this->_getEmails('checkout/payment_failed/copy_to', $checkout->getStoreId());
        $copyMethod = Mage::getStoreConfig('checkout/payment_failed/copy_method', $checkout->getStoreId());
        if ($copyTo && $copyMethod == 'bcc') {
            $mailTemplate->addBcc($copyTo);
        }

        $_reciever = Mage::getStoreConfig('checkout/payment_failed/reciever', $checkout->getStoreId());
        $sendTo = array(
            array(
                'email' => Mage::getStoreConfig('trans_email/ident_'.$_reciever.'/email', $checkout->getStoreId()),
                'name'  => Mage::getStoreConfig('trans_email/ident_'.$_reciever.'/name', $checkout->getStoreId())
            )
        );

        if ($copyTo && $copyMethod == 'copy') {
            foreach ($copyTo as $email) {
                $sendTo[] = array(
                    'email' => $email,
                    'name'  => null
                );
            }
        }
        $shippingMethod = '';
        if ($shippingInfo = $checkout->getShippingAddress()->getShippingMethod()) {
            $data = explode('_', $shippingInfo);
            $shippingMethod = $data[0];
        }

        $paymentMethod = '';
        if ($paymentInfo = $checkout->getPayment()) {
            $paymentMethod = $paymentInfo->getMethod();
        }

        $items = '';
        foreach ($checkout->getItemsCollection() as $_item) {
            /* @var $_item Mage_Sales_Model_Quote_Item */
            $items .= $_item->getProduct()->getName() . '  x '. $_item->getQty() . '  '
                    . $checkout->getStoreCurrencyCode() . ' ' . $_item->getProduct()->getFinalPrice($_item->getQty()) . "\n";
        }
        $total = $checkout->getStoreCurrencyCode() . ' ' . $checkout->getGrandTotal();

        foreach ($sendTo as $recipient) {
            $mailTemplate->setDesignConfig(array('area'=>'frontend', 'store'=>$checkout->getStoreId()))
                ->sendTransactional(
                    $template,
                    Mage::getStoreConfig('checkout/payment_failed/identity', $checkout->getStoreId()),
                    $recipient['email'],
                    $recipient['name'],
                    array(
                        'reason' => $message,
                        'checkoutType' => $checkoutType,
                        'dateAndTime' => Mage::app()->getLocale()->date(),
                        'customer' => $checkout->getCustomerFirstname() . ' ' . $checkout->getCustomerLastname(),
                        'customerEmail' => $checkout->getCustomerEmail(),
                        'billingAddress' => $checkout->getBillingAddress(),
                        'shippingAddress' => $checkout->getShippingAddress(),
                        'shippingMethod' => Mage::getStoreConfig('carriers/'.$shippingMethod.'/title'),
                        'paymentMethod' => Mage::getStoreConfig('payment/'.$paymentMethod.'/title'),
                        'items' => nl2br($items),
                        'total' => $total
                    )
                );
        }

        $translate->setTranslateInline(true);

        return $this;
    }

---

Member Data Documentation

$_agreements = null [protected]

Definition at line 36 of file Data.php.

const XML_PATH_GUEST_CHECKOUT = 'checkout/options/guest_checkout'

Definition at line 34 of file Data.php.

---

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

• app/code/core/Mage/Checkout/Helper/Data.php