Class Mage_Paypal_Model_Method_Agreement

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

Implements interfaces:

Paypal Billing Agreement method

Located in /Paypal/Model/Method/Agreement.php (line 32) 

Varien_Object
   |
   --Mage_Payment_Model_Method_Abstract
      |
      --Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract
         |
         --Mage_Paypal_Model_Method_Agreement
Variable Summary
Description | Vars (details) | Methods (details) Constants
mixed $_canAuthorize
mixed $_canCapture
mixed $_canCapturePartial
mixed $_canFetchTransactionInfo
mixed $_canRefund
mixed $_canRefundInvoicePartial
mixed $_canReviewPayment
mixed $_canUseCheckout
mixed $_canUseInternal
mixed $_canVoid
string $_code
Mage_Paypal_Model_Pro $_pro
Method Summary
Description | Constants Vars (details) | Methods (details)
Mage_Paypal_Model_Method_Agreement __construct ([array $params = array()])
bool acceptPayment ( $payment)
Mage_Paypal_Model_Method_Agreement authorize ( $payment, float $amount)
Mage_Paypal_Model_Method_Agreement cancel ( $payment)
bool canReviewPayment ( $payment)
Mage_Paypal_Model_Method_Agreement capture ( $payment, float $amount)
bool denyPayment ( $payment)
array fetchTransactionInfo ( $payment, string $transactionId)
array getBillingAgreementTokenInfo ( $agreement)
string getConfigPaymentAction ()
Mage_Paypal_Model_Method_Agreement initBillingAgreementToken ( $agreement)
Mage_Paypal_Model_Method_Agreement placeBillingAgreement ( $agreement)
Mage_Paypal_Model_Method_Agreement refund ( $payment, float $amount)
void setStore (Mage_Core_Model_Store|int $store)
Mage_Paypal_Model_Method_Agreement updateBillingAgreementStatus ( $agreement)
Mage_Paypal_Model_Method_Agreement void ( $payment)
void _isAvailable ( $quote)
Mage_Paypal_Model_Method_Agreement _placeOrder ( $payment, float $amount)
Variables
Description | Vars (details) Constants | Methods (details)
mixed $_canAuthorize = true (line 46)

Method instance settings

  • access: protected
Redefinition of:
Mage_Payment_Model_Method_Abstract::$_canAuthorize
mixed $_canCapture = true (line 47)
  • access: protected
Redefinition of:
Mage_Payment_Model_Method_Abstract::$_canCapture
mixed $_canCapturePartial = true (line 48)
  • access: protected
Redefinition of:
Mage_Payment_Model_Method_Abstract::$_canCapturePartial
mixed $_canFetchTransactionInfo = true (line 54)
  • access: protected
Redefinition of:
Mage_Payment_Model_Method_Abstract::$_canFetchTransactionInfo
mixed $_canRefund = true (line 49)
  • access: protected
Redefinition of:
Mage_Payment_Model_Method_Abstract::$_canRefund
mixed $_canRefundInvoicePartial = true (line 50)
  • access: protected
Redefinition of:
Mage_Payment_Model_Method_Abstract::$_canRefundInvoicePartial
mixed $_canReviewPayment = true (line 55)
  • access: protected
Redefinition of:
Mage_Payment_Model_Method_Abstract::$_canReviewPayment
mixed $_canUseCheckout = false (line 52)
  • access: protected
Redefinition of:
Mage_Payment_Model_Method_Abstract::$_canUseCheckout
mixed $_canUseInternal = false (line 53)
  • access: protected
Redefinition of:
Mage_Payment_Model_Method_Abstract::$_canUseInternal
mixed $_canVoid = true (line 51)
  • access: protected
Redefinition of:
Mage_Payment_Model_Method_Abstract::$_canVoid
string $_code = Mage_Paypal_Model_Config::METHOD_BILLING_AGREEMENT (line 40)

Method code

  • access: protected
Redefinition of:
Mage_Payment_Model_Method_Abstract::$_code
Mage_Paypal_Model_Pro $_pro = null (line 62)

Website Payments Pro instance

  • access: protected

Inherited Variables

Inherited from Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract

Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract::$_formBlockType
 Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract::$_infoBlockType
 Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract::$_isAvailable

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::$_canUseForMultishipping
 Mage_Payment_Model_Method_Abstract::$_debugReplacePrivateDataKeys
 Mage_Payment_Model_Method_Abstract::$_isGateway
 Mage_Payment_Model_Method_Abstract::$_isInitializeNeeded
