Class PayPalController

HttpViewController implements HttpViewControllerInterface

PayPalController

Package: HttpViewControllers
Located at Controllers/HttpView/Shop/PayPalController.inc.php

Methods summary

`public`	# `__construct( HttpContextReaderInterface $httpContextReader, HttpResponseProcessorInterface $httpResponseProcessor, ContentViewInterface $contentView )` Initialize the Controller with required properties Initialize the Controller with required properties Parameters `$httpContextReader` `$httpResponseProcessor` `$contentView` Inheritdoc Overrides `HttpViewController::__construct`
`protected CI_DB_query_builder`	# `getQueryBuilder( )` returns a QueryBuilder instance for database access. returns a QueryBuilder instance for database access. Returns CI_DB_query_builder Returns a database driver that can be used for db operations.
`public HttpControllerResponseInterface`	# `actionDefault( )` Run the actionDefault method. Run the actionDefault method. Returns `HttpControllerResponseInterface` Overrides `HttpViewController::actionDefault`
`public`	# `actionCartECS( )` sets the ECS shopping cart flag to true. The flag is used in ECSButton.js as an indication that the customer is to be redirected to PayPal for an ECS login. This is required for the ECS button on products pages to work as intended. sets the ECS shopping cart flag to true. The flag is used in ECSButton.js as an indication that the customer is to be redirected to PayPal for an ECS login. This is required for the ECS button on products pages to work as intended.
`public`	# `actionPrepareECS( )` creates a PayPal payment for the ECS flow and redirects the customer to the ECS login page. creates a PayPal payment for the ECS flow and redirects the customer to the ECS login page.
`public`	# `actionCancelECS( )` invalidates session data when the user cancels an ECS login invalidates session data when the user cancels an ECS login
`protected`	# `getLocale( )` determines LocaleCode from session data determines LocaleCode from session data
`protected`	# `_findCountryByID( $country_id )`
`public`	# `actionReturnFromECS( )` called as the return URL when a customer returns from an ECS login. If the customer is not logged in, a guest account will be created from data provided by PayPal. called as the return URL when a customer returns from an ECS login. If the customer is not logged in, a guest account will be created from data provided by PayPal.
`protected`	# `loginCustomer( Customer $customer )`
`protected`	# `getCustomerCountryIdByIso2( $iso2 )`
`protected`	# `getCustomerByEmail( $email_address )`
`public`	# `actionLogoffECSCustomer( )` called by a CheckoutSuccessExtender to end an ECS guest session called by a CheckoutSuccessExtender to end an ECS guest session
`public`	# `actionBankTxnPending( )` dummy action for the bank transaction pending URL. The flow that used to require this has recently been deprecated by PayPal. dummy action for the bank transaction pending URL. The flow that used to require this has recently been deprecated by PayPal.
`public`	# `actionSetPayment( )` called by the third party payments integration in PayPal Plus, this action simply sets one of the supported payment methods as the selected method and invalidates the PayPal payment which has been created for the paywall. called by the third party payments integration in PayPal Plus, this action simply sets one of the supported payment methods as the selected method and invalidates the PayPal payment which has been created for the paywall.
`protected boolean`	# `_isValidPayment( $paymentCode )` determines if a payment module is currently installed. Caveat: This only works for modules where the filename (plus '.php') is identical with the module code. determines if a payment module is currently installed. Caveat: This only works for modules where the filename (plus '.php') is identical with the module code. Returns boolean true if module is installed
`public`	# `actionWebhook( )` called by PayPal to deliver Webhook notifications. Any incoming notification will be recorded in the order status history of the corresponding order. If the HMAC signature check fails, a warning will be added. Notifications of type PAYMENT.SALE.COMPLETED cause the order to be transferred to the status for completed orders. called by PayPal to deliver Webhook notifications. Any incoming notification will be recorded in the order status history of the corresponding order. If the HMAC signature check fails, a warning will be added. Notifications of type PAYMENT.SALE.COMPLETED cause the order to be transferred to the status for completed orders.
`protected`	# `updateOrdersStatus( $orders_id, $orders_status_id = null, $comments = '' )` updates order status and adds entry to status history updates order status and adds entry to status history Todo: replace once services for orders and order status history are available
`public`	# `actionStatusUpdate( )` This action can be called from a cronjob to update orders still in pending state. Supposed to be used as a replacement for Webhooks in cases where the shop is inaccessible for PayPal, e.g. due to missing TLS accessibility. This action can be called from a cronjob to update orders still in pending state. Supposed to be used as a replacement for Webhooks in cases where the shop is inaccessible for PayPal, e.g. due to missing TLS accessibility.
`public`	# `actionPaylink( )` Endpoint for paylink processing. Paylinks created from the order details page are directed at this action. If the paycode hash is valid a payment will be created and the customer redirected to PayPal to approve the payment. Endpoint for paylink processing. Paylinks created from the order details page are directed at this action. If the paycode hash is valid a payment will be created and the customer redirected to PayPal to approve the payment.
`public`	# `actionPaylinkReturn( )` action used in return URLs for the paylink feature. Takes the PayerID from the query parameters and executes the payment created by actionPaylink(), then displays a quick thank you note. action used in return URLs for the paylink feature. Takes the PayerID from the query parameters and executes the payment created by actionPaylink(), then displays a quick thank you note.

Methods inherited from HttpViewController

_callActionMethod(), _getPostData(), _getPostDataCollection(), _getQueryParameter(), _getQueryParametersCollection(), _render(), _validatePageToken(), proceed()

Properties summary

`protected PayPalText`	`$paypalText` Helper for language-specific texts Helper for language-specific texts	#
`protected PayPalConfigurationStorage`	`$configurationStorage`	#
`protected PayPalLogger`	`$logger`	#

Properties inherited from HttpViewController

$assets, $contentView, $httpContextReader, $httpResponseProcessor, $postDataArray, $queryParametersArray

Packages

Classes

Class PayPalController

Methods summary

Parameters

Inheritdoc

Overrides

Returns

Returns

Overrides

Returns

Todo:

Methods inherited from HttpViewController

Properties summary

Properties inherited from HttpViewController