/wp-content/plugins/woocommerce-payments/vendor/woocommerce/subscriptions-core/includes/class-wc-subscriptions-tracker.php
PHP | 198 lines | 118 code | 27 blank | 53 comment | 7 complexity | 28ceaa1e17d7cf33dfc772f9bc3d8aea MD5 | raw file
- <?php
- /**
- * Tracker for Subscriptions usage.
- *
- * @class WC_Subscriptions_Tracker
- * @version 2.6.4
- * @package WooCommerce Subscriptions/Classes
- * @category Class
- * @author WooCommerce
- */
- defined( 'ABSPATH' ) || exit;
- class WC_Subscriptions_Tracker {
- /**
- * Initialize the Tracker.
- */
- public static function init() {
- // Only add data if Tracker enabled
- if ( 'yes' === get_option( 'woocommerce_allow_tracking', 'no' ) ) {
- add_filter( 'woocommerce_tracker_data', array( __CLASS__, 'add_subscriptions_tracking_data' ), 10, 1 );
- }
- }
- /**
- * Adds Subscriptions data to the WC tracked data.
- *
- * @param array $data
- * @return array all the tracking data.
- */
- public static function add_subscriptions_tracking_data( $data ) {
- $data['extensions']['wc_subscriptions']['settings'] = self::get_subscriptions_options();
- $data['extensions']['wc_subscriptions']['subscriptions'] = self::get_subscriptions();
- $data['extensions']['wc_subscriptions']['subscription_orders'] = self::get_subscription_orders();
- return $data;
- }
- /**
- * Gets the tracked Subscriptions options data.
- *
- * @return array Subscriptions options data.
- */
- private static function get_subscriptions_options() {
- return array(
- // Staging and live site
- 'wc_subscriptions_staging' => WCS_Staging::is_duplicate_site() ? 'staging' : 'live',
- 'wc_subscriptions_live_url' => esc_url( WCS_Staging::get_site_url_from_source( 'subscriptions_install' ) ),
- // Button text, roles
- 'add_to_cart_button_text' => get_option( WC_Subscriptions_Admin::$option_prefix . '_add_to_cart_button_text' ),
- 'order_button_text' => get_option( WC_Subscriptions_Admin::$option_prefix . '_order_button_text' ),
- 'subscriber_role' => get_option( WC_Subscriptions_Admin::$option_prefix . '_subscriber_role' ),
- 'cancelled_role' => get_option( WC_Subscriptions_Admin::$option_prefix . '_cancelled_role' ),
- // Renewals
- 'accept_manual_renewals' => get_option( WC_Subscriptions_Admin::$option_prefix . '_accept_manual_renewals' ),
- 'turn_off_automatic_payments' => 'no' == get_option( WC_Subscriptions_Admin::$option_prefix . '_accept_manual_renewals' ) ? 'none' : get_option( WC_Subscriptions_Admin::$option_prefix . '_turn_off_automatic_payments', 'none' ),
- 'enable_auto_renewal_toggle' => get_option( WC_Subscriptions_Admin::$option_prefix . '_enable_auto_renewal_toggle' ),
- // Early renewal
- 'enable_early_renewal' => get_option( WC_Subscriptions_Admin::$option_prefix . '_enable_early_renewal' ),
- 'enable_early_renewal_via_modal' => 'no' == get_option( WC_Subscriptions_Admin::$option_prefix . '_enable_early_renewal' ) ? 'none' : get_option( WC_Subscriptions_Admin::$option_prefix . '_enable_early_renewal_via_modal', 'none' ),
- // Switching
- 'allow_switching' => get_option( WC_Subscriptions_Admin::$option_prefix . '_allow_switching' ),
- 'apportion_recurring_price' => get_option( WC_Subscriptions_Admin::$option_prefix . '_apportion_recurring_price', 'none' ),
- 'apportion_sign_up_fee' => get_option( WC_Subscriptions_Admin::$option_prefix . '_apportion_sign_up_fee', 'none' ),
- 'apportion_length' => get_option( WC_Subscriptions_Admin::$option_prefix . '_apportion_length', 'none' ),
- 'switch_button_text' => get_option( WC_Subscriptions_Admin::$option_prefix . '_switch_button_text', 'none' ),
- // Synchronization
- 'sync_payments' => get_option( WC_Subscriptions_Admin::$option_prefix . '_sync_payments' ),
- 'prorate_synced_payments' => $prorate_synced_payments = ( 'no' == get_option( WC_Subscriptions_Admin::$option_prefix . '_sync_payments' ) ? 'none' : get_option( WC_Subscriptions_Admin::$option_prefix . '_prorate_synced_payments', 'none' ) ),
- 'days_no_fee' => 'recurring' == $prorate_synced_payments ? get_option( WC_Subscriptions_Admin::$option_prefix . '_days_no_fee', 'none' ) : 'none',
- // Miscellaneous
- 'max_customer_suspensions' => get_option( WC_Subscriptions_Admin::$option_prefix . '_max_customer_suspensions' ),
- 'multiple_purchase' => get_option( WC_Subscriptions_Admin::$option_prefix . '_multiple_purchase' ),
- 'allow_zero_initial_order_without_payment_method' => get_option( WC_Subscriptions_Admin::$option_prefix . '_zero_initial_payment_requires_payment' ),
- 'drip_downloadable_content_on_renewal' => get_option( WC_Subscriptions_Admin::$option_prefix . '_drip_downloadable_content_on_renewal' ),
- 'enable_retry' => get_option( WC_Subscriptions_Admin::$option_prefix . '_enable_retry' ),
- );
- }
- /**
- * Gets the combined subscription dates, count, and totals data.
- *
- * @return array
- */
- private static function get_subscriptions() {
- $subscription_dates = self::get_subscription_dates();
- $subscription_counts = self::get_subscription_counts();
- return array_merge( $subscription_dates, $subscription_counts );
- }
- /**
- * Gets subscription counts.
- *
- * @return array
- */
- private static function get_subscription_counts() {
- $subscription_counts = array();
- $subscription_counts_data = wp_count_posts( 'shop_subscription' );
- foreach ( wcs_get_subscription_statuses() as $status_slug => $status_name ) {
- $subscription_counts[ $status_slug ] = $subscription_counts_data->{ $status_slug };
- }
- return $subscription_counts;
- }
- /**
- * Gets subscription order counts and totals.
- *
- * @return array
- */
- private static function get_subscription_orders() {
- global $wpdb;
- $order_totals = array();
- $relation_types = array(
- 'switch',
- 'renewal',
- 'resubscribe',
- );
- foreach ( $relation_types as $relation_type ) {
- $total_and_count = $wpdb->get_row( sprintf(
- "SELECT
- SUM( order_total.meta_value ) AS 'gross_total', COUNT( orders.ID ) as 'count'
- FROM {$wpdb->prefix}posts AS orders
- LEFT JOIN {$wpdb->prefix}postmeta AS order_relation ON order_relation.post_id = orders.ID
- LEFT JOIN {$wpdb->prefix}postmeta AS order_total ON order_total.post_id = orders.ID
- WHERE order_relation.meta_key = '_subscription_%s'
- AND orders.post_status in ( 'wc-completed', 'wc-processing', 'wc-refunded' )
- AND order_total.meta_key = '_order_total'
- GROUP BY order_total.meta_key
- ", $relation_type
- ), ARRAY_A );
- $order_totals[ $relation_type . '_gross' ] = is_null( $total_and_count ) ? 0 : $total_and_count['gross_total'];
- $order_totals[ $relation_type . '_count' ] = is_null( $total_and_count ) ? 0 : $total_and_count['count'];
- }
- // Finally get the initial revenue and count
- $total_and_count = $wpdb->get_row(
- "SELECT
- SUM( order_total.meta_value ) AS 'gross_total', COUNT( * ) as 'count'
- FROM {$wpdb->prefix}posts AS orders
- LEFT JOIN {$wpdb->prefix}posts AS subscriptions ON subscriptions.post_parent = orders.ID
- LEFT JOIN {$wpdb->prefix}postmeta AS order_total ON order_total.post_id = orders.ID
- WHERE orders.post_status in ( 'wc-completed', 'wc-processing', 'wc-refunded' )
- AND subscriptions.post_type = 'shop_subscription'
- AND orders.post_type = 'shop_order'
- AND order_total.meta_key = '_order_total'
- GROUP BY order_total.meta_key
- ", ARRAY_A );
- $initial_order_total = is_null( $total_and_count ) ? 0 : $total_and_count['gross_total'];
- $initial_order_count = is_null( $total_and_count ) ? 0 : $total_and_count['count'];
- // Don't double count resubscribe revenue and count
- $order_totals['initial_gross'] = $initial_order_total - $order_totals['resubscribe_gross'];
- $order_totals['initial_count'] = $initial_order_count - $order_totals['resubscribe_count'];
- return $order_totals;
- }
- /**
- * Gets first and last subscription created dates.
- *
- * @return array
- */
- private static function get_subscription_dates() {
- global $wpdb;
- $min_max = $wpdb->get_row(
- "
- SELECT
- MIN( post_date_gmt ) as 'first', MAX( post_date_gmt ) as 'last'
- FROM {$wpdb->prefix}posts
- WHERE post_type = 'shop_subscription'
- AND post_status NOT IN ( 'trash', 'auto-draft' )
- ",
- ARRAY_A
- );
- if ( is_null( $min_max ) ) {
- $min_max = array(
- 'first' => '-',
- 'last' => '-',
- );
- }
- return $min_max;
- }
- }