@@ -7,7 +7,7 @@ discard block |
||
| 7 | 7 | */ |
| 8 | 8 | |
| 9 | 9 | if ( ! defined( 'ABSPATH' ) ) { |
| 10 | - exit; // Exit if accessed directly |
|
| 10 | + exit; // Exit if accessed directly |
|
| 11 | 11 | } |
| 12 | 12 | |
| 13 | 13 | /** |
@@ -16,10 +16,10 @@ discard block |
||
| 16 | 16 | class GetPaid_Meta_Box_Payment_Form { |
| 17 | 17 | |
| 18 | 18 | /** |
| 19 | - * Output the metabox. |
|
| 20 | - * |
|
| 21 | - * @param WP_Post $post |
|
| 22 | - */ |
|
| 19 | + * Output the metabox. |
|
| 20 | + * |
|
| 21 | + * @param WP_Post $post |
|
| 22 | + */ |
|
| 23 | 23 | public static function output( $post ) { |
| 24 | 24 | ?> |
| 25 | 25 | <div id="wpinv-form-builder" class="bsui"> |
@@ -86,11 +86,11 @@ discard block |
||
| 86 | 86 | } |
| 87 | 87 | |
| 88 | 88 | /** |
| 89 | - * Save meta box data. |
|
| 90 | - * |
|
| 91 | - * @param int $post_id |
|
| 92 | - */ |
|
| 93 | - public static function save( $post_id ) { |
|
| 89 | + * Save meta box data. |
|
| 90 | + * |
|
| 91 | + * @param int $post_id |
|
| 92 | + */ |
|
| 93 | + public static function save( $post_id ) { |
|
| 94 | 94 | |
| 95 | 95 | // Prepare the form. |
| 96 | 96 | $form = new GetPaid_Payment_Form( $post_id ); |
@@ -121,11 +121,11 @@ discard block |
||
| 121 | 121 | } |
| 122 | 122 | |
| 123 | 123 | /** |
| 124 | - * Converts an array fo form items to objects. |
|
| 125 | - * |
|
| 126 | - * @param array $items |
|
| 127 | - */ |
|
| 128 | - public static function item_to_objects( $items ) { |
|
| 124 | + * Converts an array fo form items to objects. |
|
| 125 | + * |
|
| 126 | + * @param array $items |
|
| 127 | + */ |
|
| 128 | + public static function item_to_objects( $items ) { |
|
| 129 | 129 | |
| 130 | 130 | $objects = array(); |
| 131 | 131 | |
@@ -8,7 +8,7 @@ discard block |
||
| 8 | 8 | */ |
| 9 | 9 | |
| 10 | 10 | if ( ! defined( 'ABSPATH' ) ) { |
| 11 | - exit; // Exit if accessed directly |
|
| 11 | + exit; // Exit if accessed directly |
|
| 12 | 12 | } |
| 13 | 13 | |
| 14 | 14 | /** |
@@ -17,10 +17,10 @@ discard block |
||
| 17 | 17 | class GetPaid_Meta_Box_Discount_Details { |
| 18 | 18 | |
| 19 | 19 | /** |
| 20 | - * Output the metabox. |
|
| 21 | - * |
|
| 22 | - * @param WP_Post $post |
|
| 23 | - */ |
|
| 20 | + * Output the metabox. |
|
| 21 | + * |
|
| 22 | + * @param WP_Post $post |
|
| 23 | + */ |
|
| 24 | 24 | public static function output( $post ) { |
| 25 | 25 | |
| 26 | 26 | // Prepare the discount. |
@@ -368,34 +368,34 @@ discard block |
||
| 368 | 368 | } |
| 369 | 369 | |
| 370 | 370 | /** |
| 371 | - * Save meta box data. |
|
| 372 | - * |
|
| 373 | - * @param int $post_id |
|
| 374 | - */ |
|
| 375 | - public static function save( $post_id ) { |
|
| 371 | + * Save meta box data. |
|
| 372 | + * |
|
| 373 | + * @param int $post_id |
|
| 374 | + */ |
|
| 375 | + public static function save( $post_id ) { |
|
| 376 | 376 | |
| 377 | 377 | // Prepare the discount. |
| 378 | 378 | $discount = new WPInv_Discount( $post_id ); |
| 379 | 379 | |
| 380 | 380 | // Load new data. |
| 381 | 381 | $discount->set_props( |
| 382 | - array( |
|
| 383 | - 'code' => isset( $_POST['wpinv_discount_code'] ) ? $_POST['wpinv_discount_code'] : null, |
|
| 384 | - 'amount' => isset( $_POST['wpinv_discount_amount'] ) ? $_POST['wpinv_discount_amount'] : null, |
|
| 385 | - 'start' => isset( $_POST['wpinv_discount_start'] ) ? wpinv_clean( $_POST['wpinv_discount_start'] ) : null, |
|
| 386 | - 'expiration' => isset( $_POST['wpinv_discount_expiration'] ) ? wpinv_clean( $_POST['wpinv_discount_expiration'] ) : null, |
|
| 387 | - 'is_single_use' => isset( $_POST['wpinv_discount_single_use'] ), |
|
| 382 | + array( |
|
| 383 | + 'code' => isset( $_POST['wpinv_discount_code'] ) ? $_POST['wpinv_discount_code'] : null, |
|
| 384 | + 'amount' => isset( $_POST['wpinv_discount_amount'] ) ? $_POST['wpinv_discount_amount'] : null, |
|
| 385 | + 'start' => isset( $_POST['wpinv_discount_start'] ) ? wpinv_clean( $_POST['wpinv_discount_start'] ) : null, |
|
| 386 | + 'expiration' => isset( $_POST['wpinv_discount_expiration'] ) ? wpinv_clean( $_POST['wpinv_discount_expiration'] ) : null, |
|
| 387 | + 'is_single_use' => isset( $_POST['wpinv_discount_single_use'] ), |
|
| 388 | 388 | 'type' => isset( $_POST['wpinv_discount_type'] ) ? $_POST['wpinv_discount_type'] : null, |
| 389 | - 'is_recurring' => isset( $_POST['wpinv_discount_recurring'] ), |
|
| 390 | - 'items' => isset( $_POST['wpinv_discount_items'] ) ? $_POST['wpinv_discount_items'] : array(), |
|
| 391 | - 'excluded_items' => isset( $_POST['wpinv_discount_excluded_items'] ) ? $_POST['wpinv_discount_excluded_items'] : array(), |
|
| 392 | - 'max_uses' => isset( $_POST['wpinv_discount_max_uses'] ) ? $_POST['wpinv_discount_max_uses'] : null, |
|
| 393 | - 'min_total' => isset( $_POST['wpinv_discount_min_total'] ) ? $_POST['wpinv_discount_min_total'] : null, |
|
| 394 | - 'max_total' => isset( $_POST['wpinv_discount_max_total'] ) ? $_POST['wpinv_discount_max_total'] : null, |
|
| 395 | - ) |
|
| 389 | + 'is_recurring' => isset( $_POST['wpinv_discount_recurring'] ), |
|
| 390 | + 'items' => isset( $_POST['wpinv_discount_items'] ) ? $_POST['wpinv_discount_items'] : array(), |
|
| 391 | + 'excluded_items' => isset( $_POST['wpinv_discount_excluded_items'] ) ? $_POST['wpinv_discount_excluded_items'] : array(), |
|
| 392 | + 'max_uses' => isset( $_POST['wpinv_discount_max_uses'] ) ? $_POST['wpinv_discount_max_uses'] : null, |
|
| 393 | + 'min_total' => isset( $_POST['wpinv_discount_min_total'] ) ? $_POST['wpinv_discount_min_total'] : null, |
|
| 394 | + 'max_total' => isset( $_POST['wpinv_discount_max_total'] ) ? $_POST['wpinv_discount_max_total'] : null, |
|
| 395 | + ) |
|
| 396 | 396 | ); |
| 397 | 397 | |
| 398 | - $discount->save(); |
|
| 399 | - do_action( 'getpaid_discount_metabox_save', $post_id, $discount ); |
|
| 400 | - } |
|
| 398 | + $discount->save(); |
|
| 399 | + do_action( 'getpaid_discount_metabox_save', $post_id, $discount ); |
|
| 400 | + } |
|
| 401 | 401 | } |
@@ -12,108 +12,108 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Payment_Form_Submission_Fees { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * The fee validation error. |
|
| 17 | - * @var string |
|
| 18 | - */ |
|
| 19 | - public $fee_error; |
|
| 20 | - |
|
| 21 | - /** |
|
| 22 | - * Submission fees. |
|
| 23 | - * @var array |
|
| 24 | - */ |
|
| 25 | - public $fees = array(); |
|
| 15 | + /** |
|
| 16 | + * The fee validation error. |
|
| 17 | + * @var string |
|
| 18 | + */ |
|
| 19 | + public $fee_error; |
|
| 20 | + |
|
| 21 | + /** |
|
| 22 | + * Submission fees. |
|
| 23 | + * @var array |
|
| 24 | + */ |
|
| 25 | + public $fees = array(); |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * Class constructor |
|
| 29 | + * |
|
| 30 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 31 | + */ |
|
| 32 | + public function __construct( $submission ) { |
|
| 33 | + |
|
| 34 | + // Process any existing invoice fees. |
|
| 35 | + if ( $submission->has_invoice() ) { |
|
| 36 | + $this->fees = $submission->get_invoice()->get_fees(); |
|
| 37 | + } |
|
| 38 | + |
|
| 39 | + // Process price fields. |
|
| 40 | + $data = $submission->get_data(); |
|
| 41 | + $payment_form = $submission->get_payment_form(); |
|
| 42 | + |
|
| 43 | + foreach ( $payment_form->get_elements() as $element ) { |
|
| 44 | + |
|
| 45 | + if ( 'price_input' == $element['type'] ) { |
|
| 46 | + $this->process_price_input( $element, $data ); |
|
| 47 | + } |
|
| 48 | + |
|
| 49 | + if ( 'price_select' == $element['type'] ) { |
|
| 50 | + $this->process_price_select( $element, $data ); |
|
| 51 | + } |
|
| 52 | + |
|
| 53 | + } |
|
| 54 | + |
|
| 55 | + } |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * Process a price input field. |
|
| 59 | + * |
|
| 60 | + * @param array $element |
|
| 61 | + * @param array $data |
|
| 62 | + */ |
|
| 63 | + public function process_price_input( $element, $data ) { |
|
| 64 | + |
|
| 65 | + // Abort if not passed. |
|
| 66 | + if ( empty( $data[ $element['id'] ] ) ) { |
|
| 67 | + return; |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + $amount = (float) wpinv_sanitize_amount( $data[ $element['id'] ] ); |
|
| 71 | + $minimum = empty( $element['minimum'] ) ? 0 : (float) wpinv_sanitize_amount( $element['minimum'] ); |
|
| 72 | + |
|
| 73 | + if ( $amount < $minimum ) { |
|
| 74 | + throw new Exception( sprintf( __( 'The minimum allowed amount is %s', 'invoicing' ), $minimum ) ); |
|
| 75 | + } |
|
| 76 | + |
|
| 77 | + $this->fees[ $element['label'] ] = array( |
|
| 78 | + 'name' => $element['label'], |
|
| 79 | + 'initial_fee' => $amount, |
|
| 80 | + 'recurring_fee' => 0, |
|
| 81 | + ); |
|
| 82 | + |
|
| 83 | + } |
|
| 26 | 84 | |
| 27 | 85 | /** |
| 28 | - * Class constructor |
|
| 29 | - * |
|
| 30 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 31 | - */ |
|
| 32 | - public function __construct( $submission ) { |
|
| 33 | - |
|
| 34 | - // Process any existing invoice fees. |
|
| 35 | - if ( $submission->has_invoice() ) { |
|
| 36 | - $this->fees = $submission->get_invoice()->get_fees(); |
|
| 37 | - } |
|
| 38 | - |
|
| 39 | - // Process price fields. |
|
| 40 | - $data = $submission->get_data(); |
|
| 41 | - $payment_form = $submission->get_payment_form(); |
|
| 42 | - |
|
| 43 | - foreach ( $payment_form->get_elements() as $element ) { |
|
| 44 | - |
|
| 45 | - if ( 'price_input' == $element['type'] ) { |
|
| 46 | - $this->process_price_input( $element, $data ); |
|
| 47 | - } |
|
| 48 | - |
|
| 49 | - if ( 'price_select' == $element['type'] ) { |
|
| 50 | - $this->process_price_select( $element, $data ); |
|
| 51 | - } |
|
| 52 | - |
|
| 53 | - } |
|
| 54 | - |
|
| 55 | - } |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * Process a price input field. |
|
| 59 | - * |
|
| 60 | - * @param array $element |
|
| 61 | - * @param array $data |
|
| 62 | - */ |
|
| 63 | - public function process_price_input( $element, $data ) { |
|
| 64 | - |
|
| 65 | - // Abort if not passed. |
|
| 66 | - if ( empty( $data[ $element['id'] ] ) ) { |
|
| 67 | - return; |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - $amount = (float) wpinv_sanitize_amount( $data[ $element['id'] ] ); |
|
| 71 | - $minimum = empty( $element['minimum'] ) ? 0 : (float) wpinv_sanitize_amount( $element['minimum'] ); |
|
| 72 | - |
|
| 73 | - if ( $amount < $minimum ) { |
|
| 74 | - throw new Exception( sprintf( __( 'The minimum allowed amount is %s', 'invoicing' ), $minimum ) ); |
|
| 75 | - } |
|
| 76 | - |
|
| 77 | - $this->fees[ $element['label'] ] = array( |
|
| 78 | - 'name' => $element['label'], |
|
| 79 | - 'initial_fee' => $amount, |
|
| 80 | - 'recurring_fee' => 0, |
|
| 81 | - ); |
|
| 82 | - |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Process a price select field. |
|
| 87 | - * |
|
| 88 | - * @param array $element |
|
| 89 | - * @param array $data |
|
| 90 | - */ |
|
| 91 | - public function process_price_select( $element, $data ) { |
|
| 92 | - |
|
| 93 | - // Abort if not passed. |
|
| 94 | - if ( empty( $data[ $element['id'] ] ) ) { |
|
| 95 | - return; |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - $options = getpaid_convert_price_string_to_options( $element['options'] ); |
|
| 99 | - $selected = wpinv_parse_list( $data[ $element['id'] ] ); |
|
| 100 | - $total = 0; |
|
| 101 | - |
|
| 102 | - foreach ( $selected as $price ) { |
|
| 103 | - |
|
| 104 | - if ( ! isset( $options[ $price ] ) ) { |
|
| 105 | - throw new Exception( __( 'You have selected an invalid amount', 'invoicing' ) ); |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - $total += (float) wpinv_sanitize_amount( $price ); |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - $this->fees[ $element['label'] ] = array( |
|
| 112 | - 'name' => $element['label'], |
|
| 113 | - 'initial_fee' => $total, |
|
| 114 | - 'recurring_fee' => 0, |
|
| 115 | - ); |
|
| 116 | - |
|
| 117 | - } |
|
| 86 | + * Process a price select field. |
|
| 87 | + * |
|
| 88 | + * @param array $element |
|
| 89 | + * @param array $data |
|
| 90 | + */ |
|
| 91 | + public function process_price_select( $element, $data ) { |
|
| 92 | + |
|
| 93 | + // Abort if not passed. |
|
| 94 | + if ( empty( $data[ $element['id'] ] ) ) { |
|
| 95 | + return; |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + $options = getpaid_convert_price_string_to_options( $element['options'] ); |
|
| 99 | + $selected = wpinv_parse_list( $data[ $element['id'] ] ); |
|
| 100 | + $total = 0; |
|
| 101 | + |
|
| 102 | + foreach ( $selected as $price ) { |
|
| 103 | + |
|
| 104 | + if ( ! isset( $options[ $price ] ) ) { |
|
| 105 | + throw new Exception( __( 'You have selected an invalid amount', 'invoicing' ) ); |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + $total += (float) wpinv_sanitize_amount( $price ); |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + $this->fees[ $element['label'] ] = array( |
|
| 112 | + 'name' => $element['label'], |
|
| 113 | + 'initial_fee' => $total, |
|
| 114 | + 'recurring_fee' => 0, |
|
| 115 | + ); |
|
| 116 | + |
|
| 117 | + } |
|
| 118 | 118 | |
| 119 | 119 | } |
@@ -12,231 +12,231 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Payment_Form_Submission_Taxes { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * Submission taxes. |
|
| 17 | - * @var array |
|
| 18 | - */ |
|
| 19 | - public $taxes = array(); |
|
| 20 | - |
|
| 21 | - /** |
|
| 22 | - * Initial tax. |
|
| 23 | - * @var float |
|
| 24 | - */ |
|
| 25 | - protected $initial_tax = 0; |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * Recurring tax. |
|
| 29 | - * @var float |
|
| 30 | - */ |
|
| 31 | - protected $recurring_tax = 0; |
|
| 15 | + /** |
|
| 16 | + * Submission taxes. |
|
| 17 | + * @var array |
|
| 18 | + */ |
|
| 19 | + public $taxes = array(); |
|
| 20 | + |
|
| 21 | + /** |
|
| 22 | + * Initial tax. |
|
| 23 | + * @var float |
|
| 24 | + */ |
|
| 25 | + protected $initial_tax = 0; |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * Recurring tax. |
|
| 29 | + * @var float |
|
| 30 | + */ |
|
| 31 | + protected $recurring_tax = 0; |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * Class constructor |
|
| 35 | + * |
|
| 36 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 37 | + */ |
|
| 38 | + public function __construct( $submission ) { |
|
| 39 | + |
|
| 40 | + // Validate VAT number. |
|
| 41 | + $this->validate_vat( $submission ); |
|
| 42 | + |
|
| 43 | + foreach ( $submission->get_items() as $item ) { |
|
| 44 | + $this->process_item_tax( $item, $submission ); |
|
| 45 | + } |
|
| 46 | + |
|
| 47 | + // Process any existing invoice taxes. |
|
| 48 | + if ( $submission->has_invoice() ) { |
|
| 49 | + $this->taxes = $submission->get_invoice()->get_taxes(); |
|
| 50 | + } |
|
| 51 | + |
|
| 52 | + // Add VAT. |
|
| 53 | + $this->taxes['vat'] = array( |
|
| 54 | + 'name' => 'vat', |
|
| 55 | + 'initial_tax' => $this->initial_tax, |
|
| 56 | + 'recurring_tax' => $this->recurring_tax, |
|
| 57 | + ); |
|
| 58 | + |
|
| 59 | + } |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * Maybe process tax. |
|
| 63 | + * |
|
| 64 | + * @since 1.0.19 |
|
| 65 | + * @param GetPaid_Form_Item $item |
|
| 66 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 67 | + */ |
|
| 68 | + public function process_item_tax( $item, $submission ) { |
|
| 69 | + |
|
| 70 | + $rate = wpinv_get_tax_rate( $submission->country, $submission->state, $item->get_id() ); |
|
| 71 | + $price = $item->get_sub_total(); |
|
| 72 | + $item_tax = $price * $rate * 0.01; |
|
| 73 | + |
|
| 74 | + if ( wpinv_prices_include_tax() ) { |
|
| 75 | + $item_tax = $price - ( $price - $price * $rate * 0.01 ); |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + $this->initial_tax += $item_tax; |
|
| 79 | + |
|
| 80 | + if ( $item->is_recurring() ) { |
|
| 81 | + $this->recurring_tax += $item_tax; |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + } |
|
| 85 | + |
|
| 86 | + /** |
|
| 87 | + * Checks if the submission has a digital item. |
|
| 88 | + * |
|
| 89 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 90 | + * @since 1.0.19 |
|
| 91 | + * @return bool |
|
| 92 | + */ |
|
| 93 | + public function has_digital_item( $submission ) { |
|
| 94 | + |
|
| 95 | + foreach ( $submission->get_items() as $item ) { |
|
| 96 | + |
|
| 97 | + if ( 'digital' == $item->get_vat_rule() ) { |
|
| 98 | + return true; |
|
| 99 | + } |
|
| 100 | + |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + return false; |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * Checks if this is an eu store. |
|
| 108 | + * |
|
| 109 | + * @since 1.0.19 |
|
| 110 | + * @return bool |
|
| 111 | + */ |
|
| 112 | + public function is_eu_store() { |
|
| 113 | + return $this->is_eu_country( wpinv_get_default_country() ); |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + /** |
|
| 117 | + * Checks if this is an eu country. |
|
| 118 | + * |
|
| 119 | + * @param string $country |
|
| 120 | + * @since 1.0.19 |
|
| 121 | + * @return bool |
|
| 122 | + */ |
|
| 123 | + public function is_eu_country( $country ) { |
|
| 124 | + return getpaid_is_eu_state( $country ) || getpaid_is_gst_country( $country ); |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + /** |
|
| 128 | + * Checks if this is an eu purchase. |
|
| 129 | + * |
|
| 130 | + * @param string $customer_country |
|
| 131 | + * @since 1.0.19 |
|
| 132 | + * @return bool |
|
| 133 | + */ |
|
| 134 | + public function is_eu_transaction( $customer_country ) { |
|
| 135 | + return $this->is_eu_country( $customer_country ) && $this->is_eu_store(); |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + /** |
|
| 139 | + * Retrieves the vat number. |
|
| 140 | + * |
|
| 141 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 142 | + * @since 1.0.19 |
|
| 143 | + * @return string |
|
| 144 | + */ |
|
| 145 | + public function get_vat_number( $submission ) { |
|
| 146 | + |
|
| 147 | + // Retrieve from the posted number. |
|
| 148 | + $vat_number = $submission->get_field( 'wpinv_vat_number' ); |
|
| 149 | + if ( ! empty( $vat_number ) ) { |
|
| 150 | + return wpinv_clean( $vat_number ); |
|
| 151 | + } |
|
| 152 | + |
|
| 153 | + // Retrieve from the invoice. |
|
| 154 | + return $submission->has_invoice() ? $submission->get_invoice()->get_vat_number() : ''; |
|
| 155 | + } |
|
| 156 | + |
|
| 157 | + /** |
|
| 158 | + * Retrieves the company. |
|
| 159 | + * |
|
| 160 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 161 | + * @since 1.0.19 |
|
| 162 | + * @return string |
|
| 163 | + */ |
|
| 164 | + public function get_company( $submission ) { |
|
| 165 | + |
|
| 166 | + // Retrieve from the posted data. |
|
| 167 | + $company = $submission->get_field( 'wpinv_company' ); |
|
| 168 | + if ( ! empty( $company ) ) { |
|
| 169 | + return wpinv_clean( $company ); |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + // Retrieve from the invoice. |
|
| 173 | + return $submission->has_invoice() ? $submission->get_invoice()->get_company() : ''; |
|
| 174 | + } |
|
| 175 | + |
|
| 176 | + /** |
|
| 177 | + * Checks if we requires a VAT number. |
|
| 178 | + * |
|
| 179 | + * @param bool $ip_in_eu Whether the customer IP is from the EU |
|
| 180 | + * @param bool $country_in_eu Whether the customer country is from the EU |
|
| 181 | + * @since 1.0.19 |
|
| 182 | + * @return string |
|
| 183 | + */ |
|
| 184 | + public function requires_vat( $ip_in_eu, $country_in_eu ) { |
|
| 185 | + |
|
| 186 | + $prevent_b2c = wpinv_get_option( 'vat_prevent_b2c_purchase' ); |
|
| 187 | + $prevent_b2c = ! empty( $prevent_b2c ); |
|
| 188 | + $is_eu = $ip_in_eu || $country_in_eu; |
|
| 189 | + |
|
| 190 | + return $prevent_b2c && $is_eu; |
|
| 191 | + } |
|
| 32 | 192 | |
| 33 | 193 | /** |
| 34 | - * Class constructor |
|
| 35 | - * |
|
| 36 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 37 | - */ |
|
| 38 | - public function __construct( $submission ) { |
|
| 39 | - |
|
| 40 | - // Validate VAT number. |
|
| 41 | - $this->validate_vat( $submission ); |
|
| 42 | - |
|
| 43 | - foreach ( $submission->get_items() as $item ) { |
|
| 44 | - $this->process_item_tax( $item, $submission ); |
|
| 45 | - } |
|
| 46 | - |
|
| 47 | - // Process any existing invoice taxes. |
|
| 48 | - if ( $submission->has_invoice() ) { |
|
| 49 | - $this->taxes = $submission->get_invoice()->get_taxes(); |
|
| 50 | - } |
|
| 51 | - |
|
| 52 | - // Add VAT. |
|
| 53 | - $this->taxes['vat'] = array( |
|
| 54 | - 'name' => 'vat', |
|
| 55 | - 'initial_tax' => $this->initial_tax, |
|
| 56 | - 'recurring_tax' => $this->recurring_tax, |
|
| 57 | - ); |
|
| 58 | - |
|
| 59 | - } |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * Maybe process tax. |
|
| 63 | - * |
|
| 64 | - * @since 1.0.19 |
|
| 65 | - * @param GetPaid_Form_Item $item |
|
| 66 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 67 | - */ |
|
| 68 | - public function process_item_tax( $item, $submission ) { |
|
| 69 | - |
|
| 70 | - $rate = wpinv_get_tax_rate( $submission->country, $submission->state, $item->get_id() ); |
|
| 71 | - $price = $item->get_sub_total(); |
|
| 72 | - $item_tax = $price * $rate * 0.01; |
|
| 73 | - |
|
| 74 | - if ( wpinv_prices_include_tax() ) { |
|
| 75 | - $item_tax = $price - ( $price - $price * $rate * 0.01 ); |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - $this->initial_tax += $item_tax; |
|
| 79 | - |
|
| 80 | - if ( $item->is_recurring() ) { |
|
| 81 | - $this->recurring_tax += $item_tax; |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * Checks if the submission has a digital item. |
|
| 88 | - * |
|
| 89 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 90 | - * @since 1.0.19 |
|
| 91 | - * @return bool |
|
| 92 | - */ |
|
| 93 | - public function has_digital_item( $submission ) { |
|
| 94 | - |
|
| 95 | - foreach ( $submission->get_items() as $item ) { |
|
| 96 | - |
|
| 97 | - if ( 'digital' == $item->get_vat_rule() ) { |
|
| 98 | - return true; |
|
| 99 | - } |
|
| 100 | - |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - return false; |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * Checks if this is an eu store. |
|
| 108 | - * |
|
| 109 | - * @since 1.0.19 |
|
| 110 | - * @return bool |
|
| 111 | - */ |
|
| 112 | - public function is_eu_store() { |
|
| 113 | - return $this->is_eu_country( wpinv_get_default_country() ); |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - /** |
|
| 117 | - * Checks if this is an eu country. |
|
| 118 | - * |
|
| 119 | - * @param string $country |
|
| 120 | - * @since 1.0.19 |
|
| 121 | - * @return bool |
|
| 122 | - */ |
|
| 123 | - public function is_eu_country( $country ) { |
|
| 124 | - return getpaid_is_eu_state( $country ) || getpaid_is_gst_country( $country ); |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - /** |
|
| 128 | - * Checks if this is an eu purchase. |
|
| 129 | - * |
|
| 130 | - * @param string $customer_country |
|
| 131 | - * @since 1.0.19 |
|
| 132 | - * @return bool |
|
| 133 | - */ |
|
| 134 | - public function is_eu_transaction( $customer_country ) { |
|
| 135 | - return $this->is_eu_country( $customer_country ) && $this->is_eu_store(); |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - /** |
|
| 139 | - * Retrieves the vat number. |
|
| 140 | - * |
|
| 141 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 142 | - * @since 1.0.19 |
|
| 143 | - * @return string |
|
| 144 | - */ |
|
| 145 | - public function get_vat_number( $submission ) { |
|
| 146 | - |
|
| 147 | - // Retrieve from the posted number. |
|
| 148 | - $vat_number = $submission->get_field( 'wpinv_vat_number' ); |
|
| 149 | - if ( ! empty( $vat_number ) ) { |
|
| 150 | - return wpinv_clean( $vat_number ); |
|
| 151 | - } |
|
| 152 | - |
|
| 153 | - // Retrieve from the invoice. |
|
| 154 | - return $submission->has_invoice() ? $submission->get_invoice()->get_vat_number() : ''; |
|
| 155 | - } |
|
| 156 | - |
|
| 157 | - /** |
|
| 158 | - * Retrieves the company. |
|
| 159 | - * |
|
| 160 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 161 | - * @since 1.0.19 |
|
| 162 | - * @return string |
|
| 163 | - */ |
|
| 164 | - public function get_company( $submission ) { |
|
| 165 | - |
|
| 166 | - // Retrieve from the posted data. |
|
| 167 | - $company = $submission->get_field( 'wpinv_company' ); |
|
| 168 | - if ( ! empty( $company ) ) { |
|
| 169 | - return wpinv_clean( $company ); |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - // Retrieve from the invoice. |
|
| 173 | - return $submission->has_invoice() ? $submission->get_invoice()->get_company() : ''; |
|
| 174 | - } |
|
| 175 | - |
|
| 176 | - /** |
|
| 177 | - * Checks if we requires a VAT number. |
|
| 178 | - * |
|
| 179 | - * @param bool $ip_in_eu Whether the customer IP is from the EU |
|
| 180 | - * @param bool $country_in_eu Whether the customer country is from the EU |
|
| 181 | - * @since 1.0.19 |
|
| 182 | - * @return string |
|
| 183 | - */ |
|
| 184 | - public function requires_vat( $ip_in_eu, $country_in_eu ) { |
|
| 185 | - |
|
| 186 | - $prevent_b2c = wpinv_get_option( 'vat_prevent_b2c_purchase' ); |
|
| 187 | - $prevent_b2c = ! empty( $prevent_b2c ); |
|
| 188 | - $is_eu = $ip_in_eu || $country_in_eu; |
|
| 189 | - |
|
| 190 | - return $prevent_b2c && $is_eu; |
|
| 191 | - } |
|
| 192 | - |
|
| 193 | - /** |
|
| 194 | - * Validate VAT data. |
|
| 195 | - * |
|
| 196 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 197 | - * @since 1.0.19 |
|
| 198 | - */ |
|
| 199 | - public function validate_vat( $submission ) { |
|
| 200 | - |
|
| 201 | - $has_digital = $this->has_digital_item( $submission ); |
|
| 202 | - $in_eu = $this->is_eu_transaction( $submission->country ); |
|
| 203 | - |
|
| 204 | - // Abort if we are not validating vat numbers. |
|
| 205 | - if ( ! $has_digital && ! $in_eu ) { |
|
| 194 | + * Validate VAT data. |
|
| 195 | + * |
|
| 196 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 197 | + * @since 1.0.19 |
|
| 198 | + */ |
|
| 199 | + public function validate_vat( $submission ) { |
|
| 200 | + |
|
| 201 | + $has_digital = $this->has_digital_item( $submission ); |
|
| 202 | + $in_eu = $this->is_eu_transaction( $submission->country ); |
|
| 203 | + |
|
| 204 | + // Abort if we are not validating vat numbers. |
|
| 205 | + if ( ! $has_digital && ! $in_eu ) { |
|
| 206 | 206 | return; |
| 207 | - } |
|
| 207 | + } |
|
| 208 | 208 | |
| 209 | - // Prepare variables. |
|
| 210 | - $vat_number = $this->get_vat_number( $submission ); |
|
| 211 | - $company = $this->get_company( $submission ); |
|
| 212 | - $ip_country = WPInv_EUVat::get_country_by_ip(); |
|
| 209 | + // Prepare variables. |
|
| 210 | + $vat_number = $this->get_vat_number( $submission ); |
|
| 211 | + $company = $this->get_company( $submission ); |
|
| 212 | + $ip_country = WPInv_EUVat::get_country_by_ip(); |
|
| 213 | 213 | $is_eu = $this->is_eu_country( $submission->country ); |
| 214 | 214 | $is_ip_eu = $this->is_eu_country( $ip_country ); |
| 215 | 215 | |
| 216 | - // If we're preventing business to consumer purchases, ensure |
|
| 217 | - if ( $this->requires_vat( $is_ip_eu, $is_eu ) && empty( $vat_number ) ) { |
|
| 216 | + // If we're preventing business to consumer purchases, ensure |
|
| 217 | + if ( $this->requires_vat( $is_ip_eu, $is_eu ) && empty( $vat_number ) ) { |
|
| 218 | 218 | |
| 219 | - // Ensure that a vat number has been specified. |
|
| 220 | - throw new Exception( |
|
| 221 | - wp_sprintf( |
|
| 222 | - __( 'Please enter your %s number to verify your purchase is by an EU business.', 'invoicing' ), |
|
| 223 | - getpaid_vat_name() |
|
| 224 | - ) |
|
| 225 | - ); |
|
| 219 | + // Ensure that a vat number has been specified. |
|
| 220 | + throw new Exception( |
|
| 221 | + wp_sprintf( |
|
| 222 | + __( 'Please enter your %s number to verify your purchase is by an EU business.', 'invoicing' ), |
|
| 223 | + getpaid_vat_name() |
|
| 224 | + ) |
|
| 225 | + ); |
|
| 226 | 226 | |
| 227 | - } |
|
| 227 | + } |
|
| 228 | 228 | |
| 229 | - // Abort if we are not validating vat (vat number should exist, user should be in eu and business too). |
|
| 230 | - if ( ! $is_eu || ! $in_eu || empty( $vat_number ) ) { |
|
| 229 | + // Abort if we are not validating vat (vat number should exist, user should be in eu and business too). |
|
| 230 | + if ( ! $is_eu || ! $in_eu || empty( $vat_number ) ) { |
|
| 231 | 231 | return; |
| 232 | - } |
|
| 232 | + } |
|
| 233 | 233 | |
| 234 | - $is_valid = WPInv_EUVat::validate_vat_number( $vat_number, $company, $submission->country ); |
|
| 234 | + $is_valid = WPInv_EUVat::validate_vat_number( $vat_number, $company, $submission->country ); |
|
| 235 | 235 | |
| 236 | - if ( is_string( $is_valid ) ) { |
|
| 237 | - throw new Exception( $is_valid ); |
|
| 238 | - } |
|
| 236 | + if ( is_string( $is_valid ) ) { |
|
| 237 | + throw new Exception( $is_valid ); |
|
| 238 | + } |
|
| 239 | 239 | |
| 240 | - } |
|
| 240 | + } |
|
| 241 | 241 | |
| 242 | 242 | } |
@@ -1,6 +1,6 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | if ( ! defined( 'ABSPATH' ) ) { |
| 3 | - exit; |
|
| 3 | + exit; |
|
| 4 | 4 | } |
| 5 | 5 | |
| 6 | 6 | /** |
@@ -10,60 +10,60 @@ discard block |
||
| 10 | 10 | class GetPaid_Form_Item extends WPInv_Item { |
| 11 | 11 | |
| 12 | 12 | /** |
| 13 | - * Stores a custom description for the item. |
|
| 14 | - * |
|
| 15 | - * @var string |
|
| 16 | - */ |
|
| 17 | - protected $custom_description = null; |
|
| 18 | - |
|
| 19 | - /** |
|
| 20 | - * Stores the item quantity. |
|
| 21 | - * |
|
| 22 | - * @var int |
|
| 23 | - */ |
|
| 24 | - protected $quantity = 1; |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * Stores the item meta. |
|
| 28 | - * |
|
| 29 | - * @var array |
|
| 30 | - */ |
|
| 31 | - protected $meta = array(); |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * Is this item required? |
|
| 35 | - * |
|
| 36 | - * @var int |
|
| 37 | - */ |
|
| 38 | - protected $is_required = true; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Are quantities allowed? |
|
| 42 | - * |
|
| 43 | - * @var int |
|
| 44 | - */ |
|
| 45 | - protected $allow_quantities = false; |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * Associated invoice. |
|
| 49 | - * |
|
| 50 | - * @var int |
|
| 51 | - */ |
|
| 52 | - public $invoice_id = 0; |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * Item discount. |
|
| 56 | - * |
|
| 57 | - * @var float |
|
| 58 | - */ |
|
| 59 | - public $item_discount = 0; |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * Item tax. |
|
| 63 | - * |
|
| 64 | - * @var float |
|
| 65 | - */ |
|
| 66 | - public $item_tax = 0; |
|
| 13 | + * Stores a custom description for the item. |
|
| 14 | + * |
|
| 15 | + * @var string |
|
| 16 | + */ |
|
| 17 | + protected $custom_description = null; |
|
| 18 | + |
|
| 19 | + /** |
|
| 20 | + * Stores the item quantity. |
|
| 21 | + * |
|
| 22 | + * @var int |
|
| 23 | + */ |
|
| 24 | + protected $quantity = 1; |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * Stores the item meta. |
|
| 28 | + * |
|
| 29 | + * @var array |
|
| 30 | + */ |
|
| 31 | + protected $meta = array(); |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * Is this item required? |
|
| 35 | + * |
|
| 36 | + * @var int |
|
| 37 | + */ |
|
| 38 | + protected $is_required = true; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * Are quantities allowed? |
|
| 42 | + * |
|
| 43 | + * @var int |
|
| 44 | + */ |
|
| 45 | + protected $allow_quantities = false; |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * Associated invoice. |
|
| 49 | + * |
|
| 50 | + * @var int |
|
| 51 | + */ |
|
| 52 | + public $invoice_id = 0; |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * Item discount. |
|
| 56 | + * |
|
| 57 | + * @var float |
|
| 58 | + */ |
|
| 59 | + public $item_discount = 0; |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * Item tax. |
|
| 63 | + * |
|
| 64 | + * @var float |
|
| 65 | + */ |
|
| 66 | + public $item_tax = 0; |
|
| 67 | 67 | |
| 68 | 68 | /* |
| 69 | 69 | |-------------------------------------------------------------------------- |
@@ -81,226 +81,226 @@ discard block |
||
| 81 | 81 | */ |
| 82 | 82 | |
| 83 | 83 | /** |
| 84 | - * Get the item name. |
|
| 85 | - * |
|
| 86 | - * @since 1.0.19 |
|
| 87 | - * @param string $context View or edit context. |
|
| 88 | - * @return string |
|
| 89 | - */ |
|
| 90 | - public function get_name( $context = 'view' ) { |
|
| 91 | - $name = parent::get_name( $context ); |
|
| 92 | - return $name . wpinv_get_item_suffix( $this ); |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - /** |
|
| 96 | - * Get the item name without a suffix. |
|
| 97 | - * |
|
| 98 | - * @since 1.0.19 |
|
| 99 | - * @param string $context View or edit context. |
|
| 100 | - * @return string |
|
| 101 | - */ |
|
| 102 | - public function get_raw_name( $context = 'view' ) { |
|
| 103 | - return parent::get_name( $context ); |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * Get the item description. |
|
| 108 | - * |
|
| 109 | - * @since 1.0.19 |
|
| 110 | - * @param string $context View or edit context. |
|
| 111 | - * @return string |
|
| 112 | - */ |
|
| 113 | - public function get_description( $context = 'view' ) { |
|
| 114 | - |
|
| 115 | - if ( isset( $this->custom_description ) ) { |
|
| 116 | - return $this->custom_description; |
|
| 117 | - } |
|
| 118 | - |
|
| 119 | - return parent::get_description( $context ); |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * Returns the sub total. |
|
| 124 | - * |
|
| 125 | - * @since 1.0.19 |
|
| 126 | - * @param string $context View or edit context. |
|
| 127 | - * @return int |
|
| 128 | - */ |
|
| 129 | - public function get_sub_total( $context = 'view' ) { |
|
| 130 | - return $this->get_quantity( $context ) * $this->get_initial_price( $context ); |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Returns the recurring sub total. |
|
| 135 | - * |
|
| 136 | - * @since 1.0.19 |
|
| 137 | - * @param string $context View or edit context. |
|
| 138 | - * @return int |
|
| 139 | - */ |
|
| 140 | - public function get_recurring_sub_total( $context = 'view' ) { |
|
| 141 | - return $this->get_quantity( $context ) * $this->get_price( $context ); |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * @deprecated |
|
| 146 | - */ |
|
| 147 | - public function get_qantity( $context = 'view' ) { |
|
| 148 | - return $this->get_quantity( $context ); |
|
| 149 | - } |
|
| 150 | - |
|
| 151 | - /** |
|
| 152 | - * Get the item quantity. |
|
| 153 | - * |
|
| 154 | - * @since 1.0.19 |
|
| 155 | - * @param string $context View or edit context. |
|
| 156 | - * @return int |
|
| 157 | - */ |
|
| 158 | - public function get_quantity( $context = 'view' ) { |
|
| 159 | - $quantity = (int) $this->quantity; |
|
| 160 | - |
|
| 161 | - if ( empty( $quantity ) || 1 > $quantity ) { |
|
| 162 | - $quantity = 1; |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - if ( 'view' == $context ) { |
|
| 166 | - return apply_filters( 'getpaid_payment_form_item_quantity', $quantity, $this ); |
|
| 167 | - } |
|
| 168 | - |
|
| 169 | - return $quantity; |
|
| 170 | - |
|
| 171 | - } |
|
| 172 | - |
|
| 173 | - /** |
|
| 174 | - * Get the item meta data. |
|
| 175 | - * |
|
| 176 | - * @since 1.0.19 |
|
| 177 | - * @param string $context View or edit context. |
|
| 178 | - * @return meta |
|
| 179 | - */ |
|
| 180 | - public function get_item_meta( $context = 'view' ) { |
|
| 181 | - $meta = $this->meta; |
|
| 182 | - |
|
| 183 | - if ( 'view' == $context ) { |
|
| 184 | - return apply_filters( 'getpaid_payment_form_item_meta', $meta, $this ); |
|
| 185 | - } |
|
| 186 | - |
|
| 187 | - return $meta; |
|
| 188 | - |
|
| 189 | - } |
|
| 190 | - |
|
| 191 | - /** |
|
| 192 | - * Returns whether or not customers can update the item quantity. |
|
| 193 | - * |
|
| 194 | - * @since 1.0.19 |
|
| 195 | - * @param string $context View or edit context. |
|
| 196 | - * @return bool |
|
| 197 | - */ |
|
| 198 | - public function get_allow_quantities( $context = 'view' ) { |
|
| 199 | - $allow_quantities = (bool) $this->allow_quantities; |
|
| 200 | - |
|
| 201 | - if ( 'view' == $context ) { |
|
| 202 | - return apply_filters( 'getpaid_payment_form_item_allow_quantities', $allow_quantities, $this ); |
|
| 203 | - } |
|
| 204 | - |
|
| 205 | - return $allow_quantities; |
|
| 206 | - |
|
| 207 | - } |
|
| 208 | - |
|
| 209 | - /** |
|
| 210 | - * Returns whether or not the item is required. |
|
| 211 | - * |
|
| 212 | - * @since 1.0.19 |
|
| 213 | - * @param string $context View or edit context. |
|
| 214 | - * @return bool |
|
| 215 | - */ |
|
| 216 | - public function get_is_required( $context = 'view' ) { |
|
| 217 | - $is_required = (bool) $this->is_required; |
|
| 218 | - |
|
| 219 | - if ( 'view' == $context ) { |
|
| 220 | - return apply_filters( 'getpaid_payment_form_item_is_required', $is_required, $this ); |
|
| 221 | - } |
|
| 222 | - |
|
| 223 | - return $is_required; |
|
| 224 | - |
|
| 225 | - } |
|
| 226 | - |
|
| 227 | - /** |
|
| 228 | - * Prepares form data for use. |
|
| 229 | - * |
|
| 230 | - * @since 1.0.19 |
|
| 231 | - * @return array |
|
| 232 | - */ |
|
| 233 | - public function prepare_data_for_use() { |
|
| 234 | - |
|
| 235 | - return array( |
|
| 236 | - 'title' => sanitize_text_field( $this->get_name() ), |
|
| 237 | - 'id' => $this->get_id(), |
|
| 238 | - 'price' => $this->get_price(), |
|
| 239 | - 'recurring' => $this->is_recurring(), |
|
| 240 | - 'description' => $this->get_description(), |
|
| 241 | - 'allow_quantities' => $this->allows_quantities(), |
|
| 242 | - 'required' => $this->is_required(), |
|
| 243 | - ); |
|
| 244 | - |
|
| 245 | - } |
|
| 246 | - |
|
| 247 | - /** |
|
| 248 | - * Prepares form data for ajax use. |
|
| 249 | - * |
|
| 250 | - * @since 1.0.19 |
|
| 251 | - * @return array |
|
| 252 | - */ |
|
| 253 | - public function prepare_data_for_invoice_edit_ajax( $currency = '' ) { |
|
| 254 | - |
|
| 255 | - $description = getpaid_item_recurring_price_help_text( $this, $currency ); |
|
| 256 | - |
|
| 257 | - if ( $description ) { |
|
| 258 | - $description = "<div class='getpaid-subscription-help-text'>$description</div>"; |
|
| 259 | - } |
|
| 260 | - |
|
| 261 | - return array( |
|
| 262 | - 'id' => $this->get_id(), |
|
| 263 | - 'texts' => array( |
|
| 264 | - 'item-name' => sanitize_text_field( $this->get_name() ), |
|
| 265 | - 'item-description' => wp_kses_post( $this->get_description() ) . $description, |
|
| 266 | - 'item-quantity' => absint( $this->get_quantity() ), |
|
| 267 | - 'item-price' => wpinv_price( wpinv_format_amount ( $this->get_price() ), $currency ), |
|
| 268 | - 'item-total' => wpinv_price( wpinv_format_amount( $this->get_sub_total() ), $currency ), |
|
| 269 | - ), |
|
| 270 | - 'inputs' => array( |
|
| 271 | - 'item-id' => $this->get_id(), |
|
| 272 | - 'item-name' => sanitize_text_field( $this->get_name() ), |
|
| 273 | - 'item-description' => wp_kses_post( $this->get_description() ), |
|
| 274 | - 'item-quantity' => absint( $this->get_quantity() ), |
|
| 275 | - 'item-price' => $this->get_price(), |
|
| 276 | - ) |
|
| 277 | - ); |
|
| 278 | - |
|
| 279 | - } |
|
| 280 | - |
|
| 281 | - /** |
|
| 282 | - * Prepares form data for saving (cart_details). |
|
| 283 | - * |
|
| 284 | - * @since 1.0.19 |
|
| 285 | - * @return array |
|
| 286 | - */ |
|
| 287 | - public function prepare_data_for_saving() { |
|
| 288 | - |
|
| 289 | - return array( |
|
| 290 | - 'post_id' => $this->invoice_id, |
|
| 291 | - 'item_id' => $this->get_id(), |
|
| 292 | - 'item_name' => sanitize_text_field( $this->get_raw_name() ), |
|
| 293 | - 'item_description' => $this->get_description(), |
|
| 294 | - 'tax' => $this->item_tax, |
|
| 295 | - 'item_price' => $this->get_price(), |
|
| 296 | - 'quantity' => (int) $this->get_quantity(), |
|
| 297 | - 'discount' => $this->item_discount, |
|
| 298 | - 'subtotal' => $this->get_sub_total(), |
|
| 299 | - 'price' => $this->get_sub_total() + $this->item_tax + $this->item_discount, |
|
| 300 | - 'meta' => $this->get_item_meta(), |
|
| 301 | - ); |
|
| 302 | - |
|
| 303 | - } |
|
| 84 | + * Get the item name. |
|
| 85 | + * |
|
| 86 | + * @since 1.0.19 |
|
| 87 | + * @param string $context View or edit context. |
|
| 88 | + * @return string |
|
| 89 | + */ |
|
| 90 | + public function get_name( $context = 'view' ) { |
|
| 91 | + $name = parent::get_name( $context ); |
|
| 92 | + return $name . wpinv_get_item_suffix( $this ); |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + /** |
|
| 96 | + * Get the item name without a suffix. |
|
| 97 | + * |
|
| 98 | + * @since 1.0.19 |
|
| 99 | + * @param string $context View or edit context. |
|
| 100 | + * @return string |
|
| 101 | + */ |
|
| 102 | + public function get_raw_name( $context = 'view' ) { |
|
| 103 | + return parent::get_name( $context ); |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * Get the item description. |
|
| 108 | + * |
|
| 109 | + * @since 1.0.19 |
|
| 110 | + * @param string $context View or edit context. |
|
| 111 | + * @return string |
|
| 112 | + */ |
|
| 113 | + public function get_description( $context = 'view' ) { |
|
| 114 | + |
|
| 115 | + if ( isset( $this->custom_description ) ) { |
|
| 116 | + return $this->custom_description; |
|
| 117 | + } |
|
| 118 | + |
|
| 119 | + return parent::get_description( $context ); |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * Returns the sub total. |
|
| 124 | + * |
|
| 125 | + * @since 1.0.19 |
|
| 126 | + * @param string $context View or edit context. |
|
| 127 | + * @return int |
|
| 128 | + */ |
|
| 129 | + public function get_sub_total( $context = 'view' ) { |
|
| 130 | + return $this->get_quantity( $context ) * $this->get_initial_price( $context ); |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Returns the recurring sub total. |
|
| 135 | + * |
|
| 136 | + * @since 1.0.19 |
|
| 137 | + * @param string $context View or edit context. |
|
| 138 | + * @return int |
|
| 139 | + */ |
|
| 140 | + public function get_recurring_sub_total( $context = 'view' ) { |
|
| 141 | + return $this->get_quantity( $context ) * $this->get_price( $context ); |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * @deprecated |
|
| 146 | + */ |
|
| 147 | + public function get_qantity( $context = 'view' ) { |
|
| 148 | + return $this->get_quantity( $context ); |
|
| 149 | + } |
|
| 150 | + |
|
| 151 | + /** |
|
| 152 | + * Get the item quantity. |
|
| 153 | + * |
|
| 154 | + * @since 1.0.19 |
|
| 155 | + * @param string $context View or edit context. |
|
| 156 | + * @return int |
|
| 157 | + */ |
|
| 158 | + public function get_quantity( $context = 'view' ) { |
|
| 159 | + $quantity = (int) $this->quantity; |
|
| 160 | + |
|
| 161 | + if ( empty( $quantity ) || 1 > $quantity ) { |
|
| 162 | + $quantity = 1; |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + if ( 'view' == $context ) { |
|
| 166 | + return apply_filters( 'getpaid_payment_form_item_quantity', $quantity, $this ); |
|
| 167 | + } |
|
| 168 | + |
|
| 169 | + return $quantity; |
|
| 170 | + |
|
| 171 | + } |
|
| 172 | + |
|
| 173 | + /** |
|
| 174 | + * Get the item meta data. |
|
| 175 | + * |
|
| 176 | + * @since 1.0.19 |
|
| 177 | + * @param string $context View or edit context. |
|
| 178 | + * @return meta |
|
| 179 | + */ |
|
| 180 | + public function get_item_meta( $context = 'view' ) { |
|
| 181 | + $meta = $this->meta; |
|
| 182 | + |
|
| 183 | + if ( 'view' == $context ) { |
|
| 184 | + return apply_filters( 'getpaid_payment_form_item_meta', $meta, $this ); |
|
| 185 | + } |
|
| 186 | + |
|
| 187 | + return $meta; |
|
| 188 | + |
|
| 189 | + } |
|
| 190 | + |
|
| 191 | + /** |
|
| 192 | + * Returns whether or not customers can update the item quantity. |
|
| 193 | + * |
|
| 194 | + * @since 1.0.19 |
|
| 195 | + * @param string $context View or edit context. |
|
| 196 | + * @return bool |
|
| 197 | + */ |
|
| 198 | + public function get_allow_quantities( $context = 'view' ) { |
|
| 199 | + $allow_quantities = (bool) $this->allow_quantities; |
|
| 200 | + |
|
| 201 | + if ( 'view' == $context ) { |
|
| 202 | + return apply_filters( 'getpaid_payment_form_item_allow_quantities', $allow_quantities, $this ); |
|
| 203 | + } |
|
| 204 | + |
|
| 205 | + return $allow_quantities; |
|
| 206 | + |
|
| 207 | + } |
|
| 208 | + |
|
| 209 | + /** |
|
| 210 | + * Returns whether or not the item is required. |
|
| 211 | + * |
|
| 212 | + * @since 1.0.19 |
|
| 213 | + * @param string $context View or edit context. |
|
| 214 | + * @return bool |
|
| 215 | + */ |
|
| 216 | + public function get_is_required( $context = 'view' ) { |
|
| 217 | + $is_required = (bool) $this->is_required; |
|
| 218 | + |
|
| 219 | + if ( 'view' == $context ) { |
|
| 220 | + return apply_filters( 'getpaid_payment_form_item_is_required', $is_required, $this ); |
|
| 221 | + } |
|
| 222 | + |
|
| 223 | + return $is_required; |
|
| 224 | + |
|
| 225 | + } |
|
| 226 | + |
|
| 227 | + /** |
|
| 228 | + * Prepares form data for use. |
|
| 229 | + * |
|
| 230 | + * @since 1.0.19 |
|
| 231 | + * @return array |
|
| 232 | + */ |
|
| 233 | + public function prepare_data_for_use() { |
|
| 234 | + |
|
| 235 | + return array( |
|
| 236 | + 'title' => sanitize_text_field( $this->get_name() ), |
|
| 237 | + 'id' => $this->get_id(), |
|
| 238 | + 'price' => $this->get_price(), |
|
| 239 | + 'recurring' => $this->is_recurring(), |
|
| 240 | + 'description' => $this->get_description(), |
|
| 241 | + 'allow_quantities' => $this->allows_quantities(), |
|
| 242 | + 'required' => $this->is_required(), |
|
| 243 | + ); |
|
| 244 | + |
|
| 245 | + } |
|
| 246 | + |
|
| 247 | + /** |
|
| 248 | + * Prepares form data for ajax use. |
|
| 249 | + * |
|
| 250 | + * @since 1.0.19 |
|
| 251 | + * @return array |
|
| 252 | + */ |
|
| 253 | + public function prepare_data_for_invoice_edit_ajax( $currency = '' ) { |
|
| 254 | + |
|
| 255 | + $description = getpaid_item_recurring_price_help_text( $this, $currency ); |
|
| 256 | + |
|
| 257 | + if ( $description ) { |
|
| 258 | + $description = "<div class='getpaid-subscription-help-text'>$description</div>"; |
|
| 259 | + } |
|
| 260 | + |
|
| 261 | + return array( |
|
| 262 | + 'id' => $this->get_id(), |
|
| 263 | + 'texts' => array( |
|
| 264 | + 'item-name' => sanitize_text_field( $this->get_name() ), |
|
| 265 | + 'item-description' => wp_kses_post( $this->get_description() ) . $description, |
|
| 266 | + 'item-quantity' => absint( $this->get_quantity() ), |
|
| 267 | + 'item-price' => wpinv_price( wpinv_format_amount ( $this->get_price() ), $currency ), |
|
| 268 | + 'item-total' => wpinv_price( wpinv_format_amount( $this->get_sub_total() ), $currency ), |
|
| 269 | + ), |
|
| 270 | + 'inputs' => array( |
|
| 271 | + 'item-id' => $this->get_id(), |
|
| 272 | + 'item-name' => sanitize_text_field( $this->get_name() ), |
|
| 273 | + 'item-description' => wp_kses_post( $this->get_description() ), |
|
| 274 | + 'item-quantity' => absint( $this->get_quantity() ), |
|
| 275 | + 'item-price' => $this->get_price(), |
|
| 276 | + ) |
|
| 277 | + ); |
|
| 278 | + |
|
| 279 | + } |
|
| 280 | + |
|
| 281 | + /** |
|
| 282 | + * Prepares form data for saving (cart_details). |
|
| 283 | + * |
|
| 284 | + * @since 1.0.19 |
|
| 285 | + * @return array |
|
| 286 | + */ |
|
| 287 | + public function prepare_data_for_saving() { |
|
| 288 | + |
|
| 289 | + return array( |
|
| 290 | + 'post_id' => $this->invoice_id, |
|
| 291 | + 'item_id' => $this->get_id(), |
|
| 292 | + 'item_name' => sanitize_text_field( $this->get_raw_name() ), |
|
| 293 | + 'item_description' => $this->get_description(), |
|
| 294 | + 'tax' => $this->item_tax, |
|
| 295 | + 'item_price' => $this->get_price(), |
|
| 296 | + 'quantity' => (int) $this->get_quantity(), |
|
| 297 | + 'discount' => $this->item_discount, |
|
| 298 | + 'subtotal' => $this->get_sub_total(), |
|
| 299 | + 'price' => $this->get_sub_total() + $this->item_tax + $this->item_discount, |
|
| 300 | + 'meta' => $this->get_item_meta(), |
|
| 301 | + ); |
|
| 302 | + |
|
| 303 | + } |
|
| 304 | 304 | |
| 305 | 305 | /* |
| 306 | 306 | |-------------------------------------------------------------------------- |
@@ -312,70 +312,70 @@ discard block |
||
| 312 | 312 | | object. |
| 313 | 313 | */ |
| 314 | 314 | |
| 315 | - /** |
|
| 316 | - * Set the item qantity. |
|
| 317 | - * |
|
| 318 | - * @since 1.0.19 |
|
| 319 | - * @param int $quantity The item quantity. |
|
| 320 | - */ |
|
| 321 | - public function set_quantity( $quantity ) { |
|
| 322 | - |
|
| 323 | - if ( empty( $quantity ) || ! is_numeric( $quantity ) ) { |
|
| 324 | - $quantity = 1; |
|
| 325 | - } |
|
| 326 | - |
|
| 327 | - $this->quantity = (int) $quantity; |
|
| 328 | - |
|
| 329 | - } |
|
| 330 | - |
|
| 331 | - /** |
|
| 332 | - * Set the item meta data. |
|
| 333 | - * |
|
| 334 | - * @since 1.0.19 |
|
| 335 | - * @param array $meta The item meta data. |
|
| 336 | - */ |
|
| 337 | - public function set_item_meta( $meta ) { |
|
| 338 | - $this->meta = maybe_unserialize( $meta ); |
|
| 339 | - } |
|
| 340 | - |
|
| 341 | - /** |
|
| 342 | - * Set whether or not the quantities are allowed. |
|
| 343 | - * |
|
| 344 | - * @since 1.0.19 |
|
| 345 | - * @param bool $allow_quantities |
|
| 346 | - */ |
|
| 347 | - public function set_allow_quantities( $allow_quantities ) { |
|
| 348 | - $this->allow_quantities = (bool) $allow_quantities; |
|
| 349 | - } |
|
| 350 | - |
|
| 351 | - /** |
|
| 352 | - * Set whether or not the item is required. |
|
| 353 | - * |
|
| 354 | - * @since 1.0.19 |
|
| 355 | - * @param bool $is_required |
|
| 356 | - */ |
|
| 357 | - public function set_is_required( $is_required ) { |
|
| 358 | - $this->is_required = (bool) $is_required; |
|
| 359 | - } |
|
| 360 | - |
|
| 361 | - /** |
|
| 362 | - * Sets the custom item description. |
|
| 363 | - * |
|
| 364 | - * @since 1.0.19 |
|
| 365 | - * @param string $description |
|
| 366 | - */ |
|
| 367 | - public function set_custom_description( $description ) { |
|
| 368 | - $this->custom_description = $description; |
|
| 369 | - } |
|
| 315 | + /** |
|
| 316 | + * Set the item qantity. |
|
| 317 | + * |
|
| 318 | + * @since 1.0.19 |
|
| 319 | + * @param int $quantity The item quantity. |
|
| 320 | + */ |
|
| 321 | + public function set_quantity( $quantity ) { |
|
| 322 | + |
|
| 323 | + if ( empty( $quantity ) || ! is_numeric( $quantity ) ) { |
|
| 324 | + $quantity = 1; |
|
| 325 | + } |
|
| 326 | + |
|
| 327 | + $this->quantity = (int) $quantity; |
|
| 328 | + |
|
| 329 | + } |
|
| 330 | + |
|
| 331 | + /** |
|
| 332 | + * Set the item meta data. |
|
| 333 | + * |
|
| 334 | + * @since 1.0.19 |
|
| 335 | + * @param array $meta The item meta data. |
|
| 336 | + */ |
|
| 337 | + public function set_item_meta( $meta ) { |
|
| 338 | + $this->meta = maybe_unserialize( $meta ); |
|
| 339 | + } |
|
| 340 | + |
|
| 341 | + /** |
|
| 342 | + * Set whether or not the quantities are allowed. |
|
| 343 | + * |
|
| 344 | + * @since 1.0.19 |
|
| 345 | + * @param bool $allow_quantities |
|
| 346 | + */ |
|
| 347 | + public function set_allow_quantities( $allow_quantities ) { |
|
| 348 | + $this->allow_quantities = (bool) $allow_quantities; |
|
| 349 | + } |
|
| 350 | + |
|
| 351 | + /** |
|
| 352 | + * Set whether or not the item is required. |
|
| 353 | + * |
|
| 354 | + * @since 1.0.19 |
|
| 355 | + * @param bool $is_required |
|
| 356 | + */ |
|
| 357 | + public function set_is_required( $is_required ) { |
|
| 358 | + $this->is_required = (bool) $is_required; |
|
| 359 | + } |
|
| 360 | + |
|
| 361 | + /** |
|
| 362 | + * Sets the custom item description. |
|
| 363 | + * |
|
| 364 | + * @since 1.0.19 |
|
| 365 | + * @param string $description |
|
| 366 | + */ |
|
| 367 | + public function set_custom_description( $description ) { |
|
| 368 | + $this->custom_description = $description; |
|
| 369 | + } |
|
| 370 | 370 | |
| 371 | 371 | /** |
| 372 | 372 | * We do not want to save items to the database. |
| 373 | 373 | * |
| 374 | - * @return int item id |
|
| 374 | + * @return int item id |
|
| 375 | 375 | */ |
| 376 | 376 | public function save( $data = array() ) { |
| 377 | 377 | return $this->get_id(); |
| 378 | - } |
|
| 378 | + } |
|
| 379 | 379 | |
| 380 | 380 | /* |
| 381 | 381 | |-------------------------------------------------------------------------- |
@@ -387,23 +387,23 @@ discard block |
||
| 387 | 387 | */ |
| 388 | 388 | |
| 389 | 389 | /** |
| 390 | - * Checks whether the item has enabled dynamic pricing. |
|
| 391 | - * |
|
| 392 | - * @since 1.0.19 |
|
| 393 | - * @return bool |
|
| 394 | - */ |
|
| 395 | - public function is_required() { |
|
| 390 | + * Checks whether the item has enabled dynamic pricing. |
|
| 391 | + * |
|
| 392 | + * @since 1.0.19 |
|
| 393 | + * @return bool |
|
| 394 | + */ |
|
| 395 | + public function is_required() { |
|
| 396 | 396 | return (bool) $this->get_is_required(); |
| 397 | - } |
|
| 398 | - |
|
| 399 | - /** |
|
| 400 | - * Checks whether users can edit the quantities. |
|
| 401 | - * |
|
| 402 | - * @since 1.0.19 |
|
| 403 | - * @return bool |
|
| 404 | - */ |
|
| 405 | - public function allows_quantities() { |
|
| 397 | + } |
|
| 398 | + |
|
| 399 | + /** |
|
| 400 | + * Checks whether users can edit the quantities. |
|
| 401 | + * |
|
| 402 | + * @since 1.0.19 |
|
| 403 | + * @return bool |
|
| 404 | + */ |
|
| 405 | + public function allows_quantities() { |
|
| 406 | 406 | return (bool) $this->get_allow_quantities(); |
| 407 | - } |
|
| 407 | + } |
|
| 408 | 408 | |
| 409 | 409 | } |
@@ -12,77 +12,77 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Payment_Form_Submission_Items { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * Submission items. |
|
| 17 | - * @var GetPaid_Form_Item[] |
|
| 18 | - */ |
|
| 19 | - public $items = array(); |
|
| 15 | + /** |
|
| 16 | + * Submission items. |
|
| 17 | + * @var GetPaid_Form_Item[] |
|
| 18 | + */ |
|
| 19 | + public $items = array(); |
|
| 20 | 20 | |
| 21 | 21 | /** |
| 22 | - * Class constructor |
|
| 23 | - * |
|
| 24 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 25 | - */ |
|
| 26 | - public function __construct( $submission ) { |
|
| 22 | + * Class constructor |
|
| 23 | + * |
|
| 24 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 25 | + */ |
|
| 26 | + public function __construct( $submission ) { |
|
| 27 | 27 | |
| 28 | - $data = $submission->get_data(); |
|
| 29 | - $payment_form = $submission->get_payment_form(); |
|
| 28 | + $data = $submission->get_data(); |
|
| 29 | + $payment_form = $submission->get_payment_form(); |
|
| 30 | 30 | |
| 31 | - // Prepare the selected items. |
|
| 32 | - $selected_items = array(); |
|
| 33 | - if ( ! empty( $data['getpaid-items'] ) ) { |
|
| 34 | - $selected_items = wpinv_clean( $data['getpaid-items'] ); |
|
| 35 | - } |
|
| 31 | + // Prepare the selected items. |
|
| 32 | + $selected_items = array(); |
|
| 33 | + if ( ! empty( $data['getpaid-items'] ) ) { |
|
| 34 | + $selected_items = wpinv_clean( $data['getpaid-items'] ); |
|
| 35 | + } |
|
| 36 | 36 | |
| 37 | - // For default forms, ensure that an item has been set. |
|
| 38 | - if ( $payment_form->is_default() && ! $submission->has_invoice() ) { |
|
| 39 | - $payment_form->set_items( $selected_items ); |
|
| 40 | - } |
|
| 37 | + // For default forms, ensure that an item has been set. |
|
| 38 | + if ( $payment_form->is_default() && ! $submission->has_invoice() ) { |
|
| 39 | + $payment_form->set_items( $selected_items ); |
|
| 40 | + } |
|
| 41 | 41 | |
| 42 | - // Process each individual item. |
|
| 43 | - foreach ( $payment_form->get_items() as $item ) { |
|
| 44 | - $this->process_item( $item, $selected_items ); |
|
| 45 | - } |
|
| 42 | + // Process each individual item. |
|
| 43 | + foreach ( $payment_form->get_items() as $item ) { |
|
| 44 | + $this->process_item( $item, $selected_items ); |
|
| 45 | + } |
|
| 46 | 46 | |
| 47 | - } |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * Process a single item. |
|
| 51 | - * |
|
| 52 | - * @param GetPaid_Form_Item $item |
|
| 53 | - * @param array $selected_items |
|
| 54 | - */ |
|
| 55 | - public function process_item( $item, $selected_items ) { |
|
| 49 | + /** |
|
| 50 | + * Process a single item. |
|
| 51 | + * |
|
| 52 | + * @param GetPaid_Form_Item $item |
|
| 53 | + * @param array $selected_items |
|
| 54 | + */ |
|
| 55 | + public function process_item( $item, $selected_items ) { |
|
| 56 | 56 | |
| 57 | - // Abort if this is an optional item and it has not been selected. |
|
| 58 | - if ( ! $item->is_required() && ! isset( $selected_items[ $item->get_id() ] ) ) { |
|
| 59 | - return; |
|
| 60 | - } |
|
| 57 | + // Abort if this is an optional item and it has not been selected. |
|
| 58 | + if ( ! $item->is_required() && ! isset( $selected_items[ $item->get_id() ] ) ) { |
|
| 59 | + return; |
|
| 60 | + } |
|
| 61 | 61 | |
| 62 | - // (maybe) let customers change the quantities and prices. |
|
| 63 | - if ( isset( $selected_items[ $item->get_id() ] ) ) { |
|
| 62 | + // (maybe) let customers change the quantities and prices. |
|
| 63 | + if ( isset( $selected_items[ $item->get_id() ] ) ) { |
|
| 64 | 64 | |
| 65 | - // Maybe change the quantities. |
|
| 66 | - if ( $item->allows_quantities() ) { |
|
| 67 | - $item->set_quantity( (int) $selected_items[ $item->get_id() ]['quantity'] ); |
|
| 68 | - } |
|
| 65 | + // Maybe change the quantities. |
|
| 66 | + if ( $item->allows_quantities() ) { |
|
| 67 | + $item->set_quantity( (int) $selected_items[ $item->get_id() ]['quantity'] ); |
|
| 68 | + } |
|
| 69 | 69 | |
| 70 | - // Maybe change the price. |
|
| 71 | - if ( $item->user_can_set_their_price() ) { |
|
| 72 | - $price = (float) wpinv_sanitize_amount( $selected_items[ $item->get_id() ]['price'] ); |
|
| 70 | + // Maybe change the price. |
|
| 71 | + if ( $item->user_can_set_their_price() ) { |
|
| 72 | + $price = (float) wpinv_sanitize_amount( $selected_items[ $item->get_id() ]['price'] ); |
|
| 73 | 73 | |
| 74 | - // But don't get lower than the minimum price. |
|
| 75 | - $price = max( $price, $item->get_minimum_price() ); |
|
| 74 | + // But don't get lower than the minimum price. |
|
| 75 | + $price = max( $price, $item->get_minimum_price() ); |
|
| 76 | 76 | |
| 77 | - $item->set_price( $price ); |
|
| 77 | + $item->set_price( $price ); |
|
| 78 | 78 | |
| 79 | - } |
|
| 79 | + } |
|
| 80 | 80 | |
| 81 | - } |
|
| 81 | + } |
|
| 82 | 82 | |
| 83 | - // Save the item. |
|
| 84 | - $this->items[] = $item; |
|
| 83 | + // Save the item. |
|
| 84 | + $this->items[] = $item; |
|
| 85 | 85 | |
| 86 | - } |
|
| 86 | + } |
|
| 87 | 87 | |
| 88 | 88 | } |
@@ -1,6 +1,6 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | if ( ! defined( 'ABSPATH' ) ) { |
| 3 | - exit; |
|
| 3 | + exit; |
|
| 4 | 4 | } |
| 5 | 5 | |
| 6 | 6 | /** |
@@ -10,55 +10,55 @@ discard block |
||
| 10 | 10 | class GetPaid_Payment_Form extends GetPaid_Data { |
| 11 | 11 | |
| 12 | 12 | /** |
| 13 | - * Which data store to load. |
|
| 14 | - * |
|
| 15 | - * @var string |
|
| 16 | - */ |
|
| 13 | + * Which data store to load. |
|
| 14 | + * |
|
| 15 | + * @var string |
|
| 16 | + */ |
|
| 17 | 17 | protected $data_store_name = 'payment_form'; |
| 18 | 18 | |
| 19 | 19 | /** |
| 20 | - * This is the name of this object type. |
|
| 21 | - * |
|
| 22 | - * @var string |
|
| 23 | - */ |
|
| 24 | - protected $object_type = 'payment_form'; |
|
| 20 | + * This is the name of this object type. |
|
| 21 | + * |
|
| 22 | + * @var string |
|
| 23 | + */ |
|
| 24 | + protected $object_type = 'payment_form'; |
|
| 25 | 25 | |
| 26 | 26 | /** |
| 27 | - * Form Data array. This is the core form data exposed in APIs. |
|
| 28 | - * |
|
| 29 | - * @since 1.0.19 |
|
| 30 | - * @var array |
|
| 31 | - */ |
|
| 32 | - protected $data = array( |
|
| 33 | - 'status' => 'draft', |
|
| 34 | - 'version' => '', |
|
| 35 | - 'date_created' => null, |
|
| 27 | + * Form Data array. This is the core form data exposed in APIs. |
|
| 28 | + * |
|
| 29 | + * @since 1.0.19 |
|
| 30 | + * @var array |
|
| 31 | + */ |
|
| 32 | + protected $data = array( |
|
| 33 | + 'status' => 'draft', |
|
| 34 | + 'version' => '', |
|
| 35 | + 'date_created' => null, |
|
| 36 | 36 | 'date_modified' => null, |
| 37 | 37 | 'name' => '', |
| 38 | 38 | 'author' => 1, |
| 39 | 39 | 'elements' => null, |
| 40 | - 'items' => null, |
|
| 41 | - 'earned' => 0, |
|
| 42 | - 'refunded' => 0, |
|
| 43 | - 'cancelled' => 0, |
|
| 44 | - 'failed' => 0, |
|
| 45 | - ); |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * Stores meta in cache for future reads. |
|
| 49 | - * |
|
| 50 | - * A group must be set to to enable caching. |
|
| 51 | - * |
|
| 52 | - * @var string |
|
| 53 | - */ |
|
| 54 | - protected $cache_group = 'getpaid_forms'; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * Stores a reference to the invoice if the form is for an invoice.. |
|
| 58 | - * |
|
| 59 | - * @var WPInv_Invoice |
|
| 60 | - */ |
|
| 61 | - public $invoice = 0; |
|
| 40 | + 'items' => null, |
|
| 41 | + 'earned' => 0, |
|
| 42 | + 'refunded' => 0, |
|
| 43 | + 'cancelled' => 0, |
|
| 44 | + 'failed' => 0, |
|
| 45 | + ); |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * Stores meta in cache for future reads. |
|
| 49 | + * |
|
| 50 | + * A group must be set to to enable caching. |
|
| 51 | + * |
|
| 52 | + * @var string |
|
| 53 | + */ |
|
| 54 | + protected $cache_group = 'getpaid_forms'; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * Stores a reference to the invoice if the form is for an invoice.. |
|
| 58 | + * |
|
| 59 | + * @var WPInv_Invoice |
|
| 60 | + */ |
|
| 61 | + public $invoice = 0; |
|
| 62 | 62 | |
| 63 | 63 | /** |
| 64 | 64 | * Stores a reference to the original WP_Post object |
@@ -68,35 +68,35 @@ discard block |
||
| 68 | 68 | protected $post = null; |
| 69 | 69 | |
| 70 | 70 | /** |
| 71 | - * Get the form if ID is passed, otherwise the form is new and empty. |
|
| 72 | - * |
|
| 73 | - * @param int|object|GetPaid_Payment_Form|WP_Post $form Form to read. |
|
| 74 | - */ |
|
| 75 | - public function __construct( $form = 0 ) { |
|
| 76 | - parent::__construct( $form ); |
|
| 71 | + * Get the form if ID is passed, otherwise the form is new and empty. |
|
| 72 | + * |
|
| 73 | + * @param int|object|GetPaid_Payment_Form|WP_Post $form Form to read. |
|
| 74 | + */ |
|
| 75 | + public function __construct( $form = 0 ) { |
|
| 76 | + parent::__construct( $form ); |
|
| 77 | 77 | |
| 78 | - if ( is_numeric( $form ) && $form > 0 ) { |
|
| 79 | - $this->set_id( $form ); |
|
| 80 | - } elseif ( $form instanceof self ) { |
|
| 78 | + if ( is_numeric( $form ) && $form > 0 ) { |
|
| 79 | + $this->set_id( $form ); |
|
| 80 | + } elseif ( $form instanceof self ) { |
|
| 81 | 81 | |
| 82 | - $this->set_id( $form->get_id() ); |
|
| 83 | - $this->invoice = $form->invoice; |
|
| 82 | + $this->set_id( $form->get_id() ); |
|
| 83 | + $this->invoice = $form->invoice; |
|
| 84 | 84 | |
| 85 | - } elseif ( ! empty( $form->ID ) ) { |
|
| 86 | - $this->set_id( $form->ID ); |
|
| 87 | - } else { |
|
| 88 | - $this->set_object_read( true ); |
|
| 89 | - } |
|
| 85 | + } elseif ( ! empty( $form->ID ) ) { |
|
| 86 | + $this->set_id( $form->ID ); |
|
| 87 | + } else { |
|
| 88 | + $this->set_object_read( true ); |
|
| 89 | + } |
|
| 90 | 90 | |
| 91 | 91 | // Load the datastore. |
| 92 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 92 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 93 | 93 | |
| 94 | - if ( $this->get_id() > 0 ) { |
|
| 94 | + if ( $this->get_id() > 0 ) { |
|
| 95 | 95 | $this->post = get_post( $this->get_id() ); |
| 96 | - $this->data_store->read( $this ); |
|
| 96 | + $this->data_store->read( $this ); |
|
| 97 | 97 | } |
| 98 | 98 | |
| 99 | - } |
|
| 99 | + } |
|
| 100 | 100 | |
| 101 | 101 | /* |
| 102 | 102 | |-------------------------------------------------------------------------- |
@@ -114,351 +114,351 @@ discard block |
||
| 114 | 114 | */ |
| 115 | 115 | |
| 116 | 116 | /** |
| 117 | - * Get plugin version when the form was created. |
|
| 118 | - * |
|
| 119 | - * @since 1.0.19 |
|
| 120 | - * @param string $context View or edit context. |
|
| 121 | - * @return string |
|
| 122 | - */ |
|
| 123 | - public function get_version( $context = 'view' ) { |
|
| 124 | - return $this->get_prop( 'version', $context ); |
|
| 117 | + * Get plugin version when the form was created. |
|
| 118 | + * |
|
| 119 | + * @since 1.0.19 |
|
| 120 | + * @param string $context View or edit context. |
|
| 121 | + * @return string |
|
| 122 | + */ |
|
| 123 | + public function get_version( $context = 'view' ) { |
|
| 124 | + return $this->get_prop( 'version', $context ); |
|
| 125 | 125 | } |
| 126 | 126 | |
| 127 | 127 | /** |
| 128 | - * Get date when the form was created. |
|
| 129 | - * |
|
| 130 | - * @since 1.0.19 |
|
| 131 | - * @param string $context View or edit context. |
|
| 132 | - * @return string |
|
| 133 | - */ |
|
| 134 | - public function get_date_created( $context = 'view' ) { |
|
| 135 | - return $this->get_prop( 'date_created', $context ); |
|
| 128 | + * Get date when the form was created. |
|
| 129 | + * |
|
| 130 | + * @since 1.0.19 |
|
| 131 | + * @param string $context View or edit context. |
|
| 132 | + * @return string |
|
| 133 | + */ |
|
| 134 | + public function get_date_created( $context = 'view' ) { |
|
| 135 | + return $this->get_prop( 'date_created', $context ); |
|
| 136 | 136 | } |
| 137 | 137 | |
| 138 | 138 | /** |
| 139 | - * Get GMT date when the form was created. |
|
| 140 | - * |
|
| 141 | - * @since 1.0.19 |
|
| 142 | - * @param string $context View or edit context. |
|
| 143 | - * @return string |
|
| 144 | - */ |
|
| 145 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 139 | + * Get GMT date when the form was created. |
|
| 140 | + * |
|
| 141 | + * @since 1.0.19 |
|
| 142 | + * @param string $context View or edit context. |
|
| 143 | + * @return string |
|
| 144 | + */ |
|
| 145 | + public function get_date_created_gmt( $context = 'view' ) { |
|
| 146 | 146 | $date = $this->get_date_created( $context ); |
| 147 | 147 | |
| 148 | 148 | if ( $date ) { |
| 149 | 149 | $date = get_gmt_from_date( $date ); |
| 150 | 150 | } |
| 151 | - return $date; |
|
| 151 | + return $date; |
|
| 152 | 152 | } |
| 153 | 153 | |
| 154 | 154 | /** |
| 155 | - * Get date when the form was last modified. |
|
| 156 | - * |
|
| 157 | - * @since 1.0.19 |
|
| 158 | - * @param string $context View or edit context. |
|
| 159 | - * @return string |
|
| 160 | - */ |
|
| 161 | - public function get_date_modified( $context = 'view' ) { |
|
| 162 | - return $this->get_prop( 'date_modified', $context ); |
|
| 155 | + * Get date when the form was last modified. |
|
| 156 | + * |
|
| 157 | + * @since 1.0.19 |
|
| 158 | + * @param string $context View or edit context. |
|
| 159 | + * @return string |
|
| 160 | + */ |
|
| 161 | + public function get_date_modified( $context = 'view' ) { |
|
| 162 | + return $this->get_prop( 'date_modified', $context ); |
|
| 163 | 163 | } |
| 164 | 164 | |
| 165 | 165 | /** |
| 166 | - * Get GMT date when the form was last modified. |
|
| 167 | - * |
|
| 168 | - * @since 1.0.19 |
|
| 169 | - * @param string $context View or edit context. |
|
| 170 | - * @return string |
|
| 171 | - */ |
|
| 172 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
| 166 | + * Get GMT date when the form was last modified. |
|
| 167 | + * |
|
| 168 | + * @since 1.0.19 |
|
| 169 | + * @param string $context View or edit context. |
|
| 170 | + * @return string |
|
| 171 | + */ |
|
| 172 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
| 173 | 173 | $date = $this->get_date_modified( $context ); |
| 174 | 174 | |
| 175 | 175 | if ( $date ) { |
| 176 | 176 | $date = get_gmt_from_date( $date ); |
| 177 | 177 | } |
| 178 | - return $date; |
|
| 178 | + return $date; |
|
| 179 | 179 | } |
| 180 | 180 | |
| 181 | 181 | /** |
| 182 | - * Get the form name. |
|
| 183 | - * |
|
| 184 | - * @since 1.0.19 |
|
| 185 | - * @param string $context View or edit context. |
|
| 186 | - * @return string |
|
| 187 | - */ |
|
| 188 | - public function get_name( $context = 'view' ) { |
|
| 189 | - return $this->get_prop( 'name', $context ); |
|
| 182 | + * Get the form name. |
|
| 183 | + * |
|
| 184 | + * @since 1.0.19 |
|
| 185 | + * @param string $context View or edit context. |
|
| 186 | + * @return string |
|
| 187 | + */ |
|
| 188 | + public function get_name( $context = 'view' ) { |
|
| 189 | + return $this->get_prop( 'name', $context ); |
|
| 190 | 190 | } |
| 191 | 191 | |
| 192 | 192 | /** |
| 193 | - * Alias of self::get_name(). |
|
| 194 | - * |
|
| 195 | - * @since 1.0.19 |
|
| 196 | - * @param string $context View or edit context. |
|
| 197 | - * @return string |
|
| 198 | - */ |
|
| 199 | - public function get_title( $context = 'view' ) { |
|
| 200 | - return $this->get_name( $context ); |
|
| 201 | - } |
|
| 193 | + * Alias of self::get_name(). |
|
| 194 | + * |
|
| 195 | + * @since 1.0.19 |
|
| 196 | + * @param string $context View or edit context. |
|
| 197 | + * @return string |
|
| 198 | + */ |
|
| 199 | + public function get_title( $context = 'view' ) { |
|
| 200 | + return $this->get_name( $context ); |
|
| 201 | + } |
|
| 202 | 202 | |
| 203 | 203 | /** |
| 204 | - * Get the owner of the form. |
|
| 205 | - * |
|
| 206 | - * @since 1.0.19 |
|
| 207 | - * @param string $context View or edit context. |
|
| 208 | - * @return int |
|
| 209 | - */ |
|
| 210 | - public function get_author( $context = 'view' ) { |
|
| 211 | - return (int) $this->get_prop( 'author', $context ); |
|
| 204 | + * Get the owner of the form. |
|
| 205 | + * |
|
| 206 | + * @since 1.0.19 |
|
| 207 | + * @param string $context View or edit context. |
|
| 208 | + * @return int |
|
| 209 | + */ |
|
| 210 | + public function get_author( $context = 'view' ) { |
|
| 211 | + return (int) $this->get_prop( 'author', $context ); |
|
| 212 | 212 | } |
| 213 | 213 | |
| 214 | 214 | /** |
| 215 | - * Get the elements that make up the form. |
|
| 216 | - * |
|
| 217 | - * @since 1.0.19 |
|
| 218 | - * @param string $context View or edit context. |
|
| 219 | - * @return array |
|
| 220 | - */ |
|
| 221 | - public function get_elements( $context = 'view' ) { |
|
| 222 | - $elements = $this->get_prop( 'elements', $context ); |
|
| 215 | + * Get the elements that make up the form. |
|
| 216 | + * |
|
| 217 | + * @since 1.0.19 |
|
| 218 | + * @param string $context View or edit context. |
|
| 219 | + * @return array |
|
| 220 | + */ |
|
| 221 | + public function get_elements( $context = 'view' ) { |
|
| 222 | + $elements = $this->get_prop( 'elements', $context ); |
|
| 223 | 223 | |
| 224 | - if ( empty( $elements ) || ! is_array( $elements ) ) { |
|
| 224 | + if ( empty( $elements ) || ! is_array( $elements ) ) { |
|
| 225 | 225 | return wpinv_get_data( 'sample-payment-form' ); |
| 226 | - } |
|
| 226 | + } |
|
| 227 | 227 | |
| 228 | - // Ensure that all required elements exist. |
|
| 229 | - $_elements = array(); |
|
| 230 | - foreach ( $elements as $element ) { |
|
| 228 | + // Ensure that all required elements exist. |
|
| 229 | + $_elements = array(); |
|
| 230 | + foreach ( $elements as $element ) { |
|
| 231 | 231 | |
| 232 | - if ( $element['type'] == 'pay_button' && ! $this->has_element_type( 'gateway_select' ) ) { |
|
| 232 | + if ( $element['type'] == 'pay_button' && ! $this->has_element_type( 'gateway_select' ) ) { |
|
| 233 | 233 | |
| 234 | - $_elements[] = array( |
|
| 235 | - 'text' => __( 'Select Payment Method', 'invoicing' ), |
|
| 236 | - 'id' => 'gtscicd', |
|
| 237 | - 'name' => 'gtscicd', |
|
| 238 | - 'type' => 'gateway_select', |
|
| 239 | - 'premade' => true |
|
| 234 | + $_elements[] = array( |
|
| 235 | + 'text' => __( 'Select Payment Method', 'invoicing' ), |
|
| 236 | + 'id' => 'gtscicd', |
|
| 237 | + 'name' => 'gtscicd', |
|
| 238 | + 'type' => 'gateway_select', |
|
| 239 | + 'premade' => true |
|
| 240 | 240 | |
| 241 | - ); |
|
| 241 | + ); |
|
| 242 | 242 | |
| 243 | - } |
|
| 243 | + } |
|
| 244 | 244 | |
| 245 | - $_elements[] = $element; |
|
| 245 | + $_elements[] = $element; |
|
| 246 | 246 | |
| 247 | - } |
|
| 247 | + } |
|
| 248 | 248 | |
| 249 | 249 | return $_elements; |
| 250 | - } |
|
| 251 | - |
|
| 252 | - /** |
|
| 253 | - * Get the items sold via the form. |
|
| 254 | - * |
|
| 255 | - * @since 1.0.19 |
|
| 256 | - * @param string $context View or edit context. |
|
| 257 | - * @param string $return objects or arrays. |
|
| 258 | - * @return GetPaid_Form_Item[] |
|
| 259 | - */ |
|
| 260 | - public function get_items( $context = 'view', $return = 'objects' ) { |
|
| 261 | - $items = $this->get_prop( 'items', $context ); |
|
| 262 | - |
|
| 263 | - if ( empty( $items ) || ! is_array( $items ) ) { |
|
| 250 | + } |
|
| 251 | + |
|
| 252 | + /** |
|
| 253 | + * Get the items sold via the form. |
|
| 254 | + * |
|
| 255 | + * @since 1.0.19 |
|
| 256 | + * @param string $context View or edit context. |
|
| 257 | + * @param string $return objects or arrays. |
|
| 258 | + * @return GetPaid_Form_Item[] |
|
| 259 | + */ |
|
| 260 | + public function get_items( $context = 'view', $return = 'objects' ) { |
|
| 261 | + $items = $this->get_prop( 'items', $context ); |
|
| 262 | + |
|
| 263 | + if ( empty( $items ) || ! is_array( $items ) ) { |
|
| 264 | 264 | $items = wpinv_get_data( 'sample-payment-form-items' ); |
| 265 | - } |
|
| 265 | + } |
|
| 266 | + |
|
| 267 | + // Convert the items. |
|
| 268 | + $prepared = array(); |
|
| 266 | 269 | |
| 267 | - // Convert the items. |
|
| 268 | - $prepared = array(); |
|
| 270 | + foreach ( $items as $key => $value ) { |
|
| 269 | 271 | |
| 270 | - foreach ( $items as $key => $value ) { |
|
| 272 | + // Form items. |
|
| 273 | + if ( $value instanceof GetPaid_Form_Item ) { |
|
| 271 | 274 | |
| 272 | - // Form items. |
|
| 273 | - if ( $value instanceof GetPaid_Form_Item ) { |
|
| 275 | + if ( $value->can_purchase() ) { |
|
| 276 | + $prepared[] = $value; |
|
| 277 | + } |
|
| 274 | 278 | |
| 275 | - if ( $value->can_purchase() ) { |
|
| 276 | - $prepared[] = $value; |
|
| 277 | - } |
|
| 279 | + continue; |
|
| 278 | 280 | |
| 279 | - continue; |
|
| 281 | + } |
|
| 280 | 282 | |
| 281 | - } |
|
| 283 | + // $item_id => $quantity (buy buttons) |
|
| 284 | + if ( is_numeric( $key ) && is_numeric( $value ) ) { |
|
| 285 | + $item = new GetPaid_Form_Item( $key ); |
|
| 282 | 286 | |
| 283 | - // $item_id => $quantity (buy buttons) |
|
| 284 | - if ( is_numeric( $key ) && is_numeric( $value ) ) { |
|
| 285 | - $item = new GetPaid_Form_Item( $key ); |
|
| 287 | + if ( $item->can_purchase() ) { |
|
| 288 | + $item->set_quantity( $value ); |
|
| 289 | + $prepared[] = $item; |
|
| 290 | + } |
|
| 286 | 291 | |
| 287 | - if ( $item->can_purchase() ) { |
|
| 288 | - $item->set_quantity( $value ); |
|
| 289 | - $prepared[] = $item; |
|
| 290 | - } |
|
| 292 | + continue; |
|
| 293 | + } |
|
| 291 | 294 | |
| 292 | - continue; |
|
| 293 | - } |
|
| 295 | + // Items saved via payment forms editor. |
|
| 296 | + if ( is_array( $value ) && isset( $value['id'] ) ) { |
|
| 294 | 297 | |
| 295 | - // Items saved via payment forms editor. |
|
| 296 | - if ( is_array( $value ) && isset( $value['id'] ) ) { |
|
| 298 | + $item = new GetPaid_Form_Item( $value['id'] ); |
|
| 297 | 299 | |
| 298 | - $item = new GetPaid_Form_Item( $value['id'] ); |
|
| 300 | + if ( ! $item->can_purchase() ) { |
|
| 301 | + continue; |
|
| 302 | + } |
|
| 299 | 303 | |
| 300 | - if ( ! $item->can_purchase() ) { |
|
| 301 | - continue; |
|
| 302 | - } |
|
| 304 | + // Sub-total (Cart items). |
|
| 305 | + if ( isset( $value['subtotal'] ) ) { |
|
| 306 | + $item->set_price( $value['subtotal'] ); |
|
| 307 | + } |
|
| 303 | 308 | |
| 304 | - // Sub-total (Cart items). |
|
| 305 | - if ( isset( $value['subtotal'] ) ) { |
|
| 306 | - $item->set_price( $value['subtotal'] ); |
|
| 307 | - } |
|
| 309 | + if ( isset( $value['quantity'] ) ) { |
|
| 310 | + $item->set_quantity( $value['quantity'] ); |
|
| 311 | + } |
|
| 308 | 312 | |
| 309 | - if ( isset( $value['quantity'] ) ) { |
|
| 310 | - $item->set_quantity( $value['quantity'] ); |
|
| 311 | - } |
|
| 313 | + if ( isset( $value['allow_quantities'] ) ) { |
|
| 314 | + $item->set_allow_quantities( $value['allow_quantities'] ); |
|
| 315 | + } |
|
| 312 | 316 | |
| 313 | - if ( isset( $value['allow_quantities'] ) ) { |
|
| 314 | - $item->set_allow_quantities( $value['allow_quantities'] ); |
|
| 315 | - } |
|
| 317 | + if ( isset( $value['required'] ) ) { |
|
| 318 | + $item->set_is_required( $value['required'] ); |
|
| 319 | + } |
|
| 316 | 320 | |
| 317 | - if ( isset( $value['required'] ) ) { |
|
| 318 | - $item->set_is_required( $value['required'] ); |
|
| 319 | - } |
|
| 321 | + if ( isset( $value['description'] ) ) { |
|
| 322 | + $item->set_custom_description( $value['description'] ); |
|
| 323 | + } |
|
| 320 | 324 | |
| 321 | - if ( isset( $value['description'] ) ) { |
|
| 322 | - $item->set_custom_description( $value['description'] ); |
|
| 323 | - } |
|
| 325 | + $prepared[] = $item; |
|
| 326 | + continue; |
|
| 324 | 327 | |
| 325 | - $prepared[] = $item; |
|
| 326 | - continue; |
|
| 328 | + } |
|
| 329 | + |
|
| 330 | + // $item_id => array( 'price' => 10 ) (item variations) |
|
| 331 | + if ( is_numeric( $key ) && is_array( $value ) ) { |
|
| 332 | + $item = new GetPaid_Form_Item( $key ); |
|
| 333 | + |
|
| 334 | + if ( isset( $value['price'] ) && $item->user_can_set_their_price() ) { |
|
| 335 | + $item->set_price( $value['price'] ); |
|
| 336 | + } |
|
| 337 | + |
|
| 338 | + if ( $item->can_purchase() ) { |
|
| 339 | + $prepared[] = $item; |
|
| 340 | + } |
|
| 341 | + |
|
| 342 | + continue; |
|
| 343 | + } |
|
| 344 | + |
|
| 345 | + } |
|
| 346 | + |
|
| 347 | + if ( 'objects' == $return && 'view' == $context ) { |
|
| 348 | + return $prepared; |
|
| 349 | + } |
|
| 350 | + |
|
| 351 | + $items = array(); |
|
| 352 | + foreach ( $prepared as $item ) { |
|
| 353 | + $items[] = $item->prepare_data_for_use(); |
|
| 354 | + } |
|
| 355 | + |
|
| 356 | + return $items; |
|
| 357 | + } |
|
| 358 | + |
|
| 359 | + /** |
|
| 360 | + * Get a single item belonging to the form. |
|
| 361 | + * |
|
| 362 | + * @since 1.0.19 |
|
| 363 | + * @param int $item_id The item id to return. |
|
| 364 | + * @return GetPaid_Form_Item|bool |
|
| 365 | + */ |
|
| 366 | + public function get_item( $item_id ) { |
|
| 367 | + |
|
| 368 | + if ( empty( $item_id ) || ! is_numeric( $item_id ) ) { |
|
| 369 | + return false; |
|
| 370 | + } |
|
| 371 | + |
|
| 372 | + foreach( $this->get_items() as $item ) { |
|
| 373 | + if ( $item->get_id() == (int) $item_id ) { |
|
| 374 | + return $item; |
|
| 375 | + } |
|
| 376 | + } |
|
| 377 | + |
|
| 378 | + return false; |
|
| 379 | + |
|
| 380 | + } |
|
| 381 | + |
|
| 382 | + /** |
|
| 383 | + * Gets a single element. |
|
| 384 | + * |
|
| 385 | + * @since 1.0.19 |
|
| 386 | + * @param string $element_type The element type to return. |
|
| 387 | + * @return array|bool |
|
| 388 | + */ |
|
| 389 | + public function get_element_type( $element_type ) { |
|
| 390 | + |
|
| 391 | + if ( empty( $element_type ) || ! is_scalar( $element_type ) ) { |
|
| 392 | + return false; |
|
| 393 | + } |
|
| 394 | + |
|
| 395 | + foreach ( $this->get_prop( 'elements' ) as $element ) { |
|
| 396 | + |
|
| 397 | + if ( $element['type'] == $element_type ) { |
|
| 398 | + return $element; |
|
| 399 | + } |
|
| 400 | + |
|
| 401 | + } |
|
| 402 | + |
|
| 403 | + return false; |
|
| 404 | + |
|
| 405 | + } |
|
| 406 | + |
|
| 407 | + /** |
|
| 408 | + * Get the total amount earned via this form. |
|
| 409 | + * |
|
| 410 | + * @since 1.0.19 |
|
| 411 | + * @param string $context View or edit context. |
|
| 412 | + * @return array |
|
| 413 | + */ |
|
| 414 | + public function get_earned( $context = 'view' ) { |
|
| 415 | + return $this->get_prop( 'earned', $context ); |
|
| 416 | + } |
|
| 417 | + |
|
| 418 | + /** |
|
| 419 | + * Get the total amount refunded via this form. |
|
| 420 | + * |
|
| 421 | + * @since 1.0.19 |
|
| 422 | + * @param string $context View or edit context. |
|
| 423 | + * @return array |
|
| 424 | + */ |
|
| 425 | + public function get_refunded( $context = 'view' ) { |
|
| 426 | + return $this->get_prop( 'refunded', $context ); |
|
| 427 | + } |
|
| 327 | 428 | |
| 328 | - } |
|
| 429 | + /** |
|
| 430 | + * Get the total amount cancelled via this form. |
|
| 431 | + * |
|
| 432 | + * @since 1.0.19 |
|
| 433 | + * @param string $context View or edit context. |
|
| 434 | + * @return array |
|
| 435 | + */ |
|
| 436 | + public function get_cancelled( $context = 'view' ) { |
|
| 437 | + return $this->get_prop( 'cancelled', $context ); |
|
| 438 | + } |
|
| 329 | 439 | |
| 330 | - // $item_id => array( 'price' => 10 ) (item variations) |
|
| 331 | - if ( is_numeric( $key ) && is_array( $value ) ) { |
|
| 332 | - $item = new GetPaid_Form_Item( $key ); |
|
| 440 | + /** |
|
| 441 | + * Get the total amount failed via this form. |
|
| 442 | + * |
|
| 443 | + * @since 1.0.19 |
|
| 444 | + * @param string $context View or edit context. |
|
| 445 | + * @return array |
|
| 446 | + */ |
|
| 447 | + public function get_failed( $context = 'view' ) { |
|
| 448 | + return $this->get_prop( 'failed', $context ); |
|
| 449 | + } |
|
| 333 | 450 | |
| 334 | - if ( isset( $value['price'] ) && $item->user_can_set_their_price() ) { |
|
| 335 | - $item->set_price( $value['price'] ); |
|
| 336 | - } |
|
| 337 | - |
|
| 338 | - if ( $item->can_purchase() ) { |
|
| 339 | - $prepared[] = $item; |
|
| 340 | - } |
|
| 341 | - |
|
| 342 | - continue; |
|
| 343 | - } |
|
| 344 | - |
|
| 345 | - } |
|
| 346 | - |
|
| 347 | - if ( 'objects' == $return && 'view' == $context ) { |
|
| 348 | - return $prepared; |
|
| 349 | - } |
|
| 350 | - |
|
| 351 | - $items = array(); |
|
| 352 | - foreach ( $prepared as $item ) { |
|
| 353 | - $items[] = $item->prepare_data_for_use(); |
|
| 354 | - } |
|
| 355 | - |
|
| 356 | - return $items; |
|
| 357 | - } |
|
| 358 | - |
|
| 359 | - /** |
|
| 360 | - * Get a single item belonging to the form. |
|
| 361 | - * |
|
| 362 | - * @since 1.0.19 |
|
| 363 | - * @param int $item_id The item id to return. |
|
| 364 | - * @return GetPaid_Form_Item|bool |
|
| 365 | - */ |
|
| 366 | - public function get_item( $item_id ) { |
|
| 367 | - |
|
| 368 | - if ( empty( $item_id ) || ! is_numeric( $item_id ) ) { |
|
| 369 | - return false; |
|
| 370 | - } |
|
| 371 | - |
|
| 372 | - foreach( $this->get_items() as $item ) { |
|
| 373 | - if ( $item->get_id() == (int) $item_id ) { |
|
| 374 | - return $item; |
|
| 375 | - } |
|
| 376 | - } |
|
| 377 | - |
|
| 378 | - return false; |
|
| 379 | - |
|
| 380 | - } |
|
| 381 | - |
|
| 382 | - /** |
|
| 383 | - * Gets a single element. |
|
| 384 | - * |
|
| 385 | - * @since 1.0.19 |
|
| 386 | - * @param string $element_type The element type to return. |
|
| 387 | - * @return array|bool |
|
| 388 | - */ |
|
| 389 | - public function get_element_type( $element_type ) { |
|
| 390 | - |
|
| 391 | - if ( empty( $element_type ) || ! is_scalar( $element_type ) ) { |
|
| 392 | - return false; |
|
| 393 | - } |
|
| 394 | - |
|
| 395 | - foreach ( $this->get_prop( 'elements' ) as $element ) { |
|
| 396 | - |
|
| 397 | - if ( $element['type'] == $element_type ) { |
|
| 398 | - return $element; |
|
| 399 | - } |
|
| 400 | - |
|
| 401 | - } |
|
| 402 | - |
|
| 403 | - return false; |
|
| 404 | - |
|
| 405 | - } |
|
| 406 | - |
|
| 407 | - /** |
|
| 408 | - * Get the total amount earned via this form. |
|
| 409 | - * |
|
| 410 | - * @since 1.0.19 |
|
| 411 | - * @param string $context View or edit context. |
|
| 412 | - * @return array |
|
| 413 | - */ |
|
| 414 | - public function get_earned( $context = 'view' ) { |
|
| 415 | - return $this->get_prop( 'earned', $context ); |
|
| 416 | - } |
|
| 417 | - |
|
| 418 | - /** |
|
| 419 | - * Get the total amount refunded via this form. |
|
| 420 | - * |
|
| 421 | - * @since 1.0.19 |
|
| 422 | - * @param string $context View or edit context. |
|
| 423 | - * @return array |
|
| 424 | - */ |
|
| 425 | - public function get_refunded( $context = 'view' ) { |
|
| 426 | - return $this->get_prop( 'refunded', $context ); |
|
| 427 | - } |
|
| 428 | - |
|
| 429 | - /** |
|
| 430 | - * Get the total amount cancelled via this form. |
|
| 431 | - * |
|
| 432 | - * @since 1.0.19 |
|
| 433 | - * @param string $context View or edit context. |
|
| 434 | - * @return array |
|
| 435 | - */ |
|
| 436 | - public function get_cancelled( $context = 'view' ) { |
|
| 437 | - return $this->get_prop( 'cancelled', $context ); |
|
| 438 | - } |
|
| 439 | - |
|
| 440 | - /** |
|
| 441 | - * Get the total amount failed via this form. |
|
| 442 | - * |
|
| 443 | - * @since 1.0.19 |
|
| 444 | - * @param string $context View or edit context. |
|
| 445 | - * @return array |
|
| 446 | - */ |
|
| 447 | - public function get_failed( $context = 'view' ) { |
|
| 448 | - return $this->get_prop( 'failed', $context ); |
|
| 449 | - } |
|
| 450 | - |
|
| 451 | - /** |
|
| 452 | - * Get the currency. |
|
| 453 | - * |
|
| 454 | - * @since 1.0.19 |
|
| 455 | - * @param string $context View or edit context. |
|
| 456 | - * @return string |
|
| 457 | - */ |
|
| 458 | - public function get_currency() { |
|
| 459 | - $currency = empty( $this->invoice ) ? wpinv_get_currency() : $this->invoice->get_currency(); |
|
| 460 | - return apply_filters( 'getpaid-payment-form-currency', $currency, $this ); |
|
| 461 | - } |
|
| 451 | + /** |
|
| 452 | + * Get the currency. |
|
| 453 | + * |
|
| 454 | + * @since 1.0.19 |
|
| 455 | + * @param string $context View or edit context. |
|
| 456 | + * @return string |
|
| 457 | + */ |
|
| 458 | + public function get_currency() { |
|
| 459 | + $currency = empty( $this->invoice ) ? wpinv_get_currency() : $this->invoice->get_currency(); |
|
| 460 | + return apply_filters( 'getpaid-payment-form-currency', $currency, $this ); |
|
| 461 | + } |
|
| 462 | 462 | |
| 463 | 463 | /* |
| 464 | 464 | |-------------------------------------------------------------------------- |
@@ -471,22 +471,22 @@ discard block |
||
| 471 | 471 | */ |
| 472 | 472 | |
| 473 | 473 | /** |
| 474 | - * Set plugin version when the item was created. |
|
| 475 | - * |
|
| 476 | - * @since 1.0.19 |
|
| 477 | - */ |
|
| 478 | - public function set_version( $value ) { |
|
| 479 | - $this->set_prop( 'version', $value ); |
|
| 474 | + * Set plugin version when the item was created. |
|
| 475 | + * |
|
| 476 | + * @since 1.0.19 |
|
| 477 | + */ |
|
| 478 | + public function set_version( $value ) { |
|
| 479 | + $this->set_prop( 'version', $value ); |
|
| 480 | 480 | } |
| 481 | 481 | |
| 482 | 482 | /** |
| 483 | - * Set date when the item was created. |
|
| 484 | - * |
|
| 485 | - * @since 1.0.19 |
|
| 486 | - * @param string $value Value to set. |
|
| 483 | + * Set date when the item was created. |
|
| 484 | + * |
|
| 485 | + * @since 1.0.19 |
|
| 486 | + * @param string $value Value to set. |
|
| 487 | 487 | * @return bool Whether or not the date was set. |
| 488 | - */ |
|
| 489 | - public function set_date_created( $value ) { |
|
| 488 | + */ |
|
| 489 | + public function set_date_created( $value ) { |
|
| 490 | 490 | $date = strtotime( $value ); |
| 491 | 491 | |
| 492 | 492 | if ( $date ) { |
@@ -499,13 +499,13 @@ discard block |
||
| 499 | 499 | } |
| 500 | 500 | |
| 501 | 501 | /** |
| 502 | - * Set date when the item was last modified. |
|
| 503 | - * |
|
| 504 | - * @since 1.0.19 |
|
| 505 | - * @param string $value Value to set. |
|
| 502 | + * Set date when the item was last modified. |
|
| 503 | + * |
|
| 504 | + * @since 1.0.19 |
|
| 505 | + * @param string $value Value to set. |
|
| 506 | 506 | * @return bool Whether or not the date was set. |
| 507 | - */ |
|
| 508 | - public function set_date_modified( $value ) { |
|
| 507 | + */ |
|
| 508 | + public function set_date_modified( $value ) { |
|
| 509 | 509 | $date = strtotime( $value ); |
| 510 | 510 | |
| 511 | 511 | if ( $date ) { |
@@ -518,118 +518,118 @@ discard block |
||
| 518 | 518 | } |
| 519 | 519 | |
| 520 | 520 | /** |
| 521 | - * Set the item name. |
|
| 522 | - * |
|
| 523 | - * @since 1.0.19 |
|
| 524 | - * @param string $value New name. |
|
| 525 | - */ |
|
| 526 | - public function set_name( $value ) { |
|
| 527 | - $this->set_prop( 'name', sanitize_text_field( $value ) ); |
|
| 528 | - } |
|
| 529 | - |
|
| 530 | - /** |
|
| 531 | - * Alias of self::set_name(). |
|
| 532 | - * |
|
| 533 | - * @since 1.0.19 |
|
| 534 | - * @param string $value New name. |
|
| 535 | - */ |
|
| 536 | - public function set_title( $value ) { |
|
| 537 | - $this->set_name( $value ); |
|
| 538 | - } |
|
| 539 | - |
|
| 540 | - /** |
|
| 541 | - * Set the owner of the item. |
|
| 542 | - * |
|
| 543 | - * @since 1.0.19 |
|
| 544 | - * @param int $value New author. |
|
| 545 | - */ |
|
| 546 | - public function set_author( $value ) { |
|
| 547 | - $this->set_prop( 'author', (int) $value ); |
|
| 548 | - } |
|
| 549 | - |
|
| 550 | - /** |
|
| 551 | - * Set the form elements. |
|
| 552 | - * |
|
| 553 | - * @since 1.0.19 |
|
| 554 | - * @param array $value Form elements. |
|
| 555 | - */ |
|
| 556 | - public function set_elements( $value ) { |
|
| 557 | - if ( is_array( $value ) ) { |
|
| 558 | - $this->set_prop( 'elements', $value ); |
|
| 559 | - } |
|
| 560 | - } |
|
| 561 | - |
|
| 562 | - /** |
|
| 563 | - * Set the form items. |
|
| 564 | - * |
|
| 565 | - * @since 1.0.19 |
|
| 566 | - * @param array $value Form elements. |
|
| 567 | - */ |
|
| 568 | - public function set_items( $value ) { |
|
| 569 | - if ( is_array( $value ) ) { |
|
| 570 | - $this->set_prop( 'items', $value ); |
|
| 571 | - } |
|
| 572 | - } |
|
| 573 | - |
|
| 574 | - /** |
|
| 575 | - * Set the total amount earned via this form. |
|
| 576 | - * |
|
| 577 | - * @since 1.0.19 |
|
| 578 | - * @param float $value Amount earned. |
|
| 579 | - */ |
|
| 580 | - public function set_earned( $value ) { |
|
| 581 | - $value = max( (float) $value, 0 ); |
|
| 582 | - $this->set_prop( 'earned', $value ); |
|
| 583 | - } |
|
| 584 | - |
|
| 585 | - /** |
|
| 586 | - * Set the total amount refunded via this form. |
|
| 587 | - * |
|
| 588 | - * @since 1.0.19 |
|
| 589 | - * @param float $value Amount refunded. |
|
| 590 | - */ |
|
| 591 | - public function set_refunded( $value ) { |
|
| 592 | - $value = max( (float) $value, 0 ); |
|
| 593 | - $this->set_prop( 'refunded', $value ); |
|
| 594 | - } |
|
| 595 | - |
|
| 596 | - /** |
|
| 597 | - * Set the total amount cancelled via this form. |
|
| 598 | - * |
|
| 599 | - * @since 1.0.19 |
|
| 600 | - * @param float $value Amount cancelled. |
|
| 601 | - */ |
|
| 602 | - public function set_cancelled( $value ) { |
|
| 603 | - $value = max( (float) $value, 0 ); |
|
| 604 | - $this->set_prop( 'cancelled', $value ); |
|
| 605 | - } |
|
| 606 | - |
|
| 607 | - /** |
|
| 608 | - * Set the total amount failed via this form. |
|
| 609 | - * |
|
| 610 | - * @since 1.0.19 |
|
| 611 | - * @param float $value Amount cancelled. |
|
| 612 | - */ |
|
| 613 | - public function set_failed( $value ) { |
|
| 614 | - $value = max( (float) $value, 0 ); |
|
| 615 | - $this->set_prop( 'failed', $value ); |
|
| 616 | - } |
|
| 521 | + * Set the item name. |
|
| 522 | + * |
|
| 523 | + * @since 1.0.19 |
|
| 524 | + * @param string $value New name. |
|
| 525 | + */ |
|
| 526 | + public function set_name( $value ) { |
|
| 527 | + $this->set_prop( 'name', sanitize_text_field( $value ) ); |
|
| 528 | + } |
|
| 529 | + |
|
| 530 | + /** |
|
| 531 | + * Alias of self::set_name(). |
|
| 532 | + * |
|
| 533 | + * @since 1.0.19 |
|
| 534 | + * @param string $value New name. |
|
| 535 | + */ |
|
| 536 | + public function set_title( $value ) { |
|
| 537 | + $this->set_name( $value ); |
|
| 538 | + } |
|
| 539 | + |
|
| 540 | + /** |
|
| 541 | + * Set the owner of the item. |
|
| 542 | + * |
|
| 543 | + * @since 1.0.19 |
|
| 544 | + * @param int $value New author. |
|
| 545 | + */ |
|
| 546 | + public function set_author( $value ) { |
|
| 547 | + $this->set_prop( 'author', (int) $value ); |
|
| 548 | + } |
|
| 549 | + |
|
| 550 | + /** |
|
| 551 | + * Set the form elements. |
|
| 552 | + * |
|
| 553 | + * @since 1.0.19 |
|
| 554 | + * @param array $value Form elements. |
|
| 555 | + */ |
|
| 556 | + public function set_elements( $value ) { |
|
| 557 | + if ( is_array( $value ) ) { |
|
| 558 | + $this->set_prop( 'elements', $value ); |
|
| 559 | + } |
|
| 560 | + } |
|
| 561 | + |
|
| 562 | + /** |
|
| 563 | + * Set the form items. |
|
| 564 | + * |
|
| 565 | + * @since 1.0.19 |
|
| 566 | + * @param array $value Form elements. |
|
| 567 | + */ |
|
| 568 | + public function set_items( $value ) { |
|
| 569 | + if ( is_array( $value ) ) { |
|
| 570 | + $this->set_prop( 'items', $value ); |
|
| 571 | + } |
|
| 572 | + } |
|
| 573 | + |
|
| 574 | + /** |
|
| 575 | + * Set the total amount earned via this form. |
|
| 576 | + * |
|
| 577 | + * @since 1.0.19 |
|
| 578 | + * @param float $value Amount earned. |
|
| 579 | + */ |
|
| 580 | + public function set_earned( $value ) { |
|
| 581 | + $value = max( (float) $value, 0 ); |
|
| 582 | + $this->set_prop( 'earned', $value ); |
|
| 583 | + } |
|
| 584 | + |
|
| 585 | + /** |
|
| 586 | + * Set the total amount refunded via this form. |
|
| 587 | + * |
|
| 588 | + * @since 1.0.19 |
|
| 589 | + * @param float $value Amount refunded. |
|
| 590 | + */ |
|
| 591 | + public function set_refunded( $value ) { |
|
| 592 | + $value = max( (float) $value, 0 ); |
|
| 593 | + $this->set_prop( 'refunded', $value ); |
|
| 594 | + } |
|
| 595 | + |
|
| 596 | + /** |
|
| 597 | + * Set the total amount cancelled via this form. |
|
| 598 | + * |
|
| 599 | + * @since 1.0.19 |
|
| 600 | + * @param float $value Amount cancelled. |
|
| 601 | + */ |
|
| 602 | + public function set_cancelled( $value ) { |
|
| 603 | + $value = max( (float) $value, 0 ); |
|
| 604 | + $this->set_prop( 'cancelled', $value ); |
|
| 605 | + } |
|
| 606 | + |
|
| 607 | + /** |
|
| 608 | + * Set the total amount failed via this form. |
|
| 609 | + * |
|
| 610 | + * @since 1.0.19 |
|
| 611 | + * @param float $value Amount cancelled. |
|
| 612 | + */ |
|
| 613 | + public function set_failed( $value ) { |
|
| 614 | + $value = max( (float) $value, 0 ); |
|
| 615 | + $this->set_prop( 'failed', $value ); |
|
| 616 | + } |
|
| 617 | 617 | |
| 618 | 618 | /** |
| 619 | 619 | * Create an item. For backwards compatibilty. |
| 620 | 620 | * |
| 621 | 621 | * @deprecated |
| 622 | - * @return int item id |
|
| 622 | + * @return int item id |
|
| 623 | 623 | */ |
| 624 | 624 | public function create( $data = array() ) { |
| 625 | 625 | |
| 626 | - // Set the properties. |
|
| 627 | - if ( is_array( $data ) ) { |
|
| 628 | - $this->set_props( $data ); |
|
| 629 | - } |
|
| 626 | + // Set the properties. |
|
| 627 | + if ( is_array( $data ) ) { |
|
| 628 | + $this->set_props( $data ); |
|
| 629 | + } |
|
| 630 | 630 | |
| 631 | - // Save the item. |
|
| 632 | - return $this->save(); |
|
| 631 | + // Save the item. |
|
| 632 | + return $this->save(); |
|
| 633 | 633 | |
| 634 | 634 | } |
| 635 | 635 | |
@@ -637,7 +637,7 @@ discard block |
||
| 637 | 637 | * Updates an item. For backwards compatibilty. |
| 638 | 638 | * |
| 639 | 639 | * @deprecated |
| 640 | - * @return int item id |
|
| 640 | + * @return int item id |
|
| 641 | 641 | */ |
| 642 | 642 | public function update( $data = array() ) { |
| 643 | 643 | return $this->create( $data ); |
@@ -653,22 +653,22 @@ discard block |
||
| 653 | 653 | */ |
| 654 | 654 | |
| 655 | 655 | /** |
| 656 | - * Checks whether this is the default payment form. |
|
| 657 | - * |
|
| 658 | - * @since 1.0.19 |
|
| 659 | - * @return bool |
|
| 660 | - */ |
|
| 656 | + * Checks whether this is the default payment form. |
|
| 657 | + * |
|
| 658 | + * @since 1.0.19 |
|
| 659 | + * @return bool |
|
| 660 | + */ |
|
| 661 | 661 | public function is_default() { |
| 662 | 662 | $is_default = $this->get_id() == wpinv_get_default_payment_form(); |
| 663 | 663 | return (bool) apply_filters( 'wpinv_is_default_payment_form', $is_default, $this->get_id(), $this ); |
| 664 | - } |
|
| 664 | + } |
|
| 665 | 665 | |
| 666 | 666 | /** |
| 667 | - * Checks whether the form is active. |
|
| 668 | - * |
|
| 669 | - * @since 1.0.19 |
|
| 670 | - * @return bool |
|
| 671 | - */ |
|
| 667 | + * Checks whether the form is active. |
|
| 668 | + * |
|
| 669 | + * @since 1.0.19 |
|
| 670 | + * @return bool |
|
| 671 | + */ |
|
| 672 | 672 | public function is_active() { |
| 673 | 673 | $is_active = 0 !== (int) $this->get_id(); |
| 674 | 674 | |
@@ -677,70 +677,70 @@ discard block |
||
| 677 | 677 | } |
| 678 | 678 | |
| 679 | 679 | return (bool) apply_filters( 'wpinv_is_payment_form_active', $is_active, $this ); |
| 680 | - } |
|
| 681 | - |
|
| 682 | - /** |
|
| 683 | - * Checks whether the form has a given item. |
|
| 684 | - * |
|
| 685 | - * @since 1.0.19 |
|
| 686 | - * @return bool |
|
| 687 | - */ |
|
| 680 | + } |
|
| 681 | + |
|
| 682 | + /** |
|
| 683 | + * Checks whether the form has a given item. |
|
| 684 | + * |
|
| 685 | + * @since 1.0.19 |
|
| 686 | + * @return bool |
|
| 687 | + */ |
|
| 688 | 688 | public function has_item( $item_id ) { |
| 689 | 689 | return false !== $this->get_item( $item_id ); |
| 690 | - } |
|
| 691 | - |
|
| 692 | - /** |
|
| 693 | - * Checks whether the form has a given element. |
|
| 694 | - * |
|
| 695 | - * @since 1.0.19 |
|
| 696 | - * @return bool |
|
| 697 | - */ |
|
| 690 | + } |
|
| 691 | + |
|
| 692 | + /** |
|
| 693 | + * Checks whether the form has a given element. |
|
| 694 | + * |
|
| 695 | + * @since 1.0.19 |
|
| 696 | + * @return bool |
|
| 697 | + */ |
|
| 698 | 698 | public function has_element_type( $element_type ) { |
| 699 | 699 | return false !== $this->get_element_type( $element_type ); |
| 700 | - } |
|
| 701 | - |
|
| 702 | - /** |
|
| 703 | - * Checks whether this form is recurring or not. |
|
| 704 | - * |
|
| 705 | - * @since 1.0.19 |
|
| 706 | - * @return bool |
|
| 707 | - */ |
|
| 700 | + } |
|
| 701 | + |
|
| 702 | + /** |
|
| 703 | + * Checks whether this form is recurring or not. |
|
| 704 | + * |
|
| 705 | + * @since 1.0.19 |
|
| 706 | + * @return bool |
|
| 707 | + */ |
|
| 708 | 708 | public function is_recurring() { |
| 709 | 709 | |
| 710 | - if ( ! empty( $this->invoice ) ) { |
|
| 711 | - return $this->invoice->is_recurring(); |
|
| 712 | - } |
|
| 710 | + if ( ! empty( $this->invoice ) ) { |
|
| 711 | + return $this->invoice->is_recurring(); |
|
| 712 | + } |
|
| 713 | 713 | |
| 714 | - foreach ( $this->get_items() as $item ) { |
|
| 714 | + foreach ( $this->get_items() as $item ) { |
|
| 715 | 715 | |
| 716 | - if ( $item->is_recurring() ) { |
|
| 717 | - return true; |
|
| 718 | - } |
|
| 716 | + if ( $item->is_recurring() ) { |
|
| 717 | + return true; |
|
| 718 | + } |
|
| 719 | 719 | |
| 720 | - } |
|
| 720 | + } |
|
| 721 | 721 | |
| 722 | 722 | return false; |
| 723 | - } |
|
| 723 | + } |
|
| 724 | 724 | |
| 725 | - /** |
|
| 726 | - * Retrieves the form's html. |
|
| 727 | - * |
|
| 728 | - * @since 1.0.19 |
|
| 729 | - */ |
|
| 725 | + /** |
|
| 726 | + * Retrieves the form's html. |
|
| 727 | + * |
|
| 728 | + * @since 1.0.19 |
|
| 729 | + */ |
|
| 730 | 730 | public function get_html() { |
| 731 | 731 | |
| 732 | - // Return the HTML. |
|
| 733 | - return wpinv_get_template_html( 'payment-forms/form.php', array( 'form' => $this ) ); |
|
| 732 | + // Return the HTML. |
|
| 733 | + return wpinv_get_template_html( 'payment-forms/form.php', array( 'form' => $this ) ); |
|
| 734 | 734 | |
| 735 | - } |
|
| 735 | + } |
|
| 736 | 736 | |
| 737 | - /** |
|
| 738 | - * Displays the payment form. |
|
| 739 | - * |
|
| 740 | - * @since 1.0.19 |
|
| 741 | - */ |
|
| 737 | + /** |
|
| 738 | + * Displays the payment form. |
|
| 739 | + * |
|
| 740 | + * @since 1.0.19 |
|
| 741 | + */ |
|
| 742 | 742 | public function display() { |
| 743 | - echo $this->get_html(); |
|
| 743 | + echo $this->get_html(); |
|
| 744 | 744 | } |
| 745 | 745 | |
| 746 | 746 | } |
@@ -12,189 +12,189 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Payment_Form_Submission_Discount { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * Submission discounts. |
|
| 17 | - * @var array |
|
| 18 | - */ |
|
| 19 | - public $discounts = array(); |
|
| 15 | + /** |
|
| 16 | + * Submission discounts. |
|
| 17 | + * @var array |
|
| 18 | + */ |
|
| 19 | + public $discounts = array(); |
|
| 20 | + |
|
| 21 | + /** |
|
| 22 | + * Class constructor |
|
| 23 | + * |
|
| 24 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 25 | + * @param float $initial_total |
|
| 26 | + * @param float $recurring_total |
|
| 27 | + */ |
|
| 28 | + public function __construct( $submission, $initial_total, $recurring_total ) { |
|
| 29 | + |
|
| 30 | + // Process any existing invoice discounts. |
|
| 31 | + if ( $submission->has_invoice() ) { |
|
| 32 | + $this->discounts = $submission->get_invoice()->get_discounts(); |
|
| 33 | + } |
|
| 34 | + |
|
| 35 | + // Do we have a discount? |
|
| 36 | + $discount = $submission->get_field( 'discount' ); |
|
| 37 | + |
|
| 38 | + if ( empty( $discount ) ) { |
|
| 39 | + |
|
| 40 | + if ( isset( $this->discounts['discount_code'] ) ) { |
|
| 41 | + unset( $this->discounts['discount_code'] ); |
|
| 42 | + } |
|
| 43 | + |
|
| 44 | + return; |
|
| 45 | + } |
|
| 46 | + |
|
| 47 | + // Processes the discount code. |
|
| 48 | + $amount = max( $initial_total, $recurring_total ); |
|
| 49 | + $this->process_discount( $submission, $discount, $amount ); |
|
| 50 | + |
|
| 51 | + } |
|
| 20 | 52 | |
| 21 | 53 | /** |
| 22 | - * Class constructor |
|
| 23 | - * |
|
| 24 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 25 | - * @param float $initial_total |
|
| 26 | - * @param float $recurring_total |
|
| 27 | - */ |
|
| 28 | - public function __construct( $submission, $initial_total, $recurring_total ) { |
|
| 29 | - |
|
| 30 | - // Process any existing invoice discounts. |
|
| 31 | - if ( $submission->has_invoice() ) { |
|
| 32 | - $this->discounts = $submission->get_invoice()->get_discounts(); |
|
| 33 | - } |
|
| 34 | - |
|
| 35 | - // Do we have a discount? |
|
| 36 | - $discount = $submission->get_field( 'discount' ); |
|
| 37 | - |
|
| 38 | - if ( empty( $discount ) ) { |
|
| 39 | - |
|
| 40 | - if ( isset( $this->discounts['discount_code'] ) ) { |
|
| 41 | - unset( $this->discounts['discount_code'] ); |
|
| 42 | - } |
|
| 43 | - |
|
| 44 | - return; |
|
| 45 | - } |
|
| 46 | - |
|
| 47 | - // Processes the discount code. |
|
| 48 | - $amount = max( $initial_total, $recurring_total ); |
|
| 49 | - $this->process_discount( $submission, $discount, $amount ); |
|
| 50 | - |
|
| 51 | - } |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * Processes a submission discount. |
|
| 55 | - * |
|
| 56 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 57 | - * @param string $discount |
|
| 58 | - * @param float $amount |
|
| 59 | - */ |
|
| 60 | - public function process_discount( $submission, $discount, $amount ) { |
|
| 61 | - |
|
| 62 | - // Fetch the discount. |
|
| 63 | - $discount = new WPInv_Discount( $discount ); |
|
| 64 | - |
|
| 65 | - // Ensure it is active. |
|
| 54 | + * Processes a submission discount. |
|
| 55 | + * |
|
| 56 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 57 | + * @param string $discount |
|
| 58 | + * @param float $amount |
|
| 59 | + */ |
|
| 60 | + public function process_discount( $submission, $discount, $amount ) { |
|
| 61 | + |
|
| 62 | + // Fetch the discount. |
|
| 63 | + $discount = new WPInv_Discount( $discount ); |
|
| 64 | + |
|
| 65 | + // Ensure it is active. |
|
| 66 | 66 | if ( ! $this->is_discount_active( $discount ) ) { |
| 67 | - throw new Exception( __( 'Invalid or expired discount code', 'invoicing' ) ); |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - // Exceeded limit. |
|
| 71 | - if ( $discount->has_exceeded_limit() ) { |
|
| 72 | - throw new Exception( __( 'This discount code has been used up', 'invoicing' ) ); |
|
| 73 | - } |
|
| 74 | - |
|
| 75 | - // Validate usages. |
|
| 76 | - $this->validate_single_use_discount( $submission, $discount ); |
|
| 77 | - |
|
| 78 | - // Validate amount. |
|
| 79 | - $this->validate_discount_amount( $submission, $discount, $amount ); |
|
| 80 | - |
|
| 81 | - // Save the discount. |
|
| 82 | - $this->discounts['discount_code'] = $this->calculate_discount( $submission, $discount ); |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Validates a single use discount. |
|
| 87 | - * |
|
| 88 | - * @param WPInv_Discount $discount |
|
| 89 | - * @return bool |
|
| 90 | - */ |
|
| 91 | - public function is_discount_active( $discount ) { |
|
| 92 | - return $discount->exists() && $discount->is_active() && $discount->has_started() && ! $discount->is_expired(); |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - /** |
|
| 96 | - * Returns a user's id or email. |
|
| 97 | - * |
|
| 98 | - * @param string $email |
|
| 99 | - * @return int|string|false |
|
| 100 | - */ |
|
| 101 | - public function get_user_id_or_email( $email ) { |
|
| 102 | - |
|
| 103 | - if ( is_user_logged_in() ) { |
|
| 104 | - return get_current_user_id(); |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - return empty( $email ) ? false : sanitize_email( $email ); |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - /** |
|
| 111 | - * Validates a single use discount. |
|
| 112 | - * |
|
| 113 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 114 | - * @param WPInv_Discount $discount |
|
| 115 | - */ |
|
| 116 | - public function validate_single_use_discount( $submission, $discount ) { |
|
| 117 | - |
|
| 118 | - // Abort if it is not a single use discount. |
|
| 119 | - if ( ! $discount->is_single_use() ) { |
|
| 120 | - return; |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - // Ensure there is a valid billing email. |
|
| 124 | - $user = $this->get_user_id_or_email( $submission->get_billing_email() ); |
|
| 125 | - |
|
| 126 | - if ( empty( $user ) ) { |
|
| 127 | - throw new Exception( __( 'You need to either log in or enter your billing email before applying this discount', 'invoicing' ) ); |
|
| 128 | - } |
|
| 129 | - |
|
| 130 | - // Has the user used this discount code before? |
|
| 131 | - if ( ! $discount->is_valid_for_user( $user ) ) { |
|
| 132 | - throw new Exception( __( 'You have already used this discount', 'invoicing' ) ); |
|
| 133 | - } |
|
| 134 | - |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - /** |
|
| 138 | - * Validates the discount's amount. |
|
| 139 | - * |
|
| 140 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 141 | - * @param WPInv_Discount $discount |
|
| 142 | - * @param float $amount |
|
| 143 | - */ |
|
| 144 | - public function validate_discount_amount( $submission, $discount, $amount ) { |
|
| 145 | - |
|
| 146 | - // Validate minimum amount. |
|
| 147 | - if ( ! $discount->is_minimum_amount_met( $amount ) ) { |
|
| 148 | - $min = wpinv_price( $discount->get_minimum_total(), $submission->get_currency() ); |
|
| 149 | - throw new Exception( sprintf( __( 'The minimum total for using this discount is %s', 'invoicing' ), $min ) ); |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - // Validate the maximum amount. |
|
| 153 | - if ( ! $discount->is_maximum_amount_met( $amount ) ) { |
|
| 154 | - $max = wpinv_price( $discount->get_maximum_total(), $submission->get_currency() ); |
|
| 155 | - throw new Exception( sprintf( __( 'The maximum total for using this discount is %s', 'invoicing' ), $max ) ); |
|
| 156 | - } |
|
| 157 | - |
|
| 158 | - } |
|
| 159 | - |
|
| 160 | - /** |
|
| 161 | - * Calculates the discount code's amount. |
|
| 162 | - * |
|
| 163 | - * Ensure that the discount exists and has been validated before calling this method. |
|
| 164 | - * |
|
| 165 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 166 | - * @param WPInv_Discount $discount |
|
| 167 | - * @return array |
|
| 168 | - */ |
|
| 169 | - public function calculate_discount( $submission, $discount ) { |
|
| 170 | - |
|
| 171 | - $initial_discount = 0; |
|
| 172 | - $recurring_discount = 0; |
|
| 173 | - |
|
| 174 | - foreach ( $submission->get_items() as $item ) { |
|
| 175 | - |
|
| 176 | - // Abort if it is not valid for this item. |
|
| 177 | - if ( ! $discount->is_valid_for_items( array( $item->get_id() ) ) ) { |
|
| 178 | - continue; |
|
| 179 | - } |
|
| 180 | - |
|
| 181 | - // Calculate the initial amount... |
|
| 182 | - $initial_discount += $discount->get_discounted_amount( $item->get_sub_total() ); |
|
| 183 | - |
|
| 184 | - // ... and maybe the recurring amount. |
|
| 185 | - if ( $item->is_recurring() && $discount->is_recurring() ) { |
|
| 186 | - $recurring_discount += $discount->get_discounted_amount( $item->get_recurring_sub_total() ); |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - } |
|
| 190 | - |
|
| 191 | - return array( |
|
| 192 | - 'name' => 'discount_code', |
|
| 193 | - 'discount_code' => $discount->get_code(), |
|
| 194 | - 'initial_discount' => $initial_discount, |
|
| 195 | - 'recurring_discount' => $recurring_discount, |
|
| 196 | - ); |
|
| 197 | - |
|
| 198 | - } |
|
| 67 | + throw new Exception( __( 'Invalid or expired discount code', 'invoicing' ) ); |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + // Exceeded limit. |
|
| 71 | + if ( $discount->has_exceeded_limit() ) { |
|
| 72 | + throw new Exception( __( 'This discount code has been used up', 'invoicing' ) ); |
|
| 73 | + } |
|
| 74 | + |
|
| 75 | + // Validate usages. |
|
| 76 | + $this->validate_single_use_discount( $submission, $discount ); |
|
| 77 | + |
|
| 78 | + // Validate amount. |
|
| 79 | + $this->validate_discount_amount( $submission, $discount, $amount ); |
|
| 80 | + |
|
| 81 | + // Save the discount. |
|
| 82 | + $this->discounts['discount_code'] = $this->calculate_discount( $submission, $discount ); |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Validates a single use discount. |
|
| 87 | + * |
|
| 88 | + * @param WPInv_Discount $discount |
|
| 89 | + * @return bool |
|
| 90 | + */ |
|
| 91 | + public function is_discount_active( $discount ) { |
|
| 92 | + return $discount->exists() && $discount->is_active() && $discount->has_started() && ! $discount->is_expired(); |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + /** |
|
| 96 | + * Returns a user's id or email. |
|
| 97 | + * |
|
| 98 | + * @param string $email |
|
| 99 | + * @return int|string|false |
|
| 100 | + */ |
|
| 101 | + public function get_user_id_or_email( $email ) { |
|
| 102 | + |
|
| 103 | + if ( is_user_logged_in() ) { |
|
| 104 | + return get_current_user_id(); |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + return empty( $email ) ? false : sanitize_email( $email ); |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + /** |
|
| 111 | + * Validates a single use discount. |
|
| 112 | + * |
|
| 113 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 114 | + * @param WPInv_Discount $discount |
|
| 115 | + */ |
|
| 116 | + public function validate_single_use_discount( $submission, $discount ) { |
|
| 117 | + |
|
| 118 | + // Abort if it is not a single use discount. |
|
| 119 | + if ( ! $discount->is_single_use() ) { |
|
| 120 | + return; |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + // Ensure there is a valid billing email. |
|
| 124 | + $user = $this->get_user_id_or_email( $submission->get_billing_email() ); |
|
| 125 | + |
|
| 126 | + if ( empty( $user ) ) { |
|
| 127 | + throw new Exception( __( 'You need to either log in or enter your billing email before applying this discount', 'invoicing' ) ); |
|
| 128 | + } |
|
| 129 | + |
|
| 130 | + // Has the user used this discount code before? |
|
| 131 | + if ( ! $discount->is_valid_for_user( $user ) ) { |
|
| 132 | + throw new Exception( __( 'You have already used this discount', 'invoicing' ) ); |
|
| 133 | + } |
|
| 134 | + |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + /** |
|
| 138 | + * Validates the discount's amount. |
|
| 139 | + * |
|
| 140 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 141 | + * @param WPInv_Discount $discount |
|
| 142 | + * @param float $amount |
|
| 143 | + */ |
|
| 144 | + public function validate_discount_amount( $submission, $discount, $amount ) { |
|
| 145 | + |
|
| 146 | + // Validate minimum amount. |
|
| 147 | + if ( ! $discount->is_minimum_amount_met( $amount ) ) { |
|
| 148 | + $min = wpinv_price( $discount->get_minimum_total(), $submission->get_currency() ); |
|
| 149 | + throw new Exception( sprintf( __( 'The minimum total for using this discount is %s', 'invoicing' ), $min ) ); |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + // Validate the maximum amount. |
|
| 153 | + if ( ! $discount->is_maximum_amount_met( $amount ) ) { |
|
| 154 | + $max = wpinv_price( $discount->get_maximum_total(), $submission->get_currency() ); |
|
| 155 | + throw new Exception( sprintf( __( 'The maximum total for using this discount is %s', 'invoicing' ), $max ) ); |
|
| 156 | + } |
|
| 157 | + |
|
| 158 | + } |
|
| 159 | + |
|
| 160 | + /** |
|
| 161 | + * Calculates the discount code's amount. |
|
| 162 | + * |
|
| 163 | + * Ensure that the discount exists and has been validated before calling this method. |
|
| 164 | + * |
|
| 165 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 166 | + * @param WPInv_Discount $discount |
|
| 167 | + * @return array |
|
| 168 | + */ |
|
| 169 | + public function calculate_discount( $submission, $discount ) { |
|
| 170 | + |
|
| 171 | + $initial_discount = 0; |
|
| 172 | + $recurring_discount = 0; |
|
| 173 | + |
|
| 174 | + foreach ( $submission->get_items() as $item ) { |
|
| 175 | + |
|
| 176 | + // Abort if it is not valid for this item. |
|
| 177 | + if ( ! $discount->is_valid_for_items( array( $item->get_id() ) ) ) { |
|
| 178 | + continue; |
|
| 179 | + } |
|
| 180 | + |
|
| 181 | + // Calculate the initial amount... |
|
| 182 | + $initial_discount += $discount->get_discounted_amount( $item->get_sub_total() ); |
|
| 183 | + |
|
| 184 | + // ... and maybe the recurring amount. |
|
| 185 | + if ( $item->is_recurring() && $discount->is_recurring() ) { |
|
| 186 | + $recurring_discount += $discount->get_discounted_amount( $item->get_recurring_sub_total() ); |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + } |
|
| 190 | + |
|
| 191 | + return array( |
|
| 192 | + 'name' => 'discount_code', |
|
| 193 | + 'discount_code' => $discount->get_code(), |
|
| 194 | + 'initial_discount' => $initial_discount, |
|
| 195 | + 'recurring_discount' => $recurring_discount, |
|
| 196 | + ); |
|
| 197 | + |
|
| 198 | + } |
|
| 199 | 199 | |
| 200 | 200 | } |
@@ -15,30 +15,30 @@ discard block |
||
| 15 | 15 | */ |
| 16 | 16 | class WPInv_Discount extends GetPaid_Data { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * Which data store to load. |
|
| 20 | - * |
|
| 21 | - * @var string |
|
| 22 | - */ |
|
| 18 | + /** |
|
| 19 | + * Which data store to load. |
|
| 20 | + * |
|
| 21 | + * @var string |
|
| 22 | + */ |
|
| 23 | 23 | protected $data_store_name = 'discount'; |
| 24 | 24 | |
| 25 | 25 | /** |
| 26 | - * This is the name of this object type. |
|
| 27 | - * |
|
| 28 | - * @var string |
|
| 29 | - */ |
|
| 30 | - protected $object_type = 'discount'; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Discount Data array. This is the core item data exposed in APIs. |
|
| 34 | - * |
|
| 35 | - * @since 1.0.19 |
|
| 36 | - * @var array |
|
| 37 | - */ |
|
| 38 | - protected $data = array( |
|
| 39 | - 'status' => 'draft', |
|
| 40 | - 'version' => '', |
|
| 41 | - 'date_created' => null, |
|
| 26 | + * This is the name of this object type. |
|
| 27 | + * |
|
| 28 | + * @var string |
|
| 29 | + */ |
|
| 30 | + protected $object_type = 'discount'; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Discount Data array. This is the core item data exposed in APIs. |
|
| 34 | + * |
|
| 35 | + * @since 1.0.19 |
|
| 36 | + * @var array |
|
| 37 | + */ |
|
| 38 | + protected $data = array( |
|
| 39 | + 'status' => 'draft', |
|
| 40 | + 'version' => '', |
|
| 41 | + 'date_created' => null, |
|
| 42 | 42 | 'date_modified' => null, |
| 43 | 43 | 'name' => 'no-name', |
| 44 | 44 | 'description' => null, |
@@ -58,144 +58,144 @@ discard block |
||
| 58 | 58 | 'amount' => null, |
| 59 | 59 | ); |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * Stores meta in cache for future reads. |
|
| 63 | - * |
|
| 64 | - * A group must be set to to enable caching. |
|
| 65 | - * |
|
| 66 | - * @var string |
|
| 67 | - */ |
|
| 68 | - protected $cache_group = 'getpaid_discounts'; |
|
| 61 | + /** |
|
| 62 | + * Stores meta in cache for future reads. |
|
| 63 | + * |
|
| 64 | + * A group must be set to to enable caching. |
|
| 65 | + * |
|
| 66 | + * @var string |
|
| 67 | + */ |
|
| 68 | + protected $cache_group = 'getpaid_discounts'; |
|
| 69 | 69 | |
| 70 | 70 | /** |
| 71 | 71 | * Stores a reference to the original WP_Post object |
| 72 | 72 | * |
| 73 | 73 | * @var WP_Post |
| 74 | 74 | */ |
| 75 | - protected $post = null; |
|
| 76 | - |
|
| 77 | - /** |
|
| 78 | - * Get the discount if ID is passed, otherwise the discount is new and empty. |
|
| 79 | - * |
|
| 80 | - * @param int|array|string|WPInv_Discount|WP_Post $discount discount data, object, ID or code. |
|
| 81 | - */ |
|
| 82 | - public function __construct( $discount = 0 ) { |
|
| 83 | - parent::__construct( $discount ); |
|
| 84 | - |
|
| 85 | - if ( is_numeric( $discount ) && 'wpi_discount' === get_post_type( $discount ) ) { |
|
| 86 | - $this->set_id( $discount ); |
|
| 87 | - } elseif ( $discount instanceof self ) { |
|
| 88 | - $this->set_id( $discount->get_id() ); |
|
| 89 | - } elseif ( ! empty( $discount->ID ) ) { |
|
| 90 | - $this->set_id( $discount->ID ); |
|
| 91 | - } elseif ( is_array( $discount ) ) { |
|
| 92 | - $this->set_props( $discount ); |
|
| 93 | - |
|
| 94 | - if ( isset( $discount['ID'] ) ) { |
|
| 95 | - $this->set_id( $discount['ID'] ); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - } elseif ( is_scalar( $discount ) && $discount = self::get_discount_id_by_code( $discount ) ) { |
|
| 99 | - $this->set_id( $discount ); |
|
| 100 | - } else { |
|
| 101 | - $this->set_object_read( true ); |
|
| 102 | - } |
|
| 75 | + protected $post = null; |
|
| 76 | + |
|
| 77 | + /** |
|
| 78 | + * Get the discount if ID is passed, otherwise the discount is new and empty. |
|
| 79 | + * |
|
| 80 | + * @param int|array|string|WPInv_Discount|WP_Post $discount discount data, object, ID or code. |
|
| 81 | + */ |
|
| 82 | + public function __construct( $discount = 0 ) { |
|
| 83 | + parent::__construct( $discount ); |
|
| 84 | + |
|
| 85 | + if ( is_numeric( $discount ) && 'wpi_discount' === get_post_type( $discount ) ) { |
|
| 86 | + $this->set_id( $discount ); |
|
| 87 | + } elseif ( $discount instanceof self ) { |
|
| 88 | + $this->set_id( $discount->get_id() ); |
|
| 89 | + } elseif ( ! empty( $discount->ID ) ) { |
|
| 90 | + $this->set_id( $discount->ID ); |
|
| 91 | + } elseif ( is_array( $discount ) ) { |
|
| 92 | + $this->set_props( $discount ); |
|
| 93 | + |
|
| 94 | + if ( isset( $discount['ID'] ) ) { |
|
| 95 | + $this->set_id( $discount['ID'] ); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + } elseif ( is_scalar( $discount ) && $discount = self::get_discount_id_by_code( $discount ) ) { |
|
| 99 | + $this->set_id( $discount ); |
|
| 100 | + } else { |
|
| 101 | + $this->set_object_read( true ); |
|
| 102 | + } |
|
| 103 | 103 | |
| 104 | 104 | // Load the datastore. |
| 105 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 105 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 106 | 106 | |
| 107 | - if ( $this->get_id() > 0 ) { |
|
| 107 | + if ( $this->get_id() > 0 ) { |
|
| 108 | 108 | $this->post = get_post( $this->get_id() ); |
| 109 | 109 | $this->ID = $this->get_id(); |
| 110 | - $this->data_store->read( $this ); |
|
| 110 | + $this->data_store->read( $this ); |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * Fetch a discount from the db/cache |
|
| 117 | + * |
|
| 118 | + * |
|
| 119 | + * @static |
|
| 120 | + * @param string $field The field to query against: 'ID', 'discount_code' |
|
| 121 | + * @param string|int $value The field value |
|
| 122 | + * @deprecated |
|
| 123 | + * @since 1.0.15 |
|
| 124 | + * @return array|bool array of discount details on success. False otherwise. |
|
| 125 | + */ |
|
| 126 | + public static function get_data_by( $field, $value ) { |
|
| 127 | + |
|
| 128 | + if ( 'id' == strtolower( $field ) ) { |
|
| 129 | + // Make sure the value is numeric to avoid casting objects, for example, |
|
| 130 | + // to int 1. |
|
| 131 | + if ( ! is_numeric( $value ) ) |
|
| 132 | + return false; |
|
| 133 | + $value = intval( $value ); |
|
| 134 | + if ( $value < 1 ) |
|
| 135 | + return false; |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + if ( ! $value || ! is_string( $field ) ) { |
|
| 139 | + return false; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + $field = trim( $field ); |
|
| 143 | + |
|
| 144 | + // prepare query args |
|
| 145 | + switch ( strtolower( $field ) ) { |
|
| 146 | + case 'id': |
|
| 147 | + $discount_id = $value; |
|
| 148 | + $args = array( 'include' => array( $value ) ); |
|
| 149 | + break; |
|
| 150 | + case 'discount_code': |
|
| 151 | + case 'code': |
|
| 152 | + $value = trim( $value ); |
|
| 153 | + $discount_id = wp_cache_get( $value, 'WPInv_Discount_Codes' ); |
|
| 154 | + $args = array( 'meta_key' => '_wpi_discount_code', 'meta_value' => $value ); |
|
| 155 | + break; |
|
| 156 | + case 'name': |
|
| 157 | + $discount_id = 0; |
|
| 158 | + $args = array( 'name' => trim( $value ) ); |
|
| 159 | + break; |
|
| 160 | + default: |
|
| 161 | + $args = apply_filters( "wpinv_discount_get_data_by_{$field}_args", null, $value ); |
|
| 162 | + if ( ! is_array( $args ) ) { |
|
| 163 | + return apply_filters( "wpinv_discount_get_data_by_$field", false, $value ); |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + // Check if there is a cached value. |
|
| 169 | + if ( ! empty( $discount_id ) && $discount = wp_cache_get( (int) $discount_id, 'WPInv_Discounts' ) ) { |
|
| 170 | + return $discount; |
|
| 171 | + } |
|
| 172 | + |
|
| 173 | + $args = array_merge( |
|
| 174 | + $args, |
|
| 175 | + array( |
|
| 176 | + 'post_type' => 'wpi_discount', |
|
| 177 | + 'posts_per_page' => 1, |
|
| 178 | + 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ) |
|
| 179 | + ) |
|
| 180 | + ); |
|
| 181 | + |
|
| 182 | + $discount = get_posts( $args ); |
|
| 183 | + |
|
| 184 | + if( empty( $discount ) ) { |
|
| 185 | + return false; |
|
| 111 | 186 | } |
| 112 | 187 | |
| 113 | - } |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * Fetch a discount from the db/cache |
|
| 117 | - * |
|
| 118 | - * |
|
| 119 | - * @static |
|
| 120 | - * @param string $field The field to query against: 'ID', 'discount_code' |
|
| 121 | - * @param string|int $value The field value |
|
| 122 | - * @deprecated |
|
| 123 | - * @since 1.0.15 |
|
| 124 | - * @return array|bool array of discount details on success. False otherwise. |
|
| 125 | - */ |
|
| 126 | - public static function get_data_by( $field, $value ) { |
|
| 127 | - |
|
| 128 | - if ( 'id' == strtolower( $field ) ) { |
|
| 129 | - // Make sure the value is numeric to avoid casting objects, for example, |
|
| 130 | - // to int 1. |
|
| 131 | - if ( ! is_numeric( $value ) ) |
|
| 132 | - return false; |
|
| 133 | - $value = intval( $value ); |
|
| 134 | - if ( $value < 1 ) |
|
| 135 | - return false; |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - if ( ! $value || ! is_string( $field ) ) { |
|
| 139 | - return false; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - $field = trim( $field ); |
|
| 143 | - |
|
| 144 | - // prepare query args |
|
| 145 | - switch ( strtolower( $field ) ) { |
|
| 146 | - case 'id': |
|
| 147 | - $discount_id = $value; |
|
| 148 | - $args = array( 'include' => array( $value ) ); |
|
| 149 | - break; |
|
| 150 | - case 'discount_code': |
|
| 151 | - case 'code': |
|
| 152 | - $value = trim( $value ); |
|
| 153 | - $discount_id = wp_cache_get( $value, 'WPInv_Discount_Codes' ); |
|
| 154 | - $args = array( 'meta_key' => '_wpi_discount_code', 'meta_value' => $value ); |
|
| 155 | - break; |
|
| 156 | - case 'name': |
|
| 157 | - $discount_id = 0; |
|
| 158 | - $args = array( 'name' => trim( $value ) ); |
|
| 159 | - break; |
|
| 160 | - default: |
|
| 161 | - $args = apply_filters( "wpinv_discount_get_data_by_{$field}_args", null, $value ); |
|
| 162 | - if ( ! is_array( $args ) ) { |
|
| 163 | - return apply_filters( "wpinv_discount_get_data_by_$field", false, $value ); |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - // Check if there is a cached value. |
|
| 169 | - if ( ! empty( $discount_id ) && $discount = wp_cache_get( (int) $discount_id, 'WPInv_Discounts' ) ) { |
|
| 170 | - return $discount; |
|
| 171 | - } |
|
| 172 | - |
|
| 173 | - $args = array_merge( |
|
| 174 | - $args, |
|
| 175 | - array( |
|
| 176 | - 'post_type' => 'wpi_discount', |
|
| 177 | - 'posts_per_page' => 1, |
|
| 178 | - 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ) |
|
| 179 | - ) |
|
| 180 | - ); |
|
| 181 | - |
|
| 182 | - $discount = get_posts( $args ); |
|
| 183 | - |
|
| 184 | - if( empty( $discount ) ) { |
|
| 185 | - return false; |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - $discount = $discount[0]; |
|
| 189 | - |
|
| 190 | - // Prepare the return data. |
|
| 191 | - $return = array( |
|
| 188 | + $discount = $discount[0]; |
|
| 189 | + |
|
| 190 | + // Prepare the return data. |
|
| 191 | + $return = array( |
|
| 192 | 192 | 'ID' => $discount->ID, |
| 193 | 193 | 'code' => get_post_meta( $discount->ID, '_wpi_discount_code', true ), |
| 194 | 194 | 'amount' => get_post_meta( $discount->ID, '_wpi_discount_amount', true ), |
| 195 | 195 | 'date_created' => $discount->post_date, |
| 196 | - 'date_modified' => $discount->post_modified, |
|
| 197 | - 'status' => $discount->post_status, |
|
| 198 | - 'start' => get_post_meta( $discount->ID, '_wpi_discount_start', true ), |
|
| 196 | + 'date_modified' => $discount->post_modified, |
|
| 197 | + 'status' => $discount->post_status, |
|
| 198 | + 'start' => get_post_meta( $discount->ID, '_wpi_discount_start', true ), |
|
| 199 | 199 | 'expiration' => get_post_meta( $discount->ID, '_wpi_discount_expiration', true ), |
| 200 | 200 | 'type' => get_post_meta( $discount->ID, '_wpi_discount_type', true ), |
| 201 | 201 | 'description' => $discount->post_excerpt, |
@@ -209,77 +209,77 @@ discard block |
||
| 209 | 209 | 'max_total' => get_post_meta( $discount->ID, '_wpi_discount_max_total', true ), |
| 210 | 210 | ); |
| 211 | 211 | |
| 212 | - $return = apply_filters( 'wpinv_discount_properties', $return ); |
|
| 213 | - |
|
| 214 | - // Update the cache with our data |
|
| 215 | - wp_cache_add( $discount->ID, $return, 'WPInv_Discounts' ); |
|
| 216 | - wp_cache_add( $return['code'], $discount->ID, 'WPInv_Discount_Codes' ); |
|
| 217 | - |
|
| 218 | - return $return; |
|
| 219 | - } |
|
| 220 | - |
|
| 221 | - /** |
|
| 222 | - * Given a discount code, it returns a discount id. |
|
| 223 | - * |
|
| 224 | - * |
|
| 225 | - * @static |
|
| 226 | - * @param string $discount_code |
|
| 227 | - * @since 1.0.15 |
|
| 228 | - * @return int |
|
| 229 | - */ |
|
| 230 | - public static function get_discount_id_by_code( $discount_code ) { |
|
| 231 | - |
|
| 232 | - // Trim the code. |
|
| 233 | - $discount_code = trim( $discount_code ); |
|
| 234 | - |
|
| 235 | - // Ensure a value has been passed. |
|
| 236 | - if ( empty( $discount_code ) ) { |
|
| 237 | - return 0; |
|
| 238 | - } |
|
| 239 | - |
|
| 240 | - // Maybe retrieve from the cache. |
|
| 241 | - $discount_id = wp_cache_get( $discount_code, 'getpaid_discount_codes' ); |
|
| 242 | - if ( ! empty( $discount_id ) ) { |
|
| 243 | - return $discount_id; |
|
| 244 | - } |
|
| 245 | - |
|
| 246 | - // Fetch the first discount codes. |
|
| 247 | - $discounts = get_posts( |
|
| 248 | - array( |
|
| 249 | - 'meta_key' => '_wpi_discount_code', |
|
| 250 | - 'meta_value' => $discount_code, |
|
| 251 | - 'post_type' => 'wpi_discount', |
|
| 252 | - 'posts_per_page' => 1, |
|
| 253 | - 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ), |
|
| 254 | - 'fields' => 'ids', |
|
| 255 | - ) |
|
| 256 | - ); |
|
| 257 | - |
|
| 258 | - if ( empty( $discounts ) ) { |
|
| 259 | - return 0; |
|
| 260 | - } |
|
| 261 | - |
|
| 262 | - $discount_id = $discounts[0]; |
|
| 263 | - |
|
| 264 | - // Update the cache with our data |
|
| 265 | - wp_cache_add( get_post_meta( $discount_id, '_wpi_discount_code', true ), $discount_id, 'getpaid_discount_codes' ); |
|
| 266 | - |
|
| 267 | - return $discount_id; |
|
| 268 | - } |
|
| 269 | - |
|
| 270 | - /** |
|
| 271 | - * Magic method for checking the existence of a certain custom field. |
|
| 272 | - * |
|
| 273 | - * @since 1.0.15 |
|
| 274 | - * @access public |
|
| 275 | - * |
|
| 276 | - * @return bool Whether the given discount field is set. |
|
| 277 | - */ |
|
| 278 | - public function __isset( $key ){ |
|
| 279 | - return isset( $this->data[$key] ) || method_exists( $this, "get_$key"); |
|
| 280 | - } |
|
| 281 | - |
|
| 282 | - /* |
|
| 212 | + $return = apply_filters( 'wpinv_discount_properties', $return ); |
|
| 213 | + |
|
| 214 | + // Update the cache with our data |
|
| 215 | + wp_cache_add( $discount->ID, $return, 'WPInv_Discounts' ); |
|
| 216 | + wp_cache_add( $return['code'], $discount->ID, 'WPInv_Discount_Codes' ); |
|
| 217 | + |
|
| 218 | + return $return; |
|
| 219 | + } |
|
| 220 | + |
|
| 221 | + /** |
|
| 222 | + * Given a discount code, it returns a discount id. |
|
| 223 | + * |
|
| 224 | + * |
|
| 225 | + * @static |
|
| 226 | + * @param string $discount_code |
|
| 227 | + * @since 1.0.15 |
|
| 228 | + * @return int |
|
| 229 | + */ |
|
| 230 | + public static function get_discount_id_by_code( $discount_code ) { |
|
| 231 | + |
|
| 232 | + // Trim the code. |
|
| 233 | + $discount_code = trim( $discount_code ); |
|
| 234 | + |
|
| 235 | + // Ensure a value has been passed. |
|
| 236 | + if ( empty( $discount_code ) ) { |
|
| 237 | + return 0; |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + // Maybe retrieve from the cache. |
|
| 241 | + $discount_id = wp_cache_get( $discount_code, 'getpaid_discount_codes' ); |
|
| 242 | + if ( ! empty( $discount_id ) ) { |
|
| 243 | + return $discount_id; |
|
| 244 | + } |
|
| 245 | + |
|
| 246 | + // Fetch the first discount codes. |
|
| 247 | + $discounts = get_posts( |
|
| 248 | + array( |
|
| 249 | + 'meta_key' => '_wpi_discount_code', |
|
| 250 | + 'meta_value' => $discount_code, |
|
| 251 | + 'post_type' => 'wpi_discount', |
|
| 252 | + 'posts_per_page' => 1, |
|
| 253 | + 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ), |
|
| 254 | + 'fields' => 'ids', |
|
| 255 | + ) |
|
| 256 | + ); |
|
| 257 | + |
|
| 258 | + if ( empty( $discounts ) ) { |
|
| 259 | + return 0; |
|
| 260 | + } |
|
| 261 | + |
|
| 262 | + $discount_id = $discounts[0]; |
|
| 263 | + |
|
| 264 | + // Update the cache with our data |
|
| 265 | + wp_cache_add( get_post_meta( $discount_id, '_wpi_discount_code', true ), $discount_id, 'getpaid_discount_codes' ); |
|
| 266 | + |
|
| 267 | + return $discount_id; |
|
| 268 | + } |
|
| 269 | + |
|
| 270 | + /** |
|
| 271 | + * Magic method for checking the existence of a certain custom field. |
|
| 272 | + * |
|
| 273 | + * @since 1.0.15 |
|
| 274 | + * @access public |
|
| 275 | + * |
|
| 276 | + * @return bool Whether the given discount field is set. |
|
| 277 | + */ |
|
| 278 | + public function __isset( $key ){ |
|
| 279 | + return isset( $this->data[$key] ) || method_exists( $this, "get_$key"); |
|
| 280 | + } |
|
| 281 | + |
|
| 282 | + /* |
|
| 283 | 283 | |-------------------------------------------------------------------------- |
| 284 | 284 | | CRUD methods |
| 285 | 285 | |-------------------------------------------------------------------------- |
@@ -294,430 +294,430 @@ discard block |
||
| 294 | 294 | |-------------------------------------------------------------------------- |
| 295 | 295 | */ |
| 296 | 296 | |
| 297 | - /** |
|
| 298 | - * Get discount status. |
|
| 299 | - * |
|
| 300 | - * @since 1.0.19 |
|
| 301 | - * @param string $context View or edit context. |
|
| 302 | - * @return string |
|
| 303 | - */ |
|
| 304 | - public function get_status( $context = 'view' ) { |
|
| 305 | - return $this->get_prop( 'status', $context ); |
|
| 297 | + /** |
|
| 298 | + * Get discount status. |
|
| 299 | + * |
|
| 300 | + * @since 1.0.19 |
|
| 301 | + * @param string $context View or edit context. |
|
| 302 | + * @return string |
|
| 303 | + */ |
|
| 304 | + public function get_status( $context = 'view' ) { |
|
| 305 | + return $this->get_prop( 'status', $context ); |
|
| 306 | 306 | } |
| 307 | 307 | |
| 308 | 308 | /** |
| 309 | - * Get plugin version when the discount was created. |
|
| 310 | - * |
|
| 311 | - * @since 1.0.19 |
|
| 312 | - * @param string $context View or edit context. |
|
| 313 | - * @return string |
|
| 314 | - */ |
|
| 315 | - public function get_version( $context = 'view' ) { |
|
| 316 | - return $this->get_prop( 'version', $context ); |
|
| 309 | + * Get plugin version when the discount was created. |
|
| 310 | + * |
|
| 311 | + * @since 1.0.19 |
|
| 312 | + * @param string $context View or edit context. |
|
| 313 | + * @return string |
|
| 314 | + */ |
|
| 315 | + public function get_version( $context = 'view' ) { |
|
| 316 | + return $this->get_prop( 'version', $context ); |
|
| 317 | 317 | } |
| 318 | 318 | |
| 319 | 319 | /** |
| 320 | - * Get date when the discount was created. |
|
| 321 | - * |
|
| 322 | - * @since 1.0.19 |
|
| 323 | - * @param string $context View or edit context. |
|
| 324 | - * @return string |
|
| 325 | - */ |
|
| 326 | - public function get_date_created( $context = 'view' ) { |
|
| 327 | - return $this->get_prop( 'date_created', $context ); |
|
| 320 | + * Get date when the discount was created. |
|
| 321 | + * |
|
| 322 | + * @since 1.0.19 |
|
| 323 | + * @param string $context View or edit context. |
|
| 324 | + * @return string |
|
| 325 | + */ |
|
| 326 | + public function get_date_created( $context = 'view' ) { |
|
| 327 | + return $this->get_prop( 'date_created', $context ); |
|
| 328 | 328 | } |
| 329 | 329 | |
| 330 | 330 | /** |
| 331 | - * Get GMT date when the discount was created. |
|
| 332 | - * |
|
| 333 | - * @since 1.0.19 |
|
| 334 | - * @param string $context View or edit context. |
|
| 335 | - * @return string |
|
| 336 | - */ |
|
| 337 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 331 | + * Get GMT date when the discount was created. |
|
| 332 | + * |
|
| 333 | + * @since 1.0.19 |
|
| 334 | + * @param string $context View or edit context. |
|
| 335 | + * @return string |
|
| 336 | + */ |
|
| 337 | + public function get_date_created_gmt( $context = 'view' ) { |
|
| 338 | 338 | $date = $this->get_date_created( $context ); |
| 339 | 339 | |
| 340 | 340 | if ( $date ) { |
| 341 | 341 | $date = get_gmt_from_date( $date ); |
| 342 | 342 | } |
| 343 | - return $date; |
|
| 343 | + return $date; |
|
| 344 | 344 | } |
| 345 | 345 | |
| 346 | 346 | /** |
| 347 | - * Get date when the discount was last modified. |
|
| 348 | - * |
|
| 349 | - * @since 1.0.19 |
|
| 350 | - * @param string $context View or edit context. |
|
| 351 | - * @return string |
|
| 352 | - */ |
|
| 353 | - public function get_date_modified( $context = 'view' ) { |
|
| 354 | - return $this->get_prop( 'date_modified', $context ); |
|
| 347 | + * Get date when the discount was last modified. |
|
| 348 | + * |
|
| 349 | + * @since 1.0.19 |
|
| 350 | + * @param string $context View or edit context. |
|
| 351 | + * @return string |
|
| 352 | + */ |
|
| 353 | + public function get_date_modified( $context = 'view' ) { |
|
| 354 | + return $this->get_prop( 'date_modified', $context ); |
|
| 355 | 355 | } |
| 356 | 356 | |
| 357 | 357 | /** |
| 358 | - * Get GMT date when the discount was last modified. |
|
| 359 | - * |
|
| 360 | - * @since 1.0.19 |
|
| 361 | - * @param string $context View or edit context. |
|
| 362 | - * @return string |
|
| 363 | - */ |
|
| 364 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
| 358 | + * Get GMT date when the discount was last modified. |
|
| 359 | + * |
|
| 360 | + * @since 1.0.19 |
|
| 361 | + * @param string $context View or edit context. |
|
| 362 | + * @return string |
|
| 363 | + */ |
|
| 364 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
| 365 | 365 | $date = $this->get_date_modified( $context ); |
| 366 | 366 | |
| 367 | 367 | if ( $date ) { |
| 368 | 368 | $date = get_gmt_from_date( $date ); |
| 369 | 369 | } |
| 370 | - return $date; |
|
| 370 | + return $date; |
|
| 371 | 371 | } |
| 372 | 372 | |
| 373 | 373 | /** |
| 374 | - * Get the discount name. |
|
| 375 | - * |
|
| 376 | - * @since 1.0.19 |
|
| 377 | - * @param string $context View or edit context. |
|
| 378 | - * @return string |
|
| 379 | - */ |
|
| 380 | - public function get_name( $context = 'view' ) { |
|
| 381 | - return $this->get_prop( 'name', $context ); |
|
| 374 | + * Get the discount name. |
|
| 375 | + * |
|
| 376 | + * @since 1.0.19 |
|
| 377 | + * @param string $context View or edit context. |
|
| 378 | + * @return string |
|
| 379 | + */ |
|
| 380 | + public function get_name( $context = 'view' ) { |
|
| 381 | + return $this->get_prop( 'name', $context ); |
|
| 382 | 382 | } |
| 383 | 383 | |
| 384 | 384 | /** |
| 385 | - * Alias of self::get_name(). |
|
| 386 | - * |
|
| 387 | - * @since 1.0.19 |
|
| 388 | - * @param string $context View or edit context. |
|
| 389 | - * @return string |
|
| 390 | - */ |
|
| 391 | - public function get_title( $context = 'view' ) { |
|
| 392 | - return $this->get_name( $context ); |
|
| 385 | + * Alias of self::get_name(). |
|
| 386 | + * |
|
| 387 | + * @since 1.0.19 |
|
| 388 | + * @param string $context View or edit context. |
|
| 389 | + * @return string |
|
| 390 | + */ |
|
| 391 | + public function get_title( $context = 'view' ) { |
|
| 392 | + return $this->get_name( $context ); |
|
| 393 | 393 | } |
| 394 | 394 | |
| 395 | 395 | /** |
| 396 | - * Get the discount description. |
|
| 397 | - * |
|
| 398 | - * @since 1.0.19 |
|
| 399 | - * @param string $context View or edit context. |
|
| 400 | - * @return string |
|
| 401 | - */ |
|
| 402 | - public function get_description( $context = 'view' ) { |
|
| 403 | - return $this->get_prop( 'description', $context ); |
|
| 396 | + * Get the discount description. |
|
| 397 | + * |
|
| 398 | + * @since 1.0.19 |
|
| 399 | + * @param string $context View or edit context. |
|
| 400 | + * @return string |
|
| 401 | + */ |
|
| 402 | + public function get_description( $context = 'view' ) { |
|
| 403 | + return $this->get_prop( 'description', $context ); |
|
| 404 | 404 | } |
| 405 | 405 | |
| 406 | 406 | /** |
| 407 | - * Alias of self::get_description(). |
|
| 408 | - * |
|
| 409 | - * @since 1.0.19 |
|
| 410 | - * @param string $context View or edit context. |
|
| 411 | - * @return string |
|
| 412 | - */ |
|
| 413 | - public function get_excerpt( $context = 'view' ) { |
|
| 414 | - return $this->get_description( $context ); |
|
| 407 | + * Alias of self::get_description(). |
|
| 408 | + * |
|
| 409 | + * @since 1.0.19 |
|
| 410 | + * @param string $context View or edit context. |
|
| 411 | + * @return string |
|
| 412 | + */ |
|
| 413 | + public function get_excerpt( $context = 'view' ) { |
|
| 414 | + return $this->get_description( $context ); |
|
| 415 | 415 | } |
| 416 | 416 | |
| 417 | 417 | /** |
| 418 | - * Alias of self::get_description(). |
|
| 419 | - * |
|
| 420 | - * @since 1.0.19 |
|
| 421 | - * @param string $context View or edit context. |
|
| 422 | - * @return string |
|
| 423 | - */ |
|
| 424 | - public function get_summary( $context = 'view' ) { |
|
| 425 | - return $this->get_description( $context ); |
|
| 418 | + * Alias of self::get_description(). |
|
| 419 | + * |
|
| 420 | + * @since 1.0.19 |
|
| 421 | + * @param string $context View or edit context. |
|
| 422 | + * @return string |
|
| 423 | + */ |
|
| 424 | + public function get_summary( $context = 'view' ) { |
|
| 425 | + return $this->get_description( $context ); |
|
| 426 | 426 | } |
| 427 | 427 | |
| 428 | 428 | /** |
| 429 | - * Get the owner of the discount. |
|
| 430 | - * |
|
| 431 | - * @since 1.0.19 |
|
| 432 | - * @param string $context View or edit context. |
|
| 433 | - * @return string |
|
| 434 | - */ |
|
| 435 | - public function get_author( $context = 'view' ) { |
|
| 436 | - return (int) $this->get_prop( 'author', $context ); |
|
| 437 | - } |
|
| 429 | + * Get the owner of the discount. |
|
| 430 | + * |
|
| 431 | + * @since 1.0.19 |
|
| 432 | + * @param string $context View or edit context. |
|
| 433 | + * @return string |
|
| 434 | + */ |
|
| 435 | + public function get_author( $context = 'view' ) { |
|
| 436 | + return (int) $this->get_prop( 'author', $context ); |
|
| 437 | + } |
|
| 438 | 438 | |
| 439 | - /** |
|
| 440 | - * Get the discount code. |
|
| 441 | - * |
|
| 442 | - * @since 1.0.19 |
|
| 443 | - * @param string $context View or edit context. |
|
| 444 | - * @return string |
|
| 445 | - */ |
|
| 446 | - public function get_code( $context = 'view' ) { |
|
| 447 | - return $this->get_prop( 'code', $context ); |
|
| 448 | - } |
|
| 439 | + /** |
|
| 440 | + * Get the discount code. |
|
| 441 | + * |
|
| 442 | + * @since 1.0.19 |
|
| 443 | + * @param string $context View or edit context. |
|
| 444 | + * @return string |
|
| 445 | + */ |
|
| 446 | + public function get_code( $context = 'view' ) { |
|
| 447 | + return $this->get_prop( 'code', $context ); |
|
| 448 | + } |
|
| 449 | 449 | |
| 450 | - /** |
|
| 451 | - * Alias for self::get_code(). |
|
| 452 | - * |
|
| 453 | - * @since 1.0.19 |
|
| 454 | - * @param string $context View or edit context. |
|
| 455 | - * @return string |
|
| 456 | - */ |
|
| 457 | - public function get_coupon_code( $context = 'view' ) { |
|
| 458 | - return $this->get_code( $context ); |
|
| 459 | - } |
|
| 450 | + /** |
|
| 451 | + * Alias for self::get_code(). |
|
| 452 | + * |
|
| 453 | + * @since 1.0.19 |
|
| 454 | + * @param string $context View or edit context. |
|
| 455 | + * @return string |
|
| 456 | + */ |
|
| 457 | + public function get_coupon_code( $context = 'view' ) { |
|
| 458 | + return $this->get_code( $context ); |
|
| 459 | + } |
|
| 460 | 460 | |
| 461 | - /** |
|
| 462 | - * Alias for self::get_code(). |
|
| 463 | - * |
|
| 464 | - * @since 1.0.19 |
|
| 465 | - * @param string $context View or edit context. |
|
| 466 | - * @return string |
|
| 467 | - */ |
|
| 468 | - public function get_discount_code( $context = 'view' ) { |
|
| 469 | - return $this->get_code( $context ); |
|
| 470 | - } |
|
| 461 | + /** |
|
| 462 | + * Alias for self::get_code(). |
|
| 463 | + * |
|
| 464 | + * @since 1.0.19 |
|
| 465 | + * @param string $context View or edit context. |
|
| 466 | + * @return string |
|
| 467 | + */ |
|
| 468 | + public function get_discount_code( $context = 'view' ) { |
|
| 469 | + return $this->get_code( $context ); |
|
| 470 | + } |
|
| 471 | 471 | |
| 472 | - /** |
|
| 473 | - * Get the discount's amount. |
|
| 474 | - * |
|
| 475 | - * @since 1.0.19 |
|
| 476 | - * @param string $context View or edit context. |
|
| 477 | - * @return float |
|
| 478 | - */ |
|
| 479 | - public function get_amount( $context = 'view' ) { |
|
| 480 | - return $this->get_prop( 'amount', $context ); |
|
| 481 | - } |
|
| 482 | - |
|
| 483 | - /** |
|
| 484 | - * Get the discount's formated amount/rate. |
|
| 485 | - * |
|
| 486 | - * @since 1.0.19 |
|
| 487 | - * @return string |
|
| 488 | - */ |
|
| 489 | - public function get_formatted_amount() { |
|
| 490 | - |
|
| 491 | - if ( $this->is_type( 'flat' ) ) { |
|
| 492 | - $rate = wpinv_price( wpinv_format_amount( $this->get_amount() ) ); |
|
| 493 | - } else { |
|
| 494 | - $rate = $this->get_amount() . '%'; |
|
| 495 | - } |
|
| 496 | - |
|
| 497 | - return apply_filters( 'wpinv_format_discount_rate', $rate, $this->get_type(), $this->get_amount() ); |
|
| 498 | - } |
|
| 472 | + /** |
|
| 473 | + * Get the discount's amount. |
|
| 474 | + * |
|
| 475 | + * @since 1.0.19 |
|
| 476 | + * @param string $context View or edit context. |
|
| 477 | + * @return float |
|
| 478 | + */ |
|
| 479 | + public function get_amount( $context = 'view' ) { |
|
| 480 | + return $this->get_prop( 'amount', $context ); |
|
| 481 | + } |
|
| 482 | + |
|
| 483 | + /** |
|
| 484 | + * Get the discount's formated amount/rate. |
|
| 485 | + * |
|
| 486 | + * @since 1.0.19 |
|
| 487 | + * @return string |
|
| 488 | + */ |
|
| 489 | + public function get_formatted_amount() { |
|
| 490 | + |
|
| 491 | + if ( $this->is_type( 'flat' ) ) { |
|
| 492 | + $rate = wpinv_price( wpinv_format_amount( $this->get_amount() ) ); |
|
| 493 | + } else { |
|
| 494 | + $rate = $this->get_amount() . '%'; |
|
| 495 | + } |
|
| 496 | + |
|
| 497 | + return apply_filters( 'wpinv_format_discount_rate', $rate, $this->get_type(), $this->get_amount() ); |
|
| 498 | + } |
|
| 499 | 499 | |
| 500 | - /** |
|
| 501 | - * Get the discount's start date. |
|
| 502 | - * |
|
| 503 | - * @since 1.0.19 |
|
| 504 | - * @param string $context View or edit context. |
|
| 505 | - * @return string |
|
| 506 | - */ |
|
| 507 | - public function get_start( $context = 'view' ) { |
|
| 508 | - return $this->get_prop( 'start', $context ); |
|
| 509 | - } |
|
| 500 | + /** |
|
| 501 | + * Get the discount's start date. |
|
| 502 | + * |
|
| 503 | + * @since 1.0.19 |
|
| 504 | + * @param string $context View or edit context. |
|
| 505 | + * @return string |
|
| 506 | + */ |
|
| 507 | + public function get_start( $context = 'view' ) { |
|
| 508 | + return $this->get_prop( 'start', $context ); |
|
| 509 | + } |
|
| 510 | 510 | |
| 511 | - /** |
|
| 512 | - * Alias for self::get_start(). |
|
| 513 | - * |
|
| 514 | - * @since 1.0.19 |
|
| 515 | - * @param string $context View or edit context. |
|
| 516 | - * @return string |
|
| 517 | - */ |
|
| 518 | - public function get_start_date( $context = 'view' ) { |
|
| 519 | - return $this->get_start( $context ); |
|
| 520 | - } |
|
| 511 | + /** |
|
| 512 | + * Alias for self::get_start(). |
|
| 513 | + * |
|
| 514 | + * @since 1.0.19 |
|
| 515 | + * @param string $context View or edit context. |
|
| 516 | + * @return string |
|
| 517 | + */ |
|
| 518 | + public function get_start_date( $context = 'view' ) { |
|
| 519 | + return $this->get_start( $context ); |
|
| 520 | + } |
|
| 521 | 521 | |
| 522 | - /** |
|
| 523 | - * Get the discount's expiration date. |
|
| 524 | - * |
|
| 525 | - * @since 1.0.19 |
|
| 526 | - * @param string $context View or edit context. |
|
| 527 | - * @return string |
|
| 528 | - */ |
|
| 529 | - public function get_expiration( $context = 'view' ) { |
|
| 530 | - return $this->get_prop( 'expiration', $context ); |
|
| 531 | - } |
|
| 522 | + /** |
|
| 523 | + * Get the discount's expiration date. |
|
| 524 | + * |
|
| 525 | + * @since 1.0.19 |
|
| 526 | + * @param string $context View or edit context. |
|
| 527 | + * @return string |
|
| 528 | + */ |
|
| 529 | + public function get_expiration( $context = 'view' ) { |
|
| 530 | + return $this->get_prop( 'expiration', $context ); |
|
| 531 | + } |
|
| 532 | 532 | |
| 533 | - /** |
|
| 534 | - * Alias for self::get_expiration(). |
|
| 535 | - * |
|
| 536 | - * @since 1.0.19 |
|
| 537 | - * @param string $context View or edit context. |
|
| 538 | - * @return string |
|
| 539 | - */ |
|
| 540 | - public function get_expiration_date( $context = 'view' ) { |
|
| 541 | - return $this->get_expiration( $context ); |
|
| 542 | - } |
|
| 543 | - |
|
| 544 | - /** |
|
| 545 | - * Alias for self::get_expiration(). |
|
| 546 | - * |
|
| 547 | - * @since 1.0.19 |
|
| 548 | - * @param string $context View or edit context. |
|
| 549 | - * @return string |
|
| 550 | - */ |
|
| 551 | - public function get_end_date( $context = 'view' ) { |
|
| 552 | - return $this->get_expiration( $context ); |
|
| 553 | - } |
|
| 533 | + /** |
|
| 534 | + * Alias for self::get_expiration(). |
|
| 535 | + * |
|
| 536 | + * @since 1.0.19 |
|
| 537 | + * @param string $context View or edit context. |
|
| 538 | + * @return string |
|
| 539 | + */ |
|
| 540 | + public function get_expiration_date( $context = 'view' ) { |
|
| 541 | + return $this->get_expiration( $context ); |
|
| 542 | + } |
|
| 543 | + |
|
| 544 | + /** |
|
| 545 | + * Alias for self::get_expiration(). |
|
| 546 | + * |
|
| 547 | + * @since 1.0.19 |
|
| 548 | + * @param string $context View or edit context. |
|
| 549 | + * @return string |
|
| 550 | + */ |
|
| 551 | + public function get_end_date( $context = 'view' ) { |
|
| 552 | + return $this->get_expiration( $context ); |
|
| 553 | + } |
|
| 554 | 554 | |
| 555 | - /** |
|
| 556 | - * Get the discount's type. |
|
| 557 | - * |
|
| 558 | - * @since 1.0.19 |
|
| 559 | - * @param string $context View or edit context. |
|
| 560 | - * @return string |
|
| 561 | - */ |
|
| 562 | - public function get_type( $context = 'view' ) { |
|
| 563 | - return $this->get_prop( 'type', $context ); |
|
| 564 | - } |
|
| 565 | - |
|
| 566 | - /** |
|
| 567 | - * Get the number of times a discount has been used. |
|
| 568 | - * |
|
| 569 | - * @since 1.0.19 |
|
| 570 | - * @param string $context View or edit context. |
|
| 571 | - * @return int |
|
| 572 | - */ |
|
| 573 | - public function get_uses( $context = 'view' ) { |
|
| 574 | - return (int) $this->get_prop( 'uses', $context ); |
|
| 575 | - } |
|
| 576 | - |
|
| 577 | - /** |
|
| 578 | - * Get the discount's usage, i.e uses / max uses. |
|
| 579 | - * |
|
| 580 | - * @since 1.0.19 |
|
| 581 | - * @return string |
|
| 582 | - */ |
|
| 583 | - public function get_usage() { |
|
| 584 | - |
|
| 585 | - if ( ! $this->has_limit() ) { |
|
| 586 | - return $this->get_uses() . ' / ' . ' ∞'; |
|
| 587 | - } |
|
| 588 | - |
|
| 589 | - return $this->get_uses() . ' / ' . (int) $this->get_max_uses(); |
|
| 590 | - |
|
| 591 | - } |
|
| 592 | - |
|
| 593 | - /** |
|
| 594 | - * Get the maximum number of time a discount can be used. |
|
| 595 | - * |
|
| 596 | - * @since 1.0.19 |
|
| 597 | - * @param string $context View or edit context. |
|
| 598 | - * @return int |
|
| 599 | - */ |
|
| 600 | - public function get_max_uses( $context = 'view' ) { |
|
| 601 | - $max_uses = $this->get_prop( 'max_uses', $context ); |
|
| 602 | - return empty( $max_uses ) ? null : $max_uses; |
|
| 603 | - } |
|
| 604 | - |
|
| 605 | - /** |
|
| 606 | - * Checks if this is a single use discount or not. |
|
| 607 | - * |
|
| 608 | - * @since 1.0.19 |
|
| 609 | - * @param string $context View or edit context. |
|
| 610 | - * @return bool |
|
| 611 | - */ |
|
| 612 | - public function get_is_single_use( $context = 'view' ) { |
|
| 613 | - return $this->get_prop( 'is_single_use', $context ); |
|
| 614 | - } |
|
| 615 | - |
|
| 616 | - /** |
|
| 617 | - * Get the items that can be used with this discount. |
|
| 618 | - * |
|
| 619 | - * @since 1.0.19 |
|
| 620 | - * @param string $context View or edit context. |
|
| 621 | - * @return array |
|
| 622 | - */ |
|
| 623 | - public function get_items( $context = 'view' ) { |
|
| 624 | - return wpinv_parse_list( $this->get_prop( 'items', $context ) ); |
|
| 625 | - } |
|
| 626 | - |
|
| 627 | - /** |
|
| 628 | - * Alias for self::get_items(). |
|
| 629 | - * |
|
| 630 | - * @since 1.0.19 |
|
| 631 | - * @param string $context View or edit context. |
|
| 632 | - * @return array |
|
| 633 | - */ |
|
| 634 | - public function get_allowed_items( $context = 'view' ) { |
|
| 635 | - return $this->get_items( $context ); |
|
| 636 | - } |
|
| 637 | - |
|
| 638 | - /** |
|
| 639 | - * Get the items that are not allowed to use this discount. |
|
| 640 | - * |
|
| 641 | - * @since 1.0.19 |
|
| 642 | - * @param string $context View or edit context. |
|
| 643 | - * @return array |
|
| 644 | - */ |
|
| 645 | - public function get_excluded_items( $context = 'view' ) { |
|
| 646 | - return wpinv_parse_list( $this->get_prop( 'excluded_items', $context ) ); |
|
| 647 | - } |
|
| 648 | - |
|
| 649 | - /** |
|
| 650 | - * Checks if this is a recurring discount or not. |
|
| 651 | - * |
|
| 652 | - * @since 1.0.19 |
|
| 653 | - * @param string $context View or edit context. |
|
| 654 | - * @return int|string|bool |
|
| 655 | - */ |
|
| 656 | - public function get_is_recurring( $context = 'view' ) { |
|
| 657 | - return $this->get_prop( 'is_recurring', $context ); |
|
| 658 | - } |
|
| 659 | - |
|
| 660 | - /** |
|
| 661 | - * Get's the minimum total amount allowed for this discount. |
|
| 662 | - * |
|
| 663 | - * @since 1.0.19 |
|
| 664 | - * @param string $context View or edit context. |
|
| 665 | - * @return float |
|
| 666 | - */ |
|
| 667 | - public function get_min_total( $context = 'view' ) { |
|
| 668 | - $minimum = $this->get_prop( 'min_total', $context ); |
|
| 669 | - return empty( $minimum ) ? null : $minimum; |
|
| 670 | - } |
|
| 671 | - |
|
| 672 | - /** |
|
| 673 | - * Alias for self::get_min_total(). |
|
| 674 | - * |
|
| 675 | - * @since 1.0.19 |
|
| 676 | - * @param string $context View or edit context. |
|
| 677 | - * @return float |
|
| 678 | - */ |
|
| 679 | - public function get_minimum_total( $context = 'view' ) { |
|
| 680 | - return $this->get_min_total( $context ); |
|
| 681 | - } |
|
| 682 | - |
|
| 683 | - /** |
|
| 684 | - * Get's the maximum total amount allowed for this discount. |
|
| 685 | - * |
|
| 686 | - * @since 1.0.19 |
|
| 687 | - * @param string $context View or edit context. |
|
| 688 | - * @return float |
|
| 689 | - */ |
|
| 690 | - public function get_max_total( $context = 'view' ) { |
|
| 691 | - $maximum = $this->get_prop( 'max_total', $context ); |
|
| 692 | - return empty( $maximum ) ? null : $maximum; |
|
| 693 | - } |
|
| 694 | - |
|
| 695 | - /** |
|
| 696 | - * Alias for self::get_max_total(). |
|
| 697 | - * |
|
| 698 | - * @since 1.0.19 |
|
| 699 | - * @param string $context View or edit context. |
|
| 700 | - * @return float |
|
| 701 | - */ |
|
| 702 | - public function get_maximum_total( $context = 'view' ) { |
|
| 703 | - return $this->get_max_total( $context ); |
|
| 704 | - } |
|
| 705 | - |
|
| 706 | - /** |
|
| 707 | - * Magic method for accessing discount properties. |
|
| 708 | - * |
|
| 709 | - * @since 1.0.15 |
|
| 710 | - * @access public |
|
| 711 | - * |
|
| 712 | - * @param string $key Discount data to retrieve |
|
| 713 | - * @param string $context View or edit context. |
|
| 714 | - * @return mixed Value of the given discount property (if set). |
|
| 715 | - */ |
|
| 716 | - public function get( $key, $context = 'view' ) { |
|
| 555 | + /** |
|
| 556 | + * Get the discount's type. |
|
| 557 | + * |
|
| 558 | + * @since 1.0.19 |
|
| 559 | + * @param string $context View or edit context. |
|
| 560 | + * @return string |
|
| 561 | + */ |
|
| 562 | + public function get_type( $context = 'view' ) { |
|
| 563 | + return $this->get_prop( 'type', $context ); |
|
| 564 | + } |
|
| 565 | + |
|
| 566 | + /** |
|
| 567 | + * Get the number of times a discount has been used. |
|
| 568 | + * |
|
| 569 | + * @since 1.0.19 |
|
| 570 | + * @param string $context View or edit context. |
|
| 571 | + * @return int |
|
| 572 | + */ |
|
| 573 | + public function get_uses( $context = 'view' ) { |
|
| 574 | + return (int) $this->get_prop( 'uses', $context ); |
|
| 575 | + } |
|
| 576 | + |
|
| 577 | + /** |
|
| 578 | + * Get the discount's usage, i.e uses / max uses. |
|
| 579 | + * |
|
| 580 | + * @since 1.0.19 |
|
| 581 | + * @return string |
|
| 582 | + */ |
|
| 583 | + public function get_usage() { |
|
| 584 | + |
|
| 585 | + if ( ! $this->has_limit() ) { |
|
| 586 | + return $this->get_uses() . ' / ' . ' ∞'; |
|
| 587 | + } |
|
| 588 | + |
|
| 589 | + return $this->get_uses() . ' / ' . (int) $this->get_max_uses(); |
|
| 590 | + |
|
| 591 | + } |
|
| 592 | + |
|
| 593 | + /** |
|
| 594 | + * Get the maximum number of time a discount can be used. |
|
| 595 | + * |
|
| 596 | + * @since 1.0.19 |
|
| 597 | + * @param string $context View or edit context. |
|
| 598 | + * @return int |
|
| 599 | + */ |
|
| 600 | + public function get_max_uses( $context = 'view' ) { |
|
| 601 | + $max_uses = $this->get_prop( 'max_uses', $context ); |
|
| 602 | + return empty( $max_uses ) ? null : $max_uses; |
|
| 603 | + } |
|
| 604 | + |
|
| 605 | + /** |
|
| 606 | + * Checks if this is a single use discount or not. |
|
| 607 | + * |
|
| 608 | + * @since 1.0.19 |
|
| 609 | + * @param string $context View or edit context. |
|
| 610 | + * @return bool |
|
| 611 | + */ |
|
| 612 | + public function get_is_single_use( $context = 'view' ) { |
|
| 613 | + return $this->get_prop( 'is_single_use', $context ); |
|
| 614 | + } |
|
| 615 | + |
|
| 616 | + /** |
|
| 617 | + * Get the items that can be used with this discount. |
|
| 618 | + * |
|
| 619 | + * @since 1.0.19 |
|
| 620 | + * @param string $context View or edit context. |
|
| 621 | + * @return array |
|
| 622 | + */ |
|
| 623 | + public function get_items( $context = 'view' ) { |
|
| 624 | + return wpinv_parse_list( $this->get_prop( 'items', $context ) ); |
|
| 625 | + } |
|
| 626 | + |
|
| 627 | + /** |
|
| 628 | + * Alias for self::get_items(). |
|
| 629 | + * |
|
| 630 | + * @since 1.0.19 |
|
| 631 | + * @param string $context View or edit context. |
|
| 632 | + * @return array |
|
| 633 | + */ |
|
| 634 | + public function get_allowed_items( $context = 'view' ) { |
|
| 635 | + return $this->get_items( $context ); |
|
| 636 | + } |
|
| 637 | + |
|
| 638 | + /** |
|
| 639 | + * Get the items that are not allowed to use this discount. |
|
| 640 | + * |
|
| 641 | + * @since 1.0.19 |
|
| 642 | + * @param string $context View or edit context. |
|
| 643 | + * @return array |
|
| 644 | + */ |
|
| 645 | + public function get_excluded_items( $context = 'view' ) { |
|
| 646 | + return wpinv_parse_list( $this->get_prop( 'excluded_items', $context ) ); |
|
| 647 | + } |
|
| 648 | + |
|
| 649 | + /** |
|
| 650 | + * Checks if this is a recurring discount or not. |
|
| 651 | + * |
|
| 652 | + * @since 1.0.19 |
|
| 653 | + * @param string $context View or edit context. |
|
| 654 | + * @return int|string|bool |
|
| 655 | + */ |
|
| 656 | + public function get_is_recurring( $context = 'view' ) { |
|
| 657 | + return $this->get_prop( 'is_recurring', $context ); |
|
| 658 | + } |
|
| 659 | + |
|
| 660 | + /** |
|
| 661 | + * Get's the minimum total amount allowed for this discount. |
|
| 662 | + * |
|
| 663 | + * @since 1.0.19 |
|
| 664 | + * @param string $context View or edit context. |
|
| 665 | + * @return float |
|
| 666 | + */ |
|
| 667 | + public function get_min_total( $context = 'view' ) { |
|
| 668 | + $minimum = $this->get_prop( 'min_total', $context ); |
|
| 669 | + return empty( $minimum ) ? null : $minimum; |
|
| 670 | + } |
|
| 671 | + |
|
| 672 | + /** |
|
| 673 | + * Alias for self::get_min_total(). |
|
| 674 | + * |
|
| 675 | + * @since 1.0.19 |
|
| 676 | + * @param string $context View or edit context. |
|
| 677 | + * @return float |
|
| 678 | + */ |
|
| 679 | + public function get_minimum_total( $context = 'view' ) { |
|
| 680 | + return $this->get_min_total( $context ); |
|
| 681 | + } |
|
| 682 | + |
|
| 683 | + /** |
|
| 684 | + * Get's the maximum total amount allowed for this discount. |
|
| 685 | + * |
|
| 686 | + * @since 1.0.19 |
|
| 687 | + * @param string $context View or edit context. |
|
| 688 | + * @return float |
|
| 689 | + */ |
|
| 690 | + public function get_max_total( $context = 'view' ) { |
|
| 691 | + $maximum = $this->get_prop( 'max_total', $context ); |
|
| 692 | + return empty( $maximum ) ? null : $maximum; |
|
| 693 | + } |
|
| 694 | + |
|
| 695 | + /** |
|
| 696 | + * Alias for self::get_max_total(). |
|
| 697 | + * |
|
| 698 | + * @since 1.0.19 |
|
| 699 | + * @param string $context View or edit context. |
|
| 700 | + * @return float |
|
| 701 | + */ |
|
| 702 | + public function get_maximum_total( $context = 'view' ) { |
|
| 703 | + return $this->get_max_total( $context ); |
|
| 704 | + } |
|
| 705 | + |
|
| 706 | + /** |
|
| 707 | + * Magic method for accessing discount properties. |
|
| 708 | + * |
|
| 709 | + * @since 1.0.15 |
|
| 710 | + * @access public |
|
| 711 | + * |
|
| 712 | + * @param string $key Discount data to retrieve |
|
| 713 | + * @param string $context View or edit context. |
|
| 714 | + * @return mixed Value of the given discount property (if set). |
|
| 715 | + */ |
|
| 716 | + public function get( $key, $context = 'view' ) { |
|
| 717 | 717 | return $this->get_prop( $key, $context ); |
| 718 | - } |
|
| 718 | + } |
|
| 719 | 719 | |
| 720 | - /* |
|
| 720 | + /* |
|
| 721 | 721 | |-------------------------------------------------------------------------- |
| 722 | 722 | | Setters |
| 723 | 723 | |-------------------------------------------------------------------------- |
@@ -727,41 +727,41 @@ discard block |
||
| 727 | 727 | | object. |
| 728 | 728 | */ |
| 729 | 729 | |
| 730 | - /** |
|
| 731 | - * Sets discount status. |
|
| 732 | - * |
|
| 733 | - * @since 1.0.19 |
|
| 734 | - * @param string $status New status. |
|
| 735 | - * @return array details of change. |
|
| 736 | - */ |
|
| 737 | - public function set_status( $status ) { |
|
| 730 | + /** |
|
| 731 | + * Sets discount status. |
|
| 732 | + * |
|
| 733 | + * @since 1.0.19 |
|
| 734 | + * @param string $status New status. |
|
| 735 | + * @return array details of change. |
|
| 736 | + */ |
|
| 737 | + public function set_status( $status ) { |
|
| 738 | 738 | $old_status = $this->get_status(); |
| 739 | 739 | |
| 740 | 740 | $this->set_prop( 'status', $status ); |
| 741 | 741 | |
| 742 | - return array( |
|
| 743 | - 'from' => $old_status, |
|
| 744 | - 'to' => $status, |
|
| 745 | - ); |
|
| 742 | + return array( |
|
| 743 | + 'from' => $old_status, |
|
| 744 | + 'to' => $status, |
|
| 745 | + ); |
|
| 746 | 746 | } |
| 747 | 747 | |
| 748 | 748 | /** |
| 749 | - * Set plugin version when the discount was created. |
|
| 750 | - * |
|
| 751 | - * @since 1.0.19 |
|
| 752 | - */ |
|
| 753 | - public function set_version( $value ) { |
|
| 754 | - $this->set_prop( 'version', $value ); |
|
| 749 | + * Set plugin version when the discount was created. |
|
| 750 | + * |
|
| 751 | + * @since 1.0.19 |
|
| 752 | + */ |
|
| 753 | + public function set_version( $value ) { |
|
| 754 | + $this->set_prop( 'version', $value ); |
|
| 755 | 755 | } |
| 756 | 756 | |
| 757 | 757 | /** |
| 758 | - * Set date when the discount was created. |
|
| 759 | - * |
|
| 760 | - * @since 1.0.19 |
|
| 761 | - * @param string $value Value to set. |
|
| 758 | + * Set date when the discount was created. |
|
| 759 | + * |
|
| 760 | + * @since 1.0.19 |
|
| 761 | + * @param string $value Value to set. |
|
| 762 | 762 | * @return bool Whether or not the date was set. |
| 763 | - */ |
|
| 764 | - public function set_date_created( $value ) { |
|
| 763 | + */ |
|
| 764 | + public function set_date_created( $value ) { |
|
| 765 | 765 | $date = strtotime( $value ); |
| 766 | 766 | |
| 767 | 767 | if ( $date ) { |
@@ -774,13 +774,13 @@ discard block |
||
| 774 | 774 | } |
| 775 | 775 | |
| 776 | 776 | /** |
| 777 | - * Set date when the discount was last modified. |
|
| 778 | - * |
|
| 779 | - * @since 1.0.19 |
|
| 780 | - * @param string $value Value to set. |
|
| 777 | + * Set date when the discount was last modified. |
|
| 778 | + * |
|
| 779 | + * @since 1.0.19 |
|
| 780 | + * @param string $value Value to set. |
|
| 781 | 781 | * @return bool Whether or not the date was set. |
| 782 | - */ |
|
| 783 | - public function set_date_modified( $value ) { |
|
| 782 | + */ |
|
| 783 | + public function set_date_modified( $value ) { |
|
| 784 | 784 | $date = strtotime( $value ); |
| 785 | 785 | |
| 786 | 786 | if ( $date ) { |
@@ -793,324 +793,324 @@ discard block |
||
| 793 | 793 | } |
| 794 | 794 | |
| 795 | 795 | /** |
| 796 | - * Set the discount name. |
|
| 797 | - * |
|
| 798 | - * @since 1.0.19 |
|
| 799 | - * @param string $value New name. |
|
| 800 | - */ |
|
| 801 | - public function set_name( $value ) { |
|
| 796 | + * Set the discount name. |
|
| 797 | + * |
|
| 798 | + * @since 1.0.19 |
|
| 799 | + * @param string $value New name. |
|
| 800 | + */ |
|
| 801 | + public function set_name( $value ) { |
|
| 802 | 802 | $name = sanitize_text_field( $value ); |
| 803 | - $this->set_prop( 'name', $name ); |
|
| 803 | + $this->set_prop( 'name', $name ); |
|
| 804 | 804 | } |
| 805 | 805 | |
| 806 | 806 | /** |
| 807 | - * Alias of self::set_name(). |
|
| 808 | - * |
|
| 809 | - * @since 1.0.19 |
|
| 810 | - * @param string $value New name. |
|
| 811 | - */ |
|
| 812 | - public function set_title( $value ) { |
|
| 813 | - $this->set_name( $value ); |
|
| 807 | + * Alias of self::set_name(). |
|
| 808 | + * |
|
| 809 | + * @since 1.0.19 |
|
| 810 | + * @param string $value New name. |
|
| 811 | + */ |
|
| 812 | + public function set_title( $value ) { |
|
| 813 | + $this->set_name( $value ); |
|
| 814 | 814 | } |
| 815 | 815 | |
| 816 | 816 | /** |
| 817 | - * Set the discount description. |
|
| 818 | - * |
|
| 819 | - * @since 1.0.19 |
|
| 820 | - * @param string $value New description. |
|
| 821 | - */ |
|
| 822 | - public function set_description( $value ) { |
|
| 817 | + * Set the discount description. |
|
| 818 | + * |
|
| 819 | + * @since 1.0.19 |
|
| 820 | + * @param string $value New description. |
|
| 821 | + */ |
|
| 822 | + public function set_description( $value ) { |
|
| 823 | 823 | $description = wp_kses_post( $value ); |
| 824 | - return $this->set_prop( 'description', $description ); |
|
| 824 | + return $this->set_prop( 'description', $description ); |
|
| 825 | 825 | } |
| 826 | 826 | |
| 827 | 827 | /** |
| 828 | - * Alias of self::set_description(). |
|
| 829 | - * |
|
| 830 | - * @since 1.0.19 |
|
| 831 | - * @param string $value New description. |
|
| 832 | - */ |
|
| 833 | - public function set_excerpt( $value ) { |
|
| 834 | - $this->set_description( $value ); |
|
| 828 | + * Alias of self::set_description(). |
|
| 829 | + * |
|
| 830 | + * @since 1.0.19 |
|
| 831 | + * @param string $value New description. |
|
| 832 | + */ |
|
| 833 | + public function set_excerpt( $value ) { |
|
| 834 | + $this->set_description( $value ); |
|
| 835 | 835 | } |
| 836 | 836 | |
| 837 | 837 | /** |
| 838 | - * Alias of self::set_description(). |
|
| 839 | - * |
|
| 840 | - * @since 1.0.19 |
|
| 841 | - * @param string $value New description. |
|
| 842 | - */ |
|
| 843 | - public function set_summary( $value ) { |
|
| 844 | - $this->set_description( $value ); |
|
| 838 | + * Alias of self::set_description(). |
|
| 839 | + * |
|
| 840 | + * @since 1.0.19 |
|
| 841 | + * @param string $value New description. |
|
| 842 | + */ |
|
| 843 | + public function set_summary( $value ) { |
|
| 844 | + $this->set_description( $value ); |
|
| 845 | 845 | } |
| 846 | 846 | |
| 847 | 847 | /** |
| 848 | - * Set the owner of the discount. |
|
| 849 | - * |
|
| 850 | - * @since 1.0.19 |
|
| 851 | - * @param int $value New author. |
|
| 852 | - */ |
|
| 853 | - public function set_author( $value ) { |
|
| 854 | - $this->set_prop( 'author', (int) $value ); |
|
| 855 | - } |
|
| 848 | + * Set the owner of the discount. |
|
| 849 | + * |
|
| 850 | + * @since 1.0.19 |
|
| 851 | + * @param int $value New author. |
|
| 852 | + */ |
|
| 853 | + public function set_author( $value ) { |
|
| 854 | + $this->set_prop( 'author', (int) $value ); |
|
| 855 | + } |
|
| 856 | 856 | |
| 857 | - /** |
|
| 858 | - * Sets the discount code. |
|
| 859 | - * |
|
| 860 | - * @since 1.0.19 |
|
| 861 | - * @param string $value New discount code. |
|
| 862 | - */ |
|
| 863 | - public function set_code( $value ) { |
|
| 864 | - $code = sanitize_text_field( $value ); |
|
| 865 | - $this->set_prop( 'code', $code ); |
|
| 866 | - } |
|
| 857 | + /** |
|
| 858 | + * Sets the discount code. |
|
| 859 | + * |
|
| 860 | + * @since 1.0.19 |
|
| 861 | + * @param string $value New discount code. |
|
| 862 | + */ |
|
| 863 | + public function set_code( $value ) { |
|
| 864 | + $code = sanitize_text_field( $value ); |
|
| 865 | + $this->set_prop( 'code', $code ); |
|
| 866 | + } |
|
| 867 | 867 | |
| 868 | - /** |
|
| 869 | - * Alias of self::set_code(). |
|
| 870 | - * |
|
| 871 | - * @since 1.0.19 |
|
| 872 | - * @param string $value New discount code. |
|
| 873 | - */ |
|
| 874 | - public function set_coupon_code( $value ) { |
|
| 875 | - $this->set_code( $value ); |
|
| 876 | - } |
|
| 868 | + /** |
|
| 869 | + * Alias of self::set_code(). |
|
| 870 | + * |
|
| 871 | + * @since 1.0.19 |
|
| 872 | + * @param string $value New discount code. |
|
| 873 | + */ |
|
| 874 | + public function set_coupon_code( $value ) { |
|
| 875 | + $this->set_code( $value ); |
|
| 876 | + } |
|
| 877 | 877 | |
| 878 | - /** |
|
| 879 | - * Alias of self::set_code(). |
|
| 880 | - * |
|
| 881 | - * @since 1.0.19 |
|
| 882 | - * @param string $value New discount code. |
|
| 883 | - */ |
|
| 884 | - public function set_discount_code( $value ) { |
|
| 885 | - $this->set_code( $value ); |
|
| 886 | - } |
|
| 878 | + /** |
|
| 879 | + * Alias of self::set_code(). |
|
| 880 | + * |
|
| 881 | + * @since 1.0.19 |
|
| 882 | + * @param string $value New discount code. |
|
| 883 | + */ |
|
| 884 | + public function set_discount_code( $value ) { |
|
| 885 | + $this->set_code( $value ); |
|
| 886 | + } |
|
| 887 | 887 | |
| 888 | - /** |
|
| 889 | - * Sets the discount amount. |
|
| 890 | - * |
|
| 891 | - * @since 1.0.19 |
|
| 892 | - * @param float $value New discount code. |
|
| 893 | - */ |
|
| 894 | - public function set_amount( $value ) { |
|
| 895 | - $amount = floatval( wpinv_sanitize_amount( $value ) ); |
|
| 896 | - $this->set_prop( 'amount', $amount ); |
|
| 897 | - } |
|
| 898 | - |
|
| 899 | - /** |
|
| 900 | - * Sets the discount's start date. |
|
| 901 | - * |
|
| 902 | - * @since 1.0.19 |
|
| 903 | - * @param float $value New start date. |
|
| 904 | - */ |
|
| 905 | - public function set_start( $value ) { |
|
| 906 | - $date = strtotime( $value ); |
|
| 888 | + /** |
|
| 889 | + * Sets the discount amount. |
|
| 890 | + * |
|
| 891 | + * @since 1.0.19 |
|
| 892 | + * @param float $value New discount code. |
|
| 893 | + */ |
|
| 894 | + public function set_amount( $value ) { |
|
| 895 | + $amount = floatval( wpinv_sanitize_amount( $value ) ); |
|
| 896 | + $this->set_prop( 'amount', $amount ); |
|
| 897 | + } |
|
| 907 | 898 | |
| 908 | - if ( $date ) { |
|
| 909 | - $this->set_prop( 'start', date( 'Y-m-d H:i', $date ) ); |
|
| 910 | - return true; |
|
| 911 | - } |
|
| 899 | + /** |
|
| 900 | + * Sets the discount's start date. |
|
| 901 | + * |
|
| 902 | + * @since 1.0.19 |
|
| 903 | + * @param float $value New start date. |
|
| 904 | + */ |
|
| 905 | + public function set_start( $value ) { |
|
| 906 | + $date = strtotime( $value ); |
|
| 907 | + |
|
| 908 | + if ( $date ) { |
|
| 909 | + $this->set_prop( 'start', date( 'Y-m-d H:i', $date ) ); |
|
| 910 | + return true; |
|
| 911 | + } |
|
| 912 | 912 | |
| 913 | - $this->set_prop( 'start', '' ); |
|
| 913 | + $this->set_prop( 'start', '' ); |
|
| 914 | 914 | |
| 915 | 915 | return false; |
| 916 | - } |
|
| 917 | - |
|
| 918 | - /** |
|
| 919 | - * Alias of self::set_start(). |
|
| 920 | - * |
|
| 921 | - * @since 1.0.19 |
|
| 922 | - * @param string $value New start date. |
|
| 923 | - */ |
|
| 924 | - public function set_start_date( $value ) { |
|
| 925 | - $this->set_start( $value ); |
|
| 926 | - } |
|
| 927 | - |
|
| 928 | - /** |
|
| 929 | - * Sets the discount's expiration date. |
|
| 930 | - * |
|
| 931 | - * @since 1.0.19 |
|
| 932 | - * @param float $value New expiration date. |
|
| 933 | - */ |
|
| 934 | - public function set_expiration( $value ) { |
|
| 935 | - $date = strtotime( $value ); |
|
| 916 | + } |
|
| 917 | + |
|
| 918 | + /** |
|
| 919 | + * Alias of self::set_start(). |
|
| 920 | + * |
|
| 921 | + * @since 1.0.19 |
|
| 922 | + * @param string $value New start date. |
|
| 923 | + */ |
|
| 924 | + public function set_start_date( $value ) { |
|
| 925 | + $this->set_start( $value ); |
|
| 926 | + } |
|
| 927 | + |
|
| 928 | + /** |
|
| 929 | + * Sets the discount's expiration date. |
|
| 930 | + * |
|
| 931 | + * @since 1.0.19 |
|
| 932 | + * @param float $value New expiration date. |
|
| 933 | + */ |
|
| 934 | + public function set_expiration( $value ) { |
|
| 935 | + $date = strtotime( $value ); |
|
| 936 | 936 | |
| 937 | 937 | if ( $date ) { |
| 938 | 938 | $this->set_prop( 'expiration', date( 'Y-m-d H:i', $date ) ); |
| 939 | 939 | return true; |
| 940 | 940 | } |
| 941 | 941 | |
| 942 | - $this->set_prop( 'expiration', '' ); |
|
| 942 | + $this->set_prop( 'expiration', '' ); |
|
| 943 | 943 | return false; |
| 944 | - } |
|
| 945 | - |
|
| 946 | - /** |
|
| 947 | - * Alias of self::set_expiration(). |
|
| 948 | - * |
|
| 949 | - * @since 1.0.19 |
|
| 950 | - * @param string $value New expiration date. |
|
| 951 | - */ |
|
| 952 | - public function set_expiration_date( $value ) { |
|
| 953 | - $this->set_expiration( $value ); |
|
| 954 | - } |
|
| 955 | - |
|
| 956 | - /** |
|
| 957 | - * Alias of self::set_expiration(). |
|
| 958 | - * |
|
| 959 | - * @since 1.0.19 |
|
| 960 | - * @param string $value New expiration date. |
|
| 961 | - */ |
|
| 962 | - public function set_end_date( $value ) { |
|
| 963 | - $this->set_expiration( $value ); |
|
| 964 | - } |
|
| 965 | - |
|
| 966 | - /** |
|
| 967 | - * Sets the discount type. |
|
| 968 | - * |
|
| 969 | - * @since 1.0.19 |
|
| 970 | - * @param string $value New discount type. |
|
| 971 | - */ |
|
| 972 | - public function set_type( $value ) { |
|
| 973 | - if ( $value && array_key_exists( sanitize_text_field( $value ), wpinv_get_discount_types() ) ) { |
|
| 974 | - $this->set_prop( 'type', sanitize_text_field( $value ) ); |
|
| 975 | - } |
|
| 976 | - } |
|
| 977 | - |
|
| 978 | - /** |
|
| 979 | - * Sets the number of times a discount has been used. |
|
| 980 | - * |
|
| 981 | - * @since 1.0.19 |
|
| 982 | - * @param int $value usage count. |
|
| 983 | - */ |
|
| 984 | - public function set_uses( $value ) { |
|
| 985 | - |
|
| 986 | - $value = (int) $value; |
|
| 987 | - |
|
| 988 | - if ( $value < 0 ) { |
|
| 989 | - $value = 0; |
|
| 990 | - } |
|
| 991 | - |
|
| 992 | - $this->set_prop( 'uses', (int) $value ); |
|
| 993 | - } |
|
| 994 | - |
|
| 995 | - /** |
|
| 996 | - * Sets the maximum number of times a discount can be used. |
|
| 997 | - * |
|
| 998 | - * @since 1.0.19 |
|
| 999 | - * @param int $value maximum usage count. |
|
| 1000 | - */ |
|
| 1001 | - public function set_max_uses( $value ) { |
|
| 1002 | - $this->set_prop( 'max_uses', absint( $value ) ); |
|
| 1003 | - } |
|
| 1004 | - |
|
| 1005 | - /** |
|
| 1006 | - * Sets if this is a single use discount or not. |
|
| 1007 | - * |
|
| 1008 | - * @since 1.0.19 |
|
| 1009 | - * @param int|bool $value is single use. |
|
| 1010 | - */ |
|
| 1011 | - public function set_is_single_use( $value ) { |
|
| 1012 | - $this->set_prop( 'is_single_use', (bool) $value ); |
|
| 1013 | - } |
|
| 1014 | - |
|
| 1015 | - /** |
|
| 1016 | - * Sets the items that can be used with this discount. |
|
| 1017 | - * |
|
| 1018 | - * @since 1.0.19 |
|
| 1019 | - * @param array $value items. |
|
| 1020 | - */ |
|
| 1021 | - public function set_items( $value ) { |
|
| 1022 | - $this->set_prop( 'items', wpinv_parse_list( $value ) ); |
|
| 1023 | - } |
|
| 1024 | - |
|
| 1025 | - /** |
|
| 1026 | - * Alias for self::set_items(). |
|
| 1027 | - * |
|
| 1028 | - * @since 1.0.19 |
|
| 1029 | - * @param array $value items. |
|
| 1030 | - */ |
|
| 1031 | - public function set_allowed_items( $value ) { |
|
| 1032 | - $this->set_items( $value ); |
|
| 1033 | - } |
|
| 1034 | - |
|
| 1035 | - /** |
|
| 1036 | - * Sets the items that can not be used with this discount. |
|
| 1037 | - * |
|
| 1038 | - * @since 1.0.19 |
|
| 1039 | - * @param array $value items. |
|
| 1040 | - */ |
|
| 1041 | - public function set_excluded_items( $value ) { |
|
| 1042 | - $this->set_prop( 'excluded_items', wpinv_parse_list( $value ) ); |
|
| 1043 | - } |
|
| 1044 | - |
|
| 1045 | - /** |
|
| 1046 | - * Sets if this is a recurring discounts or not. |
|
| 1047 | - * |
|
| 1048 | - * @since 1.0.19 |
|
| 1049 | - * @param int|bool $value is recurring. |
|
| 1050 | - */ |
|
| 1051 | - public function set_is_recurring( $value ) { |
|
| 1052 | - $this->set_prop( 'is_recurring', (bool) $value ); |
|
| 1053 | - } |
|
| 1054 | - |
|
| 1055 | - /** |
|
| 1056 | - * Sets the minimum total that can not be used with this discount. |
|
| 1057 | - * |
|
| 1058 | - * @since 1.0.19 |
|
| 1059 | - * @param float $value minimum total. |
|
| 1060 | - */ |
|
| 1061 | - public function set_min_total( $value ) { |
|
| 1062 | - $this->set_prop( 'min_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1063 | - } |
|
| 1064 | - |
|
| 1065 | - /** |
|
| 1066 | - * Alias for self::set_min_total(). |
|
| 1067 | - * |
|
| 1068 | - * @since 1.0.19 |
|
| 1069 | - * @param float $value minimum total. |
|
| 1070 | - */ |
|
| 1071 | - public function set_minimum_total( $value ) { |
|
| 1072 | - $this->set_min_total( $value ); |
|
| 1073 | - } |
|
| 1074 | - |
|
| 1075 | - /** |
|
| 1076 | - * Sets the maximum total that can not be used with this discount. |
|
| 1077 | - * |
|
| 1078 | - * @since 1.0.19 |
|
| 1079 | - * @param float $value maximum total. |
|
| 1080 | - */ |
|
| 1081 | - public function set_max_total( $value ) { |
|
| 1082 | - $this->set_prop( 'max_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1083 | - } |
|
| 1084 | - |
|
| 1085 | - /** |
|
| 1086 | - * Alias for self::set_max_total(). |
|
| 1087 | - * |
|
| 1088 | - * @since 1.0.19 |
|
| 1089 | - * @param float $value maximum total. |
|
| 1090 | - */ |
|
| 1091 | - public function set_maximum_total( $value ) { |
|
| 1092 | - $this->set_max_total( $value ); |
|
| 1093 | - } |
|
| 1094 | - |
|
| 1095 | - /** |
|
| 1096 | - * @deprecated |
|
| 1097 | - */ |
|
| 1098 | - public function refresh(){} |
|
| 1099 | - |
|
| 1100 | - /** |
|
| 1101 | - * @deprecated |
|
| 1102 | - * |
|
| 1103 | - */ |
|
| 1104 | - public function update_status( $status = 'publish' ){ |
|
| 1105 | - |
|
| 1106 | - if ( $this->exists() && $this->get_status() != $status ) { |
|
| 1107 | - $this->set_status( $status ); |
|
| 1108 | - $this->save(); |
|
| 1109 | - } |
|
| 1110 | - |
|
| 1111 | - } |
|
| 1112 | - |
|
| 1113 | - /* |
|
| 944 | + } |
|
| 945 | + |
|
| 946 | + /** |
|
| 947 | + * Alias of self::set_expiration(). |
|
| 948 | + * |
|
| 949 | + * @since 1.0.19 |
|
| 950 | + * @param string $value New expiration date. |
|
| 951 | + */ |
|
| 952 | + public function set_expiration_date( $value ) { |
|
| 953 | + $this->set_expiration( $value ); |
|
| 954 | + } |
|
| 955 | + |
|
| 956 | + /** |
|
| 957 | + * Alias of self::set_expiration(). |
|
| 958 | + * |
|
| 959 | + * @since 1.0.19 |
|
| 960 | + * @param string $value New expiration date. |
|
| 961 | + */ |
|
| 962 | + public function set_end_date( $value ) { |
|
| 963 | + $this->set_expiration( $value ); |
|
| 964 | + } |
|
| 965 | + |
|
| 966 | + /** |
|
| 967 | + * Sets the discount type. |
|
| 968 | + * |
|
| 969 | + * @since 1.0.19 |
|
| 970 | + * @param string $value New discount type. |
|
| 971 | + */ |
|
| 972 | + public function set_type( $value ) { |
|
| 973 | + if ( $value && array_key_exists( sanitize_text_field( $value ), wpinv_get_discount_types() ) ) { |
|
| 974 | + $this->set_prop( 'type', sanitize_text_field( $value ) ); |
|
| 975 | + } |
|
| 976 | + } |
|
| 977 | + |
|
| 978 | + /** |
|
| 979 | + * Sets the number of times a discount has been used. |
|
| 980 | + * |
|
| 981 | + * @since 1.0.19 |
|
| 982 | + * @param int $value usage count. |
|
| 983 | + */ |
|
| 984 | + public function set_uses( $value ) { |
|
| 985 | + |
|
| 986 | + $value = (int) $value; |
|
| 987 | + |
|
| 988 | + if ( $value < 0 ) { |
|
| 989 | + $value = 0; |
|
| 990 | + } |
|
| 991 | + |
|
| 992 | + $this->set_prop( 'uses', (int) $value ); |
|
| 993 | + } |
|
| 994 | + |
|
| 995 | + /** |
|
| 996 | + * Sets the maximum number of times a discount can be used. |
|
| 997 | + * |
|
| 998 | + * @since 1.0.19 |
|
| 999 | + * @param int $value maximum usage count. |
|
| 1000 | + */ |
|
| 1001 | + public function set_max_uses( $value ) { |
|
| 1002 | + $this->set_prop( 'max_uses', absint( $value ) ); |
|
| 1003 | + } |
|
| 1004 | + |
|
| 1005 | + /** |
|
| 1006 | + * Sets if this is a single use discount or not. |
|
| 1007 | + * |
|
| 1008 | + * @since 1.0.19 |
|
| 1009 | + * @param int|bool $value is single use. |
|
| 1010 | + */ |
|
| 1011 | + public function set_is_single_use( $value ) { |
|
| 1012 | + $this->set_prop( 'is_single_use', (bool) $value ); |
|
| 1013 | + } |
|
| 1014 | + |
|
| 1015 | + /** |
|
| 1016 | + * Sets the items that can be used with this discount. |
|
| 1017 | + * |
|
| 1018 | + * @since 1.0.19 |
|
| 1019 | + * @param array $value items. |
|
| 1020 | + */ |
|
| 1021 | + public function set_items( $value ) { |
|
| 1022 | + $this->set_prop( 'items', wpinv_parse_list( $value ) ); |
|
| 1023 | + } |
|
| 1024 | + |
|
| 1025 | + /** |
|
| 1026 | + * Alias for self::set_items(). |
|
| 1027 | + * |
|
| 1028 | + * @since 1.0.19 |
|
| 1029 | + * @param array $value items. |
|
| 1030 | + */ |
|
| 1031 | + public function set_allowed_items( $value ) { |
|
| 1032 | + $this->set_items( $value ); |
|
| 1033 | + } |
|
| 1034 | + |
|
| 1035 | + /** |
|
| 1036 | + * Sets the items that can not be used with this discount. |
|
| 1037 | + * |
|
| 1038 | + * @since 1.0.19 |
|
| 1039 | + * @param array $value items. |
|
| 1040 | + */ |
|
| 1041 | + public function set_excluded_items( $value ) { |
|
| 1042 | + $this->set_prop( 'excluded_items', wpinv_parse_list( $value ) ); |
|
| 1043 | + } |
|
| 1044 | + |
|
| 1045 | + /** |
|
| 1046 | + * Sets if this is a recurring discounts or not. |
|
| 1047 | + * |
|
| 1048 | + * @since 1.0.19 |
|
| 1049 | + * @param int|bool $value is recurring. |
|
| 1050 | + */ |
|
| 1051 | + public function set_is_recurring( $value ) { |
|
| 1052 | + $this->set_prop( 'is_recurring', (bool) $value ); |
|
| 1053 | + } |
|
| 1054 | + |
|
| 1055 | + /** |
|
| 1056 | + * Sets the minimum total that can not be used with this discount. |
|
| 1057 | + * |
|
| 1058 | + * @since 1.0.19 |
|
| 1059 | + * @param float $value minimum total. |
|
| 1060 | + */ |
|
| 1061 | + public function set_min_total( $value ) { |
|
| 1062 | + $this->set_prop( 'min_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1063 | + } |
|
| 1064 | + |
|
| 1065 | + /** |
|
| 1066 | + * Alias for self::set_min_total(). |
|
| 1067 | + * |
|
| 1068 | + * @since 1.0.19 |
|
| 1069 | + * @param float $value minimum total. |
|
| 1070 | + */ |
|
| 1071 | + public function set_minimum_total( $value ) { |
|
| 1072 | + $this->set_min_total( $value ); |
|
| 1073 | + } |
|
| 1074 | + |
|
| 1075 | + /** |
|
| 1076 | + * Sets the maximum total that can not be used with this discount. |
|
| 1077 | + * |
|
| 1078 | + * @since 1.0.19 |
|
| 1079 | + * @param float $value maximum total. |
|
| 1080 | + */ |
|
| 1081 | + public function set_max_total( $value ) { |
|
| 1082 | + $this->set_prop( 'max_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1083 | + } |
|
| 1084 | + |
|
| 1085 | + /** |
|
| 1086 | + * Alias for self::set_max_total(). |
|
| 1087 | + * |
|
| 1088 | + * @since 1.0.19 |
|
| 1089 | + * @param float $value maximum total. |
|
| 1090 | + */ |
|
| 1091 | + public function set_maximum_total( $value ) { |
|
| 1092 | + $this->set_max_total( $value ); |
|
| 1093 | + } |
|
| 1094 | + |
|
| 1095 | + /** |
|
| 1096 | + * @deprecated |
|
| 1097 | + */ |
|
| 1098 | + public function refresh(){} |
|
| 1099 | + |
|
| 1100 | + /** |
|
| 1101 | + * @deprecated |
|
| 1102 | + * |
|
| 1103 | + */ |
|
| 1104 | + public function update_status( $status = 'publish' ){ |
|
| 1105 | + |
|
| 1106 | + if ( $this->exists() && $this->get_status() != $status ) { |
|
| 1107 | + $this->set_status( $status ); |
|
| 1108 | + $this->save(); |
|
| 1109 | + } |
|
| 1110 | + |
|
| 1111 | + } |
|
| 1112 | + |
|
| 1113 | + /* |
|
| 1114 | 1114 | |-------------------------------------------------------------------------- |
| 1115 | 1115 | | Conditionals |
| 1116 | 1116 | |-------------------------------------------------------------------------- |
@@ -1119,263 +1119,263 @@ discard block |
||
| 1119 | 1119 | | |
| 1120 | 1120 | */ |
| 1121 | 1121 | |
| 1122 | - /** |
|
| 1123 | - * Checks whether a discount exists in the database or not |
|
| 1124 | - * |
|
| 1125 | - * @since 1.0.15 |
|
| 1126 | - */ |
|
| 1127 | - public function exists(){ |
|
| 1128 | - $id = $this->get_id(); |
|
| 1129 | - return ! empty( $id ); |
|
| 1130 | - } |
|
| 1131 | - |
|
| 1132 | - /** |
|
| 1133 | - * Checks the discount type. |
|
| 1134 | - * |
|
| 1135 | - * |
|
| 1136 | - * @param string $type the discount type to check against |
|
| 1137 | - * @since 1.0.15 |
|
| 1138 | - * @return bool |
|
| 1139 | - */ |
|
| 1140 | - public function is_type( $type ) { |
|
| 1141 | - return $this->get_type() == $type; |
|
| 1142 | - } |
|
| 1143 | - |
|
| 1144 | - /** |
|
| 1145 | - * Checks whether the discount is published or not |
|
| 1146 | - * |
|
| 1147 | - * @since 1.0.15 |
|
| 1148 | - * @return bool |
|
| 1149 | - */ |
|
| 1150 | - public function is_active() { |
|
| 1151 | - return $this->get_status() == 'publish'; |
|
| 1152 | - } |
|
| 1153 | - |
|
| 1154 | - /** |
|
| 1155 | - * Checks whether the discount has max uses |
|
| 1156 | - * |
|
| 1157 | - * @since 1.0.15 |
|
| 1158 | - * @return bool |
|
| 1159 | - */ |
|
| 1160 | - public function has_limit() { |
|
| 1161 | - $limit = $this->get_max_uses(); |
|
| 1162 | - return ! empty( $limit ); |
|
| 1163 | - } |
|
| 1164 | - |
|
| 1165 | - /** |
|
| 1166 | - * Checks whether the discount has ever been used. |
|
| 1167 | - * |
|
| 1168 | - * @since 1.0.15 |
|
| 1169 | - * @return bool |
|
| 1170 | - */ |
|
| 1171 | - public function has_uses() { |
|
| 1172 | - return $this->get_uses() > 0; |
|
| 1173 | - } |
|
| 1174 | - |
|
| 1175 | - /** |
|
| 1176 | - * Checks whether the discount is has exided the usage limit or not |
|
| 1177 | - * |
|
| 1178 | - * @since 1.0.15 |
|
| 1179 | - * @return bool |
|
| 1180 | - */ |
|
| 1181 | - public function has_exceeded_limit() { |
|
| 1182 | - |
|
| 1183 | - if ( ! $this->has_limit() || ! $this->has_uses() ) { |
|
| 1184 | - $exceeded = false ; |
|
| 1185 | - } else { |
|
| 1186 | - $exceeded = ! ( (int) $this->get_max_uses() < $this->get_uses() ); |
|
| 1187 | - } |
|
| 1188 | - |
|
| 1189 | - return apply_filters( 'wpinv_is_discount_maxed_out', $exceeded, $this->ID, $this, $this->code ); |
|
| 1190 | - } |
|
| 1191 | - |
|
| 1192 | - /** |
|
| 1193 | - * Checks whether the discount has an expiration date. |
|
| 1194 | - * |
|
| 1195 | - * @since 1.0.15 |
|
| 1196 | - * @return bool |
|
| 1197 | - */ |
|
| 1198 | - public function has_expiration_date() { |
|
| 1199 | - $date = $this->get_expiration_date(); |
|
| 1200 | - return ! empty( $date ); |
|
| 1201 | - } |
|
| 1202 | - |
|
| 1203 | - /** |
|
| 1204 | - * Checks if the discount is expired |
|
| 1205 | - * |
|
| 1206 | - * @since 1.0.15 |
|
| 1207 | - * @return bool |
|
| 1208 | - */ |
|
| 1209 | - public function is_expired() { |
|
| 1210 | - $expired = $this->has_expiration_date() ? current_time( 'timestamp' ) > strtotime( $this->get_expiration_date() ) : false; |
|
| 1211 | - return apply_filters( 'wpinv_is_discount_expired', $expired, $this->ID, $this, $this->code ); |
|
| 1212 | - } |
|
| 1213 | - |
|
| 1214 | - /** |
|
| 1215 | - * Checks whether the discount has a start date. |
|
| 1216 | - * |
|
| 1217 | - * @since 1.0.15 |
|
| 1218 | - * @return bool |
|
| 1219 | - */ |
|
| 1220 | - public function has_start_date() { |
|
| 1221 | - $date = $this->get_start_date(); |
|
| 1222 | - return ! empty( $date ); |
|
| 1223 | - } |
|
| 1224 | - |
|
| 1225 | - /** |
|
| 1226 | - * Checks the discount start date. |
|
| 1227 | - * |
|
| 1228 | - * @since 1.0.15 |
|
| 1229 | - * @return bool |
|
| 1230 | - */ |
|
| 1231 | - public function has_started() { |
|
| 1232 | - $started = $this->has_start_date() ? true : current_time( 'timestamp' ) > strtotime( $this->get_start_date() ); |
|
| 1233 | - return apply_filters( 'wpinv_is_discount_started', $started, $this->ID, $this, $this->code ); |
|
| 1234 | - } |
|
| 1235 | - |
|
| 1236 | - /** |
|
| 1237 | - * Checks the discount has allowed items or not. |
|
| 1238 | - * |
|
| 1239 | - * @since 1.0.15 |
|
| 1240 | - * @return bool |
|
| 1241 | - */ |
|
| 1242 | - public function has_allowed_items() { |
|
| 1243 | - $allowed_items = $this->get_allowed_items(); |
|
| 1244 | - return ! empty( $allowed_items ); |
|
| 1245 | - } |
|
| 1246 | - |
|
| 1247 | - /** |
|
| 1248 | - * Checks the discount has excluded items or not. |
|
| 1249 | - * |
|
| 1250 | - * @since 1.0.15 |
|
| 1251 | - * @return bool |
|
| 1252 | - */ |
|
| 1253 | - public function has_excluded_items() { |
|
| 1254 | - $excluded_items = $this->get_excluded_items(); |
|
| 1255 | - return ! empty( $excluded_items ); |
|
| 1256 | - } |
|
| 1257 | - |
|
| 1258 | - /** |
|
| 1259 | - * Check if a discount is valid for a given item id. |
|
| 1260 | - * |
|
| 1261 | - * @param int|int[] $item_ids |
|
| 1262 | - * @since 1.0.15 |
|
| 1263 | - * @return boolean |
|
| 1264 | - */ |
|
| 1265 | - public function is_valid_for_items( $item_ids ) { |
|
| 1266 | - |
|
| 1267 | - $item_ids = wp_parse_id_list( $item_ids ); |
|
| 1268 | - $included = array_intersect( $item_ids, $this->get_allowed_items() ); |
|
| 1269 | - $excluded = array_intersect( $item_ids, $this->get_excluded_items() ); |
|
| 1270 | - |
|
| 1271 | - if ( $this->has_excluded_items() && ! empty( $excluded ) ) { |
|
| 1272 | - return false; |
|
| 1273 | - } |
|
| 1274 | - |
|
| 1275 | - if ( $this->has_allowed_items() && empty( $included ) ) { |
|
| 1276 | - return false; |
|
| 1277 | - } |
|
| 1278 | - |
|
| 1279 | - return true; |
|
| 1280 | - } |
|
| 1281 | - |
|
| 1282 | - /** |
|
| 1283 | - * Check if a discount is valid for the given amount |
|
| 1284 | - * |
|
| 1285 | - * @param float $amount The amount to check against |
|
| 1286 | - * @since 1.0.15 |
|
| 1287 | - * @return boolean |
|
| 1288 | - */ |
|
| 1289 | - public function is_valid_for_amount( $amount ) { |
|
| 1290 | - return $this->is_minimum_amount_met( $amount ) && $this->is_maximum_amount_met( $amount ); |
|
| 1291 | - } |
|
| 1292 | - |
|
| 1293 | - /** |
|
| 1294 | - * Checks if the minimum amount is set |
|
| 1295 | - * |
|
| 1296 | - * @since 1.0.15 |
|
| 1297 | - * @return boolean |
|
| 1298 | - */ |
|
| 1299 | - public function has_minimum_amount() { |
|
| 1300 | - $minimum = $this->get_minimum_total(); |
|
| 1301 | - return ! empty( $minimum ); |
|
| 1302 | - } |
|
| 1303 | - |
|
| 1304 | - /** |
|
| 1305 | - * Checks if the minimum amount is met |
|
| 1306 | - * |
|
| 1307 | - * @param float $amount The amount to check against |
|
| 1308 | - * @since 1.0.15 |
|
| 1309 | - * @return boolean |
|
| 1310 | - */ |
|
| 1311 | - public function is_minimum_amount_met( $amount ) { |
|
| 1312 | - $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1313 | - $min_met= ! ( $this->has_minimum_amount() && $amount < floatval( wpinv_sanitize_amount( $this->get_minimum_total() ) ) ); |
|
| 1314 | - return apply_filters( 'wpinv_is_discount_min_met', $min_met, $this->ID, $this, $this->code, $amount ); |
|
| 1315 | - } |
|
| 1316 | - |
|
| 1317 | - /** |
|
| 1318 | - * Checks if the maximum amount is set |
|
| 1319 | - * |
|
| 1320 | - * @since 1.0.15 |
|
| 1321 | - * @return boolean |
|
| 1322 | - */ |
|
| 1323 | - public function has_maximum_amount() { |
|
| 1324 | - $maximum = $this->get_maximum_total(); |
|
| 1325 | - return ! empty( $maximum ); |
|
| 1326 | - } |
|
| 1327 | - |
|
| 1328 | - /** |
|
| 1329 | - * Checks if the maximum amount is met |
|
| 1330 | - * |
|
| 1331 | - * @param float $amount The amount to check against |
|
| 1332 | - * @since 1.0.15 |
|
| 1333 | - * @return boolean |
|
| 1334 | - */ |
|
| 1335 | - public function is_maximum_amount_met( $amount ) { |
|
| 1336 | - $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1337 | - $max_met= ! ( $this->has_maximum_amount() && $amount > floatval( wpinv_sanitize_amount( $this->get_maximum_total() ) ) ); |
|
| 1338 | - return apply_filters( 'wpinv_is_discount_max_met', $max_met, $this->ID, $this, $this->code, $amount ); |
|
| 1339 | - } |
|
| 1340 | - |
|
| 1341 | - /** |
|
| 1342 | - * Checks if the discount is recurring. |
|
| 1343 | - * |
|
| 1344 | - * @since 1.0.15 |
|
| 1345 | - * @return boolean |
|
| 1346 | - */ |
|
| 1347 | - public function is_recurring() { |
|
| 1348 | - $recurring = $this->get_is_recurring(); |
|
| 1349 | - return ! empty( $recurring ); |
|
| 1350 | - } |
|
| 1351 | - |
|
| 1352 | - /** |
|
| 1353 | - * Checks if the discount is single use. |
|
| 1354 | - * |
|
| 1355 | - * @since 1.0.15 |
|
| 1356 | - * @return boolean |
|
| 1357 | - */ |
|
| 1358 | - public function is_single_use() { |
|
| 1359 | - $usage = $this->get_is_single_use(); |
|
| 1360 | - return ! empty( $usage ); |
|
| 1361 | - } |
|
| 1362 | - |
|
| 1363 | - /** |
|
| 1364 | - * Check if a discount is valid for the given user |
|
| 1365 | - * |
|
| 1366 | - * @param int|string $user |
|
| 1367 | - * @since 1.0.15 |
|
| 1368 | - * @return boolean |
|
| 1369 | - */ |
|
| 1370 | - public function is_valid_for_user( $user ) { |
|
| 1371 | - |
|
| 1372 | - // Ensure that the discount is single use. |
|
| 1373 | - if ( empty( $user ) || ! $this->is_single_use() ) { |
|
| 1374 | - return true; |
|
| 1375 | - } |
|
| 1376 | - |
|
| 1377 | - // Prepare the user id. |
|
| 1378 | - $user_id = 0; |
|
| 1122 | + /** |
|
| 1123 | + * Checks whether a discount exists in the database or not |
|
| 1124 | + * |
|
| 1125 | + * @since 1.0.15 |
|
| 1126 | + */ |
|
| 1127 | + public function exists(){ |
|
| 1128 | + $id = $this->get_id(); |
|
| 1129 | + return ! empty( $id ); |
|
| 1130 | + } |
|
| 1131 | + |
|
| 1132 | + /** |
|
| 1133 | + * Checks the discount type. |
|
| 1134 | + * |
|
| 1135 | + * |
|
| 1136 | + * @param string $type the discount type to check against |
|
| 1137 | + * @since 1.0.15 |
|
| 1138 | + * @return bool |
|
| 1139 | + */ |
|
| 1140 | + public function is_type( $type ) { |
|
| 1141 | + return $this->get_type() == $type; |
|
| 1142 | + } |
|
| 1143 | + |
|
| 1144 | + /** |
|
| 1145 | + * Checks whether the discount is published or not |
|
| 1146 | + * |
|
| 1147 | + * @since 1.0.15 |
|
| 1148 | + * @return bool |
|
| 1149 | + */ |
|
| 1150 | + public function is_active() { |
|
| 1151 | + return $this->get_status() == 'publish'; |
|
| 1152 | + } |
|
| 1153 | + |
|
| 1154 | + /** |
|
| 1155 | + * Checks whether the discount has max uses |
|
| 1156 | + * |
|
| 1157 | + * @since 1.0.15 |
|
| 1158 | + * @return bool |
|
| 1159 | + */ |
|
| 1160 | + public function has_limit() { |
|
| 1161 | + $limit = $this->get_max_uses(); |
|
| 1162 | + return ! empty( $limit ); |
|
| 1163 | + } |
|
| 1164 | + |
|
| 1165 | + /** |
|
| 1166 | + * Checks whether the discount has ever been used. |
|
| 1167 | + * |
|
| 1168 | + * @since 1.0.15 |
|
| 1169 | + * @return bool |
|
| 1170 | + */ |
|
| 1171 | + public function has_uses() { |
|
| 1172 | + return $this->get_uses() > 0; |
|
| 1173 | + } |
|
| 1174 | + |
|
| 1175 | + /** |
|
| 1176 | + * Checks whether the discount is has exided the usage limit or not |
|
| 1177 | + * |
|
| 1178 | + * @since 1.0.15 |
|
| 1179 | + * @return bool |
|
| 1180 | + */ |
|
| 1181 | + public function has_exceeded_limit() { |
|
| 1182 | + |
|
| 1183 | + if ( ! $this->has_limit() || ! $this->has_uses() ) { |
|
| 1184 | + $exceeded = false ; |
|
| 1185 | + } else { |
|
| 1186 | + $exceeded = ! ( (int) $this->get_max_uses() < $this->get_uses() ); |
|
| 1187 | + } |
|
| 1188 | + |
|
| 1189 | + return apply_filters( 'wpinv_is_discount_maxed_out', $exceeded, $this->ID, $this, $this->code ); |
|
| 1190 | + } |
|
| 1191 | + |
|
| 1192 | + /** |
|
| 1193 | + * Checks whether the discount has an expiration date. |
|
| 1194 | + * |
|
| 1195 | + * @since 1.0.15 |
|
| 1196 | + * @return bool |
|
| 1197 | + */ |
|
| 1198 | + public function has_expiration_date() { |
|
| 1199 | + $date = $this->get_expiration_date(); |
|
| 1200 | + return ! empty( $date ); |
|
| 1201 | + } |
|
| 1202 | + |
|
| 1203 | + /** |
|
| 1204 | + * Checks if the discount is expired |
|
| 1205 | + * |
|
| 1206 | + * @since 1.0.15 |
|
| 1207 | + * @return bool |
|
| 1208 | + */ |
|
| 1209 | + public function is_expired() { |
|
| 1210 | + $expired = $this->has_expiration_date() ? current_time( 'timestamp' ) > strtotime( $this->get_expiration_date() ) : false; |
|
| 1211 | + return apply_filters( 'wpinv_is_discount_expired', $expired, $this->ID, $this, $this->code ); |
|
| 1212 | + } |
|
| 1213 | + |
|
| 1214 | + /** |
|
| 1215 | + * Checks whether the discount has a start date. |
|
| 1216 | + * |
|
| 1217 | + * @since 1.0.15 |
|
| 1218 | + * @return bool |
|
| 1219 | + */ |
|
| 1220 | + public function has_start_date() { |
|
| 1221 | + $date = $this->get_start_date(); |
|
| 1222 | + return ! empty( $date ); |
|
| 1223 | + } |
|
| 1224 | + |
|
| 1225 | + /** |
|
| 1226 | + * Checks the discount start date. |
|
| 1227 | + * |
|
| 1228 | + * @since 1.0.15 |
|
| 1229 | + * @return bool |
|
| 1230 | + */ |
|
| 1231 | + public function has_started() { |
|
| 1232 | + $started = $this->has_start_date() ? true : current_time( 'timestamp' ) > strtotime( $this->get_start_date() ); |
|
| 1233 | + return apply_filters( 'wpinv_is_discount_started', $started, $this->ID, $this, $this->code ); |
|
| 1234 | + } |
|
| 1235 | + |
|
| 1236 | + /** |
|
| 1237 | + * Checks the discount has allowed items or not. |
|
| 1238 | + * |
|
| 1239 | + * @since 1.0.15 |
|
| 1240 | + * @return bool |
|
| 1241 | + */ |
|
| 1242 | + public function has_allowed_items() { |
|
| 1243 | + $allowed_items = $this->get_allowed_items(); |
|
| 1244 | + return ! empty( $allowed_items ); |
|
| 1245 | + } |
|
| 1246 | + |
|
| 1247 | + /** |
|
| 1248 | + * Checks the discount has excluded items or not. |
|
| 1249 | + * |
|
| 1250 | + * @since 1.0.15 |
|
| 1251 | + * @return bool |
|
| 1252 | + */ |
|
| 1253 | + public function has_excluded_items() { |
|
| 1254 | + $excluded_items = $this->get_excluded_items(); |
|
| 1255 | + return ! empty( $excluded_items ); |
|
| 1256 | + } |
|
| 1257 | + |
|
| 1258 | + /** |
|
| 1259 | + * Check if a discount is valid for a given item id. |
|
| 1260 | + * |
|
| 1261 | + * @param int|int[] $item_ids |
|
| 1262 | + * @since 1.0.15 |
|
| 1263 | + * @return boolean |
|
| 1264 | + */ |
|
| 1265 | + public function is_valid_for_items( $item_ids ) { |
|
| 1266 | + |
|
| 1267 | + $item_ids = wp_parse_id_list( $item_ids ); |
|
| 1268 | + $included = array_intersect( $item_ids, $this->get_allowed_items() ); |
|
| 1269 | + $excluded = array_intersect( $item_ids, $this->get_excluded_items() ); |
|
| 1270 | + |
|
| 1271 | + if ( $this->has_excluded_items() && ! empty( $excluded ) ) { |
|
| 1272 | + return false; |
|
| 1273 | + } |
|
| 1274 | + |
|
| 1275 | + if ( $this->has_allowed_items() && empty( $included ) ) { |
|
| 1276 | + return false; |
|
| 1277 | + } |
|
| 1278 | + |
|
| 1279 | + return true; |
|
| 1280 | + } |
|
| 1281 | + |
|
| 1282 | + /** |
|
| 1283 | + * Check if a discount is valid for the given amount |
|
| 1284 | + * |
|
| 1285 | + * @param float $amount The amount to check against |
|
| 1286 | + * @since 1.0.15 |
|
| 1287 | + * @return boolean |
|
| 1288 | + */ |
|
| 1289 | + public function is_valid_for_amount( $amount ) { |
|
| 1290 | + return $this->is_minimum_amount_met( $amount ) && $this->is_maximum_amount_met( $amount ); |
|
| 1291 | + } |
|
| 1292 | + |
|
| 1293 | + /** |
|
| 1294 | + * Checks if the minimum amount is set |
|
| 1295 | + * |
|
| 1296 | + * @since 1.0.15 |
|
| 1297 | + * @return boolean |
|
| 1298 | + */ |
|
| 1299 | + public function has_minimum_amount() { |
|
| 1300 | + $minimum = $this->get_minimum_total(); |
|
| 1301 | + return ! empty( $minimum ); |
|
| 1302 | + } |
|
| 1303 | + |
|
| 1304 | + /** |
|
| 1305 | + * Checks if the minimum amount is met |
|
| 1306 | + * |
|
| 1307 | + * @param float $amount The amount to check against |
|
| 1308 | + * @since 1.0.15 |
|
| 1309 | + * @return boolean |
|
| 1310 | + */ |
|
| 1311 | + public function is_minimum_amount_met( $amount ) { |
|
| 1312 | + $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1313 | + $min_met= ! ( $this->has_minimum_amount() && $amount < floatval( wpinv_sanitize_amount( $this->get_minimum_total() ) ) ); |
|
| 1314 | + return apply_filters( 'wpinv_is_discount_min_met', $min_met, $this->ID, $this, $this->code, $amount ); |
|
| 1315 | + } |
|
| 1316 | + |
|
| 1317 | + /** |
|
| 1318 | + * Checks if the maximum amount is set |
|
| 1319 | + * |
|
| 1320 | + * @since 1.0.15 |
|
| 1321 | + * @return boolean |
|
| 1322 | + */ |
|
| 1323 | + public function has_maximum_amount() { |
|
| 1324 | + $maximum = $this->get_maximum_total(); |
|
| 1325 | + return ! empty( $maximum ); |
|
| 1326 | + } |
|
| 1327 | + |
|
| 1328 | + /** |
|
| 1329 | + * Checks if the maximum amount is met |
|
| 1330 | + * |
|
| 1331 | + * @param float $amount The amount to check against |
|
| 1332 | + * @since 1.0.15 |
|
| 1333 | + * @return boolean |
|
| 1334 | + */ |
|
| 1335 | + public function is_maximum_amount_met( $amount ) { |
|
| 1336 | + $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1337 | + $max_met= ! ( $this->has_maximum_amount() && $amount > floatval( wpinv_sanitize_amount( $this->get_maximum_total() ) ) ); |
|
| 1338 | + return apply_filters( 'wpinv_is_discount_max_met', $max_met, $this->ID, $this, $this->code, $amount ); |
|
| 1339 | + } |
|
| 1340 | + |
|
| 1341 | + /** |
|
| 1342 | + * Checks if the discount is recurring. |
|
| 1343 | + * |
|
| 1344 | + * @since 1.0.15 |
|
| 1345 | + * @return boolean |
|
| 1346 | + */ |
|
| 1347 | + public function is_recurring() { |
|
| 1348 | + $recurring = $this->get_is_recurring(); |
|
| 1349 | + return ! empty( $recurring ); |
|
| 1350 | + } |
|
| 1351 | + |
|
| 1352 | + /** |
|
| 1353 | + * Checks if the discount is single use. |
|
| 1354 | + * |
|
| 1355 | + * @since 1.0.15 |
|
| 1356 | + * @return boolean |
|
| 1357 | + */ |
|
| 1358 | + public function is_single_use() { |
|
| 1359 | + $usage = $this->get_is_single_use(); |
|
| 1360 | + return ! empty( $usage ); |
|
| 1361 | + } |
|
| 1362 | + |
|
| 1363 | + /** |
|
| 1364 | + * Check if a discount is valid for the given user |
|
| 1365 | + * |
|
| 1366 | + * @param int|string $user |
|
| 1367 | + * @since 1.0.15 |
|
| 1368 | + * @return boolean |
|
| 1369 | + */ |
|
| 1370 | + public function is_valid_for_user( $user ) { |
|
| 1371 | + |
|
| 1372 | + // Ensure that the discount is single use. |
|
| 1373 | + if ( empty( $user ) || ! $this->is_single_use() ) { |
|
| 1374 | + return true; |
|
| 1375 | + } |
|
| 1376 | + |
|
| 1377 | + // Prepare the user id. |
|
| 1378 | + $user_id = 0; |
|
| 1379 | 1379 | if ( is_numeric( $user ) ) { |
| 1380 | 1380 | $user_id = absint( $user ); |
| 1381 | 1381 | } else if ( is_email( $user ) && $user_data = get_user_by( 'email', $user ) ) { |
@@ -1384,117 +1384,117 @@ discard block |
||
| 1384 | 1384 | $user_id = $user_data->ID; |
| 1385 | 1385 | } |
| 1386 | 1386 | |
| 1387 | - // Ensure that we have a user. |
|
| 1388 | - if ( empty( $user_id ) ) { |
|
| 1389 | - return true; |
|
| 1390 | - } |
|
| 1387 | + // Ensure that we have a user. |
|
| 1388 | + if ( empty( $user_id ) ) { |
|
| 1389 | + return true; |
|
| 1390 | + } |
|
| 1391 | 1391 | |
| 1392 | - // Get all payments with matching user id. |
|
| 1392 | + // Get all payments with matching user id. |
|
| 1393 | 1393 | $payments = wpinv_get_invoices( array( 'user' => $user_id, 'limit' => false, 'paginate' => false ) ); |
| 1394 | - $code = strtolower( $this->get_code() ); |
|
| 1395 | - |
|
| 1396 | - // For each payment... |
|
| 1397 | - foreach ( $payments as $payment ) { |
|
| 1398 | - |
|
| 1399 | - // Only check for paid invoices. |
|
| 1400 | - if ( $payment->is_paid() && strtolower( $payment->get_discount_code() ) == $code ) { |
|
| 1401 | - return false; |
|
| 1402 | - } |
|
| 1403 | - |
|
| 1404 | - } |
|
| 1405 | - |
|
| 1406 | - return true; |
|
| 1407 | - } |
|
| 1408 | - |
|
| 1409 | - /** |
|
| 1410 | - * Deletes the discount from the database |
|
| 1411 | - * |
|
| 1412 | - * @since 1.0.15 |
|
| 1413 | - * @return boolean |
|
| 1414 | - */ |
|
| 1415 | - public function remove() { |
|
| 1416 | - return $this->delete(); |
|
| 1417 | - } |
|
| 1418 | - |
|
| 1419 | - /** |
|
| 1420 | - * Increases a discount's usage. |
|
| 1421 | - * |
|
| 1422 | - * @since 1.0.15 |
|
| 1423 | - * @param int $by The number of usages to increas by. |
|
| 1424 | - * @return int |
|
| 1425 | - */ |
|
| 1426 | - public function increase_usage( $by = 1 ) { |
|
| 1427 | - |
|
| 1428 | - // Abort if zero. |
|
| 1429 | - if ( empty( $by ) ) { |
|
| 1430 | - return; |
|
| 1431 | - } |
|
| 1432 | - |
|
| 1433 | - // Increase the usage. |
|
| 1434 | - $this->set_uses( $this->get_uses() + (int) $by ); |
|
| 1435 | - |
|
| 1436 | - // Save the discount. |
|
| 1437 | - $this->save(); |
|
| 1438 | - |
|
| 1439 | - // Fire relevant hooks. |
|
| 1440 | - if( (int) $by > 0 ) { |
|
| 1441 | - do_action( 'wpinv_discount_increase_use_count', $this->uses, $this->ID, $this->code, absint( $by ) ); |
|
| 1442 | - } else { |
|
| 1443 | - do_action( 'wpinv_discount_decrease_use_count', $this->uses, $this->ID, $this->code, absint( $by ) ); |
|
| 1444 | - } |
|
| 1445 | - |
|
| 1446 | - // Return the number of times the discount has been used. |
|
| 1447 | - return $this->get_uses(); |
|
| 1448 | - } |
|
| 1449 | - |
|
| 1450 | - /** |
|
| 1451 | - * Alias of self::__toString() |
|
| 1452 | - * |
|
| 1453 | - * @since 1.0.15 |
|
| 1454 | - * @return string|false |
|
| 1455 | - */ |
|
| 1456 | - public function get_data_as_json() { |
|
| 1457 | - return $this->__toString(); |
|
| 1458 | - } |
|
| 1459 | - |
|
| 1460 | - /** |
|
| 1461 | - * Returns a discount's discounted amount. |
|
| 1462 | - * |
|
| 1463 | - * @since 1.0.15 |
|
| 1464 | - * @param float $amount |
|
| 1465 | - * @return float |
|
| 1466 | - */ |
|
| 1467 | - public function get_discounted_amount( $amount ) { |
|
| 1468 | - |
|
| 1469 | - // Convert amount to float. |
|
| 1470 | - $amount = (float) $amount; |
|
| 1471 | - |
|
| 1472 | - // Get discount amount. |
|
| 1473 | - $discount_amount = $this->get_amount(); |
|
| 1474 | - |
|
| 1475 | - if ( empty( $discount_amount ) ) { |
|
| 1476 | - return 0; |
|
| 1477 | - } |
|
| 1478 | - |
|
| 1479 | - // Format the amount. |
|
| 1480 | - $discount_amount = floatval( wpinv_sanitize_amount( $discount_amount ) ); |
|
| 1394 | + $code = strtolower( $this->get_code() ); |
|
| 1395 | + |
|
| 1396 | + // For each payment... |
|
| 1397 | + foreach ( $payments as $payment ) { |
|
| 1398 | + |
|
| 1399 | + // Only check for paid invoices. |
|
| 1400 | + if ( $payment->is_paid() && strtolower( $payment->get_discount_code() ) == $code ) { |
|
| 1401 | + return false; |
|
| 1402 | + } |
|
| 1403 | + |
|
| 1404 | + } |
|
| 1405 | + |
|
| 1406 | + return true; |
|
| 1407 | + } |
|
| 1408 | + |
|
| 1409 | + /** |
|
| 1410 | + * Deletes the discount from the database |
|
| 1411 | + * |
|
| 1412 | + * @since 1.0.15 |
|
| 1413 | + * @return boolean |
|
| 1414 | + */ |
|
| 1415 | + public function remove() { |
|
| 1416 | + return $this->delete(); |
|
| 1417 | + } |
|
| 1418 | + |
|
| 1419 | + /** |
|
| 1420 | + * Increases a discount's usage. |
|
| 1421 | + * |
|
| 1422 | + * @since 1.0.15 |
|
| 1423 | + * @param int $by The number of usages to increas by. |
|
| 1424 | + * @return int |
|
| 1425 | + */ |
|
| 1426 | + public function increase_usage( $by = 1 ) { |
|
| 1427 | + |
|
| 1428 | + // Abort if zero. |
|
| 1429 | + if ( empty( $by ) ) { |
|
| 1430 | + return; |
|
| 1431 | + } |
|
| 1432 | + |
|
| 1433 | + // Increase the usage. |
|
| 1434 | + $this->set_uses( $this->get_uses() + (int) $by ); |
|
| 1435 | + |
|
| 1436 | + // Save the discount. |
|
| 1437 | + $this->save(); |
|
| 1438 | + |
|
| 1439 | + // Fire relevant hooks. |
|
| 1440 | + if( (int) $by > 0 ) { |
|
| 1441 | + do_action( 'wpinv_discount_increase_use_count', $this->uses, $this->ID, $this->code, absint( $by ) ); |
|
| 1442 | + } else { |
|
| 1443 | + do_action( 'wpinv_discount_decrease_use_count', $this->uses, $this->ID, $this->code, absint( $by ) ); |
|
| 1444 | + } |
|
| 1445 | + |
|
| 1446 | + // Return the number of times the discount has been used. |
|
| 1447 | + return $this->get_uses(); |
|
| 1448 | + } |
|
| 1449 | + |
|
| 1450 | + /** |
|
| 1451 | + * Alias of self::__toString() |
|
| 1452 | + * |
|
| 1453 | + * @since 1.0.15 |
|
| 1454 | + * @return string|false |
|
| 1455 | + */ |
|
| 1456 | + public function get_data_as_json() { |
|
| 1457 | + return $this->__toString(); |
|
| 1458 | + } |
|
| 1459 | + |
|
| 1460 | + /** |
|
| 1461 | + * Returns a discount's discounted amount. |
|
| 1462 | + * |
|
| 1463 | + * @since 1.0.15 |
|
| 1464 | + * @param float $amount |
|
| 1465 | + * @return float |
|
| 1466 | + */ |
|
| 1467 | + public function get_discounted_amount( $amount ) { |
|
| 1468 | + |
|
| 1469 | + // Convert amount to float. |
|
| 1470 | + $amount = (float) $amount; |
|
| 1471 | + |
|
| 1472 | + // Get discount amount. |
|
| 1473 | + $discount_amount = $this->get_amount(); |
|
| 1474 | + |
|
| 1475 | + if ( empty( $discount_amount ) ) { |
|
| 1476 | + return 0; |
|
| 1477 | + } |
|
| 1478 | + |
|
| 1479 | + // Format the amount. |
|
| 1480 | + $discount_amount = floatval( wpinv_sanitize_amount( $discount_amount ) ); |
|
| 1481 | 1481 | |
| 1482 | - // If this is a percentage discount. |
|
| 1483 | - if ( $this->is_type( 'percent' ) ) { |
|
| 1482 | + // If this is a percentage discount. |
|
| 1483 | + if ( $this->is_type( 'percent' ) ) { |
|
| 1484 | 1484 | $discount_amount = $amount * ( $discount_amount / 100 ); |
| 1485 | - } |
|
| 1485 | + } |
|
| 1486 | 1486 | |
| 1487 | - // Discount can not be less than zero... |
|
| 1488 | - if ( $discount_amount < 0 ) { |
|
| 1489 | - $discount_amount = 0; |
|
| 1490 | - } |
|
| 1487 | + // Discount can not be less than zero... |
|
| 1488 | + if ( $discount_amount < 0 ) { |
|
| 1489 | + $discount_amount = 0; |
|
| 1490 | + } |
|
| 1491 | 1491 | |
| 1492 | - // ... or more than the amount. |
|
| 1493 | - if ( $discount_amount > $amount ) { |
|
| 1494 | - $discount_amount = $amount; |
|
| 1495 | - } |
|
| 1492 | + // ... or more than the amount. |
|
| 1493 | + if ( $discount_amount > $amount ) { |
|
| 1494 | + $discount_amount = $amount; |
|
| 1495 | + } |
|
| 1496 | 1496 | |
| 1497 | - return apply_filters( 'wpinv_discount_total_discount_amount', $discount_amount, $amount, $this ); |
|
| 1498 | - } |
|
| 1497 | + return apply_filters( 'wpinv_discount_total_discount_amount', $discount_amount, $amount, $this ); |
|
| 1498 | + } |
|
| 1499 | 1499 | |
| 1500 | 1500 | } |