Passed
Push — master ( 5faead...57234e )
by Brian
04:33
created
widgets/subscriptions.php 1 patch
Indentation   +332 added lines, -332 removed lines patch added patch discarded remove patch
@@ -14,144 +14,144 @@  discard block
 block discarded – undo
14 14
  */
15 15
 class WPInv_Subscriptions_Widget extends WP_Super_Duper {
16 16
 
17
-	/**
18
-	 * Register the widget with WordPress.
19
-	 *
20
-	 */
21
-	public function __construct() {
22
-
23
-		$options = array(
24
-			'textdomain'    => 'invoicing',
25
-			'block-icon'    => 'controls-repeat',
26
-			'block-category'=> 'widgets',
27
-			'block-keywords'=> "['invoicing','subscriptions', 'getpaid']",
28
-			'class_name'     => __CLASS__,
29
-			'base_id'       => 'wpinv_subscriptions',
30
-			'name'          => __( 'GetPaid > Subscriptions', 'invoicing' ),
31
-			'widget_ops'    => array(
32
-				'classname'   => 'getpaid-subscriptions bsui',
33
-				'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ),
34
-			),
35
-			'arguments'     => array(
36
-				'title'  => array(
37
-					'title'       => __( 'Widget title', 'invoicing' ),
38
-					'desc'        => __( 'Enter widget title.', 'invoicing' ),
39
-					'type'        => 'text',
40
-					'desc_tip'    => true,
41
-					'default'     => '',
42
-					'advanced'    => false
43
-				),
44
-			)
45
-
46
-		);
47
-
48
-
49
-		parent::__construct( $options );
50
-	}
51
-
52
-	/**
53
-	 * Retrieves current user's subscriptions.
54
-	 *
55
-	 * @return GetPaid_Subscriptions_Query
56
-	 */
57
-	public function get_subscriptions() {
58
-
59
-		// Prepare license args.
60
-		$args  = array(
61
-			'customer_in' => get_current_user_id(),
62
-			'paged'       => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1,
63
-		);
64
-
65
-		return new GetPaid_Subscriptions_Query( $args );
66
-
67
-	}
68
-
69
-	/**
70
-	 * The Super block output function.
71
-	 *
72
-	 * @param array $args
73
-	 * @param array $widget_args
74
-	 * @param string $content
75
-	 *
76
-	 * @return mixed|string|bool
77
-	 */
78
-	public function output( $args = array(), $widget_args = array(), $content = '' ) {
79
-
80
-		// Ensure that the user is logged in.
81
-		if ( ! is_user_logged_in() ) {
82
-
83
-			return aui()->alert(
84
-				array(
85
-					'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ),
86
-					'type'    => 'error',
87
-				)
88
-			);
89
-
90
-		}
91
-
92
-		// Are we displaying a single subscription?
93
-		if ( isset( $_GET['subscription'] ) ) {
94
-			return $this->display_single_subscription( trim( $_GET['subscription'] ) );
95
-		}
96
-
97
-		// Retrieve the user's subscriptions.
98
-		$subscriptions = $this->get_subscriptions();
99
-
100
-		// Start the output buffer.
101
-		ob_start();
102
-
103
-		// Backwards compatibility.
104
-		do_action( 'wpinv_before_user_subscriptions' );
105
-
106
-		// Display errors and notices.
107
-		wpinv_print_errors();
108
-
109
-		do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions );
110
-
111
-		// Print the table header.
112
-		$this->print_table_header();
113
-
114
-		// Print table body.
115
-		$this->print_table_body( $subscriptions->get_results() );
116
-
117
-		// Print table footer.
118
-		$this->print_table_footer();
119
-
120
-		// Print the navigation.
121
-		$this->print_navigation( $subscriptions->get_total() );
122
-
123
-		// Backwards compatibility.
124
-		do_action( 'wpinv_after_user_subscriptions' );
125
-
126
-		// Return the output.
127
-		return ob_get_clean();
128
-
129
-	}
130
-
131
-	/**
132
-	 * Retrieves the subscription columns.
133
-	 *
134
-	 * @return array
135
-	 */
136
-	public function get_subscriptions_table_columns() {
17
+    /**
18
+     * Register the widget with WordPress.
19
+     *
20
+     */
21
+    public function __construct() {
22
+
23
+        $options = array(
24
+            'textdomain'    => 'invoicing',
25
+            'block-icon'    => 'controls-repeat',
26
+            'block-category'=> 'widgets',
27
+            'block-keywords'=> "['invoicing','subscriptions', 'getpaid']",
28
+            'class_name'     => __CLASS__,
29
+            'base_id'       => 'wpinv_subscriptions',
30
+            'name'          => __( 'GetPaid > Subscriptions', 'invoicing' ),
31
+            'widget_ops'    => array(
32
+                'classname'   => 'getpaid-subscriptions bsui',
33
+                'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ),
34
+            ),
35
+            'arguments'     => array(
36
+                'title'  => array(
37
+                    'title'       => __( 'Widget title', 'invoicing' ),
38
+                    'desc'        => __( 'Enter widget title.', 'invoicing' ),
39
+                    'type'        => 'text',
40
+                    'desc_tip'    => true,
41
+                    'default'     => '',
42
+                    'advanced'    => false
43
+                ),
44
+            )
45
+
46
+        );
47
+
48
+
49
+        parent::__construct( $options );
50
+    }
51
+
52
+    /**
53
+     * Retrieves current user's subscriptions.
54
+     *
55
+     * @return GetPaid_Subscriptions_Query
56
+     */
57
+    public function get_subscriptions() {
58
+
59
+        // Prepare license args.
60
+        $args  = array(
61
+            'customer_in' => get_current_user_id(),
62
+            'paged'       => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1,
63
+        );
64
+
65
+        return new GetPaid_Subscriptions_Query( $args );
66
+
67
+    }
68
+
69
+    /**
70
+     * The Super block output function.
71
+     *
72
+     * @param array $args
73
+     * @param array $widget_args
74
+     * @param string $content
75
+     *
76
+     * @return mixed|string|bool
77
+     */
78
+    public function output( $args = array(), $widget_args = array(), $content = '' ) {
79
+
80
+        // Ensure that the user is logged in.
81
+        if ( ! is_user_logged_in() ) {
82
+
83
+            return aui()->alert(
84
+                array(
85
+                    'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ),
86
+                    'type'    => 'error',
87
+                )
88
+            );
89
+
90
+        }
91
+
92
+        // Are we displaying a single subscription?
93
+        if ( isset( $_GET['subscription'] ) ) {
94
+            return $this->display_single_subscription( trim( $_GET['subscription'] ) );
95
+        }
96
+
97
+        // Retrieve the user's subscriptions.
98
+        $subscriptions = $this->get_subscriptions();
99
+
100
+        // Start the output buffer.
101
+        ob_start();
102
+
103
+        // Backwards compatibility.
104
+        do_action( 'wpinv_before_user_subscriptions' );
105
+
106
+        // Display errors and notices.
107
+        wpinv_print_errors();
108
+
109
+        do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions );
110
+
111
+        // Print the table header.
112
+        $this->print_table_header();
113
+
114
+        // Print table body.
115
+        $this->print_table_body( $subscriptions->get_results() );
116
+
117
+        // Print table footer.
118
+        $this->print_table_footer();
119
+
120
+        // Print the navigation.
121
+        $this->print_navigation( $subscriptions->get_total() );
122
+
123
+        // Backwards compatibility.
124
+        do_action( 'wpinv_after_user_subscriptions' );
125
+
126
+        // Return the output.
127
+        return ob_get_clean();
128
+
129
+    }
130
+
131
+    /**
132
+     * Retrieves the subscription columns.
133
+     *
134
+     * @return array
135
+     */
136
+    public function get_subscriptions_table_columns() {
137 137
 
138
-		$columns = array(
139
-			'subscription'   => __( 'Subscription', 'invoicing' ),
140
-			'amount'         => __( 'Amount', 'invoicing' ),
141
-			'renewal-date'   => __( 'Next payment', 'invoicing' ),
142
-			'status'         => __( 'Status', 'invoicing' ),
143
-		);
138
+        $columns = array(
139
+            'subscription'   => __( 'Subscription', 'invoicing' ),
140
+            'amount'         => __( 'Amount', 'invoicing' ),
141
+            'renewal-date'   => __( 'Next payment', 'invoicing' ),
142
+            'status'         => __( 'Status', 'invoicing' ),
143
+        );
144 144
 
145
-		return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns );
146
-	}
145
+        return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns );
146
+    }
147 147
 
148
-	/**
149
-	 * Displays the table header.
150
-	 *
151
-	 */
152
-	public function print_table_header() {
148
+    /**
149
+     * Displays the table header.
150
+     *
151
+     */
152
+    public function print_table_header() {
153 153
 
154
-		?>
154
+        ?>
155 155
 
156 156
 			<table class="table table-bordered table-striped">
157 157
 
@@ -167,121 +167,121 @@  discard block
 block discarded – undo
167 167
 
168 168
 		<?php
169 169
 
170
-	}
170
+    }
171 171
 
172
-	/**
173
-	 * Displays the table body.
174
-	 *
175
-	 * @param WPInv_Subscription[] $subscriptions
176
-	 */
177
-	public function print_table_body( $subscriptions ) {
172
+    /**
173
+     * Displays the table body.
174
+     *
175
+     * @param WPInv_Subscription[] $subscriptions
176
+     */
177
+    public function print_table_body( $subscriptions ) {
178 178
 
179
-		if ( empty( $subscriptions ) ) {
180
-			$this->print_table_body_no_subscriptions();
181
-		} else {
182
-			$this->print_table_body_subscriptions( $subscriptions );
183
-		}
179
+        if ( empty( $subscriptions ) ) {
180
+            $this->print_table_body_no_subscriptions();
181
+        } else {
182
+            $this->print_table_body_subscriptions( $subscriptions );
183
+        }
184 184
 
185
-	}
185
+    }
186 186
 
187
-	/**
188
-	 * Displays the table body if no subscriptions were found.
189
-	 *
190
-	 */
191
-	public function print_table_body_no_subscriptions() {
187
+    /**
188
+     * Displays the table body if no subscriptions were found.
189
+     *
190
+     */
191
+    public function print_table_body_no_subscriptions() {
192 192
 
193
-		?>
193
+        ?>
194 194
 		<tbody>
195 195
 
196 196
 			<tr>
197 197
 				<td colspan="<?php echo count( $this->get_subscriptions_table_columns() ); ?>">
198 198
 
199 199
 					<?php
200
-						echo aui()->alert(
201
-							array(
202
-								'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ),
203
-								'type'    => 'warning',
204
-							)
205
-						);
206
-					?>
200
+                        echo aui()->alert(
201
+                            array(
202
+                                'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ),
203
+                                'type'    => 'warning',
204
+                            )
205
+                        );
206
+                    ?>
207 207
 
208 208
 				</td>
209 209
 			</tr>
210 210
 
211 211
 		</tbody>
212 212
 		<?php
213
-	}
213
+    }
214 214
 
215
-	/**
216
-	 * Displays the table body if subscriptions were found.
217
-	 *
218
-	 * @param WPInv_Subscription[] $subscriptions
219
-	 */
220
-	public function print_table_body_subscriptions( $subscriptions ) {
215
+    /**
216
+     * Displays the table body if subscriptions were found.
217
+     *
218
+     * @param WPInv_Subscription[] $subscriptions
219
+     */
220
+    public function print_table_body_subscriptions( $subscriptions ) {
221 221
 
222
-		?>
222
+        ?>
223 223
 		<tbody>
224 224
 
225 225
 			<?php foreach ( $subscriptions as $subscription ) : ?>
226 226
 				<tr class="getpaid-subscriptions-table-row subscription-<?php echo (int) $subscription->get_id(); ?>">
227 227
 					<?php
228
-						wpinv_get_template(
229
-							'subscriptions/subscriptions-table-row.php',
230
-							array(
231
-								'subscription' => $subscription,
232
-								'widget'       => $this
233
-							)
234
-						);
235
-					?>
228
+                        wpinv_get_template(
229
+                            'subscriptions/subscriptions-table-row.php',
230
+                            array(
231
+                                'subscription' => $subscription,
232
+                                'widget'       => $this
233
+                            )
234
+                        );
235
+                    ?>
236 236
 				</tr>
237 237
 			<?php endforeach; ?>
238 238
 
239 239
 		</tbody>
240 240
 		<?php
241
-	}
242
-
243
-	/**
244
-	 * Adds row actions to a column
245
-	 *
246
-	 * @param string $content column content
247
-	 * @param WPInv_Subscription $subscription
248
-	 * @since       1.0.0
249
-	 * @return      string
250
-	 */
251
-	public function add_row_actions( $content, $subscription ) {
252
-
253
-		// Prepare row actions.
254
-		$actions = array();
255
-
256
-		// View subscription action.
257
-		$view_url        = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) );
258
-		$view_url        = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), $view_url ) );
259
-		$actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>';
260
-
261
-		// Filter the actions.
262
-		$actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription );
263
-
264
-		$sanitized  = array();
265
-		foreach ( $actions as $key => $action ) {
266
-			$key         = sanitize_html_class( $key );
267
-			$action      = wp_kses_post( $action );
268
-			$sanitized[] = "<span class='$key'>$action</span>";
269
-		}
270
-
271
-		$row_actions  = "<small class='form-text getpaid-subscription-item-actions'>";
272
-		$row_actions .= implode( ' | ', $sanitized );
273
-		$row_actions .= '</small>';
274
-
275
-		return $content . $row_actions;
276
-	}
277
-
278
-	/**
279
-	 * Displays the table footer.
280
-	 *
281
-	 */
282
-	public function print_table_footer() {
283
-
284
-		?>
241
+    }
242
+
243
+    /**
244
+     * Adds row actions to a column
245
+     *
246
+     * @param string $content column content
247
+     * @param WPInv_Subscription $subscription
248
+     * @since       1.0.0
249
+     * @return      string
250
+     */
251
+    public function add_row_actions( $content, $subscription ) {
252
+
253
+        // Prepare row actions.
254
+        $actions = array();
255
+
256
+        // View subscription action.
257
+        $view_url        = getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) );
258
+        $view_url        = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), $view_url ) );
259
+        $actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>';
260
+
261
+        // Filter the actions.
262
+        $actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription );
263
+
264
+        $sanitized  = array();
265
+        foreach ( $actions as $key => $action ) {
266
+            $key         = sanitize_html_class( $key );
267
+            $action      = wp_kses_post( $action );
268
+            $sanitized[] = "<span class='$key'>$action</span>";
269
+        }
270
+
271
+        $row_actions  = "<small class='form-text getpaid-subscription-item-actions'>";
272
+        $row_actions .= implode( ' | ', $sanitized );
273
+        $row_actions .= '</small>';
274
+
275
+        return $content . $row_actions;
276
+    }
277
+
278
+    /**
279
+     * Displays the table footer.
280
+     *
281
+     */
282
+    public function print_table_footer() {
283
+
284
+        ?>
285 285
 
286 286
 				<tfoot>
287 287
 					<tr>
@@ -296,129 +296,129 @@  discard block
 block discarded – undo
296 296
 			</table>
297 297
 		<?php
298 298
 
299
-	}
299
+    }
300 300
 
301
-	/**
302
-	 * Displays the navigation.
303
-	 *
304
-	 * @param int $total
305
-	 */
306
-	public function print_navigation( $total ) {
301
+    /**
302
+     * Displays the navigation.
303
+     *
304
+     * @param int $total
305
+     */
306
+    public function print_navigation( $total ) {
307 307
 
308
-		if ( $total < 1 ) {
308
+        if ( $total < 1 ) {
309 309
 
310
-			// Out-of-bounds, run the query again without LIMIT for total count.
311
-			$args  = array(
312
-				'customer_in' => get_current_user_id(),
313
-				'fields'      => 'id',
314
-			);
310
+            // Out-of-bounds, run the query again without LIMIT for total count.
311
+            $args  = array(
312
+                'customer_in' => get_current_user_id(),
313
+                'fields'      => 'id',
314
+            );
315 315
 
316
-			$count_query = new GetPaid_Subscriptions_Query( $args );
317
-			$total       = $count_query->get_total();
318
-		}
316
+            $count_query = new GetPaid_Subscriptions_Query( $args );
317
+            $total       = $count_query->get_total();
318
+        }
319 319
 
320
-		// Abort if we do not have pages.
321
-		if ( 2 > $total ) {
322
-			return;
323
-		}
320
+        // Abort if we do not have pages.
321
+        if ( 2 > $total ) {
322
+            return;
323
+        }
324 324
 
325
-		?>
325
+        ?>
326 326
 
327 327
 		<div class="getpaid-subscriptions-pagination">
328 328
 			<?php
329
-				$big = 999999;
330
-
331
-				echo getpaid_paginate_links(
332
-					array(
333
-						'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
334
-						'format'  => '?paged=%#%',
335
-						'total'   => (int) ceil( $total / 10 ),
336
-					)
337
-				);
338
-			?>
329
+                $big = 999999;
330
+
331
+                echo getpaid_paginate_links(
332
+                    array(
333
+                        'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
334
+                        'format'  => '?paged=%#%',
335
+                        'total'   => (int) ceil( $total / 10 ),
336
+                    )
337
+                );
338
+            ?>
339 339
 		</div>
340 340
 
341 341
 		<?php
342
-	}
343
-
344
-	/**
345
-	 * Returns a single subscription's columns.
346
-	 *
347
-	 * @param WPInv_Subscription $subscription
348
-	 *
349
-	 * @return array
350
-	 */
351
-	public function get_single_subscription_columns( $subscription ) {
352
-
353
-		// Prepare subscription detail columns.
354
-		$fields = apply_filters(
355
-			'getpaid_single_subscription_details_fields',
356
-			array(
357
-				'status'           => __( 'Status', 'invoicing' ),
358
-				'initial_amount'   => __( 'Initial amount', 'invoicing' ),
359
-				'recurring_amount' => __( 'Recurring amount', 'invoicing' ),
360
-				'start_date'       => __( 'Start date', 'invoicing' ),
361
-				'expiry_date'      => __( 'Next payment', 'invoicing' ),
362
-				'payments'         => __( 'Payments', 'invoicing' ),
363
-				'item'             => __( 'Item', 'invoicing' ),
364
-			),
365
-			$subscription
366
-		);
367
-
368
-		if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) {
369
-			$fields['expiry_date'] = __( 'End date', 'invoicing' );
370
-		}
371
-
372
-		if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) {
373
-			unset( $fields['initial_amount'] );
374
-		}
375
-
376
-		return $fields;
377
-	}
378
-
379
-	/**
380
-	 * Displays a single subscription.
381
-	 *
382
-	 * @param string $subscription
383
-	 *
384
-	 * @return string
385
-	 */
386
-	public function display_single_subscription( $subscription ) {
387
-
388
-		// Fetch the subscription.
389
-		$subscription = new WPInv_Subscription( (int) $subscription );
390
-
391
-		if ( ! $subscription->get_id() ) {
392
-
393
-			return aui()->alert(
394
-				array(
395
-					'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ),
396
-					'type'    => 'error',
397
-				)
398
-			);
399
-
400
-		}
401
-
402
-		// Ensure that the user owns this subscription key.
403
-		if ( get_current_user_id() != $subscription->get_customer_id() ) {
404
-
405
-			return aui()->alert(
406
-				array(
407
-					'content' => wp_kses_post( __( 'You do not have permission to view this subscription. Ensure that you are logged in to the account that owns the subscription.', 'invoicing' ) ),
408
-					'type'    => 'error',
409
-				)
410
-			);
411
-
412
-		}
413
-
414
-		return wpinv_get_template_html(
415
-			'subscriptions/subscription-details.php',
416
-			array(
417
-				'subscription' => $subscription,
418
-				'widget'       => $this
419
-			)
420
-		);
421
-
422
-	}
342
+    }
343
+
344
+    /**
345
+     * Returns a single subscription's columns.
346
+     *
347
+     * @param WPInv_Subscription $subscription
348
+     *
349
+     * @return array
350
+     */
351
+    public function get_single_subscription_columns( $subscription ) {
352
+
353
+        // Prepare subscription detail columns.
354
+        $fields = apply_filters(
355
+            'getpaid_single_subscription_details_fields',
356
+            array(
357
+                'status'           => __( 'Status', 'invoicing' ),
358
+                'initial_amount'   => __( 'Initial amount', 'invoicing' ),
359
+                'recurring_amount' => __( 'Recurring amount', 'invoicing' ),
360
+                'start_date'       => __( 'Start date', 'invoicing' ),
361
+                'expiry_date'      => __( 'Next payment', 'invoicing' ),
362
+                'payments'         => __( 'Payments', 'invoicing' ),
363
+                'item'             => __( 'Item', 'invoicing' ),
364
+            ),
365
+            $subscription
366
+        );
367
+
368
+        if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) {
369
+            $fields['expiry_date'] = __( 'End date', 'invoicing' );
370
+        }
371
+
372
+        if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) {
373
+            unset( $fields['initial_amount'] );
374
+        }
375
+
376
+        return $fields;
377
+    }
378
+
379
+    /**
380
+     * Displays a single subscription.
381
+     *
382
+     * @param string $subscription
383
+     *
384
+     * @return string
385
+     */
386
+    public function display_single_subscription( $subscription ) {
387
+
388
+        // Fetch the subscription.
389
+        $subscription = new WPInv_Subscription( (int) $subscription );
390
+
391
+        if ( ! $subscription->get_id() ) {
392
+
393
+            return aui()->alert(
394
+                array(
395
+                    'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ),
396
+                    'type'    => 'error',
397
+                )
398
+            );
399
+
400
+        }
401
+
402
+        // Ensure that the user owns this subscription key.
403
+        if ( get_current_user_id() != $subscription->get_customer_id() ) {
404
+
405
+            return aui()->alert(
406
+                array(
407
+                    'content' => wp_kses_post( __( 'You do not have permission to view this subscription. Ensure that you are logged in to the account that owns the subscription.', 'invoicing' ) ),
408
+                    'type'    => 'error',
409
+                )
410
+            );
411
+
412
+        }
413
+
414
+        return wpinv_get_template_html(
415
+            'subscriptions/subscription-details.php',
416
+            array(
417
+                'subscription' => $subscription,
418
+                'widget'       => $this
419
+            )
420
+        );
421
+
422
+    }
423 423
 
