@@ -67,7 +67,7 @@ discard block |
||
| 67 | 67 | * Checks if the current user cna view an invoice receipt. |
| 68 | 68 | */ |
| 69 | 69 | function wpinv_can_view_receipt( $invoice ) { |
| 70 | - return (bool) apply_filters( 'wpinv_can_view_receipt', wpinv_user_can_view_invoice( $invoice ), $invoice ); |
|
| 70 | + return (bool) apply_filters( 'wpinv_can_view_receipt', wpinv_user_can_view_invoice( $invoice ), $invoice ); |
|
| 71 | 71 | } |
| 72 | 72 | |
| 73 | 73 | /** |
@@ -1280,22 +1280,22 @@ discard block |
||
| 1280 | 1280 | */ |
| 1281 | 1281 | function getpaid_get_invoice_status_classes() { |
| 1282 | 1282 | |
| 1283 | - return apply_filters( |
|
| 1284 | - 'getpaid_get_invoice_status_classes', |
|
| 1285 | - array( |
|
| 1283 | + return apply_filters( |
|
| 1284 | + 'getpaid_get_invoice_status_classes', |
|
| 1285 | + array( |
|
| 1286 | 1286 | 'wpi-quote-declined' => 'badge-danger', |
| 1287 | 1287 | 'wpi-failed' => 'badge-danger', |
| 1288 | - 'wpi-processing' => 'badge-info', |
|
| 1289 | - 'wpi-onhold' => 'badge-warning', |
|
| 1290 | - 'wpi-quote-accepted' => 'badge-success', |
|
| 1291 | - 'publish' => 'badge-success', |
|
| 1292 | - 'wpi-renewal' => 'badge-primary', |
|
| 1288 | + 'wpi-processing' => 'badge-info', |
|
| 1289 | + 'wpi-onhold' => 'badge-warning', |
|
| 1290 | + 'wpi-quote-accepted' => 'badge-success', |
|
| 1291 | + 'publish' => 'badge-success', |
|
| 1292 | + 'wpi-renewal' => 'badge-primary', |
|
| 1293 | 1293 | 'wpi-cancelled' => 'badge-secondary', |
| 1294 | 1294 | 'wpi-pending' => 'badge-dark', |
| 1295 | 1295 | 'wpi-quote-pending' => 'badge-dark', |
| 1296 | 1296 | 'wpi-refunded' => 'badge-secondary', |
| 1297 | - ) |
|
| 1298 | - ); |
|
| 1297 | + ) |
|
| 1298 | + ); |
|
| 1299 | 1299 | |
| 1300 | 1300 | } |
| 1301 | 1301 | |
@@ -1309,7 +1309,7 @@ discard block |
||
| 1309 | 1309 | function getpaid_get_invoice_tax_rate( $invoice, $item ) { |
| 1310 | 1310 | |
| 1311 | 1311 | $rates = getpaid_get_item_tax_rates( $item, $invoice->get_country(), $invoice->get_state() ); |
| 1312 | - $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
| 1312 | + $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
| 1313 | 1313 | $rates = wp_list_pluck( $rates, 'rate' ); |
| 1314 | 1314 | |
| 1315 | 1315 | return array_sum( $rates ); |
@@ -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 | <style> |
@@ -102,11 +102,11 @@ discard block |
||
| 102 | 102 | } |
| 103 | 103 | |
| 104 | 104 | /** |
| 105 | - * Save meta box data. |
|
| 106 | - * |
|
| 107 | - * @param int $post_id |
|
| 108 | - */ |
|
| 109 | - public static function save( $post_id ) { |
|
| 105 | + * Save meta box data. |
|
| 106 | + * |
|
| 107 | + * @param int $post_id |
|
| 108 | + */ |
|
| 109 | + public static function save( $post_id ) { |
|
| 110 | 110 | |
| 111 | 111 | // Prepare the form. |
| 112 | 112 | $form = new GetPaid_Payment_Form( $post_id ); |
@@ -137,11 +137,11 @@ discard block |
||
| 137 | 137 | } |
| 138 | 138 | |
| 139 | 139 | /** |
| 140 | - * Converts an array fo form items to objects. |
|
| 141 | - * |
|
| 142 | - * @param array $items |
|
| 143 | - */ |
|
| 144 | - public static function item_to_objects( $items ) { |
|
| 140 | + * Converts an array fo form items to objects. |
|
| 141 | + * |
|
| 142 | + * @param array $items |
|
| 143 | + */ |
|
| 144 | + public static function item_to_objects( $items ) { |
|
| 145 | 145 | |
| 146 | 146 | $objects = array(); |
| 147 | 147 | |
@@ -12,180 +12,180 @@ discard block |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Checkout { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * @var GetPaid_Payment_Form_Submission |
|
| 17 | - */ |
|
| 18 | - protected $payment_form_submission; |
|
| 19 | - |
|
| 20 | - /** |
|
| 21 | - * Class constructor. |
|
| 22 | - * |
|
| 23 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 24 | - */ |
|
| 25 | - public function __construct( $submission ) { |
|
| 26 | - $this->payment_form_submission = $submission; |
|
| 27 | - } |
|
| 28 | - |
|
| 29 | - /** |
|
| 30 | - * Processes the checkout. |
|
| 31 | - * |
|
| 32 | - */ |
|
| 33 | - public function process_checkout() { |
|
| 34 | - |
|
| 35 | - // Validate the submission. |
|
| 36 | - $this->validate_submission(); |
|
| 37 | - |
|
| 38 | - // Prepare the invoice. |
|
| 39 | - $items = $this->get_submission_items(); |
|
| 40 | - $invoice = $this->get_submission_invoice(); |
|
| 41 | - $invoice = $this->process_submission_invoice( $invoice, $items ); |
|
| 42 | - $prepared = $this->prepare_submission_data_for_saving(); |
|
| 43 | - |
|
| 44 | - $this->prepare_billing_info( $invoice ); |
|
| 45 | - |
|
| 46 | - $shipping = $this->prepare_shipping_info( $invoice ); |
|
| 47 | - |
|
| 48 | - // Save the invoice. |
|
| 49 | - $invoice->set_is_viewed( true ); |
|
| 50 | - $invoice->recalculate_total(); |
|
| 15 | + /** |
|
| 16 | + * @var GetPaid_Payment_Form_Submission |
|
| 17 | + */ |
|
| 18 | + protected $payment_form_submission; |
|
| 19 | + |
|
| 20 | + /** |
|
| 21 | + * Class constructor. |
|
| 22 | + * |
|
| 23 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 24 | + */ |
|
| 25 | + public function __construct( $submission ) { |
|
| 26 | + $this->payment_form_submission = $submission; |
|
| 27 | + } |
|
| 28 | + |
|
| 29 | + /** |
|
| 30 | + * Processes the checkout. |
|
| 31 | + * |
|
| 32 | + */ |
|
| 33 | + public function process_checkout() { |
|
| 34 | + |
|
| 35 | + // Validate the submission. |
|
| 36 | + $this->validate_submission(); |
|
| 37 | + |
|
| 38 | + // Prepare the invoice. |
|
| 39 | + $items = $this->get_submission_items(); |
|
| 40 | + $invoice = $this->get_submission_invoice(); |
|
| 41 | + $invoice = $this->process_submission_invoice( $invoice, $items ); |
|
| 42 | + $prepared = $this->prepare_submission_data_for_saving(); |
|
| 43 | + |
|
| 44 | + $this->prepare_billing_info( $invoice ); |
|
| 45 | + |
|
| 46 | + $shipping = $this->prepare_shipping_info( $invoice ); |
|
| 47 | + |
|
| 48 | + // Save the invoice. |
|
| 49 | + $invoice->set_is_viewed( true ); |
|
| 50 | + $invoice->recalculate_total(); |
|
| 51 | 51 | $invoice->save(); |
| 52 | 52 | |
| 53 | - do_action( 'getpaid_checkout_invoice_updated', $invoice ); |
|
| 53 | + do_action( 'getpaid_checkout_invoice_updated', $invoice ); |
|
| 54 | 54 | |
| 55 | - // Send to the gateway. |
|
| 56 | - $this->post_process_submission( $invoice, $prepared, $shipping ); |
|
| 57 | - } |
|
| 55 | + // Send to the gateway. |
|
| 56 | + $this->post_process_submission( $invoice, $prepared, $shipping ); |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * Validates the submission. |
|
| 61 | - * |
|
| 62 | - */ |
|
| 63 | - protected function validate_submission() { |
|
| 59 | + /** |
|
| 60 | + * Validates the submission. |
|
| 61 | + * |
|
| 62 | + */ |
|
| 63 | + protected function validate_submission() { |
|
| 64 | 64 | |
| 65 | - $submission = $this->payment_form_submission; |
|
| 66 | - $data = $submission->get_data(); |
|
| 65 | + $submission = $this->payment_form_submission; |
|
| 66 | + $data = $submission->get_data(); |
|
| 67 | 67 | |
| 68 | - // Do we have an error? |
|
| 68 | + // Do we have an error? |
|
| 69 | 69 | if ( ! empty( $submission->last_error ) ) { |
| 70 | - wp_send_json_error( $submission->last_error ); |
|
| 70 | + wp_send_json_error( $submission->last_error ); |
|
| 71 | 71 | } |
| 72 | 72 | |
| 73 | - // We need a billing email. |
|
| 73 | + // We need a billing email. |
|
| 74 | 74 | if ( ! $submission->has_billing_email() ) { |
| 75 | 75 | wp_send_json_error( __( 'Provide a valid billing email.', 'invoicing' ) ); |
| 76 | - } |
|
| 76 | + } |
|
| 77 | 77 | |
| 78 | - // Non-recurring gateways should not be allowed to process recurring invoices. |
|
| 79 | - if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) { |
|
| 80 | - wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) ); |
|
| 81 | - } |
|
| 78 | + // Non-recurring gateways should not be allowed to process recurring invoices. |
|
| 79 | + if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) { |
|
| 80 | + wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) ); |
|
| 81 | + } |
|
| 82 | 82 | |
| 83 | - // Ensure the gateway is active. |
|
| 84 | - if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) { |
|
| 85 | - wpinv_set_error( 'invalid_gateway', __( 'The selected payment gateway is not active', 'invoicing' ) ); |
|
| 86 | - } |
|
| 83 | + // Ensure the gateway is active. |
|
| 84 | + if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) { |
|
| 85 | + wpinv_set_error( 'invalid_gateway', __( 'The selected payment gateway is not active', 'invoicing' ) ); |
|
| 86 | + } |
|
| 87 | 87 | |
| 88 | - // Clear any existing errors. |
|
| 89 | - wpinv_clear_errors(); |
|
| 88 | + // Clear any existing errors. |
|
| 89 | + wpinv_clear_errors(); |
|
| 90 | 90 | |
| 91 | - // Allow themes and plugins to hook to errors |
|
| 92 | - do_action( 'getpaid_checkout_error_checks', $submission ); |
|
| 91 | + // Allow themes and plugins to hook to errors |
|
| 92 | + do_action( 'getpaid_checkout_error_checks', $submission ); |
|
| 93 | 93 | |
| 94 | - // Do we have any errors? |
|
| 94 | + // Do we have any errors? |
|
| 95 | 95 | if ( wpinv_get_errors() ) { |
| 96 | 96 | wp_send_json_error( getpaid_get_errors_html() ); |
| 97 | - } |
|
| 97 | + } |
|
| 98 | 98 | |
| 99 | - } |
|
| 99 | + } |
|
| 100 | 100 | |
| 101 | - /** |
|
| 102 | - * Retrieves submission items. |
|
| 103 | - * |
|
| 104 | - * @return GetPaid_Form_Item[] |
|
| 105 | - */ |
|
| 106 | - protected function get_submission_items() { |
|
| 101 | + /** |
|
| 102 | + * Retrieves submission items. |
|
| 103 | + * |
|
| 104 | + * @return GetPaid_Form_Item[] |
|
| 105 | + */ |
|
| 106 | + protected function get_submission_items() { |
|
| 107 | 107 | |
| 108 | - $items = $this->payment_form_submission->get_items(); |
|
| 108 | + $items = $this->payment_form_submission->get_items(); |
|
| 109 | 109 | |
| 110 | 110 | // Ensure that we have items. |
| 111 | 111 | if ( empty( $items ) && ! $this->payment_form_submission->has_fees() ) { |
| 112 | 112 | wp_send_json_error( __( 'Please provide at least one item or amount.', 'invoicing' ) ); |
| 113 | - } |
|
| 114 | - |
|
| 115 | - return $items; |
|
| 116 | - } |
|
| 117 | - |
|
| 118 | - /** |
|
| 119 | - * Retrieves submission invoice. |
|
| 120 | - * |
|
| 121 | - * @return WPInv_Invoice |
|
| 122 | - */ |
|
| 123 | - protected function get_submission_invoice() { |
|
| 124 | - $submission = $this->payment_form_submission; |
|
| 125 | - |
|
| 126 | - if ( ! $submission->has_invoice() ) { |
|
| 127 | - $invoice = new WPInv_Invoice(); |
|
| 128 | - $invoice->set_created_via( 'payment_form' ); |
|
| 129 | - return $invoice; |
|
| 130 | 113 | } |
| 131 | 114 | |
| 132 | - $invoice = $submission->get_invoice(); |
|
| 115 | + return $items; |
|
| 116 | + } |
|
| 133 | 117 | |
| 134 | - // Make sure that it is neither paid or refunded. |
|
| 135 | - if ( $invoice->is_paid() || $invoice->is_refunded() ) { |
|
| 136 | - wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) ); |
|
| 137 | - } |
|
| 118 | + /** |
|
| 119 | + * Retrieves submission invoice. |
|
| 120 | + * |
|
| 121 | + * @return WPInv_Invoice |
|
| 122 | + */ |
|
| 123 | + protected function get_submission_invoice() { |
|
| 124 | + $submission = $this->payment_form_submission; |
|
| 138 | 125 | |
| 139 | - return $invoice; |
|
| 140 | - } |
|
| 126 | + if ( ! $submission->has_invoice() ) { |
|
| 127 | + $invoice = new WPInv_Invoice(); |
|
| 128 | + $invoice->set_created_via( 'payment_form' ); |
|
| 129 | + return $invoice; |
|
| 130 | + } |
|
| 141 | 131 | |
| 142 | - /** |
|
| 143 | - * Processes the submission invoice. |
|
| 144 | - * |
|
| 145 | - * @param WPInv_Invoice $invoice |
|
| 146 | - * @param GetPaid_Form_Item[] $items |
|
| 147 | - * @return WPInv_Invoice |
|
| 148 | - */ |
|
| 149 | - protected function process_submission_invoice( $invoice, $items ) { |
|
| 132 | + $invoice = $submission->get_invoice(); |
|
| 150 | 133 | |
| 151 | - $submission = $this->payment_form_submission; |
|
| 152 | - $data = $submission->get_data(); |
|
| 134 | + // Make sure that it is neither paid or refunded. |
|
| 135 | + if ( $invoice->is_paid() || $invoice->is_refunded() ) { |
|
| 136 | + wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) ); |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + return $invoice; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + /** |
|
| 143 | + * Processes the submission invoice. |
|
| 144 | + * |
|
| 145 | + * @param WPInv_Invoice $invoice |
|
| 146 | + * @param GetPaid_Form_Item[] $items |
|
| 147 | + * @return WPInv_Invoice |
|
| 148 | + */ |
|
| 149 | + protected function process_submission_invoice( $invoice, $items ) { |
|
| 153 | 150 | |
| 154 | - // Set-up the invoice details. |
|
| 155 | - $invoice->set_email( sanitize_email( $submission->get_billing_email() ) ); |
|
| 156 | - $invoice->set_user_id( $this->get_submission_customer() ); |
|
| 157 | - $invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) ); |
|
| 151 | + $submission = $this->payment_form_submission; |
|
| 152 | + $data = $submission->get_data(); |
|
| 153 | + |
|
| 154 | + // Set-up the invoice details. |
|
| 155 | + $invoice->set_email( sanitize_email( $submission->get_billing_email() ) ); |
|
| 156 | + $invoice->set_user_id( $this->get_submission_customer() ); |
|
| 157 | + $invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) ); |
|
| 158 | 158 | $invoice->set_items( $items ); |
| 159 | 159 | $invoice->set_fees( $submission->get_fees() ); |
| 160 | 160 | $invoice->set_taxes( $submission->get_taxes() ); |
| 161 | - $invoice->set_discounts( $submission->get_discounts() ); |
|
| 162 | - $invoice->set_gateway( $data['wpi-gateway'] ); |
|
| 161 | + $invoice->set_discounts( $submission->get_discounts() ); |
|
| 162 | + $invoice->set_gateway( $data['wpi-gateway'] ); |
|
| 163 | 163 | |
| 164 | - $address_confirmed = $submission->get_field( 'confirm-address' ); |
|
| 165 | - $invoice->set_address_confirmed( ! empty( $address_confirmed ) ); |
|
| 164 | + $address_confirmed = $submission->get_field( 'confirm-address' ); |
|
| 165 | + $invoice->set_address_confirmed( ! empty( $address_confirmed ) ); |
|
| 166 | 166 | |
| 167 | - if ( $submission->has_discount_code() ) { |
|
| 167 | + if ( $submission->has_discount_code() ) { |
|
| 168 | 168 | $invoice->set_discount_code( $submission->get_discount_code() ); |
| 169 | - } |
|
| 170 | - |
|
| 171 | - getpaid_maybe_add_default_address( $invoice ); |
|
| 172 | - return $invoice; |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - /** |
|
| 176 | - * Retrieves the submission's customer. |
|
| 177 | - * |
|
| 178 | - * @return int The customer id. |
|
| 179 | - */ |
|
| 180 | - protected function get_submission_customer() { |
|
| 181 | - $submission = $this->payment_form_submission; |
|
| 182 | - |
|
| 183 | - // If this is an existing invoice... |
|
| 184 | - if ( $submission->has_invoice() ) { |
|
| 185 | - return $submission->get_invoice()->get_user_id(); |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - // (Maybe) create the user. |
|
| 169 | + } |
|
| 170 | + |
|
| 171 | + getpaid_maybe_add_default_address( $invoice ); |
|
| 172 | + return $invoice; |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + /** |
|
| 176 | + * Retrieves the submission's customer. |
|
| 177 | + * |
|
| 178 | + * @return int The customer id. |
|
| 179 | + */ |
|
| 180 | + protected function get_submission_customer() { |
|
| 181 | + $submission = $this->payment_form_submission; |
|
| 182 | + |
|
| 183 | + // If this is an existing invoice... |
|
| 184 | + if ( $submission->has_invoice() ) { |
|
| 185 | + return $submission->get_invoice()->get_user_id(); |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + // (Maybe) create the user. |
|
| 189 | 189 | $user = get_current_user_id(); |
| 190 | 190 | |
| 191 | 191 | if ( empty( $user ) ) { |
@@ -202,31 +202,31 @@ discard block |
||
| 202 | 202 | |
| 203 | 203 | if ( is_numeric( $user ) ) { |
| 204 | 204 | return $user; |
| 205 | - } |
|
| 205 | + } |
|
| 206 | 206 | |
| 207 | - return $user->ID; |
|
| 207 | + return $user->ID; |
|
| 208 | 208 | |
| 209 | - } |
|
| 209 | + } |
|
| 210 | 210 | |
| 211 | - /** |
|
| 211 | + /** |
|
| 212 | 212 | * Prepares submission data for saving to the database. |
| 213 | 213 | * |
| 214 | - * @return array |
|
| 214 | + * @return array |
|
| 215 | 215 | */ |
| 216 | 216 | public function prepare_submission_data_for_saving() { |
| 217 | 217 | |
| 218 | - $submission = $this->payment_form_submission; |
|
| 218 | + $submission = $this->payment_form_submission; |
|
| 219 | 219 | |
| 220 | - // Prepared submission details. |
|
| 220 | + // Prepared submission details. |
|
| 221 | 221 | $prepared = array(); |
| 222 | 222 | |
| 223 | 223 | // Raw submission details. |
| 224 | - $data = $submission->get_data(); |
|
| 224 | + $data = $submission->get_data(); |
|
| 225 | 225 | |
| 226 | - // Loop through the submitted details. |
|
| 226 | + // Loop through the submitted details. |
|
| 227 | 227 | foreach ( $submission->get_payment_form()->get_elements() as $field ) { |
| 228 | 228 | |
| 229 | - // Skip premade fields. |
|
| 229 | + // Skip premade fields. |
|
| 230 | 230 | if ( ! empty( $field['premade'] ) || $field['type'] == 'address' ) { |
| 231 | 231 | continue; |
| 232 | 232 | } |
@@ -244,176 +244,176 @@ discard block |
||
| 244 | 244 | $label = $field['label']; |
| 245 | 245 | } |
| 246 | 246 | |
| 247 | - $prepared[ wpinv_clean( $label ) ] = wp_kses_post( $data[ $field['id'] ] ); |
|
| 247 | + $prepared[ wpinv_clean( $label ) ] = wp_kses_post( $data[ $field['id'] ] ); |
|
| 248 | 248 | |
| 249 | 249 | } |
| 250 | 250 | |
| 251 | - } |
|
| 251 | + } |
|
| 252 | 252 | |
| 253 | - return $prepared; |
|
| 253 | + return $prepared; |
|
| 254 | 254 | |
| 255 | - } |
|
| 255 | + } |
|
| 256 | 256 | |
| 257 | - /** |
|
| 257 | + /** |
|
| 258 | 258 | * Retrieves address details. |
| 259 | 259 | * |
| 260 | - * @return array |
|
| 261 | - * @param WPInv_Invoice $invoice |
|
| 262 | - * @param string $type |
|
| 260 | + * @return array |
|
| 261 | + * @param WPInv_Invoice $invoice |
|
| 262 | + * @param string $type |
|
| 263 | 263 | */ |
| 264 | 264 | public function prepare_address_details( $invoice, $type = 'billing' ) { |
| 265 | 265 | |
| 266 | - $data = $this->payment_form_submission->get_data(); |
|
| 267 | - $type = sanitize_key( $type ); |
|
| 268 | - $address = array(); |
|
| 269 | - $prepared = array(); |
|
| 266 | + $data = $this->payment_form_submission->get_data(); |
|
| 267 | + $type = sanitize_key( $type ); |
|
| 268 | + $address = array(); |
|
| 269 | + $prepared = array(); |
|
| 270 | 270 | |
| 271 | - if ( ! empty( $data[ $type ] ) ) { |
|
| 272 | - $address = $data[ $type ]; |
|
| 273 | - } |
|
| 271 | + if ( ! empty( $data[ $type ] ) ) { |
|
| 272 | + $address = $data[ $type ]; |
|
| 273 | + } |
|
| 274 | 274 | |
| 275 | - // Clean address details. |
|
| 276 | - foreach ( $address as $key => $value ) { |
|
| 277 | - $key = sanitize_key( $key ); |
|
| 278 | - $key = str_replace( 'wpinv_', '', $key ); |
|
| 279 | - $value = wpinv_clean( $value ); |
|
| 280 | - $prepared[ $key] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice ); |
|
| 281 | - } |
|
| 275 | + // Clean address details. |
|
| 276 | + foreach ( $address as $key => $value ) { |
|
| 277 | + $key = sanitize_key( $key ); |
|
| 278 | + $key = str_replace( 'wpinv_', '', $key ); |
|
| 279 | + $value = wpinv_clean( $value ); |
|
| 280 | + $prepared[ $key] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice ); |
|
| 281 | + } |
|
| 282 | 282 | |
| 283 | - // Filter address details. |
|
| 284 | - $prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice ); |
|
| 283 | + // Filter address details. |
|
| 284 | + $prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice ); |
|
| 285 | 285 | |
| 286 | - // Remove non-whitelisted values. |
|
| 287 | - return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY ); |
|
| 286 | + // Remove non-whitelisted values. |
|
| 287 | + return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY ); |
|
| 288 | 288 | |
| 289 | - } |
|
| 289 | + } |
|
| 290 | 290 | |
| 291 | - /** |
|
| 291 | + /** |
|
| 292 | 292 | * Prepares the billing details. |
| 293 | 293 | * |
| 294 | - * @return array |
|
| 295 | - * @param WPInv_Invoice $invoice |
|
| 294 | + * @return array |
|
| 295 | + * @param WPInv_Invoice $invoice |
|
| 296 | 296 | */ |
| 297 | 297 | protected function prepare_billing_info( &$invoice ) { |
| 298 | 298 | |
| 299 | - $billing_address = $this->prepare_address_details( $invoice, 'billing' ); |
|
| 299 | + $billing_address = $this->prepare_address_details( $invoice, 'billing' ); |
|
| 300 | 300 | |
| 301 | - // Update the invoice with the billing details. |
|
| 302 | - $invoice->set_props( $billing_address ); |
|
| 301 | + // Update the invoice with the billing details. |
|
| 302 | + $invoice->set_props( $billing_address ); |
|
| 303 | 303 | |
| 304 | - } |
|
| 304 | + } |
|
| 305 | 305 | |
| 306 | - /** |
|
| 306 | + /** |
|
| 307 | 307 | * Prepares the shipping details. |
| 308 | 308 | * |
| 309 | - * @return array |
|
| 310 | - * @param WPInv_Invoice $invoice |
|
| 309 | + * @return array |
|
| 310 | + * @param WPInv_Invoice $invoice |
|
| 311 | 311 | */ |
| 312 | 312 | protected function prepare_shipping_info( $invoice ) { |
| 313 | 313 | |
| 314 | - $data = $this->payment_form_submission->get_data(); |
|
| 314 | + $data = $this->payment_form_submission->get_data(); |
|
| 315 | 315 | |
| 316 | - if ( empty( $data['same-shipping-address'] ) ) { |
|
| 317 | - return $this->prepare_address_details( $invoice, 'shipping' ); |
|
| 318 | - } |
|
| 316 | + if ( empty( $data['same-shipping-address'] ) ) { |
|
| 317 | + return $this->prepare_address_details( $invoice, 'shipping' ); |
|
| 318 | + } |
|
| 319 | 319 | |
| 320 | - return $this->prepare_address_details( $invoice, 'billing' ); |
|
| 320 | + return $this->prepare_address_details( $invoice, 'billing' ); |
|
| 321 | 321 | |
| 322 | - } |
|
| 322 | + } |
|
| 323 | 323 | |
| 324 | - /** |
|
| 325 | - * Confirms the submission is valid and send users to the gateway. |
|
| 326 | - * |
|
| 327 | - * @param WPInv_Invoice $invoice |
|
| 328 | - * @param array $prepared_payment_form_data |
|
| 329 | - * @param array $shipping |
|
| 330 | - */ |
|
| 331 | - protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) { |
|
| 324 | + /** |
|
| 325 | + * Confirms the submission is valid and send users to the gateway. |
|
| 326 | + * |
|
| 327 | + * @param WPInv_Invoice $invoice |
|
| 328 | + * @param array $prepared_payment_form_data |
|
| 329 | + * @param array $shipping |
|
| 330 | + */ |
|
| 331 | + protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) { |
|
| 332 | 332 | |
| 333 | - // Ensure the invoice exists. |
|
| 333 | + // Ensure the invoice exists. |
|
| 334 | 334 | if ( ! $invoice->exists() ) { |
| 335 | 335 | wp_send_json_error( __( 'An error occured while saving your invoice. Please try again.', 'invoicing' ) ); |
| 336 | 336 | } |
| 337 | 337 | |
| 338 | - // Save payment form data. |
|
| 339 | - $prepared_payment_form_data = apply_filters( 'getpaid_prepared_payment_form_data', $prepared_payment_form_data, $invoice ); |
|
| 338 | + // Save payment form data. |
|
| 339 | + $prepared_payment_form_data = apply_filters( 'getpaid_prepared_payment_form_data', $prepared_payment_form_data, $invoice ); |
|
| 340 | 340 | if ( ! empty( $prepared_payment_form_data ) ) { |
| 341 | 341 | update_post_meta( $invoice->get_id(), 'payment_form_data', $prepared_payment_form_data ); |
| 342 | - } |
|
| 342 | + } |
|
| 343 | 343 | |
| 344 | - // Save payment form data. |
|
| 344 | + // Save payment form data. |
|
| 345 | 345 | if ( ! empty( $shipping ) ) { |
| 346 | 346 | update_post_meta( $invoice->get_id(), 'shipping_address', $shipping ); |
| 347 | - } |
|
| 347 | + } |
|
| 348 | 348 | |
| 349 | - // Backwards compatibility. |
|
| 349 | + // Backwards compatibility. |
|
| 350 | 350 | add_filter( 'wp_redirect', array( $this, 'send_redirect_response' ) ); |
| 351 | 351 | |
| 352 | - $this->process_payment( $invoice ); |
|
| 352 | + $this->process_payment( $invoice ); |
|
| 353 | 353 | |
| 354 | 354 | // If we are here, there was an error. |
| 355 | - wpinv_send_back_to_checkout( $invoice ); |
|
| 355 | + wpinv_send_back_to_checkout( $invoice ); |
|
| 356 | 356 | |
| 357 | - } |
|
| 357 | + } |
|
| 358 | 358 | |
| 359 | - /** |
|
| 360 | - * Processes the actual payment. |
|
| 361 | - * |
|
| 362 | - * @param WPInv_Invoice $invoice |
|
| 363 | - */ |
|
| 364 | - protected function process_payment( $invoice ) { |
|
| 359 | + /** |
|
| 360 | + * Processes the actual payment. |
|
| 361 | + * |
|
| 362 | + * @param WPInv_Invoice $invoice |
|
| 363 | + */ |
|
| 364 | + protected function process_payment( $invoice ) { |
|
| 365 | 365 | |
| 366 | - // Clear any checkout errors. |
|
| 367 | - wpinv_clear_errors(); |
|
| 366 | + // Clear any checkout errors. |
|
| 367 | + wpinv_clear_errors(); |
|
| 368 | 368 | |
| 369 | - // No need to send free invoices to the gateway. |
|
| 370 | - if ( $invoice->is_free() ) { |
|
| 371 | - $this->process_free_payment( $invoice ); |
|
| 372 | - } |
|
| 369 | + // No need to send free invoices to the gateway. |
|
| 370 | + if ( $invoice->is_free() ) { |
|
| 371 | + $this->process_free_payment( $invoice ); |
|
| 372 | + } |
|
| 373 | 373 | |
| 374 | - $submission = $this->payment_form_submission; |
|
| 374 | + $submission = $this->payment_form_submission; |
|
| 375 | 375 | |
| 376 | - // Fires before sending to the gateway. |
|
| 377 | - do_action( 'getpaid_checkout_before_gateway', $invoice, $submission ); |
|
| 376 | + // Fires before sending to the gateway. |
|
| 377 | + do_action( 'getpaid_checkout_before_gateway', $invoice, $submission ); |
|
| 378 | 378 | |
| 379 | - // Allow the sumission data to be modified before it is sent to the gateway. |
|
| 380 | - $submission_data = $submission->get_data(); |
|
| 381 | - $submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice ); |
|
| 382 | - $submission_data = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice ); |
|
| 379 | + // Allow the sumission data to be modified before it is sent to the gateway. |
|
| 380 | + $submission_data = $submission->get_data(); |
|
| 381 | + $submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice ); |
|
| 382 | + $submission_data = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice ); |
|
| 383 | 383 | |
| 384 | - // Validate the currency. |
|
| 385 | - if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) { |
|
| 386 | - wpinv_set_error( 'invalid_currency', __( 'The chosen payment gateway does not support this currency', 'invoicing' ) ); |
|
| 387 | - } |
|
| 384 | + // Validate the currency. |
|
| 385 | + if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) { |
|
| 386 | + wpinv_set_error( 'invalid_currency', __( 'The chosen payment gateway does not support this currency', 'invoicing' ) ); |
|
| 387 | + } |
|
| 388 | 388 | |
| 389 | - // Check to see if we have any errors. |
|
| 390 | - if ( wpinv_get_errors() ) { |
|
| 391 | - wpinv_send_back_to_checkout( $invoice ); |
|
| 392 | - } |
|
| 389 | + // Check to see if we have any errors. |
|
| 390 | + if ( wpinv_get_errors() ) { |
|
| 391 | + wpinv_send_back_to_checkout( $invoice ); |
|
| 392 | + } |
|
| 393 | 393 | |
| 394 | - // Send info to the gateway for payment processing |
|
| 395 | - do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission ); |
|
| 394 | + // Send info to the gateway for payment processing |
|
| 395 | + do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission ); |
|
| 396 | 396 | |
| 397 | - // Backwards compatibility. |
|
| 398 | - wpinv_send_to_gateway( $submission_gateway, $invoice ); |
|
| 397 | + // Backwards compatibility. |
|
| 398 | + wpinv_send_to_gateway( $submission_gateway, $invoice ); |
|
| 399 | 399 | |
| 400 | - } |
|
| 400 | + } |
|
| 401 | 401 | |
| 402 | - /** |
|
| 403 | - * Marks the invoice as paid in case the checkout is free. |
|
| 404 | - * |
|
| 405 | - * @param WPInv_Invoice $invoice |
|
| 406 | - */ |
|
| 407 | - protected function process_free_payment( $invoice ) { |
|
| 402 | + /** |
|
| 403 | + * Marks the invoice as paid in case the checkout is free. |
|
| 404 | + * |
|
| 405 | + * @param WPInv_Invoice $invoice |
|
| 406 | + */ |
|
| 407 | + protected function process_free_payment( $invoice ) { |
|
| 408 | 408 | |
| 409 | - $invoice->set_gateway( 'none' ); |
|
| 410 | - $invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true ); |
|
| 411 | - $invoice->mark_paid(); |
|
| 412 | - wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) ); |
|
| 409 | + $invoice->set_gateway( 'none' ); |
|
| 410 | + $invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true ); |
|
| 411 | + $invoice->mark_paid(); |
|
| 412 | + wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) ); |
|
| 413 | 413 | |
| 414 | - } |
|
| 414 | + } |
|
| 415 | 415 | |
| 416 | - /** |
|
| 416 | + /** |
|
| 417 | 417 | * Sends a redrect response to payment details. |
| 418 | 418 | * |
| 419 | 419 | */ |
@@ -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,30 +10,30 @@ discard block |
||
| 10 | 10 | class WPInv_Item 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 = 'item'; |
| 18 | 18 | |
| 19 | 19 | /** |
| 20 | - * This is the name of this object type. |
|
| 21 | - * |
|
| 22 | - * @var string |
|
| 23 | - */ |
|
| 24 | - protected $object_type = 'item'; |
|
| 20 | + * This is the name of this object type. |
|
| 21 | + * |
|
| 22 | + * @var string |
|
| 23 | + */ |
|
| 24 | + protected $object_type = 'item'; |
|
| 25 | 25 | |
| 26 | 26 | /** |
| 27 | - * Item Data array. This is the core item data exposed in APIs. |
|
| 28 | - * |
|
| 29 | - * @since 1.0.19 |
|
| 30 | - * @var array |
|
| 31 | - */ |
|
| 32 | - protected $data = array( |
|
| 33 | - 'parent_id' => 0, |
|
| 34 | - 'status' => 'draft', |
|
| 35 | - 'version' => '', |
|
| 36 | - 'date_created' => null, |
|
| 27 | + * Item Data array. This is the core item data exposed in APIs. |
|
| 28 | + * |
|
| 29 | + * @since 1.0.19 |
|
| 30 | + * @var array |
|
| 31 | + */ |
|
| 32 | + protected $data = array( |
|
| 33 | + 'parent_id' => 0, |
|
| 34 | + 'status' => 'draft', |
|
| 35 | + 'version' => '', |
|
| 36 | + 'date_created' => null, |
|
| 37 | 37 | 'date_modified' => null, |
| 38 | 38 | 'name' => '', |
| 39 | 39 | 'description' => '', |
@@ -58,13 +58,13 @@ discard block |
||
| 58 | 58 | ); |
| 59 | 59 | |
| 60 | 60 | /** |
| 61 | - * Stores meta in cache for future reads. |
|
| 62 | - * |
|
| 63 | - * A group must be set to to enable caching. |
|
| 64 | - * |
|
| 65 | - * @var string |
|
| 66 | - */ |
|
| 67 | - protected $cache_group = 'getpaid_items'; |
|
| 61 | + * Stores meta in cache for future reads. |
|
| 62 | + * |
|
| 63 | + * A group must be set to to enable caching. |
|
| 64 | + * |
|
| 65 | + * @var string |
|
| 66 | + */ |
|
| 67 | + protected $cache_group = 'getpaid_items'; |
|
| 68 | 68 | |
| 69 | 69 | /** |
| 70 | 70 | * Stores a reference to the original WP_Post object |
@@ -74,37 +74,37 @@ discard block |
||
| 74 | 74 | protected $post = null; |
| 75 | 75 | |
| 76 | 76 | /** |
| 77 | - * Get the item if ID is passed, otherwise the item is new and empty. |
|
| 78 | - * |
|
| 79 | - * @param int|object|WPInv_Item|WP_Post $item Item to read. |
|
| 80 | - */ |
|
| 81 | - public function __construct( $item = 0 ) { |
|
| 82 | - parent::__construct( $item ); |
|
| 83 | - |
|
| 84 | - if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) { |
|
| 85 | - $this->set_id( $item ); |
|
| 86 | - } elseif ( $item instanceof self ) { |
|
| 87 | - $this->set_id( $item->get_id() ); |
|
| 88 | - } elseif ( ! empty( $item->ID ) ) { |
|
| 89 | - $this->set_id( $item->ID ); |
|
| 90 | - } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) { |
|
| 91 | - $this->set_id( $item_id ); |
|
| 92 | - } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) { |
|
| 93 | - $this->set_id( $item_id ); |
|
| 94 | - } else { |
|
| 95 | - $this->set_object_read( true ); |
|
| 96 | - } |
|
| 77 | + * Get the item if ID is passed, otherwise the item is new and empty. |
|
| 78 | + * |
|
| 79 | + * @param int|object|WPInv_Item|WP_Post $item Item to read. |
|
| 80 | + */ |
|
| 81 | + public function __construct( $item = 0 ) { |
|
| 82 | + parent::__construct( $item ); |
|
| 83 | + |
|
| 84 | + if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) { |
|
| 85 | + $this->set_id( $item ); |
|
| 86 | + } elseif ( $item instanceof self ) { |
|
| 87 | + $this->set_id( $item->get_id() ); |
|
| 88 | + } elseif ( ! empty( $item->ID ) ) { |
|
| 89 | + $this->set_id( $item->ID ); |
|
| 90 | + } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) { |
|
| 91 | + $this->set_id( $item_id ); |
|
| 92 | + } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) { |
|
| 93 | + $this->set_id( $item_id ); |
|
| 94 | + } else { |
|
| 95 | + $this->set_object_read( true ); |
|
| 96 | + } |
|
| 97 | 97 | |
| 98 | 98 | // Load the datastore. |
| 99 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 99 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 100 | 100 | |
| 101 | - if ( $this->get_id() > 0 ) { |
|
| 101 | + if ( $this->get_id() > 0 ) { |
|
| 102 | 102 | $this->post = get_post( $this->get_id() ); |
| 103 | 103 | $this->ID = $this->get_id(); |
| 104 | - $this->data_store->read( $this ); |
|
| 104 | + $this->data_store->read( $this ); |
|
| 105 | 105 | } |
| 106 | 106 | |
| 107 | - } |
|
| 107 | + } |
|
| 108 | 108 | |
| 109 | 109 | /* |
| 110 | 110 | |-------------------------------------------------------------------------- |
@@ -122,401 +122,401 @@ discard block |
||
| 122 | 122 | */ |
| 123 | 123 | |
| 124 | 124 | /** |
| 125 | - * Get parent item ID. |
|
| 126 | - * |
|
| 127 | - * @since 1.0.19 |
|
| 128 | - * @param string $context View or edit context. |
|
| 129 | - * @return int |
|
| 130 | - */ |
|
| 131 | - public function get_parent_id( $context = 'view' ) { |
|
| 132 | - return (int) $this->get_prop( 'parent_id', $context ); |
|
| 125 | + * Get parent item ID. |
|
| 126 | + * |
|
| 127 | + * @since 1.0.19 |
|
| 128 | + * @param string $context View or edit context. |
|
| 129 | + * @return int |
|
| 130 | + */ |
|
| 131 | + public function get_parent_id( $context = 'view' ) { |
|
| 132 | + return (int) $this->get_prop( 'parent_id', $context ); |
|
| 133 | 133 | } |
| 134 | 134 | |
| 135 | 135 | /** |
| 136 | - * Get item status. |
|
| 137 | - * |
|
| 138 | - * @since 1.0.19 |
|
| 139 | - * @param string $context View or edit context. |
|
| 140 | - * @return string |
|
| 141 | - */ |
|
| 142 | - public function get_status( $context = 'view' ) { |
|
| 143 | - return $this->get_prop( 'status', $context ); |
|
| 136 | + * Get item status. |
|
| 137 | + * |
|
| 138 | + * @since 1.0.19 |
|
| 139 | + * @param string $context View or edit context. |
|
| 140 | + * @return string |
|
| 141 | + */ |
|
| 142 | + public function get_status( $context = 'view' ) { |
|
| 143 | + return $this->get_prop( 'status', $context ); |
|
| 144 | 144 | } |
| 145 | 145 | |
| 146 | 146 | /** |
| 147 | - * Get plugin version when the item was created. |
|
| 148 | - * |
|
| 149 | - * @since 1.0.19 |
|
| 150 | - * @param string $context View or edit context. |
|
| 151 | - * @return string |
|
| 152 | - */ |
|
| 153 | - public function get_version( $context = 'view' ) { |
|
| 154 | - return $this->get_prop( 'version', $context ); |
|
| 147 | + * Get plugin version when the item was created. |
|
| 148 | + * |
|
| 149 | + * @since 1.0.19 |
|
| 150 | + * @param string $context View or edit context. |
|
| 151 | + * @return string |
|
| 152 | + */ |
|
| 153 | + public function get_version( $context = 'view' ) { |
|
| 154 | + return $this->get_prop( 'version', $context ); |
|
| 155 | 155 | } |
| 156 | 156 | |
| 157 | 157 | /** |
| 158 | - * Get date when the item was created. |
|
| 159 | - * |
|
| 160 | - * @since 1.0.19 |
|
| 161 | - * @param string $context View or edit context. |
|
| 162 | - * @return string |
|
| 163 | - */ |
|
| 164 | - public function get_date_created( $context = 'view' ) { |
|
| 165 | - return $this->get_prop( 'date_created', $context ); |
|
| 158 | + * Get date when the item was created. |
|
| 159 | + * |
|
| 160 | + * @since 1.0.19 |
|
| 161 | + * @param string $context View or edit context. |
|
| 162 | + * @return string |
|
| 163 | + */ |
|
| 164 | + public function get_date_created( $context = 'view' ) { |
|
| 165 | + return $this->get_prop( 'date_created', $context ); |
|
| 166 | 166 | } |
| 167 | 167 | |
| 168 | 168 | /** |
| 169 | - * Get GMT date when the item was created. |
|
| 170 | - * |
|
| 171 | - * @since 1.0.19 |
|
| 172 | - * @param string $context View or edit context. |
|
| 173 | - * @return string |
|
| 174 | - */ |
|
| 175 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 169 | + * Get GMT date when the item was created. |
|
| 170 | + * |
|
| 171 | + * @since 1.0.19 |
|
| 172 | + * @param string $context View or edit context. |
|
| 173 | + * @return string |
|
| 174 | + */ |
|
| 175 | + public function get_date_created_gmt( $context = 'view' ) { |
|
| 176 | 176 | $date = $this->get_date_created( $context ); |
| 177 | 177 | |
| 178 | 178 | if ( $date ) { |
| 179 | 179 | $date = get_gmt_from_date( $date ); |
| 180 | 180 | } |
| 181 | - return $date; |
|
| 181 | + return $date; |
|
| 182 | 182 | } |
| 183 | 183 | |
| 184 | 184 | /** |
| 185 | - * Get date when the item was last modified. |
|
| 186 | - * |
|
| 187 | - * @since 1.0.19 |
|
| 188 | - * @param string $context View or edit context. |
|
| 189 | - * @return string |
|
| 190 | - */ |
|
| 191 | - public function get_date_modified( $context = 'view' ) { |
|
| 192 | - return $this->get_prop( 'date_modified', $context ); |
|
| 185 | + * Get date when the item was last modified. |
|
| 186 | + * |
|
| 187 | + * @since 1.0.19 |
|
| 188 | + * @param string $context View or edit context. |
|
| 189 | + * @return string |
|
| 190 | + */ |
|
| 191 | + public function get_date_modified( $context = 'view' ) { |
|
| 192 | + return $this->get_prop( 'date_modified', $context ); |
|
| 193 | 193 | } |
| 194 | 194 | |
| 195 | 195 | /** |
| 196 | - * Get GMT date when the item was last modified. |
|
| 197 | - * |
|
| 198 | - * @since 1.0.19 |
|
| 199 | - * @param string $context View or edit context. |
|
| 200 | - * @return string |
|
| 201 | - */ |
|
| 202 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
| 196 | + * Get GMT date when the item was last modified. |
|
| 197 | + * |
|
| 198 | + * @since 1.0.19 |
|
| 199 | + * @param string $context View or edit context. |
|
| 200 | + * @return string |
|
| 201 | + */ |
|
| 202 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
| 203 | 203 | $date = $this->get_date_modified( $context ); |
| 204 | 204 | |
| 205 | 205 | if ( $date ) { |
| 206 | 206 | $date = get_gmt_from_date( $date ); |
| 207 | 207 | } |
| 208 | - return $date; |
|
| 208 | + return $date; |
|
| 209 | 209 | } |
| 210 | 210 | |
| 211 | 211 | /** |
| 212 | - * Get the item name. |
|
| 213 | - * |
|
| 214 | - * @since 1.0.19 |
|
| 215 | - * @param string $context View or edit context. |
|
| 216 | - * @return string |
|
| 217 | - */ |
|
| 218 | - public function get_name( $context = 'view' ) { |
|
| 219 | - return $this->get_prop( 'name', $context ); |
|
| 212 | + * Get the item name. |
|
| 213 | + * |
|
| 214 | + * @since 1.0.19 |
|
| 215 | + * @param string $context View or edit context. |
|
| 216 | + * @return string |
|
| 217 | + */ |
|
| 218 | + public function get_name( $context = 'view' ) { |
|
| 219 | + return $this->get_prop( 'name', $context ); |
|
| 220 | 220 | } |
| 221 | 221 | |
| 222 | 222 | /** |
| 223 | - * Alias of self::get_name(). |
|
| 224 | - * |
|
| 225 | - * @since 1.0.19 |
|
| 226 | - * @param string $context View or edit context. |
|
| 227 | - * @return string |
|
| 228 | - */ |
|
| 229 | - public function get_title( $context = 'view' ) { |
|
| 230 | - return $this->get_name( $context ); |
|
| 223 | + * Alias of self::get_name(). |
|
| 224 | + * |
|
| 225 | + * @since 1.0.19 |
|
| 226 | + * @param string $context View or edit context. |
|
| 227 | + * @return string |
|
| 228 | + */ |
|
| 229 | + public function get_title( $context = 'view' ) { |
|
| 230 | + return $this->get_name( $context ); |
|
| 231 | 231 | } |
| 232 | 232 | |
| 233 | 233 | /** |
| 234 | - * Get the item description. |
|
| 235 | - * |
|
| 236 | - * @since 1.0.19 |
|
| 237 | - * @param string $context View or edit context. |
|
| 238 | - * @return string |
|
| 239 | - */ |
|
| 240 | - public function get_description( $context = 'view' ) { |
|
| 241 | - return $this->get_prop( 'description', $context ); |
|
| 234 | + * Get the item description. |
|
| 235 | + * |
|
| 236 | + * @since 1.0.19 |
|
| 237 | + * @param string $context View or edit context. |
|
| 238 | + * @return string |
|
| 239 | + */ |
|
| 240 | + public function get_description( $context = 'view' ) { |
|
| 241 | + return $this->get_prop( 'description', $context ); |
|
| 242 | 242 | } |
| 243 | 243 | |
| 244 | 244 | /** |
| 245 | - * Alias of self::get_description(). |
|
| 246 | - * |
|
| 247 | - * @since 1.0.19 |
|
| 248 | - * @param string $context View or edit context. |
|
| 249 | - * @return string |
|
| 250 | - */ |
|
| 251 | - public function get_excerpt( $context = 'view' ) { |
|
| 252 | - return $this->get_description( $context ); |
|
| 245 | + * Alias of self::get_description(). |
|
| 246 | + * |
|
| 247 | + * @since 1.0.19 |
|
| 248 | + * @param string $context View or edit context. |
|
| 249 | + * @return string |
|
| 250 | + */ |
|
| 251 | + public function get_excerpt( $context = 'view' ) { |
|
| 252 | + return $this->get_description( $context ); |
|
| 253 | 253 | } |
| 254 | 254 | |
| 255 | 255 | /** |
| 256 | - * Alias of self::get_description(). |
|
| 257 | - * |
|
| 258 | - * @since 1.0.19 |
|
| 259 | - * @param string $context View or edit context. |
|
| 260 | - * @return string |
|
| 261 | - */ |
|
| 262 | - public function get_summary( $context = 'view' ) { |
|
| 263 | - return $this->get_description( $context ); |
|
| 256 | + * Alias of self::get_description(). |
|
| 257 | + * |
|
| 258 | + * @since 1.0.19 |
|
| 259 | + * @param string $context View or edit context. |
|
| 260 | + * @return string |
|
| 261 | + */ |
|
| 262 | + public function get_summary( $context = 'view' ) { |
|
| 263 | + return $this->get_description( $context ); |
|
| 264 | 264 | } |
| 265 | 265 | |
| 266 | 266 | /** |
| 267 | - * Get the owner of the item. |
|
| 268 | - * |
|
| 269 | - * @since 1.0.19 |
|
| 270 | - * @param string $context View or edit context. |
|
| 271 | - * @return int |
|
| 272 | - */ |
|
| 273 | - public function get_author( $context = 'view' ) { |
|
| 274 | - return (int) $this->get_prop( 'author', $context ); |
|
| 275 | - } |
|
| 267 | + * Get the owner of the item. |
|
| 268 | + * |
|
| 269 | + * @since 1.0.19 |
|
| 270 | + * @param string $context View or edit context. |
|
| 271 | + * @return int |
|
| 272 | + */ |
|
| 273 | + public function get_author( $context = 'view' ) { |
|
| 274 | + return (int) $this->get_prop( 'author', $context ); |
|
| 275 | + } |
|
| 276 | 276 | |
| 277 | - /** |
|
| 278 | - * Alias of self::get_author(). |
|
| 279 | - * |
|
| 280 | - * @since 1.0.19 |
|
| 281 | - * @param string $context View or edit context. |
|
| 282 | - * @return int |
|
| 283 | - */ |
|
| 284 | - public function get_owner( $context = 'view' ) { |
|
| 285 | - return $this->get_author( $context ); |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * Get the price of the item. |
|
| 290 | - * |
|
| 291 | - * @since 1.0.19 |
|
| 292 | - * @param string $context View or edit context. |
|
| 293 | - * @return float |
|
| 294 | - */ |
|
| 295 | - public function get_price( $context = 'view' ) { |
|
| 277 | + /** |
|
| 278 | + * Alias of self::get_author(). |
|
| 279 | + * |
|
| 280 | + * @since 1.0.19 |
|
| 281 | + * @param string $context View or edit context. |
|
| 282 | + * @return int |
|
| 283 | + */ |
|
| 284 | + public function get_owner( $context = 'view' ) { |
|
| 285 | + return $this->get_author( $context ); |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * Get the price of the item. |
|
| 290 | + * |
|
| 291 | + * @since 1.0.19 |
|
| 292 | + * @param string $context View or edit context. |
|
| 293 | + * @return float |
|
| 294 | + */ |
|
| 295 | + public function get_price( $context = 'view' ) { |
|
| 296 | 296 | return wpinv_sanitize_amount( $this->get_prop( 'price', $context ) ); |
| 297 | - } |
|
| 297 | + } |
|
| 298 | 298 | |
| 299 | - /** |
|
| 300 | - * Get the inital price of the item. |
|
| 301 | - * |
|
| 302 | - * @since 1.0.19 |
|
| 303 | - * @param string $context View or edit context. |
|
| 304 | - * @return float |
|
| 305 | - */ |
|
| 306 | - public function get_initial_price( $context = 'view' ) { |
|
| 299 | + /** |
|
| 300 | + * Get the inital price of the item. |
|
| 301 | + * |
|
| 302 | + * @since 1.0.19 |
|
| 303 | + * @param string $context View or edit context. |
|
| 304 | + * @return float |
|
| 305 | + */ |
|
| 306 | + public function get_initial_price( $context = 'view' ) { |
|
| 307 | 307 | |
| 308 | - $price = (float) $this->get_price( $context ); |
|
| 308 | + $price = (float) $this->get_price( $context ); |
|
| 309 | 309 | |
| 310 | - if ( $this->has_free_trial() ) { |
|
| 311 | - $price = 0; |
|
| 312 | - } |
|
| 310 | + if ( $this->has_free_trial() ) { |
|
| 311 | + $price = 0; |
|
| 312 | + } |
|
| 313 | 313 | |
| 314 | 314 | return wpinv_sanitize_amount( apply_filters( 'wpinv_get_initial_item_price', $price, $this ) ); |
| 315 | 315 | } |
| 316 | 316 | |
| 317 | 317 | /** |
| 318 | - * Returns a formated price. |
|
| 319 | - * |
|
| 320 | - * @since 1.0.19 |
|
| 321 | - * @param string $context View or edit context. |
|
| 322 | - * @return string |
|
| 323 | - */ |
|
| 318 | + * Returns a formated price. |
|
| 319 | + * |
|
| 320 | + * @since 1.0.19 |
|
| 321 | + * @param string $context View or edit context. |
|
| 322 | + * @return string |
|
| 323 | + */ |
|
| 324 | 324 | public function get_the_price() { |
| 325 | 325 | return wpinv_price( $this->get_price() ); |
| 326 | - } |
|
| 327 | - |
|
| 328 | - /** |
|
| 329 | - * Returns the formated initial price. |
|
| 330 | - * |
|
| 331 | - * @since 1.0.19 |
|
| 332 | - * @param string $context View or edit context. |
|
| 333 | - * @return string |
|
| 334 | - */ |
|
| 326 | + } |
|
| 327 | + |
|
| 328 | + /** |
|
| 329 | + * Returns the formated initial price. |
|
| 330 | + * |
|
| 331 | + * @since 1.0.19 |
|
| 332 | + * @param string $context View or edit context. |
|
| 333 | + * @return string |
|
| 334 | + */ |
|
| 335 | 335 | public function get_the_initial_price() { |
| 336 | 336 | return wpinv_price( $this->get_initial_price() ); |
| 337 | 337 | } |
| 338 | 338 | |
| 339 | 339 | /** |
| 340 | - * Get the VAT rule of the item. |
|
| 341 | - * |
|
| 342 | - * @since 1.0.19 |
|
| 343 | - * @param string $context View or edit context. |
|
| 344 | - * @return string |
|
| 345 | - */ |
|
| 346 | - public function get_vat_rule( $context = 'view' ) { |
|
| 340 | + * Get the VAT rule of the item. |
|
| 341 | + * |
|
| 342 | + * @since 1.0.19 |
|
| 343 | + * @param string $context View or edit context. |
|
| 344 | + * @return string |
|
| 345 | + */ |
|
| 346 | + public function get_vat_rule( $context = 'view' ) { |
|
| 347 | 347 | return $this->get_prop( 'vat_rule', $context ); |
| 348 | 348 | } |
| 349 | 349 | |
| 350 | 350 | /** |
| 351 | - * Get the VAT class of the item. |
|
| 352 | - * |
|
| 353 | - * @since 1.0.19 |
|
| 354 | - * @param string $context View or edit context. |
|
| 355 | - * @return string |
|
| 356 | - */ |
|
| 357 | - public function get_vat_class( $context = 'view' ) { |
|
| 351 | + * Get the VAT class of the item. |
|
| 352 | + * |
|
| 353 | + * @since 1.0.19 |
|
| 354 | + * @param string $context View or edit context. |
|
| 355 | + * @return string |
|
| 356 | + */ |
|
| 357 | + public function get_vat_class( $context = 'view' ) { |
|
| 358 | 358 | return $this->get_prop( 'vat_class', $context ); |
| 359 | 359 | } |
| 360 | 360 | |
| 361 | 361 | /** |
| 362 | - * Get the type of the item. |
|
| 363 | - * |
|
| 364 | - * @since 1.0.19 |
|
| 365 | - * @param string $context View or edit context. |
|
| 366 | - * @return string |
|
| 367 | - */ |
|
| 368 | - public function get_type( $context = 'view' ) { |
|
| 362 | + * Get the type of the item. |
|
| 363 | + * |
|
| 364 | + * @since 1.0.19 |
|
| 365 | + * @param string $context View or edit context. |
|
| 366 | + * @return string |
|
| 367 | + */ |
|
| 368 | + public function get_type( $context = 'view' ) { |
|
| 369 | 369 | return $this->get_prop( 'type', $context ); |
| 370 | 370 | } |
| 371 | 371 | |
| 372 | 372 | /** |
| 373 | - * Get the custom id of the item. |
|
| 374 | - * |
|
| 375 | - * @since 1.0.19 |
|
| 376 | - * @param string $context View or edit context. |
|
| 377 | - * @return string |
|
| 378 | - */ |
|
| 379 | - public function get_custom_id( $context = 'view' ) { |
|
| 373 | + * Get the custom id of the item. |
|
| 374 | + * |
|
| 375 | + * @since 1.0.19 |
|
| 376 | + * @param string $context View or edit context. |
|
| 377 | + * @return string |
|
| 378 | + */ |
|
| 379 | + public function get_custom_id( $context = 'view' ) { |
|
| 380 | 380 | return $this->get_prop( 'custom_id', $context ); |
| 381 | 381 | } |
| 382 | 382 | |
| 383 | 383 | /** |
| 384 | - * Get the custom name of the item. |
|
| 385 | - * |
|
| 386 | - * @since 1.0.19 |
|
| 387 | - * @param string $context View or edit context. |
|
| 388 | - * @return string |
|
| 389 | - */ |
|
| 390 | - public function get_custom_name( $context = 'view' ) { |
|
| 384 | + * Get the custom name of the item. |
|
| 385 | + * |
|
| 386 | + * @since 1.0.19 |
|
| 387 | + * @param string $context View or edit context. |
|
| 388 | + * @return string |
|
| 389 | + */ |
|
| 390 | + public function get_custom_name( $context = 'view' ) { |
|
| 391 | 391 | return $this->get_prop( 'custom_name', $context ); |
| 392 | 392 | } |
| 393 | 393 | |
| 394 | 394 | /** |
| 395 | - * Get the custom singular name of the item. |
|
| 396 | - * |
|
| 397 | - * @since 1.0.19 |
|
| 398 | - * @param string $context View or edit context. |
|
| 399 | - * @return string |
|
| 400 | - */ |
|
| 401 | - public function get_custom_singular_name( $context = 'view' ) { |
|
| 395 | + * Get the custom singular name of the item. |
|
| 396 | + * |
|
| 397 | + * @since 1.0.19 |
|
| 398 | + * @param string $context View or edit context. |
|
| 399 | + * @return string |
|
| 400 | + */ |
|
| 401 | + public function get_custom_singular_name( $context = 'view' ) { |
|
| 402 | 402 | return $this->get_prop( 'custom_singular_name', $context ); |
| 403 | 403 | } |
| 404 | 404 | |
| 405 | 405 | /** |
| 406 | - * Checks if an item is editable.. |
|
| 407 | - * |
|
| 408 | - * @since 1.0.19 |
|
| 409 | - * @param string $context View or edit context. |
|
| 410 | - * @return int |
|
| 411 | - */ |
|
| 412 | - public function get_is_editable( $context = 'view' ) { |
|
| 406 | + * Checks if an item is editable.. |
|
| 407 | + * |
|
| 408 | + * @since 1.0.19 |
|
| 409 | + * @param string $context View or edit context. |
|
| 410 | + * @return int |
|
| 411 | + */ |
|
| 412 | + public function get_is_editable( $context = 'view' ) { |
|
| 413 | 413 | return (int) $this->get_prop( 'is_editable', $context ); |
| 414 | 414 | } |
| 415 | 415 | |
| 416 | 416 | /** |
| 417 | - * Alias of self::get_is_editable(). |
|
| 418 | - * |
|
| 419 | - * @since 1.0.19 |
|
| 420 | - * @param string $context View or edit context. |
|
| 421 | - * @return int |
|
| 422 | - */ |
|
| 423 | - public function get_editable( $context = 'view' ) { |
|
| 424 | - return $this->get_is_editable( $context ); |
|
| 417 | + * Alias of self::get_is_editable(). |
|
| 418 | + * |
|
| 419 | + * @since 1.0.19 |
|
| 420 | + * @param string $context View or edit context. |
|
| 421 | + * @return int |
|
| 422 | + */ |
|
| 423 | + public function get_editable( $context = 'view' ) { |
|
| 424 | + return $this->get_is_editable( $context ); |
|
| 425 | 425 | } |
| 426 | 426 | |
| 427 | 427 | /** |
| 428 | - * Checks if dynamic pricing is enabled. |
|
| 429 | - * |
|
| 430 | - * @since 1.0.19 |
|
| 431 | - * @param string $context View or edit context. |
|
| 432 | - * @return int |
|
| 433 | - */ |
|
| 434 | - public function get_is_dynamic_pricing( $context = 'view' ) { |
|
| 428 | + * Checks if dynamic pricing is enabled. |
|
| 429 | + * |
|
| 430 | + * @since 1.0.19 |
|
| 431 | + * @param string $context View or edit context. |
|
| 432 | + * @return int |
|
| 433 | + */ |
|
| 434 | + public function get_is_dynamic_pricing( $context = 'view' ) { |
|
| 435 | 435 | return (int) $this->get_prop( 'is_dynamic_pricing', $context ); |
| 436 | 436 | } |
| 437 | 437 | |
| 438 | 438 | /** |
| 439 | - * Returns the minimum price if dynamic pricing is enabled. |
|
| 440 | - * |
|
| 441 | - * @since 1.0.19 |
|
| 442 | - * @param string $context View or edit context. |
|
| 443 | - * @return float |
|
| 444 | - */ |
|
| 445 | - public function get_minimum_price( $context = 'view' ) { |
|
| 439 | + * Returns the minimum price if dynamic pricing is enabled. |
|
| 440 | + * |
|
| 441 | + * @since 1.0.19 |
|
| 442 | + * @param string $context View or edit context. |
|
| 443 | + * @return float |
|
| 444 | + */ |
|
| 445 | + public function get_minimum_price( $context = 'view' ) { |
|
| 446 | 446 | return wpinv_sanitize_amount( $this->get_prop( 'minimum_price', $context ) ); |
| 447 | 447 | } |
| 448 | 448 | |
| 449 | 449 | /** |
| 450 | - * Checks if this is a recurring item. |
|
| 451 | - * |
|
| 452 | - * @since 1.0.19 |
|
| 453 | - * @param string $context View or edit context. |
|
| 454 | - * @return int |
|
| 455 | - */ |
|
| 456 | - public function get_is_recurring( $context = 'view' ) { |
|
| 450 | + * Checks if this is a recurring item. |
|
| 451 | + * |
|
| 452 | + * @since 1.0.19 |
|
| 453 | + * @param string $context View or edit context. |
|
| 454 | + * @return int |
|
| 455 | + */ |
|
| 456 | + public function get_is_recurring( $context = 'view' ) { |
|
| 457 | 457 | return (int) $this->get_prop( 'is_recurring', $context ); |
| 458 | - } |
|
| 458 | + } |
|
| 459 | 459 | |
| 460 | - /** |
|
| 461 | - * Get the recurring price of the item. |
|
| 462 | - * |
|
| 463 | - * @since 1.0.19 |
|
| 464 | - * @param string $context View or edit context. |
|
| 465 | - * @return float |
|
| 466 | - */ |
|
| 467 | - public function get_recurring_price( $context = 'view' ) { |
|
| 468 | - $price = $this->get_price( $context ); |
|
| 460 | + /** |
|
| 461 | + * Get the recurring price of the item. |
|
| 462 | + * |
|
| 463 | + * @since 1.0.19 |
|
| 464 | + * @param string $context View or edit context. |
|
| 465 | + * @return float |
|
| 466 | + */ |
|
| 467 | + public function get_recurring_price( $context = 'view' ) { |
|
| 468 | + $price = $this->get_price( $context ); |
|
| 469 | 469 | return wpinv_sanitize_amount( apply_filters( 'wpinv_get_recurring_item_price', $price, $this->ID ) ); |
| 470 | - } |
|
| 471 | - |
|
| 472 | - /** |
|
| 473 | - * Get the formatted recurring price of the item. |
|
| 474 | - * |
|
| 475 | - * @since 1.0.19 |
|
| 476 | - * @param string $context View or edit context. |
|
| 477 | - * @return string |
|
| 478 | - */ |
|
| 470 | + } |
|
| 471 | + |
|
| 472 | + /** |
|
| 473 | + * Get the formatted recurring price of the item. |
|
| 474 | + * |
|
| 475 | + * @since 1.0.19 |
|
| 476 | + * @param string $context View or edit context. |
|
| 477 | + * @return string |
|
| 478 | + */ |
|
| 479 | 479 | public function get_the_recurring_price() { |
| 480 | 480 | return wpinv_price( $this->get_recurring_price() ); |
| 481 | - } |
|
| 482 | - |
|
| 483 | - /** |
|
| 484 | - * Get the first renewal date (in timestamps) of the item. |
|
| 485 | - * |
|
| 486 | - * @since 1.0.19 |
|
| 487 | - * @return int |
|
| 488 | - */ |
|
| 489 | - public function get_first_renewal_date() { |
|
| 490 | - |
|
| 491 | - $periods = array( |
|
| 492 | - 'D' => 'days', |
|
| 493 | - 'W' => 'weeks', |
|
| 494 | - 'M' => 'months', |
|
| 495 | - 'Y' => 'years', |
|
| 496 | - ); |
|
| 497 | - |
|
| 498 | - $period = $this->get_recurring_period(); |
|
| 499 | - $interval = $this->get_recurring_interval(); |
|
| 500 | - |
|
| 501 | - if ( $this->has_free_trial() ) { |
|
| 502 | - $period = $this->get_trial_period(); |
|
| 503 | - $interval = $this->get_trial_interval(); |
|
| 504 | - } |
|
| 505 | - |
|
| 506 | - $period = $periods[ $period ]; |
|
| 507 | - $interval = empty( $interval ) ? 1 : $interval; |
|
| 508 | - $next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) ); |
|
| 481 | + } |
|
| 482 | + |
|
| 483 | + /** |
|
| 484 | + * Get the first renewal date (in timestamps) of the item. |
|
| 485 | + * |
|
| 486 | + * @since 1.0.19 |
|
| 487 | + * @return int |
|
| 488 | + */ |
|
| 489 | + public function get_first_renewal_date() { |
|
| 490 | + |
|
| 491 | + $periods = array( |
|
| 492 | + 'D' => 'days', |
|
| 493 | + 'W' => 'weeks', |
|
| 494 | + 'M' => 'months', |
|
| 495 | + 'Y' => 'years', |
|
| 496 | + ); |
|
| 497 | + |
|
| 498 | + $period = $this->get_recurring_period(); |
|
| 499 | + $interval = $this->get_recurring_interval(); |
|
| 500 | + |
|
| 501 | + if ( $this->has_free_trial() ) { |
|
| 502 | + $period = $this->get_trial_period(); |
|
| 503 | + $interval = $this->get_trial_interval(); |
|
| 504 | + } |
|
| 505 | + |
|
| 506 | + $period = $periods[ $period ]; |
|
| 507 | + $interval = empty( $interval ) ? 1 : $interval; |
|
| 508 | + $next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) ); |
|
| 509 | 509 | return apply_filters( 'wpinv_get_first_renewal_date', $next_renewal, $this ); |
| 510 | 510 | } |
| 511 | 511 | |
| 512 | 512 | /** |
| 513 | - * Get the recurring period. |
|
| 514 | - * |
|
| 515 | - * @since 1.0.19 |
|
| 516 | - * @param bool $full Return abbreviation or in full. |
|
| 517 | - * @return string |
|
| 518 | - */ |
|
| 519 | - public function get_recurring_period( $full = false ) { |
|
| 513 | + * Get the recurring period. |
|
| 514 | + * |
|
| 515 | + * @since 1.0.19 |
|
| 516 | + * @param bool $full Return abbreviation or in full. |
|
| 517 | + * @return string |
|
| 518 | + */ |
|
| 519 | + public function get_recurring_period( $full = false ) { |
|
| 520 | 520 | $period = $this->get_prop( 'recurring_period', 'view' ); |
| 521 | 521 | |
| 522 | 522 | if ( $full && ! is_bool( $full ) ) { |
@@ -527,58 +527,58 @@ discard block |
||
| 527 | 527 | } |
| 528 | 528 | |
| 529 | 529 | /** |
| 530 | - * Get the recurring interval. |
|
| 531 | - * |
|
| 532 | - * @since 1.0.19 |
|
| 533 | - * @param string $context View or edit context. |
|
| 534 | - * @return int |
|
| 535 | - */ |
|
| 536 | - public function get_recurring_interval( $context = 'view' ) { |
|
| 537 | - $interval = absint( $this->get_prop( 'recurring_interval', $context ) ); |
|
| 538 | - return max( 1, $interval ); |
|
| 530 | + * Get the recurring interval. |
|
| 531 | + * |
|
| 532 | + * @since 1.0.19 |
|
| 533 | + * @param string $context View or edit context. |
|
| 534 | + * @return int |
|
| 535 | + */ |
|
| 536 | + public function get_recurring_interval( $context = 'view' ) { |
|
| 537 | + $interval = absint( $this->get_prop( 'recurring_interval', $context ) ); |
|
| 538 | + return max( 1, $interval ); |
|
| 539 | 539 | } |
| 540 | 540 | |
| 541 | 541 | /** |
| 542 | - * Get the recurring limit. |
|
| 543 | - * |
|
| 544 | - * @since 1.0.19 |
|
| 545 | - * @param string $context View or edit context. |
|
| 546 | - * @return int |
|
| 547 | - */ |
|
| 548 | - public function get_recurring_limit( $context = 'view' ) { |
|
| 542 | + * Get the recurring limit. |
|
| 543 | + * |
|
| 544 | + * @since 1.0.19 |
|
| 545 | + * @param string $context View or edit context. |
|
| 546 | + * @return int |
|
| 547 | + */ |
|
| 548 | + public function get_recurring_limit( $context = 'view' ) { |
|
| 549 | 549 | return (int) $this->get_prop( 'recurring_limit', $context ); |
| 550 | 550 | } |
| 551 | 551 | |
| 552 | 552 | /** |
| 553 | - * Checks if we have a free trial. |
|
| 554 | - * |
|
| 555 | - * @since 1.0.19 |
|
| 556 | - * @param string $context View or edit context. |
|
| 557 | - * @return int |
|
| 558 | - */ |
|
| 559 | - public function get_is_free_trial( $context = 'view' ) { |
|
| 553 | + * Checks if we have a free trial. |
|
| 554 | + * |
|
| 555 | + * @since 1.0.19 |
|
| 556 | + * @param string $context View or edit context. |
|
| 557 | + * @return int |
|
| 558 | + */ |
|
| 559 | + public function get_is_free_trial( $context = 'view' ) { |
|
| 560 | 560 | return (int) $this->get_prop( 'is_free_trial', $context ); |
| 561 | 561 | } |
| 562 | 562 | |
| 563 | 563 | /** |
| 564 | - * Alias for self::get_is_free_trial(). |
|
| 565 | - * |
|
| 566 | - * @since 1.0.19 |
|
| 567 | - * @param string $context View or edit context. |
|
| 568 | - * @return int |
|
| 569 | - */ |
|
| 570 | - public function get_free_trial( $context = 'view' ) { |
|
| 564 | + * Alias for self::get_is_free_trial(). |
|
| 565 | + * |
|
| 566 | + * @since 1.0.19 |
|
| 567 | + * @param string $context View or edit context. |
|
| 568 | + * @return int |
|
| 569 | + */ |
|
| 570 | + public function get_free_trial( $context = 'view' ) { |
|
| 571 | 571 | return $this->get_is_free_trial( $context ); |
| 572 | 572 | } |
| 573 | 573 | |
| 574 | 574 | /** |
| 575 | - * Get the trial period. |
|
| 576 | - * |
|
| 577 | - * @since 1.0.19 |
|
| 578 | - * @param bool $full Return abbreviation or in full. |
|
| 579 | - * @return string |
|
| 580 | - */ |
|
| 581 | - public function get_trial_period( $full = false ) { |
|
| 575 | + * Get the trial period. |
|
| 576 | + * |
|
| 577 | + * @since 1.0.19 |
|
| 578 | + * @param bool $full Return abbreviation or in full. |
|
| 579 | + * @return string |
|
| 580 | + */ |
|
| 581 | + public function get_trial_period( $full = false ) { |
|
| 582 | 582 | $period = $this->get_prop( 'trial_period', 'view' ); |
| 583 | 583 | |
| 584 | 584 | if ( $full && ! is_bool( $full ) ) { |
@@ -589,104 +589,104 @@ discard block |
||
| 589 | 589 | } |
| 590 | 590 | |
| 591 | 591 | /** |
| 592 | - * Get the trial interval. |
|
| 593 | - * |
|
| 594 | - * @since 1.0.19 |
|
| 595 | - * @param string $context View or edit context. |
|
| 596 | - * @return int |
|
| 597 | - */ |
|
| 598 | - public function get_trial_interval( $context = 'view' ) { |
|
| 592 | + * Get the trial interval. |
|
| 593 | + * |
|
| 594 | + * @since 1.0.19 |
|
| 595 | + * @param string $context View or edit context. |
|
| 596 | + * @return int |
|
| 597 | + */ |
|
| 598 | + public function get_trial_interval( $context = 'view' ) { |
|
| 599 | 599 | return (int) $this->get_prop( 'trial_interval', $context ); |
| 600 | - } |
|
| 600 | + } |
|
| 601 | 601 | |
| 602 | - /** |
|
| 603 | - * Get the item's edit url. |
|
| 604 | - * |
|
| 605 | - * @since 1.0.19 |
|
| 606 | - * @return string |
|
| 607 | - */ |
|
| 608 | - public function get_edit_url() { |
|
| 602 | + /** |
|
| 603 | + * Get the item's edit url. |
|
| 604 | + * |
|
| 605 | + * @since 1.0.19 |
|
| 606 | + * @return string |
|
| 607 | + */ |
|
| 608 | + public function get_edit_url() { |
|
| 609 | 609 | return get_edit_post_link( $this->get_id() ); |
| 610 | - } |
|
| 611 | - |
|
| 612 | - /** |
|
| 613 | - * Given an item's name/custom id, it returns its id. |
|
| 614 | - * |
|
| 615 | - * |
|
| 616 | - * @static |
|
| 617 | - * @param string $value The item name or custom id. |
|
| 618 | - * @param string $field Either name or custom_id. |
|
| 619 | - * @param string $type in case you need to search for a given type. |
|
| 620 | - * @since 1.0.15 |
|
| 621 | - * @return int |
|
| 622 | - */ |
|
| 623 | - public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) { |
|
| 624 | - |
|
| 625 | - // Trim the value. |
|
| 626 | - $value = sanitize_text_field( $value ); |
|
| 627 | - if ( empty( $value ) ) { |
|
| 628 | - return 0; |
|
| 629 | - } |
|
| 610 | + } |
|
| 611 | + |
|
| 612 | + /** |
|
| 613 | + * Given an item's name/custom id, it returns its id. |
|
| 614 | + * |
|
| 615 | + * |
|
| 616 | + * @static |
|
| 617 | + * @param string $value The item name or custom id. |
|
| 618 | + * @param string $field Either name or custom_id. |
|
| 619 | + * @param string $type in case you need to search for a given type. |
|
| 620 | + * @since 1.0.15 |
|
| 621 | + * @return int |
|
| 622 | + */ |
|
| 623 | + public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) { |
|
| 624 | + |
|
| 625 | + // Trim the value. |
|
| 626 | + $value = sanitize_text_field( $value ); |
|
| 627 | + if ( empty( $value ) ) { |
|
| 628 | + return 0; |
|
| 629 | + } |
|
| 630 | 630 | |
| 631 | 631 | // Valid fields. |
| 632 | 632 | $fields = array( 'custom_id', 'name', 'slug' ); |
| 633 | 633 | |
| 634 | - // Ensure a field has been passed. |
|
| 635 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 636 | - return 0; |
|
| 637 | - } |
|
| 638 | - |
|
| 639 | - if ( $field == 'name' ) { |
|
| 640 | - $field = 'slug'; |
|
| 641 | - } |
|
| 642 | - |
|
| 643 | - // Maybe retrieve from the cache. |
|
| 644 | - $item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 645 | - if ( ! empty( $item_id ) ) { |
|
| 646 | - return $item_id; |
|
| 647 | - } |
|
| 648 | - |
|
| 649 | - // Fetch from the db. |
|
| 650 | - $items = array(); |
|
| 651 | - if ( $field == 'slug' ) { |
|
| 652 | - $items = get_posts( |
|
| 653 | - array( |
|
| 654 | - 'post_type' => 'wpi_item', |
|
| 655 | - 'name' => $value, |
|
| 656 | - 'posts_per_page' => 1, |
|
| 657 | - 'post_status' => 'any', |
|
| 658 | - ) |
|
| 659 | - ); |
|
| 660 | - } |
|
| 661 | - |
|
| 662 | - if ( $field =='custom_id' ) { |
|
| 663 | - $items = get_posts( |
|
| 664 | - array( |
|
| 665 | - 'post_type' => 'wpi_item', |
|
| 666 | - 'posts_per_page' => 1, |
|
| 667 | - 'post_status' => 'any', |
|
| 668 | - 'meta_query' => array( |
|
| 669 | - array( |
|
| 670 | - 'key' => '_wpinv_type', |
|
| 671 | - 'value' => $type, |
|
| 672 | - ), |
|
| 673 | - array( |
|
| 674 | - 'key' => '_wpinv_custom_id', |
|
| 675 | - 'value' => $value, |
|
| 676 | - ) |
|
| 677 | - ) |
|
| 678 | - ) |
|
| 679 | - ); |
|
| 680 | - } |
|
| 681 | - |
|
| 682 | - if ( empty( $items ) ) { |
|
| 683 | - return 0; |
|
| 684 | - } |
|
| 685 | - |
|
| 686 | - // Update the cache with our data |
|
| 687 | - wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 688 | - |
|
| 689 | - return $items[0]->ID; |
|
| 634 | + // Ensure a field has been passed. |
|
| 635 | + if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 636 | + return 0; |
|
| 637 | + } |
|
| 638 | + |
|
| 639 | + if ( $field == 'name' ) { |
|
| 640 | + $field = 'slug'; |
|
| 641 | + } |
|
| 642 | + |
|
| 643 | + // Maybe retrieve from the cache. |
|
| 644 | + $item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 645 | + if ( ! empty( $item_id ) ) { |
|
| 646 | + return $item_id; |
|
| 647 | + } |
|
| 648 | + |
|
| 649 | + // Fetch from the db. |
|
| 650 | + $items = array(); |
|
| 651 | + if ( $field == 'slug' ) { |
|
| 652 | + $items = get_posts( |
|
| 653 | + array( |
|
| 654 | + 'post_type' => 'wpi_item', |
|
| 655 | + 'name' => $value, |
|
| 656 | + 'posts_per_page' => 1, |
|
| 657 | + 'post_status' => 'any', |
|
| 658 | + ) |
|
| 659 | + ); |
|
| 660 | + } |
|
| 661 | + |
|
| 662 | + if ( $field =='custom_id' ) { |
|
| 663 | + $items = get_posts( |
|
| 664 | + array( |
|
| 665 | + 'post_type' => 'wpi_item', |
|
| 666 | + 'posts_per_page' => 1, |
|
| 667 | + 'post_status' => 'any', |
|
| 668 | + 'meta_query' => array( |
|
| 669 | + array( |
|
| 670 | + 'key' => '_wpinv_type', |
|
| 671 | + 'value' => $type, |
|
| 672 | + ), |
|
| 673 | + array( |
|
| 674 | + 'key' => '_wpinv_custom_id', |
|
| 675 | + 'value' => $value, |
|
| 676 | + ) |
|
| 677 | + ) |
|
| 678 | + ) |
|
| 679 | + ); |
|
| 680 | + } |
|
| 681 | + |
|
| 682 | + if ( empty( $items ) ) { |
|
| 683 | + return 0; |
|
| 684 | + } |
|
| 685 | + |
|
| 686 | + // Update the cache with our data |
|
| 687 | + wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 688 | + |
|
| 689 | + return $items[0]->ID; |
|
| 690 | 690 | } |
| 691 | 691 | |
| 692 | 692 | /** |
@@ -719,52 +719,52 @@ discard block |
||
| 719 | 719 | */ |
| 720 | 720 | |
| 721 | 721 | /** |
| 722 | - * Set parent order ID. |
|
| 723 | - * |
|
| 724 | - * @since 1.0.19 |
|
| 725 | - */ |
|
| 726 | - public function set_parent_id( $value ) { |
|
| 727 | - if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) { |
|
| 728 | - return; |
|
| 729 | - } |
|
| 730 | - $this->set_prop( 'parent_id', absint( $value ) ); |
|
| 731 | - } |
|
| 732 | - |
|
| 733 | - /** |
|
| 734 | - * Sets item status. |
|
| 735 | - * |
|
| 736 | - * @since 1.0.19 |
|
| 737 | - * @param string $status New status. |
|
| 738 | - * @return array details of change. |
|
| 739 | - */ |
|
| 740 | - public function set_status( $status ) { |
|
| 722 | + * Set parent order ID. |
|
| 723 | + * |
|
| 724 | + * @since 1.0.19 |
|
| 725 | + */ |
|
| 726 | + public function set_parent_id( $value ) { |
|
| 727 | + if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) { |
|
| 728 | + return; |
|
| 729 | + } |
|
| 730 | + $this->set_prop( 'parent_id', absint( $value ) ); |
|
| 731 | + } |
|
| 732 | + |
|
| 733 | + /** |
|
| 734 | + * Sets item status. |
|
| 735 | + * |
|
| 736 | + * @since 1.0.19 |
|
| 737 | + * @param string $status New status. |
|
| 738 | + * @return array details of change. |
|
| 739 | + */ |
|
| 740 | + public function set_status( $status ) { |
|
| 741 | 741 | $old_status = $this->get_status(); |
| 742 | 742 | |
| 743 | 743 | $this->set_prop( 'status', $status ); |
| 744 | 744 | |
| 745 | - return array( |
|
| 746 | - 'from' => $old_status, |
|
| 747 | - 'to' => $status, |
|
| 748 | - ); |
|
| 745 | + return array( |
|
| 746 | + 'from' => $old_status, |
|
| 747 | + 'to' => $status, |
|
| 748 | + ); |
|
| 749 | 749 | } |
| 750 | 750 | |
| 751 | 751 | /** |
| 752 | - * Set plugin version when the item was created. |
|
| 753 | - * |
|
| 754 | - * @since 1.0.19 |
|
| 755 | - */ |
|
| 756 | - public function set_version( $value ) { |
|
| 757 | - $this->set_prop( 'version', $value ); |
|
| 752 | + * Set plugin version when the item was created. |
|
| 753 | + * |
|
| 754 | + * @since 1.0.19 |
|
| 755 | + */ |
|
| 756 | + public function set_version( $value ) { |
|
| 757 | + $this->set_prop( 'version', $value ); |
|
| 758 | 758 | } |
| 759 | 759 | |
| 760 | 760 | /** |
| 761 | - * Set date when the item was created. |
|
| 762 | - * |
|
| 763 | - * @since 1.0.19 |
|
| 764 | - * @param string $value Value to set. |
|
| 761 | + * Set date when the item was created. |
|
| 762 | + * |
|
| 763 | + * @since 1.0.19 |
|
| 764 | + * @param string $value Value to set. |
|
| 765 | 765 | * @return bool Whether or not the date was set. |
| 766 | - */ |
|
| 767 | - public function set_date_created( $value ) { |
|
| 766 | + */ |
|
| 767 | + public function set_date_created( $value ) { |
|
| 768 | 768 | $date = strtotime( $value ); |
| 769 | 769 | |
| 770 | 770 | if ( $date ) { |
@@ -777,13 +777,13 @@ discard block |
||
| 777 | 777 | } |
| 778 | 778 | |
| 779 | 779 | /** |
| 780 | - * Set date when the item was last modified. |
|
| 781 | - * |
|
| 782 | - * @since 1.0.19 |
|
| 783 | - * @param string $value Value to set. |
|
| 780 | + * Set date when the item was last modified. |
|
| 781 | + * |
|
| 782 | + * @since 1.0.19 |
|
| 783 | + * @param string $value Value to set. |
|
| 784 | 784 | * @return bool Whether or not the date was set. |
| 785 | - */ |
|
| 786 | - public function set_date_modified( $value ) { |
|
| 785 | + */ |
|
| 786 | + public function set_date_modified( $value ) { |
|
| 787 | 787 | $date = strtotime( $value ); |
| 788 | 788 | |
| 789 | 789 | if ( $date ) { |
@@ -796,115 +796,115 @@ discard block |
||
| 796 | 796 | } |
| 797 | 797 | |
| 798 | 798 | /** |
| 799 | - * Set the item name. |
|
| 800 | - * |
|
| 801 | - * @since 1.0.19 |
|
| 802 | - * @param string $value New name. |
|
| 803 | - */ |
|
| 804 | - public function set_name( $value ) { |
|
| 799 | + * Set the item name. |
|
| 800 | + * |
|
| 801 | + * @since 1.0.19 |
|
| 802 | + * @param string $value New name. |
|
| 803 | + */ |
|
| 804 | + public function set_name( $value ) { |
|
| 805 | 805 | $name = sanitize_text_field( $value ); |
| 806 | - $this->set_prop( 'name', $name ); |
|
| 806 | + $this->set_prop( 'name', $name ); |
|
| 807 | 807 | } |
| 808 | 808 | |
| 809 | 809 | /** |
| 810 | - * Alias of self::set_name(). |
|
| 811 | - * |
|
| 812 | - * @since 1.0.19 |
|
| 813 | - * @param string $value New name. |
|
| 814 | - */ |
|
| 815 | - public function set_title( $value ) { |
|
| 816 | - $this->set_name( $value ); |
|
| 810 | + * Alias of self::set_name(). |
|
| 811 | + * |
|
| 812 | + * @since 1.0.19 |
|
| 813 | + * @param string $value New name. |
|
| 814 | + */ |
|
| 815 | + public function set_title( $value ) { |
|
| 816 | + $this->set_name( $value ); |
|
| 817 | 817 | } |
| 818 | 818 | |
| 819 | 819 | /** |
| 820 | - * Set the item description. |
|
| 821 | - * |
|
| 822 | - * @since 1.0.19 |
|
| 823 | - * @param string $value New description. |
|
| 824 | - */ |
|
| 825 | - public function set_description( $value ) { |
|
| 826 | - $description = wp_kses_post( $value ); |
|
| 827 | - return $this->set_prop( 'description', $description ); |
|
| 820 | + * Set the item description. |
|
| 821 | + * |
|
| 822 | + * @since 1.0.19 |
|
| 823 | + * @param string $value New description. |
|
| 824 | + */ |
|
| 825 | + public function set_description( $value ) { |
|
| 826 | + $description = wp_kses_post( $value ); |
|
| 827 | + return $this->set_prop( 'description', $description ); |
|
| 828 | 828 | } |
| 829 | 829 | |
| 830 | 830 | /** |
| 831 | - * Alias of self::set_description(). |
|
| 832 | - * |
|
| 833 | - * @since 1.0.19 |
|
| 834 | - * @param string $value New description. |
|
| 835 | - */ |
|
| 836 | - public function set_excerpt( $value ) { |
|
| 837 | - $this->set_description( $value ); |
|
| 831 | + * Alias of self::set_description(). |
|
| 832 | + * |
|
| 833 | + * @since 1.0.19 |
|
| 834 | + * @param string $value New description. |
|
| 835 | + */ |
|
| 836 | + public function set_excerpt( $value ) { |
|
| 837 | + $this->set_description( $value ); |
|
| 838 | 838 | } |
| 839 | 839 | |
| 840 | 840 | /** |
| 841 | - * Alias of self::set_description(). |
|
| 842 | - * |
|
| 843 | - * @since 1.0.19 |
|
| 844 | - * @param string $value New description. |
|
| 845 | - */ |
|
| 846 | - public function set_summary( $value ) { |
|
| 847 | - $this->set_description( $value ); |
|
| 841 | + * Alias of self::set_description(). |
|
| 842 | + * |
|
| 843 | + * @since 1.0.19 |
|
| 844 | + * @param string $value New description. |
|
| 845 | + */ |
|
| 846 | + public function set_summary( $value ) { |
|
| 847 | + $this->set_description( $value ); |
|
| 848 | 848 | } |
| 849 | 849 | |
| 850 | 850 | /** |
| 851 | - * Set the owner of the item. |
|
| 852 | - * |
|
| 853 | - * @since 1.0.19 |
|
| 854 | - * @param int $value New author. |
|
| 855 | - */ |
|
| 856 | - public function set_author( $value ) { |
|
| 857 | - $this->set_prop( 'author', (int) $value ); |
|
| 858 | - } |
|
| 851 | + * Set the owner of the item. |
|
| 852 | + * |
|
| 853 | + * @since 1.0.19 |
|
| 854 | + * @param int $value New author. |
|
| 855 | + */ |
|
| 856 | + public function set_author( $value ) { |
|
| 857 | + $this->set_prop( 'author', (int) $value ); |
|
| 858 | + } |
|
| 859 | 859 | |
| 860 | - /** |
|
| 861 | - * Alias of self::set_author(). |
|
| 862 | - * |
|
| 863 | - * @since 1.0.19 |
|
| 864 | - * @param int $value New author. |
|
| 865 | - */ |
|
| 866 | - public function set_owner( $value ) { |
|
| 867 | - $this->set_author( $value ); |
|
| 868 | - } |
|
| 869 | - |
|
| 870 | - /** |
|
| 871 | - * Set the price of the item. |
|
| 872 | - * |
|
| 873 | - * @since 1.0.19 |
|
| 874 | - * @param float $value New price. |
|
| 875 | - */ |
|
| 876 | - public function set_price( $value ) { |
|
| 860 | + /** |
|
| 861 | + * Alias of self::set_author(). |
|
| 862 | + * |
|
| 863 | + * @since 1.0.19 |
|
| 864 | + * @param int $value New author. |
|
| 865 | + */ |
|
| 866 | + public function set_owner( $value ) { |
|
| 867 | + $this->set_author( $value ); |
|
| 868 | + } |
|
| 869 | + |
|
| 870 | + /** |
|
| 871 | + * Set the price of the item. |
|
| 872 | + * |
|
| 873 | + * @since 1.0.19 |
|
| 874 | + * @param float $value New price. |
|
| 875 | + */ |
|
| 876 | + public function set_price( $value ) { |
|
| 877 | 877 | $this->set_prop( 'price', (float) wpinv_sanitize_amount( $value ) ); |
| 878 | 878 | } |
| 879 | 879 | |
| 880 | 880 | /** |
| 881 | - * Set the VAT rule of the item. |
|
| 882 | - * |
|
| 883 | - * @since 1.0.19 |
|
| 884 | - * @param string $value new rule. |
|
| 885 | - */ |
|
| 886 | - public function set_vat_rule( $value ) { |
|
| 881 | + * Set the VAT rule of the item. |
|
| 882 | + * |
|
| 883 | + * @since 1.0.19 |
|
| 884 | + * @param string $value new rule. |
|
| 885 | + */ |
|
| 886 | + public function set_vat_rule( $value ) { |
|
| 887 | 887 | $this->set_prop( 'vat_rule', $value ); |
| 888 | 888 | } |
| 889 | 889 | |
| 890 | 890 | /** |
| 891 | - * Set the VAT class of the item. |
|
| 892 | - * |
|
| 893 | - * @since 1.0.19 |
|
| 894 | - * @param string $value new class. |
|
| 895 | - */ |
|
| 896 | - public function set_vat_class( $value ) { |
|
| 891 | + * Set the VAT class of the item. |
|
| 892 | + * |
|
| 893 | + * @since 1.0.19 |
|
| 894 | + * @param string $value new class. |
|
| 895 | + */ |
|
| 896 | + public function set_vat_class( $value ) { |
|
| 897 | 897 | $this->set_prop( 'vat_class', $value ); |
| 898 | 898 | } |
| 899 | 899 | |
| 900 | 900 | /** |
| 901 | - * Set the type of the item. |
|
| 902 | - * |
|
| 903 | - * @since 1.0.19 |
|
| 904 | - * @param string $value new item type. |
|
| 905 | - * @return string |
|
| 906 | - */ |
|
| 907 | - public function set_type( $value ) { |
|
| 901 | + * Set the type of the item. |
|
| 902 | + * |
|
| 903 | + * @since 1.0.19 |
|
| 904 | + * @param string $value new item type. |
|
| 905 | + * @return string |
|
| 906 | + */ |
|
| 907 | + public function set_type( $value ) { |
|
| 908 | 908 | |
| 909 | 909 | if ( empty( $value ) ) { |
| 910 | 910 | $value = 'custom'; |
@@ -914,132 +914,132 @@ discard block |
||
| 914 | 914 | } |
| 915 | 915 | |
| 916 | 916 | /** |
| 917 | - * Set the custom id of the item. |
|
| 918 | - * |
|
| 919 | - * @since 1.0.19 |
|
| 920 | - * @param string $value new custom id. |
|
| 921 | - */ |
|
| 922 | - public function set_custom_id( $value ) { |
|
| 917 | + * Set the custom id of the item. |
|
| 918 | + * |
|
| 919 | + * @since 1.0.19 |
|
| 920 | + * @param string $value new custom id. |
|
| 921 | + */ |
|
| 922 | + public function set_custom_id( $value ) { |
|
| 923 | 923 | $this->set_prop( 'custom_id', $value ); |
| 924 | 924 | } |
| 925 | 925 | |
| 926 | 926 | /** |
| 927 | - * Set the custom name of the item. |
|
| 928 | - * |
|
| 929 | - * @since 1.0.19 |
|
| 930 | - * @param string $value new custom name. |
|
| 931 | - */ |
|
| 932 | - public function set_custom_name( $value ) { |
|
| 927 | + * Set the custom name of the item. |
|
| 928 | + * |
|
| 929 | + * @since 1.0.19 |
|
| 930 | + * @param string $value new custom name. |
|
| 931 | + */ |
|
| 932 | + public function set_custom_name( $value ) { |
|
| 933 | 933 | $this->set_prop( 'custom_name', $value ); |
| 934 | 934 | } |
| 935 | 935 | |
| 936 | 936 | /** |
| 937 | - * Set the custom singular name of the item. |
|
| 938 | - * |
|
| 939 | - * @since 1.0.19 |
|
| 940 | - * @param string $value new custom singular name. |
|
| 941 | - */ |
|
| 942 | - public function set_custom_singular_name( $value ) { |
|
| 937 | + * Set the custom singular name of the item. |
|
| 938 | + * |
|
| 939 | + * @since 1.0.19 |
|
| 940 | + * @param string $value new custom singular name. |
|
| 941 | + */ |
|
| 942 | + public function set_custom_singular_name( $value ) { |
|
| 943 | 943 | $this->set_prop( 'custom_singular_name', $value ); |
| 944 | 944 | } |
| 945 | 945 | |
| 946 | 946 | /** |
| 947 | - * Sets if an item is editable.. |
|
| 948 | - * |
|
| 949 | - * @since 1.0.19 |
|
| 950 | - * @param int|bool $value whether or not the item is editable. |
|
| 951 | - */ |
|
| 952 | - public function set_is_editable( $value ) { |
|
| 953 | - $this->set_prop( 'is_editable', (int) $value ); |
|
| 947 | + * Sets if an item is editable.. |
|
| 948 | + * |
|
| 949 | + * @since 1.0.19 |
|
| 950 | + * @param int|bool $value whether or not the item is editable. |
|
| 951 | + */ |
|
| 952 | + public function set_is_editable( $value ) { |
|
| 953 | + $this->set_prop( 'is_editable', (int) $value ); |
|
| 954 | 954 | } |
| 955 | 955 | |
| 956 | 956 | /** |
| 957 | - * Sets if dynamic pricing is enabled. |
|
| 958 | - * |
|
| 959 | - * @since 1.0.19 |
|
| 960 | - * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 961 | - */ |
|
| 962 | - public function set_is_dynamic_pricing( $value ) { |
|
| 957 | + * Sets if dynamic pricing is enabled. |
|
| 958 | + * |
|
| 959 | + * @since 1.0.19 |
|
| 960 | + * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 961 | + */ |
|
| 962 | + public function set_is_dynamic_pricing( $value ) { |
|
| 963 | 963 | $this->set_prop( 'is_dynamic_pricing', (int) $value ); |
| 964 | 964 | } |
| 965 | 965 | |
| 966 | 966 | /** |
| 967 | - * Sets the minimum price if dynamic pricing is enabled. |
|
| 968 | - * |
|
| 969 | - * @since 1.0.19 |
|
| 970 | - * @param float $value minimum price. |
|
| 971 | - */ |
|
| 972 | - public function set_minimum_price( $value ) { |
|
| 967 | + * Sets the minimum price if dynamic pricing is enabled. |
|
| 968 | + * |
|
| 969 | + * @since 1.0.19 |
|
| 970 | + * @param float $value minimum price. |
|
| 971 | + */ |
|
| 972 | + public function set_minimum_price( $value ) { |
|
| 973 | 973 | $this->set_prop( 'minimum_price', (float) wpinv_sanitize_amount( $value ) ); |
| 974 | 974 | } |
| 975 | 975 | |
| 976 | 976 | /** |
| 977 | - * Sets if this is a recurring item. |
|
| 978 | - * |
|
| 979 | - * @since 1.0.19 |
|
| 980 | - * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 981 | - */ |
|
| 982 | - public function set_is_recurring( $value ) { |
|
| 977 | + * Sets if this is a recurring item. |
|
| 978 | + * |
|
| 979 | + * @since 1.0.19 |
|
| 980 | + * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 981 | + */ |
|
| 982 | + public function set_is_recurring( $value ) { |
|
| 983 | 983 | $this->set_prop( 'is_recurring', (int) $value ); |
| 984 | 984 | } |
| 985 | 985 | |
| 986 | 986 | /** |
| 987 | - * Set the recurring period. |
|
| 988 | - * |
|
| 989 | - * @since 1.0.19 |
|
| 990 | - * @param string $value new period. |
|
| 991 | - */ |
|
| 992 | - public function set_recurring_period( $value ) { |
|
| 987 | + * Set the recurring period. |
|
| 988 | + * |
|
| 989 | + * @since 1.0.19 |
|
| 990 | + * @param string $value new period. |
|
| 991 | + */ |
|
| 992 | + public function set_recurring_period( $value ) { |
|
| 993 | 993 | $this->set_prop( 'recurring_period', $value ); |
| 994 | 994 | } |
| 995 | 995 | |
| 996 | 996 | /** |
| 997 | - * Set the recurring interval. |
|
| 998 | - * |
|
| 999 | - * @since 1.0.19 |
|
| 1000 | - * @param int $value recurring interval. |
|
| 1001 | - */ |
|
| 1002 | - public function set_recurring_interval( $value ) { |
|
| 997 | + * Set the recurring interval. |
|
| 998 | + * |
|
| 999 | + * @since 1.0.19 |
|
| 1000 | + * @param int $value recurring interval. |
|
| 1001 | + */ |
|
| 1002 | + public function set_recurring_interval( $value ) { |
|
| 1003 | 1003 | return $this->set_prop( 'recurring_interval', (int) $value ); |
| 1004 | 1004 | } |
| 1005 | 1005 | |
| 1006 | 1006 | /** |
| 1007 | - * Get the recurring limit. |
|
| 1008 | - * @since 1.0.19 |
|
| 1009 | - * @param int $value The recurring limit. |
|
| 1010 | - * @return int |
|
| 1011 | - */ |
|
| 1012 | - public function set_recurring_limit( $value ) { |
|
| 1007 | + * Get the recurring limit. |
|
| 1008 | + * @since 1.0.19 |
|
| 1009 | + * @param int $value The recurring limit. |
|
| 1010 | + * @return int |
|
| 1011 | + */ |
|
| 1012 | + public function set_recurring_limit( $value ) { |
|
| 1013 | 1013 | $this->set_prop( 'recurring_limit', (int) $value ); |
| 1014 | 1014 | } |
| 1015 | 1015 | |
| 1016 | 1016 | /** |
| 1017 | - * Checks if we have a free trial. |
|
| 1018 | - * |
|
| 1019 | - * @since 1.0.19 |
|
| 1020 | - * @param int|bool $value whether or not it has a free trial. |
|
| 1021 | - */ |
|
| 1022 | - public function set_is_free_trial( $value ) { |
|
| 1017 | + * Checks if we have a free trial. |
|
| 1018 | + * |
|
| 1019 | + * @since 1.0.19 |
|
| 1020 | + * @param int|bool $value whether or not it has a free trial. |
|
| 1021 | + */ |
|
| 1022 | + public function set_is_free_trial( $value ) { |
|
| 1023 | 1023 | $this->set_prop( 'is_free_trial', (int) $value ); |
| 1024 | 1024 | } |
| 1025 | 1025 | |
| 1026 | 1026 | /** |
| 1027 | - * Set the trial period. |
|
| 1028 | - * |
|
| 1029 | - * @since 1.0.19 |
|
| 1030 | - * @param string $value trial period. |
|
| 1031 | - */ |
|
| 1032 | - public function set_trial_period( $value ) { |
|
| 1027 | + * Set the trial period. |
|
| 1028 | + * |
|
| 1029 | + * @since 1.0.19 |
|
| 1030 | + * @param string $value trial period. |
|
| 1031 | + */ |
|
| 1032 | + public function set_trial_period( $value ) { |
|
| 1033 | 1033 | $this->set_prop( 'trial_period', $value ); |
| 1034 | 1034 | } |
| 1035 | 1035 | |
| 1036 | 1036 | /** |
| 1037 | - * Set the trial interval. |
|
| 1038 | - * |
|
| 1039 | - * @since 1.0.19 |
|
| 1040 | - * @param int $value trial interval. |
|
| 1041 | - */ |
|
| 1042 | - public function set_trial_interval( $value ) { |
|
| 1037 | + * Set the trial interval. |
|
| 1038 | + * |
|
| 1039 | + * @since 1.0.19 |
|
| 1040 | + * @param int $value trial interval. |
|
| 1041 | + */ |
|
| 1042 | + public function set_trial_interval( $value ) { |
|
| 1043 | 1043 | $this->set_prop( 'trial_interval', $value ); |
| 1044 | 1044 | } |
| 1045 | 1045 | |
@@ -1047,17 +1047,17 @@ discard block |
||
| 1047 | 1047 | * Create an item. For backwards compatibilty. |
| 1048 | 1048 | * |
| 1049 | 1049 | * @deprecated |
| 1050 | - * @return int item id |
|
| 1050 | + * @return int item id |
|
| 1051 | 1051 | */ |
| 1052 | 1052 | public function create( $data = array() ) { |
| 1053 | 1053 | |
| 1054 | - // Set the properties. |
|
| 1055 | - if ( is_array( $data ) ) { |
|
| 1056 | - $this->set_props( $data ); |
|
| 1057 | - } |
|
| 1054 | + // Set the properties. |
|
| 1055 | + if ( is_array( $data ) ) { |
|
| 1056 | + $this->set_props( $data ); |
|
| 1057 | + } |
|
| 1058 | 1058 | |
| 1059 | - // Save the item. |
|
| 1060 | - return $this->save(); |
|
| 1059 | + // Save the item. |
|
| 1060 | + return $this->save(); |
|
| 1061 | 1061 | |
| 1062 | 1062 | } |
| 1063 | 1063 | |
@@ -1065,7 +1065,7 @@ discard block |
||
| 1065 | 1065 | * Updates an item. For backwards compatibilty. |
| 1066 | 1066 | * |
| 1067 | 1067 | * @deprecated |
| 1068 | - * @return int item id |
|
| 1068 | + * @return int item id |
|
| 1069 | 1069 | */ |
| 1070 | 1070 | public function update( $data = array() ) { |
| 1071 | 1071 | return $this->create( $data ); |
@@ -1081,93 +1081,93 @@ discard block |
||
| 1081 | 1081 | */ |
| 1082 | 1082 | |
| 1083 | 1083 | /** |
| 1084 | - * Checks whether the item has enabled dynamic pricing. |
|
| 1085 | - * |
|
| 1086 | - * @since 1.0.19 |
|
| 1087 | - * @return bool |
|
| 1088 | - */ |
|
| 1089 | - public function user_can_set_their_price() { |
|
| 1084 | + * Checks whether the item has enabled dynamic pricing. |
|
| 1085 | + * |
|
| 1086 | + * @since 1.0.19 |
|
| 1087 | + * @return bool |
|
| 1088 | + */ |
|
| 1089 | + public function user_can_set_their_price() { |
|
| 1090 | 1090 | return (bool) $this->get_is_dynamic_pricing(); |
| 1091 | - } |
|
| 1091 | + } |
|
| 1092 | 1092 | |
| 1093 | - /** |
|
| 1094 | - * Checks whether the item is recurring. |
|
| 1095 | - * |
|
| 1096 | - * @since 1.0.19 |
|
| 1097 | - * @return bool |
|
| 1098 | - */ |
|
| 1099 | - public function is_recurring() { |
|
| 1093 | + /** |
|
| 1094 | + * Checks whether the item is recurring. |
|
| 1095 | + * |
|
| 1096 | + * @since 1.0.19 |
|
| 1097 | + * @return bool |
|
| 1098 | + */ |
|
| 1099 | + public function is_recurring() { |
|
| 1100 | 1100 | return (bool) $this->get_is_recurring(); |
| 1101 | 1101 | } |
| 1102 | 1102 | |
| 1103 | 1103 | /** |
| 1104 | - * Checks whether the item has a free trial. |
|
| 1105 | - * |
|
| 1106 | - * @since 1.0.19 |
|
| 1107 | - * @return bool |
|
| 1108 | - */ |
|
| 1104 | + * Checks whether the item has a free trial. |
|
| 1105 | + * |
|
| 1106 | + * @since 1.0.19 |
|
| 1107 | + * @return bool |
|
| 1108 | + */ |
|
| 1109 | 1109 | public function has_free_trial() { |
| 1110 | 1110 | $has_trial = $this->is_recurring() && (bool) $this->get_free_trial() ? true : false; |
| 1111 | 1111 | return (bool) apply_filters( 'wpinv_item_has_free_trial', $has_trial, $this->ID, $this ); |
| 1112 | 1112 | } |
| 1113 | 1113 | |
| 1114 | 1114 | /** |
| 1115 | - * Checks whether the item is free. |
|
| 1116 | - * |
|
| 1117 | - * @since 1.0.19 |
|
| 1118 | - * @return bool |
|
| 1119 | - */ |
|
| 1115 | + * Checks whether the item is free. |
|
| 1116 | + * |
|
| 1117 | + * @since 1.0.19 |
|
| 1118 | + * @return bool |
|
| 1119 | + */ |
|
| 1120 | 1120 | public function is_free() { |
| 1121 | 1121 | $is_free = $this->get_price() == 0; |
| 1122 | 1122 | return (bool) apply_filters( 'wpinv_is_free_item', $is_free, $this->ID, $this ); |
| 1123 | 1123 | } |
| 1124 | 1124 | |
| 1125 | 1125 | /** |
| 1126 | - * Checks the item status against a passed in status. |
|
| 1127 | - * |
|
| 1128 | - * @param array|string $status Status to check. |
|
| 1129 | - * @return bool |
|
| 1130 | - */ |
|
| 1131 | - public function has_status( $status ) { |
|
| 1132 | - $has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status; |
|
| 1133 | - return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status ); |
|
| 1126 | + * Checks the item status against a passed in status. |
|
| 1127 | + * |
|
| 1128 | + * @param array|string $status Status to check. |
|
| 1129 | + * @return bool |
|
| 1130 | + */ |
|
| 1131 | + public function has_status( $status ) { |
|
| 1132 | + $has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status; |
|
| 1133 | + return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status ); |
|
| 1134 | 1134 | } |
| 1135 | 1135 | |
| 1136 | 1136 | /** |
| 1137 | - * Checks the item type against a passed in types. |
|
| 1138 | - * |
|
| 1139 | - * @param array|string $type Type to check. |
|
| 1140 | - * @return bool |
|
| 1141 | - */ |
|
| 1142 | - public function is_type( $type ) { |
|
| 1143 | - $is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type; |
|
| 1144 | - return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type ); |
|
| 1145 | - } |
|
| 1137 | + * Checks the item type against a passed in types. |
|
| 1138 | + * |
|
| 1139 | + * @param array|string $type Type to check. |
|
| 1140 | + * @return bool |
|
| 1141 | + */ |
|
| 1142 | + public function is_type( $type ) { |
|
| 1143 | + $is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type; |
|
| 1144 | + return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type ); |
|
| 1145 | + } |
|
| 1146 | 1146 | |
| 1147 | 1147 | /** |
| 1148 | - * Checks whether the item is editable. |
|
| 1149 | - * |
|
| 1150 | - * @since 1.0.19 |
|
| 1151 | - * @return bool |
|
| 1152 | - */ |
|
| 1148 | + * Checks whether the item is editable. |
|
| 1149 | + * |
|
| 1150 | + * @since 1.0.19 |
|
| 1151 | + * @return bool |
|
| 1152 | + */ |
|
| 1153 | 1153 | public function is_editable() { |
| 1154 | 1154 | $is_editable = $this->get_is_editable(); |
| 1155 | 1155 | return (bool) apply_filters( 'wpinv_item_is_editable', $is_editable, $this->ID, $this ); |
| 1156 | - } |
|
| 1156 | + } |
|
| 1157 | 1157 | |
| 1158 | - /** |
|
| 1159 | - * Returns an array of cart fees. |
|
| 1160 | - */ |
|
| 1161 | - public function get_fees() { |
|
| 1158 | + /** |
|
| 1159 | + * Returns an array of cart fees. |
|
| 1160 | + */ |
|
| 1161 | + public function get_fees() { |
|
| 1162 | 1162 | return array(); |
| 1163 | 1163 | } |
| 1164 | 1164 | |
| 1165 | 1165 | /** |
| 1166 | - * Checks whether the item is purchasable. |
|
| 1167 | - * |
|
| 1168 | - * @since 1.0.19 |
|
| 1169 | - * @return bool |
|
| 1170 | - */ |
|
| 1166 | + * Checks whether the item is purchasable. |
|
| 1167 | + * |
|
| 1168 | + * @since 1.0.19 |
|
| 1169 | + * @return bool |
|
| 1170 | + */ |
|
| 1171 | 1171 | public function can_purchase() { |
| 1172 | 1172 | $can_purchase = $this->exists(); |
| 1173 | 1173 | |
@@ -1179,11 +1179,11 @@ discard block |
||
| 1179 | 1179 | } |
| 1180 | 1180 | |
| 1181 | 1181 | /** |
| 1182 | - * Checks whether the item supports dynamic pricing. |
|
| 1183 | - * |
|
| 1184 | - * @since 1.0.19 |
|
| 1185 | - * @return bool |
|
| 1186 | - */ |
|
| 1182 | + * Checks whether the item supports dynamic pricing. |
|
| 1183 | + * |
|
| 1184 | + * @since 1.0.19 |
|
| 1185 | + * @return bool |
|
| 1186 | + */ |
|
| 1187 | 1187 | public function supports_dynamic_pricing() { |
| 1188 | 1188 | return (bool) apply_filters( 'wpinv_item_supports_dynamic_pricing', true, $this ); |
| 1189 | 1189 | } |
@@ -12,472 +12,472 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Invoice_Notification_Emails { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * The array of invoice email actions. |
|
| 17 | - * |
|
| 18 | - * @param array |
|
| 19 | - */ |
|
| 20 | - public $invoice_actions; |
|
| 21 | - |
|
| 22 | - /** |
|
| 23 | - * Class constructor |
|
| 24 | - * |
|
| 25 | - */ |
|
| 26 | - public function __construct() { |
|
| 27 | - |
|
| 28 | - $this->invoice_actions = apply_filters( |
|
| 29 | - 'getpaid_notification_email_invoice_triggers', |
|
| 30 | - array( |
|
| 31 | - 'getpaid_new_invoice' => array( 'new_invoice', 'user_invoice' ), |
|
| 32 | - 'getpaid_invoice_status_wpi-cancelled' => 'cancelled_invoice', |
|
| 33 | - 'getpaid_invoice_status_wpi-failed' => 'failed_invoice', |
|
| 34 | - 'getpaid_invoice_status_wpi-onhold' => 'onhold_invoice', |
|
| 35 | - 'getpaid_invoice_status_wpi-processing' => 'processing_invoice', |
|
| 36 | - 'getpaid_invoice_status_publish' => 'completed_invoice', |
|
| 37 | - 'getpaid_invoice_status_wpi-renewal' => 'completed_invoice', |
|
| 38 | - 'getpaid_invoice_status_wpi-refunded' => 'refunded_invoice', |
|
| 39 | - 'getpaid_new_customer_note' => 'user_note', |
|
| 40 | - 'getpaid_daily_maintenance' => 'overdue', |
|
| 41 | - ) |
|
| 42 | - ); |
|
| 43 | - |
|
| 44 | - $this->init_hooks(); |
|
| 45 | - |
|
| 46 | - } |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * Registers email hooks. |
|
| 50 | - */ |
|
| 51 | - public function init_hooks() { |
|
| 52 | - |
|
| 53 | - add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 ); |
|
| 54 | - add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 ); |
|
| 55 | - |
|
| 56 | - foreach ( $this->invoice_actions as $hook => $email_type ) { |
|
| 57 | - $this->init_email_type_hook( $hook, $email_type ); |
|
| 58 | - } |
|
| 59 | - } |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * Registers an email hook for an invoice action. |
|
| 63 | - * |
|
| 64 | - * @param string $hook |
|
| 65 | - * @param string|array $email_type |
|
| 66 | - */ |
|
| 67 | - public function init_email_type_hook( $hook, $email_type ) { |
|
| 68 | - |
|
| 69 | - $email_type = wpinv_parse_list( $email_type ); |
|
| 70 | - |
|
| 71 | - foreach ( $email_type as $type ) { |
|
| 72 | - |
|
| 73 | - $email = new GetPaid_Notification_Email( $type ); |
|
| 74 | - |
|
| 75 | - // Abort if it is not active. |
|
| 76 | - if ( ! $email->is_active() ) { |
|
| 77 | - continue; |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - if ( method_exists( $this, $type ) ) { |
|
| 81 | - add_action( $hook, array( $this, $type ), 100, 2 ); |
|
| 82 | - continue; |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - do_action( 'getpaid_invoice_init_email_type_hook', $type, $hook ); |
|
| 86 | - } |
|
| 87 | - |
|
| 88 | - } |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * Filters invoice merge tags. |
|
| 92 | - * |
|
| 93 | - * @param array $merge_tags |
|
| 94 | - * @param mixed|WPInv_Invoice|WPInv_Subscription $object |
|
| 95 | - */ |
|
| 96 | - public function invoice_merge_tags( $merge_tags, $object ) { |
|
| 97 | - |
|
| 98 | - if ( is_a( $object, 'WPInv_Invoice' ) ) { |
|
| 99 | - return array_merge( |
|
| 100 | - $merge_tags, |
|
| 101 | - $this->get_invoice_merge_tags( $object ) |
|
| 102 | - ); |
|
| 103 | - } |
|
| 104 | - |
|
| 105 | - if ( is_a( $object, 'WPInv_Subscription' ) ) { |
|
| 106 | - return array_merge( |
|
| 107 | - $merge_tags, |
|
| 108 | - $this->get_invoice_merge_tags( $object->get_parent_payment() ) |
|
| 109 | - ); |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - return $merge_tags; |
|
| 113 | - |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - /** |
|
| 117 | - * Generates invoice merge tags. |
|
| 118 | - * |
|
| 119 | - * @param WPInv_Invoice $invoice |
|
| 120 | - * @return array |
|
| 121 | - */ |
|
| 122 | - public function get_invoice_merge_tags( $invoice ) { |
|
| 123 | - |
|
| 124 | - // Abort if it does not exist. |
|
| 125 | - if ( ! $invoice->get_id() ) { |
|
| 126 | - return array(); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - $merge_tags = array( |
|
| 130 | - '{name}' => sanitize_text_field( $invoice->get_user_full_name() ), |
|
| 131 | - '{full_name}' => sanitize_text_field( $invoice->get_user_full_name() ), |
|
| 132 | - '{first_name}' => sanitize_text_field( $invoice->get_first_name() ), |
|
| 133 | - '{last_name}' => sanitize_text_field( $invoice->get_last_name() ), |
|
| 134 | - '{email}' => sanitize_email( $invoice->get_email() ), |
|
| 135 | - '{invoice_number}' => sanitize_text_field( $invoice->get_number() ), |
|
| 136 | - '{invoice_currency}' => sanitize_text_field( $invoice->get_currency() ), |
|
| 137 | - '{invoice_total}' => sanitize_text_field( wpinv_price( $invoice->get_total(), $invoice->get_currency() ) ), |
|
| 138 | - '{invoice_link}' => esc_url( $invoice->get_view_url() ), |
|
| 139 | - '{invoice_pay_link}' => esc_url( $invoice->get_checkout_payment_url() ), |
|
| 140 | - '{invoice_receipt_link}'=> esc_url( $invoice->get_receipt_url() ), |
|
| 141 | - '{invoice_date}' => getpaid_format_date_value( $invoice->get_date_created() ), |
|
| 142 | - '{invoice_due_date}' => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ), |
|
| 143 | - '{invoice_quote}' => sanitize_text_field( strtolower( $invoice->get_label() ) ), |
|
| 144 | - '{invoice_label}' => sanitize_text_field( ucfirst( $invoice->get_label() ) ), |
|
| 145 | - '{invoice_description}' => wp_kses_post( $invoice->get_description() ), |
|
| 146 | - '{subscription_name}' => wp_kses_post( $invoice->get_subscription_name() ), |
|
| 147 | - '{is_was}' => strtotime( $invoice->get_due_date() ) < current_time( 'timestamp' ) ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ), |
|
| 148 | - ); |
|
| 149 | - |
|
| 150 | - $payment_form_data = $invoice->get_meta( 'payment_form_data', true ); |
|
| 151 | - |
|
| 152 | - if ( is_array( $payment_form_data ) ) { |
|
| 153 | - |
|
| 154 | - foreach ( $payment_form_data as $label => $value ) { |
|
| 155 | - |
|
| 156 | - $label = preg_replace( '/[^a-z0-9]+/', '_', strtolower( $label ) ); |
|
| 157 | - $value = is_array( $value ) ? implode( ', ', $value ) : $value; |
|
| 158 | - |
|
| 159 | - if ( is_scalar ( $value ) ) { |
|
| 160 | - $merge_tags[ "{{$label}}" ] = wp_kses_post( $value ); |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - } |
|
| 166 | - |
|
| 167 | - return apply_filters( 'getpaid_invoice_email_merge_tags', $merge_tags, $invoice ); |
|
| 168 | - } |
|
| 169 | - |
|
| 170 | - /** |
|
| 171 | - * Helper function to send an email. |
|
| 172 | - * |
|
| 173 | - * @param WPInv_Invoice $invoice |
|
| 174 | - * @param GetPaid_Notification_Email $email |
|
| 175 | - * @param string $type |
|
| 176 | - * @param string|array $recipients |
|
| 177 | - * @param array $extra_args Extra template args. |
|
| 178 | - */ |
|
| 179 | - public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) { |
|
| 180 | - |
|
| 181 | - do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email ); |
|
| 182 | - |
|
| 183 | - if ( apply_filters( 'getpaid_skip_invoice_email', false, $type, $invoice ) ) { |
|
| 184 | - return; |
|
| 185 | - } |
|
| 186 | - |
|
| 187 | - $mailer = new GetPaid_Notification_Email_Sender(); |
|
| 188 | - $merge_tags = $email->get_merge_tags(); |
|
| 189 | - |
|
| 190 | - $result = $mailer->send( |
|
| 191 | - apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ), |
|
| 192 | - $email->add_merge_tags( $email->get_subject(), $merge_tags ), |
|
| 193 | - $email->get_content( $merge_tags, $extra_args ), |
|
| 194 | - $email->get_attachments() |
|
| 195 | - ); |
|
| 196 | - |
|
| 197 | - // Maybe send a copy to the admin. |
|
| 198 | - if ( $email->include_admin_bcc() ) { |
|
| 199 | - $mailer->send( |
|
| 200 | - wpinv_get_admin_email(), |
|
| 201 | - $email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ), |
|
| 202 | - $email->get_content( $merge_tags ), |
|
| 203 | - $email->get_attachments() |
|
| 204 | - ); |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - if ( $result ) { |
|
| 208 | - $invoice->add_note( sprintf( __( 'Successfully sent %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true ); |
|
| 209 | - } else { |
|
| 210 | - $invoice->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true ); |
|
| 211 | - } |
|
| 212 | - |
|
| 213 | - do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email ); |
|
| 214 | - |
|
| 215 | - return $result; |
|
| 216 | - } |
|
| 217 | - |
|
| 218 | - /** |
|
| 219 | - * Also send emails to any cc users. |
|
| 220 | - * |
|
| 221 | - * @param array $recipients |
|
| 222 | - * @param GetPaid_Notification_Email $email |
|
| 223 | - */ |
|
| 224 | - public function filter_email_recipients( $recipients, $email ) { |
|
| 225 | - |
|
| 226 | - if ( ! $email->is_admin_email() ) { |
|
| 227 | - $cc = $email->object->get_email_cc(); |
|
| 228 | - |
|
| 229 | - if ( ! empty( $cc ) ) { |
|
| 230 | - $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) ); |
|
| 231 | - $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) ); |
|
| 232 | - } |
|
| 15 | + /** |
|
| 16 | + * The array of invoice email actions. |
|
| 17 | + * |
|
| 18 | + * @param array |
|
| 19 | + */ |
|
| 20 | + public $invoice_actions; |
|
| 21 | + |
|
| 22 | + /** |
|
| 23 | + * Class constructor |
|
| 24 | + * |
|
| 25 | + */ |
|
| 26 | + public function __construct() { |
|
| 27 | + |
|
| 28 | + $this->invoice_actions = apply_filters( |
|
| 29 | + 'getpaid_notification_email_invoice_triggers', |
|
| 30 | + array( |
|
| 31 | + 'getpaid_new_invoice' => array( 'new_invoice', 'user_invoice' ), |
|
| 32 | + 'getpaid_invoice_status_wpi-cancelled' => 'cancelled_invoice', |
|
| 33 | + 'getpaid_invoice_status_wpi-failed' => 'failed_invoice', |
|
| 34 | + 'getpaid_invoice_status_wpi-onhold' => 'onhold_invoice', |
|
| 35 | + 'getpaid_invoice_status_wpi-processing' => 'processing_invoice', |
|
| 36 | + 'getpaid_invoice_status_publish' => 'completed_invoice', |
|
| 37 | + 'getpaid_invoice_status_wpi-renewal' => 'completed_invoice', |
|
| 38 | + 'getpaid_invoice_status_wpi-refunded' => 'refunded_invoice', |
|
| 39 | + 'getpaid_new_customer_note' => 'user_note', |
|
| 40 | + 'getpaid_daily_maintenance' => 'overdue', |
|
| 41 | + ) |
|
| 42 | + ); |
|
| 43 | + |
|
| 44 | + $this->init_hooks(); |
|
| 45 | + |
|
| 46 | + } |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * Registers email hooks. |
|
| 50 | + */ |
|
| 51 | + public function init_hooks() { |
|
| 52 | + |
|
| 53 | + add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 ); |
|
| 54 | + add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 ); |
|
| 55 | + |
|
| 56 | + foreach ( $this->invoice_actions as $hook => $email_type ) { |
|
| 57 | + $this->init_email_type_hook( $hook, $email_type ); |
|
| 58 | + } |
|
| 59 | + } |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * Registers an email hook for an invoice action. |
|
| 63 | + * |
|
| 64 | + * @param string $hook |
|
| 65 | + * @param string|array $email_type |
|
| 66 | + */ |
|
| 67 | + public function init_email_type_hook( $hook, $email_type ) { |
|
| 68 | + |
|
| 69 | + $email_type = wpinv_parse_list( $email_type ); |
|
| 70 | + |
|
| 71 | + foreach ( $email_type as $type ) { |
|
| 72 | + |
|
| 73 | + $email = new GetPaid_Notification_Email( $type ); |
|
| 74 | + |
|
| 75 | + // Abort if it is not active. |
|
| 76 | + if ( ! $email->is_active() ) { |
|
| 77 | + continue; |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + if ( method_exists( $this, $type ) ) { |
|
| 81 | + add_action( $hook, array( $this, $type ), 100, 2 ); |
|
| 82 | + continue; |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + do_action( 'getpaid_invoice_init_email_type_hook', $type, $hook ); |
|
| 86 | + } |
|
| 87 | + |
|
| 88 | + } |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * Filters invoice merge tags. |
|
| 92 | + * |
|
| 93 | + * @param array $merge_tags |
|
| 94 | + * @param mixed|WPInv_Invoice|WPInv_Subscription $object |
|
| 95 | + */ |
|
| 96 | + public function invoice_merge_tags( $merge_tags, $object ) { |
|
| 97 | + |
|
| 98 | + if ( is_a( $object, 'WPInv_Invoice' ) ) { |
|
| 99 | + return array_merge( |
|
| 100 | + $merge_tags, |
|
| 101 | + $this->get_invoice_merge_tags( $object ) |
|
| 102 | + ); |
|
| 103 | + } |
|
| 104 | + |
|
| 105 | + if ( is_a( $object, 'WPInv_Subscription' ) ) { |
|
| 106 | + return array_merge( |
|
| 107 | + $merge_tags, |
|
| 108 | + $this->get_invoice_merge_tags( $object->get_parent_payment() ) |
|
| 109 | + ); |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + return $merge_tags; |
|
| 113 | + |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + /** |
|
| 117 | + * Generates invoice merge tags. |
|
| 118 | + * |
|
| 119 | + * @param WPInv_Invoice $invoice |
|
| 120 | + * @return array |
|
| 121 | + */ |
|
| 122 | + public function get_invoice_merge_tags( $invoice ) { |
|
| 123 | + |
|
| 124 | + // Abort if it does not exist. |
|
| 125 | + if ( ! $invoice->get_id() ) { |
|
| 126 | + return array(); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + $merge_tags = array( |
|
| 130 | + '{name}' => sanitize_text_field( $invoice->get_user_full_name() ), |
|
| 131 | + '{full_name}' => sanitize_text_field( $invoice->get_user_full_name() ), |
|
| 132 | + '{first_name}' => sanitize_text_field( $invoice->get_first_name() ), |
|
| 133 | + '{last_name}' => sanitize_text_field( $invoice->get_last_name() ), |
|
| 134 | + '{email}' => sanitize_email( $invoice->get_email() ), |
|
| 135 | + '{invoice_number}' => sanitize_text_field( $invoice->get_number() ), |
|
| 136 | + '{invoice_currency}' => sanitize_text_field( $invoice->get_currency() ), |
|
| 137 | + '{invoice_total}' => sanitize_text_field( wpinv_price( $invoice->get_total(), $invoice->get_currency() ) ), |
|
| 138 | + '{invoice_link}' => esc_url( $invoice->get_view_url() ), |
|
| 139 | + '{invoice_pay_link}' => esc_url( $invoice->get_checkout_payment_url() ), |
|
| 140 | + '{invoice_receipt_link}'=> esc_url( $invoice->get_receipt_url() ), |
|
| 141 | + '{invoice_date}' => getpaid_format_date_value( $invoice->get_date_created() ), |
|
| 142 | + '{invoice_due_date}' => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ), |
|
| 143 | + '{invoice_quote}' => sanitize_text_field( strtolower( $invoice->get_label() ) ), |
|
| 144 | + '{invoice_label}' => sanitize_text_field( ucfirst( $invoice->get_label() ) ), |
|
| 145 | + '{invoice_description}' => wp_kses_post( $invoice->get_description() ), |
|
| 146 | + '{subscription_name}' => wp_kses_post( $invoice->get_subscription_name() ), |
|
| 147 | + '{is_was}' => strtotime( $invoice->get_due_date() ) < current_time( 'timestamp' ) ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ), |
|
| 148 | + ); |
|
| 149 | + |
|
| 150 | + $payment_form_data = $invoice->get_meta( 'payment_form_data', true ); |
|
| 151 | + |
|
| 152 | + if ( is_array( $payment_form_data ) ) { |
|
| 153 | + |
|
| 154 | + foreach ( $payment_form_data as $label => $value ) { |
|
| 155 | + |
|
| 156 | + $label = preg_replace( '/[^a-z0-9]+/', '_', strtolower( $label ) ); |
|
| 157 | + $value = is_array( $value ) ? implode( ', ', $value ) : $value; |
|
| 158 | + |
|
| 159 | + if ( is_scalar ( $value ) ) { |
|
| 160 | + $merge_tags[ "{{$label}}" ] = wp_kses_post( $value ); |
|
| 161 | + } |
|
| 162 | + |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + } |
|
| 166 | + |
|
| 167 | + return apply_filters( 'getpaid_invoice_email_merge_tags', $merge_tags, $invoice ); |
|
| 168 | + } |
|
| 169 | + |
|
| 170 | + /** |
|
| 171 | + * Helper function to send an email. |
|
| 172 | + * |
|
| 173 | + * @param WPInv_Invoice $invoice |
|
| 174 | + * @param GetPaid_Notification_Email $email |
|
| 175 | + * @param string $type |
|
| 176 | + * @param string|array $recipients |
|
| 177 | + * @param array $extra_args Extra template args. |
|
| 178 | + */ |
|
| 179 | + public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) { |
|
| 180 | + |
|
| 181 | + do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email ); |
|
| 182 | + |
|
| 183 | + if ( apply_filters( 'getpaid_skip_invoice_email', false, $type, $invoice ) ) { |
|
| 184 | + return; |
|
| 185 | + } |
|
| 186 | + |
|
| 187 | + $mailer = new GetPaid_Notification_Email_Sender(); |
|
| 188 | + $merge_tags = $email->get_merge_tags(); |
|
| 189 | + |
|
| 190 | + $result = $mailer->send( |
|
| 191 | + apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ), |
|
| 192 | + $email->add_merge_tags( $email->get_subject(), $merge_tags ), |
|
| 193 | + $email->get_content( $merge_tags, $extra_args ), |
|
| 194 | + $email->get_attachments() |
|
| 195 | + ); |
|
| 196 | + |
|
| 197 | + // Maybe send a copy to the admin. |
|
| 198 | + if ( $email->include_admin_bcc() ) { |
|
| 199 | + $mailer->send( |
|
| 200 | + wpinv_get_admin_email(), |
|
| 201 | + $email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ), |
|
| 202 | + $email->get_content( $merge_tags ), |
|
| 203 | + $email->get_attachments() |
|
| 204 | + ); |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + if ( $result ) { |
|
| 208 | + $invoice->add_note( sprintf( __( 'Successfully sent %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true ); |
|
| 209 | + } else { |
|
| 210 | + $invoice->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true ); |
|
| 211 | + } |
|
| 212 | + |
|
| 213 | + do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email ); |
|
| 214 | + |
|
| 215 | + return $result; |
|
| 216 | + } |
|
| 217 | + |
|
| 218 | + /** |
|
| 219 | + * Also send emails to any cc users. |
|
| 220 | + * |
|
| 221 | + * @param array $recipients |
|
| 222 | + * @param GetPaid_Notification_Email $email |
|
| 223 | + */ |
|
| 224 | + public function filter_email_recipients( $recipients, $email ) { |
|
| 225 | + |
|
| 226 | + if ( ! $email->is_admin_email() ) { |
|
| 227 | + $cc = $email->object->get_email_cc(); |
|
| 228 | + |
|
| 229 | + if ( ! empty( $cc ) ) { |
|
| 230 | + $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) ); |
|
| 231 | + $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) ); |
|
| 232 | + } |
|
| 233 | 233 | |
| 234 | - } |
|
| 234 | + } |
|
| 235 | 235 | |
| 236 | - return $recipients; |
|
| 236 | + return $recipients; |
|
| 237 | 237 | |
| 238 | - } |
|
| 238 | + } |
|
| 239 | 239 | |
| 240 | - /** |
|
| 241 | - * Sends a new invoice notification. |
|
| 242 | - * |
|
| 243 | - * @param WPInv_Invoice $invoice |
|
| 244 | - */ |
|
| 245 | - public function new_invoice( $invoice ) { |
|
| 240 | + /** |
|
| 241 | + * Sends a new invoice notification. |
|
| 242 | + * |
|
| 243 | + * @param WPInv_Invoice $invoice |
|
| 244 | + */ |
|
| 245 | + public function new_invoice( $invoice ) { |
|
| 246 | 246 | |
| 247 | - // Only send this email for invoices created via the admin page. |
|
| 248 | - if ( ! $invoice->is_type( 'invoice' ) || $this->is_payment_form_invoice( $invoice->get_id() ) ) { |
|
| 249 | - return; |
|
| 250 | - } |
|
| 247 | + // Only send this email for invoices created via the admin page. |
|
| 248 | + if ( ! $invoice->is_type( 'invoice' ) || $this->is_payment_form_invoice( $invoice->get_id() ) ) { |
|
| 249 | + return; |
|
| 250 | + } |
|
| 251 | 251 | |
| 252 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 253 | - $recipient = wpinv_get_admin_email(); |
|
| 252 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 253 | + $recipient = wpinv_get_admin_email(); |
|
| 254 | 254 | |
| 255 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 255 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 256 | 256 | |
| 257 | - } |
|
| 257 | + } |
|
| 258 | 258 | |
| 259 | - /** |
|
| 260 | - * Sends a cancelled invoice notification. |
|
| 261 | - * |
|
| 262 | - * @param WPInv_Invoice $invoice |
|
| 263 | - */ |
|
| 264 | - public function cancelled_invoice( $invoice ) { |
|
| 259 | + /** |
|
| 260 | + * Sends a cancelled invoice notification. |
|
| 261 | + * |
|
| 262 | + * @param WPInv_Invoice $invoice |
|
| 263 | + */ |
|
| 264 | + public function cancelled_invoice( $invoice ) { |
|
| 265 | 265 | |
| 266 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 267 | - $recipient = wpinv_get_admin_email(); |
|
| 266 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 267 | + $recipient = wpinv_get_admin_email(); |
|
| 268 | 268 | |
| 269 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 269 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 270 | 270 | |
| 271 | - } |
|
| 271 | + } |
|
| 272 | 272 | |
| 273 | - /** |
|
| 274 | - * Sends a failed invoice notification. |
|
| 275 | - * |
|
| 276 | - * @param WPInv_Invoice $invoice |
|
| 277 | - */ |
|
| 278 | - public function failed_invoice( $invoice ) { |
|
| 273 | + /** |
|
| 274 | + * Sends a failed invoice notification. |
|
| 275 | + * |
|
| 276 | + * @param WPInv_Invoice $invoice |
|
| 277 | + */ |
|
| 278 | + public function failed_invoice( $invoice ) { |
|
| 279 | 279 | |
| 280 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 281 | - $recipient = wpinv_get_admin_email(); |
|
| 280 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 281 | + $recipient = wpinv_get_admin_email(); |
|
| 282 | 282 | |
| 283 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 283 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 284 | 284 | |
| 285 | - } |
|
| 285 | + } |
|
| 286 | 286 | |
| 287 | - /** |
|
| 288 | - * Sends a notification whenever an invoice is put on hold. |
|
| 289 | - * |
|
| 290 | - * @param WPInv_Invoice $invoice |
|
| 291 | - */ |
|
| 292 | - public function onhold_invoice( $invoice ) { |
|
| 287 | + /** |
|
| 288 | + * Sends a notification whenever an invoice is put on hold. |
|
| 289 | + * |
|
| 290 | + * @param WPInv_Invoice $invoice |
|
| 291 | + */ |
|
| 292 | + public function onhold_invoice( $invoice ) { |
|
| 293 | 293 | |
| 294 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 295 | - $recipient = $invoice->get_email(); |
|
| 294 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 295 | + $recipient = $invoice->get_email(); |
|
| 296 | 296 | |
| 297 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 297 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 298 | 298 | |
| 299 | - } |
|
| 299 | + } |
|
| 300 | 300 | |
| 301 | - /** |
|
| 302 | - * Sends a notification whenever an invoice is marked as processing payment. |
|
| 303 | - * |
|
| 304 | - * @param WPInv_Invoice $invoice |
|
| 305 | - */ |
|
| 306 | - public function processing_invoice( $invoice ) { |
|
| 301 | + /** |
|
| 302 | + * Sends a notification whenever an invoice is marked as processing payment. |
|
| 303 | + * |
|
| 304 | + * @param WPInv_Invoice $invoice |
|
| 305 | + */ |
|
| 306 | + public function processing_invoice( $invoice ) { |
|
| 307 | 307 | |
| 308 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 309 | - $recipient = $invoice->get_email(); |
|
| 308 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 309 | + $recipient = $invoice->get_email(); |
|
| 310 | 310 | |
| 311 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 311 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 312 | 312 | |
| 313 | - } |
|
| 313 | + } |
|
| 314 | 314 | |
| 315 | - /** |
|
| 316 | - * Sends a notification whenever an invoice is paid. |
|
| 317 | - * |
|
| 318 | - * @param WPInv_Invoice $invoice |
|
| 319 | - */ |
|
| 320 | - public function completed_invoice( $invoice ) { |
|
| 315 | + /** |
|
| 316 | + * Sends a notification whenever an invoice is paid. |
|
| 317 | + * |
|
| 318 | + * @param WPInv_Invoice $invoice |
|
| 319 | + */ |
|
| 320 | + public function completed_invoice( $invoice ) { |
|
| 321 | 321 | |
| 322 | - // (Maybe) abort if it is a renewal invoice. |
|
| 323 | - if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) { |
|
| 324 | - return; |
|
| 325 | - } |
|
| 322 | + // (Maybe) abort if it is a renewal invoice. |
|
| 323 | + if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) { |
|
| 324 | + return; |
|
| 325 | + } |
|
| 326 | 326 | |
| 327 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 328 | - $recipient = $invoice->get_email(); |
|
| 327 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 328 | + $recipient = $invoice->get_email(); |
|
| 329 | 329 | |
| 330 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 330 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 331 | 331 | |
| 332 | - } |
|
| 332 | + } |
|
| 333 | 333 | |
| 334 | - /** |
|
| 335 | - * Sends a notification whenever an invoice is refunded. |
|
| 336 | - * |
|
| 337 | - * @param WPInv_Invoice $invoice |
|
| 338 | - */ |
|
| 339 | - public function refunded_invoice( $invoice ) { |
|
| 334 | + /** |
|
| 335 | + * Sends a notification whenever an invoice is refunded. |
|
| 336 | + * |
|
| 337 | + * @param WPInv_Invoice $invoice |
|
| 338 | + */ |
|
| 339 | + public function refunded_invoice( $invoice ) { |
|
| 340 | 340 | |
| 341 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 342 | - $recipient = $invoice->get_email(); |
|
| 341 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 342 | + $recipient = $invoice->get_email(); |
|
| 343 | 343 | |
| 344 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 344 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 345 | 345 | |
| 346 | - } |
|
| 346 | + } |
|
| 347 | 347 | |
| 348 | - /** |
|
| 349 | - * Notifies a user about new invoices |
|
| 350 | - * |
|
| 351 | - * @param WPInv_Invoice $invoice |
|
| 352 | - * @param bool $force |
|
| 353 | - */ |
|
| 354 | - public function user_invoice( $invoice, $force = false ) { |
|
| 348 | + /** |
|
| 349 | + * Notifies a user about new invoices |
|
| 350 | + * |
|
| 351 | + * @param WPInv_Invoice $invoice |
|
| 352 | + * @param bool $force |
|
| 353 | + */ |
|
| 354 | + public function user_invoice( $invoice, $force = false ) { |
|
| 355 | 355 | |
| 356 | - if ( ! empty( $GLOBALS['wpinv_skip_invoice_notification'] ) ) { |
|
| 357 | - return; |
|
| 358 | - } |
|
| 356 | + if ( ! empty( $GLOBALS['wpinv_skip_invoice_notification'] ) ) { |
|
| 357 | + return; |
|
| 358 | + } |
|
| 359 | 359 | |
| 360 | - // Only send this email for invoices created via the admin page. |
|
| 361 | - if ( ! $invoice->is_type( 'invoice' ) || ( empty( $force ) && $this->is_payment_form_invoice( $invoice->get_id() ) ) ) { |
|
| 362 | - return; |
|
| 363 | - } |
|
| 360 | + // Only send this email for invoices created via the admin page. |
|
| 361 | + if ( ! $invoice->is_type( 'invoice' ) || ( empty( $force ) && $this->is_payment_form_invoice( $invoice->get_id() ) ) ) { |
|
| 362 | + return; |
|
| 363 | + } |
|
| 364 | 364 | |
| 365 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 366 | - $recipient = $invoice->get_email(); |
|
| 365 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 366 | + $recipient = $invoice->get_email(); |
|
| 367 | 367 | |
| 368 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 368 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 369 | 369 | |
| 370 | - } |
|
| 370 | + } |
|
| 371 | 371 | |
| 372 | - /** |
|
| 373 | - * Checks if an invoice is a payment form invoice. |
|
| 374 | - * |
|
| 375 | - * @param int $invoice |
|
| 376 | - * @return bool |
|
| 377 | - */ |
|
| 378 | - public function is_payment_form_invoice( $invoice ) { |
|
| 379 | - return empty( $_GET['getpaid-admin-action'] ) && ( 'payment_form' == get_post_meta( $invoice, 'wpinv_created_via', true ) || 'geodirectory' == get_post_meta( $invoice, 'wpinv_created_via', true ) ); |
|
| 380 | - } |
|
| 372 | + /** |
|
| 373 | + * Checks if an invoice is a payment form invoice. |
|
| 374 | + * |
|
| 375 | + * @param int $invoice |
|
| 376 | + * @return bool |
|
| 377 | + */ |
|
| 378 | + public function is_payment_form_invoice( $invoice ) { |
|
| 379 | + return empty( $_GET['getpaid-admin-action'] ) && ( 'payment_form' == get_post_meta( $invoice, 'wpinv_created_via', true ) || 'geodirectory' == get_post_meta( $invoice, 'wpinv_created_via', true ) ); |
|
| 380 | + } |
|
| 381 | 381 | |
| 382 | - /** |
|
| 383 | - * Notifies admin about new invoice notes |
|
| 384 | - * |
|
| 385 | - * @param WPInv_Invoice $invoice |
|
| 386 | - * @param string $note |
|
| 387 | - */ |
|
| 388 | - public function user_note( $invoice, $note ) { |
|
| 389 | - |
|
| 390 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 391 | - $recipient = $invoice->get_email(); |
|
| 382 | + /** |
|
| 383 | + * Notifies admin about new invoice notes |
|
| 384 | + * |
|
| 385 | + * @param WPInv_Invoice $invoice |
|
| 386 | + * @param string $note |
|
| 387 | + */ |
|
| 388 | + public function user_note( $invoice, $note ) { |
|
| 389 | + |
|
| 390 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 391 | + $recipient = $invoice->get_email(); |
|
| 392 | 392 | |
| 393 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) ); |
|
| 394 | - |
|
| 395 | - } |
|
| 393 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) ); |
|
| 394 | + |
|
| 395 | + } |
|
| 396 | 396 | |
| 397 | - /** |
|
| 398 | - * (Force) Sends overdue notices. |
|
| 399 | - * |
|
| 400 | - * @param WPInv_Invoice $invoice |
|
| 401 | - */ |
|
| 402 | - public function force_send_overdue_notice( $invoice ) { |
|
| 403 | - $email = new GetPaid_Notification_Email( 'overdue', $invoice ); |
|
| 404 | - return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() ); |
|
| 405 | - } |
|
| 406 | - |
|
| 407 | - /** |
|
| 408 | - * Sends overdue notices. |
|
| 409 | - * |
|
| 410 | - * @TODO: Create an invoices query class. |
|
| 411 | - */ |
|
| 412 | - public function overdue() { |
|
| 413 | - global $wpdb; |
|
| 414 | - |
|
| 415 | - $email = new GetPaid_Notification_Email( __FUNCTION__ ); |
|
| 416 | - |
|
| 417 | - // Fetch reminder days. |
|
| 418 | - $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) ); |
|
| 419 | - |
|
| 420 | - // Abort if non is set. |
|
| 421 | - if ( empty( $reminder_days ) ) { |
|
| 422 | - return; |
|
| 423 | - } |
|
| 424 | - |
|
| 425 | - // Retrieve date query. |
|
| 426 | - $date_query = $this->get_date_query( $reminder_days ); |
|
| 427 | - |
|
| 428 | - // Invoices table. |
|
| 429 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 430 | - |
|
| 431 | - // Fetch invoices. |
|
| 432 | - $invoices = $wpdb->get_col( |
|
| 433 | - "SELECT posts.ID FROM $wpdb->posts as posts |
|
| 397 | + /** |
|
| 398 | + * (Force) Sends overdue notices. |
|
| 399 | + * |
|
| 400 | + * @param WPInv_Invoice $invoice |
|
| 401 | + */ |
|
| 402 | + public function force_send_overdue_notice( $invoice ) { |
|
| 403 | + $email = new GetPaid_Notification_Email( 'overdue', $invoice ); |
|
| 404 | + return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() ); |
|
| 405 | + } |
|
| 406 | + |
|
| 407 | + /** |
|
| 408 | + * Sends overdue notices. |
|
| 409 | + * |
|
| 410 | + * @TODO: Create an invoices query class. |
|
| 411 | + */ |
|
| 412 | + public function overdue() { |
|
| 413 | + global $wpdb; |
|
| 414 | + |
|
| 415 | + $email = new GetPaid_Notification_Email( __FUNCTION__ ); |
|
| 416 | + |
|
| 417 | + // Fetch reminder days. |
|
| 418 | + $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) ); |
|
| 419 | + |
|
| 420 | + // Abort if non is set. |
|
| 421 | + if ( empty( $reminder_days ) ) { |
|
| 422 | + return; |
|
| 423 | + } |
|
| 424 | + |
|
| 425 | + // Retrieve date query. |
|
| 426 | + $date_query = $this->get_date_query( $reminder_days ); |
|
| 427 | + |
|
| 428 | + // Invoices table. |
|
| 429 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 430 | + |
|
| 431 | + // Fetch invoices. |
|
| 432 | + $invoices = $wpdb->get_col( |
|
| 433 | + "SELECT posts.ID FROM $wpdb->posts as posts |
|
| 434 | 434 | LEFT JOIN $table as invoices ON invoices.post_id = posts.ID |
| 435 | 435 | WHERE posts.post_type = 'wpi_invoice' AND posts.post_status = 'wpi-pending' $date_query"); |
| 436 | 436 | |
| 437 | - foreach ( $invoices as $invoice ) { |
|
| 437 | + foreach ( $invoices as $invoice ) { |
|
| 438 | 438 | |
| 439 | - // Only send this email for invoices created via the admin page. |
|
| 440 | - if ( ! $this->is_payment_form_invoice( $invoice ) ) { |
|
| 441 | - $invoice = new WPInv_Invoice( $invoice ); |
|
| 442 | - $email->object = $invoice; |
|
| 439 | + // Only send this email for invoices created via the admin page. |
|
| 440 | + if ( ! $this->is_payment_form_invoice( $invoice ) ) { |
|
| 441 | + $invoice = new WPInv_Invoice( $invoice ); |
|
| 442 | + $email->object = $invoice; |
|
| 443 | 443 | |
| 444 | - if ( $invoice->needs_payment() ) { |
|
| 445 | - $this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() ); |
|
| 446 | - } |
|
| 444 | + if ( $invoice->needs_payment() ) { |
|
| 445 | + $this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() ); |
|
| 446 | + } |
|
| 447 | 447 | |
| 448 | - } |
|
| 448 | + } |
|
| 449 | 449 | |
| 450 | - } |
|
| 450 | + } |
|
| 451 | 451 | |
| 452 | - } |
|
| 452 | + } |
|
| 453 | 453 | |
| 454 | - /** |
|
| 455 | - * Calculates the date query for an invoices query |
|
| 456 | - * |
|
| 457 | - * @param array $reminder_days |
|
| 458 | - * @return string |
|
| 459 | - */ |
|
| 460 | - public function get_date_query( $reminder_days ) { |
|
| 454 | + /** |
|
| 455 | + * Calculates the date query for an invoices query |
|
| 456 | + * |
|
| 457 | + * @param array $reminder_days |
|
| 458 | + * @return string |
|
| 459 | + */ |
|
| 460 | + public function get_date_query( $reminder_days ) { |
|
| 461 | 461 | |
| 462 | - $date_query = array( |
|
| 463 | - 'relation' => 'OR' |
|
| 464 | - ); |
|
| 462 | + $date_query = array( |
|
| 463 | + 'relation' => 'OR' |
|
| 464 | + ); |
|
| 465 | 465 | |
| 466 | - foreach ( $reminder_days as $days ) { |
|
| 467 | - $date = date_parse( date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ) ); |
|
| 466 | + foreach ( $reminder_days as $days ) { |
|
| 467 | + $date = date_parse( date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ) ); |
|
| 468 | 468 | |
| 469 | - $date_query[] = array( |
|
| 470 | - 'year' => $date['year'], |
|
| 471 | - 'month' => $date['month'], |
|
| 472 | - 'day' => $date['day'], |
|
| 473 | - ); |
|
| 469 | + $date_query[] = array( |
|
| 470 | + 'year' => $date['year'], |
|
| 471 | + 'month' => $date['month'], |
|
| 472 | + 'day' => $date['day'], |
|
| 473 | + ); |
|
| 474 | 474 | |
| 475 | - } |
|
| 475 | + } |
|
| 476 | 476 | |
| 477 | - $date_query = new WP_Date_Query( $date_query, 'invoices.due_date' ); |
|
| 477 | + $date_query = new WP_Date_Query( $date_query, 'invoices.due_date' ); |
|
| 478 | 478 | |
| 479 | - return $date_query->get_sql(); |
|
| 479 | + return $date_query->get_sql(); |
|
| 480 | 480 | |
| 481 | - } |
|
| 481 | + } |
|
| 482 | 482 | |
| 483 | 483 | } |
@@ -160,51 +160,51 @@ |
||
| 160 | 160 | */ |
| 161 | 161 | function getpaid_calculate_invoice_discount( $invoice, $discount ) { |
| 162 | 162 | |
| 163 | - $initial_discount = 0; |
|
| 164 | - $recurring_discount = 0; |
|
| 163 | + $initial_discount = 0; |
|
| 164 | + $recurring_discount = 0; |
|
| 165 | 165 | |
| 166 | - foreach ( $invoice->get_items() as $item ) { |
|
| 166 | + foreach ( $invoice->get_items() as $item ) { |
|
| 167 | 167 | |
| 168 | - // Abort if it is not valid for this item. |
|
| 169 | - if ( ! $discount->is_valid_for_items( array( $item->get_id() ) ) ) { |
|
| 170 | - continue; |
|
| 171 | - } |
|
| 168 | + // Abort if it is not valid for this item. |
|
| 169 | + if ( ! $discount->is_valid_for_items( array( $item->get_id() ) ) ) { |
|
| 170 | + continue; |
|
| 171 | + } |
|
| 172 | 172 | |
| 173 | - // Calculate the initial amount... |
|
| 174 | - $item_discount = $discount->get_discounted_amount( $item->get_sub_total() ); |
|
| 175 | - $recurring_item_discount = 0; |
|
| 173 | + // Calculate the initial amount... |
|
| 174 | + $item_discount = $discount->get_discounted_amount( $item->get_sub_total() ); |
|
| 175 | + $recurring_item_discount = 0; |
|
| 176 | 176 | |
| 177 | - // ... and maybe the recurring amount. |
|
| 178 | - if ( $item->is_recurring() && $discount->is_recurring() ) { |
|
| 179 | - $recurring_item_discount = $discount->get_discounted_amount( $item->get_recurring_sub_total() ); |
|
| 180 | - } |
|
| 177 | + // ... and maybe the recurring amount. |
|
| 178 | + if ( $item->is_recurring() && $discount->is_recurring() ) { |
|
| 179 | + $recurring_item_discount = $discount->get_discounted_amount( $item->get_recurring_sub_total() ); |
|
| 180 | + } |
|
| 181 | 181 | |
| 182 | - // Discount should not exceed discounted amount. |
|
| 183 | - if ( ! $discount->is_type( 'percent' ) ) { |
|
| 182 | + // Discount should not exceed discounted amount. |
|
| 183 | + if ( ! $discount->is_type( 'percent' ) ) { |
|
| 184 | 184 | |
| 185 | - if ( ( $initial_discount + $item_discount ) > $discount->get_amount() ) { |
|
| 186 | - $item_discount = $discount->get_amount() - $initial_discount; |
|
| 187 | - } |
|
| 185 | + if ( ( $initial_discount + $item_discount ) > $discount->get_amount() ) { |
|
| 186 | + $item_discount = $discount->get_amount() - $initial_discount; |
|
| 187 | + } |
|
| 188 | 188 | |
| 189 | - if ( ( $recurring_discount + $recurring_item_discount ) > $discount->get_amount() ) { |
|
| 190 | - $recurring_item_discount = $discount->get_amount() - $recurring_discount; |
|
| 191 | - } |
|
| 189 | + if ( ( $recurring_discount + $recurring_item_discount ) > $discount->get_amount() ) { |
|
| 190 | + $recurring_item_discount = $discount->get_amount() - $recurring_discount; |
|
| 191 | + } |
|
| 192 | 192 | |
| 193 | - } |
|
| 193 | + } |
|
| 194 | 194 | |
| 195 | - $initial_discount += $item_discount; |
|
| 196 | - $recurring_discount += $recurring_item_discount; |
|
| 197 | - $item->item_discount = $item_discount; |
|
| 198 | - $item->recurring_item_discount = $recurring_item_discount; |
|
| 195 | + $initial_discount += $item_discount; |
|
| 196 | + $recurring_discount += $recurring_item_discount; |
|
| 197 | + $item->item_discount = $item_discount; |
|
| 198 | + $item->recurring_item_discount = $recurring_item_discount; |
|
| 199 | 199 | |
| 200 | - } |
|
| 200 | + } |
|
| 201 | 201 | |
| 202 | - return array( |
|
| 203 | - 'name' => 'discount_code', |
|
| 204 | - 'discount_code' => $discount->get_code(), |
|
| 205 | - 'initial_discount' => $initial_discount, |
|
| 206 | - 'recurring_discount' => $recurring_discount, |
|
| 207 | - ); |
|
| 202 | + return array( |
|
| 203 | + 'name' => 'discount_code', |
|
| 204 | + 'discount_code' => $discount->get_code(), |
|
| 205 | + 'initial_discount' => $initial_discount, |
|
| 206 | + 'recurring_discount' => $recurring_discount, |
|
| 207 | + ); |
|
| 208 | 208 | |
| 209 | 209 | } |
| 210 | 210 | |
@@ -13,168 +13,168 @@ |
||
| 13 | 13 | */ |
| 14 | 14 | class GetPaid_Tax { |
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * Calculates tax for a line item. |
|
| 18 | - * |
|
| 19 | - * @param float $price The price to calc tax on. |
|
| 20 | - * @param array $rates The rates to apply. |
|
| 21 | - * @param boolean $price_includes_tax Whether the passed price has taxes included. |
|
| 22 | - * @return array Array of tax name => tax amount. |
|
| 23 | - */ |
|
| 24 | - public static function calc_tax( $price, $rates, $price_includes_tax = false ) { |
|
| 25 | - |
|
| 26 | - if ( $price_includes_tax ) { |
|
| 27 | - $taxes = self::calc_inclusive_tax( $price, $rates ); |
|
| 28 | - } else { |
|
| 29 | - $taxes = self::calc_exclusive_tax( $price, $rates ); |
|
| 30 | - } |
|
| 31 | - |
|
| 32 | - return apply_filters( 'getpaid_calc_tax', $taxes, $price, $rates, $price_includes_tax ); |
|
| 33 | - |
|
| 34 | - } |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * Calc tax from inclusive price. |
|
| 38 | - * |
|
| 39 | - * @param float $price Price to calculate tax for. |
|
| 40 | - * @param array $rates Array of tax rates. |
|
| 41 | - * @return array |
|
| 42 | - */ |
|
| 43 | - public static function calc_inclusive_tax( $price, $rates ) { |
|
| 44 | - $taxes = array(); |
|
| 45 | - $tax_rates = wp_list_pluck( $rates, 'rate', 'name' ); |
|
| 46 | - |
|
| 47 | - // Add tax rates. |
|
| 48 | - $tax_rate = 1 + ( array_sum( $tax_rates ) / 100 ); |
|
| 49 | - |
|
| 50 | - foreach ( $tax_rates as $name => $rate ) { |
|
| 51 | - $the_rate = ( $rate / 100 ) / $tax_rate; |
|
| 52 | - $net_price = $price - ( $the_rate * $price ); |
|
| 53 | - $tax_amount = apply_filters( 'getpaid_price_inc_tax_amount', $price - $net_price, $name, $rate, $price ); |
|
| 54 | - $taxes[ $name ] = $tax_amount; |
|
| 55 | - } |
|
| 56 | - |
|
| 57 | - // Round all taxes to precision (4DP) before passing them back. |
|
| 58 | - $taxes = array_map( array( __CLASS__, 'round' ), $taxes ); |
|
| 59 | - |
|
| 60 | - return $taxes; |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Calc tax from exclusive price. |
|
| 65 | - * |
|
| 66 | - * @param float $price Price to calculate tax for. |
|
| 67 | - * @param array $rates Array of tax rates. |
|
| 68 | - * @return array |
|
| 69 | - */ |
|
| 70 | - public static function calc_exclusive_tax( $price, $rates ) { |
|
| 71 | - $taxes = array(); |
|
| 72 | - $tax_rates = wp_list_pluck( $rates, 'rate', 'name' ); |
|
| 73 | - |
|
| 74 | - foreach ( $tax_rates as $name => $rate ) { |
|
| 75 | - |
|
| 76 | - $tax_amount = $price * ( $rate / 100 ); |
|
| 77 | - $taxes[ $name ] = apply_filters( 'getpaid_price_ex_tax_amount', $tax_amount, $name, $rate, $price ); |
|
| 78 | - |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - // Round all taxes to precision (4DP) before passing them back. |
|
| 82 | - $taxes = array_map( array( __CLASS__, 'round' ), $taxes ); |
|
| 83 | - |
|
| 84 | - return $taxes; |
|
| 85 | - } |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * Get's an array of all tax rates. |
|
| 89 | - * |
|
| 90 | - * @return array |
|
| 91 | - */ |
|
| 92 | - public static function get_all_tax_rates() { |
|
| 93 | - |
|
| 94 | - $rates = get_option( 'wpinv_tax_rates', array() ); |
|
| 95 | - |
|
| 96 | - return apply_filters( |
|
| 97 | - 'getpaid_get_all_tax_rates', |
|
| 98 | - array_filter( wpinv_parse_list( $rates ) ) |
|
| 99 | - ); |
|
| 100 | - |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - /** |
|
| 104 | - * Get's an array of default tax rates. |
|
| 105 | - * |
|
| 106 | - * @return array |
|
| 107 | - */ |
|
| 108 | - public static function get_default_tax_rates() { |
|
| 109 | - |
|
| 110 | - return apply_filters( |
|
| 111 | - 'getpaid_get_default_tax_rates', |
|
| 112 | - array( |
|
| 113 | - array( |
|
| 114 | - 'country' => wpinv_get_default_country(), |
|
| 115 | - 'state' => wpinv_get_default_state(), |
|
| 116 | - 'global' => true, |
|
| 117 | - 'rate' => wpinv_get_default_tax_rate(), |
|
| 118 | - 'name' => __( 'Base Tax', 'invoicing' ), |
|
| 119 | - ) |
|
| 120 | - ) |
|
| 121 | - ); |
|
| 122 | - |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - /** |
|
| 126 | - * Get's an array of tax rates for a given address. |
|
| 127 | - * |
|
| 128 | - * @param string $country |
|
| 129 | - * @param string $state |
|
| 130 | - * @return array |
|
| 131 | - */ |
|
| 132 | - public static function get_address_tax_rates( $country, $state ) { |
|
| 133 | - |
|
| 134 | - $all_tax_rates = self::get_all_tax_rates(); |
|
| 135 | - $matching_rates = array_merge( |
|
| 136 | - wp_list_filter( $all_tax_rates, array( 'country' => $country ) ), |
|
| 137 | - wp_list_filter( $all_tax_rates, array( 'country' => '' ) ) |
|
| 138 | - ); |
|
| 139 | - |
|
| 140 | - foreach ( $matching_rates as $i => $rate ) { |
|
| 141 | - |
|
| 142 | - $states = array_filter( wpinv_clean( explode( ',', strtolower( $rate['state'] ) ) ) ); |
|
| 143 | - if ( empty( $rate['global'] ) && ! in_array( strtolower( $state ), $states ) ) { |
|
| 144 | - unset( $matching_rates[ $i ] ); |
|
| 145 | - } |
|
| 146 | - |
|
| 147 | - } |
|
| 148 | - |
|
| 149 | - return apply_filters( 'getpaid_get_address_tax_rates', $matching_rates, $country, $state ); |
|
| 150 | - |
|
| 151 | - } |
|
| 152 | - |
|
| 153 | - /** |
|
| 154 | - * Sums a set of taxes to form a single total. Result is rounded to precision. |
|
| 155 | - * |
|
| 156 | - * @param array $taxes Array of taxes. |
|
| 157 | - * @return float |
|
| 158 | - */ |
|
| 159 | - public static function get_tax_total( $taxes ) { |
|
| 160 | - return self::round( array_sum( $taxes ) ); |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - /** |
|
| 164 | - * Round to precision. |
|
| 165 | - * |
|
| 166 | - * Filter example: to return rounding to .5 cents you'd use: |
|
| 167 | - * |
|
| 168 | - * function euro_5cent_rounding( $in ) { |
|
| 169 | - * return round( $in / 5, 2 ) * 5; |
|
| 170 | - * } |
|
| 171 | - * add_filter( 'getpaid_tax_round', 'euro_5cent_rounding' ); |
|
| 172 | - * |
|
| 173 | - * @param float|int $in Value to round. |
|
| 174 | - * @return float |
|
| 175 | - */ |
|
| 176 | - public static function round( $in ) { |
|
| 177 | - return apply_filters( 'getpaid_tax_round', round( $in, 4 ), $in ); |
|
| 178 | - } |
|
| 16 | + /** |
|
| 17 | + * Calculates tax for a line item. |
|
| 18 | + * |
|
| 19 | + * @param float $price The price to calc tax on. |
|
| 20 | + * @param array $rates The rates to apply. |
|
| 21 | + * @param boolean $price_includes_tax Whether the passed price has taxes included. |
|
| 22 | + * @return array Array of tax name => tax amount. |
|
| 23 | + */ |
|
| 24 | + public static function calc_tax( $price, $rates, $price_includes_tax = false ) { |
|
| 25 | + |
|
| 26 | + if ( $price_includes_tax ) { |
|
| 27 | + $taxes = self::calc_inclusive_tax( $price, $rates ); |
|
| 28 | + } else { |
|
| 29 | + $taxes = self::calc_exclusive_tax( $price, $rates ); |
|
| 30 | + } |
|
| 31 | + |
|
| 32 | + return apply_filters( 'getpaid_calc_tax', $taxes, $price, $rates, $price_includes_tax ); |
|
| 33 | + |
|
| 34 | + } |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * Calc tax from inclusive price. |
|
| 38 | + * |
|
| 39 | + * @param float $price Price to calculate tax for. |
|
| 40 | + * @param array $rates Array of tax rates. |
|
| 41 | + * @return array |
|
| 42 | + */ |
|
| 43 | + public static function calc_inclusive_tax( $price, $rates ) { |
|
| 44 | + $taxes = array(); |
|
| 45 | + $tax_rates = wp_list_pluck( $rates, 'rate', 'name' ); |
|
| 46 | + |
|
| 47 | + // Add tax rates. |
|
| 48 | + $tax_rate = 1 + ( array_sum( $tax_rates ) / 100 ); |
|
| 49 | + |
|
| 50 | + foreach ( $tax_rates as $name => $rate ) { |
|
| 51 | + $the_rate = ( $rate / 100 ) / $tax_rate; |
|
| 52 | + $net_price = $price - ( $the_rate * $price ); |
|
| 53 | + $tax_amount = apply_filters( 'getpaid_price_inc_tax_amount', $price - $net_price, $name, $rate, $price ); |
|
| 54 | + $taxes[ $name ] = $tax_amount; |
|
| 55 | + } |
|
| 56 | + |
|
| 57 | + // Round all taxes to precision (4DP) before passing them back. |
|
| 58 | + $taxes = array_map( array( __CLASS__, 'round' ), $taxes ); |
|
| 59 | + |
|
| 60 | + return $taxes; |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Calc tax from exclusive price. |
|
| 65 | + * |
|
| 66 | + * @param float $price Price to calculate tax for. |
|
| 67 | + * @param array $rates Array of tax rates. |
|
| 68 | + * @return array |
|
| 69 | + */ |
|
| 70 | + public static function calc_exclusive_tax( $price, $rates ) { |
|
| 71 | + $taxes = array(); |
|
| 72 | + $tax_rates = wp_list_pluck( $rates, 'rate', 'name' ); |
|
| 73 | + |
|
| 74 | + foreach ( $tax_rates as $name => $rate ) { |
|
| 75 | + |
|
| 76 | + $tax_amount = $price * ( $rate / 100 ); |
|
| 77 | + $taxes[ $name ] = apply_filters( 'getpaid_price_ex_tax_amount', $tax_amount, $name, $rate, $price ); |
|
| 78 | + |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + // Round all taxes to precision (4DP) before passing them back. |
|
| 82 | + $taxes = array_map( array( __CLASS__, 'round' ), $taxes ); |
|
| 83 | + |
|
| 84 | + return $taxes; |
|
| 85 | + } |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * Get's an array of all tax rates. |
|
| 89 | + * |
|
| 90 | + * @return array |
|
| 91 | + */ |
|
| 92 | + public static function get_all_tax_rates() { |
|
| 93 | + |
|
| 94 | + $rates = get_option( 'wpinv_tax_rates', array() ); |
|
| 95 | + |
|
| 96 | + return apply_filters( |
|
| 97 | + 'getpaid_get_all_tax_rates', |
|
| 98 | + array_filter( wpinv_parse_list( $rates ) ) |
|
| 99 | + ); |
|
| 100 | + |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + /** |
|
| 104 | + * Get's an array of default tax rates. |
|
| 105 | + * |
|
| 106 | + * @return array |
|
| 107 | + */ |
|
| 108 | + public static function get_default_tax_rates() { |
|
| 109 | + |
|
| 110 | + return apply_filters( |
|
| 111 | + 'getpaid_get_default_tax_rates', |
|
| 112 | + array( |
|
| 113 | + array( |
|
| 114 | + 'country' => wpinv_get_default_country(), |
|
| 115 | + 'state' => wpinv_get_default_state(), |
|
| 116 | + 'global' => true, |
|
| 117 | + 'rate' => wpinv_get_default_tax_rate(), |
|
| 118 | + 'name' => __( 'Base Tax', 'invoicing' ), |
|
| 119 | + ) |
|
| 120 | + ) |
|
| 121 | + ); |
|
| 122 | + |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + /** |
|
| 126 | + * Get's an array of tax rates for a given address. |
|
| 127 | + * |
|
| 128 | + * @param string $country |
|
| 129 | + * @param string $state |
|
| 130 | + * @return array |
|
| 131 | + */ |
|
| 132 | + public static function get_address_tax_rates( $country, $state ) { |
|
| 133 | + |
|
| 134 | + $all_tax_rates = self::get_all_tax_rates(); |
|
| 135 | + $matching_rates = array_merge( |
|
| 136 | + wp_list_filter( $all_tax_rates, array( 'country' => $country ) ), |
|
| 137 | + wp_list_filter( $all_tax_rates, array( 'country' => '' ) ) |
|
| 138 | + ); |
|
| 139 | + |
|
| 140 | + foreach ( $matching_rates as $i => $rate ) { |
|
| 141 | + |
|
| 142 | + $states = array_filter( wpinv_clean( explode( ',', strtolower( $rate['state'] ) ) ) ); |
|
| 143 | + if ( empty( $rate['global'] ) && ! in_array( strtolower( $state ), $states ) ) { |
|
| 144 | + unset( $matching_rates[ $i ] ); |
|
| 145 | + } |
|
| 146 | + |
|
| 147 | + } |
|
| 148 | + |
|
| 149 | + return apply_filters( 'getpaid_get_address_tax_rates', $matching_rates, $country, $state ); |
|
| 150 | + |
|
| 151 | + } |
|
| 152 | + |
|
| 153 | + /** |
|
| 154 | + * Sums a set of taxes to form a single total. Result is rounded to precision. |
|
| 155 | + * |
|
| 156 | + * @param array $taxes Array of taxes. |
|
| 157 | + * @return float |
|
| 158 | + */ |
|
| 159 | + public static function get_tax_total( $taxes ) { |
|
| 160 | + return self::round( array_sum( $taxes ) ); |
|
| 161 | + } |
|
| 162 | + |
|
| 163 | + /** |
|
| 164 | + * Round to precision. |
|
| 165 | + * |
|
| 166 | + * Filter example: to return rounding to .5 cents you'd use: |
|
| 167 | + * |
|
| 168 | + * function euro_5cent_rounding( $in ) { |
|
| 169 | + * return round( $in / 5, 2 ) * 5; |
|
| 170 | + * } |
|
| 171 | + * add_filter( 'getpaid_tax_round', 'euro_5cent_rounding' ); |
|
| 172 | + * |
|
| 173 | + * @param float|int $in Value to round. |
|
| 174 | + * @return float |
|
| 175 | + */ |
|
| 176 | + public static function round( $in ) { |
|
| 177 | + return apply_filters( 'getpaid_tax_round', round( $in, 4 ), $in ); |
|
| 178 | + } |
|
| 179 | 179 | |
| 180 | 180 | } |
@@ -19,16 +19,16 @@ discard block |
||
| 19 | 19 | |
| 20 | 20 | // Define constants. |
| 21 | 21 | if ( ! defined( 'WPINV_PLUGIN_FILE' ) ) { |
| 22 | - define( 'WPINV_PLUGIN_FILE', __FILE__ ); |
|
| 22 | + define( 'WPINV_PLUGIN_FILE', __FILE__ ); |
|
| 23 | 23 | } |
| 24 | 24 | |
| 25 | 25 | if ( ! defined( 'WPINV_VERSION' ) ) { |
| 26 | - define( 'WPINV_VERSION', '2.2.6' ); |
|
| 26 | + define( 'WPINV_VERSION', '2.2.6' ); |
|
| 27 | 27 | } |
| 28 | 28 | |
| 29 | 29 | // Include the main Invoicing class. |
| 30 | 30 | if ( ! class_exists( 'WPInv_Plugin', false ) ) { |
| 31 | - require_once plugin_dir_path( WPINV_PLUGIN_FILE ) . 'includes/class-wpinv.php'; |
|
| 31 | + require_once plugin_dir_path( WPINV_PLUGIN_FILE ) . 'includes/class-wpinv.php'; |
|
| 32 | 32 | } |
| 33 | 33 | |
| 34 | 34 | /** |
@@ -43,7 +43,7 @@ discard block |
||
| 43 | 43 | $GLOBALS['invoicing'] = new WPInv_Plugin(); |
| 44 | 44 | } |
| 45 | 45 | |
| 46 | - return $GLOBALS['invoicing']; |
|
| 46 | + return $GLOBALS['invoicing']; |
|
| 47 | 47 | } |
| 48 | 48 | |
| 49 | 49 | /** |
@@ -246,7 +246,7 @@ discard block |
||
| 246 | 246 | * @deprecated |
| 247 | 247 | */ |
| 248 | 248 | function wpinv_get_payment_key( $invoice = 0 ) { |
| 249 | - $invoice = new WPInv_Invoice( $invoice ); |
|
| 249 | + $invoice = new WPInv_Invoice( $invoice ); |
|
| 250 | 250 | return $invoice->get_key(); |
| 251 | 251 | } |
| 252 | 252 | |
@@ -424,7 +424,7 @@ discard block |
||
| 424 | 424 | * @deprecated |
| 425 | 425 | */ |
| 426 | 426 | function wpinv_get_checkout_session() { |
| 427 | - return false; |
|
| 427 | + return false; |
|
| 428 | 428 | } |
| 429 | 429 | |
| 430 | 430 | /** |
@@ -1273,5 +1273,5 @@ discard block |
||
| 1273 | 1273 | * @deprecated |
| 1274 | 1274 | */ |
| 1275 | 1275 | function wpinv_get_subscription( $invoice ) { |
| 1276 | - return wpinv_get_invoice_subscription( $invoice ); |
|
| 1276 | + return wpinv_get_invoice_subscription( $invoice ); |
|
| 1277 | 1277 | } |