509 lines
18 KiB
PHP
509 lines
18 KiB
PHP
<?php
|
|
/**
|
|
* Main class for Smart Coupons Email
|
|
*
|
|
* @author StoreApps
|
|
* @since 4.4.1
|
|
* @version 1.7.0
|
|
*
|
|
* @package woocommerce-smart-coupons/includes/emails/
|
|
*/
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit; // Exit if accessed directly.
|
|
}
|
|
|
|
if ( ! class_exists( 'WC_SC_Email_Coupon' ) ) {
|
|
/**
|
|
* The Smart Coupons Email class
|
|
*
|
|
* @extends \WC_SC_Email
|
|
*/
|
|
class WC_SC_Email_Coupon extends WC_SC_Email {
|
|
|
|
/**
|
|
* Set email defaults
|
|
*/
|
|
public function __construct() {
|
|
|
|
$this->id = 'wc_sc_email_coupon';
|
|
|
|
$this->customer_email = true;
|
|
|
|
// Set email title and description.
|
|
$this->title = __( 'Smart Coupons - Auto generated coupon email', 'woocommerce-smart-coupons' );
|
|
$this->description = __( 'Email auto generated coupon to recipients. One email per coupon.', 'woocommerce-smart-coupons' );
|
|
|
|
// Use our plugin templates directory as the template base.
|
|
$this->template_base = dirname( WC_SC_PLUGIN_FILE ) . '/templates/';
|
|
|
|
// Email template location.
|
|
$this->template_html = 'email.php';
|
|
$this->template_plain = 'plain/email.php';
|
|
|
|
$this->placeholders = array(
|
|
'{coupon_code}' => '',
|
|
'{coupon_type}' => '',
|
|
'{coupon_value}' => '',
|
|
'{sender_name}' => '',
|
|
);
|
|
|
|
// Trigger for this email.
|
|
add_action( 'wc_sc_email_coupon_notification', array( $this, 'trigger' ) );
|
|
|
|
// Call parent constructor to load any other defaults not explicity defined here.
|
|
parent::__construct();
|
|
}
|
|
|
|
/**
|
|
* Get default email subject.
|
|
*
|
|
* @return string Default email subject
|
|
*/
|
|
public function get_default_subject() {
|
|
return __( '{site_title}: Congratulations! You\'ve received a {coupon_type} from {sender_name}', 'woocommerce-smart-coupons' );
|
|
}
|
|
|
|
/**
|
|
* Get default email heading.
|
|
*
|
|
* @return string Default email heading
|
|
*/
|
|
public function get_default_heading() {
|
|
return __( 'You have received a {coupon_type} {coupon_value}', 'woocommerce-smart-coupons' );
|
|
}
|
|
|
|
/**
|
|
* Determine if the email should actually be sent and setup email merge variables
|
|
*
|
|
* @param array $args Email arguments.
|
|
*/
|
|
public function trigger( $args = array() ) {
|
|
|
|
$this->email_args = wp_parse_args( $args, $this->email_args );
|
|
|
|
if ( ! isset( $this->email_args['email'] ) || empty( $this->email_args['email'] ) ) {
|
|
return;
|
|
}
|
|
|
|
$this->setup_locale();
|
|
|
|
$this->recipient = $this->email_args['email'];
|
|
|
|
$order_id = isset( $this->email_args['order_id'] ) ? $this->email_args['order_id'] : 0;
|
|
|
|
// Get order object.
|
|
if ( ! empty( $order_id ) && 0 !== $order_id ) {
|
|
$order = wc_get_order( $order_id );
|
|
if ( is_a( $order, 'WC_Order' ) ) {
|
|
$this->object = $order;
|
|
}
|
|
}
|
|
|
|
$this->set_placeholders();
|
|
|
|
$email_content = $this->get_content();
|
|
// Replace placeholders with values in the email content.
|
|
$email_content = ( is_callable( array( $this, 'format_string' ) ) ) ? $this->format_string( $email_content ) : $email_content;
|
|
|
|
// Send email.
|
|
if ( $this->is_enabled() && $this->get_recipient() ) {
|
|
$this->send( $this->get_recipient(), $this->get_subject(), $email_content, $this->get_headers(), $this->get_attachments() );
|
|
}
|
|
|
|
$this->restore_locale();
|
|
}
|
|
|
|
/**
|
|
* Function to set placeholder variables used in email subject/heading
|
|
*/
|
|
public function set_placeholders() {
|
|
$this->placeholders['{coupon_code}'] = $this->get_coupon_code();
|
|
$this->placeholders['{coupon_type}'] = $this->get_coupon_type();
|
|
$this->placeholders['{coupon_value}'] = $this->get_coupon_value();
|
|
$this->placeholders['{coupon_expiry}'] = $this->get_coupon_expiry();
|
|
$this->placeholders['{sender_name}'] = $this->get_sender_name();
|
|
}
|
|
|
|
/**
|
|
* Function to get coupon expiry date/time for current coupon being sent.
|
|
*
|
|
* @return string $coupon_expiry Coupon expiry.
|
|
*/
|
|
public function get_coupon_expiry() {
|
|
|
|
global $woocommerce_smart_coupon;
|
|
|
|
$coupon_expiry = '';
|
|
$coupon = isset( $this->email_args['coupon'] ) ? $this->email_args['coupon'] : '';
|
|
|
|
if ( empty( $coupon ) ) {
|
|
return $coupon_expiry;
|
|
}
|
|
|
|
$coupon_code = ( ! empty( $coupon['code'] ) ) ? $coupon['code'] : '';
|
|
if ( empty( $coupon_code ) ) {
|
|
return $coupon_expiry;
|
|
}
|
|
|
|
$_coupon = new WC_Coupon( $coupon_code );
|
|
if ( $woocommerce_smart_coupon->is_wc_gte_30() ) {
|
|
$coupon_id = ( is_object( $_coupon ) && is_callable( array( $_coupon, 'get_id' ) ) ) ? $_coupon->get_id() : 0;
|
|
$expiry_date = ( is_object( $_coupon ) && is_callable( array( $_coupon, 'get_date_expires' ) ) ) ? $_coupon->get_date_expires() : '';
|
|
} else {
|
|
$coupon_id = ( ! empty( $_coupon->id ) ) ? $_coupon->id : 0;
|
|
$expiry_date = ( ! empty( $_coupon->expiry_date ) ) ? $_coupon->expiry_date : '';
|
|
}
|
|
|
|
if ( ! empty( $expiry_date ) ) {
|
|
if ( $woocommerce_smart_coupon->is_wc_gte_30() && $expiry_date instanceof WC_DateTime ) {
|
|
$expiry_date = ( is_callable( array( $expiry_date, 'getTimestamp' ) ) ) ? $expiry_date->getTimestamp() : null;
|
|
} elseif ( ! is_int( $expiry_date ) ) {
|
|
$expiry_date = strtotime( $expiry_date );
|
|
}
|
|
|
|
if ( ! empty( $expiry_date ) && is_int( $expiry_date ) ) {
|
|
$expiry_time = (int) $woocommerce_smart_coupon->get_post_meta( $coupon_id, 'wc_sc_expiry_time', true );
|
|
if ( ! empty( $expiry_time ) ) {
|
|
$expiry_date += $expiry_time; // Adding expiry time to expiry date.
|
|
}
|
|
}
|
|
$coupon_expiry = $woocommerce_smart_coupon->get_expiration_format( $expiry_date );
|
|
} else {
|
|
$coupon_expiry = esc_html__( 'Never expires', 'woocommerce-smart-coupons' );
|
|
}
|
|
|
|
return $coupon_expiry;
|
|
}
|
|
|
|
/**
|
|
* Function to load email html content
|
|
*
|
|
* @return string Email content html
|
|
*/
|
|
public function get_content_html() {
|
|
|
|
global $woocommerce_smart_coupon;
|
|
|
|
$order = $this->object;
|
|
$url = $this->get_url();
|
|
$email_heading = $this->get_heading();
|
|
|
|
$sender = '';
|
|
$from = '';
|
|
|
|
$is_gift = isset( $this->email_args['is_gift'] ) ? $this->email_args['is_gift'] : '';
|
|
|
|
if ( 'yes' === $is_gift ) {
|
|
$sender_name = $this->get_sender_name();
|
|
$sender_email = $this->get_sender_email();
|
|
if ( ! empty( $sender_name ) && ! empty( $sender_email ) ) {
|
|
$sender = $sender_name . ' (' . $sender_email . ') ';
|
|
$from = ' ' . __( 'from', 'woocommerce-smart-coupons' ) . ' ';
|
|
}
|
|
}
|
|
|
|
$email = isset( $this->email_args['email'] ) ? $this->email_args['email'] : '';
|
|
$message_from_sender = isset( $this->email_args['message_from_sender'] ) ? $this->email_args['message_from_sender'] : '';
|
|
$coupon_code = isset( $this->email_args['coupon']['code'] ) ? $this->email_args['coupon']['code'] : '';
|
|
|
|
$design = get_option( 'wc_sc_setting_coupon_design', 'basic' );
|
|
$background_color = get_option( 'wc_sc_setting_coupon_background_color', '#39cccc' );
|
|
$foreground_color = get_option( 'wc_sc_setting_coupon_foreground_color', '#30050b' );
|
|
$third_color = get_option( 'wc_sc_setting_coupon_third_color', '#39cccc' );
|
|
|
|
$show_coupon_description = get_option( 'smart_coupons_show_coupon_description', 'no' );
|
|
|
|
$valid_designs = $woocommerce_smart_coupon->get_valid_coupon_designs();
|
|
|
|
if ( ! in_array( $design, $valid_designs, true ) ) {
|
|
$design = 'basic';
|
|
}
|
|
|
|
$design = ( 'custom-design' !== $design ) ? 'email-coupon' : $design;
|
|
|
|
$coupon_styles = $woocommerce_smart_coupon->get_coupon_styles( $design, array( 'is_email' => 'yes' ) );
|
|
|
|
$default_path = $this->template_base;
|
|
$template_path = $woocommerce_smart_coupon->get_template_base_dir( $this->template_html );
|
|
|
|
ob_start();
|
|
|
|
wc_get_template(
|
|
$this->template_html,
|
|
array(
|
|
'email' => $email,
|
|
'email_obj' => $this,
|
|
'email_heading' => $email_heading,
|
|
'order' => $order,
|
|
'url' => $url,
|
|
'message_from_sender' => $message_from_sender,
|
|
'from' => $from,
|
|
'coupon_code' => $coupon_code,
|
|
'background_color' => $background_color,
|
|
'foreground_color' => $foreground_color,
|
|
'third_color' => $third_color,
|
|
'coupon_styles' => $coupon_styles,
|
|
'sender' => $sender,
|
|
'design' => $design,
|
|
'show_coupon_description' => $show_coupon_description,
|
|
),
|
|
$template_path,
|
|
$default_path
|
|
);
|
|
|
|
return ob_get_clean();
|
|
}
|
|
|
|
/**
|
|
* Function to load email plain content
|
|
*
|
|
* @return string Email plain content
|
|
*/
|
|
public function get_content_plain() {
|
|
|
|
global $woocommerce_smart_coupon;
|
|
|
|
$order = $this->object;
|
|
$url = $this->get_url();
|
|
$email_heading = $this->get_heading();
|
|
|
|
$sender = '';
|
|
$from = '';
|
|
|
|
$is_gift = isset( $this->email_args['is_gift'] ) ? $this->email_args['is_gift'] : '';
|
|
|
|
if ( 'yes' === $is_gift ) {
|
|
$sender_name = $this->get_sender_name();
|
|
$sender_email = $this->get_sender_email();
|
|
if ( ! empty( $sender_name ) && ! empty( $sender_email ) ) {
|
|
$sender = $sender_name . ' (' . $sender_email . ') ';
|
|
$from = ' ' . __( 'from', 'woocommerce-smart-coupons' ) . ' ';
|
|
}
|
|
}
|
|
|
|
$email = isset( $this->email_args['email'] ) ? $this->email_args['email'] : '';
|
|
$message_from_sender = isset( $this->email_args['message_from_sender'] ) ? $this->email_args['message_from_sender'] : '';
|
|
$coupon_code = isset( $this->email_args['coupon']['code'] ) ? $this->email_args['coupon']['code'] : '';
|
|
|
|
$default_path = $this->template_base;
|
|
$template_path = $woocommerce_smart_coupon->get_template_base_dir( $this->template_plain );
|
|
|
|
ob_start();
|
|
|
|
wc_get_template(
|
|
$this->template_plain,
|
|
array(
|
|
'email' => $email,
|
|
'email_obj' => $this,
|
|
'email_heading' => $email_heading,
|
|
'order' => $order,
|
|
'url' => $url,
|
|
'message_from_sender' => $message_from_sender,
|
|
'from' => $from,
|
|
'coupon_code' => $coupon_code,
|
|
'sender' => $sender,
|
|
),
|
|
$template_path,
|
|
$default_path
|
|
);
|
|
|
|
return ob_get_clean();
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Get coupon code
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_coupon_code() {
|
|
|
|
$coupon_code = isset( $this->email_args['coupon']['code'] ) ? $this->email_args['coupon']['code'] : '';
|
|
|
|
return $coupon_code;
|
|
}
|
|
|
|
/**
|
|
* Get coupon value
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_coupon_value() {
|
|
|
|
global $woocommerce_smart_coupon, $store_credit_label;
|
|
|
|
$coupon = isset( $this->email_args['coupon'] ) ? $this->email_args['coupon'] : '';
|
|
|
|
if ( empty( $coupon ) ) {
|
|
return '';
|
|
}
|
|
|
|
$order_id = isset( $this->email_args['order_id'] ) ? $this->email_args['order_id'] : 0;
|
|
$order = ( ! empty( $order_id ) ) ? wc_get_order( $order_id ) : null;
|
|
|
|
$wc_price_args = array(
|
|
'currency' => is_callable( array( $order, 'get_currency' ) ) ? $order->get_currency() : '',
|
|
);
|
|
|
|
$discount_type = isset( $this->email_args['discount_type'] ) ? $this->email_args['discount_type'] : '';
|
|
$is_gift = isset( $this->email_args['is_gift'] ) ? $this->email_args['is_gift'] : '';
|
|
|
|
// Get smart coupon type string.
|
|
if ( 'smart_coupon' === $discount_type && 'yes' === $is_gift ) {
|
|
$smart_coupon_type = __( 'Gift Card', 'woocommerce-smart-coupons' );
|
|
} else {
|
|
$smart_coupon_type = __( 'Store Credit', 'woocommerce-smart-coupons' );
|
|
}
|
|
|
|
if ( ! empty( $store_credit_label['singular'] ) ) {
|
|
$smart_coupon_type = ucwords( $store_credit_label['singular'] );
|
|
}
|
|
|
|
$amount = $coupon['amount'];
|
|
$coupon_code = $coupon['code'];
|
|
|
|
// Get coupon types.
|
|
$all_discount_types = wc_get_coupon_types();
|
|
|
|
$_coupon = new WC_Coupon( $coupon_code );
|
|
|
|
if ( $woocommerce_smart_coupon->is_wc_gte_30() ) {
|
|
$_coupon_id = ( is_object( $_coupon ) && is_callable( array( $_coupon, 'get_id' ) ) ) ? $_coupon->get_id() : 0;
|
|
$_is_free_shipping = ( $_coupon->get_free_shipping() ) ? 'yes' : 'no';
|
|
$_discount_type = $_coupon->get_discount_type();
|
|
$_product_ids = $_coupon->get_product_ids();
|
|
$_excluded_product_ids = $_coupon->get_excluded_product_ids();
|
|
$_product_categories = $_coupon->get_product_categories();
|
|
$_excluded_product_categories = $_coupon->get_excluded_product_categories();
|
|
} else {
|
|
$_coupon_id = ( ! empty( $_coupon->id ) ) ? $_coupon->id : 0;
|
|
$_is_free_shipping = ( ! empty( $_coupon->free_shipping ) ) ? $_coupon->free_shipping : '';
|
|
$_discount_type = ( ! empty( $_coupon->discount_type ) ) ? $_coupon->discount_type : '';
|
|
$_product_ids = ( ! empty( $_coupon->product_ids ) ) ? $_coupon->product_ids : array();
|
|
$_excluded_product_ids = ( ! empty( $_coupon->exclude_product_ids ) ) ? $_coupon->exclude_product_ids : array();
|
|
$_product_categories = ( ! empty( $_coupon->product_categories ) ) ? $_coupon->product_categories : array();
|
|
$_excluded_product_categories = ( ! empty( $_coupon->exclude_product_categories ) ) ? $_coupon->exclude_product_categories : array();
|
|
}
|
|
|
|
if ( false === stripos( $discount_type, 'percent' ) ) {
|
|
$amount = $woocommerce_smart_coupon->read_price( $amount, true, $order );
|
|
}
|
|
|
|
switch ( $discount_type ) {
|
|
|
|
case 'smart_coupon':
|
|
/* translators: %s coupon amount */
|
|
$coupon_value = sprintf( __( 'worth %s ', 'woocommerce-smart-coupons' ), wc_price( $amount, $wc_price_args ) );
|
|
break;
|
|
|
|
case 'fixed_cart':
|
|
/* translators: %s: coupon amount */
|
|
$coupon_value = sprintf( __( 'worth %s (for entire purchase) ', 'woocommerce-smart-coupons' ), wc_price( $amount, $wc_price_args ) );
|
|
break;
|
|
|
|
case 'fixed_product':
|
|
if ( ! empty( $_product_ids ) || ! empty( $_excluded_product_ids ) || ! empty( $_product_categories ) || ! empty( $_excluded_product_categories ) ) {
|
|
$_discount_for_text = __( 'for some products', 'woocommerce-smart-coupons' );
|
|
} else {
|
|
$_discount_for_text = __( 'for all products', 'woocommerce-smart-coupons' );
|
|
}
|
|
|
|
/* translators: 1: coupon amount 2: discount for text */
|
|
$coupon_value = sprintf( __( 'worth %1$s (%2$s) ', 'woocommerce-smart-coupons' ), wc_price( $amount, $wc_price_args ), $_discount_for_text );
|
|
break;
|
|
|
|
case 'percent_product':
|
|
if ( ! empty( $_product_ids ) || ! empty( $_excluded_product_ids ) || ! empty( $_product_categories ) || ! empty( $_excluded_product_categories ) ) {
|
|
$_discount_for_text = __( 'for some products', 'woocommerce-smart-coupons' );
|
|
} else {
|
|
$_discount_for_text = __( 'for all products', 'woocommerce-smart-coupons' );
|
|
}
|
|
|
|
/* translators: 1: coupon amount 2: discount for text */
|
|
$coupon_value = sprintf( __( 'worth %1$s%% (%2$s) ', 'woocommerce-smart-coupons' ), $amount, $_discount_for_text );
|
|
break;
|
|
|
|
case 'percent':
|
|
if ( ! empty( $_product_ids ) || ! empty( $_excluded_product_ids ) || ! empty( $_product_categories ) || ! empty( $_excluded_product_categories ) ) {
|
|
$_discount_for_text = __( 'for some products', 'woocommerce-smart-coupons' );
|
|
} else {
|
|
$_discount_for_text = __( 'for entire purchase', 'woocommerce-smart-coupons' );
|
|
}
|
|
|
|
$max_discount_text = '';
|
|
$max_discount = $woocommerce_smart_coupon->get_post_meta( $_coupon_id, 'wc_sc_max_discount', true, true, $order );
|
|
if ( ! empty( $max_discount ) && is_numeric( $max_discount ) ) {
|
|
/* translators: %s: Maximum coupon discount amount */
|
|
$max_discount_text = sprintf( __( ' upto %s', 'woocommerce-smart-coupons' ), wc_price( $max_discount, $wc_price_args ) );
|
|
}
|
|
|
|
/* translators: 1: coupon amount 2: max discount text 3: discount for text */
|
|
$coupon_value = sprintf( __( 'worth %1$s%% %2$s (%3$s) ', 'woocommerce-smart-coupons' ), $amount, $max_discount_text, $_discount_for_text );
|
|
break;
|
|
|
|
default:
|
|
$default_coupon_type = ( ! empty( $all_discount_types[ $discount_type ] ) ) ? $all_discount_types[ $discount_type ] : ucwords( str_replace( array( '_', '-' ), ' ', $discount_type ) );
|
|
$coupon_type = apply_filters( 'wc_sc_coupon_type', $default_coupon_type, $_coupon, $all_discount_types );
|
|
$coupon_amount = apply_filters( 'wc_sc_coupon_amount', $amount, $_coupon );
|
|
|
|
/* translators: 1: coupon type 2: coupon amount */
|
|
$coupon_value = sprintf( __( '%1$s coupon of %2$s', 'woocommerce-smart-coupons' ), $coupon_type, $coupon_amount );
|
|
$coupon_value = apply_filters( 'wc_sc_email_heading', $coupon_value, $_coupon );
|
|
break;
|
|
|
|
}
|
|
|
|
if ( 'yes' === $_is_free_shipping && in_array( $_discount_type, array( 'fixed_cart', 'fixed_product', 'percent_product', 'percent' ), true ) ) {
|
|
/* translators: 1: email heading 2: suffix */
|
|
$coupon_value = sprintf( __( '%1$s Free Shipping%2$s', 'woocommerce-smart-coupons' ), ( ( ! empty( $amount ) ) ? $coupon_value . __( '&', 'woocommerce-smart-coupons' ) : __( 'You have received a', 'woocommerce-smart-coupons' ) ), ( ( empty( $amount ) ) ? __( ' coupon', 'woocommerce-smart-coupons' ) : '' ) );
|
|
}
|
|
|
|
return wp_strip_all_tags( $coupon_value );
|
|
}
|
|
|
|
/**
|
|
* Function to get coupon type for current coupon being sent.
|
|
*
|
|
* @return string $coupon_type Coupon type.
|
|
*/
|
|
public function get_coupon_type() {
|
|
|
|
global $store_credit_label;
|
|
|
|
$discount_type = isset( $this->email_args['discount_type'] ) ? $this->email_args['discount_type'] : '';
|
|
$is_gift = isset( $this->email_args['is_gift'] ) ? $this->email_args['is_gift'] : '';
|
|
|
|
if ( 'smart_coupon' === $discount_type && 'yes' === $is_gift ) {
|
|
$smart_coupon_type = __( 'Gift Card', 'woocommerce-smart-coupons' );
|
|
} else {
|
|
$smart_coupon_type = __( 'Store Credit', 'woocommerce-smart-coupons' );
|
|
}
|
|
|
|
if ( ! empty( $store_credit_label['singular'] ) ) {
|
|
$smart_coupon_type = ucwords( $store_credit_label['singular'] );
|
|
}
|
|
|
|
$coupon_type = ( 'smart_coupon' === $discount_type && ! empty( $smart_coupon_type ) ) ? $smart_coupon_type : __( 'coupon', 'woocommerce-smart-coupons' );
|
|
|
|
return $coupon_type;
|
|
}
|
|
|
|
/**
|
|
* Function to update SC admin email settings when WC email settings get updated
|
|
*/
|
|
public function process_admin_options() {
|
|
// Save regular options.
|
|
parent::process_admin_options();
|
|
|
|
$is_email_enabled = $this->get_field_value( 'enabled', $this->form_fields['enabled'] );
|
|
|
|
if ( ! empty( $is_email_enabled ) ) {
|
|
update_option( 'smart_coupons_is_send_email', $is_email_enabled, 'no' );
|
|
}
|
|
}
|
|
|
|
}
|
|
}
|