Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage_Payment_Block_Catalog_Product_View_Profile
  • Mage_Payment_Block_Form
  • Mage_Payment_Block_Form_Banktransfer
  • Mage_Payment_Block_Form_Cashondelivery
  • Mage_Payment_Block_Form_Cc
  • Mage_Payment_Block_Form_Ccsave
  • Mage_Payment_Block_Form_Checkmo
  • Mage_Payment_Block_Form_Container
  • Mage_Payment_Block_Form_Purchaseorder
  • Mage_Payment_Block_Info
  • Mage_Payment_Block_Info_Banktransfer
  • Mage_Payment_Block_Info_Cc
  • Mage_Payment_Block_Info_Ccsave
  • Mage_Payment_Block_Info_Checkmo
  • Mage_Payment_Block_Info_Container
  • Mage_Payment_Block_Info_Purchaseorder
  • Mage_Payment_Helper_Data
  • Mage_Payment_Model_Billing_AgreementAbstract
  • Mage_Payment_Model_Config
  • Mage_Payment_Model_Info
  • Mage_Payment_Model_Method_Abstract
  • Mage_Payment_Model_Method_Banktransfer
  • Mage_Payment_Model_Method_Cashondelivery
  • Mage_Payment_Model_Method_Cc
  • Mage_Payment_Model_Method_Ccsave
  • Mage_Payment_Model_Method_Checkmo
  • Mage_Payment_Model_Method_Free
  • Mage_Payment_Model_Method_Purchaseorder
  • Mage_Payment_Model_Observer
  • Mage_Payment_Model_Paygate_Result
  • Mage_Payment_Model_Recurring_Profile
  • Mage_Payment_Model_Source_Cctype
  • Mage_Payment_Model_Source_Invoice

Interfaces

  • Mage_Payment_Model_Billing_Agreement_MethodInterface
  • Mage_Payment_Model_Recurring_Profile_MethodInterface

Exceptions

  • Mage_Payment_Exception
  • Mage_Payment_Model_Info_Exception
  • Overview
  • Package
  • Class
  • Tree

Class Mage_Payment_Helper_Data

Payment module base helper

Mage_Core_Helper_Abstract
Extended by Mage_Payment_Helper_Data

Direct known subclasses

Phoenix_Moneybookers_Helper_Data
Package: Mage\Payment
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Payment/Helper/Data.php
Methods summary
public Mage_Payment_Model_Method_Abstract|false
# getMethodInstance( string $code )

Retrieve method model object

Retrieve method model object

Parameters

$code
string
$code

Returns

Mage_Payment_Model_Method_Abstract|false
public array
# getStoreMethods( mixed $store = null, Mage_Sales_Model_Quote $quote = null )

Get and sort available payment methods for specified or current store

Get and sort available payment methods for specified or current store

array structure: $index => Varien_Simplexml_Element

Parameters

$store
mixed
$store
$quote
Mage_Sales_Model_Quote
$quote

Returns

array
protected
# _sortMethods( mixed $a, mixed $b )
public Mage_Payment_Block_Form
# getMethodFormBlock( Mage_Payment_Model_Method_Abstract $method )

Retreive payment method form html

Retreive payment method form html

Parameters

$method
Mage_Payment_Model_Abstract
$method

Returns

Mage_Payment_Block_Form
public Mage_Core_Block_Template
# getInfoBlock( Mage_Payment_Model_Info $info )

Retrieve payment information block

Retrieve payment information block

Parameters

$info
Mage_Payment_Model_Info
$info

Returns

Mage_Core_Block_Template
public array
# getBillingAgreementMethods( mixed $store = null, Mage_Sales_Model_Quote $quote = null )

Retrieve available billing agreement methods

Retrieve available billing agreement methods

Parameters

$store
mixed
$store
$quote
Mage_Sales_Model_Quote
$quote

Returns

array
public array
# getRecurringProfileMethods( mixed $store = null )

Get payment methods that implement recurring profilez management

Get payment methods that implement recurring profilez management

Parameters

$store
mixed
$store

Returns

array
public array
# getPaymentMethods( mixed $store = null )

Retrieve all payment methods

Retrieve all payment methods

Parameters

$store
mixed
$store

Returns

array
public array
# getPaymentMethodList( boolean $sorted = true, boolean $asLabelValue = false, boolean $withGroups = false, mixed $store = null )

Retrieve all payment methods list as an array

Retrieve all payment methods list as an array

Possible output:

  1. assoc array as <code> => <title>
  2. array of array('label' => <title>, 'value' => <code>)
  3. array of array( array('value' => <code>, 'label' => <title>), array('value' => array( 'value' => array(array(<code1> => <title1>, <code2> =>...), 'label' => <group name> )), array('value' => <code>, 'label' => <title>), ... )

Parameters

$sorted
boolean
$sorted
$asLabelValue
boolean
$asLabelValue
$withGroups
boolean
$withGroups
$store

Returns

array
public array
# getAllBillingAgreementMethods( )

Retrieve all billing agreement methods (code and label)

Retrieve all billing agreement methods (code and label)

Returns

array
public boolean
# isZeroSubTotal( mixed $store = null )

Returns value of Zero Subtotal Checkout / Enabled

Returns value of Zero Subtotal Checkout / Enabled

Parameters

$store
mixed
$store

Returns

boolean
public string
# getZeroSubTotalOrderStatus( mixed $store = null )

Returns value of Zero Subtotal Checkout / New Order Status

Returns value of Zero Subtotal Checkout / New Order Status

Parameters

$store
mixed
$store

Returns

string
public string
# getZeroSubTotalPaymentAutomaticInvoice( mixed $store = null )

Returns value of Zero Subtotal Checkout / Automatically Invoice All Items

Returns value of Zero Subtotal Checkout / Automatically Invoice All Items

Parameters

$store
mixed
$store

Returns

string
Methods inherited from Mage_Core_Helper_Abstract
__(), _cleanCache(), _getModuleName(), _getRequest(), _getUrl(), _loadCache(), _removeCache(), _saveCache(), escapeHtml(), escapeUrl(), getLayout(), isModuleEnabled(), isModuleOutputEnabled(), jsQuoteEscape(), quoteEscape(), removeTags(), setLayout(), stripTags(), translateArray(), urlDecode(), urlEncode()
Constants summary
string XML_PATH_PAYMENT_METHODS 'payment'
#
string XML_PATH_PAYMENT_GROUPS 'global/payment/groups'
#
Properties inherited from Mage_Core_Helper_Abstract
$_layout, $_moduleName, $_request
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0