Docs For Class Mage_Paypal_Model

Description

PayPal payment information model

Aware of all PayPal payment methods Collects and provides access to PayPal-specific payment data Provides business logic information about payment flow

Located in /Paypal/Model/Info.php (line 34)

Class Constant Summary

ADDRESS_ID = 'address_id'

ADDRESS_STATUS = 'address_status'

AVS_CODE = 'avs_result'

CENTINEL_ECI = 'centinel_eci_result'

CENTINEL_VPAS = 'centinel_vpas_result'

CORRELATION_ID = 'correlation_id'

CVV2_MATCH = 'cvv2_check_result'

FRAUD_FILTERS = 'collected_fraud_filters'

IS_FRAUD = 'is_fraud_detected'

IS_FRAUD_GLOBAL = 'paypal_is_fraud_detected'

PAYER_EMAIL = 'email'

PAYER_ID = 'payer_id'

PAYER_STATUS = 'payer_status'

PAYMENTSTATUS_COMPLETED = 'completed'

PAYMENTSTATUS_DENIED = 'denied'

PAYMENTSTATUS_EXPIRED = 'expired'

PAYMENTSTATUS_FAILED = 'failed'

PAYMENTSTATUS_INPROGRESS = 'in_progress'

PAYMENTSTATUS_NONE = 'none'

PAYMENTSTATUS_PENDING = 'pending'

PAYMENTSTATUS_PROCESSED = 'processed'

PAYMENTSTATUS_REFUNDED = 'refunded'

PAYMENTSTATUS_REFUNDEDPART = 'partially_refunded'

PAYMENTSTATUS_REVERSED = 'reversed'

PAYMENTSTATUS_UNREVERSED = 'canceled_reversal'

PAYMENTSTATUS_VOIDED = 'voided'

PAYMENT_STATUS = 'payment_status'

PAYMENT_STATUS_GLOBAL = 'paypal_payment_status'

PENDING_REASON = 'pending_reason'

PENDING_REASON_GLOBAL = 'paypal_pending_reason'

PROTECTION_EL = 'protection_eligibility'

Variable Summary

array $_paymentMap

array $_paymentMapFull

array $_paymentPublicMap

array $_systemMap

Method Summary

static string explainPendingReason (string $code)

static string explainReasonCode ($code $code)

static bool isFraudReviewAllowed ( $payment)

static bool isPaymentCompleted ( $payment)

static bool isPaymentFailed ( $payment)

static bool isPaymentReviewRequired ( $payment)

static bool isPaymentSuccessful ( $payment)

static bool; isReversalDisputable (string $code)

array|Varien_Object &exportFromPayment ( $payment, array|Varien_Object|callback $to, [ $map = null])

array getPaymentInfo ( $payment, [bool $labelValuesOnly = false])

array getPublicPaymentInfo ( $payment, [bool $labelValuesOnly = false])

void importToPayment (array|Varien_Object|callback $from, $payment)

string _getAvsLabel (string $value)

string _getCvv2Label (string $value)

void _getFullInfo ( $keys, $payment, bool $labelValuesOnly)

void _getLabel (string $key)

string _getValue (string $value, string $key)

Variables

array $_paymentMap = array(
self::PAYER_ID => 'paypal_payer_id',
self::PAYER_EMAIL => 'paypal_payer_email',
self::PAYER_STATUS => 'paypal_payer_status',
self::ADDRESS_ID => 'paypal_address_id',
self::ADDRESS_STATUS => 'paypal_address_status',
self::PROTECTION_EL => 'paypal_protection_eligibility',
self::FRAUD_FILTERS => 'paypal_fraud_filters',
self::CORRELATION_ID => 'paypal_correlation_id',
self::AVS_CODE => 'paypal_avs_code',
self::CVV2_MATCH => 'paypal_cvv2_match',
self::CENTINEL_VPAS => self::CENTINEL_VPAS,
self::CENTINEL_ECI => self::CENTINEL_ECI,
) (line 66)

All payment information map

access: protected

array $_paymentMapFull = array() (line 125)

Rendered payment map cache

access: protected

array $_paymentPublicMap = array(
'paypal_payer_email',
) (line 116)

Map of payment information available to customer

access: protected

array $_systemMap = array(
self::PAYMENT_STATUS => self::PAYMENT_STATUS_GLOBAL,
self::PENDING_REASON => self::PENDING_REASON_GLOBAL,
self::IS_FRAUD => self::IS_FRAUD_GLOBAL,
) (line 86)

System information map

access: protected

Methods

static method explainPendingReason (line 278)

Explain pending payment reason code

static string explainPendingReason (string $code)

string $code

static method explainReasonCode (line 317)

Explain the refund or chargeback reason code

static string explainReasonCode ($code $code)

$code $code

static method isFraudReviewAllowed (line 217)

Check whether fraud order review detected and can be reviewed

access: public

static bool isFraudReviewAllowed ( $payment)

Mage_Payment_Model_Info $payment

static method isPaymentCompleted (line 229)

Check whether the payment is completed

access: public

static bool isPaymentCompleted ( $payment)

