Files
woocommerce-subscriptions/includes/core/emails/class-wcs-email-completed-switch-order.php
2025-08-20 10:17:55 +00:00

176 lines
5.4 KiB
PHP

<?php
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
/**
* Customer Completed Switch Order Email
*
* Order switch email sent to customer when a subscription is switched successfully.
*
* @class WCS_Email_Completed_Switch_Order
* @version 1.0.0 - Migrated from WooCommerce Subscriptions v2.0.0
* @package WooCommerce/Classes/Emails
* @author Prospress
* @extends WC_Email
*/
class WCS_Email_Completed_Switch_Order extends WC_Email_Customer_Completed_Order {
/**
* @var array Subscriptions linked to the switch order.
*/
public $subscriptions;
/**
* Constructor
*/
function __construct() {
// Call override values
$this->id = 'customer_completed_switch_order';
$this->title = __( 'Subscription Switch Complete', 'woocommerce-subscriptions' );
$this->description = __( 'Subscription switch complete emails are sent to the customer when a subscription is switched successfully.', 'woocommerce-subscriptions' );
$this->customer_email = true;
$this->heading = __( 'Your subscription change is complete', 'woocommerce-subscriptions' );
$this->subject = __( 'Your {site_title} subscription change from {order_date} is complete', 'woocommerce-subscriptions' );
$this->template_html = 'emails/customer-completed-switch-order.php';
$this->template_plain = 'emails/plain/customer-completed-switch-order.php';
$this->template_base = WC_Subscriptions_Plugin::instance()->get_plugin_directory( 'templates/' );
// Triggers for this email
add_action( 'woocommerce_subscriptions_switch_completed_switch_notification', array( $this, 'trigger' ) );
// We want most of the parent's methods, with none of its properties, so call its parent's constructor
WC_Email::__construct();
}
/**
* Get the default e-mail subject.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.5.3
* @return string
*/
public function get_default_subject() {
return $this->subject;
}
/**
* Get the default e-mail heading.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.5.3
* @return string
*/
public function get_default_heading() {
return $this->heading;
}
/**
* trigger function.
*
* We need to override WC_Email_Customer_Completed_Order's trigger method because it expects to be run only once
* per request (but multiple subscription switch orders can be generated per request).
*
* @access public
* @return void
*/
function trigger( $order_id, $order = null ) {
if ( $order_id ) {
$this->object = wc_get_order( $order_id );
$this->recipient = wcs_get_objects_property( $this->object, 'billing_email' );
$order_date_index = array_search( '{order_date}', $this->find );
if ( false === $order_date_index ) {
$this->find['order_date'] = '{order_date}';
$this->replace['order_date'] = wcs_format_datetime( wcs_get_objects_property( $this->object, 'date_created' ) );
} else {
$this->replace[ $order_date_index ] = wcs_format_datetime( wcs_get_objects_property( $this->object, 'date_created' ) );
}
$order_number_index = array_search( '{order_number}', $this->find );
if ( false === $order_number_index ) {
$this->find['order_number'] = '{order_number}';
$this->replace['order_number'] = $this->object->get_order_number();
} else {
$this->replace[ $order_number_index ] = $this->object->get_order_number();
}
$this->subscriptions = wcs_get_subscriptions_for_switch_order( $this->object );
}
if ( ! $this->is_enabled() || ! $this->get_recipient() ) {
return;
}
$this->send( $this->get_recipient(), $this->get_subject(), $this->get_content(), $this->get_headers(), $this->get_attachments() );
}
/**
* get_subject function.
*
* @access public
* @return string
*/
function get_subject() {
return apply_filters( 'woocommerce_subscriptions_email_subject_customer_completed_switch_order', parent::get_subject(), $this->object );
}
/**
* get_heading function.
*
* @access public
* @return string
*/
function get_heading() {
return apply_filters( 'woocommerce_email_heading_customer_switch_order', parent::get_heading(), $this->object );
}
/**
* get_content_html function.
*
* @access public
* @return string
*/
function get_content_html() {
return wc_get_template_html(
$this->template_html,
array(
'order' => $this->object,
'subscriptions' => $this->subscriptions,
'email_heading' => $this->get_heading(),
'additional_content' => is_callable( array( $this, 'get_additional_content' ) ) ? $this->get_additional_content() : '', // WC 3.7 introduced an additional content field for all emails.
'sent_to_admin' => false,
'plain_text' => false,
'email' => $this,
),
'',
$this->template_base
);
}
/**
* get_content_plain function.
*
* @access public
* @return string
*/
function get_content_plain() {
return wc_get_template_html(
$this->template_plain,
array(
'order' => $this->object,
'subscriptions' => $this->subscriptions,
'email_heading' => $this->get_heading(),
'additional_content' => is_callable( array( $this, 'get_additional_content' ) ) ? $this->get_additional_content() : '', // WC 3.7 introduced an additional content field for all emails.
'sent_to_admin' => false,
'plain_text' => true,
'email' => $this,
),
'',
$this->template_base
);
}
}