jetpack
/
modules
/
woocommerce-analytics
/
classes
/
class-jetpack-woocommerce-analytics-checkout-flow.php
class-jetpack-woocommerce-analytics-checkout-flow.php
2 years ago
class-jetpack-woocommerce-analytics-my-account.php
2 years ago
class-jetpack-woocommerce-analytics-trait.php
2 years ago
class-jetpack-woocommerce-analytics-universal.php
2 years ago
class-jetpack-woocommerce-analytics-checkout-flow.php
205 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Jetpack_WooCommerce_Analytics_Checkout_Flow |
| 4 | * |
| 5 | * @deprecated 13.3 |
| 6 | * |
| 7 | * @package automattic/jetpack |
| 8 | * @author Automattic |
| 9 | */ |
| 10 | |
| 11 | /** |
| 12 | * Bail if accessed directly |
| 13 | */ |
| 14 | if ( ! defined( 'ABSPATH' ) ) { |
| 15 | exit; |
| 16 | } |
| 17 | |
| 18 | /** |
| 19 | * Class Jetpack_WooCommerce_Analytics_Checkout_Flow |
| 20 | * Class that handles all page view events for the checkout flow (from product view to order confirmation view) |
| 21 | * |
| 22 | * @deprecated 13.3 |
| 23 | */ |
| 24 | class Jetpack_WooCommerce_Analytics_Checkout_Flow { |
| 25 | |
| 26 | use Jetpack_WooCommerce_Analytics_Trait; |
| 27 | |
| 28 | /** |
| 29 | * Jetpack_WooCommerce_Analytics_Checkout_Flow constructor. |
| 30 | * |
| 31 | * @deprecated 13.3 |
| 32 | */ |
| 33 | public function __construct() { |
| 34 | $this->find_cart_checkout_content_sources(); |
| 35 | $this->additional_blocks_on_cart_page = $this->get_additional_blocks_on_page( 'cart' ); |
| 36 | $this->additional_blocks_on_checkout_page = $this->get_additional_blocks_on_page( 'checkout' ); |
| 37 | |
| 38 | // single product page view. |
| 39 | add_action( 'woocommerce_after_single_product', array( $this, 'capture_product_view' ) ); |
| 40 | |
| 41 | // order confirmed page view |
| 42 | add_action( 'woocommerce_thankyou', array( $this, 'capture_order_confirmation_view' ), 10, 1 ); |
| 43 | |
| 44 | // cart page view |
| 45 | add_action( 'wp_footer', array( $this, 'capture_cart_view' ) ); |
| 46 | |
| 47 | // checkout page view |
| 48 | add_action( 'wp_footer', array( $this, 'capture_checkout_view' ) ); |
| 49 | } |
| 50 | |
| 51 | /** |
| 52 | * Track a product page view |
| 53 | * |
| 54 | * @deprecated 13.3 |
| 55 | */ |
| 56 | public function capture_product_view() { |
| 57 | global $product; |
| 58 | if ( ! $product instanceof WC_Product ) { |
| 59 | return; |
| 60 | } |
| 61 | |
| 62 | $this->record_event( |
| 63 | 'woocommerceanalytics_product_view', |
| 64 | array(), |
| 65 | $product->get_id() |
| 66 | ); |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * Track the order confirmation page view |
| 71 | * |
| 72 | * @deprecated 13.3 |
| 73 | */ |
| 74 | public function capture_order_confirmation_view() { |
| 75 | $order_id = absint( get_query_var( 'order-received' ) ); |
| 76 | if ( ! $order_id ) { |
| 77 | return; |
| 78 | } |
| 79 | |
| 80 | if ( ! is_order_received_page() ) { |
| 81 | return; |
| 82 | } |
| 83 | |
| 84 | $order = wc_get_order( $order_id ); |
| 85 | |
| 86 | $order_source = $order->get_created_via(); |
| 87 | $checkout_page_contains_checkout_block = '0'; |
| 88 | $checkout_page_contains_checkout_shortcode = '0'; |
| 89 | |
| 90 | if ( 'store-api' === $order_source ) { |
| 91 | $checkout_page_contains_checkout_block = '1'; |
| 92 | $checkout_page_contains_checkout_shortcode = '0'; |
| 93 | } elseif ( 'checkout' === $order_source ) { |
| 94 | $checkout_page_contains_checkout_block = '0'; |
| 95 | $checkout_page_contains_checkout_shortcode = '1'; |
| 96 | } |
| 97 | |
| 98 | $coupons = $order->get_coupons(); |
| 99 | $coupon_used = 0; |
| 100 | if ( is_countable( $coupons ) ) { |
| 101 | $coupon_used = count( $coupons ) ? 1 : 0; |
| 102 | } |
| 103 | |
| 104 | if ( is_object( WC()->session ) ) { |
| 105 | $create_account = true === WC()->session->get( 'wc_checkout_createaccount_used' ) ? 'Yes' : 'No'; |
| 106 | $checkout_page_used = true === WC()->session->get( 'checkout_page_used' ) ? 'Yes' : 'No'; |
| 107 | } else { |
| 108 | $create_account = 'No'; |
| 109 | $checkout_page_used = 'No'; |
| 110 | } |
| 111 | |
| 112 | $this->record_event( |
| 113 | 'woocommerceanalytics_order_confirmation_view', |
| 114 | array( |
| 115 | 'coupon_used' => $coupon_used, |
| 116 | 'create_account' => $create_account, |
| 117 | 'express_checkout' => 'null', // TODO: not solved yet. |
| 118 | 'guest_checkout' => $order->get_customer_id() ? 'No' : 'Yes', |
| 119 | 'oi' => $order->get_id(), |
| 120 | 'order_value' => $order->get_total(), |
| 121 | 'payment_option' => $order->get_payment_method(), |
| 122 | 'products_count' => $order->get_item_count(), |
| 123 | 'products' => $this->format_items_to_json( $order->get_items() ), |
| 124 | 'order_note' => $order->get_customer_note(), |
| 125 | 'shipping_option' => $order->get_shipping_method(), |
| 126 | 'from_checkout' => $checkout_page_used, |
| 127 | 'checkout_page_contains_checkout_block' => $checkout_page_contains_checkout_block, |
| 128 | 'checkout_page_contains_checkout_shortcode' => $checkout_page_contains_checkout_shortcode, |
| 129 | ) |
| 130 | ); |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | * Track the cart page view |
| 135 | * |
| 136 | * @deprecated 13.3 |
| 137 | */ |
| 138 | public function capture_cart_view() { |
| 139 | if ( ! is_cart() ) { |
| 140 | return; |
| 141 | } |
| 142 | |
| 143 | $this->record_event( |
| 144 | 'woocommerceanalytics_cart_view', |
| 145 | array_merge( |
| 146 | $this->get_cart_checkout_shared_data(), |
| 147 | array() |
| 148 | ) |
| 149 | ); |
| 150 | } |
| 151 | |
| 152 | /** |
| 153 | * Track the checkout page view |
| 154 | * |
| 155 | * @deprecated 13.3 |
| 156 | */ |
| 157 | public function capture_checkout_view() { |
| 158 | global $post; |
| 159 | $checkout_page_id = wc_get_page_id( 'checkout' ); |
| 160 | |
| 161 | $is_checkout = $checkout_page_id && is_page( $checkout_page_id ) |
| 162 | || wc_post_content_has_shortcode( 'woocommerce_checkout' ) |
| 163 | || has_block( 'woocommerce/checkout', $post ) |
| 164 | || has_block( 'woocommerce/classic-shortcode', $post ) |
| 165 | || apply_filters( 'woocommerce_is_checkout', false ) |
| 166 | || \Automattic\Jetpack\Constants::is_defined( 'WOOCOMMERCE_CHECKOUT' ); |
| 167 | |
| 168 | if ( ! $is_checkout ) { |
| 169 | return; |
| 170 | } |
| 171 | |
| 172 | $is_in_checkout_page = $checkout_page_id === $post->ID ? 'Yes' : 'No'; |
| 173 | $checkout_page_contains_checkout_block = '0'; |
| 174 | $checkout_page_contains_checkout_shortcode = '1'; |
| 175 | |
| 176 | $session = WC()->session; |
| 177 | if ( is_object( $session ) ) { |
| 178 | $session->set( 'checkout_page_used', true ); |
| 179 | $session->save_data(); |
| 180 | $draft_order_id = $session->get( 'store_api_draft_order', 0 ); |
| 181 | if ( $draft_order_id ) { |
| 182 | $checkout_page_contains_checkout_block = '1'; |
| 183 | $checkout_page_contains_checkout_shortcode = '0'; |
| 184 | } |
| 185 | } |
| 186 | |
| 187 | // Order received page is also a checkout page, so we need to bail out if we are on that page. |
| 188 | if ( is_order_received_page() ) { |
| 189 | return; |
| 190 | } |
| 191 | |
| 192 | $this->record_event( |
| 193 | 'woocommerceanalytics_checkout_view', |
| 194 | array_merge( |
| 195 | $this->get_cart_checkout_shared_data(), |
| 196 | array( |
| 197 | 'from_checkout' => $is_in_checkout_page, |
| 198 | 'checkout_page_contains_checkout_block' => $checkout_page_contains_checkout_block, |
| 199 | 'checkout_page_contains_checkout_shortcode' => $checkout_page_contains_checkout_shortcode, |
| 200 | ) |
| 201 | ) |
| 202 | ); |
| 203 | } |
| 204 | } |
| 205 |