Mage_Payment_Model_Info $payment

static method isPaymentFailed (line 261)

Check whether the payment was processed unsuccessfully or failed

access: public

static bool isPaymentFailed ( $payment)

Mage_Payment_Model_Info $payment

static method isPaymentReviewRequired (line 201)

Check whether the payment is in review state

access: public

static bool isPaymentReviewRequired ( $payment)

Mage_Payment_Model_Info $payment

static method isPaymentSuccessful (line 241)

Check whether the payment was processed successfully

access: public

static bool isPaymentSuccessful ( $payment)

Mage_Payment_Model_Info $payment

static method isReversalDisputable (line 347)

Whether a reversal/refund can be disputed with PayPal

access: public

static bool; isReversalDisputable (string $code)

string $code

exportFromPayment (line 186)

Grab data from payment and map it into target

access: public

array|Varien_Object &exportFromPayment ( $payment, array|Varien_Object|callback $to, [ $map = null])

Mage_Payment_Model_Info $payment
array|Varien_Object|callback $to
array $map

getPaymentInfo (line 134)

All available payment info getter

access: public

array getPaymentInfo ( $payment, [bool $labelValuesOnly = false])

Mage_Payment_Model_Info $payment
bool $labelValuesOnly

getPublicPaymentInfo (line 158)

Public payment info getter

access: public

array getPublicPaymentInfo ( $payment, [bool $labelValuesOnly = false])

Mage_Payment_Model_Info $payment
bool $labelValuesOnly

importToPayment (line 169)

Grab data from source and map it into payment

access: public

void importToPayment (array|Varien_Object|callback $from, $payment)

array|Varien_Object|callback $from
Mage_Payment_Model_Info $payment

_getAvsLabel (line 472)

Attempt to convert AVS check result code into label

link: https://cms.paypal.com/us/cgi-bin/?&cmd=_render-content&content_ID=developer/e_howto_api_nvp_AVSResponseCodes
access: protected

string _getAvsLabel (string $value)

string $value

_getCvv2Label (line 536)

Attempt to convert CVV2 check result code into label

link: https://cms.paypal.com/us/cgi-bin/?&cmd=_render-content&content_ID=developer/e_howto_api_nvp_AVSResponseCodes
access: protected

string _getCvv2Label (string $value)

string $value

_getFullInfo (line 372)

Render info item

access: protected

void _getFullInfo ( $keys, $payment, bool $labelValuesOnly)

array $keys
Mage_Payment_Model_Info $payment
bool $labelValuesOnly

_getLabel (line 405)

Render info item labels

access: protected

void _getLabel (string $key)

string $key

_getValue (line 443)

Apply a filter upon value getting

access: protected

string _getValue (string $value, string $key)

string $value
string $key

Class Constants

ADDRESS_ID = 'address_id' (line 44)

ADDRESS_STATUS = 'address_status' (line 45)

AVS_CODE = 'avs_result' (line 49)

CENTINEL_ECI = 'centinel_eci_result' (line 52)

CENTINEL_VPAS = 'centinel_vpas_result' (line 51)

CORRELATION_ID = 'correlation_id' (line 48)

CVV2_MATCH = 'cvv2_check_result' (line 50)

FRAUD_FILTERS = 'collected_fraud_filters' (line 47)

IS_FRAUD = 'is_fraud_detected' (line 56)

IS_FRAUD_GLOBAL = 'paypal_is_fraud_detected' (line 59)

PAYER_EMAIL = 'email' (line 42)

PAYER_ID = 'payer_id' (line 41)

Cross-models public exchange keys

PAYER_STATUS = 'payer_status' (line 43)

PAYMENTSTATUS_COMPLETED = 'completed' (line 98)

PAYMENTSTATUS_DENIED = 'denied' (line 99)

PAYMENTSTATUS_EXPIRED = 'expired' (line 100)

PAYMENTSTATUS_FAILED = 'failed' (line 101)

PAYMENTSTATUS_INPROGRESS = 'in_progress' (line 102)

PAYMENTSTATUS_NONE = 'none' (line 97)

PayPal payment status possible values

PAYMENTSTATUS_PENDING = 'pending' (line 103)

PAYMENTSTATUS_PROCESSED = 'processed' (line 108)

PAYMENTSTATUS_REFUNDED = 'refunded' (line 104)

PAYMENTSTATUS_REFUNDEDPART = 'partially_refunded' (line 105)

PAYMENTSTATUS_REVERSED = 'reversed' (line 106)

PAYMENTSTATUS_UNREVERSED = 'canceled_reversal' (line 107)

PAYMENTSTATUS_VOIDED = 'voided' (line 109)

PAYMENT_STATUS = 'payment_status' (line 54)

PAYMENT_STATUS_GLOBAL = 'paypal_payment_status' (line 57)

PENDING_REASON = 'pending_reason' (line 55)

PENDING_REASON_GLOBAL = 'paypal_pending_reason' (line 58)

PROTECTION_EL = 'protection_eligibility' (line 46)

Class Mage_Paypal_Model_Info