give / includes / admin / tools / data / class-give-tools-recount-income.php

class-give-tools-recount-income.php in GiveWP – Donation Plugin and Fundraising Platform 2.3.1, at includes/admin/tools/data/class-give-tools-recount-income.php

304 lines 6.0 KB

Raw Download Zip

1	<?php
2	/**
3	* Recount earnings
4	*
5	* This class handles batch processing of recounting earnings
6	*
7	* @subpackage Admin/Tools/Give_Tools_Recount_Income
8	* @copyright Copyright (c) 2016, GiveWP
9	* @license https://opensource.org/licenses/gpl-license GNU Public License
10	* @since 1.5
11	*/
12
13	// Exit if accessed directly.
14	if ( ! defined( 'ABSPATH' ) ) {
15	exit;
16	}
17
18	/**
19	* Give_Tools_Recount_Income Class
20	*
21	* @since 1.5
22	*/
23	class Give_Tools_Recount_Income extends Give_Batch_Export {
24
25	/**
26	* Our export type. Used for export-type specific filters/actions
27	* @var string
28	* @since 1.5
29	*/
30	public $export_type = '';
31
32	/**
33	* Allows for a non-form batch processing to be run.
34	* @since 1.5
35	* @var boolean
36	*/
37	public $is_void = true;
38
39	/**
40	* Sets the number of items to pull on each step
41	* @since 1.5
42	* @var integer
43	*/
44	public $per_step = 100;
45
46	/**
47	* Constructor.
48	*/
49	public function __construct( $_step = 1 ) {
50	parent::__construct( $_step );
51
52	$this->is_writable = true;
53	}
54	/**
55	* Get the Export Data
56	*
57	* @access public
58	* @since 1.5
59	*
60	* @return bool
61	*/
62	public function get_data() {
63
64	if ( $this->step == 1 ) {
65	$this->delete_data( 'give_temp_recount_earnings' );
66	}
67
68	$total = get_option( 'give_temp_recount_earnings', false );
69
70	if ( false === $total ) {
71	$total = (float) 0;
72	$this->store_data( 'give_temp_recount_earnings', $total );
73	}
74
75	$accepted_statuses = apply_filters( 'give_recount_accepted_statuses', array( 'publish' ) );
76
77	$args = apply_filters( 'give_recount_earnings_args', array(
78	'number' => $this->per_step,
79	'page' => $this->step,
80	'status' => $accepted_statuses,
81	) );
82
83	$payments = give_get_payments( $args );
84
85	if ( ! empty( $payments ) ) {
86
87	foreach ( $payments as $payment ) {
88	// Get the payment amount.
89	$payment_amount = give_get_meta( $payment->ID, '_give_payment_total', true );
90
91	/**
92	* Filter the payment amount.
93	*
94	* @since 2.1
95	*/
96	$donation_amount = apply_filters(
97	'give_donation_amount',
98	give_format_amount( $payment_amount, array( 'donation_id' => $payment->ID ) ),
99	$payment->total,
100	$payment->ID,
101	array( 'type' => 'stats', 'currency' => false, 'amount' => false )
102	);
103
104	$total += (float) give_maybe_sanitize_amount( $donation_amount );
105	}
106
107	if ( $total < 0 ) {
108	$totals = 0;
109	}
110
111	$total = round( $total, give_get_price_decimals() );
112
113	$this->store_data( 'give_temp_recount_earnings', $total );
114
115	return true;
116
117	}
118
119	update_option( 'give_earnings_total', $total, false );
120
121	return false;
122
123	}
124
125	/**
126	* Return the calculated completion percentage
127	*
128	* @since 1.5
129	* @return int
130	*/
131	public function get_percentage_complete() {
132
133	$total = $this->get_stored_data( 'give_recount_earnings_total' );
134
135	if ( false === $total ) {
136	$args = apply_filters( 'give_recount_earnings_total_args', array() );
137
138	$counts = give_count_payments( $args );
139	$total = absint( $counts->publish );
140	$total = apply_filters( 'give_recount_store_earnings_total', $total );
141
142	$this->store_data( 'give_recount_earnings_total', $total );
143	}
144
145	$percentage = 100;
146
147	if ( $total > 0 ) {
148	$percentage = ( ( $this->per_step * $this->step ) / $total ) * 100;
149	}
150
151	if ( $percentage > 100 ) {
152	$percentage = 100;
153	}
154
155	return $percentage;
156	}
157
158	/**
159	* Set the properties specific to the payments export
160	*
161	* @since 1.5
162	*
163	* @param array $request The Form Data passed into the batch processing
164	*/
165	public function set_properties( $request ) {
166	}
167
168	/**
169	* Process a step
170	*
171	* @since 1.5
172	* @return bool
173	*/
174	public function process_step() {
175
176	if ( ! $this->can_export() ) {
177	wp_die( esc_html__( 'You do not have permission to recount stats.', 'give' ), esc_html__( 'Error', 'give' ), array( 'response' => 403 ) );
178	}
179
180	$had_data = $this->get_data();
181
182	if ( $had_data ) {
183	$this->done = false;
184
185	return true;
186	} else {
187	$this->delete_data( 'give_recount_earnings_total' );
188	$this->delete_data( 'give_temp_recount_earnings' );
189	$this->done = true;
190	$this->message = esc_html__( 'Income stats have been successfully recounted.', 'give' );
191
192	return false;
193	}
194	}
195
196	/**
197	* Headers.
198	*/
199	public function headers() {
200	give_ignore_user_abort();
201	}
202
203	/**
204	* Perform the export
205	*
206	* @access public
207	* @since 1.5
208	* @return void
209	*/
210	public function export() {
211
212	// Set headers
213	$this->headers();
214
215	give_die();
216	}
217
218	/**
219	* Given a key, get the information from the Database Directly
220	*
221	* @since 1.5
222	*
223	* @param string $key The option_name
224	*
225	* @return mixed Returns the data from the database
226	*/
227	private function get_stored_data( $key ) {
228	global $wpdb;
229	$value = $wpdb->get_var( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = '%s'", $key ) );
230
231	if ( empty( $value ) ) {
232	return false;
233	}
234
235	$maybe_json = json_decode( $value );
236	if ( ! is_null( $maybe_json ) ) {
237	$value = json_decode( $value, true );
238	}
239
240	return $value;
241	}
242
243	/**
244	* Give a key, store the value
245	*
246	* @since 1.5
247	*
248	* @param string $key The option_name
249	* @param mixed $value The value to store
250	*
251	* @return void
252	*/
253	private function store_data( $key, $value ) {
254	global $wpdb;
255
256	$value = is_array( $value ) ? wp_json_encode( $value ) : esc_attr( $value );
257
258	$data = array(
259	'option_name' => $key,
260	'option_value' => $value,
261	'autoload' => 'no',
262	);
263
264	$formats = array(
265	'%s',
266	'%s',
267	'%s',
268	);
269
270	$wpdb->replace( $wpdb->options, $data, $formats );
271	}
272
273	/**
274	* Delete an option
275	*
276	* @since 1.5
277	*
278	* @param string $key The option_name to delete
279	*
280	* @return void
281	*/
282	private function delete_data( $key ) {
283	global $wpdb;
284	$wpdb->delete( $wpdb->options, array( 'option_name' => $key ) );
285	}
286
287	/**
288	* Unset the properties specific to the donors export.
289	*
290	* @since 2.3.0
291	*
292	* @param array $request
293	* @param Give_Batch_Export $export
294	*/
295	public function unset_properties( $request, $export ) {
296	if ( $export->done ) {
297	// Delete all the donation ids.
298	$this->delete_data( 'give_temp_recount_earnings' );
299	$this->delete_data( 'give_recount_earnings_total' );
300	}
301	}
302
303	}
304