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