ElementorPro/modules/forms/actions/convertkit.php
2024-07-07 01:00:30 +02:00

287 lines
7.3 KiB
PHP

<?php
namespace ElementorPro\Modules\Forms\Actions;
use Elementor\Controls_Manager;
use ElementorPro\Modules\Forms\Classes\Form_Record;
use ElementorPro\Modules\Forms\Classes\Integration_Base;
use ElementorPro\Modules\Forms\Classes\Convertkit_Handler;
use ElementorPro\Core\Utils;
use Elementor\Settings;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
class Convertkit extends Integration_Base {
const OPTION_NAME_API_KEY = 'pro_convertkit_api_key';
private function get_global_api_key() {
return get_option( 'elementor_' . self::OPTION_NAME_API_KEY );
}
public function get_name() {
return 'convertkit';
}
public function get_label() {
return esc_html__( 'ConvertKit', 'elementor-pro' );
}
public function register_settings_section( $widget ) {
$widget->start_controls_section(
'section_convertkit',
[
'label' => esc_html__( 'ConvertKit', 'elementor-pro' ),
'condition' => [
'submit_actions' => $this->get_name(),
],
]
);
self::global_api_control(
$widget,
$this->get_global_api_key(),
'ConvertKit API key',
[
'convertkit_api_key_source' => 'default',
],
$this->get_name()
);
$widget->add_control(
'convertkit_api_key_source',
[
'label' => esc_html__( 'API Key', 'elementor-pro' ),
'type' => Controls_Manager::SELECT,
'label_block' => false,
'options' => [
'default' => esc_html__( 'Default', 'elementor-pro' ),
'custom' => esc_html__( 'Custom', 'elementor-pro' ),
],
'default' => 'default',
]
);
$widget->add_control(
'convertkit_custom_api_key',
[
'label' => esc_html__( 'Custom API Key', 'elementor-pro' ),
'type' => Controls_Manager::TEXT,
'description' => esc_html__( 'Use this field to set a custom API Key for the current form', 'elementor-pro' ),
'condition' => [
'convertkit_api_key_source' => 'custom',
],
'ai' => [
'active' => false,
],
]
);
$widget->add_control(
'convertkit_form',
[
'label' => esc_html__( 'Form', 'elementor-pro' ),
'type' => Controls_Manager::SELECT,
'options' => [],
'render_type' => 'none',
'conditions' => [
'relation' => 'or',
'terms' => [
[
'name' => 'convertkit_custom_api_key',
'operator' => '!==',
'value' => '',
],
[
'name' => 'convertkit_api_key_source',
'operator' => '=',
'value' => 'default',
],
],
],
]
);
$this->register_fields_map_control( $widget );
$widget->add_control(
'convertkit_tags',
[
'label' => esc_html__( 'Tags', 'elementor-pro' ),
'type' => Controls_Manager::SELECT2,
'options' => [],
'multiple' => true,
'render_type' => 'none',
'label_block' => true,
'condition' => [
'convertkit_form!' => '',
],
]
);
$widget->end_controls_section();
}
public function on_export( $element ) {
unset(
$element['settings']['convertkit_api_key_source'],
$element['settings']['convertkit_custom_api_key'],
$element['settings']['convertkit_form'],
$element['settings']['convertkit_fields_map']
);
return $element;
}
public function run( $record, $ajax_handler ) {
$form_settings = $record->get( 'form_settings' );
$subscriber = $this->create_subscriber_object( $record );
if ( ! $subscriber ) {
throw new \Exception( 'Integration requires an email field.' );
}
if ( 'default' === $form_settings['convertkit_api_key_source'] ) {
$api_key = $this->get_global_api_key();
} else {
$api_key = $form_settings['convertkit_custom_api_key'];
}
if ( '' !== $form_settings['convertkit_tags'] ) {
$subscriber['tags'] = $form_settings['convertkit_tags'];
}
$handler = new ConvertKit_Handler( $api_key );
$handler->create_subscriber( $form_settings['convertkit_form'], $subscriber );
}
/**
* Create subscriber array from submitted data and form settings
* returns a subscriber array or false on error
*
* @param Form_Record $record
*
* @return array|bool
*/
private function create_subscriber_object( Form_Record $record ) {
$subscriber = $this->map_fields( $record );
if ( ! isset( $subscriber['email'] ) ) {
return false;
}
$subscriber['ipAddress'] = Utils::get_client_ip();
return $subscriber;
}
/**
* @param Form_Record $record
*
* @return array
*/
private function map_fields( Form_Record $record ) {
$subscriber = [];
$fields = $record->get( 'fields' );
// Other form has a field mapping
foreach ( $record->get_form_settings( 'convertkit_fields_map' ) as $map_item ) {
if ( empty( $fields[ $map_item['local_id'] ]['value'] ) ) {
continue;
}
$value = $fields[ $map_item['local_id'] ]['value'];
if ( in_array( $map_item['remote_id'], [ 'first_name', 'email' ] ) ) {
$subscriber[ $map_item['remote_id'] ] = $value;
continue;
}
}
return $subscriber;
}
/**
* @param array $data
*
* @return array
* @throws \Exception
*/
public function handle_panel_request( array $data ) {
if ( ! empty( $data['api_key'] ) && 'default' === $data['api_key'] ) {
$api_key = $this->get_global_api_key();
} elseif ( ! empty( $data['custom_api_key'] ) ) {
$api_key = $data['custom_api_key'];
}
if ( empty( $api_key ) ) {
throw new \Exception( '`api_key` is required.', 400 );
}
$handler = new Convertkit_Handler( $api_key );
return $handler->get_forms_and_tags();
}
public function ajax_validate_api_token() {
check_ajax_referer( self::OPTION_NAME_API_KEY, '_nonce' );
if ( ! isset( $_POST['api_key'] ) ) {
wp_send_json_error();
}
if ( ! current_user_can( 'manage_options' ) ) {
wp_send_json_error( 'Permission denied' );
}
try {
new Convertkit_Handler( $_POST['api_key'] ); // phpcs:ignore -- No need to sanitize to support special characters.
} catch ( \Exception $exception ) {
wp_send_json_error();
}
wp_send_json_success();
}
public function register_admin_fields( Settings $settings ) {
$settings->add_section( Settings::TAB_INTEGRATIONS, 'convertkit', [
'callback' => function() {
echo '<hr><h2>' . esc_html__( 'ConvertKit', 'elementor-pro' ) . '</h2>';
},
'fields' => [
self::OPTION_NAME_API_KEY => [
'label' => esc_html__( 'API Key', 'elementor-pro' ),
'field_args' => [
'type' => 'text',
'desc' => sprintf(
/* translators: 1: Link opening tag, 2: Link closing tag. */
esc_html__( 'To integrate with our forms you need an %1$sAPI Key%2$s.', 'elementor-pro' ),
'<a href="https://app.convertkit.com/account/edit" target="_blank">',
'</a>'
),
],
],
'validate_api_data' => [
'field_args' => [
'type' => 'raw_html',
'html' => sprintf( '<button data-action="%s" data-nonce="%s" class="button elementor-button-spinner" id="elementor_pro_convertkit_api_key_button">%s</button>', self::OPTION_NAME_API_KEY . '_validate', wp_create_nonce( self::OPTION_NAME_API_KEY ), esc_html__( 'Validate API Key', 'elementor-pro' ) ),
],
],
],
] );
}
public function __construct() {
if ( is_admin() ) {
add_action( 'elementor/admin/after_create_settings/' . Settings::PAGE_ID, [ $this, 'register_admin_fields' ], 15 );
}
add_action( 'wp_ajax_' . self::OPTION_NAME_API_KEY . '_validate', [ $this, 'ajax_validate_api_token' ] );
}
protected function get_fields_map_control_options() {
return [
'condition' => [
'convertkit_form!' => '',
],
];
}
}