Edit File by line
/home/zeestwma/richards.../wp-conte.../plugins/wpforms-.../includes/provider...
File: class-base.php
<?php
[0] Fix | Delete
[1] Fix | Delete
// phpcs:disable Generic.Commenting.DocComment.MissingShort
[2] Fix | Delete
/** @noinspection PhpIllegalPsrClassPathInspection */
[3] Fix | Delete
/** @noinspection AutoloadingIssuesInspection */
[4] Fix | Delete
// phpcs:enable Generic.Commenting.DocComment.MissingShort
[5] Fix | Delete
[6] Fix | Delete
use WPForms\Providers\Provider\Settings\FormBuilder;
[7] Fix | Delete
use WPForms\Providers\Provider\Status;
[8] Fix | Delete
[9] Fix | Delete
/**
[10] Fix | Delete
* Provider class.
[11] Fix | Delete
*
[12] Fix | Delete
* @since 1.0.0
[13] Fix | Delete
*/
[14] Fix | Delete
abstract class WPForms_Provider {
[15] Fix | Delete
[16] Fix | Delete
/**
[17] Fix | Delete
* Provider addon version.
[18] Fix | Delete
*
[19] Fix | Delete
* @since 1.0.0
[20] Fix | Delete
*
[21] Fix | Delete
* @var string
[22] Fix | Delete
*/
[23] Fix | Delete
protected $version;
[24] Fix | Delete
[25] Fix | Delete
/**
[26] Fix | Delete
* Provider name.
[27] Fix | Delete
*
[28] Fix | Delete
* @since 1.0.0
[29] Fix | Delete
*
[30] Fix | Delete
* @var string
[31] Fix | Delete
*/
[32] Fix | Delete
public $name;
[33] Fix | Delete
[34] Fix | Delete
/**
[35] Fix | Delete
* Provider name in slug format.
[36] Fix | Delete
*
[37] Fix | Delete
* @since 1.0.0
[38] Fix | Delete
*
[39] Fix | Delete
* @var string
[40] Fix | Delete
*/
[41] Fix | Delete
public $slug;
[42] Fix | Delete
[43] Fix | Delete
/**
[44] Fix | Delete
* Load priority.
[45] Fix | Delete
*
[46] Fix | Delete
* @since 1.0.0
[47] Fix | Delete
*
[48] Fix | Delete
* @var int
[49] Fix | Delete
*/
[50] Fix | Delete
public $priority = 10;
[51] Fix | Delete
[52] Fix | Delete
/**
[53] Fix | Delete
* Store the API connections.
[54] Fix | Delete
*
[55] Fix | Delete
* @since 1.0.0
[56] Fix | Delete
*
[57] Fix | Delete
* @var array
[58] Fix | Delete
*/
[59] Fix | Delete
public $api = [];
[60] Fix | Delete
[61] Fix | Delete
/**
[62] Fix | Delete
* Service icon.
[63] Fix | Delete
*
[64] Fix | Delete
* @since 1.0.0
[65] Fix | Delete
*
[66] Fix | Delete
* @var string
[67] Fix | Delete
*/
[68] Fix | Delete
public $icon;
[69] Fix | Delete
[70] Fix | Delete
/**
[71] Fix | Delete
* Service icon.
[72] Fix | Delete
*
[73] Fix | Delete
* @since 1.2.3
[74] Fix | Delete
*
[75] Fix | Delete
* @var string
[76] Fix | Delete
*/
[77] Fix | Delete
public $type;
[78] Fix | Delete
[79] Fix | Delete
/**
[80] Fix | Delete
* Form data and settings.
[81] Fix | Delete
*
[82] Fix | Delete
* @since 1.2.3
[83] Fix | Delete
*
[84] Fix | Delete
* @var array
[85] Fix | Delete
*/
[86] Fix | Delete
public $form_data;
[87] Fix | Delete
[88] Fix | Delete
/**
[89] Fix | Delete
* Primary class constructor.
[90] Fix | Delete
*
[91] Fix | Delete
* @since 1.0.0
[92] Fix | Delete
*/
[93] Fix | Delete
public function __construct() {
[94] Fix | Delete
[95] Fix | Delete
$this->type = esc_html__( 'Connection', 'wpforms-lite' );
[96] Fix | Delete
[97] Fix | Delete
$this->init();
[98] Fix | Delete
$this->hooks();
[99] Fix | Delete
}
[100] Fix | Delete
[101] Fix | Delete
/**
[102] Fix | Delete
* Hooks.
[103] Fix | Delete
*
[104] Fix | Delete
* @since 1.6.8
[105] Fix | Delete
*/
[106] Fix | Delete
private function hooks() {
[107] Fix | Delete
[108] Fix | Delete
// Add to a list of available providers.
[109] Fix | Delete
add_filter( 'wpforms_providers_available', [ $this, 'register_provider' ], $this->priority );
[110] Fix | Delete
[111] Fix | Delete
// Process builder AJAX requests.
[112] Fix | Delete
add_action( "wp_ajax_wpforms_provider_ajax_$this->slug", [ $this, 'process_ajax' ] );
[113] Fix | Delete
[114] Fix | Delete
// Process entry.
[115] Fix | Delete
add_action( 'wpforms_process_complete', [ $this, 'process_entry' ], 5, 4 );
[116] Fix | Delete
[117] Fix | Delete
// Fetch and store the current form data when in the builder.
[118] Fix | Delete
add_action( 'wpforms_builder_init', [ $this, 'builder_form_data' ] );
[119] Fix | Delete
[120] Fix | Delete
// Output builder sidebar.
[121] Fix | Delete
add_action( 'wpforms_providers_panel_sidebar', [ $this, 'builder_sidebar' ], $this->priority );
[122] Fix | Delete
[123] Fix | Delete
// Output builder content.
[124] Fix | Delete
add_action( 'wpforms_providers_panel_content', [ $this, 'builder_output' ], $this->priority );
[125] Fix | Delete
[126] Fix | Delete
// Remove provider from Settings Integrations tab.
[127] Fix | Delete
add_action( "wp_ajax_wpforms_settings_provider_disconnect_$this->slug", [ $this, 'integrations_tab_disconnect' ] );
[128] Fix | Delete
[129] Fix | Delete
// Add new provider from Settings Integrations tab.
[130] Fix | Delete
add_action( "wp_ajax_wpforms_settings_provider_add_$this->slug", [ $this, 'integrations_tab_add' ] );
[131] Fix | Delete
[132] Fix | Delete
// Add providers sections to the Settings Integrations tab.
[133] Fix | Delete
add_action( 'wpforms_settings_providers', [ $this, 'integrations_tab_options' ], $this->priority, 2 );
[134] Fix | Delete
}
[135] Fix | Delete
[136] Fix | Delete
/**
[137] Fix | Delete
* Add to a list of registered providers.
[138] Fix | Delete
*
[139] Fix | Delete
* @since 1.0.0
[140] Fix | Delete
*
[141] Fix | Delete
* @param array $providers Array of all active providers.
[142] Fix | Delete
*
[143] Fix | Delete
* @return array
[144] Fix | Delete
*/
[145] Fix | Delete
public function register_provider( $providers = [] ) {
[146] Fix | Delete
[147] Fix | Delete
$providers[ $this->slug ] = $this->name;
[148] Fix | Delete
[149] Fix | Delete
return $providers;
[150] Fix | Delete
}
[151] Fix | Delete
[152] Fix | Delete
/**
[153] Fix | Delete
* Process the Builder AJAX requests.
[154] Fix | Delete
*
[155] Fix | Delete
* @since 1.0.0
[156] Fix | Delete
*/
[157] Fix | Delete
public function process_ajax() { // phpcs:ignore Generic.Metrics.CyclomaticComplexity.TooHigh
[158] Fix | Delete
[159] Fix | Delete
// Run a security check.
[160] Fix | Delete
check_ajax_referer( 'wpforms-builder', 'nonce' );
[161] Fix | Delete
[162] Fix | Delete
// Check for permissions.
[163] Fix | Delete
if ( ! wpforms_current_user_can( 'edit_forms' ) ) {
[164] Fix | Delete
wp_send_json_error(
[165] Fix | Delete
[
[166] Fix | Delete
'error' => esc_html__( 'You do not have permission', 'wpforms-lite' ),
[167] Fix | Delete
]
[168] Fix | Delete
);
[169] Fix | Delete
}
[170] Fix | Delete
[171] Fix | Delete
$name = ! empty( $_POST['name'] ) ? sanitize_text_field( wp_unslash( $_POST['name'] ) ) : '';
[172] Fix | Delete
$task = ! empty( $_POST['task'] ) ? sanitize_text_field( wp_unslash( $_POST['task'] ) ) : '';
[173] Fix | Delete
$id = ! empty( $_POST['id'] ) ? sanitize_text_field( wp_unslash( $_POST['id'] ) ) : '';
[174] Fix | Delete
$connection_id = ! empty( $_POST['connection_id'] ) ? sanitize_text_field( wp_unslash( $_POST['connection_id'] ) ) : '';
[175] Fix | Delete
$account_id = ! empty( $_POST['account_id'] ) ? sanitize_text_field( wp_unslash( $_POST['account_id'] ) ) : '';
[176] Fix | Delete
$list_id = ! empty( $_POST['list_id'] ) ? sanitize_text_field( wp_unslash( $_POST['list_id'] ) ) : '';
[177] Fix | Delete
$data = ! empty( $_POST['data'] ) ? array_map( 'sanitize_text_field', wp_parse_args( wp_unslash( $_POST['data'] ) ) ) : []; //phpcs:ignore
[178] Fix | Delete
[179] Fix | Delete
/*
[180] Fix | Delete
* Create a new connection.
[181] Fix | Delete
*/
[182] Fix | Delete
if ( $task === 'new_connection' ) {
[183] Fix | Delete
[184] Fix | Delete
$connection = $this->output_connection(
[185] Fix | Delete
'',
[186] Fix | Delete
[
[187] Fix | Delete
'connection_name' => $name,
[188] Fix | Delete
],
[189] Fix | Delete
$id
[190] Fix | Delete
);
[191] Fix | Delete
[192] Fix | Delete
wp_send_json_success(
[193] Fix | Delete
[
[194] Fix | Delete
'html' => $connection,
[195] Fix | Delete
]
[196] Fix | Delete
);
[197] Fix | Delete
}
[198] Fix | Delete
[199] Fix | Delete
/*
[200] Fix | Delete
* Create a new Provider account.
[201] Fix | Delete
*/
[202] Fix | Delete
if ( $task === 'new_account' ) {
[203] Fix | Delete
[204] Fix | Delete
$auth = $this->api_auth( $data, $id );
[205] Fix | Delete
[206] Fix | Delete
if ( is_wp_error( $auth ) ) {
[207] Fix | Delete
[208] Fix | Delete
wp_send_json_error(
[209] Fix | Delete
[
[210] Fix | Delete
'error' => $auth->get_error_message(),
[211] Fix | Delete
]
[212] Fix | Delete
);
[213] Fix | Delete
[214] Fix | Delete
} else {
[215] Fix | Delete
[216] Fix | Delete
$accounts = $this->output_accounts(
[217] Fix | Delete
$connection_id,
[218] Fix | Delete
[
[219] Fix | Delete
'account_id' => $auth,
[220] Fix | Delete
]
[221] Fix | Delete
);
[222] Fix | Delete
[223] Fix | Delete
wp_send_json_success(
[224] Fix | Delete
[
[225] Fix | Delete
'html' => $accounts,
[226] Fix | Delete
]
[227] Fix | Delete
);
[228] Fix | Delete
}
[229] Fix | Delete
}
[230] Fix | Delete
[231] Fix | Delete
/*
[232] Fix | Delete
* Select/Toggle Provider accounts.
[233] Fix | Delete
*/
[234] Fix | Delete
if ( $task === 'select_account' ) {
[235] Fix | Delete
[236] Fix | Delete
$lists = $this->output_lists(
[237] Fix | Delete
$connection_id,
[238] Fix | Delete
[
[239] Fix | Delete
'account_id' => $account_id,
[240] Fix | Delete
]
[241] Fix | Delete
);
[242] Fix | Delete
[243] Fix | Delete
if ( is_wp_error( $lists ) ) {
[244] Fix | Delete
[245] Fix | Delete
wp_send_json_error(
[246] Fix | Delete
[
[247] Fix | Delete
'error' => $lists->get_error_message(),
[248] Fix | Delete
]
[249] Fix | Delete
);
[250] Fix | Delete
[251] Fix | Delete
} else {
[252] Fix | Delete
[253] Fix | Delete
wp_send_json_success(
[254] Fix | Delete
[
[255] Fix | Delete
'html' => $lists,
[256] Fix | Delete
]
[257] Fix | Delete
);
[258] Fix | Delete
}
[259] Fix | Delete
}
[260] Fix | Delete
[261] Fix | Delete
/*
[262] Fix | Delete
* Select/Toggle Provider account lists.
[263] Fix | Delete
*/
[264] Fix | Delete
if ( $task === 'select_list' ) {
[265] Fix | Delete
[266] Fix | Delete
$fields = $this->output_fields(
[267] Fix | Delete
$connection_id,
[268] Fix | Delete
[
[269] Fix | Delete
'account_id' => $account_id,
[270] Fix | Delete
'list_id' => $list_id,
[271] Fix | Delete
],
[272] Fix | Delete
$id
[273] Fix | Delete
);
[274] Fix | Delete
[275] Fix | Delete
if ( is_wp_error( $fields ) ) {
[276] Fix | Delete
[277] Fix | Delete
wp_send_json_error(
[278] Fix | Delete
[
[279] Fix | Delete
'error' => $fields->get_error_message(),
[280] Fix | Delete
]
[281] Fix | Delete
);
[282] Fix | Delete
[283] Fix | Delete
} else {
[284] Fix | Delete
[285] Fix | Delete
$groups = $this->output_groups(
[286] Fix | Delete
$connection_id,
[287] Fix | Delete
[
[288] Fix | Delete
'account_id' => $account_id,
[289] Fix | Delete
'list_id' => $list_id,
[290] Fix | Delete
]
[291] Fix | Delete
);
[292] Fix | Delete
[293] Fix | Delete
$conditionals = $this->output_conditionals(
[294] Fix | Delete
$connection_id,
[295] Fix | Delete
[
[296] Fix | Delete
'account_id' => $account_id,
[297] Fix | Delete
'list_id' => $list_id,
[298] Fix | Delete
],
[299] Fix | Delete
[
[300] Fix | Delete
'id' => absint( $_POST['form_id'] ), //phpcs:ignore
[301] Fix | Delete
]
[302] Fix | Delete
);
[303] Fix | Delete
[304] Fix | Delete
$options = $this->output_options(
[305] Fix | Delete
$connection_id,
[306] Fix | Delete
[
[307] Fix | Delete
'account_id' => $account_id,
[308] Fix | Delete
'list_id' => $list_id,
[309] Fix | Delete
]
[310] Fix | Delete
);
[311] Fix | Delete
[312] Fix | Delete
wp_send_json_success(
[313] Fix | Delete
[
[314] Fix | Delete
'html' => $groups . $fields . $conditionals . $options,
[315] Fix | Delete
]
[316] Fix | Delete
);
[317] Fix | Delete
}
[318] Fix | Delete
}
[319] Fix | Delete
[320] Fix | Delete
die();
[321] Fix | Delete
}
[322] Fix | Delete
[323] Fix | Delete
/**
[324] Fix | Delete
* Process and submit entry to provider.
[325] Fix | Delete
*
[326] Fix | Delete
* @since 1.0.0
[327] Fix | Delete
*
[328] Fix | Delete
* @param array $fields List of fields in a form.
[329] Fix | Delete
* @param array $entry Submitted entry values.
[330] Fix | Delete
* @param array $form_data Form data and settings.
[331] Fix | Delete
* @param int $entry_id Saved entry ID.
[332] Fix | Delete
*/
[333] Fix | Delete
public function process_entry( $fields, $entry, $form_data, $entry_id ) {}
[334] Fix | Delete
[335] Fix | Delete
/**
[336] Fix | Delete
* Process conditional fields.
[337] Fix | Delete
*
[338] Fix | Delete
* @since 1.0.0
[339] Fix | Delete
*
[340] Fix | Delete
* @param array $fields List of fields with their data and settings.
[341] Fix | Delete
* @param array $entry Submitted entry values.
[342] Fix | Delete
* @param array $form_data Form data and settings.
[343] Fix | Delete
* @param array $connection List of connection settings.
[344] Fix | Delete
*
[345] Fix | Delete
* @return bool
[346] Fix | Delete
* @noinspection PhpMissingParamTypeInspection
[347] Fix | Delete
* @noinspection PhpUnusedParameterInspection
[348] Fix | Delete
*/
[349] Fix | Delete
public function process_conditionals( $fields, $entry, $form_data, $connection ) {
[350] Fix | Delete
[351] Fix | Delete
if (
[352] Fix | Delete
empty( $connection['conditional_logic'] ) ||
[353] Fix | Delete
empty( $connection['conditionals'] ) ||
[354] Fix | Delete
! function_exists( 'wpforms_conditional_logic' )
[355] Fix | Delete
) {
[356] Fix | Delete
return true;
[357] Fix | Delete
}
[358] Fix | Delete
[359] Fix | Delete
$process = wpforms_conditional_logic()->process( $fields, $form_data, $connection['conditionals'] );
[360] Fix | Delete
[361] Fix | Delete
if ( ! empty( $connection['conditional_type'] ) && $connection['conditional_type'] === 'stop' ) {
[362] Fix | Delete
$process = ! $process;
[363] Fix | Delete
}
[364] Fix | Delete
[365] Fix | Delete
return $process;
[366] Fix | Delete
}
[367] Fix | Delete
[368] Fix | Delete
/**
[369] Fix | Delete
* Retrieve all available forms in a field.
[370] Fix | Delete
*
[371] Fix | Delete
* Not all fields should be available for merge tags, so we compare against an allowlist.
[372] Fix | Delete
* Also, some fields, such as Name, should have additional variations.
[373] Fix | Delete
*
[374] Fix | Delete
* @since 1.0.0
[375] Fix | Delete
*
[376] Fix | Delete
* @param object|int $form Form object or form ID.
[377] Fix | Delete
* @param array $allowlist Allowlist of field types to allow.
[378] Fix | Delete
*
[379] Fix | Delete
* @return bool|array
[380] Fix | Delete
*/
[381] Fix | Delete
public function get_form_fields( $form = false, $allowlist = [] ) {
[382] Fix | Delete
[383] Fix | Delete
// Accept form (post) object or form ID.
[384] Fix | Delete
if ( is_object( $form ) ) {
[385] Fix | Delete
$form = wpforms_decode( $form->post_content );
[386] Fix | Delete
} elseif ( is_numeric( $form ) ) {
[387] Fix | Delete
$form_obj = wpforms()->obj( 'form' );
[388] Fix | Delete
$form = $form_obj
[389] Fix | Delete
? $form_obj->get( $form, [ 'content_only' => true ] )
[390] Fix | Delete
: [];
[391] Fix | Delete
}
[392] Fix | Delete
[393] Fix | Delete
if ( ! is_array( $form ) || empty( $form['fields'] ) ) {
[394] Fix | Delete
return false;
[395] Fix | Delete
}
[396] Fix | Delete
[397] Fix | Delete
// Allowlist of field types to allow.
[398] Fix | Delete
$allowed_form_fields = [
[399] Fix | Delete
'text',
[400] Fix | Delete
'textarea',
[401] Fix | Delete
'select',
[402] Fix | Delete
'radio',
[403] Fix | Delete
'checkbox',
[404] Fix | Delete
'email',
[405] Fix | Delete
'address',
[406] Fix | Delete
'url',
[407] Fix | Delete
'name',
[408] Fix | Delete
'hidden',
[409] Fix | Delete
'date-time',
[410] Fix | Delete
'phone',
[411] Fix | Delete
'number',
[412] Fix | Delete
];
[413] Fix | Delete
[414] Fix | Delete
/**
[415] Fix | Delete
* Filter the allowed form fields for the provider.
[416] Fix | Delete
*
[417] Fix | Delete
* @since 1.0.0
[418] Fix | Delete
*
[419] Fix | Delete
* @param array $allowed_form_fields List of allowed form fields.
[420] Fix | Delete
*
[421] Fix | Delete
* @return array
[422] Fix | Delete
*/
[423] Fix | Delete
$allowed_form_fields = (array) apply_filters( 'wpforms_providers_fields', $allowed_form_fields );
[424] Fix | Delete
[425] Fix | Delete
$allowlist = ! empty( $allowlist ) ? $allowlist : $allowed_form_fields;
[426] Fix | Delete
[427] Fix | Delete
$form_fields = $form['fields'];
[428] Fix | Delete
[429] Fix | Delete
foreach ( $form_fields as $id => $form_field ) {
[430] Fix | Delete
if ( ! in_array( $form_field['type'], $allowlist, true ) ) {
[431] Fix | Delete
unset( $form_fields[ $id ] );
[432] Fix | Delete
}
[433] Fix | Delete
}
[434] Fix | Delete
[435] Fix | Delete
return $form_fields;
[436] Fix | Delete
}
[437] Fix | Delete
[438] Fix | Delete
/**
[439] Fix | Delete
* Get form fields ready for select list options.
[440] Fix | Delete
*
[441] Fix | Delete
* In this function, we also do the logic to limit certain fields to certain provider field types.
[442] Fix | Delete
*
[443] Fix | Delete
* @since 1.0.0
[444] Fix | Delete
*
[445] Fix | Delete
* @param array $form_fields List of form fields.
[446] Fix | Delete
* @param string $form_field_type Provider field type.
[447] Fix | Delete
*
[448] Fix | Delete
* @return array
[449] Fix | Delete
*/
[450] Fix | Delete
public function get_form_field_select( $form_fields = [], $form_field_type = '' ) {
[451] Fix | Delete
[452] Fix | Delete
if ( empty( $form_fields ) || empty( $form_field_type ) ) {
[453] Fix | Delete
return [];
[454] Fix | Delete
}
[455] Fix | Delete
[456] Fix | Delete
$formatted = [];
[457] Fix | Delete
[458] Fix | Delete
// Include only specific field types.
[459] Fix | Delete
foreach ( $form_fields as $id => $form_field ) {
[460] Fix | Delete
[461] Fix | Delete
// Email.
[462] Fix | Delete
if (
[463] Fix | Delete
$form_field_type === 'email' &&
[464] Fix | Delete
! in_array( $form_field['type'], [ 'text', 'email' ], true )
[465] Fix | Delete
) {
[466] Fix | Delete
unset( $form_fields[ $id ] );
[467] Fix | Delete
}
[468] Fix | Delete
[469] Fix | Delete
// Address.
[470] Fix | Delete
if ( $form_field_type === 'address' && $form_field['type'] !== 'address' ) {
[471] Fix | Delete
unset( $form_fields[ $id ] );
[472] Fix | Delete
}
[473] Fix | Delete
}
[474] Fix | Delete
[475] Fix | Delete
// Format.
[476] Fix | Delete
foreach ( $form_fields as $form_field ) {
[477] Fix | Delete
[478] Fix | Delete
// Complex Name field.
[479] Fix | Delete
if ( $form_field['type'] === 'name' ) {
[480] Fix | Delete
[481] Fix | Delete
// Full Name.
[482] Fix | Delete
$formatted[] = [
[483] Fix | Delete
'id' => $form_field['id'],
[484] Fix | Delete
'key' => 'value',
[485] Fix | Delete
'type' => $form_field['type'],
[486] Fix | Delete
'subtype' => '',
[487] Fix | Delete
'provider_type' => $form_field_type,
[488] Fix | Delete
'label' => sprintf(
[489] Fix | Delete
/* translators: %s - Name field label. */
[490] Fix | Delete
esc_html__( '%s (Full)', 'wpforms-lite' ),
[491] Fix | Delete
$form_field['label']
[492] Fix | Delete
),
[493] Fix | Delete
];
[494] Fix | Delete
[495] Fix | Delete
// First Name.
[496] Fix | Delete
if ( strpos( $form_field['format'], 'first' ) !== false ) {
[497] Fix | Delete
$formatted[] = [
[498] Fix | Delete
'id' => $form_field['id'],
[499] Fix | Delete
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
Function