mirror of
https://github.com/woocommerce/woocommerce-paypal-payments.git
synced 2025-09-05 08:59:14 +08:00
343 lines
9.8 KiB
PHP
343 lines
9.8 KiB
PHP
<?php
|
||
/**
|
||
* The PayPal Payment Gateway
|
||
*
|
||
* @package WooCommerce\PayPalCommerce\WcGateway\Gateway
|
||
*/
|
||
|
||
declare(strict_types=1);
|
||
|
||
namespace WooCommerce\PayPalCommerce\WcGateway\Gateway;
|
||
|
||
use WooCommerce\PayPalCommerce\ApiClient\Exception\PayPalApiException;
|
||
use WooCommerce\PayPalCommerce\Onboarding\State;
|
||
use WooCommerce\PayPalCommerce\Session\SessionHandler;
|
||
use WooCommerce\PayPalCommerce\WcGateway\Notice\AuthorizeOrderActionNotice;
|
||
use WooCommerce\PayPalCommerce\WcGateway\Processor\AuthorizedPaymentsProcessor;
|
||
use WooCommerce\PayPalCommerce\WcGateway\Processor\OrderProcessor;
|
||
use WooCommerce\PayPalCommerce\WcGateway\Processor\RefundProcessor;
|
||
use WooCommerce\PayPalCommerce\WcGateway\Settings\SectionsRenderer;
|
||
use WooCommerce\PayPalCommerce\WcGateway\Settings\SettingsRenderer;
|
||
use Psr\Container\ContainerInterface;
|
||
|
||
/**
|
||
* Class PayPalGateway
|
||
*/
|
||
class PayPalGateway extends \WC_Payment_Gateway {
|
||
|
||
use ProcessPaymentTrait;
|
||
|
||
const ID = 'ppcp-gateway';
|
||
const CAPTURED_META_KEY = '_ppcp_paypal_captured';
|
||
const INTENT_META_KEY = '_ppcp_paypal_intent';
|
||
const ORDER_ID_META_KEY = '_ppcp_paypal_order_id';
|
||
|
||
/**
|
||
* The Settings Renderer.
|
||
*
|
||
* @var SettingsRenderer
|
||
*/
|
||
protected $settings_renderer;
|
||
|
||
/**
|
||
* The processor for authorized payments.
|
||
*
|
||
* @var AuthorizedPaymentsProcessor
|
||
*/
|
||
protected $authorized_payments;
|
||
|
||
/**
|
||
* The Authorized Order Action Notice.
|
||
*
|
||
* @var AuthorizeOrderActionNotice
|
||
*/
|
||
protected $notice;
|
||
|
||
/**
|
||
* The processor for orders.
|
||
*
|
||
* @var OrderProcessor
|
||
*/
|
||
protected $order_processor;
|
||
|
||
/**
|
||
* The settings.
|
||
*
|
||
* @var ContainerInterface
|
||
*/
|
||
protected $config;
|
||
|
||
/**
|
||
* The Session Handler.
|
||
*
|
||
* @var SessionHandler
|
||
*/
|
||
protected $session_handler;
|
||
|
||
/**
|
||
* The Refund Processor.
|
||
*
|
||
* @var RefundProcessor
|
||
*/
|
||
private $refund_processor;
|
||
|
||
/**
|
||
* PayPalGateway constructor.
|
||
*
|
||
* @param SettingsRenderer $settings_renderer The Settings Renderer.
|
||
* @param OrderProcessor $order_processor The Order Processor.
|
||
* @param AuthorizedPaymentsProcessor $authorized_payments_processor The Authorized Payments Processor.
|
||
* @param AuthorizeOrderActionNotice $notice The Order Action Notice object.
|
||
* @param ContainerInterface $config The settings.
|
||
* @param SessionHandler $session_handler The Session Handler.
|
||
* @param RefundProcessor $refund_processor The Refund Processor.
|
||
* @param State $state The state.
|
||
*/
|
||
public function __construct(
|
||
SettingsRenderer $settings_renderer,
|
||
OrderProcessor $order_processor,
|
||
AuthorizedPaymentsProcessor $authorized_payments_processor,
|
||
AuthorizeOrderActionNotice $notice,
|
||
ContainerInterface $config,
|
||
SessionHandler $session_handler,
|
||
RefundProcessor $refund_processor,
|
||
State $state
|
||
) {
|
||
|
||
$this->id = self::ID;
|
||
$this->order_processor = $order_processor;
|
||
$this->authorized_payments = $authorized_payments_processor;
|
||
$this->notice = $notice;
|
||
$this->settings_renderer = $settings_renderer;
|
||
$this->config = $config;
|
||
$this->session_handler = $session_handler;
|
||
$this->refund_processor = $refund_processor;
|
||
|
||
if ( $state->current_state() === State::STATE_ONBOARDED ) {
|
||
$this->supports = array( 'refunds' );
|
||
}
|
||
if (
|
||
defined( 'PPCP_FLAG_SUBSCRIPTION' )
|
||
&& PPCP_FLAG_SUBSCRIPTION
|
||
&& $this->config->has( 'vault_enabled' )
|
||
&& $this->config->get( 'vault_enabled' )
|
||
) {
|
||
$this->supports = array(
|
||
'refunds',
|
||
'products',
|
||
'subscriptions',
|
||
'subscription_cancellation',
|
||
'subscription_suspension',
|
||
'subscription_reactivation',
|
||
'subscription_amount_changes',
|
||
'subscription_date_changes',
|
||
'subscription_payment_method_change',
|
||
'subscription_payment_method_change_customer',
|
||
'subscription_payment_method_change_admin',
|
||
'multiple_subscriptions',
|
||
);
|
||
}
|
||
|
||
$this->method_title = $this->define_method_title();
|
||
$this->method_description = $this->define_method_description();
|
||
$this->title = $this->config->has( 'title' ) ?
|
||
$this->config->get( 'title' ) : $this->method_title;
|
||
$this->description = $this->config->has( 'description' ) ?
|
||
$this->config->get( 'description' ) : $this->method_description;
|
||
|
||
$this->init_form_fields();
|
||
$this->init_settings();
|
||
|
||
add_action(
|
||
'woocommerce_update_options_payment_gateways_' . $this->id,
|
||
array(
|
||
$this,
|
||
'process_admin_options',
|
||
)
|
||
);
|
||
}
|
||
|
||
/**
|
||
* Whether the Gateway needs to be setup.
|
||
*
|
||
* @return bool
|
||
*/
|
||
public function needs_setup(): bool {
|
||
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* Initializes the form fields.
|
||
*/
|
||
public function init_form_fields() {
|
||
$this->form_fields = array(
|
||
'enabled' => array(
|
||
'title' => __( 'Enable/Disable', 'paypal-payments-for-woocommerce' ),
|
||
'type' => 'checkbox',
|
||
'desc_tip' => true,
|
||
'description' => __( 'In order to use PayPal or PayPal Card Processing, you need to enable the Gateway.', 'paypal-payments-for-woocommerce' ),
|
||
'label' => __( 'Enable the PayPal Gateway', 'paypal-payments-for-woocommerce' ),
|
||
'default' => 'no',
|
||
),
|
||
'ppcp' => array(
|
||
'type' => 'ppcp',
|
||
),
|
||
);
|
||
|
||
$should_show_enabled_checkbox = ! $this->is_credit_card_tab() && ( $this->config->has( 'merchant_email' ) && $this->config->get( 'merchant_email' ) );
|
||
if ( ! $should_show_enabled_checkbox ) {
|
||
unset( $this->form_fields['enabled'] );
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Captures an authorized payment for an WooCommerce order.
|
||
*
|
||
* @param \WC_Order $wc_order The WooCommerce order.
|
||
*
|
||
* @return bool
|
||
*/
|
||
public function capture_authorized_payment( \WC_Order $wc_order ): bool {
|
||
$is_processed = $this->authorized_payments->process( $wc_order );
|
||
$this->render_authorization_message_for_status( $this->authorized_payments->last_status() );
|
||
|
||
if ( $is_processed ) {
|
||
$wc_order->add_order_note(
|
||
__( 'Payment successfully captured.', 'paypal-payments-for-woocommerce' )
|
||
);
|
||
|
||
$wc_order->set_status( 'processing' );
|
||
$wc_order->update_meta_data( self::CAPTURED_META_KEY, 'true' );
|
||
$wc_order->save();
|
||
return true;
|
||
}
|
||
|
||
if ( $this->authorized_payments->last_status() === AuthorizedPaymentsProcessor::ALREADY_CAPTURED ) {
|
||
if ( $wc_order->get_status() === 'on-hold' ) {
|
||
$wc_order->add_order_note(
|
||
__( 'Payment successfully captured.', 'paypal-payments-for-woocommerce' )
|
||
);
|
||
$wc_order->set_status( 'processing' );
|
||
}
|
||
|
||
$wc_order->update_meta_data( self::CAPTURED_META_KEY, 'true' );
|
||
$wc_order->save();
|
||
return true;
|
||
}
|
||
return false;
|
||
}
|
||
|
||
/**
|
||
* Displays the notice for a status.
|
||
*
|
||
* @param string $status The status.
|
||
*/
|
||
private function render_authorization_message_for_status( string $status ) {
|
||
|
||
$message_mapping = array(
|
||
AuthorizedPaymentsProcessor::SUCCESSFUL => AuthorizeOrderActionNotice::SUCCESS,
|
||
AuthorizedPaymentsProcessor::ALREADY_CAPTURED => AuthorizeOrderActionNotice::ALREADY_CAPTURED,
|
||
AuthorizedPaymentsProcessor::INACCESSIBLE => AuthorizeOrderActionNotice::NO_INFO,
|
||
AuthorizedPaymentsProcessor::NOT_FOUND => AuthorizeOrderActionNotice::NOT_FOUND,
|
||
);
|
||
$display_message = ( isset( $message_mapping[ $status ] ) ) ?
|
||
$message_mapping[ $status ]
|
||
: AuthorizeOrderActionNotice::FAILED;
|
||
$this->notice->display_message( $display_message );
|
||
}
|
||
|
||
/**
|
||
* Renders the settings.
|
||
*
|
||
* @return string
|
||
*/
|
||
public function generate_ppcp_html(): string {
|
||
|
||
ob_start();
|
||
$this->settings_renderer->render( false );
|
||
$content = ob_get_contents();
|
||
ob_end_clean();
|
||
return $content;
|
||
}
|
||
|
||
/**
|
||
* Defines the method title. If we are on the credit card tab in the settings, we want to change this.
|
||
*
|
||
* @return string
|
||
*/
|
||
private function define_method_title(): string {
|
||
if ( $this->is_credit_card_tab() ) {
|
||
return __( 'PayPal Card Processing', 'paypal-payments-for-woocommerce' );
|
||
}
|
||
if ( $this->is_paypal_tab() ) {
|
||
return __( 'PayPal Checkout', 'paypal-payments-for-woocommerce' );
|
||
}
|
||
return __( 'PayPal', 'paypal-payments-for-woocommerce' );
|
||
}
|
||
|
||
/**
|
||
* Defines the method description. If we are on the credit card tab in the settings, we want to change this.
|
||
*
|
||
* @return string
|
||
*/
|
||
private function define_method_description(): string {
|
||
if ( $this->is_credit_card_tab() ) {
|
||
return __(
|
||
'Accept debit and credit cards, and local payment methods with PayPal’s latest solution.',
|
||
'paypal-payments-for-woocommerce'
|
||
);
|
||
}
|
||
|
||
return __(
|
||
'Accept PayPal, PayPal Credit and alternative payment types with PayPal’s latest solution.',
|
||
'paypal-payments-for-woocommerce'
|
||
);
|
||
}
|
||
|
||
// phpcs:disable WordPress.Security.NonceVerification.Recommended
|
||
|
||
/**
|
||
* Determines, whether the current session is on the credit card tab in the admin settings.
|
||
*
|
||
* @return bool
|
||
*/
|
||
private function is_credit_card_tab() : bool {
|
||
return is_admin()
|
||
&& isset( $_GET[ SectionsRenderer::KEY ] )
|
||
&& CreditCardGateway::ID === sanitize_text_field( wp_unslash( $_GET[ SectionsRenderer::KEY ] ) );
|
||
|
||
}
|
||
|
||
/**
|
||
* Whether we are on the PayPal settings tab.
|
||
*
|
||
* @return bool
|
||
*/
|
||
private function is_paypal_tab() : bool {
|
||
return ! $this->is_credit_card_tab()
|
||
&& is_admin()
|
||
&& isset( $_GET['section'] )
|
||
&& self::ID === sanitize_text_field( wp_unslash( $_GET['section'] ) );
|
||
}
|
||
// phpcs:enable WordPress.Security.NonceVerification.Recommended
|
||
|
||
/**
|
||
* Process refund.
|
||
*
|
||
* If the gateway declares 'refunds' support, this will allow it to refund.
|
||
* a passed in amount.
|
||
*
|
||
* @param int $order_id Order ID.
|
||
* @param float $amount Refund amount.
|
||
* @param string $reason Refund reason.
|
||
* @return boolean True or false based on success, or a WP_Error object.
|
||
*/
|
||
public function process_refund( $order_id, $amount = null, $reason = '' ) {
|
||
$order = wc_get_order( $order_id );
|
||
if ( ! is_a( $order, \WC_Order::class ) ) {
|
||
return false;
|
||
}
|
||
return $this->refund_processor->process( $order, (float) $amount, (string) $reason );
|
||
}
|
||
}
|
