Docs For Class Mage_Paypal_Model

Class Mage_Paypal_Model_Express

Description

Implements interfaces:

Mage_Payment_Model_Recurring_Profile_MethodInterface

PayPal Express Module

author: Magento Core Team <[email protected]>

Located in /Paypal/Model/Express.php (line 31)

Varien_Object
   |
   --Mage_Payment_Model_Method_Abstract
      |
      --Mage_Paypal_Model_Express

Direct descendents

Class	Description
Mage_PaypalUk_Model_Express	PayPalUk Express Module
Mage_XmlConnect_Model_Payment_Method_Paypal_Mep	PayPal Mobile Embedded Payments Checkout Module

Variable Summary

mixed $_canAuthorize

mixed $_canCapture

mixed $_canCapturePartial

mixed $_canCreateBillingAgreement

mixed $_canFetchTransactionInfo

mixed $_canOrder

mixed $_canRefund

mixed $_canRefundInvoicePartial

mixed $_canReviewPayment

mixed $_canUseCheckout

mixed $_canUseForMultishipping

mixed $_canUseInternal

mixed $_canVoid

mixed $_code

mixed $_formBlockType

mixed $_infoBlockType

mixed $_isGateway

Mage_Paypal_Model_Pro $_pro

$_proType $_proType

Method Summary

Mage_Paypal_Model_Express __construct ([ $params = array()])

bool acceptPayment ( $payment)

Mage_Payment_Model_Info assignData (mixed $data)

Mage_Paypal_Model_Express authorize ( $payment, float $amount)

Mage_Paypal_Model_Express cancel ( $payment)

void canGetRecurringProfileDetails ()

bool canReviewPayment ( $payment)

bool canUseForCurrency (string $currencyCode)

bool canVoid ( $payment)

Mage_Paypal_Model_Express capture ( $payment, float $amount)

bool denyPayment ( $payment)

array fetchTransactionInfo ( $payment, string $transactionId)

string getCheckoutRedirectUrl ()

mixed getConfigData (string $field, [int $storeId = null])

string getConfigPaymentAction ()

void getRecurringProfileDetails (string $referenceId, $result)

bool isAvailable ([Mage_Sales_Model_Quote $quote = null])

Mage_Paypal_Model_Express order ( $payment, float $amount)

Mage_Paypal_Model_Express refund ( $payment, float $amount)

void setStore (Mage_Core_Model_Store|int $store)

void submitRecurringProfile ( $profile, $paymentInfo)

void updateRecurringProfile ( $profile)

void updateRecurringProfileStatus ( $profile)

void validateRecurringProfile ( $profile)

Mage_Paypal_Model_Express void ( $payment)

void _importToPayment (Mage_Paypal_Model_Api_Nvp $api, Mage_Sales_Model_Order_Payment $payment)

Mage_Paypal_Model_Express _placeOrder ( $payment, float $amount)

Variables

mixed $_canAuthorize = true (line 50)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_canAuthorize

mixed $_canCapture = true (line 51)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_canCapture

mixed $_canCapturePartial = true (line 52)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_canCapturePartial

mixed $_canCreateBillingAgreement = true (line 60)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_canCreateBillingAgreement

Redefined in descendants as:

Mage_PaypalUk_Model_Express::$_canCreateBillingAgreement

mixed $_canFetchTransactionInfo = true (line 59)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_canFetchTransactionInfo

mixed $_canOrder = true (line 49)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_canOrder

mixed $_canRefund = true (line 53)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_canRefund

mixed $_canRefundInvoicePartial = true (line 54)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_canRefundInvoicePartial

mixed $_canReviewPayment = true (line 61)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_canReviewPayment

mixed $_canUseCheckout = true (line 57)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_canUseCheckout

Redefined in descendants as:

Mage_XmlConnect_Model_Payment_Method_Paypal_Mep::$_canUseCheckout

mixed $_canUseForMultishipping = false (line 58)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_canUseForMultishipping

Redefined in descendants as:

Mage_XmlConnect_Model_Payment_Method_Paypal_Mep::$_canUseForMultishipping

mixed $_canUseInternal = false (line 56)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_canUseInternal

Redefined in descendants as:

Mage_XmlConnect_Model_Payment_Method_Paypal_Mep::$_canUseInternal

mixed $_canVoid = true (line 55)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_canVoid

mixed $_code = Mage_Paypal_Model_Config::METHOD_WPP_EXPRESS (line 34)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_code

