<?php
namespace ElementorPro\Modules\Payments\Classes;
use Elementor\Utils;
use Elementor\Widget_Base;
use Elementor\Controls_Manager;
use Elementor\Core\Kits\Documents\Tabs\Global_Typography;
use Elementor\Group_Control_Typography;
use Elementor\Modules\DynamicTags\Module as TagsModule;
use Elementor\Widget_Button;
use ElementorPro\Base\Base_Widget_Trait;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
abstract class Payment_Button extends Widget_Button {
use Base_Widget_Trait;
// Payment types.
const PAYMENT_TYPE_CHECKOUT = 'checkout';
const PAYMENT_TYPE_SUBSCRIPTION = 'subscription';
const PAYMENT_TYPE_DONATION = 'donation';
// Billing cycles.
const BILLING_CYCLE_DAYS = 'days';
const BILLING_CYCLE_WEEKS = 'weeks';
const BILLING_CYCLE_MONTHS = 'months';
const BILLING_CYCLE_YEARS = 'years';
// Donation types.
const DONATION_TYPE_ANY = 'any';
const DONATION_TYPE_FIXED = 'fixed';
// Error messages.
const ERROR_MESSAGE_GLOBAL = 'global';
const ERROR_MESSAGE_PAYMENT_METHOD = 'payment';
// Retrieve the merchant display name.
abstract protected function get_merchant_name();
// Account details section.
abstract protected function register_account_section();
// Custom sandbox controls.
abstract protected function register_sandbox_controls();
public function get_group_name() {
return 'payments';
}
// Render custom controls after product type.
protected function after_product_type() { }
// Render custom controls test toggle control.
protected function after_custom_messages_toggle() { }
// Edit error massage placeholders for stripe widget
protected function update_error_massages() { }
// Return an array of supported currencies.
protected function get_currencies() {
return [
'AUD' => _x( 'AUD', 'Currency', 'elementor-pro' ),
'CAD' => _x( 'CAD', 'Currency', 'elementor-pro' ),
'CZK' => _x( 'CZK', 'Currency', 'elementor-pro' ),
'DKK' => _x( 'DKK', 'Currency', 'elementor-pro' ),
'EUR' => _x( 'EUR', 'Currency', 'elementor-pro' ),
'HKD' => _x( 'HKD', 'Currency', 'elementor-pro' ),
'HUF' => _x( 'HUF', 'Currency', 'elementor-pro' ),
'ILS' => _x( 'ILS', 'Currency', 'elementor-pro' ),
'JPY' => _x( 'JPY', 'Currency', 'elementor-pro' ),
'MXN' => _x( 'MXN', 'Currency', 'elementor-pro' ),
'NOK' => _x( 'NOK', 'Currency', 'elementor-pro' ),
'NZD' => _x( 'NZD', 'Currency', 'elementor-pro' ),
'PHP' => _x( 'PHP', 'Currency', 'elementor-pro' ),
'PLN' => _x( 'PLN', 'Currency', 'elementor-pro' ),
'GBP' => _x( 'GBP', 'Currency', 'elementor-pro' ),
'RUB' => _x( 'RUB', 'Currency', 'elementor-pro' ),
'SGD' => _x( 'SGD', 'Currency', 'elementor-pro' ),
'SEK' => _x( 'SEK', 'Currency', 'elementor-pro' ),
'CHF' => _x( 'CHF', 'Currency', 'elementor-pro' ),
'TWD' => _x( 'TWD', 'Currency', 'elementor-pro' ),
'THB' => _x( 'THB', 'Currency', 'elementor-pro' ),
'TRY' => _x( 'TRY', 'Currency', 'elementor-pro' ),
'USD' => _x( 'USD', 'Currency', 'elementor-pro' ),
];
}
// Return an array of default error messages.
protected function get_default_error_messages() {
return [
self::ERROR_MESSAGE_GLOBAL => esc_html__( 'An error occurred.', 'elementor-pro' ),
self::ERROR_MESSAGE_PAYMENT_METHOD => esc_html__( 'No payment method connected. Contact seller.', 'elementor-pro' ),
];
}
// Get message text by id (`error_message_$id`).
protected function get_custom_message( $id ) {
$message = $this->get_settings_for_display( 'error_message_' . $id );
// Return the user-defined message.
if ( ! empty( $message ) ) {
return $message;
}
// Return the default message.
$error_messages = $this->get_default_error_messages();
return ( ! empty( $error_messages[ $id ] ) ) ? $error_messages[ $id ] : esc_html__( 'Unknown error.', 'elementor-pro' );
}
// Product details section.
protected function register_product_controls() {
$this->add_control(
'type',
[
'label' => esc_html__( 'Transaction Type', 'elementor-pro' ),
'type' => Controls_Manager::SELECT,
'default' => 'checkout',
'options' => [
self::PAYMENT_TYPE_CHECKOUT => esc_html__( 'Checkout', 'elementor-pro' ),
self::PAYMENT_TYPE_DONATION => esc_html__( 'Donation', 'elementor-pro' ),
self::PAYMENT_TYPE_SUBSCRIPTION => esc_html__( 'Subscription', 'elementor-pro' ),
],
'separator' => 'before',
]
);
$this->after_product_type();
$this->add_control(
'product_name',
[
'label' => esc_html__( 'Item Name', 'elementor-pro' ),
'type' => Controls_Manager::TEXT,
'dynamic' => [
'active' => true,
],
'label_block' => true,
]
);
$this->add_control(
'product_sku',
[
'label' => esc_html__( 'SKU', 'elementor-pro' ),
'type' => Controls_Manager::TEXT,
'dynamic' => [
'active' => true,
],
]
);
$this->add_control(
'product_price',
[
'label' => esc_html__( 'Price', 'elementor-pro' ),
'type' => Controls_Manager::NUMBER,
'default' => '0.00',
'dynamic' => [
'active' => true,
],
'condition' => [
'type!' => self::PAYMENT_TYPE_DONATION,
],
]
);
$this->add_control(
'donation_type',
[
'label' => esc_html__( 'Donation Amount', 'elementor-pro' ),
'type' => Controls_Manager::SELECT,
'default' => self::DONATION_TYPE_FIXED,
'options' => [
self::DONATION_TYPE_ANY => esc_html__( 'Any Amount', 'elementor-pro' ),
self::DONATION_TYPE_FIXED => esc_html__( 'Fixed', 'elementor-pro' ),
],
'condition' => [
'type' => self::PAYMENT_TYPE_DONATION,
],
]
);
$this->add_control(
'donation_amount',
[
'label' => esc_html__( 'Amount', 'elementor-pro' ),
'type' => Controls_Manager::NUMBER,
'default' => '1',
'dynamic' => [
'active' => true,
],
'condition' => [
'type' => self::PAYMENT_TYPE_DONATION,
'donation_type' => self::DONATION_TYPE_FIXED,
],
]
);
$this->add_control(
'currency',
[
'label' => esc_html__( 'Currency', 'elementor-pro' ),
'type' => Controls_Manager::SELECT,
'default' => 'USD',
'options' => $this->get_currencies(),
]
);
$this->add_control(
'billing_cycle',
[
'label' => esc_html__( 'Billing Cycle', 'elementor-pro' ),
'type' => Controls_Manager::SELECT,
'default' => self::BILLING_CYCLE_MONTHS,
'options' => [
self::BILLING_CYCLE_DAYS => esc_html__( 'Daily', 'elementor-pro' ),
self::BILLING_CYCLE_WEEKS => esc_html__( 'Weekly', 'elementor-pro' ),
self::BILLING_CYCLE_MONTHS => esc_html__( 'Monthly', 'elementor-pro' ),
self::BILLING_CYCLE_YEARS => esc_html__( 'Yearly', 'elementor-pro' ),
],
'condition' => [
'type' => self::PAYMENT_TYPE_SUBSCRIPTION,
],
]
);
$this->add_control(
'auto_renewal',
[
'type' => Controls_Manager::SWITCHER,
'label' => esc_html__( 'Auto Renewal', 'elementor-pro' ),
'default' => 'yes',
'label_off' => esc_html__( 'Off', 'elementor-pro' ),
'label_on' => esc_html__( 'On', 'elementor-pro' ),
'condition' => [
'type' => self::PAYMENT_TYPE_SUBSCRIPTION,
],
]
);
$this->add_control(
'quantity',
[
'label' => esc_html__( 'Quantity', 'elementor-pro' ),
'type' => Controls_Manager::NUMBER,
'default' => 1,
'condition' => [
'type' => self::PAYMENT_TYPE_CHECKOUT,
],
]
);
$this->add_control(
'shipping_price',
[
'label' => esc_html__( 'Shipping Price', 'elementor-pro' ),
'type' => Controls_Manager::NUMBER,
'default' => 0,
'dynamic' => [
'active' => true,
],
'condition' => [
'type' => self::PAYMENT_TYPE_CHECKOUT,
],
]
);
$this->add_control(
'tax_type',
[
'label' => esc_html__( 'Tax', 'elementor-pro' ),
'type' => Controls_Manager::SELECT,
'default' => '',
'options' => [
'' => esc_html__( 'None', 'elementor-pro' ),
'percentage' => esc_html__( 'Percentage', 'elementor-pro' ),
],
'condition' => [
'type' => self::PAYMENT_TYPE_CHECKOUT,
],
]
);
$this->add_control(
'tax_rate',
[
'label' => esc_html__( 'Tax Percentage', 'elementor-pro' ),
'type' => Controls_Manager::NUMBER,
'default' => '0',
'dynamic' => [
'active' => true,
],
'condition' => [
'type' => self::PAYMENT_TYPE_CHECKOUT,
'tax_type' => 'percentage',
],
]
);
}
// Submission settings section.
protected function register_settings_section() {
$this->start_controls_section(
'section_settings',
[
'label' => esc_html__( 'Additional Options', 'elementor-pro' ),
]
);
$this->add_control(
'redirect_after_success',
[
'label' => esc_html__( 'Redirect After Success', 'elementor-pro' ),
'type' => Controls_Manager::URL,
'options' => false,
'placeholder' => esc_html__( 'Choose a page or add a URL', 'elementor-pro' ),
'dynamic' => [
'active' => true,
],
'label_block' => true,
'render_type' => 'none',
]
);
$this->add_control(
'sandbox_mode',
[
'type' => Controls_Manager::SWITCHER,
'label' => esc_html__( 'Sandbox', 'elementor-pro' ),
'default' => 'no',
'label_off' => esc_html__( 'Off', 'elementor-pro' ),
'label_on' => esc_html__( 'On', 'elementor-pro' ),
]
);
$this->register_sandbox_controls();
$this->add_control(
'open_in_new_window',
[
'type' => Controls_Manager::SWITCHER,
'label' => sprintf(
/* translators: %s: Merchant name. */
esc_html__( 'Open %s In New Tab', 'elementor-pro' ),
$this->get_merchant_name()
),
'default' => 'yes',
'label_off' => esc_html__( 'No', 'elementor-pro' ),
'label_on' => esc_html__( 'Yes', 'elementor-pro' ),
]
);
$this->add_control(
'custom_messages',
[
'label' => esc_html__( 'Custom Messages', 'elementor-pro' ),
'type' => Controls_Manager::SWITCHER,
'default' => '',
]
);
$this->after_custom_messages_toggle();
$error_messages = $this->get_default_error_messages();
$this->add_control(
'error_message_' . self::ERROR_MESSAGE_GLOBAL,
[
'label' => esc_html__( 'Error Message', 'elementor-pro' ),
'type' => Controls_Manager::TEXT,
'default' => $error_messages[ self::ERROR_MESSAGE_GLOBAL ],
'placeholder' => $error_messages[ self::ERROR_MESSAGE_GLOBAL ],
'label_block' => true,
'condition' => [
'custom_messages!' => '',
],
'dynamic' => [
'active' => true,
],
]
);
$this->add_control(
'error_message_' . self::ERROR_MESSAGE_PAYMENT_METHOD,
[
'label' => sprintf(
/* translators: %s: Merchant name. */
esc_html__( '%s Not Connected', 'elementor-pro' ),
$this->get_merchant_name()
),
'type' => Controls_Manager::TEXT,
'default' => $error_messages[ self::ERROR_MESSAGE_PAYMENT_METHOD ],
'placeholder' => $error_messages[ self::ERROR_MESSAGE_PAYMENT_METHOD ],
'label_block' => true,
'condition' => [
'custom_messages!' => '',
],
'dynamic' => [
'active' => true,
],
]
);
$this->update_error_massages();
$this->end_controls_section();
}
// Customize the default button controls.
protected function register_button_controls() {
parent::register_controls();
$this->remove_control( 'button_type' );
$this->remove_control( 'link' );
$this->remove_control( 'size' );
$this->update_control( 'text', [
'default' => 'Buy Now',
] );
$this->update_control( 'button_text_color', [
'default' => '#FFF',
] );
$this->update_control(
'icon_align',
[
'options' => [
'left' => esc_html__( 'Before Text', 'elementor-pro' ),
'right' => esc_html__( 'After Text', 'elementor-pro' ),
],
]
);
}
// Add typography settings for custom messages.
protected function register_messages_style_section() {
$this->start_controls_section(
'section_messages_style',
[
'label' => esc_html__( 'Messages', 'elementor-pro' ),
'tab' => Controls_Manager::TAB_STYLE,
]
);
$this->add_group_control(
Group_Control_Typography::get_type(),
[
'name' => 'message_typography',
'global' => [
'default' => Global_Typography::TYPOGRAPHY_TEXT,
],
'selector' => '{{WRAPPER}} .elementor-message',
]
);
$this->add_control(
'message_color_' . self::ERROR_MESSAGE_GLOBAL,
[
'label' => esc_html__( 'Error Message Color', 'elementor-pro' ),
'type' => Controls_Manager::COLOR,
'selectors' => [
'{{WRAPPER}} .elementor-message.elementor-error-message-' . self::ERROR_MESSAGE_GLOBAL => 'color: {{COLOR}};',
],
]
);
$this->add_control(
'message_color_' . self::ERROR_MESSAGE_PAYMENT_METHOD,
[
'label' => sprintf(
/* translators: %s: Merchant name. */
esc_html__( '%s Not Connected Color', 'elementor-pro' ),
$this->get_merchant_name()
),
'type' => Controls_Manager::COLOR,
'selectors' => [
'{{WRAPPER}} .elementor-message.elementor-error-message-' . self::ERROR_MESSAGE_PAYMENT_METHOD => 'color: {{COLOR}};',
],
]
);
$this->end_controls_section();
}
// Register widget controls.
protected function register_controls() {
$this->register_account_section();
$this->register_button_controls();
$this->register_settings_section();
$this->register_messages_style_section();
}
// Render the checkout button.
protected function render_button( Widget_Base $instance = null, $tag = 'a' ) {
$this->add_render_attribute( 'button', 'class', 'elementor-payment-button' );
?>
<<?php Utils::print_validated_html_tag( $tag ); ?> <?php $this->print_render_attribute_string( 'button' ); ?>>
<?php $this->render_text(); ?>
</<?php Utils::print_validated_html_tag( $tag ); ?>>
<?php
}
// Render the widget.
protected function render() {
$settings = $this->get_settings_for_display();
$this->add_render_attribute( 'wrapper', 'class', 'elementor-button-wrapper' );
$this->add_render_attribute( 'button', 'class', 'elementor-button' );
$this->add_render_attribute( 'button', 'role', 'button' );
if ( ! empty( $settings['button_css_id'] ) ) {
$this->add_render_attribute( 'button', 'id', $settings['button_css_id'] );
}
if ( ! empty( $settings['size'] ) ) {
$this->add_render_attribute( 'button', 'class', 'elementor-size-' . $settings['size'] );
}
if ( $settings['hover_animation'] ) {
$this->add_render_attribute( 'button', 'class', 'elementor-animation-' . $settings['hover_animation'] );
}
?>
<div <?php $this->print_render_attribute_string( 'wrapper' ); ?>>
<?php $this->render_button(); ?>
</div>
<?php
}
protected function content_template() {
return;
?>
<#
view.addRenderAttribute( 'text', 'class', 'elementor-button-text' );
view.addInlineEditingAttributes( 'text', 'none' );
var iconHTML = elementor.helpers.renderIcon( view, settings.selected_icon, { 'aria-hidden': true }, 'i' , 'object' ),
migrated = elementor.helpers.isIconMigrated( settings, 'selected_icon' );
#>
<div class="elementor-button-wrapper">
<a id="{{ settings.button_css_id }}" class="elementor-button elementor-size-{{ settings.size }} elementor-animation-{{ settings.hover_animation }}" href="#" role="button">
<span class="elementor-button-content-wrapper">
<# if ( settings.icon || settings.selected_icon ) { #>
<span class="elementor-button-icon elementor-align-icon-{{ settings.icon_align }}">
<# if ( ( migrated || ! settings.icon ) && iconHTML.rendered ) { #>
{{{ iconHTML.value }}}
<# } else { #>
<i class="{{ settings.icon }}" aria-hidden="true"></i>
<# } #>
</span>
<# } #>
<span {{{ view.getRenderAttributeString( 'text' ) }}}>{{{ settings.text }}}</span>
</span>
</a>
</div>
<?php
}
// Check if it's sandbox mode.
protected function is_sandbox() {
return 'yes' === $this->get_settings_for_display( 'sandbox_mode' );
}
}