424 424
 }
Please login to merge, or discard this patch.
includes/invoice-functions.php 1 patch
Indentation   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -67,7 +67,7 @@  discard block
 block discarded – undo
67 67
  * Checks if the current user cna view an invoice receipt.
68 68
  */
69 69
 function wpinv_can_view_receipt( $invoice ) {
70
-	return (bool) apply_filters( 'wpinv_can_view_receipt', wpinv_user_can_view_invoice( $invoice ), $invoice );
70
+    return (bool) apply_filters( 'wpinv_can_view_receipt', wpinv_user_can_view_invoice( $invoice ), $invoice );
71 71
 }
72 72
 
73 73
 /**
@@ -1256,21 +1256,21 @@  discard block
 block discarded – undo
1256 1256
  */
1257 1257
 function getpaid_get_invoice_status_classes() {
1258 1258
 
1259
-	return apply_filters(
1260
-		'getpaid_get_invoice_status_classes',
1261
-		array(
1259
+    return apply_filters(
1260
+        'getpaid_get_invoice_status_classes',
1261
+        array(
1262 1262
             'wpi-quote-declined' => 'badge-danger',
1263 1263
             'wpi-failed'         => 'badge-danger',
1264
-			'wpi-processing'     => 'badge-info',
1265
-			'wpi-onhold'         => 'badge-warning',
1266
-			'wpi-quote-accepted' => 'badge-success',
1267
-			'publish'            => 'badge-success',
1268
-			'wpi-renewal'        => 'badge-primary',
1264
+            'wpi-processing'     => 'badge-info',
1265
+            'wpi-onhold'         => 'badge-warning',
1266
+            'wpi-quote-accepted' => 'badge-success',
1267
+            'publish'            => 'badge-success',
1268
+            'wpi-renewal'        => 'badge-primary',
1269 1269
             'wpi-cancelled'      => 'badge-secondary',
1270 1270
             'wpi-pending'        => 'badge-dark',
1271 1271
             'wpi-quote-pending'  => 'badge-dark',
1272 1272
             'wpi-refunded'       => 'badge-secondary',
1273
-		)
1274
-	);
1273
+        )
1274
+    );
1275 1275
 
1276 1276
 }
Please login to merge, or discard this patch.
includes/api/class-getpaid-rest-settings-controller.php 1 patch
Indentation   +749 added lines, -749 removed lines patch added patch discarded remove patch
@@ -18,758 +18,758 @@
 block discarded – undo
18 18
  */
19 19
 class GetPaid_REST_Settings_Controller extends GetPaid_REST_Controller {
20 20
 
21
-	/**
22
-	 * An array of available settings.
23
-	 *
24
-	 * @var string
25
-	 */
26
-	protected $settings;
27
-
28
-	/**
29
-	 * Route base.
30
-	 *
31
-	 * @var string
32
-	 */
33
-	protected $rest_base = 'settings';
34
-
35
-	/**
36
-	 * Registers the routes for the objects of the controller.
37
-	 *
38
-	 * @since 2.0.0
39
-	 *
40
-	 * @see register_rest_route()
41
-	 */
42
-	public function register_namespace_routes( $namespace ) {
43
-
44
-		// List all registered tabs.
45
-		register_rest_route(
46
-			$namespace,
47
-			$this->rest_base,
48
-			array(
49
-				array(
50
-					'methods'             => WP_REST_Server::READABLE,
51
-					'callback'            => array( $this, 'get_tabs' ),
52
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
53
-				),
54
-				'schema' => '__return_empty_array',
55
-			)
56
-		);
57
-
58
-		// View/Update a single setting.
59
-		register_rest_route(
60
-			$namespace,
61
-			$this->rest_base . '/setting/(?P<id>[\w-]+)',
62
-			array(
63
-				'args'   => array(
64
-					'id'    => array(
65
-						'description' => __( 'Unique identifier for the setting.', 'invoicing' ),
66
-						'type'        => 'string',
67
-						'required'    => true,
68
-					),
69
-				),
70
-				array(
71
-					'methods'             => WP_REST_Server::READABLE,
72
-					'callback'            => array( $this, 'get_item' ),
73
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
74
-				),
75
-				array(
76
-					'methods'             => WP_REST_Server::EDITABLE,
77
-					'callback'            => array( $this, 'update_item' ),
78
-					'permission_callback' => array( $this, 'update_items_permissions_check' ),
79
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
80
-				),
81
-				'schema' => array( $this, 'get_public_item_schema' ),
82
-			)
83
-		);
84
-
85
-		// List registered sections for a given tab.
86
-		register_rest_route(
87
-			$namespace,
88
-			$this->rest_base . '/(?P<tab>[\w-]+)',
89
-			array(
90
-				'args'   => array(
91
-					'tab'    => array(
92
-						'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ),
93
-						'type'        => 'string',
94
-						'required'    => true,
95
-						'enum'        => array_keys( wpinv_get_settings_tabs() ),
96
-					),
97
-				),
98
-				array(
99
-					'methods'             => WP_REST_Server::READABLE,
100
-					'callback'            => array( $this, 'get_sections' ),
101
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
102
-				),
103
-				'schema' => '__return_empty_array',
104
-			)
105
-		);
106
-
107
-		// List all registered settings for a given tab.
108
-		register_rest_route(
109
-			$namespace,
110
-			$this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)',
111
-			array(
112
-				'args'   => array(
113
-					'tab'    => array(
114
-						'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ),
115
-						'type'        => 'string',
116
-						'required'    => true,
117
-						'enum'        => array_keys( wpinv_get_settings_tabs() ),
118
-					),
119
-					'section'    => array(
120
-						'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ),
121
-						'type'        => 'string',
122
-						'required'    => true,
123
-					),
124
-				),
125
-				array(
126
-					'methods'             => WP_REST_Server::READABLE,
127
-					'callback'            => array( $this, 'get_items' ),
128
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
129
-				),
130
-				'schema' => array( $this, 'get_public_item_schema' ),
131
-			)
132
-		);
133
-
134
-		register_rest_route(
135
-			$namespace,
136
-			'/' . $this->rest_base . '/batch',
137
-			array(
138
-				'args'   => array(
139
-					'id'              => array(
140
-						'description' => __( 'Setting ID.', 'invoicing' ),
141
-						'type'        => 'string',
142
-					),
143
-				),
144
-				array(
145
-					'methods'             => WP_REST_Server::EDITABLE,
146
-					'callback'            => array( $this, 'batch_items' ),
147
-					'permission_callback' => array( $this, 'batch_items_permissions_check' ),
148
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
149
-				),
150
-				'schema' => array( $this, 'get_public_batch_schema' ),
151
-			)
152
-		);
153
-
154
-	}
21
+    /**
22
+     * An array of available settings.
23
+     *
24
+     * @var string
25
+     */
26
+    protected $settings;
27
+
28
+    /**
29
+     * Route base.
30
+     *
31
+     * @var string
32
+     */
33
+    protected $rest_base = 'settings';
34
+
35
+    /**
36
+     * Registers the routes for the objects of the controller.
37
+     *
38
+     * @since 2.0.0
39
+     *
40
+     * @see register_rest_route()
41
+     */
42
+    public function register_namespace_routes( $namespace ) {
43
+
44
+        // List all registered tabs.
45
+        register_rest_route(
46
+            $namespace,
47
+            $this->rest_base,
48
+            array(
49
+                array(
50
+                    'methods'             => WP_REST_Server::READABLE,
51
+                    'callback'            => array( $this, 'get_tabs' ),
52
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
53
+                ),
54
+                'schema' => '__return_empty_array',
55
+            )
56
+        );
57
+
58
+        // View/Update a single setting.
59
+        register_rest_route(
60
+            $namespace,
61
+            $this->rest_base . '/setting/(?P<id>[\w-]+)',
62
+            array(
63
+                'args'   => array(
64
+                    'id'    => array(
65
+                        'description' => __( 'Unique identifier for the setting.', 'invoicing' ),
66
+                        'type'        => 'string',
67
+                        'required'    => true,
68
+                    ),
69
+                ),
70
+                array(
71
+                    'methods'             => WP_REST_Server::READABLE,
72
+                    'callback'            => array( $this, 'get_item' ),
73
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
74
+                ),
75
+                array(
76
+                    'methods'             => WP_REST_Server::EDITABLE,
77
+                    'callback'            => array( $this, 'update_item' ),
78
+                    'permission_callback' => array( $this, 'update_items_permissions_check' ),
79
+                    'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
80
+                ),
81
+                'schema' => array( $this, 'get_public_item_schema' ),
82
+            )
83
+        );
84
+
85
+        // List registered sections for a given tab.
86
+        register_rest_route(
87
+            $namespace,
88
+            $this->rest_base . '/(?P<tab>[\w-]+)',
89
+            array(
90
+                'args'   => array(
91
+                    'tab'    => array(
92
+                        'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ),
93
+                        'type'        => 'string',
94
+                        'required'    => true,
95
+                        'enum'        => array_keys( wpinv_get_settings_tabs() ),
96
+                    ),
97
+                ),
98
+                array(
99
+                    'methods'             => WP_REST_Server::READABLE,
100
+                    'callback'            => array( $this, 'get_sections' ),
101
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
102
+                ),
103
+                'schema' => '__return_empty_array',
104
+            )
105
+        );
106
+
107
+        // List all registered settings for a given tab.
108
+        register_rest_route(
109
+            $namespace,
110
+            $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)',
111
+            array(
112
+                'args'   => array(
113
+                    'tab'    => array(
114
+                        'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ),
115
+                        'type'        => 'string',
116
+                        'required'    => true,
117
+                        'enum'        => array_keys( wpinv_get_settings_tabs() ),
118
+                    ),
119
+                    'section'    => array(
120
+                        'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ),
121
+                        'type'        => 'string',
122
+                        'required'    => true,
123
+                    ),
124
+                ),
125
+                array(
126
+                    'methods'             => WP_REST_Server::READABLE,
127
+                    'callback'            => array( $this, 'get_items' ),
128
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
129
+                ),
130
+                'schema' => array( $this, 'get_public_item_schema' ),
131
+            )
132
+        );
133
+
134
+        register_rest_route(
135
+            $namespace,
136
+            '/' . $this->rest_base . '/batch',
137
+            array(
138
+                'args'   => array(
139
+                    'id'              => array(
140
+                        'description' => __( 'Setting ID.', 'invoicing' ),
141
+                        'type'        => 'string',
142
+                    ),
143
+                ),
144
+                array(
145
+                    'methods'             => WP_REST_Server::EDITABLE,
146
+                    'callback'            => array( $this, 'batch_items' ),
147
+                    'permission_callback' => array( $this, 'batch_items_permissions_check' ),
148
+                    'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
149
+                ),
150
+                'schema' => array( $this, 'get_public_batch_schema' ),
151
+            )
152
+        );
153
+
154
+    }
155 155
 	
