Automattic\WooCommerce\Admin\API\Reports\Coupons\Stats

DataStore{} │ WC 1.0

API\Reports\Coupons\Stats\DataStore.

No Hooks.

Usage

$DataStore = new DataStore();
// use class methods

Methods

1. ERROR: no method name found on line `'interval' => 'week',`
2. ERROR: no method name found on line ``
3. public add_time_period_sql_params( $query_args, $order_coupon_lookup_table )
4. ERROR: no method name found on line `*/`
5. public add_sql_clause( $clause, $clauses[ $clause ] )
6. ERROR: no method name found on line ``
7. ERROR: no method name found on line ``
8. ERROR: no method name found on line ``
9. ERROR: no method name found on line ``
10. public array(
11. ERROR: no method name found on line ``
12. ERROR: no method name found on line ``
13. ERROR: no method name found on line ``
14. ERROR: no method name found on line `'pages' => 0,`
15. public get_status_subquery( $query_args )
16. ERROR: no method name found on line `* @return stdClass|WP_Error Data.`
17. ERROR: no method name found on line ``
18. ERROR: no method name found on line `}`
19. ERROR: no method name found on line ``
20. ERROR: no method name found on line ``
21. ERROR: no method name found on line `}`
22. ERROR: no method name found on line ``
23. protected update_sql_query_params( $query_args )
24. ERROR: no method name found on line ``
25. ERROR: no method name found on line `*`
26. ERROR: no method name found on line ``
27. public AND ( {$order_status_filter} )
28. ERROR: no method name found on line ``
29. ERROR: no method name found on line `*/`
30. ERROR: no method name found on line `}`
31. ERROR: no method name found on line `'where' => '',`
32. ERROR: no method name found on line `);`
33. protected assign_report_columns()
34. public COUNT(DISTINCT coupon_id)
35. ERROR: no method name found on line ``
36. ERROR: no method name found on line ``
37. ERROR: no method name found on line ``
38. ERROR: no method name found on line `*/`
39. ERROR: no method name found on line ``
40. public get_totals_segments( $totals_query, $table_name )
41. ERROR: no method name found on line ``
42. ERROR: no method name found on line ``
43. ERROR: no method name found on line ``
44. ERROR: no method name found on line ``
45. ERROR: no method name found on line ``
46. ERROR: no method name found on line ``
47. ERROR: no method name found on line ``
48. ERROR: no method name found on line ``
49. ERROR: no method name found on line ``
50. ERROR: no method name found on line `);`
51. public if ( null === $totals )
52. ERROR: no method name found on line `* @since 3.5.0`
53. ERROR: no method name found on line ``
54. ERROR: no method name found on line ``
55. ERROR: no method name found on line ``
56. ERROR: no method name found on line ``
57. ERROR: no method name found on line ``
58. ERROR: no method name found on line ``
59. ERROR: no method name found on line ``
60. ERROR: no method name found on line `'date_start' => 'strval',`
61. protected initialize_queries()
62. ERROR: no method name found on line ``
63. ERROR: no method name found on line ``
64. ERROR: no method name found on line `*`
65. ERROR: no method name found on line `return $data;`
66. ERROR: no method name found on line ``
67. ERROR: no method name found on line ``
68. ERROR: no method name found on line ``
69. public get_cached_data( $cache_key )
70. public normalize_timezones( $query_args, $defaults )
71. ERROR: no method name found on line ``
72. public get_db_table_name()
73. public update_interval_boundary_dates( $query_args['after'], $query_args['before'], $query_args['interval'], $data->intervals )
74. public get_data( $query_args )
75. ERROR: no method name found on line ``
76. ERROR: no method name found on line ``
77. ERROR: no method name found on line `}`
78. ERROR: no method name found on line ``
79. ERROR: no method name found on line ``
80. ERROR: no method name found on line ``
81. ERROR: no method name found on line ``
82. ERROR: no method name found on line ``
83. ERROR: no method name found on line ``
84. ERROR: no method name found on line ``
85. ERROR: no method name found on line ``
86. ERROR: no method name found on line ``
87. ERROR: no method name found on line ``
88. ERROR: no method name found on line ``
89. ERROR: no method name found on line ``
90. ERROR: no method name found on line ``
91. ERROR: no method name found on line ``
92. ERROR: no method name found on line ``
93. ERROR: no method name found on line ``
94. ERROR: no method name found on line `*/`
95. ERROR: no method name found on line `);`
96. ERROR: no method name found on line ``
97. ERROR: no method name found on line ``
98. ERROR: no method name found on line ``
99. ERROR: no method name found on line ``
100. ERROR: no method name found on line ``
101. ERROR: no method name found on line ``
102. ERROR: no method name found on line ``
103. ERROR: no method name found on line ``
104. ERROR: no method name found on line `* Updates the database query with parameters used for Products Stats report: categories and order status.`
105. ERROR: no method name found on line ``
106. ERROR: no method name found on line ``
107. ERROR: no method name found on line ``
108. ERROR: no method name found on line ``
109. ERROR: no method name found on line ``
110. ERROR: no method name found on line ``
111. ERROR: no method name found on line ``
112. ERROR: no method name found on line ``
113. ERROR: no method name found on line ``
114. ERROR: no method name found on line ``
115. ERROR: no method name found on line ``
116. ERROR: no method name found on line ``
117. ERROR: no method name found on line ``
118. public wp_parse_args( $query_args, $defaults )
119. ERROR: no method name found on line ``
120. ERROR: no method name found on line ``
121. ERROR: no method name found on line ``
122. ERROR: no method name found on line ``
123. ERROR: no method name found on line ``
124. ERROR: no method name found on line ``
125. ERROR: no method name found on line ``
126. ERROR: no method name found on line ``
127. public cast_numbers( $totals[0] )
128. ERROR: no method name found on line ``
129. public ceil( $expected_interval_count / $limit_params['per_page'] )
130. ERROR: no method name found on line `/**`
131. ERROR: no method name found on line `*`
132. ERROR: no method name found on line ``
133. ERROR: no method name found on line ``
134. ERROR: no method name found on line ``
135. ERROR: no method name found on line ``
136. ERROR: no method name found on line `}`
137. ERROR: no method name found on line ``
138. ERROR: no method name found on line ``
139. ERROR: no method name found on line ``
140. ERROR: no method name found on line ``
141. ERROR: no method name found on line ``
142. ERROR: no method name found on line ``
143. public get_sql_clause( 'where' )
144. ERROR: no method name found on line ``
145. ERROR: no method name found on line ``
146. ERROR: no method name found on line ``
147. ERROR: no method name found on line ``
148. ERROR: no method name found on line ``
149. ERROR: no method name found on line ``
150. ERROR: no method name found on line ``
151. public selected_columns( $query_args )
152. ERROR: no method name found on line `);`
153. ERROR: no method name found on line ``
154. public intervals_between( $query_args['after'], $query_args['before'], $query_args['interval'] )
155. ERROR: no method name found on line `* Initialize query objects.`
156. ERROR: no method name found on line ``
157. ERROR: no method name found on line ``
158. ERROR: no method name found on line ``
159. public get_results(
160. ERROR: no method name found on line ``
161. ERROR: no method name found on line `'pages' => 0,`
162. ERROR: no method name found on line ``
163. ERROR: no method name found on line ``
164. ERROR: no method name found on line ``
165. ERROR: no method name found on line `/**`
166. ERROR: no method name found on line `'intervals' => $intervals,`
167. ERROR: no method name found on line ``
168. ERROR: no method name found on line ``
169. ERROR: no method name found on line ``
170. ERROR: no method name found on line ``
171. ERROR: no method name found on line ``
172. ERROR: no method name found on line ``
173. ERROR: no method name found on line ``
174. ERROR: no method name found on line ``
175. ERROR: no method name found on line ``
176. ERROR: no method name found on line ``
177. ERROR: no method name found on line ``
178. ERROR: no method name found on line ``
179. ERROR: no method name found on line ``
180. ERROR: no method name found on line ``
181. ERROR: no method name found on line ``
182. ERROR: no method name found on line `'order' => 'DESC',`
183. ERROR: no method name found on line ``
184. ERROR: no method name found on line ``
185. ERROR: no method name found on line ``
186. public update_intervals_sql_params()
187. ERROR: no method name found on line ``
188. ERROR: no method name found on line ``
189. ERROR: no method name found on line ``
190. ERROR: no method name found on line ``
191. ERROR: no method name found on line `* @param array $query_args Query arguments supplied by the user.`
192. ERROR: no method name found on line `}`

DataStore{} DataStore{} code ^{WC 7.3.0}

class DataStore extends CouponsDataStore implements DataStoreInterface {
	/**
	 * Mapping columns to data type to return correct response types.
	 *
	 * @var array
	 */
	protected $column_types = array(
		'date_start'     => 'strval',
		'date_end'       => 'strval',
		'date_start_gmt' => 'strval',
		'date_end_gmt'   => 'strval',
		'amount'         => 'floatval',
		'coupons_count'  => 'intval',
		'orders_count'   => 'intval',
	);

	/**
	 * SQL columns to select in the db query.
	 *
	 * @var array
	 */
	protected $report_columns;

	/**
	 * Data store context used to pass to filters.
	 *
	 * @var string
	 */
	protected $context = 'coupons_stats';

	/**
	 * Cache identifier.
	 *
	 * @var string
	 */
	protected $cache_key = 'coupons_stats';

	/**
	 * Assign report columns once full table name has been assigned.
	 */
	protected function assign_report_columns() {
		$table_name           = self::get_db_table_name();
		$this->report_columns = array(
			'amount'        => 'SUM(discount_amount) as amount',
			'coupons_count' => 'COUNT(DISTINCT coupon_id) as coupons_count',
			'orders_count'  => "COUNT(DISTINCT {$table_name}.order_id) as orders_count",
		);
	}

	/**
	 * Updates the database query with parameters used for Products Stats report: categories and order status.
	 *
	 * @param array $query_args       Query arguments supplied by the user.
	 */
	protected function update_sql_query_params( $query_args ) {
		global $wpdb;

		$clauses = array(
			'where' => '',
			'join'  => '',
		);

		$order_coupon_lookup_table = self::get_db_table_name();

		$included_coupons = $this->get_included_coupons( $query_args, 'coupons' );
		if ( $included_coupons ) {
			$clauses['where'] .= " AND {$order_coupon_lookup_table}.coupon_id IN ({$included_coupons})";
		}

		$order_status_filter = $this->get_status_subquery( $query_args );
		if ( $order_status_filter ) {
			$clauses['join']  .= " JOIN {$wpdb->prefix}wc_order_stats ON {$order_coupon_lookup_table}.order_id = {$wpdb->prefix}wc_order_stats.order_id";
			$clauses['where'] .= " AND ( {$order_status_filter} )";
		}

		$this->add_time_period_sql_params( $query_args, $order_coupon_lookup_table );
		$this->add_intervals_sql_params( $query_args, $order_coupon_lookup_table );
		$clauses['where_time'] = $this->get_sql_clause( 'where_time' );

		$this->interval_query->add_sql_clause( 'limit', $this->get_sql_clause( 'limit' ) );
		$this->interval_query->add_sql_clause( 'order_by', $this->get_sql_clause( 'order_by' ) );
		$this->interval_query->add_sql_clause( 'select', $this->get_sql_clause( 'select' ) );
		$this->interval_query->add_sql_clause( 'select', 'AS time_interval' );

		foreach ( array( 'join', 'where_time', 'where' ) as $clause ) {
			$this->interval_query->add_sql_clause( $clause, $clauses[ $clause ] );
			$this->total_query->add_sql_clause( $clause, $clauses[ $clause ] );
		}
	}

	/**
	 * Returns the report data based on parameters supplied by the user.
	 *
	 * @since 3.5.0
	 * @param array $query_args  Query parameters.
	 * @return stdClass|WP_Error Data.
	 */
	public function get_data( $query_args ) {
		global $wpdb;

		$table_name = self::get_db_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'  => 'date',
			'before'   => TimeInterval::default_before(),
			'after'    => TimeInterval::default_after(),
			'fields'   => '*',
			'interval' => 'week',
			'coupons'  => array(),
		);
		$query_args = wp_parse_args( $query_args, $defaults );
		$this->normalize_timezones( $query_args, $defaults );

		/*
		 * We need to get the cache key here because
		 * parent::update_intervals_sql_params() modifies $query_args.
		 */
		$cache_key = $this->get_cache_key( $query_args );
		$data      = $this->get_cached_data( $cache_key );

		if ( false === $data ) {
			$this->initialize_queries();

			$data = (object) array(
				'data'    => array(),
				'total'   => 0,
				'pages'   => 0,
				'page_no' => 0,
			);

			$selections      = $this->selected_columns( $query_args );
			$totals_query    = array();
			$intervals_query = array();
			$limit_params    = $this->get_limit_sql_params( $query_args );
			$this->update_sql_query_params( $query_args, $totals_query, $intervals_query );

			$db_intervals = $wpdb->get_col(
				$this->interval_query->get_query_statement()
			); // WPCS: cache ok, DB call ok, unprepared SQL ok.

			$db_interval_count       = count( $db_intervals );
			$expected_interval_count = TimeInterval::intervals_between( $query_args['after'], $query_args['before'], $query_args['interval'] );
			$total_pages             = (int) ceil( $expected_interval_count / $limit_params['per_page'] );
			if ( $query_args['page'] < 1 || $query_args['page'] > $total_pages ) {
				return $data;
			}

			$this->total_query->add_sql_clause( 'select', $selections );
			$totals = $wpdb->get_results(
				$this->total_query->get_query_statement(),
				ARRAY_A
			); // WPCS: cache ok, DB call ok, unprepared SQL ok.

			if ( null === $totals ) {
				return $data;
			}

			// @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' => $this->total_query->get_sql_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' => $this->interval_query->get_sql_clause( 'where_time' ),
				'where_clause'      => $this->interval_query->get_sql_clause( 'where' ),
				'limit'             => $this->get_sql_clause( 'limit' ),
			);
			$segmenter             = new Segmenter( $query_args, $this->report_columns );
			$totals[0]['segments'] = $segmenter->get_totals_segments( $totals_query, $table_name );
			$totals                = (object) $this->cast_numbers( $totals[0] );

			// Intervals.
			$this->update_intervals_sql_params( $query_args, $db_interval_count, $expected_interval_count, $table_name );
			$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(
				$this->interval_query->get_query_statement(),
				ARRAY_A
			); // WPCS: cache ok, DB call ok, unprepared SQL ok.

			if ( null === $intervals ) {
				return $data;
			}

			$data = (object) array(
				'totals'    => $totals,
				'intervals' => $intervals,
				'total'     => $expected_interval_count,
				'pages'     => $total_pages,
				'page_no'   => (int) $query_args['page'],
			);

			if ( TimeInterval::intervals_missing( $expected_interval_count, $db_interval_count, $limit_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'], $limit_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 );
			$this->create_interval_subtotals( $data->intervals );

			$this->set_cached_data( $cache_key, $data );
		}

		return $data;
	}

	/**
	 * Initialize query objects.
	 */
	protected function initialize_queries() {
		$this->clear_all_clauses();
		unset( $this->subquery );
		$this->total_query = new SqlQuery( $this->context . '_total' );
		$this->total_query->add_sql_clause( 'from', self::get_db_table_name() );

		$this->interval_query = new SqlQuery( $this->context . '_interval' );
		$this->interval_query->add_sql_clause( 'from', self::get_db_table_name() );
		$this->interval_query->add_sql_clause( 'group_by', 'time_interval' );
	}
}