Redefined in descendants as:

Mage_PaypalUk_Model_Express::$_code
Mage_XmlConnect_Model_Payment_Method_Paypal_Mep::$_code : Payment method code

mixed $_formBlockType = 'paypal/express_form' (line 35)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_formBlockType

Redefined in descendants as:

Mage_PaypalUk_Model_Express::$_formBlockType

mixed $_infoBlockType = 'paypal/payment_info' (line 36)

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_infoBlockType

mixed $_isGateway = false (line 48)

Availability options

access: protected

Redefinition of:

Mage_Payment_Model_Method_Abstract::$_isGateway: Payment Method features

Mage_Paypal_Model_Pro $_pro = null (line 68)

Website Payments Pro instance

access: protected

$_proType $_proType = 'paypal/pro' (line 43)

Website Payments Pro instance type

var: string
access: protected

Redefined in descendants as:

Mage_PaypalUk_Model_Express::$_proType : Website Payments Pro instance type

Inherited Variables

Inherited from Mage_Payment_Model_Method_Abstract

Mage_Payment_Model_Method_Abstract::$_canCancelInvoice
Mage_Payment_Model_Method_Abstract::$_canManageRecurringProfiles
Mage_Payment_Model_Method_Abstract::$_debugReplacePrivateDataKeys
Mage_Payment_Model_Method_Abstract::$_isInitializeNeeded

Methods

Constructor __construct (line 70)

access: public

Mage_Paypal_Model_Express __construct ([ $params = array()])

$params

Redefinition of:

Mage_Payment_Model_Method_Abstract::__construct()

acceptPayment (line 238)

Attempt to accept a pending payment

access: public

bool acceptPayment ( $payment)

Mage_Sales_Model_Order_Payment $payment

Redefinition of:

Mage_Payment_Model_Method_Abstract::acceptPayment(): Attempt to accept a payment that us under review

assignData (line 348)

Assign data to info model instance

access: public

Mage_Payment_Model_Info assignData (mixed $data)

mixed $data

Redefinition of:

Mage_Payment_Model_Method_Abstract::assignData(): Assign data to info model instance

authorize (line 163)

Authorize payment

access: public

Mage_Paypal_Model_Express authorize ( $payment, float $amount)

Mage_Sales_Model_Order_Payment $payment
float $amount

Redefinition of:

Mage_Payment_Model_Method_Abstract::authorize(): Authorize

cancel (line 214)

Cancel payment

access: public

Mage_Paypal_Model_Express cancel ( $payment)

Mage_Sales_Model_Order_Payment $payment

Redefinition of:

Mage_Payment_Model_Method_Abstract::cancel(): Cancel payment (GoogleCheckout)

canGetRecurringProfileDetails (line 317)

Whether can get recurring profile details

access: public

void canGetRecurringProfileDetails ()

canReviewPayment (line 227)

Whether payment can be reviewed

access: public

bool canReviewPayment ( $payment)

Mage_Sales_Model_Order_Payment $payment

Redefinition of:

Mage_Payment_Model_Method_Abstract::canReviewPayment(): Whether this method can accept or deny payment

canUseForCurrency (line 103)

Whether method is available for specified currency

access: public

bool canUseForCurrency (string $currencyCode)

string $currencyCode

Redefinition of:

Mage_Payment_Model_Method_Abstract::canUseForCurrency(): Check method for processing with base currency

canVoid (line 421)

Check void availability

access: public

bool canVoid ( $payment)

Varien_Object $payment

Redefinition of:

Mage_Payment_Model_Method_Abstract::canVoid(): Check void availability

capture (line 187)

Capture payment

access: public

Mage_Paypal_Model_Express capture ( $payment, float $amount)

Mage_Sales_Model_Order_Payment $payment
float $amount

Redefinition of:

Mage_Payment_Model_Method_Abstract::capture(): Capture payment

Redefined in descendants as:

Mage_XmlConnect_Model_Payment_Method_Paypal_Mep::capture() : Capture payment

denyPayment (line 250)

Attempt to deny a pending payment

access: public

bool denyPayment ( $payment)

Mage_Sales_Model_Order_Payment $payment

Redefinition of:

Mage_Payment_Model_Method_Abstract::denyPayment(): Attempt to deny a payment that us under review

fetchTransactionInfo (line 275)

Fetch transaction details info

access: public

