Automattic\WooCommerce\Admin\API\Reports\Orders\Stats

DataStore::get_noncached_stats_data()publicWC 1.0

Returns the report data based on normalized parameters. Will be called by get_data if there is no data in cache.

Method of the class: DataStore{}

No Hooks.

Return

stdClass|WP_Error. Data object { totals: *, intervals: array, total: int, pages: int, page_no: int }, or error.

Usage

$DataStore = new DataStore();
$DataStore->get_noncached_stats_data( $query_args, $params, $data, $expected_interval_count );
$query_args(array) (required)
Query parameters.
$params(array) (required)
Query limit parameters.
$data(stdClass) (required) (passed by reference — &)
Reference to the data object to fill.
$expected_interval_count(int) (required)
Number of expected intervals.

Notes

  • See: get_data
  • See: get_noncached_stats_data

DataStore::get_noncached_stats_data() code WC 9.3.3

public function get_noncached_stats_data( $query_args, $params, &$data, $expected_interval_count ) {
	global $wpdb;

	$table_name = self::get_db_table_name();

	if ( isset( $query_args['date_type'] ) ) {
		$this->date_column_name = $query_args['date_type'];
	}

	$this->initialize_queries();

	$selections = $this->selected_columns( $query_args );
	$this->add_time_period_sql_params( $query_args, $table_name );
	$this->add_intervals_sql_params( $query_args, $table_name );
	$this->add_order_by_sql_params( $query_args );
	$where_time  = $this->get_sql_clause( 'where_time' );
	$params      = $this->get_limit_sql_params( $query_args );
	$coupon_join = "LEFT JOIN (
				SELECT
					order_id,
					SUM(discount_amount) AS discount_amount,
					COUNT(DISTINCT coupon_id) AS coupons_count
				FROM
					{$wpdb->prefix}wc_order_coupon_lookup
				GROUP BY
					order_id
				) order_coupon_lookup
				ON order_coupon_lookup.order_id = {$wpdb->prefix}wc_order_stats.order_id";

	// Additional filtering for Orders report.
	$this->orders_stats_sql_filter( $query_args );
	$this->total_query->add_sql_clause( 'select', $selections );
	$this->total_query->add_sql_clause( 'left_join', $coupon_join );
	$this->total_query->add_sql_clause( 'where_time', $where_time );
	$totals = $wpdb->get_results(
		// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- cache ok, DB call ok, unprepared SQL ok.
		$this->total_query->get_query_statement(),
		ARRAY_A
	);
	if ( null === $totals ) {
		return new \WP_Error( 'woocommerce_analytics_revenue_result_failed', __( 'Sorry, fetching revenue data failed.', 'woocommerce' ) );
	}

	// phpcs:ignore Generic.Commenting.Todo.TaskFound
	// @todo Remove these assignements when refactoring segmenter classes to use query objects.
	$totals_query    = array(
		'from_clause'       => $this->total_query->get_sql_clause( 'join' ),
		'where_time_clause' => $where_time,
		'where_clause'      => $this->total_query->get_sql_clause( 'where' ),
	);
	$intervals_query = array(
		'select_clause'     => $this->get_sql_clause( 'select' ),
		'from_clause'       => $this->interval_query->get_sql_clause( 'join' ),
		'where_time_clause' => $where_time,
		'where_clause'      => $this->interval_query->get_sql_clause( 'where' ),
		'limit'             => $this->get_sql_clause( 'limit' ),
	);

	$unique_products            = $this->get_unique_product_count( $totals_query['from_clause'], $totals_query['where_time_clause'], $totals_query['where_clause'] );
	$totals[0]['products']      = $unique_products;
	$segmenter                  = new Segmenter( $query_args, $this->report_columns );
	$unique_coupons             = $this->get_unique_coupon_count( $totals_query['from_clause'], $totals_query['where_time_clause'], $totals_query['where_clause'] );
	$totals[0]['coupons_count'] = $unique_coupons;
	$totals[0]['segments']      = $segmenter->get_totals_segments( $totals_query, $table_name );
	$totals                     = (object) $this->cast_numbers( $totals[0] );

	$this->interval_query->add_sql_clause( 'select', $this->get_sql_clause( 'select' ) . ' AS time_interval' );
	$this->interval_query->add_sql_clause( 'left_join', $coupon_join );
	$this->interval_query->add_sql_clause( 'where_time', $where_time );
	$db_intervals = $wpdb->get_col(
		// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- cache ok, DB call ok, , unprepared SQL ok.
		$this->interval_query->get_query_statement()
	);

	$db_interval_count = count( $db_intervals );

	$this->update_intervals_sql_params( $query_args, $db_interval_count, $expected_interval_count, $table_name );
	$this->interval_query->add_sql_clause( 'order_by', $this->get_sql_clause( 'order_by' ) );
	$this->interval_query->add_sql_clause( 'limit', $this->get_sql_clause( 'limit' ) );
	$this->interval_query->add_sql_clause( 'select', ", MAX({$table_name}.date_created) AS datetime_anchor" );
	if ( '' !== $selections ) {
		$this->interval_query->add_sql_clause( 'select', ', ' . $selections );
	}
	$intervals = $wpdb->get_results(
		// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- cache ok, DB call ok, , unprepared SQL ok.
		$this->interval_query->get_query_statement(),
		ARRAY_A
	);

	if ( null === $intervals ) {
		return new \WP_Error( 'woocommerce_analytics_revenue_result_failed', __( 'Sorry, fetching revenue data failed.', 'woocommerce' ) );
	}

	if ( isset( $intervals[0] ) ) {
		$unique_coupons                = $this->get_unique_coupon_count( $intervals_query['from_clause'], $intervals_query['where_time_clause'], $intervals_query['where_clause'], true );
		$intervals[0]['coupons_count'] = $unique_coupons;
	}

	$data->totals    = $totals;
	$data->intervals = $intervals;

	if ( TimeInterval::intervals_missing( $expected_interval_count, $db_interval_count, $params['per_page'], $query_args['page'], $query_args['order'], $query_args['orderby'], count( $intervals ) ) ) {
		$this->fill_in_missing_intervals( $db_intervals, $query_args['adj_after'], $query_args['adj_before'], $query_args['interval'], $data );
		$this->sort_intervals( $data, $query_args['orderby'], $query_args['order'] );
		$this->remove_extra_records( $data, $query_args['page'], $params['per_page'], $db_interval_count, $expected_interval_count, $query_args['orderby'], $query_args['order'] );
	} else {
		$this->update_interval_boundary_dates( $query_args['after'], $query_args['before'], $query_args['interval'], $data->intervals );
	}
	$segmenter->add_intervals_segments( $data, $intervals_query, $table_name );

	return $data;
}