woocommerce/includes/emails/class-wc-email-customer-ref...

274 lines
7.9 KiB
PHP
Raw Normal View History

2015-03-20 15:31:31 +00:00
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
2017-02-16 11:46:01 +00:00
if ( ! class_exists( 'WC_Email_Customer_Refunded_Order', false ) ) :
2015-03-20 15:31:31 +00:00
/**
2015-11-03 13:31:20 +00:00
* Customer Refunded Order Email.
2015-03-20 15:31:31 +00:00
*
* Order refunded emails are sent to the customer when the order is marked refunded.
*
2015-03-20 15:37:16 +00:00
* @class WC_Email_Customer_Refunded_Order
2015-03-20 16:55:50 +00:00
* @version 2.4.0
2015-03-20 15:37:16 +00:00
* @package WooCommerce/Classes/Emails
2015-03-20 15:37:57 +00:00
* @author WooThemes
2015-03-20 15:37:16 +00:00
* @extends WC_Email
2015-03-20 15:31:31 +00:00
*/
class WC_Email_Customer_Refunded_Order extends WC_Email {
/**
* Refund order.
*
2016-06-06 17:57:24 +00:00
* @var WC_Order|bool
*/
public $refund;
/**
* Is the order partial refunded?
*
* @var bool
*/
public $partial_refund;
2015-03-20 15:31:31 +00:00
/**
2015-11-03 13:31:20 +00:00
* Constructor.
2015-03-20 15:31:31 +00:00
*/
public function __construct() {
$this->customer_email = true;
$this->id = 'customer_refunded_order';
$this->title = __( 'Refunded order', 'woocommerce' );
$this->description = __( 'Order refunded emails are sent to customers when their orders are refunded.', 'woocommerce' );
$this->template_html = 'emails/customer-refunded-order.php';
$this->template_plain = 'emails/plain/customer-refunded-order.php';
2015-03-20 15:31:31 +00:00
// Triggers for this email
add_action( 'woocommerce_order_fully_refunded_notification', array( $this, 'trigger_full' ), 10, 2 );
add_action( 'woocommerce_order_partially_refunded_notification', array( $this, 'trigger_partial' ), 10, 2 );
2015-03-20 15:31:31 +00:00
// Call parent constuctor
parent::__construct();
}
/**
* Get email subject.
*
* @since 3.1.0
* @return string
*/
public function get_default_subject( $partial = false ) {
if ( $partial ) {
return __( 'Your {site_title} order from {order_date} has been partially refunded', 'woocommerce' );
} else {
return __( 'Your {site_title} order from {order_date} has been refunded', 'woocommerce' );
}
}
/**
* Get email heading.
*
* @since 3.1.0
* @return string
*/
public function get_default_heading( $partial = false ) {
if ( $partial ) {
return __( 'Order {order_number} details', 'woocommerce' );
} else {
return __( 'Your order has been partially refunded', 'woocommerce' );
}
}
/**
* Get email subject.
*
* @access public
* @return string
*/
public function get_subject() {
if ( $this->partial_refund ) {
$subject = $this->get_option( 'subject_partial', $this->get_default_subject( true ) );
} else {
$subject = $this->get_option( 'subject_full', $this->get_default_heading() );
}
return apply_filters( 'woocommerce_email_subject_customer_refunded_order', $this->format_string( $subject ), $this->object );
}
/**
* Get email heading.
*
* @access public
* @return string
*/
public function get_heading() {
if ( $this->partial_refund ) {
$heading = $this->get_option( 'heading_partial', $this->get_default_heading( true ) );
} else {
$heading = $this->get_option( 'heading_full', $this->get_default_heading() );
}
return apply_filters( 'woocommerce_email_heading_customer_refunded_order', $this->format_string( $heading ), $this->object );
}
/**
* Set email strings.
* @deprecated 3.1.0 Unused.
*/
public function set_email_strings( $partial_refund = false ) {}
2015-03-20 15:31:31 +00:00
/**
2015-11-03 13:31:20 +00:00
* Full refund notification.
*
* @param int $order_id
* @param int $refund_id
2015-03-20 15:31:31 +00:00
*/
public function trigger_full( $order_id, $refund_id = null ) {
$this->trigger( $order_id, false, $refund_id );
}
2015-03-20 15:31:31 +00:00
/**
2015-11-03 13:31:20 +00:00
* Partial refund notification.
*
* @param int $order_id
* @param int $refund_id
*/
public function trigger_partial( $order_id, $refund_id = null ) {
$this->trigger( $order_id, true, $refund_id );
}
/**
* Trigger.
*
* @param int $order_id
* @param bool $partial_refund
* @param int $refund_id
*/
public function trigger( $order_id, $partial_refund = false, $refund_id = null ) {
$this->partial_refund = $partial_refund;
$this->id = $this->partial_refund ? 'customer_partially_refunded_order' : 'customer_refunded_order';
2015-03-20 15:31:31 +00:00
if ( $order_id ) {
2015-03-20 15:37:16 +00:00
$this->object = wc_get_order( $order_id );
2016-08-05 15:11:23 +00:00
$this->recipient = $this->object->get_billing_email();
2015-03-20 15:31:31 +00:00
$this->find['order-date'] = '{order_date}';
$this->find['order-number'] = '{order_number}';
2017-03-10 16:29:15 +00:00
$this->replace['order-date'] = wc_format_datetime( $this->object->get_date_created() );
2015-03-20 15:31:31 +00:00
$this->replace['order-number'] = $this->object->get_order_number();
}
2016-06-06 17:57:24 +00:00
if ( ! empty( $refund_id ) ) {
$this->refund = wc_get_order( $refund_id );
} else {
$this->refund = false;
}
2015-03-20 15:31:31 +00:00
if ( ! $this->is_enabled() || ! $this->get_recipient() ) {
return;
}
$this->setup_locale();
2015-03-20 15:31:31 +00:00
$this->send( $this->get_recipient(), $this->get_subject(), $this->get_content(), $this->get_headers(), $this->get_attachments() );
$this->restore_locale();
2015-03-20 15:31:31 +00:00
}
/**
* Get content html.
2015-03-20 15:31:31 +00:00
*
* @access public
* @return string
*/
public function get_content_html() {
2015-12-04 13:39:57 +00:00
return wc_get_template_html( $this->template_html, array(
'order' => $this->object,
'refund' => $this->refund,
'partial_refund' => $this->partial_refund,
'email_heading' => $this->get_heading(),
'sent_to_admin' => false,
'plain_text' => false,
'email' => $this,
2015-03-20 15:31:31 +00:00
) );
}
/**
2015-07-16 19:55:48 +00:00
* Get content plain.
2015-03-20 15:31:31 +00:00
*
* @return string
*/
public function get_content_plain() {
2015-12-04 13:39:57 +00:00
return wc_get_template_html( $this->template_plain, array(
'order' => $this->object,
'refund' => $this->refund,
'partial_refund' => $this->partial_refund,
'email_heading' => $this->get_heading(),
'sent_to_admin' => false,
'plain_text' => true,
'email' => $this,
2015-03-20 15:31:31 +00:00
) );
}
/**
2015-07-16 19:55:48 +00:00
* Initialise settings form fields.
2015-03-20 15:31:31 +00:00
*/
public function init_form_fields() {
2015-03-20 15:31:31 +00:00
$this->form_fields = array(
'enabled' => array(
2015-03-20 15:37:16 +00:00
'title' => __( 'Enable/Disable', 'woocommerce' ),
'type' => 'checkbox',
'label' => __( 'Enable this email notification', 'woocommerce' ),
'default' => 'yes',
2015-03-20 15:31:31 +00:00
),
'subject_full' => array(
'title' => __( 'Full refund subject', 'woocommerce' ),
2015-03-20 15:37:16 +00:00
'type' => 'text',
'desc_tip' => true,
/* translators: %s: list of placeholders */
'description' => sprintf( __( 'Available placeholders: %s', 'woocommerce' ), '<code>{site_title}, {order_date}, {order_number}</code>' ),
'placeholder' => $this->get_default_subject(),
'default' => '',
),
'subject_partial' => array(
'title' => __( 'Partial refund subject', 'woocommerce' ),
'type' => 'text',
'desc_tip' => true,
/* translators: %s: list of placeholders */
'description' => sprintf( __( 'Available placeholders: %s', 'woocommerce' ), '<code>{site_title}, {order_date}, {order_number}</code>' ),
'placeholder' => $this->get_default_subject( true ),
'default' => '',
),
'heading_full' => array(
'title' => __( 'Full refund email heading', 'woocommerce' ),
'type' => 'text',
'desc_tip' => true,
/* translators: %s: list of placeholders */
'description' => sprintf( __( 'Available placeholders: %s', 'woocommerce' ), '<code>{site_title}, {order_date}, {order_number}</code>' ),
'placeholder' => $this->get_default_heading(),
'default' => '',
2015-03-20 15:31:31 +00:00
),
'heading_partial' => array(
'title' => __( 'Partial refund email heading', 'woocommerce' ),
2015-03-20 15:37:16 +00:00
'type' => 'text',
'desc_tip' => true,
/* translators: %s: list of placeholders */
'description' => sprintf( __( 'Available placeholders: %s', 'woocommerce' ), '<code>{site_title}, {order_date}, {order_number}</code>' ),
'placeholder' => $this->get_default_heading( true ),
'default' => '',
2015-03-20 15:31:31 +00:00
),
'email_type' => array(
'title' => __( 'Email type', 'woocommerce' ),
2015-03-20 15:37:16 +00:00
'type' => 'select',
'description' => __( 'Choose which format of email to send.', 'woocommerce' ),
'default' => 'html',
'class' => 'email_type wc-enhanced-select',
2015-11-03 14:59:48 +00:00
'options' => $this->get_email_type_options(),
'desc_tip' => true,
),
2015-03-20 15:31:31 +00:00
);
}
}
endif;
return new WC_Email_Customer_Refunded_Order();