WordImpress /
Give
Complex classes like Give_Customer 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 Give_Customer, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 22 | class Give_Customer { |
||
| 23 | |||
| 24 | /** |
||
| 25 | * The customer ID |
||
| 26 | * |
||
| 27 | * @since 1.0 |
||
| 28 | */ |
||
| 29 | public $id = 0; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * The customer's purchase count |
||
| 33 | * |
||
| 34 | * @since 1.0 |
||
| 35 | */ |
||
| 36 | public $purchase_count = 0; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * The customer's lifetime value |
||
| 40 | * |
||
| 41 | * @since 1.0 |
||
| 42 | */ |
||
| 43 | public $purchase_value = 0; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * The customer's email |
||
| 47 | * |
||
| 48 | * @since 1.0 |
||
| 49 | */ |
||
| 50 | public $email; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * The customer's name |
||
| 54 | * |
||
| 55 | * @since 1.0 |
||
| 56 | */ |
||
| 57 | public $name; |
||
| 58 | |||
| 59 | /** |
||
| 60 | * The customer's creation date |
||
| 61 | * |
||
| 62 | * @since 1.0 |
||
| 63 | */ |
||
| 64 | public $date_created; |
||
| 65 | |||
| 66 | /** |
||
| 67 | * The payment IDs associated with the customer |
||
| 68 | * |
||
| 69 | * @since 1.0 |
||
| 70 | */ |
||
| 71 | public $payment_ids; |
||
| 72 | |||
| 73 | /** |
||
| 74 | * The user ID associated with the customer |
||
| 75 | * |
||
| 76 | * @since 1.0 |
||
| 77 | */ |
||
| 78 | public $user_id; |
||
| 79 | |||
| 80 | /** |
||
| 81 | * Customer Notes |
||
| 82 | * |
||
| 83 | * @since 1.0 |
||
| 84 | */ |
||
| 85 | public $notes; |
||
| 86 | |||
| 87 | /** |
||
| 88 | * The Database Abstraction |
||
| 89 | * |
||
| 90 | * @since 1.0 |
||
| 91 | */ |
||
| 92 | protected $db; |
||
| 93 | |||
| 94 | /** |
||
| 95 | * Give_Customer constructor. |
||
| 96 | * |
||
| 97 | * @param bool $_id_or_email |
||
| 98 | * @param bool $by_user_id |
||
| 99 | */ |
||
| 100 | 52 | public function __construct( $_id_or_email = false, $by_user_id = false ) { |
|
| 125 | |||
| 126 | /** |
||
| 127 | * Given the customer data, let's set the variables |
||
| 128 | * |
||
| 129 | * @since 1.0 |
||
| 130 | * |
||
| 131 | * @param object $customer The Customer Object |
||
| 132 | * |
||
| 133 | * @return bool If the setup was successful or not |
||
| 134 | */ |
||
| 135 | 52 | private function setup_customer( $customer ) { |
|
| 165 | |||
| 166 | /** |
||
| 167 | * Magic __get function to dispatch a call to retrieve a private property |
||
| 168 | * |
||
| 169 | * @since 1.0 |
||
| 170 | */ |
||
| 171 | 1 | public function __get( $key ) { |
|
| 172 | |||
| 173 | 1 | if ( method_exists( $this, 'get_' . $key ) ) { |
|
| 174 | |||
| 175 | return call_user_func( array( $this, 'get_' . $key ) ); |
||
| 176 | |||
| 177 | } else { |
||
| 178 | |||
| 179 | /* translators: %s: property key */ |
||
| 180 | 1 | return new WP_Error( 'give-customer-invalid-property', sprintf( esc_html__( 'Can\'t get property %s.', 'give' ), $key ) ); |
|
| 181 | |||
| 182 | } |
||
| 183 | |||
| 184 | } |
||
| 185 | |||
| 186 | /** |
||
| 187 | * Creates a customer |
||
| 188 | * |
||
| 189 | * @since 1.0 |
||
| 190 | * |
||
| 191 | * @param array $data Array of attributes for a customer |
||
| 192 | * |
||
| 193 | * @return mixed False if not a valid creation, Customer ID if user is found or valid creation |
||
| 194 | */ |
||
| 195 | 53 | public function create( $data = array() ) { |
|
| 237 | |||
| 238 | /** |
||
| 239 | * Update a customer record |
||
| 240 | * |
||
| 241 | * @since 1.0 |
||
| 242 | * |
||
| 243 | * @param array $data Array of data attributes for a customer (checked via whitelist) |
||
| 244 | * |
||
| 245 | * @return bool If the update was successful or not |
||
| 246 | */ |
||
| 247 | 53 | public function update( $data = array() ) { |
|
| 271 | |||
| 272 | |||
| 273 | /** |
||
| 274 | * Attach payment to the customer then triggers increasing stats |
||
| 275 | * |
||
| 276 | * @since 1.0 |
||
| 277 | * |
||
| 278 | * @param int $payment_id The payment ID to attach to the customer |
||
| 279 | * @param bool $update_stats For backwards compatibility, if we should increase the stats or not |
||
| 280 | * |
||
| 281 | * @return bool If the attachment was successfuly |
||
| 282 | */ |
||
| 283 | 52 | public function attach_payment( $payment_id = 0, $update_stats = true ) { |
|
| 332 | |||
| 333 | |||
| 334 | /** |
||
| 335 | * Remove a payment from this customer, then triggers reducing stats |
||
| 336 | * |
||
| 337 | * @since 1.0 |
||
| 338 | * |
||
| 339 | * @param integer $payment_id The Payment ID to remove |
||
| 340 | * @param bool $update_stats For backwards compatibility, if we should increase the stats or not |
||
| 341 | * |
||
| 342 | * @return boolean If the removal was successful |
||
| 343 | */ |
||
| 344 | 3 | public function remove_payment( $payment_id = 0, $update_stats = true ) { |
|
| 345 | |||
| 346 | 3 | if ( empty( $payment_id ) ) { |
|
| 347 | return false; |
||
| 348 | } |
||
| 349 | |||
| 350 | 3 | $payment = new Give_Payment( $payment_id ); |
|
| 351 | |||
| 352 | 3 | if ( 'publish' !== $payment->status && 'revoked' !== $payment->status ) { |
|
| 353 | 3 | $update_stats = false; |
|
| 354 | 3 | } |
|
| 355 | |||
| 356 | 3 | $new_payment_ids = ''; |
|
| 357 | |||
| 358 | 3 | if ( ! empty( $this->payment_ids ) ) { |
|
| 359 | |||
| 360 | 3 | $payment_ids = array_map( 'absint', explode( ',', $this->payment_ids ) ); |
|
| 361 | |||
| 362 | 3 | $pos = array_search( $payment_id, $payment_ids ); |
|
| 363 | 3 | if ( false === $pos ) { |
|
| 364 | return false; |
||
| 365 | } |
||
| 366 | |||
| 367 | 3 | unset( $payment_ids[ $pos ] ); |
|
| 368 | 3 | $payment_ids = array_filter( $payment_ids ); |
|
| 369 | |||
| 370 | 3 | $new_payment_ids = implode( ',', array_unique( array_values( $payment_ids ) ) ); |
|
| 371 | |||
| 372 | 3 | } |
|
| 373 | |||
| 374 | 3 | do_action( 'give_customer_pre_remove_payment', $payment_id, $this->id ); |
|
| 375 | |||
| 376 | 3 | $payment_removed = $this->update( array( 'payment_ids' => $new_payment_ids ) ); |
|
| 377 | |||
| 378 | 3 | if ( $payment_removed ) { |
|
| 379 | |||
| 380 | 3 | $this->payment_ids = $new_payment_ids; |
|
| 381 | |||
| 382 | 3 | if ( $update_stats ) { |
|
| 383 | // We removed this payment successfully, decrement the stats |
||
| 384 | $payment_amount = give_get_payment_amount( $payment_id ); |
||
| 385 | |||
| 386 | if ( ! empty( $payment_amount ) ) { |
||
| 387 | $this->decrease_value( $payment_amount ); |
||
| 388 | } |
||
| 389 | |||
| 390 | $this->decrease_purchase_count(); |
||
| 391 | } |
||
| 392 | |||
| 393 | 3 | } |
|
| 394 | |||
| 395 | 3 | do_action( 'give_customer_post_remove_payment', $payment_removed, $payment_id, $this->id ); |
|
| 396 | |||
| 397 | 3 | return $payment_removed; |
|
| 398 | |||
| 399 | } |
||
| 400 | |||
| 401 | /** |
||
| 402 | * Increase the purchase count of a customer. |
||
| 403 | * |
||
| 404 | * @since 1.0 |
||
| 405 | * |
||
| 406 | * @param integer $count The number to increment by. |
||
| 407 | * |
||
| 408 | * @return int The purchase count. |
||
| 409 | */ |
||
| 410 | 42 | public function increase_purchase_count( $count = 1 ) { |
|
| 429 | |||
| 430 | /** |
||
| 431 | * Decrease the customer purchase count. |
||
| 432 | * |
||
| 433 | * @since 1.0 |
||
| 434 | * |
||
| 435 | * @param integer $count The amount to decrease by. |
||
| 436 | * |
||
| 437 | * @return mixed If successful, the new count, otherwise false. |
||
| 438 | */ |
||
| 439 | 6 | public function decrease_purchase_count( $count = 1 ) { |
|
| 462 | |||
| 463 | /** |
||
| 464 | * Increase the customer's lifetime value. |
||
| 465 | * |
||
| 466 | * @since 1.0 |
||
| 467 | * |
||
| 468 | * @param float $value The value to increase by. |
||
| 469 | * |
||
| 470 | * @return mixed If successful, the new value, otherwise false. |
||
| 471 | */ |
||
| 472 | 42 | public function increase_value( $value = 0.00 ) { |
|
| 486 | |||
| 487 | /** |
||
| 488 | * Decrease a customer's lifetime value. |
||
| 489 | * |
||
| 490 | * @since 1.0 |
||
| 491 | * |
||
| 492 | * @param float $value The value to decrease by. |
||
| 493 | * |
||
| 494 | * @return mixed If successful, the new value, otherwise false. |
||
| 495 | */ |
||
| 496 | 7 | public function decrease_value( $value = 0.00 ) { |
|
| 514 | |||
| 515 | /** |
||
| 516 | * Decrease/Increase a customer's lifetime value. |
||
| 517 | * |
||
| 518 | * This function will update donation stat on basis of current amount and new amount donation difference. |
||
| 519 | * Difference value can positive or negative. Negative value will decrease user donation stat while positive value increase donation stat. |
||
| 520 | * |
||
| 521 | * |
||
| 522 | * @access public |
||
| 523 | * @since 1.0 |
||
| 524 | * |
||
| 525 | 52 | * @param float $curr_amount Current Donation amount. |
|
| 526 | * @param float $new_amount New ( changed ) Donation amount. |
||
| 527 | 52 | * |
|
| 528 | 52 | * @return mixed If successful, the new donation stat value, otherwise false. |
|
| 529 | */ |
||
| 530 | 52 | public function update_donation_value( $curr_amount, $new_amount ) { |
|
| 531 | 52 | /** |
|
| 532 | * Payment total difference value can be: |
||
| 533 | 52 | * zero (in case amount not change) |
|
| 534 | * or -ve (in case amount decrease) |
||
| 535 | 52 | * or +ve (in case amount increase) |
|
| 536 | */ |
||
| 537 | $payment_total_diff = $new_amount - $curr_amount; |
||
| 538 | |||
| 539 | // We do not need to update donation stat if donation did not change. |
||
| 540 | if( ! $payment_total_diff ) { |
||
| 541 | return false; |
||
| 542 | } |
||
| 543 | |||
| 544 | |||
| 545 | 1 | if( $payment_total_diff > 0 ) { |
|
| 546 | $this->increase_value( $payment_total_diff ); |
||
| 547 | 1 | }else{ |
|
| 548 | 1 | // Pass payment total difference as +ve value to decrease amount from user lifetime stat. |
|
| 549 | $this->decrease_value( -$payment_total_diff ); |
||
| 550 | 1 | } |
|
| 551 | |||
| 552 | return $this->purchase_value; |
||
| 553 | } |
||
| 554 | |||
| 555 | /** |
||
| 556 | * Get the parsed notes for a customer as an array. |
||
| 557 | * |
||
| 558 | * @since 1.0 |
||
| 559 | * |
||
| 560 | * @param integer $length The number of notes to get. |
||
| 561 | * @param integer $paged What note to start at. |
||
| 562 | * |
||
| 563 | 1 | * @return array The notes requested. |
|
| 564 | */ |
||
| 565 | 1 | public function get_notes( $length = 20, $paged = 1 ) { |
|
| 578 | 1 | ||
| 579 | /** |
||
| 580 | 1 | * Get the total number of notes we have after parsing. |
|
| 581 | * |
||
| 582 | 1 | * @since 1.0 |
|
| 583 | * @return int The number of notes for the customer. |
||
| 584 | 1 | */ |
|
| 585 | 1 | public function get_notes_count() { |
|
| 593 | |||
| 594 | /** |
||
| 595 | * Add a note for the customer. |
||
| 596 | * |
||
| 597 | * @since 1.0 |
||
| 598 | * |
||
| 599 | * @param string $note The note to add. |
||
| 600 | * |
||
| 601 | 52 | * @return string|boolean The new note if added successfully, false otherwise. |
|
| 602 | */ |
||
| 603 | 52 | public function add_note( $note = '' ) { |
|
| 634 | 52 | ||
| 635 | 52 | /** |
|
| 636 | 1 | * Get the notes column for the customer |
|
| 637 | 1 | * |
|
| 638 | 52 | * @since 1.0 |
|
| 639 | * @return string The Notes for the customer, non-parsed |
||
| 640 | 52 | */ |
|
| 641 | private function get_raw_notes() { |
||
| 648 | 52 | ||
| 649 | /** |
||
| 650 | 42 | * Retrieve customer meta field for a customer. |
|
| 651 | * |
||
| 652 | 42 | * @param string $meta_key The meta key to retrieve. |
|
| 653 | * @param bool $single Whether to return a single value. |
||
| 654 | 42 | * @return mixed Will be an array if $single is false. Will be value of meta data field if $single is true. |
|
| 655 | * |
||
| 656 | * @access public |
||
| 657 | 42 | * @since 1.6 |
|
| 658 | */ |
||
| 659 | 42 | public function get_meta( $meta_key = '', $single = true ) { |
|
| 662 | |||
| 663 | /** |
||
| 664 | * Add meta data field to a customer. |
||
| 665 | * |
||
| 666 | * @param string $meta_key Metadata name. |
||
| 667 | 52 | * @param mixed $meta_value Metadata value. |
|
| 668 | * @param bool $unique Optional, default is false. Whether the same key should not be added. |
||
| 669 | 52 | * @return bool False for failure. True for success. |
|
| 670 | * |
||
| 671 | * @access public |
||
| 672 | * @since 1.6 |
||
| 673 | */ |
||
| 674 | public function add_meta( $meta_key = '', $meta_value, $unique = false ) { |
||
| 677 | |||
| 678 | /** |
||
| 679 | * Update customer meta field based on customer ID. |
||
| 680 | * |
||
| 681 | * @param string $meta_key Metadata key. |
||
| 682 | * @param mixed $meta_value Metadata value. |
||
| 683 | * @param mixed $prev_value Optional. Previous value to check before removing. |
||
| 684 | * @return bool False on failure, true if success. |
||
| 685 | * |
||
| 686 | * @access public |
||
| 687 | * @since 1.6 |
||
| 688 | */ |
||
| 689 | public function update_meta( $meta_key = '', $meta_value, $prev_value = '' ) { |
||
| 692 | |||
| 693 | /** |
||
| 694 | * Sanitize the data for update/create |
||
| 695 | * |
||
| 696 | * @since 1.0 |
||
| 697 | * |
||
| 698 | * @param array $data The data to sanitize |
||
| 699 | * |
||
| 700 | * @return array The sanitized data, based off column defaults |
||
| 701 | */ |
||
| 702 | private function sanitize_columns( $data ) { |
||
| 755 | |||
| 756 | } |
||
| 757 |
Loading history...
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.