184 lines
8.0 KiB
PHP
184 lines
8.0 KiB
PHP
<?php
|
|
|
|
/**
|
|
* The API for operations with orders.
|
|
*
|
|
* @package WooCommerce\PayPalCommerce\Api
|
|
*
|
|
* @phpcs:disable Squiz.Commenting.FunctionCommentThrowTag
|
|
*/
|
|
declare (strict_types=1);
|
|
namespace WooCommerce\PayPalCommerce\Api;
|
|
|
|
use Exception;
|
|
use InvalidArgumentException;
|
|
use RuntimeException;
|
|
use WC_Order;
|
|
use WooCommerce\PayPalCommerce\ApiClient\Endpoint\OrderEndpoint;
|
|
use WooCommerce\PayPalCommerce\ApiClient\Entity\Order;
|
|
use WooCommerce\PayPalCommerce\OrderTracking\Endpoint\OrderTrackingEndpoint;
|
|
use WooCommerce\PayPalCommerce\OrderTracking\Shipment\ShipmentFactoryInterface;
|
|
use WooCommerce\PayPalCommerce\PPCP;
|
|
use WooCommerce\PayPalCommerce\WcGateway\Gateway\PayPalGateway;
|
|
use WooCommerce\PayPalCommerce\WcGateway\Helper\RefundFeesUpdater;
|
|
use WooCommerce\PayPalCommerce\WcGateway\Processor\AuthorizedPaymentsProcessor;
|
|
use WooCommerce\PayPalCommerce\WcGateway\Processor\OrderProcessor;
|
|
use WooCommerce\PayPalCommerce\WcGateway\Processor\RefundProcessor;
|
|
/**
|
|
* Returns the PayPal order.
|
|
*
|
|
* @param string|WC_Order $paypal_id_or_wc_order The ID of PayPal order or a WC order (with the ID in meta).
|
|
* @throws InvalidArgumentException When the argument cannot be used for retrieving the order.
|
|
* @throws Exception When the operation fails.
|
|
*/
|
|
function ppcp_get_paypal_order($paypal_id_or_wc_order): Order
|
|
{
|
|
if ($paypal_id_or_wc_order instanceof WC_Order) {
|
|
$paypal_id_or_wc_order = $paypal_id_or_wc_order->get_meta(PayPalGateway::ORDER_ID_META_KEY);
|
|
if (!$paypal_id_or_wc_order) {
|
|
throw new InvalidArgumentException('PayPal order ID not found in meta.');
|
|
}
|
|
}
|
|
if (!is_string($paypal_id_or_wc_order)) {
|
|
throw new InvalidArgumentException('Invalid PayPal order ID, string expected.');
|
|
}
|
|
$order_endpoint = PPCP::container()->get('api.endpoint.order');
|
|
assert($order_endpoint instanceof OrderEndpoint);
|
|
return $order_endpoint->order($paypal_id_or_wc_order);
|
|
}
|
|
/**
|
|
* Creates a PayPal order for the given WC order.
|
|
*
|
|
* @param WC_Order $wc_order The WC order.
|
|
* @throws Exception When the operation fails.
|
|
*/
|
|
function ppcp_create_paypal_order_for_wc_order(WC_Order $wc_order): Order
|
|
{
|
|
$order_processor = PPCP::container()->get('wcgateway.order-processor');
|
|
assert($order_processor instanceof OrderProcessor);
|
|
return $order_processor->create_order($wc_order);
|
|
}
|
|
/**
|
|
* Captures the PayPal order.
|
|
*
|
|
* @param WC_Order $wc_order The WC order.
|
|
* @throws InvalidArgumentException When the order cannot be captured.
|
|
* @throws Exception When the operation fails.
|
|
*/
|
|
function ppcp_capture_order(WC_Order $wc_order): void
|
|
{
|
|
$intent = strtoupper((string) $wc_order->get_meta(PayPalGateway::INTENT_META_KEY));
|
|
if ($intent !== 'AUTHORIZE') {
|
|
throw new InvalidArgumentException('Only orders with "authorize" intent can be captured.');
|
|
}
|
|
$captured = wc_string_to_bool($wc_order->get_meta(AuthorizedPaymentsProcessor::CAPTURED_META_KEY));
|
|
if ($captured) {
|
|
throw new InvalidArgumentException('The order is already captured.');
|
|
}
|
|
$authorized_payment_processor = PPCP::container()->get('wcgateway.processor.authorized-payments');
|
|
assert($authorized_payment_processor instanceof AuthorizedPaymentsProcessor);
|
|
if (!$authorized_payment_processor->capture_authorized_payment($wc_order)) {
|
|
throw new RuntimeException('Capture failed.');
|
|
}
|
|
}
|
|
/**
|
|
* Reauthorizes the PayPal order.
|
|
*
|
|
* @param WC_Order $wc_order The WC order.
|
|
* @throws InvalidArgumentException When the order cannot be captured.
|
|
* @throws Exception When the operation fails.
|
|
*/
|
|
function ppcp_reauthorize_order(WC_Order $wc_order): void
|
|
{
|
|
$intent = strtoupper((string) $wc_order->get_meta(PayPalGateway::INTENT_META_KEY));
|
|
if ($intent !== 'AUTHORIZE') {
|
|
throw new InvalidArgumentException('Only orders with "authorize" intent can be reauthorized.');
|
|
}
|
|
$captured = wc_string_to_bool($wc_order->get_meta(AuthorizedPaymentsProcessor::CAPTURED_META_KEY));
|
|
if ($captured) {
|
|
throw new InvalidArgumentException('The order is already captured.');
|
|
}
|
|
$authorized_payment_processor = PPCP::container()->get('wcgateway.processor.authorized-payments');
|
|
assert($authorized_payment_processor instanceof AuthorizedPaymentsProcessor);
|
|
if ($authorized_payment_processor->reauthorize_payment($wc_order) !== AuthorizedPaymentsProcessor::SUCCESSFUL) {
|
|
throw new RuntimeException($authorized_payment_processor->reauthorization_failure_reason() ?: 'Reauthorization failed.');
|
|
}
|
|
}
|
|
/**
|
|
* Refunds the PayPal order.
|
|
* Note that you can use wc_refund_payment() to trigger the refund in WC and PayPal.
|
|
*
|
|
* @param WC_Order $wc_order The WC order.
|
|
* @param float $amount The refund amount.
|
|
* @param string $reason The reason for the refund.
|
|
* @return string The PayPal refund ID.
|
|
* @throws InvalidArgumentException When the order cannot be refunded.
|
|
* @throws Exception When the operation fails.
|
|
*/
|
|
function ppcp_refund_order(WC_Order $wc_order, float $amount, string $reason = ''): string
|
|
{
|
|
$order = ppcp_get_paypal_order($wc_order);
|
|
$refund_processor = PPCP::container()->get('wcgateway.processor.refunds');
|
|
assert($refund_processor instanceof RefundProcessor);
|
|
return $refund_processor->refund($order, $wc_order, $amount, $reason);
|
|
}
|
|
/**
|
|
* Voids the authorization.
|
|
*
|
|
* @param WC_Order $wc_order The WC order.
|
|
* @throws InvalidArgumentException When the order cannot be voided.
|
|
* @throws Exception When the operation fails.
|
|
*/
|
|
function ppcp_void_order(WC_Order $wc_order): void
|
|
{
|
|
$order = ppcp_get_paypal_order($wc_order);
|
|
$refund_processor = PPCP::container()->get('wcgateway.processor.refunds');
|
|
assert($refund_processor instanceof RefundProcessor);
|
|
$refund_processor->void($order);
|
|
}
|
|
/**
|
|
* Updates the PayPal refund fees totals on an order.
|
|
*
|
|
* @param WC_Order $wc_order The WC order.
|
|
*/
|
|
function ppcp_update_order_refund_fees(WC_Order $wc_order): void
|
|
{
|
|
$updater = PPCP::container()->get('wcgateway.helper.refund-fees-updater');
|
|
assert($updater instanceof RefundFeesUpdater);
|
|
$updater->update($wc_order);
|
|
}
|
|
/**
|
|
* Creates or updates PayPal order tracking information for a WooCommerce order.
|
|
*
|
|
* Retrieves the PayPal capture ID associated with the given WooCommerce order,
|
|
* creates a shipment instance, and sends it to the PayPal Order Tracking API.
|
|
* If tracking information for the given tracking number already exists, it will
|
|
* be updated; otherwise, it will be added as new tracking information.
|
|
*
|
|
* @param WC_Order $wc_order WooCommerce order instance to attach tracking to.
|
|
* @param string $tracking_number Tracking number provided by the carrier.
|
|
* @param string $carrier Name of the shipping carrier (must be PayPal-approved).
|
|
* @param string $status Shipment status (must be PayPal-approved). Defaults to 'SHIPPED'.
|
|
*
|
|
* @see https://developer.paypal.com/docs/tracking/reference/carriers/ List of PayPal-approved carriers.
|
|
* @see https://developer.paypal.com/docs/tracking/reference/shipping-status/ List of PayPal-approved shipment statuses.
|
|
*
|
|
* @return void
|
|
*/
|
|
function ppcp_create_order_tracking(WC_Order $wc_order, string $tracking_number, string $carrier, string $status = 'SHIPPED'): void
|
|
{
|
|
$shipment_factory = PPCP::container()->get('order-tracking.shipment.factory');
|
|
assert($shipment_factory instanceof ShipmentFactoryInterface);
|
|
$endpoint = PPCP::container()->get('order-tracking.endpoint.controller');
|
|
assert($endpoint instanceof OrderTrackingEndpoint);
|
|
$paypal_order = ppcp_get_paypal_order($wc_order);
|
|
$capture_id = $endpoint->get_paypal_order_transaction_id($paypal_order);
|
|
if (is_null($capture_id)) {
|
|
throw new RuntimeException('Could not retrieve transaction ID from PayPal order');
|
|
}
|
|
$wc_order_id = $wc_order->get_id();
|
|
$ppcp_shipment = $shipment_factory->create_shipment($wc_order_id, $capture_id, $tracking_number, $status, 'OTHER', $carrier, array());
|
|
$tracking_information = $endpoint->get_tracking_information($wc_order_id, $tracking_number);
|
|
$tracking_information ? $endpoint->update_tracking_information($ppcp_shipment, $wc_order_id) : $endpoint->add_tracking_information($ppcp_shipment, $wc_order_id);
|
|
}
|