AyeCode /
invoicing
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like WPInv_Invoice often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use WPInv_Invoice, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 14 | final class WPInv_Invoice { |
||
| 15 | public $ID = 0; |
||
| 16 | public $title; |
||
| 17 | public $post_type; |
||
| 18 | |||
| 19 | public $pending; |
||
| 20 | public $items = array(); |
||
| 21 | public $user_info = array(); |
||
| 22 | public $payment_meta = array(); |
||
| 23 | |||
| 24 | public $new = false; |
||
| 25 | public $number = ''; |
||
| 26 | public $mode = 'live'; |
||
| 27 | public $key = ''; |
||
| 28 | public $total = 0.00; |
||
| 29 | public $subtotal = 0; |
||
| 30 | public $tax = 0; |
||
| 31 | public $fees = array(); |
||
| 32 | public $fees_total = 0; |
||
| 33 | public $discounts = ''; |
||
| 34 | public $discount = 0; |
||
| 35 | public $discount_code = 0; |
||
| 36 | public $date = ''; |
||
| 37 | public $due_date = ''; |
||
| 38 | public $completed_date = ''; |
||
| 39 | public $status = 'pending'; |
||
| 40 | public $post_status = 'pending'; |
||
| 41 | public $old_status = ''; |
||
| 42 | public $status_nicename = ''; |
||
| 43 | public $user_id = 0; |
||
| 44 | public $first_name = ''; |
||
| 45 | public $last_name = ''; |
||
| 46 | public $email = ''; |
||
| 47 | public $phone = ''; |
||
| 48 | public $address = ''; |
||
| 49 | public $city = ''; |
||
| 50 | public $country = ''; |
||
| 51 | public $state = ''; |
||
| 52 | public $zip = ''; |
||
| 53 | public $transaction_id = ''; |
||
| 54 | public $ip = ''; |
||
| 55 | public $gateway = ''; |
||
| 56 | public $gateway_title = ''; |
||
| 57 | public $currency = ''; |
||
| 58 | public $cart_details = array(); |
||
| 59 | |||
| 60 | public $company = ''; |
||
| 61 | public $vat_number = ''; |
||
| 62 | public $vat_rate = ''; |
||
| 63 | public $adddress_confirmed = ''; |
||
| 64 | |||
| 65 | public $full_name = ''; |
||
| 66 | public $parent_invoice = 0; |
||
| 67 | |||
| 68 | public function __construct( $invoice_id = false ) { |
||
| 69 | if( empty( $invoice_id ) ) { |
||
| 70 | return false; |
||
|
Bug
introduced
by
|
|||
| 71 | } |
||
| 72 | |||
| 73 | $this->setup_invoice( $invoice_id ); |
||
| 74 | } |
||
| 75 | |||
| 76 | public function get( $key ) { |
||
| 77 | if ( method_exists( $this, 'get_' . $key ) ) { |
||
| 78 | $value = call_user_func( array( $this, 'get_' . $key ) ); |
||
| 79 | } else { |
||
| 80 | $value = $this->$key; |
||
| 81 | } |
||
| 82 | |||
| 83 | return $value; |
||
| 84 | } |
||
| 85 | |||
| 86 | public function set( $key, $value ) { |
||
| 87 | $ignore = array( 'items', 'cart_details', 'fees', '_ID' ); |
||
| 88 | |||
| 89 | if ( $key === 'status' ) { |
||
| 90 | $this->old_status = $this->status; |
||
| 91 | } |
||
| 92 | |||
| 93 | if ( ! in_array( $key, $ignore ) ) { |
||
| 94 | $this->pending[ $key ] = $value; |
||
| 95 | } |
||
| 96 | |||
| 97 | if( '_ID' !== $key ) { |
||
| 98 | $this->$key = $value; |
||
| 99 | } |
||
| 100 | } |
||
| 101 | |||
| 102 | public function _isset( $name ) { |
||
| 103 | if ( property_exists( $this, $name) ) { |
||
| 104 | return false === empty( $this->$name ); |
||
| 105 | } else { |
||
| 106 | return null; |
||
| 107 | } |
||
| 108 | } |
||
| 109 | |||
| 110 | private function setup_invoice( $invoice_id ) { |
||
| 111 | $this->pending = array(); |
||
| 112 | |||
| 113 | if ( empty( $invoice_id ) ) { |
||
| 114 | return false; |
||
| 115 | } |
||
| 116 | |||
| 117 | $invoice = get_post( $invoice_id ); |
||
| 118 | |||
| 119 | if( !$invoice || is_wp_error( $invoice ) ) { |
||
| 120 | return false; |
||
| 121 | } |
||
| 122 | |||
| 123 | if( !('wpi_invoice' == $invoice->post_type OR 'wpi_quote' == $invoice->post_type) ) { |
||
| 124 | return false; |
||
| 125 | } |
||
| 126 | |||
| 127 | do_action( 'wpinv_pre_setup_invoice', $this, $invoice_id ); |
||
| 128 | |||
| 129 | // Primary Identifier |
||
| 130 | $this->ID = absint( $invoice_id ); |
||
| 131 | $this->post_type = $invoice->post_type; |
||
| 132 | |||
| 133 | // We have a payment, get the generic payment_meta item to reduce calls to it |
||
| 134 | $this->payment_meta = $this->get_meta(); |
||
| 135 | $this->date = $invoice->post_date; |
||
| 136 | $this->due_date = $this->setup_due_date(); |
||
| 137 | $this->completed_date = $this->setup_completed_date(); |
||
| 138 | $this->status = $invoice->post_status; |
||
| 139 | $this->post_status = $this->status; |
||
| 140 | $this->mode = $this->setup_mode(); |
||
| 141 | $this->parent_invoice = $invoice->post_parent; |
||
| 142 | $this->post_name = $this->setup_post_name( $invoice ); |
||
| 143 | $this->status_nicename = $this->setup_status_nicename($invoice->post_status); |
||
| 144 | |||
| 145 | // Items |
||
| 146 | $this->fees = $this->setup_fees(); |
||
| 147 | $this->cart_details = $this->setup_cart_details(); |
||
| 148 | $this->items = $this->setup_items(); |
||
| 149 | |||
| 150 | // Currency Based |
||
| 151 | $this->total = $this->setup_total(); |
||
| 152 | $this->tax = $this->setup_tax(); |
||
| 153 | $this->fees_total = $this->get_fees_total(); |
||
| 154 | $this->subtotal = $this->setup_subtotal(); |
||
| 155 | $this->currency = $this->setup_currency(); |
||
| 156 | |||
| 157 | // Gateway based |
||
| 158 | $this->gateway = $this->setup_gateway(); |
||
| 159 | $this->gateway_title = $this->setup_gateway_title(); |
||
| 160 | $this->transaction_id = $this->setup_transaction_id(); |
||
| 161 | |||
| 162 | // User based |
||
| 163 | $this->ip = $this->setup_ip(); |
||
| 164 | $this->user_id = !empty( $invoice->post_author ) ? $invoice->post_author : get_current_user_id();///$this->setup_user_id(); |
||
| 165 | $this->email = get_the_author_meta( 'email', $this->user_id ); |
||
| 166 | |||
| 167 | $this->user_info = $this->setup_user_info(); |
||
| 168 | |||
| 169 | $this->first_name = $this->user_info['first_name']; |
||
| 170 | $this->last_name = $this->user_info['last_name']; |
||
| 171 | $this->company = $this->user_info['company']; |
||
| 172 | $this->vat_number = $this->user_info['vat_number']; |
||
| 173 | $this->vat_rate = $this->user_info['vat_rate']; |
||
| 174 | $this->adddress_confirmed = $this->user_info['adddress_confirmed']; |
||
| 175 | $this->address = $this->user_info['address']; |
||
| 176 | $this->city = $this->user_info['city']; |
||
| 177 | $this->country = $this->user_info['country']; |
||
| 178 | $this->state = $this->user_info['state']; |
||
| 179 | $this->zip = $this->user_info['zip']; |
||
| 180 | $this->phone = $this->user_info['phone']; |
||
| 181 | |||
| 182 | $this->discounts = $this->user_info['discount']; |
||
| 183 | $this->discount = $this->setup_discount(); |
||
| 184 | $this->discount_code = $this->setup_discount_code(); |
||
| 185 | |||
| 186 | // Other Identifiers |
||
| 187 | $this->key = $this->setup_invoice_key(); |
||
| 188 | $this->number = $this->setup_invoice_number(); |
||
| 189 | $this->title = !empty( $invoice->post_title ) ? $invoice->post_title : $this->number; |
||
| 190 | |||
| 191 | $this->full_name = trim( $this->first_name . ' '. $this->last_name ); |
||
| 192 | |||
| 193 | // Allow extensions to add items to this object via hook |
||
| 194 | do_action( 'wpinv_setup_invoice', $this, $invoice_id ); |
||
| 195 | |||
| 196 | return true; |
||
| 197 | } |
||
| 198 | |||
| 199 | private function setup_status_nicename($status) { |
||
| 200 | $all_invoice_statuses = wpinv_get_invoice_statuses(); |
||
| 201 | $status = isset( $all_invoice_statuses[$status] ) ? $all_invoice_statuses[$status] : __( $status, 'invoicing' ); |
||
| 202 | |||
| 203 | return apply_filters( 'setup_status_nicename', $status ); |
||
| 204 | } |
||
| 205 | |||
| 206 | private function setup_post_name( $post = NULL ) { |
||
| 207 | $post_name = ''; |
||
| 208 | |||
| 209 | if ( !empty( $post ) ) { |
||
| 210 | if( !empty( $post->post_name ) ) { |
||
| 211 | $post_name = $post->post_name; |
||
| 212 | } else if ( !empty( $post->ID ) && !empty( $post->post_title ) ) { |
||
| 213 | $post_name = sanitize_title( $post->post_title ); |
||
| 214 | |||
| 215 | global $wpdb; |
||
| 216 | $wpdb->update( $wpdb->posts, array( 'post_name' => $post_name ), array( 'ID' => $post->ID ) ); |
||
| 217 | } |
||
| 218 | } |
||
| 219 | |||
| 220 | $this->post_name = $post_name; |
||
| 221 | } |
||
| 222 | |||
| 223 | private function setup_due_date() { |
||
| 224 | $due_date = $this->get_meta( '_wpinv_due_date' ); |
||
| 225 | |||
| 226 | if ( empty( $due_date ) ) { |
||
| 227 | $overdue_time = strtotime( $this->date ) + ( DAY_IN_SECONDS * absint( wpinv_get_option( 'overdue_days' ) ) ); |
||
| 228 | $due_date = date_i18n( 'Y-m-d', $overdue_time ); |
||
| 229 | } else if ( $due_date == 'none' ) { |
||
| 230 | $due_date = ''; |
||
| 231 | } |
||
| 232 | |||
| 233 | return $due_date; |
||
| 234 | } |
||
| 235 | |||
| 236 | private function setup_completed_date() { |
||
| 237 | $invoice = get_post( $this->ID ); |
||
| 238 | |||
| 239 | if ( 'pending' == $invoice->post_status || 'preapproved' == $invoice->post_status ) { |
||
| 240 | return false; // This invoice was never paid |
||
| 241 | } |
||
| 242 | |||
| 243 | $date = ( $date = $this->get_meta( '_wpinv_completed_date', true ) ) ? $date : $invoice->modified_date; |
||
| 244 | |||
| 245 | return $date; |
||
| 246 | } |
||
| 247 | |||
| 248 | private function setup_cart_details() { |
||
| 249 | $cart_details = isset( $this->payment_meta['cart_details'] ) ? maybe_unserialize( $this->payment_meta['cart_details'] ) : array(); |
||
| 250 | return $cart_details; |
||
| 251 | } |
||
| 252 | |||
| 253 | public function array_convert() { |
||
| 254 | return get_object_vars( $this ); |
||
| 255 | } |
||
| 256 | |||
| 257 | private function setup_items() { |
||
| 258 | $items = isset( $this->payment_meta['items'] ) ? maybe_unserialize( $this->payment_meta['items'] ) : array(); |
||
| 259 | return $items; |
||
| 260 | } |
||
| 261 | |||
| 262 | private function setup_fees() { |
||
| 263 | $payment_fees = isset( $this->payment_meta['fees'] ) ? $this->payment_meta['fees'] : array(); |
||
| 264 | return $payment_fees; |
||
| 265 | } |
||
| 266 | |||
| 267 | private function setup_currency() { |
||
| 268 | $currency = isset( $this->payment_meta['currency'] ) ? $this->payment_meta['currency'] : apply_filters( 'wpinv_currency_default', wpinv_get_currency(), $this ); |
||
| 269 | return $currency; |
||
| 270 | } |
||
| 271 | |||
| 272 | private function setup_discount() { |
||
| 273 | //$discount = $this->get_meta( '_wpinv_discount', true ); |
||
| 274 | $discount = (float)$this->subtotal - ( (float)$this->total - (float)$this->tax - (float)$this->fees_total ); |
||
| 275 | if ( $discount < 0 ) { |
||
| 276 | $discount = 0; |
||
| 277 | } |
||
| 278 | $discount = wpinv_round_amount( $discount ); |
||
| 279 | |||
| 280 | return $discount; |
||
| 281 | } |
||
| 282 | |||
| 283 | private function setup_discount_code() { |
||
| 284 | $discount_code = !empty( $this->discounts ) ? $this->discounts : $this->get_meta( '_wpinv_discount_code', true ); |
||
| 285 | return $discount_code; |
||
| 286 | } |
||
| 287 | |||
| 288 | private function setup_tax() { |
||
| 289 | $tax = $this->get_meta( '_wpinv_tax', true ); |
||
| 290 | |||
| 291 | // We don't have tax as it's own meta and no meta was passed |
||
| 292 | if ( '' === $tax ) { |
||
| 293 | $tax = isset( $this->payment_meta['tax'] ) ? $this->payment_meta['tax'] : 0; |
||
| 294 | } |
||
| 295 | |||
| 296 | return $tax; |
||
| 297 | } |
||
| 298 | |||
| 299 | private function setup_subtotal() { |
||
| 300 | $subtotal = 0; |
||
| 301 | $cart_details = $this->cart_details; |
||
| 302 | |||
| 303 | if ( is_array( $cart_details ) ) { |
||
| 304 | foreach ( $cart_details as $item ) { |
||
| 305 | if ( isset( $item['subtotal'] ) ) { |
||
| 306 | $subtotal += $item['subtotal']; |
||
| 307 | } |
||
| 308 | } |
||
| 309 | } else { |
||
| 310 | $subtotal = $this->total; |
||
| 311 | $tax = wpinv_use_taxes() ? $this->tax : 0; |
||
| 312 | $subtotal -= $tax; |
||
| 313 | } |
||
| 314 | |||
| 315 | return $subtotal; |
||
| 316 | } |
||
| 317 | |||
| 318 | private function setup_discounts() { |
||
| 319 | $discounts = ! empty( $this->payment_meta['user_info']['discount'] ) ? $this->payment_meta['user_info']['discount'] : array(); |
||
| 320 | return $discounts; |
||
| 321 | } |
||
| 322 | |||
| 323 | private function setup_total() { |
||
| 324 | $amount = $this->get_meta( '_wpinv_total', true ); |
||
| 325 | |||
| 326 | if ( empty( $amount ) && '0.00' != $amount ) { |
||
| 327 | $meta = $this->get_meta( '_wpinv_payment_meta', true ); |
||
| 328 | $meta = maybe_unserialize( $meta ); |
||
| 329 | |||
| 330 | if ( isset( $meta['amount'] ) ) { |
||
| 331 | $amount = $meta['amount']; |
||
| 332 | } |
||
| 333 | } |
||
| 334 | |||
| 335 | return $amount; |
||
| 336 | } |
||
| 337 | |||
| 338 | private function setup_mode() { |
||
| 339 | return $this->get_meta( '_wpinv_mode' ); |
||
| 340 | } |
||
| 341 | |||
| 342 | private function setup_gateway() { |
||
| 343 | $gateway = $this->get_meta( '_wpinv_gateway' ); |
||
| 344 | |||
| 345 | if ( empty( $gateway ) && 'publish' === $this->status ) { |
||
| 346 | $gateway = 'manual'; |
||
| 347 | } |
||
| 348 | |||
| 349 | return $gateway; |
||
| 350 | } |
||
| 351 | |||
| 352 | private function setup_gateway_title() { |
||
| 353 | $gateway_title = wpinv_get_gateway_checkout_label( $this->gateway ); |
||
| 354 | return $gateway_title; |
||
| 355 | } |
||
| 356 | |||
| 357 | private function setup_transaction_id() { |
||
| 358 | $transaction_id = $this->get_meta( '_wpinv_transaction_id' ); |
||
| 359 | |||
| 360 | if ( empty( $transaction_id ) || (int) $transaction_id === (int) $this->ID ) { |
||
| 361 | $gateway = $this->gateway; |
||
| 362 | $transaction_id = apply_filters( 'wpinv_get_invoice_transaction_id-' . $gateway, $this->ID ); |
||
| 363 | } |
||
| 364 | |||
| 365 | return $transaction_id; |
||
| 366 | } |
||
| 367 | |||
| 368 | private function setup_ip() { |
||
| 369 | $ip = $this->get_meta( '_wpinv_user_ip' ); |
||
| 370 | return $ip; |
||
| 371 | } |
||
| 372 | |||
| 373 | ///private function setup_user_id() { |
||
| 374 | ///$user_id = $this->get_meta( '_wpinv_user_id' ); |
||
| 375 | ///return $user_id; |
||
| 376 | ///} |
||
| 377 | |||
| 378 | private function setup_first_name() { |
||
| 379 | $first_name = $this->get_meta( '_wpinv_first_name' ); |
||
| 380 | return $first_name; |
||
| 381 | } |
||
| 382 | |||
| 383 | private function setup_last_name() { |
||
| 384 | $last_name = $this->get_meta( '_wpinv_last_name' ); |
||
| 385 | return $last_name; |
||
| 386 | } |
||
| 387 | |||
| 388 | private function setup_company() { |
||
| 389 | $company = $this->get_meta( '_wpinv_company' ); |
||
| 390 | return $company; |
||
| 391 | } |
||
| 392 | |||
| 393 | private function setup_vat_number() { |
||
| 394 | $vat_number = $this->get_meta( '_wpinv_vat_number' ); |
||
| 395 | return $vat_number; |
||
| 396 | } |
||
| 397 | |||
| 398 | private function setup_vat_rate() { |
||
| 399 | $vat_rate = $this->get_meta( '_wpinv_vat_rate' ); |
||
| 400 | return $vat_rate; |
||
| 401 | } |
||
| 402 | |||
| 403 | private function setup_adddress_confirmed() { |
||
| 404 | $adddress_confirmed = $this->get_meta( '_wpinv_adddress_confirmed' ); |
||
| 405 | return $adddress_confirmed; |
||
| 406 | } |
||
| 407 | |||
| 408 | private function setup_phone() { |
||
| 409 | $phone = $this->get_meta( '_wpinv_phone' ); |
||
| 410 | return $phone; |
||
| 411 | } |
||
| 412 | |||
| 413 | private function setup_address() { |
||
| 414 | $address = $this->get_meta( '_wpinv_address', true ); |
||
| 415 | return $address; |
||
| 416 | } |
||
| 417 | |||
| 418 | private function setup_city() { |
||
| 419 | $city = $this->get_meta( '_wpinv_city', true ); |
||
| 420 | return $city; |
||
| 421 | } |
||
| 422 | |||
| 423 | private function setup_country() { |
||
| 424 | $country = $this->get_meta( '_wpinv_country', true ); |
||
| 425 | return $country; |
||
| 426 | } |
||
| 427 | |||
| 428 | private function setup_state() { |
||
| 429 | $state = $this->get_meta( '_wpinv_state', true ); |
||
| 430 | return $state; |
||
| 431 | } |
||
| 432 | |||
| 433 | private function setup_zip() { |
||
| 434 | $zip = $this->get_meta( '_wpinv_zip', true ); |
||
| 435 | return $zip; |
||
| 436 | } |
||
| 437 | |||
| 438 | private function setup_user_info() { |
||
| 439 | $defaults = array( |
||
| 440 | 'user_id' => $this->user_id, |
||
| 441 | 'first_name' => $this->first_name, |
||
| 442 | 'last_name' => $this->last_name, |
||
| 443 | 'email' => get_the_author_meta( 'email', $this->user_id ), |
||
| 444 | 'phone' => $this->phone, |
||
| 445 | 'address' => $this->address, |
||
| 446 | 'city' => $this->city, |
||
| 447 | 'country' => $this->country, |
||
| 448 | 'state' => $this->state, |
||
| 449 | 'zip' => $this->zip, |
||
| 450 | 'company' => $this->company, |
||
| 451 | 'vat_number' => $this->vat_number, |
||
| 452 | 'vat_rate' => $this->vat_rate, |
||
| 453 | 'adddress_confirmed' => $this->adddress_confirmed, |
||
| 454 | 'discount' => $this->discounts, |
||
| 455 | ); |
||
| 456 | |||
| 457 | $user_info = array(); |
||
| 458 | if ( isset( $this->payment_meta['user_info'] ) ) { |
||
| 459 | $user_info = maybe_unserialize( $this->payment_meta['user_info'] ); |
||
| 460 | |||
| 461 | if ( !empty( $user_info ) && isset( $user_info['user_id'] ) && $post = get_post( $this->ID ) ) { |
||
| 462 | $this->user_id = $post->post_author; |
||
| 463 | $this->email = get_the_author_meta( 'email', $this->user_id ); |
||
| 464 | |||
| 465 | $user_info['user_id'] = $this->user_id; |
||
| 466 | $user_info['email'] = $this->email; |
||
| 467 | $this->payment_meta['user_id'] = $this->user_id; |
||
| 468 | $this->payment_meta['email'] = $this->email; |
||
| 469 | } |
||
| 470 | } |
||
| 471 | |||
| 472 | $user_info = wp_parse_args( $user_info, $defaults ); |
||
| 473 | |||
| 474 | // Get the user, but only if it's been created |
||
| 475 | $user = get_userdata( $this->user_id ); |
||
| 476 | |||
| 477 | if ( !empty( $user ) && $user->ID > 0 ) { |
||
| 478 | if ( empty( $user_info ) ) { |
||
| 479 | $user_info = array( |
||
| 480 | 'user_id' => $user->ID, |
||
| 481 | 'first_name' => $user->first_name, |
||
| 482 | 'last_name' => $user->last_name, |
||
| 483 | 'email' => $user->user_email, |
||
| 484 | 'discount' => '', |
||
| 485 | ); |
||
| 486 | } else { |
||
| 487 | foreach ( $user_info as $key => $value ) { |
||
| 488 | if ( ! empty( $value ) ) { |
||
| 489 | continue; |
||
| 490 | } |
||
| 491 | |||
| 492 | switch( $key ) { |
||
| 493 | case 'user_id': |
||
| 494 | $user_info[ $key ] = $user->ID; |
||
| 495 | break; |
||
| 496 | case 'first_name': |
||
| 497 | $user_info[ $key ] = $user->first_name; |
||
| 498 | break; |
||
| 499 | case 'last_name': |
||
| 500 | $user_info[ $key ] = $user->last_name; |
||
| 501 | break; |
||
| 502 | case 'email': |
||
| 503 | $user_info[ $key ] = $user->user_email; |
||
| 504 | break; |
||
| 505 | } |
||
| 506 | } |
||
| 507 | } |
||
| 508 | } |
||
| 509 | |||
| 510 | return $user_info; |
||
| 511 | } |
||
| 512 | |||
| 513 | private function setup_invoice_key() { |
||
| 514 | $key = $this->get_meta( '_wpinv_key', true ); |
||
| 515 | |||
| 516 | return $key; |
||
| 517 | } |
||
| 518 | |||
| 519 | private function setup_invoice_number() { |
||
| 520 | $number = $this->get_meta( '_wpinv_number', true ); |
||
| 521 | |||
| 522 | if ( !$number ) { |
||
| 523 | $number = wpinv_format_invoice_number( $this->ID ); |
||
| 524 | } |
||
| 525 | |||
| 526 | return $number; |
||
| 527 | } |
||
| 528 | |||
| 529 | private function insert_invoice() { |
||
| 530 | $invoice_title = ''; |
||
| 531 | |||
| 532 | if ($number = $this->get_number()) { |
||
| 533 | $invoice_title = $number; |
||
| 534 | } else if ( ! empty( $this->ID ) ) { |
||
| 535 | $invoice_title = wpinv_format_invoice_number( $this->ID ); |
||
| 536 | } else { |
||
| 537 | $invoice_title = wpinv_format_invoice_number( 0 ); |
||
| 538 | } |
||
| 539 | |||
| 540 | View Code Duplication | if ( empty( $this->key ) ) { |
|
| 541 | $this->key = self::generate_key(); |
||
| 542 | $this->pending['key'] = $this->key; |
||
| 543 | } |
||
| 544 | |||
| 545 | if ( empty( $this->ip ) ) { |
||
| 546 | $this->ip = wpinv_get_ip(); |
||
| 547 | $this->pending['ip'] = $this->ip; |
||
| 548 | } |
||
| 549 | |||
| 550 | $payment_data = array( |
||
| 551 | 'price' => $this->total, |
||
| 552 | 'date' => $this->date, |
||
| 553 | 'user_email' => $this->email, |
||
| 554 | 'invoice_key' => $this->key, |
||
| 555 | 'currency' => $this->currency, |
||
| 556 | 'items' => $this->items, |
||
| 557 | 'user_info' => array( |
||
| 558 | 'user_id' => $this->user_id, |
||
| 559 | 'email' => $this->email, |
||
| 560 | 'first_name' => $this->first_name, |
||
| 561 | 'last_name' => $this->last_name, |
||
| 562 | 'address' => $this->address, |
||
| 563 | 'phone' => $this->phone, |
||
| 564 | 'city' => $this->city, |
||
| 565 | 'country' => $this->country, |
||
| 566 | 'state' => $this->state, |
||
| 567 | 'zip' => $this->zip, |
||
| 568 | 'company' => $this->company, |
||
| 569 | 'vat_number' => $this->vat_number, |
||
| 570 | 'discount' => $this->discounts, |
||
| 571 | ), |
||
| 572 | 'cart_details' => $this->cart_details, |
||
| 573 | 'status' => $this->status, |
||
| 574 | 'fees' => $this->fees, |
||
| 575 | ); |
||
| 576 | |||
| 577 | $post_name = sanitize_title( $invoice_title ); |
||
| 578 | |||
| 579 | $post_data = array( |
||
| 580 | 'post_title' => $invoice_title, |
||
| 581 | 'post_status' => $this->status, |
||
| 582 | 'post_author' => $this->user_id, |
||
| 583 | 'post_type' => $this->post_type, |
||
| 584 | 'post_date' => ! empty( $this->date ) && $this->date != '0000-00-00 00:00:00' ? $this->date : current_time( 'mysql' ), |
||
| 585 | 'post_date_gmt' => ! empty( $this->date ) && $this->date != '0000-00-00 00:00:00' ? get_gmt_from_date( $this->date ) : current_time( 'mysql', 1 ), |
||
| 586 | 'post_parent' => $this->parent_invoice, |
||
| 587 | ); |
||
| 588 | $args = apply_filters( 'wpinv_insert_invoice_args', $post_data, $this ); |
||
| 589 | |||
| 590 | // Create a blank invoice |
||
| 591 | if ( !empty( $this->ID ) ) { |
||
| 592 | $args['ID'] = $this->ID; |
||
| 593 | $args['post_name'] = $post_name; |
||
| 594 | |||
| 595 | $invoice_id = wp_update_post( $args ); |
||
| 596 | } else { |
||
| 597 | $invoice_id = wp_insert_post( $args ); |
||
| 598 | |||
| 599 | $post_title = wpinv_format_invoice_number( $invoice_id ); |
||
| 600 | global $wpdb; |
||
| 601 | $wpdb->update( $wpdb->posts, array( 'post_title' => $post_title, 'post_name' => sanitize_title( $post_title ) ), array( 'ID' => $invoice_id ) ); |
||
| 602 | clean_post_cache( $invoice_id ); |
||
| 603 | } |
||
| 604 | |||
| 605 | if ( !empty( $invoice_id ) ) { |
||
| 606 | $this->ID = $invoice_id; |
||
| 607 | $this->_ID = $invoice_id; |
||
| 608 | |||
| 609 | ///$this->pending['user_id'] = $this->user_id; |
||
| 610 | if ( isset( $this->pending['number'] ) ) { |
||
| 611 | $this->pending['number'] = $post_name; |
||
| 612 | } |
||
| 613 | |||
| 614 | $this->payment_meta = apply_filters( 'wpinv_payment_meta', $this->payment_meta, $payment_data ); |
||
| 615 | if ( ! empty( $this->payment_meta['fees'] ) ) { |
||
| 616 | $this->fees = array_merge( $this->fees, $this->payment_meta['fees'] ); |
||
| 617 | foreach( $this->fees as $fee ) { |
||
| 618 | $this->increase_fees( $fee['amount'] ); |
||
| 619 | } |
||
| 620 | } |
||
| 621 | |||
| 622 | $this->update_meta( '_wpinv_payment_meta', $this->payment_meta ); |
||
| 623 | $this->new = true; |
||
| 624 | } |
||
| 625 | |||
| 626 | return $this->ID; |
||
| 627 | } |
||
| 628 | |||
| 629 | public function save( $setup = false ) { |
||
| 630 | global $wpi_session; |
||
| 631 | |||
| 632 | $saved = false; |
||
| 633 | if ( empty( $this->items ) ) { |
||
| 634 | return $saved; // Don't save empty invoice. |
||
| 635 | } |
||
| 636 | |||
| 637 | View Code Duplication | if ( empty( $this->key ) ) { |
|
| 638 | $this->key = self::generate_key(); |
||
| 639 | $this->pending['key'] = $this->key; |
||
| 640 | } |
||
| 641 | |||
| 642 | if ( empty( $this->ID ) ) { |
||
| 643 | $invoice_id = $this->insert_invoice(); |
||
| 644 | |||
| 645 | if ( false === $invoice_id ) { |
||
| 646 | $saved = false; |
||
| 647 | } else { |
||
| 648 | $this->ID = $invoice_id; |
||
| 649 | } |
||
| 650 | } |
||
| 651 | |||
| 652 | // If we have something pending, let's save it |
||
| 653 | if ( !empty( $this->pending ) ) { |
||
| 654 | $total_increase = 0; |
||
| 655 | $total_decrease = 0; |
||
| 656 | |||
| 657 | foreach ( $this->pending as $key => $value ) { |
||
| 658 | switch( $key ) { |
||
| 659 | case 'items': |
||
| 660 | // Update totals for pending items |
||
| 661 | foreach ( $this->pending[ $key ] as $item ) { |
||
| 662 | switch( $item['action'] ) { |
||
| 663 | case 'add': |
||
| 664 | $price = $item['price']; |
||
| 665 | $taxes = $item['tax']; |
||
| 666 | |||
| 667 | if ( 'publish' === $this->status ) { |
||
| 668 | $total_increase += $price; |
||
| 669 | } |
||
| 670 | break; |
||
| 671 | |||
| 672 | case 'remove': |
||
| 673 | if ( 'publish' === $this->status ) { |
||
| 674 | $total_decrease += $item['price']; |
||
| 675 | } |
||
| 676 | break; |
||
| 677 | } |
||
| 678 | } |
||
| 679 | break; |
||
| 680 | case 'fees': |
||
| 681 | if ( 'publish' !== $this->status ) { |
||
| 682 | break; |
||
| 683 | } |
||
| 684 | |||
| 685 | if ( empty( $this->pending[ $key ] ) ) { |
||
| 686 | break; |
||
| 687 | } |
||
| 688 | |||
| 689 | foreach ( $this->pending[ $key ] as $fee ) { |
||
| 690 | switch( $fee['action'] ) { |
||
| 691 | case 'add': |
||
| 692 | $total_increase += $fee['amount']; |
||
| 693 | break; |
||
| 694 | |||
| 695 | case 'remove': |
||
| 696 | $total_decrease += $fee['amount']; |
||
| 697 | break; |
||
| 698 | } |
||
| 699 | } |
||
| 700 | break; |
||
| 701 | case 'status': |
||
| 702 | $this->update_status( $this->status ); |
||
| 703 | break; |
||
| 704 | case 'gateway': |
||
| 705 | $this->update_meta( '_wpinv_gateway', $this->gateway ); |
||
| 706 | break; |
||
| 707 | case 'mode': |
||
| 708 | $this->update_meta( '_wpinv_mode', $this->mode ); |
||
| 709 | break; |
||
| 710 | case 'transaction_id': |
||
| 711 | $this->update_meta( '_wpinv_transaction_id', $this->transaction_id ); |
||
| 712 | break; |
||
| 713 | case 'ip': |
||
| 714 | $this->update_meta( '_wpinv_user_ip', $this->ip ); |
||
| 715 | break; |
||
| 716 | ///case 'user_id': |
||
| 717 | ///$this->update_meta( '_wpinv_user_id', $this->user_id ); |
||
| 718 | ///$this->user_info['user_id'] = $this->user_id; |
||
| 719 | ///break; |
||
| 720 | case 'first_name': |
||
| 721 | $this->update_meta( '_wpinv_first_name', $this->first_name ); |
||
| 722 | $this->user_info['first_name'] = $this->first_name; |
||
| 723 | break; |
||
| 724 | case 'last_name': |
||
| 725 | $this->update_meta( '_wpinv_last_name', $this->last_name ); |
||
| 726 | $this->user_info['last_name'] = $this->last_name; |
||
| 727 | break; |
||
| 728 | case 'phone': |
||
| 729 | $this->update_meta( '_wpinv_phone', $this->phone ); |
||
| 730 | $this->user_info['phone'] = $this->phone; |
||
| 731 | break; |
||
| 732 | case 'address': |
||
| 733 | $this->update_meta( '_wpinv_address', $this->address ); |
||
| 734 | $this->user_info['address'] = $this->address; |
||
| 735 | break; |
||
| 736 | case 'city': |
||
| 737 | $this->update_meta( '_wpinv_city', $this->city ); |
||
| 738 | $this->user_info['city'] = $this->city; |
||
| 739 | break; |
||
| 740 | case 'country': |
||
| 741 | $this->update_meta( '_wpinv_country', $this->country ); |
||
| 742 | $this->user_info['country'] = $this->country; |
||
| 743 | break; |
||
| 744 | case 'state': |
||
| 745 | $this->update_meta( '_wpinv_state', $this->state ); |
||
| 746 | $this->user_info['state'] = $this->state; |
||
| 747 | break; |
||
| 748 | case 'zip': |
||
| 749 | $this->update_meta( '_wpinv_zip', $this->zip ); |
||
| 750 | $this->user_info['zip'] = $this->zip; |
||
| 751 | break; |
||
| 752 | case 'company': |
||
| 753 | $this->update_meta( '_wpinv_company', $this->company ); |
||
| 754 | $this->user_info['company'] = $this->company; |
||
| 755 | break; |
||
| 756 | case 'vat_number': |
||
| 757 | $this->update_meta( '_wpinv_vat_number', $this->vat_number ); |
||
| 758 | $this->user_info['vat_number'] = $this->vat_number; |
||
| 759 | |||
| 760 | $vat_info = $wpi_session->get( 'user_vat_data' ); |
||
| 761 | if ( $this->vat_number && !empty( $vat_info ) && isset( $vat_info['number'] ) && isset( $vat_info['valid'] ) && $vat_info['number'] == $this->vat_number ) { |
||
| 762 | $adddress_confirmed = isset( $vat_info['adddress_confirmed'] ) ? $vat_info['adddress_confirmed'] : false; |
||
| 763 | $this->update_meta( '_wpinv_adddress_confirmed', (bool)$adddress_confirmed ); |
||
| 764 | $this->user_info['adddress_confirmed'] = (bool)$adddress_confirmed; |
||
| 765 | } |
||
| 766 | |||
| 767 | break; |
||
| 768 | case 'vat_rate': |
||
| 769 | $this->update_meta( '_wpinv_vat_rate', $this->vat_rate ); |
||
| 770 | $this->user_info['vat_rate'] = $this->vat_rate; |
||
| 771 | break; |
||
| 772 | case 'adddress_confirmed': |
||
| 773 | $this->update_meta( '_wpinv_adddress_confirmed', $this->adddress_confirmed ); |
||
| 774 | $this->user_info['adddress_confirmed'] = $this->adddress_confirmed; |
||
| 775 | break; |
||
| 776 | |||
| 777 | case 'key': |
||
| 778 | $this->update_meta( '_wpinv_key', $this->key ); |
||
| 779 | break; |
||
| 780 | case 'number': |
||
| 781 | $this->update_meta( '_wpinv_number', $this->number ); |
||
| 782 | break; |
||
| 783 | case 'date': |
||
| 784 | $args = array( |
||
| 785 | 'ID' => $this->ID, |
||
| 786 | 'post_date' => $this->date, |
||
| 787 | 'edit_date' => true, |
||
| 788 | ); |
||
| 789 | |||
| 790 | wp_update_post( $args ); |
||
| 791 | break; |
||
| 792 | case 'due_date': |
||
| 793 | if ( empty( $this->due_date ) ) { |
||
| 794 | $this->due_date = 'none'; |
||
| 795 | } |
||
| 796 | |||
| 797 | $this->update_meta( '_wpinv_due_date', $this->due_date ); |
||
| 798 | break; |
||
| 799 | case 'completed_date': |
||
| 800 | $this->update_meta( '_wpinv_completed_date', $this->completed_date ); |
||
| 801 | break; |
||
| 802 | case 'discounts': |
||
| 803 | if ( ! is_array( $this->discounts ) ) { |
||
| 804 | $this->discounts = explode( ',', $this->discounts ); |
||
| 805 | } |
||
| 806 | |||
| 807 | $this->user_info['discount'] = implode( ',', $this->discounts ); |
||
| 808 | break; |
||
| 809 | |||
| 810 | //case 'tax': |
||
| 811 | //$this->update_meta( '_wpinv_tax', wpinv_round_amount( $this->tax ) ); |
||
| 812 | //break; |
||
| 813 | case 'discount': |
||
| 814 | $this->update_meta( '_wpinv_discount', wpinv_round_amount( $this->discount ) ); |
||
| 815 | break; |
||
| 816 | case 'discount_code': |
||
| 817 | $this->update_meta( '_wpinv_discount_code', $this->discount_code ); |
||
| 818 | break; |
||
| 819 | //case 'fees': |
||
| 820 | //$this->update_meta( '_wpinv_fees', $this->fees ); |
||
| 821 | //break; |
||
| 822 | case 'parent_invoice': |
||
| 823 | $args = array( |
||
| 824 | 'ID' => $this->ID, |
||
| 825 | 'post_parent' => $this->parent_invoice, |
||
| 826 | ); |
||
| 827 | wp_update_post( $args ); |
||
| 828 | break; |
||
| 829 | default: |
||
| 830 | do_action( 'wpinv_save', $this, $key ); |
||
| 831 | break; |
||
| 832 | } |
||
| 833 | } |
||
| 834 | |||
| 835 | $this->update_meta( '_wpinv_subtotal', wpinv_round_amount( $this->subtotal ) ); |
||
| 836 | $this->update_meta( '_wpinv_total', wpinv_round_amount( $this->total ) ); |
||
| 837 | $this->update_meta( '_wpinv_tax', wpinv_round_amount( $this->tax ) ); |
||
| 838 | |||
| 839 | $this->items = array_values( $this->items ); |
||
| 840 | |||
| 841 | $new_meta = array( |
||
| 842 | 'items' => $this->items, |
||
| 843 | 'cart_details' => $this->cart_details, |
||
| 844 | 'fees' => $this->fees, |
||
| 845 | 'currency' => $this->currency, |
||
| 846 | 'user_info' => $this->user_info, |
||
| 847 | ); |
||
| 848 | |||
| 849 | $meta = $this->get_meta(); |
||
| 850 | $merged_meta = array_merge( $meta, $new_meta ); |
||
| 851 | |||
| 852 | // Only save the payment meta if it's changed |
||
| 853 | if ( md5( serialize( $meta ) ) !== md5( serialize( $merged_meta) ) ) { |
||
| 854 | $updated = $this->update_meta( '_wpinv_payment_meta', $merged_meta ); |
||
| 855 | if ( false !== $updated ) { |
||
| 856 | $saved = true; |
||
| 857 | } |
||
| 858 | } |
||
| 859 | |||
| 860 | $this->pending = array(); |
||
| 861 | $saved = true; |
||
| 862 | } else { |
||
| 863 | $this->update_meta( '_wpinv_subtotal', wpinv_round_amount( $this->subtotal ) ); |
||
| 864 | $this->update_meta( '_wpinv_total', wpinv_round_amount( $this->total ) ); |
||
| 865 | $this->update_meta( '_wpinv_tax', wpinv_round_amount( $this->tax ) ); |
||
| 866 | } |
||
| 867 | |||
| 868 | do_action( 'wpinv_invoice_save', $this, $saved ); |
||
| 869 | |||
| 870 | if ( true === $saved || $setup ) { |
||
| 871 | $this->setup_invoice( $this->ID ); |
||
| 872 | } |
||
| 873 | |||
| 874 | $this->refresh_item_ids(); |
||
| 875 | |||
| 876 | return $saved; |
||
| 877 | } |
||
| 878 | |||
| 879 | public function add_fee( $args, $global = true ) { |
||
| 880 | $default_args = array( |
||
| 881 | 'label' => '', |
||
| 882 | 'amount' => 0, |
||
| 883 | 'type' => 'fee', |
||
| 884 | 'id' => '', |
||
| 885 | 'no_tax' => false, |
||
| 886 | 'item_id' => 0, |
||
| 887 | ); |
||
| 888 | |||
| 889 | $fee = wp_parse_args( $args, $default_args ); |
||
| 890 | |||
| 891 | if ( !empty( $fee['label'] ) ) { |
||
| 892 | return false; |
||
| 893 | } |
||
| 894 | |||
| 895 | $fee['id'] = sanitize_title( $fee['label'] ); |
||
| 896 | |||
| 897 | $this->fees[] = $fee; |
||
| 898 | |||
| 899 | $added_fee = $fee; |
||
| 900 | $added_fee['action'] = 'add'; |
||
| 901 | $this->pending['fees'][] = $added_fee; |
||
| 902 | reset( $this->fees ); |
||
| 903 | |||
| 904 | $this->increase_fees( $fee['amount'] ); |
||
| 905 | return true; |
||
| 906 | } |
||
| 907 | |||
| 908 | public function remove_fee( $key ) { |
||
| 909 | $removed = false; |
||
| 910 | |||
| 911 | if ( is_numeric( $key ) ) { |
||
| 912 | $removed = $this->remove_fee_by( 'index', $key ); |
||
| 913 | } |
||
| 914 | |||
| 915 | return $removed; |
||
| 916 | } |
||
| 917 | |||
| 918 | public function remove_fee_by( $key, $value, $global = false ) { |
||
| 919 | $allowed_fee_keys = apply_filters( 'wpinv_fee_keys', array( |
||
| 920 | 'index', 'label', 'amount', 'type', |
||
| 921 | ) ); |
||
| 922 | |||
| 923 | if ( ! in_array( $key, $allowed_fee_keys ) ) { |
||
| 924 | return false; |
||
| 925 | } |
||
| 926 | |||
| 927 | $removed = false; |
||
| 928 | if ( 'index' === $key && array_key_exists( $value, $this->fees ) ) { |
||
| 929 | $removed_fee = $this->fees[ $value ]; |
||
| 930 | $removed_fee['action'] = 'remove'; |
||
| 931 | $this->pending['fees'][] = $removed_fee; |
||
| 932 | |||
| 933 | $this->decrease_fees( $removed_fee['amount'] ); |
||
| 934 | |||
| 935 | unset( $this->fees[ $value ] ); |
||
| 936 | $removed = true; |
||
| 937 | } else if ( 'index' !== $key ) { |
||
| 938 | foreach ( $this->fees as $index => $fee ) { |
||
| 939 | if ( isset( $fee[ $key ] ) && $fee[ $key ] == $value ) { |
||
| 940 | $removed_fee = $fee; |
||
| 941 | $removed_fee['action'] = 'remove'; |
||
| 942 | $this->pending['fees'][] = $removed_fee; |
||
| 943 | |||
| 944 | $this->decrease_fees( $removed_fee['amount'] ); |
||
| 945 | |||
| 946 | unset( $this->fees[ $index ] ); |
||
| 947 | $removed = true; |
||
| 948 | |||
| 949 | if ( false === $global ) { |
||
| 950 | break; |
||
| 951 | } |
||
| 952 | } |
||
| 953 | } |
||
| 954 | } |
||
| 955 | |||
| 956 | if ( true === $removed ) { |
||
| 957 | $this->fees = array_values( $this->fees ); |
||
| 958 | } |
||
| 959 | |||
| 960 | return $removed; |
||
| 961 | } |
||
| 962 | |||
| 963 | |||
| 964 | |||
| 965 | public function add_note( $note = '', $customer_type = false, $added_by_user = false, $system = false ) { |
||
| 966 | // Bail if no note specified |
||
| 967 | if( !$note ) { |
||
| 968 | return false; |
||
| 969 | } |
||
| 970 | |||
| 971 | if ( empty( $this->ID ) ) |
||
| 972 | return false; |
||
| 973 | |||
| 974 | if ( ( ( is_user_logged_in() && current_user_can( 'manage_options' ) ) || $added_by_user ) && !$system ) { |
||
| 975 | $user = get_user_by( 'id', get_current_user_id() ); |
||
| 976 | $comment_author = $user->display_name; |
||
| 977 | $comment_author_email = $user->user_email; |
||
| 978 | } else { |
||
| 979 | $comment_author = __( 'System', 'invoicing' ); |
||
| 980 | $comment_author_email = strtolower( __( 'System', 'invoicing' ) ) . '@'; |
||
| 981 | $comment_author_email .= isset( $_SERVER['HTTP_HOST'] ) ? str_replace( 'www.', '', $_SERVER['HTTP_HOST'] ) : 'noreply.com'; |
||
| 982 | $comment_author_email = sanitize_email( $comment_author_email ); |
||
| 983 | } |
||
| 984 | |||
| 985 | do_action( 'wpinv_pre_insert_invoice_note', $this->ID, $note, $customer_type ); |
||
| 986 | |||
| 987 | $note_id = wp_insert_comment( wp_filter_comment( array( |
||
| 988 | 'comment_post_ID' => $this->ID, |
||
| 989 | 'comment_content' => $note, |
||
| 990 | 'comment_agent' => 'GeoDirectory', |
||
| 991 | 'user_id' => is_admin() ? get_current_user_id() : 0, |
||
| 992 | 'comment_date' => current_time( 'mysql' ), |
||
| 993 | 'comment_date_gmt' => current_time( 'mysql', 1 ), |
||
| 994 | 'comment_approved' => 1, |
||
| 995 | 'comment_parent' => 0, |
||
| 996 | 'comment_author' => $comment_author, |
||
| 997 | 'comment_author_IP' => wpinv_get_ip(), |
||
| 998 | 'comment_author_url' => '', |
||
| 999 | 'comment_author_email' => $comment_author_email, |
||
| 1000 | 'comment_type' => 'wpinv_note' |
||
| 1001 | ) ) ); |
||
| 1002 | |||
| 1003 | do_action( 'wpinv_insert_payment_note', $note_id, $this->ID, $note ); |
||
| 1004 | |||
| 1005 | if ( $customer_type ) { |
||
| 1006 | add_comment_meta( $note_id, '_wpi_customer_note', 1 ); |
||
| 1007 | |||
| 1008 | do_action( 'wpinv_new_customer_note', array( 'invoice_id' => $this->ID, 'user_note' => $note ) ); |
||
| 1009 | } |
||
| 1010 | |||
| 1011 | return $note_id; |
||
| 1012 | } |
||
| 1013 | |||
| 1014 | private function increase_subtotal( $amount = 0.00 ) { |
||
| 1015 | $amount = (float) $amount; |
||
| 1016 | $this->subtotal += $amount; |
||
| 1017 | $this->subtotal = wpinv_round_amount( $this->subtotal ); |
||
| 1018 | |||
| 1019 | $this->recalculate_total(); |
||
| 1020 | } |
||
| 1021 | |||
| 1022 | View Code Duplication | private function decrease_subtotal( $amount = 0.00 ) { |
|
| 1023 | $amount = (float) $amount; |
||
| 1024 | $this->subtotal -= $amount; |
||
| 1025 | $this->subtotal = wpinv_round_amount( $this->subtotal ); |
||
| 1026 | |||
| 1027 | if ( $this->subtotal < 0 ) { |
||
| 1028 | $this->subtotal = 0; |
||
| 1029 | } |
||
| 1030 | |||
| 1031 | $this->recalculate_total(); |
||
| 1032 | } |
||
| 1033 | |||
| 1034 | private function increase_fees( $amount = 0.00 ) { |
||
| 1035 | $amount = (float)$amount; |
||
| 1036 | $this->fees_total += $amount; |
||
| 1037 | $this->fees_total = wpinv_round_amount( $this->fees_total ); |
||
| 1038 | |||
| 1039 | $this->recalculate_total(); |
||
| 1040 | } |
||
| 1041 | |||
| 1042 | View Code Duplication | private function decrease_fees( $amount = 0.00 ) { |
|
| 1043 | $amount = (float) $amount; |
||
| 1044 | $this->fees_total -= $amount; |
||
| 1045 | $this->fees_total = wpinv_round_amount( $this->fees_total ); |
||
| 1046 | |||
| 1047 | if ( $this->fees_total < 0 ) { |
||
| 1048 | $this->fees_total = 0; |
||
| 1049 | } |
||
| 1050 | |||
| 1051 | $this->recalculate_total(); |
||
| 1052 | } |
||
| 1053 | |||
| 1054 | public function recalculate_total() { |
||
| 1055 | global $wpi_nosave; |
||
| 1056 | |||
| 1057 | $this->total = $this->subtotal + $this->tax + $this->fees_total; |
||
| 1058 | $this->total = wpinv_round_amount( $this->total ); |
||
| 1059 | |||
| 1060 | do_action( 'wpinv_invoice_recalculate_total', $this, $wpi_nosave ); |
||
| 1061 | } |
||
| 1062 | |||
| 1063 | public function increase_tax( $amount = 0.00 ) { |
||
| 1064 | $amount = (float) $amount; |
||
| 1065 | $this->tax += $amount; |
||
| 1066 | |||
| 1067 | $this->recalculate_total(); |
||
| 1068 | } |
||
| 1069 | |||
| 1070 | public function decrease_tax( $amount = 0.00 ) { |
||
| 1071 | $amount = (float) $amount; |
||
| 1072 | $this->tax -= $amount; |
||
| 1073 | |||
| 1074 | if ( $this->tax < 0 ) { |
||
| 1075 | $this->tax = 0; |
||
| 1076 | } |
||
| 1077 | |||
| 1078 | $this->recalculate_total(); |
||
| 1079 | } |
||
| 1080 | |||
| 1081 | public function update_status( $new_status = false, $note = '', $manual = false ) { |
||
| 1082 | $old_status = ! empty( $this->old_status ) ? $this->old_status : get_post_status( $this->ID ); |
||
| 1083 | |||
| 1084 | if ( $old_status === $new_status && in_array( $new_status, array_keys( wpinv_get_invoice_statuses() ) ) ) { |
||
| 1085 | return false; // Don't permit status changes that aren't changes |
||
| 1086 | } |
||
| 1087 | |||
| 1088 | $do_change = apply_filters( 'wpinv_should_update_invoice_status', true, $this->ID, $new_status, $old_status ); |
||
| 1089 | $updated = false; |
||
| 1090 | |||
| 1091 | if ( $do_change ) { |
||
| 1092 | do_action( 'wpinv_before_invoice_status_change', $this->ID, $new_status, $old_status ); |
||
| 1093 | |||
| 1094 | $update_post_data = array(); |
||
| 1095 | $update_post_data['ID'] = $this->ID; |
||
| 1096 | $update_post_data['post_status'] = $new_status; |
||
| 1097 | $update_post_data['edit_date'] = current_time( 'mysql', 0 ); |
||
| 1098 | $update_post_data['edit_date_gmt'] = current_time( 'mysql', 1 ); |
||
| 1099 | |||
| 1100 | $update_post_data = apply_filters( 'wpinv_update_invoice_status_fields', $update_post_data, $this->ID ); |
||
| 1101 | |||
| 1102 | $updated = wp_update_post( $update_post_data ); |
||
| 1103 | |||
| 1104 | // Process any specific status functions |
||
| 1105 | switch( $new_status ) { |
||
| 1106 | case 'wpi-refunded': |
||
| 1107 | $this->process_refund(); |
||
| 1108 | break; |
||
| 1109 | case 'wpi-failed': |
||
| 1110 | $this->process_failure(); |
||
| 1111 | break; |
||
| 1112 | case 'pending': |
||
| 1113 | $this->process_pending(); |
||
| 1114 | break; |
||
| 1115 | } |
||
| 1116 | |||
| 1117 | // Status was changed. |
||
| 1118 | do_action( 'wpinv_status_' . $new_status, $this->ID, $old_status ); |
||
| 1119 | do_action( 'wpinv_status_' . $old_status . '_to_' . $new_status, $this->ID, $old_status ); |
||
| 1120 | do_action( 'wpinv_update_status', $this->ID, $new_status, $old_status ); |
||
| 1121 | } |
||
| 1122 | |||
| 1123 | return $updated; |
||
| 1124 | } |
||
| 1125 | |||
| 1126 | public function refund() { |
||
| 1127 | $this->old_status = $this->status; |
||
| 1128 | $this->status = 'wpi-refunded'; |
||
| 1129 | $this->pending['status'] = $this->status; |
||
| 1130 | |||
| 1131 | $this->save(); |
||
| 1132 | } |
||
| 1133 | |||
| 1134 | public function update_meta( $meta_key = '', $meta_value = '', $prev_value = '' ) { |
||
| 1135 | if ( empty( $meta_key ) ) { |
||
| 1136 | return false; |
||
| 1137 | } |
||
| 1138 | |||
| 1139 | if ( $meta_key == 'key' || $meta_key == 'date' ) { |
||
| 1140 | $current_meta = $this->get_meta(); |
||
| 1141 | $current_meta[ $meta_key ] = $meta_value; |
||
| 1142 | |||
| 1143 | $meta_key = '_wpinv_payment_meta'; |
||
| 1144 | $meta_value = $current_meta; |
||
| 1145 | } |
||
| 1146 | |||
| 1147 | $meta_value = apply_filters( 'wpinv_update_payment_meta_' . $meta_key, $meta_value, $this->ID ); |
||
| 1148 | |||
| 1149 | if ( $meta_key == '_wpinv_completed_date' && !empty( $meta_value ) ) { |
||
| 1150 | $args = array( |
||
| 1151 | 'ID' => $this->ID, |
||
| 1152 | 'post_date' => $meta_value, |
||
| 1153 | 'edit_date' => true, |
||
| 1154 | 'post_date_gmt' => get_gmt_from_date( $meta_value ), |
||
| 1155 | 'post_modified' => $meta_value, |
||
| 1156 | 'post_modified_gmt' => get_gmt_from_date( $meta_value ) |
||
| 1157 | ); |
||
| 1158 | wp_update_post( $args ); |
||
| 1159 | } |
||
| 1160 | |||
| 1161 | return update_post_meta( $this->ID, $meta_key, $meta_value, $prev_value ); |
||
| 1162 | } |
||
| 1163 | |||
| 1164 | private function process_refund() { |
||
| 1165 | $process_refund = true; |
||
| 1166 | |||
| 1167 | // If the payment was not in publish, don't decrement stats as they were never incremented |
||
| 1168 | if ( 'publish' != $this->old_status || 'wpi-refunded' != $this->status ) { |
||
| 1169 | $process_refund = false; |
||
| 1170 | } |
||
| 1171 | |||
| 1172 | // Allow extensions to filter for their own payment types, Example: Recurring Payments |
||
| 1173 | $process_refund = apply_filters( 'wpinv_should_process_refund', $process_refund, $this ); |
||
| 1174 | |||
| 1175 | if ( false === $process_refund ) { |
||
| 1176 | return; |
||
| 1177 | } |
||
| 1178 | |||
| 1179 | do_action( 'wpinv_pre_refund_invoice', $this ); |
||
| 1180 | |||
| 1181 | $decrease_store_earnings = apply_filters( 'wpinv_decrease_store_earnings_on_refund', true, $this ); |
||
| 1182 | $decrease_customer_value = apply_filters( 'wpinv_decrease_customer_value_on_refund', true, $this ); |
||
| 1183 | $decrease_purchase_count = apply_filters( 'wpinv_decrease_customer_purchase_count_on_refund', true, $this ); |
||
| 1184 | |||
| 1185 | do_action( 'wpinv_post_refund_invoice', $this ); |
||
| 1186 | } |
||
| 1187 | |||
| 1188 | private function process_failure() { |
||
| 1189 | $discounts = $this->discounts; |
||
| 1190 | if ( empty( $discounts ) ) { |
||
| 1191 | return; |
||
| 1192 | } |
||
| 1193 | |||
| 1194 | if ( ! is_array( $discounts ) ) { |
||
| 1195 | $discounts = array_map( 'trim', explode( ',', $discounts ) ); |
||
| 1196 | } |
||
| 1197 | |||
| 1198 | foreach ( $discounts as $discount ) { |
||
| 1199 | wpinv_decrease_discount_usage( $discount ); |
||
| 1200 | } |
||
| 1201 | } |
||
| 1202 | |||
| 1203 | private function process_pending() { |
||
| 1204 | $process_pending = true; |
||
| 1205 | |||
| 1206 | // If the payment was not in publish or revoked status, don't decrement stats as they were never incremented |
||
| 1207 | if ( ( 'publish' != $this->old_status && 'revoked' != $this->old_status ) || 'pending' != $this->status ) { |
||
| 1208 | $process_pending = false; |
||
| 1209 | } |
||
| 1210 | |||
| 1211 | // Allow extensions to filter for their own payment types, Example: Recurring Payments |
||
| 1212 | $process_pending = apply_filters( 'wpinv_should_process_pending', $process_pending, $this ); |
||
| 1213 | |||
| 1214 | if ( false === $process_pending ) { |
||
| 1215 | return; |
||
| 1216 | } |
||
| 1217 | |||
| 1218 | $decrease_store_earnings = apply_filters( 'wpinv_decrease_store_earnings_on_pending', true, $this ); |
||
| 1219 | $decrease_customer_value = apply_filters( 'wpinv_decrease_customer_value_on_pending', true, $this ); |
||
| 1220 | $decrease_purchase_count = apply_filters( 'wpinv_decrease_customer_purchase_count_on_pending', true, $this ); |
||
| 1221 | |||
| 1222 | $this->completed_date = ''; |
||
| 1223 | $this->update_meta( '_wpinv_completed_date', '' ); |
||
| 1224 | } |
||
| 1225 | |||
| 1226 | // get data |
||
| 1227 | public function get_meta( $meta_key = '_wpinv_payment_meta', $single = true ) { |
||
| 1228 | $meta = get_post_meta( $this->ID, $meta_key, $single ); |
||
| 1229 | |||
| 1230 | if ( $meta_key === '_wpinv_payment_meta' ) { |
||
| 1231 | |||
| 1232 | if(!is_array($meta)){$meta = array();} // we need this to be an array so make sure it is. |
||
| 1233 | |||
| 1234 | if ( empty( $meta['key'] ) ) { |
||
| 1235 | $meta['key'] = $this->setup_invoice_key(); |
||
| 1236 | } |
||
| 1237 | |||
| 1238 | if ( empty( $meta['date'] ) ) { |
||
| 1239 | $meta['date'] = get_post_field( 'post_date', $this->ID ); |
||
| 1240 | } |
||
| 1241 | } |
||
| 1242 | |||
| 1243 | $meta = apply_filters( 'wpinv_get_invoice_meta_' . $meta_key, $meta, $this->ID ); |
||
| 1244 | |||
| 1245 | return apply_filters( 'wpinv_get_invoice_meta', $meta, $this->ID, $meta_key ); |
||
| 1246 | } |
||
| 1247 | |||
| 1248 | public function get_description() { |
||
| 1254 | |||
| 1255 | public function get_status( $nicename = false ) { |
||
| 1264 | |||
| 1265 | public function get_cart_details() { |
||
| 1268 | |||
| 1269 | View Code Duplication | public function get_subtotal( $currency = false ) { |
|
| 1278 | |||
| 1279 | View Code Duplication | public function get_total( $currency = false ) { |
|
| 1280 | if ( $this->is_free_trial() ) { |
||
| 1281 | $total = wpinv_round_amount( 0 ); |
||
| 1282 | } else { |
||
| 1283 | $total = wpinv_round_amount( $this->total ); |
||
| 1284 | } |
||
| 1285 | if ( $currency ) { |
||
| 1286 | $total = wpinv_price( wpinv_format_amount( $total, NULL, !$currency ), $this->get_currency() ); |
||
| 1287 | } |
||
| 1288 | |||
| 1289 | return apply_filters( 'wpinv_get_invoice_total', $total, $this->ID, $this, $currency ); |
||
| 1290 | } |
||
| 1291 | |||
| 1292 | public function get_recurring_details( $field = '', $currency = false ) { |
||
| 1367 | |||
| 1368 | public function get_final_tax( $currency = false ) { |
||
| 1369 | $final_total = wpinv_round_amount( $this->tax ); |
||
| 1370 | if ( $currency ) { |
||
| 1371 | $final_total = wpinv_price( wpinv_format_amount( $final_total, NULL, !$currency ), $this->get_currency() ); |
||
| 1372 | } |
||
| 1373 | |||
| 1374 | return apply_filters( 'wpinv_get_invoice_final_total', $final_total, $this, $currency ); |
||
| 1375 | } |
||
| 1376 | |||
| 1377 | public function get_discounts( $array = false ) { |
||
| 1384 | |||
| 1385 | public function get_discount( $currency = false, $dash = false ) { |
||
| 1386 | if ( !empty( $this->discounts ) ) { |
||
| 1387 | global $ajax_cart_details; |
||
| 1388 | $ajax_cart_details = $this->get_cart_details(); |
||
| 1389 | |||
| 1390 | if ( !empty( $ajax_cart_details ) && count( $ajax_cart_details ) == count( $this->items ) ) { |
||
| 1391 | $cart_items = $ajax_cart_details; |
||
| 1392 | } else { |
||
| 1393 | $cart_items = $this->items; |
||
| 1394 | } |
||
| 1395 | |||
| 1396 | $this->discount = wpinv_get_cart_items_discount_amount( $cart_items , $this->discounts ); |
||
| 1397 | } |
||
| 1398 | $discount = wpinv_round_amount( $this->discount ); |
||
| 1399 | $dash = $dash && $discount > 0 ? '–' : ''; |
||
| 1400 | |||
| 1401 | if ( $currency ) { |
||
| 1402 | $discount = wpinv_price( wpinv_format_amount( $discount, NULL, !$currency ), $this->get_currency() ); |
||
| 1403 | } |
||
| 1404 | |||
| 1405 | $discount = $dash . $discount; |
||
| 1406 | |||
| 1407 | return apply_filters( 'wpinv_get_invoice_discount', $discount, $this->ID, $this, $currency, $dash ); |
||
| 1408 | } |
||
| 1409 | |||
| 1410 | public function get_discount_code() { |
||
| 1411 | return $this->discount_code; |
||
| 1412 | } |
||
| 1413 | |||
| 1414 | View Code Duplication | public function get_tax( $currency = false ) { |
|
| 1415 | $tax = wpinv_round_amount( $this->tax ); |
||
| 1416 | |||
| 1417 | if ( $currency ) { |
||
| 1418 | $tax = wpinv_price( wpinv_format_amount( $tax, NULL, !$currency ), $this->get_currency() ); |
||
| 1419 | } |
||
| 1420 | |||
| 1421 | return apply_filters( 'wpinv_get_invoice_tax', $tax, $this->ID, $this, $currency ); |
||
| 1422 | } |
||
| 1423 | |||
| 1424 | public function get_fees( $type = 'all' ) { |
||
| 1425 | $fees = array(); |
||
| 1426 | |||
| 1427 | if ( ! empty( $this->fees ) && is_array( $this->fees ) ) { |
||
| 1428 | foreach ( $this->fees as $fee ) { |
||
| 1429 | View Code Duplication | if( 'all' != $type && ! empty( $fee['type'] ) && $type != $fee['type'] ) { |
|
| 1430 | continue; |
||
| 1431 | } |
||
| 1432 | |||
| 1433 | $fee['label'] = stripslashes( $fee['label'] ); |
||
| 1434 | $fee['amount_display'] = wpinv_price( $fee['amount'], $this->get_currency() ); |
||
| 1435 | $fees[] = $fee; |
||
| 1436 | } |
||
| 1437 | } |
||
| 1438 | |||
| 1439 | return apply_filters( 'wpinv_get_invoice_fees', $fees, $this->ID, $this ); |
||
| 1440 | } |
||
| 1441 | |||
| 1442 | public function get_fees_total( $type = 'all' ) { |
||
| 1443 | $fees_total = (float) 0.00; |
||
| 1444 | |||
| 1445 | $payment_fees = isset( $this->payment_meta['fees'] ) ? $this->payment_meta['fees'] : array(); |
||
| 1446 | if ( ! empty( $payment_fees ) ) { |
||
| 1447 | foreach ( $payment_fees as $fee ) { |
||
| 1448 | $fees_total += (float) $fee['amount']; |
||
| 1449 | } |
||
| 1450 | } |
||
| 1470 | |||
| 1471 | public function get_user_id() { |
||
| 1474 | |||
| 1475 | public function get_first_name() { |
||
| 1478 | |||
| 1479 | public function get_last_name() { |
||
| 1482 | |||
| 1483 | public function get_user_full_name() { |
||
| 1486 | |||
| 1487 | public function get_user_info() { |
||
| 1490 | |||
| 1491 | public function get_email() { |
||
| 1494 | |||
| 1495 | public function get_address() { |
||
| 1498 | |||
| 1499 | public function get_phone() { |
||
| 1502 | |||
| 1503 | public function get_number() { |
||
| 1506 | |||
| 1507 | public function get_items() { |
||
| 1510 | |||
| 1511 | public function get_key() { |
||
| 1514 | |||
| 1515 | public function get_transaction_id() { |
||
| 1518 | |||
| 1519 | public function get_gateway() { |
||
| 1522 | |||
| 1523 | public function get_gateway_title() { |
||
| 1528 | |||
| 1529 | public function get_currency() { |
||
| 1532 | |||
| 1533 | public function get_created_date() { |
||
| 1536 | |||
| 1537 | public function get_due_date( $display = false ) { |
||
| 1546 | |||
| 1547 | public function get_completed_date() { |
||
| 1550 | |||
| 1551 | public function get_invoice_date( $formatted = true ) { |
||
| 1566 | |||
| 1567 | public function get_ip() { |
||
| 1570 | |||
| 1571 | public function has_status( $status ) { |
||
| 1574 | |||
| 1575 | public function add_item( $item_id = 0, $args = array() ) { |
||
| 1743 | |||
| 1744 | public function remove_item( $item_id, $args = array() ) { |
||
| 1897 | |||
| 1898 | public function update_items($temp = false) { |
||
| 1968 | |||
| 1969 | public function recalculate_totals($temp = false) { |
||
| 1975 | |||
| 1976 | public function needs_payment() { |
||
| 1987 | |||
| 1988 | public function get_checkout_payment_url( $on_checkout = false, $secret = false ) { |
||
| 2009 | |||
| 2010 | public function get_view_url( $secret = false ) { |
||
| 2019 | |||
| 2020 | public function generate_key( $string = '' ) { |
||
| 2024 | |||
| 2025 | public function is_recurring() { |
||
| 2044 | |||
| 2045 | public function is_free_trial() { |
||
| 2056 | |||
| 2057 | public function get_recurring( $object = false ) { |
||
| 2079 | |||
| 2080 | public function get_subscription_name() { |
||
| 2093 | |||
| 2094 | public function get_expiration() { |
||
| 2098 | |||
| 2099 | public function get_cancelled_date( $formatted = true ) { |
||
| 2108 | |||
| 2109 | public function get_trial_end_date( $formatted = true ) { |
||
| 2129 | |||
| 2130 | public function get_subscription_created( $default = true ) { |
||
| 2138 | |||
| 2139 | public function get_subscription_start( $formatted = true ) { |
||
| 2153 | |||
| 2154 | public function get_subscription_end( $formatted = true ) { |
||
| 2183 | |||
| 2184 | public function get_expiration_time() { |
||
| 2187 | |||
| 2188 | public function get_original_invoice_id() { |
||
| 2191 | |||
| 2192 | public function get_bill_times() { |
||
| 2196 | |||
| 2197 | public function get_child_payments( $self = false ) { |
||
| 2224 | |||
| 2225 | public function get_total_payments( $self = true ) { |
||
| 2228 | |||
| 2229 | public function get_subscriptions( $limit = -1 ) { |
||
| 2234 | |||
| 2235 | public function get_subscription_id() { |
||
| 2246 | |||
| 2247 | public function get_subscription_status() { |
||
| 2281 | |||
| 2282 | public function get_subscription_status_label( $status = '' ) { |
||
| 2325 | |||
| 2326 | View Code Duplication | public function get_subscription_period( $full = false ) { |
|
| 2363 | |||
| 2364 | public function get_subscription_interval() { |
||
| 2373 | |||
| 2374 | View Code Duplication | public function get_subscription_trial_period( $full = false ) { |
|
| 2415 | |||
| 2416 | public function get_subscription_trial_interval() { |
||
| 2429 | |||
| 2430 | View Code Duplication | public function failing_subscription() { |
|
| 2442 | |||
| 2443 | View Code Duplication | public function stop_subscription() { |
|
| 2455 | |||
| 2456 | View Code Duplication | public function restart_subscription() { |
|
| 2468 | |||
| 2469 | public function cancel_subscription() { |
||
| 2496 | |||
| 2497 | public function can_cancel() { |
||
| 2500 | |||
| 2501 | public function add_subscription( $data = array() ) { |
||
| 2541 | |||
| 2542 | public function update_subscription( $args = array() ) { |
||
| 2569 | |||
| 2570 | public function renew_subscription() { |
||
| 2614 | |||
| 2615 | public function complete_subscription() { |
||
| 2624 | |||
| 2625 | public function expire_subscription() { |
||
| 2634 | |||
| 2635 | public function get_cancel_url() { |
||
| 2640 | |||
| 2641 | public function can_update() { |
||
| 2644 | |||
| 2645 | public function get_update_url() { |
||
| 2650 | |||
| 2651 | public function is_parent() { |
||
| 2656 | |||
| 2657 | public function is_renewal() { |
||
| 2662 | |||
| 2663 | public function get_parent_payment() { |
||
| 2672 | |||
| 2673 | public function is_subscription_active() { |
||
| 2684 | |||
| 2685 | public function is_subscription_expired() { |
||
| 2706 | |||
| 2707 | public function get_new_expiration( $item_id = 0, $trial = true ) { |
||
| 2720 | |||
| 2721 | public function get_subscription_data( $filed = '' ) { |
||
| 2769 | |||
| 2770 | public function is_paid() { |
||
| 2777 | |||
| 2778 | public function is_free() { |
||
| 2791 | |||
| 2792 | public function has_vat() { |
||
| 2805 | |||
| 2806 | public function refresh_item_ids() { |
||
| 2821 | |||
| 2822 | public function get_invoice_quote_type( $post_id ) { |
||
| 2837 | } |
||
| 2838 |
Loading history...