156
-	/**
157
-	 * Return all settings.
158
-	 *
159
-	 * @since  2.0.0
160
-	 * @param  WP_REST_Request $request Request data.
161
-	 * @return WP_Error|WP_REST_Response
162
-	 */
163
-	public function get_items( $request ) {
164
-
165
-		$settings = $this->get_settings();
166
-
167
-		if ( ! isset( $settings[ $request['tab'] ] ) ) {
168
-			return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) );
169
-		}
170
-
171
-		if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) {
172
-			return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) );
173
-		}
174
-
175
-		$settings = $settings[ $request['tab'] ][ $request['section'] ];
176
-		$prepared = array();
177
-
178
-		foreach ( $settings as $setting ) {
179
-
180
-			$setting      = $this->sanitize_setting( $setting );
181
-			$setting_data = $this->prepare_item_for_response( $setting, $request );
182
-			$setting_data = $this->prepare_response_for_collection( $setting_data );
183
-
184
-			if ( $this->is_setting_type_valid( $setting['type'] ) ) {
185
-				$prepared[]   = $setting_data;
186
-			}
187
-
188
-		}
189
-
190
-		return rest_ensure_response( $prepared );
191
-	}
192
-
193
-	/**
194
-	 * Return a single setting.
195
-	 *
196
-	 * @since  2.0.0
197
-	 * @param  WP_REST_Request $request Request data.
198
-	 * @return WP_Error|WP_REST_Response
199
-	 */
200
-	public function get_item( $request ) {
201
-		$setting  = $this->get_setting( $request['id'] );
202
-
203
-		if ( is_wp_error( $setting ) ) {
204
-			return $setting;
205
-		}
206
-
207
-		$setting  = $this->sanitize_setting( $setting );
208
-		$response = $this->prepare_item_for_response( $setting, $request );
209
-		return rest_ensure_response( $response );
210
-	}
211
-
212
-	/**
213
-	 * Update a single setting.
214
-	 *
215
-	 * @since  2.0.0
216
-	 * @param  WP_REST_Request $request Request data.
217
-	 * @return WP_Error|WP_REST_Response
218
-	 */
219
-	public function update_item( $request ) {
220
-		$setting = $this->get_setting( $request['id'] );
221
-
222
-		if ( is_wp_error( $setting ) ) {
223
-			return $setting;
224
-		}
225
-
226
-		if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) {
227
-			$value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting );
228
-		} else {
229
-			$value = $this->validate_setting_text_field( $request['value'], $setting );
230
-		}
231
-
232
-		if ( is_wp_error( $value ) ) {
233
-			return $value;
234
-		}
235
-
236
-		wpinv_update_option( $request['id'], $value );
237
-		$setting['value'] = $value;
238
-		$setting          = $this->sanitize_setting( $setting );
239
-		$response         = $this->prepare_item_for_response( $setting, $request );
240
-
241
-		return rest_ensure_response( $response );
242
-	}
243
-
244
-	/**
245
-	 * Makes sure the current user has access to READ the settings APIs.
246
-	 *
247
-	 * @since  2.0.0
248
-	 * @param WP_REST_Request $request Full data about the request.
249
-	 * @return WP_Error|boolean
250
-	 */
251
-	public function get_items_permissions_check( $request ) {
252
-		if ( ! wpinv_current_user_can_manage_invoicing() ) {
253
-			return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
254
-		}
255
-
256
-		return true;
257
-	}
258
-
259
-	/**
260
-	 * Makes sure the current user has access to WRITE the settings APIs.
261
-	 *
262
-	 * @since  2.0.0
263
-	 * @param WP_REST_Request $request Full data about the request.
264
-	 * @return WP_Error|boolean
265
-	 */
266
-	public function update_items_permissions_check( $request ) {
267
-		if ( ! wpinv_current_user_can_manage_invoicing() ) {
268
-			return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
269
-		}
270
-
271
-		return true;
272
-	}
273
-
274
-	/**
275
-	 * Check if a given request has access batch create, update and delete items.
276
-	 *
277
-	 * @param  WP_REST_Request $request Full details about the request.
278
-	 *
279
-	 * @return boolean|WP_Error
280
-	 */
281
-	public function batch_items_permissions_check( $request ) {
282
-		return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
283
-	}
284
-
285
-	/**
286
-	 * Prepare links for the request.
287
-	 *
288
-	 * @param string $setting_id Setting ID.
289
-	 * @return array Links for the given setting.
290
-	 */
291
-	protected function prepare_links( $setting_id ) {
292
-
293
-		$links = array(
294
-			'self'       => array(
295
-				'href'   => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ),
296
-			),
297
-			'collection' => array(
298
-				'href'   => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
299
-			),
300
-		);
301
-
302
-		return $links;
303
-	}
304
-
305
-	/**
306
-	 * Prepare a settings object for serialization.
307
-	 *
308
-	 * @since  2.0.0
309
-	 * @param array           $item Setting object.
310
-	 * @param WP_REST_Request $request Request object.
311
-	 * @return WP_REST_Response $response Response data.
312
-	 */
313
-	public function prepare_item_for_response( $item, $request ) {
314
-		$context = empty( $request['context'] ) ? 'view' : $request['context'];
315
-		$data    = $this->add_additional_fields_to_object( $item, $request );
316
-		$data    = $this->filter_response_by_context( $data, $context );
317
-
318
-		$response = rest_ensure_response( $data );
319
-
320
-		$response->add_links( $this->prepare_links( $item['id'] ) );
321
-
322
-		return $response;
323
-	}
324
-
325
-	/**
326
-	 * Filters out bad values from the settings array/filter so we
327
-	 * only return known values via the API.
328
-	 *
329
-	 * @since 2.0.0
330
-	 * @param  array $setting Setting.
331
-	 * @return array
332
-	 */
333
-	public function filter_setting( $setting ) {
334
-		return array_intersect_key(
335
-			$setting,
336
-			array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) )
337
-		);
338
-	}
339
-
340
-	/**
341
-	 * Callback for allowed keys for each setting response.
342
-	 *
343
-	 * @param  string $key Key to check.
344
-	 * @return boolean
345
-	 */
346
-	public function allowed_setting_keys( $key ) {
347
-		return in_array( $key, array_keys( $this->setting_defaults() ), true );
348
-	}
349
-
350
-	/**
351
-	 * Returns default options for a setting. null means the field is required.
352
-	 *
353
-	 * @since  2.0.0
354
-	 * @return array
355
-	 */
356
-	protected function setting_defaults() {
357
-		return array(
358
-			'id'          => null,
359
-			'name'        => null,
360
-			'desc'        => '',
361
-			'options'     => array(),
362
-			'std'         => false,
363
-			'value'       => false,
364
-			'placeholder' => '',
365
-			'readonly'    => false,
366
-			'faux'        => false,
367
-			'section'     => 'main',
368
-			'tab'         => 'general',
369
-			'type'        => 'text',
370
-		);
371
-	}
372
-
373
-	/**
374
-	 * Sanitizes a setting's field.
375
-	 *
376
-	 * @param  array $setting The setting to sanitize.
377
-	 * @return array
378
-	 */
379
-	public function sanitize_setting( $setting ) {
156
+    /**
157
+     * Return all settings.
158
+     *
159
+     * @since  2.0.0
160
+     * @param  WP_REST_Request $request Request data.
161
+     * @return WP_Error|WP_REST_Response
162
+     */
163
+    public function get_items( $request ) {
164
+
165
+        $settings = $this->get_settings();
166
+
167
+        if ( ! isset( $settings[ $request['tab'] ] ) ) {
168
+            return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) );
169
+        }
170
+
171
+        if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) {
172
+            return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) );
173
+        }
174
+
175
+        $settings = $settings[ $request['tab'] ][ $request['section'] ];
176
+        $prepared = array();
177
+
178
+        foreach ( $settings as $setting ) {
179
+
180
+            $setting      = $this->sanitize_setting( $setting );
181
+            $setting_data = $this->prepare_item_for_response( $setting, $request );
182
+            $setting_data = $this->prepare_response_for_collection( $setting_data );
183
+
184
+            if ( $this->is_setting_type_valid( $setting['type'] ) ) {
185
+                $prepared[]   = $setting_data;
186
+            }
187
+
188
+        }
189
+
190
+        return rest_ensure_response( $prepared );
191
+    }
192
+
193
+    /**
194
+     * Return a single setting.
195
+     *
196
+     * @since  2.0.0
197
+     * @param  WP_REST_Request $request Request data.
198
+     * @return WP_Error|WP_REST_Response
199
+     */
200
+    public function get_item( $request ) {
201
+        $setting  = $this->get_setting( $request['id'] );
202
+
203
+        if ( is_wp_error( $setting ) ) {
204
+            return $setting;
205
+        }
206
+
207
+        $setting  = $this->sanitize_setting( $setting );
208
+        $response = $this->prepare_item_for_response( $setting, $request );
209
+        return rest_ensure_response( $response );
210
+    }
211
+
212
+    /**
213
+     * Update a single setting.
214
+     *
215
+     * @since  2.0.0
216
+     * @param  WP_REST_Request $request Request data.
217
+     * @return WP_Error|WP_REST_Response
218
+     */
219
+    public function update_item( $request ) {
220
+        $setting = $this->get_setting( $request['id'] );
221
+
222
+        if ( is_wp_error( $setting ) ) {
223
+            return $setting;
224
+        }
225
+
226
+        if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) {
227
+            $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting );
228
+        } else {
229
+            $value = $this->validate_setting_text_field( $request['value'], $setting );
230
+        }
231
+
232
+        if ( is_wp_error( $value ) ) {
233
+            return $value;
234
+        }
235
+
236
+        wpinv_update_option( $request['id'], $value );
237
+        $setting['value'] = $value;
238
+        $setting          = $this->sanitize_setting( $setting );
239
+        $response         = $this->prepare_item_for_response( $setting, $request );
240
+
241
+        return rest_ensure_response( $response );
242
+    }
243
+
244
+    /**
245
+     * Makes sure the current user has access to READ the settings APIs.
246
+     *
247
+     * @since  2.0.0
248
+     * @param WP_REST_Request $request Full data about the request.
249
+     * @return WP_Error|boolean
250
+     */
251
+    public function get_items_permissions_check( $request ) {
252
+        if ( ! wpinv_current_user_can_manage_invoicing() ) {
253
+            return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
254
+        }
255
+
256
+        return true;
257
+    }
258
+
259
+    /**
260
+     * Makes sure the current user has access to WRITE the settings APIs.
261
+     *
262
+     * @since  2.0.0
263
+     * @param WP_REST_Request $request Full data about the request.
264
+     * @return WP_Error|boolean
265
+     */
266
+    public function update_items_permissions_check( $request ) {
267
+        if ( ! wpinv_current_user_can_manage_invoicing() ) {
268
+            return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
269
+        }
270
+
271
+        return true;
272
+    }
273
+
274
+    /**
275
+     * Check if a given request has access batch create, update and delete items.
276
+     *
277
+     * @param  WP_REST_Request $request Full details about the request.
278
+     *
279
+     * @return boolean|WP_Error
280
+     */
281
+    public function batch_items_permissions_check( $request ) {
282
+        return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
283
+    }
284
+
285
+    /**
286
+     * Prepare links for the request.
287
+     *
288
+     * @param string $setting_id Setting ID.
289
+     * @return array Links for the given setting.
290
+     */
291
+    protected function prepare_links( $setting_id ) {
292
+
293
+        $links = array(
294
+            'self'       => array(
295
+                'href'   => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ),
296
+            ),
297
+            'collection' => array(
298
+                'href'   => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
299
+            ),
300
+        );
301
+
302
+        return $links;
303
+    }
304
+
305
+    /**
306
+     * Prepare a settings object for serialization.
307
+     *
308
+     * @since  2.0.0
309
+     * @param array           $item Setting object.
310
+     * @param WP_REST_Request $request Request object.
311
+     * @return WP_REST_Response $response Response data.
312
+     */
313
+    public function prepare_item_for_response( $item, $request ) {
314
+        $context = empty( $request['context'] ) ? 'view' : $request['context'];
315
+        $data    = $this->add_additional_fields_to_object( $item, $request );
316
+        $data    = $this->filter_response_by_context( $data, $context );
317
+
318
+        $response = rest_ensure_response( $data );
319
+
320
+        $response->add_links( $this->prepare_links( $item['id'] ) );
321
+
322
+        return $response;
323
+    }
324
+
325
+    /**
326
+     * Filters out bad values from the settings array/filter so we
327
+     * only return known values via the API.
328
+     *
329
+     * @since 2.0.0
330
+     * @param  array $setting Setting.
331
+     * @return array
332
+     */
333
+    public function filter_setting( $setting ) {
334
+        return array_intersect_key(
335
+            $setting,
336
+            array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) )
337
+        );
338
+    }
339
+
340
+    /**
341
+     * Callback for allowed keys for each setting response.
342
+     *
343
+     * @param  string $key Key to check.
344
+     * @return boolean
345
+     */
346
+    public function allowed_setting_keys( $key ) {
347
+        return in_array( $key, array_keys( $this->setting_defaults() ), true );
348
+    }
349
+
350
+    /**
351
+     * Returns default options for a setting. null means the field is required.
352
+     *
353
+     * @since  2.0.0
354
+     * @return array
355
+     */
356
+    protected function setting_defaults() {
357
+        return array(
358
+            'id'          => null,
359
+            'name'        => null,
360
+            'desc'        => '',
361
+            'options'     => array(),
362
+            'std'         => false,
363
+            'value'       => false,
364
+            'placeholder' => '',
365
+            'readonly'    => false,
366
+            'faux'        => false,
367
+            'section'     => 'main',
368
+            'tab'         => 'general',
369
+            'type'        => 'text',
370
+        );
371
+    }
372
+
373
+    /**
374
+     * Sanitizes a setting's field.
375
+     *
376
+     * @param  array $setting The setting to sanitize.
377
+     * @return array
378
+     */
379
+    public function sanitize_setting( $setting ) {
380 380
 		
381
-		$setting          = wp_parse_args( $setting, $this->setting_defaults() );
382
-		$setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] );
383
-		return $this->filter_setting( $setting );
384
-
385
-	}
386
-
387
-	/**
388
-	 * Get setting data.
389
-	 *
390
-	 * @since  2.0.0
391
-	 * @param string $setting_id Setting ID.
392
-	 * @return array|WP_Error
393
-	 */
394
-	public function get_setting( $setting_id ) {
395
-
396
-		if ( empty( $setting_id ) ) {
397
-			return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) );
398
-		}
399
-
400
-		$settings  = $this->get_settings();
401
-
402
-		foreach ( $settings as $tabs ) {
403
-
404
-			foreach ( $tabs as $sections ) {
405
-
406
-				if ( isset( $sections[ $setting_id ] ) ) {
407
-					if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) {
408
-						return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) );
409
-					}
410
-
411
-					return $sections[ $setting_id ];
412
-				}
413
-
414
-			}
415
-
416
-		}
417
-
418
-		return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) );
419
-	}
420
-
421
-	/**
422
-	 * Get all tabs.
423
-	 *
424
-	 * @param  WP_REST_Request $request Request data.
425
-	 * @return array
426
-	 */
427
-	public function get_tabs( $request ) {
428
-		$tabs     = wpinv_get_settings_tabs();
429
-		$prepared = array();
430
-
431
-		foreach ( $tabs as $id => $tab ) {
432
-
433
-			$_request        = $request;
434
-			$_request['tab'] = sanitize_title( $id );
435
-			$data            = array(
436
-				'id'       => sanitize_title( $id ),
437
-				'label'    => sanitize_text_field( $tab ),
438
-				'sections' => $this->get_sections( $_request ),
439
-			);
440
-
441
-			$data     = $this->add_additional_fields_to_object( $data, $request );
442
-			$response = rest_ensure_response( $data );
443
-
444
-			if ( ! is_wp_error( $response ) ) {
445
-				$links = array(
446
-					'sections'   => array(
447
-						'href'   => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ),
448
-					),
449
-					'collection' => array(
450
-						'href'   => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
451
-					),
452
-				);
453
-				$response->add_links( $links );
454
-				$response = $this->prepare_response_for_collection( $response );
455
-			}
456
-
457
-			$prepared[] = $response;
458
-
459
-		}
460
-
461
-		return rest_ensure_response( $prepared );
462
-	}
463
-
464
-	/**
465
-	 * Get all sections.
466
-	 *
467
-	 * @param  WP_REST_Request $request Request data.
468
-	 * @return array
469
-	 */
470
-	public function get_sections( $request ) {
471
-
472
-		$tab      = sanitize_title( $request['tab'] );
473
-		$sections = wpinv_get_settings_tab_sections( $tab );
474
-		$prepared = array();
475
-
476
-		foreach ( $sections as $id => $section ) {
477
-
478
-			$data            = array(
479
-				'id'       => sanitize_title( $id ),
480
-				'label'    => sanitize_text_field( $section ),
481
-			);
482
-
483
-			$data     = $this->add_additional_fields_to_object( $data, $request );
484
-			$response = rest_ensure_response( $data );
485
-
486
-			if ( ! is_wp_error( $response ) ) {
487
-				$links = array(
488
-					'settings'   => array(
489
-						'href'   => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ),
490
-					),
491
-					'collection' => array(
492
-						'href'   => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ),
493
-					),
494
-					'tabs'       => array(
495
-						'href'   => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
496
-					),
497
-				);
498
-				$response->add_links( $links );
499
-				$response = $this->prepare_response_for_collection( $response );
500
-			}
501
-
502
-			$prepared[] = $response;
503
-
504
-		}
505
-
506
-		return rest_ensure_response( $prepared );
507
-	}
508
-
509
-	/**
510
-	 * Get all settings.
511
-	 *
512
-	 * @return array
513
-	 */
514
-	public function get_settings() {
515
-
516
-		if ( empty( $this->settings ) ) {
517
-			$this->settings = wpinv_get_registered_settings();
518
-		}
519
-
520
-		return $this->settings;
521
-
522
-	}
523
-
524
-	/**
525
-	 * Boolean for if a setting type is a valid supported setting type.
526
-	 *
527
-	 * @since  2.0.0
528
-	 * @param  string $type Type.
529
-	 * @return bool
530
-	 */
531
-	public function is_setting_type_valid( $type ) {
532
-
533
-		return in_array(
534
-			$type, array(
535
-				'text',         // Validates with validate_setting_text_field.
536
-				'email',        // Validates with validate_setting_text_field.
537
-				'number',       // Validates with validate_setting_text_field.
538
-				'color',        // Validates with validate_setting_text_field.
539
-				'password',     // Validates with validate_setting_text_field.
540
-				'textarea',     // Validates with validate_setting_textarea_field.
541
-				'select',       // Validates with validate_setting_select_field.
542
-				'multiselect',  // Validates with validate_setting_multiselect_field.
543
-				'radio',        // Validates with validate_setting_radio_field (-> validate_setting_select_field).
544
-				'checkbox',     // Validates with validate_setting_checkbox_field.
545
-				'header',       // Validates with validate_setting_text_field.
546
-			)
547
-		);
548
-
549
-	}
550
-
551
-	/**
552
-	 * Get the settings schema, conforming to JSON Schema.
553
-	 *
554
-	 * @return array
555
-	 */
556
-	public function get_item_schema() {
557
-
558
-		// Maybe retrieve the schema from cache.
559
-		if ( ! empty( $this->schema ) ) {
560
-			return $this->add_additional_fields_schema( $this->schema );
561
-		}
562
-
563
-		$schema = array(
564
-			'$schema'    => 'http://json-schema.org/draft-04/schema#',
565
-			'title'      => 'setting',
566
-			'type'       => 'object',
567
-			'properties' => array(
568
-				'id'          => array(
569
-					'description' => __( 'A unique identifier for the setting.', 'invoicing' ),
570
-					'type'        => 'string',
571
-					'arg_options' => array(
572
-						'sanitize_callback' => 'sanitize_title',
573
-					),
574
-					'context'     => array( 'view', 'edit' ),
575
-					'readonly'    => true,
576
-				),
577
-				'tab'         => array(
578
-					'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ),
579
-					'type'        => 'string',
580
-					'arg_options' => array(
581
-						'sanitize_callback' => 'sanitize_title',
582
-					),
583
-					'context'     => array( 'view', 'edit' ),
584
-					'readonly'    => true,
585
-				),
586
-				'section'     => array(
587
-					'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ),
588
-					'type'        => 'string',
589
-					'arg_options' => array(
590
-						'sanitize_callback' => 'sanitize_title',
591
-					),
592
-					'context'     => array( 'view', 'edit' ),
593
-					'readonly'    => true,
594
-				),
595
-				'name'       => array(
596
-					'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ),
597
-					'type'        => 'string',
598
-					'arg_options' => array(
599
-						'sanitize_callback' => 'sanitize_text_field',
600
-					),
601
-					'context'     => array( 'view', 'edit' ),
602
-					'readonly'    => true,
603
-				),
604
-				'desc'        => array(
605
-					'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ),
606
-					'type'        => 'string',
607
-					'context'     => array( 'view', 'edit' ),
608
-					'readonly'    => true,
609
-				),
610
-				'value'       => array(
611
-					'description' => __( 'The current value of this setting.', 'invoicing' ),
612
-					'type'        => 'mixed',
613
-					'context'     => array( 'view', 'edit' ),
614
-				),
615
-				'default'     => array(
616
-					'description' => __( 'Default value for the setting.', 'invoicing' ),
617
-					'type'        => 'mixed',
618
-					'context'     => array( 'view', 'edit' ),
619
-					'readonly'    => true,
620
-				),
621
-				'placeholder' => array(
622
-					'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ),
623
-					'type'        => 'string',
624
-					'arg_options' => array(
625
-						'sanitize_callback' => 'sanitize_text_field',
626
-					),
627
-					'context'     => array( 'view', 'edit' ),
628
-					'readonly'    => true,
629
-				),
630
-				'type'        => array(
631
-					'description' => __( 'Type of setting.', 'invoicing' ),
632
-					'type'        => 'string',
633
-					'arg_options' => array(
634
-						'sanitize_callback' => 'sanitize_text_field',
635
-					),
636
-					'context'     => array( 'view', 'edit' ),
637
-					'enum'        => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ),
638
-					'readonly'    => true,
639
-				),
640
-				'options'     => array(
641
-					'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ),
642
-					'type'        => 'object',
643
-					'context'     => array( 'view', 'edit' ),
644
-					'readonly'    => true,
645
-				),
646
-				'readonly'        => array(
647
-					'description' => __( 'Whether or not this setting is readonly', 'invoicing' ),
648
-					'type'        => 'string',
649
-					'context'     => array( 'view' ),
650
-					'readonly'    => true,
651
-				),
652
-				'faux'            => array(
653
-					'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ),
654
-					'type'        => 'string',
655
-					'context'     => array( 'view' ),
656
-					'readonly'    => true,
657
-				),
658
-			),
659
-		);
660
-
661
-		// Filters the settings schema for the REST API.
381
+        $setting          = wp_parse_args( $setting, $this->setting_defaults() );
382
+        $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] );
383
+        return $this->filter_setting( $setting );
384
+
385
+    }
386
+
387
+    /**
388
+     * Get setting data.
389
+     *
390
+     * @since  2.0.0
391
+     * @param string $setting_id Setting ID.
392
+     * @return array|WP_Error
393
+     */
394
+    public function get_setting( $setting_id ) {
395
+
396
+        if ( empty( $setting_id ) ) {
397
+            return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) );
398
+        }
399
+
400
+        $settings  = $this->get_settings();
401
+
402
+        foreach ( $settings as $tabs ) {
403
+
404
+            foreach ( $tabs as $sections ) {
405
+
406
+                if ( isset( $sections[ $setting_id ] ) ) {
407
+                    if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) {
408
+                        return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) );
409
+                    }
410
+
411
+                    return $sections[ $setting_id ];
412
+                }
413
+
414
+            }
415
+
416
+        }
417
+
418
+        return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) );
419
+    }
420
+
421
+    /**
422
+     * Get all tabs.
423
+     *
424
+     * @param  WP_REST_Request $request Request data.
425
+     * @return array
426
+     */
427
+    public function get_tabs( $request ) {
428
+        $tabs     = wpinv_get_settings_tabs();
429
+        $prepared = array();
430
+
431
+        foreach ( $tabs as $id => $tab ) {
432
+
433
+            $_request        = $request;
434
+            $_request['tab'] = sanitize_title( $id );
435
+            $data            = array(
436
+                'id'       => sanitize_title( $id ),
437
+                'label'    => sanitize_text_field( $tab ),
438
+                'sections' => $this->get_sections( $_request ),
439
+            );
440
+
441
+            $data     = $this->add_additional_fields_to_object( $data, $request );
442
+            $response = rest_ensure_response( $data );
443
+
444
+            if ( ! is_wp_error( $response ) ) {
445
+                $links = array(
446
+                    'sections'   => array(
447
+                        'href'   => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ),
448
+                    ),
449
+                    'collection' => array(
450
+                        'href'   => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
451
+                    ),
452
+                );
453
+                $response->add_links( $links );
454
+                $response = $this->prepare_response_for_collection( $response );
455
+            }
456
+
457
+            $prepared[] = $response;
458
+
459
+        }
460
+
461
+        return rest_ensure_response( $prepared );
462
+    }
463
+
464
+    /**
465
+     * Get all sections.
466
+     *
467
+     * @param  WP_REST_Request $request Request data.
468
+     * @return array
469
+     */
470
+    public function get_sections( $request ) {
471
+
472
+        $tab      = sanitize_title( $request['tab'] );
473
+        $sections = wpinv_get_settings_tab_sections( $tab );
474
+        $prepared = array();
475
+
476
+        foreach ( $sections as $id => $section ) {
477
+
478
+            $data            = array(
479
+                'id'       => sanitize_title( $id ),
480
+                'label'    => sanitize_text_field( $section ),
481
+            );
482
+
483
+            $data     = $this->add_additional_fields_to_object( $data, $request );
484
+            $response = rest_ensure_response( $data );
485
+
486
+            if ( ! is_wp_error( $response ) ) {
487
+                $links = array(
488
+                    'settings'   => array(
489
+                        'href'   => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ),
490
+                    ),
491
+                    'collection' => array(
492
+                        'href'   => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ),
493
+                    ),
494
+                    'tabs'       => array(
495
+                        'href'   => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
496
+                    ),
497
+                );
498
+                $response->add_links( $links );
499
+                $response = $this->prepare_response_for_collection( $response );
500
+            }
501
+
502
+            $prepared[] = $response;
503
+
504
+        }
505
+
506
+        return rest_ensure_response( $prepared );
507
+    }
508
+
509
+    /**
510
+     * Get all settings.
511
+     *
512
+     * @return array
513
+     */
514
+    public function get_settings() {
515
+
516
+        if ( empty( $this->settings ) ) {
517
+            $this->settings = wpinv_get_registered_settings();
518
+        }
519
+
520
+        return $this->settings;
521
+
522
+    }
523
+
524
+    /**
525
+     * Boolean for if a setting type is a valid supported setting type.
526
+     *
527
+     * @since  2.0.0
528
+     * @param  string $type Type.
529
+     * @return bool
530
+     */
531
+    public function is_setting_type_valid( $type ) {
532
+
533
+        return in_array(
534
+            $type, array(
535
+                'text',         // Validates with validate_setting_text_field.
536
+                'email',        // Validates with validate_setting_text_field.
537
+                'number',       // Validates with validate_setting_text_field.
538
+                'color',        // Validates with validate_setting_text_field.
539
+                'password',     // Validates with validate_setting_text_field.
540
+                'textarea',     // Validates with validate_setting_textarea_field.
541
+                'select',       // Validates with validate_setting_select_field.
542
+                'multiselect',  // Validates with validate_setting_multiselect_field.
543
+                'radio',        // Validates with validate_setting_radio_field (-> validate_setting_select_field).
544
+                'checkbox',     // Validates with validate_setting_checkbox_field.
545
+                'header',       // Validates with validate_setting_text_field.
546
+            )
547
+        );
548
+
549
+    }
550
+
551
+    /**
552
+     * Get the settings schema, conforming to JSON Schema.
553
+     *
554
+     * @return array
555
+     */
556
+    public function get_item_schema() {
557
+
558
+        // Maybe retrieve the schema from cache.
559
+        if ( ! empty( $this->schema ) ) {
560
+            return $this->add_additional_fields_schema( $this->schema );
561
+        }
562
+
563
+        $schema = array(
564
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
565
+            'title'      => 'setting',
566
+            'type'       => 'object',
567
+            'properties' => array(
568
+                'id'          => array(
569
+                    'description' => __( 'A unique identifier for the setting.', 'invoicing' ),
570
+                    'type'        => 'string',
571
+                    'arg_options' => array(
572
+                        'sanitize_callback' => 'sanitize_title',
573
+                    ),
574
+                    'context'     => array( 'view', 'edit' ),
575
+                    'readonly'    => true,
576
+                ),
577
+                'tab'         => array(
578
+                    'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ),
579
+                    'type'        => 'string',
580
+                    'arg_options' => array(
581
+                        'sanitize_callback' => 'sanitize_title',
582
+                    ),
583
+                    'context'     => array( 'view', 'edit' ),
584
+                    'readonly'    => true,
585
+                ),
586
+                'section'     => array(
587
+                    'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ),
588
+                    'type'        => 'string',
589
+                    'arg_options' => array(
590
+                        'sanitize_callback' => 'sanitize_title',
591
+                    ),
592
+                    'context'     => array( 'view', 'edit' ),
593
+                    'readonly'    => true,
594
+                ),
595
+                'name'       => array(
596
+                    'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ),
597
+                    'type'        => 'string',
598
+                    'arg_options' => array(
599
+                        'sanitize_callback' => 'sanitize_text_field',
600
+                    ),
601
+                    'context'     => array( 'view', 'edit' ),
602
+                    'readonly'    => true,
603
+                ),
604
+                'desc'        => array(
605
+                    'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ),
606
+                    'type'        => 'string',
607
+                    'context'     => array( 'view', 'edit' ),
608
+                    'readonly'    => true,
609
+                ),
610
+                'value'       => array(
611
+                    'description' => __( 'The current value of this setting.', 'invoicing' ),
612
+                    'type'        => 'mixed',
613
+                    'context'     => array( 'view', 'edit' ),
614
+                ),
615
+                'default'     => array(
616
+                    'description' => __( 'Default value for the setting.', 'invoicing' ),
617
+                    'type'        => 'mixed',
618
+                    'context'     => array( 'view', 'edit' ),
619
+                    'readonly'    => true,
620
+                ),
621
+                'placeholder' => array(
622
+                    'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ),
623
+                    'type'        => 'string',
624
+                    'arg_options' => array(
625
+                        'sanitize_callback' => 'sanitize_text_field',
626
+                    ),
627
+                    'context'     => array( 'view', 'edit' ),
628
+                    'readonly'    => true,
629
+                ),
630
+                'type'        => array(
631
+                    'description' => __( 'Type of setting.', 'invoicing' ),
632
+                    'type'        => 'string',
633
+                    'arg_options' => array(
634
+                        'sanitize_callback' => 'sanitize_text_field',
635
+                    ),
636
+                    'context'     => array( 'view', 'edit' ),
637
+                    'enum'        => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ),
638
+                    'readonly'    => true,
639
+                ),
640
+                'options'     => array(
641
+                    'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ),
642
+                    'type'        => 'object',
643
+                    'context'     => array( 'view', 'edit' ),
644
+                    'readonly'    => true,
645
+                ),
646
+                'readonly'        => array(
647
+                    'description' => __( 'Whether or not this setting is readonly', 'invoicing' ),
648
+                    'type'        => 'string',
649
+                    'context'     => array( 'view' ),
650
+                    'readonly'    => true,
651
+                ),
652
+                'faux'            => array(
653
+                    'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ),
654
+                    'type'        => 'string',
655
+                    'context'     => array( 'view' ),
656
+                    'readonly'    => true,
657
+                ),
658
+            ),
659
+        );
660
+
661
+        // Filters the settings schema for the REST API.
662 662
         $schema = apply_filters( 'getpaid_rest_settings_schema', $schema );
