PHP Class WC_Gateway_Paypal_IPN_Handler

Inheritance: extends WC_Gateway_Paypal_Response

Show file Open project: woocommerce/woocommerce

Protected Properties

Property	Type	Description
$receiver_email		Receiver email address to validate

Public Methods

Method	Description
__construct ( boolean $sandbox = false, string $receiver_email = '' )	Constructor.
check_response ( )	Check for PayPal IPN Response.
valid_response ( array $posted )	There was a valid response.
validate_ipn ( )	Check PayPal IPN validity.

Protected Methods

Method	Description
payment_status_canceled_reversal ( WC_Order $order, array $posted )	Handle a cancelled reveral.
payment_status_completed ( WC_Order $order, array $posted )	Handle a completed payment.
payment_status_denied ( WC_Order $order, array $posted )	Handle a denied payment.
payment_status_expired ( WC_Order $order, array $posted )	Handle an expired payment.
payment_status_failed ( WC_Order $order, array $posted )	Handle a failed payment.
payment_status_pending ( WC_Order $order, array $posted )	Handle a pending payment.
payment_status_refunded ( WC_Order $order, array $posted )	Handle a refunded order.
payment_status_reversed ( WC_Order $order, array $posted )	Handle a reveral.
payment_status_voided ( WC_Order $order, array $posted )	Handle a voided payment.
save_paypal_meta_data ( WC_Order $order, array $posted )	Save important data from the IPN to the order.
send_ipn_email_notification ( string $subject, string $message )	Send a notification to the user handling orders.
validate_amount ( WC_Order $order, integer $amount )	Check payment amount from IPN matches the order.
validate_currency ( WC_Order $order, string $currency )	Check currency from IPN matches the order.
validate_receiver_email ( WC_Order $order, string $receiver_email )	Check receiver email from PayPal. If the receiver email in the IPN is different than what is stored in.
validate_transaction_type ( string $txn_type )	Check for a valid transaction type.

Method Details

__construct() public method

Constructor.

public __construct ( boolean $sandbox = false, string $receiver_email = '' )
$sandbox	boolean
$receiver_email	string

check_response() public method

Check for PayPal IPN Response.

public check_response ( )

payment_status_canceled_reversal() protected method

Handle a cancelled reveral.

protected payment_status_canceled_reversal ( WC_Order $order, array $posted )
$order	WC_Order
$posted	array

payment_status_completed() protected method

Handle a completed payment.

protected payment_status_completed ( WC_Order $order, array $posted )
$order	WC_Order
$posted	array

payment_status_denied() protected method

Handle a denied payment.

protected payment_status_denied ( WC_Order $order, array $posted )
$order	WC_Order
$posted	array

payment_status_expired() protected method

Handle an expired payment.

protected payment_status_expired ( WC_Order $order, array $posted )
$order	WC_Order
$posted	array

payment_status_failed() protected method

Handle a failed payment.

protected payment_status_failed ( WC_Order $order, array $posted )
$order	WC_Order
$posted	array

payment_status_pending() protected method

Handle a pending payment.

protected payment_status_pending ( WC_Order $order, array $posted )
$order	WC_Order
$posted	array

payment_status_refunded() protected method

Handle a refunded order.

protected payment_status_refunded ( WC_Order $order, array $posted )
$order	WC_Order
$posted	array

payment_status_reversed() protected method

Handle a reveral.

protected payment_status_reversed ( WC_Order $order, array $posted )
$order	WC_Order
$posted	array

payment_status_voided() protected method

Handle a voided payment.

protected payment_status_voided ( WC_Order $order, array $posted )
$order	WC_Order
$posted	array

save_paypal_meta_data() protected method

Save important data from the IPN to the order.

protected save_paypal_meta_data ( WC_Order $order, array $posted )
$order	WC_Order
$posted	array

send_ipn_email_notification() protected method

Send a notification to the user handling orders.

protected send_ipn_email_notification ( string $subject, string $message )
$subject	string
$message	string

valid_response() public method

There was a valid response.

public valid_response ( array $posted )
$posted	array	Post data after wp_unslash

validate_amount() protected method

Check payment amount from IPN matches the order.

protected validate_amount ( WC_Order $order, integer $amount )
$order	WC_Order
$amount	integer

validate_currency() protected method

Check currency from IPN matches the order.

protected validate_currency ( WC_Order $order, string $currency )
$order	WC_Order
$currency	string

validate_ipn() public method

Check PayPal IPN validity.

public validate_ipn ( )

validate_receiver_email() protected method

WooCommerce -> Settings -> Checkout -> PayPal, it will log an error about it.

protected validate_receiver_email ( WC_Order $order, string $receiver_email )
$order	WC_Order
$receiver_email	string

validate_transaction_type() protected method

Check for a valid transaction type.

protected validate_transaction_type ( string $txn_type )
$txn_type	string

Property Details

$receiver_email protected property

Receiver email address to validate

protected $receiver_email