Class Mage_Paypal_Model_Hostedpro

Description
Description | Vars (details) | Methods (details) Constants (details)

Website Payments Pro Hosted Solution payment gateway model

  • author: Magento Core Team <[email protected]>
  • copyright: Copyright (c) 2010 Magento Inc. (http://www.magentocommerce.com)

Located in /Paypal/Model/Hostedpro.php (line 35) 

Varien_Object
   |
   --Mage_Payment_Model_Method_Abstract
      |
      --Mage_Payment_Model_Method_Cc
         |
         --Mage_Paypal_Model_Direct
            |
            --Mage_Paypal_Model_Hostedpro
Class Constant Summary
Description | Constants (details) Vars (details) | | Methods (details)
BM_BUTTON_CODE = 'TOKEN'
BM_BUTTON_METHOD = 'BMCreateButton'
BM_BUTTON_TYPE = 'PAYMENT'
Variable Summary
Description | Vars (details) | Methods (details) Constants (details)
mixed $_canSaveCc
mixed $_canUseForMultishipping
mixed $_canUseInternal
mixed $_code
mixed $_formBlockType
mixed $_infoBlockType
mixed $_isInitializeNeeded
Method Summary
Description | Constants (details) Vars (details) | Methods (details)
bool getAllowedCcTypes ()
string getCancelUrl ([int $storeId = null])
string getMerchantCountry ()
string getNotifyUrl ([int $storeId = null])
string getReturnUrl ([int $storeId = null])
void initialize (string $paymentAction, Varien_Object $stateObject)
bool validate ()
Mage_Paypal_Model_Hostedpro_Request _buildBasicRequest ()
Mage_Paypal_Model_Hostedpro_Request _buildFormUrlRequest ( $payment)
string _getUrl (string $path, int $storeId, [bool $secure = null])
string _sendFormUrlRequest (Mage_Paypal_Model_Hostedpro_Request $request)
void _setPaymentFormUrl ( $payment)
Variables
Description | Vars (details) Constants (details) | Methods (details)
mixed $_canSaveCc = false (line 71)
  • access: protected
Redefinition of:
Mage_Paypal_Model_Direct::$_canSaveCc
mixed $_canUseForMultishipping = false (line 70)
  • access: protected
Redefinition of:
Mage_Paypal_Model_Direct::$_canUseForMultishipping
mixed $_canUseInternal = false (line 69)

Availability options

  • access: protected
Redefinition of:
Mage_Paypal_Model_Direct::$_canUseInternal
mixed $_code = Mage_Paypal_Model_Config::METHOD_HOSTEDPRO (line 61)

Payment method code

  • access: protected
Redefinition of:
Mage_Paypal_Model_Direct::$_code
mixed $_formBlockType = 'paypal/payflow_link_form' (line 63)
  • access: protected
Redefinition of:
Mage_Payment_Model_Method_Cc::$_formBlockType
mixed $_infoBlockType = 'paypal/payflow_link_info' (line 64)
  • access: protected
Redefinition of:
Mage_Paypal_Model_Direct::$_infoBlockType
mixed $_isInitializeNeeded = true (line 72)
  • access: protected
Redefinition of:
Mage_Payment_Model_Method_Abstract::$_isInitializeNeeded

Inherited Variables

Inherited from Mage_Paypal_Model_Direct

Mage_Paypal_Model_Direct::$_canAuthorize
 Mage_Paypal_Model_Direct::$_canCapture
 Mage_Paypal_Model_Direct::$_canCapturePartial
 Mage_Paypal_Model_Direct::$_canFetchTransactionInfo
 Mage_Paypal_Model_Direct::$_canRefund
 Mage_Paypal_Model_Direct::$_canRefundInvoicePartial
 Mage_Paypal_Model_Direct::$_canReviewPayment
 Mage_Paypal_Model_Direct::$_canUseCheckout
 Mage_Paypal_Model_Direct::$_canVoid
 Mage_Paypal_Model_Direct::$_isGateway
 Mage_Paypal_Model_Direct::$_pro
 Mage_Paypal_Model_Direct::$_proType

Inherited from Mage_Payment_Model_Method_Abstract

Mage_Payment_Model_Method_Abstract::$_canCancelInvoice
 Mage_Payment_Model_Method_Abstract::$_canCreateBillingAgreement
 Mage_Payment_Model_Method_Abstract::$_canManageRecurringProfiles
 Mage_Payment_Model_Method_Abstract::$_canOrder
 Mage_Payment_Model_Method_Abstract::$_debugReplacePrivateDataKeys
Methods
Description | Vars (details) Constants (details) Methods (details)
getAllowedCcTypes (line 80)

Return available CC types for gateway based on merchant country.

We do not have to check the availability of card types.

  • access: public
bool getAllowedCcTypes ()
Redefinition of:
Mage_Paypal_Model_Direct::getAllowedCcTypes()
Return available CC types for gateway based on merchant country
getCancelUrl (line 226)

Get cancel URL

  • access: public
string getCancelUrl ([int $storeId = null])
  • int $storeId
getMerchantCountry (line 91)

Return merchant country code from config, use default country if it not specified in General settings

  • access: public
string getMerchantCountry ()
getNotifyUrl (line 215)

Get notify (IPN) URL

  • access: public
string getNotifyUrl ([int $storeId = null])
  • int $storeId
getReturnUrl (line 204)

Get return URL

  • access: public
string getReturnUrl ([int $storeId = null])
  • int $storeId
initialize (line 112)

Instantiate state and set it to state object

  • access: public
void initialize (string $paymentAction, Varien_Object $stateObject)
  • string $paymentAction
  • Varien_Object $stateObject
Redefinition of:
Mage_Payment_Model_Method_Abstract::initialize()
Method that will be executed instead of authorize or capture if flag isInitilizeNeeded set to true
validate (line 101)

Do not validate payment form using server methods

  • access: public
bool validate ()
Redefinition of:
Mage_Payment_Model_Method_Cc::validate()
Validate payment method information object
_buildBasicRequest (line 187)

Return request object with basic information

  • access: protected
Mage_Paypal_Model_Hostedpro_Request _buildBasicRequest ()
_buildFormUrlRequest (line 156)

Returns request object with needed data for API request to PayPal to get form URL.

  • access: protected
Mage_Paypal_Model_Hostedpro_Request _buildFormUrlRequest ( $payment)
_getUrl (line 239)

Build URL for store

  • access: protected
string _getUrl (string $path, int $storeId, [bool $secure = null])
  • string $path
  • int $storeId
  • bool $secure
_sendFormUrlRequest (line 171)

Returns form URL from request to PayPal.

  • return: | false
  • access: protected
string _sendFormUrlRequest (Mage_Paypal_Model_Hostedpro_Request $request)
_setPaymentFormUrl (line 139)

Sends API request to PayPal to get form URL, then sets this URL to $payment object.

  • access: protected
void _setPaymentFormUrl ( $payment)

Inherited Methods

Inherited From Mage_Paypal_Model_Direct

Mage_Paypal_Model_Direct::__construct()
Mage_Paypal_Model_Direct::acceptPayment()
Mage_Paypal_Model_Direct::authorize()
Mage_Paypal_Model_Direct::cancel()
Mage_Paypal_Model_Direct::canReviewPayment()
Mage_Paypal_Model_Direct::canUseForCurrency()
Mage_Paypal_Model_Direct::canVoid()
Mage_Paypal_Model_Direct::capture()
Mage_Paypal_Model_Direct::denyPayment()
Mage_Paypal_Model_Direct::fetchTransactionInfo()
Mage_Paypal_Model_Direct::getAllowedCcTypes()
Mage_Paypal_Model_Direct::getCentinelValidator()
Mage_Paypal_Model_Direct::getConfigData()
Mage_Paypal_Model_Direct::getConfigPaymentAction()
Mage_Paypal_Model_Direct::isAvailable()
Mage_Paypal_Model_Direct::refund()
Mage_Paypal_Model_Direct::setStore()
Mage_Paypal_Model_Direct::void()
Mage_Paypal_Model_Direct::_getFormattedCcExpirationDate()
Mage_Paypal_Model_Direct::_importResultToPayment()
Mage_Paypal_Model_Direct::_placeOrder()

Inherited From Mage_Payment_Model_Method_Cc

Mage_Payment_Model_Method_Cc::assignData()
Mage_Payment_Model_Method_Cc::getCentinelValidationData()
Mage_Payment_Model_Method_Cc::getCentinelValidator()
Mage_Payment_Model_Method_Cc::getIsCentinelValidationEnabled()
Mage_Payment_Model_Method_Cc::getVerificationRegEx()
Mage_Payment_Model_Method_Cc::hasVerification()
Mage_Payment_Model_Method_Cc::isAvailable()
Mage_Payment_Model_Method_Cc::OtherCcType()
Mage_Payment_Model_Method_Cc::prepareSave()
Mage_Payment_Model_Method_Cc::validate()
Mage_Payment_Model_Method_Cc::validateCcNum()
Mage_Payment_Model_Method_Cc::validateCcNumOther()
Mage_Payment_Model_Method_Cc::_validateExpDate()

Inherited From Mage_Payment_Model_Method_Abstract

Mage_Payment_Model_Method_Abstract::__construct()
Mage_Payment_Model_Method_Abstract::acceptPayment()
Mage_Payment_Model_Method_Abstract::assignData()
Mage_Payment_Model_Method_Abstract::authorize()
Mage_Payment_Model_Method_Abstract::canAuthorize()
Mage_Payment_Model_Method_Abstract::canCapture()
Mage_Payment_Model_Method_Abstract::canCapturePartial()
Mage_Payment_Model_Method_Abstract::cancel()
Mage_Payment_Model_Method_Abstract::canCreateBillingAgreement()
Mage_Payment_Model_Method_Abstract::canEdit()
Mage_Payment_Model_Method_Abstract::canFetchTransactionInfo()
Mage_Payment_Model_Method_Abstract::canManageBillingAgreements()
Mage_Payment_Model_Method_Abstract::canManageRecurringProfiles()
Mage_Payment_Model_Method_Abstract::canOrder()
Mage_Payment_Model_Method_Abstract::canRefund()
Mage_Payment_Model_Method_Abstract::canRefundPartialPerInvoice()
Mage_Payment_Model_Method_Abstract::canReviewPayment()
Mage_Payment_Model_Method_Abstract::canUseCheckout()
Mage_Payment_Model_Method_Abstract::canUseForCountry()
Mage_Payment_Model_Method_Abstract::canUseForCurrency()
Mage_Payment_Model_Method_Abstract::canUseForMultishipping()
Mage_Payment_Model_Method_Abstract::canUseInternal()
Mage_Payment_Model_Method_Abstract::canVoid()
Mage_Payment_Model_Method_Abstract::capture()
Mage_Payment_Model_Method_Abstract::debugData()
Mage_Payment_Model_Method_Abstract::denyPayment()
Mage_Payment_Model_Method_Abstract::fetchTransactionInfo()
Mage_Payment_Model_Method_Abstract::getCode()
Mage_Payment_Model_Method_Abstract::getConfigData()
Mage_Payment_Model_Method_Abstract::getConfigPaymentAction()
Mage_Payment_Model_Method_Abstract::getDebugFlag()
Mage_Payment_Model_Method_Abstract::getFormBlockType()
Mage_Payment_Model_Method_Abstract::getInfoBlockType()
Mage_Payment_Model_Method_Abstract::getInfoInstance()
Mage_Payment_Model_Method_Abstract::getTitle()
Mage_Payment_Model_Method_Abstract::initialize()
Mage_Payment_Model_Method_Abstract::isAvailable()
Mage_Payment_Model_Method_Abstract::isGateway()
Mage_Payment_Model_Method_Abstract::isInitializeNeeded()
Mage_Payment_Model_Method_Abstract::order()
Mage_Payment_Model_Method_Abstract::prepareSave()
Mage_Payment_Model_Method_Abstract::processBeforeRefund()
Mage_Payment_Model_Method_Abstract::processBeforeVoid()
Mage_Payment_Model_Method_Abstract::processCreditmemo()
Mage_Payment_Model_Method_Abstract::processInvoice()
Mage_Payment_Model_Method_Abstract::refund()
Mage_Payment_Model_Method_Abstract::validate()
Mage_Payment_Model_Method_Abstract::void()
Mage_Payment_Model_Method_Abstract::_debug()
Mage_Payment_Model_Method_Abstract::_getHelper()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)
BM_BUTTON_CODE = 'TOKEN' (line 42)

Button code

BM_BUTTON_METHOD = 'BMCreateButton' (line 56)

Paypal API method name for button creation

BM_BUTTON_TYPE = 'PAYMENT' (line 49)

Button type

Inherited Constants

Inherited from Mage_Payment_Model_Method_Abstract

Mage_Payment_Model_Method_Abstract::ACTION_AUTHORIZE
 Mage_Payment_Model_Method_Abstract::ACTION_AUTHORIZE_CAPTURE
 Mage_Payment_Model_Method_Abstract::ACTION_ORDER
 Mage_Payment_Model_Method_Abstract::STATUS_APPROVED
 Mage_Payment_Model_Method_Abstract::STATUS_DECLINED
 Mage_Payment_Model_Method_Abstract::STATUS_ERROR
 Mage_Payment_Model_Method_Abstract::STATUS_SUCCESS
 Mage_Payment_Model_Method_Abstract::STATUS_UNKNOWN
 Mage_Payment_Model_Method_Abstract::STATUS_VOID

Documentation generated on Fri, 11 Feb 2011 17:06:14 +0200 by phpDocumentor 1.4.3