663 663
 
664
-		// Cache the settings schema.
665
-		$this->schema = $schema;
666
-
667
-		return $this->add_additional_fields_schema( $this->schema );
668
-
669
-	}
670
-
671
-	/**
672
-	 * Validate a text value for a text based setting.
673
-	 *
674
-	 * @since 2.0.0
675
-	 * @param string $value Value.
676
-	 * @param array  $setting Setting.
677
-	 * @return string
678
-	 */
679
-	public function validate_setting_text_field( $value ) {
680
-		$value = is_null( $value ) ? '' : $value;
681
-		return wp_kses_post( trim( stripslashes( $value ) ) );
682
-	}
683
-
684
-	/**
685
-	 * Validate select based settings.
686
-	 *
687
-	 * @since 2.0.0
688
-	 * @param string $value Value.
689
-	 * @param array  $setting Setting.
690
-	 * @return string|WP_Error
691
-	 */
692
-	public function validate_setting_select_field( $value, $setting ) {
693
-		if ( array_key_exists( $value, $setting['options'] ) ) {
694
-			return $value;
695
-		} else {
696
-			return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) );
697
-		}
698
-	}
699
-
700
-	/**
701
-	 * Validate multiselect based settings.
702
-	 *
703
-	 * @since 2.0.0
704
-	 * @param array $values Values.
705
-	 * @param array $setting Setting.
706
-	 * @return array|WP_Error
707
-	 */
708
-	public function validate_setting_multiselect_field( $values, $setting ) {
709
-		if ( empty( $values ) ) {
710
-			return array();
711
-		}
712
-
713
-		if ( ! is_array( $values ) ) {
714
-			return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) );
715
-		}
716
-
717
-		$final_values = array();
718
-		foreach ( $values as $value ) {
719
-			if ( array_key_exists( $value, $setting['options'] ) ) {
720
-				$final_values[] = $value;
721
-			}
722
-		}
723
-
724
-		return $final_values;
725
-	}
726
-
727
-	/**
728
-	 * Validate radio based settings.
729
-	 *
730
-	 * @since 2.0.0
731
-	 * @param string $value Value.
732
-	 * @param array  $setting Setting.
733
-	 * @return string|WP_Error
734
-	 */
735
-	public function validate_setting_radio_field( $value, $setting ) {
736
-		return $this->validate_setting_select_field( $value, $setting );
737
-	}
738
-
739
-	/**
740
-	 * Validate checkbox based settings.
741
-	 *
742
-	 * @since 2.0.0
743
-	 * @param string $value Value.
744
-	 * @return int
745
-	 */
746
-	public function validate_setting_checkbox_field( $value ) {
747
-		return (int) ! empty( $value );
748
-	}
749
-
750
-	/**
751
-	 * Validate textarea based settings.
752
-	 *
753
-	 * @since 2.0.0
754
-	 * @param string $value Value.
755
-	 * @return string
756
-	 */
757
-	public function validate_setting_textarea_field( $value ) {
758
-		$value = is_null( $value ) ? '' : $value;
759
-		return wp_kses(
760
-			trim( stripslashes( $value ) ),
761
-			array_merge(
762
-				array(
763
-					'iframe' => array(
764
-						'src'   => true,
765
-						'style' => true,
766
-						'id'    => true,
767
-						'class' => true,
768
-					),
769
-				),
770
-				wp_kses_allowed_html( 'post' )
771
-			)
772
-		);
773
-	}
664
+        // Cache the settings schema.
665
+        $this->schema = $schema;
666
+
667
+        return $this->add_additional_fields_schema( $this->schema );
668
+
669
+    }
670
+
671
+    /**
672
+     * Validate a text value for a text based setting.
673
+     *
674
+     * @since 2.0.0
675
+     * @param string $value Value.
676
+     * @param array  $setting Setting.
677
+     * @return string
678
+     */
679
+    public function validate_setting_text_field( $value ) {
680
+        $value = is_null( $value ) ? '' : $value;
681
+        return wp_kses_post( trim( stripslashes( $value ) ) );
682
+    }
683
+
684
+    /**
685
+     * Validate select based settings.
686
+     *
687
+     * @since 2.0.0
688
+     * @param string $value Value.
689
+     * @param array  $setting Setting.
690
+     * @return string|WP_Error
691
+     */
692
+    public function validate_setting_select_field( $value, $setting ) {
693
+        if ( array_key_exists( $value, $setting['options'] ) ) {
694
+            return $value;
695
+        } else {
696
+            return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) );
697
+        }
698
+    }
699
+
700
+    /**
701
+     * Validate multiselect based settings.
702
+     *
703
+     * @since 2.0.0
704
+     * @param array $values Values.
705
+     * @param array $setting Setting.
706
+     * @return array|WP_Error
707
+     */
708
+    public function validate_setting_multiselect_field( $values, $setting ) {
709
+        if ( empty( $values ) ) {
710
+            return array();
711
+        }
712
+
713
+        if ( ! is_array( $values ) ) {
714
+            return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) );
715
+        }
716
+
717
+        $final_values = array();
718
+        foreach ( $values as $value ) {
719
+            if ( array_key_exists( $value, $setting['options'] ) ) {
720
+                $final_values[] = $value;
721
+            }
722
+        }
723
+
724
+        return $final_values;
725
+    }
726
+
727
+    /**
728
+     * Validate radio based settings.
729
+     *
730
+     * @since 2.0.0
731
+     * @param string $value Value.
732
+     * @param array  $setting Setting.
733
+     * @return string|WP_Error
734
+     */
735
+    public function validate_setting_radio_field( $value, $setting ) {
736
+        return $this->validate_setting_select_field( $value, $setting );
737
+    }
738
+
739
+    /**
740
+     * Validate checkbox based settings.
741
+     *
742
+     * @since 2.0.0
743
+     * @param string $value Value.
744
+     * @return int
745
+     */
746
+    public function validate_setting_checkbox_field( $value ) {
747
+        return (int) ! empty( $value );
748
+    }
749
+
750
+    /**
751
+     * Validate textarea based settings.
752
+     *
753
+     * @since 2.0.0
754
+     * @param string $value Value.
755
+     * @return string
756
+     */
757
+    public function validate_setting_textarea_field( $value ) {
758
+        $value = is_null( $value ) ? '' : $value;
759
+        return wp_kses(
760
+            trim( stripslashes( $value ) ),
761
+            array_merge(
762
+                array(
763
+                    'iframe' => array(
764
+                        'src'   => true,
765
+                        'style' => true,
766
+                        'id'    => true,
767
+                        'class' => true,
768
+                    ),
769
+                ),
770
+                wp_kses_allowed_html( 'post' )
771
+            )
772
+        );
773
+    }
774 774
 
775 775
 }
Please login to merge, or discard this patch.
includes/reports/class-getpaid-reports-helper.php 1 patch
Indentation   +276 added lines, -276 removed lines patch added patch discarded remove patch
@@ -12,294 +12,294 @@
 block discarded – undo
12 12
  */
