Edit File by line

<?php

[0] Fix | Delete

// phpcs:ignoreFile WPForms.PHP.BackSlash.RemoveBackslash

[1] Fix | Delete

namespace WPForms\Integrations\Stripe\Api;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Vendor\Stripe\Customer;

[4] Fix | Delete

use WPForms\Vendor\Stripe\Plan;

[5] Fix | Delete

use WPForms\Vendor\Stripe\Stripe;

[6] Fix | Delete

use WPForms\Vendor\Stripe\Subscription;

[7] Fix | Delete

use WPForms\Integrations\Stripe\Helpers;

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Common methods for every Stripe API implementation.

[11] Fix | Delete

[12] Fix | Delete

* @since 1.8.2

[13] Fix | Delete

[14] Fix | Delete

abstract class Common {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* API configuration.

[18] Fix | Delete

[19] Fix | Delete

* @since 1.8.2

[20] Fix | Delete

[21] Fix | Delete

* @var array

[22] Fix | Delete

[23] Fix | Delete

protected $config;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Stripe customer object.

[27] Fix | Delete

[28] Fix | Delete

* @since 1.8.2

[29] Fix | Delete

[30] Fix | Delete

* @var Customer

[31] Fix | Delete

[32] Fix | Delete

protected $customer;

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Stripe subscription object.

[36] Fix | Delete

[37] Fix | Delete

* @since 1.8.2

[38] Fix | Delete

[39] Fix | Delete

* @var Subscription

[40] Fix | Delete

[41] Fix | Delete

protected $subscription;

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* API error message.

[45] Fix | Delete

[46] Fix | Delete

* @since 1.8.2

[47] Fix | Delete

[48] Fix | Delete

* @var string

[49] Fix | Delete

[50] Fix | Delete

protected $error;

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

* API exception.

[54] Fix | Delete

[55] Fix | Delete

* @since 1.8.2

[56] Fix | Delete

[57] Fix | Delete

* @var \Exception

[58] Fix | Delete

[59] Fix | Delete

protected $exception;

[60] Fix | Delete

[61] Fix | Delete

/**

[62] Fix | Delete

* Get class variable value or its key.

[63] Fix | Delete

[64] Fix | Delete

* @since 1.8.2

[65] Fix | Delete

[66] Fix | Delete

* @param string $field Name of the variable to retrieve.

[67] Fix | Delete

* @param string $key Name of the key to retrieve.

[68] Fix | Delete

[69] Fix | Delete

* @return mixed

[70] Fix | Delete

[71] Fix | Delete

protected function get_var( $field, $key = '' ) {

[72] Fix | Delete

[73] Fix | Delete

$var = isset( $this->{$field} ) ? $this->{$field} : null;

[74] Fix | Delete

[75] Fix | Delete

if ( ! $key ) {

[76] Fix | Delete

return $var;

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

if ( is_object( $var ) ) {

[80] Fix | Delete

return isset( $var->{$key} ) ? $var->{$key} : null;

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

if ( is_array( $var ) ) {

[84] Fix | Delete

return isset( $var[ $key ] ) ? $var[ $key ] : null;

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

return $var;

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* Get API configuration array or its key.

[92] Fix | Delete

[93] Fix | Delete

* @since 1.8.2

[94] Fix | Delete

[95] Fix | Delete

* @param string $key Name of the key to retrieve.

[96] Fix | Delete

[97] Fix | Delete

* @return mixed

[98] Fix | Delete

[99] Fix | Delete

public function get_config( $key = '' ) {

[100] Fix | Delete

[101] Fix | Delete

return $this->get_var( 'config', $key );

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

/**

[105] Fix | Delete

* Get saved Stripe customer object or its key.

[106] Fix | Delete

[107] Fix | Delete

* @since 1.8.2

[108] Fix | Delete

[109] Fix | Delete

* @param string $key Name of the key to retrieve.

[110] Fix | Delete

[111] Fix | Delete

* @return mixed

[112] Fix | Delete

[113] Fix | Delete

public function get_customer( $key = '' ) {

[114] Fix | Delete

[115] Fix | Delete

return $this->get_var( 'customer', $key );

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

/**

[119] Fix | Delete

* Get saved Stripe subscription object or its key.

[120] Fix | Delete

[121] Fix | Delete

* @since 1.8.2

[122] Fix | Delete

[123] Fix | Delete

* @param string $key Name of the key to retrieve.

[124] Fix | Delete

[125] Fix | Delete

* @return mixed

[126] Fix | Delete

[127] Fix | Delete

public function get_subscription( $key = '' ) {

[128] Fix | Delete

[129] Fix | Delete

return $this->get_var( 'subscription', $key );

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

/**

[133] Fix | Delete

* Get API error message.

[134] Fix | Delete

[135] Fix | Delete

* @since 1.8.2

[136] Fix | Delete

[137] Fix | Delete

* @return string

[138] Fix | Delete

[139] Fix | Delete

public function get_error() {

[140] Fix | Delete

[141] Fix | Delete

return $this->get_var( 'error' );

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

/**

[145] Fix | Delete

* Get API exception.

[146] Fix | Delete

[147] Fix | Delete

* @since 1.8.2

[148] Fix | Delete

[149] Fix | Delete

* @return \Exception

[150] Fix | Delete

[151] Fix | Delete

public function get_exception() {

[152] Fix | Delete

[153] Fix | Delete

return $this->get_var( 'exception' );

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

/**

[157] Fix | Delete

* Initial Stripe app configuration.

[158] Fix | Delete

[159] Fix | Delete

* @since 1.8.2

[160] Fix | Delete

[161] Fix | Delete

public function setup_stripe() {

[162] Fix | Delete

[163] Fix | Delete

Stripe::setAppInfo(

[164] Fix | Delete

'WPForms acct_17Xt6qIdtRxnENqV',

[165] Fix | Delete

WPFORMS_VERSION,

[166] Fix | Delete

'https://wpforms.com/addons/stripe-addon/',

[167] Fix | Delete

'pp_partner_Dw7IkUZbIlCrtq'

[168] Fix | Delete

);

[169] Fix | Delete

}

[170] Fix | Delete

[171] Fix | Delete

/**

[172] Fix | Delete

* Set a customer object.

[173] Fix | Delete

* Check if a customer exists in Stripe, if not creates one.

[174] Fix | Delete

[175] Fix | Delete

* @since 1.8.2

[176] Fix | Delete

* @since 1.8.6 Added customer name argument and allow empty email.

[177] Fix | Delete

* @since 1.8.8 Added customer billing address argument.

[178] Fix | Delete

[179] Fix | Delete

* @param string $email Email to fetch an existing customer.

[180] Fix | Delete

* @param string $name Customer name.

[181] Fix | Delete

* @param array $address Customer billing address.

[182] Fix | Delete

[183] Fix | Delete

protected function set_customer( string $email = '', string $name = '', array $address = [] ) {

[184] Fix | Delete

[185] Fix | Delete

if ( ! $email && ! $name ) {

[186] Fix | Delete

return;

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

$args = [];

[190] Fix | Delete

[191] Fix | Delete

if ( $name ) {

[192] Fix | Delete

$args['name'] = $name;

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

if ( $address ) {

[196] Fix | Delete

$args['address'] = $address;

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

// Create a customer with name only if email is empty.

[200] Fix | Delete

if ( ! $email ) {

[201] Fix | Delete

[202] Fix | Delete

try {

[203] Fix | Delete

$customer = Customer::create( $args, Helpers::get_auth_opts() );

[204] Fix | Delete

} catch ( \Exception $e ) {

[205] Fix | Delete

$customer = null;

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

if ( ! isset( $customer->id ) ) {

[209] Fix | Delete

return;

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete

$this->customer = $customer;

[213] Fix | Delete

return;

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

try {

[217] Fix | Delete

$customers = Customer::all(

[218] Fix | Delete

[ 'email' => $email ],

[219] Fix | Delete

Helpers::get_auth_opts()

[220] Fix | Delete

);

[221] Fix | Delete

} catch ( \Exception $e ) {

[222] Fix | Delete

$customers = null;

[223] Fix | Delete

}

[224] Fix | Delete

[225] Fix | Delete

if ( isset( $customers->data[0]->id ) ) {

[226] Fix | Delete

$this->customer = $customers->data[0];

[227] Fix | Delete

[228] Fix | Delete

if ( ! empty( $name ) && $name !== $this->customer->name ) {

[229] Fix | Delete

try {

[230] Fix | Delete

$this->customer = Customer::update(

[231] Fix | Delete

$this->customer->id,

[232] Fix | Delete

$args,

[233] Fix | Delete

Helpers::get_auth_opts()

[234] Fix | Delete

);

[235] Fix | Delete

} catch ( \Exception $e ) {

[236] Fix | Delete

wpforms_log(

[237] Fix | Delete

'Stripe: Unable to update user name.',

[238] Fix | Delete

$e->getMessage(),

[239] Fix | Delete

[

[240] Fix | Delete

'type' => [ 'payment', 'error' ],

[241] Fix | Delete

]

[242] Fix | Delete

);

[243] Fix | Delete

}

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

return;

[247] Fix | Delete

}

[248] Fix | Delete

[249] Fix | Delete

try {

[250] Fix | Delete

$args['email'] = $email;

[251] Fix | Delete

[252] Fix | Delete

$customer = Customer::create( $args, Helpers::get_auth_opts() );

[253] Fix | Delete

} catch ( \Exception $e ) {

[254] Fix | Delete

$customer = null;

[255] Fix | Delete

}

[256] Fix | Delete

[257] Fix | Delete

if ( ! isset( $customer->id ) ) {

[258] Fix | Delete

return;

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

$this->customer = $customer;

[262] Fix | Delete

}

[263] Fix | Delete

[264] Fix | Delete

/**

[265] Fix | Delete

* Set an error message from a Stripe API exception.

[266] Fix | Delete

[267] Fix | Delete

* @since 1.8.2

[268] Fix | Delete

[269] Fix | Delete

* @param \Exception|\WPForms\Vendor\Stripe\Exception\ApiErrorException $e Stripe API exception to process.

[270] Fix | Delete

[271] Fix | Delete

protected function set_error_from_exception( $e ) {

[272] Fix | Delete

[273] Fix | Delete

/**

[274] Fix | Delete

* WPForms set Stripe error from exception.

[275] Fix | Delete

[276] Fix | Delete

* @since 1.8.2

[277] Fix | Delete

[278] Fix | Delete

* @param \Exception|\WPForms\Vendor\Stripe\Exception\ApiErrorException $e Stripe API exception to process.

[279] Fix | Delete

[280] Fix | Delete

do_action( 'wpformsstripe_api_common_set_error_from_exception', $e ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[281] Fix | Delete

[282] Fix | Delete

if ( is_a( $e, '\WPForms\Vendor\Stripe\Exception\CardException' ) ) {

[283] Fix | Delete

$body = $e->getJsonBody();

[284] Fix | Delete

$this->error = $body['error']['message'];

[285] Fix | Delete

[286] Fix | Delete

return;

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

$errors = [

[290] Fix | Delete

'\WPForms\Vendor\Stripe\Exception\RateLimitException' => esc_html__( 'Too many requests made to the API too quickly.', 'wpforms-lite' ),

[291] Fix | Delete

'\WPForms\Vendor\Stripe\Exception\InvalidRequestException' => esc_html__( 'Invalid parameters were supplied to Stripe API.', 'wpforms-lite' ),

[292] Fix | Delete

'\WPForms\Vendor\Stripe\Exception\AuthenticationException' => esc_html__( 'Authentication with Stripe API failed.', 'wpforms-lite' ),

[293] Fix | Delete

'\WPForms\Vendor\Stripe\Exception\ApiConnectionException' => esc_html__( 'Network communication with Stripe failed.', 'wpforms-lite' ),

[294] Fix | Delete

'\WPForms\Vendor\Stripe\Exception\ApiErrorException' => esc_html__( 'Unable to process Stripe payment.', 'wpforms-lite' ),

[295] Fix | Delete

'\Exception' => esc_html__( 'Unable to process payment.', 'wpforms-lite' ),

[296] Fix | Delete

];

[297] Fix | Delete

[298] Fix | Delete

foreach ( $errors as $error_type => $error_message ) {

[299] Fix | Delete

[300] Fix | Delete

if ( is_a( $e, $error_type ) ) {

[301] Fix | Delete

$this->error = $error_message;

[302] Fix | Delete

[303] Fix | Delete

return;

[304] Fix | Delete

}

[305] Fix | Delete

}

[306] Fix | Delete

}

[307] Fix | Delete

[308] Fix | Delete

/**

[309] Fix | Delete

* Set an exception from a Stripe API exception.

[310] Fix | Delete

[311] Fix | Delete

* @since 1.8.2

[312] Fix | Delete

[313] Fix | Delete

* @param \Exception $e Stripe API exception to process.

[314] Fix | Delete

[315] Fix | Delete

protected function set_exception( $e ) {

[316] Fix | Delete

[317] Fix | Delete

$this->exception = $e;

[318] Fix | Delete

}

[319] Fix | Delete

[320] Fix | Delete

/**

[321] Fix | Delete

* Handle Stripe API exception.

[322] Fix | Delete

[323] Fix | Delete

* @since 1.8.2

[324] Fix | Delete

[325] Fix | Delete

* @param \Exception $e Stripe API exception to process.

[326] Fix | Delete

[327] Fix | Delete

protected function handle_exception( $e ) {

[328] Fix | Delete

[329] Fix | Delete

$this->set_exception( $e );

[330] Fix | Delete

$this->set_error_from_exception( $e );

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

/**

[334] Fix | Delete

* Get data for every subscription period.

[335] Fix | Delete

[336] Fix | Delete

* @since 1.8.2

[337] Fix | Delete

[338] Fix | Delete

* @return array

[339] Fix | Delete

[340] Fix | Delete

protected function get_subscription_period_data() {

[341] Fix | Delete

[342] Fix | Delete

return [

[343] Fix | Delete

'daily' => [

[344] Fix | Delete

'name' => 'daily',

[345] Fix | Delete

'interval' => 'day',

[346] Fix | Delete

'count' => 1,

[347] Fix | Delete

'desc' => esc_html__( 'Daily', 'wpforms-lite' ),

[348] Fix | Delete

[349] Fix | Delete

'weekly' => [

[350] Fix | Delete

'name' => 'weekly',

[351] Fix | Delete

'interval' => 'week',

[352] Fix | Delete

'count' => 1,

[353] Fix | Delete

'desc' => esc_html__( 'Weekly', 'wpforms-lite' ),

[354] Fix | Delete

[355] Fix | Delete

'monthly' => [

[356] Fix | Delete

'name' => 'monthly',

[357] Fix | Delete

'interval' => 'month',

[358] Fix | Delete

'count' => 1,

[359] Fix | Delete

'desc' => esc_html__( 'Monthly', 'wpforms-lite' ),

[360] Fix | Delete

[361] Fix | Delete

'quarterly' => [

[362] Fix | Delete

'name' => 'quarterly',

[363] Fix | Delete

'interval' => 'month',

[364] Fix | Delete

'count' => 3,

[365] Fix | Delete

'desc' => esc_html__( 'Quarterly', 'wpforms-lite' ),

[366] Fix | Delete

[367] Fix | Delete

'semiyearly' => [

[368] Fix | Delete

'name' => 'semiyearly',

[369] Fix | Delete

'interval' => 'month',

[370] Fix | Delete

'count' => 6,

[371] Fix | Delete

'desc' => esc_html__( 'Semi-Yearly', 'wpforms-lite' ),

[372] Fix | Delete

[373] Fix | Delete

'yearly' => [

[374] Fix | Delete

'name' => 'yearly',

[375] Fix | Delete

'interval' => 'year',

[376] Fix | Delete

'count' => 1,

[377] Fix | Delete

'desc' => esc_html__( 'Yearly', 'wpforms-lite' ),

[378] Fix | Delete

[379] Fix | Delete

];

[380] Fix | Delete

}

[381] Fix | Delete

[382] Fix | Delete

/**

[383] Fix | Delete

* Create Stripe plan.

[384] Fix | Delete

[385] Fix | Delete

* @since 1.8.2

[386] Fix | Delete

[387] Fix | Delete

* @param string $id ID of a plan to create.

[388] Fix | Delete

* @param array $period Subscription period data.

[389] Fix | Delete

* @param array $args Additional arguments.

[390] Fix | Delete

[391] Fix | Delete

* @return Plan|null

[392] Fix | Delete

[393] Fix | Delete

protected function create_plan( $id, $period, $args ) {

[394] Fix | Delete

[395] Fix | Delete

$name = sprintf(

[396] Fix | Delete

'%s (%s %s)',

[397] Fix | Delete

! empty( $args['settings']['name'] ) ? $args['settings']['name'] : $args['form_title'],

[398] Fix | Delete

$args['amount'],

[399] Fix | Delete

$period['desc']

[400] Fix | Delete

);

[401] Fix | Delete

[402] Fix | Delete

/**

[403] Fix | Delete

* Allow to filter Stripe subscription plan name.

[404] Fix | Delete

[405] Fix | Delete

* @since 1.8.8

[406] Fix | Delete

[407] Fix | Delete

* @param string $name Plan name.

[408] Fix | Delete

* @param array $period Subscription period data.

[409] Fix | Delete

* @param array $args Additional arguments.

[410] Fix | Delete

[411] Fix | Delete

$name = (string) apply_filters( 'wpforms_integrations_stripe_api_common_create_plan_name', $name, $period, $args );

[412] Fix | Delete

[413] Fix | Delete

$plan_args = [

[414] Fix | Delete

'amount' => $args['amount'],

[415] Fix | Delete

'interval' => $period['interval'],

[416] Fix | Delete

'interval_count' => $period['count'],

[417] Fix | Delete

'product' => [

[418] Fix | Delete

'name' => sanitize_text_field( $name ),

[419] Fix | Delete

[420] Fix | Delete

'nickname' => sanitize_text_field( $name ),

[421] Fix | Delete

'currency' => strtolower( wpforms_get_currency() ),

[422] Fix | Delete

'id' => $id,

[423] Fix | Delete

'metadata' => [

[424] Fix | Delete

'form_name' => sanitize_text_field( $args['form_title'] ),

[425] Fix | Delete

'form_id' => $args['form_id'],

[426] Fix | Delete

[427] Fix | Delete

];

[428] Fix | Delete

[429] Fix | Delete

try {

[430] Fix | Delete

$plan = Plan::create( $plan_args, Helpers::get_auth_opts() );

[431] Fix | Delete

} catch ( \Exception $e ) {

[432] Fix | Delete

$plan = null;

[433] Fix | Delete

}

[434] Fix | Delete

[435] Fix | Delete

return $plan;

[436] Fix | Delete

}

[437] Fix | Delete

[438] Fix | Delete

/**

[439] Fix | Delete

* Get Stripe plan ID.

[440] Fix | Delete

* Check if a plan exists in Stripe, if not creates one.

[441] Fix | Delete

[442] Fix | Delete

* @since 1.8.2

[443] Fix | Delete

[444] Fix | Delete

* @param array $args Arguments needed for getting a valid plan ID.

[445] Fix | Delete

[446] Fix | Delete

* @return string

[447] Fix | Delete

[448] Fix | Delete

protected function get_plan_id( $args ) {

[449] Fix | Delete

[450] Fix | Delete

$period_data = $this->get_subscription_period_data();

[451] Fix | Delete

[452] Fix | Delete

$period = array_key_exists( $args['settings']['period'], $period_data ) ? $period_data[ $args['settings']['period'] ] : $period_data['yearly'];

[453] Fix | Delete

[454] Fix | Delete

if ( ! empty( $args['settings']['name'] ) ) {

[455] Fix | Delete

$slug = preg_replace( '/[^a-z0-9\-]/', '', strtolower( str_replace( ' ', '-', $args['settings']['name'] ) ) );

[456] Fix | Delete

} else {

[457] Fix | Delete

$slug = 'form' . $args['form_id'];

[458] Fix | Delete

}

[459] Fix | Delete

[460] Fix | Delete

$plan_id = sprintf(

[461] Fix | Delete

'%s_%s_%s',

[462] Fix | Delete

$slug,

[463] Fix | Delete

$args['amount'],

[464] Fix | Delete

$period['name']

[465] Fix | Delete

);

[466] Fix | Delete

[467] Fix | Delete

try {

[468] Fix | Delete

$plan = Plan::retrieve( $plan_id, Helpers::get_auth_opts() );

[469] Fix | Delete

} catch ( \Exception $e ) {

[470] Fix | Delete

$plan = $this->create_plan( $plan_id, $period, $args );

[471] Fix | Delete

}

[472] Fix | Delete

[473] Fix | Delete

return isset( $plan->id ) ? $plan->id : '';

[474] Fix | Delete

}

[475] Fix | Delete

}

[476] Fix | Delete

[477] Fix | Delete