array fetchTransactionInfo ( $payment, string $transactionId)

Mage_Payment_Model_Info $payment
string $transactionId

Redefinition of:

Mage_Payment_Model_Method_Abstract::fetchTransactionInfo(): Fetch transaction info

getCheckoutRedirectUrl (line 263)

Checkout redirect URL getter for onepage checkout (hardcode)

see: Mage_Checkout_OnepageController::savePaymentAction()
see: Mage_Sales_Model_Quote_Payment::getCheckoutRedirectUrl()
access: public

string getCheckoutRedirectUrl ()

Redefined in descendants as:

Mage_PaypalUk_Model_Express::getCheckoutRedirectUrl() : Checkout redirect URL getter for onepage checkout (hardcode)

getConfigData (line 139)

Custom getter for payment configuration

access: public

mixed getConfigData (string $field, [int $storeId = null])

string $field
int $storeId

Redefinition of:

Mage_Payment_Model_Method_Abstract::getConfigData(): Retrieve information from payment configuration

getConfigPaymentAction (line 114)

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

Redefined in descendants as:

Mage_XmlConnect_Model_Payment_Method_Paypal_Mep::getConfigPaymentAction() : Get config peyment action url Used to universalize payment actions when processing payment place

getRecurringProfileDetails (line 309)

Fetch RP details

access: public

void getRecurringProfileDetails (string $referenceId, $result)

string $referenceId
Varien_Object $result

isAvailable (line 124)

Check whether payment method can be used

access: public

bool isAvailable ([Mage_Sales_Model_Quote $quote = null])

Mage_Sales_Model_Quote $quote

Redefinition of:

Mage_Payment_Model_Method_Abstract::isAvailable(): Check whether payment method can be used

Redefined in descendants as:

Mage_PaypalUk_Model_Express::isAvailable() : EC PE won't be available if the EC is available
Mage_XmlConnect_Model_Payment_Method_Paypal_Mep::isAvailable() : Check whether payment method can be used

order (line 151)

Order payment

access: public

Mage_Paypal_Model_Express order ( $payment, float $amount)

Mage_Sales_Model_Order_Payment $payment
float $amount

Redefinition of:

Mage_Payment_Model_Method_Abstract::order(): Order

refund (line 202)

Refund capture

access: public

Mage_Paypal_Model_Express refund ( $payment, float $amount)

Mage_Sales_Model_Order_Payment $payment
float $amount

Redefinition of:

Mage_Payment_Model_Method_Abstract::refund(): Refund money

setStore (line 87)

Store setter Also updates store ID in config object

access: public

void setStore (Mage_Core_Model_Store|int $store)

Mage_Core_Model_Store|int $store

submitRecurringProfile (line 296)

Submit RP to the gateway

access: public

void submitRecurringProfile ( $profile, $paymentInfo)

Mage_Payment_Model_Recurring_Profile $profile
Mage_Payment_Model_Info $paymentInfo

updateRecurringProfile (line 327)

Update RP data

access: public

void updateRecurringProfile ( $profile)

Mage_Payment_Model_Recurring_Profile $profile

updateRecurringProfileStatus (line 337)

Manage status

access: public

void updateRecurringProfileStatus ( $profile)

Mage_Payment_Model_Recurring_Profile $profile

validateRecurringProfile (line 285)

Validate RP data

access: public

void validateRecurringProfile ( $profile)

Mage_Payment_Model_Recurring_Profile $profile

void (line 174)

Void payment

access: public

Mage_Paypal_Model_Express void ( $payment)

Mage_Sales_Model_Order_Payment $payment

Redefinition of:

Mage_Payment_Model_Method_Abstract::void(): Void payment

_importToPayment (line 398)

Import payment info to payment

access: protected

void _importToPayment (Mage_Paypal_Model_Api_Nvp $api, Mage_Sales_Model_Order_Payment $payment)

Mage_Paypal_Model_Api_Nvp $api
Mage_Sales_Model_Order_Payment $payment

Redefined in descendants as:

Mage_PaypalUk_Model_Express::_importToPayment() : Import payment info to payment

_placeOrder (line 368)

Place an order with authorization or capture action

access: protected

Mage_Paypal_Model_Express _placeOrder ( $payment, float $amount)

Mage_Sales_Model_Order_Payment $payment
float $amount

Inherited Methods

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

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:02:22 +0200 by phpDocumentor 1.4.3