Class Mage_Paypal_Model_Express

PayPal Express Module

Varien_Object

Mage_Paypal_Model_Express implements Mage_Payment_Model_Recurring_Profile_MethodInterface

Direct known subclasses

Mage_PaypalUk_Model_Express, Mage_XmlConnect_Model_Payment_Method_Paypal_Mecl, Mage_XmlConnect_Model_Payment_Method_Paypal_Mep

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/Express.php

Methods summary
`public`	# `__construct( mixed $params = array() )` Overrides `Mage_Payment_Model_Method_Abstract::__construct()`
`public`	# `setStore( Mage_Core_Model_Store\|integer $store )` Store setter Also updates store ID in config object Store setter Also updates store ID in config object Parameters `$store` `Mage_Core_Model_Store\|integer` $store
`public boolean`	# `canUseCheckout( )` Can be used in regular checkout Can be used in regular checkout Returns `boolean` Overrides `Mage_Payment_Model_Method_Abstract::canUseCheckout()`
`public boolean`	# `canUseForCurrency( string $currencyCode )` Whether method is available for specified currency Whether method is available for specified currency Parameters `$currencyCode` `string` $currencyCode Returns `boolean` Overrides `Mage_Payment_Model_Method_Abstract::canUseForCurrency()`
`public string`	# `getConfigPaymentAction( )` Payment action getter compatible with payment model Payment action getter compatible with payment model Returns `string` See Mage_Sales_Model_Payment::place() Overrides `Mage_Payment_Model_Method_Abstract::getConfigPaymentAction()`
`public boolean`	# `isAvailable( Mage_Sales_Model_Quote $quote = null )` Check whether payment method can be used Check whether payment method can be used Parameters `$quote` `Mage_Sales_Model_Quote` Returns `boolean` Overrides `Mage_Payment_Model_Method_Abstract::isAvailable()`
`public mixed`	# `getConfigData( string $field, integer $storeId = null )` Custom getter for payment configuration Custom getter for payment configuration Parameters `$field` `string` $field `$storeId` `integer` $storeId Returns `mixed` Overrides `Mage_Payment_Model_Method_Abstract::getConfigData()`
`public Mage_Paypal_Model_Express`	# `order( Varien_Object $payment, float $amount )` Order payment Order payment Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment `$amount` `float` $amount Returns `Mage_Paypal_Model_Express` Overrides `Mage_Payment_Model_Method_Abstract::order()`
`public Mage_Paypal_Model_Express`	# `authorize( Varien_Object $payment, float $amount )` Authorize payment Authorize payment Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment `$amount` `float` $amount Returns `Mage_Paypal_Model_Express` Overrides `Mage_Payment_Model_Method_Abstract::authorize()`
`public Mage_Paypal_Model_Express`	# `void( Varien_Object $payment )` Void payment Void payment Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `Mage_Paypal_Model_Express` Overrides `Mage_Payment_Model_Method_Abstract::void()`
`public Mage_Paypal_Model_Express`	# `capture( Varien_Object $payment, float $amount )` Capture payment Capture payment Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment `$amount` `float` $amount Returns `Mage_Paypal_Model_Express` Overrides `Mage_Payment_Model_Method_Abstract::capture()`
`public Mage_Paypal_Model_Express`	# `refund( Varien_Object $payment, float $amount )` Refund capture Refund capture Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment `$amount` `float` $amount Returns `Mage_Paypal_Model_Express` Overrides `Mage_Payment_Model_Method_Abstract::refund()`
`public Mage_Paypal_Model_Express`	# `cancel( Varien_Object $payment )` Cancel payment Cancel payment Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `Mage_Paypal_Model_Express` Overrides `Mage_Payment_Model_Method_Abstract::cancel()`
`public boolean`	# `canReviewPayment( Mage_Payment_Model_Info $payment )` Whether payment can be reviewed Whether payment can be reviewed Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `boolean` Overrides `Mage_Payment_Model_Method_Abstract::canReviewPayment()`
`public boolean`	# `acceptPayment( Mage_Payment_Model_Info $payment )` Attempt to accept a pending payment Attempt to accept a pending payment Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `boolean` Throws `Mage_Core_Exception` Overrides `Mage_Payment_Model_Method_Abstract::acceptPayment()`
`public boolean`	# `denyPayment( Mage_Payment_Model_Info $payment )` Attempt to deny a pending payment Attempt to deny a pending payment Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `boolean` Throws `Mage_Core_Exception` Overrides `Mage_Payment_Model_Method_Abstract::denyPayment()`
`public string`	# `getCheckoutRedirectUrl( )` Checkout redirect URL getter for onepage checkout (hardcode) Checkout redirect URL getter for onepage checkout (hardcode) Returns `string` See `Mage_Checkout_OnepageController::savePaymentAction()` `Mage_Sales_Model_Quote_Payment::getCheckoutRedirectUrl()`
`public array`	# `fetchTransactionInfo( Mage_Payment_Model_Info $payment, string $transactionId )` Fetch transaction details info Fetch transaction details info Parameters `$payment` `Mage_Payment_Model_Info` $payment `$transactionId` `string` $transactionId Returns `array` Overrides `Mage_Payment_Model_Method_Abstract::fetchTransactionInfo()`
`public`	# `validateRecurringProfile( Mage_Payment_Model_Recurring_Profile $profile )` Validate RP data Validate RP data Parameters `$profile` `Mage_Payment_Model_Recurring_Profile` $profile Throws `Mage_Core_Exception` Implementation of `Mage_Payment_Model_Recurring_Profile_MethodInterface::validateRecurringProfile()`
`public`	# `submitRecurringProfile( Mage_Payment_Model_Recurring_Profile $profile, Mage_Payment_Model_Info $paymentInfo )` Submit RP to the gateway Submit RP to the gateway Parameters `$profile` `Mage_Payment_Model_Recurring_Profile` $profile `$paymentInfo` `Mage_Payment_Model_Info` $paymentInfo Implementation of `Mage_Payment_Model_Recurring_Profile_MethodInterface::submitRecurringProfile()`
`public`	# `getRecurringProfileDetails( string $referenceId, Varien_Object $result )` Fetch RP details Fetch RP details Parameters `$referenceId` `string` $referenceId `$result` `Varien_Object` $result Implementation of `Mage_Payment_Model_Recurring_Profile_MethodInterface::getRecurringProfileDetails()`
`public boolean`	# `canGetRecurringProfileDetails( )` Whether can get recurring profile details Whether can get recurring profile details Returns `boolean` Implementation of `Mage_Payment_Model_Recurring_Profile_MethodInterface::canGetRecurringProfileDetails()`
`public`	# `updateRecurringProfile( Mage_Payment_Model_Recurring_Profile $profile )` Update RP data Update RP data Parameters `$profile` `Mage_Payment_Model_Recurring_Profile` $profile Implementation of `Mage_Payment_Model_Recurring_Profile_MethodInterface::updateRecurringProfile()`
`public`	# `updateRecurringProfileStatus( Mage_Payment_Model_Recurring_Profile $profile )` Manage status Manage status Parameters `$profile` `Mage_Payment_Model_Recurring_Profile` $profile Implementation of `Mage_Payment_Model_Recurring_Profile_MethodInterface::updateRecurringProfileStatus()`
`public Mage_Payment_Model_Info`	# `assignData( mixed $data )` Assign data to info model instance Assign data to info model instance Parameters `$data` `mixed` $data Returns `Mage_Payment_Model_Info` Overrides `Mage_Payment_Model_Method_Abstract::assignData()`
`protected Mage_Paypal_Model_Express`	# `_placeOrder( Mage_Sales_Model_Order_Payment $payment, float $amount )` Place an order with authorization or capture action Place an order with authorization or capture action Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment `$amount` `float` $amount Returns `Mage_Paypal_Model_Express`
`protected`	# `_importToPayment( Mage_Paypal_Model_Api_Nvp $api, Mage_Sales_Model_Order_Payment $payment )` Import payment info to payment Import payment info to payment Parameters `$api` `Mage_Paypal_Model_Api_Nvp` `$payment` `Mage_Sales_Model_Order_Payment`
`public boolean`	# `canVoid( Varien_Object $payment )` Check void availability Check void availability Parameters `$payment` `Varien_Object` $payment Returns `boolean` Overrides `Mage_Payment_Model_Method_Abstract::canVoid()`
`public boolean`	# `canCapture( )` Check capture availability Check capture availability Returns `boolean` Overrides `Mage_Payment_Model_Method_Abstract::canCapture()`
`protected Mage_Paypal_Model_Api_Abstract`	# `_callDoAuthorize( integer $amount, Varien_Object $payment, string $parentTransactionId )` Call DoAuthorize Call DoAuthorize Parameters `$amount` `integer` $amount `$payment` `Varien_Object` $payment `$parentTransactionId` `string` $parentTransactionId Returns `Mage_Paypal_Model_Api_Abstract`
`protected boolean`	# `_isTransactionExpired( Mage_Sales_Model_Order_Payment_Transaction $transaction, integer $period )` Check transaction for expiration in PST Check transaction for expiration in PST Parameters `$transaction` `Mage_Sales_Model_Order_Payment_Transaction` $transaction `$period` `integer` $period Returns `boolean`

Methods inherited from Mage_Payment_Model_Method_Abstract
_debug(), _getHelper(), canAuthorize(), canCapturePartial(), canCreateBillingAgreement(), canEdit(), canFetchTransactionInfo(), canManageBillingAgreements(), canManageRecurringProfiles(), canOrder(), canRefund(), canRefundPartialPerInvoice(), canUseForCountry(), canUseForMultishipping(), canUseInternal(), debugData(), getCode(), getDebugFlag(), getFormBlockType(), getInfoBlockType(), getInfoInstance(), getTitle(), initialize(), isGateway(), isInitializeNeeded(), prepareSave(), processBeforeRefund(), processCreditmemo(), processInvoice(), validate()

Constants inherited from Mage_Payment_Model_Method_Abstract
`ACTION_AUTHORIZE, ACTION_AUTHORIZE_CAPTURE, ACTION_ORDER, STATUS_APPROVED, STATUS_DECLINED, STATUS_ERROR, STATUS_SUCCESS, STATUS_UNKNOWN, STATUS_VOID`

Properties summary
`protected string`	`$_code`	`Mage_Paypal_Model_Config::METHOD_WPP_EXPRESS`	#
`protected string`	`$_formBlockType`	`'paypal/express_form'`	#
`protected string`	`$_infoBlockType`	`'paypal/payment_info'`	#
`protected string`	`$_proType`	`'paypal/pro'`	# Website Payments Pro instance type Website Payments Pro instance type
`protected boolean`	`$_isGateway`	`false`	# Availability options Availability options
`protected boolean`	`$_canOrder`	`true`	#
`protected boolean`	`$_canAuthorize`	`true`	#
`protected boolean`	`$_canCapture`	`true`	#
`protected boolean`	`$_canCapturePartial`	`true`	#
`protected boolean`	`$_canRefund`	`true`	#
`protected boolean`	`$_canRefundInvoicePartial`	`true`	#
`protected boolean`	`$_canVoid`	`true`	#
`protected boolean`	`$_canUseInternal`	`false`	#
`protected boolean`	`$_canUseCheckout`	`true`	#
`protected boolean`	`$_canUseForMultishipping`	`false`	#
`protected boolean`	`$_canFetchTransactionInfo`	`true`	#
`protected boolean`	`$_canCreateBillingAgreement`	`true`	#
`protected boolean`	`$_canReviewPayment`	`true`	#
`protected Mage_Paypal_Model_Pro`	`$_pro`	`null`	# Website Payments Pro instance Website Payments Pro instance
`protected string`	`$_isOrderPaymentActionKey`	`'is_order_action'`	# Payment additional information key for payment action Payment additional information key for payment action
`protected string`	`$_authorizationCountKey`	`'authorization_count'`	# Payment additional information key for number of used authorizations Payment additional information key for number of used authorizations

Properties inherited from Mage_Payment_Model_Method_Abstract
`$_canCancelInvoice, $_canManageRecurringProfiles, $_debugReplacePrivateDataKeys, $_isInitializeNeeded`

Packages

Classes

Exceptions

Class Mage_Paypal_Model_Express

Direct known subclasses

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Returns

See

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

See

Parameters

Returns

Overrides

Parameters

Throws

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Parameters

Returns

Overrides

Returns

Overrides

Parameters