includes/notifications/views/class.llms.notification.view.subscription.cancelled.php
<?php
/**
* Notification View: Student Welcome.
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.17.8
* @version 5.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Purchase Receipt.
*
* @since 3.17.8
*/
class LLMS_Notification_View_Subscription_Cancelled extends LLMS_Abstract_Notification_View {
/**
* Notification Trigger ID.
*
* @var string
*/
public $trigger_id = 'subscription_cancelled';
/**
* Setup body content for output.
*
* @since 3.17.8
*
* @return string
*/
protected function set_body() {
return sprintf(
__( '%1$s has cancelled their subscription (#%2$s) to the %3$s %4$s', 'lifterlms' ),
'{{CUSTOMER_NAME}}',
'{{ORDER_ID}}',
'{{PRODUCT_TYPE}}',
'{{PRODUCT_TITLE_LINK}}'
);
}
/**
* Setup footer content for output.
*
* @since 3.17.8
*
* @return string
*/
protected function set_footer() {
return '';
}
/**
* Setup notification icon for output.
*
* @since 3.17.8
*
* @return string
*/
protected function set_icon() {
return '';
}
/**
* Setup merge codes that can be used with the notification.
*
* @since 3.17.8
*
* @return array
*/
protected function set_merge_codes() {
return array(
'{{CUSTOMER_NAME}}' => __( 'Customer Name', 'lifterlms' ),
'{{ORDER_ID}}' => __( 'Order ID', 'lifterlms' ),
'{{PLAN_TITLE}}' => __( 'Plan Title', 'lifterlms' ),
'{{PRODUCT_TITLE}}' => __( 'Product Title', 'lifterlms' ),
'{{PRODUCT_TYPE}}' => __( 'Product Type', 'lifterlms' ),
'{{PRODUCT_TITLE_LINK}}' => __( 'Product Title (Link)', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values.
*
* @since 3.17.8
* @since 5.4.0 Account for deleted products.
*
* @param string $code The merge code to ge merged data for.
* @return string
*/
protected function set_merge_data( $code ) {
$order = $this->post;
switch ( $code ) {
case '{{CUSTOMER_NAME}}':
$code = $order->get_customer_name();
break;
case '{{ORDER_ID}}':
$code = $order->get( 'id' );
break;
case '{{PLAN_TITLE}}':
$code = $order->get( 'plan_title' );
break;
case '{{PRODUCT_TITLE}}':
$code = $order->get( 'product_title' );
break;
case '{{PRODUCT_TITLE_LINK}}':
$permalink = esc_url( get_permalink( $order->get( 'product_id' ) ) );
if ( $permalink ) {
$title = $this->set_merge_data( '{{PRODUCT_TITLE}}' );
$code = '<a href="' . $permalink . '">' . $title . '</a>';
}
break;
case '{{PRODUCT_TYPE}}':
$obj = $order->get_product();
if ( empty( $obj ) ) {
$code = __( '[DELETED ITEM]', 'lifterlms' );
} elseif ( is_a( $obj, 'WP_Post' ) ) {
$code = _x( 'Item', 'generic product type description', 'lifterlms' );
} else {
$code = $obj->get_post_type_label( 'singular_name' );
}
break;
}
return $code;
}
/**
* Setup notification subject for output.
*
* @since 3.17.8
*
* @return string
*/
protected function set_subject() {
return esc_html__( 'Subscription Cancellation Notice', 'lifterlms' );
}
/**
* Setup notification title for output.
*
* @since 3.17.8
*
* @return string
*/
protected function set_title() {
return sprintf( esc_html__( '%1$s subscription cancellation', 'lifterlms' ), '{{PRODUCT_TYPE}}' );
}
}