WooCommerce Code Reference

WC_Gateway_Paypal_Request
in package

Generates requests to send to PayPal.

Table of Contents

$endpoint  : string
Endpoint for requests to PayPal.
$gateway  : WC_Gateway_Paypal
Pointer to gateway making the request.
$line_items  : array
Stores line items to send to PayPal.
$notify_url  : string
Endpoint for requests from PayPal.
__construct()  : mixed
Constructor.
get_request_url()  : string
Get the PayPal request URL for an order.
add_line_item()  : mixed
Add PayPal Line Item.
currency_has_decimals()  : bool
Check if currency has decimals.
delete_line_items()  : mixed
Remove all line items.
fix_request_length()  : array
If the default request with line items is too long, generate a new one with only one line item.
get_line_item_args()  : array
Get line item args for paypal request.
get_line_item_args_single_item()  : array
Get line item args for paypal request as a single line item.
get_line_items()  : mixed
Return all line items.
get_order_item_name()  : string
Get order item names as a string.
get_order_item_names()  : string
Get order item names as a string.
get_paypal_args()  : array
Get PayPal Args for passing to PP.
get_paypal_state()  : string
Get the state to send to paypal.
get_phone_number_args()  : array
Get phone number args for paypal request.
get_shipping_args()  : array
Get shipping args for paypal request.
get_shipping_cost_line_item()  : array
Get shipping cost line item args for paypal request.
get_transaction_args()  : array
Get transaction args for paypal request, except for line item args.
limit_length()  : string
Limit length of an arg.
line_items_valid()  : bool
Check if the order has valid line items to use for PayPal request.
number_format()  : string
Format prices.
prepare_line_items()  : mixed
Get line items to send to paypal.
round()  : float
Round prices.

Properties

Methods

add_line_item()

Add PayPal Line Item.

protected add_line_item(string $item_name[, int $quantity = 1 ][, float $amount = 0.0 ][, string $item_number = '' ]) : mixed
Parameters
$item_name : string

Item name.

$quantity : int = 1

Item quantity.

$amount : float = 0.0

Amount.

$item_number : string = ''

Item number.

Return values
mixed

fix_request_length()

If the default request with line items is too long, generate a new one with only one line item.

protected fix_request_length(WC_Order $order, array $paypal_args) : array

If URL is longer than 2,083 chars, ignore line items and send cart to Paypal as a single item. One item's name can only be 127 characters long, so the URL should not be longer than limit. URL character limit via: https://support.microsoft.com/en-us/help/208427/maximum-url-length-is-2-083-characters-in-internet-explorer.

Parameters
$order : WC_Order

Order to be sent to Paypal.

$paypal_args : array

Arguments sent to Paypal in the request.

Return values
array