Class Mage_Paypal_Model_Info

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

Package: Mage\Paypal
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Located at code/core/Mage/Paypal/Model/Info.php

Methods summary
`public array`	# `getPaymentInfo( Mage_Payment_Model_Info $payment, boolean $labelValuesOnly = false )` All available payment info getter All available payment info getter Parameters `$payment` `Mage_Payment_Model_Info` $payment `$labelValuesOnly` `boolean` $labelValuesOnly Returns `array`
`public array`	# `getPublicPaymentInfo( Mage_Payment_Model_Info $payment, boolean $labelValuesOnly = false )` Public payment info getter Public payment info getter Parameters `$payment` `Mage_Payment_Model_Info` $payment `$labelValuesOnly` `boolean` $labelValuesOnly Returns `array`
`public`	# `importToPayment( array\|Varien_Object\|callable $from, Mage_Payment_Model_Info $payment )` Grab data from source and map it into payment Grab data from source and map it into payment Parameters `$from` `array\|Varien_Object\|callable` $from `$payment` `Mage_Payment_Model_Info` $payment
`public array\|Varien_Object &`	# `exportFromPayment( Mage_Payment_Model_Info $payment, array\|Varien_Object\|callable $to, array $map = null )` Grab data from payment and map it into target Grab data from payment and map it into target Parameters `$payment` `Mage_Payment_Model_Info` $payment `$to` `array\|Varien_Object\|callable` $to `$map` `array` $map Returns `array\|Varien_Object`
`public static boolean`	# `isPaymentReviewRequired( Mage_Payment_Model_Info $payment )` Check whether the payment is in review state Check whether the payment is in review state Parameters `$payment` `Mage_Payment_Model_Info` $payment Returns `boolean`
`public static boolean`	# `isFraudReviewAllowed( Mage_Payment_Model_Info $payment )` Check whether fraud order review detected and can be reviewed Check whether fraud order review detected and can be reviewed Parameters `$payment` `Mage_Payment_Model_Info` $payment Returns `boolean`
`public static boolean`	# `isPaymentCompleted( Mage_Payment_Model_Info $payment )` Check whether the payment is completed Check whether the payment is completed Parameters `$payment` `Mage_Payment_Model_Info` $payment Returns `boolean`
`public static boolean`	# `isPaymentSuccessful( Mage_Payment_Model_Info $payment )` Check whether the payment was processed successfully Check whether the payment was processed successfully Parameters `$payment` `Mage_Payment_Model_Info` $payment Returns `boolean`
`public static boolean`	# `isPaymentFailed( Mage_Payment_Model_Info $payment )` Check whether the payment was processed unsuccessfully or failed Check whether the payment was processed unsuccessfully or failed Parameters `$payment` `Mage_Payment_Model_Info` $payment Returns `boolean`
`public static string`	# `explainPendingReason( string $code )` Explain pending payment reason code Explain pending payment reason code Parameters `$code` `string` $code Returns `string` Link https://cms.paypal.com/us/cgi-bin/?&cmd=_render-content&content_ID=developer/e_howto_html_IPNandPDTVariables https://cms.paypal.com/us/cgi-bin/?&cmd=_render-content&content_ID=developer/e_howto_api_nvp_r_GetTransactionDetails
`public static string`	# `explainReasonCode( mixed $code )` Explain the refund or chargeback reason code Explain the refund or chargeback reason code Parameters `$code` `mixed` $code Returns `string` Link https://cms.paypal.com/us/cgi-bin/?&cmd=_render-content&content_ID=developer/e_howto_html_IPNandPDTVariables https://cms.paypal.com/us/cgi-bin/?&cmd=_render-content&content_ID=developer/e_howto_api_nvp_r_GetTransactionDetails
`public static bool;`	# `isReversalDisputable( string $code )` Whether a reversal/refund can be disputed with PayPal Whether a reversal/refund can be disputed with PayPal Parameters `$code` `string` $code Returns `bool;`
`protected`	# `_getFullInfo( array $keys, Mage_Payment_Model_Info $payment, boolean $labelValuesOnly )` Render info item Render info item Parameters `$keys` `array` $keys `$payment` `Mage_Payment_Model_Info` $payment `$labelValuesOnly` `boolean` $labelValuesOnly
`protected`	# `_getLabel( string $key )` Render info item labels Render info item labels Parameters `$key` `string` $key
`protected string`	# `_getValue( string $value, string $key )` Apply a filter upon value getting Apply a filter upon value getting Parameters `$value` `string` $value `$key` `string` $key Returns `string`
`protected string`	# `_getAvsLabel( string $value )` Attempt to convert AVS check result code into label Attempt to convert AVS check result code into label Parameters `$value` `string` $value Returns `string` Link https://cms.paypal.com/us/cgi-bin/?&cmd=_render-content&content_ID=developer/e_howto_api_nvp_AVSResponseCodes
`protected string`	# `_getCvv2Label( string $value )` Attempt to convert CVV2 check result code into label Attempt to convert CVV2 check result code into label Parameters `$value` `string` $value Returns `string` Link https://cms.paypal.com/us/cgi-bin/?&cmd=_render-content&content_ID=developer/e_howto_api_nvp_AVSResponseCodes
`private string`	# `_getCentinelVpasLabel( string $value )` Attempt to convert centinel VPAS result into label Attempt to convert centinel VPAS result into label Parameters `$value` `string` $value Returns `string` Link https://cms.paypal.com/us/cgi-bin/?&cmd=_render-content&content_ID=developer/e_howto_api_nvp_r_DoDirectPayment
`private string`	# `_getCentinelEciLabel( string $value )` Attempt to convert centinel ECI result into label Attempt to convert centinel ECI result into label Parameters `$value` `string` $value Returns `string` Link https://cms.paypal.com/us/cgi-bin/?&cmd=_render-content&content_ID=developer/e_howto_api_nvp_r_DoDirectPayment
`protected string`	# `_getBuyerIdTypeValue( string $code )` Retrieve buyer id type value based on code received from PayPal (Brazil only) Retrieve buyer id type value based on code received from PayPal (Brazil only) Parameters `$code` `string` $code Returns `string`