Methods
Description | Vars (details) Constants Methods (details)
Constructor __construct (line 69)

Initialize Mage_Paypal_Model_Pro model

  • access: public
Mage_Paypal_Model_Method_Agreement __construct ([array $params = array()])
  • array $params
Redefinition of:
Mage_Payment_Model_Method_Abstract::__construct()
acceptPayment (line 257)

Attempt to accept a pending payment

  • access: public
bool acceptPayment ( $payment)
Redefinition of:
Mage_Payment_Model_Method_Abstract::acceptPayment()
Attempt to accept a payment that us under review
authorize (line 183)

Authorize payment

  • access: public
Mage_Paypal_Model_Method_Agreement authorize ( $payment, float $amount)
  • Varien_Object $payment
  • float $amount
Redefinition of:
Mage_Payment_Model_Method_Abstract::authorize()
Authorize
cancel (line 234)

Cancel payment

  • access: public
Mage_Paypal_Model_Method_Agreement cancel ( $payment)
Redefinition of:
Mage_Payment_Model_Method_Abstract::cancel()
Cancel payment (GoogleCheckout)
canReviewPayment (line 246)

Whether payment can be reviewed

  • access: public
bool canReviewPayment ( $payment)
Redefinition of:
Mage_Payment_Model_Method_Abstract::canReviewPayment()
Whether this method can accept or deny payment
capture (line 207)

Capture payment

  • access: public
Mage_Paypal_Model_Method_Agreement capture ( $payment, float $amount)
Redefinition of:
Mage_Payment_Model_Method_Abstract::capture()
Capture payment
denyPayment (line 269)

Attempt to deny a pending payment

  • access: public
bool denyPayment ( $payment)
Redefinition of:
Mage_Payment_Model_Method_Abstract::denyPayment()
Attempt to deny a payment that us under review
fetchTransactionInfo (line 282)

Fetch transaction details info

  • access: public
array fetchTransactionInfo ( $payment, string $transactionId)
Redefinition of:
Mage_Payment_Model_Method_Abstract::fetchTransactionInfo()
Fetch transaction info
getBillingAgreementTokenInfo (line 122)

Retrieve billing agreement customer details by token

  • access: public
array getBillingAgreementTokenInfo ( $agreement)
getConfigPaymentAction (line 340)

Payment action getter compatible with payment model

  • see: Mage_Sales_Model_Payment::place()
  • access: public
string getConfigPaymentAction ()
Redefinition of:
Mage_Payment_Model_Method_Abstract::getConfigPaymentAction()
Get config peyment action url Used to universalize payment actions when processing payment place
initBillingAgreementToken (line 102)

Init billing agreement

  • access: public
Mage_Paypal_Model_Method_Agreement initBillingAgreementToken ( $agreement)
placeBillingAgreement (line 143)

Create billing agreement by token specified in request

  • access: public
Mage_Paypal_Model_Method_Agreement placeBillingAgreement ( $agreement)
refund (line 222)

Refund capture

  • access: public
Mage_Paypal_Model_Method_Agreement refund ( $payment, float $amount)
Redefinition of:
Mage_Payment_Model_Method_Abstract::refund()
Refund money
setStore (line 86)

Store setter Also updates store ID in config object

  • access: public
void setStore (Mage_Core_Model_Store|int $store)
updateBillingAgreementStatus (line 158)

Update billing agreement status

  • access: public
Mage_Paypal_Model_Method_Agreement updateBillingAgreementStatus ( $agreement)
void (line 194)

Void payment

  • access: public
Mage_Paypal_Model_Method_Agreement void ( $payment)
Redefinition of:
Mage_Payment_Model_Method_Abstract::void()
Void payment
_isAvailable (line 329)
  • access: protected
void _isAvailable ( $quote)
  • $quote
Redefinition of:
Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract::_isAvailable()
_placeOrder (line 294)

Place an order with authorization or capture action

  • access: protected
Mage_Paypal_Model_Method_Agreement _placeOrder ( $payment, float $amount)

Inherited Methods

Inherited From Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract

Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract::assignData()
Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract::isAvailable()
Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract::_isAvailable()

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)

Inherited Constants

Inherited from Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract

Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract::PAYMENT_INFO_REFERENCE_ID
 Mage_Sales_Model_Payment_Method_Billing_AgreementAbstract::TRANSPORT_BILLING_AGREEMENT_ID

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 16:56:20 +0200 by phpDocumentor 1.4.3