Skip to content

Instantly share code, notes, and snippets.

@daigo75

daigo75/class-payment-stats.php

Last active September 28, 2015 18:35
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save daigo75/25a00fdaa9507910cb28 to your computer and use it in GitHub Desktop.
Save daigo75/25a00fdaa9507910cb28 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
class-payment-stats.php
<?php
/**
* Earnings / Sales Stats
*
* @package EDD
* @subpackage Classes/Stats
* @copyright Copyright (c) 2015, Pippin Williamson
* @license http://opensource.org/licenses/gpl-2.0.php GNU Public License
* @since 1.8
*/
// Exit if accessed directly
if ( ! defined( 'ABSPATH' ) ) exit;
/**
* EDD_Stats Class
*
* This class is for retrieving stats for earnings and sales
*
* Stats can be retrieved for date ranges and pre-defined periods
*
* @since 1.8
*/
class EDD_Payment_Stats extends EDD_Stats {
/**
* Retrieve sale stats
*
* @access public
* @since 1.8
* @param $download_id INT The download product to retrieve stats for. If false, gets stats for all products
* @param $start_date string|bool The starting date for which we'd like to filter our sale stats. If false, we'll use the default start date of `this_month`
* @param $end_date string|bool The end date for which we'd like to filter our sale stats. If false, we'll use the default end date of `this_month`
* @param $status string|array The sale status(es) to count. Only valid when retrieving global stats
* @return float|int
*/
public function get_sales( $download_id = 0, $start_date = false, $end_date = false, $status = 'publish' ) {
$this->setup_dates( $start_date, $end_date );
// Make sure start date is valid
if( is_wp_error( $this->start_date ) )
return $this->start_date;
// Make sure end date is valid
if( is_wp_error( $this->end_date ) )
return $this->end_date;
if( empty( $download_id ) ) {
// Global sale stats
add_filter( 'edd_count_payments_where', array( $this, 'count_where' ) );
if( is_array( $status ) ) {
$count = 0;
foreach( $status as $payment_status ) {
$count += edd_count_payments()->$payment_status;
}
} else {
$count = edd_count_payments()->$status;
}
remove_filter( 'edd_count_payments_where', array( $this, 'count_where' ) );
} else {
// Product specific stats
global $edd_logs;
add_filter( 'posts_where', array( $this, 'payments_where' ) );
$count = $edd_logs->get_log_count( $download_id, 'sale' );
remove_filter( 'posts_where', array( $this, 'payments_where' ) );
}
return $count;
}
/**
* Retrieve earning stats
*
* @access public
* @since 1.8
* @param $download_id INT The download product to retrieve stats for. If false, gets stats for all products
* @param $start_date string|bool The starting date for which we'd like to filter our sale stats. If false, we'll use the default start date of `this_month`
* @param $end_date string|bool The end date for which we'd like to filter our sale stats. If false, we'll use the default end date of `this_month`
* @param $include_taxes bool If taxes should be included in the earnings graphs
* @return float|int
*/
public function get_earnings( $download_id = 0, $start_date = false, $end_date = false, $include_taxes = true ) {
global $wpdb;
$this->setup_dates( $start_date, $end_date );
// Make sure start date is valid
if( is_wp_error( $this->start_date ) )
return $this->start_date;
// Make sure end date is valid
if( is_wp_error( $this->end_date ) )
return $this->end_date;
$earnings = false;
add_filter( 'posts_where', array( $this, 'payments_where' ) );
if( empty( $download_id ) ) {
// Global earning stats
$args = array(
'post_type' => 'edd_payment',
'nopaging' => true,
'post_status' => array( 'publish', 'revoked' ),
'fields' => 'ids',
'update_post_term_cache' => false,
'suppress_filters' => false,
'start_date' => $this->start_date, // These dates are not valid query args, but they are used for cache keys
'end_date' => $this->end_date,
'edd_transient_type' => 'edd_earnings', // This is not a valid query arg, but is used for cache keying
'include_taxes' => $include_taxes,
);
$args = apply_filters( 'edd_stats_earnings_args', $args );
// Aelia - Allow to override transient key
$key = apply_filters( 'edd_stats_earnings_transient_key', md5( serialize( $args ) ) );
$earnings = get_transient( $key );
if( false === $earnings ) {
// Aelia - Allow to filter the orders retrieved from database
$sales = apply_filters( 'edd_stats_earnings_sales', get_posts( $args ) );
$earnings = 0;
if ( $sales ) {
// Aelia - Allow 3rd parties to calculate the earnings
$tmp_earnings = apply_filters( 'edd_stats_earnings', false, $sales, $start_date, $end_date, $include_taxes );
// If earnings were calculated by 3rd parties, use them. If not,
// calculate them as usual
if( $tmp_earnings !== false ) {
$earnings += $tmp_earnings;
}
else {
$sales = implode( ',', array_map('intval', $sales ) );
if ( $include_taxes ) {
$earnings += $wpdb->get_var( "SELECT SUM(meta_value) FROM $wpdb->postmeta WHERE meta_key = '_edd_payment_total' AND post_id IN ({$sales})" );
} else {
$earnings_with_tax = $wpdb->get_var( "SELECT SUM(meta_value) FROM $wpdb->postmeta WHERE meta_key = '_edd_payment_total' AND post_id IN ({$sales})" );
$total_tax = $wpdb->get_var( "SELECT SUM(meta_value) FROM $wpdb->postmeta WHERE meta_key = '_edd_payment_tax' AND post_id IN ({$sales})" );
$earnings += ( $earnings_with_tax - $total_tax );
}
}
}
// Cache the results for one hour
set_transient( $key, $earnings, 60*60 );
}
} else {
// Download specific earning stats
global $edd_logs, $wpdb;
$args = array(
'post_parent' => $download_id,
'nopaging' => true,
'log_type' => 'sale',
'fields' => 'ids',
'suppress_filters' => false,
'start_date' => $this->start_date, // These dates are not valid query args, but they are used for cache keys
'end_date' => $this->end_date,
'edd_transient_type' => 'edd_earnings', // This is not a valid query arg, but is used for cache keying
'include_taxes' => $include_taxes,
);
$args = apply_filters( 'edd_stats_earnings_args', $args );
// Aelia - Allow to override transient key
$key = apply_filters( 'edd_stats_earnings_transient_key', md5( serialize( $args ) ) );
$earnings = get_transient( $key );
if( false === $earnings ) {
$log_ids = $edd_logs->get_connected_logs( $args, 'sale' );
$earnings = 0;
if( $log_ids ) {
$log_ids = implode( ',', array_map('intval', $log_ids ) );
$payment_ids = $wpdb->get_col( "SELECT meta_value FROM $wpdb->postmeta WHERE meta_key = '_edd_log_payment_id' AND post_id IN ($log_ids);" );
// Aelia - Allow to filter the orders retrieved from database
$payment_ids = apply_filters( 'edd_stats_earnings_payment_ids', $payment_ids );
foreach( $payment_ids as $payment_id ) {
// Aelia - Allow 3rd parties to calculate the earnings
$tmp_earnings = apply_filters( 'edd_stats_payment_earnings', false, $sales, $start_date, $end_date, $include_taxes );
// If earnings were calculated by 3rd parties, use them. If not,
// calculate them as usual
if( $tmp_earnings !== false ) {
$earnings += $tmp_earnings;
}
else {
$items = edd_get_payment_meta_cart_details( $payment_id );
foreach( $items as $item ) {
if( $item['id'] != $download_id )
continue;
$earnings += $item['price'];
}
if ( ! $include_taxes ) {
$earnings -= edd_get_payment_tax( $payment_id );
}
}
}
}
// Cache the results for one hour
set_transient( $key, $earnings, 60*60 );
}
}
remove_filter( 'posts_where', array( $this, 'payments_where' ) );
return round( $earnings, edd_currency_decimal_filter() );
}
/**
* Get the best selling products
*
* @access public
* @since 1.8
* @param $number int The number of results to retrieve with the default set to 10.
* @return array
*/
public function get_best_selling( $number = 10 ) {
global $wpdb;
$downloads = $wpdb->get_results( $wpdb->prepare(
"SELECT post_id as download_id, max(meta_value) as sales
FROM $wpdb->postmeta WHERE meta_key='_edd_download_sales' AND meta_value > 0
GROUP BY meta_value+0
DESC LIMIT %d;", $number
) );
return $downloads;
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment