type = esc_html__( 'Connection', 'wpforms-lite' ); $this->init(); $this->hooks(); } /** * Hooks. * * @since 1.6.8 */ private function hooks() { // Add to a list of available providers. add_filter( 'wpforms_providers_available', [ $this, 'register_provider' ], $this->priority ); // Process builder AJAX requests. add_action( "wp_ajax_wpforms_provider_ajax_$this->slug", [ $this, 'process_ajax' ] ); // Process entry. add_action( 'wpforms_process_complete', [ $this, 'process_entry' ], 5, 4 ); // Fetch and store the current form data when in the builder. add_action( 'wpforms_builder_init', [ $this, 'builder_form_data' ] ); // Output builder sidebar. add_action( 'wpforms_providers_panel_sidebar', [ $this, 'builder_sidebar' ], $this->priority ); // Output builder content. add_action( 'wpforms_providers_panel_content', [ $this, 'builder_output' ], $this->priority ); // Remove provider from Settings Integrations tab. add_action( "wp_ajax_wpforms_settings_provider_disconnect_$this->slug", [ $this, 'integrations_tab_disconnect' ] ); // Add new provider from Settings Integrations tab. add_action( "wp_ajax_wpforms_settings_provider_add_$this->slug", [ $this, 'integrations_tab_add' ] ); // Add providers sections to the Settings Integrations tab. add_action( 'wpforms_settings_providers', [ $this, 'integrations_tab_options' ], $this->priority, 2 ); } /** * Add to a list of registered providers. * * @since 1.0.0 * * @param array $providers Array of all active providers. * * @return array */ public function register_provider( $providers = [] ) { $providers[ $this->slug ] = $this->name; return $providers; } /** * Process the Builder AJAX requests. * * @since 1.0.0 */ public function process_ajax() { // phpcs:ignore Generic.Metrics.CyclomaticComplexity.TooHigh // Run a security check. check_ajax_referer( 'wpforms-builder', 'nonce' ); // Check for permissions. if ( ! wpforms_current_user_can( 'edit_forms' ) ) { wp_send_json_error( [ 'error' => esc_html__( 'You do not have permission', 'wpforms-lite' ), ] ); } $name = ! empty( $_POST['name'] ) ? sanitize_text_field( wp_unslash( $_POST['name'] ) ) : ''; $task = ! empty( $_POST['task'] ) ? sanitize_text_field( wp_unslash( $_POST['task'] ) ) : ''; $id = ! empty( $_POST['id'] ) ? sanitize_text_field( wp_unslash( $_POST['id'] ) ) : ''; $connection_id = ! empty( $_POST['connection_id'] ) ? sanitize_text_field( wp_unslash( $_POST['connection_id'] ) ) : ''; $account_id = ! empty( $_POST['account_id'] ) ? sanitize_text_field( wp_unslash( $_POST['account_id'] ) ) : ''; $list_id = ! empty( $_POST['list_id'] ) ? sanitize_text_field( wp_unslash( $_POST['list_id'] ) ) : ''; $data = ! empty( $_POST['data'] ) ? array_map( 'sanitize_text_field', wp_parse_args( wp_unslash( $_POST['data'] ) ) ) : []; //phpcs:ignore /* * Create a new connection. */ if ( $task === 'new_connection' ) { $connection = $this->output_connection( '', [ 'connection_name' => $name, ], $id ); wp_send_json_success( [ 'html' => $connection, ] ); } /* * Create a new Provider account. */ if ( $task === 'new_account' ) { $auth = $this->api_auth( $data, $id ); if ( is_wp_error( $auth ) ) { wp_send_json_error( [ 'error' => $auth->get_error_message(), ] ); } else { $accounts = $this->output_accounts( $connection_id, [ 'account_id' => $auth, ] ); wp_send_json_success( [ 'html' => $accounts, ] ); } } /* * Select/Toggle Provider accounts. */ if ( $task === 'select_account' ) { $lists = $this->output_lists( $connection_id, [ 'account_id' => $account_id, ] ); if ( is_wp_error( $lists ) ) { wp_send_json_error( [ 'error' => $lists->get_error_message(), ] ); } else { wp_send_json_success( [ 'html' => $lists, ] ); } } /* * Select/Toggle Provider account lists. */ if ( $task === 'select_list' ) { $fields = $this->output_fields( $connection_id, [ 'account_id' => $account_id, 'list_id' => $list_id, ], $id ); if ( is_wp_error( $fields ) ) { wp_send_json_error( [ 'error' => $fields->get_error_message(), ] ); } else { $groups = $this->output_groups( $connection_id, [ 'account_id' => $account_id, 'list_id' => $list_id, ] ); $conditionals = $this->output_conditionals( $connection_id, [ 'account_id' => $account_id, 'list_id' => $list_id, ], [ 'id' => absint( $_POST['form_id'] ), //phpcs:ignore ] ); $options = $this->output_options( $connection_id, [ 'account_id' => $account_id, 'list_id' => $list_id, ] ); wp_send_json_success( [ 'html' => $groups . $fields . $conditionals . $options, ] ); } } die(); } /** * Process and submit entry to provider. * * @since 1.0.0 * * @param array $fields List of fields in a form. * @param array $entry Submitted entry values. * @param array $form_data Form data and settings. * @param int $entry_id Saved entry ID. */ public function process_entry( $fields, $entry, $form_data, $entry_id ) {} /** * Process conditional fields. * * @since 1.0.0 * * @param array $fields List of fields with their data and settings. * @param array $entry Submitted entry values. * @param array $form_data Form data and settings. * @param array $connection List of connection settings. * * @return bool * @noinspection PhpMissingParamTypeInspection * @noinspection PhpUnusedParameterInspection */ public function process_conditionals( $fields, $entry, $form_data, $connection ) { if ( empty( $connection['conditional_logic'] ) || empty( $connection['conditionals'] ) || ! function_exists( 'wpforms_conditional_logic' ) ) { return true; } $process = wpforms_conditional_logic()->process( $fields, $form_data, $connection['conditionals'] ); if ( ! empty( $connection['conditional_type'] ) && $connection['conditional_type'] === 'stop' ) { $process = ! $process; } return $process; } /** * Retrieve all available forms in a field. * * Not all fields should be available for merge tags, so we compare against an allowlist. * Also, some fields, such as Name, should have additional variations. * * @since 1.0.0 * * @param object|int $form Form object or form ID. * @param array $allowlist Allowlist of field types to allow. * * @return bool|array */ public function get_form_fields( $form = false, $allowlist = [] ) { // Accept form (post) object or form ID. if ( is_object( $form ) ) { $form = wpforms_decode( $form->post_content ); } elseif ( is_numeric( $form ) ) { $form_obj = wpforms()->obj( 'form' ); $form = $form_obj ? $form_obj->get( $form, [ 'content_only' => true ] ) : []; } if ( ! is_array( $form ) || empty( $form['fields'] ) ) { return false; } // Allowlist of field types to allow. $allowed_form_fields = [ 'text', 'textarea', 'select', 'radio', 'checkbox', 'email', 'address', 'url', 'name', 'hidden', 'date-time', 'phone', 'number', ]; /** * Filter the allowed form fields for the provider. * * @since 1.0.0 * * @param array $allowed_form_fields List of allowed form fields. * * @return array */ $allowed_form_fields = (array) apply_filters( 'wpforms_providers_fields', $allowed_form_fields ); $allowlist = ! empty( $allowlist ) ? $allowlist : $allowed_form_fields; $form_fields = $form['fields']; foreach ( $form_fields as $id => $form_field ) { if ( ! in_array( $form_field['type'], $allowlist, true ) ) { unset( $form_fields[ $id ] ); } } return $form_fields; } /** * Get form fields ready for select list options. * * In this function, we also do the logic to limit certain fields to certain provider field types. * * @since 1.0.0 * * @param array $form_fields List of form fields. * @param string $form_field_type Provider field type. * * @return array */ public function get_form_field_select( $form_fields = [], $form_field_type = '' ) { if ( empty( $form_fields ) || empty( $form_field_type ) ) { return []; } $formatted = []; // Include only specific field types. foreach ( $form_fields as $id => $form_field ) { // Email. if ( $form_field_type === 'email' && ! in_array( $form_field['type'], [ 'text', 'email' ], true ) ) { unset( $form_fields[ $id ] ); } // Address. if ( $form_field_type === 'address' && $form_field['type'] !== 'address' ) { unset( $form_fields[ $id ] ); } } // Format. foreach ( $form_fields as $form_field ) { // Complex Name field. if ( $form_field['type'] === 'name' ) { // Full Name. $formatted[] = [ 'id' => $form_field['id'], 'key' => 'value', 'type' => $form_field['type'], 'subtype' => '', 'provider_type' => $form_field_type, 'label' => sprintf( /* translators: %s - Name field label. */ esc_html__( '%s (Full)', 'wpforms-lite' ), $form_field['label'] ), ]; // First Name. if ( strpos( $form_field['format'], 'first' ) !== false ) { $formatted[] = [ 'id' => $form_field['id'], 'key' => 'first', 'type' => $form_field['type'], 'subtype' => 'first', 'provider_type' => $form_field_type, 'label' => sprintf( /* translators: %s - Name field label. */ esc_html__( '%s (First)', 'wpforms-lite' ), $form_field['label'] ), ]; } // Middle Name. if ( strpos( $form_field['format'], 'middle' ) !== false ) { $formatted[] = [ 'id' => $form_field['id'], 'key' => 'middle', 'type' => $form_field['type'], 'subtype' => 'middle', 'provider_type' => $form_field_type, 'label' => sprintf( /* translators: %s - Name field label. */ esc_html__( '%s (Middle)', 'wpforms-lite' ), $form_field['label'] ), ]; } // Last Name. if ( strpos( $form_field['format'], 'last' ) !== false ) { $formatted[] = [ 'id' => $form_field['id'], 'key' => 'last', 'type' => $form_field['type'], 'subtype' => 'last', 'provider_type' => $form_field_type, 'label' => sprintf( /* translators: %s - Name field label. */ esc_html__( '%s (Last)', 'wpforms-lite' ), $form_field['label'] ), ]; } } else { // All other fields. $formatted[] = [ 'id' => $form_field['id'], 'key' => 'value', 'type' => $form_field['type'], 'subtype' => '', 'provider_type' => $form_field_type, 'label' => $form_field['label'], ]; } } return $formatted; } /************************************************************************ * API methods - these methods interact directly with the provider API. * ************************************************************************/ /** * Authenticate with the provider API. * * @since 1.0.0 * * @param array $data Form data. * @param string $form_id Form ID. * * @return string|WP_Error id or error object */ public function api_auth( $data = [], $form_id = '' ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed return $this->error( 'Authorization failed' ); } /** * Establish connection object to provider API. * * @since 1.0.0 * * @param string $account_id Account ID. * * @return WP_Error|array|object */ public function api_connect( $account_id ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found return $this->error( 'API connect failed' ); } /** * Retrieve provider account lists. * * @since 1.0.0 * * @param string $connection_id Unique connection ID. * @param string $account_id Account ID. * * @return WP_Error|array|object * @noinspection PhpMissingParamTypeInspection * @noinspection PhpUnusedParameterInspection */ public function api_lists( $connection_id = '', $account_id = '' ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed return $this->error( 'Could not retrieve lists' ); } /** * Retrieve provider account list groups. * * @since 1.0.0 * * @param string $connection_id Unique connection ID. * @param string $account_id Account ID. * @param string $list_id List ID. * * @return mixed array or error object * @noinspection PhpMissingParamTypeInspection * @noinspection PhpUnusedParameterInspection */ public function api_groups( $connection_id = '', $account_id = '', $list_id = '' ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed return $this->error( 'Could not retrieve groups' ); } /** * Retrieve provider account list fields. * * @since 1.0.0 * * @param string $connection_id Unique connection ID. * @param string $account_id Account ID. * @param string $list_id List ID. * * @return mixed array or error object * @noinspection PhpMissingParamTypeInspection * @noinspection PhpUnusedParameterInspection */ public function api_fields( $connection_id = '', $account_id = '', $list_id = '' ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed return $this->error( 'Could not retrieve fields' ); } /************************************************************************* * Output methods - these methods generally return HTML for the builder. * *************************************************************************/ /** * Connection HTML. * * This method compiles all the HTML necessary for a connection to a provider. * * @since 1.0.0 * * @param string $connection_id Unique connection ID. * @param array $connection Connection data. * @param mixed $form Form id or form data. * * @return string * @noinspection NonSecureUniqidUsageInspection */ public function output_connection( $connection_id = '', $connection = [], $form = '' ) { if ( empty( $connection_id ) ) { $connection_id = 'connection_' . uniqid(); } if ( empty( $connection ) || empty( $form ) ) { return ''; } $output = sprintf( '
%s
', esc_html__( 'We also noticed that you have some segments in your list. You can select specific list segments below if needed. This is optional.', 'wpforms-lite' ) ); $output .= '%s
', esc_html( $groupset['name'] ) ); foreach ( $groupset['groups'] as $group ) { $selected = ! empty( $connection['groups'] ) && ! empty( $connection['groups'][ $groupset['id'] ] ) && in_array( $group['name'], $connection['groups'][ $groupset['id'] ], true ); $output .= sprintf( '', esc_attr( $group['id'] ), esc_attr( $group['name'] ), $this->slug, $connection_id, $groupset['id'], $group['id'], checked( $selected, true, false ), esc_attr( $group['id'] ), esc_attr( $group['name'] ) ); } } $output .= '| %s | %s |
|---|---|
| '; $output .= esc_html( $provider_field['name'] ); if ( ! empty( $provider_field['req'] ) && (int) $provider_field['req'] === 1 ) { $output .= '*'; } $output .= ' | '; $output .= sprintf( ''; $output .= ' | '; $output .= '
name ) ); ?>