472 lines
14 KiB
PHP
472 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* WC_Admin_Reports_Coupons_Data_Store class file.
|
|
*
|
|
* @package WooCommerce Admin/Classes
|
|
*/
|
|
|
|
defined( 'ABSPATH' ) || exit;
|
|
|
|
/**
|
|
* WC_Admin_Reports_Coupons_Data_Store.
|
|
*/
|
|
class WC_Admin_Reports_Coupons_Data_Store extends WC_Admin_Reports_Data_Store implements WC_Admin_Reports_Data_Store_Interface {
|
|
|
|
/**
|
|
* Table used to get the data.
|
|
*
|
|
* @var string
|
|
*/
|
|
const TABLE_NAME = 'wc_order_coupon_lookup';
|
|
|
|
/**
|
|
* Mapping columns to data type to return correct response types.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $column_types = array(
|
|
'coupon_id' => 'intval',
|
|
'amount' => 'floatval',
|
|
'orders_count' => 'intval',
|
|
);
|
|
|
|
/**
|
|
* SQL columns to select in the db query and their mapping to SQL code.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $report_columns = array(
|
|
'coupon_id' => 'coupon_id',
|
|
'amount' => 'SUM(discount_amount) as amount',
|
|
'orders_count' => 'COUNT(DISTINCT order_id) as orders_count',
|
|
);
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
public function __construct() {
|
|
global $wpdb;
|
|
$table_name = $wpdb->prefix . self::TABLE_NAME;
|
|
// Avoid ambigious column order_id in SQL query.
|
|
$this->report_columns['orders_count'] = str_replace( 'order_id', $table_name . '.order_id', $this->report_columns['orders_count'] );
|
|
}
|
|
|
|
/**
|
|
* Set up all the hooks for maintaining and populating table data.
|
|
*/
|
|
public static function init() {
|
|
add_action( 'woocommerce_reports_delete_order_stats', array( __CLASS__, 'sync_on_order_delete' ), 5 );
|
|
add_action( 'delete_post', array( __CLASS__, 'delete_coupon' ) );
|
|
}
|
|
|
|
/**
|
|
* Returns an array of ids of included coupons, based on query arguments from the user.
|
|
*
|
|
* @param array $query_args Parameters supplied by the user.
|
|
* @return array
|
|
*/
|
|
protected function get_included_coupons_array( $query_args ) {
|
|
if ( isset( $query_args['coupons'] ) && is_array( $query_args['coupons'] ) && count( $query_args['coupons'] ) > 0 ) {
|
|
return $query_args['coupons'];
|
|
}
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* Returns comma separated ids of included coupons, based on query arguments from the user.
|
|
*
|
|
* @param array $query_args Parameters supplied by the user.
|
|
* @return string
|
|
*/
|
|
protected function get_included_coupons( $query_args ) {
|
|
$included_coupons = $this->get_included_coupons_array( $query_args );
|
|
return implode( ',', $included_coupons );
|
|
}
|
|
|
|
/**
|
|
* Updates the database query with parameters used for Products report: categories and order status.
|
|
*
|
|
* @param array $query_args Query arguments supplied by the user.
|
|
* @return array Array of parameters used for SQL query.
|
|
*/
|
|
protected function get_sql_query_params( $query_args ) {
|
|
global $wpdb;
|
|
$order_coupon_lookup_table = $wpdb->prefix . self::TABLE_NAME;
|
|
|
|
$sql_query_params = $this->get_time_period_sql_params( $query_args, $order_coupon_lookup_table );
|
|
$sql_query_params = array_merge( $sql_query_params, $this->get_limit_sql_params( $query_args ) );
|
|
|
|
$included_coupons = $this->get_included_coupons( $query_args );
|
|
if ( $included_coupons ) {
|
|
$sql_query_params['where_clause'] .= " AND {$order_coupon_lookup_table}.coupon_id IN ({$included_coupons})";
|
|
|
|
$sql_query_params = array_merge( $sql_query_params, $this->get_order_by_params( $query_args, 'outer_from_clause', 'default_results.coupon_id' ) );
|
|
} else {
|
|
$sql_query_params = array_merge( $sql_query_params, $this->get_order_by_params( $query_args, 'from_clause', "{$order_coupon_lookup_table}.coupon_id" ) );
|
|
}
|
|
|
|
$order_status_filter = $this->get_status_subquery( $query_args );
|
|
if ( $order_status_filter ) {
|
|
$sql_query_params['from_clause'] .= " JOIN {$wpdb->prefix}wc_order_stats ON {$order_coupon_lookup_table}.order_id = {$wpdb->prefix}wc_order_stats.order_id";
|
|
$sql_query_params['where_clause'] .= " AND ( {$order_status_filter} )";
|
|
}
|
|
|
|
return $sql_query_params;
|
|
}
|
|
|
|
/**
|
|
* Fills ORDER BY clause of SQL request based on user supplied parameters.
|
|
*
|
|
* @param array $query_args Parameters supplied by the user.
|
|
* @param string $from_arg Name of the FROM sql param.
|
|
* @param string $id_cell ID cell identifier, like `table_name.id_column_name`.
|
|
* @return array
|
|
*/
|
|
protected function get_order_by_params( $query_args, $from_arg, $id_cell ) {
|
|
global $wpdb;
|
|
$lookup_table = $wpdb->prefix . self::TABLE_NAME;
|
|
$sql_query = array();
|
|
$sql_query['from_clause'] = '';
|
|
$sql_query['outer_from_clause'] = '';
|
|
$sql_query['order_by_clause'] = '';
|
|
if ( isset( $query_args['orderby'] ) ) {
|
|
$sql_query['order_by_clause'] = $this->normalize_order_by( $query_args['orderby'] );
|
|
}
|
|
|
|
if ( false !== strpos( $sql_query['order_by_clause'], '_coupons' ) ) {
|
|
$sql_query[ $from_arg ] .= " JOIN {$wpdb->prefix}posts AS _coupons ON {$id_cell} = _coupons.ID";
|
|
}
|
|
|
|
if ( isset( $query_args['order'] ) ) {
|
|
$sql_query['order_by_clause'] .= ' ' . $query_args['order'];
|
|
} else {
|
|
$sql_query['order_by_clause'] .= ' DESC';
|
|
}
|
|
|
|
return $sql_query;
|
|
}
|
|
|
|
/**
|
|
* Maps ordering specified by the user to columns in the database/fields in the data.
|
|
*
|
|
* @param string $order_by Sorting criterion.
|
|
* @return string
|
|
*/
|
|
protected function normalize_order_by( $order_by ) {
|
|
if ( 'date' === $order_by ) {
|
|
return 'time_interval';
|
|
}
|
|
if ( 'code' === $order_by ) {
|
|
return '_coupons.post_title';
|
|
}
|
|
return $order_by;
|
|
}
|
|
|
|
/**
|
|
* Enriches the coupon data with extra attributes.
|
|
*
|
|
* @param array $coupon_data Coupon data.
|
|
* @param array $query_args Query parameters.
|
|
*/
|
|
protected function include_extended_info( &$coupon_data, $query_args ) {
|
|
foreach ( $coupon_data as $idx => $coupon_datum ) {
|
|
$extended_info = new ArrayObject();
|
|
if ( $query_args['extended_info'] ) {
|
|
$coupon_id = $coupon_datum['coupon_id'];
|
|
$coupon = new WC_Coupon( $coupon_id );
|
|
|
|
$gmt_timzone = new DateTimeZone( 'UTC' );
|
|
|
|
$date_expires = $coupon->get_date_expires();
|
|
if ( null === $date_expires ) {
|
|
$date_expires = '';
|
|
$date_expires_gmt = '';
|
|
} else {
|
|
$date_expires = $date_expires->format( WC_Admin_Reports_Interval::$iso_datetime_format );
|
|
$date_expires_gmt = new DateTime( $date_expires );
|
|
$date_expires_gmt->setTimezone( $gmt_timzone );
|
|
$date_expires_gmt = $date_expires_gmt->format( WC_Admin_Reports_Interval::$iso_datetime_format );
|
|
}
|
|
|
|
$date_created = $coupon->get_date_created();
|
|
if ( null === $date_created ) {
|
|
$date_created = '';
|
|
$date_created_gmt = '';
|
|
} else {
|
|
$date_created = $date_created->format( WC_Admin_Reports_Interval::$iso_datetime_format );
|
|
$date_created_gmt = new DateTime( $date_created );
|
|
$date_created_gmt->setTimezone( $gmt_timzone );
|
|
$date_created_gmt = $date_created_gmt->format( WC_Admin_Reports_Interval::$iso_datetime_format );
|
|
}
|
|
|
|
$extended_info = array(
|
|
'code' => $coupon->get_code(),
|
|
'date_created' => $date_created,
|
|
'date_created_gmt' => $date_created_gmt,
|
|
'date_expires' => $date_expires,
|
|
'date_expires_gmt' => $date_expires_gmt,
|
|
'discount_type' => $coupon->get_discount_type(),
|
|
);
|
|
}
|
|
$coupon_data[ $idx ]['extended_info'] = $extended_info;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the report data based on parameters supplied by the user.
|
|
*
|
|
* @param array $query_args Query parameters.
|
|
* @return stdClass|WP_Error Data.
|
|
*/
|
|
public function get_data( $query_args ) {
|
|
global $wpdb;
|
|
|
|
$table_name = $wpdb->prefix . self::TABLE_NAME;
|
|
|
|
// These defaults are only partially applied when used via REST API, as that has its own defaults.
|
|
$defaults = array(
|
|
'per_page' => get_option( 'posts_per_page' ),
|
|
'page' => 1,
|
|
'order' => 'DESC',
|
|
'orderby' => 'coupon_id',
|
|
'before' => WC_Admin_Reports_Interval::default_before(),
|
|
'after' => WC_Admin_Reports_Interval::default_after(),
|
|
'fields' => '*',
|
|
'coupons' => array(),
|
|
'extended_info' => false,
|
|
);
|
|
$query_args = wp_parse_args( $query_args, $defaults );
|
|
$this->normalize_timezones( $query_args, $defaults );
|
|
|
|
$cache_key = $this->get_cache_key( $query_args );
|
|
$data = wp_cache_get( $cache_key, $this->cache_group );
|
|
|
|
if ( false === $data ) {
|
|
$data = (object) array(
|
|
'data' => array(),
|
|
'total' => 0,
|
|
'pages' => 0,
|
|
'page_no' => 0,
|
|
);
|
|
|
|
$selections = $this->selected_columns( $query_args );
|
|
$sql_query_params = $this->get_sql_query_params( $query_args );
|
|
$included_coupons = $this->get_included_coupons_array( $query_args );
|
|
|
|
if ( count( $included_coupons ) > 0 ) {
|
|
$total_results = count( $included_coupons );
|
|
$total_pages = (int) ceil( $total_results / $sql_query_params['per_page'] );
|
|
|
|
$fields = $this->get_fields( $query_args );
|
|
$join_selections = $this->format_join_selections( $fields, array( 'coupon_id' ) );
|
|
$ids_table = $this->get_ids_table( $included_coupons, 'coupon_id' );
|
|
|
|
$prefix = "SELECT {$join_selections} FROM (";
|
|
$suffix = ") AS {$table_name}";
|
|
$right_join = "RIGHT JOIN ( {$ids_table} ) AS default_results
|
|
ON default_results.coupon_id = {$table_name}.coupon_id";
|
|
} else {
|
|
$db_records_count = (int) $wpdb->get_var(
|
|
"SELECT COUNT(*) FROM (
|
|
SELECT
|
|
coupon_id
|
|
FROM
|
|
{$table_name}
|
|
{$sql_query_params['from_clause']}
|
|
WHERE
|
|
1=1
|
|
{$sql_query_params['where_time_clause']}
|
|
{$sql_query_params['where_clause']}
|
|
GROUP BY
|
|
coupon_id
|
|
) AS tt"
|
|
); // WPCS: cache ok, DB call ok, unprepared SQL ok.
|
|
|
|
$total_results = $db_records_count;
|
|
$total_pages = (int) ceil( $db_records_count / $sql_query_params['per_page'] );
|
|
if ( $query_args['page'] < 1 || $query_args['page'] > $total_pages ) {
|
|
return $data;
|
|
}
|
|
|
|
$prefix = '';
|
|
$suffix = '';
|
|
$right_join = '';
|
|
}
|
|
|
|
$coupon_data = $wpdb->get_results(
|
|
"${prefix}
|
|
SELECT
|
|
{$selections}
|
|
FROM
|
|
{$table_name}
|
|
{$sql_query_params['from_clause']}
|
|
WHERE
|
|
1=1
|
|
{$sql_query_params['where_time_clause']}
|
|
{$sql_query_params['where_clause']}
|
|
GROUP BY
|
|
coupon_id
|
|
{$suffix}
|
|
{$right_join}
|
|
{$sql_query_params['outer_from_clause']}
|
|
ORDER BY
|
|
{$sql_query_params['order_by_clause']}
|
|
{$sql_query_params['limit']}
|
|
",
|
|
ARRAY_A
|
|
); // WPCS: cache ok, DB call ok, unprepared SQL ok.
|
|
|
|
if ( null === $coupon_data ) {
|
|
return $data;
|
|
}
|
|
|
|
$this->include_extended_info( $coupon_data, $query_args );
|
|
|
|
$coupon_data = array_map( array( $this, 'cast_numbers' ), $coupon_data );
|
|
$data = (object) array(
|
|
'data' => $coupon_data,
|
|
'total' => $total_results,
|
|
'pages' => $total_pages,
|
|
'page_no' => (int) $query_args['page'],
|
|
);
|
|
|
|
wp_cache_set( $cache_key, $data, $this->cache_group );
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Returns string to be used as cache key for the data.
|
|
*
|
|
* @param array $params Query parameters.
|
|
* @return string
|
|
*/
|
|
protected function get_cache_key( $params ) {
|
|
return 'woocommerce_' . self::TABLE_NAME . '_' . md5( wp_json_encode( $params ) );
|
|
}
|
|
|
|
/**
|
|
* Create or update an an entry in the wc_order_coupon_lookup table for an order.
|
|
*
|
|
* @since 3.5.0
|
|
* @param int $order_id Order ID.
|
|
* @return int|bool Returns -1 if order won't be processed, or a boolean indicating processing success.
|
|
*/
|
|
public static function sync_order_coupons( $order_id ) {
|
|
global $wpdb;
|
|
|
|
$order = wc_get_order( $order_id );
|
|
|
|
// Skip `shop_order_refunds` when factoring stats on coupon usage.
|
|
if ( ! $order || 'shop_order' !== $order->get_type() ) {
|
|
return -1;
|
|
}
|
|
|
|
$coupon_items = $order->get_items( 'coupon' );
|
|
$coupon_items_count = count( $coupon_items );
|
|
$num_updated = 0;
|
|
|
|
foreach ( $coupon_items as $coupon_item ) {
|
|
$coupon_id = wc_get_coupon_id_by_code( $coupon_item->get_code() );
|
|
|
|
if ( ! $coupon_id ) {
|
|
$coupon_items_count--;
|
|
continue;
|
|
}
|
|
|
|
$result = $wpdb->replace(
|
|
$wpdb->prefix . self::TABLE_NAME,
|
|
array(
|
|
'order_id' => $order_id,
|
|
'coupon_id' => $coupon_id,
|
|
'discount_amount' => $coupon_item->get_discount(),
|
|
'date_created' => $order->get_date_created( 'edit' )->date( WC_Admin_Reports_Interval::$sql_datetime_format ),
|
|
),
|
|
array(
|
|
'%d',
|
|
'%d',
|
|
'%f',
|
|
'%s',
|
|
)
|
|
);
|
|
|
|
/**
|
|
* Fires when coupon's reports are updated.
|
|
*
|
|
* @param int $coupon_id Coupon ID.
|
|
* @param int $order_id Order ID.
|
|
*/
|
|
do_action( 'woocommerce_reports_update_coupon', $coupon_id, $order_id );
|
|
|
|
$num_updated += intval( $result );
|
|
}
|
|
|
|
return ( $coupon_items_count === $num_updated );
|
|
}
|
|
|
|
/**
|
|
* Clean coupons data when an order is deleted.
|
|
*
|
|
* @param int $order_id Order ID.
|
|
*/
|
|
public static function sync_on_order_delete( $order_id ) {
|
|
global $wpdb;
|
|
|
|
$table_name = $wpdb->prefix . self::TABLE_NAME;
|
|
|
|
$wpdb->query(
|
|
$wpdb->prepare(
|
|
"DELETE FROM ${table_name} WHERE order_id = %d",
|
|
$order_id
|
|
)
|
|
);
|
|
|
|
/**
|
|
* Fires when coupon's reports are removed from database.
|
|
*
|
|
* @param int $coupon_id Coupon ID.
|
|
* @param int $order_id Order ID.
|
|
*/
|
|
do_action( 'woocommerce_reports_delete_coupon', 0, $order_id );
|
|
}
|
|
|
|
/**
|
|
* Deletes the coupon lookup information when a coupon is deleted.
|
|
* This keeps data consistent if it gets resynced at any point.
|
|
*
|
|
* @param int $post_id Post ID.
|
|
*/
|
|
public static function delete_coupon( $post_id ) {
|
|
global $wpdb;
|
|
|
|
if ( 'shop_coupon' !== get_post_type( $post_id ) ) {
|
|
return;
|
|
}
|
|
|
|
$wpdb->delete(
|
|
$wpdb->prefix . self::TABLE_NAME,
|
|
array( 'coupon_id' => $post_id )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Gets coupons based on the provided arguments.
|
|
*
|
|
* @todo Upon core merge, including this in core's `class-wc-coupon-data-store-cpt.php` might make more sense.
|
|
* @param array $args Array of args to filter the query by. Supports `include`.
|
|
* @return array Array of results.
|
|
*/
|
|
public static function get_coupons( $args ) {
|
|
global $wpdb;
|
|
$query = "SELECT ID, post_title FROM {$wpdb->prefix}posts WHERE post_type='shop_coupon'";
|
|
|
|
if ( ! empty( $args['include'] ) ) {
|
|
$included_coupons = implode( ',', $args['include'] );
|
|
$query .= " AND ID IN ({$included_coupons})";
|
|
}
|
|
|
|
return $wpdb->get_results( $query ); // WPCS: cache ok, DB call ok, unprepared SQL ok.
|
|
}
|
|
}
|