class-give-tools-delete-donations.php
6 years ago
class-give-tools-delete-import-donors.php
6 years ago
class-give-tools-delete-test-donors.php
6 years ago
class-give-tools-delete-test-transactions.php
6 years ago
class-give-tools-recount-all-stats.php
6 years ago
class-give-tools-recount-donor-stats.php
6 years ago
class-give-tools-recount-form-stats.php
5 years ago
class-give-tools-recount-income.php
5 years ago
class-give-tools-recount-single-donor-stats.php
6 years ago
class-give-tools-reset-stats.php
5 years ago
tools-actions.php
7 years ago
class-give-tools-recount-form-stats.php
342 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Recount donation form income and donations |
| 4 | * |
| 5 | * This class handles batch processing of recounting earnings and stats |
| 6 | * |
| 7 | * @subpackage Admin/Tools/Give_Tools_Recount_Stats |
| 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_Form_Stats Class |
| 20 | * |
| 21 | * @since 1.5 |
| 22 | */ |
| 23 | class Give_Tools_Recount_Form_Stats extends Give_Batch_Export { |
| 24 | |
| 25 | /** |
| 26 | * Our export type. Used for export-type specific filters/actions |
| 27 | * |
| 28 | * @var string |
| 29 | * @since 1.5 |
| 30 | */ |
| 31 | public $export_type = ''; |
| 32 | |
| 33 | /** |
| 34 | * Allows for a non-form batch processing to be run. |
| 35 | * |
| 36 | * @since 1.5 |
| 37 | * @var boolean |
| 38 | */ |
| 39 | public $is_void = true; |
| 40 | |
| 41 | /** |
| 42 | * Sets the number of items to pull on each step |
| 43 | * |
| 44 | * @since 1.5 |
| 45 | * @var integer |
| 46 | */ |
| 47 | public $per_step = 30; |
| 48 | |
| 49 | /** |
| 50 | * Sets the donation form ID to recalculate |
| 51 | * |
| 52 | * @since 1.5 |
| 53 | * @var integer |
| 54 | */ |
| 55 | protected $form_id = 0; |
| 56 | |
| 57 | /** |
| 58 | * Constructor. |
| 59 | */ |
| 60 | public function __construct( $_step = 1 ) { |
| 61 | parent::__construct( $_step ); |
| 62 | |
| 63 | $this->is_writable = true; |
| 64 | } |
| 65 | |
| 66 | /** |
| 67 | * Get the Export Data |
| 68 | * |
| 69 | * @access public |
| 70 | * @since 1.5 |
| 71 | * |
| 72 | * @return bool |
| 73 | */ |
| 74 | public function get_data() { |
| 75 | |
| 76 | $accepted_statuses = apply_filters( 'give_recount_accepted_statuses', [ 'publish' ] ); |
| 77 | |
| 78 | if ( $this->step == 1 ) { |
| 79 | $this->delete_data( 'give_temp_recount_form_stats' ); |
| 80 | } |
| 81 | |
| 82 | $totals = $this->get_stored_data( 'give_temp_recount_form_stats' ); |
| 83 | |
| 84 | if ( false === $totals ) { |
| 85 | $totals = [ |
| 86 | 'earnings' => (float) 0, |
| 87 | 'sales' => 0, |
| 88 | ]; |
| 89 | $this->store_data( 'give_temp_recount_form_stats', $totals ); |
| 90 | } |
| 91 | |
| 92 | $args = apply_filters( |
| 93 | 'give_recount_form_stats_args', |
| 94 | [ |
| 95 | 'give_forms' => $this->form_id, |
| 96 | 'number' => $this->per_step, |
| 97 | 'status' => $accepted_statuses, |
| 98 | 'paged' => $this->step, |
| 99 | 'fields' => 'ids', |
| 100 | ] |
| 101 | ); |
| 102 | |
| 103 | $payments = new Give_Payments_Query( $args ); |
| 104 | $payments = $payments->get_payments(); |
| 105 | |
| 106 | if ( $payments ) { |
| 107 | foreach ( $payments as $payment ) { |
| 108 | |
| 109 | // Ensure acceptable status only. |
| 110 | if ( ! in_array( $payment->post_status, $accepted_statuses ) ) { |
| 111 | continue; |
| 112 | } |
| 113 | |
| 114 | // Ensure only payments for this form are counted. |
| 115 | if ( $payment->form_id != $this->form_id ) { |
| 116 | continue; |
| 117 | } |
| 118 | |
| 119 | $currency_code = give_get_payment_currency_code( $payment->ID ); |
| 120 | |
| 121 | /** |
| 122 | * Filter the payment amount. |
| 123 | * |
| 124 | * @since 2.1 |
| 125 | */ |
| 126 | $earning_amount = apply_filters( |
| 127 | 'give_donation_amount', |
| 128 | give_format_amount( $payment->total, [ 'donation_id' => $payment->ID ] ), |
| 129 | $payment->total, |
| 130 | $payment->ID, |
| 131 | [ |
| 132 | 'type' => 'stats', |
| 133 | 'currency' => false, |
| 134 | 'amount' => false, |
| 135 | ] |
| 136 | ); |
| 137 | |
| 138 | $totals['sales'] ++; |
| 139 | $totals['earnings'] += (float) give_maybe_sanitize_amount( $earning_amount, [ 'currency' => $currency_code ] ); |
| 140 | |
| 141 | } |
| 142 | |
| 143 | $this->store_data( 'give_temp_recount_form_stats', $totals ); |
| 144 | |
| 145 | return true; |
| 146 | } |
| 147 | |
| 148 | give_update_meta( $this->form_id, '_give_form_sales', $totals['sales'] ); |
| 149 | give_update_meta( $this->form_id, '_give_form_earnings', give_sanitize_amount_for_db( $totals['earnings'] ) ); |
| 150 | |
| 151 | return false; |
| 152 | } |
| 153 | |
| 154 | /** |
| 155 | * Return the calculated completion percentage |
| 156 | * |
| 157 | * @since 1.5 |
| 158 | * @return int |
| 159 | */ |
| 160 | public function get_percentage_complete() { |
| 161 | if ( $this->step == 1 ) { |
| 162 | $this->delete_data( 'give_recount_total_' . $this->form_id ); |
| 163 | } |
| 164 | |
| 165 | $accepted_statuses = apply_filters( 'give_recount_accepted_statuses', [ 'publish' ] ); |
| 166 | $total = $this->get_stored_data( 'give_recount_total_' . $this->form_id ); |
| 167 | |
| 168 | if ( false === $total ) { |
| 169 | $total = 0; |
| 170 | $args = apply_filters( |
| 171 | 'give_recount_form_stats_total_args', |
| 172 | [ |
| 173 | 'give_forms' => $this->form_id, |
| 174 | 'number' => - 1, |
| 175 | 'status' => $accepted_statuses, |
| 176 | 'fields' => 'ids', |
| 177 | ] |
| 178 | ); |
| 179 | |
| 180 | $payments = new Give_Payments_Query( $args ); |
| 181 | $total = count( $payments->get_payments() ); |
| 182 | $this->store_data( 'give_recount_total_' . $this->form_id, $total ); |
| 183 | |
| 184 | } |
| 185 | |
| 186 | $percentage = 100; |
| 187 | |
| 188 | if ( $total > 0 ) { |
| 189 | $percentage = ( ( $this->per_step * $this->step ) / $total ) * 100; |
| 190 | } |
| 191 | |
| 192 | if ( $percentage > 100 ) { |
| 193 | $percentage = 100; |
| 194 | } |
| 195 | |
| 196 | return $percentage; |
| 197 | } |
| 198 | |
| 199 | /** |
| 200 | * Set the properties specific to the payments export |
| 201 | * |
| 202 | * @since 1.5 |
| 203 | * |
| 204 | * @param array $request The Form Data passed into the batch processing |
| 205 | */ |
| 206 | public function set_properties( $request ) { |
| 207 | $this->form_id = isset( $request['form_id'] ) ? sanitize_text_field( $request['form_id'] ) : false; |
| 208 | } |
| 209 | |
| 210 | /** |
| 211 | * Process a step |
| 212 | * |
| 213 | * @since 1.5 |
| 214 | * @return bool |
| 215 | */ |
| 216 | public function process_step() { |
| 217 | |
| 218 | if ( ! $this->can_export() ) { |
| 219 | wp_die( esc_html__( 'You do not have permission to recount stats.', 'give' ), esc_html__( 'Error', 'give' ), [ 'response' => 403 ] ); |
| 220 | } |
| 221 | |
| 222 | $had_data = $this->get_data(); |
| 223 | |
| 224 | if ( $had_data ) { |
| 225 | $this->done = false; |
| 226 | |
| 227 | return true; |
| 228 | } else { |
| 229 | $this->delete_data( 'give_recount_total_' . $this->form_id ); |
| 230 | $this->delete_data( 'give_temp_recount_form_stats' ); |
| 231 | $this->done = true; |
| 232 | $this->message = sprintf( esc_html__( 'Donation counts and revenue amount statistics successfully recounted for "%s".', 'give' ), get_the_title( $this->form_id ) ); |
| 233 | |
| 234 | return false; |
| 235 | } |
| 236 | } |
| 237 | |
| 238 | public function headers() { |
| 239 | give_ignore_user_abort(); |
| 240 | } |
| 241 | |
| 242 | /** |
| 243 | * Perform the export |
| 244 | * |
| 245 | * @access public |
| 246 | * @since 1.5 |
| 247 | * @return void |
| 248 | */ |
| 249 | public function export() { |
| 250 | |
| 251 | // Set headers |
| 252 | $this->headers(); |
| 253 | |
| 254 | give_die(); |
| 255 | } |
| 256 | |
| 257 | /** |
| 258 | * Given a key, get the information from the Database Directly |
| 259 | * |
| 260 | * @since 1.5 |
| 261 | * |
| 262 | * @param string $key The option_name |
| 263 | * |
| 264 | * @return mixed Returns the data from the database |
| 265 | */ |
| 266 | private function get_stored_data( $key ) { |
| 267 | global $wpdb; |
| 268 | $value = $wpdb->get_var( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = '%s'", $key ) ); |
| 269 | |
| 270 | if ( empty( $value ) ) { |
| 271 | return false; |
| 272 | } |
| 273 | |
| 274 | $maybe_json = json_decode( $value ); |
| 275 | if ( ! is_null( $maybe_json ) ) { |
| 276 | $value = json_decode( $value, true ); |
| 277 | } |
| 278 | |
| 279 | return $value; |
| 280 | } |
| 281 | |
| 282 | /** |
| 283 | * Give a key, store the value |
| 284 | * |
| 285 | * @since 1.5 |
| 286 | * |
| 287 | * @param string $key The option_name |
| 288 | * @param mixed $value The value to store |
| 289 | * |
| 290 | * @return void |
| 291 | */ |
| 292 | private function store_data( $key, $value ) { |
| 293 | global $wpdb; |
| 294 | |
| 295 | $value = is_array( $value ) ? wp_json_encode( $value ) : esc_attr( $value ); |
| 296 | |
| 297 | $data = [ |
| 298 | 'option_name' => $key, |
| 299 | 'option_value' => $value, |
| 300 | 'autoload' => 'no', |
| 301 | ]; |
| 302 | |
| 303 | $formats = [ |
| 304 | '%s', |
| 305 | '%s', |
| 306 | '%s', |
| 307 | ]; |
| 308 | |
| 309 | $wpdb->replace( $wpdb->options, $data, $formats ); |
| 310 | } |
| 311 | |
| 312 | /** |
| 313 | * Delete an option |
| 314 | * |
| 315 | * @since 1.5 |
| 316 | * |
| 317 | * @param string $key The option_name to delete |
| 318 | * |
| 319 | * @return void |
| 320 | */ |
| 321 | private function delete_data( $key ) { |
| 322 | global $wpdb; |
| 323 | $wpdb->delete( $wpdb->options, [ 'option_name' => $key ] ); |
| 324 | } |
| 325 | |
| 326 | /** |
| 327 | * Unset the properties specific to the donors export. |
| 328 | * |
| 329 | * @since 2.3.0 |
| 330 | * |
| 331 | * @param array $request |
| 332 | * @param Give_Batch_Export $export |
| 333 | */ |
| 334 | public function unset_properties( $request, $export ) { |
| 335 | if ( $export->done ) { |
| 336 | // Delete all the donation ids. |
| 337 | $this->delete_data( 'give_temp_recount_form_stats' ); |
| 338 | $this->delete_data( 'give_recount_total_' . $this->form_id ); |
| 339 | } |
| 340 | } |
| 341 | } |
| 342 |