initial commit
This commit is contained in:
432
includes/admin/reports/class-wc-report-customers.php
Normal file
432
includes/admin/reports/class-wc-report-customers.php
Normal file
@ -0,0 +1,432 @@
|
||||
<?php
|
||||
/**
|
||||
* Class WC_Report_Customers file.
|
||||
*
|
||||
* @package WooCommerce\Reports
|
||||
*/
|
||||
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit; // Exit if accessed directly.
|
||||
}
|
||||
|
||||
/**
|
||||
* WC_Report_Customers
|
||||
*
|
||||
* @package WooCommerce\Admin\Reports
|
||||
* @version 2.1.0
|
||||
*/
|
||||
class WC_Report_Customers extends WC_Admin_Report {
|
||||
|
||||
/**
|
||||
* Chart colors.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $chart_colours = array();
|
||||
|
||||
/**
|
||||
* Customers.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $customers = array();
|
||||
|
||||
/**
|
||||
* Get the legend for the main chart sidebar.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function get_chart_legend() {
|
||||
$legend = array();
|
||||
|
||||
$legend[] = array(
|
||||
/* translators: %s: signups amount */
|
||||
'title' => sprintf( __( '%s signups in this period', 'woocommerce' ), '<strong>' . count( $this->customers ) . '</strong>' ),
|
||||
'color' => $this->chart_colours['signups'],
|
||||
'highlight_series' => 2,
|
||||
);
|
||||
|
||||
return $legend;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get chart widgets.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function get_chart_widgets() {
|
||||
$widgets = array();
|
||||
|
||||
$widgets[] = array(
|
||||
'title' => '',
|
||||
'callback' => array( $this, 'customers_vs_guests' ),
|
||||
);
|
||||
|
||||
return $widgets;
|
||||
}
|
||||
|
||||
/**
|
||||
* Output customers vs guests chart.
|
||||
*/
|
||||
public function customers_vs_guests() {
|
||||
|
||||
$customer_order_totals = $this->get_order_report_data(
|
||||
array(
|
||||
'data' => array(
|
||||
'ID' => array(
|
||||
'type' => 'post_data',
|
||||
'function' => 'COUNT',
|
||||
'name' => 'total_orders',
|
||||
),
|
||||
),
|
||||
'where_meta' => array(
|
||||
array(
|
||||
'meta_key' => '_customer_user',
|
||||
'meta_value' => '0',
|
||||
'operator' => '>',
|
||||
),
|
||||
),
|
||||
'filter_range' => true,
|
||||
)
|
||||
);
|
||||
|
||||
$guest_order_totals = $this->get_order_report_data(
|
||||
array(
|
||||
'data' => array(
|
||||
'ID' => array(
|
||||
'type' => 'post_data',
|
||||
'function' => 'COUNT',
|
||||
'name' => 'total_orders',
|
||||
),
|
||||
),
|
||||
'where_meta' => array(
|
||||
array(
|
||||
'meta_key' => '_customer_user',
|
||||
'meta_value' => '0',
|
||||
'operator' => '=',
|
||||
),
|
||||
),
|
||||
'filter_range' => true,
|
||||
)
|
||||
);
|
||||
?>
|
||||
<div class="chart-container">
|
||||
<div class="chart-placeholder customers_vs_guests pie-chart" style="height:200px"></div>
|
||||
<ul class="pie-chart-legend">
|
||||
<li style="border-color: <?php echo esc_attr( $this->chart_colours['customers'] ); ?>"><?php esc_html_e( 'Customer sales', 'woocommerce' ); ?></li>
|
||||
<li style="border-color: <?php echo esc_attr( $this->chart_colours['guests'] ); ?>"><?php esc_html_e( 'Guest sales', 'woocommerce' ); ?></li>
|
||||
</ul>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
jQuery(function(){
|
||||
jQuery.plot(
|
||||
jQuery('.chart-placeholder.customers_vs_guests'),
|
||||
[
|
||||
{
|
||||
label: '<?php esc_html_e( 'Customer orders', 'woocommerce' ); ?>',
|
||||
data: "<?php echo esc_html( $customer_order_totals->total_orders ); ?>",
|
||||
color: '<?php echo esc_html( $this->chart_colours['customers'] ); ?>'
|
||||
},
|
||||
{
|
||||
label: '<?php esc_html_e( 'Guest orders', 'woocommerce' ); ?>',
|
||||
data: "<?php echo esc_html( $guest_order_totals->total_orders ); ?>",
|
||||
color: '<?php echo esc_html( $this->chart_colours['guests'] ); ?>'
|
||||
}
|
||||
],
|
||||
{
|
||||
grid: {
|
||||
hoverable: true
|
||||
},
|
||||
series: {
|
||||
pie: {
|
||||
show: true,
|
||||
radius: 1,
|
||||
innerRadius: 0.6,
|
||||
label: {
|
||||
show: false
|
||||
}
|
||||
},
|
||||
enable_tooltip: true,
|
||||
append_tooltip: "<?php echo esc_html( ' ' . __( 'orders', 'woocommerce' ) ); ?>",
|
||||
},
|
||||
legend: {
|
||||
show: false
|
||||
}
|
||||
}
|
||||
);
|
||||
|
||||
jQuery('.chart-placeholder.customers_vs_guests').trigger( 'resize' );
|
||||
});
|
||||
</script>
|
||||
<?php
|
||||
}
|
||||
|
||||
/**
|
||||
* Output the report.
|
||||
*/
|
||||
public function output_report() {
|
||||
|
||||
$ranges = array(
|
||||
'year' => __( 'Year', 'woocommerce' ),
|
||||
'last_month' => __( 'Last month', 'woocommerce' ),
|
||||
'month' => __( 'This month', 'woocommerce' ),
|
||||
'7day' => __( 'Last 7 days', 'woocommerce' ),
|
||||
);
|
||||
|
||||
$this->chart_colours = array(
|
||||
'signups' => '#3498db',
|
||||
'customers' => '#1abc9c',
|
||||
'guests' => '#8fdece',
|
||||
);
|
||||
|
||||
$current_range = ! empty( $_GET['range'] ) ? sanitize_text_field( wp_unslash( $_GET['range'] ) ) : '7day';
|
||||
|
||||
if ( ! in_array( $current_range, array( 'custom', 'year', 'last_month', 'month', '7day' ), true ) ) {
|
||||
$current_range = '7day';
|
||||
}
|
||||
|
||||
$this->check_current_range_nonce( $current_range );
|
||||
$this->calculate_current_range( $current_range );
|
||||
|
||||
$admin_users = new WP_User_Query(
|
||||
array(
|
||||
'role' => 'administrator',
|
||||
'fields' => 'ID',
|
||||
)
|
||||
);
|
||||
|
||||
$manager_users = new WP_User_Query(
|
||||
array(
|
||||
'role' => 'shop_manager',
|
||||
'fields' => 'ID',
|
||||
)
|
||||
);
|
||||
|
||||
$users_query = new WP_User_Query(
|
||||
apply_filters(
|
||||
'woocommerce_admin_report_customers_user_query_args',
|
||||
array(
|
||||
'fields' => array( 'user_registered' ),
|
||||
'exclude' => array_merge( $admin_users->get_results(), $manager_users->get_results() ),
|
||||
)
|
||||
)
|
||||
);
|
||||
|
||||
$this->customers = $users_query->get_results();
|
||||
|
||||
foreach ( $this->customers as $key => $customer ) {
|
||||
if ( strtotime( $customer->user_registered ) < $this->start_date || strtotime( $customer->user_registered ) > $this->end_date ) {
|
||||
unset( $this->customers[ $key ] );
|
||||
}
|
||||
}
|
||||
|
||||
include WC()->plugin_path() . '/includes/admin/views/html-report-by-date.php';
|
||||
}
|
||||
|
||||
/**
|
||||
* Output an export link.
|
||||
*/
|
||||
public function get_export_button() {
|
||||
|
||||
$current_range = ! empty( $_GET['range'] ) ? sanitize_text_field( wp_unslash( $_GET['range'] ) ) : '7day';
|
||||
?>
|
||||
<a
|
||||
href="#"
|
||||
download="report-<?php echo esc_attr( $current_range ); ?>-<?php echo esc_attr( date_i18n( 'Y-m-d', current_time( 'timestamp' ) ) ); ?>.csv"
|
||||
class="export_csv"
|
||||
data-export="chart"
|
||||
data-xaxes="<?php esc_attr_e( 'Date', 'woocommerce' ); ?>"
|
||||
data-groupby="<?php echo esc_attr( $this->chart_groupby ); ?>"
|
||||
>
|
||||
<?php esc_html_e( 'Export CSV', 'woocommerce' ); ?>
|
||||
</a>
|
||||
<?php
|
||||
}
|
||||
|
||||
/**
|
||||
* Output the main chart.
|
||||
*/
|
||||
public function get_main_chart() {
|
||||
global $wp_locale;
|
||||
|
||||
$customer_orders = $this->get_order_report_data(
|
||||
array(
|
||||
'data' => array(
|
||||
'ID' => array(
|
||||
'type' => 'post_data',
|
||||
'function' => 'COUNT',
|
||||
'name' => 'total_orders',
|
||||
),
|
||||
'post_date' => array(
|
||||
'type' => 'post_data',
|
||||
'function' => '',
|
||||
'name' => 'post_date',
|
||||
),
|
||||
),
|
||||
'where_meta' => array(
|
||||
array(
|
||||
'meta_key' => '_customer_user',
|
||||
'meta_value' => '0',
|
||||
'operator' => '>',
|
||||
),
|
||||
),
|
||||
'group_by' => $this->group_by_query,
|
||||
'order_by' => 'post_date ASC',
|
||||
'query_type' => 'get_results',
|
||||
'filter_range' => true,
|
||||
)
|
||||
);
|
||||
|
||||
$guest_orders = $this->get_order_report_data(
|
||||
array(
|
||||
'data' => array(
|
||||
'ID' => array(
|
||||
'type' => 'post_data',
|
||||
'function' => 'COUNT',
|
||||
'name' => 'total_orders',
|
||||
),
|
||||
'post_date' => array(
|
||||
'type' => 'post_data',
|
||||
'function' => '',
|
||||
'name' => 'post_date',
|
||||
),
|
||||
),
|
||||
'where_meta' => array(
|
||||
array(
|
||||
'meta_key' => '_customer_user',
|
||||
'meta_value' => '0',
|
||||
'operator' => '=',
|
||||
),
|
||||
),
|
||||
'group_by' => $this->group_by_query,
|
||||
'order_by' => 'post_date ASC',
|
||||
'query_type' => 'get_results',
|
||||
'filter_range' => true,
|
||||
)
|
||||
);
|
||||
|
||||
$signups = $this->prepare_chart_data( $this->customers, 'user_registered', '', $this->chart_interval, $this->start_date, $this->chart_groupby );
|
||||
$customer_orders = $this->prepare_chart_data( $customer_orders, 'post_date', 'total_orders', $this->chart_interval, $this->start_date, $this->chart_groupby );
|
||||
$guest_orders = $this->prepare_chart_data( $guest_orders, 'post_date', 'total_orders', $this->chart_interval, $this->start_date, $this->chart_groupby );
|
||||
|
||||
$chart_data = wp_json_encode(
|
||||
array(
|
||||
'signups' => array_values( $signups ),
|
||||
'customer_orders' => array_values( $customer_orders ),
|
||||
'guest_orders' => array_values( $guest_orders ),
|
||||
)
|
||||
);
|
||||
?>
|
||||
<div class="chart-container">
|
||||
<div class="chart-placeholder main"></div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
var main_chart;
|
||||
|
||||
jQuery(function(){
|
||||
var chart_data = JSON.parse( decodeURIComponent( '<?php echo rawurlencode( $chart_data ); ?>' ) );
|
||||
|
||||
var drawGraph = function( highlight ) {
|
||||
var series = [
|
||||
{
|
||||
label: "<?php echo esc_js( __( 'Customer orders', 'woocommerce' ) ); ?>",
|
||||
data: chart_data.customer_orders,
|
||||
color: '<?php echo esc_html( $this->chart_colours['customers'] ); ?>',
|
||||
bars: { fillColor: '<?php echo esc_html( $this->chart_colours['customers'] ); ?>', fill: true, show: true, lineWidth: 0, barWidth: <?php echo esc_html( $this->barwidth ); ?> * 0.5, align: 'center' },
|
||||
shadowSize: 0,
|
||||
enable_tooltip: true,
|
||||
append_tooltip: "<?php echo esc_html( ' ' . __( 'customer orders', 'woocommerce' ) ); ?>",
|
||||
stack: true,
|
||||
},
|
||||
{
|
||||
label: "<?php echo esc_js( __( 'Guest orders', 'woocommerce' ) ); ?>",
|
||||
data: chart_data.guest_orders,
|
||||
color: '<?php echo esc_html( $this->chart_colours['guests'] ); ?>',
|
||||
bars: { fillColor: '<?php echo esc_html( $this->chart_colours['guests'] ); ?>', fill: true, show: true, lineWidth: 0, barWidth: <?php echo esc_html( $this->barwidth ); ?> * 0.5, align: 'center' },
|
||||
shadowSize: 0,
|
||||
enable_tooltip: true,
|
||||
append_tooltip: "<?php echo esc_html( ' ' . __( 'guest orders', 'woocommerce' ) ); ?>",
|
||||
stack: true,
|
||||
},
|
||||
{
|
||||
label: "<?php echo esc_js( __( 'Signups', 'woocommerce' ) ); ?>",
|
||||
data: chart_data.signups,
|
||||
color: '<?php echo esc_html( $this->chart_colours['signups'] ); ?>',
|
||||
points: { show: true, radius: 5, lineWidth: 3, fillColor: '#fff', fill: true },
|
||||
lines: { show: true, lineWidth: 4, fill: false },
|
||||
shadowSize: 0,
|
||||
enable_tooltip: true,
|
||||
append_tooltip: "<?php echo esc_html( ' ' . __( 'new users', 'woocommerce' ) ); ?>",
|
||||
stack: false
|
||||
},
|
||||
];
|
||||
|
||||
if ( highlight !== 'undefined' && series[ highlight ] ) {
|
||||
highlight_series = series[ highlight ];
|
||||
|
||||
highlight_series.color = '#9c5d90';
|
||||
|
||||
if ( highlight_series.bars )
|
||||
highlight_series.bars.fillColor = '#9c5d90';
|
||||
|
||||
if ( highlight_series.lines ) {
|
||||
highlight_series.lines.lineWidth = 5;
|
||||
}
|
||||
}
|
||||
|
||||
main_chart = jQuery.plot(
|
||||
jQuery('.chart-placeholder.main'),
|
||||
series,
|
||||
{
|
||||
legend: {
|
||||
show: false
|
||||
},
|
||||
grid: {
|
||||
color: '#aaa',
|
||||
borderColor: 'transparent',
|
||||
borderWidth: 0,
|
||||
hoverable: true
|
||||
},
|
||||
xaxes: [ {
|
||||
color: '#aaa',
|
||||
position: "bottom",
|
||||
tickColor: 'transparent',
|
||||
mode: "time",
|
||||
timeformat: "<?php echo ( 'day' === $this->chart_groupby ) ? '%d %b' : '%b'; ?>",
|
||||
monthNames: JSON.parse( decodeURIComponent( '<?php echo rawurlencode( wp_json_encode( array_values( $wp_locale->month_abbrev ) ) ); ?>' ) ),
|
||||
tickLength: 1,
|
||||
minTickSize: [1, "<?php echo esc_html( $this->chart_groupby ); ?>"],
|
||||
tickSize: [1, "<?php echo esc_html( $this->chart_groupby ); ?>"],
|
||||
font: {
|
||||
color: "#aaa"
|
||||
}
|
||||
} ],
|
||||
yaxes: [
|
||||
{
|
||||
min: 0,
|
||||
minTickSize: 1,
|
||||
tickDecimals: 0,
|
||||
color: '#ecf0f1',
|
||||
font: { color: "#aaa" }
|
||||
}
|
||||
],
|
||||
}
|
||||
);
|
||||
jQuery('.chart-placeholder').trigger( 'resize' );
|
||||
}
|
||||
|
||||
drawGraph();
|
||||
|
||||
jQuery('.highlight_series').on( 'mouseenter',
|
||||
function() {
|
||||
drawGraph( jQuery(this).data('series') );
|
||||
} ).on( 'mouseleave',
|
||||
function() {
|
||||
drawGraph();
|
||||
}
|
||||
);
|
||||
});
|
||||
</script>
|
||||
<?php
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user