Class Mage_Paypal_Model_Express_Checkout

Wrapper that performs Paypal Express and Checkout communication Use current Paypal Express method instance

Direct known subclasses

Mage_PaypalUk_Model_Express_Checkout, Mage_XmlConnect_Model_Paypal_Mecl_Checkout

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

Methods summary
`public`	# `__construct( array $params = array() )` Set quote and config instances Set quote and config instances Parameters `$params` `array` $params
`public string`	# `getCheckoutShortcutImageUrl( )` Checkout with PayPal image URL getter Spares API calls of getting "pal" variable, by putting it into cache per store view Checkout with PayPal image URL getter Spares API calls of getting "pal" variable, by putting it into cache per store view Returns `string`
`public Mage_Paypal_Model_Express_Checkout`	# `prepareGiropayUrls( string $successUrl, string $cancelUrl, string $pendingUrl )` Setter that enables giropay redirects flow Setter that enables giropay redirects flow Parameters `$successUrl` `string` $successUrl - payment success result `$cancelUrl` `string` $cancelUrl - payment cancellation result `$pendingUrl` `string` $pendingUrl - pending payment result Returns `Mage_Paypal_Model_Express_Checkout`
`public Mage_Paypal_Model_Express_Checkout`	# `setIsBillingAgreementRequested( boolean $flag )` Set create billing agreement flag Set create billing agreement flag Parameters `$flag` `boolean` $flag Returns `Mage_Paypal_Model_Express_Checkout`
`public Mage_Paypal_Model_Express_Checkout`	# `setCustomer( Mage_Customer_Model_Customer $customer )` Setter for customer Setter for customer Parameters `$customer` `Mage_Customer_Model_Customer` $customer Returns `Mage_Paypal_Model_Express_Checkout`
`public Mage_Paypal_Model_Express_Checkout`	# `setCustomerWithAddressChange( Mage_Customer_Model_Customer $customer, Mage_Sales_Model_Quote_Address $billingAddress = null, Mage_Sales_Model_Quote_Address $shippingAddress = null )` Setter for customer with billing and shipping address changing ability Setter for customer with billing and shipping address changing ability Parameters `$customer` `Mage_Customer_Model_Customer` $customer `$billingAddress` `Mage_Sales_Model_Quote_Address` $billingAddress `$shippingAddress` `Mage_Sales_Model_Quote_Address` $shippingAddress Returns `Mage_Paypal_Model_Express_Checkout`
`public mixed`	# `start( string $returnUrl, string $cancelUrl )` Reserve order ID for specified quote and start checkout on PayPal Reserve order ID for specified quote and start checkout on PayPal Parameters `$returnUrl` `string` $returnUrl `$cancelUrl` `string` $cancelUrl Returns `mixed`
`public`	# `returnFromPaypal( string $token )` Update quote when returned from PayPal rewrite billing address by paypal save old billing address for new customer export shipping address in case address absence Update quote when returned from PayPal rewrite billing address by paypal save old billing address for new customer export shipping address in case address absence Parameters `$token` `string` $token
`public`	# `prepareOrderReview( mixed $token = null )` Check whether order review has enough data to initialize Check whether order review has enough data to initialize Parameters `$token` `mixed` $token Throws `Mage_Core_Exception`
`public string`	# `getShippingOptionsCallbackResponse( array $request )` Return callback response with shipping options Return callback response with shipping options Parameters `$request` `array` $request Returns `string`
`public`	# `updateShippingMethod( string $methodCode )` Set shipping method to quote, if needed Set shipping method to quote, if needed Parameters `$methodCode` `string` $methodCode
`public`	# `updateOrder( array $data )` Update order data Update order data Parameters `$data` `array` $data
`public`	# `place( string $token, string $shippingMethodCode = null )` Place the order and recurring payment profiles when customer returned from paypal Until this moment all quote data must be valid Place the order and recurring payment profiles when customer returned from paypal Until this moment all quote data must be valid Parameters `$token` `string` $token `$shippingMethodCode` `string` $shippingMethodCode
`private`	# `_ignoreAddressValidation( )` Make sure addresses will be saved without validation errors Make sure addresses will be saved without validation errors
`public string`	# `getRedirectUrl( )` Determine whether redirect somewhere specifically is required Determine whether redirect somewhere specifically is required Returns `string`
`public array`	# `getRecurringPaymentProfiles( )` Return recurring payment profiles Return recurring payment profiles Returns `array`
`public Mage_Sales_Model_Billing_Agreement\|null`	# `getBillingAgreement( )` Get created billing agreement Get created billing agreement Returns `Mage_Sales_Model_Billing_Agreement\|null`
`public Mage_Sales_Model_Order`	# `getOrder( )` Return order Return order Returns `Mage_Sales_Model_Order`
`public string`	# `getCheckoutMethod( )` Get checkout method Get checkout method Returns `string`
`protected`	# `_setExportedAddressData( Mage_Sales_Model_Quote_Address $address, array $exportedAddress )` Sets address data from exported address Sets address data from exported address Parameters `$address` `Mage_Sales_Model_Quote_Address` $address `$exportedAddress` `array` $exportedAddress
`protected Mage_Paypal_Model_Express_Checkout`	# `_setBillingAgreementRequest( )` Set create billing agreement flag to api call Set create billing agreement flag to api call Returns `Mage_Paypal_Model_Express_Checkout`
`protected Mage_Paypal_Model_Api_Nvp`	# `_getApi( )` Returns `Mage_Paypal_Model_Api_Nvp`
`protected array\|false`	# `_prepareShippingOptions( Mage_Sales_Model_Quote_Address $address, boolean $mayReturnEmpty = false, mixed $calculateTax = false )` Attempt to collect address shipping rates and return them for further usage in instant update API Returns empty array if it was impossible to obtain any shipping rate If there are shipping rates obtained, the method must return one of them as default. Attempt to collect address shipping rates and return them for further usage in instant update API Returns empty array if it was impossible to obtain any shipping rate If there are shipping rates obtained, the method must return one of them as default. Parameters `$address` `Mage_Sales_Model_Quote_Address` $address `$mayReturnEmpty` `boolean` $mayReturnEmpty `$calculateTax` Returns `array\|false`
`protected static integer`	# `cmpShippingOptions( Varien_Object $option1, Varien_Object $option2 )` Compare two shipping options based on their amounts Compare two shipping options based on their amounts This function is used as a callback comparison function in shipping options sorting process Parameters `$option1` `Varien_Object` $option1 `$option2` `Varien_Object` $option2 Returns `integer` See `Mage_Paypal_Model_Express_Checkout::_prepareShippingOptions()`
`protected string`	# `_matchShippingMethodCode( Mage_Sales_Model_Quote_Address $address, string $selectedCode )` Try to find whether the code provided by PayPal corresponds to any of possible shipping rates This method was created only because PayPal has issues with returning the selected code. If in future the issue is fixed, we don't need to attempt to match it. It would be enough to set the method code before collecting shipping rates Try to find whether the code provided by PayPal corresponds to any of possible shipping rates This method was created only because PayPal has issues with returning the selected code. If in future the issue is fixed, we don't need to attempt to match it. It would be enough to set the method code before collecting shipping rates Parameters `$address` `Mage_Sales_Model_Quote_Address` $address `$selectedCode` `string` $selectedCode Returns `string`
`protected Mage_Paypal_Model_Express_Checkout`	# `_prepareGuestQuote( )` Prepare quote for guest checkout order submit Prepare quote for guest checkout order submit Returns `Mage_Paypal_Model_Express_Checkout`
`protected Mage_Paypal_Model_Express_Checkout`	# `_prepareNewCustomerQuote( )` Prepare quote for customer registration and customer order submit and restore magento customer data from quote Prepare quote for customer registration and customer order submit and restore magento customer data from quote Returns `Mage_Paypal_Model_Express_Checkout`
`protected Mage_Paypal_Model_Express_Checkout`	# `_prepareCustomerQuote( )` Prepare quote for customer order submit Prepare quote for customer order submit Returns `Mage_Paypal_Model_Express_Checkout`
`protected Mage_Paypal_Model_Express_Checkout`	# `_involveNewCustomer( )` Involve new customer to system Involve new customer to system Returns `Mage_Paypal_Model_Express_Checkout`
`public Mage_Customer_Model_Session`	# `getCustomerSession( )` Get customer session object Get customer session object Returns `Mage_Customer_Model_Session`