13 13
 class GetPaid_Reports_Helper {
14 14
 
15
-	/**
16
-	 * Get report totals such as invoice totals and discount amounts.
17
-	 *
18
-	 * Data example:
19
-	 *
20
-	 * 'subtotal' => array(
21
-	 *     'type'     => 'invoice_data',
22
-	 *     'function' => 'SUM',
23
-	 *     'name'     => 'subtotal'
24
-	 * )
25
-	 *
26
-	 * @param  array $args
27
-	 * @return mixed depending on query_type
28
-	 */
29
-	public static function get_invoice_report_data( $args = array() ) {
30
-		global $wpdb;
31
-
32
-		$default_args = array(
33
-			'data'                  => array(), // The data to retrieve.
34
-			'where'                 => array(), // An array of where queries.
35
-			'query_type'            => 'get_row', // wpdb query to run.
36
-			'group_by'              => '', // What to group results by.
37
-			'order_by'              => '', // What to order by.
38
-			'limit'                 => '', // Results limit.
39
-			'filter_range'          => array(), // An array of before and after dates to limit results by.
40
-			'invoice_types'         => array( 'wpi_invoice' ), // An array of post types to retrieve.
41
-			'invoice_status'        => array( 'publish', 'wpi-processing', 'wpi-onhold' ),
42
-			'parent_invoice_status' => false, // Optionally filter by parent invoice status.
43
-		);
44
-
45
-		$args         = apply_filters( 'getpaid_reports_get_invoice_report_data_args', $args );
46
-		$args         = wp_parse_args( $args, $default_args );
47
-
48
-		extract( $args );
49
-
50
-		if ( empty( $data ) ) {
51
-			return '';
52
-		}
53
-
54
-		$query           = array();
55
-		$query['select'] = 'SELECT ' . implode( ',', self::prepare_invoice_data( $data ) );
56
-		$query['from']   = "FROM {$wpdb->posts} AS posts";
57
-		$query['join']   = implode( ' ', self::prepare_invoice_joins( $data + $where, ! empty( $parent_invoice_status ) ) );
58
-
59
-		$query['where']  = "
15
+    /**
16
+     * Get report totals such as invoice totals and discount amounts.
17
+     *
18
+     * Data example:
19
+     *
20
+     * 'subtotal' => array(
21
+     *     'type'     => 'invoice_data',
22
+     *     'function' => 'SUM',
23
+     *     'name'     => 'subtotal'
24
+     * )
25
+     *
26
+     * @param  array $args
27
+     * @return mixed depending on query_type
28
+     */
29
+    public static function get_invoice_report_data( $args = array() ) {
30
+        global $wpdb;
31
+
32
+        $default_args = array(
33
+            'data'                  => array(), // The data to retrieve.
34
+            'where'                 => array(), // An array of where queries.
35
+            'query_type'            => 'get_row', // wpdb query to run.
36
+            'group_by'              => '', // What to group results by.
37
+            'order_by'              => '', // What to order by.
38
+            'limit'                 => '', // Results limit.
39
+            'filter_range'          => array(), // An array of before and after dates to limit results by.
40
+            'invoice_types'         => array( 'wpi_invoice' ), // An array of post types to retrieve.
41
+            'invoice_status'        => array( 'publish', 'wpi-processing', 'wpi-onhold' ),
42
+            'parent_invoice_status' => false, // Optionally filter by parent invoice status.
43
+        );
44
+
45
+        $args         = apply_filters( 'getpaid_reports_get_invoice_report_data_args', $args );
46
+        $args         = wp_parse_args( $args, $default_args );
47
+
48
+        extract( $args );
49
+
50
+        if ( empty( $data ) ) {
51
+            return '';
52
+        }
53
+
54
+        $query           = array();
55
+        $query['select'] = 'SELECT ' . implode( ',', self::prepare_invoice_data( $data ) );
56
+        $query['from']   = "FROM {$wpdb->posts} AS posts";
57
+        $query['join']   = implode( ' ', self::prepare_invoice_joins( $data + $where, ! empty( $parent_invoice_status ) ) );
58
+
59
+        $query['where']  = "
60 60
 			WHERE 	posts.post_type 	IN ( '" . implode( "','", $invoice_types ) . "' )
61 61
 			";
62 62
 
63
-		if ( ! empty( $invoice_status ) ) {
64
-			$query['where'] .= "
63
+        if ( ! empty( $invoice_status ) ) {
64
+            $query['where'] .= "
65 65
 				AND 	posts.post_status 	IN ( '" . implode( "','", $invoice_status ) . "' )
66 66
 			";
67
-		}
68
-
69
-		if ( ! empty( $parent_invoice_status ) ) {
70
-			if ( ! empty( $invoice_status ) ) {
71
-				$query['where'] .= " AND ( parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) OR parent.ID IS NULL ) ";
72
-			} else {
73
-				$query['where'] .= " AND parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) ";
74
-			}
75
-		}
76
-
77
-		if ( ! empty( $filter_range['before'] ) ) {
78
-			$query['where'] .= "
67
+        }
68
+
69
+        if ( ! empty( $parent_invoice_status ) ) {
70
+            if ( ! empty( $invoice_status ) ) {
71
+                $query['where'] .= " AND ( parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) OR parent.ID IS NULL ) ";
72
+            } else {
73
+                $query['where'] .= " AND parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) ";
74
+            }
75
+        }
76
+
77
+        if ( ! empty( $filter_range['before'] ) ) {
78
+            $query['where'] .= "
79 79
 				AND 	posts.post_date < '" . date( 'Y-m-d H:i:s', strtotime( $filter_range['before'] ) ) . "'
80 80
 			";
81
-		}
81
+        }
82 82
 
83
-		if ( ! empty( $filter_range['after'] ) ) {
84
-			$query['where'] .= "
83
+        if ( ! empty( $filter_range['after'] ) ) {
84
+            $query['where'] .= "
85 85
 				AND 	posts.post_date > '" . date( 'Y-m-d H:i:s', strtotime( $filter_range['after'] ) ) . "'
86 86
 			";
87
-		}
87
+        }
88 88
 
89
-		if ( ! empty( $where ) ) {
89
+        if ( ! empty( $where ) ) {
90 90
 
91
-			foreach ( $where as $value ) {
91
+            foreach ( $where as $value ) {
92 92
 
93
-				if ( strtolower( $value['operator'] ) == 'in' || strtolower( $value['operator'] ) == 'not in' ) {
94
-
95
-					if ( is_array( $value['value'] ) ) {
96
-						$value['value'] = implode( "','", $value['value'] );
97
-					}
98
-
99
-					if ( ! empty( $value['value'] ) ) {
100
-						$where_value = "{$value['operator']} ('{$value['value']}')";
101
-					}
102
-				} else {
103
-					$where_value = "{$value['operator']} '{$value['value']}'";
104
-				}
105
-
106
-				if ( ! empty( $where_value ) ) {
107
-					$query['where'] .= " AND {$value['key']} {$where_value}";
108
-				}
109
-			}
110
-		}
111
-
112
-		if ( $group_by ) {
113
-			$query['group_by'] = "GROUP BY {$group_by}";
114
-		}
115
-
116
-		if ( $order_by ) {
117
-			$query['order_by'] = "ORDER BY {$order_by}";
118
-		}
119
-
120
-		if ( $limit ) {
121
-			$query['limit'] = "LIMIT {$limit}";
122
-		}
123
-
124
-		$query = apply_filters( 'getpaid_reports_get_invoice_report_query', $query, $data );
125
-		$query = implode( ' ', $query );
126
-
127
-		return self::execute( $query_type, $query );
128
-
129
-	}
130
-
131
-	/**
132
-	 * Prepares the data to select.
133
-	 *
134
-	 *
135
-	 * @param  array $data
136
-	 * @return array
137
-	 */
138
-	public static function prepare_invoice_data( $data ) {
139
-
140
-		$prepared = array();
141
-
142
-		foreach ( $data as $raw_key => $value ) {
143
-			$key      = sanitize_key( $raw_key );
144
-			$distinct = '';
145
-
146
-			if ( isset( $value['distinct'] ) ) {
147
-				$distinct = 'DISTINCT';
148
-			}
149
-
150
-			$get_key = self::get_invoice_table_key( $key, $value['type'] );
151
-
152
-			if ( false === $get_key ) {
153
-				// Skip to the next foreach iteration else the query will be invalid.
154
-				continue;
155
-			}
156
-
157
-			if ( ! empty( $value['function'] ) ) {
158
-				$get = "{$value['function']}({$distinct} {$get_key})";
159
-			} else {
160
-				$get = "{$distinct} {$get_key}";
161
-			}
162
-
163
-			$prepared[] = "{$get} as {$value['name']}";
164
-		}
165
-
166
-		return $prepared;
167
-
168
-	}
169
-
170
-	/**
171
-	 * Prepares the joins to use.
172
-	 *
173
-	 *
174
-	 * @param  array $data
175
-	 * @param  bool $with_parent
176
-	 * @return array
177
-	 */
178
-	public static function prepare_invoice_joins( $data, $with_parent ) {
179
-		global $wpdb;
180
-
181
-		$prepared = array();
182
-
183
-		foreach ( $data as $raw_key => $value ) {
184
-			$join_type = isset( $value['join_type'] ) ? $value['join_type'] : 'INNER';
185
-			$type      = isset( $value['type'] ) ? $value['type'] : false;
186
-			$key       = sanitize_key( $raw_key );
187
-
188
-			switch ( $type ) {
189
-				case 'meta':
190
-					$prepared[ "meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS meta_{$key} ON ( posts.ID = meta_{$key}.post_id AND meta_{$key}.meta_key = '{$raw_key}' )";
191
-					break;
192
-				case 'parent_meta':
193
-					$prepared[ "parent_meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS parent_meta_{$key} ON (posts.post_parent = parent_meta_{$key}.post_id) AND (parent_meta_{$key}.meta_key = '{$raw_key}')";
194
-					break;
195
-				case 'invoice_data':
196
-					$prepared['invoices'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoices AS invoices ON posts.ID = invoices.post_id";
197
-					break;
198
-				case 'invoice_item':
199
-					$prepared['invoice_items'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoice_items AS invoice_items ON posts.ID = invoice_items.post_id";
200
-					break;
201
-			}
202
-		}
203
-
204
-		if ( $with_parent ) {
205
-			$prepared['parent'] = "LEFT JOIN {$wpdb->posts} AS parent ON posts.post_parent = parent.ID";
206
-		}
207
-
208
-		return $prepared;
209
-
210
-	}
211
-
212
-	/**
213
-	 * Retrieves the appropriate table key to use.
214
-	 *
215
-	 *
216
-	 * @param  string $key
217
-	 * @param  string $table
218
-	 * @return string|false
219
-	 */
220
-	public static function get_invoice_table_key( $key, $table ) {
221
-
222
-		$keys = array(
223
-			'meta'         => "meta_{$key}.meta_value",
224
-			'parent_meta'  => "parent_meta_{$key}.meta_value",
225
-			'post_data'    => "posts.{$key}",
226
-			'invoice_data' => "invoices.{$key}",
227
-			'invoice_item' => "invoice_items.{$key}",
228
-		);
229
-
230
-		return isset( $keys[ $table ] ) ? $keys[ $table ] : false;
231
-
232
-	}
233
-
234
-	/**
235
-	 * Executes a query and caches the result for a minute.
236
-	 *
237
-	 *
238
-	 * @param  string $query_type
239
-	 * @param  string $query
240
-	 * @return mixed depending on query_type
241
-	 */
242
-	public static function execute( $query_type, $query ) {
243
-		global $wpdb;
244
-
245
-		$query_hash = md5( $query_type . $query );
246
-		$result     = self::get_cached_query( $query_hash );
247
-		if ( $result === false ) {
248
-			self::enable_big_selects();
249
-
250
-			$result = $wpdb->$query_type( $query );
251
-			self::set_cached_query( $query_hash, $result );
252
-		}
253
-
254
-		return $result;
255
-
256
-	}
257
-
258
-	/**
259
-	 * Enables big mysql selects for reports, just once for this session.
260
-	 */
261
-	protected static function enable_big_selects() {
262
-		static $big_selects = false;
263
-
264
-		global $wpdb;
265
-
266
-		if ( ! $big_selects ) {
267
-			$wpdb->query( 'SET SESSION SQL_BIG_SELECTS=1' );
268
-			$big_selects = true;
269
-		}
270
-	}
271
-
272
-	/**
273
-	 * Get the cached query result or null if it's not in the cache.
274
-	 *
275
-	 * @param string $query_hash The query hash.
276
-	 *
277
-	 * @return mixed|false The cache contents on success, false on failure to retrieve contents.
278
-	 */
279
-	protected static function get_cached_query( $query_hash ) {
280
-
281
-		return wp_cache_get(
282
-			$query_hash,
283
-			strtolower( __CLASS__ )
284
-		);
285
-
286
-	}
287
-
288
-	/**
289
-	 * Set the cached query result.
290
-	 *
291
-	 * @param string $query_hash The query hash.
292
-	 * @param mixed  $data The data to cache.
293
-	 */
294
-	protected static function set_cached_query( $query_hash, $data ) {
295
-
296
-		wp_cache_set(
297
-			$query_hash,
298
-			$data,
299
-			strtolower( __CLASS__ ),
300
-			5 * MINUTE_IN_SECONDS
301
-		);
302
-
303
-	}
93
+                if ( strtolower( $value['operator'] ) == 'in' || strtolower( $value['operator'] ) == 'not in' ) {
94
+
95
+                    if ( is_array( $value['value'] ) ) {
96
+                        $value['value'] = implode( "','", $value['value'] );
97
+                    }
98
+
99
+                    if ( ! empty( $value['value'] ) ) {
100
+                        $where_value = "{$value['operator']} ('{$value['value']}')";
101
+                    }
102
+                } else {
103
+                    $where_value = "{$value['operator']} '{$value['value']}'";
104
+                }
105
+
106
+                if ( ! empty( $where_value ) ) {
107
+                    $query['where'] .= " AND {$value['key']} {$where_value}";
108
+                }
109
+            }
110
+        }
111
+
112
+        if ( $group_by ) {
113
+            $query['group_by'] = "GROUP BY {$group_by}";
114
+        }
115
+
116
+        if ( $order_by ) {
117
+            $query['order_by'] = "ORDER BY {$order_by}";
118
+        }
119
+
120
+        if ( $limit ) {
121
+            $query['limit'] = "LIMIT {$limit}";
122
+        }
123
+
124
+        $query = apply_filters( 'getpaid_reports_get_invoice_report_query', $query, $data );
125
+        $query = implode( ' ', $query );
126
+
127
+        return self::execute( $query_type, $query );
128
+
129
+    }
130
+
131
+    /**
132
+     * Prepares the data to select.
133
+     *
134
+     *
135
+     * @param  array $data
136
+     * @return array
137
+     */
138
+    public static function prepare_invoice_data( $data ) {
139
+
140
+        $prepared = array();
141
+
142
+        foreach ( $data as $raw_key => $value ) {
143
+            $key      = sanitize_key( $raw_key );
144
+            $distinct = '';
145
+
146
+            if ( isset( $value['distinct'] ) ) {
147
+                $distinct = 'DISTINCT';
148
+            }
149
+
150
+            $get_key = self::get_invoice_table_key( $key, $value['type'] );
151
+
152
+            if ( false === $get_key ) {
153
+                // Skip to the next foreach iteration else the query will be invalid.
154
+                continue;
155
+            }
156
+
157
+            if ( ! empty( $value['function'] ) ) {
158
+                $get = "{$value['function']}({$distinct} {$get_key})";
159
+            } else {
160
+                $get = "{$distinct} {$get_key}";
161
+            }
162
+
163
+            $prepared[] = "{$get} as {$value['name']}";
164
+        }
165
+
166
+        return $prepared;
167
+
168
+    }
169
+
170
+    /**
171
+     * Prepares the joins to use.
172
+     *
173
+     *
174
+     * @param  array $data
175
+     * @param  bool $with_parent
176
+     * @return array
177
+     */
178
+    public static function prepare_invoice_joins( $data, $with_parent ) {
179
+        global $wpdb;
180
+
181
+        $prepared = array();
182
+
183
+        foreach ( $data as $raw_key => $value ) {
184
+            $join_type = isset( $value['join_type'] ) ? $value['join_type'] : 'INNER';
185
+            $type      = isset( $value['type'] ) ? $value['type'] : false;
186
+            $key       = sanitize_key( $raw_key );
187
+
188
+            switch ( $type ) {
189
+                case 'meta':
190
+                    $prepared[ "meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS meta_{$key} ON ( posts.ID = meta_{$key}.post_id AND meta_{$key}.meta_key = '{$raw_key}' )";
191
+                    break;
192
+                case 'parent_meta':
193
+                    $prepared[ "parent_meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS parent_meta_{$key} ON (posts.post_parent = parent_meta_{$key}.post_id) AND (parent_meta_{$key}.meta_key = '{$raw_key}')";
194
+                    break;
195
+                case 'invoice_data':
196
+                    $prepared['invoices'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoices AS invoices ON posts.ID = invoices.post_id";
197
+                    break;
198
+                case 'invoice_item':
199
+                    $prepared['invoice_items'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoice_items AS invoice_items ON posts.ID = invoice_items.post_id";
200
+                    break;
201
+            }
202
+        }
203
+
204
+        if ( $with_parent ) {
205
+            $prepared['parent'] = "LEFT JOIN {$wpdb->posts} AS parent ON posts.post_parent = parent.ID";
206
+        }
207
+
208
+        return $prepared;
209
+
210
+    }
211
+
212
+    /**
213
+     * Retrieves the appropriate table key to use.
214
+     *
215
+     *
216
+     * @param  string $key
217
+     * @param  string $table
218
+     * @return string|false
219
+     */
220
+    public static function get_invoice_table_key( $key, $table ) {
221
+
222
+        $keys = array(
223
+            'meta'         => "meta_{$key}.meta_value",
224
+            'parent_meta'  => "parent_meta_{$key}.meta_value",
225
+            'post_data'    => "posts.{$key}",
226
+            'invoice_data' => "invoices.{$key}",
227
+            'invoice_item' => "invoice_items.{$key}",
228
+        );
229
+
230
+        return isset( $keys[ $table ] ) ? $keys[ $table ] : false;
231
+
232
+    }
233
+
234
+    /**
235
+     * Executes a query and caches the result for a minute.
236
+     *
237
+     *
238
+     * @param  string $query_type
239
+     * @param  string $query
240
+     * @return mixed depending on query_type
241
+     */
242
+    public static function execute( $query_type, $query ) {
243
+        global $wpdb;
244
+
245
+        $query_hash = md5( $query_type . $query );
246
+        $result     = self::get_cached_query( $query_hash );
247
+        if ( $result === false ) {
248
+            self::enable_big_selects();
249
+
250
+            $result = $wpdb->$query_type( $query );
251
+            self::set_cached_query( $query_hash, $result );
252
+        }
253
+
254
+        return $result;
255
+
256
+    }
257
+
258
+    /**
259
+     * Enables big mysql selects for reports, just once for this session.
260
+     */
261
+    protected static function enable_big_selects() {
262
+        static $big_selects = false;
263
+
264
+        global $wpdb;
265
+
266
+        if ( ! $big_selects ) {
267
+            $wpdb->query( 'SET SESSION SQL_BIG_SELECTS=1' );
268
+            $big_selects = true;
269
+        }
270
+    }
271
+
272
+    /**
273
+     * Get the cached query result or null if it's not in the cache.
274
+     *
275
+     * @param string $query_hash The query hash.
276
+     *
277
+     * @return mixed|false The cache contents on success, false on failure to retrieve contents.
278
+     */
279
+    protected static function get_cached_query( $query_hash ) {
280
+
281
+        return wp_cache_get(
282
+            $query_hash,
283
+            strtolower( __CLASS__ )
284
+        );
285
+
286
+    }
287
+
288
+    /**
289
+     * Set the cached query result.
290
+     *
291
+     * @param string $query_hash The query hash.
292
+     * @param mixed  $data The data to cache.
293
+     */
294
+    protected static function set_cached_query( $query_hash, $data ) {
295
+
296
+        wp_cache_set(
297
+            $query_hash,
298
+            $data,
299
+            strtolower( __CLASS__ ),
300
+            5 * MINUTE_IN_SECONDS
301
+        );
302
+
303
+    }
304 304
 
305 305
 }
Please login to merge, or discard this patch.
includes/api/class-getpaid-rest-report-top-earners-controller.php 1 patch
Indentation   +42 added lines, -42 removed lines patch added patch discarded remove patch
@@ -18,50 +18,50 @@
 block discarded – undo
18 18
  */
19 19
 class GetPaid_REST_Report_Top_Earners_Controller extends GetPaid_REST_Report_Top_Sellers_Controller {
20 20
 
21
-	/**
22
-	 * Route base.
23
-	 *
24
-	 * @var string
25
-	 */
26
-	protected $rest_base = 'reports/top_earners';
21
+    /**
22
+     * Route base.
23
+     *
24
+     * @var string
25
+     */
26
+    protected $rest_base = 'reports/top_earners';
27 27
 
28
-	/**
29
-	 * Get all data needed for this report and store in the class.
30
-	 */
31
-	protected function query_report_data() {
28
+    /**
29
+     * Get all data needed for this report and store in the class.
30
+     */
31
+    protected function query_report_data() {
32 32
 
33
-		$this->report_data = GetPaid_Reports_Helper::get_invoice_report_data(
34
-			array(
35
-				'data'              => array(
36
-					'quantity'      => array(
37
-						'type'            => 'invoice_item',
38
-						'function'        => 'SUM',
39
-						'name'            => 'invoice_item_qty',
40
-					),
41
-					'item_id'             => array(
42
-						'type'            => 'invoice_item',
43
-						'function'        => '',
44
-						'name'            => 'invoice_item_id',
45
-					),
46
-					'item_name'           => array(
47
-						'type'            => 'invoice_item',
48
-						'function'        => '',
49
-						'name'            => 'invoice_item_name',
50
-					),
51
-					'price'               => array(
52
-						'type'            => 'invoice_item',
53
-						'function'        => 'SUM',
54
-						'name'            => 'invoice_item_price',
55
-					),
56
-				),
57
-				'group_by'       => 'invoice_item_id',
58
-				'order_by'       => 'invoice_item_price DESC',
59
-				'query_type'     => 'get_results',
60
-				'limit'          => 10,
61
-				'filter_range'   => $this->report_range,
62
-			)
63
-		);
33
+        $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data(
34
+            array(
35
+                'data'              => array(
36
+                    'quantity'      => array(
37
+                        'type'            => 'invoice_item',
38
+                        'function'        => 'SUM',
39
+                        'name'            => 'invoice_item_qty',
40
+                    ),
41
+                    'item_id'             => array(
42
+                        'type'            => 'invoice_item',
43
+                        'function'        => '',
44
+                        'name'            => 'invoice_item_id',
45
+                    ),
46
+                    'item_name'           => array(
47
+                        'type'            => 'invoice_item',
48
+                        'function'        => '',
49
+                        'name'            => 'invoice_item_name',
50
+                    ),
51
+                    'price'               => array(
52
+                        'type'            => 'invoice_item',
53
+                        'function'        => 'SUM',
54
+                        'name'            => 'invoice_item_price',
55
+                    ),
56
+                ),
57
+                'group_by'       => 'invoice_item_id',
58
+                'order_by'       => 'invoice_item_price DESC',
59
+                'query_type'     => 'get_results',
60
+                'limit'          => 10,
61
+                'filter_range'   => $this->report_range,
62
+            )
63
+        );
64 64
 
65
-	}
65
+    }
66 66
 
67 67
 }
Please login to merge, or discard this patch.
includes/api/class-getpaid-rest-report-invoice-counts-controller.php 1 patch
Indentation   +98 added lines, -98 removed lines patch added patch discarded remove patch
@@ -18,102 +18,102 @@
 block discarded – undo
18 18
  */
19 19
 class GetPaid_REST_Report_Invoice_Counts_Controller extends GetPaid_REST_Reports_Controller {
20 20
 
21
-	/**
22
-	 * Route base.
23
-	 *
24
-	 * @var string
25
-	 */
26
-	protected $rest_base = 'reports/invoices/counts';
27
-
28
-	/**
29
-	 * Prepare a report object for serialization.
30
-	 *
31
-	 * @param  stdClass        $report Report data.
32
-	 * @param  WP_REST_Request $request Request object.
33
-	 * @return WP_REST_Response $response Response data.
34
-	 */
35
-	public function prepare_item_for_response( $report, $request ) {
36
-
37
-		$data    = (array) $report;
38
-		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
39
-		$data    = $this->add_additional_fields_to_object( $data, $request );
40
-		$data    = $this->filter_response_by_context( $data, $context );
41
-
42
-		// Wrap the data in a response object.
43
-		$response = rest_ensure_response( $data );
44
-
45
-		$response->add_links(
46
-			array(
47
-				'about' => array(
48
-					'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
49
-				),
50
-			)
51
-		);
52
-
53
-		return apply_filters( 'getpaid_rest_prepare_report_invoices_count', $response, $report, $request );
54
-	}
55
-
56
-	/**
57
-	 * Get reports list.
58
-	 *
59
-	 * @since 2.0.0
60
-	 * @return array
61
-	 */
62
-	protected function get_reports() {
63
-
64
-		$counts = wp_count_posts( 'wpi_invoice' );
65
-		$data   = array();
66
-
67
-		foreach ( wpinv_get_invoice_statuses() as $slug => $name ) {
68
-
69
-			if ( ! isset( $counts->$slug ) ) {
70
-				continue;
71
-			}
72
-
73
-			$data[] = array(
74
-				'slug'  => $slug,
75
-				'name'  => $name,
76
-				'count' => (int) $counts->$slug,
77
-			);
78
-
79
-		}
80
-
81
-		return $data;
82
-
83
-	}
84
-
85
-	/**
86
-	 * Get the Report's schema, conforming to JSON Schema.
87
-	 *
88
-	 * @return array
89
-	 */
90
-	public function get_item_schema() {
91
-		$schema = array(
92
-			'$schema'    => 'http://json-schema.org/draft-04/schema#',
93
-			'title'      => 'report_invoice_counts',
94
-			'type'       => 'object',
95
-			'properties' => array(
96
-				'slug'  => array(
97
-					'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ),
98
-					'type'        => 'string',
99
-					'context'     => array( 'view' ),
100
-					'readonly'    => true,
101
-				),
102
-				'name'  => array(
103
-					'description' => __( 'Invoice status name.', 'invoicing' ),
104
-					'type'        => 'string',
105
-					'context'     => array( 'view' ),
106
-					'readonly'    => true,
107
-				),
108
-				'count' => array(
109
-					'description' => __( 'Number of invoices.', 'invoicing' ),
110
-					'type'        => 'string',
111
-					'context'     => array( 'view' ),
112
-					'readonly'    => true,
113
-				),
114
-			),
115
-		);
116
-
117
-		return $this->add_additional_fields_schema( $schema );
118
-	}
21
+    /**
22
+     * Route base.
23
+     *
24
+     * @var string
25
+     */
26
+    protected $rest_base = 'reports/invoices/counts';
27
+
28
+    /**
29
+     * Prepare a report object for serialization.
30
+     *
31
+     * @param  stdClass        $report Report data.
32
+     * @param  WP_REST_Request $request Request object.
33
+     * @return WP_REST_Response $response Response data.
34
+     */
35
+    public function prepare_item_for_response( $report, $request ) {
36
+
37
+        $data    = (array) $report;
38
+        $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
39
+        $data    = $this->add_additional_fields_to_object( $data, $request );
40
+        $data    = $this->filter_response_by_context( $data, $context );
41
+
42
+        // Wrap the data in a response object.
43
+        $response = rest_ensure_response( $data );
44
+
45
+        $response->add_links(
46
+            array(
47
+                'about' => array(
48
+                    'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
49
+                ),
50
+            )
51
+        );
52
+
53
+        return apply_filters( 'getpaid_rest_prepare_report_invoices_count', $response, $report, $request );
54
+    }
55
+
56
+    /**
57
+     * Get reports list.
58
+     *
59
+     * @since 2.0.0
60
+     * @return array
61
+     */
62
+    protected function get_reports() {
63
+
64
+        $counts = wp_count_posts( 'wpi_invoice' );
65
+        $data   = array();
66
+
67
+        foreach ( wpinv_get_invoice_statuses() as $slug => $name ) {
68
+
69
+            if ( ! isset( $counts->$slug ) ) {
70
+                continue;
71
+            }
72
+
73
+            $data[] = array(
74
+                'slug'  => $slug,
75
+                'name'  => $name,
76
+                'count' => (int) $counts->$slug,
77
+            );
78
+
79
+        }
80
+
81
+        return $data;
82
+
83
+    }
84
+
85
+    /**
86
+     * Get the Report's schema, conforming to JSON Schema.
87
+     *
88
+     * @return array
89
+     */
90
+    public function get_item_schema() {
91
+        $schema = array(
92
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
93
+            'title'      => 'report_invoice_counts',
94
+            'type'       => 'object',
95
+            'properties' => array(
96
+                'slug'  => array(
97
+                    'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ),
98
+                    'type'        => 'string',
99
+                    'context'     => array( 'view' ),
100
+                    'readonly'    => true,
101
+                ),
102
+                'name'  => array(
103
+                    'description' => __( 'Invoice status name.', 'invoicing' ),
104
+                    'type'        => 'string',
105
+                    'context'     => array( 'view' ),
106
+                    'readonly'    => true,
107
+                ),
108
+                'count' => array(
109
+                    'description' => __( 'Number of invoices.', 'invoicing' ),
110
+                    'type'        => 'string',
111
+                    'context'     => array( 'view' ),
112
+                    'readonly'    => true,
113
+                ),
114
+            ),
115
+        );
116
+
117
+        return $this->add_additional_fields_schema( $schema );
118
+    }
119 119
 }
Please login to merge, or discard this patch.
includes/api/class-getpaid-rest-reports-controller.php 1 patch
Indentation   +172 added lines, -172 removed lines patch added patch discarded remove patch
@@ -18,176 +18,176 @@
 block discarded – undo
18 18
  */
19 19
 class GetPaid_REST_Reports_Controller extends GetPaid_REST_Controller {
20 20
 
21
-	/**
22
-	 * Route base.
23
-	 *
24
-	 * @var string
25
-	 */
26
-	protected $rest_base = 'reports';
27
-
28
-	/**
29
-	 * Registers the routes for the objects of the controller.
30
-	 *
31
-	 * @since 2.0.0
32
-	 *
33
-	 * @see register_rest_route()
34
-	 */
35
-	public function register_namespace_routes( $namespace ) {
36
-
37
-		// List all available reports.
38
-		register_rest_route(
39
-			$namespace,
40
-			$this->rest_base,
41
-			array(
42
-				array(
43
-					'methods'             => WP_REST_Server::READABLE,
44
-					'callback'            => array( $this, 'get_items' ),
45
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
46
-					'args'                => $this->get_collection_params(),
47
-				),
48
-				'schema' => array( $this, 'get_public_item_schema' ),
49
-			)
50
-		);
51
-
52
-	}
53
-
54
-	/**
55
-	 * Makes sure the current user has access to READ the report APIs.
56
-	 *
57
-	 * @since  2.0.0
58
-	 * @param WP_REST_Request $request Full data about the request.
59
-	 * @return WP_Error|boolean
60
-	 */
61
-	public function get_items_permissions_check( $request ) {
62
-
63
-		if ( ! wpinv_current_user_can_manage_invoicing() ) {
64
-			return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
65
-		}
66
-
67
-		return true;
68
-	}
69
-
70
-	/**
71
-	 * Get reports list.
72
-	 *
73
-	 * @since 2.0.0
74
-	 * @return array
75
-	 */
76
-	protected function get_reports() {
77
-
78
-		$reports = array(
79
-			array(
80
-				'slug'        => 'sales',
81
-				'description' => __( 'List of sales reports.', 'invoicing' ),
82
-			),
83
-			array(
84
-				'slug'        => 'top_sellers',
85
-				'description' => __( 'List of top selling items.', 'invoicing' ),
86
-			),
87
-			array(
88
-				'slug'        => 'top_earners',
89
-				'description' => __( 'List of top earning items.', 'invoicing' ),
90
-			),
91
-			array(
92
-				'slug'        => 'invoices/counts',
93
-				'description' => __( 'Invoice counts.', 'invoicing' ),
94
-			),
95
-		);
96
-
97
-		return apply_filters( 'getpaid_available_api_reports', $reports );
98
-
99
-	}
100
-
101
-	/**
102
-	 * Get all reports.
103
-	 *
104
-	 * @since 2.0.0
105
-	 * @param WP_REST_Request $request
106
-	 * @return array|WP_Error
107
-	 */
108
-	public function get_items( $request ) {
109
-		$data    = array();
110
-		$reports = $this->get_reports();
111
-
112
-		foreach ( $reports as $report ) {
113
-			$item   = $this->prepare_item_for_response( (object) $report, $request );
114
-			$data[] = $this->prepare_response_for_collection( $item );
115
-		}
116
-
117
-		return rest_ensure_response( $data );
118
-	}
119
-
120
-	/**
121
-	 * Prepare a report object for serialization.
122
-	 *
123
-	 * @since 2.0.0
124
-	 * @param stdClass $report Report data.
125
-	 * @param WP_REST_Request $request Request object.
126
-	 * @return WP_REST_Response $response Response data.
127
-	 */
128
-	public function prepare_item_for_response( $report, $request ) {
129
-		$data = array(
130
-			'slug'        => $report->slug,
131
-			'description' => $report->description,
132
-		);
133
-
134
-		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
135
-		$data = $this->add_additional_fields_to_object( $data, $request );
136
-		$data = $this->filter_response_by_context( $data, $context );
137
-
138
-		// Wrap the data in a response object.
139
-		$response = rest_ensure_response( $data );
140
-		$response->add_links( array(
141
-			'self' => array(
142
-				'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ),
143
-			),
144
-			'collection' => array(
145
-				'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),
146
-			),
147
-		) );
148
-
149
-		return apply_filters( 'getpaid_rest_prepare_report', $response, $report, $request );
150
-	}
151
-
152
-	/**
153
-	 * Get the Report's schema, conforming to JSON Schema.
154
-	 *
155
-	 * @since 2.0.0
156
-	 * @return array
157
-	 */
158
-	public function get_item_schema() {
159
-		$schema = array(
160
-			'$schema'    => 'http://json-schema.org/draft-04/schema#',
161
-			'title'      => 'report',
162
-			'type'       => 'object',
163
-			'properties' => array(
164
-				'slug' => array(
165
-					'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ),
166
-					'type'        => 'string',
167
-					'context'     => array( 'view' ),
168
-					'readonly'    => true,
169
-				),
170
-				'description' => array(
171
-					'description' => __( 'A human-readable description of the resource.', 'invoicing' ),
172
-					'type'        => 'string',
173
-					'context'     => array( 'view' ),
174
-					'readonly'    => true,
175
-				),
176
-			),
177
-		);
178
-
179
-		return $this->add_additional_fields_schema( $schema );
180
-	}
181
-
182
-	/**
183
-	 * Get the query params for collections.
184
-	 *
185
-	 * @since 2.0.0
186
-	 * @return array
187
-	 */
188
-	public function get_collection_params() {
189
-		return array(
190
-			'context' => $this->get_context_param( array( 'default' => 'view' ) ),
191
-		);
192
-	}
21
+    /**
22
+     * Route base.
23
+     *
24
+     * @var string
25
+     */
26
+    protected $rest_base = 'reports';
27
+
28
+    /**
29
+     * Registers the routes for the objects of the controller.
30
+     *
31
+     * @since 2.0.0
32
+     *
33
+     * @see register_rest_route()
34
+     */
35
+    public function register_namespace_routes( $namespace ) {
36
+
37
+        // List all available reports.
38
+        register_rest_route(
39
+            $namespace,
40
+            $this->rest_base,
41
+            array(
42
+                array(
43
+                    'methods'             => WP_REST_Server::READABLE,
44
+                    'callback'            => array( $this, 'get_items' ),
45
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
46
+                    'args'                => $this->get_collection_params(),
47
+                ),
48
+                'schema' => array( $this, 'get_public_item_schema' ),
49
+            )
50
+        );
51
+
52
+    }
53
+
54
+    /**
55
+     * Makes sure the current user has access to READ the report APIs.
56
+     *
57
+     * @since  2.0.0
58
+     * @param WP_REST_Request $request Full data about the request.
59
+     * @return WP_Error|boolean
60
+     */
61
+    public function get_items_permissions_check( $request ) {
62
+
63
+        if ( ! wpinv_current_user_can_manage_invoicing() ) {
64
+            return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
65
+        }
66
+
67
+        return true;
68
+    }
69
+
70
+    /**
71
+     * Get reports list.
72
+     *
73
+     * @since 2.0.0
74
+     * @return array
75
+     */
76
+    protected function get_reports() {
77
+
78
+        $reports = array(
79
+            array(
80
+                'slug'        => 'sales',
81
+                'description' => __( 'List of sales reports.', 'invoicing' ),
82
+            ),
83
+            array(
84
+                'slug'        => 'top_sellers',
85
+                'description' => __( 'List of top selling items.', 'invoicing' ),
86
+            ),
87
+            array(
88
+                'slug'        => 'top_earners',
89
+                'description' => __( 'List of top earning items.', 'invoicing' ),
90
+            ),
91
+            array(
92
+                'slug'        => 'invoices/counts',
93
+                'description' => __( 'Invoice counts.', 'invoicing' ),
94
+            ),
95
+        );
96
+
97
+        return apply_filters( 'getpaid_available_api_reports', $reports );
98
+
99
+    }
100
+
101
+    /**
102
+     * Get all reports.
103
+     *
104
+     * @since 2.0.0
105
+     * @param WP_REST_Request $request
106
+     * @return array|WP_Error
107
+     */
108
+    public function get_items( $request ) {
109
+        $data    = array();
110
+        $reports = $this->get_reports();
111
+
112
+        foreach ( $reports as $report ) {
113
+            $item   = $this->prepare_item_for_response( (object) $report, $request );
114
+            $data[] = $this->prepare_response_for_collection( $item );
115
+        }
116
+
117
+        return rest_ensure_response( $data );
118
+    }
119
+
120
+    /**
121
+     * Prepare a report object for serialization.
122
+     *
123
+     * @since 2.0.0
124
+     * @param stdClass $report Report data.
125
+     * @param WP_REST_Request $request Request object.
126
+     * @return WP_REST_Response $response Response data.
127
+     */
128
+    public function prepare_item_for_response( $report, $request ) {
129
+        $data = array(
130
+            'slug'        => $report->slug,
131
+            'description' => $report->description,
132
+        );
133
+
134
+        $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
135
+        $data = $this->add_additional_fields_to_object( $data, $request );
136
+        $data = $this->filter_response_by_context( $data, $context );
137
+
138
+        // Wrap the data in a response object.
139
+        $response = rest_ensure_response( $data );
140
+        $response->add_links( array(
141
+            'self' => array(
142
+                'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ),
143
+            ),
144
+            'collection' => array(
145
+                'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),
146
+            ),
147
+        ) );
148
+
149
+        return apply_filters( 'getpaid_rest_prepare_report', $response, $report, $request );
150
+    }
151
+
152
+    /**
153
+     * Get the Report's schema, conforming to JSON Schema.
154
+     *
155
+     * @since 2.0.0
156
+     * @return array
157
+     */
158
+    public function get_item_schema() {
159
+        $schema = array(
160
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
161
+            'title'      => 'report',
162
+            'type'       => 'object',
163
+            'properties' => array(
164
+                'slug' => array(
165
+                    'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ),
166
+                    'type'        => 'string',
167
+                    'context'     => array( 'view' ),
168
+                    'readonly'    => true,
169
+                ),
170
+                'description' => array(
171
+                    'description' => __( 'A human-readable description of the resource.', 'invoicing' ),
172
+                    'type'        => 'string',
173
+                    'context'     => array( 'view' ),
174
+                    'readonly'    => true,
175
+                ),
176
+            ),
177
+        );
178
+
179
+        return $this->add_additional_fields_schema( $schema );
180
+    }
181
+
182
+    /**
183
+     * Get the query params for collections.
184
+     *
185
+     * @since 2.0.0
186
+     * @return array
187
+     */
188
+    public function get_collection_params() {
189
+        return array(
190
+            'context' => $this->get_context_param( array( 'default' => 'view' ) ),
191
+        );
192
+    }
193 193
 }
Please login to merge, or discard this patch.
includes/reports/class-getpaid-reports-report-earnings.php 1 patch
Indentation   +133 added lines, -133 removed lines patch added patch discarded remove patch
@@ -12,43 +12,43 @@  discard block
 block discarded – undo
12 12
  */
13 13
 class GetPaid_Reports_Report_Earnings extends GetPaid_Reports_Abstract_Report {
14 14
 
15
-	/**
16
-	 * Retrieves the earning graphs.
17
-	 *
18
-	 */
19
-	public function get_graphs() {
15
+    /**
16
+     * Retrieves the earning graphs.
17
+     *
18
+     */
19
+    public function get_graphs() {
20 20
 
21
-		$graphs = array(
21
+        $graphs = array(
22 22
 
23 23
             'total'      => __( 'Earnings', 'invoicing' ),
24 24
             'discount'   => __( 'Discount', 'invoicing' ),
25
-			'fees_total' => __( 'Fees', 'invoicing' ),
26
-			'tax'        => __( 'Tax', 'invoicing' ),
25
+            'fees_total' => __( 'Fees', 'invoicing' ),
26
+            'tax'        => __( 'Tax', 'invoicing' ),
27 27
 
28
-		);
28
+        );
29 29
 
30
-		return apply_filters( 'getpaid_earning_graphs', $graphs );
30
+        return apply_filters( 'getpaid_earning_graphs', $graphs );
31 31
 
32
-	}
32
+    }
33 33
 
34
-	/**
35
-	 * Retrieves the earning sql.
36
-	 *
37
-	 */
38
-	public function get_sql( $range ) {
39
-		global $wpdb;
34
+    /**
35
+     * Retrieves the earning sql.
36
+     *
37
+     */
38
+    public function get_sql( $range ) {
39
+        global $wpdb;
40 40
 
41
-		$table      = $wpdb->prefix . 'getpaid_invoices';
42
-		$clauses    = $this->get_range_sql( $range );
43
-		$graphs     = array_keys( $this->get_graphs() );
44
-		$graphs_sql = array();
41
+        $table      = $wpdb->prefix . 'getpaid_invoices';
42
+        $clauses    = $this->get_range_sql( $range );
43
+        $graphs     = array_keys( $this->get_graphs() );
44
+        $graphs_sql = array();
45 45
 
46
-		foreach ( $graphs as $graph ) {
47
-			$graphs_sql[] = "SUM( meta.$graph ) AS $graph";
48
-		}
46
+        foreach ( $graphs as $graph ) {
47
+            $graphs_sql[] = "SUM( meta.$graph ) AS $graph";
48
+        }
49 49
 
50
-		$graphs_sql = implode( ', ', $graphs_sql );
51
-		$sql        = "SELECT {$clauses[0]} AS completed_date, $graphs_sql
50
+        $graphs_sql = implode( ', ', $graphs_sql );
51
+        $sql        = "SELECT {$clauses[0]} AS completed_date, $graphs_sql
52 52
             FROM $wpdb->posts
53 53
             LEFT JOIN $table as meta ON meta.post_id = $wpdb->posts.ID
54 54
             WHERE meta.post_id IS NOT NULL
@@ -58,94 +58,94 @@  discard block
 block discarded – undo
58 58
             GROUP BY {$clauses[0]}
59 59
         ";
60 60
 
61
-		return apply_filters( 'getpaid_earning_graphs_get_sql', $sql, $range );
62
-
63
-	}
64
-
65
-	/**
66
-	 * Prepares the report stats.
67
-	 *
68
-	 */
69
-	public function prepare_stats() {
70
-		global $wpdb;
71
-		$this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) );
72
-	}
73
-
74
-	/**
75
-	 * Retrieves report labels.
76
-	 *
77
-	 */
78
-	public function get_labels( $range ) {
79
-
80
-		$labels = array(
81
-			'today'     => $this->get_hours_in_a_day(),
82
-			'yesterday' => $this->get_hours_in_a_day(),
83
-			'7_days'    => $this->get_days_in_period( 7 ),
84
-			'30_days'   => $this->get_days_in_period( 30 ),
85
-			'60_days'   => $this->get_days_in_period( 60 ),
86
-			'90_days'   => $this->get_weeks_in_period( 90 ),
87
-			'180_days'  => $this->get_weeks_in_period( 180 ),
88
-			'360_days'  => $this->get_weeks_in_period( 360 ),
89
-		);
90
-
91
-		$label = isset( $labels[ $range ] ) ? $labels[ $range ] : $labels[ '7_days' ];
92
-		return apply_filters( 'getpaid_earning_graphs_get_labels', $label, $range );
93
-	}
94
-
95
-	/**
96
-	 * Retrieves report datasets.
97
-	 *
98
-	 */
99
-	public function get_datasets( $labels ) {
100
-
101
-		$datasets = array();
102
-
103
-		foreach ( $this->get_graphs() as $key => $label ) {
104
-			$datasets[ $key ] = array(
105
-				'label' => $label,
106
-				'data'  => $this->get_data( $key, $labels )
107
-			);
108
-		}
109
-
110
-		return apply_filters( 'getpaid_earning_graphs_get_datasets', $datasets, $labels );
111
-	}
112
-
113
-	/**
114
-	 * Retrieves report data.
115
-	 *
116
-	 */
117
-	public function get_data( $key, $labels ) {
118
-
119
-		$data     = wp_list_pluck( $this->stats, $key, 'completed_date' );
120
-		$prepared = array();
121
-
122
-		foreach ( $labels as $label ) {
123
-
124
-			$value = 0;
125
-			if ( isset( $data[ $label ] ) ) {
126
-				$value = wpinv_round_amount( wpinv_sanitize_amount( $data[ $label ] ) );
127
-			}
128
-
129
-			$prepared[] = $value;
130
-		}
131
-
132
-		return apply_filters( 'getpaid_earning_graphs_get_data', $prepared, $key, $labels );
133
-
134
-	}
135
-
136
-	/**
137
-	 * Displays the report card.
138
-	 *
139
-	 */
140
-	public function display() {
141
-
142
-		$labels     = $this->get_labels( $this->get_range() );
143
-		$chart_data = array(
144
-			'labels'   => array_values( $labels ),
145
-			'datasets' => $this->get_datasets( array_keys( $labels ) ),
146
-		);
147
-
148
-		?>
61
+        return apply_filters( 'getpaid_earning_graphs_get_sql', $sql, $range );
62
+
63
+    }
64
+
65
+    /**
66
+     * Prepares the report stats.
67
+     *
68
+     */
69
+    public function prepare_stats() {
70
+        global $wpdb;
71
+        $this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) );
72
+    }
73
+
74
+    /**
75
+     * Retrieves report labels.
76
+     *
77
+     */
78
+    public function get_labels( $range ) {
79
+
80
+        $labels = array(
81
+            'today'     => $this->get_hours_in_a_day(),
82
+            'yesterday' => $this->get_hours_in_a_day(),
83
+            '7_days'    => $this->get_days_in_period( 7 ),
84
+            '30_days'   => $this->get_days_in_period( 30 ),
85
+            '60_days'   => $this->get_days_in_period( 60 ),
86
+            '90_days'   => $this->get_weeks_in_period( 90 ),
87
+            '180_days'  => $this->get_weeks_in_period( 180 ),
88
+            '360_days'  => $this->get_weeks_in_period( 360 ),
89
+        );
90
+
91
+        $label = isset( $labels[ $range ] ) ? $labels[ $range ] : $labels[ '7_days' ];
92
+        return apply_filters( 'getpaid_earning_graphs_get_labels', $label, $range );
93
+    }
94
+
95
+    /**
96
+     * Retrieves report datasets.
97
+     *
98
+     */
99
+    public function get_datasets( $labels ) {
100
+
101
+        $datasets = array();
102
+
103
+        foreach ( $this->get_graphs() as $key => $label ) {
104
+            $datasets[ $key ] = array(
105
+                'label' => $label,
106
+                'data'  => $this->get_data( $key, $labels )
107
+            );
108
+        }
109
+
110
+        return apply_filters( 'getpaid_earning_graphs_get_datasets', $datasets, $labels );
111
+    }
112
+
113
+    /**
114
+     * Retrieves report data.
115
+     *
116
+     */
117
+    public function get_data( $key, $labels ) {
118
+
119
+        $data     = wp_list_pluck( $this->stats, $key, 'completed_date' );
120
+        $prepared = array();
121
+
122
+        foreach ( $labels as $label ) {
123
+
124
+            $value = 0;
125
+            if ( isset( $data[ $label ] ) ) {
126
+                $value = wpinv_round_amount( wpinv_sanitize_amount( $data[ $label ] ) );
127
+            }
128
+
129
+            $prepared[] = $value;
130
+        }
131
+
132
+        return apply_filters( 'getpaid_earning_graphs_get_data', $prepared, $key, $labels );
133
+
134
+    }
135
+
136
+    /**
137
+     * Displays the report card.
138
+     *
139
+     */
140
+    public function display() {
141
+
142
+        $labels     = $this->get_labels( $this->get_range() );
143
+        $chart_data = array(
144
+            'labels'   => array_values( $labels ),
145
+            'datasets' => $this->get_datasets( array_keys( $labels ) ),
146
+        );
147
+
148
+        ?>
149 149
 
150 150
 			<?php foreach ( $chart_data['datasets'] as $key => $dataset ) : ?>
151 151
 				<div class="row mb-4">
@@ -165,15 +165,15 @@  discard block
 block discarded – undo
165 165
 
166 166
 		<?php
167 167
 
168
-	}
168
+    }
169 169
 
170
-	/**
171
-	 * Displays the actual report.
172
-	 *
173
-	 */
174
-	public function display_graph( $key, $dataset, $labels ) {
170
+    /**
171
+     * Displays the actual report.
172
+     *
173
+     */
174
+    public function display_graph( $key, $dataset, $labels ) {
175 175
 
176
-		?>
176
+        ?>
177 177
 
178 178
 		<canvas id="getpaid-chartjs-earnings-<?php echo sanitize_key( $key ); ?>"></canvas>
179 179
 
@@ -223,20 +223,20 @@  discard block
 block discarded – undo
223 223
 		</script>
224 224
 
225 225
 		<?php
226
-	}
226
+    }
227 227
 
228
-	/**
229
-	 * Displays the actual report.
230
-	 *
231
-	 */
232
-	public function display_stats() {}
228
+    /**
229
+     * Displays the actual report.
230
+     *
231
+     */
232
+    public function display_stats() {}
233 233
 
234
-	/**
235
-	 * Displays the range selector.
236
-	 *
237
-	 */
238
-	public function display_range_selector() {
234
+    /**
235
+     * Displays the range selector.
236
+     *
237
+     */
238
+    public function display_range_selector() {
239 239
 
240
-	}
240
+    }
241 241
 
242 242
 }
Please login to merge, or discard this patch.
includes/api/class-getpaid-rest-report-sales-controller.php 1 patch
Indentation   +659 added lines, -659 removed lines patch added patch discarded remove patch
@@ -18,664 +18,664 @@
 block discarded – undo
18 18
  */
19 19
 class GetPaid_REST_Report_Sales_Controller extends GetPaid_REST_Date_Based_Controller {
20 20
 
21
-	/**
22
-	 * Route base.
23
-	 *
24
-	 * @var string
25
-	 */
26
-	protected $rest_base = 'reports/sales';
27
-
28
-	/**
29
-	 * The report data.
30
-	 *
31
-	 * @var stdClass
32
-	 */
33
-	protected $report_data;
34
-
35
-	/**
36
-	 * The report range.
37
-	 *
38
-	 * @var array
39
-	 */
40
-	protected $report_range;
41
-
42
-	/**
43
-	 * Registers the routes for the objects of the controller.
44
-	 *
45
-	 * @since 2.0.0
46
-	 *
47
-	 * @see register_rest_route()
48
-	 */
49
-	public function register_namespace_routes( $namespace ) {
50
-
51
-		// Get sales report.
52
-		register_rest_route(
53
-			$namespace,
54
-			$this->rest_base,
55
-			array(
56
-				array(
57
-					'methods'             => WP_REST_Server::READABLE,
58
-					'callback'            => array( $this, 'get_items' ),
59
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
60
-					'args'                => $this->get_collection_params(),
61
-				),
62
-				'schema' => array( $this, 'get_public_item_schema' ),
63
-			)
64
-		);
65
-
66
-	}
67
-
68
-	/**
69
-	 * Makes sure the current user has access to READ the report APIs.
70
-	 *
71
-	 * @since  2.0.0
72
-	 * @param WP_REST_Request $request Full data about the request.
73
-	 * @return WP_Error|boolean
74
-	 */
75
-	public function get_items_permissions_check( $request ) {
76
-
77
-		if ( ! wpinv_current_user_can_manage_invoicing() ) {
78
-			return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
79
-		}
80
-
81
-		return true;
82
-	}
83
-
84
-	/**
85
-	 * Get sales reports.
86
-	 *
87
-	 * @param WP_REST_Request $request
88
-	 * @return array|WP_Error
89
-	 */
90
-	public function get_items( $request ) {
91
-		$data   = array();
92
-		$item   = $this->prepare_item_for_response( null, $request );
93
-		$data[] = $this->prepare_response_for_collection( $item );
94
-
95
-		return rest_ensure_response( $data );
96
-	}
97
-
98
-	/**
99
-	 * Prepare a report sales object for serialization.
100
-	 *
101
-	 * @param null $_
102
-	 * @param WP_REST_Request $request Request object.
103
-	 * @return WP_REST_Response $response Response data.
104
-	 */
105
-	public function prepare_item_for_response( $_, $request ) {
106
-
107
-		// Set report range.
108
-		$this->report_range = $this->get_date_range( $request );
109
-
110
-		$report_data     = $this->get_report_data();
111
-		$period_totals   = array();
112
-
113
-		// Setup period totals by ensuring each period in the interval has data.
114
-		$start_date      = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS;
115
-
116
-		if ( 'month' === $this->groupby ) {
117
-			$start_date      = strtotime( date( 'Y-m-01', $start_date ) );
118
-		}
119
-
120
-		for ( $i = 0; $i < $this->interval; $i++ ) {
121
-
122
-			switch ( $this->groupby ) {
123
-				case 'day' :
124
-					$time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) );
125
-					break;
126
-				default :
127
-					$time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) );
128
-					break;
129
-			}
130
-
131
-			// Set the defaults for each period.
132
-			$period_totals[ $time ] = array(
133
-				'sales'             => wpinv_round_amount( 0.00 ),
134
-				'invoices'          => 0,
135
-				'refunds'           => wpinv_round_amount( 0.00 ),
136
-				'items'             => 0,
137
-				'refunded_items'    => 0,
138
-				'tax'               => wpinv_round_amount( 0.00 ),
139
-				'refunded_tax'      => wpinv_round_amount( 0.00 ),
140
-				'subtotal'          => wpinv_round_amount( 0.00 ),
141
-				'refunded_subtotal' => wpinv_round_amount( 0.00 ),
142
-				'fees'              => wpinv_round_amount( 0.00 ),
143
-				'refunded_fees'     => wpinv_round_amount( 0.00 ),
144
-				'discount'          => wpinv_round_amount( 0.00 ),
145
-			);
146
-
147
-		}
148
-
149
-		// add total sales, total invoice count, total tax for each period
150
-		$date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m';
151
-		foreach ( $report_data->invoices as $invoice ) {
152
-			$time = date( $date_format, strtotime( $invoice->post_date ) );
153
-
154
-			if ( ! isset( $period_totals[ $time ] ) ) {
155
-				continue;
156
-			}
157
-
158
-			$period_totals[ $time ]['sales']    = wpinv_round_amount( $invoice->total_sales );
159
-			$period_totals[ $time ]['tax']      = wpinv_round_amount( $invoice->total_tax );
160
-			$period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal );
161
-			$period_totals[ $time ]['fees']     = wpinv_round_amount( $invoice->total_fees );
162
-
163
-		}
164
-
165
-		foreach ( $report_data->refunds as $invoice ) {
166
-			$time = date( $date_format, strtotime( $invoice->post_date ) );
167
-
168
-			if ( ! isset( $period_totals[ $time ] ) ) {
169
-				continue;
170
-			}
171
-
172
-			$period_totals[ $time ]['refunds']           = wpinv_round_amount( $invoice->total_sales );
173
-			$period_totals[ $time ]['refunded_tax']      = wpinv_round_amount( $invoice->total_tax );
174
-			$period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal );
175
-			$period_totals[ $time ]['refunded_fees']     = wpinv_round_amount( $invoice->total_fees );
176
-
177
-		}
178
-
179
-		foreach ( $report_data->invoice_counts as $invoice ) {
180
-			$time = date( $date_format, strtotime( $invoice->post_date ) );
181
-
182
-			if ( isset( $period_totals[ $time ] ) ) {
183
-				$period_totals[ $time ]['invoices']   = (int) $invoice->count;
184
-			}
185
-
186
-		}
187
-
188
-		// Add total invoice items for each period.
189
-		foreach ( $report_data->invoice_items as $invoice_item ) {
190
-			$time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) );
191
-
192
-			if ( isset( $period_totals[ $time ] ) ) {
193
-				$period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count;
194
-			}
195
-
196
-		}
197
-
198
-		// Add total discount for each period.
199
-		foreach ( $report_data->coupons as $discount ) {
200
-			$time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) );
201
-
202
-			if ( isset( $period_totals[ $time ] ) ) {
203
-				$period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount );
204
-			}
205
-
206
-		}
207
-
208
-		$report_data->totals            = $period_totals;
209
-		$report_data->grouped_by        = $this->groupby;
210
-		$report_data->interval          = max( $this->interval, 1 );
211
-		$report_data->currency          = wpinv_get_currency();
212
-		$report_data->currency_symbol   = wpinv_currency_symbol();
213
-		$report_data->currency_position = wpinv_currency_position();
214
-		$report_data->decimal_places    = wpinv_decimals();
215
-		$report_data->thousands_sep     = wpinv_thousands_separator();
216
-		$report_data->decimals_sep      = wpinv_decimal_separator();
217
-		$report_data->start_date        = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS );
218
-		$report_data->end_date          = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS );
219
-		$report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) );
220
-		$report_data->end_date_locale   = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) );
221
-		$report_data->decimals_sep      = wpinv_decimal_separator();
222
-
223
-		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
224
-		$data    = $report_data;
225
-		unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items );
226
-		$data    = $this->add_additional_fields_to_object( (array) $data, $request );
227
-		$data    = $this->filter_response_by_context( $data, $context );
228
-
229
-		// Wrap the data in a response object.
230
-		$response = rest_ensure_response( $data );
231
-		$response->add_links( array(
232
-			'about' => array(
233
-				'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
234
-			),
235
-		) );
236
-
237
-		return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request );
238
-	}
239
-
240
-	/**
241
-	 * Get report data.
242
-	 *
243
-	 * @return stdClass
244
-	 */
245
-	public function get_report_data() {
246
-		if ( empty( $this->report_data ) ) {
247
-			$this->query_report_data();
248
-		}
249
-		return $this->report_data;
250
-	}
251
-
252
-	/**
253
-	 * Get all data needed for this report and store in the class.
254
-	 */
255
-	protected function query_report_data() {
256
-
257
-		// Prepare reports.
258
-		$this->report_data = (object) array(
259
-			'invoice_counts' => $this->query_invoice_counts(),//count, post_date
260
-			'coupons'        => $this->query_coupon_counts(), // discount_amount, post_date
261
-			'invoice_items'  => $this->query_item_counts(), // invoice_item_count, post_date
262
-			'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date
263
-			'invoices'       => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date
264
-			'refunds'        => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date
265
-			'previous_range' => $this->previous_range,
266
-		);
267
-
268
-		// Calculated totals.
269
-		$this->report_data->total_tax          = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) );
270
-		$this->report_data->total_sales        = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) );
271
-		$this->report_data->total_discount     = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) );
272
-		$this->report_data->total_fees         = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) );
273
-		$this->report_data->subtotal           = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) );
274
-		$this->report_data->net_sales          = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) );
275
-		$this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) );
276
-		$this->report_data->total_refunds      = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) );
277
-		$this->report_data->refunded_discount  = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) );
278
-		$this->report_data->refunded_fees      = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) );
279
-		$this->report_data->refunded_subtotal  = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) );
280
-		$this->report_data->net_refunds        = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) );
281
-
282
-
283
-		// Calculate average based on net.
284
-		$this->report_data->average_sales       = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 );
285
-		$this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 );
286
-
287
-		// Total invoices in this period, even if refunded.
288
-		$this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) );
289
-
290
-		// Items invoiced in this period, even if refunded.
291
-		$this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) );
292
-
293
-		// 3rd party filtering of report data
294
-		$this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data );
295
-	}
296
-
297
-	/**
298
-	 * Prepares invoice counts.
299
-	 *
300
-	 * @return array.
301
-	 */
302
-	protected function query_invoice_counts() {
303
-
304
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
305
-			array(
306
-				'data'         => array(
307
-					'ID'        => array(
308
-						'type'     => 'post_data',
309
-						'function' => 'COUNT',
310
-						'name'     => 'count',
311
-						'distinct' => true,
312
-					),
313
-					'post_date' => array(
314
-						'type'     => 'post_data',
315
-						'function' => '',
316
-						'name'     => 'post_date',
317
-					),
318
-				),
319
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
320
-				'order_by'       => 'post_date ASC',
321
-				'query_type'     => 'get_results',
322
-				'filter_range'   => $this->report_range,
323
-				'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
324
-			)
325
-		);
326
-
327
-	}
328
-
329
-	/**
330
-	 * Prepares coupon counts.
331
-	 *
332
-	 * @return array.
333
-	 */
334
-	protected function query_coupon_counts() {
335
-
336
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
337
-			array(
338
-				'data'         => array(
339
-					'discount' => array(
340
-						'type'     => 'invoice_data',
341
-						'function' => 'SUM',
342
-						'name'     => 'discount_amount',
343
-					),
344
-					'post_date'       => array(
345
-						'type'     => 'post_data',
346
-						'function' => '',
347
-						'name'     => 'post_date',
348
-					),
349
-				),
350
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
351
-				'order_by'       => 'post_date ASC',
352
-				'query_type'     => 'get_results',
353
-				'filter_range'   => $this->report_range,
354
-				'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
355
-			)
356
-		);
357
-
358
-	}
359
-
360
-	/**
361
-	 * Prepares item counts.
362
-	 *
363
-	 * @return array.
364
-	 */
365
-	protected function query_item_counts() {
366
-
367
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
368
-			array(
369
-				'data'         => array(
370
-					'quantity'      => array(
371
-						'type'            => 'invoice_item',
372
-						'function'        => 'SUM',
373
-						'name'            => 'invoice_item_count',
374
-					),
375
-					'post_date' => array(
376
-						'type'     => 'post_data',
377
-						'function' => '',
378
-						'name'     => 'post_date',
379
-					),
380
-				),
381
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
382
-				'order_by'       => 'post_date ASC',
383
-				'query_type'     => 'get_results',
384
-				'filter_range'   => $this->report_range,
385
-				'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
386
-			)
387
-		);
388
-
389
-	}
390
-
391
-	/**
392
-	 * Prepares refunded item counts.
393
-	 *
394
-	 * @return array.
395
-	 */
396
-	protected function count_refunded_items() {
397
-
398
-		return (int) GetPaid_Reports_Helper::get_invoice_report_data(
399
-			array(
400
-				'data'         => array(
401
-					'quantity'      => array(
402
-						'type'            => 'invoice_item',
403
-						'function'        => 'SUM',
404
-						'name'            => 'invoice_item_count',
405
-					),
406
-				),
407
-				'query_type'     => 'get_var',
408
-				'filter_range'   => $this->report_range,
409
-				'invoice_status' => array( 'wpi-refunded' ),
410
-			)
411
-		);
412
-
413
-	}
414
-
415
-	/**
416
-	 * Prepares daily invoice totals.
417
-	 *
418
-	 * @return array.
419
-	 */
420
-	protected function query_invoice_totals() {
421
-
422
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
423
-			array(
424
-				'data'         => array(
425
-					'total'      => array(
426
-						'type'            => 'invoice_data',
427
-						'function'        => 'SUM',
428
-						'name'            => 'total_sales',
429
-					),
430
-					'tax'      => array(
431
-						'type'            => 'invoice_data',
432
-						'function'        => 'SUM',
433
-						'name'            => 'total_tax',
434
-					),
435
-					'discount'      => array(
436
-						'type'            => 'invoice_data',
437
-						'function'        => 'SUM',
438
-						'name'            => 'total_discount',
439
-					),
440
-					'fees_total'      => array(
441
-						'type'            => 'invoice_data',
442
-						'function'        => 'SUM',
443
-						'name'            => 'total_fees',
444
-					),
445
-					'subtotal'      => array(
446
-						'type'            => 'invoice_data',
447
-						'function'        => 'SUM',
448
-						'name'            => 'subtotal',
449
-					),
450
-					'post_date' => array(
451
-						'type'     => 'post_data',
452
-						'function' => '',
453
-						'name'     => 'post_date',
454
-					),
455
-				),
456
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
457
-				'order_by'       => 'post_date ASC',
458
-				'query_type'     => 'get_results',
459
-				'filter_range'   => $this->report_range,
460
-				'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ),
461
-			)
462
-		);
463
-
464
-	}
465
-
466
-	/**
467
-	 * Prepares daily invoice totals.
468
-	 *
469
-	 * @return array.
470
-	 */
471
-	protected function query_refunded_totals() {
472
-
473
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
474
-			array(
475
-				'data'         => array(
476
-					'total'      => array(
477
-						'type'            => 'invoice_data',
478
-						'function'        => 'SUM',
479
-						'name'            => 'total_sales',
480
-					),
481
-					'tax'      => array(
482
-						'type'            => 'invoice_data',
483
-						'function'        => 'SUM',
484
-						'name'            => 'total_tax',
485
-					),
486
-					'discount'      => array(
487
-						'type'            => 'invoice_data',
488
-						'function'        => 'SUM',
489
-						'name'            => 'total_discount',
490
-					),
491
-					'fees_total'      => array(
492
-						'type'            => 'invoice_data',
493
-						'function'        => 'SUM',
494
-						'name'            => 'total_fees',
495
-					),
496
-					'subtotal'      => array(
497
-						'type'            => 'invoice_data',
498
-						'function'        => 'SUM',
499
-						'name'            => 'subtotal',
500
-					),
501
-					'post_date' => array(
502
-						'type'     => 'post_data',
503
-						'function' => '',
504
-						'name'     => 'post_date',
505
-					),
506
-				),
507
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
508
-				'order_by'       => 'post_date ASC',
509
-				'query_type'     => 'get_results',
510
-				'filter_range'   => $this->report_range,
511
-				'invoice_status' => array( 'wpi-refunded' ),
512
-			)
513
-		);
514
-
515
-	}
516
-
517
-	/**
518
-	 * Get the Report's schema, conforming to JSON Schema.
519
-	 *
520
-	 * @return array
521
-	 */
522
-	public function get_item_schema() {
523
-
524
-		$schema = array(
525
-			'$schema'    => 'http://json-schema.org/draft-04/schema#',
526
-			'title'      => 'sales_report',
527
-			'type'       => 'object',
528
-			'properties' => array(
529
-				'total_sales' => array(
530
-					'description' => __( 'Gross sales in the period.', 'invoicing' ),
531
-					'type'        => 'string',
532
-					'context'     => array( 'view' ),
533
-					'readonly'    => true,
534
-				),
535
-				'net_sales' => array(
536
-					'description' => __( 'Net sales in the period.', 'invoicing' ),
537
-					'type'        => 'string',
538
-					'context'     => array( 'view' ),
539
-					'readonly'    => true,
540
-				),
541
-				'average_sales' => array(
542
-					'description' => __( 'Average net daily sales.', 'invoicing' ),
543
-					'type'        => 'string',
544
-					'context'     => array( 'view' ),
545
-					'readonly'    => true,
546
-				),
547
-				'average_total_sales' => array(
548
-					'description' => __( 'Average gross daily sales.', 'invoicing' ),
549
-					'type'        => 'string',
550
-					'context'     => array( 'view' ),
551
-					'readonly'    => true,
552
-				),
553
-				'total_invoices'  => array(
554
-					'description' => __( 'Number of paid invoices.', 'invoicing' ),
555
-					'type'        => 'integer',
556
-					'context'     => array( 'view' ),
557
-					'readonly'    => true,
558
-				),
559
-				'total_items' => array(
560
-					'description' => __( 'Number of items purchased.', 'invoicing' ),
561
-					'type'        => 'integer',
562
-					'context'     => array( 'view' ),
563
-					'readonly'    => true,
564
-				),
565
-				'refunded_items' => array(
566
-					'description' => __( 'Number of items refunded.', 'invoicing' ),
567
-					'type'        => 'integer',
568
-					'context'     => array( 'view' ),
569
-					'readonly'    => true,
570
-				),
571
-				'total_tax' => array(
572
-					'description' => __( 'Total charged for taxes.', 'invoicing' ),
573
-					'type'        => 'string',
574
-					'context'     => array( 'view' ),
575
-					'readonly'    => true,
576
-				),
577
-				'total_refunded_tax' => array(
578
-					'description' => __( 'Total refunded for taxes.', 'invoicing' ),
579
-					'type'        => 'string',
580
-					'context'     => array( 'view' ),
581
-					'readonly'    => true,
582
-				),
583
-				'total_fees' => array(
584
-					'description' => __( 'Total fees charged.', 'invoicing' ),
585
-					'type'        => 'string',
586
-					'context'     => array( 'view' ),
587
-					'readonly'    => true,
588
-				),
589
-				'total_refunds' => array(
590
-					'description' => __( 'Total of refunded invoices.', 'invoicing' ),
591
-					'type'        => 'integer',
592
-					'context'     => array( 'view' ),
593
-					'readonly'    => true,
594
-				),
595
-				'net_refunds' => array(
596
-					'description' => __( 'Net of refunded invoices.', 'invoicing' ),
597
-					'type'        => 'integer',
598
-					'context'     => array( 'view' ),
599
-					'readonly'    => true,
600
-				),
601
-				'total_discount' => array(
602
-					'description' => __( 'Total of discounts used.', 'invoicing' ),
603
-					'type'        => 'integer',
604
-					'context'     => array( 'view' ),
605
-					'readonly'    => true,
606
-				),
607
-				'totals' => array(
608
-					'description' => __( 'Totals.', 'invoicing' ),
609
-					'type'        => 'array',
610
-					'items'       => array(
611
-						'type'    => 'array',
612
-					),
613
-					'context'     => array( 'view' ),
614
-					'readonly'    => true,
615
-				),
616
-				'interval' => array(
617
-					'description' => __( 'Number of months/days in the report period.', 'invoicing' ),
618
-					'type'        => 'integer',
619
-					'context'     => array( 'view' ),
620
-					'readonly'    => true,
621
-				),
622
-				'previous_range'  => array(
623
-					'description' => __( 'The previous report period.', 'invoicing' ),
624
-					'type'        => 'array',
625
-					'items'       => array(
626
-						'type'    => 'string',
627
-					),
628
-					'context'     => array( 'view' ),
629
-					'readonly'    => true,
630
-				),
631
-				'grouped_by' => array(
632
-					'description' => __( 'The period used to group the totals.', 'invoicing' ),
633
-					'type'        => 'string',
634
-					'context'     => array( 'view' ),
635
-					'enum'        => array( 'day', 'month' ),
636
-					'readonly'    => true,
637
-				),
638
-				'currency' => array(
639
-					'description' => __( 'The default store currency.', 'invoicing' ),
640
-					'type'        => 'string',
641
-					'context'     => array( 'view' ),
642
-					'readonly'    => true,
643
-				),
644
-				'currency_symbol' => array(
645
-					'description' => __( 'The default store currency symbol.', 'invoicing' ),
646
-					'type'        => 'string',
647
-					'context'     => array( 'view' ),
648
-					'readonly'    => true,
649
-				),
650
-				'currency_position' => array(
651
-					'description' => __( 'The default store currency position.', 'invoicing' ),
652
-					'type'        => 'string',
653
-					'context'     => array( 'view' ),
654
-					'readonly'    => true,
655
-				),
656
-				'decimal_places' => array(
657
-					'description' => __( 'The default store decimal places.', 'invoicing' ),
658
-					'type'        => 'string',
659
-					'context'     => array( 'view' ),
660
-					'readonly'    => true,
661
-				),
662
-				'thousands_sep' => array(
663
-					'description' => __( 'The default store thousands separator.', 'invoicing' ),
664
-					'type'        => 'string',
665
-					'context'     => array( 'view' ),
666
-					'readonly'    => true,
667
-				),
668
-				'decimals_sep' => array(
669
-					'description' => __( 'The default store decimals separator.', 'invoicing' ),
670
-					'type'        => 'string',
671
-					'context'     => array( 'view' ),
672
-					'readonly'    => true,
673
-				),
674
-			),
675
-		);
676
-
677
-		return $this->add_additional_fields_schema( $schema );
678
-
679
-	}
21
+    /**
22
+     * Route base.
23
+     *
24
+     * @var string
25
+     */
26
+    protected $rest_base = 'reports/sales';
27
+
28
+    /**
29
+     * The report data.
30
+     *
31
+     * @var stdClass
32
+     */
33
+    protected $report_data;
34
+
35
+    /**
36
+     * The report range.
37
+     *
38
+     * @var array
39
+     */
40
+    protected $report_range;
41
+
42
+    /**
43
+     * Registers the routes for the objects of the controller.
44
+     *
45
+     * @since 2.0.0
46
+     *
47
+     * @see register_rest_route()
48
+     */
49
+    public function register_namespace_routes( $namespace ) {
50
+
51
+        // Get sales report.
52
+        register_rest_route(
53
+            $namespace,
54
+            $this->rest_base,
55
+            array(
56
+                array(
57
+                    'methods'             => WP_REST_Server::READABLE,
58
+                    'callback'            => array( $this, 'get_items' ),
59
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
60
+                    'args'                => $this->get_collection_params(),
61
+                ),
62
+                'schema' => array( $this, 'get_public_item_schema' ),
63
+            )
64
+        );
65
+
66
+    }
67
+
68
+    /**
69
+     * Makes sure the current user has access to READ the report APIs.
70
+     *
71
+     * @since  2.0.0
72
+     * @param WP_REST_Request $request Full data about the request.
73
+     * @return WP_Error|boolean
74
+     */
75
+    public function get_items_permissions_check( $request ) {
76
+
77
+        if ( ! wpinv_current_user_can_manage_invoicing() ) {
78
+            return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
79
+        }
80
+
81
+        return true;
82
+    }
83
+
84
+    /**
85
+     * Get sales reports.
86
+     *
87
+     * @param WP_REST_Request $request
88
+     * @return array|WP_Error
89
+     */
90
+    public function get_items( $request ) {
91
+        $data   = array();
92
+        $item   = $this->prepare_item_for_response( null, $request );
93
+        $data[] = $this->prepare_response_for_collection( $item );
94
+
95
+        return rest_ensure_response( $data );
96
+    }
97
+
98
+    /**
99
+     * Prepare a report sales object for serialization.
100
+     *
101
+     * @param null $_
102
+     * @param WP_REST_Request $request Request object.
103
+     * @return WP_REST_Response $response Response data.
104
+     */
105
+    public function prepare_item_for_response( $_, $request ) {
106
+
107
+        // Set report range.
108
+        $this->report_range = $this->get_date_range( $request );
109
+
110
+        $report_data     = $this->get_report_data();
111
+        $period_totals   = array();
112
+
113
+        // Setup period totals by ensuring each period in the interval has data.
114
+        $start_date      = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS;
115
+
116
+        if ( 'month' === $this->groupby ) {
117
+            $start_date      = strtotime( date( 'Y-m-01', $start_date ) );
118
+        }
119
+
120
+        for ( $i = 0; $i < $this->interval; $i++ ) {
121
+
122
+            switch ( $this->groupby ) {
123
+                case 'day' :
124
+                    $time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) );
125
+                    break;
126
+                default :
127
+                    $time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) );
128
+                    break;
129
+            }
130
+
131
+            // Set the defaults for each period.
132
+            $period_totals[ $time ] = array(
133
+                'sales'             => wpinv_round_amount( 0.00 ),
134
+                'invoices'          => 0,
135
+                'refunds'           => wpinv_round_amount( 0.00 ),
136
+                'items'             => 0,
137
+                'refunded_items'    => 0,
138
+                'tax'               => wpinv_round_amount( 0.00 ),
139
+                'refunded_tax'      => wpinv_round_amount( 0.00 ),
140
+                'subtotal'          => wpinv_round_amount( 0.00 ),
141
+                'refunded_subtotal' => wpinv_round_amount( 0.00 ),
142
+                'fees'              => wpinv_round_amount( 0.00 ),
143
+                'refunded_fees'     => wpinv_round_amount( 0.00 ),
144
+                'discount'          => wpinv_round_amount( 0.00 ),
145
+            );
146
+
147
+        }
148
+
149
+        // add total sales, total invoice count, total tax for each period
150
+        $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m';
151
+        foreach ( $report_data->invoices as $invoice ) {
152
+            $time = date( $date_format, strtotime( $invoice->post_date ) );
153
+
154
+            if ( ! isset( $period_totals[ $time ] ) ) {
155
+                continue;
156
+            }
157
+
158
+            $period_totals[ $time ]['sales']    = wpinv_round_amount( $invoice->total_sales );
159
+            $period_totals[ $time ]['tax']      = wpinv_round_amount( $invoice->total_tax );
160
+            $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal );
161
+            $period_totals[ $time ]['fees']     = wpinv_round_amount( $invoice->total_fees );
162
+
163
+        }
164
+
165
+        foreach ( $report_data->refunds as $invoice ) {
166
+            $time = date( $date_format, strtotime( $invoice->post_date ) );
167
+
168
+            if ( ! isset( $period_totals[ $time ] ) ) {
169
+                continue;
170
+            }
171
+
172
+            $period_totals[ $time ]['refunds']           = wpinv_round_amount( $invoice->total_sales );
173
+            $period_totals[ $time ]['refunded_tax']      = wpinv_round_amount( $invoice->total_tax );
174
+            $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal );
175
+            $period_totals[ $time ]['refunded_fees']     = wpinv_round_amount( $invoice->total_fees );
176
+
177
+        }
178
+
179
+        foreach ( $report_data->invoice_counts as $invoice ) {
180
+            $time = date( $date_format, strtotime( $invoice->post_date ) );
181
+
182
+            if ( isset( $period_totals[ $time ] ) ) {
183
+                $period_totals[ $time ]['invoices']   = (int) $invoice->count;
184
+            }
185
+
186
+        }
187
+
188
+        // Add total invoice items for each period.
189
+        foreach ( $report_data->invoice_items as $invoice_item ) {
190
+            $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) );
191
+
192
+            if ( isset( $period_totals[ $time ] ) ) {
193
+                $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count;
194
+            }
195
+
196
+        }
197
+
198
+        // Add total discount for each period.
199
+        foreach ( $report_data->coupons as $discount ) {
200
+            $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) );
201
+
202
+            if ( isset( $period_totals[ $time ] ) ) {
203
+                $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount );
204
+            }
205
+
206
+        }
207
+
208
+        $report_data->totals            = $period_totals;
209
+        $report_data->grouped_by        = $this->groupby;
210
+        $report_data->interval          = max( $this->interval, 1 );
211
+        $report_data->currency          = wpinv_get_currency();
212
+        $report_data->currency_symbol   = wpinv_currency_symbol();
213
+        $report_data->currency_position = wpinv_currency_position();
214
+        $report_data->decimal_places    = wpinv_decimals();
215
+        $report_data->thousands_sep     = wpinv_thousands_separator();
216
+        $report_data->decimals_sep      = wpinv_decimal_separator();
217
+        $report_data->start_date        = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS );
218
+        $report_data->end_date          = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS );
219
+        $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) );
220
+        $report_data->end_date_locale   = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) );
221
+        $report_data->decimals_sep      = wpinv_decimal_separator();
222
+
223
+        $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
224
+        $data    = $report_data;
225
+        unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items );
226
+        $data    = $this->add_additional_fields_to_object( (array) $data, $request );
227
+        $data    = $this->filter_response_by_context( $data, $context );
228
+
229
+        // Wrap the data in a response object.
230
+        $response = rest_ensure_response( $data );
231
+        $response->add_links( array(
232
+            'about' => array(
233
+                'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
234
+            ),
235
+        ) );
236
+
237
+        return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request );
238
+    }
239
+
240
+    /**
241
+     * Get report data.
242
+     *
243
+     * @return stdClass
244
+     */
245
+    public function get_report_data() {
246
+        if ( empty( $this->report_data ) ) {
247
+            $this->query_report_data();
248
+        }
249
+        return $this->report_data;
250
+    }
251
+
252
+    /**
253
+     * Get all data needed for this report and store in the class.
254
+     */
255
+    protected function query_report_data() {
256
+
257
+        // Prepare reports.
258
+        $this->report_data = (object) array(
259
+            'invoice_counts' => $this->query_invoice_counts(),//count, post_date
260
+            'coupons'        => $this->query_coupon_counts(), // discount_amount, post_date
261
+            'invoice_items'  => $this->query_item_counts(), // invoice_item_count, post_date
262
+            'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date
263
+            'invoices'       => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date
264
+            'refunds'        => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date
265
+            'previous_range' => $this->previous_range,
266
+        );
267
+
268
+        // Calculated totals.
269
+        $this->report_data->total_tax          = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) );
270
+        $this->report_data->total_sales        = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) );
271
+        $this->report_data->total_discount     = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) );
272
+        $this->report_data->total_fees         = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) );
273
+        $this->report_data->subtotal           = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) );
274
+        $this->report_data->net_sales          = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) );
275
+        $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) );
276
+        $this->report_data->total_refunds      = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) );
277
+        $this->report_data->refunded_discount  = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) );
278
+        $this->report_data->refunded_fees      = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) );
279
+        $this->report_data->refunded_subtotal  = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) );
280
+        $this->report_data->net_refunds        = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) );
281
+
282
+
283
+        // Calculate average based on net.
284
+        $this->report_data->average_sales       = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 );
285
+        $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 );
286
+
287
+        // Total invoices in this period, even if refunded.
288
+        $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) );
289
+
290
+        // Items invoiced in this period, even if refunded.
291
+        $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) );
292
+
293
+        // 3rd party filtering of report data
294
+        $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data );
295
+    }
296
+
297
+    /**
298
+     * Prepares invoice counts.
299
+     *
300
+     * @return array.
301
+     */
302
+    protected function query_invoice_counts() {
303
+
304
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
305
+            array(
306
+                'data'         => array(
307
+                    'ID'        => array(
308
+                        'type'     => 'post_data',
309
+                        'function' => 'COUNT',
310
+                        'name'     => 'count',
311
+                        'distinct' => true,
312
+                    ),
313
+                    'post_date' => array(
314
+                        'type'     => 'post_data',
315
+                        'function' => '',
316
+                        'name'     => 'post_date',
317
+                    ),
318
+                ),
319
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
320
+                'order_by'       => 'post_date ASC',
321
+                'query_type'     => 'get_results',
322
+                'filter_range'   => $this->report_range,
323
+                'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
324
+            )
325
+        );
326
+
327
+    }
328
+
329
+    /**
330
+     * Prepares coupon counts.
331
+     *
332
+     * @return array.
333
+     */
334
+    protected function query_coupon_counts() {
335
+
336
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
337
+            array(
338
+                'data'         => array(
339
+                    'discount' => array(
340
+                        'type'     => 'invoice_data',
341
+                        'function' => 'SUM',
342
+                        'name'     => 'discount_amount',
343
+                    ),
344
+                    'post_date'       => array(
345
+                        'type'     => 'post_data',
346
+                        'function' => '',
347
+                        'name'     => 'post_date',
348
+                    ),
349
+                ),
350
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
351
+                'order_by'       => 'post_date ASC',
352
+                'query_type'     => 'get_results',
353
+                'filter_range'   => $this->report_range,
354
+                'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
355
+            )
356
+        );
357
+
358
+    }
359
+
360
+    /**
361
+     * Prepares item counts.
362
+     *
363
+     * @return array.
364
+     */
365
+    protected function query_item_counts() {
366
+
367
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
368
+            array(
369
+                'data'         => array(
370
+                    'quantity'      => array(
371
+                        'type'            => 'invoice_item',
372
+                        'function'        => 'SUM',
373
+                        'name'            => 'invoice_item_count',
374
+                    ),
375
+                    'post_date' => array(
376
+                        'type'     => 'post_data',
377
+                        'function' => '',
378
+                        'name'     => 'post_date',
379
+                    ),
380
+                ),
381
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
382
+                'order_by'       => 'post_date ASC',
383
+                'query_type'     => 'get_results',
384
+                'filter_range'   => $this->report_range,
385
+                'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
386
+            )
387
+        );
388
+
389
+    }
390
+
391
+    /**
392
+     * Prepares refunded item counts.
393
+     *
394
+     * @return array.
395
+     */
396
+    protected function count_refunded_items() {
397
+
398
+        return (int) GetPaid_Reports_Helper::get_invoice_report_data(
399
+            array(
400
+                'data'         => array(
401
+                    'quantity'      => array(
402
+                        'type'            => 'invoice_item',
403
+                        'function'        => 'SUM',
404
+                        'name'            => 'invoice_item_count',
405
+                    ),
406
+                ),
407
+                'query_type'     => 'get_var',
408
+                'filter_range'   => $this->report_range,
409
+                'invoice_status' => array( 'wpi-refunded' ),
410
+            )
411
+        );
412
+
413
+    }
414
+
415
+    /**
416
+     * Prepares daily invoice totals.
417
+     *
418
+     * @return array.
419
+     */
420
+    protected function query_invoice_totals() {
421
+
422
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
423
+            array(
424
+                'data'         => array(
425
+                    'total'      => array(
426
+                        'type'            => 'invoice_data',
427
+                        'function'        => 'SUM',
428
+                        'name'            => 'total_sales',
429
+                    ),
430
+                    'tax'      => array(
431
+                        'type'            => 'invoice_data',
432
+                        'function'        => 'SUM',
433
+                        'name'            => 'total_tax',
434
+                    ),
435
+                    'discount'      => array(
436
+                        'type'            => 'invoice_data',
437
+                        'function'        => 'SUM',
438
+                        'name'            => 'total_discount',
439
+                    ),
440
+                    'fees_total'      => array(
441
+                        'type'            => 'invoice_data',
442
+                        'function'        => 'SUM',
443
+                        'name'            => 'total_fees',
444
+                    ),
445
+                    'subtotal'      => array(
446
+                        'type'            => 'invoice_data',
447
+                        'function'        => 'SUM',
448
+                        'name'            => 'subtotal',
449
+                    ),
450
+                    'post_date' => array(
451
+                        'type'     => 'post_data',
452
+                        'function' => '',
453
+                        'name'     => 'post_date',
454
+                    ),
455
+                ),
456
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
457
+                'order_by'       => 'post_date ASC',
458
+                'query_type'     => 'get_results',
459
+                'filter_range'   => $this->report_range,
460
+                'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ),
461
+            )
462
+        );
463
+
464
+    }
465
+
466
+    /**
467
+     * Prepares daily invoice totals.
468
+     *
469
+     * @return array.
470
+     */
471
+    protected function query_refunded_totals() {
472
+
473
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
474
+            array(
475
+                'data'         => array(
476
+                    'total'      => array(
477
+                        'type'            => 'invoice_data',
478
+                        'function'        => 'SUM',
479
+                        'name'            => 'total_sales',
480
+                    ),
481
+                    'tax'      => array(
482
+                        'type'            => 'invoice_data',
483
+                        'function'        => 'SUM',
484
+                        'name'            => 'total_tax',
485
+                    ),
486
+                    'discount'      => array(
487
+                        'type'            => 'invoice_data',
488
+                        'function'        => 'SUM',
489
+                        'name'            => 'total_discount',
490
+                    ),
491
+                    'fees_total'      => array(
492
+                        'type'            => 'invoice_data',
493
+                        'function'        => 'SUM',
494
+                        'name'            => 'total_fees',
495
+                    ),
496
+                    'subtotal'      => array(
497
+                        'type'            => 'invoice_data',
498
+                        'function'        => 'SUM',
499
+                        'name'            => 'subtotal',
500
+                    ),
501
+                    'post_date' => array(
502
+                        'type'     => 'post_data',
503
+                        'function' => '',
504
+                        'name'     => 'post_date',
505
+                    ),
506
+                ),
507
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
508
+                'order_by'       => 'post_date ASC',
509
+                'query_type'     => 'get_results',
510
+                'filter_range'   => $this->report_range,
511
+                'invoice_status' => array( 'wpi-refunded' ),
512
+            )
513
+        );
514
+
515
+    }
516
+
517
+    /**
518
+     * Get the Report's schema, conforming to JSON Schema.
519
+     *
520
+     * @return array
521
+     */
522
+    public function get_item_schema() {
523
+
524
+        $schema = array(
525
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
526
+            'title'      => 'sales_report',
527
+            'type'       => 'object',
528
+            'properties' => array(
529
+                'total_sales' => array(
530
+                    'description' => __( 'Gross sales in the period.', 'invoicing' ),
531
+                    'type'        => 'string',
532
+                    'context'     => array( 'view' ),
533
+                    'readonly'    => true,
534
+                ),
535
+                'net_sales' => array(
536
+                    'description' => __( 'Net sales in the period.', 'invoicing' ),
537
+                    'type'        => 'string',
538
+                    'context'     => array( 'view' ),
539
+                    'readonly'    => true,
540
+                ),
541
+                'average_sales' => array(
542
+                    'description' => __( 'Average net daily sales.', 'invoicing' ),
543
+                    'type'        => 'string',
544
+                    'context'     => array( 'view' ),
545
+                    'readonly'    => true,
546
+                ),
547
+                'average_total_sales' => array(
548
+                    'description' => __( 'Average gross daily sales.', 'invoicing' ),
549
+                    'type'        => 'string',
550
+                    'context'     => array( 'view' ),
551
+                    'readonly'    => true,
552
+                ),
553
+                'total_invoices'  => array(
554
+                    'description' => __( 'Number of paid invoices.', 'invoicing' ),
555
+                    'type'        => 'integer',
556
+                    'context'     => array( 'view' ),
557
+                    'readonly'    => true,
558
+                ),
559
+                'total_items' => array(
560
+                    'description' => __( 'Number of items purchased.', 'invoicing' ),
561
+                    'type'        => 'integer',
562
+                    'context'     => array( 'view' ),
563
+                    'readonly'    => true,
564
+                ),
565
+                'refunded_items' => array(
566
+                    'description' => __( 'Number of items refunded.', 'invoicing' ),
567
+                    'type'        => 'integer',
568
+                    'context'     => array( 'view' ),
569
+                    'readonly'    => true,
570
+                ),
571
+                'total_tax' => array(
572
+                    'description' => __( 'Total charged for taxes.', 'invoicing' ),
573
+                    'type'        => 'string',
574
+                    'context'     => array( 'view' ),
575
+                    'readonly'    => true,
576
+                ),
577
+                'total_refunded_tax' => array(
578
+                    'description' => __( 'Total refunded for taxes.', 'invoicing' ),
579
+                    'type'        => 'string',
580
+                    'context'     => array( 'view' ),
581
+                    'readonly'    => true,
582
+                ),
583
+                'total_fees' => array(
584
+                    'description' => __( 'Total fees charged.', 'invoicing' ),
585
+                    'type'        => 'string',
586
+                    'context'     => array( 'view' ),
587
+                    'readonly'    => true,
588
+                ),
589
+                'total_refunds' => array(
590
+                    'description' => __( 'Total of refunded invoices.', 'invoicing' ),
591
+                    'type'        => 'integer',
592
+                    'context'     => array( 'view' ),
593
+                    'readonly'    => true,
594
+                ),
595
+                'net_refunds' => array(
596
+                    'description' => __( 'Net of refunded invoices.', 'invoicing' ),
597
+                    'type'        => 'integer',
598
+                    'context'     => array( 'view' ),
599
+                    'readonly'    => true,
600
+                ),
601
+                'total_discount' => array(
602
+                    'description' => __( 'Total of discounts used.', 'invoicing' ),
603
+                    'type'        => 'integer',
604
+                    'context'     => array( 'view' ),
605
+                    'readonly'    => true,
606
+                ),
607
+                'totals' => array(
608
+                    'description' => __( 'Totals.', 'invoicing' ),
609
+                    'type'        => 'array',
610
+                    'items'       => array(
611
+                        'type'    => 'array',
612
+                    ),
613
+                    'context'     => array( 'view' ),
614
+                    'readonly'    => true,
615
+                ),
616
+                'interval' => array(
617
+                    'description' => __( 'Number of months/days in the report period.', 'invoicing' ),
618
+                    'type'        => 'integer',
619
+                    'context'     => array( 'view' ),
620
+                    'readonly'    => true,
621
+                ),
622
+                'previous_range'  => array(
623
+                    'description' => __( 'The previous report period.', 'invoicing' ),
624
+                    'type'        => 'array',
625
+                    'items'       => array(
626
+                        'type'    => 'string',
627
+                    ),
628
+                    'context'     => array( 'view' ),
629
+                    'readonly'    => true,
630
+                ),
631
+                'grouped_by' => array(
632
+                    'description' => __( 'The period used to group the totals.', 'invoicing' ),
633
+                    'type'        => 'string',
634
+                    'context'     => array( 'view' ),
635
+                    'enum'        => array( 'day', 'month' ),
636
+                    'readonly'    => true,
637
+                ),
638
+                'currency' => array(
639
+                    'description' => __( 'The default store currency.', 'invoicing' ),
640
+                    'type'        => 'string',
641
+                    'context'     => array( 'view' ),
642
+                    'readonly'    => true,
643
+                ),
644
+                'currency_symbol' => array(
645
+                    'description' => __( 'The default store currency symbol.', 'invoicing' ),
646
+                    'type'        => 'string',
647
+                    'context'     => array( 'view' ),
648
+                    'readonly'    => true,
649
+                ),
650
+                'currency_position' => array(
651
+                    'description' => __( 'The default store currency position.', 'invoicing' ),
652
+                    'type'        => 'string',
653
+                    'context'     => array( 'view' ),
654
+                    'readonly'    => true,
655
+                ),
656
+                'decimal_places' => array(
657
+                    'description' => __( 'The default store decimal places.', 'invoicing' ),
658
+                    'type'        => 'string',
659
+                    'context'     => array( 'view' ),
660
+                    'readonly'    => true,
661
+                ),
662
+                'thousands_sep' => array(
663
+                    'description' => __( 'The default store thousands separator.', 'invoicing' ),
664
+                    'type'        => 'string',
665
+                    'context'     => array( 'view' ),
666
+                    'readonly'    => true,
667
+                ),
668
+                'decimals_sep' => array(
669
+                    'description' => __( 'The default store decimals separator.', 'invoicing' ),
670
+                    'type'        => 'string',
671
+                    'context'     => array( 'view' ),
672
+                    'readonly'    => true,
673
+                ),
674
+            ),
675
+        );
676
+
677
+        return $this->add_additional_fields_schema( $schema );
678
+
679
+    }
680 680
 
681 681
 }
Please login to merge, or discard this patch.