event_merge_tag_groups = array( 'bwf_contact', 'wc_subscription' );
$this->event_name = esc_html__( 'Subscriptions Status Changed', 'wp-marketing-automations-pro' );
$this->event_desc = esc_html__( 'This event runs after a subscription status is changed.', 'wp-marketing-automations-pro' );
$this->event_rule_groups = array(
'wc_subscription',
'wc_customer',
'bwf_contact_segments',
'bwf_contact',
'bwf_contact_fields',
'bwf_contact_user',
'bwf_contact_wc',
'bwf_contact_geo',
'bwf_engagement',
'bwf_broadcast'
);
$this->optgroup_label = esc_html__( 'Subscription', 'wp-marketing-automations-pro' );
$this->support_lang = true;
$this->priority = 25.1;
$this->v2 = true;
}
public static function get_instance() {
if ( null === self::$instance ) {
self::$instance = new self();
}
return self::$instance;
}
public function load_hooks() {
add_action( 'woocommerce_subscription_status_updated', [ $this, 'subscription_status_changed' ], 11, 3 );
}
/**
* Localize data for html fields for the current event.
*/
public function admin_enqueue_assets() {
if ( BWFAN_Common::is_load_admin_assets( 'automation' ) ) {
$integration_data = $this->get_view_data();
BWFAN_Core()->admin->set_events_js_data( $this->get_slug(), 'from_options', $integration_data );
BWFAN_Core()->admin->set_events_js_data( $this->get_slug(), 'to_options', $integration_data );
}
}
public function get_view_data() {
if ( ! function_exists( 'wcs_get_subscription_statuses' ) ) {
return array();
}
$all_status = wcs_get_subscription_statuses();
$all_status['wc-on-hold'] = __( 'On Hold / Suspend', 'wp-marketing-automations-pro' );
return $all_status;
}
/**
* Show the html fields for the current event.
*/
public function get_view( $db_eventmeta_saved_value ) {
?>
validate_subscription( $data );
}
/**
* v2 Method: Validate event settings
*
* @param $automation_data
*
* @return bool
*/
public function validate_v2_event_settings( $automation_data ) {
if ( ! isset( $automation_data['event_meta'] ) || empty( $automation_data['event_meta'] ) || ! is_array( $automation_data['event_meta'] ) ) {
return false;
}
$current_automation_status_from = ( isset( $automation_data['event_meta']['from'] ) ) ? $automation_data['event_meta']['from'] : 'wc-any';
$current_automation_status_to = ( isset( $automation_data['event_meta']['to'] ) ) ? $automation_data['event_meta']['to'] : 'wc-any';
$subscription_contains = ( isset( $automation_data['event_meta']['subscription-contains'] ) ) ? $automation_data['event_meta']['subscription-contains'] : 'any';
if ( 'wc-any' === $current_automation_status_from && 'wc-any' === $current_automation_status_to && ( empty( $subscription_contains ) || 'any' === $subscription_contains ) ) {
return true;
}
/** Specific product case */
if ( 'selected_product' === $subscription_contains ) {
$subscription = wcs_get_subscription( absint( $automation_data['wc_subscription_id'] ) );
$ordered_products = array();
foreach ( $subscription->get_items() as $subscription_product ) {
$ordered_products[] = $subscription_product->get_product_id();
/** In case variation */
if ( $subscription_product->get_variation_id() ) {
$ordered_products[] = $subscription_product->get_variation_id();
}
}
$ordered_products = array_unique( $ordered_products );
$get_selected_product = $automation_data['event_meta']['products'];
$product_selected = array_column( $get_selected_product, 'id' );
$check_products = count( array_intersect( $product_selected, $ordered_products ) );
/** No selected products found */
if ( $check_products <= 0 ) {
return false;
}
}
$order_status_from = 'wc-' . $automation_data['from_status'];
$order_status_to = 'wc-' . $automation_data['to_status'];
/** checking from any to any status */
if ( 'wc-any' === $current_automation_status_from && 'wc-any' === $current_automation_status_to ) {
return true;
}
/** checking any status to selected status */
if ( 'wc-any' === $current_automation_status_from ) {
return ( $order_status_to === $current_automation_status_to );
}
/** checking selected status to any status */
if ( 'wc-any' === $current_automation_status_to ) {
return ( $order_status_from === $current_automation_status_from );
}
/** checking selected status to selected status */
return ( ( $order_status_from === $current_automation_status_from ) && ( $order_status_to === $current_automation_status_to ) );
}
public function handle_single_automation_run( $value1, $automation_id ) {
$is_register_task = false;
$to_status = $this->to_status;
$from_status = $this->from_status;
$event_meta = $value1['event_meta'];
$from = str_replace( 'wc-', '', $event_meta['from'] );
$to = str_replace( 'wc-', '', $event_meta['to'] );
if ( 'any' === $from && 'any' === $to ) {
$is_register_task = true;
} elseif ( 'any' === $from && $to_status === $to ) {
$is_register_task = true;
} elseif ( $from_status === $from && 'any' === $to ) {
$is_register_task = true;
} elseif ( $from_status === $from && $to_status === $to ) {
$is_register_task = true;
}
if ( $is_register_task && function_exists( 'wcs_get_subscription_statuses' ) ) {
$all_statuses = wcs_get_subscription_statuses();
$value1['from'] = $all_statuses[ 'wc-' . $from_status ];
$value1['to'] = $all_statuses[ 'wc-' . $to_status ];
return parent::handle_single_automation_run( $value1, $automation_id );
}
return '';
}
public function subscription_status_changed( $subscription, $to_status, $from_status ) {
$subscription_id = $subscription->get_id();
$this->process( $subscription_id, $from_status, $to_status );
}
/**
* Make the required data for the current event and send it asynchronously.
*
* @param $subscription_id
* @param $from_status
* @param $to_status
*/
public function process( $subscription_id, $from_status, $to_status ) {
$data = $this->get_default_data();
$data['wc_subscription_id'] = $subscription_id;
$data['from_status'] = $from_status;
$data['to_status'] = $to_status;
$subscription = wcs_get_subscription( $subscription_id );
$data['email'] = $subscription->get_billing_email();
$this->send_async_call( $data );
}
/**
* Returns the current event settings set in the automation at the time of task creation.
*
* @param $value
*
* @return array
*/
public function get_automation_event_data( $value ) {
$event_meta = $value['event_meta'];
$event_data = [
'event_source' => $value['source'],
'event_slug' => $value['event'],
'validate_event' => ( isset( $value['event_meta']['validate_event'] ) ) ? 1 : 0,
'from_status' => $event_meta['from'],
'to_status' => $event_meta['to'],
'from' => isset( $value['from'] ) ? $value['from'] : '',
'to' => isset( $value['to'] ) ? $value['to'] : '',
];
return $event_data;
}
/**
* Registers the tasks for current event.
*
* @param $automation_id
* @param $integration_data
* @param $event_data
*/
public function register_tasks( $automation_id, $integration_data, $event_data ) {
if ( ! is_array( $integration_data ) ) {
return;
}
$data_to_send = $this->get_event_data();
$this->create_tasks( $automation_id, $integration_data, $event_data, $data_to_send );
}
public function get_event_data() {
$this->subscription = wcs_get_subscription( $this->subscription_id );
$user_id = $this->get_user_id_event();
$data_to_send = [ 'global' => [] ];
$data_to_send['global']['wc_subscription_id'] = $this->subscription_id;
$data_to_send['global']['wc_subscription'] = is_object( $this->subscription ) ? $this->subscription : '';
$data_to_send['global']['email'] = $this->email;
$data_to_send['from_status'] = $this->from_status;
$data_to_send['to_status'] = $this->to_status;
if ( intval( $user_id ) > 0 ) {
$data_to_send['global']['user_id'] = $user_id;
$email = BWFAN_PRO_Common::get_contact_email( $user_id );
if ( ! empty( $email ) ) {
$data_to_send['global']['email'] = $email;
}
}
return $data_to_send;
}
public function get_user_id_event() {
if ( $this->subscription instanceof WC_Subscription ) {
return $this->subscription->get_user_id();
}
return 0;
}
/**
* Make the view data for the current event which will be shown in task listing screen.
*
* @param $global_data
*
* @return false|string
*/
public function get_task_view( $global_data ) {
ob_start();
?>
get_automation_event_validation();
return $result;
}
// Current automation event does not match with the event of task when the task was made
if ( $task_event !== $current_automation_event ) {
$result = $this->get_automation_event_status();
return $result;
}
if ( ( $current_automation_status_from === $task_status_from ) && ( $current_automation_status_to === $task_status_to ) ) {
$result = $this->get_automation_event_success();
return $result;
}
$result['status'] = 4;
$result['message'] = __( 'Subscription Statuses in automation has been changed', 'wp-marketing-automations-pro' );
return $result;
}
/**
* Set global data for all the merge tags which are supported by this event.
*
* @param $task_meta
*/
public function set_merge_tags_data( $task_meta ) {
$subscription_id = BWFAN_Merge_Tag_Loader::get_data( 'wc_subscription_id' );
if ( ( empty( $subscription_id ) || intval( $subscription_id ) !== intval( $task_meta['global']['wc_subscription_id'] ) ) && function_exists( 'wcs_get_subscription' ) ) {
$set_data = array(
'wc_subscription_id' => intval( $task_meta['global']['wc_subscription_id'] ),
'email' => $task_meta['global']['email'],
'wc_order' => isset( $task_meta['global']['wc_order'] ) ? $task_meta['global']['wc_order'] : null,
'user_id' => $task_meta['global']['user_id'],
'wc_subscription' => $task_meta['global']['wc_subscription'],
);
BWFAN_Merge_Tag_Loader::set_data( $set_data );
}
}
/**
* Capture the async data for the current event.
* @return array|bool
*/
public function capture_async_data() {
if ( ! function_exists( 'wcs_get_subscription' ) ) {
return false;
}
$subscription_id = BWFAN_Common::$events_async_data['wc_subscription_id'];
$from_status = BWFAN_Common::$events_async_data['from_status'];
$to_status = BWFAN_Common::$events_async_data['to_status'];
$subscription = wcs_get_subscription( $subscription_id );
$this->subscription_id = $subscription_id;
$this->subscription = $subscription;
$this->from_status = $from_status;
$this->to_status = $to_status;
$this->email = BWFAN_Common::$events_async_data['email'];
return $this->run_automations();
}
/**
* Set up rules data
*
* @param $value
*/
public function pre_executable_actions( $value ) {
BWFAN_Core()->rules->setRulesData( $this->subscription, 'wc_subscription' );
BWFAN_Core()->rules->setRulesData( $this->from_status, 'wcs_old_status' );
BWFAN_Core()->rules->setRulesData( $this->event_automation_id, 'automation_id' );
BWFAN_Core()->rules->setRulesData( BWFAN_Common::get_bwf_customer( $this->get_email_event(), $this->get_user_id_event() ), 'bwf_customer' );
}
public function get_email_event() {
return $this->subscription->get_billing_email();
}
/**
* v2 Capture the async data for the current event.
*
* @return array|bool
*/
public function capture_v2_data( $automation_data ) {
if ( ! function_exists( 'wcs_get_subscription' ) ) {
return $automation_data;
}
$this->subscription_id = BWFAN_Common::$events_async_data['wc_subscription_id'];
$this->subscription = wcs_get_subscription( $this->subscription_id );
$this->from_status = BWFAN_Common::$events_async_data['from_status'];
$this->to_status = BWFAN_Common::$events_async_data['to_status'];
$this->email = BWFAN_Common::$events_async_data['email'];
$automation_data['wc_subscription_id'] = $this->subscription_id;
$automation_data['from_status'] = $this->from_status;
$automation_data['to_status'] = $this->to_status;
$automation_data['email'] = $this->to_status;
return $automation_data;
}
public function get_fields_schema() {
$default = [
[
'label' => __( 'Any', 'wp-marketing-automations-pro' ),
'value' => 'wc-any',
]
];
$options = BWFAN_PRO_Common::prepared_field_options( $this->get_view_data() );
$options = array_merge( $default, $options );
return [
[
'id' => 'from',
'label' => __( "Subscription Status From", 'wp-marketing-automations-pro' ),
'type' => 'wp_select',
'options' => $options,
'placeholder' => __( 'Choose from Status', 'wp-marketing-automations-pro' ),
"class" => 'bwfan-input-wrapper bwf-3-col-item',
'tip' => "",
"description" => "",
"required" => true,
"errorMsg" => __( "Status from is required.", 'wp-marketing-automations-pro' ),
],
[
'id' => 'to',
'label' => __( "Subscription Status To", 'wp-marketing-automations-pro' ),
'type' => 'wp_select',
'options' => $options,
'placeholder' => __( 'Choose to Status', 'wp-marketing-automations-pro' ),
"class" => 'bwfan-input-wrapper bwf-3-col-item',
'tip' => "",
"description" => "",
"required" => true,
"errorMsg" => __( "Status to is required.", 'wp-marketing-automations-pro' ),
],
[
'id' => 'subscription-contains',
'label' => __( 'Subscription Contains', 'wp-marketing-automations-pro' ),
'type' => 'radio',
'options' => [
[
'label' => __( 'Any Product', 'wp-marketing-automations-pro' ),
'value' => 'any'
],
[
'label' => __( 'Specific Products', 'wp-marketing-automations-pro' ),
'value' => 'selected_product'
],
],
"class" => 'bwfan-input-wrapper',
"tip" => "",
"required" => false,
"description" => ""
],
[
'id' => 'products',
'label' => __( 'Select Products', 'wp-marketing-automations-pro' ),
"type" => 'custom_search',
'autocompleterOption' => [
'path' => 'wcs_products',
'slug' => 'wcs_products',
'labelText' => 'WooCommerce Subscription products '
],
'class' => '',
'placeholder' => '',
'required' => true,
'toggler' => [
'fields' => [
[
'id' => 'subscription-contains',
'value' => 'selected_product',
]
]
],
],
];
}
public function get_default_values() {
return [
'from' => 'wc-any',
'to' => 'wc-any',
'subscription-contains' => 'any',
];
}
}
/**
* Register this event to a source.
* This will show the current event in dropdown in single automation screen.
*/
if ( bwfan_is_woocommerce_active() && bwfan_is_woocommerce_subscriptions_active() ) {
return 'BWFAN_WCS_Status_Changed';
}