title = __('WooCommerce', 'notificationx');
$this->module_title = __('WooCommerce', 'notificationx');
$this->templates = Conversions::get_instance()->templates;
$this->templates['woo_template_new']['third_param']['product_title_raw'] = __('Product Title Raw', 'notificationx');
$this->templates['woo_template_sales_count']['third_param']['product_title_raw'] = __('Product Title Raw', 'notificationx');
}
public function init(){
parent::init();
add_action('woocommerce_order_status_changed', array($this, 'status_transition'), 10, 4);
add_action('woocommerce_process_shop_order_meta', array( $this, 'manual_order'), 10, 2 );
add_action('woocommerce_new_order_item', array($this, 'save_new_orders'), 10, 3);
add_filter("nx_entry_show_on_frontend_{$this->id}", [$this, 'entry_display'], 10, 3);
}
/**
* This function is responsible for checking if the product is published or not.
*
* @param boolean $data
* @param array $post
* @param array $entry
* @return boolean
*/
public function entry_display($data, $post, $entry) {
$product_id = $post['product_id'];
if ( empty($product_id) ) {
return true;
}
$product = wc_get_product($product_id);
if ( ! $product ) {
return true;
}
if ( $product->get_status() !== 'publish' ) {
return true;
}
return false;
}
public function init_fields(){
parent::init_fields();
add_filter('nx_link_types', [$this, 'link_types']);
add_filter( 'nx_woo_order_status', array( $this, 'order_status' ), 11 );
$this->_init_fields();
}
/**
* This functions is hooked
*
* @return void
*/
public function admin_actions() {
parent::admin_actions();
add_filter("nx_can_entry_{$this->id}", array($this, 'check_order_status'), 10, 3);
add_filter("nx_can_entry_{$this->id}", array($this->get_type(), 'nx_can_entry'), 10, 3);
}
public function public_actions(){
parent::public_actions();
add_filter("nx_filtered_data_{$this->id}", array($this, 'multiorder_combine'), 11, 3);
}
public function wpml_actions(){
add_filter("nx_filtered_entry_{$this->id}", array($this, 'wpml_translate'), 11, 2);
add_filter("nx_notification_link_{$this->id}", [$this, 'product_link'], 10, 3);
}
public function source_error_message($messages) {
if (!$this->class_exists()) {
$url = admin_url('plugin-install.php?s=woocommerce&tab=search&type=term');
$messages[$this->id] = [
'message' => sprintf( '%s %s %s',
__( 'You have to install', 'notificationx' ),
$url,
__( 'WooCommerce', 'notificationx' ),
__( 'plugin first.', 'notificationx' )
),
'html' => true,
'type' => 'error',
'rules' => Rules::is('source', $this->id),
];
}
return $messages;
}
public function order_status($options){
if(function_exists('wc_get_order_statuses')){
$options = GlobalFields::get_instance()->normalize_fields(wc_get_order_statuses(), 'source', $this->id, $options);
}
return $options;
}
/**
* Adds option to Link Type field in Content tab.
*
* @param array $options
* @return array
*/
public function link_types($options) {
$options = GlobalFields::get_instance()->normalize_fields([
'product_page' => __('Product Page', 'notificationx'),
], 'source', $this->id, $options);
return $options;
}
public function saved_post($post, $data, $nx_id) {
$this->delete_notification(null, $nx_id);
$this->get_notification_ready($data);
}
/**
* This function is responsible for making the notification ready for first time we make the notification.
*
* @param string $type
* @param array $data
* @return void
*/
public function get_notification_ready($post = array()) {
if (!is_null($orders = $this->get_orders($post))) {
// $orders = Helper::sortBy($orders, 'woocommerce');
$entries = [];
foreach ($orders as $key => $order) {
$entries[] = [
'nx_id' => $post['nx_id'],
'source' => $this->id,
'entry_key' => $key,
'data' => $order,
// 'updated_at' => Helper::mysql_time($order['timestamp']),
];
}
$this->update_notifications($entries);
}
return $orders;
}
/**
* It will generate and save a notification
* when orders are placed.
*
* @param int $item_id
* @param WC_Order_Item_Product $item
* @param int $order_id
* @return void
*/
public function save_new_orders($item_id, $item, $order_id) {
$single_notification = $this->ordered_product($item_id, $item, $order_id);
if (!empty($single_notification)) {
$key = $order_id . '-' . $item_id;
$this->save([
'source' => $this->id,
'entry_key' => $key,
'data' => $single_notification,
]);
return true;
}
return false;
}
public function status_transition($id, $from, $to, $order) {
$has_course = false;
$from = "wc-$from";
$to = "wc-$to";
$items = $order->get_items();
$posts = PostType::get_instance()->get_posts([
'source' => $this->id,
'enabled' => true,
]);
if (!empty($posts)) {
foreach ($posts as $post) {
$done = !empty($post['order_status']) ? $post['order_status'] : ['wc-completed', 'wc-processing'];
$status = array_keys(wc_get_order_statuses());
$status = array_diff($status, $done);
$status[] = 'wcf-main-order';
foreach ($items as $item) {
$key = $id . '-' . $item->get_id();
if (function_exists('tutor_utils')) {
$has_course = tutor_utils()->product_belongs_with_course($item->get_product_id());
}
if ($has_course) {
continue;
}
if (in_array($from, $done) && in_array($to, $status)) {
$this->delete_notification($key);
}
if (in_array($from, $status) && in_array($to, $done)) {
$single_notification = $this->ordered_product($item->get_id(), $item, $order);
if (!empty($single_notification)) {
$this->update_notification([
'nx_id' => $post['nx_id'],
'source' => $this->id,
'entry_key' => $key,
'data' => $single_notification,
], false);
}
}
}
}
}
return true;
}
// define the manual_order callback
public function manual_order( $order_id, $post ){
$orders = [];
$order = wc_get_order($order_id);
$items = $order->get_items();
foreach( $items as $item ) {
$tutor_product = metadata_exists('post', $item->get_product_id(), "_tutor_product");
if($tutor_product ) {
continue;
}
$order_item = $this->ordered_product($item->get_id(), $item, $order);
if($order_item){
$this->save([
'source' => $this->id,
'entry_key' => $order->get_id() . '-' . $item->get_id(),
'data' => $order_item,
], false);
}
}
}
/**
* This function is responsible for making ready the orders data.
*
* @param int $item_id
* @param \WC_Order_Item_Product $item
* @param int $order_id
* @return void
*/
public function ordered_product($item_id, $item, $order_id) {
if (!$item instanceof \WC_Order_Item_Product) {
return false;
}
$product = wc_get_product( $item->get_product_id() );
if( empty( $product ) ) {
return false;
}
$if_has_course = false;
if (function_exists('tutor_utils')) {
$if_has_course = tutor_utils()->product_belongs_with_course($item->get_product_id());
}
if ($if_has_course) {
return false;
}
$new_order = [];
if (is_int($order_id)) {
$order = new \WC_Order($order_id);
} else {
$order = $order_id;
}
if (!$order instanceof \WC_Order) {
return false;
}
$new_order['status'] = 'wc-' . $order->get_status();
$date = $order->get_date_created();
$countries = new \WC_Countries();
$shipping_country = $order->get_billing_country();
if (empty($shipping_country)) {
$shipping_country = $order->get_shipping_country();
}
if (!empty($shipping_country)) {
$new_order['country'] = isset($countries->countries[$shipping_country]) ? $countries->countries[$shipping_country] : '';
$billing_state = $order->get_billing_state();
if (!empty($billing_state)) {
$new_order['state'] = isset($countries->states[$shipping_country], $countries->states[$shipping_country][$billing_state]) ? $countries->states[$shipping_country][$billing_state] : $billing_state;
}else {
$shipping_state = $order->get_shipping_state();
if (!empty($shipping_state)) {
$new_order['state'] = isset($countries->states[$shipping_country], $countries->states[$shipping_country][$shipping_state]) ? $countries->states[$shipping_country][$shipping_state] : $shipping_state;
}
}
}
$new_order['city'] = $order->get_billing_city();
if (empty($new_order['city'])) {
$new_order['city'] = $order->get_shipping_city();
}
$new_order['ip'] = $order->get_customer_ip_address();
$product_data = $this->ready_product_data($item->get_data());
if (!empty($product_data)) {
$new_order['order_id'] = is_int($order_id) ? $order_id : $order_id->get_id();
$product = $item->get_product();
if ( isset($product) && $product->get_type() === 'variation' ) {
$new_order['var_product_id'] = $item->get_variation_id();
}
$new_order['product_id'] = $item->get_product_id();
$new_order['title'] = strip_tags($product_data['title']);
$new_order['link'] = $product_data['link'];
}
if($date && method_exists($date, 'getTimestamp')){
$new_order['timestamp'] = $date->getTimestamp();
}
else{
$new_order['timestamp'] = time();
}
return array_merge($new_order, $this->buyer($order));
}
/**
* It will take an array to make data clean
*
* @param array $data
* @return void
*/
protected function ready_product_data($data) {
if (empty($data)) {
return;
}
$product = wc_get_product( $data['product_id'] );
if( empty( $product ) ) {
return;
}
return array(
'title' => $data['name'],
'product_name' => $product ? $product->get_name() : $data['name'],
'link' => get_permalink($data['product_id']),
);
}
/**
* This function is responsible for getting
* the buyer name from order.
*
* @param WC_Order $order
* @return void
*/
protected function buyer(\WC_Order $order) {
$first_name = $last_name = $email = '';
$buyer_data = [];
if (empty($first_name)) {
$first_name = $order->get_billing_first_name();
}
if (empty($last_name)) {
$last_name = $order->get_billing_last_name();
}
if (empty($email)) {
$email = $order->get_billing_email();
}
$buyer_data['first_name'] = $first_name;
$buyer_data['last_name'] = $last_name;
$buyer_data['name'] = $first_name . ' ' . mb_substr($last_name, 0, 1);
$buyer_data['email'] = $email;
return $buyer_data;
}
/**
* Get all the orders from database using a date query
* for limitation.
*
* @param array $data
* @return array
*/
public function get_orders($data = array()) {
if (empty($data) || !function_exists('wc_get_orders')) return null;
$orders = [];
$time = Helper::generate_time_string($data);
$from = strtotime(date('Y-m-d h:i', $time));
$status = !empty($data['order_status']) ? $data['order_status'] : ['wc-completed', 'wc-processing'];
$wc_orders = \wc_get_orders([
'status' => $status,
'date_created' => '>' . $from,
'numberposts' => isset($data['display_last']) ? intval($data['display_last']) : 10,
]);
foreach ($wc_orders as $order) {
$items = $order->get_items();
foreach ($items as $item) {
$tutor_product = metadata_exists('post', $item->get_product_id(), "_tutor_product");
if ($tutor_product) {
continue;
}
$orders[$order->get_id() . '-' . $item->get_id()] = $this->ordered_product($item->get_id(), $item, $order);
}
}
return $orders;
}
/**
* Limit entry by selected status;
*
* @param bool $return
* @param array $entry
* @param array $settings
* @return boolean
*/
public function check_order_status($return, $entry, $settings){
$done = !empty($settings['order_status']) ? $settings['order_status'] : ['wc-completed', 'wc-processing'];
if(!in_array($entry['data']['status'], $done)){
return false;
}
return $return;
}
public function wpml_translate($entry, $settings) {
if(!empty($entry['product_id'])){
$product_id = apply_filters( 'wpml_object_id', $entry['product_id'], 'product', false);
$product = wc_get_product($product_id);
if($product){
// $current_lang = apply_filters( 'wpml_current_language', NULL );
$entry['product_id'] = $product_id;
$entry['title'] = $product->get_name();
}
}
return $entry;
}
public function product_link($link, $post, $entry) {
if(!empty($entry['product_id']) && !empty( $post['link_type'] ) && $post['link_type'] === 'product_page' ){
$link = get_permalink($entry['product_id']);
}
return $link;
}
public function multiorder_combine($data, $settings) {
$should_combine = apply_filters('nx_should_combine', true, $data, $settings);
if (!$should_combine || empty($settings['combine_multiorder']) || intval($settings['combine_multiorder']) != 1 ) {
return $data;
}
$items = [];
$item_counts = [];
foreach ($data as $key => $item) {
$order_id = isset( $item['order_id'] ) ? $item['order_id'] : ( isset( $item['id'] ) ? $item['id'] : null );
if( $order_id === null ) {
continue;
}
if (!isset($items[$order_id])) {
$items[$order_id] = $item;
} else {
$item_counts[$order_id] = isset($item_counts[$order_id]) ? ++$item_counts[$order_id] : 1;
}
}
$products_more_title = isset($settings['combine_multiorder_text']) && !empty($settings['combine_multiorder_text']) ? __($settings['combine_multiorder_text'], 'notificationx') : __('more products', 'notificationx');
foreach ($item_counts as $key => $item) {
// translators: %1$s: title, %2$s: number of product, %3$s: Combine Multi Order Text.
$items[$key]['title'] = sprintf(__('%1$s & %2$s %3$s', 'notificationx'), $items[$key]['title'], $item, $products_more_title);
}
// @todo maybe sort
return $items;
}
/**
* Image action callback
* @param array $image_data
* @param array $data
* @param stdClass $settings
* @return array
*/
public function notification_image($image_data, $data, $settings) {
if (!$settings['show_default_image'] && $settings['show_notification_image'] === 'featured_image') {
$id = $this->product_img_id( $data );
if ( ! empty( $id ) ) {
$image_size = (string) Settings::get_instance()->get('settings.notification_image_size', '100_100');
$image_size = explode('_', $image_size);
$width = 100;
$height = 100;
if( !empty( $image_size[0] ) && !empty( $image_size[1] ) ) {
$width = !empty($image_size[0]) ? $image_size[0] : 100;
$height = !empty( $image_size[1] ) ? $image_size[1] : 100;
}
$product_image = wp_get_attachment_image_src(
get_post_thumbnail_id($id),
[$width, $height],
false
);
$image_data['url'] = is_array($product_image) ? $product_image[0] : '';
}
}
return $image_data;
}
private function product_img_id( $data ) {
if (!empty($data['var_product_id']) && has_post_thumbnail($data['var_product_id'])) {
return $data['var_product_id'];
} elseif (!empty($data['product_id']) && has_post_thumbnail($data['product_id'])) {
return $data['product_id'];
}
}
public function fallback_data($data, $entry) {
$data['name'] = __('Someone', 'notificationx');
$data['first_name'] = __('Someone', 'notificationx');
$data['last_name'] = __('Someone', 'notificationx');
$data['anonymous_title'] = __('Anonymous Product', 'notificationx');
if(empty($entry['product_title']) && !empty($entry['title'])){
$data['product_title'] = $entry['title'];
}
return $data;
}
public function doc(){
return sprintf(__('Make sure that you have WooCommerce installed & activated to use this campaign. For further assistance, check out our step by step documentation.
🎦 Watch video tutorial to learn quickly
⭐ NotificationX Integration with WooCommerce
Recommended Blog:
🔥 Why NotificationX is The Best FOMO and Social Proof Plugin for WooCommerce?
🚀 How to boost WooCommerce Sales Using NotificationX
', 'notificationx'),
'https://wordpress.org/plugins/woocommerce/',
'https://notificationx.com/docs/woocommerce-sales-notifications/',
'https://www.youtube.com/watch?v=dVthd36hJ-E&t=1s',
'https://notificationx.com/integrations/woocommerce/',
'https://notificationx.com/blog/best-fomo-and-social-proof-plugin-for-woocommerce/'
);
}
}