Docs For Class Mage_Paypal_Model

Description

PayPal Website Payments Pro implementation for payment method instaces

This model was created because right now PayPal Direct and PayPal Express payment methods cannot have same abstract

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

Direct descendents

Class	Description
Mage_PaypalUk_Model_Pro	PayPal Website Payments Pro (Payflow Edition) implementation for payment method instaces

Class Constant Summary

PAYMENT_REVIEW_ACCEPT = 'accept'

PAYMENT_REVIEW_DENY = 'deny'

Variable Summary

Mage_Paypal_Model_Api_Nvp $_api

string $_apiType

Mage_Paypal_Model_Config $_config

string $_configType

Mage_Paypal_Model_Info $_infoInstance

Method Summary

void cancel ( $payment)

bool canReviewPayment ( $payment)

false|null capture ( $payment, float $amount)

array fetchTransactionInfo ( $payment, string $transactionId)

Mage_Paypal_Model_Api_Nvp getApi ()

Mage_Paypal_Model_Config getConfig ()

Mage_Paypal_Model_Info getInfo ()

void getRecurringProfileDetails (string $referenceId, $result)

Mage_Paypal_Model_Pro importPaymentInfo ( $from, $to)

void refund ( $payment, float $amount)

bool reviewPayment ( $payment, string $action)

void setConfig (Mage_Paypal_Model_Config $instace, [int $storeId = null])

void setMethod (string $code, [int|null $storeId = null])

void submitRecurringProfile ( $profile, $paymentInfo)

void updateRecurringProfile ( $profile)

void updateRecurringProfileStatus ( $profile)

void validateRecurringProfile ( $profile)

void void ( $payment)

string _getParentTransactionId ( $payment)

void _importCaptureResultToPayment (Mage_Paypal_Model_Api_Nvp $api, Mage_Sales_Model_Order_Payment $payment)

void _importRefundResultToPayment (Mage_Paypal_Model_Api_Nvp $api, Mage_Sales_Model_Order_Payment $payment, bool $canRefundMore)

Variables

Mage_Paypal_Model_Api_Nvp $_api = null (line 53)

API instance

access: protected

string $_apiType = 'paypal/api_nvp' (line 67)

API model type

access: protected

Redefined in descendants as:

Mage_PaypalUk_Model_Pro::$_apiType : Api model type

Mage_Paypal_Model_Config $_config = null (line 46)

Config instance

access: protected

string $_configType = 'paypal/config' (line 74)

Config model type

access: protected

Redefined in descendants as:

Mage_PaypalUk_Model_Pro::$_configType : Config model type

Mage_Paypal_Model_Info $_infoInstance = null (line 60)

PayPal info object

access: protected

Methods

cancel (line 263)

Cancel payment

access: public

void cancel ( $payment)

Varien_Object $payment

canReviewPayment (line 275)

access: public

bool canReviewPayment ( $payment)

Mage_Sales_Model_Order_Payment $payment

capture (line 209)

Attempt to capture payment Will return false if the payment is not supposed to be captured

access: public

false|null capture ( $payment, float $amount)

Varien_Object $payment
float $amount

fetchTransactionInfo (line 312)

Fetch transaction details info

access: public

array fetchTransactionInfo ( $payment, string $transactionId)

Mage_Payment_Model_Info $payment
string $transactionId

getApi (line 130)

API instance getter Sets current store id to current config instance and passes it to API

access: public

Mage_Paypal_Model_Api_Nvp getApi ()

getConfig (line 119)

Config instance getter

access: public

Mage_Paypal_Model_Config getConfig ()

getInfo (line 144)

Instantiate and return info model

access: public

Mage_Paypal_Model_Info getInfo ()

getRecurringProfileDetails (line 382)

Fetch RP details

access: public

void getRecurringProfileDetails (string $referenceId, $result)

string $referenceId
Varien_Object $result

importPaymentInfo (line 159)

Transfer transaction/payment information from API instance to order payment

access: public

Mage_Paypal_Model_Pro importPaymentInfo ( $from, $to)

Mage_Paypal_Model_Api_Abstract $from
Mage_Payment_Model_Info $to

refund (line 234)

Refund a capture transaction

access: public

void refund ( $payment, float $amount)

Varien_Object $payment
float $amount

Redefined in descendants as:

Mage_PaypalUk_Model_Pro::refund() : Refund a capture transaction

reviewPayment (line 287)

Perform the payment review

access: public

bool reviewPayment ( $payment, string $action)

Mage_Payment_Model_Info $payment
string $action

setConfig (line 105)

Config instance setter

access: public

void setConfig (Mage_Paypal_Model_Config $instace, [int $storeId = null])

Mage_Paypal_Model_Config $instace
int $storeId

setMethod (line 82)

Payment method code setter. Also instantiates/updates config

access: public

void setMethod (string $code, [int|null $storeId = null])

string $code
int|null $storeId

submitRecurringProfile (line 355)

Submit RP to the gateway

throws: Mage_Core_Exception
access: public

void submitRecurringProfile ( $profile, $paymentInfo)

Mage_Payment_Model_Recurring_Profile $profile
Mage_Payment_Model_Info $paymentInfo

updateRecurringProfile (line 395)

Update RP data

access: public

void updateRecurringProfile ( $profile)

Mage_Payment_Model_Recurring_Profile $profile

updateRecurringProfileStatus (line 405)

Manage status

access: public

void updateRecurringProfileStatus ( $profile)

Mage_Payment_Model_Recurring_Profile $profile

validateRecurringProfile (line 329)

Validate RP data

throws: Mage_Core_Exception
access: public

void validateRecurringProfile ( $profile)

Mage_Payment_Model_Recurring_Profile $profile

void (line 190)

Void transaction

access: public

void void ( $payment)

Varien_Object $payment

_getParentTransactionId (line 458)

Parent transaction id getter

access: protected

string _getParentTransactionId ( $payment)

Varien_Object $payment

Redefined in descendants as:

Mage_PaypalUk_Model_Pro::_getParentTransactionId() : Get payflow transaction id from parent transaction

_importCaptureResultToPayment (line 430)

Import capture results to payment

access: protected

void _importCaptureResultToPayment (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_Pro::_importCaptureResultToPayment() : Import capture results to payment

_importRefundResultToPayment (line 443)

Import refund results to payment

access: protected

void _importRefundResultToPayment (Mage_Paypal_Model_Api_Nvp $api, Mage_Sales_Model_Order_Payment $payment, bool $canRefundMore)

bool $canRefundMore
Mage_Paypal_Model_Api_Nvp $api
Mage_Sales_Model_Order_Payment $payment

Redefined in descendants as:

Mage_PaypalUk_Model_Pro::_importRefundResultToPayment() : Import refund results to payment

Class Constants

PAYMENT_REVIEW_ACCEPT = 'accept' (line 38)

Possible payment review actions (for FMF only)

PAYMENT_REVIEW_DENY = 'deny' (line 39)

Class Mage_Paypal_Model_Pro