<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Integrations\Square;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Vendor\Square\Environment;

[4] Fix | Delete

use WPForms\Vendor\Square\Models\SubscriptionCadence;

[5] Fix | Delete

use WPForms\Helpers\Transient;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Square related helper methods.

[9] Fix | Delete

*

[10] Fix | Delete

* @since 1.9.5

[11] Fix | Delete

*/

[12] Fix | Delete

class Helpers {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Determine whether the addon is activated and appropriate license is set.

[16] Fix | Delete

*

[17] Fix | Delete

* @since 1.9.5

[18] Fix | Delete

*

[19] Fix | Delete

* @return bool

[20] Fix | Delete

*/

[21] Fix | Delete

public static function is_pro(): bool {

[22] Fix | Delete

[23] Fix | Delete

return self::is_addon_active() && self::is_allowed_license_type();

[24] Fix | Delete

}

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Determine whether the addon is activated.

[28] Fix | Delete

*

[29] Fix | Delete

* @since 1.9.5

[30] Fix | Delete

*

[31] Fix | Delete

* @return bool

[32] Fix | Delete

*/

[33] Fix | Delete

public static function is_addon_active(): bool {

[34] Fix | Delete

[35] Fix | Delete

return wpforms_is_addon_initialized( 'square' );

[36] Fix | Delete

}

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Determine whether a license is ok.

[40] Fix | Delete

*

[41] Fix | Delete

* @since 1.9.5

[42] Fix | Delete

*

[43] Fix | Delete

* @return bool

[44] Fix | Delete

*/

[45] Fix | Delete

public static function is_license_ok(): bool {

[46] Fix | Delete

[47] Fix | Delete

return self::is_license_active() && self::is_allowed_license_type();

[48] Fix | Delete

}

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* Determine whether a license type is allowed.

[52] Fix | Delete

*

[53] Fix | Delete

* @since 1.9.5

[54] Fix | Delete

*

[55] Fix | Delete

* @return bool

[56] Fix | Delete

*/

[57] Fix | Delete

public static function is_allowed_license_type(): bool {

[58] Fix | Delete

[59] Fix | Delete

return in_array( wpforms_get_license_type(), [ 'pro', 'elite', 'agency', 'ultimate' ], true );

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Determine whether a license key is active.

[64] Fix | Delete

*

[65] Fix | Delete

* @since 1.9.5

[66] Fix | Delete

*

[67] Fix | Delete

* @return bool

[68] Fix | Delete

*/

[69] Fix | Delete

public static function is_license_active(): bool {

[70] Fix | Delete

[71] Fix | Delete

$license = (array) get_option( 'wpforms_license', [] );

[72] Fix | Delete

[73] Fix | Delete

return ! empty( wpforms_get_license_key() ) &&

[74] Fix | Delete

empty( $license['is_expired'] ) &&

[75] Fix | Delete

empty( $license['is_disabled'] ) &&

[76] Fix | Delete

empty( $license['is_invalid'] );

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

/**

[80] Fix | Delete

* Determine if Square single payment is enabled for the form.

[81] Fix | Delete

*

[82] Fix | Delete

* @since 1.9.5

[83] Fix | Delete

*

[84] Fix | Delete

* @param array $form_data Form data and settings.

[85] Fix | Delete

*

[86] Fix | Delete

* @return bool

[87] Fix | Delete

*/

[88] Fix | Delete

private static function is_square_single_enabled( array $form_data ): bool {

[89] Fix | Delete

[90] Fix | Delete

return ! empty( $form_data['payments']['square']['enable'] ) || ! empty( $form_data['payments']['square']['enable_one_time'] );

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Determine if Square recurring payment is enabled for the form.

[95] Fix | Delete

*

[96] Fix | Delete

* @since 1.9.5

[97] Fix | Delete

*

[98] Fix | Delete

* @param array $form_data Form data and settings.

[99] Fix | Delete

*

[100] Fix | Delete

* @return bool

[101] Fix | Delete

*/

[102] Fix | Delete

public static function is_square_recurring_enabled( array $form_data ): bool {

[103] Fix | Delete

[104] Fix | Delete

return ! empty( $form_data['payments']['square']['enable_recurring'] );

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

/**

[108] Fix | Delete

* Determine if Square payment enabled for the form.

[109] Fix | Delete

*

[110] Fix | Delete

* @since 1.9.5

[111] Fix | Delete

*

[112] Fix | Delete

* @param array $form_data Form data.

[113] Fix | Delete

*

[114] Fix | Delete

* @return bool

[115] Fix | Delete

*/

[116] Fix | Delete

public static function is_payments_enabled( array $form_data ): bool {

[117] Fix | Delete

[118] Fix | Delete

return self::is_square_single_enabled( $form_data ) || self::is_square_recurring_enabled( $form_data );

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

/**

[122] Fix | Delete

* Determine if Square is in use on the page.

[123] Fix | Delete

*

[124] Fix | Delete

* @since 1.9.5

[125] Fix | Delete

*

[126] Fix | Delete

* @param array $forms Forms data (e.g. forms on a current page).

[127] Fix | Delete

*

[128] Fix | Delete

* @return bool

[129] Fix | Delete

*/

[130] Fix | Delete

public static function has_square_enabled( array $forms ): bool {

[131] Fix | Delete

[132] Fix | Delete

foreach ( $forms as $form_data ) {

[133] Fix | Delete

if ( self::is_payments_enabled( $form_data ) ) {

[134] Fix | Delete

return true;

[135] Fix | Delete

}

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

return false;

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

/**

[142] Fix | Delete

* Determine if Square field is in the form.

[143] Fix | Delete

*

[144] Fix | Delete

* @since 1.9.5

[145] Fix | Delete

*

[146] Fix | Delete

* @param array $forms Form data (e.g. forms on a current page).

[147] Fix | Delete

* @param bool $multiple Must be 'true' if $forms contain multiple forms.

[148] Fix | Delete

*

[149] Fix | Delete

* @return bool

[150] Fix | Delete

*/

[151] Fix | Delete

public static function has_square_field( array $forms, bool $multiple = false ): bool {

[152] Fix | Delete

[153] Fix | Delete

return wpforms_has_field_type( 'square', $forms, $multiple );

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

/**

[157] Fix | Delete

* Determine whether Square is in sandbox mode.

[158] Fix | Delete

*

[159] Fix | Delete

* @since 1.9.5

[160] Fix | Delete

*

[161] Fix | Delete

* @return bool

[162] Fix | Delete

*/

[163] Fix | Delete

public static function is_sandbox_mode(): bool {

[164] Fix | Delete

[165] Fix | Delete

return self::get_mode() === Environment::SANDBOX;

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

/**

[169] Fix | Delete

* Determine whether Square is in production mode.

[170] Fix | Delete

*

[171] Fix | Delete

* @since 1.9.5

[172] Fix | Delete

*

[173] Fix | Delete

* @return bool

[174] Fix | Delete

*/

[175] Fix | Delete

public static function is_production_mode(): bool {

[176] Fix | Delete

[177] Fix | Delete

return self::get_mode() === Environment::PRODUCTION;

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

/**

[181] Fix | Delete

* Retrieve Square mode from WPForms settings.

[182] Fix | Delete

*

[183] Fix | Delete

* @since 1.9.5

[184] Fix | Delete

*

[185] Fix | Delete

* @return string

[186] Fix | Delete

*/

[187] Fix | Delete

public static function get_mode(): string {

[188] Fix | Delete

[189] Fix | Delete

return wpforms_setting( 'square-sandbox-mode' ) ? Environment::SANDBOX : Environment::PRODUCTION;

[190] Fix | Delete

}

[191] Fix | Delete

[192] Fix | Delete

/**

[193] Fix | Delete

* Set/update Square mode from WPForms settings.

[194] Fix | Delete

*

[195] Fix | Delete

* @since 1.9.5

[196] Fix | Delete

*

[197] Fix | Delete

* @param string $mode Square mode that will be set.

[198] Fix | Delete

*

[199] Fix | Delete

* @return bool

[200] Fix | Delete

*/

[201] Fix | Delete

public static function set_mode( string $mode ): bool {

[202] Fix | Delete

[203] Fix | Delete

$key = 'square-sandbox-mode';

[204] Fix | Delete

$settings = (array) get_option( 'wpforms_settings', [] );

[205] Fix | Delete

$settings[ $key ] = $mode === Environment::SANDBOX;

[206] Fix | Delete

[207] Fix | Delete

return update_option( 'wpforms_settings', $settings );

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

/**

[211] Fix | Delete

* Retrieve Square Business Location ID from WPForms settings.

[212] Fix | Delete

*

[213] Fix | Delete

* @since 1.9.5

[214] Fix | Delete

*

[215] Fix | Delete

* @param string $mode Square mode.

[216] Fix | Delete

*

[217] Fix | Delete

* @return string

[218] Fix | Delete

*/

[219] Fix | Delete

public static function get_location_id( string $mode = '' ): string {

[220] Fix | Delete

[221] Fix | Delete

$mode = self::validate_mode( $mode );

[222] Fix | Delete

[223] Fix | Delete

return wpforms_setting( 'square-location-id-' . $mode, '' );

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

/**

[227] Fix | Delete

* Set/update Square Business Location ID from WPForms settings.

[228] Fix | Delete

*

[229] Fix | Delete

* @since 1.9.5

[230] Fix | Delete

*

[231] Fix | Delete

* @param string $id The location ID.

[232] Fix | Delete

* @param string $mode Square mode.

[233] Fix | Delete

*

[234] Fix | Delete

* @return bool

[235] Fix | Delete

*/

[236] Fix | Delete

public static function set_locataion_id( string $id, string $mode ): bool {

[237] Fix | Delete

[238] Fix | Delete

$mode = self::validate_mode( $mode );

[239] Fix | Delete

$key = 'square-location-id-' . $mode;

[240] Fix | Delete

$settings = (array) get_option( 'wpforms_settings', [] );

[241] Fix | Delete

$settings[ $key ] = $id;

[242] Fix | Delete

[243] Fix | Delete

return update_option( 'wpforms_settings', $settings );

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

/**

[247] Fix | Delete

* Delete transients by mode.

[248] Fix | Delete

*

[249] Fix | Delete

* @since 1.9.5

[250] Fix | Delete

*

[251] Fix | Delete

* @param string $mode Square mode.

[252] Fix | Delete

*/

[253] Fix | Delete

public static function detete_transients( string $mode ) {

[254] Fix | Delete

[255] Fix | Delete

Transient::delete( 'wpforms_square_account_' . $mode );

[256] Fix | Delete

Transient::delete( 'wpforms_square_active_locations_' . $mode );

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete

/**

[260] Fix | Delete

* Retrieve Square available modes.

[261] Fix | Delete

*

[262] Fix | Delete

* @since 1.9.5

[263] Fix | Delete

*

[264] Fix | Delete

* @return array

[265] Fix | Delete

*/

[266] Fix | Delete

public static function get_available_modes(): array {

[267] Fix | Delete

[268] Fix | Delete

return [ Environment::SANDBOX, Environment::PRODUCTION ];

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete

/**

[272] Fix | Delete

* Validate Square mode to ensure it's either 'production' or 'sandbox'.

[273] Fix | Delete

* If given mode is invalid, fetches current Square mode.

[274] Fix | Delete

*

[275] Fix | Delete

* @since 1.9.5

[276] Fix | Delete

*

[277] Fix | Delete

* @param string $mode Square mode to validate.

[278] Fix | Delete

*

[279] Fix | Delete

* @return string

[280] Fix | Delete

*/

[281] Fix | Delete

public static function validate_mode( string $mode ): string {

[282] Fix | Delete

[283] Fix | Delete

return in_array( $mode, self::get_available_modes(), true ) ? $mode : self::get_mode();

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

/**

[287] Fix | Delete

* Retrieve the WPForms > Payments settings page URL.

[288] Fix | Delete

*

[289] Fix | Delete

* @since 1.9.5

[290] Fix | Delete

*

[291] Fix | Delete

* @return string

[292] Fix | Delete

*/

[293] Fix | Delete

public static function get_settings_page_url(): string {

[294] Fix | Delete

[295] Fix | Delete

return add_query_arg(

[296] Fix | Delete

[

[297] Fix | Delete

'page' => 'wpforms-settings',

[298] Fix | Delete

'view' => 'payments',

[299] Fix | Delete

],

[300] Fix | Delete

admin_url( 'admin.php' )

[301] Fix | Delete

);

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete

/**

[305] Fix | Delete

* The `array_key_first` polyfill.

[306] Fix | Delete

*

[307] Fix | Delete

* @since 1.9.5

[308] Fix | Delete

*

[309] Fix | Delete

* @param array $arr Input array.

[310] Fix | Delete

*

[311] Fix | Delete

* @return mixed|null

[312] Fix | Delete

*/

[313] Fix | Delete

public static function array_key_first( array $arr ) {

[314] Fix | Delete

[315] Fix | Delete

if ( function_exists( 'array_key_first' ) ) {

[316] Fix | Delete

return array_key_first( $arr );

[317] Fix | Delete

}

[318] Fix | Delete

[319] Fix | Delete

foreach ( $arr as $key => $unused ) {

[320] Fix | Delete

return $key;

[321] Fix | Delete

}

[322] Fix | Delete

[323] Fix | Delete

return null;

[324] Fix | Delete

}

[325] Fix | Delete

[326] Fix | Delete

/**

[327] Fix | Delete

* Determine if webhook ID and secret are set in WPForms settings.

[328] Fix | Delete

*

[329] Fix | Delete

* @since 1.9.5

[330] Fix | Delete

*

[331] Fix | Delete

* @return bool

[332] Fix | Delete

*/

[333] Fix | Delete

public static function is_webhook_configured(): bool {

[334] Fix | Delete

[335] Fix | Delete

$mode = self::get_mode();

[336] Fix | Delete

[337] Fix | Delete

return wpforms_setting( 'square-webhooks-id-' . $mode ) && wpforms_setting( 'square-webhooks-secret-' . $mode );

[338] Fix | Delete

}

[339] Fix | Delete

[340] Fix | Delete

/**

[341] Fix | Delete

* Determine if Square is configured and valid.

[342] Fix | Delete

*

[343] Fix | Delete

* @since 1.9.5

[344] Fix | Delete

*

[345] Fix | Delete

* @return bool

[346] Fix | Delete

*/

[347] Fix | Delete

public static function is_square_configured(): bool {

[348] Fix | Delete

[349] Fix | Delete

$connection = Connection::get();

[350] Fix | Delete

[351] Fix | Delete

// Check if connection is configured and valid.

[352] Fix | Delete

return ! ( ! $connection || ! $connection->is_configured() || ! $connection->is_valid() );

[353] Fix | Delete

}

[354] Fix | Delete

[355] Fix | Delete

/**

[356] Fix | Delete

* Get webhook URL for REST API.

[357] Fix | Delete

*

[358] Fix | Delete

* @since 1.9.5

[359] Fix | Delete

*

[360] Fix | Delete

* @return string

[361] Fix | Delete

*/

[362] Fix | Delete

public static function get_webhook_url_for_rest(): string {

[363] Fix | Delete

[364] Fix | Delete

$path = implode(

[365] Fix | Delete

'/',

[366] Fix | Delete

[

[367] Fix | Delete

self::get_webhook_endpoint_data()['namespace'],

[368] Fix | Delete

self::get_webhook_endpoint_data()['route'],

[369] Fix | Delete

]

[370] Fix | Delete

);

[371] Fix | Delete

[372] Fix | Delete

return rest_url( $path );

[373] Fix | Delete

}

[374] Fix | Delete

[375] Fix | Delete

/**

[376] Fix | Delete

* Reset Square webhooks settings.

[377] Fix | Delete

*

[378] Fix | Delete

* @since 1.9.5

[379] Fix | Delete

*

[380] Fix | Delete

* @param bool $reset_enable Optional. Whether to reset the webhook enabled status. Default is false.

[381] Fix | Delete

*

[382] Fix | Delete

* @return bool

[383] Fix | Delete

*/

[384] Fix | Delete

public static function reset_webhook_configuration( bool $reset_enable = false ): bool {

[385] Fix | Delete

[386] Fix | Delete

$settings = (array) get_option( 'wpforms_settings', [] );

[387] Fix | Delete

[388] Fix | Delete

$mode = self::get_mode();

[389] Fix | Delete

[390] Fix | Delete

if ( $reset_enable ) {

[391] Fix | Delete

$settings['square-webhooks-enabled'] = false; // Switch off webhooks.

[392] Fix | Delete

}

[393] Fix | Delete

[394] Fix | Delete

$settings[ 'square-webhooks-id-' . $mode ] = '';

[395] Fix | Delete

$settings[ 'square-webhooks-secret-' . $mode ] = '';

[396] Fix | Delete

[397] Fix | Delete

return update_option( 'wpforms_settings', $settings );

[398] Fix | Delete

}

[399] Fix | Delete

[400] Fix | Delete

/**

[401] Fix | Delete

* Determine the billing cadences of a Subscription.

[402] Fix | Delete

*

[403] Fix | Delete

* @since 1.9.5

[404] Fix | Delete

*

[405] Fix | Delete

* @return array

[406] Fix | Delete

*/

[407] Fix | Delete

public static function get_subscription_cadences(): array {

[408] Fix | Delete

[409] Fix | Delete

/**

[410] Fix | Delete

* Filter the available billing cadences of a Subscription.

[411] Fix | Delete

*

[412] Fix | Delete

* @since 1.9.5

[413] Fix | Delete

*

[414] Fix | Delete

* @param array $cadences Subscription billing cadences.

[415] Fix | Delete

*/

[416] Fix | Delete

return (array) apply_filters(

[417] Fix | Delete

'wpforms_integrations_square_helpers_get_subscription_cadences',

[418] Fix | Delete

[

[419] Fix | Delete

'daily' => [

[420] Fix | Delete

'slug' => 'daily',

[421] Fix | Delete

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

[422] Fix | Delete

'value' => SubscriptionCadence::DAILY,

[423] Fix | Delete

],

[424] Fix | Delete

'weekly' => [

[425] Fix | Delete

'slug' => 'weekly',

[426] Fix | Delete

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

[427] Fix | Delete

'value' => SubscriptionCadence::WEEKLY,

[428] Fix | Delete

],

[429] Fix | Delete

'monthly' => [

[430] Fix | Delete

'slug' => 'monthly',

[431] Fix | Delete

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

[432] Fix | Delete

'value' => SubscriptionCadence::MONTHLY,

[433] Fix | Delete

],

[434] Fix | Delete

'quarterly' => [

[435] Fix | Delete

'slug' => 'quarterly',

[436] Fix | Delete

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

[437] Fix | Delete

'value' => SubscriptionCadence::QUARTERLY,

[438] Fix | Delete

],

[439] Fix | Delete

'semiyearly' => [

[440] Fix | Delete

'slug' => 'semiyearly',

[441] Fix | Delete

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

[442] Fix | Delete

'value' => SubscriptionCadence::EVERY_SIX_MONTHS,

[443] Fix | Delete

],

[444] Fix | Delete

'yearly' => [

[445] Fix | Delete

'slug' => 'yearly',

[446] Fix | Delete

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

[447] Fix | Delete

'value' => SubscriptionCadence::ANNUAL,

[448] Fix | Delete

],

[449] Fix | Delete

]

[450] Fix | Delete

);

[451] Fix | Delete

}

[452] Fix | Delete

[453] Fix | Delete

/**

[454] Fix | Delete

* Return a formatted amount required by Square API.

[455] Fix | Delete

*

[456] Fix | Delete

* @since 1.9.5

[457] Fix | Delete

*

[458] Fix | Delete

* @param string $amount Price amount.

[459] Fix | Delete

*

[460] Fix | Delete

* @return float|int

[461] Fix | Delete

*/

[462] Fix | Delete

public static function format_amount( string $amount ) {

[463] Fix | Delete

[464] Fix | Delete

return wpforms_sanitize_amount( $amount ) * wpforms_get_currency_multiplier();

[465] Fix | Delete

}

[466] Fix | Delete

[467] Fix | Delete

/**

[468] Fix | Delete

* Get Square webhook endpoint data.

[469] Fix | Delete

*

[470] Fix | Delete

* @since 1.9.5

[471] Fix | Delete

*

[472] Fix | Delete

* @return array

[473] Fix | Delete

*/

[474] Fix | Delete

public static function get_webhook_endpoint_data(): array {

[475] Fix | Delete

[476] Fix | Delete

return [

[477] Fix | Delete

'namespace' => 'wpforms',

[478] Fix | Delete

'route' => 'square/webhooks',

[479] Fix | Delete

'fallback' => 'wpforms_square_webhooks',

[480] Fix | Delete

];

[481] Fix | Delete

}

[482] Fix | Delete

[483] Fix | Delete

/**

[484] Fix | Delete

* Get Square webhook endpoint URL.

[485] Fix | Delete

*

[486] Fix | Delete

* If the constant WPFORMS_SQUARE_WHURL is defined, it will be used as the webhook URL.

[487] Fix | Delete

*

[488] Fix | Delete

* @since 1.9.5

[489] Fix | Delete

*

[490] Fix | Delete

* @return string

[491] Fix | Delete

*/

[492] Fix | Delete

public static function get_webhook_url(): string {

[493] Fix | Delete

[494] Fix | Delete

if ( defined( 'WPFORMS_SQUARE_WHURL' ) ) {

[495] Fix | Delete

return WPFORMS_SQUARE_WHURL;

[496] Fix | Delete

}

[497] Fix | Delete

[498] Fix | Delete

if ( self::is_rest_api_set() ) {

[499] Fix | Delete