mirror of
https://github.com/woocommerce/woocommerce-paypal-payments.git
synced 2025-09-05 08:59:14 +08:00
319 lines
8.9 KiB
PHP
319 lines
8.9 KiB
PHP
<?php
|
|
/**
|
|
* The PurchaseUnit factory.
|
|
*
|
|
* @package WooCommerce\PayPalCommerce\ApiClient\Factory
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace WooCommerce\PayPalCommerce\ApiClient\Factory;
|
|
|
|
use WC_Session_Handler;
|
|
use WooCommerce\PayPalCommerce\ApiClient\Entity\Item;
|
|
use WooCommerce\PayPalCommerce\ApiClient\Entity\PurchaseUnit;
|
|
use WooCommerce\PayPalCommerce\ApiClient\Exception\RuntimeException;
|
|
use WooCommerce\PayPalCommerce\ApiClient\Helper\PurchaseUnitSanitizer;
|
|
use WooCommerce\PayPalCommerce\Webhooks\CustomIds;
|
|
|
|
/**
|
|
* Class PurchaseUnitFactory
|
|
*/
|
|
class PurchaseUnitFactory {
|
|
|
|
/**
|
|
* The amount factory.
|
|
*
|
|
* @var AmountFactory
|
|
*/
|
|
private $amount_factory;
|
|
|
|
/**
|
|
* The item factory.
|
|
*
|
|
* @var ItemFactory
|
|
*/
|
|
private $item_factory;
|
|
|
|
/**
|
|
* The shipping factory.
|
|
*
|
|
* @var ShippingFactory
|
|
*/
|
|
private $shipping_factory;
|
|
|
|
/**
|
|
* The payments factory.
|
|
*
|
|
* @var PaymentsFactory
|
|
*/
|
|
private $payments_factory;
|
|
|
|
/**
|
|
* The Prefix.
|
|
*
|
|
* @var string
|
|
*/
|
|
private $prefix;
|
|
|
|
/**
|
|
* The Soft Descriptor.
|
|
*
|
|
* @var string
|
|
*/
|
|
private $soft_descriptor;
|
|
|
|
/**
|
|
* The sanitizer for purchase unit output data.
|
|
*
|
|
* @var PurchaseUnitSanitizer|null
|
|
*/
|
|
private $sanitizer;
|
|
|
|
/**
|
|
* PurchaseUnitFactory constructor.
|
|
*
|
|
* @param AmountFactory $amount_factory The amount factory.
|
|
* @param ItemFactory $item_factory The item factory.
|
|
* @param ShippingFactory $shipping_factory The shipping factory.
|
|
* @param PaymentsFactory $payments_factory The payments factory.
|
|
* @param string $prefix The prefix.
|
|
* @param string $soft_descriptor The soft descriptor.
|
|
* @param ?PurchaseUnitSanitizer $sanitizer The purchase unit to_array sanitizer.
|
|
*/
|
|
public function __construct(
|
|
AmountFactory $amount_factory,
|
|
ItemFactory $item_factory,
|
|
ShippingFactory $shipping_factory,
|
|
PaymentsFactory $payments_factory,
|
|
string $prefix = 'WC-',
|
|
string $soft_descriptor = '',
|
|
PurchaseUnitSanitizer $sanitizer = null
|
|
) {
|
|
|
|
$this->amount_factory = $amount_factory;
|
|
$this->item_factory = $item_factory;
|
|
$this->shipping_factory = $shipping_factory;
|
|
$this->payments_factory = $payments_factory;
|
|
$this->prefix = $prefix;
|
|
$this->soft_descriptor = $soft_descriptor;
|
|
$this->sanitizer = $sanitizer;
|
|
}
|
|
|
|
/**
|
|
* Creates a PurchaseUnit based off a WooCommerce order.
|
|
*
|
|
* @param \WC_Order $order The order.
|
|
*
|
|
* @return PurchaseUnit
|
|
*/
|
|
public function from_wc_order( \WC_Order $order ): PurchaseUnit {
|
|
$amount = $this->amount_factory->from_wc_order( $order );
|
|
$items = array_filter(
|
|
$this->item_factory->from_wc_order( $order ),
|
|
function ( Item $item ): bool {
|
|
return $item->unit_amount()->value() >= 0;
|
|
}
|
|
);
|
|
$shipping = $this->shipping_factory->from_wc_order( $order );
|
|
if (
|
|
! $this->shipping_needed( ... array_values( $items ) ) ||
|
|
empty( $shipping->address()->country_code() ) ||
|
|
( ! $shipping->address()->postal_code() && ! $this->country_without_postal_code( $shipping->address()->country_code() ) )
|
|
) {
|
|
$shipping = null;
|
|
}
|
|
$reference_id = 'default';
|
|
$description = '';
|
|
$custom_id = (string) $order->get_id();
|
|
$invoice_id = $this->prefix . $order->get_order_number();
|
|
$soft_descriptor = $this->soft_descriptor;
|
|
|
|
$purchase_unit = new PurchaseUnit(
|
|
$amount,
|
|
$items,
|
|
$shipping,
|
|
$reference_id,
|
|
$description,
|
|
$custom_id,
|
|
$invoice_id,
|
|
$soft_descriptor
|
|
);
|
|
|
|
$this->init_purchase_unit( $purchase_unit );
|
|
|
|
/**
|
|
* Returns PurchaseUnit for the WC order.
|
|
*/
|
|
return apply_filters(
|
|
'woocommerce_paypal_payments_purchase_unit_from_wc_order',
|
|
$purchase_unit,
|
|
$order
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a PurchaseUnit based off a WooCommerce cart.
|
|
*
|
|
* @param \WC_Cart|null $cart The cart.
|
|
* @param bool $with_shipping_options Include WC shipping methods.
|
|
*
|
|
* @return PurchaseUnit
|
|
*/
|
|
public function from_wc_cart( ?\WC_Cart $cart = null, bool $with_shipping_options = false ): PurchaseUnit {
|
|
if ( ! $cart ) {
|
|
$cart = WC()->cart ?? new \WC_Cart();
|
|
}
|
|
|
|
$amount = $this->amount_factory->from_wc_cart( $cart );
|
|
$items = array_filter(
|
|
$this->item_factory->from_wc_cart( $cart ),
|
|
function ( Item $item ): bool {
|
|
return $item->unit_amount()->value() >= 0;
|
|
}
|
|
);
|
|
|
|
$shipping = null;
|
|
$customer = \WC()->customer;
|
|
if ( $this->shipping_needed( ... array_values( $items ) ) && is_a( $customer, \WC_Customer::class ) ) {
|
|
$shipping = $this->shipping_factory->from_wc_customer( \WC()->customer, $with_shipping_options );
|
|
if (
|
|
2 !== strlen( $shipping->address()->country_code() ) ||
|
|
( ! $shipping->address()->postal_code() && ! $this->country_without_postal_code( $shipping->address()->country_code() ) )
|
|
) {
|
|
$shipping = null;
|
|
}
|
|
}
|
|
|
|
$reference_id = 'default';
|
|
$description = '';
|
|
|
|
$custom_id = '';
|
|
$session = WC()->session;
|
|
if ( $session instanceof WC_Session_Handler ) {
|
|
$session_id = $session->get_customer_unique_id();
|
|
if ( $session_id ) {
|
|
$custom_id = CustomIds::CUSTOMER_ID_PREFIX . $session_id;
|
|
}
|
|
}
|
|
$invoice_id = '';
|
|
$soft_descriptor = $this->soft_descriptor;
|
|
$purchase_unit = new PurchaseUnit(
|
|
$amount,
|
|
$items,
|
|
$shipping,
|
|
$reference_id,
|
|
$description,
|
|
$custom_id,
|
|
$invoice_id,
|
|
$soft_descriptor
|
|
);
|
|
|
|
$this->init_purchase_unit( $purchase_unit );
|
|
|
|
return $purchase_unit;
|
|
}
|
|
|
|
/**
|
|
* Builds a Purchase unit based off a PayPal JSON response.
|
|
*
|
|
* @param \stdClass $data The JSON object.
|
|
*
|
|
* @return PurchaseUnit
|
|
* @throws RuntimeException When JSON object is malformed.
|
|
*/
|
|
public function from_paypal_response( \stdClass $data ): PurchaseUnit {
|
|
if ( ! isset( $data->reference_id ) || ! is_string( $data->reference_id ) ) {
|
|
throw new RuntimeException(
|
|
__( 'No reference ID given.', 'woocommerce-paypal-payments' )
|
|
);
|
|
}
|
|
|
|
$amount = $this->amount_factory->from_paypal_response( $data->amount );
|
|
$description = ( isset( $data->description ) ) ? $data->description : '';
|
|
$custom_id = ( isset( $data->custom_id ) ) ? $data->custom_id : '';
|
|
$invoice_id = ( isset( $data->invoice_id ) ) ? $data->invoice_id : '';
|
|
$soft_descriptor = ( isset( $data->soft_descriptor ) ) ? $data->soft_descriptor : $this->soft_descriptor;
|
|
$items = array();
|
|
if ( isset( $data->items ) && is_array( $data->items ) ) {
|
|
$items = array_map(
|
|
function ( \stdClass $item ): Item {
|
|
return $this->item_factory->from_paypal_response( $item );
|
|
},
|
|
$data->items
|
|
);
|
|
}
|
|
$shipping = null;
|
|
try {
|
|
if ( isset( $data->shipping ) ) {
|
|
$shipping = $this->shipping_factory->from_paypal_response( $data->shipping );
|
|
}
|
|
} catch ( RuntimeException $error ) {
|
|
;
|
|
}
|
|
$payments = null;
|
|
try {
|
|
if ( isset( $data->payments ) ) {
|
|
$payments = $this->payments_factory->from_paypal_response( $data->payments );
|
|
}
|
|
} catch ( RuntimeException $error ) {
|
|
;
|
|
}
|
|
|
|
$purchase_unit = new PurchaseUnit(
|
|
$amount,
|
|
$items,
|
|
$shipping,
|
|
$data->reference_id,
|
|
$description,
|
|
$custom_id,
|
|
$invoice_id,
|
|
$soft_descriptor,
|
|
$payments
|
|
);
|
|
|
|
$this->init_purchase_unit( $purchase_unit );
|
|
|
|
return $purchase_unit;
|
|
}
|
|
|
|
/**
|
|
* Whether we need a shipping address for a set of items or not.
|
|
*
|
|
* @param Item ...$items The items on based which the decision is made.
|
|
*
|
|
* @return bool
|
|
*/
|
|
private function shipping_needed( Item ...$items ): bool {
|
|
|
|
foreach ( $items as $item ) {
|
|
if ( $item->category() !== Item::DIGITAL_GOODS ) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Check if country does not have postal code.
|
|
*
|
|
* @param string $country_code The country code.
|
|
* @return bool Whether country has postal code or not.
|
|
*/
|
|
private function country_without_postal_code( string $country_code ): bool {
|
|
$countries = array( 'AE', 'AF', 'AG', 'AI', 'AL', 'AN', 'AO', 'AW', 'BB', 'BF', 'BH', 'BI', 'BJ', 'BM', 'BO', 'BS', 'BT', 'BW', 'BZ', 'CD', 'CF', 'CG', 'CI', 'CK', 'CL', 'CM', 'CO', 'CR', 'CV', 'DJ', 'DM', 'DO', 'EC', 'EG', 'ER', 'ET', 'FJ', 'FK', 'GA', 'GD', 'GH', 'GI', 'GM', 'GN', 'GQ', 'GT', 'GW', 'GY', 'HK', 'HN', 'HT', 'IE', 'IQ', 'IR', 'JM', 'JO', 'KE', 'KH', 'KI', 'KM', 'KN', 'KP', 'KW', 'KY', 'LA', 'LB', 'LC', 'LK', 'LR', 'LS', 'LY', 'ML', 'MM', 'MO', 'MR', 'MS', 'MT', 'MU', 'MW', 'MZ', 'NA', 'NE', 'NG', 'NI', 'NP', 'NR', 'NU', 'OM', 'PA', 'PE', 'PF', 'PY', 'QA', 'RW', 'SA', 'SB', 'SC', 'SD', 'SL', 'SN', 'SO', 'SR', 'SS', 'ST', 'SV', 'SY', 'TC', 'TD', 'TG', 'TL', 'TO', 'TT', 'TV', 'TZ', 'UG', 'UY', 'VC', 'VE', 'VG', 'VN', 'VU', 'WS', 'XA', 'XB', 'XC', 'XE', 'XL', 'XM', 'XN', 'XS', 'YE', 'ZM', 'ZW' );
|
|
return in_array( $country_code, $countries, true );
|
|
}
|
|
|
|
/**
|
|
* Initializes a purchase unit object.
|
|
*
|
|
* @param PurchaseUnit $purchase_unit The purchase unit.
|
|
* @return void
|
|
*/
|
|
private function init_purchase_unit( PurchaseUnit $purchase_unit ): void {
|
|
if ( $this->sanitizer instanceof PurchaseUnitSanitizer ) {
|
|
$purchase_unit->set_sanitizer( $this->sanitizer );
|
|
}
|
|
}
|
|
}
|