Constants summary
`string`	`PAL_CACHE_ID`	`'paypal_express_checkout_pal'`	# Cache ID prefix for "pal" lookup Cache ID prefix for "pal" lookup
`string`	`PAYMENT_INFO_TRANSPORT_TOKEN`	`'paypal_express_checkout_token'`	# Keys for passthrough variables in sales/quote_payment and sales/order_payment Uses additional_information as storage Keys for passthrough variables in sales/quote_payment and sales/order_payment Uses additional_information as storage
`string`	`PAYMENT_INFO_TRANSPORT_SHIPPING_OVERRIDEN`	`'paypal_express_checkout_shipping_overriden'`	#
`string`	`PAYMENT_INFO_TRANSPORT_SHIPPING_METHOD`	`'paypal_express_checkout_shipping_method'`	#
`string`	`PAYMENT_INFO_TRANSPORT_PAYER_ID`	`'paypal_express_checkout_payer_id'`	#
`string`	`PAYMENT_INFO_TRANSPORT_REDIRECT`	`'paypal_express_checkout_redirect_required'`	#
`string`	`PAYMENT_INFO_TRANSPORT_BILLING_AGREEMENT`	`'paypal_ec_create_ba'`	#

Properties summary
`protected Mage_Sales_Model_Quote`	`$_quote`	`null`	#
`protected Mage_Paypal_Model_Config`	`$_config`	`null`	# Config instance Config instance
`protected Mage_Paypal_Model_Api_Nvp`	`$_api`	`null`	# API instance API instance
`protected string`	`$_apiType`	`'paypal/api_nvp'`	# Api Model Type Api Model Type
`protected unknown_type`	`$_methodType`	`Mage_Paypal_Model_Config::METHOD_WPP_EXPRESS`	# Payment method type Payment method type
`protected string`	`$_redirectUrl`	`''`	# State helper variables State helper variables
`protected string`	`$_pendingPaymentMessage`	`''`	#
`protected string`	`$_checkoutRedirectUrl`	`''`	#
`protected Mage_Customer_Model_Session`	`$_customerSession`		#
`protected array`	`$_giropayUrls`	`array()`	# Redirect urls supposed to be set to support giropay Redirect urls supposed to be set to support giropay
`protected boolean`	`$_isBARequested`	`false`	# Create Billing Agreement flag Create Billing Agreement flag
`protected integer`	`$_customerId`	`null`	# Customer ID Customer ID
`protected array`	`$_recurringPaymentProfiles`	`array()`	# Recurring payment profiles Recurring payment profiles
`protected Mage_Sales_Model_Billing_Agreement`	`$_billingAgreement`	`null`	# Billing agreement that might be created during order placing Billing agreement that might be created during order placing
`protected Mage_Sales_Model_QuoteMage_Sales_Model_Quote`	`$_order`	`null`	# Order Order

Packages

Classes

Exceptions

Class Mage_Paypal_Model_Express_Checkout

Direct known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Throws

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Returns

Returns

Returns

Returns

Returns