Constants summary
`string`	`PAYER_ID`	`'payer_id'`	# Cross-models public exchange keys Cross-models public exchange keys
`string`	`PAYER_EMAIL`	`'email'`	#
`string`	`PAYER_STATUS`	`'payer_status'`	#
`string`	`ADDRESS_ID`	`'address_id'`	#
`string`	`ADDRESS_STATUS`	`'address_status'`	#
`string`	`PROTECTION_EL`	`'protection_eligibility'`	#
`string`	`FRAUD_FILTERS`	`'collected_fraud_filters'`	#
`string`	`CORRELATION_ID`	`'correlation_id'`	#
`string`	`AVS_CODE`	`'avs_result'`	#
`string`	`CVV2_MATCH`	`'cvv2_check_result'`	#
`string`	`CENTINEL_VPAS`	`'centinel_vpas_result'`	#
`string`	`CENTINEL_ECI`	`'centinel_eci_result'`	#
`string`	`BUYER_TAX_ID`	`'buyer_tax_id'`	#
`string`	`BUYER_TAX_ID_TYPE`	`'buyer_tax_id_type'`	#
`string`	`PAYMENT_STATUS`	`'payment_status'`	#
`string`	`PENDING_REASON`	`'pending_reason'`	#
`string`	`IS_FRAUD`	`'is_fraud_detected'`	#
`string`	`PAYMENT_STATUS_GLOBAL`	`'paypal_payment_status'`	#
`string`	`PENDING_REASON_GLOBAL`	`'paypal_pending_reason'`	#
`string`	`IS_FRAUD_GLOBAL`	`'paypal_is_fraud_detected'`	#
`string`	`BUYER_TAX_ID_TYPE_CPF`	`'BR_CPF'`	# Possible buyer's tax id types (Brazil only) Possible buyer's tax id types (Brazil only)
`string`	`BUYER_TAX_ID_TYPE_CNPJ`	`'BR_CNPJ'`	#
`string`	`PAYMENTSTATUS_NONE`	`'none'`	# PayPal payment status possible values PayPal payment status possible values
`string`	`PAYMENTSTATUS_COMPLETED`	`'completed'`	#
`string`	`PAYMENTSTATUS_DENIED`	`'denied'`	#
`string`	`PAYMENTSTATUS_EXPIRED`	`'expired'`	#
`string`	`PAYMENTSTATUS_FAILED`	`'failed'`	#
`string`	`PAYMENTSTATUS_INPROGRESS`	`'in_progress'`	#
`string`	`PAYMENTSTATUS_PENDING`	`'pending'`	#
`string`	`PAYMENTSTATUS_REFUNDED`	`'refunded'`	#
`string`	`PAYMENTSTATUS_REFUNDEDPART`	`'partially_refunded'`	#
`string`	`PAYMENTSTATUS_REVERSED`	`'reversed'`	#
`string`	`PAYMENTSTATUS_UNREVERSED`	`'canceled_reversal'`	#
`string`	`PAYMENTSTATUS_PROCESSED`	`'processed'`	#
`string`	`PAYMENTSTATUS_VOIDED`	`'voided'`	#

Properties summary
`protected 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, self::BUYER_TAX_ID => self::BUYER_TAX_ID, self::BUYER_TAX_ID_TYPE => self::BUYER_TAX_ID_TYPE, )	# All payment information map All payment information map
`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, )`	# System information map System information map
`protected array`	`$_paymentPublicMap`	`array( 'paypal_payer_email', self::BUYER_TAX_ID, self::BUYER_TAX_ID_TYPE )`	# Map of payment information available to customer Map of payment information available to customer
`protected array`	`$_paymentMapFull`	`array()`	# Rendered payment map cache Rendered payment map cache

Packages

Classes

Exceptions

Class Mage_Paypal_Model_Info

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Link

Parameters

Returns

Link

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Link

Parameters

Returns

Link

Parameters

Returns

Link

Parameters

Returns

Link

Parameters

Returns