AyeCode /
invoicing
@@ -26,58 +26,58 @@ discard block |
||
| 26 | 26 | |
| 27 | 27 | <?php |
| 28 | 28 | |
| 29 | - // Fires before printing a line item column. |
|
| 30 | - do_action( "getpaid_form_cart_item_before_$key", $item, $form ); |
|
| 29 | + // Fires before printing a line item column. |
|
| 30 | + do_action( "getpaid_form_cart_item_before_$key", $item, $form ); |
|
| 31 | 31 | |
| 32 | - // Item name. |
|
| 33 | - if ( 'name' == $key ) { |
|
| 32 | + // Item name. |
|
| 33 | + if ( 'name' == $key ) { |
|
| 34 | 34 | |
| 35 | - ob_start(); |
|
| 36 | - // And an optional description. |
|
| 35 | + ob_start(); |
|
| 36 | + // And an optional description. |
|
| 37 | 37 | $description = $item->get_description(); |
| 38 | 38 | |
| 39 | 39 | if ( ! empty( $description ) ) { |
| 40 | 40 | $description = wp_kses_post( $description ); |
| 41 | 41 | echo "<small class='form-text text-muted pr-2 m-0'>$description</small>"; |
| 42 | - } |
|
| 42 | + } |
|
| 43 | 43 | |
| 44 | - // Price help text. |
|
| 44 | + // Price help text. |
|
| 45 | 45 | $description = getpaid_item_recurring_price_help_text( $item, $currency ); |
| 46 | 46 | if ( $description ) { |
| 47 | 47 | echo "<small class='getpaid-form-item-price-desc form-text text-muted pr-2 m-0'>$description</small>"; |
| 48 | - } |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | - do_action( 'getpaid_payment_form_cart_item_description', $item, $form ); |
|
| 50 | + do_action( 'getpaid_payment_form_cart_item_description', $item, $form ); |
|
| 51 | 51 | |
| 52 | - if ( wpinv_current_user_can_manage_invoicing() ) { |
|
| 52 | + if ( wpinv_current_user_can_manage_invoicing() ) { |
|
| 53 | 53 | |
| 54 | - edit_post_link( |
|
| 55 | - __( 'Edit this item.', 'invoicing' ), |
|
| 56 | - '<small class="form-text text-muted">', |
|
| 57 | - '</small>', |
|
| 58 | - $item->get_id(), |
|
| 59 | - 'text-danger' |
|
| 60 | - ); |
|
| 54 | + edit_post_link( |
|
| 55 | + __( 'Edit this item.', 'invoicing' ), |
|
| 56 | + '<small class="form-text text-muted">', |
|
| 57 | + '</small>', |
|
| 58 | + $item->get_id(), |
|
| 59 | + 'text-danger' |
|
| 60 | + ); |
|
| 61 | 61 | |
| 62 | - } |
|
| 62 | + } |
|
| 63 | 63 | |
| 64 | - $description = ob_get_clean(); |
|
| 64 | + $description = ob_get_clean(); |
|
| 65 | 65 | |
| 66 | - // Display the name. |
|
| 67 | - $tootip = empty( $description ) ? '' : " " . '<i class="fas fa-xs fa-info gp-tooltip d-sm-none text-muted"></i>'; |
|
| 68 | - echo '<div class="mb-1">' . esc_html( $item->get_name() ) . $tootip . '</div>'; |
|
| 66 | + // Display the name. |
|
| 67 | + $tootip = empty( $description ) ? '' : " " . '<i class="fas fa-xs fa-info gp-tooltip d-sm-none text-muted"></i>'; |
|
| 68 | + echo '<div class="mb-1">' . esc_html( $item->get_name() ) . $tootip . '</div>'; |
|
| 69 | 69 | |
| 70 | - if ( ! empty( $description ) ) { |
|
| 71 | - printf( '<span class="d-none d-sm-block getpaid-item-desc">%s</span>', $description ); |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - if ( $item->allows_quantities() ) { |
|
| 75 | - printf( |
|
| 76 | - '<small class="d-sm-none text-muted form-text">%s</small>', |
|
| 77 | - sprintf( |
|
| 78 | - __( 'Qty %s', 'invoicing' ), |
|
| 79 | - sprintf( |
|
| 80 | - '<input |
|
| 70 | + if ( ! empty( $description ) ) { |
|
| 71 | + printf( '<span class="d-none d-sm-block getpaid-item-desc">%s</span>', $description ); |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + if ( $item->allows_quantities() ) { |
|
| 75 | + printf( |
|
| 76 | + '<small class="d-sm-none text-muted form-text">%s</small>', |
|
| 77 | + sprintf( |
|
| 78 | + __( 'Qty %s', 'invoicing' ), |
|
| 79 | + sprintf( |
|
| 80 | + '<input |
|
| 81 | 81 | type="number" |
| 82 | 82 | step="0.01" |
| 83 | 83 | style="width: 48px;" |
@@ -85,56 +85,56 @@ discard block |
||
| 85 | 85 | value="%s" |
| 86 | 86 | min="1" |
| 87 | 87 | %s>', |
| 88 | - (float) $item->get_quantity() == 0 ? 1 : (float) $item->get_quantity(), |
|
| 89 | - null !== $max_qty ? 'max="' . (float) $max_qty . '"' : '' |
|
| 90 | - ) |
|
| 91 | - ) |
|
| 92 | - ); |
|
| 93 | - } else { |
|
| 94 | - printf( |
|
| 95 | - '<small class="d-sm-none text-muted form-text">%s</small>', |
|
| 96 | - sprintf( |
|
| 97 | - __( 'Qty %s', 'invoicing' ), |
|
| 98 | - (float) $item->get_quantity() |
|
| 99 | - ) |
|
| 100 | - ); |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - } |
|
| 104 | - |
|
| 105 | - // Item price. |
|
| 106 | - if ( 'price' == $key ) { |
|
| 107 | - |
|
| 108 | - // Set the currency position. |
|
| 109 | - $position = wpinv_currency_position(); |
|
| 110 | - |
|
| 111 | - if ( $position == 'left_space' ) { |
|
| 112 | - $position = 'left'; |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - if ( $position == 'right_space' ) { |
|
| 116 | - $position = 'right'; |
|
| 117 | - } |
|
| 118 | - |
|
| 119 | - if ( $item->user_can_set_their_price() ) { |
|
| 120 | - $price = max( (float) $item->get_price(), (float) $item->get_minimum_price() ); |
|
| 121 | - $minimum = (float) $item->get_minimum_price(); |
|
| 122 | - $validate_minimum = ''; |
|
| 123 | - $class = ''; |
|
| 124 | - $data_minimum = ''; |
|
| 125 | - |
|
| 126 | - if ( $minimum > 0 ) { |
|
| 127 | - $validate_minimum = sprintf( |
|
| 128 | - esc_attr__( 'The minimum allowed amount is %s', 'invoicing' ), |
|
| 129 | - strip_tags( wpinv_price( $minimum, $currency ) ) |
|
| 130 | - ); |
|
| 131 | - |
|
| 132 | - $class = 'getpaid-validate-minimum-amount'; |
|
| 133 | - |
|
| 134 | - $data_minimum = "data-minimum-amount='" . esc_attr( getpaid_unstandardize_amount( $minimum ) ) . "'"; |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - ?> |
|
| 88 | + (float) $item->get_quantity() == 0 ? 1 : (float) $item->get_quantity(), |
|
| 89 | + null !== $max_qty ? 'max="' . (float) $max_qty . '"' : '' |
|
| 90 | + ) |
|
| 91 | + ) |
|
| 92 | + ); |
|
| 93 | + } else { |
|
| 94 | + printf( |
|
| 95 | + '<small class="d-sm-none text-muted form-text">%s</small>', |
|
| 96 | + sprintf( |
|
| 97 | + __( 'Qty %s', 'invoicing' ), |
|
| 98 | + (float) $item->get_quantity() |
|
| 99 | + ) |
|
| 100 | + ); |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + } |
|
| 104 | + |
|
| 105 | + // Item price. |
|
| 106 | + if ( 'price' == $key ) { |
|
| 107 | + |
|
| 108 | + // Set the currency position. |
|
| 109 | + $position = wpinv_currency_position(); |
|
| 110 | + |
|
| 111 | + if ( $position == 'left_space' ) { |
|
| 112 | + $position = 'left'; |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + if ( $position == 'right_space' ) { |
|
| 116 | + $position = 'right'; |
|
| 117 | + } |
|
| 118 | + |
|
| 119 | + if ( $item->user_can_set_their_price() ) { |
|
| 120 | + $price = max( (float) $item->get_price(), (float) $item->get_minimum_price() ); |
|
| 121 | + $minimum = (float) $item->get_minimum_price(); |
|
| 122 | + $validate_minimum = ''; |
|
| 123 | + $class = ''; |
|
| 124 | + $data_minimum = ''; |
|
| 125 | + |
|
| 126 | + if ( $minimum > 0 ) { |
|
| 127 | + $validate_minimum = sprintf( |
|
| 128 | + esc_attr__( 'The minimum allowed amount is %s', 'invoicing' ), |
|
| 129 | + strip_tags( wpinv_price( $minimum, $currency ) ) |
|
| 130 | + ); |
|
| 131 | + |
|
| 132 | + $class = 'getpaid-validate-minimum-amount'; |
|
| 133 | + |
|
| 134 | + $data_minimum = "data-minimum-amount='" . esc_attr( getpaid_unstandardize_amount( $minimum ) ) . "'"; |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + ?> |
|
| 138 | 138 | <div class="input-group input-group-sm"> |
| 139 | 139 | <?php if( 'left' == $position ) : ?> |
| 140 | 140 | <div class="input-group-prepend"> |
@@ -159,44 +159,44 @@ discard block |
||
| 159 | 159 | |
| 160 | 160 | <?php |
| 161 | 161 | |
| 162 | - } else { |
|
| 163 | - echo wpinv_price( $item->get_price(), $currency ); |
|
| 162 | + } else { |
|
| 163 | + echo wpinv_price( $item->get_price(), $currency ); |
|
| 164 | 164 | |
| 165 | - ?> |
|
| 165 | + ?> |
|
| 166 | 166 | <input name='getpaid-items[<?php echo (int) $item->get_id(); ?>][price]' type='hidden' class='getpaid-item-price-input' value='<?php echo esc_attr( $item->get_price() ); ?>'> |
| 167 | 167 | <?php |
| 168 | - } |
|
| 168 | + } |
|
| 169 | 169 | |
| 170 | - printf( |
|
| 171 | - '<small class="d-sm-none text-muted form-text getpaid-mobile-item-subtotal">%s</small>', |
|
| 172 | - sprintf( __( 'Subtotal: %s', 'invoicing' ), wpinv_price( $item->get_sub_total(), $currency ) ) |
|
| 173 | - ); |
|
| 174 | - } |
|
| 170 | + printf( |
|
| 171 | + '<small class="d-sm-none text-muted form-text getpaid-mobile-item-subtotal">%s</small>', |
|
| 172 | + sprintf( __( 'Subtotal: %s', 'invoicing' ), wpinv_price( $item->get_sub_total(), $currency ) ) |
|
| 173 | + ); |
|
| 174 | + } |
|
| 175 | 175 | |
| 176 | - // Item quantity. |
|
| 177 | - if ( 'quantity' == $key ) { |
|
| 176 | + // Item quantity. |
|
| 177 | + if ( 'quantity' == $key ) { |
|
| 178 | 178 | |
| 179 | - if ( $item->allows_quantities() ) { |
|
| 180 | - ?> |
|
| 179 | + if ( $item->allows_quantities() ) { |
|
| 180 | + ?> |
|
| 181 | 181 | <input name='getpaid-items[<?php echo (int) $item->get_id(); ?>][quantity]' type="number" step="0.01" style='width: 64px; line-height: 1; min-height: 35px;' class='getpaid-item-quantity-input p-1 align-middle font-weight-normal shadow-none m-0 rounded-0 text-center border' value='<?php echo (float) $item->get_quantity() == 0 ? 1 : (float) $item->get_quantity(); ?>' min='1' <?php echo null !== $max_qty ? 'max="' . (float) $max_qty . '"' : '' ?> required> |
| 182 | 182 | <?php |
| 183 | - } else { |
|
| 184 | - echo (float) $item->get_quantity(); |
|
| 185 | - echo ' '; |
|
| 186 | - ?> |
|
| 183 | + } else { |
|
| 184 | + echo (float) $item->get_quantity(); |
|
| 185 | + echo ' '; |
|
| 186 | + ?> |
|
| 187 | 187 | <input type='hidden' name='getpaid-items[<?php echo (int) $item->get_id(); ?>][quantity]' class='getpaid-item-quantity-input' value='<?php echo (float) $item->get_quantity(); ?>'> |
| 188 | 188 | <?php |
| 189 | - } |
|
| 189 | + } |
|
| 190 | 190 | |
| 191 | - } |
|
| 191 | + } |
|
| 192 | 192 | |
| 193 | - // Item sub total. |
|
| 194 | - if ( 'subtotal' == $key ) { |
|
| 195 | - echo wpinv_price( $item->get_sub_total(), $currency ); |
|
| 196 | - } |
|
| 193 | + // Item sub total. |
|
| 194 | + if ( 'subtotal' == $key ) { |
|
| 195 | + echo wpinv_price( $item->get_sub_total(), $currency ); |
|
| 196 | + } |
|
| 197 | 197 | |
| 198 | - do_action( "getpaid_payment_form_cart_item_$key", $item, $form ); |
|
| 199 | - ?> |
|
| 198 | + do_action( "getpaid_payment_form_cart_item_$key", $item, $form ); |
|
| 199 | + ?> |
|
| 200 | 200 | |
| 201 | 201 | </div> |
| 202 | 202 | |
@@ -14,30 +14,30 @@ discard block |
||
| 14 | 14 | class WPInv_Invoice extends GetPaid_Data { |
| 15 | 15 | |
| 16 | 16 | /** |
| 17 | - * Which data store to load. |
|
| 18 | - * |
|
| 19 | - * @var string |
|
| 20 | - */ |
|
| 17 | + * Which data store to load. |
|
| 18 | + * |
|
| 19 | + * @var string |
|
| 20 | + */ |
|
| 21 | 21 | protected $data_store_name = 'invoice'; |
| 22 | 22 | |
| 23 | 23 | /** |
| 24 | - * This is the name of this object type. |
|
| 25 | - * |
|
| 26 | - * @var string |
|
| 27 | - */ |
|
| 24 | + * This is the name of this object type. |
|
| 25 | + * |
|
| 26 | + * @var string |
|
| 27 | + */ |
|
| 28 | 28 | protected $object_type = 'invoice'; |
| 29 | 29 | |
| 30 | 30 | /** |
| 31 | - * Item Data array. This is the core item data exposed in APIs. |
|
| 32 | - * |
|
| 33 | - * @since 1.0.19 |
|
| 34 | - * @var array |
|
| 35 | - */ |
|
| 36 | - protected $data = array( |
|
| 37 | - 'parent_id' => 0, |
|
| 38 | - 'status' => 'wpi-pending', |
|
| 39 | - 'version' => '', |
|
| 40 | - 'date_created' => null, |
|
| 31 | + * Item Data array. This is the core item data exposed in APIs. |
|
| 32 | + * |
|
| 33 | + * @since 1.0.19 |
|
| 34 | + * @var array |
|
| 35 | + */ |
|
| 36 | + protected $data = array( |
|
| 37 | + 'parent_id' => 0, |
|
| 38 | + 'status' => 'wpi-pending', |
|
| 39 | + 'version' => '', |
|
| 40 | + 'date_created' => null, |
|
| 41 | 41 | 'date_modified' => null, |
| 42 | 42 | 'due_date' => null, |
| 43 | 43 | 'completed_date' => null, |
@@ -60,17 +60,17 @@ discard block |
||
| 60 | 60 | 'state' => null, |
| 61 | 61 | 'zip' => null, |
| 62 | 62 | 'company' => null, |
| 63 | - 'company_id' => null, |
|
| 63 | + 'company_id' => null, |
|
| 64 | 64 | 'vat_number' => null, |
| 65 | 65 | 'vat_rate' => null, |
| 66 | 66 | 'address' => null, |
| 67 | 67 | 'address_confirmed' => false, |
| 68 | 68 | 'shipping' => null, |
| 69 | - 'subtotal' => 0, |
|
| 69 | + 'subtotal' => 0, |
|
| 70 | 70 | 'total_discount' => 0, |
| 71 | 71 | 'total_tax' => 0, |
| 72 | - 'total_fees' => 0, |
|
| 73 | - 'total' => 0, |
|
| 72 | + 'total_fees' => 0, |
|
| 73 | + 'total' => 0, |
|
| 74 | 74 | 'fees' => array(), |
| 75 | 75 | 'discounts' => array(), |
| 76 | 76 | 'taxes' => array(), |
@@ -82,22 +82,22 @@ discard block |
||
| 82 | 82 | 'transaction_id' => '', |
| 83 | 83 | 'currency' => '', |
| 84 | 84 | 'disable_taxes' => false, |
| 85 | - 'subscription_id' => null, |
|
| 86 | - 'remote_subscription_id' => null, |
|
| 87 | - 'is_viewed' => false, |
|
| 88 | - 'email_cc' => '', |
|
| 89 | - 'template' => 'quantity', // hours, amount only |
|
| 90 | - 'created_via' => null, |
|
| 85 | + 'subscription_id' => null, |
|
| 86 | + 'remote_subscription_id' => null, |
|
| 87 | + 'is_viewed' => false, |
|
| 88 | + 'email_cc' => '', |
|
| 89 | + 'template' => 'quantity', // hours, amount only |
|
| 90 | + 'created_via' => null, |
|
| 91 | 91 | ); |
| 92 | 92 | |
| 93 | 93 | /** |
| 94 | - * Stores meta in cache for future reads. |
|
| 95 | - * |
|
| 96 | - * A group must be set to to enable caching. |
|
| 97 | - * |
|
| 98 | - * @var string |
|
| 99 | - */ |
|
| 100 | - protected $cache_group = 'getpaid_invoices'; |
|
| 94 | + * Stores meta in cache for future reads. |
|
| 95 | + * |
|
| 96 | + * A group must be set to to enable caching. |
|
| 97 | + * |
|
| 98 | + * @var string |
|
| 99 | + */ |
|
| 100 | + protected $cache_group = 'getpaid_invoices'; |
|
| 101 | 101 | |
| 102 | 102 | /** |
| 103 | 103 | * Stores a reference to the original WP_Post object |
@@ -111,111 +111,111 @@ discard block |
||
| 111 | 111 | * |
| 112 | 112 | * @var int |
| 113 | 113 | */ |
| 114 | - protected $recurring_item = null; |
|
| 114 | + protected $recurring_item = null; |
|
| 115 | 115 | |
| 116 | - /** |
|
| 116 | + /** |
|
| 117 | 117 | * Stores an array of item totals. |
| 118 | - * |
|
| 119 | - * e.g $totals['discount'] = array( |
|
| 120 | - * 'initial' => 10, |
|
| 121 | - * 'recurring' => 10, |
|
| 122 | - * ) |
|
| 118 | + * |
|
| 119 | + * e.g $totals['discount'] = array( |
|
| 120 | + * 'initial' => 10, |
|
| 121 | + * 'recurring' => 10, |
|
| 122 | + * ) |
|
| 123 | 123 | * |
| 124 | 124 | * @var array |
| 125 | 125 | */ |
| 126 | - protected $totals = array(); |
|
| 126 | + protected $totals = array(); |
|
| 127 | 127 | |
| 128 | - /** |
|
| 128 | + /** |
|
| 129 | 129 | * Tax rate. |
| 130 | - * |
|
| 130 | + * |
|
| 131 | 131 | * @var float |
| 132 | 132 | */ |
| 133 | - protected $tax_rate = 0; |
|
| 133 | + protected $tax_rate = 0; |
|
| 134 | 134 | |
| 135 | - /** |
|
| 136 | - * Stores the status transition information. |
|
| 137 | - * |
|
| 138 | - * @since 1.0.19 |
|
| 139 | - * @var bool|array |
|
| 140 | - */ |
|
| 141 | - protected $status_transition = false; |
|
| 135 | + /** |
|
| 136 | + * Stores the status transition information. |
|
| 137 | + * |
|
| 138 | + * @since 1.0.19 |
|
| 139 | + * @var bool|array |
|
| 140 | + */ |
|
| 141 | + protected $status_transition = false; |
|
| 142 | 142 | |
| 143 | 143 | /** |
| 144 | - * Get the invoice if ID is passed, otherwise the invoice is new and empty. |
|
| 145 | - * |
|
| 146 | - * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object to read. |
|
| 147 | - */ |
|
| 144 | + * Get the invoice if ID is passed, otherwise the invoice is new and empty. |
|
| 145 | + * |
|
| 146 | + * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object to read. |
|
| 147 | + */ |
|
| 148 | 148 | public function __construct( $invoice = 0 ) { |
| 149 | 149 | |
| 150 | 150 | parent::__construct( $invoice ); |
| 151 | 151 | |
| 152 | - if ( ! empty( $invoice ) && is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( (int) $invoice ) ) ) { |
|
| 153 | - $this->set_id( (int) $invoice ); |
|
| 154 | - } elseif ( $invoice instanceof self ) { |
|
| 155 | - $this->set_id( $invoice->get_id() ); |
|
| 156 | - } elseif ( ! empty( $invoice->ID ) ) { |
|
| 157 | - $this->set_id( $invoice->ID ); |
|
| 158 | - } elseif ( is_array( $invoice ) ) { |
|
| 159 | - $this->set_props( $invoice ); |
|
| 160 | - |
|
| 161 | - if ( isset( $invoice['ID'] ) ) { |
|
| 162 | - $this->set_id( $invoice['ID'] ); |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'key' ) ) { |
|
| 166 | - $this->set_id( $invoice_id ); |
|
| 167 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'number' ) ) { |
|
| 168 | - $this->set_id( $invoice_id ); |
|
| 169 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'transaction_id' ) ) { |
|
| 170 | - $this->set_id( $invoice_id ); |
|
| 171 | - } else { |
|
| 172 | - $this->set_object_read( true ); |
|
| 173 | - } |
|
| 152 | + if ( ! empty( $invoice ) && is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( (int) $invoice ) ) ) { |
|
| 153 | + $this->set_id( (int) $invoice ); |
|
| 154 | + } elseif ( $invoice instanceof self ) { |
|
| 155 | + $this->set_id( $invoice->get_id() ); |
|
| 156 | + } elseif ( ! empty( $invoice->ID ) ) { |
|
| 157 | + $this->set_id( $invoice->ID ); |
|
| 158 | + } elseif ( is_array( $invoice ) ) { |
|
| 159 | + $this->set_props( $invoice ); |
|
| 160 | + |
|
| 161 | + if ( isset( $invoice['ID'] ) ) { |
|
| 162 | + $this->set_id( $invoice['ID'] ); |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'key' ) ) { |
|
| 166 | + $this->set_id( $invoice_id ); |
|
| 167 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'number' ) ) { |
|
| 168 | + $this->set_id( $invoice_id ); |
|
| 169 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'transaction_id' ) ) { |
|
| 170 | + $this->set_id( $invoice_id ); |
|
| 171 | + } else { |
|
| 172 | + $this->set_object_read( true ); |
|
| 173 | + } |
|
| 174 | 174 | |
| 175 | 175 | // Load the datastore. |
| 176 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 176 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 177 | 177 | |
| 178 | - if ( $this->get_id() > 0 ) { |
|
| 178 | + if ( $this->get_id() > 0 ) { |
|
| 179 | 179 | $this->post = get_post( $this->get_id() ); |
| 180 | 180 | $this->ID = $this->get_id(); |
| 181 | - $this->data_store->read( $this ); |
|
| 181 | + $this->data_store->read( $this ); |
|
| 182 | 182 | } |
| 183 | 183 | |
| 184 | 184 | } |
| 185 | 185 | |
| 186 | 186 | /** |
| 187 | - * Given an invoice key/number, it returns its id. |
|
| 188 | - * |
|
| 189 | - * |
|
| 190 | - * @static |
|
| 191 | - * @param string $value The invoice key or number |
|
| 192 | - * @param string $field Either key, transaction_id or number. |
|
| 193 | - * @since 1.0.15 |
|
| 194 | - * @return int |
|
| 195 | - */ |
|
| 196 | - public static function get_invoice_id_by_field( $value, $field = 'key' ) { |
|
| 187 | + * Given an invoice key/number, it returns its id. |
|
| 188 | + * |
|
| 189 | + * |
|
| 190 | + * @static |
|
| 191 | + * @param string $value The invoice key or number |
|
| 192 | + * @param string $field Either key, transaction_id or number. |
|
| 193 | + * @since 1.0.15 |
|
| 194 | + * @return int |
|
| 195 | + */ |
|
| 196 | + public static function get_invoice_id_by_field( $value, $field = 'key' ) { |
|
| 197 | 197 | global $wpdb; |
| 198 | 198 | |
| 199 | - // Trim the value. |
|
| 200 | - $value = trim( $value ); |
|
| 199 | + // Trim the value. |
|
| 200 | + $value = trim( $value ); |
|
| 201 | 201 | |
| 202 | - if ( empty( $value ) ) { |
|
| 203 | - return 0; |
|
| 204 | - } |
|
| 202 | + if ( empty( $value ) ) { |
|
| 203 | + return 0; |
|
| 204 | + } |
|
| 205 | 205 | |
| 206 | 206 | // Valid fields. |
| 207 | 207 | $fields = array( 'key', 'number', 'transaction_id' ); |
| 208 | 208 | |
| 209 | - // Ensure a field has been passed. |
|
| 210 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 211 | - return 0; |
|
| 212 | - } |
|
| 209 | + // Ensure a field has been passed. |
|
| 210 | + if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 211 | + return 0; |
|
| 212 | + } |
|
| 213 | 213 | |
| 214 | - // Maybe retrieve from the cache. |
|
| 215 | - $invoice_id = wp_cache_get( $value, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
| 216 | - if ( false !== $invoice_id ) { |
|
| 217 | - return $invoice_id; |
|
| 218 | - } |
|
| 214 | + // Maybe retrieve from the cache. |
|
| 215 | + $invoice_id = wp_cache_get( $value, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
| 216 | + if ( false !== $invoice_id ) { |
|
| 217 | + return $invoice_id; |
|
| 218 | + } |
|
| 219 | 219 | |
| 220 | 220 | // Fetch from the db. |
| 221 | 221 | $table = $wpdb->prefix . 'getpaid_invoices'; |
@@ -223,10 +223,10 @@ discard block |
||
| 223 | 223 | $wpdb->prepare( "SELECT `post_id` FROM $table WHERE `$field`=%s LIMIT 1", $value ) |
| 224 | 224 | ); |
| 225 | 225 | |
| 226 | - // Update the cache with our data |
|
| 227 | - wp_cache_set( $value, $invoice_id, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
| 226 | + // Update the cache with our data |
|
| 227 | + wp_cache_set( $value, $invoice_id, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
| 228 | 228 | |
| 229 | - return $invoice_id; |
|
| 229 | + return $invoice_id; |
|
| 230 | 230 | } |
| 231 | 231 | |
| 232 | 232 | /** |
@@ -252,83 +252,83 @@ discard block |
||
| 252 | 252 | */ |
| 253 | 253 | |
| 254 | 254 | /** |
| 255 | - * Get parent invoice ID. |
|
| 256 | - * |
|
| 257 | - * @since 1.0.19 |
|
| 258 | - * @param string $context View or edit context. |
|
| 259 | - * @return int |
|
| 260 | - */ |
|
| 261 | - public function get_parent_id( $context = 'view' ) { |
|
| 262 | - return (int) $this->get_prop( 'parent_id', $context ); |
|
| 255 | + * Get parent invoice ID. |
|
| 256 | + * |
|
| 257 | + * @since 1.0.19 |
|
| 258 | + * @param string $context View or edit context. |
|
| 259 | + * @return int |
|
| 260 | + */ |
|
| 261 | + public function get_parent_id( $context = 'view' ) { |
|
| 262 | + return (int) $this->get_prop( 'parent_id', $context ); |
|
| 263 | 263 | } |
| 264 | 264 | |
| 265 | 265 | /** |
| 266 | - * Get parent invoice. |
|
| 267 | - * |
|
| 268 | - * @since 1.0.19 |
|
| 269 | - * @return WPInv_Invoice |
|
| 270 | - */ |
|
| 266 | + * Get parent invoice. |
|
| 267 | + * |
|
| 268 | + * @since 1.0.19 |
|
| 269 | + * @return WPInv_Invoice |
|
| 270 | + */ |
|
| 271 | 271 | public function get_parent_payment() { |
| 272 | 272 | return new WPInv_Invoice( $this->get_parent_id() ); |
| 273 | 273 | } |
| 274 | 274 | |
| 275 | 275 | /** |
| 276 | - * Alias for self::get_parent_payment(). |
|
| 277 | - * |
|
| 278 | - * @since 1.0.19 |
|
| 279 | - * @return WPInv_Invoice |
|
| 280 | - */ |
|
| 276 | + * Alias for self::get_parent_payment(). |
|
| 277 | + * |
|
| 278 | + * @since 1.0.19 |
|
| 279 | + * @return WPInv_Invoice |
|
| 280 | + */ |
|
| 281 | 281 | public function get_parent() { |
| 282 | 282 | return $this->get_parent_payment(); |
| 283 | 283 | } |
| 284 | 284 | |
| 285 | 285 | /** |
| 286 | - * Get invoice status. |
|
| 287 | - * |
|
| 288 | - * @since 1.0.19 |
|
| 289 | - * @param string $context View or edit context. |
|
| 290 | - * @return string |
|
| 291 | - */ |
|
| 292 | - public function get_status( $context = 'view' ) { |
|
| 293 | - return $this->get_prop( 'status', $context ); |
|
| 294 | - } |
|
| 286 | + * Get invoice status. |
|
| 287 | + * |
|
| 288 | + * @since 1.0.19 |
|
| 289 | + * @param string $context View or edit context. |
|
| 290 | + * @return string |
|
| 291 | + */ |
|
| 292 | + public function get_status( $context = 'view' ) { |
|
| 293 | + return $this->get_prop( 'status', $context ); |
|
| 294 | + } |
|
| 295 | 295 | |
| 296 | - /** |
|
| 297 | - * Retrieves an array of possible invoice statuses. |
|
| 298 | - * |
|
| 299 | - * @since 1.0.19 |
|
| 300 | - * @return array |
|
| 301 | - */ |
|
| 302 | - public function get_all_statuses() { |
|
| 303 | - return wpinv_get_invoice_statuses( true, true, $this ); |
|
| 304 | - } |
|
| 305 | - |
|
| 306 | - /** |
|
| 307 | - * Get invoice status nice name. |
|
| 308 | - * |
|
| 309 | - * @since 1.0.19 |
|
| 310 | - * @return string |
|
| 311 | - */ |
|
| 296 | + /** |
|
| 297 | + * Retrieves an array of possible invoice statuses. |
|
| 298 | + * |
|
| 299 | + * @since 1.0.19 |
|
| 300 | + * @return array |
|
| 301 | + */ |
|
| 302 | + public function get_all_statuses() { |
|
| 303 | + return wpinv_get_invoice_statuses( true, true, $this ); |
|
| 304 | + } |
|
| 305 | + |
|
| 306 | + /** |
|
| 307 | + * Get invoice status nice name. |
|
| 308 | + * |
|
| 309 | + * @since 1.0.19 |
|
| 310 | + * @return string |
|
| 311 | + */ |
|
| 312 | 312 | public function get_status_nicename() { |
| 313 | - $statuses = $this->get_all_statuses(); |
|
| 313 | + $statuses = $this->get_all_statuses(); |
|
| 314 | 314 | |
| 315 | 315 | $status = isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : $this->get_status(); |
| 316 | 316 | |
| 317 | 317 | return apply_filters( 'wpinv_get_invoice_status_nicename', $status, $this ); |
| 318 | 318 | } |
| 319 | 319 | |
| 320 | - /** |
|
| 321 | - * Retrieves the invoice status class |
|
| 322 | - * |
|
| 323 | - * @since 1.0.19 |
|
| 324 | - * @return string |
|
| 325 | - */ |
|
| 326 | - public function get_status_class() { |
|
| 327 | - $statuses = getpaid_get_invoice_status_classes(); |
|
| 328 | - return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
| 329 | - } |
|
| 320 | + /** |
|
| 321 | + * Retrieves the invoice status class |
|
| 322 | + * |
|
| 323 | + * @since 1.0.19 |
|
| 324 | + * @return string |
|
| 325 | + */ |
|
| 326 | + public function get_status_class() { |
|
| 327 | + $statuses = getpaid_get_invoice_status_classes(); |
|
| 328 | + return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
| 329 | + } |
|
| 330 | 330 | |
| 331 | - /** |
|
| 331 | + /** |
|
| 332 | 332 | * Retrieves the invoice status label html |
| 333 | 333 | * |
| 334 | 334 | * @since 1.0.0 |
@@ -336,263 +336,263 @@ discard block |
||
| 336 | 336 | */ |
| 337 | 337 | public function get_status_label_html() { |
| 338 | 338 | |
| 339 | - $status_label = sanitize_text_field( $this->get_status_nicename() ); |
|
| 340 | - $status = sanitize_html_class( $this->get_status() ); |
|
| 341 | - $class = esc_attr( $this->get_status_class() ); |
|
| 339 | + $status_label = sanitize_text_field( $this->get_status_nicename() ); |
|
| 340 | + $status = sanitize_html_class( $this->get_status() ); |
|
| 341 | + $class = esc_attr( $this->get_status_class() ); |
|
| 342 | 342 | |
| 343 | - return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
| 344 | - } |
|
| 343 | + return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
| 344 | + } |
|
| 345 | 345 | |
| 346 | 346 | /** |
| 347 | - * Get plugin version when the invoice was created. |
|
| 348 | - * |
|
| 349 | - * @since 1.0.19 |
|
| 350 | - * @param string $context View or edit context. |
|
| 351 | - * @return string |
|
| 352 | - */ |
|
| 353 | - public function get_version( $context = 'view' ) { |
|
| 354 | - return $this->get_prop( 'version', $context ); |
|
| 355 | - } |
|
| 347 | + * Get plugin version when the invoice was created. |
|
| 348 | + * |
|
| 349 | + * @since 1.0.19 |
|
| 350 | + * @param string $context View or edit context. |
|
| 351 | + * @return string |
|
| 352 | + */ |
|
| 353 | + public function get_version( $context = 'view' ) { |
|
| 354 | + return $this->get_prop( 'version', $context ); |
|
| 355 | + } |
|
| 356 | 356 | |
| 357 | - /** |
|
| 358 | - * @deprecated |
|
| 359 | - */ |
|
| 360 | - public function get_invoice_date( $format = true ) { |
|
| 361 | - $date = getpaid_format_date( $this->get_date_completed() ); |
|
| 362 | - $date = empty( $date ) ? $this->get_date_created() : $this->get_date_completed(); |
|
| 363 | - $formatted = getpaid_format_date( $date ); |
|
| 357 | + /** |
|
| 358 | + * @deprecated |
|
| 359 | + */ |
|
| 360 | + public function get_invoice_date( $format = true ) { |
|
| 361 | + $date = getpaid_format_date( $this->get_date_completed() ); |
|
| 362 | + $date = empty( $date ) ? $this->get_date_created() : $this->get_date_completed(); |
|
| 363 | + $formatted = getpaid_format_date( $date ); |
|
| 364 | 364 | |
| 365 | - if ( $format ) { |
|
| 366 | - return $formatted; |
|
| 367 | - } |
|
| 365 | + if ( $format ) { |
|
| 366 | + return $formatted; |
|
| 367 | + } |
|
| 368 | 368 | |
| 369 | - return empty( $formatted ) ? '' : $date; |
|
| 369 | + return empty( $formatted ) ? '' : $date; |
|
| 370 | 370 | |
| 371 | 371 | } |
| 372 | 372 | |
| 373 | 373 | /** |
| 374 | - * Get date when the invoice was created. |
|
| 375 | - * |
|
| 376 | - * @since 1.0.19 |
|
| 377 | - * @param string $context View or edit context. |
|
| 378 | - * @return string |
|
| 379 | - */ |
|
| 380 | - public function get_date_created( $context = 'view' ) { |
|
| 381 | - return $this->get_prop( 'date_created', $context ); |
|
| 382 | - } |
|
| 374 | + * Get date when the invoice was created. |
|
| 375 | + * |
|
| 376 | + * @since 1.0.19 |
|
| 377 | + * @param string $context View or edit context. |
|
| 378 | + * @return string |
|
| 379 | + */ |
|
| 380 | + public function get_date_created( $context = 'view' ) { |
|
| 381 | + return $this->get_prop( 'date_created', $context ); |
|
| 382 | + } |
|
| 383 | 383 | |
| 384 | - /** |
|
| 385 | - * Alias for self::get_date_created(). |
|
| 386 | - * |
|
| 387 | - * @since 1.0.19 |
|
| 388 | - * @param string $context View or edit context. |
|
| 389 | - * @return string |
|
| 390 | - */ |
|
| 391 | - public function get_created_date( $context = 'view' ) { |
|
| 392 | - return $this->get_date_created( $context ); |
|
| 393 | - } |
|
| 394 | - |
|
| 395 | - /** |
|
| 396 | - * Get GMT date when the invoice was created. |
|
| 397 | - * |
|
| 398 | - * @since 1.0.19 |
|
| 399 | - * @param string $context View or edit context. |
|
| 400 | - * @return string |
|
| 401 | - */ |
|
| 402 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 384 | + /** |
|
| 385 | + * Alias for self::get_date_created(). |
|
| 386 | + * |
|
| 387 | + * @since 1.0.19 |
|
| 388 | + * @param string $context View or edit context. |
|
| 389 | + * @return string |
|
| 390 | + */ |
|
| 391 | + public function get_created_date( $context = 'view' ) { |
|
| 392 | + return $this->get_date_created( $context ); |
|
| 393 | + } |
|
| 394 | + |
|
| 395 | + /** |
|
| 396 | + * Get GMT date when the invoice was created. |
|
| 397 | + * |
|
| 398 | + * @since 1.0.19 |
|
| 399 | + * @param string $context View or edit context. |
|
| 400 | + * @return string |
|
| 401 | + */ |
|
| 402 | + public function get_date_created_gmt( $context = 'view' ) { |
|
| 403 | 403 | $date = $this->get_date_created( $context ); |
| 404 | 404 | |
| 405 | 405 | if ( $date ) { |
| 406 | 406 | $date = get_gmt_from_date( $date ); |
| 407 | 407 | } |
| 408 | - return $date; |
|
| 408 | + return $date; |
|
| 409 | 409 | } |
| 410 | 410 | |
| 411 | 411 | /** |
| 412 | - * Get date when the invoice was last modified. |
|
| 413 | - * |
|
| 414 | - * @since 1.0.19 |
|
| 415 | - * @param string $context View or edit context. |
|
| 416 | - * @return string |
|
| 417 | - */ |
|
| 418 | - public function get_date_modified( $context = 'view' ) { |
|
| 419 | - return $this->get_prop( 'date_modified', $context ); |
|
| 420 | - } |
|
| 412 | + * Get date when the invoice was last modified. |
|
| 413 | + * |
|
| 414 | + * @since 1.0.19 |
|
| 415 | + * @param string $context View or edit context. |
|
| 416 | + * @return string |
|
| 417 | + */ |
|
| 418 | + public function get_date_modified( $context = 'view' ) { |
|
| 419 | + return $this->get_prop( 'date_modified', $context ); |
|
| 420 | + } |
|
| 421 | 421 | |
| 422 | - /** |
|
| 423 | - * Alias for self::get_date_modified(). |
|
| 424 | - * |
|
| 425 | - * @since 1.0.19 |
|
| 426 | - * @param string $context View or edit context. |
|
| 427 | - * @return string |
|
| 428 | - */ |
|
| 429 | - public function get_modified_date( $context = 'view' ) { |
|
| 430 | - return $this->get_date_modified( $context ); |
|
| 422 | + /** |
|
| 423 | + * Alias for self::get_date_modified(). |
|
| 424 | + * |
|
| 425 | + * @since 1.0.19 |
|
| 426 | + * @param string $context View or edit context. |
|
| 427 | + * @return string |
|
| 428 | + */ |
|
| 429 | + public function get_modified_date( $context = 'view' ) { |
|
| 430 | + return $this->get_date_modified( $context ); |
|
| 431 | 431 | } |
| 432 | 432 | |
| 433 | 433 | /** |
| 434 | - * Get GMT date when the invoice was last modified. |
|
| 435 | - * |
|
| 436 | - * @since 1.0.19 |
|
| 437 | - * @param string $context View or edit context. |
|
| 438 | - * @return string |
|
| 439 | - */ |
|
| 440 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
| 434 | + * Get GMT date when the invoice was last modified. |
|
| 435 | + * |
|
| 436 | + * @since 1.0.19 |
|
| 437 | + * @param string $context View or edit context. |
|
| 438 | + * @return string |
|
| 439 | + */ |
|
| 440 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
| 441 | 441 | $date = $this->get_date_modified( $context ); |
| 442 | 442 | |
| 443 | 443 | if ( $date ) { |
| 444 | 444 | $date = get_gmt_from_date( $date ); |
| 445 | 445 | } |
| 446 | - return $date; |
|
| 446 | + return $date; |
|
| 447 | 447 | } |
| 448 | 448 | |
| 449 | 449 | /** |
| 450 | - * Get the invoice due date. |
|
| 451 | - * |
|
| 452 | - * @since 1.0.19 |
|
| 453 | - * @param string $context View or edit context. |
|
| 454 | - * @return string |
|
| 455 | - */ |
|
| 456 | - public function get_due_date( $context = 'view' ) { |
|
| 457 | - return $this->get_prop( 'due_date', $context ); |
|
| 450 | + * Get the invoice due date. |
|
| 451 | + * |
|
| 452 | + * @since 1.0.19 |
|
| 453 | + * @param string $context View or edit context. |
|
| 454 | + * @return string |
|
| 455 | + */ |
|
| 456 | + public function get_due_date( $context = 'view' ) { |
|
| 457 | + return $this->get_prop( 'due_date', $context ); |
|
| 458 | 458 | } |
| 459 | 459 | |
| 460 | 460 | /** |
| 461 | - * Alias for self::get_due_date(). |
|
| 462 | - * |
|
| 463 | - * @since 1.0.19 |
|
| 464 | - * @param string $context View or edit context. |
|
| 465 | - * @return string |
|
| 466 | - */ |
|
| 467 | - public function get_date_due( $context = 'view' ) { |
|
| 468 | - return $this->get_due_date( $context ); |
|
| 461 | + * Alias for self::get_due_date(). |
|
| 462 | + * |
|
| 463 | + * @since 1.0.19 |
|
| 464 | + * @param string $context View or edit context. |
|
| 465 | + * @return string |
|
| 466 | + */ |
|
| 467 | + public function get_date_due( $context = 'view' ) { |
|
| 468 | + return $this->get_due_date( $context ); |
|
| 469 | 469 | } |
| 470 | 470 | |
| 471 | 471 | /** |
| 472 | - * Get the invoice GMT due date. |
|
| 473 | - * |
|
| 474 | - * @since 1.0.19 |
|
| 475 | - * @param string $context View or edit context. |
|
| 476 | - * @return string |
|
| 477 | - */ |
|
| 478 | - public function get_due_date_gmt( $context = 'view' ) { |
|
| 472 | + * Get the invoice GMT due date. |
|
| 473 | + * |
|
| 474 | + * @since 1.0.19 |
|
| 475 | + * @param string $context View or edit context. |
|
| 476 | + * @return string |
|
| 477 | + */ |
|
| 478 | + public function get_due_date_gmt( $context = 'view' ) { |
|
| 479 | 479 | $date = $this->get_due_date( $context ); |
| 480 | 480 | |
| 481 | 481 | if ( $date ) { |
| 482 | 482 | $date = get_gmt_from_date( $date ); |
| 483 | 483 | } |
| 484 | - return $date; |
|
| 484 | + return $date; |
|
| 485 | 485 | } |
| 486 | 486 | |
| 487 | 487 | /** |
| 488 | - * Alias for self::get_due_date_gmt(). |
|
| 489 | - * |
|
| 490 | - * @since 1.0.19 |
|
| 491 | - * @param string $context View or edit context. |
|
| 492 | - * @return string |
|
| 493 | - */ |
|
| 494 | - public function get_gmt_date_due( $context = 'view' ) { |
|
| 495 | - return $this->get_due_date_gmt( $context ); |
|
| 488 | + * Alias for self::get_due_date_gmt(). |
|
| 489 | + * |
|
| 490 | + * @since 1.0.19 |
|
| 491 | + * @param string $context View or edit context. |
|
| 492 | + * @return string |
|
| 493 | + */ |
|
| 494 | + public function get_gmt_date_due( $context = 'view' ) { |
|
| 495 | + return $this->get_due_date_gmt( $context ); |
|
| 496 | 496 | } |
| 497 | 497 | |
| 498 | 498 | /** |
| 499 | - * Get date when the invoice was completed. |
|
| 500 | - * |
|
| 501 | - * @since 1.0.19 |
|
| 502 | - * @param string $context View or edit context. |
|
| 503 | - * @return string |
|
| 504 | - */ |
|
| 505 | - public function get_completed_date( $context = 'view' ) { |
|
| 506 | - return $this->get_prop( 'completed_date', $context ); |
|
| 499 | + * Get date when the invoice was completed. |
|
| 500 | + * |
|
| 501 | + * @since 1.0.19 |
|
| 502 | + * @param string $context View or edit context. |
|
| 503 | + * @return string |
|
| 504 | + */ |
|
| 505 | + public function get_completed_date( $context = 'view' ) { |
|
| 506 | + return $this->get_prop( 'completed_date', $context ); |
|
| 507 | 507 | } |
| 508 | 508 | |
| 509 | 509 | /** |
| 510 | - * Alias for self::get_completed_date(). |
|
| 511 | - * |
|
| 512 | - * @since 1.0.19 |
|
| 513 | - * @param string $context View or edit context. |
|
| 514 | - * @return string |
|
| 515 | - */ |
|
| 516 | - public function get_date_completed( $context = 'view' ) { |
|
| 517 | - return $this->get_completed_date( $context ); |
|
| 510 | + * Alias for self::get_completed_date(). |
|
| 511 | + * |
|
| 512 | + * @since 1.0.19 |
|
| 513 | + * @param string $context View or edit context. |
|
| 514 | + * @return string |
|
| 515 | + */ |
|
| 516 | + public function get_date_completed( $context = 'view' ) { |
|
| 517 | + return $this->get_completed_date( $context ); |
|
| 518 | 518 | } |
| 519 | 519 | |
| 520 | 520 | /** |
| 521 | - * Get GMT date when the invoice was was completed. |
|
| 522 | - * |
|
| 523 | - * @since 1.0.19 |
|
| 524 | - * @param string $context View or edit context. |
|
| 525 | - * @return string |
|
| 526 | - */ |
|
| 527 | - public function get_completed_date_gmt( $context = 'view' ) { |
|
| 521 | + * Get GMT date when the invoice was was completed. |
|
| 522 | + * |
|
| 523 | + * @since 1.0.19 |
|
| 524 | + * @param string $context View or edit context. |
|
| 525 | + * @return string |
|
| 526 | + */ |
|
| 527 | + public function get_completed_date_gmt( $context = 'view' ) { |
|
| 528 | 528 | $date = $this->get_completed_date( $context ); |
| 529 | 529 | |
| 530 | 530 | if ( $date ) { |
| 531 | 531 | $date = get_gmt_from_date( $date ); |
| 532 | 532 | } |
| 533 | - return $date; |
|
| 533 | + return $date; |
|
| 534 | 534 | } |
| 535 | 535 | |
| 536 | 536 | /** |
| 537 | - * Alias for self::get_completed_date_gmt(). |
|
| 538 | - * |
|
| 539 | - * @since 1.0.19 |
|
| 540 | - * @param string $context View or edit context. |
|
| 541 | - * @return string |
|
| 542 | - */ |
|
| 543 | - public function get_gmt_completed_date( $context = 'view' ) { |
|
| 544 | - return $this->get_completed_date_gmt( $context ); |
|
| 537 | + * Alias for self::get_completed_date_gmt(). |
|
| 538 | + * |
|
| 539 | + * @since 1.0.19 |
|
| 540 | + * @param string $context View or edit context. |
|
| 541 | + * @return string |
|
| 542 | + */ |
|
| 543 | + public function get_gmt_completed_date( $context = 'view' ) { |
|
| 544 | + return $this->get_completed_date_gmt( $context ); |
|
| 545 | 545 | } |
| 546 | 546 | |
| 547 | 547 | /** |
| 548 | - * Get the invoice number. |
|
| 549 | - * |
|
| 550 | - * @since 1.0.19 |
|
| 551 | - * @param string $context View or edit context. |
|
| 552 | - * @return string |
|
| 553 | - */ |
|
| 554 | - public function get_number( $context = 'view' ) { |
|
| 555 | - $number = $this->get_prop( 'number', $context ); |
|
| 548 | + * Get the invoice number. |
|
| 549 | + * |
|
| 550 | + * @since 1.0.19 |
|
| 551 | + * @param string $context View or edit context. |
|
| 552 | + * @return string |
|
| 553 | + */ |
|
| 554 | + public function get_number( $context = 'view' ) { |
|
| 555 | + $number = $this->get_prop( 'number', $context ); |
|
| 556 | 556 | |
| 557 | - if ( empty( $number ) ) { |
|
| 558 | - $number = $this->generate_number(); |
|
| 559 | - $this->set_number( $this->generate_number() ); |
|
| 560 | - } |
|
| 557 | + if ( empty( $number ) ) { |
|
| 558 | + $number = $this->generate_number(); |
|
| 559 | + $this->set_number( $this->generate_number() ); |
|
| 560 | + } |
|
| 561 | 561 | |
| 562 | - return $number; |
|
| 562 | + return $number; |
|
| 563 | 563 | } |
| 564 | 564 | |
| 565 | - /** |
|
| 566 | - * Set the invoice number. |
|
| 567 | - * |
|
| 568 | - * @since 1.0.19 |
|
| 569 | - */ |
|
| 570 | - public function maybe_set_number() { |
|
| 565 | + /** |
|
| 566 | + * Set the invoice number. |
|
| 567 | + * |
|
| 568 | + * @since 1.0.19 |
|
| 569 | + */ |
|
| 570 | + public function maybe_set_number() { |
|
| 571 | 571 | $number = $this->get_number(); |
| 572 | 572 | |
| 573 | 573 | if ( empty( $number ) || $this->get_id() == $number ) { |
| 574 | - $this->set_number( $this->generate_number() ); |
|
| 574 | + $this->set_number( $this->generate_number() ); |
|
| 575 | 575 | } |
| 576 | 576 | |
| 577 | - } |
|
| 577 | + } |
|
| 578 | 578 | |
| 579 | 579 | /** |
| 580 | - * Get the invoice key. |
|
| 581 | - * |
|
| 582 | - * @since 1.0.19 |
|
| 583 | - * @param string $context View or edit context. |
|
| 584 | - * @return string |
|
| 585 | - */ |
|
| 586 | - public function get_key( $context = 'view' ) { |
|
| 580 | + * Get the invoice key. |
|
| 581 | + * |
|
| 582 | + * @since 1.0.19 |
|
| 583 | + * @param string $context View or edit context. |
|
| 584 | + * @return string |
|
| 585 | + */ |
|
| 586 | + public function get_key( $context = 'view' ) { |
|
| 587 | 587 | return $this->get_prop( 'key', $context ); |
| 588 | - } |
|
| 589 | - |
|
| 590 | - /** |
|
| 591 | - * Set the invoice key. |
|
| 592 | - * |
|
| 593 | - * @since 1.0.19 |
|
| 594 | - */ |
|
| 595 | - public function maybe_set_key() { |
|
| 588 | + } |
|
| 589 | + |
|
| 590 | + /** |
|
| 591 | + * Set the invoice key. |
|
| 592 | + * |
|
| 593 | + * @since 1.0.19 |
|
| 594 | + */ |
|
| 595 | + public function maybe_set_key() { |
|
| 596 | 596 | $key = $this->get_key(); |
| 597 | 597 | |
| 598 | 598 | if ( empty( $key ) ) { |
@@ -603,140 +603,140 @@ discard block |
||
| 603 | 603 | } |
| 604 | 604 | |
| 605 | 605 | /** |
| 606 | - * Get the invoice type. |
|
| 607 | - * |
|
| 608 | - * @since 1.0.19 |
|
| 609 | - * @param string $context View or edit context. |
|
| 610 | - * @return string |
|
| 611 | - */ |
|
| 612 | - public function get_type( $context = 'view' ) { |
|
| 606 | + * Get the invoice type. |
|
| 607 | + * |
|
| 608 | + * @since 1.0.19 |
|
| 609 | + * @param string $context View or edit context. |
|
| 610 | + * @return string |
|
| 611 | + */ |
|
| 612 | + public function get_type( $context = 'view' ) { |
|
| 613 | 613 | return $this->get_prop( 'type', $context ); |
| 614 | - } |
|
| 615 | - |
|
| 616 | - /** |
|
| 617 | - * Returns the post type name. |
|
| 618 | - * |
|
| 619 | - * @since 1.0.19 |
|
| 620 | - * @return string |
|
| 621 | - */ |
|
| 622 | - public function get_invoice_quote_type() { |
|
| 614 | + } |
|
| 615 | + |
|
| 616 | + /** |
|
| 617 | + * Returns the post type name. |
|
| 618 | + * |
|
| 619 | + * @since 1.0.19 |
|
| 620 | + * @return string |
|
| 621 | + */ |
|
| 622 | + public function get_invoice_quote_type() { |
|
| 623 | 623 | return getpaid_get_post_type_label( $this->get_post_type(), false ); |
| 624 | 624 | } |
| 625 | 625 | |
| 626 | 626 | /** |
| 627 | - * Get the invoice post type label. |
|
| 628 | - * |
|
| 629 | - * @since 1.0.19 |
|
| 630 | - * @param string $context View or edit context. |
|
| 631 | - * @return string |
|
| 632 | - */ |
|
| 633 | - public function get_label( $context = 'view' ) { |
|
| 627 | + * Get the invoice post type label. |
|
| 628 | + * |
|
| 629 | + * @since 1.0.19 |
|
| 630 | + * @param string $context View or edit context. |
|
| 631 | + * @return string |
|
| 632 | + */ |
|
| 633 | + public function get_label( $context = 'view' ) { |
|
| 634 | 634 | return getpaid_get_post_type_label( $this->get_post_type( $context ), false ); |
| 635 | - } |
|
| 636 | - |
|
| 637 | - /** |
|
| 638 | - * Get the invoice post type. |
|
| 639 | - * |
|
| 640 | - * @since 1.0.19 |
|
| 641 | - * @param string $context View or edit context. |
|
| 642 | - * @return string |
|
| 643 | - */ |
|
| 644 | - public function get_post_type( $context = 'view' ) { |
|
| 635 | + } |
|
| 636 | + |
|
| 637 | + /** |
|
| 638 | + * Get the invoice post type. |
|
| 639 | + * |
|
| 640 | + * @since 1.0.19 |
|
| 641 | + * @param string $context View or edit context. |
|
| 642 | + * @return string |
|
| 643 | + */ |
|
| 644 | + public function get_post_type( $context = 'view' ) { |
|
| 645 | 645 | return $this->get_prop( 'post_type', $context ); |
| 646 | 646 | } |
| 647 | 647 | |
| 648 | 648 | /** |
| 649 | - * Get the invoice mode. |
|
| 650 | - * |
|
| 651 | - * @since 1.0.19 |
|
| 652 | - * @param string $context View or edit context. |
|
| 653 | - * @return string |
|
| 654 | - */ |
|
| 655 | - public function get_mode( $context = 'view' ) { |
|
| 649 | + * Get the invoice mode. |
|
| 650 | + * |
|
| 651 | + * @since 1.0.19 |
|
| 652 | + * @param string $context View or edit context. |
|
| 653 | + * @return string |
|
| 654 | + */ |
|
| 655 | + public function get_mode( $context = 'view' ) { |
|
| 656 | 656 | return $this->get_prop( 'mode', $context ); |
| 657 | 657 | } |
| 658 | 658 | |
| 659 | 659 | /** |
| 660 | - * Get the invoice path. |
|
| 661 | - * |
|
| 662 | - * @since 1.0.19 |
|
| 663 | - * @param string $context View or edit context. |
|
| 664 | - * @return string |
|
| 665 | - */ |
|
| 666 | - public function get_path( $context = 'view' ) { |
|
| 660 | + * Get the invoice path. |
|
| 661 | + * |
|
| 662 | + * @since 1.0.19 |
|
| 663 | + * @param string $context View or edit context. |
|
| 664 | + * @return string |
|
| 665 | + */ |
|
| 666 | + public function get_path( $context = 'view' ) { |
|
| 667 | 667 | $path = $this->get_prop( 'path', $context ); |
| 668 | - $prefix = $this->get_type(); |
|
| 668 | + $prefix = $this->get_type(); |
|
| 669 | 669 | |
| 670 | - if ( 0 !== strpos( $path, $prefix ) ) { |
|
| 671 | - $path = sanitize_title( $prefix . '-' . $this->get_id() ); |
|
| 672 | - $this->set_path( $path ); |
|
| 673 | - } |
|
| 670 | + if ( 0 !== strpos( $path, $prefix ) ) { |
|
| 671 | + $path = sanitize_title( $prefix . '-' . $this->get_id() ); |
|
| 672 | + $this->set_path( $path ); |
|
| 673 | + } |
|
| 674 | 674 | |
| 675 | - return $path; |
|
| 675 | + return $path; |
|
| 676 | 676 | } |
| 677 | 677 | |
| 678 | 678 | /** |
| 679 | - * Get the invoice name/title. |
|
| 680 | - * |
|
| 681 | - * @since 1.0.19 |
|
| 682 | - * @param string $context View or edit context. |
|
| 683 | - * @return string |
|
| 684 | - */ |
|
| 685 | - public function get_name( $context = 'view' ) { |
|
| 679 | + * Get the invoice name/title. |
|
| 680 | + * |
|
| 681 | + * @since 1.0.19 |
|
| 682 | + * @param string $context View or edit context. |
|
| 683 | + * @return string |
|
| 684 | + */ |
|
| 685 | + public function get_name( $context = 'view' ) { |
|
| 686 | 686 | return $this->get_prop( 'title', $context ); |
| 687 | 687 | } |
| 688 | 688 | |
| 689 | 689 | /** |
| 690 | - * Alias of self::get_name(). |
|
| 691 | - * |
|
| 692 | - * @since 1.0.19 |
|
| 693 | - * @param string $context View or edit context. |
|
| 694 | - * @return string |
|
| 695 | - */ |
|
| 696 | - public function get_title( $context = 'view' ) { |
|
| 697 | - return $this->get_name( $context ); |
|
| 690 | + * Alias of self::get_name(). |
|
| 691 | + * |
|
| 692 | + * @since 1.0.19 |
|
| 693 | + * @param string $context View or edit context. |
|
| 694 | + * @return string |
|
| 695 | + */ |
|
| 696 | + public function get_title( $context = 'view' ) { |
|
| 697 | + return $this->get_name( $context ); |
|
| 698 | 698 | } |
| 699 | 699 | |
| 700 | 700 | /** |
| 701 | - * Get the invoice description. |
|
| 702 | - * |
|
| 703 | - * @since 1.0.19 |
|
| 704 | - * @param string $context View or edit context. |
|
| 705 | - * @return string |
|
| 706 | - */ |
|
| 707 | - public function get_description( $context = 'view' ) { |
|
| 708 | - return $this->get_prop( 'description', $context ); |
|
| 701 | + * Get the invoice description. |
|
| 702 | + * |
|
| 703 | + * @since 1.0.19 |
|
| 704 | + * @param string $context View or edit context. |
|
| 705 | + * @return string |
|
| 706 | + */ |
|
| 707 | + public function get_description( $context = 'view' ) { |
|
| 708 | + return $this->get_prop( 'description', $context ); |
|
| 709 | 709 | } |
| 710 | 710 | |
| 711 | 711 | /** |
| 712 | - * Alias of self::get_description(). |
|
| 713 | - * |
|
| 714 | - * @since 1.0.19 |
|
| 715 | - * @param string $context View or edit context. |
|
| 716 | - * @return string |
|
| 717 | - */ |
|
| 718 | - public function get_excerpt( $context = 'view' ) { |
|
| 719 | - return $this->get_description( $context ); |
|
| 712 | + * Alias of self::get_description(). |
|
| 713 | + * |
|
| 714 | + * @since 1.0.19 |
|
| 715 | + * @param string $context View or edit context. |
|
| 716 | + * @return string |
|
| 717 | + */ |
|
| 718 | + public function get_excerpt( $context = 'view' ) { |
|
| 719 | + return $this->get_description( $context ); |
|
| 720 | 720 | } |
| 721 | 721 | |
| 722 | 722 | /** |
| 723 | - * Alias of self::get_description(). |
|
| 724 | - * |
|
| 725 | - * @since 1.0.19 |
|
| 726 | - * @param string $context View or edit context. |
|
| 727 | - * @return string |
|
| 728 | - */ |
|
| 729 | - public function get_summary( $context = 'view' ) { |
|
| 730 | - return $this->get_description( $context ); |
|
| 723 | + * Alias of self::get_description(). |
|
| 724 | + * |
|
| 725 | + * @since 1.0.19 |
|
| 726 | + * @param string $context View or edit context. |
|
| 727 | + * @return string |
|
| 728 | + */ |
|
| 729 | + public function get_summary( $context = 'view' ) { |
|
| 730 | + return $this->get_description( $context ); |
|
| 731 | 731 | } |
| 732 | 732 | |
| 733 | 733 | /** |
| 734 | - * Returns the user info. |
|
| 735 | - * |
|
| 736 | - * @since 1.0.19 |
|
| 734 | + * Returns the user info. |
|
| 735 | + * |
|
| 736 | + * @since 1.0.19 |
|
| 737 | 737 | * @param string $context View or edit context. |
| 738 | - * @return array |
|
| 739 | - */ |
|
| 738 | + * @return array |
|
| 739 | + */ |
|
| 740 | 740 | public function get_user_info( $context = 'view' ) { |
| 741 | 741 | |
| 742 | 742 | $user_info = array( |
@@ -751,683 +751,683 @@ discard block |
||
| 751 | 751 | 'state' => $this->get_state( $context ), |
| 752 | 752 | 'zip' => $this->get_zip( $context ), |
| 753 | 753 | 'company' => $this->get_company( $context ), |
| 754 | - 'company_id' => $this->get_company_id( $context ), |
|
| 754 | + 'company_id' => $this->get_company_id( $context ), |
|
| 755 | 755 | 'vat_number' => $this->get_vat_number( $context ), |
| 756 | 756 | 'discount' => $this->get_discount_code( $context ), |
| 757 | - ); |
|
| 757 | + ); |
|
| 758 | 758 | |
| 759 | - return apply_filters( 'wpinv_user_info', $user_info, $this->get_id(), $this ); |
|
| 759 | + return apply_filters( 'wpinv_user_info', $user_info, $this->get_id(), $this ); |
|
| 760 | 760 | |
| 761 | 761 | } |
| 762 | 762 | |
| 763 | 763 | /** |
| 764 | - * Get the customer id. |
|
| 765 | - * |
|
| 766 | - * @since 1.0.19 |
|
| 767 | - * @param string $context View or edit context. |
|
| 768 | - * @return int |
|
| 769 | - */ |
|
| 770 | - public function get_author( $context = 'view' ) { |
|
| 771 | - return (int) $this->get_prop( 'author', $context ); |
|
| 764 | + * Get the customer id. |
|
| 765 | + * |
|
| 766 | + * @since 1.0.19 |
|
| 767 | + * @param string $context View or edit context. |
|
| 768 | + * @return int |
|
| 769 | + */ |
|
| 770 | + public function get_author( $context = 'view' ) { |
|
| 771 | + return (int) $this->get_prop( 'author', $context ); |
|
| 772 | 772 | } |
| 773 | 773 | |
| 774 | 774 | /** |
| 775 | - * Alias of self::get_author(). |
|
| 776 | - * |
|
| 777 | - * @since 1.0.19 |
|
| 778 | - * @param string $context View or edit context. |
|
| 779 | - * @return int |
|
| 780 | - */ |
|
| 781 | - public function get_user_id( $context = 'view' ) { |
|
| 782 | - return $this->get_author( $context ); |
|
| 775 | + * Alias of self::get_author(). |
|
| 776 | + * |
|
| 777 | + * @since 1.0.19 |
|
| 778 | + * @param string $context View or edit context. |
|
| 779 | + * @return int |
|
| 780 | + */ |
|
| 781 | + public function get_user_id( $context = 'view' ) { |
|
| 782 | + return $this->get_author( $context ); |
|
| 783 | 783 | } |
| 784 | 784 | |
| 785 | - /** |
|
| 786 | - * Alias of self::get_author(). |
|
| 787 | - * |
|
| 788 | - * @since 1.0.19 |
|
| 789 | - * @param string $context View or edit context. |
|
| 790 | - * @return int |
|
| 791 | - */ |
|
| 792 | - public function get_customer_id( $context = 'view' ) { |
|
| 793 | - return $this->get_author( $context ); |
|
| 785 | + /** |
|
| 786 | + * Alias of self::get_author(). |
|
| 787 | + * |
|
| 788 | + * @since 1.0.19 |
|
| 789 | + * @param string $context View or edit context. |
|
| 790 | + * @return int |
|
| 791 | + */ |
|
| 792 | + public function get_customer_id( $context = 'view' ) { |
|
| 793 | + return $this->get_author( $context ); |
|
| 794 | 794 | } |
| 795 | 795 | |
| 796 | 796 | /** |
| 797 | - * Get the customer's ip. |
|
| 798 | - * |
|
| 799 | - * @since 1.0.19 |
|
| 800 | - * @param string $context View or edit context. |
|
| 801 | - * @return string |
|
| 802 | - */ |
|
| 803 | - public function get_ip( $context = 'view' ) { |
|
| 804 | - return $this->get_prop( 'user_ip', $context ); |
|
| 797 | + * Get the customer's ip. |
|
| 798 | + * |
|
| 799 | + * @since 1.0.19 |
|
| 800 | + * @param string $context View or edit context. |
|
| 801 | + * @return string |
|
| 802 | + */ |
|
| 803 | + public function get_ip( $context = 'view' ) { |
|
| 804 | + return $this->get_prop( 'user_ip', $context ); |
|
| 805 | 805 | } |
| 806 | 806 | |
| 807 | 807 | /** |
| 808 | - * Alias of self::get_ip(). |
|
| 809 | - * |
|
| 810 | - * @since 1.0.19 |
|
| 811 | - * @param string $context View or edit context. |
|
| 812 | - * @return string |
|
| 813 | - */ |
|
| 814 | - public function get_user_ip( $context = 'view' ) { |
|
| 815 | - return $this->get_ip( $context ); |
|
| 808 | + * Alias of self::get_ip(). |
|
| 809 | + * |
|
| 810 | + * @since 1.0.19 |
|
| 811 | + * @param string $context View or edit context. |
|
| 812 | + * @return string |
|
| 813 | + */ |
|
| 814 | + public function get_user_ip( $context = 'view' ) { |
|
| 815 | + return $this->get_ip( $context ); |
|
| 816 | 816 | } |
| 817 | 817 | |
| 818 | - /** |
|
| 819 | - * Alias of self::get_ip(). |
|
| 820 | - * |
|
| 821 | - * @since 1.0.19 |
|
| 822 | - * @param string $context View or edit context. |
|
| 823 | - * @return string |
|
| 824 | - */ |
|
| 825 | - public function get_customer_ip( $context = 'view' ) { |
|
| 826 | - return $this->get_ip( $context ); |
|
| 818 | + /** |
|
| 819 | + * Alias of self::get_ip(). |
|
| 820 | + * |
|
| 821 | + * @since 1.0.19 |
|
| 822 | + * @param string $context View or edit context. |
|
| 823 | + * @return string |
|
| 824 | + */ |
|
| 825 | + public function get_customer_ip( $context = 'view' ) { |
|
| 826 | + return $this->get_ip( $context ); |
|
| 827 | 827 | } |
| 828 | 828 | |
| 829 | 829 | /** |
| 830 | - * Get the customer's first name. |
|
| 831 | - * |
|
| 832 | - * @since 1.0.19 |
|
| 833 | - * @param string $context View or edit context. |
|
| 834 | - * @return string |
|
| 835 | - */ |
|
| 836 | - public function get_first_name( $context = 'view' ) { |
|
| 837 | - return $this->get_prop( 'first_name', $context ); |
|
| 830 | + * Get the customer's first name. |
|
| 831 | + * |
|
| 832 | + * @since 1.0.19 |
|
| 833 | + * @param string $context View or edit context. |
|
| 834 | + * @return string |
|
| 835 | + */ |
|
| 836 | + public function get_first_name( $context = 'view' ) { |
|
| 837 | + return $this->get_prop( 'first_name', $context ); |
|
| 838 | 838 | } |
| 839 | 839 | |
| 840 | 840 | /** |
| 841 | - * Alias of self::get_first_name(). |
|
| 842 | - * |
|
| 843 | - * @since 1.0.19 |
|
| 844 | - * @param string $context View or edit context. |
|
| 845 | - * @return string |
|
| 846 | - */ |
|
| 847 | - public function get_user_first_name( $context = 'view' ) { |
|
| 848 | - return $this->get_first_name( $context ); |
|
| 841 | + * Alias of self::get_first_name(). |
|
| 842 | + * |
|
| 843 | + * @since 1.0.19 |
|
| 844 | + * @param string $context View or edit context. |
|
| 845 | + * @return string |
|
| 846 | + */ |
|
| 847 | + public function get_user_first_name( $context = 'view' ) { |
|
| 848 | + return $this->get_first_name( $context ); |
|
| 849 | 849 | } |
| 850 | 850 | |
| 851 | - /** |
|
| 852 | - * Alias of self::get_first_name(). |
|
| 853 | - * |
|
| 854 | - * @since 1.0.19 |
|
| 855 | - * @param string $context View or edit context. |
|
| 856 | - * @return string |
|
| 857 | - */ |
|
| 858 | - public function get_customer_first_name( $context = 'view' ) { |
|
| 859 | - return $this->get_first_name( $context ); |
|
| 851 | + /** |
|
| 852 | + * Alias of self::get_first_name(). |
|
| 853 | + * |
|
| 854 | + * @since 1.0.19 |
|
| 855 | + * @param string $context View or edit context. |
|
| 856 | + * @return string |
|
| 857 | + */ |
|
| 858 | + public function get_customer_first_name( $context = 'view' ) { |
|
| 859 | + return $this->get_first_name( $context ); |
|
| 860 | 860 | } |
| 861 | 861 | |
| 862 | 862 | /** |
| 863 | - * Get the customer's last name. |
|
| 864 | - * |
|
| 865 | - * @since 1.0.19 |
|
| 866 | - * @param string $context View or edit context. |
|
| 867 | - * @return string |
|
| 868 | - */ |
|
| 869 | - public function get_last_name( $context = 'view' ) { |
|
| 870 | - return $this->get_prop( 'last_name', $context ); |
|
| 863 | + * Get the customer's last name. |
|
| 864 | + * |
|
| 865 | + * @since 1.0.19 |
|
| 866 | + * @param string $context View or edit context. |
|
| 867 | + * @return string |
|
| 868 | + */ |
|
| 869 | + public function get_last_name( $context = 'view' ) { |
|
| 870 | + return $this->get_prop( 'last_name', $context ); |
|
| 871 | 871 | } |
| 872 | 872 | |
| 873 | 873 | /** |
| 874 | - * Alias of self::get_last_name(). |
|
| 875 | - * |
|
| 876 | - * @since 1.0.19 |
|
| 877 | - * @param string $context View or edit context. |
|
| 878 | - * @return string |
|
| 879 | - */ |
|
| 880 | - public function get_user_last_name( $context = 'view' ) { |
|
| 881 | - return $this->get_last_name( $context ); |
|
| 874 | + * Alias of self::get_last_name(). |
|
| 875 | + * |
|
| 876 | + * @since 1.0.19 |
|
| 877 | + * @param string $context View or edit context. |
|
| 878 | + * @return string |
|
| 879 | + */ |
|
| 880 | + public function get_user_last_name( $context = 'view' ) { |
|
| 881 | + return $this->get_last_name( $context ); |
|
| 882 | 882 | } |
| 883 | 883 | |
| 884 | 884 | /** |
| 885 | - * Alias of self::get_last_name(). |
|
| 886 | - * |
|
| 887 | - * @since 1.0.19 |
|
| 888 | - * @param string $context View or edit context. |
|
| 889 | - * @return string |
|
| 890 | - */ |
|
| 891 | - public function get_customer_last_name( $context = 'view' ) { |
|
| 892 | - return $this->get_last_name( $context ); |
|
| 885 | + * Alias of self::get_last_name(). |
|
| 886 | + * |
|
| 887 | + * @since 1.0.19 |
|
| 888 | + * @param string $context View or edit context. |
|
| 889 | + * @return string |
|
| 890 | + */ |
|
| 891 | + public function get_customer_last_name( $context = 'view' ) { |
|
| 892 | + return $this->get_last_name( $context ); |
|
| 893 | 893 | } |
| 894 | 894 | |
| 895 | 895 | /** |
| 896 | - * Get the customer's full name. |
|
| 897 | - * |
|
| 898 | - * @since 1.0.19 |
|
| 899 | - * @param string $context View or edit context. |
|
| 900 | - * @return string |
|
| 901 | - */ |
|
| 902 | - public function get_full_name( $context = 'view' ) { |
|
| 903 | - $name = trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) ); |
|
| 896 | + * Get the customer's full name. |
|
| 897 | + * |
|
| 898 | + * @since 1.0.19 |
|
| 899 | + * @param string $context View or edit context. |
|
| 900 | + * @return string |
|
| 901 | + */ |
|
| 902 | + public function get_full_name( $context = 'view' ) { |
|
| 903 | + $name = trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) ); |
|
| 904 | 904 | |
| 905 | - if ( ! $name ) { |
|
| 906 | - $user = get_userdata( $this->get_author( $context ) ); |
|
| 905 | + if ( ! $name ) { |
|
| 906 | + $user = get_userdata( $this->get_author( $context ) ); |
|
| 907 | 907 | |
| 908 | - if ( $user ) { |
|
| 909 | - $name = $user->display_name; |
|
| 910 | - } |
|
| 911 | - } |
|
| 908 | + if ( $user ) { |
|
| 909 | + $name = $user->display_name; |
|
| 910 | + } |
|
| 911 | + } |
|
| 912 | 912 | |
| 913 | - if ( ! $name ) { |
|
| 914 | - $name = $this->get_email( $context ); |
|
| 915 | - } |
|
| 913 | + if ( ! $name ) { |
|
| 914 | + $name = $this->get_email( $context ); |
|
| 915 | + } |
|
| 916 | 916 | |
| 917 | - return apply_filters( 'wpinv_invoice_user_full_name', $name, $this ); |
|
| 917 | + return apply_filters( 'wpinv_invoice_user_full_name', $name, $this ); |
|
| 918 | 918 | } |
| 919 | 919 | |
| 920 | 920 | /** |
| 921 | - * Alias of self::get_full_name(). |
|
| 922 | - * |
|
| 923 | - * @since 1.0.19 |
|
| 924 | - * @param string $context View or edit context. |
|
| 925 | - * @return string |
|
| 926 | - */ |
|
| 927 | - public function get_user_full_name( $context = 'view' ) { |
|
| 928 | - return $this->get_full_name( $context ); |
|
| 921 | + * Alias of self::get_full_name(). |
|
| 922 | + * |
|
| 923 | + * @since 1.0.19 |
|
| 924 | + * @param string $context View or edit context. |
|
| 925 | + * @return string |
|
| 926 | + */ |
|
| 927 | + public function get_user_full_name( $context = 'view' ) { |
|
| 928 | + return $this->get_full_name( $context ); |
|
| 929 | 929 | } |
| 930 | 930 | |
| 931 | 931 | /** |
| 932 | - * Alias of self::get_full_name(). |
|
| 933 | - * |
|
| 934 | - * @since 1.0.19 |
|
| 935 | - * @param string $context View or edit context. |
|
| 936 | - * @return string |
|
| 937 | - */ |
|
| 938 | - public function get_customer_full_name( $context = 'view' ) { |
|
| 939 | - return $this->get_full_name( $context ); |
|
| 932 | + * Alias of self::get_full_name(). |
|
| 933 | + * |
|
| 934 | + * @since 1.0.19 |
|
| 935 | + * @param string $context View or edit context. |
|
| 936 | + * @return string |
|
| 937 | + */ |
|
| 938 | + public function get_customer_full_name( $context = 'view' ) { |
|
| 939 | + return $this->get_full_name( $context ); |
|
| 940 | 940 | } |
| 941 | 941 | |
| 942 | 942 | /** |
| 943 | - * Get the customer's phone number. |
|
| 944 | - * |
|
| 945 | - * @since 1.0.19 |
|
| 946 | - * @param string $context View or edit context. |
|
| 947 | - * @return string |
|
| 948 | - */ |
|
| 949 | - public function get_phone( $context = 'view' ) { |
|
| 950 | - return $this->get_prop( 'phone', $context ); |
|
| 943 | + * Get the customer's phone number. |
|
| 944 | + * |
|
| 945 | + * @since 1.0.19 |
|
| 946 | + * @param string $context View or edit context. |
|
| 947 | + * @return string |
|
| 948 | + */ |
|
| 949 | + public function get_phone( $context = 'view' ) { |
|
| 950 | + return $this->get_prop( 'phone', $context ); |
|
| 951 | 951 | } |
| 952 | 952 | |
| 953 | 953 | /** |
| 954 | - * Alias of self::get_phone(). |
|
| 955 | - * |
|
| 956 | - * @since 1.0.19 |
|
| 957 | - * @param string $context View or edit context. |
|
| 958 | - * @return string |
|
| 959 | - */ |
|
| 960 | - public function get_phone_number( $context = 'view' ) { |
|
| 961 | - return $this->get_phone( $context ); |
|
| 954 | + * Alias of self::get_phone(). |
|
| 955 | + * |
|
| 956 | + * @since 1.0.19 |
|
| 957 | + * @param string $context View or edit context. |
|
| 958 | + * @return string |
|
| 959 | + */ |
|
| 960 | + public function get_phone_number( $context = 'view' ) { |
|
| 961 | + return $this->get_phone( $context ); |
|
| 962 | 962 | } |
| 963 | 963 | |
| 964 | 964 | /** |
| 965 | - * Alias of self::get_phone(). |
|
| 966 | - * |
|
| 967 | - * @since 1.0.19 |
|
| 968 | - * @param string $context View or edit context. |
|
| 969 | - * @return string |
|
| 970 | - */ |
|
| 971 | - public function get_user_phone( $context = 'view' ) { |
|
| 972 | - return $this->get_phone( $context ); |
|
| 965 | + * Alias of self::get_phone(). |
|
| 966 | + * |
|
| 967 | + * @since 1.0.19 |
|
| 968 | + * @param string $context View or edit context. |
|
| 969 | + * @return string |
|
| 970 | + */ |
|
| 971 | + public function get_user_phone( $context = 'view' ) { |
|
| 972 | + return $this->get_phone( $context ); |
|
| 973 | 973 | } |
| 974 | 974 | |
| 975 | 975 | /** |
| 976 | - * Alias of self::get_phone(). |
|
| 977 | - * |
|
| 978 | - * @since 1.0.19 |
|
| 979 | - * @param string $context View or edit context. |
|
| 980 | - * @return string |
|
| 981 | - */ |
|
| 982 | - public function get_customer_phone( $context = 'view' ) { |
|
| 983 | - return $this->get_phone( $context ); |
|
| 976 | + * Alias of self::get_phone(). |
|
| 977 | + * |
|
| 978 | + * @since 1.0.19 |
|
| 979 | + * @param string $context View or edit context. |
|
| 980 | + * @return string |
|
| 981 | + */ |
|
| 982 | + public function get_customer_phone( $context = 'view' ) { |
|
| 983 | + return $this->get_phone( $context ); |
|
| 984 | 984 | } |
| 985 | 985 | |
| 986 | 986 | /** |
| 987 | - * Get the customer's email address. |
|
| 988 | - * |
|
| 989 | - * @since 1.0.19 |
|
| 990 | - * @param string $context View or edit context. |
|
| 991 | - * @return string |
|
| 992 | - */ |
|
| 993 | - public function get_email( $context = 'view' ) { |
|
| 994 | - return $this->get_prop( 'email', $context ); |
|
| 987 | + * Get the customer's email address. |
|
| 988 | + * |
|
| 989 | + * @since 1.0.19 |
|
| 990 | + * @param string $context View or edit context. |
|
| 991 | + * @return string |
|
| 992 | + */ |
|
| 993 | + public function get_email( $context = 'view' ) { |
|
| 994 | + return $this->get_prop( 'email', $context ); |
|
| 995 | 995 | } |
| 996 | 996 | |
| 997 | 997 | /** |
| 998 | - * Alias of self::get_email(). |
|
| 999 | - * |
|
| 1000 | - * @since 1.0.19 |
|
| 1001 | - * @param string $context View or edit context. |
|
| 1002 | - * @return string |
|
| 1003 | - */ |
|
| 1004 | - public function get_email_address( $context = 'view' ) { |
|
| 1005 | - return $this->get_email( $context ); |
|
| 998 | + * Alias of self::get_email(). |
|
| 999 | + * |
|
| 1000 | + * @since 1.0.19 |
|
| 1001 | + * @param string $context View or edit context. |
|
| 1002 | + * @return string |
|
| 1003 | + */ |
|
| 1004 | + public function get_email_address( $context = 'view' ) { |
|
| 1005 | + return $this->get_email( $context ); |
|
| 1006 | 1006 | } |
| 1007 | 1007 | |
| 1008 | 1008 | /** |
| 1009 | - * Alias of self::get_email(). |
|
| 1010 | - * |
|
| 1011 | - * @since 1.0.19 |
|
| 1012 | - * @param string $context View or edit context. |
|
| 1013 | - * @return string |
|
| 1014 | - */ |
|
| 1015 | - public function get_user_email( $context = 'view' ) { |
|
| 1016 | - return $this->get_email( $context ); |
|
| 1009 | + * Alias of self::get_email(). |
|
| 1010 | + * |
|
| 1011 | + * @since 1.0.19 |
|
| 1012 | + * @param string $context View or edit context. |
|
| 1013 | + * @return string |
|
| 1014 | + */ |
|
| 1015 | + public function get_user_email( $context = 'view' ) { |
|
| 1016 | + return $this->get_email( $context ); |
|
| 1017 | 1017 | } |
| 1018 | 1018 | |
| 1019 | 1019 | /** |
| 1020 | - * Alias of self::get_email(). |
|
| 1021 | - * |
|
| 1022 | - * @since 1.0.19 |
|
| 1023 | - * @param string $context View or edit context. |
|
| 1024 | - * @return string |
|
| 1025 | - */ |
|
| 1026 | - public function get_customer_email( $context = 'view' ) { |
|
| 1027 | - return $this->get_email( $context ); |
|
| 1020 | + * Alias of self::get_email(). |
|
| 1021 | + * |
|
| 1022 | + * @since 1.0.19 |
|
| 1023 | + * @param string $context View or edit context. |
|
| 1024 | + * @return string |
|
| 1025 | + */ |
|
| 1026 | + public function get_customer_email( $context = 'view' ) { |
|
| 1027 | + return $this->get_email( $context ); |
|
| 1028 | + } |
|
| 1029 | + |
|
| 1030 | + /** |
|
| 1031 | + * Get the customer's country. |
|
| 1032 | + * |
|
| 1033 | + * @since 1.0.19 |
|
| 1034 | + * @param string $context View or edit context. |
|
| 1035 | + * @return string |
|
| 1036 | + */ |
|
| 1037 | + public function get_country( $context = 'view' ) { |
|
| 1038 | + $country = $this->get_prop( 'country', $context ); |
|
| 1039 | + return empty( $country ) ? wpinv_get_default_country() : $country; |
|
| 1028 | 1040 | } |
| 1029 | 1041 | |
| 1030 | 1042 | /** |
| 1031 | - * Get the customer's country. |
|
| 1032 | - * |
|
| 1033 | - * @since 1.0.19 |
|
| 1034 | - * @param string $context View or edit context. |
|
| 1035 | - * @return string |
|
| 1036 | - */ |
|
| 1037 | - public function get_country( $context = 'view' ) { |
|
| 1038 | - $country = $this->get_prop( 'country', $context ); |
|
| 1039 | - return empty( $country ) ? wpinv_get_default_country() : $country; |
|
| 1043 | + * Alias of self::get_country(). |
|
| 1044 | + * |
|
| 1045 | + * @since 1.0.19 |
|
| 1046 | + * @param string $context View or edit context. |
|
| 1047 | + * @return string |
|
| 1048 | + */ |
|
| 1049 | + public function get_user_country( $context = 'view' ) { |
|
| 1050 | + return $this->get_country( $context ); |
|
| 1040 | 1051 | } |
| 1041 | 1052 | |
| 1042 | 1053 | /** |
| 1043 | - * Alias of self::get_country(). |
|
| 1044 | - * |
|
| 1045 | - * @since 1.0.19 |
|
| 1046 | - * @param string $context View or edit context. |
|
| 1047 | - * @return string |
|
| 1048 | - */ |
|
| 1049 | - public function get_user_country( $context = 'view' ) { |
|
| 1050 | - return $this->get_country( $context ); |
|
| 1054 | + * Alias of self::get_country(). |
|
| 1055 | + * |
|
| 1056 | + * @since 1.0.19 |
|
| 1057 | + * @param string $context View or edit context. |
|
| 1058 | + * @return string |
|
| 1059 | + */ |
|
| 1060 | + public function get_customer_country( $context = 'view' ) { |
|
| 1061 | + return $this->get_country( $context ); |
|
| 1062 | + } |
|
| 1063 | + |
|
| 1064 | + /** |
|
| 1065 | + * Get the customer's state. |
|
| 1066 | + * |
|
| 1067 | + * @since 1.0.19 |
|
| 1068 | + * @param string $context View or edit context. |
|
| 1069 | + * @return string |
|
| 1070 | + */ |
|
| 1071 | + public function get_state( $context = 'view' ) { |
|
| 1072 | + $state = $this->get_prop( 'state', $context ); |
|
| 1073 | + return empty( $state ) ? wpinv_get_default_state() : $state; |
|
| 1074 | + } |
|
| 1075 | + |
|
| 1076 | + /** |
|
| 1077 | + * Alias of self::get_state(). |
|
| 1078 | + * |
|
| 1079 | + * @since 1.0.19 |
|
| 1080 | + * @param string $context View or edit context. |
|
| 1081 | + * @return string |
|
| 1082 | + */ |
|
| 1083 | + public function get_user_state( $context = 'view' ) { |
|
| 1084 | + return $this->get_state( $context ); |
|
| 1085 | + } |
|
| 1086 | + |
|
| 1087 | + /** |
|
| 1088 | + * Alias of self::get_state(). |
|
| 1089 | + * |
|
| 1090 | + * @since 1.0.19 |
|
| 1091 | + * @param string $context View or edit context. |
|
| 1092 | + * @return string |
|
| 1093 | + */ |
|
| 1094 | + public function get_customer_state( $context = 'view' ) { |
|
| 1095 | + return $this->get_state( $context ); |
|
| 1096 | + } |
|
| 1097 | + |
|
| 1098 | + /** |
|
| 1099 | + * Get the customer's city. |
|
| 1100 | + * |
|
| 1101 | + * @since 1.0.19 |
|
| 1102 | + * @param string $context View or edit context. |
|
| 1103 | + * @return string |
|
| 1104 | + */ |
|
| 1105 | + public function get_city( $context = 'view' ) { |
|
| 1106 | + return $this->get_prop( 'city', $context ); |
|
| 1107 | + } |
|
| 1108 | + |
|
| 1109 | + /** |
|
| 1110 | + * Alias of self::get_city(). |
|
| 1111 | + * |
|
| 1112 | + * @since 1.0.19 |
|
| 1113 | + * @param string $context View or edit context. |
|
| 1114 | + * @return string |
|
| 1115 | + */ |
|
| 1116 | + public function get_user_city( $context = 'view' ) { |
|
| 1117 | + return $this->get_city( $context ); |
|
| 1051 | 1118 | } |
| 1052 | 1119 | |
| 1053 | 1120 | /** |
| 1054 | - * Alias of self::get_country(). |
|
| 1055 | - * |
|
| 1056 | - * @since 1.0.19 |
|
| 1057 | - * @param string $context View or edit context. |
|
| 1058 | - * @return string |
|
| 1059 | - */ |
|
| 1060 | - public function get_customer_country( $context = 'view' ) { |
|
| 1061 | - return $this->get_country( $context ); |
|
| 1121 | + * Alias of self::get_city(). |
|
| 1122 | + * |
|
| 1123 | + * @since 1.0.19 |
|
| 1124 | + * @param string $context View or edit context. |
|
| 1125 | + * @return string |
|
| 1126 | + */ |
|
| 1127 | + public function get_customer_city( $context = 'view' ) { |
|
| 1128 | + return $this->get_city( $context ); |
|
| 1062 | 1129 | } |
| 1063 | 1130 | |
| 1064 | 1131 | /** |
| 1065 | - * Get the customer's state. |
|
| 1066 | - * |
|
| 1067 | - * @since 1.0.19 |
|
| 1068 | - * @param string $context View or edit context. |
|
| 1069 | - * @return string |
|
| 1070 | - */ |
|
| 1071 | - public function get_state( $context = 'view' ) { |
|
| 1072 | - $state = $this->get_prop( 'state', $context ); |
|
| 1073 | - return empty( $state ) ? wpinv_get_default_state() : $state; |
|
| 1132 | + * Get the customer's zip. |
|
| 1133 | + * |
|
| 1134 | + * @since 1.0.19 |
|
| 1135 | + * @param string $context View or edit context. |
|
| 1136 | + * @return string |
|
| 1137 | + */ |
|
| 1138 | + public function get_zip( $context = 'view' ) { |
|
| 1139 | + return $this->get_prop( 'zip', $context ); |
|
| 1074 | 1140 | } |
| 1075 | 1141 | |
| 1076 | 1142 | /** |
| 1077 | - * Alias of self::get_state(). |
|
| 1078 | - * |
|
| 1079 | - * @since 1.0.19 |
|
| 1080 | - * @param string $context View or edit context. |
|
| 1081 | - * @return string |
|
| 1082 | - */ |
|
| 1083 | - public function get_user_state( $context = 'view' ) { |
|
| 1084 | - return $this->get_state( $context ); |
|
| 1143 | + * Alias of self::get_zip(). |
|
| 1144 | + * |
|
| 1145 | + * @since 1.0.19 |
|
| 1146 | + * @param string $context View or edit context. |
|
| 1147 | + * @return string |
|
| 1148 | + */ |
|
| 1149 | + public function get_user_zip( $context = 'view' ) { |
|
| 1150 | + return $this->get_zip( $context ); |
|
| 1085 | 1151 | } |
| 1086 | 1152 | |
| 1087 | 1153 | /** |
| 1088 | - * Alias of self::get_state(). |
|
| 1089 | - * |
|
| 1090 | - * @since 1.0.19 |
|
| 1091 | - * @param string $context View or edit context. |
|
| 1092 | - * @return string |
|
| 1093 | - */ |
|
| 1094 | - public function get_customer_state( $context = 'view' ) { |
|
| 1095 | - return $this->get_state( $context ); |
|
| 1154 | + * Alias of self::get_zip(). |
|
| 1155 | + * |
|
| 1156 | + * @since 1.0.19 |
|
| 1157 | + * @param string $context View or edit context. |
|
| 1158 | + * @return string |
|
| 1159 | + */ |
|
| 1160 | + public function get_customer_zip( $context = 'view' ) { |
|
| 1161 | + return $this->get_zip( $context ); |
|
| 1096 | 1162 | } |
| 1097 | 1163 | |
| 1098 | 1164 | /** |
| 1099 | - * Get the customer's city. |
|
| 1100 | - * |
|
| 1101 | - * @since 1.0.19 |
|
| 1102 | - * @param string $context View or edit context. |
|
| 1103 | - * @return string |
|
| 1104 | - */ |
|
| 1105 | - public function get_city( $context = 'view' ) { |
|
| 1106 | - return $this->get_prop( 'city', $context ); |
|
| 1165 | + * Get the customer's company. |
|
| 1166 | + * |
|
| 1167 | + * @since 1.0.19 |
|
| 1168 | + * @param string $context View or edit context. |
|
| 1169 | + * @return string |
|
| 1170 | + */ |
|
| 1171 | + public function get_company( $context = 'view' ) { |
|
| 1172 | + return $this->get_prop( 'company', $context ); |
|
| 1107 | 1173 | } |
| 1108 | 1174 | |
| 1109 | 1175 | /** |
| 1110 | - * Alias of self::get_city(). |
|
| 1111 | - * |
|
| 1112 | - * @since 1.0.19 |
|
| 1113 | - * @param string $context View or edit context. |
|
| 1114 | - * @return string |
|
| 1115 | - */ |
|
| 1116 | - public function get_user_city( $context = 'view' ) { |
|
| 1117 | - return $this->get_city( $context ); |
|
| 1176 | + * Alias of self::get_company(). |
|
| 1177 | + * |
|
| 1178 | + * @since 1.0.19 |
|
| 1179 | + * @param string $context View or edit context. |
|
| 1180 | + * @return string |
|
| 1181 | + */ |
|
| 1182 | + public function get_user_company( $context = 'view' ) { |
|
| 1183 | + return $this->get_company( $context ); |
|
| 1118 | 1184 | } |
| 1119 | 1185 | |
| 1120 | 1186 | /** |
| 1121 | - * Alias of self::get_city(). |
|
| 1122 | - * |
|
| 1123 | - * @since 1.0.19 |
|
| 1124 | - * @param string $context View or edit context. |
|
| 1125 | - * @return string |
|
| 1126 | - */ |
|
| 1127 | - public function get_customer_city( $context = 'view' ) { |
|
| 1128 | - return $this->get_city( $context ); |
|
| 1187 | + * Alias of self::get_company(). |
|
| 1188 | + * |
|
| 1189 | + * @since 1.0.19 |
|
| 1190 | + * @param string $context View or edit context. |
|
| 1191 | + * @return string |
|
| 1192 | + */ |
|
| 1193 | + public function get_customer_company( $context = 'view' ) { |
|
| 1194 | + return $this->get_company( $context ); |
|
| 1129 | 1195 | } |
| 1130 | 1196 | |
| 1131 | 1197 | /** |
| 1132 | - * Get the customer's zip. |
|
| 1133 | - * |
|
| 1134 | - * @since 1.0.19 |
|
| 1135 | - * @param string $context View or edit context. |
|
| 1136 | - * @return string |
|
| 1137 | - */ |
|
| 1138 | - public function get_zip( $context = 'view' ) { |
|
| 1139 | - return $this->get_prop( 'zip', $context ); |
|
| 1198 | + * Get the customer's company id. |
|
| 1199 | + * |
|
| 1200 | + * @since 1.0.19 |
|
| 1201 | + * @param string $context View or edit context. |
|
| 1202 | + * @return string |
|
| 1203 | + */ |
|
| 1204 | + public function get_company_id( $context = 'view' ) { |
|
| 1205 | + return $this->get_prop( 'company_id', $context ); |
|
| 1140 | 1206 | } |
| 1141 | 1207 | |
| 1142 | 1208 | /** |
| 1143 | - * Alias of self::get_zip(). |
|
| 1144 | - * |
|
| 1145 | - * @since 1.0.19 |
|
| 1146 | - * @param string $context View or edit context. |
|
| 1147 | - * @return string |
|
| 1148 | - */ |
|
| 1149 | - public function get_user_zip( $context = 'view' ) { |
|
| 1150 | - return $this->get_zip( $context ); |
|
| 1209 | + * Get the customer's vat number. |
|
| 1210 | + * |
|
| 1211 | + * @since 1.0.19 |
|
| 1212 | + * @param string $context View or edit context. |
|
| 1213 | + * @return string |
|
| 1214 | + */ |
|
| 1215 | + public function get_vat_number( $context = 'view' ) { |
|
| 1216 | + return $this->get_prop( 'vat_number', $context ); |
|
| 1151 | 1217 | } |
| 1152 | 1218 | |
| 1153 | 1219 | /** |
| 1154 | - * Alias of self::get_zip(). |
|
| 1155 | - * |
|
| 1156 | - * @since 1.0.19 |
|
| 1157 | - * @param string $context View or edit context. |
|
| 1158 | - * @return string |
|
| 1159 | - */ |
|
| 1160 | - public function get_customer_zip( $context = 'view' ) { |
|
| 1161 | - return $this->get_zip( $context ); |
|
| 1220 | + * Alias of self::get_vat_number(). |
|
| 1221 | + * |
|
| 1222 | + * @since 1.0.19 |
|
| 1223 | + * @param string $context View or edit context. |
|
| 1224 | + * @return string |
|
| 1225 | + */ |
|
| 1226 | + public function get_user_vat_number( $context = 'view' ) { |
|
| 1227 | + return $this->get_vat_number( $context ); |
|
| 1162 | 1228 | } |
| 1163 | 1229 | |
| 1164 | 1230 | /** |
| 1165 | - * Get the customer's company. |
|
| 1166 | - * |
|
| 1167 | - * @since 1.0.19 |
|
| 1168 | - * @param string $context View or edit context. |
|
| 1169 | - * @return string |
|
| 1170 | - */ |
|
| 1171 | - public function get_company( $context = 'view' ) { |
|
| 1172 | - return $this->get_prop( 'company', $context ); |
|
| 1231 | + * Alias of self::get_vat_number(). |
|
| 1232 | + * |
|
| 1233 | + * @since 1.0.19 |
|
| 1234 | + * @param string $context View or edit context. |
|
| 1235 | + * @return string |
|
| 1236 | + */ |
|
| 1237 | + public function get_customer_vat_number( $context = 'view' ) { |
|
| 1238 | + return $this->get_vat_number( $context ); |
|
| 1173 | 1239 | } |
| 1174 | 1240 | |
| 1175 | 1241 | /** |
| 1176 | - * Alias of self::get_company(). |
|
| 1177 | - * |
|
| 1178 | - * @since 1.0.19 |
|
| 1179 | - * @param string $context View or edit context. |
|
| 1180 | - * @return string |
|
| 1181 | - */ |
|
| 1182 | - public function get_user_company( $context = 'view' ) { |
|
| 1183 | - return $this->get_company( $context ); |
|
| 1242 | + * Get the customer's vat rate. |
|
| 1243 | + * |
|
| 1244 | + * @since 1.0.19 |
|
| 1245 | + * @param string $context View or edit context. |
|
| 1246 | + * @return string |
|
| 1247 | + */ |
|
| 1248 | + public function get_vat_rate( $context = 'view' ) { |
|
| 1249 | + return $this->get_prop( 'vat_rate', $context ); |
|
| 1184 | 1250 | } |
| 1185 | 1251 | |
| 1186 | 1252 | /** |
| 1187 | - * Alias of self::get_company(). |
|
| 1188 | - * |
|
| 1189 | - * @since 1.0.19 |
|
| 1190 | - * @param string $context View or edit context. |
|
| 1191 | - * @return string |
|
| 1192 | - */ |
|
| 1193 | - public function get_customer_company( $context = 'view' ) { |
|
| 1194 | - return $this->get_company( $context ); |
|
| 1253 | + * Alias of self::get_vat_rate(). |
|
| 1254 | + * |
|
| 1255 | + * @since 1.0.19 |
|
| 1256 | + * @param string $context View or edit context. |
|
| 1257 | + * @return string |
|
| 1258 | + */ |
|
| 1259 | + public function get_user_vat_rate( $context = 'view' ) { |
|
| 1260 | + return $this->get_vat_rate( $context ); |
|
| 1195 | 1261 | } |
| 1196 | 1262 | |
| 1197 | - /** |
|
| 1198 | - * Get the customer's company id. |
|
| 1199 | - * |
|
| 1200 | - * @since 1.0.19 |
|
| 1201 | - * @param string $context View or edit context. |
|
| 1202 | - * @return string |
|
| 1203 | - */ |
|
| 1204 | - public function get_company_id( $context = 'view' ) { |
|
| 1205 | - return $this->get_prop( 'company_id', $context ); |
|
| 1263 | + /** |
|
| 1264 | + * Alias of self::get_vat_rate(). |
|
| 1265 | + * |
|
| 1266 | + * @since 1.0.19 |
|
| 1267 | + * @param string $context View or edit context. |
|
| 1268 | + * @return string |
|
| 1269 | + */ |
|
| 1270 | + public function get_customer_vat_rate( $context = 'view' ) { |
|
| 1271 | + return $this->get_vat_rate( $context ); |
|
| 1206 | 1272 | } |
| 1207 | 1273 | |
| 1208 | 1274 | /** |
| 1209 | - * Get the customer's vat number. |
|
| 1210 | - * |
|
| 1211 | - * @since 1.0.19 |
|
| 1212 | - * @param string $context View or edit context. |
|
| 1213 | - * @return string |
|
| 1214 | - */ |
|
| 1215 | - public function get_vat_number( $context = 'view' ) { |
|
| 1216 | - return $this->get_prop( 'vat_number', $context ); |
|
| 1275 | + * Get the customer's address. |
|
| 1276 | + * |
|
| 1277 | + * @since 1.0.19 |
|
| 1278 | + * @param string $context View or edit context. |
|
| 1279 | + * @return string |
|
| 1280 | + */ |
|
| 1281 | + public function get_address( $context = 'view' ) { |
|
| 1282 | + return $this->get_prop( 'address', $context ); |
|
| 1217 | 1283 | } |
| 1218 | 1284 | |
| 1219 | 1285 | /** |
| 1220 | - * Alias of self::get_vat_number(). |
|
| 1221 | - * |
|
| 1222 | - * @since 1.0.19 |
|
| 1223 | - * @param string $context View or edit context. |
|
| 1224 | - * @return string |
|
| 1225 | - */ |
|
| 1226 | - public function get_user_vat_number( $context = 'view' ) { |
|
| 1227 | - return $this->get_vat_number( $context ); |
|
| 1286 | + * Alias of self::get_address(). |
|
| 1287 | + * |
|
| 1288 | + * @since 1.0.19 |
|
| 1289 | + * @param string $context View or edit context. |
|
| 1290 | + * @return string |
|
| 1291 | + */ |
|
| 1292 | + public function get_user_address( $context = 'view' ) { |
|
| 1293 | + return $this->get_address( $context ); |
|
| 1228 | 1294 | } |
| 1229 | 1295 | |
| 1230 | 1296 | /** |
| 1231 | - * Alias of self::get_vat_number(). |
|
| 1232 | - * |
|
| 1233 | - * @since 1.0.19 |
|
| 1234 | - * @param string $context View or edit context. |
|
| 1235 | - * @return string |
|
| 1236 | - */ |
|
| 1237 | - public function get_customer_vat_number( $context = 'view' ) { |
|
| 1238 | - return $this->get_vat_number( $context ); |
|
| 1297 | + * Alias of self::get_address(). |
|
| 1298 | + * |
|
| 1299 | + * @since 1.0.19 |
|
| 1300 | + * @param string $context View or edit context. |
|
| 1301 | + * @return string |
|
| 1302 | + */ |
|
| 1303 | + public function get_customer_address( $context = 'view' ) { |
|
| 1304 | + return $this->get_address( $context ); |
|
| 1239 | 1305 | } |
| 1240 | 1306 | |
| 1241 | - /** |
|
| 1242 | - * Get the customer's vat rate. |
|
| 1243 | - * |
|
| 1244 | - * @since 1.0.19 |
|
| 1245 | - * @param string $context View or edit context. |
|
| 1246 | - * @return string |
|
| 1247 | - */ |
|
| 1248 | - public function get_vat_rate( $context = 'view' ) { |
|
| 1249 | - return $this->get_prop( 'vat_rate', $context ); |
|
| 1250 | - } |
|
| 1251 | - |
|
| 1252 | - /** |
|
| 1253 | - * Alias of self::get_vat_rate(). |
|
| 1254 | - * |
|
| 1255 | - * @since 1.0.19 |
|
| 1256 | - * @param string $context View or edit context. |
|
| 1257 | - * @return string |
|
| 1258 | - */ |
|
| 1259 | - public function get_user_vat_rate( $context = 'view' ) { |
|
| 1260 | - return $this->get_vat_rate( $context ); |
|
| 1261 | - } |
|
| 1262 | - |
|
| 1263 | - /** |
|
| 1264 | - * Alias of self::get_vat_rate(). |
|
| 1265 | - * |
|
| 1266 | - * @since 1.0.19 |
|
| 1267 | - * @param string $context View or edit context. |
|
| 1268 | - * @return string |
|
| 1269 | - */ |
|
| 1270 | - public function get_customer_vat_rate( $context = 'view' ) { |
|
| 1271 | - return $this->get_vat_rate( $context ); |
|
| 1272 | - } |
|
| 1273 | - |
|
| 1274 | - /** |
|
| 1275 | - * Get the customer's address. |
|
| 1276 | - * |
|
| 1277 | - * @since 1.0.19 |
|
| 1278 | - * @param string $context View or edit context. |
|
| 1279 | - * @return string |
|
| 1280 | - */ |
|
| 1281 | - public function get_address( $context = 'view' ) { |
|
| 1282 | - return $this->get_prop( 'address', $context ); |
|
| 1283 | - } |
|
| 1284 | - |
|
| 1285 | - /** |
|
| 1286 | - * Alias of self::get_address(). |
|
| 1287 | - * |
|
| 1288 | - * @since 1.0.19 |
|
| 1289 | - * @param string $context View or edit context. |
|
| 1290 | - * @return string |
|
| 1291 | - */ |
|
| 1292 | - public function get_user_address( $context = 'view' ) { |
|
| 1293 | - return $this->get_address( $context ); |
|
| 1294 | - } |
|
| 1295 | - |
|
| 1296 | - /** |
|
| 1297 | - * Alias of self::get_address(). |
|
| 1298 | - * |
|
| 1299 | - * @since 1.0.19 |
|
| 1300 | - * @param string $context View or edit context. |
|
| 1301 | - * @return string |
|
| 1302 | - */ |
|
| 1303 | - public function get_customer_address( $context = 'view' ) { |
|
| 1304 | - return $this->get_address( $context ); |
|
| 1305 | - } |
|
| 1306 | - |
|
| 1307 | - /** |
|
| 1308 | - * Get whether the customer has viewed the invoice or not. |
|
| 1309 | - * |
|
| 1310 | - * @since 1.0.19 |
|
| 1311 | - * @param string $context View or edit context. |
|
| 1312 | - * @return bool |
|
| 1313 | - */ |
|
| 1314 | - public function get_is_viewed( $context = 'view' ) { |
|
| 1315 | - return (bool) $this->get_prop( 'is_viewed', $context ); |
|
| 1316 | - } |
|
| 1317 | - |
|
| 1318 | - /** |
|
| 1319 | - * Get other recipients for invoice communications. |
|
| 1320 | - * |
|
| 1321 | - * @since 1.0.19 |
|
| 1322 | - * @param string $context View or edit context. |
|
| 1323 | - * @return bool |
|
| 1324 | - */ |
|
| 1325 | - public function get_email_cc( $context = 'view' ) { |
|
| 1326 | - return $this->get_prop( 'email_cc', $context ); |
|
| 1327 | - } |
|
| 1328 | - |
|
| 1329 | - /** |
|
| 1330 | - * Get invoice template. |
|
| 1331 | - * |
|
| 1332 | - * @since 1.0.19 |
|
| 1333 | - * @param string $context View or edit context. |
|
| 1334 | - * @return bool |
|
| 1335 | - */ |
|
| 1336 | - public function get_template( $context = 'view' ) { |
|
| 1337 | - return $this->get_prop( 'template', $context ); |
|
| 1338 | - } |
|
| 1339 | - |
|
| 1340 | - /** |
|
| 1341 | - * Get invoice source. |
|
| 1342 | - * |
|
| 1343 | - * @since 1.0.19 |
|
| 1344 | - * @param string $context View or edit context. |
|
| 1345 | - * @return bool |
|
| 1346 | - */ |
|
| 1347 | - public function get_created_via( $context = 'view' ) { |
|
| 1348 | - return $this->get_prop( 'created_via', $context ); |
|
| 1349 | - } |
|
| 1350 | - |
|
| 1351 | - /** |
|
| 1352 | - * Get whether the customer has confirmed their address. |
|
| 1353 | - * |
|
| 1354 | - * @since 1.0.19 |
|
| 1355 | - * @param string $context View or edit context. |
|
| 1356 | - * @return bool |
|
| 1357 | - */ |
|
| 1358 | - public function get_address_confirmed( $context = 'view' ) { |
|
| 1359 | - return (bool) $this->get_prop( 'address_confirmed', $context ); |
|
| 1360 | - } |
|
| 1361 | - |
|
| 1362 | - /** |
|
| 1363 | - * Alias of self::get_address_confirmed(). |
|
| 1364 | - * |
|
| 1365 | - * @since 1.0.19 |
|
| 1366 | - * @param string $context View or edit context. |
|
| 1367 | - * @return bool |
|
| 1368 | - */ |
|
| 1369 | - public function get_user_address_confirmed( $context = 'view' ) { |
|
| 1370 | - return $this->get_address_confirmed( $context ); |
|
| 1371 | - } |
|
| 1372 | - |
|
| 1373 | - /** |
|
| 1374 | - * Alias of self::get_address(). |
|
| 1375 | - * |
|
| 1376 | - * @since 1.0.19 |
|
| 1377 | - * @param string $context View or edit context. |
|
| 1378 | - * @return bool |
|
| 1379 | - */ |
|
| 1380 | - public function get_customer_address_confirmed( $context = 'view' ) { |
|
| 1381 | - return $this->get_address_confirmed( $context ); |
|
| 1382 | - } |
|
| 1383 | - |
|
| 1384 | - /** |
|
| 1385 | - * Get the shipping address. |
|
| 1386 | - * |
|
| 1387 | - * @since 1.0.19 |
|
| 1388 | - * @return array|false |
|
| 1389 | - */ |
|
| 1390 | - public function get_shipping_address() { |
|
| 1391 | - |
|
| 1392 | - $shipping_address = get_post_meta( $this->get_id(), 'shipping_address', true ); |
|
| 1393 | - return is_array( $shipping_address ) ? $shipping_address : false; |
|
| 1394 | - } |
|
| 1395 | - |
|
| 1396 | - /** |
|
| 1397 | - * Check if the invoice has a shipping address. |
|
| 1398 | - */ |
|
| 1399 | - public function has_shipping_address() { |
|
| 1400 | - return false !== $this->get_shipping_address(); |
|
| 1401 | - } |
|
| 1402 | - |
|
| 1403 | - /** |
|
| 1404 | - * Get the shipping amount. |
|
| 1405 | - * |
|
| 1406 | - * @since 1.0.19 |
|
| 1407 | - * @param string $context View or edit context. |
|
| 1408 | - * @return float |
|
| 1409 | - */ |
|
| 1410 | - public function get_shipping( $context = 'view' ) { |
|
| 1411 | - |
|
| 1412 | - if ( $context = 'view' ) { |
|
| 1413 | - return floatval( $this->get_prop( 'shipping', $context ) ); |
|
| 1414 | - } |
|
| 1307 | + /** |
|
| 1308 | + * Get whether the customer has viewed the invoice or not. |
|
| 1309 | + * |
|
| 1310 | + * @since 1.0.19 |
|
| 1311 | + * @param string $context View or edit context. |
|
| 1312 | + * @return bool |
|
| 1313 | + */ |
|
| 1314 | + public function get_is_viewed( $context = 'view' ) { |
|
| 1315 | + return (bool) $this->get_prop( 'is_viewed', $context ); |
|
| 1316 | + } |
|
| 1317 | + |
|
| 1318 | + /** |
|
| 1319 | + * Get other recipients for invoice communications. |
|
| 1320 | + * |
|
| 1321 | + * @since 1.0.19 |
|
| 1322 | + * @param string $context View or edit context. |
|
| 1323 | + * @return bool |
|
| 1324 | + */ |
|
| 1325 | + public function get_email_cc( $context = 'view' ) { |
|
| 1326 | + return $this->get_prop( 'email_cc', $context ); |
|
| 1327 | + } |
|
| 1328 | + |
|
| 1329 | + /** |
|
| 1330 | + * Get invoice template. |
|
| 1331 | + * |
|
| 1332 | + * @since 1.0.19 |
|
| 1333 | + * @param string $context View or edit context. |
|
| 1334 | + * @return bool |
|
| 1335 | + */ |
|
| 1336 | + public function get_template( $context = 'view' ) { |
|
| 1337 | + return $this->get_prop( 'template', $context ); |
|
| 1338 | + } |
|
| 1339 | + |
|
| 1340 | + /** |
|
| 1341 | + * Get invoice source. |
|
| 1342 | + * |
|
| 1343 | + * @since 1.0.19 |
|
| 1344 | + * @param string $context View or edit context. |
|
| 1345 | + * @return bool |
|
| 1346 | + */ |
|
| 1347 | + public function get_created_via( $context = 'view' ) { |
|
| 1348 | + return $this->get_prop( 'created_via', $context ); |
|
| 1349 | + } |
|
| 1350 | + |
|
| 1351 | + /** |
|
| 1352 | + * Get whether the customer has confirmed their address. |
|
| 1353 | + * |
|
| 1354 | + * @since 1.0.19 |
|
| 1355 | + * @param string $context View or edit context. |
|
| 1356 | + * @return bool |
|
| 1357 | + */ |
|
| 1358 | + public function get_address_confirmed( $context = 'view' ) { |
|
| 1359 | + return (bool) $this->get_prop( 'address_confirmed', $context ); |
|
| 1360 | + } |
|
| 1361 | + |
|
| 1362 | + /** |
|
| 1363 | + * Alias of self::get_address_confirmed(). |
|
| 1364 | + * |
|
| 1365 | + * @since 1.0.19 |
|
| 1366 | + * @param string $context View or edit context. |
|
| 1367 | + * @return bool |
|
| 1368 | + */ |
|
| 1369 | + public function get_user_address_confirmed( $context = 'view' ) { |
|
| 1370 | + return $this->get_address_confirmed( $context ); |
|
| 1371 | + } |
|
| 1372 | + |
|
| 1373 | + /** |
|
| 1374 | + * Alias of self::get_address(). |
|
| 1375 | + * |
|
| 1376 | + * @since 1.0.19 |
|
| 1377 | + * @param string $context View or edit context. |
|
| 1378 | + * @return bool |
|
| 1379 | + */ |
|
| 1380 | + public function get_customer_address_confirmed( $context = 'view' ) { |
|
| 1381 | + return $this->get_address_confirmed( $context ); |
|
| 1382 | + } |
|
| 1383 | + |
|
| 1384 | + /** |
|
| 1385 | + * Get the shipping address. |
|
| 1386 | + * |
|
| 1387 | + * @since 1.0.19 |
|
| 1388 | + * @return array|false |
|
| 1389 | + */ |
|
| 1390 | + public function get_shipping_address() { |
|
| 1391 | + |
|
| 1392 | + $shipping_address = get_post_meta( $this->get_id(), 'shipping_address', true ); |
|
| 1393 | + return is_array( $shipping_address ) ? $shipping_address : false; |
|
| 1394 | + } |
|
| 1395 | + |
|
| 1396 | + /** |
|
| 1397 | + * Check if the invoice has a shipping address. |
|
| 1398 | + */ |
|
| 1399 | + public function has_shipping_address() { |
|
| 1400 | + return false !== $this->get_shipping_address(); |
|
| 1401 | + } |
|
| 1402 | + |
|
| 1403 | + /** |
|
| 1404 | + * Get the shipping amount. |
|
| 1405 | + * |
|
| 1406 | + * @since 1.0.19 |
|
| 1407 | + * @param string $context View or edit context. |
|
| 1408 | + * @return float |
|
| 1409 | + */ |
|
| 1410 | + public function get_shipping( $context = 'view' ) { |
|
| 1411 | + |
|
| 1412 | + if ( $context = 'view' ) { |
|
| 1413 | + return floatval( $this->get_prop( 'shipping', $context ) ); |
|
| 1414 | + } |
|
| 1415 | 1415 | |
| 1416 | - return $this->get_prop( 'shipping', $context ); |
|
| 1416 | + return $this->get_prop( 'shipping', $context ); |
|
| 1417 | 1417 | } |
| 1418 | 1418 | |
| 1419 | - public function has_shipping() { |
|
| 1420 | - return defined( 'GETPAID_SHIPPING_CALCULATOR_VERSION' ) && null !== $this->get_prop( 'shipping', 'edit' ); |
|
| 1419 | + public function has_shipping() { |
|
| 1420 | + return defined( 'GETPAID_SHIPPING_CALCULATOR_VERSION' ) && null !== $this->get_prop( 'shipping', 'edit' ); |
|
| 1421 | 1421 | } |
| 1422 | 1422 | |
| 1423 | 1423 | /** |
| 1424 | - * Get the invoice subtotal. |
|
| 1425 | - * |
|
| 1426 | - * @since 1.0.19 |
|
| 1427 | - * @param string $context View or edit context. |
|
| 1428 | - * @return float |
|
| 1429 | - */ |
|
| 1430 | - public function get_subtotal( $context = 'view' ) { |
|
| 1424 | + * Get the invoice subtotal. |
|
| 1425 | + * |
|
| 1426 | + * @since 1.0.19 |
|
| 1427 | + * @param string $context View or edit context. |
|
| 1428 | + * @return float |
|
| 1429 | + */ |
|
| 1430 | + public function get_subtotal( $context = 'view' ) { |
|
| 1431 | 1431 | $subtotal = (float) $this->get_prop( 'subtotal', $context ); |
| 1432 | 1432 | |
| 1433 | 1433 | // Backwards compatibility. |
@@ -1439,198 +1439,198 @@ discard block |
||
| 1439 | 1439 | } |
| 1440 | 1440 | |
| 1441 | 1441 | /** |
| 1442 | - * Get the invoice discount total. |
|
| 1443 | - * |
|
| 1444 | - * @since 1.0.19 |
|
| 1445 | - * @param string $context View or edit context. |
|
| 1446 | - * @return float |
|
| 1447 | - */ |
|
| 1448 | - public function get_total_discount( $context = 'view' ) { |
|
| 1449 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_discount', $context ) ) ); |
|
| 1442 | + * Get the invoice discount total. |
|
| 1443 | + * |
|
| 1444 | + * @since 1.0.19 |
|
| 1445 | + * @param string $context View or edit context. |
|
| 1446 | + * @return float |
|
| 1447 | + */ |
|
| 1448 | + public function get_total_discount( $context = 'view' ) { |
|
| 1449 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_discount', $context ) ) ); |
|
| 1450 | 1450 | } |
| 1451 | 1451 | |
| 1452 | 1452 | /** |
| 1453 | - * Get the invoice tax total. |
|
| 1454 | - * |
|
| 1455 | - * @since 1.0.19 |
|
| 1456 | - * @param string $context View or edit context. |
|
| 1457 | - * @return float |
|
| 1458 | - */ |
|
| 1459 | - public function get_total_tax( $context = 'view' ) { |
|
| 1460 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_tax', $context ) ) ); |
|
| 1461 | - } |
|
| 1453 | + * Get the invoice tax total. |
|
| 1454 | + * |
|
| 1455 | + * @since 1.0.19 |
|
| 1456 | + * @param string $context View or edit context. |
|
| 1457 | + * @return float |
|
| 1458 | + */ |
|
| 1459 | + public function get_total_tax( $context = 'view' ) { |
|
| 1460 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_tax', $context ) ) ); |
|
| 1461 | + } |
|
| 1462 | 1462 | |
| 1463 | - /** |
|
| 1464 | - * @deprecated |
|
| 1465 | - */ |
|
| 1466 | - public function get_final_tax( $currency = false ) { |
|
| 1467 | - $tax = $this->get_total_tax(); |
|
| 1463 | + /** |
|
| 1464 | + * @deprecated |
|
| 1465 | + */ |
|
| 1466 | + public function get_final_tax( $currency = false ) { |
|
| 1467 | + $tax = $this->get_total_tax(); |
|
| 1468 | 1468 | |
| 1469 | 1469 | if ( $currency ) { |
| 1470 | - return wpinv_price( $tax, $this->get_currency() ); |
|
| 1470 | + return wpinv_price( $tax, $this->get_currency() ); |
|
| 1471 | 1471 | } |
| 1472 | 1472 | |
| 1473 | 1473 | return $tax; |
| 1474 | 1474 | } |
| 1475 | 1475 | |
| 1476 | 1476 | /** |
| 1477 | - * Get the invoice fees total. |
|
| 1478 | - * |
|
| 1479 | - * @since 1.0.19 |
|
| 1480 | - * @param string $context View or edit context. |
|
| 1481 | - * @return float |
|
| 1482 | - */ |
|
| 1483 | - public function get_total_fees( $context = 'view' ) { |
|
| 1484 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_fees', $context ) ) ); |
|
| 1477 | + * Get the invoice fees total. |
|
| 1478 | + * |
|
| 1479 | + * @since 1.0.19 |
|
| 1480 | + * @param string $context View or edit context. |
|
| 1481 | + * @return float |
|
| 1482 | + */ |
|
| 1483 | + public function get_total_fees( $context = 'view' ) { |
|
| 1484 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_fees', $context ) ) ); |
|
| 1485 | + } |
|
| 1486 | + |
|
| 1487 | + /** |
|
| 1488 | + * Alias for self::get_total_fees(). |
|
| 1489 | + * |
|
| 1490 | + * @since 1.0.19 |
|
| 1491 | + * @param string $context View or edit context. |
|
| 1492 | + * @return float |
|
| 1493 | + */ |
|
| 1494 | + public function get_fees_total( $context = 'view' ) { |
|
| 1495 | + return $this->get_total_fees( $context ); |
|
| 1485 | 1496 | } |
| 1486 | 1497 | |
| 1487 | 1498 | /** |
| 1488 | - * Alias for self::get_total_fees(). |
|
| 1489 | - * |
|
| 1490 | - * @since 1.0.19 |
|
| 1491 | - * @param string $context View or edit context. |
|
| 1492 | - * @return float |
|
| 1493 | - */ |
|
| 1494 | - public function get_fees_total( $context = 'view' ) { |
|
| 1495 | - return $this->get_total_fees( $context ); |
|
| 1499 | + * Get the invoice total. |
|
| 1500 | + * |
|
| 1501 | + * @since 1.0.19 |
|
| 1502 | + * @return float |
|
| 1503 | + */ |
|
| 1504 | + public function get_total( $context = 'view' ) { |
|
| 1505 | + $total = $this->get_prop( 'total', $context ); |
|
| 1506 | + |
|
| 1507 | + if ( $this->has_shipping() && $context == 'view' ) { |
|
| 1508 | + $total = $this->get_prop( 'total', $context ) + $this->get_shipping( $context ); |
|
| 1509 | + } |
|
| 1510 | + |
|
| 1511 | + return wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
| 1496 | 1512 | } |
| 1497 | 1513 | |
| 1498 | 1514 | /** |
| 1499 | - * Get the invoice total. |
|
| 1500 | - * |
|
| 1501 | - * @since 1.0.19 |
|
| 1515 | + * Retrieves the non-recurring total of items. |
|
| 1516 | + * |
|
| 1517 | + * @since 2.3.0 |
|
| 1502 | 1518 | * @return float |
| 1503 | - */ |
|
| 1504 | - public function get_total( $context = 'view' ) { |
|
| 1505 | - $total = $this->get_prop( 'total', $context ); |
|
| 1506 | - |
|
| 1507 | - if ( $this->has_shipping() && $context == 'view' ) { |
|
| 1508 | - $total = $this->get_prop( 'total', $context ) + $this->get_shipping( $context ); |
|
| 1509 | - } |
|
| 1510 | - |
|
| 1511 | - return wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
| 1512 | - } |
|
| 1513 | - |
|
| 1514 | - /** |
|
| 1515 | - * Retrieves the non-recurring total of items. |
|
| 1516 | - * |
|
| 1517 | - * @since 2.3.0 |
|
| 1518 | - * @return float |
|
| 1519 | - */ |
|
| 1520 | - public function get_non_recurring_total() { |
|
| 1521 | - |
|
| 1522 | - $subtotal = 0; |
|
| 1523 | - foreach ( $this->get_items() as $item ) { |
|
| 1524 | - if ( ! $item->is_recurring() ) { |
|
| 1525 | - $subtotal += $item->get_sub_total(); |
|
| 1526 | - } |
|
| 1527 | - } |
|
| 1528 | - |
|
| 1529 | - foreach ( $this->get_fees() as $fee ) { |
|
| 1530 | - if ( empty( $fee['recurring_fee'] ) ) { |
|
| 1531 | - $subtotal += wpinv_sanitize_amount( $fee['initial_fee'] ); |
|
| 1532 | - } |
|
| 1533 | - } |
|
| 1534 | - |
|
| 1535 | - $subtotal = wpinv_round_amount( wpinv_sanitize_amount( $subtotal ) ); |
|
| 1519 | + */ |
|
| 1520 | + public function get_non_recurring_total() { |
|
| 1521 | + |
|
| 1522 | + $subtotal = 0; |
|
| 1523 | + foreach ( $this->get_items() as $item ) { |
|
| 1524 | + if ( ! $item->is_recurring() ) { |
|
| 1525 | + $subtotal += $item->get_sub_total(); |
|
| 1526 | + } |
|
| 1527 | + } |
|
| 1528 | + |
|
| 1529 | + foreach ( $this->get_fees() as $fee ) { |
|
| 1530 | + if ( empty( $fee['recurring_fee'] ) ) { |
|
| 1531 | + $subtotal += wpinv_sanitize_amount( $fee['initial_fee'] ); |
|
| 1532 | + } |
|
| 1533 | + } |
|
| 1534 | + |
|
| 1535 | + $subtotal = wpinv_round_amount( wpinv_sanitize_amount( $subtotal ) ); |
|
| 1536 | 1536 | return apply_filters( 'wpinv_get_non_recurring_invoice_total', $subtotal, $this ); |
| 1537 | 1537 | |
| 1538 | 1538 | } |
| 1539 | 1539 | |
| 1540 | - /** |
|
| 1541 | - * Get the invoice totals. |
|
| 1542 | - * |
|
| 1543 | - * @since 1.0.19 |
|
| 1540 | + /** |
|
| 1541 | + * Get the invoice totals. |
|
| 1542 | + * |
|
| 1543 | + * @since 1.0.19 |
|
| 1544 | 1544 | * @return array |
| 1545 | - */ |
|
| 1546 | - public function get_totals() { |
|
| 1547 | - return $this->totals; |
|
| 1545 | + */ |
|
| 1546 | + public function get_totals() { |
|
| 1547 | + return $this->totals; |
|
| 1548 | 1548 | } |
| 1549 | 1549 | |
| 1550 | 1550 | /** |
| 1551 | - * Get the initial invoice total. |
|
| 1552 | - * |
|
| 1553 | - * @since 1.0.19 |
|
| 1551 | + * Get the initial invoice total. |
|
| 1552 | + * |
|
| 1553 | + * @since 1.0.19 |
|
| 1554 | 1554 | * @param string $context View or edit context. |
| 1555 | 1555 | * @return float |
| 1556 | - */ |
|
| 1556 | + */ |
|
| 1557 | 1557 | public function get_initial_total() { |
| 1558 | 1558 | |
| 1559 | - if ( empty( $this->totals ) ) { |
|
| 1560 | - $this->recalculate_total(); |
|
| 1561 | - } |
|
| 1559 | + if ( empty( $this->totals ) ) { |
|
| 1560 | + $this->recalculate_total(); |
|
| 1561 | + } |
|
| 1562 | 1562 | |
| 1563 | - $tax = $this->totals['tax']['initial']; |
|
| 1564 | - $fee = $this->totals['fee']['initial']; |
|
| 1565 | - $discount = $this->totals['discount']['initial']; |
|
| 1566 | - $subtotal = $this->totals['subtotal']['initial']; |
|
| 1567 | - $total = $tax + $fee - $discount + $subtotal; |
|
| 1563 | + $tax = $this->totals['tax']['initial']; |
|
| 1564 | + $fee = $this->totals['fee']['initial']; |
|
| 1565 | + $discount = $this->totals['discount']['initial']; |
|
| 1566 | + $subtotal = $this->totals['subtotal']['initial']; |
|
| 1567 | + $total = $tax + $fee - $discount + $subtotal; |
|
| 1568 | 1568 | |
| 1569 | - if ( 0 > $total ) { |
|
| 1570 | - $total = 0; |
|
| 1571 | - } |
|
| 1569 | + if ( 0 > $total ) { |
|
| 1570 | + $total = 0; |
|
| 1571 | + } |
|
| 1572 | 1572 | |
| 1573 | - $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
| 1573 | + $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
| 1574 | 1574 | return apply_filters( 'wpinv_get_initial_invoice_total', $total, $this ); |
| 1575 | - } |
|
| 1575 | + } |
|
| 1576 | 1576 | |
| 1577 | - /** |
|
| 1578 | - * Get the recurring invoice total. |
|
| 1579 | - * |
|
| 1580 | - * @since 1.0.19 |
|
| 1577 | + /** |
|
| 1578 | + * Get the recurring invoice total. |
|
| 1579 | + * |
|
| 1580 | + * @since 1.0.19 |
|
| 1581 | 1581 | * @param string $context View or edit context. |
| 1582 | 1582 | * @return float |
| 1583 | - */ |
|
| 1583 | + */ |
|
| 1584 | 1584 | public function get_recurring_total() { |
| 1585 | 1585 | |
| 1586 | - if ( empty( $this->totals ) ) { |
|
| 1587 | - $this->recalculate_total(); |
|
| 1588 | - } |
|
| 1586 | + if ( empty( $this->totals ) ) { |
|
| 1587 | + $this->recalculate_total(); |
|
| 1588 | + } |
|
| 1589 | 1589 | |
| 1590 | - $tax = $this->totals['tax']['recurring']; |
|
| 1591 | - $fee = $this->totals['fee']['recurring']; |
|
| 1592 | - $discount = $this->totals['discount']['recurring']; |
|
| 1593 | - $subtotal = $this->totals['subtotal']['recurring']; |
|
| 1594 | - $total = $tax + $fee - $discount + $subtotal; |
|
| 1590 | + $tax = $this->totals['tax']['recurring']; |
|
| 1591 | + $fee = $this->totals['fee']['recurring']; |
|
| 1592 | + $discount = $this->totals['discount']['recurring']; |
|
| 1593 | + $subtotal = $this->totals['subtotal']['recurring']; |
|
| 1594 | + $total = $tax + $fee - $discount + $subtotal; |
|
| 1595 | 1595 | |
| 1596 | - if ( 0 > $total ) { |
|
| 1597 | - $total = 0; |
|
| 1598 | - } |
|
| 1596 | + if ( 0 > $total ) { |
|
| 1597 | + $total = 0; |
|
| 1598 | + } |
|
| 1599 | 1599 | |
| 1600 | - $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
| 1600 | + $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
| 1601 | 1601 | return apply_filters( 'wpinv_get_recurring_invoice_total', $total, $this ); |
| 1602 | - } |
|
| 1602 | + } |
|
| 1603 | 1603 | |
| 1604 | - /** |
|
| 1605 | - * Returns recurring payment details. |
|
| 1606 | - * |
|
| 1607 | - * @since 1.0.19 |
|
| 1604 | + /** |
|
| 1605 | + * Returns recurring payment details. |
|
| 1606 | + * |
|
| 1607 | + * @since 1.0.19 |
|
| 1608 | 1608 | * @param string $field Optionally provide a field to return. |
| 1609 | - * @param string $currency Whether to include the currency. |
|
| 1609 | + * @param string $currency Whether to include the currency. |
|
| 1610 | 1610 | * @return float|string |
| 1611 | - */ |
|
| 1611 | + */ |
|
| 1612 | 1612 | public function get_recurring_details( $field = '', $currency = false ) { |
| 1613 | 1613 | |
| 1614 | - // Maybe recalculate totals. |
|
| 1615 | - if ( empty( $this->totals ) ) { |
|
| 1616 | - $this->recalculate_total(); |
|
| 1617 | - } |
|
| 1614 | + // Maybe recalculate totals. |
|
| 1615 | + if ( empty( $this->totals ) ) { |
|
| 1616 | + $this->recalculate_total(); |
|
| 1617 | + } |
|
| 1618 | 1618 | |
| 1619 | - // Prepare recurring totals. |
|
| 1619 | + // Prepare recurring totals. |
|
| 1620 | 1620 | $data = apply_filters( |
| 1621 | - 'wpinv_get_invoice_recurring_details', |
|
| 1622 | - array( |
|
| 1623 | - 'cart_details' => $this->get_cart_details(), |
|
| 1624 | - 'subtotal' => $this->totals['subtotal']['recurring'], |
|
| 1625 | - 'discount' => $this->totals['discount']['recurring'], |
|
| 1626 | - 'tax' => $this->totals['tax']['recurring'], |
|
| 1627 | - 'fee' => $this->totals['fee']['recurring'], |
|
| 1628 | - 'total' => $this->get_recurring_total(), |
|
| 1629 | - ), |
|
| 1630 | - $this, |
|
| 1631 | - $field, |
|
| 1632 | - $currency |
|
| 1633 | - ); |
|
| 1621 | + 'wpinv_get_invoice_recurring_details', |
|
| 1622 | + array( |
|
| 1623 | + 'cart_details' => $this->get_cart_details(), |
|
| 1624 | + 'subtotal' => $this->totals['subtotal']['recurring'], |
|
| 1625 | + 'discount' => $this->totals['discount']['recurring'], |
|
| 1626 | + 'tax' => $this->totals['tax']['recurring'], |
|
| 1627 | + 'fee' => $this->totals['fee']['recurring'], |
|
| 1628 | + 'total' => $this->get_recurring_total(), |
|
| 1629 | + ), |
|
| 1630 | + $this, |
|
| 1631 | + $field, |
|
| 1632 | + $currency |
|
| 1633 | + ); |
|
| 1634 | 1634 | |
| 1635 | 1635 | if ( isset( $data[$field] ) ) { |
| 1636 | 1636 | return ( $currency ? wpinv_price( $data[$field], $this->get_currency() ) : $data[$field] ); |
@@ -1640,166 +1640,166 @@ discard block |
||
| 1640 | 1640 | } |
| 1641 | 1641 | |
| 1642 | 1642 | /** |
| 1643 | - * Get the invoice fees. |
|
| 1644 | - * |
|
| 1645 | - * @since 1.0.19 |
|
| 1646 | - * @param string $context View or edit context. |
|
| 1647 | - * @return array |
|
| 1648 | - */ |
|
| 1649 | - public function get_fees( $context = 'view' ) { |
|
| 1650 | - return wpinv_parse_list( $this->get_prop( 'fees', $context ) ); |
|
| 1643 | + * Get the invoice fees. |
|
| 1644 | + * |
|
| 1645 | + * @since 1.0.19 |
|
| 1646 | + * @param string $context View or edit context. |
|
| 1647 | + * @return array |
|
| 1648 | + */ |
|
| 1649 | + public function get_fees( $context = 'view' ) { |
|
| 1650 | + return wpinv_parse_list( $this->get_prop( 'fees', $context ) ); |
|
| 1651 | 1651 | } |
| 1652 | 1652 | |
| 1653 | 1653 | /** |
| 1654 | - * Get the invoice discounts. |
|
| 1655 | - * |
|
| 1656 | - * @since 1.0.19 |
|
| 1657 | - * @param string $context View or edit context. |
|
| 1658 | - * @return array |
|
| 1659 | - */ |
|
| 1660 | - public function get_discounts( $context = 'view' ) { |
|
| 1661 | - return wpinv_parse_list( $this->get_prop( 'discounts', $context ) ); |
|
| 1654 | + * Get the invoice discounts. |
|
| 1655 | + * |
|
| 1656 | + * @since 1.0.19 |
|
| 1657 | + * @param string $context View or edit context. |
|
| 1658 | + * @return array |
|
| 1659 | + */ |
|
| 1660 | + public function get_discounts( $context = 'view' ) { |
|
| 1661 | + return wpinv_parse_list( $this->get_prop( 'discounts', $context ) ); |
|
| 1662 | 1662 | } |
| 1663 | 1663 | |
| 1664 | 1664 | /** |
| 1665 | - * Get the invoice taxes. |
|
| 1666 | - * |
|
| 1667 | - * @since 1.0.19 |
|
| 1668 | - * @param string $context View or edit context. |
|
| 1669 | - * @return array |
|
| 1670 | - */ |
|
| 1671 | - public function get_taxes( $context = 'view' ) { |
|
| 1672 | - return wpinv_parse_list( $this->get_prop( 'taxes', $context ) ); |
|
| 1665 | + * Get the invoice taxes. |
|
| 1666 | + * |
|
| 1667 | + * @since 1.0.19 |
|
| 1668 | + * @param string $context View or edit context. |
|
| 1669 | + * @return array |
|
| 1670 | + */ |
|
| 1671 | + public function get_taxes( $context = 'view' ) { |
|
| 1672 | + return wpinv_parse_list( $this->get_prop( 'taxes', $context ) ); |
|
| 1673 | 1673 | } |
| 1674 | 1674 | |
| 1675 | 1675 | /** |
| 1676 | - * Get the invoice items. |
|
| 1677 | - * |
|
| 1678 | - * @since 1.0.19 |
|
| 1679 | - * @param string $context View or edit context. |
|
| 1680 | - * @return GetPaid_Form_Item[] |
|
| 1681 | - */ |
|
| 1682 | - public function get_items( $context = 'view' ) { |
|
| 1676 | + * Get the invoice items. |
|
| 1677 | + * |
|
| 1678 | + * @since 1.0.19 |
|
| 1679 | + * @param string $context View or edit context. |
|
| 1680 | + * @return GetPaid_Form_Item[] |
|
| 1681 | + */ |
|
| 1682 | + public function get_items( $context = 'view' ) { |
|
| 1683 | 1683 | return $this->get_prop( 'items', $context ); |
| 1684 | - } |
|
| 1684 | + } |
|
| 1685 | 1685 | |
| 1686 | - /** |
|
| 1687 | - * Get the invoice item ids. |
|
| 1688 | - * |
|
| 1689 | - * @since 1.0.19 |
|
| 1690 | - * @return string |
|
| 1691 | - */ |
|
| 1692 | - public function get_item_ids() { |
|
| 1693 | - return implode( ', ', wp_list_pluck( $this->get_cart_details(), 'item_id' ) ); |
|
| 1686 | + /** |
|
| 1687 | + * Get the invoice item ids. |
|
| 1688 | + * |
|
| 1689 | + * @since 1.0.19 |
|
| 1690 | + * @return string |
|
| 1691 | + */ |
|
| 1692 | + public function get_item_ids() { |
|
| 1693 | + return implode( ', ', wp_list_pluck( $this->get_cart_details(), 'item_id' ) ); |
|
| 1694 | 1694 | } |
| 1695 | 1695 | |
| 1696 | 1696 | /** |
| 1697 | - * Get the invoice's payment form. |
|
| 1698 | - * |
|
| 1699 | - * @since 1.0.19 |
|
| 1700 | - * @param string $context View or edit context. |
|
| 1701 | - * @return int |
|
| 1702 | - */ |
|
| 1703 | - public function get_payment_form( $context = 'view' ) { |
|
| 1704 | - return intval( $this->get_prop( 'payment_form', $context ) ); |
|
| 1697 | + * Get the invoice's payment form. |
|
| 1698 | + * |
|
| 1699 | + * @since 1.0.19 |
|
| 1700 | + * @param string $context View or edit context. |
|
| 1701 | + * @return int |
|
| 1702 | + */ |
|
| 1703 | + public function get_payment_form( $context = 'view' ) { |
|
| 1704 | + return intval( $this->get_prop( 'payment_form', $context ) ); |
|
| 1705 | 1705 | } |
| 1706 | 1706 | |
| 1707 | 1707 | /** |
| 1708 | - * Get the invoice's submission id. |
|
| 1709 | - * |
|
| 1710 | - * @since 1.0.19 |
|
| 1711 | - * @param string $context View or edit context. |
|
| 1712 | - * @return string |
|
| 1713 | - */ |
|
| 1714 | - public function get_submission_id( $context = 'view' ) { |
|
| 1715 | - return $this->get_prop( 'submission_id', $context ); |
|
| 1708 | + * Get the invoice's submission id. |
|
| 1709 | + * |
|
| 1710 | + * @since 1.0.19 |
|
| 1711 | + * @param string $context View or edit context. |
|
| 1712 | + * @return string |
|
| 1713 | + */ |
|
| 1714 | + public function get_submission_id( $context = 'view' ) { |
|
| 1715 | + return $this->get_prop( 'submission_id', $context ); |
|
| 1716 | 1716 | } |
| 1717 | 1717 | |
| 1718 | 1718 | /** |
| 1719 | - * Get the invoice's discount code. |
|
| 1720 | - * |
|
| 1721 | - * @since 1.0.19 |
|
| 1722 | - * @param string $context View or edit context. |
|
| 1723 | - * @return string |
|
| 1724 | - */ |
|
| 1725 | - public function get_discount_code( $context = 'view' ) { |
|
| 1726 | - return $this->get_prop( 'discount_code', $context ); |
|
| 1719 | + * Get the invoice's discount code. |
|
| 1720 | + * |
|
| 1721 | + * @since 1.0.19 |
|
| 1722 | + * @param string $context View or edit context. |
|
| 1723 | + * @return string |
|
| 1724 | + */ |
|
| 1725 | + public function get_discount_code( $context = 'view' ) { |
|
| 1726 | + return $this->get_prop( 'discount_code', $context ); |
|
| 1727 | 1727 | } |
| 1728 | 1728 | |
| 1729 | 1729 | /** |
| 1730 | - * Get the invoice's gateway. |
|
| 1731 | - * |
|
| 1732 | - * @since 1.0.19 |
|
| 1733 | - * @param string $context View or edit context. |
|
| 1734 | - * @return string |
|
| 1735 | - */ |
|
| 1736 | - public function get_gateway( $context = 'view' ) { |
|
| 1737 | - return $this->get_prop( 'gateway', $context ); |
|
| 1730 | + * Get the invoice's gateway. |
|
| 1731 | + * |
|
| 1732 | + * @since 1.0.19 |
|
| 1733 | + * @param string $context View or edit context. |
|
| 1734 | + * @return string |
|
| 1735 | + */ |
|
| 1736 | + public function get_gateway( $context = 'view' ) { |
|
| 1737 | + return $this->get_prop( 'gateway', $context ); |
|
| 1738 | 1738 | } |
| 1739 | 1739 | |
| 1740 | 1740 | /** |
| 1741 | - * Get the invoice's gateway display title. |
|
| 1742 | - * |
|
| 1743 | - * @since 1.0.19 |
|
| 1744 | - * @return string |
|
| 1745 | - */ |
|
| 1741 | + * Get the invoice's gateway display title. |
|
| 1742 | + * |
|
| 1743 | + * @since 1.0.19 |
|
| 1744 | + * @return string |
|
| 1745 | + */ |
|
| 1746 | 1746 | public function get_gateway_title() { |
| 1747 | 1747 | $title = wpinv_get_gateway_checkout_label( $this->get_gateway() ); |
| 1748 | 1748 | return apply_filters( 'wpinv_gateway_title', $title, $this->get_id(), $this ); |
| 1749 | 1749 | } |
| 1750 | 1750 | |
| 1751 | 1751 | /** |
| 1752 | - * Get the invoice's transaction id. |
|
| 1753 | - * |
|
| 1754 | - * @since 1.0.19 |
|
| 1755 | - * @param string $context View or edit context. |
|
| 1756 | - * @return string |
|
| 1757 | - */ |
|
| 1758 | - public function get_transaction_id( $context = 'view' ) { |
|
| 1759 | - return $this->get_prop( 'transaction_id', $context ); |
|
| 1752 | + * Get the invoice's transaction id. |
|
| 1753 | + * |
|
| 1754 | + * @since 1.0.19 |
|
| 1755 | + * @param string $context View or edit context. |
|
| 1756 | + * @return string |
|
| 1757 | + */ |
|
| 1758 | + public function get_transaction_id( $context = 'view' ) { |
|
| 1759 | + return $this->get_prop( 'transaction_id', $context ); |
|
| 1760 | 1760 | } |
| 1761 | 1761 | |
| 1762 | 1762 | /** |
| 1763 | - * Get the invoice's currency. |
|
| 1764 | - * |
|
| 1765 | - * @since 1.0.19 |
|
| 1766 | - * @param string $context View or edit context. |
|
| 1767 | - * @return string |
|
| 1768 | - */ |
|
| 1769 | - public function get_currency( $context = 'view' ) { |
|
| 1763 | + * Get the invoice's currency. |
|
| 1764 | + * |
|
| 1765 | + * @since 1.0.19 |
|
| 1766 | + * @param string $context View or edit context. |
|
| 1767 | + * @return string |
|
| 1768 | + */ |
|
| 1769 | + public function get_currency( $context = 'view' ) { |
|
| 1770 | 1770 | $currency = $this->get_prop( 'currency', $context ); |
| 1771 | 1771 | return empty( $currency ) ? wpinv_get_currency() : $currency; |
| 1772 | 1772 | } |
| 1773 | 1773 | |
| 1774 | 1774 | /** |
| 1775 | - * Checks if we are charging taxes for this invoice. |
|
| 1776 | - * |
|
| 1777 | - * @since 1.0.19 |
|
| 1778 | - * @param string $context View or edit context. |
|
| 1779 | - * @return bool |
|
| 1780 | - */ |
|
| 1781 | - public function get_disable_taxes( $context = 'view' ) { |
|
| 1775 | + * Checks if we are charging taxes for this invoice. |
|
| 1776 | + * |
|
| 1777 | + * @since 1.0.19 |
|
| 1778 | + * @param string $context View or edit context. |
|
| 1779 | + * @return bool |
|
| 1780 | + */ |
|
| 1781 | + public function get_disable_taxes( $context = 'view' ) { |
|
| 1782 | 1782 | return (bool) $this->get_prop( 'disable_taxes', $context ); |
| 1783 | 1783 | } |
| 1784 | 1784 | |
| 1785 | 1785 | /** |
| 1786 | - * Retrieves the subscription id for an invoice. |
|
| 1787 | - * |
|
| 1788 | - * @since 1.0.19 |
|
| 1789 | - * @param string $context View or edit context. |
|
| 1790 | - * @return int |
|
| 1791 | - */ |
|
| 1786 | + * Retrieves the subscription id for an invoice. |
|
| 1787 | + * |
|
| 1788 | + * @since 1.0.19 |
|
| 1789 | + * @param string $context View or edit context. |
|
| 1790 | + * @return int |
|
| 1791 | + */ |
|
| 1792 | 1792 | public function get_subscription_id( $context = 'view' ) { |
| 1793 | - return $this->is_renewal() ? $this->get_parent()->get_subscription_id( $context ) : $this->get_prop( 'subscription_id', $context ); |
|
| 1794 | - } |
|
| 1795 | - |
|
| 1796 | - /** |
|
| 1797 | - * Retrieves the remote subscription id for an invoice. |
|
| 1798 | - * |
|
| 1799 | - * @since 1.0.19 |
|
| 1800 | - * @param string $context View or edit context. |
|
| 1801 | - * @return int |
|
| 1802 | - */ |
|
| 1793 | + return $this->is_renewal() ? $this->get_parent()->get_subscription_id( $context ) : $this->get_prop( 'subscription_id', $context ); |
|
| 1794 | + } |
|
| 1795 | + |
|
| 1796 | + /** |
|
| 1797 | + * Retrieves the remote subscription id for an invoice. |
|
| 1798 | + * |
|
| 1799 | + * @since 1.0.19 |
|
| 1800 | + * @param string $context View or edit context. |
|
| 1801 | + * @return int |
|
| 1802 | + */ |
|
| 1803 | 1803 | public function get_remote_subscription_id( $context = 'view' ) { |
| 1804 | 1804 | $subscription_id = $this->get_prop( 'remote_subscription_id', $context ); |
| 1805 | 1805 | |
@@ -1812,12 +1812,12 @@ discard block |
||
| 1812 | 1812 | } |
| 1813 | 1813 | |
| 1814 | 1814 | /** |
| 1815 | - * Retrieves the payment meta for an invoice. |
|
| 1816 | - * |
|
| 1817 | - * @since 1.0.19 |
|
| 1818 | - * @param string $context View or edit context. |
|
| 1819 | - * @return array |
|
| 1820 | - */ |
|
| 1815 | + * Retrieves the payment meta for an invoice. |
|
| 1816 | + * |
|
| 1817 | + * @since 1.0.19 |
|
| 1818 | + * @param string $context View or edit context. |
|
| 1819 | + * @return array |
|
| 1820 | + */ |
|
| 1821 | 1821 | public function get_payment_meta( $context = 'view' ) { |
| 1822 | 1822 | |
| 1823 | 1823 | return array( |
@@ -1837,31 +1837,31 @@ discard block |
||
| 1837 | 1837 | } |
| 1838 | 1838 | |
| 1839 | 1839 | /** |
| 1840 | - * Retrieves the cart details for an invoice. |
|
| 1841 | - * |
|
| 1842 | - * @since 1.0.19 |
|
| 1843 | - * @return array |
|
| 1844 | - */ |
|
| 1840 | + * Retrieves the cart details for an invoice. |
|
| 1841 | + * |
|
| 1842 | + * @since 1.0.19 |
|
| 1843 | + * @return array |
|
| 1844 | + */ |
|
| 1845 | 1845 | public function get_cart_details() { |
| 1846 | 1846 | $items = $this->get_items(); |
| 1847 | 1847 | $cart_details = array(); |
| 1848 | 1848 | |
| 1849 | 1849 | foreach ( $items as $item ) { |
| 1850 | - $item->invoice_id = $this->get_id(); |
|
| 1850 | + $item->invoice_id = $this->get_id(); |
|
| 1851 | 1851 | $cart_details[] = $item->prepare_data_for_saving(); |
| 1852 | 1852 | } |
| 1853 | 1853 | |
| 1854 | 1854 | return $cart_details; |
| 1855 | - } |
|
| 1855 | + } |
|
| 1856 | 1856 | |
| 1857 | - /** |
|
| 1858 | - * Retrieves the recurring item. |
|
| 1859 | - * |
|
| 1860 | - * @return null|GetPaid_Form_Item|int |
|
| 1861 | - */ |
|
| 1862 | - public function get_recurring( $object = false ) { |
|
| 1857 | + /** |
|
| 1858 | + * Retrieves the recurring item. |
|
| 1859 | + * |
|
| 1860 | + * @return null|GetPaid_Form_Item|int |
|
| 1861 | + */ |
|
| 1862 | + public function get_recurring( $object = false ) { |
|
| 1863 | 1863 | |
| 1864 | - // Are we returning an object? |
|
| 1864 | + // Are we returning an object? |
|
| 1865 | 1865 | if ( $object ) { |
| 1866 | 1866 | return $this->get_item( $this->recurring_item ); |
| 1867 | 1867 | } |
@@ -1869,124 +1869,124 @@ discard block |
||
| 1869 | 1869 | return $this->recurring_item; |
| 1870 | 1870 | } |
| 1871 | 1871 | |
| 1872 | - /** |
|
| 1873 | - * Retrieves the subscription name. |
|
| 1874 | - * |
|
| 1875 | - * @since 1.0.19 |
|
| 1876 | - * @return string |
|
| 1877 | - */ |
|
| 1878 | - public function get_subscription_name() { |
|
| 1872 | + /** |
|
| 1873 | + * Retrieves the subscription name. |
|
| 1874 | + * |
|
| 1875 | + * @since 1.0.19 |
|
| 1876 | + * @return string |
|
| 1877 | + */ |
|
| 1878 | + public function get_subscription_name() { |
|
| 1879 | 1879 | |
| 1880 | - // Retrieve the recurring name |
|
| 1880 | + // Retrieve the recurring name |
|
| 1881 | 1881 | $item = $this->get_recurring( true ); |
| 1882 | 1882 | |
| 1883 | - // Abort if it does not exist. |
|
| 1883 | + // Abort if it does not exist. |
|
| 1884 | 1884 | if ( empty( $item ) ) { |
| 1885 | 1885 | return ''; |
| 1886 | 1886 | } |
| 1887 | 1887 | |
| 1888 | - // Return the item name. |
|
| 1888 | + // Return the item name. |
|
| 1889 | 1889 | return apply_filters( 'wpinv_invoice_get_subscription_name', $item->get_name(), $this ); |
| 1890 | - } |
|
| 1891 | - |
|
| 1892 | - /** |
|
| 1893 | - * Retrieves the view url. |
|
| 1894 | - * |
|
| 1895 | - * @since 1.0.19 |
|
| 1896 | - * @return string |
|
| 1897 | - */ |
|
| 1898 | - public function get_view_url() { |
|
| 1890 | + } |
|
| 1891 | + |
|
| 1892 | + /** |
|
| 1893 | + * Retrieves the view url. |
|
| 1894 | + * |
|
| 1895 | + * @since 1.0.19 |
|
| 1896 | + * @return string |
|
| 1897 | + */ |
|
| 1898 | + public function get_view_url() { |
|
| 1899 | 1899 | $invoice_url = get_permalink( $this->get_id() ); |
| 1900 | - $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url ); |
|
| 1900 | + $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url ); |
|
| 1901 | 1901 | return apply_filters( 'wpinv_get_view_url', $invoice_url, $this ); |
| 1902 | - } |
|
| 1902 | + } |
|
| 1903 | 1903 | |
| 1904 | - /** |
|
| 1905 | - * Retrieves the payment url. |
|
| 1906 | - * |
|
| 1907 | - * @since 1.0.19 |
|
| 1908 | - * @return string |
|
| 1909 | - */ |
|
| 1910 | - public function get_checkout_payment_url( $deprecated = false, $secret = false ) { |
|
| 1904 | + /** |
|
| 1905 | + * Retrieves the payment url. |
|
| 1906 | + * |
|
| 1907 | + * @since 1.0.19 |
|
| 1908 | + * @return string |
|
| 1909 | + */ |
|
| 1910 | + public function get_checkout_payment_url( $deprecated = false, $secret = false ) { |
|
| 1911 | 1911 | |
| 1912 | - // Retrieve the checkout url. |
|
| 1912 | + // Retrieve the checkout url. |
|
| 1913 | 1913 | $pay_url = wpinv_get_checkout_uri(); |
| 1914 | 1914 | |
| 1915 | - // Maybe force ssl. |
|
| 1915 | + // Maybe force ssl. |
|
| 1916 | 1916 | if ( is_ssl() ) { |
| 1917 | 1917 | $pay_url = str_replace( 'http:', 'https:', $pay_url ); |
| 1918 | 1918 | } |
| 1919 | 1919 | |
| 1920 | - // Add the invoice key. |
|
| 1921 | - $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url ); |
|
| 1920 | + // Add the invoice key. |
|
| 1921 | + $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url ); |
|
| 1922 | 1922 | |
| 1923 | - // (Maybe?) add a secret |
|
| 1923 | + // (Maybe?) add a secret |
|
| 1924 | 1924 | if ( $secret ) { |
| 1925 | 1925 | $pay_url = add_query_arg( array( '_wpipay' => md5( $this->get_user_id() . '::' . $this->get_email() . '::' . $this->get_key() ) ), $pay_url ); |
| 1926 | 1926 | } |
| 1927 | 1927 | |
| 1928 | 1928 | return apply_filters( 'wpinv_get_checkout_payment_url', $pay_url, $this, $deprecated, $secret ); |
| 1929 | - } |
|
| 1929 | + } |
|
| 1930 | 1930 | |
| 1931 | - /** |
|
| 1932 | - * Retrieves the receipt url. |
|
| 1933 | - * |
|
| 1934 | - * @since 1.0.19 |
|
| 1935 | - * @return string |
|
| 1936 | - */ |
|
| 1937 | - public function get_receipt_url() { |
|
| 1938 | - |
|
| 1939 | - // Retrieve the checkout url. |
|
| 1931 | + /** |
|
| 1932 | + * Retrieves the receipt url. |
|
| 1933 | + * |
|
| 1934 | + * @since 1.0.19 |
|
| 1935 | + * @return string |
|
| 1936 | + */ |
|
| 1937 | + public function get_receipt_url() { |
|
| 1938 | + |
|
| 1939 | + // Retrieve the checkout url. |
|
| 1940 | 1940 | $receipt_url = wpinv_get_success_page_uri(); |
| 1941 | 1941 | |
| 1942 | - // Maybe force ssl. |
|
| 1942 | + // Maybe force ssl. |
|
| 1943 | 1943 | if ( is_ssl() ) { |
| 1944 | 1944 | $receipt_url = str_replace( 'http:', 'https:', $receipt_url ); |
| 1945 | 1945 | } |
| 1946 | 1946 | |
| 1947 | - // Add the invoice key. |
|
| 1948 | - $receipt_url = add_query_arg( 'invoice_key', $this->get_key(), $receipt_url ); |
|
| 1947 | + // Add the invoice key. |
|
| 1948 | + $receipt_url = add_query_arg( 'invoice_key', $this->get_key(), $receipt_url ); |
|
| 1949 | 1949 | |
| 1950 | 1950 | return apply_filters( 'getpaid_get_invoice_receipt_url', $receipt_url, $this ); |
| 1951 | - } |
|
| 1952 | - |
|
| 1953 | - /** |
|
| 1954 | - * Retrieves the remote transaction url. |
|
| 1955 | - * |
|
| 1956 | - * @since 1.6.0 |
|
| 1957 | - * @return string |
|
| 1958 | - */ |
|
| 1959 | - public function get_transaction_url() { |
|
| 1960 | - return apply_filters( 'getpaid_gateway_' . $this->get_gateway() . '_transaction_url', '', $this ); |
|
| 1961 | - } |
|
| 1962 | - |
|
| 1963 | - /** |
|
| 1964 | - * Retrieves the default status. |
|
| 1965 | - * |
|
| 1966 | - * @since 1.0.19 |
|
| 1967 | - * @return string |
|
| 1968 | - */ |
|
| 1969 | - public function get_default_status() { |
|
| 1970 | - |
|
| 1971 | - $type = $this->get_type(); |
|
| 1972 | - $status = "wpi-$type-pending"; |
|
| 1973 | - return str_replace( '-invoice', '', $status ); |
|
| 1974 | - |
|
| 1975 | - } |
|
| 1976 | - |
|
| 1977 | - /** |
|
| 1978 | - * Magic method for accessing invoice properties. |
|
| 1979 | - * |
|
| 1980 | - * @since 1.0.15 |
|
| 1981 | - * @access public |
|
| 1982 | - * |
|
| 1983 | - * @param string $key Discount data to retrieve |
|
| 1984 | - * @param string $context View or edit context. |
|
| 1985 | - * @return mixed Value of the given invoice property (if set). |
|
| 1986 | - */ |
|
| 1987 | - public function get( $key, $context = 'view' ) { |
|
| 1951 | + } |
|
| 1952 | + |
|
| 1953 | + /** |
|
| 1954 | + * Retrieves the remote transaction url. |
|
| 1955 | + * |
|
| 1956 | + * @since 1.6.0 |
|
| 1957 | + * @return string |
|
| 1958 | + */ |
|
| 1959 | + public function get_transaction_url() { |
|
| 1960 | + return apply_filters( 'getpaid_gateway_' . $this->get_gateway() . '_transaction_url', '', $this ); |
|
| 1961 | + } |
|
| 1962 | + |
|
| 1963 | + /** |
|
| 1964 | + * Retrieves the default status. |
|
| 1965 | + * |
|
| 1966 | + * @since 1.0.19 |
|
| 1967 | + * @return string |
|
| 1968 | + */ |
|
| 1969 | + public function get_default_status() { |
|
| 1970 | + |
|
| 1971 | + $type = $this->get_type(); |
|
| 1972 | + $status = "wpi-$type-pending"; |
|
| 1973 | + return str_replace( '-invoice', '', $status ); |
|
| 1974 | + |
|
| 1975 | + } |
|
| 1976 | + |
|
| 1977 | + /** |
|
| 1978 | + * Magic method for accessing invoice properties. |
|
| 1979 | + * |
|
| 1980 | + * @since 1.0.15 |
|
| 1981 | + * @access public |
|
| 1982 | + * |
|
| 1983 | + * @param string $key Discount data to retrieve |
|
| 1984 | + * @param string $context View or edit context. |
|
| 1985 | + * @return mixed Value of the given invoice property (if set). |
|
| 1986 | + */ |
|
| 1987 | + public function get( $key, $context = 'view' ) { |
|
| 1988 | 1988 | return $this->get_prop( $key, $context ); |
| 1989 | - } |
|
| 1989 | + } |
|
| 1990 | 1990 | |
| 1991 | 1991 | /* |
| 1992 | 1992 | |-------------------------------------------------------------------------- |
@@ -1999,130 +1999,130 @@ discard block |
||
| 1999 | 1999 | */ |
| 2000 | 2000 | |
| 2001 | 2001 | /** |
| 2002 | - * Magic method for setting invoice properties. |
|
| 2003 | - * |
|
| 2004 | - * @since 1.0.19 |
|
| 2005 | - * @access public |
|
| 2006 | - * |
|
| 2007 | - * @param string $key Discount data to retrieve |
|
| 2008 | - * @param mixed $value new value. |
|
| 2009 | - * @return mixed Value of the given invoice property (if set). |
|
| 2010 | - */ |
|
| 2011 | - public function set( $key, $value ) { |
|
| 2002 | + * Magic method for setting invoice properties. |
|
| 2003 | + * |
|
| 2004 | + * @since 1.0.19 |
|
| 2005 | + * @access public |
|
| 2006 | + * |
|
| 2007 | + * @param string $key Discount data to retrieve |
|
| 2008 | + * @param mixed $value new value. |
|
| 2009 | + * @return mixed Value of the given invoice property (if set). |
|
| 2010 | + */ |
|
| 2011 | + public function set( $key, $value ) { |
|
| 2012 | 2012 | |
| 2013 | 2013 | $setter = "set_$key"; |
| 2014 | 2014 | if ( is_callable( array( $this, $setter ) ) ) { |
| 2015 | 2015 | $this->{$setter}( $value ); |
| 2016 | 2016 | } |
| 2017 | 2017 | |
| 2018 | - } |
|
| 2018 | + } |
|
| 2019 | 2019 | |
| 2020 | - /** |
|
| 2021 | - * Sets item status. |
|
| 2022 | - * |
|
| 2023 | - * @since 1.0.19 |
|
| 2024 | - * @param string $new_status New status. |
|
| 2025 | - * @param string $note Optional note to add. |
|
| 2026 | - * @param bool $manual_update Is this a manual status change?. |
|
| 2027 | - * @return array details of change. |
|
| 2028 | - */ |
|
| 2029 | - public function set_status( $new_status, $note = '', $manual_update = false ) { |
|
| 2030 | - $old_status = $this->get_status(); |
|
| 2020 | + /** |
|
| 2021 | + * Sets item status. |
|
| 2022 | + * |
|
| 2023 | + * @since 1.0.19 |
|
| 2024 | + * @param string $new_status New status. |
|
| 2025 | + * @param string $note Optional note to add. |
|
| 2026 | + * @param bool $manual_update Is this a manual status change?. |
|
| 2027 | + * @return array details of change. |
|
| 2028 | + */ |
|
| 2029 | + public function set_status( $new_status, $note = '', $manual_update = false ) { |
|
| 2030 | + $old_status = $this->get_status(); |
|
| 2031 | 2031 | |
| 2032 | - $statuses = $this->get_all_statuses(); |
|
| 2032 | + $statuses = $this->get_all_statuses(); |
|
| 2033 | 2033 | |
| 2034 | - if ( isset( $statuses[ 'draft' ] ) ) { |
|
| 2035 | - unset( $statuses[ 'draft' ] ); |
|
| 2036 | - } |
|
| 2034 | + if ( isset( $statuses[ 'draft' ] ) ) { |
|
| 2035 | + unset( $statuses[ 'draft' ] ); |
|
| 2036 | + } |
|
| 2037 | 2037 | |
| 2038 | - $this->set_prop( 'status', $new_status ); |
|
| 2038 | + $this->set_prop( 'status', $new_status ); |
|
| 2039 | 2039 | |
| 2040 | - // If setting the status, ensure it's set to a valid status. |
|
| 2041 | - if ( true === $this->object_read ) { |
|
| 2040 | + // If setting the status, ensure it's set to a valid status. |
|
| 2041 | + if ( true === $this->object_read ) { |
|
| 2042 | 2042 | |
| 2043 | - // Only allow valid new status. |
|
| 2044 | - if ( ! array_key_exists( $new_status, $statuses ) ) { |
|
| 2045 | - $new_status = $this->get_default_status(); |
|
| 2046 | - } |
|
| 2043 | + // Only allow valid new status. |
|
| 2044 | + if ( ! array_key_exists( $new_status, $statuses ) ) { |
|
| 2045 | + $new_status = $this->get_default_status(); |
|
| 2046 | + } |
|
| 2047 | 2047 | |
| 2048 | - // If the old status is set but unknown (e.g. draft) assume its pending for action usage. |
|
| 2049 | - if ( $old_status && ! array_key_exists( $new_status, $statuses ) ) { |
|
| 2050 | - $old_status = $this->get_default_status(); |
|
| 2051 | - } |
|
| 2048 | + // If the old status is set but unknown (e.g. draft) assume its pending for action usage. |
|
| 2049 | + if ( $old_status && ! array_key_exists( $new_status, $statuses ) ) { |
|
| 2050 | + $old_status = $this->get_default_status(); |
|
| 2051 | + } |
|
| 2052 | 2052 | |
| 2053 | - // Paid - Renewal (i.e when duplicating a parent invoice ) |
|
| 2054 | - if ( $new_status == 'wpi-pending' && $old_status == 'publish' && ! $this->get_id() ) { |
|
| 2055 | - $old_status = 'wpi-pending'; |
|
| 2056 | - } |
|
| 2053 | + // Paid - Renewal (i.e when duplicating a parent invoice ) |
|
| 2054 | + if ( $new_status == 'wpi-pending' && $old_status == 'publish' && ! $this->get_id() ) { |
|
| 2055 | + $old_status = 'wpi-pending'; |
|
| 2056 | + } |
|
| 2057 | 2057 | |
| 2058 | - if ( $old_status !== $new_status ) { |
|
| 2059 | - $this->status_transition = array( |
|
| 2060 | - 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
| 2061 | - 'to' => $new_status, |
|
| 2062 | - 'note' => $note, |
|
| 2063 | - 'manual' => (bool) $manual_update, |
|
| 2064 | - ); |
|
| 2058 | + if ( $old_status !== $new_status ) { |
|
| 2059 | + $this->status_transition = array( |
|
| 2060 | + 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
| 2061 | + 'to' => $new_status, |
|
| 2062 | + 'note' => $note, |
|
| 2063 | + 'manual' => (bool) $manual_update, |
|
| 2064 | + ); |
|
| 2065 | 2065 | |
| 2066 | - if ( $manual_update ) { |
|
| 2067 | - do_action( 'getpaid_' . $this->object_type .'_edit_status', $this->get_id(), $new_status ); |
|
| 2068 | - } |
|
| 2066 | + if ( $manual_update ) { |
|
| 2067 | + do_action( 'getpaid_' . $this->object_type .'_edit_status', $this->get_id(), $new_status ); |
|
| 2068 | + } |
|
| 2069 | 2069 | |
| 2070 | - $this->maybe_set_date_paid(); |
|
| 2070 | + $this->maybe_set_date_paid(); |
|
| 2071 | 2071 | |
| 2072 | - } |
|
| 2072 | + } |
|
| 2073 | 2073 | |
| 2074 | - } |
|
| 2074 | + } |
|
| 2075 | 2075 | |
| 2076 | - return array( |
|
| 2077 | - 'from' => $old_status, |
|
| 2078 | - 'to' => $new_status, |
|
| 2079 | - ); |
|
| 2080 | - } |
|
| 2076 | + return array( |
|
| 2077 | + 'from' => $old_status, |
|
| 2078 | + 'to' => $new_status, |
|
| 2079 | + ); |
|
| 2080 | + } |
|
| 2081 | 2081 | |
| 2082 | - /** |
|
| 2083 | - * Maybe set date paid. |
|
| 2084 | - * |
|
| 2085 | - * Sets the date paid variable when transitioning to the payment complete |
|
| 2086 | - * order status. |
|
| 2087 | - * |
|
| 2088 | - * @since 1.0.19 |
|
| 2089 | - */ |
|
| 2090 | - public function maybe_set_date_paid() { |
|
| 2082 | + /** |
|
| 2083 | + * Maybe set date paid. |
|
| 2084 | + * |
|
| 2085 | + * Sets the date paid variable when transitioning to the payment complete |
|
| 2086 | + * order status. |
|
| 2087 | + * |
|
| 2088 | + * @since 1.0.19 |
|
| 2089 | + */ |
|
| 2090 | + public function maybe_set_date_paid() { |
|
| 2091 | 2091 | |
| 2092 | - if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) { |
|
| 2093 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
| 2094 | - } |
|
| 2095 | - } |
|
| 2092 | + if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) { |
|
| 2093 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
| 2094 | + } |
|
| 2095 | + } |
|
| 2096 | 2096 | |
| 2097 | 2097 | /** |
| 2098 | - * Set parent invoice ID. |
|
| 2099 | - * |
|
| 2100 | - * @since 1.0.19 |
|
| 2101 | - */ |
|
| 2102 | - public function set_parent_id( $value ) { |
|
| 2103 | - if ( $value && ( $value === $this->get_id() ) ) { |
|
| 2104 | - return; |
|
| 2105 | - } |
|
| 2106 | - $this->set_prop( 'parent_id', absint( $value ) ); |
|
| 2098 | + * Set parent invoice ID. |
|
| 2099 | + * |
|
| 2100 | + * @since 1.0.19 |
|
| 2101 | + */ |
|
| 2102 | + public function set_parent_id( $value ) { |
|
| 2103 | + if ( $value && ( $value === $this->get_id() ) ) { |
|
| 2104 | + return; |
|
| 2105 | + } |
|
| 2106 | + $this->set_prop( 'parent_id', absint( $value ) ); |
|
| 2107 | 2107 | } |
| 2108 | 2108 | |
| 2109 | 2109 | /** |
| 2110 | - * Set plugin version when the invoice was created. |
|
| 2111 | - * |
|
| 2112 | - * @since 1.0.19 |
|
| 2113 | - */ |
|
| 2114 | - public function set_version( $value ) { |
|
| 2115 | - $this->set_prop( 'version', $value ); |
|
| 2110 | + * Set plugin version when the invoice was created. |
|
| 2111 | + * |
|
| 2112 | + * @since 1.0.19 |
|
| 2113 | + */ |
|
| 2114 | + public function set_version( $value ) { |
|
| 2115 | + $this->set_prop( 'version', $value ); |
|
| 2116 | 2116 | } |
| 2117 | - |
|
| 2118 | - /** |
|
| 2119 | - * Set date when the invoice was created. |
|
| 2120 | - * |
|
| 2121 | - * @since 1.0.19 |
|
| 2122 | - * @param string $value Value to set. |
|
| 2117 | + |
|
| 2118 | + /** |
|
| 2119 | + * Set date when the invoice was created. |
|
| 2120 | + * |
|
| 2121 | + * @since 1.0.19 |
|
| 2122 | + * @param string $value Value to set. |
|
| 2123 | 2123 | * @return bool Whether or not the date was set. |
| 2124 | - */ |
|
| 2125 | - public function set_date_created( $value ) { |
|
| 2124 | + */ |
|
| 2125 | + public function set_date_created( $value ) { |
|
| 2126 | 2126 | $date = strtotime( $value ); |
| 2127 | 2127 | |
| 2128 | 2128 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2130,19 +2130,19 @@ discard block |
||
| 2130 | 2130 | return true; |
| 2131 | 2131 | } |
| 2132 | 2132 | |
| 2133 | - $this->set_prop( 'date_created', '' ); |
|
| 2134 | - return false; |
|
| 2133 | + $this->set_prop( 'date_created', '' ); |
|
| 2134 | + return false; |
|
| 2135 | 2135 | |
| 2136 | 2136 | } |
| 2137 | 2137 | |
| 2138 | 2138 | /** |
| 2139 | - * Set date invoice due date. |
|
| 2140 | - * |
|
| 2141 | - * @since 1.0.19 |
|
| 2142 | - * @param string $value Value to set. |
|
| 2139 | + * Set date invoice due date. |
|
| 2140 | + * |
|
| 2141 | + * @since 1.0.19 |
|
| 2142 | + * @param string $value Value to set. |
|
| 2143 | 2143 | * @return bool Whether or not the date was set. |
| 2144 | - */ |
|
| 2145 | - public function set_due_date( $value ) { |
|
| 2144 | + */ |
|
| 2145 | + public function set_due_date( $value ) { |
|
| 2146 | 2146 | $date = strtotime( $value ); |
| 2147 | 2147 | |
| 2148 | 2148 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2150,29 +2150,29 @@ discard block |
||
| 2150 | 2150 | return true; |
| 2151 | 2151 | } |
| 2152 | 2152 | |
| 2153 | - $this->set_prop( 'due_date', '' ); |
|
| 2153 | + $this->set_prop( 'due_date', '' ); |
|
| 2154 | 2154 | return false; |
| 2155 | 2155 | |
| 2156 | 2156 | } |
| 2157 | 2157 | |
| 2158 | 2158 | /** |
| 2159 | - * Alias of self::set_due_date(). |
|
| 2160 | - * |
|
| 2161 | - * @since 1.0.19 |
|
| 2162 | - * @param string $value New name. |
|
| 2163 | - */ |
|
| 2164 | - public function set_date_due( $value ) { |
|
| 2165 | - $this->set_due_date( $value ); |
|
| 2159 | + * Alias of self::set_due_date(). |
|
| 2160 | + * |
|
| 2161 | + * @since 1.0.19 |
|
| 2162 | + * @param string $value New name. |
|
| 2163 | + */ |
|
| 2164 | + public function set_date_due( $value ) { |
|
| 2165 | + $this->set_due_date( $value ); |
|
| 2166 | 2166 | } |
| 2167 | 2167 | |
| 2168 | 2168 | /** |
| 2169 | - * Set date invoice was completed. |
|
| 2170 | - * |
|
| 2171 | - * @since 1.0.19 |
|
| 2172 | - * @param string $value Value to set. |
|
| 2169 | + * Set date invoice was completed. |
|
| 2170 | + * |
|
| 2171 | + * @since 1.0.19 |
|
| 2172 | + * @param string $value Value to set. |
|
| 2173 | 2173 | * @return bool Whether or not the date was set. |
| 2174 | - */ |
|
| 2175 | - public function set_completed_date( $value ) { |
|
| 2174 | + */ |
|
| 2175 | + public function set_completed_date( $value ) { |
|
| 2176 | 2176 | $date = strtotime( $value ); |
| 2177 | 2177 | |
| 2178 | 2178 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2180,29 +2180,29 @@ discard block |
||
| 2180 | 2180 | return true; |
| 2181 | 2181 | } |
| 2182 | 2182 | |
| 2183 | - $this->set_prop( 'completed_date', '' ); |
|
| 2183 | + $this->set_prop( 'completed_date', '' ); |
|
| 2184 | 2184 | return false; |
| 2185 | 2185 | |
| 2186 | 2186 | } |
| 2187 | 2187 | |
| 2188 | 2188 | /** |
| 2189 | - * Alias of self::set_completed_date(). |
|
| 2190 | - * |
|
| 2191 | - * @since 1.0.19 |
|
| 2192 | - * @param string $value New name. |
|
| 2193 | - */ |
|
| 2194 | - public function set_date_completed( $value ) { |
|
| 2195 | - $this->set_completed_date( $value ); |
|
| 2189 | + * Alias of self::set_completed_date(). |
|
| 2190 | + * |
|
| 2191 | + * @since 1.0.19 |
|
| 2192 | + * @param string $value New name. |
|
| 2193 | + */ |
|
| 2194 | + public function set_date_completed( $value ) { |
|
| 2195 | + $this->set_completed_date( $value ); |
|
| 2196 | 2196 | } |
| 2197 | 2197 | |
| 2198 | 2198 | /** |
| 2199 | - * Set date when the invoice was last modified. |
|
| 2200 | - * |
|
| 2201 | - * @since 1.0.19 |
|
| 2202 | - * @param string $value Value to set. |
|
| 2199 | + * Set date when the invoice was last modified. |
|
| 2200 | + * |
|
| 2201 | + * @since 1.0.19 |
|
| 2202 | + * @param string $value Value to set. |
|
| 2203 | 2203 | * @return bool Whether or not the date was set. |
| 2204 | - */ |
|
| 2205 | - public function set_date_modified( $value ) { |
|
| 2204 | + */ |
|
| 2205 | + public function set_date_modified( $value ) { |
|
| 2206 | 2206 | $date = strtotime( $value ); |
| 2207 | 2207 | |
| 2208 | 2208 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2210,813 +2210,813 @@ discard block |
||
| 2210 | 2210 | return true; |
| 2211 | 2211 | } |
| 2212 | 2212 | |
| 2213 | - $this->set_prop( 'date_modified', '' ); |
|
| 2213 | + $this->set_prop( 'date_modified', '' ); |
|
| 2214 | 2214 | return false; |
| 2215 | 2215 | |
| 2216 | 2216 | } |
| 2217 | 2217 | |
| 2218 | 2218 | /** |
| 2219 | - * Set the invoice number. |
|
| 2220 | - * |
|
| 2221 | - * @since 1.0.19 |
|
| 2222 | - * @param string $value New number. |
|
| 2223 | - */ |
|
| 2224 | - public function set_number( $value ) { |
|
| 2219 | + * Set the invoice number. |
|
| 2220 | + * |
|
| 2221 | + * @since 1.0.19 |
|
| 2222 | + * @param string $value New number. |
|
| 2223 | + */ |
|
| 2224 | + public function set_number( $value ) { |
|
| 2225 | 2225 | $number = sanitize_text_field( $value ); |
| 2226 | - $this->set_prop( 'number', $number ); |
|
| 2226 | + $this->set_prop( 'number', $number ); |
|
| 2227 | 2227 | } |
| 2228 | 2228 | |
| 2229 | 2229 | /** |
| 2230 | - * Set the invoice type. |
|
| 2231 | - * |
|
| 2232 | - * @since 1.0.19 |
|
| 2233 | - * @param string $value Type. |
|
| 2234 | - */ |
|
| 2235 | - public function set_type( $value ) { |
|
| 2230 | + * Set the invoice type. |
|
| 2231 | + * |
|
| 2232 | + * @since 1.0.19 |
|
| 2233 | + * @param string $value Type. |
|
| 2234 | + */ |
|
| 2235 | + public function set_type( $value ) { |
|
| 2236 | 2236 | $type = sanitize_text_field( str_replace( 'wpi_', '', $value ) ); |
| 2237 | - $this->set_prop( 'type', $type ); |
|
| 2238 | - } |
|
| 2237 | + $this->set_prop( 'type', $type ); |
|
| 2238 | + } |
|
| 2239 | 2239 | |
| 2240 | 2240 | /** |
| 2241 | - * Set the invoice post type. |
|
| 2242 | - * |
|
| 2243 | - * @since 1.0.19 |
|
| 2244 | - * @param string $value Post type. |
|
| 2245 | - */ |
|
| 2246 | - public function set_post_type( $value ) { |
|
| 2241 | + * Set the invoice post type. |
|
| 2242 | + * |
|
| 2243 | + * @since 1.0.19 |
|
| 2244 | + * @param string $value Post type. |
|
| 2245 | + */ |
|
| 2246 | + public function set_post_type( $value ) { |
|
| 2247 | 2247 | if ( getpaid_is_invoice_post_type( $value ) ) { |
| 2248 | - $this->set_type( $value ); |
|
| 2248 | + $this->set_type( $value ); |
|
| 2249 | 2249 | $this->set_prop( 'post_type', $value ); |
| 2250 | 2250 | } |
| 2251 | 2251 | } |
| 2252 | 2252 | |
| 2253 | 2253 | /** |
| 2254 | - * Set the invoice key. |
|
| 2255 | - * |
|
| 2256 | - * @since 1.0.19 |
|
| 2257 | - * @param string $value New key. |
|
| 2258 | - */ |
|
| 2259 | - public function set_key( $value ) { |
|
| 2254 | + * Set the invoice key. |
|
| 2255 | + * |
|
| 2256 | + * @since 1.0.19 |
|
| 2257 | + * @param string $value New key. |
|
| 2258 | + */ |
|
| 2259 | + public function set_key( $value ) { |
|
| 2260 | 2260 | $key = sanitize_text_field( $value ); |
| 2261 | - $this->set_prop( 'key', $key ); |
|
| 2261 | + $this->set_prop( 'key', $key ); |
|
| 2262 | 2262 | } |
| 2263 | 2263 | |
| 2264 | 2264 | /** |
| 2265 | - * Set the invoice mode. |
|
| 2266 | - * |
|
| 2267 | - * @since 1.0.19 |
|
| 2268 | - * @param string $value mode. |
|
| 2269 | - */ |
|
| 2270 | - public function set_mode( $value ) { |
|
| 2265 | + * Set the invoice mode. |
|
| 2266 | + * |
|
| 2267 | + * @since 1.0.19 |
|
| 2268 | + * @param string $value mode. |
|
| 2269 | + */ |
|
| 2270 | + public function set_mode( $value ) { |
|
| 2271 | 2271 | if ( in_array( $value, array( 'live', 'test' ) ) ) { |
| 2272 | 2272 | $this->set_prop( 'mode', $value ); |
| 2273 | 2273 | } |
| 2274 | 2274 | } |
| 2275 | 2275 | |
| 2276 | 2276 | /** |
| 2277 | - * Set the invoice path. |
|
| 2278 | - * |
|
| 2279 | - * @since 1.0.19 |
|
| 2280 | - * @param string $value path. |
|
| 2281 | - */ |
|
| 2282 | - public function set_path( $value ) { |
|
| 2277 | + * Set the invoice path. |
|
| 2278 | + * |
|
| 2279 | + * @since 1.0.19 |
|
| 2280 | + * @param string $value path. |
|
| 2281 | + */ |
|
| 2282 | + public function set_path( $value ) { |
|
| 2283 | 2283 | $this->set_prop( 'path', $value ); |
| 2284 | 2284 | } |
| 2285 | 2285 | |
| 2286 | 2286 | /** |
| 2287 | - * Set the invoice name. |
|
| 2288 | - * |
|
| 2289 | - * @since 1.0.19 |
|
| 2290 | - * @param string $value New name. |
|
| 2291 | - */ |
|
| 2292 | - public function set_name( $value ) { |
|
| 2287 | + * Set the invoice name. |
|
| 2288 | + * |
|
| 2289 | + * @since 1.0.19 |
|
| 2290 | + * @param string $value New name. |
|
| 2291 | + */ |
|
| 2292 | + public function set_name( $value ) { |
|
| 2293 | 2293 | $name = sanitize_text_field( $value ); |
| 2294 | - $this->set_prop( 'name', $name ); |
|
| 2294 | + $this->set_prop( 'name', $name ); |
|
| 2295 | 2295 | } |
| 2296 | 2296 | |
| 2297 | 2297 | /** |
| 2298 | - * Alias of self::set_name(). |
|
| 2299 | - * |
|
| 2300 | - * @since 1.0.19 |
|
| 2301 | - * @param string $value New name. |
|
| 2302 | - */ |
|
| 2303 | - public function set_title( $value ) { |
|
| 2304 | - $this->set_name( $value ); |
|
| 2298 | + * Alias of self::set_name(). |
|
| 2299 | + * |
|
| 2300 | + * @since 1.0.19 |
|
| 2301 | + * @param string $value New name. |
|
| 2302 | + */ |
|
| 2303 | + public function set_title( $value ) { |
|
| 2304 | + $this->set_name( $value ); |
|
| 2305 | 2305 | } |
| 2306 | 2306 | |
| 2307 | 2307 | /** |
| 2308 | - * Set the invoice description. |
|
| 2309 | - * |
|
| 2310 | - * @since 1.0.19 |
|
| 2311 | - * @param string $value New description. |
|
| 2312 | - */ |
|
| 2313 | - public function set_description( $value ) { |
|
| 2308 | + * Set the invoice description. |
|
| 2309 | + * |
|
| 2310 | + * @since 1.0.19 |
|
| 2311 | + * @param string $value New description. |
|
| 2312 | + */ |
|
| 2313 | + public function set_description( $value ) { |
|
| 2314 | 2314 | $description = wp_kses_post( $value ); |
| 2315 | - $this->set_prop( 'description', $description ); |
|
| 2315 | + $this->set_prop( 'description', $description ); |
|
| 2316 | + } |
|
| 2317 | + |
|
| 2318 | + /** |
|
| 2319 | + * Alias of self::set_description(). |
|
| 2320 | + * |
|
| 2321 | + * @since 1.0.19 |
|
| 2322 | + * @param string $value New description. |
|
| 2323 | + */ |
|
| 2324 | + public function set_excerpt( $value ) { |
|
| 2325 | + $this->set_description( $value ); |
|
| 2326 | + } |
|
| 2327 | + |
|
| 2328 | + /** |
|
| 2329 | + * Alias of self::set_description(). |
|
| 2330 | + * |
|
| 2331 | + * @since 1.0.19 |
|
| 2332 | + * @param string $value New description. |
|
| 2333 | + */ |
|
| 2334 | + public function set_summary( $value ) { |
|
| 2335 | + $this->set_description( $value ); |
|
| 2336 | + } |
|
| 2337 | + |
|
| 2338 | + /** |
|
| 2339 | + * Set the receiver of the invoice. |
|
| 2340 | + * |
|
| 2341 | + * @since 1.0.19 |
|
| 2342 | + * @param int $value New author. |
|
| 2343 | + */ |
|
| 2344 | + public function set_author( $value ) { |
|
| 2345 | + $user = get_user_by( 'id', (int) $value ); |
|
| 2346 | + |
|
| 2347 | + if ( $user && $user->ID ) { |
|
| 2348 | + $this->set_prop( 'author', $user->ID ); |
|
| 2349 | + $this->set_prop( 'email', $user->user_email ); |
|
| 2350 | + } |
|
| 2351 | + |
|
| 2352 | + } |
|
| 2353 | + |
|
| 2354 | + /** |
|
| 2355 | + * Alias of self::set_author(). |
|
| 2356 | + * |
|
| 2357 | + * @since 1.0.19 |
|
| 2358 | + * @param int $value New user id. |
|
| 2359 | + */ |
|
| 2360 | + public function set_user_id( $value ) { |
|
| 2361 | + $this->set_author( $value ); |
|
| 2362 | + } |
|
| 2363 | + |
|
| 2364 | + /** |
|
| 2365 | + * Alias of self::set_author(). |
|
| 2366 | + * |
|
| 2367 | + * @since 1.0.19 |
|
| 2368 | + * @param int $value New user id. |
|
| 2369 | + */ |
|
| 2370 | + public function set_customer_id( $value ) { |
|
| 2371 | + $this->set_author( $value ); |
|
| 2372 | + } |
|
| 2373 | + |
|
| 2374 | + /** |
|
| 2375 | + * Set the customer's ip. |
|
| 2376 | + * |
|
| 2377 | + * @since 1.0.19 |
|
| 2378 | + * @param string $value ip address. |
|
| 2379 | + */ |
|
| 2380 | + public function set_ip( $value ) { |
|
| 2381 | + $this->set_prop( 'ip', $value ); |
|
| 2382 | + } |
|
| 2383 | + |
|
| 2384 | + /** |
|
| 2385 | + * Alias of self::set_ip(). |
|
| 2386 | + * |
|
| 2387 | + * @since 1.0.19 |
|
| 2388 | + * @param string $value ip address. |
|
| 2389 | + */ |
|
| 2390 | + public function set_user_ip( $value ) { |
|
| 2391 | + $this->set_ip( $value ); |
|
| 2392 | + } |
|
| 2393 | + |
|
| 2394 | + /** |
|
| 2395 | + * Set the customer's first name. |
|
| 2396 | + * |
|
| 2397 | + * @since 1.0.19 |
|
| 2398 | + * @param string $value first name. |
|
| 2399 | + */ |
|
| 2400 | + public function set_first_name( $value ) { |
|
| 2401 | + $this->set_prop( 'first_name', $value ); |
|
| 2402 | + } |
|
| 2403 | + |
|
| 2404 | + /** |
|
| 2405 | + * Alias of self::set_first_name(). |
|
| 2406 | + * |
|
| 2407 | + * @since 1.0.19 |
|
| 2408 | + * @param string $value first name. |
|
| 2409 | + */ |
|
| 2410 | + public function set_user_first_name( $value ) { |
|
| 2411 | + $this->set_first_name( $value ); |
|
| 2412 | + } |
|
| 2413 | + |
|
| 2414 | + /** |
|
| 2415 | + * Alias of self::set_first_name(). |
|
| 2416 | + * |
|
| 2417 | + * @since 1.0.19 |
|
| 2418 | + * @param string $value first name. |
|
| 2419 | + */ |
|
| 2420 | + public function set_customer_first_name( $value ) { |
|
| 2421 | + $this->set_first_name( $value ); |
|
| 2422 | + } |
|
| 2423 | + |
|
| 2424 | + /** |
|
| 2425 | + * Set the customer's last name. |
|
| 2426 | + * |
|
| 2427 | + * @since 1.0.19 |
|
| 2428 | + * @param string $value last name. |
|
| 2429 | + */ |
|
| 2430 | + public function set_last_name( $value ) { |
|
| 2431 | + $this->set_prop( 'last_name', $value ); |
|
| 2432 | + } |
|
| 2433 | + |
|
| 2434 | + /** |
|
| 2435 | + * Alias of self::set_last_name(). |
|
| 2436 | + * |
|
| 2437 | + * @since 1.0.19 |
|
| 2438 | + * @param string $value last name. |
|
| 2439 | + */ |
|
| 2440 | + public function set_user_last_name( $value ) { |
|
| 2441 | + $this->set_last_name( $value ); |
|
| 2442 | + } |
|
| 2443 | + |
|
| 2444 | + /** |
|
| 2445 | + * Alias of self::set_last_name(). |
|
| 2446 | + * |
|
| 2447 | + * @since 1.0.19 |
|
| 2448 | + * @param string $value last name. |
|
| 2449 | + */ |
|
| 2450 | + public function set_customer_last_name( $value ) { |
|
| 2451 | + $this->set_last_name( $value ); |
|
| 2452 | + } |
|
| 2453 | + |
|
| 2454 | + /** |
|
| 2455 | + * Set the customer's phone number. |
|
| 2456 | + * |
|
| 2457 | + * @since 1.0.19 |
|
| 2458 | + * @param string $value phone. |
|
| 2459 | + */ |
|
| 2460 | + public function set_phone( $value ) { |
|
| 2461 | + $this->set_prop( 'phone', $value ); |
|
| 2316 | 2462 | } |
| 2317 | 2463 | |
| 2318 | 2464 | /** |
| 2319 | - * Alias of self::set_description(). |
|
| 2320 | - * |
|
| 2321 | - * @since 1.0.19 |
|
| 2322 | - * @param string $value New description. |
|
| 2323 | - */ |
|
| 2324 | - public function set_excerpt( $value ) { |
|
| 2325 | - $this->set_description( $value ); |
|
| 2465 | + * Alias of self::set_phone(). |
|
| 2466 | + * |
|
| 2467 | + * @since 1.0.19 |
|
| 2468 | + * @param string $value phone. |
|
| 2469 | + */ |
|
| 2470 | + public function set_user_phone( $value ) { |
|
| 2471 | + $this->set_phone( $value ); |
|
| 2326 | 2472 | } |
| 2327 | 2473 | |
| 2328 | 2474 | /** |
| 2329 | - * Alias of self::set_description(). |
|
| 2330 | - * |
|
| 2331 | - * @since 1.0.19 |
|
| 2332 | - * @param string $value New description. |
|
| 2333 | - */ |
|
| 2334 | - public function set_summary( $value ) { |
|
| 2335 | - $this->set_description( $value ); |
|
| 2475 | + * Alias of self::set_phone(). |
|
| 2476 | + * |
|
| 2477 | + * @since 1.0.19 |
|
| 2478 | + * @param string $value phone. |
|
| 2479 | + */ |
|
| 2480 | + public function set_customer_phone( $value ) { |
|
| 2481 | + $this->set_phone( $value ); |
|
| 2336 | 2482 | } |
| 2337 | 2483 | |
| 2338 | 2484 | /** |
| 2339 | - * Set the receiver of the invoice. |
|
| 2340 | - * |
|
| 2341 | - * @since 1.0.19 |
|
| 2342 | - * @param int $value New author. |
|
| 2343 | - */ |
|
| 2344 | - public function set_author( $value ) { |
|
| 2345 | - $user = get_user_by( 'id', (int) $value ); |
|
| 2485 | + * Alias of self::set_phone(). |
|
| 2486 | + * |
|
| 2487 | + * @since 1.0.19 |
|
| 2488 | + * @param string $value phone. |
|
| 2489 | + */ |
|
| 2490 | + public function set_phone_number( $value ) { |
|
| 2491 | + $this->set_phone( $value ); |
|
| 2492 | + } |
|
| 2346 | 2493 | |
| 2347 | - if ( $user && $user->ID ) { |
|
| 2348 | - $this->set_prop( 'author', $user->ID ); |
|
| 2349 | - $this->set_prop( 'email', $user->user_email ); |
|
| 2350 | - } |
|
| 2494 | + /** |
|
| 2495 | + * Set the customer's email address. |
|
| 2496 | + * |
|
| 2497 | + * @since 1.0.19 |
|
| 2498 | + * @param string $value email address. |
|
| 2499 | + */ |
|
| 2500 | + public function set_email( $value ) { |
|
| 2501 | + $this->set_prop( 'email', $value ); |
|
| 2502 | + } |
|
| 2351 | 2503 | |
| 2504 | + /** |
|
| 2505 | + * Alias of self::set_email(). |
|
| 2506 | + * |
|
| 2507 | + * @since 1.0.19 |
|
| 2508 | + * @param string $value email address. |
|
| 2509 | + */ |
|
| 2510 | + public function set_user_email( $value ) { |
|
| 2511 | + $this->set_email( $value ); |
|
| 2352 | 2512 | } |
| 2353 | 2513 | |
| 2354 | 2514 | /** |
| 2355 | - * Alias of self::set_author(). |
|
| 2356 | - * |
|
| 2357 | - * @since 1.0.19 |
|
| 2358 | - * @param int $value New user id. |
|
| 2359 | - */ |
|
| 2360 | - public function set_user_id( $value ) { |
|
| 2361 | - $this->set_author( $value ); |
|
| 2515 | + * Alias of self::set_email(). |
|
| 2516 | + * |
|
| 2517 | + * @since 1.0.19 |
|
| 2518 | + * @param string $value email address. |
|
| 2519 | + */ |
|
| 2520 | + public function set_email_address( $value ) { |
|
| 2521 | + $this->set_email( $value ); |
|
| 2362 | 2522 | } |
| 2363 | 2523 | |
| 2364 | 2524 | /** |
| 2365 | - * Alias of self::set_author(). |
|
| 2366 | - * |
|
| 2367 | - * @since 1.0.19 |
|
| 2368 | - * @param int $value New user id. |
|
| 2369 | - */ |
|
| 2370 | - public function set_customer_id( $value ) { |
|
| 2371 | - $this->set_author( $value ); |
|
| 2525 | + * Alias of self::set_email(). |
|
| 2526 | + * |
|
| 2527 | + * @since 1.0.19 |
|
| 2528 | + * @param string $value email address. |
|
| 2529 | + */ |
|
| 2530 | + public function set_customer_email( $value ) { |
|
| 2531 | + $this->set_email( $value ); |
|
| 2372 | 2532 | } |
| 2373 | 2533 | |
| 2374 | 2534 | /** |
| 2375 | - * Set the customer's ip. |
|
| 2376 | - * |
|
| 2377 | - * @since 1.0.19 |
|
| 2378 | - * @param string $value ip address. |
|
| 2379 | - */ |
|
| 2380 | - public function set_ip( $value ) { |
|
| 2381 | - $this->set_prop( 'ip', $value ); |
|
| 2535 | + * Set the customer's country. |
|
| 2536 | + * |
|
| 2537 | + * @since 1.0.19 |
|
| 2538 | + * @param string $value country. |
|
| 2539 | + */ |
|
| 2540 | + public function set_country( $value ) { |
|
| 2541 | + $this->set_prop( 'country', $value ); |
|
| 2382 | 2542 | } |
| 2383 | 2543 | |
| 2384 | 2544 | /** |
| 2385 | - * Alias of self::set_ip(). |
|
| 2386 | - * |
|
| 2387 | - * @since 1.0.19 |
|
| 2388 | - * @param string $value ip address. |
|
| 2389 | - */ |
|
| 2390 | - public function set_user_ip( $value ) { |
|
| 2391 | - $this->set_ip( $value ); |
|
| 2545 | + * Alias of self::set_country(). |
|
| 2546 | + * |
|
| 2547 | + * @since 1.0.19 |
|
| 2548 | + * @param string $value country. |
|
| 2549 | + */ |
|
| 2550 | + public function set_user_country( $value ) { |
|
| 2551 | + $this->set_country( $value ); |
|
| 2392 | 2552 | } |
| 2393 | 2553 | |
| 2394 | 2554 | /** |
| 2395 | - * Set the customer's first name. |
|
| 2396 | - * |
|
| 2397 | - * @since 1.0.19 |
|
| 2398 | - * @param string $value first name. |
|
| 2399 | - */ |
|
| 2400 | - public function set_first_name( $value ) { |
|
| 2401 | - $this->set_prop( 'first_name', $value ); |
|
| 2555 | + * Alias of self::set_country(). |
|
| 2556 | + * |
|
| 2557 | + * @since 1.0.19 |
|
| 2558 | + * @param string $value country. |
|
| 2559 | + */ |
|
| 2560 | + public function set_customer_country( $value ) { |
|
| 2561 | + $this->set_country( $value ); |
|
| 2402 | 2562 | } |
| 2403 | 2563 | |
| 2404 | 2564 | /** |
| 2405 | - * Alias of self::set_first_name(). |
|
| 2406 | - * |
|
| 2407 | - * @since 1.0.19 |
|
| 2408 | - * @param string $value first name. |
|
| 2409 | - */ |
|
| 2410 | - public function set_user_first_name( $value ) { |
|
| 2411 | - $this->set_first_name( $value ); |
|
| 2565 | + * Set the customer's state. |
|
| 2566 | + * |
|
| 2567 | + * @since 1.0.19 |
|
| 2568 | + * @param string $value state. |
|
| 2569 | + */ |
|
| 2570 | + public function set_state( $value ) { |
|
| 2571 | + $this->set_prop( 'state', $value ); |
|
| 2412 | 2572 | } |
| 2413 | 2573 | |
| 2414 | 2574 | /** |
| 2415 | - * Alias of self::set_first_name(). |
|
| 2416 | - * |
|
| 2417 | - * @since 1.0.19 |
|
| 2418 | - * @param string $value first name. |
|
| 2419 | - */ |
|
| 2420 | - public function set_customer_first_name( $value ) { |
|
| 2421 | - $this->set_first_name( $value ); |
|
| 2575 | + * Alias of self::set_state(). |
|
| 2576 | + * |
|
| 2577 | + * @since 1.0.19 |
|
| 2578 | + * @param string $value state. |
|
| 2579 | + */ |
|
| 2580 | + public function set_user_state( $value ) { |
|
| 2581 | + $this->set_state( $value ); |
|
| 2422 | 2582 | } |
| 2423 | 2583 | |
| 2424 | 2584 | /** |
| 2425 | - * Set the customer's last name. |
|
| 2426 | - * |
|
| 2427 | - * @since 1.0.19 |
|
| 2428 | - * @param string $value last name. |
|
| 2429 | - */ |
|
| 2430 | - public function set_last_name( $value ) { |
|
| 2431 | - $this->set_prop( 'last_name', $value ); |
|
| 2585 | + * Alias of self::set_state(). |
|
| 2586 | + * |
|
| 2587 | + * @since 1.0.19 |
|
| 2588 | + * @param string $value state. |
|
| 2589 | + */ |
|
| 2590 | + public function set_customer_state( $value ) { |
|
| 2591 | + $this->set_state( $value ); |
|
| 2432 | 2592 | } |
| 2433 | 2593 | |
| 2434 | 2594 | /** |
| 2435 | - * Alias of self::set_last_name(). |
|
| 2436 | - * |
|
| 2437 | - * @since 1.0.19 |
|
| 2438 | - * @param string $value last name. |
|
| 2439 | - */ |
|
| 2440 | - public function set_user_last_name( $value ) { |
|
| 2441 | - $this->set_last_name( $value ); |
|
| 2595 | + * Set the customer's city. |
|
| 2596 | + * |
|
| 2597 | + * @since 1.0.19 |
|
| 2598 | + * @param string $value city. |
|
| 2599 | + */ |
|
| 2600 | + public function set_city( $value ) { |
|
| 2601 | + $this->set_prop( 'city', $value ); |
|
| 2442 | 2602 | } |
| 2443 | 2603 | |
| 2444 | 2604 | /** |
| 2445 | - * Alias of self::set_last_name(). |
|
| 2446 | - * |
|
| 2447 | - * @since 1.0.19 |
|
| 2448 | - * @param string $value last name. |
|
| 2449 | - */ |
|
| 2450 | - public function set_customer_last_name( $value ) { |
|
| 2451 | - $this->set_last_name( $value ); |
|
| 2605 | + * Alias of self::set_city(). |
|
| 2606 | + * |
|
| 2607 | + * @since 1.0.19 |
|
| 2608 | + * @param string $value city. |
|
| 2609 | + */ |
|
| 2610 | + public function set_user_city( $value ) { |
|
| 2611 | + $this->set_city( $value ); |
|
| 2452 | 2612 | } |
| 2453 | 2613 | |
| 2454 | 2614 | /** |
| 2455 | - * Set the customer's phone number. |
|
| 2456 | - * |
|
| 2457 | - * @since 1.0.19 |
|
| 2458 | - * @param string $value phone. |
|
| 2459 | - */ |
|
| 2460 | - public function set_phone( $value ) { |
|
| 2461 | - $this->set_prop( 'phone', $value ); |
|
| 2615 | + * Alias of self::set_city(). |
|
| 2616 | + * |
|
| 2617 | + * @since 1.0.19 |
|
| 2618 | + * @param string $value city. |
|
| 2619 | + */ |
|
| 2620 | + public function set_customer_city( $value ) { |
|
| 2621 | + $this->set_city( $value ); |
|
| 2462 | 2622 | } |
| 2463 | 2623 | |
| 2464 | 2624 | /** |
| 2465 | - * Alias of self::set_phone(). |
|
| 2466 | - * |
|
| 2467 | - * @since 1.0.19 |
|
| 2468 | - * @param string $value phone. |
|
| 2469 | - */ |
|
| 2470 | - public function set_user_phone( $value ) { |
|
| 2471 | - $this->set_phone( $value ); |
|
| 2625 | + * Set the customer's zip code. |
|
| 2626 | + * |
|
| 2627 | + * @since 1.0.19 |
|
| 2628 | + * @param string $value zip. |
|
| 2629 | + */ |
|
| 2630 | + public function set_zip( $value ) { |
|
| 2631 | + $this->set_prop( 'zip', $value ); |
|
| 2472 | 2632 | } |
| 2473 | 2633 | |
| 2474 | 2634 | /** |
| 2475 | - * Alias of self::set_phone(). |
|
| 2476 | - * |
|
| 2477 | - * @since 1.0.19 |
|
| 2478 | - * @param string $value phone. |
|
| 2479 | - */ |
|
| 2480 | - public function set_customer_phone( $value ) { |
|
| 2481 | - $this->set_phone( $value ); |
|
| 2635 | + * Alias of self::set_zip(). |
|
| 2636 | + * |
|
| 2637 | + * @since 1.0.19 |
|
| 2638 | + * @param string $value zip. |
|
| 2639 | + */ |
|
| 2640 | + public function set_user_zip( $value ) { |
|
| 2641 | + $this->set_zip( $value ); |
|
| 2482 | 2642 | } |
| 2483 | 2643 | |
| 2484 | 2644 | /** |
| 2485 | - * Alias of self::set_phone(). |
|
| 2486 | - * |
|
| 2487 | - * @since 1.0.19 |
|
| 2488 | - * @param string $value phone. |
|
| 2489 | - */ |
|
| 2490 | - public function set_phone_number( $value ) { |
|
| 2491 | - $this->set_phone( $value ); |
|
| 2645 | + * Alias of self::set_zip(). |
|
| 2646 | + * |
|
| 2647 | + * @since 1.0.19 |
|
| 2648 | + * @param string $value zip. |
|
| 2649 | + */ |
|
| 2650 | + public function set_customer_zip( $value ) { |
|
| 2651 | + $this->set_zip( $value ); |
|
| 2492 | 2652 | } |
| 2493 | 2653 | |
| 2494 | 2654 | /** |
| 2495 | - * Set the customer's email address. |
|
| 2496 | - * |
|
| 2497 | - * @since 1.0.19 |
|
| 2498 | - * @param string $value email address. |
|
| 2499 | - */ |
|
| 2500 | - public function set_email( $value ) { |
|
| 2501 | - $this->set_prop( 'email', $value ); |
|
| 2655 | + * Set the customer's company. |
|
| 2656 | + * |
|
| 2657 | + * @since 1.0.19 |
|
| 2658 | + * @param string $value company. |
|
| 2659 | + */ |
|
| 2660 | + public function set_company( $value ) { |
|
| 2661 | + $this->set_prop( 'company', $value ); |
|
| 2502 | 2662 | } |
| 2503 | 2663 | |
| 2504 | 2664 | /** |
| 2505 | - * Alias of self::set_email(). |
|
| 2506 | - * |
|
| 2507 | - * @since 1.0.19 |
|
| 2508 | - * @param string $value email address. |
|
| 2509 | - */ |
|
| 2510 | - public function set_user_email( $value ) { |
|
| 2511 | - $this->set_email( $value ); |
|
| 2665 | + * Alias of self::set_company(). |
|
| 2666 | + * |
|
| 2667 | + * @since 1.0.19 |
|
| 2668 | + * @param string $value company. |
|
| 2669 | + */ |
|
| 2670 | + public function set_user_company( $value ) { |
|
| 2671 | + $this->set_company( $value ); |
|
| 2512 | 2672 | } |
| 2513 | 2673 | |
| 2514 | 2674 | /** |
| 2515 | - * Alias of self::set_email(). |
|
| 2516 | - * |
|
| 2517 | - * @since 1.0.19 |
|
| 2518 | - * @param string $value email address. |
|
| 2519 | - */ |
|
| 2520 | - public function set_email_address( $value ) { |
|
| 2521 | - $this->set_email( $value ); |
|
| 2675 | + * Alias of self::set_company(). |
|
| 2676 | + * |
|
| 2677 | + * @since 1.0.19 |
|
| 2678 | + * @param string $value company. |
|
| 2679 | + */ |
|
| 2680 | + public function set_customer_company( $value ) { |
|
| 2681 | + $this->set_company( $value ); |
|
| 2522 | 2682 | } |
| 2523 | 2683 | |
| 2524 | 2684 | /** |
| 2525 | - * Alias of self::set_email(). |
|
| 2526 | - * |
|
| 2527 | - * @since 1.0.19 |
|
| 2528 | - * @param string $value email address. |
|
| 2529 | - */ |
|
| 2530 | - public function set_customer_email( $value ) { |
|
| 2531 | - $this->set_email( $value ); |
|
| 2685 | + * Set the customer's company id. |
|
| 2686 | + * |
|
| 2687 | + * @since 1.0.19 |
|
| 2688 | + * @param string $value company id. |
|
| 2689 | + */ |
|
| 2690 | + public function set_company_id( $value ) { |
|
| 2691 | + $this->set_prop( 'company_id', $value ); |
|
| 2532 | 2692 | } |
| 2533 | 2693 | |
| 2534 | 2694 | /** |
| 2535 | - * Set the customer's country. |
|
| 2536 | - * |
|
| 2537 | - * @since 1.0.19 |
|
| 2538 | - * @param string $value country. |
|
| 2539 | - */ |
|
| 2540 | - public function set_country( $value ) { |
|
| 2541 | - $this->set_prop( 'country', $value ); |
|
| 2695 | + * Set the customer's var number. |
|
| 2696 | + * |
|
| 2697 | + * @since 1.0.19 |
|
| 2698 | + * @param string $value var number. |
|
| 2699 | + */ |
|
| 2700 | + public function set_vat_number( $value ) { |
|
| 2701 | + $this->set_prop( 'vat_number', $value ); |
|
| 2542 | 2702 | } |
| 2543 | 2703 | |
| 2544 | 2704 | /** |
| 2545 | - * Alias of self::set_country(). |
|
| 2546 | - * |
|
| 2547 | - * @since 1.0.19 |
|
| 2548 | - * @param string $value country. |
|
| 2549 | - */ |
|
| 2550 | - public function set_user_country( $value ) { |
|
| 2551 | - $this->set_country( $value ); |
|
| 2705 | + * Alias of self::set_vat_number(). |
|
| 2706 | + * |
|
| 2707 | + * @since 1.0.19 |
|
| 2708 | + * @param string $value var number. |
|
| 2709 | + */ |
|
| 2710 | + public function set_user_vat_number( $value ) { |
|
| 2711 | + $this->set_vat_number( $value ); |
|
| 2552 | 2712 | } |
| 2553 | 2713 | |
| 2554 | 2714 | /** |
| 2555 | - * Alias of self::set_country(). |
|
| 2556 | - * |
|
| 2557 | - * @since 1.0.19 |
|
| 2558 | - * @param string $value country. |
|
| 2559 | - */ |
|
| 2560 | - public function set_customer_country( $value ) { |
|
| 2561 | - $this->set_country( $value ); |
|
| 2715 | + * Alias of self::set_vat_number(). |
|
| 2716 | + * |
|
| 2717 | + * @since 1.0.19 |
|
| 2718 | + * @param string $value var number. |
|
| 2719 | + */ |
|
| 2720 | + public function set_customer_vat_number( $value ) { |
|
| 2721 | + $this->set_vat_number( $value ); |
|
| 2562 | 2722 | } |
| 2563 | 2723 | |
| 2564 | 2724 | /** |
| 2565 | - * Set the customer's state. |
|
| 2566 | - * |
|
| 2567 | - * @since 1.0.19 |
|
| 2568 | - * @param string $value state. |
|
| 2569 | - */ |
|
| 2570 | - public function set_state( $value ) { |
|
| 2571 | - $this->set_prop( 'state', $value ); |
|
| 2725 | + * Set the customer's vat rate. |
|
| 2726 | + * |
|
| 2727 | + * @since 1.0.19 |
|
| 2728 | + * @param string $value var rate. |
|
| 2729 | + */ |
|
| 2730 | + public function set_vat_rate( $value ) { |
|
| 2731 | + $this->set_prop( 'vat_rate', $value ); |
|
| 2572 | 2732 | } |
| 2573 | 2733 | |
| 2574 | 2734 | /** |
| 2575 | - * Alias of self::set_state(). |
|
| 2576 | - * |
|
| 2577 | - * @since 1.0.19 |
|
| 2578 | - * @param string $value state. |
|
| 2579 | - */ |
|
| 2580 | - public function set_user_state( $value ) { |
|
| 2581 | - $this->set_state( $value ); |
|
| 2735 | + * Alias of self::set_vat_rate(). |
|
| 2736 | + * |
|
| 2737 | + * @since 1.0.19 |
|
| 2738 | + * @param string $value var number. |
|
| 2739 | + */ |
|
| 2740 | + public function set_user_vat_rate( $value ) { |
|
| 2741 | + $this->set_vat_rate( $value ); |
|
| 2582 | 2742 | } |
| 2583 | 2743 | |
| 2584 | 2744 | /** |
| 2585 | - * Alias of self::set_state(). |
|
| 2586 | - * |
|
| 2587 | - * @since 1.0.19 |
|
| 2588 | - * @param string $value state. |
|
| 2589 | - */ |
|
| 2590 | - public function set_customer_state( $value ) { |
|
| 2591 | - $this->set_state( $value ); |
|
| 2745 | + * Alias of self::set_vat_rate(). |
|
| 2746 | + * |
|
| 2747 | + * @since 1.0.19 |
|
| 2748 | + * @param string $value var number. |
|
| 2749 | + */ |
|
| 2750 | + public function set_customer_vat_rate( $value ) { |
|
| 2751 | + $this->set_vat_rate( $value ); |
|
| 2592 | 2752 | } |
| 2593 | 2753 | |
| 2594 | 2754 | /** |
| 2595 | - * Set the customer's city. |
|
| 2596 | - * |
|
| 2597 | - * @since 1.0.19 |
|
| 2598 | - * @param string $value city. |
|
| 2599 | - */ |
|
| 2600 | - public function set_city( $value ) { |
|
| 2601 | - $this->set_prop( 'city', $value ); |
|
| 2755 | + * Set the customer's address. |
|
| 2756 | + * |
|
| 2757 | + * @since 1.0.19 |
|
| 2758 | + * @param string $value address. |
|
| 2759 | + */ |
|
| 2760 | + public function set_address( $value ) { |
|
| 2761 | + $this->set_prop( 'address', $value ); |
|
| 2602 | 2762 | } |
| 2603 | 2763 | |
| 2604 | 2764 | /** |
| 2605 | - * Alias of self::set_city(). |
|
| 2606 | - * |
|
| 2607 | - * @since 1.0.19 |
|
| 2608 | - * @param string $value city. |
|
| 2609 | - */ |
|
| 2610 | - public function set_user_city( $value ) { |
|
| 2611 | - $this->set_city( $value ); |
|
| 2765 | + * Alias of self::set_address(). |
|
| 2766 | + * |
|
| 2767 | + * @since 1.0.19 |
|
| 2768 | + * @param string $value address. |
|
| 2769 | + */ |
|
| 2770 | + public function set_user_address( $value ) { |
|
| 2771 | + $this->set_address( $value ); |
|
| 2612 | 2772 | } |
| 2613 | 2773 | |
| 2614 | 2774 | /** |
| 2615 | - * Alias of self::set_city(). |
|
| 2616 | - * |
|
| 2617 | - * @since 1.0.19 |
|
| 2618 | - * @param string $value city. |
|
| 2619 | - */ |
|
| 2620 | - public function set_customer_city( $value ) { |
|
| 2621 | - $this->set_city( $value ); |
|
| 2775 | + * Alias of self::set_address(). |
|
| 2776 | + * |
|
| 2777 | + * @since 1.0.19 |
|
| 2778 | + * @param string $value address. |
|
| 2779 | + */ |
|
| 2780 | + public function set_customer_address( $value ) { |
|
| 2781 | + $this->set_address( $value ); |
|
| 2622 | 2782 | } |
| 2623 | 2783 | |
| 2624 | 2784 | /** |
| 2625 | - * Set the customer's zip code. |
|
| 2626 | - * |
|
| 2627 | - * @since 1.0.19 |
|
| 2628 | - * @param string $value zip. |
|
| 2629 | - */ |
|
| 2630 | - public function set_zip( $value ) { |
|
| 2631 | - $this->set_prop( 'zip', $value ); |
|
| 2785 | + * Set whether the customer has viewed the invoice or not. |
|
| 2786 | + * |
|
| 2787 | + * @since 1.0.19 |
|
| 2788 | + * @param int|bool $value confirmed. |
|
| 2789 | + */ |
|
| 2790 | + public function set_is_viewed( $value ) { |
|
| 2791 | + $this->set_prop( 'is_viewed', $value ); |
|
| 2632 | 2792 | } |
| 2633 | 2793 | |
| 2634 | 2794 | /** |
| 2635 | - * Alias of self::set_zip(). |
|
| 2636 | - * |
|
| 2637 | - * @since 1.0.19 |
|
| 2638 | - * @param string $value zip. |
|
| 2639 | - */ |
|
| 2640 | - public function set_user_zip( $value ) { |
|
| 2641 | - $this->set_zip( $value ); |
|
| 2795 | + * Set extra email recipients. |
|
| 2796 | + * |
|
| 2797 | + * @since 1.0.19 |
|
| 2798 | + * @param string $value email recipients. |
|
| 2799 | + */ |
|
| 2800 | + public function set_email_cc( $value ) { |
|
| 2801 | + $this->set_prop( 'email_cc', $value ); |
|
| 2642 | 2802 | } |
| 2643 | 2803 | |
| 2644 | 2804 | /** |
| 2645 | - * Alias of self::set_zip(). |
|
| 2646 | - * |
|
| 2647 | - * @since 1.0.19 |
|
| 2648 | - * @param string $value zip. |
|
| 2649 | - */ |
|
| 2650 | - public function set_customer_zip( $value ) { |
|
| 2651 | - $this->set_zip( $value ); |
|
| 2805 | + * Set the invoice template. |
|
| 2806 | + * |
|
| 2807 | + * @since 1.0.19 |
|
| 2808 | + * @param string $value template. |
|
| 2809 | + */ |
|
| 2810 | + public function set_template( $value ) { |
|
| 2811 | + if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) { |
|
| 2812 | + $this->set_prop( 'template', $value ); |
|
| 2813 | + } |
|
| 2652 | 2814 | } |
| 2653 | 2815 | |
| 2654 | 2816 | /** |
| 2655 | - * Set the customer's company. |
|
| 2656 | - * |
|
| 2657 | - * @since 1.0.19 |
|
| 2658 | - * @param string $value company. |
|
| 2659 | - */ |
|
| 2660 | - public function set_company( $value ) { |
|
| 2661 | - $this->set_prop( 'company', $value ); |
|
| 2817 | + * Set the invoice source. |
|
| 2818 | + * |
|
| 2819 | + * @since 1.0.19 |
|
| 2820 | + * @param string $value source. |
|
| 2821 | + * @deprecated |
|
| 2822 | + */ |
|
| 2823 | + public function created_via( $value ) { |
|
| 2824 | + $this->set_created_via( sanitize_text_field( $value ) ); |
|
| 2662 | 2825 | } |
| 2663 | 2826 | |
| 2664 | 2827 | /** |
| 2665 | - * Alias of self::set_company(). |
|
| 2666 | - * |
|
| 2667 | - * @since 1.0.19 |
|
| 2668 | - * @param string $value company. |
|
| 2669 | - */ |
|
| 2670 | - public function set_user_company( $value ) { |
|
| 2671 | - $this->set_company( $value ); |
|
| 2828 | + * Set the invoice source. |
|
| 2829 | + * |
|
| 2830 | + * @since 1.0.19 |
|
| 2831 | + * @param string $value source. |
|
| 2832 | + */ |
|
| 2833 | + public function set_created_via( $value ) { |
|
| 2834 | + $this->set_prop( 'created_via', sanitize_text_field( $value ) ); |
|
| 2672 | 2835 | } |
| 2673 | 2836 | |
| 2674 | 2837 | /** |
| 2675 | - * Alias of self::set_company(). |
|
| 2676 | - * |
|
| 2677 | - * @since 1.0.19 |
|
| 2678 | - * @param string $value company. |
|
| 2679 | - */ |
|
| 2680 | - public function set_customer_company( $value ) { |
|
| 2681 | - $this->set_company( $value ); |
|
| 2682 | - } |
|
| 2683 | - |
|
| 2684 | - /** |
|
| 2685 | - * Set the customer's company id. |
|
| 2686 | - * |
|
| 2687 | - * @since 1.0.19 |
|
| 2688 | - * @param string $value company id. |
|
| 2689 | - */ |
|
| 2690 | - public function set_company_id( $value ) { |
|
| 2691 | - $this->set_prop( 'company_id', $value ); |
|
| 2838 | + * Set the customer's address confirmed status. |
|
| 2839 | + * |
|
| 2840 | + * @since 1.0.19 |
|
| 2841 | + * @param int|bool $value confirmed. |
|
| 2842 | + */ |
|
| 2843 | + public function set_address_confirmed( $value ) { |
|
| 2844 | + $this->set_prop( 'address_confirmed', $value ); |
|
| 2692 | 2845 | } |
| 2693 | 2846 | |
| 2694 | 2847 | /** |
| 2695 | - * Set the customer's var number. |
|
| 2696 | - * |
|
| 2697 | - * @since 1.0.19 |
|
| 2698 | - * @param string $value var number. |
|
| 2699 | - */ |
|
| 2700 | - public function set_vat_number( $value ) { |
|
| 2701 | - $this->set_prop( 'vat_number', $value ); |
|
| 2848 | + * Alias of self::set_address_confirmed(). |
|
| 2849 | + * |
|
| 2850 | + * @since 1.0.19 |
|
| 2851 | + * @param int|bool $value confirmed. |
|
| 2852 | + */ |
|
| 2853 | + public function set_user_address_confirmed( $value ) { |
|
| 2854 | + $this->set_address_confirmed( $value ); |
|
| 2702 | 2855 | } |
| 2703 | 2856 | |
| 2704 | 2857 | /** |
| 2705 | - * Alias of self::set_vat_number(). |
|
| 2706 | - * |
|
| 2707 | - * @since 1.0.19 |
|
| 2708 | - * @param string $value var number. |
|
| 2709 | - */ |
|
| 2710 | - public function set_user_vat_number( $value ) { |
|
| 2711 | - $this->set_vat_number( $value ); |
|
| 2858 | + * Alias of self::set_address_confirmed(). |
|
| 2859 | + * |
|
| 2860 | + * @since 1.0.19 |
|
| 2861 | + * @param int|bool $value confirmed. |
|
| 2862 | + */ |
|
| 2863 | + public function set_customer_address_confirmed( $value ) { |
|
| 2864 | + $this->set_address_confirmed( $value ); |
|
| 2712 | 2865 | } |
| 2713 | 2866 | |
| 2714 | 2867 | /** |
| 2715 | - * Alias of self::set_vat_number(). |
|
| 2716 | - * |
|
| 2717 | - * @since 1.0.19 |
|
| 2718 | - * @param string $value var number. |
|
| 2719 | - */ |
|
| 2720 | - public function set_customer_vat_number( $value ) { |
|
| 2721 | - $this->set_vat_number( $value ); |
|
| 2868 | + * Set the shipping fee |
|
| 2869 | + * |
|
| 2870 | + * @since 1.0.19 |
|
| 2871 | + * @param float $value shipping amount. |
|
| 2872 | + */ |
|
| 2873 | + public function set_shipping( $value ) { |
|
| 2874 | + |
|
| 2875 | + if ( ! is_numeric( $value ) ) { |
|
| 2876 | + return $this->set_prop( 'shipping', null ); |
|
| 2877 | + } |
|
| 2878 | + |
|
| 2879 | + $this->set_prop( 'shipping', max( 0, floatval( $value ) ) ); |
|
| 2722 | 2880 | } |
| 2723 | 2881 | |
| 2724 | 2882 | /** |
| 2725 | - * Set the customer's vat rate. |
|
| 2726 | - * |
|
| 2727 | - * @since 1.0.19 |
|
| 2728 | - * @param string $value var rate. |
|
| 2729 | - */ |
|
| 2730 | - public function set_vat_rate( $value ) { |
|
| 2731 | - $this->set_prop( 'vat_rate', $value ); |
|
| 2883 | + * Set the invoice sub total. |
|
| 2884 | + * |
|
| 2885 | + * @since 1.0.19 |
|
| 2886 | + * @param float $value sub total. |
|
| 2887 | + */ |
|
| 2888 | + public function set_subtotal( $value ) { |
|
| 2889 | + $this->set_prop( 'subtotal', max( 0, $value ) ); |
|
| 2732 | 2890 | } |
| 2733 | 2891 | |
| 2734 | - /** |
|
| 2735 | - * Alias of self::set_vat_rate(). |
|
| 2736 | - * |
|
| 2737 | - * @since 1.0.19 |
|
| 2738 | - * @param string $value var number. |
|
| 2739 | - */ |
|
| 2740 | - public function set_user_vat_rate( $value ) { |
|
| 2741 | - $this->set_vat_rate( $value ); |
|
| 2742 | - } |
|
| 2743 | - |
|
| 2744 | - /** |
|
| 2745 | - * Alias of self::set_vat_rate(). |
|
| 2746 | - * |
|
| 2747 | - * @since 1.0.19 |
|
| 2748 | - * @param string $value var number. |
|
| 2749 | - */ |
|
| 2750 | - public function set_customer_vat_rate( $value ) { |
|
| 2751 | - $this->set_vat_rate( $value ); |
|
| 2752 | - } |
|
| 2753 | - |
|
| 2754 | - /** |
|
| 2755 | - * Set the customer's address. |
|
| 2756 | - * |
|
| 2757 | - * @since 1.0.19 |
|
| 2758 | - * @param string $value address. |
|
| 2759 | - */ |
|
| 2760 | - public function set_address( $value ) { |
|
| 2761 | - $this->set_prop( 'address', $value ); |
|
| 2762 | - } |
|
| 2763 | - |
|
| 2764 | - /** |
|
| 2765 | - * Alias of self::set_address(). |
|
| 2766 | - * |
|
| 2767 | - * @since 1.0.19 |
|
| 2768 | - * @param string $value address. |
|
| 2769 | - */ |
|
| 2770 | - public function set_user_address( $value ) { |
|
| 2771 | - $this->set_address( $value ); |
|
| 2772 | - } |
|
| 2773 | - |
|
| 2774 | - /** |
|
| 2775 | - * Alias of self::set_address(). |
|
| 2776 | - * |
|
| 2777 | - * @since 1.0.19 |
|
| 2778 | - * @param string $value address. |
|
| 2779 | - */ |
|
| 2780 | - public function set_customer_address( $value ) { |
|
| 2781 | - $this->set_address( $value ); |
|
| 2782 | - } |
|
| 2783 | - |
|
| 2784 | - /** |
|
| 2785 | - * Set whether the customer has viewed the invoice or not. |
|
| 2786 | - * |
|
| 2787 | - * @since 1.0.19 |
|
| 2788 | - * @param int|bool $value confirmed. |
|
| 2789 | - */ |
|
| 2790 | - public function set_is_viewed( $value ) { |
|
| 2791 | - $this->set_prop( 'is_viewed', $value ); |
|
| 2792 | - } |
|
| 2793 | - |
|
| 2794 | - /** |
|
| 2795 | - * Set extra email recipients. |
|
| 2796 | - * |
|
| 2797 | - * @since 1.0.19 |
|
| 2798 | - * @param string $value email recipients. |
|
| 2799 | - */ |
|
| 2800 | - public function set_email_cc( $value ) { |
|
| 2801 | - $this->set_prop( 'email_cc', $value ); |
|
| 2802 | - } |
|
| 2803 | - |
|
| 2804 | - /** |
|
| 2805 | - * Set the invoice template. |
|
| 2806 | - * |
|
| 2807 | - * @since 1.0.19 |
|
| 2808 | - * @param string $value template. |
|
| 2809 | - */ |
|
| 2810 | - public function set_template( $value ) { |
|
| 2811 | - if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) { |
|
| 2812 | - $this->set_prop( 'template', $value ); |
|
| 2813 | - } |
|
| 2814 | - } |
|
| 2815 | - |
|
| 2816 | - /** |
|
| 2817 | - * Set the invoice source. |
|
| 2818 | - * |
|
| 2819 | - * @since 1.0.19 |
|
| 2820 | - * @param string $value source. |
|
| 2821 | - * @deprecated |
|
| 2822 | - */ |
|
| 2823 | - public function created_via( $value ) { |
|
| 2824 | - $this->set_created_via( sanitize_text_field( $value ) ); |
|
| 2825 | - } |
|
| 2826 | - |
|
| 2827 | - /** |
|
| 2828 | - * Set the invoice source. |
|
| 2829 | - * |
|
| 2830 | - * @since 1.0.19 |
|
| 2831 | - * @param string $value source. |
|
| 2832 | - */ |
|
| 2833 | - public function set_created_via( $value ) { |
|
| 2834 | - $this->set_prop( 'created_via', sanitize_text_field( $value ) ); |
|
| 2835 | - } |
|
| 2836 | - |
|
| 2837 | - /** |
|
| 2838 | - * Set the customer's address confirmed status. |
|
| 2839 | - * |
|
| 2840 | - * @since 1.0.19 |
|
| 2841 | - * @param int|bool $value confirmed. |
|
| 2842 | - */ |
|
| 2843 | - public function set_address_confirmed( $value ) { |
|
| 2844 | - $this->set_prop( 'address_confirmed', $value ); |
|
| 2845 | - } |
|
| 2846 | - |
|
| 2847 | - /** |
|
| 2848 | - * Alias of self::set_address_confirmed(). |
|
| 2849 | - * |
|
| 2850 | - * @since 1.0.19 |
|
| 2851 | - * @param int|bool $value confirmed. |
|
| 2852 | - */ |
|
| 2853 | - public function set_user_address_confirmed( $value ) { |
|
| 2854 | - $this->set_address_confirmed( $value ); |
|
| 2855 | - } |
|
| 2856 | - |
|
| 2857 | - /** |
|
| 2858 | - * Alias of self::set_address_confirmed(). |
|
| 2859 | - * |
|
| 2860 | - * @since 1.0.19 |
|
| 2861 | - * @param int|bool $value confirmed. |
|
| 2862 | - */ |
|
| 2863 | - public function set_customer_address_confirmed( $value ) { |
|
| 2864 | - $this->set_address_confirmed( $value ); |
|
| 2865 | - } |
|
| 2866 | - |
|
| 2867 | - /** |
|
| 2868 | - * Set the shipping fee |
|
| 2869 | - * |
|
| 2870 | - * @since 1.0.19 |
|
| 2871 | - * @param float $value shipping amount. |
|
| 2872 | - */ |
|
| 2873 | - public function set_shipping( $value ) { |
|
| 2874 | - |
|
| 2875 | - if ( ! is_numeric( $value ) ) { |
|
| 2876 | - return $this->set_prop( 'shipping', null ); |
|
| 2877 | - } |
|
| 2878 | - |
|
| 2879 | - $this->set_prop( 'shipping', max( 0, floatval( $value ) ) ); |
|
| 2880 | - } |
|
| 2881 | - |
|
| 2882 | - /** |
|
| 2883 | - * Set the invoice sub total. |
|
| 2884 | - * |
|
| 2885 | - * @since 1.0.19 |
|
| 2886 | - * @param float $value sub total. |
|
| 2887 | - */ |
|
| 2888 | - public function set_subtotal( $value ) { |
|
| 2889 | - $this->set_prop( 'subtotal', max( 0, $value ) ); |
|
| 2890 | - } |
|
| 2891 | - |
|
| 2892 | - /** |
|
| 2893 | - * Set the invoice total. |
|
| 2894 | - * |
|
| 2895 | - * @since 1.0.19 |
|
| 2896 | - * @param float $value sub total. |
|
| 2897 | - */ |
|
| 2898 | - public function set_total( $value ) { |
|
| 2899 | - $this->set_prop( 'total', max( 0, $value ) ); |
|
| 2892 | + /** |
|
| 2893 | + * Set the invoice total. |
|
| 2894 | + * |
|
| 2895 | + * @since 1.0.19 |
|
| 2896 | + * @param float $value sub total. |
|
| 2897 | + */ |
|
| 2898 | + public function set_total( $value ) { |
|
| 2899 | + $this->set_prop( 'total', max( 0, $value ) ); |
|
| 2900 | 2900 | } |
| 2901 | 2901 | |
| 2902 | 2902 | /** |
| 2903 | - * Set the invoice discount amount. |
|
| 2904 | - * |
|
| 2905 | - * @since 1.0.19 |
|
| 2906 | - * @param float $value discount total. |
|
| 2907 | - */ |
|
| 2908 | - public function set_total_discount( $value ) { |
|
| 2909 | - $this->set_prop( 'total_discount', max( 0, $value ) ); |
|
| 2903 | + * Set the invoice discount amount. |
|
| 2904 | + * |
|
| 2905 | + * @since 1.0.19 |
|
| 2906 | + * @param float $value discount total. |
|
| 2907 | + */ |
|
| 2908 | + public function set_total_discount( $value ) { |
|
| 2909 | + $this->set_prop( 'total_discount', max( 0, $value ) ); |
|
| 2910 | 2910 | } |
| 2911 | 2911 | |
| 2912 | 2912 | /** |
| 2913 | - * Alias of self::set_total_discount(). |
|
| 2914 | - * |
|
| 2915 | - * @since 1.0.19 |
|
| 2916 | - * @param float $value discount total. |
|
| 2917 | - */ |
|
| 2918 | - public function set_discount( $value ) { |
|
| 2919 | - $this->set_total_discount( $value ); |
|
| 2913 | + * Alias of self::set_total_discount(). |
|
| 2914 | + * |
|
| 2915 | + * @since 1.0.19 |
|
| 2916 | + * @param float $value discount total. |
|
| 2917 | + */ |
|
| 2918 | + public function set_discount( $value ) { |
|
| 2919 | + $this->set_total_discount( $value ); |
|
| 2920 | 2920 | } |
| 2921 | 2921 | |
| 2922 | 2922 | /** |
| 2923 | - * Set the invoice tax amount. |
|
| 2924 | - * |
|
| 2925 | - * @since 1.0.19 |
|
| 2926 | - * @param float $value tax total. |
|
| 2927 | - */ |
|
| 2928 | - public function set_total_tax( $value ) { |
|
| 2929 | - $this->set_prop( 'total_tax', max( 0, $value ) ); |
|
| 2923 | + * Set the invoice tax amount. |
|
| 2924 | + * |
|
| 2925 | + * @since 1.0.19 |
|
| 2926 | + * @param float $value tax total. |
|
| 2927 | + */ |
|
| 2928 | + public function set_total_tax( $value ) { |
|
| 2929 | + $this->set_prop( 'total_tax', max( 0, $value ) ); |
|
| 2930 | 2930 | } |
| 2931 | 2931 | |
| 2932 | 2932 | /** |
| 2933 | - * Alias of self::set_total_tax(). |
|
| 2934 | - * |
|
| 2935 | - * @since 1.0.19 |
|
| 2936 | - * @param float $value tax total. |
|
| 2937 | - */ |
|
| 2938 | - public function set_tax_total( $value ) { |
|
| 2939 | - $this->set_total_tax( $value ); |
|
| 2933 | + * Alias of self::set_total_tax(). |
|
| 2934 | + * |
|
| 2935 | + * @since 1.0.19 |
|
| 2936 | + * @param float $value tax total. |
|
| 2937 | + */ |
|
| 2938 | + public function set_tax_total( $value ) { |
|
| 2939 | + $this->set_total_tax( $value ); |
|
| 2940 | 2940 | } |
| 2941 | 2941 | |
| 2942 | 2942 | /** |
| 2943 | - * Set the invoice fees amount. |
|
| 2944 | - * |
|
| 2945 | - * @since 1.0.19 |
|
| 2946 | - * @param float $value fees total. |
|
| 2947 | - */ |
|
| 2948 | - public function set_total_fees( $value ) { |
|
| 2949 | - $this->set_prop( 'total_fees', max( 0, $value ) ); |
|
| 2943 | + * Set the invoice fees amount. |
|
| 2944 | + * |
|
| 2945 | + * @since 1.0.19 |
|
| 2946 | + * @param float $value fees total. |
|
| 2947 | + */ |
|
| 2948 | + public function set_total_fees( $value ) { |
|
| 2949 | + $this->set_prop( 'total_fees', max( 0, $value ) ); |
|
| 2950 | 2950 | } |
| 2951 | 2951 | |
| 2952 | 2952 | /** |
| 2953 | - * Alias of self::set_total_fees(). |
|
| 2954 | - * |
|
| 2955 | - * @since 1.0.19 |
|
| 2956 | - * @param float $value fees total. |
|
| 2957 | - */ |
|
| 2958 | - public function set_fees_total( $value ) { |
|
| 2959 | - $this->set_total_fees( $value ); |
|
| 2953 | + * Alias of self::set_total_fees(). |
|
| 2954 | + * |
|
| 2955 | + * @since 1.0.19 |
|
| 2956 | + * @param float $value fees total. |
|
| 2957 | + */ |
|
| 2958 | + public function set_fees_total( $value ) { |
|
| 2959 | + $this->set_total_fees( $value ); |
|
| 2960 | 2960 | } |
| 2961 | 2961 | |
| 2962 | 2962 | /** |
| 2963 | - * Set the invoice fees. |
|
| 2964 | - * |
|
| 2965 | - * @since 1.0.19 |
|
| 2966 | - * @param array $value fees. |
|
| 2967 | - */ |
|
| 2968 | - public function set_fees( $value ) { |
|
| 2963 | + * Set the invoice fees. |
|
| 2964 | + * |
|
| 2965 | + * @since 1.0.19 |
|
| 2966 | + * @param array $value fees. |
|
| 2967 | + */ |
|
| 2968 | + public function set_fees( $value ) { |
|
| 2969 | 2969 | |
| 2970 | - if ( ! is_array( $value ) ) { |
|
| 2971 | - $value = array(); |
|
| 2972 | - } |
|
| 2970 | + if ( ! is_array( $value ) ) { |
|
| 2971 | + $value = array(); |
|
| 2972 | + } |
|
| 2973 | 2973 | |
| 2974 | - $this->set_prop( 'fees', $value ); |
|
| 2974 | + $this->set_prop( 'fees', $value ); |
|
| 2975 | 2975 | |
| 2976 | 2976 | } |
| 2977 | 2977 | |
| 2978 | 2978 | /** |
| 2979 | - * Set the invoice taxes. |
|
| 2980 | - * |
|
| 2981 | - * @since 1.0.19 |
|
| 2982 | - * @param array $value taxes. |
|
| 2983 | - */ |
|
| 2984 | - public function set_taxes( $value ) { |
|
| 2979 | + * Set the invoice taxes. |
|
| 2980 | + * |
|
| 2981 | + * @since 1.0.19 |
|
| 2982 | + * @param array $value taxes. |
|
| 2983 | + */ |
|
| 2984 | + public function set_taxes( $value ) { |
|
| 2985 | 2985 | |
| 2986 | - if ( ! is_array( $value ) ) { |
|
| 2987 | - $value = array(); |
|
| 2988 | - } |
|
| 2986 | + if ( ! is_array( $value ) ) { |
|
| 2987 | + $value = array(); |
|
| 2988 | + } |
|
| 2989 | 2989 | |
| 2990 | - $this->set_prop( 'taxes', $value ); |
|
| 2990 | + $this->set_prop( 'taxes', $value ); |
|
| 2991 | 2991 | |
| 2992 | 2992 | } |
| 2993 | 2993 | |
| 2994 | 2994 | /** |
| 2995 | - * Set the invoice discounts. |
|
| 2996 | - * |
|
| 2997 | - * @since 1.0.19 |
|
| 2998 | - * @param array $value discounts. |
|
| 2999 | - */ |
|
| 3000 | - public function set_discounts( $value ) { |
|
| 2995 | + * Set the invoice discounts. |
|
| 2996 | + * |
|
| 2997 | + * @since 1.0.19 |
|
| 2998 | + * @param array $value discounts. |
|
| 2999 | + */ |
|
| 3000 | + public function set_discounts( $value ) { |
|
| 3001 | 3001 | |
| 3002 | - if ( ! is_array( $value ) ) { |
|
| 3003 | - $value = array(); |
|
| 3004 | - } |
|
| 3002 | + if ( ! is_array( $value ) ) { |
|
| 3003 | + $value = array(); |
|
| 3004 | + } |
|
| 3005 | 3005 | |
| 3006 | - $this->set_prop( 'discounts', $value ); |
|
| 3006 | + $this->set_prop( 'discounts', $value ); |
|
| 3007 | 3007 | } |
| 3008 | 3008 | |
| 3009 | 3009 | /** |
| 3010 | - * Set the invoice items. |
|
| 3011 | - * |
|
| 3012 | - * @since 1.0.19 |
|
| 3013 | - * @param GetPaid_Form_Item[] $value items. |
|
| 3014 | - */ |
|
| 3015 | - public function set_items( $value ) { |
|
| 3010 | + * Set the invoice items. |
|
| 3011 | + * |
|
| 3012 | + * @since 1.0.19 |
|
| 3013 | + * @param GetPaid_Form_Item[] $value items. |
|
| 3014 | + */ |
|
| 3015 | + public function set_items( $value ) { |
|
| 3016 | 3016 | |
| 3017 | 3017 | // Remove existing items. |
| 3018 | 3018 | $this->set_prop( 'items', array() ); |
| 3019 | - $this->recurring_item = null; |
|
| 3019 | + $this->recurring_item = null; |
|
| 3020 | 3020 | |
| 3021 | 3021 | // Ensure that we have an array. |
| 3022 | 3022 | if ( ! is_array( $value ) ) { |
@@ -3030,95 +3030,95 @@ discard block |
||
| 3030 | 3030 | } |
| 3031 | 3031 | |
| 3032 | 3032 | /** |
| 3033 | - * Set the payment form. |
|
| 3034 | - * |
|
| 3035 | - * @since 1.0.19 |
|
| 3036 | - * @param int $value payment form. |
|
| 3037 | - */ |
|
| 3038 | - public function set_payment_form( $value ) { |
|
| 3039 | - $this->set_prop( 'payment_form', $value ); |
|
| 3033 | + * Set the payment form. |
|
| 3034 | + * |
|
| 3035 | + * @since 1.0.19 |
|
| 3036 | + * @param int $value payment form. |
|
| 3037 | + */ |
|
| 3038 | + public function set_payment_form( $value ) { |
|
| 3039 | + $this->set_prop( 'payment_form', $value ); |
|
| 3040 | 3040 | } |
| 3041 | 3041 | |
| 3042 | 3042 | /** |
| 3043 | - * Set the submission id. |
|
| 3044 | - * |
|
| 3045 | - * @since 1.0.19 |
|
| 3046 | - * @param string $value submission id. |
|
| 3047 | - */ |
|
| 3048 | - public function set_submission_id( $value ) { |
|
| 3049 | - $this->set_prop( 'submission_id', $value ); |
|
| 3043 | + * Set the submission id. |
|
| 3044 | + * |
|
| 3045 | + * @since 1.0.19 |
|
| 3046 | + * @param string $value submission id. |
|
| 3047 | + */ |
|
| 3048 | + public function set_submission_id( $value ) { |
|
| 3049 | + $this->set_prop( 'submission_id', $value ); |
|
| 3050 | 3050 | } |
| 3051 | 3051 | |
| 3052 | 3052 | /** |
| 3053 | - * Set the discount code. |
|
| 3054 | - * |
|
| 3055 | - * @since 1.0.19 |
|
| 3056 | - * @param string $value discount code. |
|
| 3057 | - */ |
|
| 3058 | - public function set_discount_code( $value ) { |
|
| 3059 | - $this->set_prop( 'discount_code', sanitize_text_field( $value ) ); |
|
| 3053 | + * Set the discount code. |
|
| 3054 | + * |
|
| 3055 | + * @since 1.0.19 |
|
| 3056 | + * @param string $value discount code. |
|
| 3057 | + */ |
|
| 3058 | + public function set_discount_code( $value ) { |
|
| 3059 | + $this->set_prop( 'discount_code', sanitize_text_field( $value ) ); |
|
| 3060 | 3060 | } |
| 3061 | 3061 | |
| 3062 | 3062 | /** |
| 3063 | - * Set the gateway. |
|
| 3064 | - * |
|
| 3065 | - * @since 1.0.19 |
|
| 3066 | - * @param string $value gateway. |
|
| 3067 | - */ |
|
| 3068 | - public function set_gateway( $value ) { |
|
| 3069 | - $this->set_prop( 'gateway', $value ); |
|
| 3063 | + * Set the gateway. |
|
| 3064 | + * |
|
| 3065 | + * @since 1.0.19 |
|
| 3066 | + * @param string $value gateway. |
|
| 3067 | + */ |
|
| 3068 | + public function set_gateway( $value ) { |
|
| 3069 | + $this->set_prop( 'gateway', $value ); |
|
| 3070 | 3070 | } |
| 3071 | 3071 | |
| 3072 | 3072 | /** |
| 3073 | - * Set the transaction id. |
|
| 3074 | - * |
|
| 3075 | - * @since 1.0.19 |
|
| 3076 | - * @param string $value transaction id. |
|
| 3077 | - */ |
|
| 3078 | - public function set_transaction_id( $value ) { |
|
| 3079 | - if ( ! empty( $value ) ) { |
|
| 3080 | - $this->set_prop( 'transaction_id', $value ); |
|
| 3081 | - } |
|
| 3073 | + * Set the transaction id. |
|
| 3074 | + * |
|
| 3075 | + * @since 1.0.19 |
|
| 3076 | + * @param string $value transaction id. |
|
| 3077 | + */ |
|
| 3078 | + public function set_transaction_id( $value ) { |
|
| 3079 | + if ( ! empty( $value ) ) { |
|
| 3080 | + $this->set_prop( 'transaction_id', $value ); |
|
| 3081 | + } |
|
| 3082 | 3082 | } |
| 3083 | 3083 | |
| 3084 | 3084 | /** |
| 3085 | - * Set the currency id. |
|
| 3086 | - * |
|
| 3087 | - * @since 1.0.19 |
|
| 3088 | - * @param string $value currency id. |
|
| 3089 | - */ |
|
| 3090 | - public function set_currency( $value ) { |
|
| 3091 | - $this->set_prop( 'currency', $value ); |
|
| 3085 | + * Set the currency id. |
|
| 3086 | + * |
|
| 3087 | + * @since 1.0.19 |
|
| 3088 | + * @param string $value currency id. |
|
| 3089 | + */ |
|
| 3090 | + public function set_currency( $value ) { |
|
| 3091 | + $this->set_prop( 'currency', $value ); |
|
| 3092 | 3092 | } |
| 3093 | 3093 | |
| 3094 | - /** |
|
| 3095 | - * Set whether to disable taxes. |
|
| 3096 | - * |
|
| 3097 | - * @since 1.0.19 |
|
| 3098 | - * @param bool $value value. |
|
| 3099 | - */ |
|
| 3100 | - public function set_disable_taxes( $value ) { |
|
| 3101 | - $this->set_prop( 'disable_taxes', (bool) $value ); |
|
| 3102 | - } |
|
| 3094 | + /** |
|
| 3095 | + * Set whether to disable taxes. |
|
| 3096 | + * |
|
| 3097 | + * @since 1.0.19 |
|
| 3098 | + * @param bool $value value. |
|
| 3099 | + */ |
|
| 3100 | + public function set_disable_taxes( $value ) { |
|
| 3101 | + $this->set_prop( 'disable_taxes', (bool) $value ); |
|
| 3102 | + } |
|
| 3103 | 3103 | |
| 3104 | 3104 | /** |
| 3105 | - * Set the subscription id. |
|
| 3106 | - * |
|
| 3107 | - * @since 1.0.19 |
|
| 3108 | - * @param string $value subscription id. |
|
| 3109 | - */ |
|
| 3110 | - public function set_subscription_id( $value ) { |
|
| 3111 | - $this->set_prop( 'subscription_id', $value ); |
|
| 3112 | - } |
|
| 3105 | + * Set the subscription id. |
|
| 3106 | + * |
|
| 3107 | + * @since 1.0.19 |
|
| 3108 | + * @param string $value subscription id. |
|
| 3109 | + */ |
|
| 3110 | + public function set_subscription_id( $value ) { |
|
| 3111 | + $this->set_prop( 'subscription_id', $value ); |
|
| 3112 | + } |
|
| 3113 | 3113 | |
| 3114 | - /** |
|
| 3115 | - * Set the remote subscription id. |
|
| 3116 | - * |
|
| 3117 | - * @since 1.0.19 |
|
| 3118 | - * @param string $value subscription id. |
|
| 3119 | - */ |
|
| 3120 | - public function set_remote_subscription_id( $value ) { |
|
| 3121 | - $this->set_prop( 'remote_subscription_id', $value ); |
|
| 3114 | + /** |
|
| 3115 | + * Set the remote subscription id. |
|
| 3116 | + * |
|
| 3117 | + * @since 1.0.19 |
|
| 3118 | + * @param string $value subscription id. |
|
| 3119 | + */ |
|
| 3120 | + public function set_remote_subscription_id( $value ) { |
|
| 3121 | + $this->set_prop( 'remote_subscription_id', $value ); |
|
| 3122 | 3122 | } |
| 3123 | 3123 | |
| 3124 | 3124 | /* |
@@ -3157,24 +3157,24 @@ discard block |
||
| 3157 | 3157 | */ |
| 3158 | 3158 | public function is_taxable() { |
| 3159 | 3159 | return ! $this->get_disable_taxes(); |
| 3160 | - } |
|
| 3160 | + } |
|
| 3161 | 3161 | |
| 3162 | - /** |
|
| 3163 | - * @deprecated |
|
| 3164 | - */ |
|
| 3165 | - public function has_vat() { |
|
| 3162 | + /** |
|
| 3163 | + * @deprecated |
|
| 3164 | + */ |
|
| 3165 | + public function has_vat() { |
|
| 3166 | 3166 | return $this->is_taxable(); |
| 3167 | - } |
|
| 3167 | + } |
|
| 3168 | 3168 | |
| 3169 | - /** |
|
| 3170 | - * Checks to see if the invoice requires payment. |
|
| 3171 | - */ |
|
| 3172 | - public function is_free() { |
|
| 3169 | + /** |
|
| 3170 | + * Checks to see if the invoice requires payment. |
|
| 3171 | + */ |
|
| 3172 | + public function is_free() { |
|
| 3173 | 3173 | $is_free = ( (float) wpinv_round_amount( $this->get_initial_total() ) == 0 ); |
| 3174 | 3174 | |
| 3175 | - if ( $this->is_recurring() && $this->get_recurring_total() > 0 ) { |
|
| 3176 | - $is_free = false; |
|
| 3177 | - } |
|
| 3175 | + if ( $this->is_recurring() && $this->get_recurring_total() > 0 ) { |
|
| 3176 | + $is_free = false; |
|
| 3177 | + } |
|
| 3178 | 3178 | |
| 3179 | 3179 | return apply_filters( 'wpinv_invoice_is_free', $is_free, $this ); |
| 3180 | 3180 | } |
@@ -3185,46 +3185,46 @@ discard block |
||
| 3185 | 3185 | public function is_paid() { |
| 3186 | 3186 | $is_paid = $this->has_status( array( 'publish', 'wpi-processing', 'wpi-renewal' ) ); |
| 3187 | 3187 | return apply_filters( 'wpinv_invoice_is_paid', $is_paid, $this ); |
| 3188 | - } |
|
| 3188 | + } |
|
| 3189 | 3189 | |
| 3190 | - /** |
|
| 3190 | + /** |
|
| 3191 | 3191 | * Checks if the invoice needs payment. |
| 3192 | 3192 | */ |
| 3193 | - public function needs_payment() { |
|
| 3194 | - $needs_payment = ! $this->is_paid() && ! $this->is_refunded() && ! $this->is_free(); |
|
| 3193 | + public function needs_payment() { |
|
| 3194 | + $needs_payment = ! $this->is_paid() && ! $this->is_refunded() && ! $this->is_free(); |
|
| 3195 | 3195 | return apply_filters( 'wpinv_needs_payment', $needs_payment, $this ); |
| 3196 | 3196 | } |
| 3197 | 3197 | |
| 3198 | - /** |
|
| 3198 | + /** |
|
| 3199 | 3199 | * Checks if the invoice is refunded. |
| 3200 | 3200 | */ |
| 3201 | - public function is_refunded() { |
|
| 3201 | + public function is_refunded() { |
|
| 3202 | 3202 | $is_refunded = $this->has_status( 'wpi-refunded' ); |
| 3203 | 3203 | return apply_filters( 'wpinv_invoice_is_refunded', $is_refunded, $this ); |
| 3204 | - } |
|
| 3204 | + } |
|
| 3205 | 3205 | |
| 3206 | - /** |
|
| 3206 | + /** |
|
| 3207 | 3207 | * Checks if the invoice is held. |
| 3208 | 3208 | */ |
| 3209 | - public function is_held() { |
|
| 3209 | + public function is_held() { |
|
| 3210 | 3210 | $is_held = $this->has_status( 'wpi-onhold' ); |
| 3211 | 3211 | return apply_filters( 'wpinv_invoice_is_held', $is_held, $this ); |
| 3212 | - } |
|
| 3212 | + } |
|
| 3213 | 3213 | |
| 3214 | - /** |
|
| 3214 | + /** |
|
| 3215 | 3215 | * Checks if the invoice is due. |
| 3216 | 3216 | */ |
| 3217 | - public function is_due() { |
|
| 3218 | - $due_date = $this->get_due_date(); |
|
| 3219 | - return empty( $due_date ) ? false : current_time( 'timestamp' ) > strtotime( $due_date ); |
|
| 3220 | - } |
|
| 3217 | + public function is_due() { |
|
| 3218 | + $due_date = $this->get_due_date(); |
|
| 3219 | + return empty( $due_date ) ? false : current_time( 'timestamp' ) > strtotime( $due_date ); |
|
| 3220 | + } |
|
| 3221 | 3221 | |
| 3222 | - /** |
|
| 3222 | + /** |
|
| 3223 | 3223 | * Checks if the invoice is draft. |
| 3224 | 3224 | */ |
| 3225 | - public function is_draft() { |
|
| 3225 | + public function is_draft() { |
|
| 3226 | 3226 | return $this->has_status( 'draft, auto-draft' ); |
| 3227 | - } |
|
| 3227 | + } |
|
| 3228 | 3228 | |
| 3229 | 3229 | /** |
| 3230 | 3230 | * Checks if the invoice has a given status. |
@@ -3232,9 +3232,9 @@ discard block |
||
| 3232 | 3232 | public function has_status( $status ) { |
| 3233 | 3233 | $status = wpinv_parse_list( $status ); |
| 3234 | 3234 | return apply_filters( 'wpinv_has_status', in_array( $this->get_status(), $status ), $status ); |
| 3235 | - } |
|
| 3235 | + } |
|
| 3236 | 3236 | |
| 3237 | - /** |
|
| 3237 | + /** |
|
| 3238 | 3238 | * Checks if the invoice is of a given type. |
| 3239 | 3239 | */ |
| 3240 | 3240 | public function is_type( $type ) { |
@@ -3257,25 +3257,25 @@ discard block |
||
| 3257 | 3257 | */ |
| 3258 | 3258 | public function has_free_trial() { |
| 3259 | 3259 | return $this->is_recurring() && 0 == $this->get_initial_total(); |
| 3260 | - } |
|
| 3260 | + } |
|
| 3261 | 3261 | |
| 3262 | - /** |
|
| 3262 | + /** |
|
| 3263 | 3263 | * @deprecated |
| 3264 | 3264 | */ |
| 3265 | 3265 | public function is_free_trial() { |
| 3266 | 3266 | $this->has_free_trial(); |
| 3267 | 3267 | } |
| 3268 | 3268 | |
| 3269 | - /** |
|
| 3269 | + /** |
|
| 3270 | 3270 | * Check if the initial payment if 0. |
| 3271 | 3271 | * |
| 3272 | 3272 | */ |
| 3273 | - public function is_initial_free() { |
|
| 3273 | + public function is_initial_free() { |
|
| 3274 | 3274 | $is_initial_free = ! ( (float) wpinv_round_amount( $this->get_initial_total() ) > 0 ); |
| 3275 | 3275 | return apply_filters( 'wpinv_invoice_is_initial_free', $is_initial_free, $this->get_cart_details(), $this ); |
| 3276 | 3276 | } |
| 3277 | 3277 | |
| 3278 | - /** |
|
| 3278 | + /** |
|
| 3279 | 3279 | * Check if the recurring item has a free trial. |
| 3280 | 3280 | * |
| 3281 | 3281 | */ |
@@ -3288,21 +3288,21 @@ discard block |
||
| 3288 | 3288 | |
| 3289 | 3289 | $item = $this->get_recurring( true ); |
| 3290 | 3290 | return $item->has_free_trial(); |
| 3291 | - } |
|
| 3291 | + } |
|
| 3292 | 3292 | |
| 3293 | - /** |
|
| 3293 | + /** |
|
| 3294 | 3294 | * Check if the free trial is a result of a discount. |
| 3295 | 3295 | */ |
| 3296 | 3296 | public function is_free_trial_from_discount() { |
| 3297 | - return $this->has_free_trial() && ! $this->item_has_free_trial(); |
|
| 3298 | - } |
|
| 3297 | + return $this->has_free_trial() && ! $this->item_has_free_trial(); |
|
| 3298 | + } |
|
| 3299 | 3299 | |
| 3300 | - /** |
|
| 3300 | + /** |
|
| 3301 | 3301 | * @deprecated |
| 3302 | 3302 | */ |
| 3303 | 3303 | public function discount_first_payment_only() { |
| 3304 | 3304 | |
| 3305 | - $discount = wpinv_get_discount_obj( $this->get_discount_code() ); |
|
| 3305 | + $discount = wpinv_get_discount_obj( $this->get_discount_code() ); |
|
| 3306 | 3306 | if ( ! $discount->exists() || ! $this->is_recurring() ) { |
| 3307 | 3307 | return true; |
| 3308 | 3308 | } |
@@ -3327,147 +3327,147 @@ discard block |
||
| 3327 | 3327 | */ |
| 3328 | 3328 | public function add_item( $item ) { |
| 3329 | 3329 | |
| 3330 | - if ( is_array( $item ) ) { |
|
| 3331 | - $item = $this->process_array_item( $item ); |
|
| 3332 | - } |
|
| 3330 | + if ( is_array( $item ) ) { |
|
| 3331 | + $item = $this->process_array_item( $item ); |
|
| 3332 | + } |
|
| 3333 | 3333 | |
| 3334 | - if ( is_numeric( $item ) ) { |
|
| 3335 | - $item = new GetPaid_Form_Item( $item ); |
|
| 3336 | - } |
|
| 3334 | + if ( is_numeric( $item ) ) { |
|
| 3335 | + $item = new GetPaid_Form_Item( $item ); |
|
| 3336 | + } |
|
| 3337 | 3337 | |
| 3338 | 3338 | // Make sure that it is available for purchase. |
| 3339 | - if ( $item->get_id() > 0 && ! $item->can_purchase() ) { |
|
| 3340 | - return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) ); |
|
| 3339 | + if ( $item->get_id() > 0 && ! $item->can_purchase() ) { |
|
| 3340 | + return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) ); |
|
| 3341 | 3341 | } |
| 3342 | 3342 | |
| 3343 | 3343 | // Do we have a recurring item? |
| 3344 | - if ( $item->is_recurring() ) { |
|
| 3345 | - $this->recurring_item = $item->get_id(); |
|
| 3344 | + if ( $item->is_recurring() ) { |
|
| 3345 | + $this->recurring_item = $item->get_id(); |
|
| 3346 | 3346 | } |
| 3347 | 3347 | |
| 3348 | 3348 | // Invoice id. |
| 3349 | 3349 | $item->invoice_id = (int) $this->get_id(); |
| 3350 | 3350 | |
| 3351 | - // Remove duplicates. |
|
| 3352 | - $this->remove_item( $item->get_id() ); |
|
| 3351 | + // Remove duplicates. |
|
| 3352 | + $this->remove_item( $item->get_id() ); |
|
| 3353 | 3353 | |
| 3354 | - if ( 0 == $item->get_quantity() ) { |
|
| 3355 | - return; |
|
| 3356 | - } |
|
| 3354 | + if ( 0 == $item->get_quantity() ) { |
|
| 3355 | + return; |
|
| 3356 | + } |
|
| 3357 | 3357 | |
| 3358 | - // Retrieve all items. |
|
| 3358 | + // Retrieve all items. |
|
| 3359 | 3359 | $items = $this->get_items(); |
| 3360 | 3360 | |
| 3361 | - // Add new item. |
|
| 3361 | + // Add new item. |
|
| 3362 | 3362 | $items[] = $item; |
| 3363 | 3363 | |
| 3364 | 3364 | $this->set_prop( 'items', $items ); |
| 3365 | 3365 | |
| 3366 | - return true; |
|
| 3367 | - } |
|
| 3366 | + return true; |
|
| 3367 | + } |
|
| 3368 | 3368 | |
| 3369 | - /** |
|
| 3370 | - * Converts an array to an item. |
|
| 3371 | - * |
|
| 3372 | - * @since 1.0.19 |
|
| 3373 | - * @return GetPaid_Form_Item |
|
| 3374 | - */ |
|
| 3375 | - protected function process_array_item( $array ) { |
|
| 3369 | + /** |
|
| 3370 | + * Converts an array to an item. |
|
| 3371 | + * |
|
| 3372 | + * @since 1.0.19 |
|
| 3373 | + * @return GetPaid_Form_Item |
|
| 3374 | + */ |
|
| 3375 | + protected function process_array_item( $array ) { |
|
| 3376 | 3376 | |
| 3377 | - $item_id = isset( $array['item_id'] ) ? $array['item_id'] : 0; |
|
| 3378 | - $item = new GetPaid_Form_Item( $item_id ); |
|
| 3377 | + $item_id = isset( $array['item_id'] ) ? $array['item_id'] : 0; |
|
| 3378 | + $item = new GetPaid_Form_Item( $item_id ); |
|
| 3379 | 3379 | |
| 3380 | - // Set item data. |
|
| 3381 | - foreach ( array( 'name', 'price', 'description' ) as $key ) { |
|
| 3382 | - if ( isset( $array[ "item_$key" ] ) ) { |
|
| 3383 | - $method = "set_$key"; |
|
| 3384 | - $item->$method( $array[ "item_$key" ] ); |
|
| 3385 | - } |
|
| 3386 | - } |
|
| 3380 | + // Set item data. |
|
| 3381 | + foreach ( array( 'name', 'price', 'description' ) as $key ) { |
|
| 3382 | + if ( isset( $array[ "item_$key" ] ) ) { |
|
| 3383 | + $method = "set_$key"; |
|
| 3384 | + $item->$method( $array[ "item_$key" ] ); |
|
| 3385 | + } |
|
| 3386 | + } |
|
| 3387 | 3387 | |
| 3388 | - if ( isset( $array['quantity'] ) ) { |
|
| 3389 | - $item->set_quantity( $array['quantity'] ); |
|
| 3390 | - } |
|
| 3388 | + if ( isset( $array['quantity'] ) ) { |
|
| 3389 | + $item->set_quantity( $array['quantity'] ); |
|
| 3390 | + } |
|
| 3391 | 3391 | |
| 3392 | - // Set item meta. |
|
| 3393 | - if ( isset( $array['meta'] ) && is_array( $array['meta'] ) ) { |
|
| 3394 | - $item->set_item_meta( $array['meta'] ); |
|
| 3395 | - } |
|
| 3392 | + // Set item meta. |
|
| 3393 | + if ( isset( $array['meta'] ) && is_array( $array['meta'] ) ) { |
|
| 3394 | + $item->set_item_meta( $array['meta'] ); |
|
| 3395 | + } |
|
| 3396 | 3396 | |
| 3397 | - return $item; |
|
| 3397 | + return $item; |
|
| 3398 | 3398 | |
| 3399 | - } |
|
| 3399 | + } |
|
| 3400 | 3400 | |
| 3401 | 3401 | /** |
| 3402 | - * Retrieves a specific item. |
|
| 3403 | - * |
|
| 3404 | - * @since 1.0.19 |
|
| 3405 | - * @return GetPaid_Form_Item|null |
|
| 3406 | - */ |
|
| 3407 | - public function get_item( $item_id ) { |
|
| 3402 | + * Retrieves a specific item. |
|
| 3403 | + * |
|
| 3404 | + * @since 1.0.19 |
|
| 3405 | + * @return GetPaid_Form_Item|null |
|
| 3406 | + */ |
|
| 3407 | + public function get_item( $item_id ) { |
|
| 3408 | 3408 | |
| 3409 | - foreach ( $this->get_items() as $item ) { |
|
| 3410 | - if ( (int) $item_id == $item->get_id() ) { |
|
| 3411 | - return $item; |
|
| 3412 | - } |
|
| 3413 | - } |
|
| 3409 | + foreach ( $this->get_items() as $item ) { |
|
| 3410 | + if ( (int) $item_id == $item->get_id() ) { |
|
| 3411 | + return $item; |
|
| 3412 | + } |
|
| 3413 | + } |
|
| 3414 | 3414 | |
| 3415 | - return null; |
|
| 3415 | + return null; |
|
| 3416 | 3416 | } |
| 3417 | 3417 | |
| 3418 | 3418 | /** |
| 3419 | - * Removes a specific item. |
|
| 3420 | - * |
|
| 3421 | - * @since 1.0.19 |
|
| 3422 | - */ |
|
| 3423 | - public function remove_item( $item_id ) { |
|
| 3424 | - $items = $this->get_items(); |
|
| 3425 | - $item_id = (int) $item_id; |
|
| 3419 | + * Removes a specific item. |
|
| 3420 | + * |
|
| 3421 | + * @since 1.0.19 |
|
| 3422 | + */ |
|
| 3423 | + public function remove_item( $item_id ) { |
|
| 3424 | + $items = $this->get_items(); |
|
| 3425 | + $item_id = (int) $item_id; |
|
| 3426 | 3426 | |
| 3427 | - foreach ( $items as $index => $item ) { |
|
| 3428 | - if ( (int) $item_id == $item->get_id() ) { |
|
| 3429 | - unset( $items[ $index ] ); |
|
| 3430 | - $this->set_prop( 'items', $items ); |
|
| 3427 | + foreach ( $items as $index => $item ) { |
|
| 3428 | + if ( (int) $item_id == $item->get_id() ) { |
|
| 3429 | + unset( $items[ $index ] ); |
|
| 3430 | + $this->set_prop( 'items', $items ); |
|
| 3431 | 3431 | |
| 3432 | - if ( $item_id == $this->recurring_item ) { |
|
| 3433 | - $this->recurring_item = null; |
|
| 3434 | - } |
|
| 3432 | + if ( $item_id == $this->recurring_item ) { |
|
| 3433 | + $this->recurring_item = null; |
|
| 3434 | + } |
|
| 3435 | 3435 | |
| 3436 | - } |
|
| 3437 | - } |
|
| 3436 | + } |
|
| 3437 | + } |
|
| 3438 | 3438 | |
| 3439 | 3439 | } |
| 3440 | 3440 | |
| 3441 | 3441 | /** |
| 3442 | - * Adds a fee to the invoice. |
|
| 3443 | - * |
|
| 3444 | - * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
| 3445 | - * @since 1.0.19 |
|
| 3446 | - */ |
|
| 3442 | + * Adds a fee to the invoice. |
|
| 3443 | + * |
|
| 3444 | + * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
| 3445 | + * @since 1.0.19 |
|
| 3446 | + */ |
|
| 3447 | 3447 | public function add_fee( $fee ) { |
| 3448 | 3448 | |
| 3449 | - $fees = $this->get_fees(); |
|
| 3450 | - $fees[ $fee['name'] ] = $fee; |
|
| 3451 | - $this->set_prop( 'fees', $fees ); |
|
| 3449 | + $fees = $this->get_fees(); |
|
| 3450 | + $fees[ $fee['name'] ] = $fee; |
|
| 3451 | + $this->set_prop( 'fees', $fees ); |
|
| 3452 | 3452 | |
| 3453 | 3453 | } |
| 3454 | 3454 | |
| 3455 | 3455 | /** |
| 3456 | - * Retrieves a specific fee. |
|
| 3457 | - * |
|
| 3458 | - * @since 1.0.19 |
|
| 3459 | - */ |
|
| 3460 | - public function get_fee( $fee ) { |
|
| 3456 | + * Retrieves a specific fee. |
|
| 3457 | + * |
|
| 3458 | + * @since 1.0.19 |
|
| 3459 | + */ |
|
| 3460 | + public function get_fee( $fee ) { |
|
| 3461 | 3461 | $fees = $this->get_fees(); |
| 3462 | - return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null; |
|
| 3462 | + return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null; |
|
| 3463 | 3463 | } |
| 3464 | 3464 | |
| 3465 | 3465 | /** |
| 3466 | - * Removes a specific fee. |
|
| 3467 | - * |
|
| 3468 | - * @since 1.0.19 |
|
| 3469 | - */ |
|
| 3470 | - public function remove_fee( $fee ) { |
|
| 3466 | + * Removes a specific fee. |
|
| 3467 | + * |
|
| 3468 | + * @since 1.0.19 |
|
| 3469 | + */ |
|
| 3470 | + public function remove_fee( $fee ) { |
|
| 3471 | 3471 | $fees = $this->get_fees(); |
| 3472 | 3472 | if ( isset( $fees[ $fee ] ) ) { |
| 3473 | 3473 | unset( $fees[ $fee ] ); |
@@ -3475,55 +3475,55 @@ discard block |
||
| 3475 | 3475 | } |
| 3476 | 3476 | } |
| 3477 | 3477 | |
| 3478 | - /** |
|
| 3479 | - * Adds a discount to the invoice. |
|
| 3480 | - * |
|
| 3481 | - * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code. |
|
| 3482 | - * @since 1.0.19 |
|
| 3483 | - */ |
|
| 3484 | - public function add_discount( $discount ) { |
|
| 3478 | + /** |
|
| 3479 | + * Adds a discount to the invoice. |
|
| 3480 | + * |
|
| 3481 | + * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code. |
|
| 3482 | + * @since 1.0.19 |
|
| 3483 | + */ |
|
| 3484 | + public function add_discount( $discount ) { |
|
| 3485 | 3485 | |
| 3486 | - $discounts = $this->get_discounts(); |
|
| 3487 | - $discounts[ $discount['name'] ] = $discount; |
|
| 3488 | - $this->set_prop( 'discounts', $discounts ); |
|
| 3486 | + $discounts = $this->get_discounts(); |
|
| 3487 | + $discounts[ $discount['name'] ] = $discount; |
|
| 3488 | + $this->set_prop( 'discounts', $discounts ); |
|
| 3489 | 3489 | |
| 3490 | - } |
|
| 3490 | + } |
|
| 3491 | 3491 | |
| 3492 | 3492 | /** |
| 3493 | - * Retrieves a specific discount. |
|
| 3494 | - * |
|
| 3495 | - * @since 1.0.19 |
|
| 3496 | - * @return float |
|
| 3497 | - */ |
|
| 3498 | - public function get_discount( $discount = false ) { |
|
| 3493 | + * Retrieves a specific discount. |
|
| 3494 | + * |
|
| 3495 | + * @since 1.0.19 |
|
| 3496 | + * @return float |
|
| 3497 | + */ |
|
| 3498 | + public function get_discount( $discount = false ) { |
|
| 3499 | 3499 | |
| 3500 | - // Backwards compatibilty. |
|
| 3501 | - if ( empty( $discount ) ) { |
|
| 3502 | - return $this->get_total_discount(); |
|
| 3503 | - } |
|
| 3500 | + // Backwards compatibilty. |
|
| 3501 | + if ( empty( $discount ) ) { |
|
| 3502 | + return $this->get_total_discount(); |
|
| 3503 | + } |
|
| 3504 | 3504 | |
| 3505 | 3505 | $discounts = $this->get_discounts(); |
| 3506 | - return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null; |
|
| 3506 | + return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null; |
|
| 3507 | 3507 | } |
| 3508 | 3508 | |
| 3509 | 3509 | /** |
| 3510 | - * Removes a specific discount. |
|
| 3511 | - * |
|
| 3512 | - * @since 1.0.19 |
|
| 3513 | - */ |
|
| 3514 | - public function remove_discount( $discount ) { |
|
| 3510 | + * Removes a specific discount. |
|
| 3511 | + * |
|
| 3512 | + * @since 1.0.19 |
|
| 3513 | + */ |
|
| 3514 | + public function remove_discount( $discount ) { |
|
| 3515 | 3515 | $discounts = $this->get_discounts(); |
| 3516 | 3516 | if ( isset( $discounts[ $discount ] ) ) { |
| 3517 | 3517 | unset( $discounts[ $discount ] ); |
| 3518 | 3518 | $this->set_prop( 'discounts', $discounts ); |
| 3519 | 3519 | } |
| 3520 | 3520 | |
| 3521 | - if ( 'discount_code' == $discount ) { |
|
| 3522 | - foreach ( $this->get_items() as $item ) { |
|
| 3523 | - $item->item_discount = 0; |
|
| 3524 | - $item->recurring_item_discount = 0; |
|
| 3525 | - } |
|
| 3526 | - } |
|
| 3521 | + if ( 'discount_code' == $discount ) { |
|
| 3522 | + foreach ( $this->get_items() as $item ) { |
|
| 3523 | + $item->item_discount = 0; |
|
| 3524 | + $item->recurring_item_discount = 0; |
|
| 3525 | + } |
|
| 3526 | + } |
|
| 3527 | 3527 | |
| 3528 | 3528 | } |
| 3529 | 3529 | |
@@ -3536,34 +3536,34 @@ discard block |
||
| 3536 | 3536 | if ( $this->is_taxable() ) { |
| 3537 | 3537 | |
| 3538 | 3538 | $taxes = $this->get_taxes(); |
| 3539 | - $taxes[ $tax['name'] ] = $tax; |
|
| 3540 | - $this->set_prop( 'taxes', $tax ); |
|
| 3539 | + $taxes[ $tax['name'] ] = $tax; |
|
| 3540 | + $this->set_prop( 'taxes', $tax ); |
|
| 3541 | 3541 | |
| 3542 | 3542 | } |
| 3543 | 3543 | } |
| 3544 | 3544 | |
| 3545 | 3545 | /** |
| 3546 | - * Retrieves a specific tax. |
|
| 3547 | - * |
|
| 3548 | - * @since 1.0.19 |
|
| 3549 | - */ |
|
| 3550 | - public function get_tax( $tax = null ) { |
|
| 3546 | + * Retrieves a specific tax. |
|
| 3547 | + * |
|
| 3548 | + * @since 1.0.19 |
|
| 3549 | + */ |
|
| 3550 | + public function get_tax( $tax = null ) { |
|
| 3551 | 3551 | |
| 3552 | - // Backwards compatility. |
|
| 3553 | - if ( empty( $tax ) ) { |
|
| 3554 | - return $this->get_total_tax(); |
|
| 3555 | - } |
|
| 3552 | + // Backwards compatility. |
|
| 3553 | + if ( empty( $tax ) ) { |
|
| 3554 | + return $this->get_total_tax(); |
|
| 3555 | + } |
|
| 3556 | 3556 | |
| 3557 | 3557 | $taxes = $this->get_taxes(); |
| 3558 | - return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null; |
|
| 3558 | + return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null; |
|
| 3559 | 3559 | } |
| 3560 | 3560 | |
| 3561 | 3561 | /** |
| 3562 | - * Removes a specific tax. |
|
| 3563 | - * |
|
| 3564 | - * @since 1.0.19 |
|
| 3565 | - */ |
|
| 3566 | - public function remove_tax( $tax ) { |
|
| 3562 | + * Removes a specific tax. |
|
| 3563 | + * |
|
| 3564 | + * @since 1.0.19 |
|
| 3565 | + */ |
|
| 3566 | + public function remove_tax( $tax ) { |
|
| 3567 | 3567 | $taxes = $this->get_taxes(); |
| 3568 | 3568 | if ( isset( $taxes[ $tax ] ) ) { |
| 3569 | 3569 | unset( $taxes[ $tax ] ); |
@@ -3572,185 +3572,185 @@ discard block |
||
| 3572 | 3572 | } |
| 3573 | 3573 | |
| 3574 | 3574 | /** |
| 3575 | - * Recalculates the invoice subtotal. |
|
| 3576 | - * |
|
| 3577 | - * @since 1.0.19 |
|
| 3578 | - * @return float The recalculated subtotal |
|
| 3579 | - */ |
|
| 3580 | - public function recalculate_subtotal() { |
|
| 3575 | + * Recalculates the invoice subtotal. |
|
| 3576 | + * |
|
| 3577 | + * @since 1.0.19 |
|
| 3578 | + * @return float The recalculated subtotal |
|
| 3579 | + */ |
|
| 3580 | + public function recalculate_subtotal() { |
|
| 3581 | 3581 | $items = $this->get_items(); |
| 3582 | - $subtotal = 0; |
|
| 3583 | - $recurring = 0; |
|
| 3582 | + $subtotal = 0; |
|
| 3583 | + $recurring = 0; |
|
| 3584 | 3584 | |
| 3585 | 3585 | foreach ( $items as $item ) { |
| 3586 | - $subtotal += $item->get_sub_total( 'edit' ); |
|
| 3587 | - $recurring += $item->get_recurring_sub_total( 'edit' ); |
|
| 3586 | + $subtotal += $item->get_sub_total( 'edit' ); |
|
| 3587 | + $recurring += $item->get_recurring_sub_total( 'edit' ); |
|
| 3588 | 3588 | } |
| 3589 | 3589 | |
| 3590 | - if ( wpinv_prices_include_tax() ) { |
|
| 3591 | - $subtotal = max( 0, $subtotal - $this->totals['tax']['initial'] ); |
|
| 3592 | - $recurring = max( 0, $recurring - $this->totals['tax']['recurring'] ); |
|
| 3593 | - } |
|
| 3590 | + if ( wpinv_prices_include_tax() ) { |
|
| 3591 | + $subtotal = max( 0, $subtotal - $this->totals['tax']['initial'] ); |
|
| 3592 | + $recurring = max( 0, $recurring - $this->totals['tax']['recurring'] ); |
|
| 3593 | + } |
|
| 3594 | 3594 | |
| 3595 | - $current = $this->is_renewal() ? $recurring : $subtotal; |
|
| 3596 | - $this->set_subtotal( $current ); |
|
| 3595 | + $current = $this->is_renewal() ? $recurring : $subtotal; |
|
| 3596 | + $this->set_subtotal( $current ); |
|
| 3597 | 3597 | |
| 3598 | - $this->totals['subtotal'] = array( |
|
| 3599 | - 'initial' => $subtotal, |
|
| 3600 | - 'recurring' => $recurring, |
|
| 3601 | - ); |
|
| 3598 | + $this->totals['subtotal'] = array( |
|
| 3599 | + 'initial' => $subtotal, |
|
| 3600 | + 'recurring' => $recurring, |
|
| 3601 | + ); |
|
| 3602 | 3602 | |
| 3603 | 3603 | return $current; |
| 3604 | 3604 | } |
| 3605 | 3605 | |
| 3606 | 3606 | /** |
| 3607 | - * Recalculates the invoice discount total. |
|
| 3608 | - * |
|
| 3609 | - * @since 1.0.19 |
|
| 3610 | - * @return float The recalculated discount |
|
| 3611 | - */ |
|
| 3612 | - public function recalculate_total_discount() { |
|
| 3607 | + * Recalculates the invoice discount total. |
|
| 3608 | + * |
|
| 3609 | + * @since 1.0.19 |
|
| 3610 | + * @return float The recalculated discount |
|
| 3611 | + */ |
|
| 3612 | + public function recalculate_total_discount() { |
|
| 3613 | 3613 | $discounts = $this->get_discounts(); |
| 3614 | - $discount = 0; |
|
| 3615 | - $recurring = 0; |
|
| 3614 | + $discount = 0; |
|
| 3615 | + $recurring = 0; |
|
| 3616 | 3616 | |
| 3617 | 3617 | foreach ( $discounts as $data ) { |
| 3618 | - $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
| 3619 | - $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
| 3620 | - } |
|
| 3618 | + $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
| 3619 | + $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
| 3620 | + } |
|
| 3621 | 3621 | |
| 3622 | - $current = $this->is_renewal() ? $recurring : $discount; |
|
| 3622 | + $current = $this->is_renewal() ? $recurring : $discount; |
|
| 3623 | 3623 | |
| 3624 | - $this->set_total_discount( $current ); |
|
| 3624 | + $this->set_total_discount( $current ); |
|
| 3625 | 3625 | |
| 3626 | - $this->totals['discount'] = array( |
|
| 3627 | - 'initial' => $discount, |
|
| 3628 | - 'recurring' => $recurring, |
|
| 3629 | - ); |
|
| 3626 | + $this->totals['discount'] = array( |
|
| 3627 | + 'initial' => $discount, |
|
| 3628 | + 'recurring' => $recurring, |
|
| 3629 | + ); |
|
| 3630 | 3630 | |
| 3631 | - return $current; |
|
| 3631 | + return $current; |
|
| 3632 | 3632 | |
| 3633 | 3633 | } |
| 3634 | 3634 | |
| 3635 | 3635 | /** |
| 3636 | - * Recalculates the invoice tax total. |
|
| 3637 | - * |
|
| 3638 | - * @since 1.0.19 |
|
| 3639 | - * @return float The recalculated tax |
|
| 3640 | - */ |
|
| 3641 | - public function recalculate_total_tax() { |
|
| 3636 | + * Recalculates the invoice tax total. |
|
| 3637 | + * |
|
| 3638 | + * @since 1.0.19 |
|
| 3639 | + * @return float The recalculated tax |
|
| 3640 | + */ |
|
| 3641 | + public function recalculate_total_tax() { |
|
| 3642 | 3642 | |
| 3643 | - // Maybe disable taxes. |
|
| 3644 | - $vat_number = $this->get_vat_number(); |
|
| 3645 | - $skip_tax = GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $this->get_country() ) && ! empty( $vat_number ); |
|
| 3643 | + // Maybe disable taxes. |
|
| 3644 | + $vat_number = $this->get_vat_number(); |
|
| 3645 | + $skip_tax = GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $this->get_country() ) && ! empty( $vat_number ); |
|
| 3646 | 3646 | |
| 3647 | - if ( wpinv_is_base_country( $this->get_country() ) && 'vat_too' == wpinv_get_option( 'vat_same_country_rule', 'vat_too' ) ) { |
|
| 3648 | - $skip_tax = false; |
|
| 3649 | - } |
|
| 3647 | + if ( wpinv_is_base_country( $this->get_country() ) && 'vat_too' == wpinv_get_option( 'vat_same_country_rule', 'vat_too' ) ) { |
|
| 3648 | + $skip_tax = false; |
|
| 3649 | + } |
|
| 3650 | 3650 | |
| 3651 | - if ( ! wpinv_use_taxes() || $this->get_disable_taxes() || ! wpinv_is_country_taxable( $this->get_country() ) || $skip_tax ) { |
|
| 3651 | + if ( ! wpinv_use_taxes() || $this->get_disable_taxes() || ! wpinv_is_country_taxable( $this->get_country() ) || $skip_tax ) { |
|
| 3652 | 3652 | |
| 3653 | - $this->totals['tax'] = array( |
|
| 3654 | - 'initial' => 0, |
|
| 3655 | - 'recurring' => 0, |
|
| 3656 | - ); |
|
| 3653 | + $this->totals['tax'] = array( |
|
| 3654 | + 'initial' => 0, |
|
| 3655 | + 'recurring' => 0, |
|
| 3656 | + ); |
|
| 3657 | 3657 | |
| 3658 | - $this->tax_rate = 0; |
|
| 3658 | + $this->tax_rate = 0; |
|
| 3659 | 3659 | |
| 3660 | - $this->set_taxes( array() ); |
|
| 3661 | - $current = 0; |
|
| 3662 | - } else { |
|
| 3660 | + $this->set_taxes( array() ); |
|
| 3661 | + $current = 0; |
|
| 3662 | + } else { |
|
| 3663 | 3663 | |
| 3664 | - $item_taxes = array(); |
|
| 3664 | + $item_taxes = array(); |
|
| 3665 | 3665 | |
| 3666 | - foreach ( $this->get_items() as $item ) { |
|
| 3667 | - $rates = getpaid_get_item_tax_rates( $item, $this->get_country(), $this->get_state() ); |
|
| 3668 | - $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
| 3669 | - $taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, false ), $rates ); |
|
| 3670 | - $r_taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, true ), $rates ); |
|
| 3671 | - foreach ( $taxes as $name => $amount ) { |
|
| 3672 | - $recurring = isset( $r_taxes[ $name ] ) ? $r_taxes[ $name ] : 0; |
|
| 3673 | - $tax = getpaid_prepare_item_tax( $item, $name, $amount, $recurring ); |
|
| 3666 | + foreach ( $this->get_items() as $item ) { |
|
| 3667 | + $rates = getpaid_get_item_tax_rates( $item, $this->get_country(), $this->get_state() ); |
|
| 3668 | + $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
| 3669 | + $taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, false ), $rates ); |
|
| 3670 | + $r_taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, true ), $rates ); |
|
| 3671 | + foreach ( $taxes as $name => $amount ) { |
|
| 3672 | + $recurring = isset( $r_taxes[ $name ] ) ? $r_taxes[ $name ] : 0; |
|
| 3673 | + $tax = getpaid_prepare_item_tax( $item, $name, $amount, $recurring ); |
|
| 3674 | 3674 | |
| 3675 | - if ( ! isset( $item_taxes[ $name ] ) ) { |
|
| 3676 | - $item_taxes[ $name ] = $tax; |
|
| 3677 | - continue; |
|
| 3678 | - } |
|
| 3675 | + if ( ! isset( $item_taxes[ $name ] ) ) { |
|
| 3676 | + $item_taxes[ $name ] = $tax; |
|
| 3677 | + continue; |
|
| 3678 | + } |
|
| 3679 | 3679 | |
| 3680 | - $item_taxes[ $name ]['initial_tax'] += $tax['initial_tax']; |
|
| 3681 | - $item_taxes[ $name ]['recurring_tax'] += $tax['recurring_tax']; |
|
| 3680 | + $item_taxes[ $name ]['initial_tax'] += $tax['initial_tax']; |
|
| 3681 | + $item_taxes[ $name ]['recurring_tax'] += $tax['recurring_tax']; |
|
| 3682 | 3682 | |
| 3683 | - } |
|
| 3683 | + } |
|
| 3684 | 3684 | |
| 3685 | - } |
|
| 3685 | + } |
|
| 3686 | 3686 | |
| 3687 | - $item_taxes = array_replace( $this->get_taxes(), $item_taxes ); |
|
| 3688 | - $this->set_taxes( $item_taxes ); |
|
| 3687 | + $item_taxes = array_replace( $this->get_taxes(), $item_taxes ); |
|
| 3688 | + $this->set_taxes( $item_taxes ); |
|
| 3689 | 3689 | |
| 3690 | - $initial_tax = array_sum( wp_list_pluck( $item_taxes, 'initial_tax' ) ); |
|
| 3691 | - $recurring_tax = array_sum( wp_list_pluck( $item_taxes, 'recurring_tax' ) ); |
|
| 3690 | + $initial_tax = array_sum( wp_list_pluck( $item_taxes, 'initial_tax' ) ); |
|
| 3691 | + $recurring_tax = array_sum( wp_list_pluck( $item_taxes, 'recurring_tax' ) ); |
|
| 3692 | 3692 | |
| 3693 | - $current = $this->is_renewal() ? $recurring_tax : $initial_tax; |
|
| 3693 | + $current = $this->is_renewal() ? $recurring_tax : $initial_tax; |
|
| 3694 | 3694 | |
| 3695 | - $this->totals['tax'] = array( |
|
| 3696 | - 'initial' => $initial_tax, |
|
| 3697 | - 'recurring' => $recurring_tax, |
|
| 3698 | - ); |
|
| 3695 | + $this->totals['tax'] = array( |
|
| 3696 | + 'initial' => $initial_tax, |
|
| 3697 | + 'recurring' => $recurring_tax, |
|
| 3698 | + ); |
|
| 3699 | 3699 | |
| 3700 | - } |
|
| 3700 | + } |
|
| 3701 | 3701 | |
| 3702 | - $this->set_total_tax( $current ); |
|
| 3702 | + $this->set_total_tax( $current ); |
|
| 3703 | 3703 | |
| 3704 | - return $current; |
|
| 3704 | + return $current; |
|
| 3705 | 3705 | |
| 3706 | 3706 | } |
| 3707 | 3707 | |
| 3708 | 3708 | /** |
| 3709 | - * Recalculates the invoice fees total. |
|
| 3710 | - * |
|
| 3711 | - * @since 1.0.19 |
|
| 3712 | - * @return float The recalculated fee |
|
| 3713 | - */ |
|
| 3714 | - public function recalculate_total_fees() { |
|
| 3715 | - $fees = $this->get_fees(); |
|
| 3716 | - $fee = 0; |
|
| 3717 | - $recurring = 0; |
|
| 3709 | + * Recalculates the invoice fees total. |
|
| 3710 | + * |
|
| 3711 | + * @since 1.0.19 |
|
| 3712 | + * @return float The recalculated fee |
|
| 3713 | + */ |
|
| 3714 | + public function recalculate_total_fees() { |
|
| 3715 | + $fees = $this->get_fees(); |
|
| 3716 | + $fee = 0; |
|
| 3717 | + $recurring = 0; |
|
| 3718 | 3718 | |
| 3719 | 3719 | foreach ( $fees as $data ) { |
| 3720 | - $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
| 3721 | - $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
| 3722 | - } |
|
| 3720 | + $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
| 3721 | + $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
| 3722 | + } |
|
| 3723 | 3723 | |
| 3724 | - $current = $this->is_renewal() ? $recurring : $fee; |
|
| 3725 | - $this->set_total_fees( $current ); |
|
| 3724 | + $current = $this->is_renewal() ? $recurring : $fee; |
|
| 3725 | + $this->set_total_fees( $current ); |
|
| 3726 | 3726 | |
| 3727 | - $this->totals['fee'] = array( |
|
| 3728 | - 'initial' => $fee, |
|
| 3729 | - 'recurring' => $recurring, |
|
| 3730 | - ); |
|
| 3727 | + $this->totals['fee'] = array( |
|
| 3728 | + 'initial' => $fee, |
|
| 3729 | + 'recurring' => $recurring, |
|
| 3730 | + ); |
|
| 3731 | 3731 | |
| 3732 | 3732 | $this->set_total_fees( $fee ); |
| 3733 | 3733 | return $current; |
| 3734 | 3734 | } |
| 3735 | 3735 | |
| 3736 | 3736 | /** |
| 3737 | - * Recalculates the invoice total. |
|
| 3738 | - * |
|
| 3739 | - * @since 1.0.19 |
|
| 3737 | + * Recalculates the invoice total. |
|
| 3738 | + * |
|
| 3739 | + * @since 1.0.19 |
|
| 3740 | 3740 | * @return float The invoice total |
| 3741 | - */ |
|
| 3742 | - public function recalculate_total() { |
|
| 3741 | + */ |
|
| 3742 | + public function recalculate_total() { |
|
| 3743 | 3743 | $this->recalculate_total_fees(); |
| 3744 | 3744 | $this->recalculate_total_discount(); |
| 3745 | - $this->recalculate_total_tax(); |
|
| 3746 | - $this->recalculate_subtotal(); |
|
| 3747 | - $this->set_total( $this->get_total_tax( 'edit' ) + $this->get_total_fees( 'edit' ) + $this->get_subtotal( 'edit' ) - $this->get_total_discount( 'edit' ) ); |
|
| 3748 | - return $this->get_total(); |
|
| 3749 | - } |
|
| 3750 | - |
|
| 3751 | - /** |
|
| 3752 | - * @deprecated |
|
| 3753 | - */ |
|
| 3745 | + $this->recalculate_total_tax(); |
|
| 3746 | + $this->recalculate_subtotal(); |
|
| 3747 | + $this->set_total( $this->get_total_tax( 'edit' ) + $this->get_total_fees( 'edit' ) + $this->get_subtotal( 'edit' ) - $this->get_total_discount( 'edit' ) ); |
|
| 3748 | + return $this->get_total(); |
|
| 3749 | + } |
|
| 3750 | + |
|
| 3751 | + /** |
|
| 3752 | + * @deprecated |
|
| 3753 | + */ |
|
| 3754 | 3754 | public function recalculate_totals() { |
| 3755 | 3755 | $this->recalculate_total(); |
| 3756 | 3756 | $this->save( true ); |
@@ -3764,22 +3764,22 @@ discard block |
||
| 3764 | 3764 | return $this->get_data(); |
| 3765 | 3765 | } |
| 3766 | 3766 | |
| 3767 | - /** |
|
| 3767 | + /** |
|
| 3768 | 3768 | * Adds a system note to an invoice. |
| 3769 | 3769 | * |
| 3770 | 3770 | * @param string $note The note being added. |
| 3771 | - * @return int|false The new note's ID on success, false on failure. |
|
| 3771 | + * @return int|false The new note's ID on success, false on failure. |
|
| 3772 | 3772 | * |
| 3773 | 3773 | */ |
| 3774 | 3774 | public function add_system_note( $note ) { |
| 3775 | - return $this->add_note( $note, false, false, true ); |
|
| 3776 | - } |
|
| 3775 | + return $this->add_note( $note, false, false, true ); |
|
| 3776 | + } |
|
| 3777 | 3777 | |
| 3778 | 3778 | /** |
| 3779 | 3779 | * Adds a note to an invoice. |
| 3780 | 3780 | * |
| 3781 | 3781 | * @param string $note The note being added. |
| 3782 | - * @return int|false The new note's ID on success, false on failure. |
|
| 3782 | + * @return int|false The new note's ID on success, false on failure. |
|
| 3783 | 3783 | * |
| 3784 | 3784 | */ |
| 3785 | 3785 | public function add_note( $note = '', $customer_type = false, $added_by_user = false, $system = false ) { |
@@ -3789,21 +3789,21 @@ discard block |
||
| 3789 | 3789 | return false; |
| 3790 | 3790 | } |
| 3791 | 3791 | |
| 3792 | - $author = 'System'; |
|
| 3793 | - $author_email = '[email protected]'; |
|
| 3792 | + $author = 'System'; |
|
| 3793 | + $author_email = '[email protected]'; |
|
| 3794 | 3794 | |
| 3795 | - // If this is an admin comment or it has been added by the user. |
|
| 3796 | - if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
| 3797 | - $user = get_user_by( 'id', get_current_user_id() ); |
|
| 3795 | + // If this is an admin comment or it has been added by the user. |
|
| 3796 | + if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
| 3797 | + $user = get_user_by( 'id', get_current_user_id() ); |
|
| 3798 | 3798 | $author = $user->display_name; |
| 3799 | 3799 | $author_email = $user->user_email; |
| 3800 | - } |
|
| 3800 | + } |
|
| 3801 | 3801 | |
| 3802 | - return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
| 3802 | + return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
| 3803 | 3803 | |
| 3804 | - } |
|
| 3804 | + } |
|
| 3805 | 3805 | |
| 3806 | - /** |
|
| 3806 | + /** |
|
| 3807 | 3807 | * Generates a unique key for the invoice. |
| 3808 | 3808 | */ |
| 3809 | 3809 | public function generate_key( $string = '' ) { |
@@ -3823,113 +3823,113 @@ discard block |
||
| 3823 | 3823 | $number = wpinv_get_next_invoice_number( $this->get_post_type() ); |
| 3824 | 3824 | } |
| 3825 | 3825 | |
| 3826 | - return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
| 3827 | - |
|
| 3828 | - } |
|
| 3829 | - |
|
| 3830 | - /** |
|
| 3831 | - * Handle the status transition. |
|
| 3832 | - */ |
|
| 3833 | - protected function status_transition() { |
|
| 3834 | - $status_transition = $this->status_transition; |
|
| 3835 | - |
|
| 3836 | - // Reset status transition variable. |
|
| 3837 | - $this->status_transition = false; |
|
| 3826 | + return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
| 3838 | 3827 | |
| 3839 | - if ( $status_transition ) { |
|
| 3840 | - try { |
|
| 3841 | - |
|
| 3842 | - // Fire a hook for the status change. |
|
| 3843 | - do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
| 3844 | - |
|
| 3845 | - // @deprecated this is deprecated and will be removed in the future. |
|
| 3846 | - do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
| 3847 | - |
|
| 3848 | - if ( ! empty( $status_transition['from'] ) ) { |
|
| 3849 | - |
|
| 3850 | - /* translators: 1: old invoice status 2: new invoice status */ |
|
| 3851 | - $transition_note = sprintf( __( 'Status changed from %1$s to %2$s.', 'invoicing' ), wpinv_status_nicename( $status_transition['from'], $this ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
| 3852 | - |
|
| 3853 | - // Fire another hook. |
|
| 3854 | - do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
| 3855 | - do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
| 3856 | - |
|
| 3857 | - // @deprecated this is deprecated and will be removed in the future. |
|
| 3858 | - do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
| 3859 | - |
|
| 3860 | - // Note the transition occurred. |
|
| 3861 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), false, $status_transition['manual'] ); |
|
| 3862 | - |
|
| 3863 | - // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
| 3864 | - if ( |
|
| 3865 | - in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
| 3866 | - && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
| 3867 | - ) { |
|
| 3868 | - do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
| 3869 | - } |
|
| 3870 | - |
|
| 3871 | - // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
| 3872 | - if ( |
|
| 3873 | - in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
| 3874 | - && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
| 3875 | - ) { |
|
| 3876 | - do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
| 3877 | - } |
|
| 3878 | - } else { |
|
| 3879 | - /* translators: %s: new invoice status */ |
|
| 3880 | - $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
| 3881 | - |
|
| 3882 | - // Note the transition occurred. |
|
| 3883 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
| 3828 | + } |
|
| 3884 | 3829 | |
| 3885 | - } |
|
| 3886 | - } catch ( Exception $e ) { |
|
| 3887 | - $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
| 3888 | - } |
|
| 3889 | - } |
|
| 3890 | - } |
|
| 3830 | + /** |
|
| 3831 | + * Handle the status transition. |
|
| 3832 | + */ |
|
| 3833 | + protected function status_transition() { |
|
| 3834 | + $status_transition = $this->status_transition; |
|
| 3835 | + |
|
| 3836 | + // Reset status transition variable. |
|
| 3837 | + $this->status_transition = false; |
|
| 3838 | + |
|
| 3839 | + if ( $status_transition ) { |
|
| 3840 | + try { |
|
| 3841 | + |
|
| 3842 | + // Fire a hook for the status change. |
|
| 3843 | + do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
| 3844 | + |
|
| 3845 | + // @deprecated this is deprecated and will be removed in the future. |
|
| 3846 | + do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
| 3847 | + |
|
| 3848 | + if ( ! empty( $status_transition['from'] ) ) { |
|
| 3849 | + |
|
| 3850 | + /* translators: 1: old invoice status 2: new invoice status */ |
|
| 3851 | + $transition_note = sprintf( __( 'Status changed from %1$s to %2$s.', 'invoicing' ), wpinv_status_nicename( $status_transition['from'], $this ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
| 3852 | + |
|
| 3853 | + // Fire another hook. |
|
| 3854 | + do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
| 3855 | + do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
| 3856 | + |
|
| 3857 | + // @deprecated this is deprecated and will be removed in the future. |
|
| 3858 | + do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
| 3859 | + |
|
| 3860 | + // Note the transition occurred. |
|
| 3861 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), false, $status_transition['manual'] ); |
|
| 3862 | + |
|
| 3863 | + // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
| 3864 | + if ( |
|
| 3865 | + in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
| 3866 | + && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
| 3867 | + ) { |
|
| 3868 | + do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
| 3869 | + } |
|
| 3870 | + |
|
| 3871 | + // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
| 3872 | + if ( |
|
| 3873 | + in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
| 3874 | + && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
| 3875 | + ) { |
|
| 3876 | + do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
| 3877 | + } |
|
| 3878 | + } else { |
|
| 3879 | + /* translators: %s: new invoice status */ |
|
| 3880 | + $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
| 3881 | + |
|
| 3882 | + // Note the transition occurred. |
|
| 3883 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
| 3884 | + |
|
| 3885 | + } |
|
| 3886 | + } catch ( Exception $e ) { |
|
| 3887 | + $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
| 3888 | + } |
|
| 3889 | + } |
|
| 3890 | + } |
|
| 3891 | 3891 | |
| 3892 | - /** |
|
| 3893 | - * Updates an invoice status. |
|
| 3894 | - */ |
|
| 3895 | - public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
| 3892 | + /** |
|
| 3893 | + * Updates an invoice status. |
|
| 3894 | + */ |
|
| 3895 | + public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
| 3896 | 3896 | |
| 3897 | - // Fires before updating a status. |
|
| 3898 | - do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
| 3897 | + // Fires before updating a status. |
|
| 3898 | + do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
| 3899 | 3899 | |
| 3900 | - // Update the status. |
|
| 3901 | - $this->set_status( $new_status, $note, $manual ); |
|
| 3900 | + // Update the status. |
|
| 3901 | + $this->set_status( $new_status, $note, $manual ); |
|
| 3902 | 3902 | |
| 3903 | - // Save the order. |
|
| 3904 | - return $this->save(); |
|
| 3903 | + // Save the order. |
|
| 3904 | + return $this->save(); |
|
| 3905 | 3905 | |
| 3906 | - } |
|
| 3906 | + } |
|
| 3907 | 3907 | |
| 3908 | - /** |
|
| 3909 | - * @deprecated |
|
| 3910 | - */ |
|
| 3911 | - public function refresh_item_ids() { |
|
| 3908 | + /** |
|
| 3909 | + * @deprecated |
|
| 3910 | + */ |
|
| 3911 | + public function refresh_item_ids() { |
|
| 3912 | 3912 | $item_ids = implode( ',', array_unique( wp_list_pluck( $this->get_cart_details(), 'item_id' ) ) ); |
| 3913 | 3913 | update_post_meta( $this->get_id(), '_wpinv_item_ids', $item_ids ); |
| 3914 | - } |
|
| 3914 | + } |
|
| 3915 | 3915 | |
| 3916 | - /** |
|
| 3917 | - * @deprecated |
|
| 3918 | - */ |
|
| 3919 | - public function update_items( $temp = false ) { |
|
| 3916 | + /** |
|
| 3917 | + * @deprecated |
|
| 3918 | + */ |
|
| 3919 | + public function update_items( $temp = false ) { |
|
| 3920 | 3920 | |
| 3921 | - $this->set_items( $this->get_items() ); |
|
| 3921 | + $this->set_items( $this->get_items() ); |
|
| 3922 | 3922 | |
| 3923 | - if ( ! $temp ) { |
|
| 3924 | - $this->save(); |
|
| 3925 | - } |
|
| 3923 | + if ( ! $temp ) { |
|
| 3924 | + $this->save(); |
|
| 3925 | + } |
|
| 3926 | 3926 | |
| 3927 | 3927 | return $this; |
| 3928 | - } |
|
| 3928 | + } |
|
| 3929 | 3929 | |
| 3930 | - /** |
|
| 3931 | - * @deprecated |
|
| 3932 | - */ |
|
| 3930 | + /** |
|
| 3931 | + * @deprecated |
|
| 3932 | + */ |
|
| 3933 | 3933 | public function validate_discount() { |
| 3934 | 3934 | |
| 3935 | 3935 | $discount_code = $this->get_discount_code(); |
@@ -3945,93 +3945,93 @@ discard block |
||
| 3945 | 3945 | |
| 3946 | 3946 | } |
| 3947 | 3947 | |
| 3948 | - /** |
|
| 3949 | - * Refunds an invoice. |
|
| 3950 | - */ |
|
| 3948 | + /** |
|
| 3949 | + * Refunds an invoice. |
|
| 3950 | + */ |
|
| 3951 | 3951 | public function refund() { |
| 3952 | - $this->set_status( 'wpi-refunded' ); |
|
| 3952 | + $this->set_status( 'wpi-refunded' ); |
|
| 3953 | 3953 | $this->save(); |
| 3954 | - } |
|
| 3954 | + } |
|
| 3955 | 3955 | |
| 3956 | - /** |
|
| 3957 | - * Marks an invoice as paid. |
|
| 3958 | - * |
|
| 3959 | - * @param string $transaction_id |
|
| 3960 | - */ |
|
| 3956 | + /** |
|
| 3957 | + * Marks an invoice as paid. |
|
| 3958 | + * |
|
| 3959 | + * @param string $transaction_id |
|
| 3960 | + */ |
|
| 3961 | 3961 | public function mark_paid( $transaction_id = null, $note = '' ) { |
| 3962 | 3962 | |
| 3963 | - // Set the transaction id. |
|
| 3964 | - if ( empty( $transaction_id ) ) { |
|
| 3965 | - $transaction_id = $this->generate_key('trans_'); |
|
| 3966 | - } |
|
| 3963 | + // Set the transaction id. |
|
| 3964 | + if ( empty( $transaction_id ) ) { |
|
| 3965 | + $transaction_id = $this->generate_key('trans_'); |
|
| 3966 | + } |
|
| 3967 | 3967 | |
| 3968 | - if ( ! $this->get_transaction_id() ) { |
|
| 3969 | - $this->set_transaction_id( $transaction_id ); |
|
| 3970 | - } |
|
| 3968 | + if ( ! $this->get_transaction_id() ) { |
|
| 3969 | + $this->set_transaction_id( $transaction_id ); |
|
| 3970 | + } |
|
| 3971 | 3971 | |
| 3972 | - if ( $this->is_paid() && 'wpi-processing' != $this->get_status() ) { |
|
| 3973 | - return $this->save(); |
|
| 3974 | - } |
|
| 3972 | + if ( $this->is_paid() && 'wpi-processing' != $this->get_status() ) { |
|
| 3973 | + return $this->save(); |
|
| 3974 | + } |
|
| 3975 | 3975 | |
| 3976 | - // Set the completed date. |
|
| 3977 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
| 3976 | + // Set the completed date. |
|
| 3977 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
| 3978 | 3978 | |
| 3979 | - // Set the new status. |
|
| 3980 | - $gateway = sanitize_text_field( $this->get_gateway_title() ); |
|
| 3981 | - if ( $this->is_renewal() || ! $this->is_parent() ) { |
|
| 3979 | + // Set the new status. |
|
| 3980 | + $gateway = sanitize_text_field( $this->get_gateway_title() ); |
|
| 3981 | + if ( $this->is_renewal() || ! $this->is_parent() ) { |
|
| 3982 | 3982 | |
| 3983 | - $_note = wp_sprintf( __( 'Renewed via %s', 'invoicing' ), $gateway ); |
|
| 3984 | - $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
| 3983 | + $_note = wp_sprintf( __( 'Renewed via %s', 'invoicing' ), $gateway ); |
|
| 3984 | + $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
| 3985 | 3985 | |
| 3986 | - if ( 'none' == $this->get_gateway() ) { |
|
| 3987 | - $_note = $note; |
|
| 3988 | - } |
|
| 3986 | + if ( 'none' == $this->get_gateway() ) { |
|
| 3987 | + $_note = $note; |
|
| 3988 | + } |
|
| 3989 | 3989 | |
| 3990 | - $this->set_status( 'wpi-renewal', $_note ); |
|
| 3990 | + $this->set_status( 'wpi-renewal', $_note ); |
|
| 3991 | 3991 | |
| 3992 | - } else { |
|
| 3992 | + } else { |
|
| 3993 | 3993 | |
| 3994 | - $_note = wp_sprintf( __( 'Paid via %s', 'invoicing' ), $gateway ); |
|
| 3995 | - $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
| 3994 | + $_note = wp_sprintf( __( 'Paid via %s', 'invoicing' ), $gateway ); |
|
| 3995 | + $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
| 3996 | 3996 | |
| 3997 | - if ( 'none' == $this->get_gateway() ) { |
|
| 3998 | - $_note = $note; |
|
| 3999 | - } |
|
| 3997 | + if ( 'none' == $this->get_gateway() ) { |
|
| 3998 | + $_note = $note; |
|
| 3999 | + } |
|
| 4000 | 4000 | |
| 4001 | - $this->set_status( 'publish', $_note ); |
|
| 4001 | + $this->set_status( 'publish', $_note ); |
|
| 4002 | 4002 | |
| 4003 | - } |
|
| 4003 | + } |
|
| 4004 | 4004 | |
| 4005 | - // Set checkout mode. |
|
| 4006 | - $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
| 4007 | - $this->set_mode( $mode ); |
|
| 4005 | + // Set checkout mode. |
|
| 4006 | + $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
| 4007 | + $this->set_mode( $mode ); |
|
| 4008 | 4008 | |
| 4009 | - // Save the invoice. |
|
| 4009 | + // Save the invoice. |
|
| 4010 | 4010 | $this->save(); |
| 4011 | - } |
|
| 4012 | - |
|
| 4013 | - /** |
|
| 4014 | - * Save data to the database. |
|
| 4015 | - * |
|
| 4016 | - * @since 1.0.19 |
|
| 4017 | - * @return int invoice ID |
|
| 4018 | - */ |
|
| 4019 | - public function save() { |
|
| 4020 | - $this->maybe_set_date_paid(); |
|
| 4021 | - $this->maybe_set_key(); |
|
| 4022 | - parent::save(); |
|
| 4023 | - $this->clear_cache(); |
|
| 4024 | - $this->status_transition(); |
|
| 4025 | - return $this->get_id(); |
|
| 4026 | - } |
|
| 4027 | - |
|
| 4028 | - /** |
|
| 4011 | + } |
|
| 4012 | + |
|
| 4013 | + /** |
|
| 4014 | + * Save data to the database. |
|
| 4015 | + * |
|
| 4016 | + * @since 1.0.19 |
|
| 4017 | + * @return int invoice ID |
|
| 4018 | + */ |
|
| 4019 | + public function save() { |
|
| 4020 | + $this->maybe_set_date_paid(); |
|
| 4021 | + $this->maybe_set_key(); |
|
| 4022 | + parent::save(); |
|
| 4023 | + $this->clear_cache(); |
|
| 4024 | + $this->status_transition(); |
|
| 4025 | + return $this->get_id(); |
|
| 4026 | + } |
|
| 4027 | + |
|
| 4028 | + /** |
|
| 4029 | 4029 | * Clears the subscription's cache. |
| 4030 | 4030 | */ |
| 4031 | 4031 | public function clear_cache() { |
| 4032 | - wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
| 4033 | - wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
| 4034 | - wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
| 4035 | - } |
|
| 4032 | + wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
| 4033 | + wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
| 4034 | + wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
| 4035 | + } |
|
| 4036 | 4036 | |
| 4037 | 4037 | } |
@@ -14,91 +14,91 @@ discard block |
||
| 14 | 14 | class GetPaid_Admin { |
| 15 | 15 | |
| 16 | 16 | /** |
| 17 | - * Local path to this plugins admin directory |
|
| 18 | - * |
|
| 19 | - * @var string |
|
| 20 | - */ |
|
| 21 | - public $admin_path; |
|
| 22 | - |
|
| 23 | - /** |
|
| 24 | - * Web path to this plugins admin directory |
|
| 25 | - * |
|
| 26 | - * @var string |
|
| 27 | - */ |
|
| 28 | - public $admin_url; |
|
| 17 | + * Local path to this plugins admin directory |
|
| 18 | + * |
|
| 19 | + * @var string |
|
| 20 | + */ |
|
| 21 | + public $admin_path; |
|
| 22 | + |
|
| 23 | + /** |
|
| 24 | + * Web path to this plugins admin directory |
|
| 25 | + * |
|
| 26 | + * @var string |
|
| 27 | + */ |
|
| 28 | + public $admin_url; |
|
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * Reports components. |
|
| 32 | - * |
|
| 33 | - * @var GetPaid_Reports |
|
| 34 | - */ |
|
| 30 | + /** |
|
| 31 | + * Reports components. |
|
| 32 | + * |
|
| 33 | + * @var GetPaid_Reports |
|
| 34 | + */ |
|
| 35 | 35 | public $reports; |
| 36 | 36 | |
| 37 | 37 | /** |
| 38 | - * Class constructor. |
|
| 39 | - */ |
|
| 40 | - public function __construct(){ |
|
| 38 | + * Class constructor. |
|
| 39 | + */ |
|
| 40 | + public function __construct(){ |
|
| 41 | 41 | |
| 42 | 42 | $this->admin_path = plugin_dir_path( __FILE__ ); |
| 43 | - $this->admin_url = plugins_url( '/', __FILE__ ); |
|
| 44 | - $this->reports = new GetPaid_Reports(); |
|
| 43 | + $this->admin_url = plugins_url( '/', __FILE__ ); |
|
| 44 | + $this->reports = new GetPaid_Reports(); |
|
| 45 | 45 | |
| 46 | 46 | if ( is_admin() ) { |
| 47 | - $this->init_admin_hooks(); |
|
| 47 | + $this->init_admin_hooks(); |
|
| 48 | 48 | } |
| 49 | 49 | |
| 50 | 50 | } |
| 51 | 51 | |
| 52 | 52 | /** |
| 53 | - * Init action and filter hooks |
|
| 54 | - * |
|
| 55 | - */ |
|
| 56 | - private function init_admin_hooks() { |
|
| 53 | + * Init action and filter hooks |
|
| 54 | + * |
|
| 55 | + */ |
|
| 56 | + private function init_admin_hooks() { |
|
| 57 | 57 | add_action( 'admin_enqueue_scripts', array( $this, 'enqeue_scripts' ), 9 ); |
| 58 | 58 | add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) ); |
| 59 | 59 | add_action( 'admin_init', array( $this, 'init_ayecode_connect_helper' ) ); |
| 60 | 60 | add_action( 'admin_init', array( $this, 'activation_redirect') ); |
| 61 | 61 | add_action( 'admin_init', array( $this, 'maybe_do_admin_action') ); |
| 62 | - add_action( 'admin_notices', array( $this, 'show_notices' ) ); |
|
| 63 | - add_action( 'getpaid_authenticated_admin_action_rate_plugin', array( $this, 'redirect_to_wordpress_rating_page' ) ); |
|
| 64 | - add_action( 'getpaid_authenticated_admin_action_duplicate_form', array( $this, 'duplicate_payment_form' ) ); |
|
| 65 | - add_action( 'getpaid_authenticated_admin_action_duplicate_invoice', array( $this, 'duplicate_invoice' ) ); |
|
| 66 | - add_action( 'getpaid_authenticated_admin_action_send_invoice', array( $this, 'send_customer_invoice' ) ); |
|
| 67 | - add_action( 'getpaid_authenticated_admin_action_send_invoice_reminder', array( $this, 'send_customer_payment_reminder' ) ); |
|
| 62 | + add_action( 'admin_notices', array( $this, 'show_notices' ) ); |
|
| 63 | + add_action( 'getpaid_authenticated_admin_action_rate_plugin', array( $this, 'redirect_to_wordpress_rating_page' ) ); |
|
| 64 | + add_action( 'getpaid_authenticated_admin_action_duplicate_form', array( $this, 'duplicate_payment_form' ) ); |
|
| 65 | + add_action( 'getpaid_authenticated_admin_action_duplicate_invoice', array( $this, 'duplicate_invoice' ) ); |
|
| 66 | + add_action( 'getpaid_authenticated_admin_action_send_invoice', array( $this, 'send_customer_invoice' ) ); |
|
| 67 | + add_action( 'getpaid_authenticated_admin_action_send_invoice_reminder', array( $this, 'send_customer_payment_reminder' ) ); |
|
| 68 | 68 | add_action( 'getpaid_authenticated_admin_action_reset_tax_rates', array( $this, 'admin_reset_tax_rates' ) ); |
| 69 | - add_action( 'getpaid_authenticated_admin_action_create_missing_pages', array( $this, 'admin_create_missing_pages' ) ); |
|
| 70 | - add_action( 'getpaid_authenticated_admin_action_create_missing_tables', array( $this, 'admin_create_missing_tables' ) ); |
|
| 71 | - add_action( 'getpaid_authenticated_admin_action_migrate_old_invoices', array( $this, 'admin_migrate_old_invoices' ) ); |
|
| 72 | - add_action( 'getpaid_authenticated_admin_action_download_customers', array( $this, 'admin_download_customers' ) ); |
|
| 73 | - add_action( 'getpaid_authenticated_admin_action_recalculate_discounts', array( $this, 'admin_recalculate_discounts' ) ); |
|
| 74 | - add_action( 'getpaid_authenticated_admin_action_install_plugin', array( $this, 'admin_install_plugin' ) ); |
|
| 75 | - add_action( 'getpaid_authenticated_admin_action_connect_gateway', array( $this, 'admin_connect_gateway' ) ); |
|
| 76 | - add_filter( 'admin_footer_text', array( $this, 'admin_footer_text' ) ); |
|
| 77 | - do_action( 'getpaid_init_admin_hooks', $this ); |
|
| 78 | - |
|
| 79 | - // Setup/welcome |
|
| 80 | - if ( ! empty( $_GET['page'] ) ) { |
|
| 81 | - switch ( $_GET['page'] ) { |
|
| 82 | - case 'gp-setup' : |
|
| 83 | - include_once( dirname( __FILE__ ) . '/class-getpaid-admin-setup-wizard.php' ); |
|
| 84 | - break; |
|
| 85 | - } |
|
| 86 | - } |
|
| 87 | - |
|
| 88 | - } |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * Register admin scripts |
|
| 92 | - * |
|
| 93 | - */ |
|
| 94 | - public function enqeue_scripts() { |
|
| 69 | + add_action( 'getpaid_authenticated_admin_action_create_missing_pages', array( $this, 'admin_create_missing_pages' ) ); |
|
| 70 | + add_action( 'getpaid_authenticated_admin_action_create_missing_tables', array( $this, 'admin_create_missing_tables' ) ); |
|
| 71 | + add_action( 'getpaid_authenticated_admin_action_migrate_old_invoices', array( $this, 'admin_migrate_old_invoices' ) ); |
|
| 72 | + add_action( 'getpaid_authenticated_admin_action_download_customers', array( $this, 'admin_download_customers' ) ); |
|
| 73 | + add_action( 'getpaid_authenticated_admin_action_recalculate_discounts', array( $this, 'admin_recalculate_discounts' ) ); |
|
| 74 | + add_action( 'getpaid_authenticated_admin_action_install_plugin', array( $this, 'admin_install_plugin' ) ); |
|
| 75 | + add_action( 'getpaid_authenticated_admin_action_connect_gateway', array( $this, 'admin_connect_gateway' ) ); |
|
| 76 | + add_filter( 'admin_footer_text', array( $this, 'admin_footer_text' ) ); |
|
| 77 | + do_action( 'getpaid_init_admin_hooks', $this ); |
|
| 78 | + |
|
| 79 | + // Setup/welcome |
|
| 80 | + if ( ! empty( $_GET['page'] ) ) { |
|
| 81 | + switch ( $_GET['page'] ) { |
|
| 82 | + case 'gp-setup' : |
|
| 83 | + include_once( dirname( __FILE__ ) . '/class-getpaid-admin-setup-wizard.php' ); |
|
| 84 | + break; |
|
| 85 | + } |
|
| 86 | + } |
|
| 87 | + |
|
| 88 | + } |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * Register admin scripts |
|
| 92 | + * |
|
| 93 | + */ |
|
| 94 | + public function enqeue_scripts() { |
|
| 95 | 95 | global $current_screen, $pagenow; |
| 96 | 96 | |
| 97 | - $page = isset( $_GET['page'] ) ? $_GET['page'] : ''; |
|
| 98 | - $editing = $pagenow == 'post.php' || $pagenow == 'post-new.php'; |
|
| 97 | + $page = isset( $_GET['page'] ) ? $_GET['page'] : ''; |
|
| 98 | + $editing = $pagenow == 'post.php' || $pagenow == 'post-new.php'; |
|
| 99 | 99 | |
| 100 | 100 | if ( ! empty( $current_screen->post_type ) ) { |
| 101 | - $page = $current_screen->post_type; |
|
| 101 | + $page = $current_screen->post_type; |
|
| 102 | 102 | } |
| 103 | 103 | |
| 104 | 104 | // General styles. |
@@ -119,54 +119,54 @@ discard block |
||
| 119 | 119 | } |
| 120 | 120 | |
| 121 | 121 | // Payment form scripts. |
| 122 | - if ( 'wpi_payment_form' == $page && $editing ) { |
|
| 122 | + if ( 'wpi_payment_form' == $page && $editing ) { |
|
| 123 | 123 | $this->load_payment_form_scripts(); |
| 124 | 124 | } |
| 125 | 125 | |
| 126 | - if ( $page == 'wpinv-subscriptions' ) { |
|
| 127 | - wp_enqueue_script( 'postbox' ); |
|
| 128 | - } |
|
| 126 | + if ( $page == 'wpinv-subscriptions' ) { |
|
| 127 | + wp_enqueue_script( 'postbox' ); |
|
| 128 | + } |
|
| 129 | 129 | |
| 130 | 130 | } |
| 131 | 131 | |
| 132 | 132 | /** |
| 133 | - * Returns admin js translations. |
|
| 134 | - * |
|
| 135 | - */ |
|
| 136 | - protected function get_admin_i18() { |
|
| 133 | + * Returns admin js translations. |
|
| 134 | + * |
|
| 135 | + */ |
|
| 136 | + protected function get_admin_i18() { |
|
| 137 | 137 | global $post; |
| 138 | 138 | |
| 139 | - $date_range = array( |
|
| 140 | - 'period' => isset( $_GET['date_range'] ) ? sanitize_text_field( $_GET['date_range'] ) : '7_days' |
|
| 141 | - ); |
|
| 139 | + $date_range = array( |
|
| 140 | + 'period' => isset( $_GET['date_range'] ) ? sanitize_text_field( $_GET['date_range'] ) : '7_days' |
|
| 141 | + ); |
|
| 142 | 142 | |
| 143 | - if ( $date_range['period'] == 'custom' ) { |
|
| 143 | + if ( $date_range['period'] == 'custom' ) { |
|
| 144 | 144 | |
| 145 | - if ( isset( $_GET['from'] ) ) { |
|
| 146 | - $date_range[ 'after' ] = date( 'Y-m-d', strtotime( sanitize_text_field( $_GET['from'] ), current_time( 'timestamp' ) ) - DAY_IN_SECONDS ); |
|
| 147 | - } |
|
| 145 | + if ( isset( $_GET['from'] ) ) { |
|
| 146 | + $date_range[ 'after' ] = date( 'Y-m-d', strtotime( sanitize_text_field( $_GET['from'] ), current_time( 'timestamp' ) ) - DAY_IN_SECONDS ); |
|
| 147 | + } |
|
| 148 | 148 | |
| 149 | - if ( isset( $_GET['to'] ) ) { |
|
| 150 | - $date_range[ 'before' ] = date( 'Y-m-d', strtotime( sanitize_text_field( $_GET['to'] ), current_time( 'timestamp' ) ) + DAY_IN_SECONDS ); |
|
| 151 | - } |
|
| 149 | + if ( isset( $_GET['to'] ) ) { |
|
| 150 | + $date_range[ 'before' ] = date( 'Y-m-d', strtotime( sanitize_text_field( $_GET['to'] ), current_time( 'timestamp' ) ) + DAY_IN_SECONDS ); |
|
| 151 | + } |
|
| 152 | 152 | |
| 153 | - } |
|
| 153 | + } |
|
| 154 | 154 | |
| 155 | 155 | $i18n = array( |
| 156 | 156 | 'ajax_url' => admin_url( 'admin-ajax.php' ), |
| 157 | 157 | 'post_ID' => isset( $post->ID ) ? $post->ID : '', |
| 158 | - 'wpinv_nonce' => wp_create_nonce( 'wpinv-nonce' ), |
|
| 159 | - 'rest_nonce' => wp_create_nonce( 'wp_rest' ), |
|
| 160 | - 'rest_root' => esc_url_raw( rest_url() ), |
|
| 161 | - 'date_range' => $date_range, |
|
| 158 | + 'wpinv_nonce' => wp_create_nonce( 'wpinv-nonce' ), |
|
| 159 | + 'rest_nonce' => wp_create_nonce( 'wp_rest' ), |
|
| 160 | + 'rest_root' => esc_url_raw( rest_url() ), |
|
| 161 | + 'date_range' => $date_range, |
|
| 162 | 162 | 'add_invoice_note_nonce' => wp_create_nonce( 'add-invoice-note' ), |
| 163 | 163 | 'delete_invoice_note_nonce' => wp_create_nonce( 'delete-invoice-note' ), |
| 164 | 164 | 'invoice_item_nonce' => wp_create_nonce( 'invoice-item' ), |
| 165 | 165 | 'billing_details_nonce' => wp_create_nonce( 'get-billing-details' ), |
| 166 | 166 | 'tax' => wpinv_tax_amount(), |
| 167 | 167 | 'discount' => 0, |
| 168 | - 'currency_symbol' => wpinv_currency_symbol(), |
|
| 169 | - 'currency' => wpinv_get_currency(), |
|
| 168 | + 'currency_symbol' => wpinv_currency_symbol(), |
|
| 169 | + 'currency' => wpinv_get_currency(), |
|
| 170 | 170 | 'currency_pos' => wpinv_currency_position(), |
| 171 | 171 | 'thousand_sep' => wpinv_thousands_separator(), |
| 172 | 172 | 'decimal_sep' => wpinv_decimal_separator(), |
@@ -186,119 +186,119 @@ discard block |
||
| 186 | 186 | 'item_description' => __( 'Item Description', 'invoicing' ), |
| 187 | 187 | 'invoice_description' => __( 'Invoice Description', 'invoicing' ), |
| 188 | 188 | 'discount_description' => __( 'Discount Description', 'invoicing' ), |
| 189 | - 'searching' => __( 'Searching', 'invoicing' ), |
|
| 190 | - 'loading' => __( 'Loading...', 'invoicing' ), |
|
| 191 | - 'search_customers' => __( 'Enter customer name or email', 'invoicing' ), |
|
| 192 | - 'search_items' => __( 'Enter item name', 'invoicing' ), |
|
| 193 | - 'graphs' => array_merge( ['refunded_fees', 'refunded_items', 'refunded_subtotal', 'refunded_tax'], array_keys( wpinv_get_report_graphs() ) ), |
|
| 189 | + 'searching' => __( 'Searching', 'invoicing' ), |
|
| 190 | + 'loading' => __( 'Loading...', 'invoicing' ), |
|
| 191 | + 'search_customers' => __( 'Enter customer name or email', 'invoicing' ), |
|
| 192 | + 'search_items' => __( 'Enter item name', 'invoicing' ), |
|
| 193 | + 'graphs' => array_merge( ['refunded_fees', 'refunded_items', 'refunded_subtotal', 'refunded_tax'], array_keys( wpinv_get_report_graphs() ) ), |
|
| 194 | 194 | ); |
| 195 | 195 | |
| 196 | - if ( ! empty( $post ) && getpaid_is_invoice_post_type( $post->post_type ) ) { |
|
| 196 | + if ( ! empty( $post ) && getpaid_is_invoice_post_type( $post->post_type ) ) { |
|
| 197 | 197 | |
| 198 | - $invoice = new WPInv_Invoice( $post ); |
|
| 199 | - $i18n['save_invoice'] = sprintf( |
|
| 200 | - __( 'Save %s', 'invoicing' ), |
|
| 201 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 202 | - ); |
|
| 198 | + $invoice = new WPInv_Invoice( $post ); |
|
| 199 | + $i18n['save_invoice'] = sprintf( |
|
| 200 | + __( 'Save %s', 'invoicing' ), |
|
| 201 | + ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 202 | + ); |
|
| 203 | 203 | |
| 204 | - $i18n['invoice_description'] = sprintf( |
|
| 205 | - __( '%s Description', 'invoicing' ), |
|
| 206 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 207 | - ); |
|
| 204 | + $i18n['invoice_description'] = sprintf( |
|
| 205 | + __( '%s Description', 'invoicing' ), |
|
| 206 | + ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 207 | + ); |
|
| 208 | 208 | |
| 209 | - } |
|
| 210 | - return $i18n; |
|
| 211 | - } |
|
| 209 | + } |
|
| 210 | + return $i18n; |
|
| 211 | + } |
|
| 212 | 212 | |
| 213 | - /** |
|
| 214 | - * Change the admin footer text on GetPaid admin pages. |
|
| 215 | - * |
|
| 216 | - * @since 2.0.0 |
|
| 217 | - * @param string $footer_text |
|
| 218 | - * @return string |
|
| 219 | - */ |
|
| 220 | - public function admin_footer_text( $footer_text ) { |
|
| 221 | - global $current_screen; |
|
| 213 | + /** |
|
| 214 | + * Change the admin footer text on GetPaid admin pages. |
|
| 215 | + * |
|
| 216 | + * @since 2.0.0 |
|
| 217 | + * @param string $footer_text |
|
| 218 | + * @return string |
|
| 219 | + */ |
|
| 220 | + public function admin_footer_text( $footer_text ) { |
|
| 221 | + global $current_screen; |
|
| 222 | 222 | |
| 223 | - $page = isset( $_GET['page'] ) ? $_GET['page'] : ''; |
|
| 223 | + $page = isset( $_GET['page'] ) ? $_GET['page'] : ''; |
|
| 224 | 224 | |
| 225 | 225 | if ( ! empty( $current_screen->post_type ) ) { |
| 226 | - $page = $current_screen->post_type; |
|
| 226 | + $page = $current_screen->post_type; |
|
| 227 | 227 | } |
| 228 | 228 | |
| 229 | 229 | // General styles. |
| 230 | 230 | if ( apply_filters( 'getpaid_display_admin_footer_text', wpinv_current_user_can_manage_invoicing() ) && false !== stripos( $page, 'wpi' ) ) { |
| 231 | 231 | |
| 232 | - // Change the footer text |
|
| 233 | - if ( ! get_user_meta( get_current_user_id(), 'getpaid_admin_footer_text_rated', true ) ) { |
|
| 234 | - |
|
| 235 | - $rating_url = esc_url( |
|
| 236 | - wp_nonce_url( |
|
| 237 | - admin_url( 'admin.php?page=wpinv-reports&getpaid-admin-action=rate_plugin' ), |
|
| 238 | - 'getpaid-nonce', |
|
| 239 | - 'getpaid-nonce' |
|
| 240 | - ) |
|
| 241 | - ); |
|
| 242 | - |
|
| 243 | - $footer_text = sprintf( |
|
| 244 | - /* translators: %s: five stars */ |
|
| 245 | - __( 'If you like <strong>GetPaid</strong>, please leave us a %s rating. A huge thanks in advance!', 'invoicing' ), |
|
| 246 | - "<a href='$rating_url'>★★★★★</a>" |
|
| 247 | - ); |
|
| 248 | - |
|
| 249 | - } else { |
|
| 250 | - |
|
| 251 | - $footer_text = sprintf( |
|
| 252 | - /* translators: %s: GetPaid */ |
|
| 253 | - __( 'Thank you for using %s!', 'invoicing' ), |
|
| 254 | - "<a href='https://wpgetpaid.com/' target='_blank'><strong>GetPaid</strong></a>" |
|
| 255 | - ); |
|
| 256 | - |
|
| 257 | - } |
|
| 258 | - |
|
| 259 | - } |
|
| 260 | - |
|
| 261 | - return $footer_text; |
|
| 262 | - } |
|
| 263 | - |
|
| 264 | - /** |
|
| 265 | - * Redirects to wp.org to rate the plugin. |
|
| 266 | - * |
|
| 267 | - * @since 2.0.0 |
|
| 268 | - */ |
|
| 269 | - public function redirect_to_wordpress_rating_page() { |
|
| 270 | - update_user_meta( get_current_user_id(), 'getpaid_admin_footer_text_rated', 1 ); |
|
| 271 | - wp_redirect( 'https://wordpress.org/support/plugin/invoicing/reviews?rate=5#new-post' ); |
|
| 272 | - exit; |
|
| 273 | - } |
|
| 274 | - |
|
| 275 | - /** |
|
| 276 | - * Loads payment form js. |
|
| 277 | - * |
|
| 278 | - */ |
|
| 279 | - protected function load_payment_form_scripts() { |
|
| 232 | + // Change the footer text |
|
| 233 | + if ( ! get_user_meta( get_current_user_id(), 'getpaid_admin_footer_text_rated', true ) ) { |
|
| 234 | + |
|
| 235 | + $rating_url = esc_url( |
|
| 236 | + wp_nonce_url( |
|
| 237 | + admin_url( 'admin.php?page=wpinv-reports&getpaid-admin-action=rate_plugin' ), |
|
| 238 | + 'getpaid-nonce', |
|
| 239 | + 'getpaid-nonce' |
|
| 240 | + ) |
|
| 241 | + ); |
|
| 242 | + |
|
| 243 | + $footer_text = sprintf( |
|
| 244 | + /* translators: %s: five stars */ |
|
| 245 | + __( 'If you like <strong>GetPaid</strong>, please leave us a %s rating. A huge thanks in advance!', 'invoicing' ), |
|
| 246 | + "<a href='$rating_url'>★★★★★</a>" |
|
| 247 | + ); |
|
| 248 | + |
|
| 249 | + } else { |
|
| 250 | + |
|
| 251 | + $footer_text = sprintf( |
|
| 252 | + /* translators: %s: GetPaid */ |
|
| 253 | + __( 'Thank you for using %s!', 'invoicing' ), |
|
| 254 | + "<a href='https://wpgetpaid.com/' target='_blank'><strong>GetPaid</strong></a>" |
|
| 255 | + ); |
|
| 256 | + |
|
| 257 | + } |
|
| 258 | + |
|
| 259 | + } |
|
| 260 | + |
|
| 261 | + return $footer_text; |
|
| 262 | + } |
|
| 263 | + |
|
| 264 | + /** |
|
| 265 | + * Redirects to wp.org to rate the plugin. |
|
| 266 | + * |
|
| 267 | + * @since 2.0.0 |
|
| 268 | + */ |
|
| 269 | + public function redirect_to_wordpress_rating_page() { |
|
| 270 | + update_user_meta( get_current_user_id(), 'getpaid_admin_footer_text_rated', 1 ); |
|
| 271 | + wp_redirect( 'https://wordpress.org/support/plugin/invoicing/reviews?rate=5#new-post' ); |
|
| 272 | + exit; |
|
| 273 | + } |
|
| 274 | + |
|
| 275 | + /** |
|
| 276 | + * Loads payment form js. |
|
| 277 | + * |
|
| 278 | + */ |
|
| 279 | + protected function load_payment_form_scripts() { |
|
| 280 | 280 | global $post; |
| 281 | 281 | |
| 282 | 282 | wp_enqueue_script( 'vue', WPINV_PLUGIN_URL . 'assets/js/vue/vue.min.js', array(), WPINV_VERSION ); |
| 283 | - wp_enqueue_script( 'sortable', WPINV_PLUGIN_URL . 'assets/js/sortable.min.js', array(), WPINV_VERSION ); |
|
| 284 | - wp_enqueue_script( 'vue_draggable', WPINV_PLUGIN_URL . 'assets/js/vue/vuedraggable.min.js', array( 'sortable', 'vue' ), WPINV_VERSION ); |
|
| 283 | + wp_enqueue_script( 'sortable', WPINV_PLUGIN_URL . 'assets/js/sortable.min.js', array(), WPINV_VERSION ); |
|
| 284 | + wp_enqueue_script( 'vue_draggable', WPINV_PLUGIN_URL . 'assets/js/vue/vuedraggable.min.js', array( 'sortable', 'vue' ), WPINV_VERSION ); |
|
| 285 | 285 | |
| 286 | - $version = filemtime( WPINV_PLUGIN_DIR . 'assets/js/admin-payment-forms.js' ); |
|
| 287 | - wp_register_script( 'wpinv-admin-payment-form-script', WPINV_PLUGIN_URL . 'assets/js/admin-payment-forms.js', array( 'wpinv-admin-script', 'vue_draggable', 'wp-hooks' ), $version ); |
|
| 286 | + $version = filemtime( WPINV_PLUGIN_DIR . 'assets/js/admin-payment-forms.js' ); |
|
| 287 | + wp_register_script( 'wpinv-admin-payment-form-script', WPINV_PLUGIN_URL . 'assets/js/admin-payment-forms.js', array( 'wpinv-admin-script', 'vue_draggable', 'wp-hooks' ), $version ); |
|
| 288 | 288 | |
| 289 | - wp_localize_script( |
|
| 289 | + wp_localize_script( |
|
| 290 | 290 | 'wpinv-admin-payment-form-script', |
| 291 | 291 | 'wpinvPaymentFormAdmin', |
| 292 | 292 | array( |
| 293 | - 'elements' => wpinv_get_data( 'payment-form-elements' ), |
|
| 294 | - 'form_elements' => getpaid_get_payment_form_elements( $post->ID ), |
|
| 295 | - 'currency' => wpinv_currency_symbol(), |
|
| 296 | - 'position' => wpinv_currency_position(), |
|
| 297 | - 'decimals' => (int) wpinv_decimals(), |
|
| 298 | - 'thousands_sep' => wpinv_thousands_separator(), |
|
| 299 | - 'decimals_sep' => wpinv_decimal_separator(), |
|
| 300 | - 'form_items' => gepaid_get_form_items( $post->ID ), |
|
| 301 | - 'is_default' => $post->ID == wpinv_get_default_payment_form(), |
|
| 293 | + 'elements' => wpinv_get_data( 'payment-form-elements' ), |
|
| 294 | + 'form_elements' => getpaid_get_payment_form_elements( $post->ID ), |
|
| 295 | + 'currency' => wpinv_currency_symbol(), |
|
| 296 | + 'position' => wpinv_currency_position(), |
|
| 297 | + 'decimals' => (int) wpinv_decimals(), |
|
| 298 | + 'thousands_sep' => wpinv_thousands_separator(), |
|
| 299 | + 'decimals_sep' => wpinv_decimal_separator(), |
|
| 300 | + 'form_items' => gepaid_get_form_items( $post->ID ), |
|
| 301 | + 'is_default' => $post->ID == wpinv_get_default_payment_form(), |
|
| 302 | 302 | ) |
| 303 | 303 | ); |
| 304 | 304 | |
@@ -307,20 +307,20 @@ discard block |
||
| 307 | 307 | } |
| 308 | 308 | |
| 309 | 309 | /** |
| 310 | - * Add our classes to admin pages. |
|
| 310 | + * Add our classes to admin pages. |
|
| 311 | 311 | * |
| 312 | 312 | * @param string $classes |
| 313 | 313 | * @return string |
| 314 | - * |
|
| 315 | - */ |
|
| 314 | + * |
|
| 315 | + */ |
|
| 316 | 316 | public function admin_body_class( $classes ) { |
| 317 | - global $pagenow, $post, $current_screen; |
|
| 317 | + global $pagenow, $post, $current_screen; |
|
| 318 | 318 | |
| 319 | 319 | |
| 320 | 320 | $page = isset( $_GET['page'] ) ? $_GET['page'] : ''; |
| 321 | 321 | |
| 322 | 322 | if ( ! empty( $current_screen->post_type ) ) { |
| 323 | - $page = $current_screen->post_type; |
|
| 323 | + $page = $current_screen->post_type; |
|
| 324 | 324 | } |
| 325 | 325 | |
| 326 | 326 | if ( false !== stripos( $page, 'wpi' ) ) { |
@@ -329,68 +329,68 @@ discard block |
||
| 329 | 329 | |
| 330 | 330 | if ( in_array( $page, wpinv_parse_list( 'wpi_invoice wpi_payment_form wpi_quote' ) ) ) { |
| 331 | 331 | $classes .= ' wpinv-cpt wpinv'; |
| 332 | - } |
|
| 332 | + } |
|
| 333 | 333 | |
| 334 | - if ( getpaid_is_invoice_post_type( $page ) ) { |
|
| 334 | + if ( getpaid_is_invoice_post_type( $page ) ) { |
|
| 335 | 335 | $classes .= ' getpaid-is-invoice-cpt'; |
| 336 | 336 | } |
| 337 | 337 | |
| 338 | - return $classes; |
|
| 338 | + return $classes; |
|
| 339 | 339 | } |
| 340 | 340 | |
| 341 | 341 | /** |
| 342 | - * Maybe show the AyeCode Connect Notice. |
|
| 343 | - */ |
|
| 344 | - public function init_ayecode_connect_helper(){ |
|
| 342 | + * Maybe show the AyeCode Connect Notice. |
|
| 343 | + */ |
|
| 344 | + public function init_ayecode_connect_helper(){ |
|
| 345 | 345 | |
| 346 | - // Register with the deactivation survey class. |
|
| 347 | - AyeCode_Deactivation_Survey::instance(array( |
|
| 348 | - 'slug' => 'invoicing', |
|
| 349 | - 'version' => WPINV_VERSION, |
|
| 350 | - 'support_url' => 'https://wpgetpaid.com/support/', |
|
| 351 | - 'documentation_url' => 'https://docs.wpgetpaid.com/', |
|
| 352 | - 'activated' => (int) get_option( 'gepaid_installed_on' ), |
|
| 353 | - )); |
|
| 346 | + // Register with the deactivation survey class. |
|
| 347 | + AyeCode_Deactivation_Survey::instance(array( |
|
| 348 | + 'slug' => 'invoicing', |
|
| 349 | + 'version' => WPINV_VERSION, |
|
| 350 | + 'support_url' => 'https://wpgetpaid.com/support/', |
|
| 351 | + 'documentation_url' => 'https://docs.wpgetpaid.com/', |
|
| 352 | + 'activated' => (int) get_option( 'gepaid_installed_on' ), |
|
| 353 | + )); |
|
| 354 | 354 | |
| 355 | 355 | new AyeCode_Connect_Helper( |
| 356 | 356 | array( |
| 357 | - 'connect_title' => __("WP Invoicing - an AyeCode product!","invoicing"), |
|
| 358 | - 'connect_external' => __( "Please confirm you wish to connect your site?","invoicing" ), |
|
| 359 | - 'connect' => sprintf( __( "<strong>Have a license?</strong> Forget about entering license keys or downloading zip files, connect your site for instant access. %slearn more%s","invoicing" ),"<a href='https://ayecode.io/introducing-ayecode-connect/' target='_blank'>","</a>" ), |
|
| 360 | - 'connect_button' => __("Connect Site","invoicing"), |
|
| 361 | - 'connecting_button' => __("Connecting...","invoicing"), |
|
| 362 | - 'error_localhost' => __( "This service will only work with a live domain, not a localhost.","invoicing" ), |
|
| 363 | - 'error' => __( "Something went wrong, please refresh and try again.","invoicing" ), |
|
| 357 | + 'connect_title' => __("WP Invoicing - an AyeCode product!","invoicing"), |
|
| 358 | + 'connect_external' => __( "Please confirm you wish to connect your site?","invoicing" ), |
|
| 359 | + 'connect' => sprintf( __( "<strong>Have a license?</strong> Forget about entering license keys or downloading zip files, connect your site for instant access. %slearn more%s","invoicing" ),"<a href='https://ayecode.io/introducing-ayecode-connect/' target='_blank'>","</a>" ), |
|
| 360 | + 'connect_button' => __("Connect Site","invoicing"), |
|
| 361 | + 'connecting_button' => __("Connecting...","invoicing"), |
|
| 362 | + 'error_localhost' => __( "This service will only work with a live domain, not a localhost.","invoicing" ), |
|
| 363 | + 'error' => __( "Something went wrong, please refresh and try again.","invoicing" ), |
|
| 364 | 364 | ), |
| 365 | 365 | array( 'wpi-addons' ) |
| 366 | 366 | ); |
| 367 | 367 | |
| 368 | 368 | } |
| 369 | 369 | |
| 370 | - /** |
|
| 371 | - * Redirect users to settings on activation. |
|
| 372 | - * |
|
| 373 | - * @return void |
|
| 374 | - */ |
|
| 375 | - public function activation_redirect() { |
|
| 370 | + /** |
|
| 371 | + * Redirect users to settings on activation. |
|
| 372 | + * |
|
| 373 | + * @return void |
|
| 374 | + */ |
|
| 375 | + public function activation_redirect() { |
|
| 376 | 376 | |
| 377 | - $redirected = get_option( 'wpinv_redirected_to_settings' ); |
|
| 377 | + $redirected = get_option( 'wpinv_redirected_to_settings' ); |
|
| 378 | 378 | |
| 379 | - if ( ! empty( $redirected ) || wp_doing_ajax() || ! current_user_can( 'manage_options' ) ) { |
|
| 380 | - return; |
|
| 381 | - } |
|
| 379 | + if ( ! empty( $redirected ) || wp_doing_ajax() || ! current_user_can( 'manage_options' ) ) { |
|
| 380 | + return; |
|
| 381 | + } |
|
| 382 | 382 | |
| 383 | - // Bail if activating from network, or bulk |
|
| 384 | - if ( is_network_admin() || isset( $_GET['activate-multi'] ) ) { |
|
| 385 | - return; |
|
| 386 | - } |
|
| 383 | + // Bail if activating from network, or bulk |
|
| 384 | + if ( is_network_admin() || isset( $_GET['activate-multi'] ) ) { |
|
| 385 | + return; |
|
| 386 | + } |
|
| 387 | 387 | |
| 388 | - update_option( 'wpinv_redirected_to_settings', 1 ); |
|
| 388 | + update_option( 'wpinv_redirected_to_settings', 1 ); |
|
| 389 | 389 | |
| 390 | 390 | wp_safe_redirect( admin_url( 'index.php?page=gp-setup' ) ); |
| 391 | 391 | exit; |
| 392 | 392 | |
| 393 | - } |
|
| 393 | + } |
|
| 394 | 394 | |
| 395 | 395 | /** |
| 396 | 396 | * Fires an admin action after verifying that a user can fire them. |
@@ -404,532 +404,532 @@ discard block |
||
| 404 | 404 | |
| 405 | 405 | } |
| 406 | 406 | |
| 407 | - /** |
|
| 407 | + /** |
|
| 408 | 408 | * Duplicate invoice. |
| 409 | - * |
|
| 410 | - * @param array $args |
|
| 409 | + * |
|
| 410 | + * @param array $args |
|
| 411 | 411 | */ |
| 412 | 412 | public function duplicate_invoice( $args ) { |
| 413 | 413 | |
| 414 | - if ( empty( $args['invoice_id'] ) ) { |
|
| 415 | - return; |
|
| 416 | - } |
|
| 414 | + if ( empty( $args['invoice_id'] ) ) { |
|
| 415 | + return; |
|
| 416 | + } |
|
| 417 | 417 | |
| 418 | - $invoice = new WPInv_Invoice( (int) $args['invoice_id'] ); |
|
| 418 | + $invoice = new WPInv_Invoice( (int) $args['invoice_id'] ); |
|
| 419 | 419 | |
| 420 | - if ( ! $invoice->exists() ) { |
|
| 421 | - return; |
|
| 422 | - } |
|
| 420 | + if ( ! $invoice->exists() ) { |
|
| 421 | + return; |
|
| 422 | + } |
|
| 423 | 423 | |
| 424 | - $new_invoice = getpaid_duplicate_invoice( $invoice ); |
|
| 425 | - $new_invoice->save(); |
|
| 424 | + $new_invoice = getpaid_duplicate_invoice( $invoice ); |
|
| 425 | + $new_invoice->save(); |
|
| 426 | 426 | |
| 427 | - if ( $new_invoice->exists() ) { |
|
| 427 | + if ( $new_invoice->exists() ) { |
|
| 428 | 428 | |
| 429 | - getpaid_admin()->show_success( __( 'Invoice duplicated successfully.', 'newsletter-optin-box' ) ); |
|
| 429 | + getpaid_admin()->show_success( __( 'Invoice duplicated successfully.', 'newsletter-optin-box' ) ); |
|
| 430 | 430 | |
| 431 | - wp_safe_redirect( |
|
| 432 | - add_query_arg( |
|
| 433 | - array( |
|
| 434 | - 'action' => 'edit', |
|
| 435 | - 'post' => $new_invoice->get_id(), |
|
| 436 | - ), |
|
| 437 | - admin_url( 'post.php' ) |
|
| 438 | - ) |
|
| 439 | - ); |
|
| 440 | - exit; |
|
| 431 | + wp_safe_redirect( |
|
| 432 | + add_query_arg( |
|
| 433 | + array( |
|
| 434 | + 'action' => 'edit', |
|
| 435 | + 'post' => $new_invoice->get_id(), |
|
| 436 | + ), |
|
| 437 | + admin_url( 'post.php' ) |
|
| 438 | + ) |
|
| 439 | + ); |
|
| 440 | + exit; |
|
| 441 | 441 | |
| 442 | - } |
|
| 442 | + } |
|
| 443 | 443 | |
| 444 | - getpaid_admin()->show_error( __( 'There was an error duplicating this invoice. Please try again.', 'newsletter-optin-box' ) ); |
|
| 444 | + getpaid_admin()->show_error( __( 'There was an error duplicating this invoice. Please try again.', 'newsletter-optin-box' ) ); |
|
| 445 | 445 | |
| 446 | - } |
|
| 446 | + } |
|
| 447 | 447 | |
| 448 | - /** |
|
| 448 | + /** |
|
| 449 | 449 | * Sends a payment reminder to a customer. |
| 450 | - * |
|
| 451 | - * @param array $args |
|
| 450 | + * |
|
| 451 | + * @param array $args |
|
| 452 | 452 | */ |
| 453 | 453 | public function duplicate_payment_form( $args ) { |
| 454 | 454 | |
| 455 | - if ( empty( $args['form_id'] ) ) { |
|
| 456 | - return; |
|
| 457 | - } |
|
| 458 | - |
|
| 459 | - $form = new GetPaid_Payment_Form( (int) $args['form_id'] ); |
|
| 455 | + if ( empty( $args['form_id'] ) ) { |
|
| 456 | + return; |
|
| 457 | + } |
|
| 460 | 458 | |
| 461 | - if ( ! $form->exists() ) { |
|
| 462 | - return; |
|
| 463 | - } |
|
| 459 | + $form = new GetPaid_Payment_Form( (int) $args['form_id'] ); |
|
| 464 | 460 | |
| 465 | - $new_form = new GetPaid_Payment_Form(); |
|
| 466 | - $new_form->set_author( $form->get_author( 'edit' ) ); |
|
| 467 | - $new_form->set_name( $form->get_name( 'edit' ) . __( '(copy)', 'invoicing' ) ); |
|
| 468 | - $new_form->set_elements( $form->get_elements( 'edit' ) ); |
|
| 469 | - $new_form->set_items( $form->get_items( 'edit' ) ); |
|
| 470 | - $new_form->save(); |
|
| 461 | + if ( ! $form->exists() ) { |
|
| 462 | + return; |
|
| 463 | + } |
|
| 471 | 464 | |
| 472 | - if ( $new_form->exists() ) { |
|
| 473 | - $this->show_success( __( 'Form duplicated successfully', 'invoicing' ) ); |
|
| 474 | - $url = get_edit_post_link( $new_form->get_id(), 'edit' ); |
|
| 475 | - } else { |
|
| 476 | - $this->show_error( __( 'Unable to duplicate form', 'invoicing' ) ); |
|
| 477 | - $url = remove_query_arg( array( 'getpaid-admin-action', 'form_id', 'getpaid-nonce' ) ); |
|
| 478 | - } |
|
| 465 | + $new_form = new GetPaid_Payment_Form(); |
|
| 466 | + $new_form->set_author( $form->get_author( 'edit' ) ); |
|
| 467 | + $new_form->set_name( $form->get_name( 'edit' ) . __( '(copy)', 'invoicing' ) ); |
|
| 468 | + $new_form->set_elements( $form->get_elements( 'edit' ) ); |
|
| 469 | + $new_form->set_items( $form->get_items( 'edit' ) ); |
|
| 470 | + $new_form->save(); |
|
| 471 | + |
|
| 472 | + if ( $new_form->exists() ) { |
|
| 473 | + $this->show_success( __( 'Form duplicated successfully', 'invoicing' ) ); |
|
| 474 | + $url = get_edit_post_link( $new_form->get_id(), 'edit' ); |
|
| 475 | + } else { |
|
| 476 | + $this->show_error( __( 'Unable to duplicate form', 'invoicing' ) ); |
|
| 477 | + $url = remove_query_arg( array( 'getpaid-admin-action', 'form_id', 'getpaid-nonce' ) ); |
|
| 478 | + } |
|
| 479 | 479 | |
| 480 | - wp_redirect( $url ); |
|
| 481 | - exit; |
|
| 482 | - } |
|
| 480 | + wp_redirect( $url ); |
|
| 481 | + exit; |
|
| 482 | + } |
|
| 483 | 483 | |
| 484 | - /** |
|
| 484 | + /** |
|
| 485 | 485 | * Sends a payment reminder to a customer. |
| 486 | - * |
|
| 487 | - * @param array $args |
|
| 486 | + * |
|
| 487 | + * @param array $args |
|
| 488 | 488 | */ |
| 489 | 489 | public function send_customer_invoice( $args ) { |
| 490 | - getpaid()->get( 'invoice_emails' )->user_invoice( new WPInv_Invoice( $args['invoice_id'] ), true ); |
|
| 491 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce', 'invoice_id' ) ) ); |
|
| 492 | - exit; |
|
| 493 | - } |
|
| 490 | + getpaid()->get( 'invoice_emails' )->user_invoice( new WPInv_Invoice( $args['invoice_id'] ), true ); |
|
| 491 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce', 'invoice_id' ) ) ); |
|
| 492 | + exit; |
|
| 493 | + } |
|
| 494 | 494 | |
| 495 | - /** |
|
| 495 | + /** |
|
| 496 | 496 | * Sends a payment reminder to a customer. |
| 497 | - * |
|
| 498 | - * @param array $args |
|
| 497 | + * |
|
| 498 | + * @param array $args |
|
| 499 | 499 | */ |
| 500 | 500 | public function send_customer_payment_reminder( $args ) { |
| 501 | - $sent = getpaid()->get( 'invoice_emails' )->force_send_overdue_notice( new WPInv_Invoice( $args['invoice_id'] ) ); |
|
| 501 | + $sent = getpaid()->get( 'invoice_emails' )->force_send_overdue_notice( new WPInv_Invoice( $args['invoice_id'] ) ); |
|
| 502 | 502 | |
| 503 | - if ( $sent ) { |
|
| 504 | - $this->show_success( __( 'Payment reminder was successfully sent to the customer', 'invoicing' ) ); |
|
| 505 | - } else { |
|
| 506 | - $this->show_error( __( 'Could not sent payment reminder to the customer', 'invoicing' ) ); |
|
| 507 | - } |
|
| 503 | + if ( $sent ) { |
|
| 504 | + $this->show_success( __( 'Payment reminder was successfully sent to the customer', 'invoicing' ) ); |
|
| 505 | + } else { |
|
| 506 | + $this->show_error( __( 'Could not sent payment reminder to the customer', 'invoicing' ) ); |
|
| 507 | + } |
|
| 508 | 508 | |
| 509 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce', 'invoice_id' ) ) ); |
|
| 510 | - exit; |
|
| 511 | - } |
|
| 509 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce', 'invoice_id' ) ) ); |
|
| 510 | + exit; |
|
| 511 | + } |
|
| 512 | 512 | |
| 513 | - /** |
|
| 513 | + /** |
|
| 514 | 514 | * Resets tax rates. |
| 515 | - * |
|
| 515 | + * |
|
| 516 | 516 | */ |
| 517 | 517 | public function admin_reset_tax_rates() { |
| 518 | 518 | |
| 519 | - update_option( 'wpinv_tax_rates', wpinv_get_data( 'tax-rates' ) ); |
|
| 520 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 521 | - exit; |
|
| 519 | + update_option( 'wpinv_tax_rates', wpinv_get_data( 'tax-rates' ) ); |
|
| 520 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 521 | + exit; |
|
| 522 | 522 | |
| 523 | - } |
|
| 523 | + } |
|
| 524 | 524 | |
| 525 | - /** |
|
| 525 | + /** |
|
| 526 | 526 | * Resets admin pages. |
| 527 | - * |
|
| 527 | + * |
|
| 528 | 528 | */ |
| 529 | 529 | public function admin_create_missing_pages() { |
| 530 | - $installer = new GetPaid_Installer(); |
|
| 531 | - $installer->create_pages(); |
|
| 532 | - $this->show_success( __( 'GetPaid pages updated.', 'invoicing' ) ); |
|
| 533 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 534 | - exit; |
|
| 535 | - } |
|
| 536 | - |
|
| 537 | - /** |
|
| 530 | + $installer = new GetPaid_Installer(); |
|
| 531 | + $installer->create_pages(); |
|
| 532 | + $this->show_success( __( 'GetPaid pages updated.', 'invoicing' ) ); |
|
| 533 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 534 | + exit; |
|
| 535 | + } |
|
| 536 | + |
|
| 537 | + /** |
|
| 538 | 538 | * Creates an missing admin tables. |
| 539 | - * |
|
| 539 | + * |
|
| 540 | 540 | */ |
| 541 | 541 | public function admin_create_missing_tables() { |
| 542 | - global $wpdb; |
|
| 543 | - $installer = new GetPaid_Installer(); |
|
| 542 | + global $wpdb; |
|
| 543 | + $installer = new GetPaid_Installer(); |
|
| 544 | 544 | |
| 545 | - if ( $wpdb->get_var( "SHOW TABLES LIKE '{$wpdb->prefix}wpinv_subscriptions'" ) != $wpdb->prefix . 'wpinv_subscriptions' ) { |
|
| 546 | - $installer->create_subscriptions_table(); |
|
| 545 | + if ( $wpdb->get_var( "SHOW TABLES LIKE '{$wpdb->prefix}wpinv_subscriptions'" ) != $wpdb->prefix . 'wpinv_subscriptions' ) { |
|
| 546 | + $installer->create_subscriptions_table(); |
|
| 547 | 547 | |
| 548 | - if ( $wpdb->last_error !== '' ) { |
|
| 549 | - $this->show_error( __( 'Your GetPaid tables have been updated:', 'invoicing' ) . ' ' . $wpdb->last_error ); |
|
| 550 | - } |
|
| 551 | - } |
|
| 548 | + if ( $wpdb->last_error !== '' ) { |
|
| 549 | + $this->show_error( __( 'Your GetPaid tables have been updated:', 'invoicing' ) . ' ' . $wpdb->last_error ); |
|
| 550 | + } |
|
| 551 | + } |
|
| 552 | 552 | |
| 553 | - if ( $wpdb->get_var( "SHOW TABLES LIKE '{$wpdb->prefix}getpaid_invoices'" ) != $wpdb->prefix . 'getpaid_invoices' ) { |
|
| 554 | - $installer->create_invoices_table(); |
|
| 553 | + if ( $wpdb->get_var( "SHOW TABLES LIKE '{$wpdb->prefix}getpaid_invoices'" ) != $wpdb->prefix . 'getpaid_invoices' ) { |
|
| 554 | + $installer->create_invoices_table(); |
|
| 555 | 555 | |
| 556 | - if ( $wpdb->last_error !== '' ) { |
|
| 557 | - $this->show_error( __( 'Your GetPaid tables have been updated:', 'invoicing' ) . ' ' . $wpdb->last_error ); |
|
| 558 | - } |
|
| 559 | - } |
|
| 556 | + if ( $wpdb->last_error !== '' ) { |
|
| 557 | + $this->show_error( __( 'Your GetPaid tables have been updated:', 'invoicing' ) . ' ' . $wpdb->last_error ); |
|
| 558 | + } |
|
| 559 | + } |
|
| 560 | 560 | |
| 561 | - if ( $wpdb->get_var( "SHOW TABLES LIKE '{$wpdb->prefix}getpaid_invoice_items'" ) != $wpdb->prefix . 'getpaid_invoice_items' ) { |
|
| 562 | - $installer->create_invoice_items_table(); |
|
| 561 | + if ( $wpdb->get_var( "SHOW TABLES LIKE '{$wpdb->prefix}getpaid_invoice_items'" ) != $wpdb->prefix . 'getpaid_invoice_items' ) { |
|
| 562 | + $installer->create_invoice_items_table(); |
|
| 563 | 563 | |
| 564 | - if ( $wpdb->last_error !== '' ) { |
|
| 565 | - $this->show_error( __( 'Your GetPaid tables have been updated:', 'invoicing' ) . ' ' . $wpdb->last_error ); |
|
| 566 | - } |
|
| 567 | - } |
|
| 564 | + if ( $wpdb->last_error !== '' ) { |
|
| 565 | + $this->show_error( __( 'Your GetPaid tables have been updated:', 'invoicing' ) . ' ' . $wpdb->last_error ); |
|
| 566 | + } |
|
| 567 | + } |
|
| 568 | 568 | |
| 569 | - if ( ! $this->has_notices() ) { |
|
| 570 | - $this->show_success( __( 'Your GetPaid tables have been updated.', 'invoicing' ) ); |
|
| 571 | - } |
|
| 569 | + if ( ! $this->has_notices() ) { |
|
| 570 | + $this->show_success( __( 'Your GetPaid tables have been updated.', 'invoicing' ) ); |
|
| 571 | + } |
|
| 572 | 572 | |
| 573 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 574 | - exit; |
|
| 575 | - } |
|
| 573 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 574 | + exit; |
|
| 575 | + } |
|
| 576 | 576 | |
| 577 | - /** |
|
| 577 | + /** |
|
| 578 | 578 | * Migrates old invoices to the new database tables. |
| 579 | - * |
|
| 579 | + * |
|
| 580 | 580 | */ |
| 581 | 581 | public function admin_migrate_old_invoices() { |
| 582 | 582 | |
| 583 | - // Migrate the invoices. |
|
| 584 | - $installer = new GetPaid_Installer(); |
|
| 585 | - $installer->migrate_old_invoices(); |
|
| 583 | + // Migrate the invoices. |
|
| 584 | + $installer = new GetPaid_Installer(); |
|
| 585 | + $installer->migrate_old_invoices(); |
|
| 586 | 586 | |
| 587 | - // Show an admin message. |
|
| 588 | - $this->show_success( __( 'Your invoices have been migrated.', 'invoicing' ) ); |
|
| 587 | + // Show an admin message. |
|
| 588 | + $this->show_success( __( 'Your invoices have been migrated.', 'invoicing' ) ); |
|
| 589 | 589 | |
| 590 | - // Redirect the admin. |
|
| 591 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 592 | - exit; |
|
| 590 | + // Redirect the admin. |
|
| 591 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 592 | + exit; |
|
| 593 | 593 | |
| 594 | - } |
|
| 594 | + } |
|
| 595 | 595 | |
| 596 | - /** |
|
| 596 | + /** |
|
| 597 | 597 | * Download customers. |
| 598 | - * |
|
| 598 | + * |
|
| 599 | 599 | */ |
| 600 | 600 | public function admin_download_customers() { |
| 601 | - global $wpdb; |
|
| 601 | + global $wpdb; |
|
| 602 | 602 | |
| 603 | - $output = fopen( 'php://output', 'w' ) or die( __( 'Unsupported server', 'invoicing' ) ); |
|
| 603 | + $output = fopen( 'php://output', 'w' ) or die( __( 'Unsupported server', 'invoicing' ) ); |
|
| 604 | 604 | |
| 605 | - header( "Content-Type:text/csv" ); |
|
| 606 | - header( "Content-Disposition:attachment;filename=customers.csv" ); |
|
| 605 | + header( "Content-Type:text/csv" ); |
|
| 606 | + header( "Content-Disposition:attachment;filename=customers.csv" ); |
|
| 607 | 607 | |
| 608 | - $post_types = ''; |
|
| 608 | + $post_types = ''; |
|
| 609 | 609 | |
| 610 | - foreach ( array_keys( getpaid_get_invoice_post_types() ) as $post_type ) { |
|
| 611 | - $post_types .= $wpdb->prepare( "post_type=%s OR ", $post_type ); |
|
| 612 | - } |
|
| 610 | + foreach ( array_keys( getpaid_get_invoice_post_types() ) as $post_type ) { |
|
| 611 | + $post_types .= $wpdb->prepare( "post_type=%s OR ", $post_type ); |
|
| 612 | + } |
|
| 613 | 613 | |
| 614 | - $post_types = rtrim( $post_types, ' OR' ); |
|
| 614 | + $post_types = rtrim( $post_types, ' OR' ); |
|
| 615 | 615 | |
| 616 | - $customers = $wpdb->get_col( |
|
| 617 | - $wpdb->prepare( |
|
| 618 | - "SELECT DISTINCT( post_author ) FROM $wpdb->posts WHERE $post_types" |
|
| 619 | - ) |
|
| 620 | - ); |
|
| 616 | + $customers = $wpdb->get_col( |
|
| 617 | + $wpdb->prepare( |
|
| 618 | + "SELECT DISTINCT( post_author ) FROM $wpdb->posts WHERE $post_types" |
|
| 619 | + ) |
|
| 620 | + ); |
|
| 621 | 621 | |
| 622 | - $columns = array( |
|
| 623 | - 'name' => __( 'Name', 'invoicing' ), |
|
| 624 | - 'email' => __( 'Email', 'invoicing' ), |
|
| 625 | - 'country' => __( 'Country', 'invoicing' ), |
|
| 626 | - 'state' => __( 'State', 'invoicing' ), |
|
| 627 | - 'city' => __( 'City', 'invoicing' ), |
|
| 628 | - 'zip' => __( 'ZIP', 'invoicing' ), |
|
| 629 | - 'address' => __( 'Address', 'invoicing' ), |
|
| 630 | - 'phone' => __( 'Phone', 'invoicing' ), |
|
| 631 | - 'company' => __( 'Company', 'invoicing' ), |
|
| 632 | - 'company_id' => __( 'Company ID', 'invoicing' ), |
|
| 633 | - 'invoices' => __( 'Invoices', 'invoicing' ), |
|
| 634 | - 'total_raw' => __( 'Total Spend', 'invoicing' ), |
|
| 635 | - 'signup' => __( 'Date created', 'invoicing' ), |
|
| 636 | - ); |
|
| 622 | + $columns = array( |
|
| 623 | + 'name' => __( 'Name', 'invoicing' ), |
|
| 624 | + 'email' => __( 'Email', 'invoicing' ), |
|
| 625 | + 'country' => __( 'Country', 'invoicing' ), |
|
| 626 | + 'state' => __( 'State', 'invoicing' ), |
|
| 627 | + 'city' => __( 'City', 'invoicing' ), |
|
| 628 | + 'zip' => __( 'ZIP', 'invoicing' ), |
|
| 629 | + 'address' => __( 'Address', 'invoicing' ), |
|
| 630 | + 'phone' => __( 'Phone', 'invoicing' ), |
|
| 631 | + 'company' => __( 'Company', 'invoicing' ), |
|
| 632 | + 'company_id' => __( 'Company ID', 'invoicing' ), |
|
| 633 | + 'invoices' => __( 'Invoices', 'invoicing' ), |
|
| 634 | + 'total_raw' => __( 'Total Spend', 'invoicing' ), |
|
| 635 | + 'signup' => __( 'Date created', 'invoicing' ), |
|
| 636 | + ); |
|
| 637 | 637 | |
| 638 | - // Output the csv column headers. |
|
| 639 | - fputcsv( $output, array_values( $columns ) ); |
|
| 638 | + // Output the csv column headers. |
|
| 639 | + fputcsv( $output, array_values( $columns ) ); |
|
| 640 | 640 | |
| 641 | - // Loop through |
|
| 642 | - $table = new WPInv_Customers_Table(); |
|
| 643 | - foreach ( $customers as $customer_id ) { |
|
| 641 | + // Loop through |
|
| 642 | + $table = new WPInv_Customers_Table(); |
|
| 643 | + foreach ( $customers as $customer_id ) { |
|
| 644 | 644 | |
| 645 | - $user = get_user_by( 'id', $customer_id ); |
|
| 646 | - $row = array(); |
|
| 647 | - if ( empty( $user ) ) { |
|
| 648 | - continue; |
|
| 649 | - } |
|
| 645 | + $user = get_user_by( 'id', $customer_id ); |
|
| 646 | + $row = array(); |
|
| 647 | + if ( empty( $user ) ) { |
|
| 648 | + continue; |
|
| 649 | + } |
|
| 650 | 650 | |
| 651 | - foreach ( array_keys( $columns ) as $column ) { |
|
| 651 | + foreach ( array_keys( $columns ) as $column ) { |
|
| 652 | 652 | |
| 653 | - $method = 'column_' . $column; |
|
| 653 | + $method = 'column_' . $column; |
|
| 654 | 654 | |
| 655 | - if ( 'name' == $column ) { |
|
| 656 | - $value = esc_html( $user->display_name ); |
|
| 657 | - } else if( 'email' == $column ) { |
|
| 658 | - $value = sanitize_email( $user->user_email ); |
|
| 659 | - } else if ( is_callable( array( $table, $method ) ) ) { |
|
| 660 | - $value = strip_tags( $table->$method( $user ) ); |
|
| 661 | - } |
|
| 655 | + if ( 'name' == $column ) { |
|
| 656 | + $value = esc_html( $user->display_name ); |
|
| 657 | + } else if( 'email' == $column ) { |
|
| 658 | + $value = sanitize_email( $user->user_email ); |
|
| 659 | + } else if ( is_callable( array( $table, $method ) ) ) { |
|
| 660 | + $value = strip_tags( $table->$method( $user ) ); |
|
| 661 | + } |
|
| 662 | 662 | |
| 663 | - if ( empty( $value ) ) { |
|
| 664 | - $value = esc_html( get_user_meta( $user->ID, '_wpinv_' . $column, true ) ); |
|
| 665 | - } |
|
| 663 | + if ( empty( $value ) ) { |
|
| 664 | + $value = esc_html( get_user_meta( $user->ID, '_wpinv_' . $column, true ) ); |
|
| 665 | + } |
|
| 666 | 666 | |
| 667 | - $row[] = $value; |
|
| 667 | + $row[] = $value; |
|
| 668 | 668 | |
| 669 | - } |
|
| 669 | + } |
|
| 670 | 670 | |
| 671 | - fputcsv( $output, $row ); |
|
| 672 | - } |
|
| 671 | + fputcsv( $output, $row ); |
|
| 672 | + } |
|
| 673 | 673 | |
| 674 | - fclose( $output ); |
|
| 675 | - exit; |
|
| 674 | + fclose( $output ); |
|
| 675 | + exit; |
|
| 676 | 676 | |
| 677 | - } |
|
| 677 | + } |
|
| 678 | 678 | |
| 679 | - /** |
|
| 679 | + /** |
|
| 680 | 680 | * Installs a plugin. |
| 681 | - * |
|
| 682 | - * @param array $data |
|
| 681 | + * |
|
| 682 | + * @param array $data |
|
| 683 | 683 | */ |
| 684 | 684 | public function admin_install_plugin( $data ) { |
| 685 | 685 | |
| 686 | - if ( ! empty( $data['plugins'] ) ) { |
|
| 687 | - include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; |
|
| 688 | - wp_cache_flush(); |
|
| 686 | + if ( ! empty( $data['plugins'] ) ) { |
|
| 687 | + include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; |
|
| 688 | + wp_cache_flush(); |
|
| 689 | 689 | |
| 690 | - foreach ( $data['plugins'] as $slug => $file ) { |
|
| 691 | - $plugin_zip = esc_url( 'https://downloads.wordpress.org/plugin/' . $slug . '.latest-stable.zip' ); |
|
| 692 | - $upgrader = new Plugin_Upgrader( new Automatic_Upgrader_Skin() ); |
|
| 693 | - $installed = $upgrader->install( $plugin_zip ); |
|
| 690 | + foreach ( $data['plugins'] as $slug => $file ) { |
|
| 691 | + $plugin_zip = esc_url( 'https://downloads.wordpress.org/plugin/' . $slug . '.latest-stable.zip' ); |
|
| 692 | + $upgrader = new Plugin_Upgrader( new Automatic_Upgrader_Skin() ); |
|
| 693 | + $installed = $upgrader->install( $plugin_zip ); |
|
| 694 | 694 | |
| 695 | - if ( ! is_wp_error( $installed ) && $installed ) { |
|
| 696 | - activate_plugin( $file, '', false, true ); |
|
| 697 | - } else { |
|
| 698 | - wpinv_error_log( $upgrader->skin->get_upgrade_messages(), false ); |
|
| 699 | - } |
|
| 695 | + if ( ! is_wp_error( $installed ) && $installed ) { |
|
| 696 | + activate_plugin( $file, '', false, true ); |
|
| 697 | + } else { |
|
| 698 | + wpinv_error_log( $upgrader->skin->get_upgrade_messages(), false ); |
|
| 699 | + } |
|
| 700 | 700 | |
| 701 | - } |
|
| 701 | + } |
|
| 702 | 702 | |
| 703 | - } |
|
| 703 | + } |
|
| 704 | 704 | |
| 705 | - $redirect = isset( $data['redirect'] ) ? esc_url_raw( $data['redirect'] ) : admin_url( 'plugins.php' ); |
|
| 706 | - wp_safe_redirect( $redirect ); |
|
| 707 | - exit; |
|
| 705 | + $redirect = isset( $data['redirect'] ) ? esc_url_raw( $data['redirect'] ) : admin_url( 'plugins.php' ); |
|
| 706 | + wp_safe_redirect( $redirect ); |
|
| 707 | + exit; |
|
| 708 | 708 | |
| 709 | - } |
|
| 709 | + } |
|
| 710 | 710 | |
| 711 | - /** |
|
| 711 | + /** |
|
| 712 | 712 | * Connects a gateway. |
| 713 | - * |
|
| 714 | - * @param array $data |
|
| 713 | + * |
|
| 714 | + * @param array $data |
|
| 715 | 715 | */ |
| 716 | 716 | public function admin_connect_gateway( $data ) { |
| 717 | 717 | |
| 718 | - if ( ! empty( $data['plugin'] ) ) { |
|
| 718 | + if ( ! empty( $data['plugin'] ) ) { |
|
| 719 | 719 | |
| 720 | - $gateway = sanitize_key( $data['plugin'] ); |
|
| 721 | - $connect_url = apply_filters( "getpaid_get_{$gateway}_connect_url", false, $data ); |
|
| 720 | + $gateway = sanitize_key( $data['plugin'] ); |
|
| 721 | + $connect_url = apply_filters( "getpaid_get_{$gateway}_connect_url", false, $data ); |
|
| 722 | 722 | |
| 723 | - if ( ! empty( $connect_url ) ) { |
|
| 724 | - wp_redirect( $connect_url ); |
|
| 725 | - exit; |
|
| 726 | - } |
|
| 723 | + if ( ! empty( $connect_url ) ) { |
|
| 724 | + wp_redirect( $connect_url ); |
|
| 725 | + exit; |
|
| 726 | + } |
|
| 727 | 727 | |
| 728 | - if ( 'stripe' == $data['plugin'] ) { |
|
| 729 | - require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
| 730 | - include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; |
|
| 731 | - wp_cache_flush(); |
|
| 728 | + if ( 'stripe' == $data['plugin'] ) { |
|
| 729 | + require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
| 730 | + include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; |
|
| 731 | + wp_cache_flush(); |
|
| 732 | 732 | |
| 733 | - if ( ! array_key_exists( 'getpaid-stripe-payments/getpaid-stripe-payments.php', get_plugins() ) ) { |
|
| 734 | - $plugin_zip = esc_url( 'https://downloads.wordpress.org/plugin/getpaid-stripe-payments.latest-stable.zip' ); |
|
| 735 | - $upgrader = new Plugin_Upgrader( new Automatic_Upgrader_Skin() ); |
|
| 736 | - $upgrader->install( $plugin_zip ); |
|
| 737 | - } |
|
| 733 | + if ( ! array_key_exists( 'getpaid-stripe-payments/getpaid-stripe-payments.php', get_plugins() ) ) { |
|
| 734 | + $plugin_zip = esc_url( 'https://downloads.wordpress.org/plugin/getpaid-stripe-payments.latest-stable.zip' ); |
|
| 735 | + $upgrader = new Plugin_Upgrader( new Automatic_Upgrader_Skin() ); |
|
| 736 | + $upgrader->install( $plugin_zip ); |
|
| 737 | + } |
|
| 738 | 738 | |
| 739 | - activate_plugin( 'getpaid-stripe-payments/getpaid-stripe-payments.php', '', false, true ); |
|
| 740 | - } |
|
| 739 | + activate_plugin( 'getpaid-stripe-payments/getpaid-stripe-payments.php', '', false, true ); |
|
| 740 | + } |
|
| 741 | 741 | |
| 742 | - $connect_url = apply_filters( "getpaid_get_{$gateway}_connect_url", false, $data ); |
|
| 743 | - if ( ! empty( $connect_url ) ) { |
|
| 744 | - wp_redirect( $connect_url ); |
|
| 745 | - exit; |
|
| 746 | - } |
|
| 742 | + $connect_url = apply_filters( "getpaid_get_{$gateway}_connect_url", false, $data ); |
|
| 743 | + if ( ! empty( $connect_url ) ) { |
|
| 744 | + wp_redirect( $connect_url ); |
|
| 745 | + exit; |
|
| 746 | + } |
|
| 747 | 747 | |
| 748 | - } |
|
| 748 | + } |
|
| 749 | 749 | |
| 750 | - $redirect = isset( $data['redirect'] ) ? esc_url_raw( urldecode( $data['redirect'] ) ) : admin_url( 'admin.php?page=wpinv-settings&tab=gateways' ); |
|
| 751 | - wp_safe_redirect( $redirect ); |
|
| 752 | - exit; |
|
| 750 | + $redirect = isset( $data['redirect'] ) ? esc_url_raw( urldecode( $data['redirect'] ) ) : admin_url( 'admin.php?page=wpinv-settings&tab=gateways' ); |
|
| 751 | + wp_safe_redirect( $redirect ); |
|
| 752 | + exit; |
|
| 753 | 753 | |
| 754 | - } |
|
| 754 | + } |
|
| 755 | 755 | |
| 756 | - /** |
|
| 756 | + /** |
|
| 757 | 757 | * Recalculates discounts. |
| 758 | - * |
|
| 758 | + * |
|
| 759 | 759 | */ |
| 760 | 760 | public function admin_recalculate_discounts() { |
| 761 | - global $wpdb; |
|
| 761 | + global $wpdb; |
|
| 762 | 762 | |
| 763 | - // Fetch all invoices that have discount codes. |
|
| 764 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 765 | - $invoices = $wpdb->get_col( "SELECT `post_id` FROM `$table` WHERE `discount` = 0 && `discount_code` <> ''" ); |
|
| 763 | + // Fetch all invoices that have discount codes. |
|
| 764 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 765 | + $invoices = $wpdb->get_col( "SELECT `post_id` FROM `$table` WHERE `discount` = 0 && `discount_code` <> ''" ); |
|
| 766 | 766 | |
| 767 | - foreach ( $invoices as $invoice ) { |
|
| 767 | + foreach ( $invoices as $invoice ) { |
|
| 768 | 768 | |
| 769 | - $invoice = new WPInv_Invoice( $invoice ); |
|
| 769 | + $invoice = new WPInv_Invoice( $invoice ); |
|
| 770 | 770 | |
| 771 | - if ( ! $invoice->exists() ) { |
|
| 772 | - continue; |
|
| 773 | - } |
|
| 771 | + if ( ! $invoice->exists() ) { |
|
| 772 | + continue; |
|
| 773 | + } |
|
| 774 | 774 | |
| 775 | - // Abort if the discount does not exist or does not apply here. |
|
| 776 | - $discount = new WPInv_Discount( $invoice->get_discount_code() ); |
|
| 777 | - if ( ! $discount->exists() ) { |
|
| 778 | - continue; |
|
| 779 | - } |
|
| 775 | + // Abort if the discount does not exist or does not apply here. |
|
| 776 | + $discount = new WPInv_Discount( $invoice->get_discount_code() ); |
|
| 777 | + if ( ! $discount->exists() ) { |
|
| 778 | + continue; |
|
| 779 | + } |
|
| 780 | 780 | |
| 781 | - $invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) ); |
|
| 782 | - $invoice->recalculate_total(); |
|
| 781 | + $invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) ); |
|
| 782 | + $invoice->recalculate_total(); |
|
| 783 | 783 | |
| 784 | - if ( $invoice->get_total_discount() > 0 ) { |
|
| 785 | - $invoice->save(); |
|
| 786 | - } |
|
| 784 | + if ( $invoice->get_total_discount() > 0 ) { |
|
| 785 | + $invoice->save(); |
|
| 786 | + } |
|
| 787 | 787 | |
| 788 | - } |
|
| 788 | + } |
|
| 789 | 789 | |
| 790 | - // Show an admin message. |
|
| 791 | - $this->show_success( __( 'Discounts have been recalculated.', 'invoicing' ) ); |
|
| 790 | + // Show an admin message. |
|
| 791 | + $this->show_success( __( 'Discounts have been recalculated.', 'invoicing' ) ); |
|
| 792 | 792 | |
| 793 | - // Redirect the admin. |
|
| 794 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 795 | - exit; |
|
| 793 | + // Redirect the admin. |
|
| 794 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 795 | + exit; |
|
| 796 | 796 | |
| 797 | - } |
|
| 797 | + } |
|
| 798 | 798 | |
| 799 | 799 | /** |
| 800 | - * Returns an array of admin notices. |
|
| 801 | - * |
|
| 802 | - * @since 1.0.19 |
|
| 800 | + * Returns an array of admin notices. |
|
| 801 | + * |
|
| 802 | + * @since 1.0.19 |
|
| 803 | 803 | * @return array |
| 804 | - */ |
|
| 805 | - public function get_notices() { |
|
| 806 | - $notices = get_option( 'wpinv_admin_notices' ); |
|
| 804 | + */ |
|
| 805 | + public function get_notices() { |
|
| 806 | + $notices = get_option( 'wpinv_admin_notices' ); |
|
| 807 | 807 | return is_array( $notices ) ? $notices : array(); |
| 808 | - } |
|
| 808 | + } |
|
| 809 | 809 | |
| 810 | - /** |
|
| 811 | - * Checks if we have any admin notices. |
|
| 812 | - * |
|
| 813 | - * @since 2.0.4 |
|
| 810 | + /** |
|
| 811 | + * Checks if we have any admin notices. |
|
| 812 | + * |
|
| 813 | + * @since 2.0.4 |
|
| 814 | 814 | * @return array |
| 815 | - */ |
|
| 816 | - public function has_notices() { |
|
| 817 | - return count( $this->get_notices() ) > 0; |
|
| 818 | - } |
|
| 819 | - |
|
| 820 | - /** |
|
| 821 | - * Clears all admin notices |
|
| 822 | - * |
|
| 823 | - * @access public |
|
| 824 | - * @since 1.0.19 |
|
| 825 | - */ |
|
| 826 | - public function clear_notices() { |
|
| 827 | - delete_option( 'wpinv_admin_notices' ); |
|
| 828 | - } |
|
| 829 | - |
|
| 830 | - /** |
|
| 831 | - * Saves a new admin notice |
|
| 832 | - * |
|
| 833 | - * @access public |
|
| 834 | - * @since 1.0.19 |
|
| 835 | - */ |
|
| 836 | - public function save_notice( $type, $message ) { |
|
| 837 | - $notices = $this->get_notices(); |
|
| 838 | - |
|
| 839 | - if ( empty( $notices[ $type ] ) || ! is_array( $notices[ $type ]) ) { |
|
| 840 | - $notices[ $type ] = array(); |
|
| 841 | - } |
|
| 842 | - |
|
| 843 | - $notices[ $type ][] = $message; |
|
| 844 | - |
|
| 845 | - update_option( 'wpinv_admin_notices', $notices ); |
|
| 846 | - } |
|
| 847 | - |
|
| 848 | - /** |
|
| 849 | - * Displays a success notice |
|
| 850 | - * |
|
| 851 | - * @param string $msg The message to qeue. |
|
| 852 | - * @access public |
|
| 853 | - * @since 1.0.19 |
|
| 854 | - */ |
|
| 855 | - public function show_success( $msg ) { |
|
| 856 | - $this->save_notice( 'success', $msg ); |
|
| 857 | - } |
|
| 858 | - |
|
| 859 | - /** |
|
| 860 | - * Displays a error notice |
|
| 861 | - * |
|
| 862 | - * @access public |
|
| 863 | - * @param string $msg The message to qeue. |
|
| 864 | - * @since 1.0.19 |
|
| 865 | - */ |
|
| 866 | - public function show_error( $msg ) { |
|
| 867 | - $this->save_notice( 'error', $msg ); |
|
| 868 | - } |
|
| 869 | - |
|
| 870 | - /** |
|
| 871 | - * Displays a warning notice |
|
| 872 | - * |
|
| 873 | - * @access public |
|
| 874 | - * @param string $msg The message to qeue. |
|
| 875 | - * @since 1.0.19 |
|
| 876 | - */ |
|
| 877 | - public function show_warning( $msg ) { |
|
| 878 | - $this->save_notice( 'warning', $msg ); |
|
| 879 | - } |
|
| 880 | - |
|
| 881 | - /** |
|
| 882 | - * Displays a info notice |
|
| 883 | - * |
|
| 884 | - * @access public |
|
| 885 | - * @param string $msg The message to qeue. |
|
| 886 | - * @since 1.0.19 |
|
| 887 | - */ |
|
| 888 | - public function show_info( $msg ) { |
|
| 889 | - $this->save_notice( 'info', $msg ); |
|
| 890 | - } |
|
| 891 | - |
|
| 892 | - /** |
|
| 893 | - * Show notices |
|
| 894 | - * |
|
| 895 | - * @access public |
|
| 896 | - * @since 1.0.19 |
|
| 897 | - */ |
|
| 898 | - public function show_notices() { |
|
| 815 | + */ |
|
| 816 | + public function has_notices() { |
|
| 817 | + return count( $this->get_notices() ) > 0; |
|
| 818 | + } |
|
| 819 | + |
|
| 820 | + /** |
|
| 821 | + * Clears all admin notices |
|
| 822 | + * |
|
| 823 | + * @access public |
|
| 824 | + * @since 1.0.19 |
|
| 825 | + */ |
|
| 826 | + public function clear_notices() { |
|
| 827 | + delete_option( 'wpinv_admin_notices' ); |
|
| 828 | + } |
|
| 829 | + |
|
| 830 | + /** |
|
| 831 | + * Saves a new admin notice |
|
| 832 | + * |
|
| 833 | + * @access public |
|
| 834 | + * @since 1.0.19 |
|
| 835 | + */ |
|
| 836 | + public function save_notice( $type, $message ) { |
|
| 837 | + $notices = $this->get_notices(); |
|
| 838 | + |
|
| 839 | + if ( empty( $notices[ $type ] ) || ! is_array( $notices[ $type ]) ) { |
|
| 840 | + $notices[ $type ] = array(); |
|
| 841 | + } |
|
| 842 | + |
|
| 843 | + $notices[ $type ][] = $message; |
|
| 844 | + |
|
| 845 | + update_option( 'wpinv_admin_notices', $notices ); |
|
| 846 | + } |
|
| 847 | + |
|
| 848 | + /** |
|
| 849 | + * Displays a success notice |
|
| 850 | + * |
|
| 851 | + * @param string $msg The message to qeue. |
|
| 852 | + * @access public |
|
| 853 | + * @since 1.0.19 |
|
| 854 | + */ |
|
| 855 | + public function show_success( $msg ) { |
|
| 856 | + $this->save_notice( 'success', $msg ); |
|
| 857 | + } |
|
| 858 | + |
|
| 859 | + /** |
|
| 860 | + * Displays a error notice |
|
| 861 | + * |
|
| 862 | + * @access public |
|
| 863 | + * @param string $msg The message to qeue. |
|
| 864 | + * @since 1.0.19 |
|
| 865 | + */ |
|
| 866 | + public function show_error( $msg ) { |
|
| 867 | + $this->save_notice( 'error', $msg ); |
|
| 868 | + } |
|
| 869 | + |
|
| 870 | + /** |
|
| 871 | + * Displays a warning notice |
|
| 872 | + * |
|
| 873 | + * @access public |
|
| 874 | + * @param string $msg The message to qeue. |
|
| 875 | + * @since 1.0.19 |
|
| 876 | + */ |
|
| 877 | + public function show_warning( $msg ) { |
|
| 878 | + $this->save_notice( 'warning', $msg ); |
|
| 879 | + } |
|
| 880 | + |
|
| 881 | + /** |
|
| 882 | + * Displays a info notice |
|
| 883 | + * |
|
| 884 | + * @access public |
|
| 885 | + * @param string $msg The message to qeue. |
|
| 886 | + * @since 1.0.19 |
|
| 887 | + */ |
|
| 888 | + public function show_info( $msg ) { |
|
| 889 | + $this->save_notice( 'info', $msg ); |
|
| 890 | + } |
|
| 891 | + |
|
| 892 | + /** |
|
| 893 | + * Show notices |
|
| 894 | + * |
|
| 895 | + * @access public |
|
| 896 | + * @since 1.0.19 |
|
| 897 | + */ |
|
| 898 | + public function show_notices() { |
|
| 899 | 899 | |
| 900 | 900 | $notices = $this->get_notices(); |
| 901 | 901 | $this->clear_notices(); |
| 902 | 902 | |
| 903 | - foreach ( $notices as $type => $messages ) { |
|
| 903 | + foreach ( $notices as $type => $messages ) { |
|
| 904 | 904 | |
| 905 | - if ( ! is_array( $messages ) ) { |
|
| 906 | - continue; |
|
| 907 | - } |
|
| 905 | + if ( ! is_array( $messages ) ) { |
|
| 906 | + continue; |
|
| 907 | + } |
|
| 908 | 908 | |
| 909 | 909 | $type = sanitize_key( $type ); |
| 910 | - foreach ( $messages as $message ) { |
|
| 910 | + foreach ( $messages as $message ) { |
|
| 911 | 911 | $message = wp_kses_post( $message ); |
| 912 | - echo "<div class='notice notice-$type is-dismissible'><p>$message</p></div>"; |
|
| 912 | + echo "<div class='notice notice-$type is-dismissible'><p>$message</p></div>"; |
|
| 913 | 913 | } |
| 914 | 914 | |
| 915 | 915 | } |
| 916 | 916 | |
| 917 | - foreach ( array( 'checkout_page', 'invoice_history_page', 'success_page', 'failure_page', 'invoice_subscription_page' ) as $page ) { |
|
| 918 | - |
|
| 919 | - if ( ! is_numeric( wpinv_get_option( $page, false ) ) ) { |
|
| 920 | - $url = wp_nonce_url( |
|
| 921 | - add_query_arg( 'getpaid-admin-action', 'create_missing_pages' ), |
|
| 922 | - 'getpaid-nonce', |
|
| 923 | - 'getpaid-nonce' |
|
| 924 | - ); |
|
| 925 | - $message = __( 'Some GetPaid pages are missing. To use GetPaid without any issues, click the button below to generate the missing pages.', 'invoicing' ); |
|
| 926 | - $message2 = __( 'Generate Pages', 'invoicing' ); |
|
| 927 | - echo "<div class='notice notice-warning is-dismissible'><p>$message<br><br><a href='$url' class='button button-primary'>$message2</a></p></div>"; |
|
| 928 | - break; |
|
| 929 | - } |
|
| 917 | + foreach ( array( 'checkout_page', 'invoice_history_page', 'success_page', 'failure_page', 'invoice_subscription_page' ) as $page ) { |
|
| 918 | + |
|
| 919 | + if ( ! is_numeric( wpinv_get_option( $page, false ) ) ) { |
|
| 920 | + $url = wp_nonce_url( |
|
| 921 | + add_query_arg( 'getpaid-admin-action', 'create_missing_pages' ), |
|
| 922 | + 'getpaid-nonce', |
|
| 923 | + 'getpaid-nonce' |
|
| 924 | + ); |
|
| 925 | + $message = __( 'Some GetPaid pages are missing. To use GetPaid without any issues, click the button below to generate the missing pages.', 'invoicing' ); |
|
| 926 | + $message2 = __( 'Generate Pages', 'invoicing' ); |
|
| 927 | + echo "<div class='notice notice-warning is-dismissible'><p>$message<br><br><a href='$url' class='button button-primary'>$message2</a></p></div>"; |
|
| 928 | + break; |
|
| 929 | + } |
|
| 930 | 930 | |
| 931 | - } |
|
| 931 | + } |
|
| 932 | 932 | |
| 933 | - } |
|
| 933 | + } |
|
| 934 | 934 | |
| 935 | 935 | } |
@@ -18,691 +18,691 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Report_Sales_Controller extends GetPaid_REST_Date_Based_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Route base. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $rest_base = 'reports/sales'; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * The report data. |
|
| 30 | - * |
|
| 31 | - * @var stdClass |
|
| 32 | - */ |
|
| 33 | - public $report_data; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * The report range. |
|
| 37 | - * |
|
| 38 | - * @var array |
|
| 39 | - */ |
|
| 40 | - public $report_range; |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * Registers the routes for the objects of the controller. |
|
| 44 | - * |
|
| 45 | - * @since 2.0.0 |
|
| 46 | - * |
|
| 47 | - * @see register_rest_route() |
|
| 48 | - */ |
|
| 49 | - public function register_namespace_routes( $namespace ) { |
|
| 50 | - |
|
| 51 | - // Get sales report. |
|
| 52 | - register_rest_route( |
|
| 53 | - $namespace, |
|
| 54 | - $this->rest_base, |
|
| 55 | - array( |
|
| 56 | - array( |
|
| 57 | - 'methods' => WP_REST_Server::READABLE, |
|
| 58 | - 'callback' => array( $this, 'get_items' ), |
|
| 59 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 60 | - 'args' => $this->get_collection_params(), |
|
| 61 | - ), |
|
| 62 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 63 | - ) |
|
| 64 | - ); |
|
| 65 | - |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * Makes sure the current user has access to READ the report APIs. |
|
| 70 | - * |
|
| 71 | - * @since 2.0.0 |
|
| 72 | - * @param WP_REST_Request $request Full data about the request. |
|
| 73 | - * @return WP_Error|boolean |
|
| 74 | - */ |
|
| 75 | - public function get_items_permissions_check( $request ) { |
|
| 76 | - |
|
| 77 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 78 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - return true; |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * Get sales reports. |
|
| 86 | - * |
|
| 87 | - * @param WP_REST_Request $request |
|
| 88 | - * @return array|WP_Error |
|
| 89 | - */ |
|
| 90 | - public function get_items( $request ) { |
|
| 91 | - $data = array(); |
|
| 92 | - $item = $this->prepare_item_for_response( null, $request ); |
|
| 93 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
| 94 | - |
|
| 95 | - return rest_ensure_response( $data ); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * Prepare a report sales object for serialization. |
|
| 100 | - * |
|
| 101 | - * @param null $_ |
|
| 102 | - * @param WP_REST_Request $request Request object. |
|
| 103 | - * @return WP_REST_Response $response Response data. |
|
| 104 | - */ |
|
| 105 | - public function prepare_item_for_response( $_, $request ) { |
|
| 106 | - |
|
| 107 | - // Set report range. |
|
| 108 | - $this->report_range = $this->get_date_range( $request ); |
|
| 109 | - |
|
| 110 | - $report_data = $this->get_report_data(); |
|
| 111 | - $period_totals = array(); |
|
| 112 | - |
|
| 113 | - // Setup period totals by ensuring each period in the interval has data. |
|
| 114 | - $start_date = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS; |
|
| 115 | - |
|
| 116 | - if ( 'month' === $this->groupby ) { |
|
| 117 | - $start_date = strtotime( date( 'Y-m-01', $start_date ) ); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - for ( $i = 0; $i < $this->interval; $i++ ) { |
|
| 121 | - |
|
| 122 | - switch ( $this->groupby ) { |
|
| 123 | - case 'day' : |
|
| 124 | - $time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
| 125 | - break; |
|
| 126 | - default : |
|
| 127 | - $time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
| 128 | - break; |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - // Set the defaults for each period. |
|
| 132 | - $period_totals[ $time ] = array( |
|
| 133 | - 'invoices' => 0, |
|
| 134 | - 'items' => 0, |
|
| 135 | - 'refunded_items' => 0, |
|
| 136 | - 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
| 137 | - 'subtotal' => wpinv_round_amount( 0.00 ), |
|
| 138 | - 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
| 139 | - 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
| 140 | - 'discount' => wpinv_round_amount( 0.00 ), |
|
| 141 | - ); |
|
| 142 | - |
|
| 143 | - foreach( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
| 144 | - if ( ! isset( $period_totals[ $time ][ $key ] ) ) { |
|
| 145 | - $period_totals[ $time ][ $key ] = wpinv_round_amount( 0.00 ); |
|
| 146 | - } |
|
| 147 | - } |
|
| 148 | - |
|
| 149 | - } |
|
| 150 | - |
|
| 151 | - // add total sales, total invoice count, total tax for each period |
|
| 152 | - $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
| 153 | - foreach ( $report_data->invoices as $invoice ) { |
|
| 154 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 155 | - |
|
| 156 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 157 | - continue; |
|
| 158 | - } |
|
| 159 | - |
|
| 160 | - $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 161 | - $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 162 | - $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 163 | - $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 164 | - |
|
| 165 | - } |
|
| 166 | - |
|
| 167 | - foreach ( $report_data->refunds as $invoice ) { |
|
| 168 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 169 | - |
|
| 170 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 171 | - continue; |
|
| 172 | - } |
|
| 173 | - |
|
| 174 | - $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 175 | - $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 176 | - $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 177 | - $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 178 | - |
|
| 179 | - } |
|
| 180 | - |
|
| 181 | - foreach ( $report_data->invoice_counts as $invoice ) { |
|
| 182 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 183 | - |
|
| 184 | - if ( isset( $period_totals[ $time ] ) ) { |
|
| 185 | - $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - } |
|
| 189 | - |
|
| 190 | - // Add total invoice items for each period. |
|
| 191 | - foreach ( $report_data->invoice_items as $invoice_item ) { |
|
| 192 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
| 193 | - |
|
| 194 | - if ( isset( $period_totals[ $time ] ) ) { |
|
| 195 | - $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
| 196 | - } |
|
| 197 | - |
|
| 198 | - } |
|
| 199 | - |
|
| 200 | - // Add total discount for each period. |
|
| 201 | - foreach ( $report_data->coupons as $discount ) { |
|
| 202 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) ); |
|
| 203 | - |
|
| 204 | - if ( isset( $period_totals[ $time ] ) ) { |
|
| 205 | - $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - } |
|
| 209 | - |
|
| 210 | - // Extra fields. |
|
| 211 | - foreach( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
| 212 | - |
|
| 213 | - // Abort unprepared. |
|
| 214 | - if ( ! isset( $report_data->$key ) ) { |
|
| 215 | - continue; |
|
| 216 | - } |
|
| 217 | - |
|
| 218 | - // Abort defaults. |
|
| 219 | - if ( in_array( $key, array( 'sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items' ) ) ) { |
|
| 220 | - continue; |
|
| 221 | - } |
|
| 222 | - |
|
| 223 | - // Set values. |
|
| 224 | - foreach ( $report_data->$key as $item ) { |
|
| 225 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $item->date ) ) : date( 'Y-m', strtotime( $item->date ) ); |
|
| 226 | - |
|
| 227 | - if ( isset( $period_totals[ $time ] ) ) { |
|
| 228 | - $period_totals[ $time ][ $key ] = wpinv_round_amount( $item->val ); |
|
| 229 | - } |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - unset( $report_data->$key ); |
|
| 233 | - } |
|
| 234 | - |
|
| 235 | - $report_data->totals = $period_totals; |
|
| 236 | - $report_data->grouped_by = $this->groupby; |
|
| 237 | - $report_data->interval = max( $this->interval, 1 ); |
|
| 238 | - $report_data->currency = wpinv_get_currency(); |
|
| 239 | - $report_data->currency_symbol = wpinv_currency_symbol(); |
|
| 240 | - $report_data->currency_position = wpinv_currency_position(); |
|
| 241 | - $report_data->decimal_places = wpinv_decimals(); |
|
| 242 | - $report_data->thousands_sep = wpinv_thousands_separator(); |
|
| 243 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 244 | - $report_data->start_date = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ); |
|
| 245 | - $report_data->end_date = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ); |
|
| 246 | - $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) ); |
|
| 247 | - $report_data->end_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) ); |
|
| 248 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 249 | - |
|
| 250 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 251 | - $data = $report_data; |
|
| 252 | - unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
| 253 | - $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
| 254 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 255 | - |
|
| 256 | - // Wrap the data in a response object. |
|
| 257 | - $response = rest_ensure_response( $data ); |
|
| 258 | - $response->add_links( array( |
|
| 259 | - 'about' => array( |
|
| 260 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 261 | - ), |
|
| 262 | - ) ); |
|
| 263 | - |
|
| 264 | - return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
| 265 | - } |
|
| 266 | - |
|
| 267 | - /** |
|
| 268 | - * Get report data. |
|
| 269 | - * |
|
| 270 | - * @return stdClass |
|
| 271 | - */ |
|
| 272 | - public function get_report_data() { |
|
| 273 | - if ( empty( $this->report_data ) ) { |
|
| 274 | - $this->query_report_data(); |
|
| 275 | - } |
|
| 276 | - return $this->report_data; |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - /** |
|
| 280 | - * Get all data needed for this report and store in the class. |
|
| 281 | - */ |
|
| 282 | - protected function query_report_data() { |
|
| 283 | - |
|
| 284 | - // Prepare reports. |
|
| 285 | - $this->report_data = (object) array( |
|
| 286 | - 'invoice_counts' => $this->query_invoice_counts(),//count, post_date |
|
| 287 | - 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
| 288 | - 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
| 289 | - 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
| 290 | - 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 291 | - 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 292 | - 'previous_range' => $this->previous_range, |
|
| 293 | - ); |
|
| 294 | - |
|
| 295 | - // Calculated totals. |
|
| 296 | - $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
| 297 | - $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
| 298 | - $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
| 299 | - $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
| 300 | - $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
| 301 | - $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
| 302 | - $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
| 303 | - $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
| 304 | - $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
| 305 | - $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
| 306 | - $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
| 307 | - $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
| 308 | - |
|
| 309 | - |
|
| 310 | - // Calculate average based on net. |
|
| 311 | - $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
| 312 | - $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
| 313 | - |
|
| 314 | - // Total invoices in this period, even if refunded. |
|
| 315 | - $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
| 316 | - |
|
| 317 | - // Items invoiced in this period, even if refunded. |
|
| 318 | - $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
| 319 | - |
|
| 320 | - // 3rd party filtering of report data |
|
| 321 | - $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data, $this ); |
|
| 322 | - } |
|
| 323 | - |
|
| 324 | - /** |
|
| 325 | - * Prepares invoice counts. |
|
| 326 | - * |
|
| 327 | - * @return array. |
|
| 328 | - */ |
|
| 329 | - protected function query_invoice_counts() { |
|
| 330 | - |
|
| 331 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 332 | - array( |
|
| 333 | - 'data' => array( |
|
| 334 | - 'ID' => array( |
|
| 335 | - 'type' => 'post_data', |
|
| 336 | - 'function' => 'COUNT', |
|
| 337 | - 'name' => 'count', |
|
| 338 | - 'distinct' => true, |
|
| 339 | - ), |
|
| 340 | - 'post_date' => array( |
|
| 341 | - 'type' => 'post_data', |
|
| 342 | - 'function' => '', |
|
| 343 | - 'name' => 'post_date', |
|
| 344 | - ), |
|
| 345 | - ), |
|
| 346 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 347 | - 'order_by' => 'post_date ASC', |
|
| 348 | - 'query_type' => 'get_results', |
|
| 349 | - 'filter_range' => $this->report_range, |
|
| 350 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 351 | - ) |
|
| 352 | - ); |
|
| 353 | - |
|
| 354 | - } |
|
| 355 | - |
|
| 356 | - /** |
|
| 357 | - * Prepares coupon counts. |
|
| 358 | - * |
|
| 359 | - * @return array. |
|
| 360 | - */ |
|
| 361 | - protected function query_coupon_counts() { |
|
| 362 | - |
|
| 363 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 364 | - array( |
|
| 365 | - 'data' => array( |
|
| 366 | - 'discount' => array( |
|
| 367 | - 'type' => 'invoice_data', |
|
| 368 | - 'function' => 'SUM', |
|
| 369 | - 'name' => 'discount_amount', |
|
| 370 | - ), |
|
| 371 | - 'post_date' => array( |
|
| 372 | - 'type' => 'post_data', |
|
| 373 | - 'function' => '', |
|
| 374 | - 'name' => 'post_date', |
|
| 375 | - ), |
|
| 376 | - ), |
|
| 377 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 378 | - 'order_by' => 'post_date ASC', |
|
| 379 | - 'query_type' => 'get_results', |
|
| 380 | - 'filter_range' => $this->report_range, |
|
| 381 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 382 | - ) |
|
| 383 | - ); |
|
| 384 | - |
|
| 385 | - } |
|
| 386 | - |
|
| 387 | - /** |
|
| 388 | - * Prepares item counts. |
|
| 389 | - * |
|
| 390 | - * @return array. |
|
| 391 | - */ |
|
| 392 | - protected function query_item_counts() { |
|
| 393 | - |
|
| 394 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 395 | - array( |
|
| 396 | - 'data' => array( |
|
| 397 | - 'quantity' => array( |
|
| 398 | - 'type' => 'invoice_item', |
|
| 399 | - 'function' => 'SUM', |
|
| 400 | - 'name' => 'invoice_item_count', |
|
| 401 | - ), |
|
| 402 | - 'post_date' => array( |
|
| 403 | - 'type' => 'post_data', |
|
| 404 | - 'function' => '', |
|
| 405 | - 'name' => 'post_date', |
|
| 406 | - ), |
|
| 407 | - ), |
|
| 408 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 409 | - 'order_by' => 'post_date ASC', |
|
| 410 | - 'query_type' => 'get_results', |
|
| 411 | - 'filter_range' => $this->report_range, |
|
| 412 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 413 | - ) |
|
| 414 | - ); |
|
| 415 | - |
|
| 416 | - } |
|
| 417 | - |
|
| 418 | - /** |
|
| 419 | - * Prepares refunded item counts. |
|
| 420 | - * |
|
| 421 | - * @return array. |
|
| 422 | - */ |
|
| 423 | - protected function count_refunded_items() { |
|
| 424 | - |
|
| 425 | - return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 426 | - array( |
|
| 427 | - 'data' => array( |
|
| 428 | - 'quantity' => array( |
|
| 429 | - 'type' => 'invoice_item', |
|
| 430 | - 'function' => 'SUM', |
|
| 431 | - 'name' => 'invoice_item_count', |
|
| 432 | - ), |
|
| 433 | - ), |
|
| 434 | - 'query_type' => 'get_var', |
|
| 435 | - 'filter_range' => $this->report_range, |
|
| 436 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
| 437 | - ) |
|
| 438 | - ); |
|
| 439 | - |
|
| 440 | - } |
|
| 441 | - |
|
| 442 | - /** |
|
| 443 | - * Prepares daily invoice totals. |
|
| 444 | - * |
|
| 445 | - * @return array. |
|
| 446 | - */ |
|
| 447 | - protected function query_invoice_totals() { |
|
| 448 | - |
|
| 449 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 450 | - array( |
|
| 451 | - 'data' => array( |
|
| 452 | - 'total' => array( |
|
| 453 | - 'type' => 'invoice_data', |
|
| 454 | - 'function' => 'SUM', |
|
| 455 | - 'name' => 'total_sales', |
|
| 456 | - ), |
|
| 457 | - 'tax' => array( |
|
| 458 | - 'type' => 'invoice_data', |
|
| 459 | - 'function' => 'SUM', |
|
| 460 | - 'name' => 'total_tax', |
|
| 461 | - ), |
|
| 462 | - 'discount' => array( |
|
| 463 | - 'type' => 'invoice_data', |
|
| 464 | - 'function' => 'SUM', |
|
| 465 | - 'name' => 'total_discount', |
|
| 466 | - ), |
|
| 467 | - 'fees_total' => array( |
|
| 468 | - 'type' => 'invoice_data', |
|
| 469 | - 'function' => 'SUM', |
|
| 470 | - 'name' => 'total_fees', |
|
| 471 | - ), |
|
| 472 | - 'subtotal' => array( |
|
| 473 | - 'type' => 'invoice_data', |
|
| 474 | - 'function' => 'SUM', |
|
| 475 | - 'name' => 'subtotal', |
|
| 476 | - ), |
|
| 477 | - 'post_date' => array( |
|
| 478 | - 'type' => 'post_data', |
|
| 479 | - 'function' => '', |
|
| 480 | - 'name' => 'post_date', |
|
| 481 | - ), |
|
| 482 | - ), |
|
| 483 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 484 | - 'order_by' => 'post_date ASC', |
|
| 485 | - 'query_type' => 'get_results', |
|
| 486 | - 'filter_range' => $this->report_range, |
|
| 487 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
| 488 | - ) |
|
| 489 | - ); |
|
| 490 | - |
|
| 491 | - } |
|
| 492 | - |
|
| 493 | - /** |
|
| 494 | - * Prepares daily invoice totals. |
|
| 495 | - * |
|
| 496 | - * @return array. |
|
| 497 | - */ |
|
| 498 | - protected function query_refunded_totals() { |
|
| 499 | - |
|
| 500 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 501 | - array( |
|
| 502 | - 'data' => array( |
|
| 503 | - 'total' => array( |
|
| 504 | - 'type' => 'invoice_data', |
|
| 505 | - 'function' => 'SUM', |
|
| 506 | - 'name' => 'total_sales', |
|
| 507 | - ), |
|
| 508 | - 'tax' => array( |
|
| 509 | - 'type' => 'invoice_data', |
|
| 510 | - 'function' => 'SUM', |
|
| 511 | - 'name' => 'total_tax', |
|
| 512 | - ), |
|
| 513 | - 'discount' => array( |
|
| 514 | - 'type' => 'invoice_data', |
|
| 515 | - 'function' => 'SUM', |
|
| 516 | - 'name' => 'total_discount', |
|
| 517 | - ), |
|
| 518 | - 'fees_total' => array( |
|
| 519 | - 'type' => 'invoice_data', |
|
| 520 | - 'function' => 'SUM', |
|
| 521 | - 'name' => 'total_fees', |
|
| 522 | - ), |
|
| 523 | - 'subtotal' => array( |
|
| 524 | - 'type' => 'invoice_data', |
|
| 525 | - 'function' => 'SUM', |
|
| 526 | - 'name' => 'subtotal', |
|
| 527 | - ), |
|
| 528 | - 'post_date' => array( |
|
| 529 | - 'type' => 'post_data', |
|
| 530 | - 'function' => '', |
|
| 531 | - 'name' => 'post_date', |
|
| 532 | - ), |
|
| 533 | - ), |
|
| 534 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 535 | - 'order_by' => 'post_date ASC', |
|
| 536 | - 'query_type' => 'get_results', |
|
| 537 | - 'filter_range' => $this->report_range, |
|
| 538 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
| 539 | - ) |
|
| 540 | - ); |
|
| 541 | - |
|
| 542 | - } |
|
| 543 | - |
|
| 544 | - /** |
|
| 545 | - * Get the Report's schema, conforming to JSON Schema. |
|
| 546 | - * |
|
| 547 | - * @return array |
|
| 548 | - */ |
|
| 549 | - public function get_item_schema() { |
|
| 550 | - |
|
| 551 | - $schema = array( |
|
| 552 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 553 | - 'title' => 'sales_report', |
|
| 554 | - 'type' => 'object', |
|
| 555 | - 'properties' => array( |
|
| 556 | - 'total_sales' => array( |
|
| 557 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
| 558 | - 'type' => 'string', |
|
| 559 | - 'context' => array( 'view' ), |
|
| 560 | - 'readonly' => true, |
|
| 561 | - ), |
|
| 562 | - 'net_sales' => array( |
|
| 563 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
| 564 | - 'type' => 'string', |
|
| 565 | - 'context' => array( 'view' ), |
|
| 566 | - 'readonly' => true, |
|
| 567 | - ), |
|
| 568 | - 'average_sales' => array( |
|
| 569 | - 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
| 570 | - 'type' => 'string', |
|
| 571 | - 'context' => array( 'view' ), |
|
| 572 | - 'readonly' => true, |
|
| 573 | - ), |
|
| 574 | - 'average_total_sales' => array( |
|
| 575 | - 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
| 576 | - 'type' => 'string', |
|
| 577 | - 'context' => array( 'view' ), |
|
| 578 | - 'readonly' => true, |
|
| 579 | - ), |
|
| 580 | - 'total_invoices' => array( |
|
| 581 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
| 582 | - 'type' => 'integer', |
|
| 583 | - 'context' => array( 'view' ), |
|
| 584 | - 'readonly' => true, |
|
| 585 | - ), |
|
| 586 | - 'total_items' => array( |
|
| 587 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
| 588 | - 'type' => 'integer', |
|
| 589 | - 'context' => array( 'view' ), |
|
| 590 | - 'readonly' => true, |
|
| 591 | - ), |
|
| 592 | - 'refunded_items' => array( |
|
| 593 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
| 594 | - 'type' => 'integer', |
|
| 595 | - 'context' => array( 'view' ), |
|
| 596 | - 'readonly' => true, |
|
| 597 | - ), |
|
| 598 | - 'total_tax' => array( |
|
| 599 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
| 600 | - 'type' => 'string', |
|
| 601 | - 'context' => array( 'view' ), |
|
| 602 | - 'readonly' => true, |
|
| 603 | - ), |
|
| 604 | - 'total_refunded_tax' => array( |
|
| 605 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
| 606 | - 'type' => 'string', |
|
| 607 | - 'context' => array( 'view' ), |
|
| 608 | - 'readonly' => true, |
|
| 609 | - ), |
|
| 610 | - 'total_fees' => array( |
|
| 611 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
| 612 | - 'type' => 'string', |
|
| 613 | - 'context' => array( 'view' ), |
|
| 614 | - 'readonly' => true, |
|
| 615 | - ), |
|
| 616 | - 'total_refunds' => array( |
|
| 617 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
| 618 | - 'type' => 'integer', |
|
| 619 | - 'context' => array( 'view' ), |
|
| 620 | - 'readonly' => true, |
|
| 621 | - ), |
|
| 622 | - 'net_refunds' => array( |
|
| 623 | - 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
| 624 | - 'type' => 'integer', |
|
| 625 | - 'context' => array( 'view' ), |
|
| 626 | - 'readonly' => true, |
|
| 627 | - ), |
|
| 628 | - 'total_discount' => array( |
|
| 629 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
| 630 | - 'type' => 'integer', |
|
| 631 | - 'context' => array( 'view' ), |
|
| 632 | - 'readonly' => true, |
|
| 633 | - ), |
|
| 634 | - 'totals' => array( |
|
| 635 | - 'description' => __( 'Totals.', 'invoicing' ), |
|
| 636 | - 'type' => 'array', |
|
| 637 | - 'items' => array( |
|
| 638 | - 'type' => 'array', |
|
| 639 | - ), |
|
| 640 | - 'context' => array( 'view' ), |
|
| 641 | - 'readonly' => true, |
|
| 642 | - ), |
|
| 643 | - 'interval' => array( |
|
| 644 | - 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
| 645 | - 'type' => 'integer', |
|
| 646 | - 'context' => array( 'view' ), |
|
| 647 | - 'readonly' => true, |
|
| 648 | - ), |
|
| 649 | - 'previous_range' => array( |
|
| 650 | - 'description' => __( 'The previous report period.', 'invoicing' ), |
|
| 651 | - 'type' => 'array', |
|
| 652 | - 'items' => array( |
|
| 653 | - 'type' => 'string', |
|
| 654 | - ), |
|
| 655 | - 'context' => array( 'view' ), |
|
| 656 | - 'readonly' => true, |
|
| 657 | - ), |
|
| 658 | - 'grouped_by' => array( |
|
| 659 | - 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
| 660 | - 'type' => 'string', |
|
| 661 | - 'context' => array( 'view' ), |
|
| 662 | - 'enum' => array( 'day', 'month' ), |
|
| 663 | - 'readonly' => true, |
|
| 664 | - ), |
|
| 665 | - 'currency' => array( |
|
| 666 | - 'description' => __( 'The default store currency.', 'invoicing' ), |
|
| 667 | - 'type' => 'string', |
|
| 668 | - 'context' => array( 'view' ), |
|
| 669 | - 'readonly' => true, |
|
| 670 | - ), |
|
| 671 | - 'currency_symbol' => array( |
|
| 672 | - 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
| 673 | - 'type' => 'string', |
|
| 674 | - 'context' => array( 'view' ), |
|
| 675 | - 'readonly' => true, |
|
| 676 | - ), |
|
| 677 | - 'currency_position' => array( |
|
| 678 | - 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
| 679 | - 'type' => 'string', |
|
| 680 | - 'context' => array( 'view' ), |
|
| 681 | - 'readonly' => true, |
|
| 682 | - ), |
|
| 683 | - 'decimal_places' => array( |
|
| 684 | - 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
| 685 | - 'type' => 'string', |
|
| 686 | - 'context' => array( 'view' ), |
|
| 687 | - 'readonly' => true, |
|
| 688 | - ), |
|
| 689 | - 'thousands_sep' => array( |
|
| 690 | - 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
| 691 | - 'type' => 'string', |
|
| 692 | - 'context' => array( 'view' ), |
|
| 693 | - 'readonly' => true, |
|
| 694 | - ), |
|
| 695 | - 'decimals_sep' => array( |
|
| 696 | - 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
| 697 | - 'type' => 'string', |
|
| 698 | - 'context' => array( 'view' ), |
|
| 699 | - 'readonly' => true, |
|
| 700 | - ), |
|
| 701 | - ), |
|
| 702 | - ); |
|
| 703 | - |
|
| 704 | - return $this->add_additional_fields_schema( $schema ); |
|
| 705 | - |
|
| 706 | - } |
|
| 21 | + /** |
|
| 22 | + * Route base. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $rest_base = 'reports/sales'; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * The report data. |
|
| 30 | + * |
|
| 31 | + * @var stdClass |
|
| 32 | + */ |
|
| 33 | + public $report_data; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * The report range. |
|
| 37 | + * |
|
| 38 | + * @var array |
|
| 39 | + */ |
|
| 40 | + public $report_range; |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * Registers the routes for the objects of the controller. |
|
| 44 | + * |
|
| 45 | + * @since 2.0.0 |
|
| 46 | + * |
|
| 47 | + * @see register_rest_route() |
|
| 48 | + */ |
|
| 49 | + public function register_namespace_routes( $namespace ) { |
|
| 50 | + |
|
| 51 | + // Get sales report. |
|
| 52 | + register_rest_route( |
|
| 53 | + $namespace, |
|
| 54 | + $this->rest_base, |
|
| 55 | + array( |
|
| 56 | + array( |
|
| 57 | + 'methods' => WP_REST_Server::READABLE, |
|
| 58 | + 'callback' => array( $this, 'get_items' ), |
|
| 59 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 60 | + 'args' => $this->get_collection_params(), |
|
| 61 | + ), |
|
| 62 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 63 | + ) |
|
| 64 | + ); |
|
| 65 | + |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + /** |
|
| 69 | + * Makes sure the current user has access to READ the report APIs. |
|
| 70 | + * |
|
| 71 | + * @since 2.0.0 |
|
| 72 | + * @param WP_REST_Request $request Full data about the request. |
|
| 73 | + * @return WP_Error|boolean |
|
| 74 | + */ |
|
| 75 | + public function get_items_permissions_check( $request ) { |
|
| 76 | + |
|
| 77 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 78 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + return true; |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * Get sales reports. |
|
| 86 | + * |
|
| 87 | + * @param WP_REST_Request $request |
|
| 88 | + * @return array|WP_Error |
|
| 89 | + */ |
|
| 90 | + public function get_items( $request ) { |
|
| 91 | + $data = array(); |
|
| 92 | + $item = $this->prepare_item_for_response( null, $request ); |
|
| 93 | + $data[] = $this->prepare_response_for_collection( $item ); |
|
| 94 | + |
|
| 95 | + return rest_ensure_response( $data ); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * Prepare a report sales object for serialization. |
|
| 100 | + * |
|
| 101 | + * @param null $_ |
|
| 102 | + * @param WP_REST_Request $request Request object. |
|
| 103 | + * @return WP_REST_Response $response Response data. |
|
| 104 | + */ |
|
| 105 | + public function prepare_item_for_response( $_, $request ) { |
|
| 106 | + |
|
| 107 | + // Set report range. |
|
| 108 | + $this->report_range = $this->get_date_range( $request ); |
|
| 109 | + |
|
| 110 | + $report_data = $this->get_report_data(); |
|
| 111 | + $period_totals = array(); |
|
| 112 | + |
|
| 113 | + // Setup period totals by ensuring each period in the interval has data. |
|
| 114 | + $start_date = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS; |
|
| 115 | + |
|
| 116 | + if ( 'month' === $this->groupby ) { |
|
| 117 | + $start_date = strtotime( date( 'Y-m-01', $start_date ) ); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + for ( $i = 0; $i < $this->interval; $i++ ) { |
|
| 121 | + |
|
| 122 | + switch ( $this->groupby ) { |
|
| 123 | + case 'day' : |
|
| 124 | + $time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
| 125 | + break; |
|
| 126 | + default : |
|
| 127 | + $time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
| 128 | + break; |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + // Set the defaults for each period. |
|
| 132 | + $period_totals[ $time ] = array( |
|
| 133 | + 'invoices' => 0, |
|
| 134 | + 'items' => 0, |
|
| 135 | + 'refunded_items' => 0, |
|
| 136 | + 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
| 137 | + 'subtotal' => wpinv_round_amount( 0.00 ), |
|
| 138 | + 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
| 139 | + 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
| 140 | + 'discount' => wpinv_round_amount( 0.00 ), |
|
| 141 | + ); |
|
| 142 | + |
|
| 143 | + foreach( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
| 144 | + if ( ! isset( $period_totals[ $time ][ $key ] ) ) { |
|
| 145 | + $period_totals[ $time ][ $key ] = wpinv_round_amount( 0.00 ); |
|
| 146 | + } |
|
| 147 | + } |
|
| 148 | + |
|
| 149 | + } |
|
| 150 | + |
|
| 151 | + // add total sales, total invoice count, total tax for each period |
|
| 152 | + $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
| 153 | + foreach ( $report_data->invoices as $invoice ) { |
|
| 154 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 155 | + |
|
| 156 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 157 | + continue; |
|
| 158 | + } |
|
| 159 | + |
|
| 160 | + $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 161 | + $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 162 | + $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 163 | + $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 164 | + |
|
| 165 | + } |
|
| 166 | + |
|
| 167 | + foreach ( $report_data->refunds as $invoice ) { |
|
| 168 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 169 | + |
|
| 170 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 171 | + continue; |
|
| 172 | + } |
|
| 173 | + |
|
| 174 | + $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 175 | + $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 176 | + $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 177 | + $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 178 | + |
|
| 179 | + } |
|
| 180 | + |
|
| 181 | + foreach ( $report_data->invoice_counts as $invoice ) { |
|
| 182 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 183 | + |
|
| 184 | + if ( isset( $period_totals[ $time ] ) ) { |
|
| 185 | + $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + } |
|
| 189 | + |
|
| 190 | + // Add total invoice items for each period. |
|
| 191 | + foreach ( $report_data->invoice_items as $invoice_item ) { |
|
| 192 | + $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
| 193 | + |
|
| 194 | + if ( isset( $period_totals[ $time ] ) ) { |
|
| 195 | + $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
| 196 | + } |
|
| 197 | + |
|
| 198 | + } |
|
| 199 | + |
|
| 200 | + // Add total discount for each period. |
|
| 201 | + foreach ( $report_data->coupons as $discount ) { |
|
| 202 | + $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) ); |
|
| 203 | + |
|
| 204 | + if ( isset( $period_totals[ $time ] ) ) { |
|
| 205 | + $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + } |
|
| 209 | + |
|
| 210 | + // Extra fields. |
|
| 211 | + foreach( array_keys( wpinv_get_report_graphs() ) as $key ) { |
|
| 212 | + |
|
| 213 | + // Abort unprepared. |
|
| 214 | + if ( ! isset( $report_data->$key ) ) { |
|
| 215 | + continue; |
|
| 216 | + } |
|
| 217 | + |
|
| 218 | + // Abort defaults. |
|
| 219 | + if ( in_array( $key, array( 'sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items' ) ) ) { |
|
| 220 | + continue; |
|
| 221 | + } |
|
| 222 | + |
|
| 223 | + // Set values. |
|
| 224 | + foreach ( $report_data->$key as $item ) { |
|
| 225 | + $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $item->date ) ) : date( 'Y-m', strtotime( $item->date ) ); |
|
| 226 | + |
|
| 227 | + if ( isset( $period_totals[ $time ] ) ) { |
|
| 228 | + $period_totals[ $time ][ $key ] = wpinv_round_amount( $item->val ); |
|
| 229 | + } |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + unset( $report_data->$key ); |
|
| 233 | + } |
|
| 234 | + |
|
| 235 | + $report_data->totals = $period_totals; |
|
| 236 | + $report_data->grouped_by = $this->groupby; |
|
| 237 | + $report_data->interval = max( $this->interval, 1 ); |
|
| 238 | + $report_data->currency = wpinv_get_currency(); |
|
| 239 | + $report_data->currency_symbol = wpinv_currency_symbol(); |
|
| 240 | + $report_data->currency_position = wpinv_currency_position(); |
|
| 241 | + $report_data->decimal_places = wpinv_decimals(); |
|
| 242 | + $report_data->thousands_sep = wpinv_thousands_separator(); |
|
| 243 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 244 | + $report_data->start_date = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ); |
|
| 245 | + $report_data->end_date = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ); |
|
| 246 | + $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) ); |
|
| 247 | + $report_data->end_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) ); |
|
| 248 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 249 | + |
|
| 250 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 251 | + $data = $report_data; |
|
| 252 | + unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
| 253 | + $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
| 254 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 255 | + |
|
| 256 | + // Wrap the data in a response object. |
|
| 257 | + $response = rest_ensure_response( $data ); |
|
| 258 | + $response->add_links( array( |
|
| 259 | + 'about' => array( |
|
| 260 | + 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 261 | + ), |
|
| 262 | + ) ); |
|
| 263 | + |
|
| 264 | + return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
| 265 | + } |
|
| 266 | + |
|
| 267 | + /** |
|
| 268 | + * Get report data. |
|
| 269 | + * |
|
| 270 | + * @return stdClass |
|
| 271 | + */ |
|
| 272 | + public function get_report_data() { |
|
| 273 | + if ( empty( $this->report_data ) ) { |
|
| 274 | + $this->query_report_data(); |
|
| 275 | + } |
|
| 276 | + return $this->report_data; |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + /** |
|
| 280 | + * Get all data needed for this report and store in the class. |
|
| 281 | + */ |
|
| 282 | + protected function query_report_data() { |
|
| 283 | + |
|
| 284 | + // Prepare reports. |
|
| 285 | + $this->report_data = (object) array( |
|
| 286 | + 'invoice_counts' => $this->query_invoice_counts(),//count, post_date |
|
| 287 | + 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
| 288 | + 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
| 289 | + 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
| 290 | + 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 291 | + 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 292 | + 'previous_range' => $this->previous_range, |
|
| 293 | + ); |
|
| 294 | + |
|
| 295 | + // Calculated totals. |
|
| 296 | + $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
| 297 | + $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
| 298 | + $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
| 299 | + $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
| 300 | + $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
| 301 | + $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
| 302 | + $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
| 303 | + $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
| 304 | + $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
| 305 | + $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
| 306 | + $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
| 307 | + $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
| 308 | + |
|
| 309 | + |
|
| 310 | + // Calculate average based on net. |
|
| 311 | + $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
| 312 | + $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
| 313 | + |
|
| 314 | + // Total invoices in this period, even if refunded. |
|
| 315 | + $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
| 316 | + |
|
| 317 | + // Items invoiced in this period, even if refunded. |
|
| 318 | + $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
| 319 | + |
|
| 320 | + // 3rd party filtering of report data |
|
| 321 | + $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data, $this ); |
|
| 322 | + } |
|
| 323 | + |
|
| 324 | + /** |
|
| 325 | + * Prepares invoice counts. |
|
| 326 | + * |
|
| 327 | + * @return array. |
|
| 328 | + */ |
|
| 329 | + protected function query_invoice_counts() { |
|
| 330 | + |
|
| 331 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 332 | + array( |
|
| 333 | + 'data' => array( |
|
| 334 | + 'ID' => array( |
|
| 335 | + 'type' => 'post_data', |
|
| 336 | + 'function' => 'COUNT', |
|
| 337 | + 'name' => 'count', |
|
| 338 | + 'distinct' => true, |
|
| 339 | + ), |
|
| 340 | + 'post_date' => array( |
|
| 341 | + 'type' => 'post_data', |
|
| 342 | + 'function' => '', |
|
| 343 | + 'name' => 'post_date', |
|
| 344 | + ), |
|
| 345 | + ), |
|
| 346 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 347 | + 'order_by' => 'post_date ASC', |
|
| 348 | + 'query_type' => 'get_results', |
|
| 349 | + 'filter_range' => $this->report_range, |
|
| 350 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 351 | + ) |
|
| 352 | + ); |
|
| 353 | + |
|
| 354 | + } |
|
| 355 | + |
|
| 356 | + /** |
|
| 357 | + * Prepares coupon counts. |
|
| 358 | + * |
|
| 359 | + * @return array. |
|
| 360 | + */ |
|
| 361 | + protected function query_coupon_counts() { |
|
| 362 | + |
|
| 363 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 364 | + array( |
|
| 365 | + 'data' => array( |
|
| 366 | + 'discount' => array( |
|
| 367 | + 'type' => 'invoice_data', |
|
| 368 | + 'function' => 'SUM', |
|
| 369 | + 'name' => 'discount_amount', |
|
| 370 | + ), |
|
| 371 | + 'post_date' => array( |
|
| 372 | + 'type' => 'post_data', |
|
| 373 | + 'function' => '', |
|
| 374 | + 'name' => 'post_date', |
|
| 375 | + ), |
|
| 376 | + ), |
|
| 377 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 378 | + 'order_by' => 'post_date ASC', |
|
| 379 | + 'query_type' => 'get_results', |
|
| 380 | + 'filter_range' => $this->report_range, |
|
| 381 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 382 | + ) |
|
| 383 | + ); |
|
| 384 | + |
|
| 385 | + } |
|
| 386 | + |
|
| 387 | + /** |
|
| 388 | + * Prepares item counts. |
|
| 389 | + * |
|
| 390 | + * @return array. |
|
| 391 | + */ |
|
| 392 | + protected function query_item_counts() { |
|
| 393 | + |
|
| 394 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 395 | + array( |
|
| 396 | + 'data' => array( |
|
| 397 | + 'quantity' => array( |
|
| 398 | + 'type' => 'invoice_item', |
|
| 399 | + 'function' => 'SUM', |
|
| 400 | + 'name' => 'invoice_item_count', |
|
| 401 | + ), |
|
| 402 | + 'post_date' => array( |
|
| 403 | + 'type' => 'post_data', |
|
| 404 | + 'function' => '', |
|
| 405 | + 'name' => 'post_date', |
|
| 406 | + ), |
|
| 407 | + ), |
|
| 408 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 409 | + 'order_by' => 'post_date ASC', |
|
| 410 | + 'query_type' => 'get_results', |
|
| 411 | + 'filter_range' => $this->report_range, |
|
| 412 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 413 | + ) |
|
| 414 | + ); |
|
| 415 | + |
|
| 416 | + } |
|
| 417 | + |
|
| 418 | + /** |
|
| 419 | + * Prepares refunded item counts. |
|
| 420 | + * |
|
| 421 | + * @return array. |
|
| 422 | + */ |
|
| 423 | + protected function count_refunded_items() { |
|
| 424 | + |
|
| 425 | + return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 426 | + array( |
|
| 427 | + 'data' => array( |
|
| 428 | + 'quantity' => array( |
|
| 429 | + 'type' => 'invoice_item', |
|
| 430 | + 'function' => 'SUM', |
|
| 431 | + 'name' => 'invoice_item_count', |
|
| 432 | + ), |
|
| 433 | + ), |
|
| 434 | + 'query_type' => 'get_var', |
|
| 435 | + 'filter_range' => $this->report_range, |
|
| 436 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
| 437 | + ) |
|
| 438 | + ); |
|
| 439 | + |
|
| 440 | + } |
|
| 441 | + |
|
| 442 | + /** |
|
| 443 | + * Prepares daily invoice totals. |
|
| 444 | + * |
|
| 445 | + * @return array. |
|
| 446 | + */ |
|
| 447 | + protected function query_invoice_totals() { |
|
| 448 | + |
|
| 449 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 450 | + array( |
|
| 451 | + 'data' => array( |
|
| 452 | + 'total' => array( |
|
| 453 | + 'type' => 'invoice_data', |
|
| 454 | + 'function' => 'SUM', |
|
| 455 | + 'name' => 'total_sales', |
|
| 456 | + ), |
|
| 457 | + 'tax' => array( |
|
| 458 | + 'type' => 'invoice_data', |
|
| 459 | + 'function' => 'SUM', |
|
| 460 | + 'name' => 'total_tax', |
|
| 461 | + ), |
|
| 462 | + 'discount' => array( |
|
| 463 | + 'type' => 'invoice_data', |
|
| 464 | + 'function' => 'SUM', |
|
| 465 | + 'name' => 'total_discount', |
|
| 466 | + ), |
|
| 467 | + 'fees_total' => array( |
|
| 468 | + 'type' => 'invoice_data', |
|
| 469 | + 'function' => 'SUM', |
|
| 470 | + 'name' => 'total_fees', |
|
| 471 | + ), |
|
| 472 | + 'subtotal' => array( |
|
| 473 | + 'type' => 'invoice_data', |
|
| 474 | + 'function' => 'SUM', |
|
| 475 | + 'name' => 'subtotal', |
|
| 476 | + ), |
|
| 477 | + 'post_date' => array( |
|
| 478 | + 'type' => 'post_data', |
|
| 479 | + 'function' => '', |
|
| 480 | + 'name' => 'post_date', |
|
| 481 | + ), |
|
| 482 | + ), |
|
| 483 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 484 | + 'order_by' => 'post_date ASC', |
|
| 485 | + 'query_type' => 'get_results', |
|
| 486 | + 'filter_range' => $this->report_range, |
|
| 487 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
| 488 | + ) |
|
| 489 | + ); |
|
| 490 | + |
|
| 491 | + } |
|
| 492 | + |
|
| 493 | + /** |
|
| 494 | + * Prepares daily invoice totals. |
|
| 495 | + * |
|
| 496 | + * @return array. |
|
| 497 | + */ |
|
| 498 | + protected function query_refunded_totals() { |
|
| 499 | + |
|
| 500 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 501 | + array( |
|
| 502 | + 'data' => array( |
|
| 503 | + 'total' => array( |
|
| 504 | + 'type' => 'invoice_data', |
|
| 505 | + 'function' => 'SUM', |
|
| 506 | + 'name' => 'total_sales', |
|
| 507 | + ), |
|
| 508 | + 'tax' => array( |
|
| 509 | + 'type' => 'invoice_data', |
|
| 510 | + 'function' => 'SUM', |
|
| 511 | + 'name' => 'total_tax', |
|
| 512 | + ), |
|
| 513 | + 'discount' => array( |
|
| 514 | + 'type' => 'invoice_data', |
|
| 515 | + 'function' => 'SUM', |
|
| 516 | + 'name' => 'total_discount', |
|
| 517 | + ), |
|
| 518 | + 'fees_total' => array( |
|
| 519 | + 'type' => 'invoice_data', |
|
| 520 | + 'function' => 'SUM', |
|
| 521 | + 'name' => 'total_fees', |
|
| 522 | + ), |
|
| 523 | + 'subtotal' => array( |
|
| 524 | + 'type' => 'invoice_data', |
|
| 525 | + 'function' => 'SUM', |
|
| 526 | + 'name' => 'subtotal', |
|
| 527 | + ), |
|
| 528 | + 'post_date' => array( |
|
| 529 | + 'type' => 'post_data', |
|
| 530 | + 'function' => '', |
|
| 531 | + 'name' => 'post_date', |
|
| 532 | + ), |
|
| 533 | + ), |
|
| 534 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 535 | + 'order_by' => 'post_date ASC', |
|
| 536 | + 'query_type' => 'get_results', |
|
| 537 | + 'filter_range' => $this->report_range, |
|
| 538 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
| 539 | + ) |
|
| 540 | + ); |
|
| 541 | + |
|
| 542 | + } |
|
| 543 | + |
|
| 544 | + /** |
|
| 545 | + * Get the Report's schema, conforming to JSON Schema. |
|
| 546 | + * |
|
| 547 | + * @return array |
|
| 548 | + */ |
|
| 549 | + public function get_item_schema() { |
|
| 550 | + |
|
| 551 | + $schema = array( |
|
| 552 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 553 | + 'title' => 'sales_report', |
|
| 554 | + 'type' => 'object', |
|
| 555 | + 'properties' => array( |
|
| 556 | + 'total_sales' => array( |
|
| 557 | + 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
| 558 | + 'type' => 'string', |
|
| 559 | + 'context' => array( 'view' ), |
|
| 560 | + 'readonly' => true, |
|
| 561 | + ), |
|
| 562 | + 'net_sales' => array( |
|
| 563 | + 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
| 564 | + 'type' => 'string', |
|
| 565 | + 'context' => array( 'view' ), |
|
| 566 | + 'readonly' => true, |
|
| 567 | + ), |
|
| 568 | + 'average_sales' => array( |
|
| 569 | + 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
| 570 | + 'type' => 'string', |
|
| 571 | + 'context' => array( 'view' ), |
|
| 572 | + 'readonly' => true, |
|
| 573 | + ), |
|
| 574 | + 'average_total_sales' => array( |
|
| 575 | + 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
| 576 | + 'type' => 'string', |
|
| 577 | + 'context' => array( 'view' ), |
|
| 578 | + 'readonly' => true, |
|
| 579 | + ), |
|
| 580 | + 'total_invoices' => array( |
|
| 581 | + 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
| 582 | + 'type' => 'integer', |
|
| 583 | + 'context' => array( 'view' ), |
|
| 584 | + 'readonly' => true, |
|
| 585 | + ), |
|
| 586 | + 'total_items' => array( |
|
| 587 | + 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
| 588 | + 'type' => 'integer', |
|
| 589 | + 'context' => array( 'view' ), |
|
| 590 | + 'readonly' => true, |
|
| 591 | + ), |
|
| 592 | + 'refunded_items' => array( |
|
| 593 | + 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
| 594 | + 'type' => 'integer', |
|
| 595 | + 'context' => array( 'view' ), |
|
| 596 | + 'readonly' => true, |
|
| 597 | + ), |
|
| 598 | + 'total_tax' => array( |
|
| 599 | + 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
| 600 | + 'type' => 'string', |
|
| 601 | + 'context' => array( 'view' ), |
|
| 602 | + 'readonly' => true, |
|
| 603 | + ), |
|
| 604 | + 'total_refunded_tax' => array( |
|
| 605 | + 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
| 606 | + 'type' => 'string', |
|
| 607 | + 'context' => array( 'view' ), |
|
| 608 | + 'readonly' => true, |
|
| 609 | + ), |
|
| 610 | + 'total_fees' => array( |
|
| 611 | + 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
| 612 | + 'type' => 'string', |
|
| 613 | + 'context' => array( 'view' ), |
|
| 614 | + 'readonly' => true, |
|
| 615 | + ), |
|
| 616 | + 'total_refunds' => array( |
|
| 617 | + 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
| 618 | + 'type' => 'integer', |
|
| 619 | + 'context' => array( 'view' ), |
|
| 620 | + 'readonly' => true, |
|
| 621 | + ), |
|
| 622 | + 'net_refunds' => array( |
|
| 623 | + 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
| 624 | + 'type' => 'integer', |
|
| 625 | + 'context' => array( 'view' ), |
|
| 626 | + 'readonly' => true, |
|
| 627 | + ), |
|
| 628 | + 'total_discount' => array( |
|
| 629 | + 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
| 630 | + 'type' => 'integer', |
|
| 631 | + 'context' => array( 'view' ), |
|
| 632 | + 'readonly' => true, |
|
| 633 | + ), |
|
| 634 | + 'totals' => array( |
|
| 635 | + 'description' => __( 'Totals.', 'invoicing' ), |
|
| 636 | + 'type' => 'array', |
|
| 637 | + 'items' => array( |
|
| 638 | + 'type' => 'array', |
|
| 639 | + ), |
|
| 640 | + 'context' => array( 'view' ), |
|
| 641 | + 'readonly' => true, |
|
| 642 | + ), |
|
| 643 | + 'interval' => array( |
|
| 644 | + 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
| 645 | + 'type' => 'integer', |
|
| 646 | + 'context' => array( 'view' ), |
|
| 647 | + 'readonly' => true, |
|
| 648 | + ), |
|
| 649 | + 'previous_range' => array( |
|
| 650 | + 'description' => __( 'The previous report period.', 'invoicing' ), |
|
| 651 | + 'type' => 'array', |
|
| 652 | + 'items' => array( |
|
| 653 | + 'type' => 'string', |
|
| 654 | + ), |
|
| 655 | + 'context' => array( 'view' ), |
|
| 656 | + 'readonly' => true, |
|
| 657 | + ), |
|
| 658 | + 'grouped_by' => array( |
|
| 659 | + 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
| 660 | + 'type' => 'string', |
|
| 661 | + 'context' => array( 'view' ), |
|
| 662 | + 'enum' => array( 'day', 'month' ), |
|
| 663 | + 'readonly' => true, |
|
| 664 | + ), |
|
| 665 | + 'currency' => array( |
|
| 666 | + 'description' => __( 'The default store currency.', 'invoicing' ), |
|
| 667 | + 'type' => 'string', |
|
| 668 | + 'context' => array( 'view' ), |
|
| 669 | + 'readonly' => true, |
|
| 670 | + ), |
|
| 671 | + 'currency_symbol' => array( |
|
| 672 | + 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
| 673 | + 'type' => 'string', |
|
| 674 | + 'context' => array( 'view' ), |
|
| 675 | + 'readonly' => true, |
|
| 676 | + ), |
|
| 677 | + 'currency_position' => array( |
|
| 678 | + 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
| 679 | + 'type' => 'string', |
|
| 680 | + 'context' => array( 'view' ), |
|
| 681 | + 'readonly' => true, |
|
| 682 | + ), |
|
| 683 | + 'decimal_places' => array( |
|
| 684 | + 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
| 685 | + 'type' => 'string', |
|
| 686 | + 'context' => array( 'view' ), |
|
| 687 | + 'readonly' => true, |
|
| 688 | + ), |
|
| 689 | + 'thousands_sep' => array( |
|
| 690 | + 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
| 691 | + 'type' => 'string', |
|
| 692 | + 'context' => array( 'view' ), |
|
| 693 | + 'readonly' => true, |
|
| 694 | + ), |
|
| 695 | + 'decimals_sep' => array( |
|
| 696 | + 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
| 697 | + 'type' => 'string', |
|
| 698 | + 'context' => array( 'view' ), |
|
| 699 | + 'readonly' => true, |
|
| 700 | + ), |
|
| 701 | + ), |
|
| 702 | + ); |
|
| 703 | + |
|
| 704 | + return $this->add_additional_fields_schema( $schema ); |
|
| 705 | + |
|
| 706 | + } |
|
| 707 | 707 | |
| 708 | 708 | } |
@@ -12,88 +12,88 @@ discard block |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Reports_Report { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * @var array |
|
| 17 | - */ |
|
| 18 | - public $views; |
|
| 15 | + /** |
|
| 16 | + * @var array |
|
| 17 | + */ |
|
| 18 | + public $views; |
|
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * Class constructor. |
|
| 22 | - * |
|
| 23 | - */ |
|
| 24 | - public function __construct() { |
|
| 20 | + /** |
|
| 21 | + * Class constructor. |
|
| 22 | + * |
|
| 23 | + */ |
|
| 24 | + public function __construct() { |
|
| 25 | 25 | |
| 26 | - $this->views = array( |
|
| 26 | + $this->views = array( |
|
| 27 | 27 | |
| 28 | 28 | 'items' => array( |
| 29 | - 'label' => __( 'Items', 'invoicing' ), |
|
| 30 | - 'class' => 'GetPaid_Reports_Report_Items', |
|
| 31 | - ), |
|
| 29 | + 'label' => __( 'Items', 'invoicing' ), |
|
| 30 | + 'class' => 'GetPaid_Reports_Report_Items', |
|
| 31 | + ), |
|
| 32 | 32 | |
| 33 | - 'gateways' => array( |
|
| 34 | - 'label' => __( 'Payment Methods', 'invoicing' ), |
|
| 35 | - 'class' => 'GetPaid_Reports_Report_Gateways', |
|
| 36 | - ), |
|
| 33 | + 'gateways' => array( |
|
| 34 | + 'label' => __( 'Payment Methods', 'invoicing' ), |
|
| 35 | + 'class' => 'GetPaid_Reports_Report_Gateways', |
|
| 36 | + ), |
|
| 37 | 37 | |
| 38 | - 'discounts' => array( |
|
| 39 | - 'label' => __( 'Discount Codes', 'invoicing' ), |
|
| 40 | - 'class' => 'GetPaid_Reports_Report_Discounts', |
|
| 41 | - ), |
|
| 38 | + 'discounts' => array( |
|
| 39 | + 'label' => __( 'Discount Codes', 'invoicing' ), |
|
| 40 | + 'class' => 'GetPaid_Reports_Report_Discounts', |
|
| 41 | + ), |
|
| 42 | 42 | |
| 43 | 43 | ); |
| 44 | 44 | |
| 45 | - $this->views = apply_filters( 'wpinv_report_views', $this->views ); |
|
| 46 | - |
|
| 47 | - } |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * Retrieves the current range. |
|
| 51 | - * |
|
| 52 | - */ |
|
| 53 | - public function get_range() { |
|
| 54 | - $valid_ranges = $this->get_periods(); |
|
| 55 | - |
|
| 56 | - if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) { |
|
| 57 | - return sanitize_key( $_GET['date_range'] ); |
|
| 58 | - } |
|
| 59 | - |
|
| 60 | - return '7_days'; |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Returns an array of date ranges. |
|
| 65 | - * |
|
| 66 | - * @return array |
|
| 67 | - */ |
|
| 68 | - public function get_periods() { |
|
| 69 | - |
|
| 70 | - $periods = array( |
|
| 71 | - 'today' => __( 'Today', 'invoicing' ), |
|
| 72 | - 'yesterday' => __( 'Yesterday', 'invoicing' ), |
|
| 73 | - 'week' => __( 'This week', 'invoicing' ), |
|
| 74 | - 'last_week' => __( 'Last week', 'invoicing' ), |
|
| 75 | - '7_days' => __( 'Last 7 days', 'invoicing' ), |
|
| 76 | - 'month' => __( 'This month', 'invoicing' ), |
|
| 77 | - 'last_month' => __( 'Last month', 'invoicing' ), |
|
| 78 | - '30_days' => __( 'Last 30 days', 'invoicing' ), |
|
| 79 | - 'quarter' => __( 'This Quarter', 'invoicing' ), |
|
| 80 | - 'last_quarter' => __( 'Last Quarter', 'invoicing' ), |
|
| 81 | - 'year' => __( 'This year', 'invoicing' ), |
|
| 82 | - 'last_year' => __( 'Last Year', 'invoicing' ), |
|
| 83 | - 'custom' => __( 'Custom Date Range', 'invoicing' ), |
|
| 84 | - ); |
|
| 85 | - |
|
| 86 | - return apply_filters( 'getpaid_earning_periods', $periods ); |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - /** |
|
| 90 | - * Displays the range selector. |
|
| 91 | - * |
|
| 92 | - */ |
|
| 93 | - public function display_range_selector() { |
|
| 94 | - |
|
| 95 | - $range = $this->get_range(); |
|
| 96 | - ?> |
|
| 45 | + $this->views = apply_filters( 'wpinv_report_views', $this->views ); |
|
| 46 | + |
|
| 47 | + } |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * Retrieves the current range. |
|
| 51 | + * |
|
| 52 | + */ |
|
| 53 | + public function get_range() { |
|
| 54 | + $valid_ranges = $this->get_periods(); |
|
| 55 | + |
|
| 56 | + if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) { |
|
| 57 | + return sanitize_key( $_GET['date_range'] ); |
|
| 58 | + } |
|
| 59 | + |
|
| 60 | + return '7_days'; |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Returns an array of date ranges. |
|
| 65 | + * |
|
| 66 | + * @return array |
|
| 67 | + */ |
|
| 68 | + public function get_periods() { |
|
| 69 | + |
|
| 70 | + $periods = array( |
|
| 71 | + 'today' => __( 'Today', 'invoicing' ), |
|
| 72 | + 'yesterday' => __( 'Yesterday', 'invoicing' ), |
|
| 73 | + 'week' => __( 'This week', 'invoicing' ), |
|
| 74 | + 'last_week' => __( 'Last week', 'invoicing' ), |
|
| 75 | + '7_days' => __( 'Last 7 days', 'invoicing' ), |
|
| 76 | + 'month' => __( 'This month', 'invoicing' ), |
|
| 77 | + 'last_month' => __( 'Last month', 'invoicing' ), |
|
| 78 | + '30_days' => __( 'Last 30 days', 'invoicing' ), |
|
| 79 | + 'quarter' => __( 'This Quarter', 'invoicing' ), |
|
| 80 | + 'last_quarter' => __( 'Last Quarter', 'invoicing' ), |
|
| 81 | + 'year' => __( 'This year', 'invoicing' ), |
|
| 82 | + 'last_year' => __( 'Last Year', 'invoicing' ), |
|
| 83 | + 'custom' => __( 'Custom Date Range', 'invoicing' ), |
|
| 84 | + ); |
|
| 85 | + |
|
| 86 | + return apply_filters( 'getpaid_earning_periods', $periods ); |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + /** |
|
| 90 | + * Displays the range selector. |
|
| 91 | + * |
|
| 92 | + */ |
|
| 93 | + public function display_range_selector() { |
|
| 94 | + |
|
| 95 | + $range = $this->get_range(); |
|
| 96 | + ?> |
|
| 97 | 97 | |
| 98 | 98 | <form method="get" class="getpaid-filter-earnings float-right"> |
| 99 | 99 | <?php getpaid_hidden_field( 'page', isset( $_GET['page'] ) ? wpinv_clean( $_GET['page'] ) : 'wpinv-reports' ); ?> |
@@ -115,14 +115,14 @@ discard block |
||
| 115 | 115 | </form> |
| 116 | 116 | |
| 117 | 117 | <?php |
| 118 | - } |
|
| 118 | + } |
|
| 119 | 119 | |
| 120 | - /** |
|
| 121 | - * Displays the reports tab. |
|
| 122 | - * |
|
| 123 | - */ |
|
| 124 | - public function display() { |
|
| 125 | - ?> |
|
| 120 | + /** |
|
| 121 | + * Displays the reports tab. |
|
| 122 | + * |
|
| 123 | + */ |
|
| 124 | + public function display() { |
|
| 125 | + ?> |
|
| 126 | 126 | |
| 127 | 127 | <div class="mt-4"> |
| 128 | 128 | |
@@ -202,16 +202,16 @@ discard block |
||
| 202 | 202 | |
| 203 | 203 | <?php |
| 204 | 204 | |
| 205 | - } |
|
| 205 | + } |
|
| 206 | 206 | |
| 207 | - /** |
|
| 208 | - * Displays the left side. |
|
| 209 | - * |
|
| 210 | - */ |
|
| 211 | - public function display_left() { |
|
| 212 | - $graphs = wpinv_get_report_graphs(); |
|
| 207 | + /** |
|
| 208 | + * Displays the left side. |
|
| 209 | + * |
|
| 210 | + */ |
|
| 211 | + public function display_left() { |
|
| 212 | + $graphs = wpinv_get_report_graphs(); |
|
| 213 | 213 | |
| 214 | - ?> |
|
| 214 | + ?> |
|
| 215 | 215 | |
| 216 | 216 | <?php foreach ( $graphs as $key => $graph ) : ?> |
| 217 | 217 | <div class="row mb-4"> |
@@ -230,35 +230,35 @@ discard block |
||
| 230 | 230 | |
| 231 | 231 | <?php |
| 232 | 232 | |
| 233 | - } |
|
| 234 | - |
|
| 235 | - /** |
|
| 236 | - * Retrieves the download url. |
|
| 237 | - * |
|
| 238 | - */ |
|
| 239 | - public function get_download_url( $graph, $file_type ) { |
|
| 240 | - |
|
| 241 | - return wp_nonce_url( |
|
| 242 | - add_query_arg( |
|
| 243 | - array( |
|
| 244 | - 'getpaid-admin-action' => 'download_graph', |
|
| 245 | - 'file_type' => urlencode( $file_type ), |
|
| 246 | - 'graph' => urlencode( $graph ), |
|
| 247 | - ) |
|
| 248 | - ), |
|
| 249 | - 'getpaid-nonce', |
|
| 250 | - 'getpaid-nonce' |
|
| 251 | - ); |
|
| 233 | + } |
|
| 234 | + |
|
| 235 | + /** |
|
| 236 | + * Retrieves the download url. |
|
| 237 | + * |
|
| 238 | + */ |
|
| 239 | + public function get_download_url( $graph, $file_type ) { |
|
| 240 | + |
|
| 241 | + return wp_nonce_url( |
|
| 242 | + add_query_arg( |
|
| 243 | + array( |
|
| 244 | + 'getpaid-admin-action' => 'download_graph', |
|
| 245 | + 'file_type' => urlencode( $file_type ), |
|
| 246 | + 'graph' => urlencode( $graph ), |
|
| 247 | + ) |
|
| 248 | + ), |
|
| 249 | + 'getpaid-nonce', |
|
| 250 | + 'getpaid-nonce' |
|
| 251 | + ); |
|
| 252 | 252 | |
| 253 | - } |
|
| 253 | + } |
|
| 254 | 254 | |
| 255 | - /** |
|
| 256 | - * Displays the right side. |
|
| 257 | - * |
|
| 258 | - */ |
|
| 259 | - public function display_right() { |
|
| 255 | + /** |
|
| 256 | + * Displays the right side. |
|
| 257 | + * |
|
| 258 | + */ |
|
| 259 | + public function display_right() { |
|
| 260 | 260 | |
| 261 | - ?> |
|
| 261 | + ?> |
|
| 262 | 262 | |
| 263 | 263 | <?php foreach ( $this->views as $key => $view ) : ?> |
| 264 | 264 | <div class="row mb-4"> |
@@ -287,10 +287,10 @@ discard block |
||
| 287 | 287 | </div> |
| 288 | 288 | <div class="card-body"> |
| 289 | 289 | <?php |
| 290 | - $class = $view['class']; |
|
| 291 | - $class = new $class(); |
|
| 292 | - $class->display_stats(); |
|
| 293 | - ?> |
|
| 290 | + $class = $view['class']; |
|
| 291 | + $class = new $class(); |
|
| 292 | + $class->display_stats(); |
|
| 293 | + ?> |
|
| 294 | 294 | </div> |
| 295 | 295 | </div> |
| 296 | 296 | </div> |
@@ -299,68 +299,68 @@ discard block |
||
| 299 | 299 | |
| 300 | 300 | <?php |
| 301 | 301 | |
| 302 | - do_action( 'getpaid_reports_display_right', $this ); |
|
| 303 | - } |
|
| 304 | - |
|
| 305 | - /** |
|
| 306 | - * Returns a list of report cards. |
|
| 307 | - * |
|
| 308 | - */ |
|
| 309 | - public function get_cards() { |
|
| 310 | - |
|
| 311 | - $cards = array( |
|
| 312 | - 'total_sales' => array( |
|
| 313 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
| 314 | - 'label' => __( 'Gross Revenue', 'invoicing' ), |
|
| 315 | - ), |
|
| 316 | - 'net_sales' => array( |
|
| 317 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
| 318 | - 'label' => __( 'Net Revenue', 'invoicing' ), |
|
| 319 | - ), |
|
| 320 | - 'average_sales' => array( |
|
| 321 | - 'description' => __( 'Average net daily/monthly sales.', 'invoicing' ), |
|
| 322 | - 'label' => __( 'Avg. Net Sales', 'invoicing' ), |
|
| 323 | - ), |
|
| 324 | - 'average_total_sales' => array( |
|
| 325 | - 'description' => __( 'Average gross daily/monthly sales.', 'invoicing' ), |
|
| 326 | - 'label' => __( 'Avg. Gross Sales', 'invoicing' ), |
|
| 327 | - ), |
|
| 328 | - 'total_invoices' => array( |
|
| 329 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
| 330 | - 'label' => __( 'Paid Invoices', 'invoicing' ), |
|
| 331 | - ), |
|
| 332 | - 'total_items' => array( |
|
| 333 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
| 334 | - 'label' => __( 'Purchased Items', 'invoicing' ), |
|
| 335 | - ), |
|
| 336 | - 'refunded_items' => array( |
|
| 337 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
| 338 | - 'label' => __( 'Refunded Items', 'invoicing' ), |
|
| 339 | - ), |
|
| 340 | - 'total_tax' => array( |
|
| 341 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
| 342 | - 'label' => __( 'Tax', 'invoicing' ), |
|
| 343 | - ), |
|
| 344 | - 'total_refunded_tax' => array( |
|
| 345 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
| 346 | - 'label' => __( 'Refunded Tax', 'invoicing' ), |
|
| 347 | - ), |
|
| 348 | - 'total_fees' => array( |
|
| 349 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
| 350 | - 'label' => __( 'Fees', 'invoicing' ), |
|
| 351 | - ), |
|
| 352 | - 'total_refunds' => array( |
|
| 353 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
| 354 | - 'label' => __( 'Refunded', 'invoicing' ), |
|
| 355 | - ), |
|
| 356 | - 'total_discount' => array( |
|
| 357 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
| 358 | - 'label' => __( 'Discounted', 'invoicing' ), |
|
| 359 | - ), |
|
| 360 | - ); |
|
| 361 | - |
|
| 362 | - return apply_filters( 'wpinv_report_cards', $cards ); |
|
| 363 | - } |
|
| 302 | + do_action( 'getpaid_reports_display_right', $this ); |
|
| 303 | + } |
|
| 304 | + |
|
| 305 | + /** |
|
| 306 | + * Returns a list of report cards. |
|
| 307 | + * |
|
| 308 | + */ |
|
| 309 | + public function get_cards() { |
|
| 310 | + |
|
| 311 | + $cards = array( |
|
| 312 | + 'total_sales' => array( |
|
| 313 | + 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
| 314 | + 'label' => __( 'Gross Revenue', 'invoicing' ), |
|
| 315 | + ), |
|
| 316 | + 'net_sales' => array( |
|
| 317 | + 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
| 318 | + 'label' => __( 'Net Revenue', 'invoicing' ), |
|
| 319 | + ), |
|
| 320 | + 'average_sales' => array( |
|
| 321 | + 'description' => __( 'Average net daily/monthly sales.', 'invoicing' ), |
|
| 322 | + 'label' => __( 'Avg. Net Sales', 'invoicing' ), |
|
| 323 | + ), |
|
| 324 | + 'average_total_sales' => array( |
|
| 325 | + 'description' => __( 'Average gross daily/monthly sales.', 'invoicing' ), |
|
| 326 | + 'label' => __( 'Avg. Gross Sales', 'invoicing' ), |
|
| 327 | + ), |
|
| 328 | + 'total_invoices' => array( |
|
| 329 | + 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
| 330 | + 'label' => __( 'Paid Invoices', 'invoicing' ), |
|
| 331 | + ), |
|
| 332 | + 'total_items' => array( |
|
| 333 | + 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
| 334 | + 'label' => __( 'Purchased Items', 'invoicing' ), |
|
| 335 | + ), |
|
| 336 | + 'refunded_items' => array( |
|
| 337 | + 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
| 338 | + 'label' => __( 'Refunded Items', 'invoicing' ), |
|
| 339 | + ), |
|
| 340 | + 'total_tax' => array( |
|
| 341 | + 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
| 342 | + 'label' => __( 'Tax', 'invoicing' ), |
|
| 343 | + ), |
|
| 344 | + 'total_refunded_tax' => array( |
|
| 345 | + 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
| 346 | + 'label' => __( 'Refunded Tax', 'invoicing' ), |
|
| 347 | + ), |
|
| 348 | + 'total_fees' => array( |
|
| 349 | + 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
| 350 | + 'label' => __( 'Fees', 'invoicing' ), |
|
| 351 | + ), |
|
| 352 | + 'total_refunds' => array( |
|
| 353 | + 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
| 354 | + 'label' => __( 'Refunded', 'invoicing' ), |
|
| 355 | + ), |
|
| 356 | + 'total_discount' => array( |
|
| 357 | + 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
| 358 | + 'label' => __( 'Discounted', 'invoicing' ), |
|
| 359 | + ), |
|
| 360 | + ); |
|
| 361 | + |
|
| 362 | + return apply_filters( 'wpinv_report_cards', $cards ); |
|
| 363 | + } |
|
| 364 | 364 | |
| 365 | 365 | |
| 366 | 366 | |
@@ -12,69 +12,69 @@ discard block |
||
| 12 | 12 | */ |
| 13 | 13 | abstract class GetPaid_Reports_Abstract_Report { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * @var array |
|
| 17 | - */ |
|
| 18 | - public $stats; |
|
| 19 | - |
|
| 20 | - /** |
|
| 21 | - * Class constructor. |
|
| 22 | - * |
|
| 23 | - */ |
|
| 24 | - public function __construct() { |
|
| 25 | - $this->prepare_stats(); |
|
| 26 | - } |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Retrieves the current range. |
|
| 30 | - * |
|
| 31 | - */ |
|
| 32 | - public function get_range() { |
|
| 33 | - $valid_ranges = $this->get_periods(); |
|
| 34 | - |
|
| 35 | - if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) { |
|
| 36 | - return sanitize_key( $_GET['date_range'] ); |
|
| 37 | - } |
|
| 38 | - |
|
| 39 | - return '7_days'; |
|
| 40 | - } |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * Returns an array of date ranges. |
|
| 44 | - * |
|
| 45 | - * @return array |
|
| 46 | - */ |
|
| 47 | - public function get_periods() { |
|
| 48 | - |
|
| 49 | - $periods = array( |
|
| 15 | + /** |
|
| 16 | + * @var array |
|
| 17 | + */ |
|
| 18 | + public $stats; |
|
| 19 | + |
|
| 20 | + /** |
|
| 21 | + * Class constructor. |
|
| 22 | + * |
|
| 23 | + */ |
|
| 24 | + public function __construct() { |
|
| 25 | + $this->prepare_stats(); |
|
| 26 | + } |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Retrieves the current range. |
|
| 30 | + * |
|
| 31 | + */ |
|
| 32 | + public function get_range() { |
|
| 33 | + $valid_ranges = $this->get_periods(); |
|
| 34 | + |
|
| 35 | + if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) { |
|
| 36 | + return sanitize_key( $_GET['date_range'] ); |
|
| 37 | + } |
|
| 38 | + |
|
| 39 | + return '7_days'; |
|
| 40 | + } |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * Returns an array of date ranges. |
|
| 44 | + * |
|
| 45 | + * @return array |
|
| 46 | + */ |
|
| 47 | + public function get_periods() { |
|
| 48 | + |
|
| 49 | + $periods = array( |
|
| 50 | 50 | 'today' => __( 'Today', 'invoicing' ), |
| 51 | 51 | 'yesterday' => __( 'Yesterday', 'invoicing' ), |
| 52 | 52 | '7_days' => __( 'Last 7 days', 'invoicing' ), |
| 53 | - '30_days' => __( 'Last 30 days', 'invoicing' ), |
|
| 54 | - '60_days' => __( 'Last 60 days', 'invoicing' ), |
|
| 55 | - '90_days' => __( 'Last 90 days', 'invoicing' ), |
|
| 56 | - '180_days' => __( 'Last 180 days', 'invoicing' ), |
|
| 57 | - '360_days' => __( 'Last 360 days', 'invoicing' ), |
|
| 58 | - ); |
|
| 59 | - |
|
| 60 | - return apply_filters( 'getpaid_earning_periods', $periods ); |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Retrieves the current range's sql. |
|
| 65 | - * |
|
| 66 | - */ |
|
| 67 | - public function get_range_sql( $range, $date = 'CAST(meta.completed_date AS DATE)', $datetime = 'meta.comlpeted_date' ) { |
|
| 53 | + '30_days' => __( 'Last 30 days', 'invoicing' ), |
|
| 54 | + '60_days' => __( 'Last 60 days', 'invoicing' ), |
|
| 55 | + '90_days' => __( 'Last 90 days', 'invoicing' ), |
|
| 56 | + '180_days' => __( 'Last 180 days', 'invoicing' ), |
|
| 57 | + '360_days' => __( 'Last 360 days', 'invoicing' ), |
|
| 58 | + ); |
|
| 59 | + |
|
| 60 | + return apply_filters( 'getpaid_earning_periods', $periods ); |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Retrieves the current range's sql. |
|
| 65 | + * |
|
| 66 | + */ |
|
| 67 | + public function get_range_sql( $range, $date = 'CAST(meta.completed_date AS DATE)', $datetime = 'meta.comlpeted_date' ) { |
|
| 68 | 68 | |
| 69 | 69 | // Prepare durations. |
| 70 | 70 | $today = current_time( 'Y-m-d' ); |
| 71 | - $yesterday = date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ); |
|
| 72 | - $seven_days_ago = date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ); |
|
| 73 | - $thirty_days_ago = date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ); |
|
| 74 | - $ninety_days_ago = date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ); |
|
| 75 | - $sixty_days_ago = date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ); |
|
| 76 | - $one_eighty_days_ago = date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ); |
|
| 77 | - $three_sixty_days_ago = date( 'Y-m-d', strtotime( '-360 days', current_time( 'timestamp' ) ) ); |
|
| 71 | + $yesterday = date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ); |
|
| 72 | + $seven_days_ago = date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ); |
|
| 73 | + $thirty_days_ago = date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ); |
|
| 74 | + $ninety_days_ago = date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ); |
|
| 75 | + $sixty_days_ago = date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ); |
|
| 76 | + $one_eighty_days_ago = date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ); |
|
| 77 | + $three_sixty_days_ago = date( 'Y-m-d', strtotime( '-360 days', current_time( 'timestamp' ) ) ); |
|
| 78 | 78 | |
| 79 | 79 | $ranges = array( |
| 80 | 80 | |
@@ -91,130 +91,130 @@ discard block |
||
| 91 | 91 | '7_days' => array( |
| 92 | 92 | "DATE($datetime)", |
| 93 | 93 | "$date BETWEEN '$seven_days_ago' AND '$today'" |
| 94 | - ), |
|
| 94 | + ), |
|
| 95 | 95 | |
| 96 | - '30_days' => array( |
|
| 96 | + '30_days' => array( |
|
| 97 | 97 | "DATE($datetime)", |
| 98 | 98 | "$date BETWEEN '$thirty_days_ago' AND '$today'" |
| 99 | - ), |
|
| 99 | + ), |
|
| 100 | 100 | |
| 101 | - '60_days' => array( |
|
| 101 | + '60_days' => array( |
|
| 102 | 102 | "DATE($datetime)", |
| 103 | 103 | "$date BETWEEN '$sixty_days_ago' AND '$today'" |
| 104 | - ), |
|
| 104 | + ), |
|
| 105 | 105 | |
| 106 | - '90_days' => array( |
|
| 106 | + '90_days' => array( |
|
| 107 | 107 | "WEEK($datetime)", |
| 108 | 108 | "$date BETWEEN '$ninety_days_ago' AND '$today'" |
| 109 | - ), |
|
| 109 | + ), |
|
| 110 | 110 | |
| 111 | - '180_days' => array( |
|
| 111 | + '180_days' => array( |
|
| 112 | 112 | "WEEK($datetime)", |
| 113 | 113 | "$date BETWEEN '$one_eighty_days_ago' AND '$today'" |
| 114 | - ), |
|
| 114 | + ), |
|
| 115 | 115 | |
| 116 | - '360_days' => array( |
|
| 116 | + '360_days' => array( |
|
| 117 | 117 | "WEEK($datetime)", |
| 118 | 118 | "$date BETWEEN '$three_sixty_days_ago' AND '$today'" |
| 119 | 119 | ), |
| 120 | 120 | |
| 121 | 121 | ); |
| 122 | 122 | |
| 123 | - $sql = isset( $ranges[ $range ] ) ? $ranges[ $range ] : $ranges[ '7_days' ]; |
|
| 124 | - return apply_filters( 'getpaid_earning_graphs_get_range_sql', $sql, $range ); |
|
| 125 | - |
|
| 126 | - } |
|
| 127 | - |
|
| 128 | - /** |
|
| 129 | - * Retrieves the hours in a day |
|
| 130 | - * |
|
| 131 | - */ |
|
| 132 | - public function get_hours_in_a_day() { |
|
| 133 | - |
|
| 134 | - return array( |
|
| 135 | - '12AM' => __( '12 AM', 'invoicing'), |
|
| 136 | - '1AM' => __( '1 AM', 'invoicing'), |
|
| 137 | - '2AM' => __( '2 AM', 'invoicing'), |
|
| 138 | - '3AM' => __( '3 AM', 'invoicing'), |
|
| 139 | - '4AM' => __( '4 AM', 'invoicing'), |
|
| 140 | - '5AM' => __( '5 AM', 'invoicing'), |
|
| 141 | - '6AM' => __( '6 AM', 'invoicing'), |
|
| 142 | - '7AM' => __( '7 AM', 'invoicing'), |
|
| 143 | - '8AM' => __( '8 AM', 'invoicing'), |
|
| 144 | - '9AM' => __( '9 AM', 'invoicing'), |
|
| 145 | - '10AM' => __( '10 AM', 'invoicing'), |
|
| 146 | - '11AM' => __( '11 AM', 'invoicing'), |
|
| 147 | - '12pm' => __( '12 PM', 'invoicing'), |
|
| 148 | - '1PM' => __( '1 PM', 'invoicing'), |
|
| 149 | - '2PM' => __( '2 PM', 'invoicing'), |
|
| 150 | - '3PM' => __( '3 PM', 'invoicing'), |
|
| 151 | - '4PM' => __( '4 PM', 'invoicing'), |
|
| 152 | - '5PM' => __( '5 PM', 'invoicing'), |
|
| 153 | - '6PM' => __( '6 PM', 'invoicing'), |
|
| 154 | - '7PM' => __( '7 PM', 'invoicing'), |
|
| 155 | - '8PM' => __( '8 PM', 'invoicing'), |
|
| 156 | - '9PM' => __( '9 PM', 'invoicing'), |
|
| 157 | - '10PM' => __( '10 PM', 'invoicing'), |
|
| 158 | - '11PM' => __( '11 PM', 'invoicing'), |
|
| 159 | - ); |
|
| 160 | - |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - /** |
|
| 164 | - * Retrieves the days in a period |
|
| 165 | - * |
|
| 166 | - */ |
|
| 167 | - public function get_days_in_period( $days ) { |
|
| 168 | - |
|
| 169 | - $return = array(); |
|
| 170 | - $format = 'Y-m-d'; |
|
| 171 | - |
|
| 172 | - if ( $days < 8 ) { |
|
| 173 | - $format = 'D'; |
|
| 174 | - } |
|
| 175 | - |
|
| 176 | - if ( $days < 32 ) { |
|
| 177 | - $format = 'M j'; |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - while ( $days > 0 ) { |
|
| 181 | - |
|
| 182 | - $key = date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ); |
|
| 183 | - $label = date_i18n( $format, strtotime( "-$days days", current_time( 'timestamp' ) ) ); |
|
| 184 | - $return[ $key ] = $label; |
|
| 185 | - $days--; |
|
| 186 | - |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - return $return; |
|
| 190 | - } |
|
| 191 | - |
|
| 192 | - /** |
|
| 193 | - * Retrieves the weeks in a period |
|
| 194 | - * |
|
| 195 | - */ |
|
| 196 | - public function get_weeks_in_period( $days ) { |
|
| 197 | - |
|
| 198 | - $return = array(); |
|
| 199 | - |
|
| 200 | - while ( $days > 0 ) { |
|
| 201 | - |
|
| 202 | - $key = date( 'W', strtotime( "-$days days", current_time( 'timestamp' ) ) ); |
|
| 203 | - $label = date_i18n( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ); |
|
| 204 | - $return[ $key ] = $label; |
|
| 205 | - $days--; |
|
| 206 | - |
|
| 207 | - } |
|
| 208 | - |
|
| 209 | - return $return; |
|
| 210 | - } |
|
| 211 | - |
|
| 212 | - /** |
|
| 213 | - * Displays the report card. |
|
| 214 | - * |
|
| 215 | - */ |
|
| 216 | - public function display() { |
|
| 217 | - ?> |
|
| 123 | + $sql = isset( $ranges[ $range ] ) ? $ranges[ $range ] : $ranges[ '7_days' ]; |
|
| 124 | + return apply_filters( 'getpaid_earning_graphs_get_range_sql', $sql, $range ); |
|
| 125 | + |
|
| 126 | + } |
|
| 127 | + |
|
| 128 | + /** |
|
| 129 | + * Retrieves the hours in a day |
|
| 130 | + * |
|
| 131 | + */ |
|
| 132 | + public function get_hours_in_a_day() { |
|
| 133 | + |
|
| 134 | + return array( |
|
| 135 | + '12AM' => __( '12 AM', 'invoicing'), |
|
| 136 | + '1AM' => __( '1 AM', 'invoicing'), |
|
| 137 | + '2AM' => __( '2 AM', 'invoicing'), |
|
| 138 | + '3AM' => __( '3 AM', 'invoicing'), |
|
| 139 | + '4AM' => __( '4 AM', 'invoicing'), |
|
| 140 | + '5AM' => __( '5 AM', 'invoicing'), |
|
| 141 | + '6AM' => __( '6 AM', 'invoicing'), |
|
| 142 | + '7AM' => __( '7 AM', 'invoicing'), |
|
| 143 | + '8AM' => __( '8 AM', 'invoicing'), |
|
| 144 | + '9AM' => __( '9 AM', 'invoicing'), |
|
| 145 | + '10AM' => __( '10 AM', 'invoicing'), |
|
| 146 | + '11AM' => __( '11 AM', 'invoicing'), |
|
| 147 | + '12pm' => __( '12 PM', 'invoicing'), |
|
| 148 | + '1PM' => __( '1 PM', 'invoicing'), |
|
| 149 | + '2PM' => __( '2 PM', 'invoicing'), |
|
| 150 | + '3PM' => __( '3 PM', 'invoicing'), |
|
| 151 | + '4PM' => __( '4 PM', 'invoicing'), |
|
| 152 | + '5PM' => __( '5 PM', 'invoicing'), |
|
| 153 | + '6PM' => __( '6 PM', 'invoicing'), |
|
| 154 | + '7PM' => __( '7 PM', 'invoicing'), |
|
| 155 | + '8PM' => __( '8 PM', 'invoicing'), |
|
| 156 | + '9PM' => __( '9 PM', 'invoicing'), |
|
| 157 | + '10PM' => __( '10 PM', 'invoicing'), |
|
| 158 | + '11PM' => __( '11 PM', 'invoicing'), |
|
| 159 | + ); |
|
| 160 | + |
|
| 161 | + } |
|
| 162 | + |
|
| 163 | + /** |
|
| 164 | + * Retrieves the days in a period |
|
| 165 | + * |
|
| 166 | + */ |
|
| 167 | + public function get_days_in_period( $days ) { |
|
| 168 | + |
|
| 169 | + $return = array(); |
|
| 170 | + $format = 'Y-m-d'; |
|
| 171 | + |
|
| 172 | + if ( $days < 8 ) { |
|
| 173 | + $format = 'D'; |
|
| 174 | + } |
|
| 175 | + |
|
| 176 | + if ( $days < 32 ) { |
|
| 177 | + $format = 'M j'; |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + while ( $days > 0 ) { |
|
| 181 | + |
|
| 182 | + $key = date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ); |
|
| 183 | + $label = date_i18n( $format, strtotime( "-$days days", current_time( 'timestamp' ) ) ); |
|
| 184 | + $return[ $key ] = $label; |
|
| 185 | + $days--; |
|
| 186 | + |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + return $return; |
|
| 190 | + } |
|
| 191 | + |
|
| 192 | + /** |
|
| 193 | + * Retrieves the weeks in a period |
|
| 194 | + * |
|
| 195 | + */ |
|
| 196 | + public function get_weeks_in_period( $days ) { |
|
| 197 | + |
|
| 198 | + $return = array(); |
|
| 199 | + |
|
| 200 | + while ( $days > 0 ) { |
|
| 201 | + |
|
| 202 | + $key = date( 'W', strtotime( "-$days days", current_time( 'timestamp' ) ) ); |
|
| 203 | + $label = date_i18n( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ); |
|
| 204 | + $return[ $key ] = $label; |
|
| 205 | + $days--; |
|
| 206 | + |
|
| 207 | + } |
|
| 208 | + |
|
| 209 | + return $return; |
|
| 210 | + } |
|
| 211 | + |
|
| 212 | + /** |
|
| 213 | + * Displays the report card. |
|
| 214 | + * |
|
| 215 | + */ |
|
| 216 | + public function display() { |
|
| 217 | + ?> |
|
| 218 | 218 | |
| 219 | 219 | <div class="row"> |
| 220 | 220 | <div class="col-12"> |
@@ -228,20 +228,20 @@ discard block |
||
| 228 | 228 | |
| 229 | 229 | <?php |
| 230 | 230 | |
| 231 | - } |
|
| 232 | - |
|
| 233 | - /** |
|
| 234 | - * Prepares the report stats. |
|
| 235 | - * |
|
| 236 | - * Extend this in child classes. |
|
| 237 | - */ |
|
| 238 | - abstract public function prepare_stats(); |
|
| 239 | - |
|
| 240 | - /** |
|
| 241 | - * Displays the actual report. |
|
| 242 | - * |
|
| 243 | - * Extend this in child classes. |
|
| 244 | - */ |
|
| 245 | - abstract public function display_stats(); |
|
| 231 | + } |
|
| 232 | + |
|
| 233 | + /** |
|
| 234 | + * Prepares the report stats. |
|
| 235 | + * |
|
| 236 | + * Extend this in child classes. |
|
| 237 | + */ |
|
| 238 | + abstract public function prepare_stats(); |
|
| 239 | + |
|
| 240 | + /** |
|
| 241 | + * Displays the actual report. |
|
| 242 | + * |
|
| 243 | + * Extend this in child classes. |
|
| 244 | + */ |
|
| 245 | + abstract public function display_stats(); |
|
| 246 | 246 | |
| 247 | 247 | } |
@@ -12,294 +12,294 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Reports_Helper { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * Get report totals such as invoice totals and discount amounts. |
|
| 17 | - * |
|
| 18 | - * Data example: |
|
| 19 | - * |
|
| 20 | - * 'subtotal' => array( |
|
| 21 | - * 'type' => 'invoice_data', |
|
| 22 | - * 'function' => 'SUM', |
|
| 23 | - * 'name' => 'subtotal' |
|
| 24 | - * ) |
|
| 25 | - * |
|
| 26 | - * @param array $args |
|
| 27 | - * @return mixed depending on query_type |
|
| 28 | - */ |
|
| 29 | - public static function get_invoice_report_data( $args = array() ) { |
|
| 30 | - global $wpdb; |
|
| 31 | - |
|
| 32 | - $default_args = array( |
|
| 33 | - 'data' => array(), // The data to retrieve. |
|
| 34 | - 'where' => array(), // An array of where queries. |
|
| 35 | - 'query_type' => 'get_row', // wpdb query to run. |
|
| 36 | - 'group_by' => '', // What to group results by. |
|
| 37 | - 'order_by' => '', // What to order by. |
|
| 38 | - 'limit' => '', // Results limit. |
|
| 39 | - 'filter_range' => array(), // An array of before and after dates to limit results by. |
|
| 40 | - 'invoice_types' => array( 'wpi_invoice' ), // An array of post types to retrieve. |
|
| 41 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold' ), |
|
| 42 | - 'parent_invoice_status' => false, // Optionally filter by parent invoice status. |
|
| 43 | - ); |
|
| 44 | - |
|
| 45 | - $args = apply_filters( 'getpaid_reports_get_invoice_report_data_args', $args ); |
|
| 46 | - $args = wp_parse_args( $args, $default_args ); |
|
| 47 | - |
|
| 48 | - extract( $args ); |
|
| 49 | - |
|
| 50 | - if ( empty( $data ) ) { |
|
| 51 | - return ''; |
|
| 52 | - } |
|
| 53 | - |
|
| 54 | - $query = array(); |
|
| 55 | - $query['select'] = 'SELECT ' . implode( ',', self::prepare_invoice_data( $data ) ); |
|
| 56 | - $query['from'] = "FROM {$wpdb->posts} AS posts"; |
|
| 57 | - $query['join'] = implode( ' ', self::prepare_invoice_joins( $data + $where, ! empty( $parent_invoice_status ) ) ); |
|
| 58 | - |
|
| 59 | - $query['where'] = " |
|
| 15 | + /** |
|
| 16 | + * Get report totals such as invoice totals and discount amounts. |
|
| 17 | + * |
|
| 18 | + * Data example: |
|
| 19 | + * |
|
| 20 | + * 'subtotal' => array( |
|
| 21 | + * 'type' => 'invoice_data', |
|
| 22 | + * 'function' => 'SUM', |
|
| 23 | + * 'name' => 'subtotal' |
|
| 24 | + * ) |
|
| 25 | + * |
|
| 26 | + * @param array $args |
|
| 27 | + * @return mixed depending on query_type |
|
| 28 | + */ |
|
| 29 | + public static function get_invoice_report_data( $args = array() ) { |
|
| 30 | + global $wpdb; |
|
| 31 | + |
|
| 32 | + $default_args = array( |
|
| 33 | + 'data' => array(), // The data to retrieve. |
|
| 34 | + 'where' => array(), // An array of where queries. |
|
| 35 | + 'query_type' => 'get_row', // wpdb query to run. |
|
| 36 | + 'group_by' => '', // What to group results by. |
|
| 37 | + 'order_by' => '', // What to order by. |
|
| 38 | + 'limit' => '', // Results limit. |
|
| 39 | + 'filter_range' => array(), // An array of before and after dates to limit results by. |
|
| 40 | + 'invoice_types' => array( 'wpi_invoice' ), // An array of post types to retrieve. |
|
| 41 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold' ), |
|
| 42 | + 'parent_invoice_status' => false, // Optionally filter by parent invoice status. |
|
| 43 | + ); |
|
| 44 | + |
|
| 45 | + $args = apply_filters( 'getpaid_reports_get_invoice_report_data_args', $args ); |
|
| 46 | + $args = wp_parse_args( $args, $default_args ); |
|
| 47 | + |
|
| 48 | + extract( $args ); |
|
| 49 | + |
|
| 50 | + if ( empty( $data ) ) { |
|
| 51 | + return ''; |
|
| 52 | + } |
|
| 53 | + |
|
| 54 | + $query = array(); |
|
| 55 | + $query['select'] = 'SELECT ' . implode( ',', self::prepare_invoice_data( $data ) ); |
|
| 56 | + $query['from'] = "FROM {$wpdb->posts} AS posts"; |
|
| 57 | + $query['join'] = implode( ' ', self::prepare_invoice_joins( $data + $where, ! empty( $parent_invoice_status ) ) ); |
|
| 58 | + |
|
| 59 | + $query['where'] = " |
|
| 60 | 60 | WHERE posts.post_type IN ( '" . implode( "','", $invoice_types ) . "' ) |
| 61 | 61 | "; |
| 62 | 62 | |
| 63 | - if ( ! empty( $invoice_status ) ) { |
|
| 64 | - $query['where'] .= " |
|
| 63 | + if ( ! empty( $invoice_status ) ) { |
|
| 64 | + $query['where'] .= " |
|
| 65 | 65 | AND posts.post_status IN ( '" . implode( "','", $invoice_status ) . "' ) |
| 66 | 66 | "; |
| 67 | - } |
|
| 68 | - |
|
| 69 | - if ( ! empty( $parent_invoice_status ) ) { |
|
| 70 | - if ( ! empty( $invoice_status ) ) { |
|
| 71 | - $query['where'] .= " AND ( parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) OR parent.ID IS NULL ) "; |
|
| 72 | - } else { |
|
| 73 | - $query['where'] .= " AND parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) "; |
|
| 74 | - } |
|
| 75 | - } |
|
| 76 | - |
|
| 77 | - if ( ! empty( $filter_range['before'] ) ) { |
|
| 78 | - $query['where'] .= " |
|
| 67 | + } |
|
| 68 | + |
|
| 69 | + if ( ! empty( $parent_invoice_status ) ) { |
|
| 70 | + if ( ! empty( $invoice_status ) ) { |
|
| 71 | + $query['where'] .= " AND ( parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) OR parent.ID IS NULL ) "; |
|
| 72 | + } else { |
|
| 73 | + $query['where'] .= " AND parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) "; |
|
| 74 | + } |
|
| 75 | + } |
|
| 76 | + |
|
| 77 | + if ( ! empty( $filter_range['before'] ) ) { |
|
| 78 | + $query['where'] .= " |
|
| 79 | 79 | AND posts.post_date < '" . date( 'Y-m-d 23:59:59', strtotime( $filter_range['before'] ) ) . "' |
| 80 | 80 | "; |
| 81 | - } |
|
| 81 | + } |
|
| 82 | 82 | |
| 83 | - if ( ! empty( $filter_range['after'] ) ) { |
|
| 84 | - $query['where'] .= " |
|
| 83 | + if ( ! empty( $filter_range['after'] ) ) { |
|
| 84 | + $query['where'] .= " |
|
| 85 | 85 | AND posts.post_date > '" . date( 'Y-m-d H:i:s', strtotime( $filter_range['after'] ) ) . "' |
| 86 | 86 | "; |
| 87 | - } |
|
| 87 | + } |
|
| 88 | 88 | |
| 89 | - if ( ! empty( $where ) ) { |
|
| 89 | + if ( ! empty( $where ) ) { |
|
| 90 | 90 | |
| 91 | - foreach ( $where as $value ) { |
|
| 91 | + foreach ( $where as $value ) { |
|
| 92 | 92 | |
| 93 | - if ( strtolower( $value['operator'] ) == 'in' || strtolower( $value['operator'] ) == 'not in' ) { |
|
| 94 | - |
|
| 95 | - if ( is_array( $value['value'] ) ) { |
|
| 96 | - $value['value'] = implode( "','", $value['value'] ); |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - if ( ! empty( $value['value'] ) ) { |
|
| 100 | - $where_value = "{$value['operator']} ('{$value['value']}')"; |
|
| 101 | - } |
|
| 102 | - } else { |
|
| 103 | - $where_value = "{$value['operator']} '{$value['value']}'"; |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - if ( ! empty( $where_value ) ) { |
|
| 107 | - $query['where'] .= " AND {$value['key']} {$where_value}"; |
|
| 108 | - } |
|
| 109 | - } |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - if ( $group_by ) { |
|
| 113 | - $query['group_by'] = "GROUP BY {$group_by}"; |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - if ( $order_by ) { |
|
| 117 | - $query['order_by'] = "ORDER BY {$order_by}"; |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - if ( $limit ) { |
|
| 121 | - $query['limit'] = "LIMIT {$limit}"; |
|
| 122 | - } |
|
| 123 | - |
|
| 124 | - $query = apply_filters( 'getpaid_reports_get_invoice_report_query', $query, $data ); |
|
| 125 | - $query = implode( ' ', $query ); |
|
| 126 | - |
|
| 127 | - return self::execute( $query_type, $query ); |
|
| 128 | - |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - /** |
|
| 132 | - * Prepares the data to select. |
|
| 133 | - * |
|
| 134 | - * |
|
| 135 | - * @param array $data |
|
| 136 | - * @return array |
|
| 137 | - */ |
|
| 138 | - public static function prepare_invoice_data( $data ) { |
|
| 139 | - |
|
| 140 | - $prepared = array(); |
|
| 141 | - |
|
| 142 | - foreach ( $data as $raw_key => $value ) { |
|
| 143 | - $key = sanitize_key( $raw_key ); |
|
| 144 | - $distinct = ''; |
|
| 145 | - |
|
| 146 | - if ( isset( $value['distinct'] ) ) { |
|
| 147 | - $distinct = 'DISTINCT'; |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - $get_key = self::get_invoice_table_key( $key, $value['type'] ); |
|
| 151 | - |
|
| 152 | - if ( false === $get_key ) { |
|
| 153 | - // Skip to the next foreach iteration else the query will be invalid. |
|
| 154 | - continue; |
|
| 155 | - } |
|
| 156 | - |
|
| 157 | - if ( ! empty( $value['function'] ) ) { |
|
| 158 | - $get = "{$value['function']}({$distinct} {$get_key})"; |
|
| 159 | - } else { |
|
| 160 | - $get = "{$distinct} {$get_key}"; |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - $prepared[] = "{$get} as {$value['name']}"; |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - return $prepared; |
|
| 167 | - |
|
| 168 | - } |
|
| 169 | - |
|
| 170 | - /** |
|
| 171 | - * Prepares the joins to use. |
|
| 172 | - * |
|
| 173 | - * |
|
| 174 | - * @param array $data |
|
| 175 | - * @param bool $with_parent |
|
| 176 | - * @return array |
|
| 177 | - */ |
|
| 178 | - public static function prepare_invoice_joins( $data, $with_parent ) { |
|
| 179 | - global $wpdb; |
|
| 180 | - |
|
| 181 | - $prepared = array(); |
|
| 182 | - |
|
| 183 | - foreach ( $data as $raw_key => $value ) { |
|
| 184 | - $join_type = isset( $value['join_type'] ) ? $value['join_type'] : 'INNER'; |
|
| 185 | - $type = isset( $value['type'] ) ? $value['type'] : false; |
|
| 186 | - $key = sanitize_key( $raw_key ); |
|
| 187 | - |
|
| 188 | - switch ( $type ) { |
|
| 189 | - case 'meta': |
|
| 190 | - $prepared[ "meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS meta_{$key} ON ( posts.ID = meta_{$key}.post_id AND meta_{$key}.meta_key = '{$raw_key}' )"; |
|
| 191 | - break; |
|
| 192 | - case 'parent_meta': |
|
| 193 | - $prepared[ "parent_meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS parent_meta_{$key} ON (posts.post_parent = parent_meta_{$key}.post_id) AND (parent_meta_{$key}.meta_key = '{$raw_key}')"; |
|
| 194 | - break; |
|
| 195 | - case 'invoice_data': |
|
| 196 | - $prepared['invoices'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoices AS invoices ON posts.ID = invoices.post_id"; |
|
| 197 | - break; |
|
| 198 | - case 'invoice_item': |
|
| 199 | - $prepared['invoice_items'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoice_items AS invoice_items ON posts.ID = invoice_items.post_id"; |
|
| 200 | - break; |
|
| 201 | - } |
|
| 202 | - } |
|
| 203 | - |
|
| 204 | - if ( $with_parent ) { |
|
| 205 | - $prepared['parent'] = "LEFT JOIN {$wpdb->posts} AS parent ON posts.post_parent = parent.ID"; |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - return $prepared; |
|
| 209 | - |
|
| 210 | - } |
|
| 211 | - |
|
| 212 | - /** |
|
| 213 | - * Retrieves the appropriate table key to use. |
|
| 214 | - * |
|
| 215 | - * |
|
| 216 | - * @param string $key |
|
| 217 | - * @param string $table |
|
| 218 | - * @return string|false |
|
| 219 | - */ |
|
| 220 | - public static function get_invoice_table_key( $key, $table ) { |
|
| 221 | - |
|
| 222 | - $keys = array( |
|
| 223 | - 'meta' => "meta_{$key}.meta_value", |
|
| 224 | - 'parent_meta' => "parent_meta_{$key}.meta_value", |
|
| 225 | - 'post_data' => "posts.{$key}", |
|
| 226 | - 'invoice_data' => "invoices.{$key}", |
|
| 227 | - 'invoice_item' => "invoice_items.{$key}", |
|
| 228 | - ); |
|
| 229 | - |
|
| 230 | - return isset( $keys[ $table ] ) ? $keys[ $table ] : false; |
|
| 231 | - |
|
| 232 | - } |
|
| 233 | - |
|
| 234 | - /** |
|
| 235 | - * Executes a query and caches the result for a minute. |
|
| 236 | - * |
|
| 237 | - * |
|
| 238 | - * @param string $query_type |
|
| 239 | - * @param string $query |
|
| 240 | - * @return mixed depending on query_type |
|
| 241 | - */ |
|
| 242 | - public static function execute( $query_type, $query ) { |
|
| 243 | - global $wpdb; |
|
| 244 | - |
|
| 245 | - $query_hash = md5( $query_type . $query ); |
|
| 246 | - $result = self::get_cached_query( $query_hash ); |
|
| 247 | - if ( $result === false ) { |
|
| 248 | - self::enable_big_selects(); |
|
| 249 | - |
|
| 250 | - $result = $wpdb->$query_type( $query ); |
|
| 251 | - self::set_cached_query( $query_hash, $result ); |
|
| 252 | - } |
|
| 253 | - |
|
| 254 | - return $result; |
|
| 255 | - |
|
| 256 | - } |
|
| 257 | - |
|
| 258 | - /** |
|
| 259 | - * Enables big mysql selects for reports, just once for this session. |
|
| 260 | - */ |
|
| 261 | - protected static function enable_big_selects() { |
|
| 262 | - static $big_selects = false; |
|
| 263 | - |
|
| 264 | - global $wpdb; |
|
| 265 | - |
|
| 266 | - if ( ! $big_selects ) { |
|
| 267 | - $wpdb->query( 'SET SESSION SQL_BIG_SELECTS=1' ); |
|
| 268 | - $big_selects = true; |
|
| 269 | - } |
|
| 270 | - } |
|
| 271 | - |
|
| 272 | - /** |
|
| 273 | - * Get the cached query result or null if it's not in the cache. |
|
| 274 | - * |
|
| 275 | - * @param string $query_hash The query hash. |
|
| 276 | - * |
|
| 277 | - * @return mixed|false The cache contents on success, false on failure to retrieve contents. |
|
| 278 | - */ |
|
| 279 | - protected static function get_cached_query( $query_hash ) { |
|
| 280 | - |
|
| 281 | - return wp_cache_get( |
|
| 282 | - $query_hash, |
|
| 283 | - strtolower( __CLASS__ ) |
|
| 284 | - ); |
|
| 285 | - |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * Set the cached query result. |
|
| 290 | - * |
|
| 291 | - * @param string $query_hash The query hash. |
|
| 292 | - * @param mixed $data The data to cache. |
|
| 293 | - */ |
|
| 294 | - protected static function set_cached_query( $query_hash, $data ) { |
|
| 295 | - |
|
| 296 | - wp_cache_set( |
|
| 297 | - $query_hash, |
|
| 298 | - $data, |
|
| 299 | - strtolower( __CLASS__ ), |
|
| 300 | - MINUTE_IN_SECONDS |
|
| 301 | - ); |
|
| 302 | - |
|
| 303 | - } |
|
| 93 | + if ( strtolower( $value['operator'] ) == 'in' || strtolower( $value['operator'] ) == 'not in' ) { |
|
| 94 | + |
|
| 95 | + if ( is_array( $value['value'] ) ) { |
|
| 96 | + $value['value'] = implode( "','", $value['value'] ); |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + if ( ! empty( $value['value'] ) ) { |
|
| 100 | + $where_value = "{$value['operator']} ('{$value['value']}')"; |
|
| 101 | + } |
|
| 102 | + } else { |
|
| 103 | + $where_value = "{$value['operator']} '{$value['value']}'"; |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + if ( ! empty( $where_value ) ) { |
|
| 107 | + $query['where'] .= " AND {$value['key']} {$where_value}"; |
|
| 108 | + } |
|
| 109 | + } |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + if ( $group_by ) { |
|
| 113 | + $query['group_by'] = "GROUP BY {$group_by}"; |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + if ( $order_by ) { |
|
| 117 | + $query['order_by'] = "ORDER BY {$order_by}"; |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + if ( $limit ) { |
|
| 121 | + $query['limit'] = "LIMIT {$limit}"; |
|
| 122 | + } |
|
| 123 | + |
|
| 124 | + $query = apply_filters( 'getpaid_reports_get_invoice_report_query', $query, $data ); |
|
| 125 | + $query = implode( ' ', $query ); |
|
| 126 | + |
|
| 127 | + return self::execute( $query_type, $query ); |
|
| 128 | + |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + /** |
|
| 132 | + * Prepares the data to select. |
|
| 133 | + * |
|
| 134 | + * |
|
| 135 | + * @param array $data |
|
| 136 | + * @return array |
|
| 137 | + */ |
|
| 138 | + public static function prepare_invoice_data( $data ) { |
|
| 139 | + |
|
| 140 | + $prepared = array(); |
|
| 141 | + |
|
| 142 | + foreach ( $data as $raw_key => $value ) { |
|
| 143 | + $key = sanitize_key( $raw_key ); |
|
| 144 | + $distinct = ''; |
|
| 145 | + |
|
| 146 | + if ( isset( $value['distinct'] ) ) { |
|
| 147 | + $distinct = 'DISTINCT'; |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + $get_key = self::get_invoice_table_key( $key, $value['type'] ); |
|
| 151 | + |
|
| 152 | + if ( false === $get_key ) { |
|
| 153 | + // Skip to the next foreach iteration else the query will be invalid. |
|
| 154 | + continue; |
|
| 155 | + } |
|
| 156 | + |
|
| 157 | + if ( ! empty( $value['function'] ) ) { |
|
| 158 | + $get = "{$value['function']}({$distinct} {$get_key})"; |
|
| 159 | + } else { |
|
| 160 | + $get = "{$distinct} {$get_key}"; |
|
| 161 | + } |
|
| 162 | + |
|
| 163 | + $prepared[] = "{$get} as {$value['name']}"; |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + return $prepared; |
|
| 167 | + |
|
| 168 | + } |
|
| 169 | + |
|
| 170 | + /** |
|
| 171 | + * Prepares the joins to use. |
|
| 172 | + * |
|
| 173 | + * |
|
| 174 | + * @param array $data |
|
| 175 | + * @param bool $with_parent |
|
| 176 | + * @return array |
|
| 177 | + */ |
|
| 178 | + public static function prepare_invoice_joins( $data, $with_parent ) { |
|
| 179 | + global $wpdb; |
|
| 180 | + |
|
| 181 | + $prepared = array(); |
|
| 182 | + |
|
| 183 | + foreach ( $data as $raw_key => $value ) { |
|
| 184 | + $join_type = isset( $value['join_type'] ) ? $value['join_type'] : 'INNER'; |
|
| 185 | + $type = isset( $value['type'] ) ? $value['type'] : false; |
|
| 186 | + $key = sanitize_key( $raw_key ); |
|
| 187 | + |
|
| 188 | + switch ( $type ) { |
|
| 189 | + case 'meta': |
|
| 190 | + $prepared[ "meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS meta_{$key} ON ( posts.ID = meta_{$key}.post_id AND meta_{$key}.meta_key = '{$raw_key}' )"; |
|
| 191 | + break; |
|
| 192 | + case 'parent_meta': |
|
| 193 | + $prepared[ "parent_meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS parent_meta_{$key} ON (posts.post_parent = parent_meta_{$key}.post_id) AND (parent_meta_{$key}.meta_key = '{$raw_key}')"; |
|
| 194 | + break; |
|
| 195 | + case 'invoice_data': |
|
| 196 | + $prepared['invoices'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoices AS invoices ON posts.ID = invoices.post_id"; |
|
| 197 | + break; |
|
| 198 | + case 'invoice_item': |
|
| 199 | + $prepared['invoice_items'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoice_items AS invoice_items ON posts.ID = invoice_items.post_id"; |
|
| 200 | + break; |
|
| 201 | + } |
|
| 202 | + } |
|
| 203 | + |
|
| 204 | + if ( $with_parent ) { |
|
| 205 | + $prepared['parent'] = "LEFT JOIN {$wpdb->posts} AS parent ON posts.post_parent = parent.ID"; |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + return $prepared; |
|
| 209 | + |
|
| 210 | + } |
|
| 211 | + |
|
| 212 | + /** |
|
| 213 | + * Retrieves the appropriate table key to use. |
|
| 214 | + * |
|
| 215 | + * |
|
| 216 | + * @param string $key |
|
| 217 | + * @param string $table |
|
| 218 | + * @return string|false |
|
| 219 | + */ |
|
| 220 | + public static function get_invoice_table_key( $key, $table ) { |
|
| 221 | + |
|
| 222 | + $keys = array( |
|
| 223 | + 'meta' => "meta_{$key}.meta_value", |
|
| 224 | + 'parent_meta' => "parent_meta_{$key}.meta_value", |
|
| 225 | + 'post_data' => "posts.{$key}", |
|
| 226 | + 'invoice_data' => "invoices.{$key}", |
|
| 227 | + 'invoice_item' => "invoice_items.{$key}", |
|
| 228 | + ); |
|
| 229 | + |
|
| 230 | + return isset( $keys[ $table ] ) ? $keys[ $table ] : false; |
|
| 231 | + |
|
| 232 | + } |
|
| 233 | + |
|
| 234 | + /** |
|
| 235 | + * Executes a query and caches the result for a minute. |
|
| 236 | + * |
|
| 237 | + * |
|
| 238 | + * @param string $query_type |
|
| 239 | + * @param string $query |
|
| 240 | + * @return mixed depending on query_type |
|
| 241 | + */ |
|
| 242 | + public static function execute( $query_type, $query ) { |
|
| 243 | + global $wpdb; |
|
| 244 | + |
|
| 245 | + $query_hash = md5( $query_type . $query ); |
|
| 246 | + $result = self::get_cached_query( $query_hash ); |
|
| 247 | + if ( $result === false ) { |
|
| 248 | + self::enable_big_selects(); |
|
| 249 | + |
|
| 250 | + $result = $wpdb->$query_type( $query ); |
|
| 251 | + self::set_cached_query( $query_hash, $result ); |
|
| 252 | + } |
|
| 253 | + |
|
| 254 | + return $result; |
|
| 255 | + |
|
| 256 | + } |
|
| 257 | + |
|
| 258 | + /** |
|
| 259 | + * Enables big mysql selects for reports, just once for this session. |
|
| 260 | + */ |
|
| 261 | + protected static function enable_big_selects() { |
|
| 262 | + static $big_selects = false; |
|
| 263 | + |
|
| 264 | + global $wpdb; |
|
| 265 | + |
|
| 266 | + if ( ! $big_selects ) { |
|
| 267 | + $wpdb->query( 'SET SESSION SQL_BIG_SELECTS=1' ); |
|
| 268 | + $big_selects = true; |
|
| 269 | + } |
|
| 270 | + } |
|
| 271 | + |
|
| 272 | + /** |
|
| 273 | + * Get the cached query result or null if it's not in the cache. |
|
| 274 | + * |
|
| 275 | + * @param string $query_hash The query hash. |
|
| 276 | + * |
|
| 277 | + * @return mixed|false The cache contents on success, false on failure to retrieve contents. |
|
| 278 | + */ |
|
| 279 | + protected static function get_cached_query( $query_hash ) { |
|
| 280 | + |
|
| 281 | + return wp_cache_get( |
|
| 282 | + $query_hash, |
|
| 283 | + strtolower( __CLASS__ ) |
|
| 284 | + ); |
|
| 285 | + |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * Set the cached query result. |
|
| 290 | + * |
|
| 291 | + * @param string $query_hash The query hash. |
|
| 292 | + * @param mixed $data The data to cache. |
|
| 293 | + */ |
|
| 294 | + protected static function set_cached_query( $query_hash, $data ) { |
|
| 295 | + |
|
| 296 | + wp_cache_set( |
|
| 297 | + $query_hash, |
|
| 298 | + $data, |
|
| 299 | + strtolower( __CLASS__ ), |
|
| 300 | + MINUTE_IN_SECONDS |
|
| 301 | + ); |
|
| 302 | + |
|
| 303 | + } |
|
| 304 | 304 | |
| 305 | 305 | } |
@@ -37,14 +37,14 @@ discard block |
||
| 37 | 37 | 'advanced' => false |
| 38 | 38 | ), |
| 39 | 39 | 'id' => array( |
| 40 | - 'title' => __( 'Invoice', 'invoicing' ), |
|
| 41 | - 'desc' => __( 'Enter the invoice ID', 'invoicing' ), |
|
| 42 | - 'type' => 'text', |
|
| 43 | - 'desc_tip' => true, |
|
| 44 | - 'default' => '', |
|
| 45 | - 'placeholder' => __('1','invoicing'), |
|
| 46 | - 'advanced' => false |
|
| 47 | - ), |
|
| 40 | + 'title' => __( 'Invoice', 'invoicing' ), |
|
| 41 | + 'desc' => __( 'Enter the invoice ID', 'invoicing' ), |
|
| 42 | + 'type' => 'text', |
|
| 43 | + 'desc_tip' => true, |
|
| 44 | + 'default' => '', |
|
| 45 | + 'placeholder' => __('1','invoicing'), |
|
| 46 | + 'advanced' => false |
|
| 47 | + ), |
|
| 48 | 48 | ) |
| 49 | 49 | |
| 50 | 50 | ); |
@@ -53,26 +53,26 @@ discard block |
||
| 53 | 53 | parent::__construct( $options ); |
| 54 | 54 | } |
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * The Super block output function. |
|
| 58 | - * |
|
| 59 | - * @param array $args |
|
| 60 | - * @param array $widget_args |
|
| 61 | - * @param string $content |
|
| 62 | - * |
|
| 63 | - * @return mixed|string|bool |
|
| 64 | - */ |
|
| 56 | + /** |
|
| 57 | + * The Super block output function. |
|
| 58 | + * |
|
| 59 | + * @param array $args |
|
| 60 | + * @param array $widget_args |
|
| 61 | + * @param string $content |
|
| 62 | + * |
|
| 63 | + * @return mixed|string|bool |
|
| 64 | + */ |
|
| 65 | 65 | public function output( $args = array(), $widget_args = array(), $content = '' ) { |
| 66 | 66 | |
| 67 | 67 | // Is the shortcode set up correctly? |
| 68 | - if ( empty( $args['id'] ) ) { |
|
| 69 | - return aui()->alert( |
|
| 70 | - array( |
|
| 71 | - 'type' => 'warning', |
|
| 72 | - 'content' => __( 'Missing invoice ID', 'invoicing' ), |
|
| 73 | - ) |
|
| 74 | - ); |
|
| 75 | - } |
|
| 68 | + if ( empty( $args['id'] ) ) { |
|
| 69 | + return aui()->alert( |
|
| 70 | + array( |
|
| 71 | + 'type' => 'warning', |
|
| 72 | + 'content' => __( 'Missing invoice ID', 'invoicing' ), |
|
| 73 | + ) |
|
| 74 | + ); |
|
| 75 | + } |
|
| 76 | 76 | |
| 77 | 77 | $invoice = wpinv_get_invoice( (int) $args['id'] ); |
| 78 | 78 | |
@@ -14,621 +14,621 @@ |
||
| 14 | 14 | */ |
| 15 | 15 | class WPInv_Plugin { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * GetPaid version. |
|
| 19 | - * |
|
| 20 | - * @var string |
|
| 21 | - */ |
|
| 22 | - public $version; |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * Data container. |
|
| 26 | - * |
|
| 27 | - * @var array |
|
| 28 | - */ |
|
| 29 | - protected $data = array(); |
|
| 30 | - |
|
| 31 | - /** |
|
| 32 | - * Form elements instance. |
|
| 33 | - * |
|
| 34 | - * @var WPInv_Payment_Form_Elements |
|
| 35 | - */ |
|
| 36 | - public $form_elements; |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * @var array An array of payment gateways. |
|
| 40 | - */ |
|
| 41 | - public $gateways; |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * Class constructor. |
|
| 45 | - */ |
|
| 46 | - public function __construct() { |
|
| 47 | - $this->define_constants(); |
|
| 48 | - $this->includes(); |
|
| 49 | - $this->init_hooks(); |
|
| 50 | - $this->set_properties(); |
|
| 51 | - } |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * Sets a custom data property. |
|
| 55 | - * |
|
| 56 | - * @param string $prop The prop to set. |
|
| 57 | - * @param mixed $value The value to retrieve. |
|
| 58 | - */ |
|
| 59 | - public function set( $prop, $value ) { |
|
| 60 | - $this->data[ $prop ] = $value; |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Gets a custom data property. |
|
| 65 | - * |
|
| 66 | - * @param string $prop The prop to set. |
|
| 67 | - * @return mixed The value. |
|
| 68 | - */ |
|
| 69 | - public function get( $prop ) { |
|
| 70 | - |
|
| 71 | - if ( isset( $this->data[ $prop ] ) ) { |
|
| 72 | - return $this->data[ $prop ]; |
|
| 73 | - } |
|
| 74 | - |
|
| 75 | - return null; |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * Define class properties. |
|
| 80 | - */ |
|
| 81 | - public function set_properties() { |
|
| 82 | - |
|
| 83 | - // Sessions. |
|
| 84 | - $this->set( 'session', new WPInv_Session_Handler() ); |
|
| 85 | - $GLOBALS['wpi_session'] = $this->get( 'session' ); // Backwards compatibility. |
|
| 86 | - $GLOBALS['wpinv_euvat'] = new WPInv_EUVat(); // Backwards compatibility. |
|
| 87 | - |
|
| 88 | - // Init other objects. |
|
| 89 | - $this->set( 'session', new WPInv_Session_Handler() ); |
|
| 90 | - $this->set( 'notes', new WPInv_Notes() ); |
|
| 91 | - $this->set( 'api', new WPInv_API() ); |
|
| 92 | - $this->set( 'post_types', new GetPaid_Post_Types() ); |
|
| 93 | - $this->set( 'template', new GetPaid_Template() ); |
|
| 94 | - $this->set( 'admin', new GetPaid_Admin() ); |
|
| 95 | - $this->set( 'subscriptions', new WPInv_Subscriptions() ); |
|
| 96 | - $this->set( 'invoice_emails', new GetPaid_Invoice_Notification_Emails() ); |
|
| 97 | - $this->set( 'subscription_emails', new GetPaid_Subscription_Notification_Emails() ); |
|
| 98 | - $this->set( 'daily_maintenace', new GetPaid_Daily_Maintenance() ); |
|
| 99 | - $this->set( 'payment_forms', new GetPaid_Payment_Forms() ); |
|
| 100 | - $this->set( 'maxmind', new GetPaid_MaxMind_Geolocation() ); |
|
| 101 | - |
|
| 102 | - } |
|
| 103 | - |
|
| 104 | - /** |
|
| 105 | - * Define plugin constants. |
|
| 106 | - */ |
|
| 107 | - public function define_constants() { |
|
| 108 | - define( 'WPINV_PLUGIN_DIR', plugin_dir_path( WPINV_PLUGIN_FILE ) ); |
|
| 109 | - define( 'WPINV_PLUGIN_URL', plugin_dir_url( WPINV_PLUGIN_FILE ) ); |
|
| 110 | - $this->version = WPINV_VERSION; |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * Hook into actions and filters. |
|
| 115 | - * |
|
| 116 | - * @since 1.0.19 |
|
| 117 | - */ |
|
| 118 | - protected function init_hooks() { |
|
| 119 | - /* Internationalize the text strings used. */ |
|
| 120 | - add_action( 'plugins_loaded', array( &$this, 'plugins_loaded' ) ); |
|
| 121 | - |
|
| 122 | - // Init the plugin after WordPress inits. |
|
| 123 | - add_action( 'init', array( $this, 'init' ), 1 ); |
|
| 124 | - add_action( 'init', array( $this, 'maybe_process_ipn' ), 10 ); |
|
| 125 | - add_action( 'init', array( $this, 'wpinv_actions' ) ); |
|
| 126 | - add_action( 'init', array( $this, 'maybe_do_authenticated_action' ), 100 ); |
|
| 127 | - add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ), 11 ); |
|
| 128 | - add_action( 'wp_footer', array( $this, 'wp_footer' ) ); |
|
| 129 | - add_action( 'wp_head', array( $this, 'wp_head' ) ); |
|
| 130 | - add_action( 'widgets_init', array( $this, 'register_widgets' ) ); |
|
| 131 | - add_filter( 'wpseo_exclude_from_sitemap_by_post_ids', array( $this, 'wpseo_exclude_from_sitemap_by_post_ids' ) ); |
|
| 132 | - add_filter( 'pre_get_posts', array( &$this, 'pre_get_posts' ) ); |
|
| 133 | - |
|
| 134 | - add_filter( 'query_vars', array( $this, 'custom_query_vars' ) ); |
|
| 17 | + /** |
|
| 18 | + * GetPaid version. |
|
| 19 | + * |
|
| 20 | + * @var string |
|
| 21 | + */ |
|
| 22 | + public $version; |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * Data container. |
|
| 26 | + * |
|
| 27 | + * @var array |
|
| 28 | + */ |
|
| 29 | + protected $data = array(); |
|
| 30 | + |
|
| 31 | + /** |
|
| 32 | + * Form elements instance. |
|
| 33 | + * |
|
| 34 | + * @var WPInv_Payment_Form_Elements |
|
| 35 | + */ |
|
| 36 | + public $form_elements; |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * @var array An array of payment gateways. |
|
| 40 | + */ |
|
| 41 | + public $gateways; |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * Class constructor. |
|
| 45 | + */ |
|
| 46 | + public function __construct() { |
|
| 47 | + $this->define_constants(); |
|
| 48 | + $this->includes(); |
|
| 49 | + $this->init_hooks(); |
|
| 50 | + $this->set_properties(); |
|
| 51 | + } |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * Sets a custom data property. |
|
| 55 | + * |
|
| 56 | + * @param string $prop The prop to set. |
|
| 57 | + * @param mixed $value The value to retrieve. |
|
| 58 | + */ |
|
| 59 | + public function set( $prop, $value ) { |
|
| 60 | + $this->data[ $prop ] = $value; |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Gets a custom data property. |
|
| 65 | + * |
|
| 66 | + * @param string $prop The prop to set. |
|
| 67 | + * @return mixed The value. |
|
| 68 | + */ |
|
| 69 | + public function get( $prop ) { |
|
| 70 | + |
|
| 71 | + if ( isset( $this->data[ $prop ] ) ) { |
|
| 72 | + return $this->data[ $prop ]; |
|
| 73 | + } |
|
| 74 | + |
|
| 75 | + return null; |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * Define class properties. |
|
| 80 | + */ |
|
| 81 | + public function set_properties() { |
|
| 82 | + |
|
| 83 | + // Sessions. |
|
| 84 | + $this->set( 'session', new WPInv_Session_Handler() ); |
|
| 85 | + $GLOBALS['wpi_session'] = $this->get( 'session' ); // Backwards compatibility. |
|
| 86 | + $GLOBALS['wpinv_euvat'] = new WPInv_EUVat(); // Backwards compatibility. |
|
| 87 | + |
|
| 88 | + // Init other objects. |
|
| 89 | + $this->set( 'session', new WPInv_Session_Handler() ); |
|
| 90 | + $this->set( 'notes', new WPInv_Notes() ); |
|
| 91 | + $this->set( 'api', new WPInv_API() ); |
|
| 92 | + $this->set( 'post_types', new GetPaid_Post_Types() ); |
|
| 93 | + $this->set( 'template', new GetPaid_Template() ); |
|
| 94 | + $this->set( 'admin', new GetPaid_Admin() ); |
|
| 95 | + $this->set( 'subscriptions', new WPInv_Subscriptions() ); |
|
| 96 | + $this->set( 'invoice_emails', new GetPaid_Invoice_Notification_Emails() ); |
|
| 97 | + $this->set( 'subscription_emails', new GetPaid_Subscription_Notification_Emails() ); |
|
| 98 | + $this->set( 'daily_maintenace', new GetPaid_Daily_Maintenance() ); |
|
| 99 | + $this->set( 'payment_forms', new GetPaid_Payment_Forms() ); |
|
| 100 | + $this->set( 'maxmind', new GetPaid_MaxMind_Geolocation() ); |
|
| 101 | + |
|
| 102 | + } |
|
| 103 | + |
|
| 104 | + /** |
|
| 105 | + * Define plugin constants. |
|
| 106 | + */ |
|
| 107 | + public function define_constants() { |
|
| 108 | + define( 'WPINV_PLUGIN_DIR', plugin_dir_path( WPINV_PLUGIN_FILE ) ); |
|
| 109 | + define( 'WPINV_PLUGIN_URL', plugin_dir_url( WPINV_PLUGIN_FILE ) ); |
|
| 110 | + $this->version = WPINV_VERSION; |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * Hook into actions and filters. |
|
| 115 | + * |
|
| 116 | + * @since 1.0.19 |
|
| 117 | + */ |
|
| 118 | + protected function init_hooks() { |
|
| 119 | + /* Internationalize the text strings used. */ |
|
| 120 | + add_action( 'plugins_loaded', array( &$this, 'plugins_loaded' ) ); |
|
| 121 | + |
|
| 122 | + // Init the plugin after WordPress inits. |
|
| 123 | + add_action( 'init', array( $this, 'init' ), 1 ); |
|
| 124 | + add_action( 'init', array( $this, 'maybe_process_ipn' ), 10 ); |
|
| 125 | + add_action( 'init', array( $this, 'wpinv_actions' ) ); |
|
| 126 | + add_action( 'init', array( $this, 'maybe_do_authenticated_action' ), 100 ); |
|
| 127 | + add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ), 11 ); |
|
| 128 | + add_action( 'wp_footer', array( $this, 'wp_footer' ) ); |
|
| 129 | + add_action( 'wp_head', array( $this, 'wp_head' ) ); |
|
| 130 | + add_action( 'widgets_init', array( $this, 'register_widgets' ) ); |
|
| 131 | + add_filter( 'wpseo_exclude_from_sitemap_by_post_ids', array( $this, 'wpseo_exclude_from_sitemap_by_post_ids' ) ); |
|
| 132 | + add_filter( 'pre_get_posts', array( &$this, 'pre_get_posts' ) ); |
|
| 133 | + |
|
| 134 | + add_filter( 'query_vars', array( $this, 'custom_query_vars' ) ); |
|
| 135 | 135 | add_action( 'init', array( $this, 'add_rewrite_rule' ), 10, 0 ); |
| 136 | - add_action( 'pre_get_posts', array( $this, 'maybe_process_new_ipn' ), 1 ); |
|
| 137 | - |
|
| 138 | - // Fires after registering actions. |
|
| 139 | - do_action( 'wpinv_actions', $this ); |
|
| 140 | - do_action( 'getpaid_actions', $this ); |
|
| 141 | - |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - public function plugins_loaded() { |
|
| 145 | - /* Internationalize the text strings used. */ |
|
| 146 | - $this->load_textdomain(); |
|
| 147 | - |
|
| 148 | - do_action( 'wpinv_loaded' ); |
|
| 149 | - |
|
| 150 | - // Fix oxygen page builder conflict |
|
| 151 | - if ( function_exists( 'ct_css_output' ) ) { |
|
| 152 | - wpinv_oxygen_fix_conflict(); |
|
| 153 | - } |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * Load Localisation files. |
|
| 158 | - * |
|
| 159 | - * Note: the first-loaded translation file overrides any following ones if the same translation is present. |
|
| 160 | - * |
|
| 161 | - * Locales found in: |
|
| 162 | - * - WP_LANG_DIR/plugins/invoicing-LOCALE.mo |
|
| 163 | - * - WP_PLUGIN_DIR/invoicing/languages/invoicing-LOCALE.mo |
|
| 164 | - * |
|
| 165 | - * @since 1.0.0 |
|
| 166 | - */ |
|
| 167 | - public function load_textdomain() { |
|
| 168 | - |
|
| 169 | - load_plugin_textdomain( |
|
| 170 | - 'invoicing', |
|
| 171 | - false, |
|
| 172 | - plugin_basename( dirname( WPINV_PLUGIN_FILE ) ) . '/languages/' |
|
| 173 | - ); |
|
| 174 | - |
|
| 175 | - } |
|
| 176 | - |
|
| 177 | - /** |
|
| 178 | - * Include required core files used in admin and on the frontend. |
|
| 179 | - */ |
|
| 180 | - public function includes() { |
|
| 181 | - |
|
| 182 | - // Start with the settings. |
|
| 183 | - require_once( WPINV_PLUGIN_DIR . 'includes/admin/register-settings.php' ); |
|
| 184 | - |
|
| 185 | - // Packages/libraries. |
|
| 186 | - require_once( WPINV_PLUGIN_DIR . 'vendor/autoload.php' ); |
|
| 187 | - require_once( WPINV_PLUGIN_DIR . 'vendor/ayecode/wp-ayecode-ui/ayecode-ui-loader.php' ); |
|
| 188 | - |
|
| 189 | - // Load functions. |
|
| 190 | - require_once( WPINV_PLUGIN_DIR . 'includes/deprecated-functions.php' ); |
|
| 191 | - require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-email-functions.php' ); |
|
| 192 | - require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-general-functions.php' ); |
|
| 193 | - require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-helper-functions.php' ); |
|
| 194 | - require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-tax-functions.php' ); |
|
| 195 | - require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-template-functions.php' ); |
|
| 196 | - require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-address-functions.php' ); |
|
| 197 | - require_once( WPINV_PLUGIN_DIR . 'includes/invoice-functions.php' ); |
|
| 198 | - require_once( WPINV_PLUGIN_DIR . 'includes/subscription-functions.php' ); |
|
| 199 | - require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-item-functions.php' ); |
|
| 200 | - require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-discount-functions.php' ); |
|
| 201 | - require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-gateway-functions.php' ); |
|
| 202 | - require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-payment-functions.php' ); |
|
| 203 | - require_once( WPINV_PLUGIN_DIR . 'includes/user-functions.php' ); |
|
| 204 | - require_once( WPINV_PLUGIN_DIR . 'includes/error-functions.php' ); |
|
| 205 | - |
|
| 206 | - // Register autoloader. |
|
| 207 | - try { |
|
| 208 | - spl_autoload_register( array( $this, 'autoload' ), true ); |
|
| 209 | - } catch ( Exception $e ) { |
|
| 210 | - wpinv_error_log( $e->getMessage(), '', __FILE__, 149, true ); |
|
| 211 | - } |
|
| 212 | - |
|
| 213 | - require_once( WPINV_PLUGIN_DIR . 'includes/abstracts/abstract-wpinv-session.php' ); |
|
| 214 | - require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-session-handler.php' ); |
|
| 215 | - require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-ajax.php' ); |
|
| 216 | - require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-api.php' ); |
|
| 217 | - require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-cache-helper.php' ); |
|
| 218 | - require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-db.php' ); |
|
| 219 | - require_once( WPINV_PLUGIN_DIR . 'includes/admin/subscriptions.php' ); |
|
| 220 | - require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-subscriptions-db.php' ); |
|
| 221 | - require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-subscription.php' ); |
|
| 222 | - require_once( WPINV_PLUGIN_DIR . 'includes/abstracts/abstract-wpinv-privacy.php' ); |
|
| 223 | - require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-privacy.php' ); |
|
| 224 | - require_once( WPINV_PLUGIN_DIR . 'includes/libraries/class-ayecode-addons.php' ); |
|
| 225 | - require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-addons.php' ); |
|
| 226 | - require_once( WPINV_PLUGIN_DIR . 'widgets/checkout.php' ); |
|
| 227 | - require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-history.php' ); |
|
| 228 | - require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-receipt.php' ); |
|
| 229 | - require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-messages.php' ); |
|
| 230 | - require_once( WPINV_PLUGIN_DIR . 'widgets/subscriptions.php' ); |
|
| 231 | - require_once( WPINV_PLUGIN_DIR . 'widgets/buy-item.php' ); |
|
| 232 | - require_once( WPINV_PLUGIN_DIR . 'widgets/getpaid.php' ); |
|
| 233 | - require_once( WPINV_PLUGIN_DIR . 'widgets/invoice.php' ); |
|
| 234 | - require_once( WPINV_PLUGIN_DIR . 'includes/admin/admin-pages.php' ); |
|
| 235 | - |
|
| 236 | - if ( is_admin() || ( defined( 'WP_CLI' ) && WP_CLI ) ) { |
|
| 237 | - GetPaid_Post_Types_Admin::init(); |
|
| 238 | - |
|
| 239 | - require_once( WPINV_PLUGIN_DIR . 'includes/admin/wpinv-admin-functions.php' ); |
|
| 240 | - require_once( WPINV_PLUGIN_DIR . 'includes/admin/meta-boxes/class-mb-payment-form.php' ); |
|
| 241 | - require_once( WPINV_PLUGIN_DIR . 'includes/admin/meta-boxes/class-mb-invoice-notes.php' ); |
|
| 242 | - require_once( WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-admin-menus.php' ); |
|
| 243 | - require_once( WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-users.php' ); |
|
| 244 | - require_once( WPINV_PLUGIN_DIR . 'includes/admin/class-getpaid-admin-profile.php' ); |
|
| 245 | - // load the user class only on the users.php page |
|
| 246 | - global $pagenow; |
|
| 247 | - if($pagenow=='users.php'){ |
|
| 248 | - new WPInv_Admin_Users(); |
|
| 249 | - } |
|
| 250 | - } |
|
| 251 | - |
|
| 252 | - // Register cli commands |
|
| 253 | - if ( defined( 'WP_CLI' ) && WP_CLI ) { |
|
| 254 | - require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-cli.php' ); |
|
| 255 | - WP_CLI::add_command( 'invoicing', 'WPInv_CLI' ); |
|
| 256 | - } |
|
| 257 | - |
|
| 258 | - } |
|
| 259 | - |
|
| 260 | - /** |
|
| 261 | - * Class autoloader |
|
| 262 | - * |
|
| 263 | - * @param string $class_name The name of the class to load. |
|
| 264 | - * @access public |
|
| 265 | - * @since 1.0.19 |
|
| 266 | - * @return void |
|
| 267 | - */ |
|
| 268 | - public function autoload( $class_name ) { |
|
| 269 | - |
|
| 270 | - // Normalize the class name... |
|
| 271 | - $class_name = strtolower( $class_name ); |
|
| 272 | - |
|
| 273 | - // ... and make sure it is our class. |
|
| 274 | - if ( false === strpos( $class_name, 'getpaid_' ) && false === strpos( $class_name, 'wpinv_' ) ) { |
|
| 275 | - return; |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - // Next, prepare the file name from the class. |
|
| 279 | - $file_name = 'class-' . str_replace( '_', '-', $class_name ) . '.php'; |
|
| 280 | - |
|
| 281 | - // Base path of the classes. |
|
| 282 | - $plugin_path = untrailingslashit( WPINV_PLUGIN_DIR ); |
|
| 283 | - |
|
| 284 | - // And an array of possible locations in order of importance. |
|
| 285 | - $locations = array( |
|
| 286 | - "$plugin_path/includes", |
|
| 287 | - "$plugin_path/includes/data-stores", |
|
| 288 | - "$plugin_path/includes/gateways", |
|
| 289 | - "$plugin_path/includes/payments", |
|
| 290 | - "$plugin_path/includes/geolocation", |
|
| 291 | - "$plugin_path/includes/reports", |
|
| 292 | - "$plugin_path/includes/api", |
|
| 293 | - "$plugin_path/includes/admin", |
|
| 294 | - "$plugin_path/includes/admin/meta-boxes", |
|
| 295 | - ); |
|
| 296 | - |
|
| 297 | - foreach ( apply_filters( 'getpaid_autoload_locations', $locations ) as $location ) { |
|
| 298 | - |
|
| 299 | - if ( file_exists( trailingslashit( $location ) . $file_name ) ) { |
|
| 300 | - include trailingslashit( $location ) . $file_name; |
|
| 301 | - break; |
|
| 302 | - } |
|
| 303 | - |
|
| 304 | - } |
|
| 305 | - |
|
| 306 | - } |
|
| 307 | - |
|
| 308 | - /** |
|
| 309 | - * Inits hooks etc. |
|
| 310 | - */ |
|
| 311 | - public function init() { |
|
| 312 | - |
|
| 313 | - // Fires before getpaid inits. |
|
| 314 | - do_action( 'before_getpaid_init', $this ); |
|
| 315 | - |
|
| 316 | - // Maybe upgrade. |
|
| 317 | - $this->maybe_upgrade_database(); |
|
| 318 | - |
|
| 319 | - // Load default gateways. |
|
| 320 | - $gateways = apply_filters( |
|
| 321 | - 'getpaid_default_gateways', |
|
| 322 | - array( |
|
| 323 | - 'manual' => 'GetPaid_Manual_Gateway', |
|
| 324 | - 'paypal' => 'GetPaid_Paypal_Gateway', |
|
| 325 | - 'worldpay' => 'GetPaid_Worldpay_Gateway', |
|
| 326 | - 'bank_transfer' => 'GetPaid_Bank_Transfer_Gateway', |
|
| 327 | - 'authorizenet' => 'GetPaid_Authorize_Net_Gateway', |
|
| 328 | - ) |
|
| 329 | - ); |
|
| 330 | - |
|
| 331 | - foreach ( $gateways as $id => $class ) { |
|
| 332 | - $this->gateways[ $id ] = new $class(); |
|
| 333 | - } |
|
| 334 | - |
|
| 335 | - if ( 'yes' != get_option( 'wpinv_renamed_gateways' ) ) { |
|
| 336 | - GetPaid_Installer::rename_gateways_label(); |
|
| 337 | - update_option( 'wpinv_renamed_gateways', 'yes' ); |
|
| 338 | - } |
|
| 339 | - |
|
| 340 | - // Fires after getpaid inits. |
|
| 341 | - do_action( 'getpaid_init', $this ); |
|
| 342 | - |
|
| 343 | - } |
|
| 344 | - |
|
| 345 | - /** |
|
| 346 | - * Checks if this is an IPN request and processes it. |
|
| 347 | - */ |
|
| 348 | - public function maybe_process_ipn() { |
|
| 349 | - |
|
| 350 | - // Ensure that this is an IPN request. |
|
| 351 | - if ( empty( $_GET['wpi-listener'] ) || 'IPN' !== $_GET['wpi-listener'] || empty( $_GET['wpi-gateway'] ) ) { |
|
| 352 | - return; |
|
| 353 | - } |
|
| 354 | - |
|
| 355 | - $gateway = wpinv_clean( $_GET['wpi-gateway'] ); |
|
| 356 | - |
|
| 357 | - do_action( 'wpinv_verify_payment_ipn', $gateway ); |
|
| 358 | - do_action( "wpinv_verify_{$gateway}_ipn" ); |
|
| 359 | - exit; |
|
| 360 | - |
|
| 361 | - } |
|
| 362 | - |
|
| 363 | - public function enqueue_scripts() { |
|
| 364 | - |
|
| 365 | - // Fires before adding scripts. |
|
| 366 | - do_action( 'getpaid_enqueue_scripts' ); |
|
| 367 | - |
|
| 368 | - $localize = array(); |
|
| 369 | - $localize['ajax_url'] = admin_url( 'admin-ajax.php' ); |
|
| 370 | - $localize['thousands'] = wpinv_thousands_separator(); |
|
| 371 | - $localize['decimals'] = wpinv_decimal_separator(); |
|
| 372 | - $localize['nonce'] = wp_create_nonce( 'wpinv-nonce' ); |
|
| 373 | - $localize['txtComplete'] = __( 'Continue', 'invoicing' ); |
|
| 374 | - $localize['UseTaxes'] = wpinv_use_taxes(); |
|
| 375 | - $localize['formNonce'] = wp_create_nonce( 'getpaid_form_nonce' ); |
|
| 376 | - $localize['loading'] = __( 'Loading...', 'invoicing' ); |
|
| 377 | - $localize['connectionError'] = __( 'Could not establish a connection to the server.', 'invoicing' ); |
|
| 378 | - |
|
| 379 | - $localize = apply_filters( 'wpinv_front_js_localize', $localize ); |
|
| 380 | - |
|
| 381 | - $version = filemtime( WPINV_PLUGIN_DIR . 'assets/js/payment-forms.js' ); |
|
| 382 | - wp_enqueue_script( 'wpinv-front-script', WPINV_PLUGIN_URL . 'assets/js/payment-forms.js', array( 'jquery' ), $version, true ); |
|
| 383 | - wp_localize_script( 'wpinv-front-script', 'WPInv', $localize ); |
|
| 384 | - } |
|
| 385 | - |
|
| 386 | - public function wpinv_actions() { |
|
| 387 | - if ( isset( $_REQUEST['wpi_action'] ) ) { |
|
| 388 | - do_action( 'wpinv_' . wpinv_sanitize_key( $_REQUEST['wpi_action'] ), $_REQUEST ); |
|
| 389 | - } |
|
| 390 | - |
|
| 391 | - if ( defined( 'WP_ALL_IMPORT_ROOT_DIR' ) ) { |
|
| 392 | - include plugin_dir_path( __FILE__ ) . 'libraries/wp-all-import/class-getpaid-wp-all-import.php'; |
|
| 393 | - } |
|
| 394 | - } |
|
| 136 | + add_action( 'pre_get_posts', array( $this, 'maybe_process_new_ipn' ), 1 ); |
|
| 137 | + |
|
| 138 | + // Fires after registering actions. |
|
| 139 | + do_action( 'wpinv_actions', $this ); |
|
| 140 | + do_action( 'getpaid_actions', $this ); |
|
| 141 | + |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + public function plugins_loaded() { |
|
| 145 | + /* Internationalize the text strings used. */ |
|
| 146 | + $this->load_textdomain(); |
|
| 147 | + |
|
| 148 | + do_action( 'wpinv_loaded' ); |
|
| 149 | + |
|
| 150 | + // Fix oxygen page builder conflict |
|
| 151 | + if ( function_exists( 'ct_css_output' ) ) { |
|
| 152 | + wpinv_oxygen_fix_conflict(); |
|
| 153 | + } |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * Load Localisation files. |
|
| 158 | + * |
|
| 159 | + * Note: the first-loaded translation file overrides any following ones if the same translation is present. |
|
| 160 | + * |
|
| 161 | + * Locales found in: |
|
| 162 | + * - WP_LANG_DIR/plugins/invoicing-LOCALE.mo |
|
| 163 | + * - WP_PLUGIN_DIR/invoicing/languages/invoicing-LOCALE.mo |
|
| 164 | + * |
|
| 165 | + * @since 1.0.0 |
|
| 166 | + */ |
|
| 167 | + public function load_textdomain() { |
|
| 168 | + |
|
| 169 | + load_plugin_textdomain( |
|
| 170 | + 'invoicing', |
|
| 171 | + false, |
|
| 172 | + plugin_basename( dirname( WPINV_PLUGIN_FILE ) ) . '/languages/' |
|
| 173 | + ); |
|
| 174 | + |
|
| 175 | + } |
|
| 176 | + |
|
| 177 | + /** |
|
| 178 | + * Include required core files used in admin and on the frontend. |
|
| 179 | + */ |
|
| 180 | + public function includes() { |
|
| 181 | + |
|
| 182 | + // Start with the settings. |
|
| 183 | + require_once( WPINV_PLUGIN_DIR . 'includes/admin/register-settings.php' ); |
|
| 184 | + |
|
| 185 | + // Packages/libraries. |
|
| 186 | + require_once( WPINV_PLUGIN_DIR . 'vendor/autoload.php' ); |
|
| 187 | + require_once( WPINV_PLUGIN_DIR . 'vendor/ayecode/wp-ayecode-ui/ayecode-ui-loader.php' ); |
|
| 188 | + |
|
| 189 | + // Load functions. |
|
| 190 | + require_once( WPINV_PLUGIN_DIR . 'includes/deprecated-functions.php' ); |
|
| 191 | + require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-email-functions.php' ); |
|
| 192 | + require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-general-functions.php' ); |
|
| 193 | + require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-helper-functions.php' ); |
|
| 194 | + require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-tax-functions.php' ); |
|
| 195 | + require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-template-functions.php' ); |
|
| 196 | + require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-address-functions.php' ); |
|
| 197 | + require_once( WPINV_PLUGIN_DIR . 'includes/invoice-functions.php' ); |
|
| 198 | + require_once( WPINV_PLUGIN_DIR . 'includes/subscription-functions.php' ); |
|
| 199 | + require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-item-functions.php' ); |
|
| 200 | + require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-discount-functions.php' ); |
|
| 201 | + require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-gateway-functions.php' ); |
|
| 202 | + require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-payment-functions.php' ); |
|
| 203 | + require_once( WPINV_PLUGIN_DIR . 'includes/user-functions.php' ); |
|
| 204 | + require_once( WPINV_PLUGIN_DIR . 'includes/error-functions.php' ); |
|
| 205 | + |
|
| 206 | + // Register autoloader. |
|
| 207 | + try { |
|
| 208 | + spl_autoload_register( array( $this, 'autoload' ), true ); |
|
| 209 | + } catch ( Exception $e ) { |
|
| 210 | + wpinv_error_log( $e->getMessage(), '', __FILE__, 149, true ); |
|
| 211 | + } |
|
| 212 | + |
|
| 213 | + require_once( WPINV_PLUGIN_DIR . 'includes/abstracts/abstract-wpinv-session.php' ); |
|
| 214 | + require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-session-handler.php' ); |
|
| 215 | + require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-ajax.php' ); |
|
| 216 | + require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-api.php' ); |
|
| 217 | + require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-cache-helper.php' ); |
|
| 218 | + require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-db.php' ); |
|
| 219 | + require_once( WPINV_PLUGIN_DIR . 'includes/admin/subscriptions.php' ); |
|
| 220 | + require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-subscriptions-db.php' ); |
|
| 221 | + require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-subscription.php' ); |
|
| 222 | + require_once( WPINV_PLUGIN_DIR . 'includes/abstracts/abstract-wpinv-privacy.php' ); |
|
| 223 | + require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-privacy.php' ); |
|
| 224 | + require_once( WPINV_PLUGIN_DIR . 'includes/libraries/class-ayecode-addons.php' ); |
|
| 225 | + require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-addons.php' ); |
|
| 226 | + require_once( WPINV_PLUGIN_DIR . 'widgets/checkout.php' ); |
|
| 227 | + require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-history.php' ); |
|
| 228 | + require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-receipt.php' ); |
|
| 229 | + require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-messages.php' ); |
|
| 230 | + require_once( WPINV_PLUGIN_DIR . 'widgets/subscriptions.php' ); |
|
| 231 | + require_once( WPINV_PLUGIN_DIR . 'widgets/buy-item.php' ); |
|
| 232 | + require_once( WPINV_PLUGIN_DIR . 'widgets/getpaid.php' ); |
|
| 233 | + require_once( WPINV_PLUGIN_DIR . 'widgets/invoice.php' ); |
|
| 234 | + require_once( WPINV_PLUGIN_DIR . 'includes/admin/admin-pages.php' ); |
|
| 235 | + |
|
| 236 | + if ( is_admin() || ( defined( 'WP_CLI' ) && WP_CLI ) ) { |
|
| 237 | + GetPaid_Post_Types_Admin::init(); |
|
| 238 | + |
|
| 239 | + require_once( WPINV_PLUGIN_DIR . 'includes/admin/wpinv-admin-functions.php' ); |
|
| 240 | + require_once( WPINV_PLUGIN_DIR . 'includes/admin/meta-boxes/class-mb-payment-form.php' ); |
|
| 241 | + require_once( WPINV_PLUGIN_DIR . 'includes/admin/meta-boxes/class-mb-invoice-notes.php' ); |
|
| 242 | + require_once( WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-admin-menus.php' ); |
|
| 243 | + require_once( WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-users.php' ); |
|
| 244 | + require_once( WPINV_PLUGIN_DIR . 'includes/admin/class-getpaid-admin-profile.php' ); |
|
| 245 | + // load the user class only on the users.php page |
|
| 246 | + global $pagenow; |
|
| 247 | + if($pagenow=='users.php'){ |
|
| 248 | + new WPInv_Admin_Users(); |
|
| 249 | + } |
|
| 250 | + } |
|
| 251 | + |
|
| 252 | + // Register cli commands |
|
| 253 | + if ( defined( 'WP_CLI' ) && WP_CLI ) { |
|
| 254 | + require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-cli.php' ); |
|
| 255 | + WP_CLI::add_command( 'invoicing', 'WPInv_CLI' ); |
|
| 256 | + } |
|
| 257 | + |
|
| 258 | + } |
|
| 259 | + |
|
| 260 | + /** |
|
| 261 | + * Class autoloader |
|
| 262 | + * |
|
| 263 | + * @param string $class_name The name of the class to load. |
|
| 264 | + * @access public |
|
| 265 | + * @since 1.0.19 |
|
| 266 | + * @return void |
|
| 267 | + */ |
|
| 268 | + public function autoload( $class_name ) { |
|
| 269 | + |
|
| 270 | + // Normalize the class name... |
|
| 271 | + $class_name = strtolower( $class_name ); |
|
| 272 | + |
|
| 273 | + // ... and make sure it is our class. |
|
| 274 | + if ( false === strpos( $class_name, 'getpaid_' ) && false === strpos( $class_name, 'wpinv_' ) ) { |
|
| 275 | + return; |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + // Next, prepare the file name from the class. |
|
| 279 | + $file_name = 'class-' . str_replace( '_', '-', $class_name ) . '.php'; |
|
| 280 | + |
|
| 281 | + // Base path of the classes. |
|
| 282 | + $plugin_path = untrailingslashit( WPINV_PLUGIN_DIR ); |
|
| 283 | + |
|
| 284 | + // And an array of possible locations in order of importance. |
|
| 285 | + $locations = array( |
|
| 286 | + "$plugin_path/includes", |
|
| 287 | + "$plugin_path/includes/data-stores", |
|
| 288 | + "$plugin_path/includes/gateways", |
|
| 289 | + "$plugin_path/includes/payments", |
|
| 290 | + "$plugin_path/includes/geolocation", |
|
| 291 | + "$plugin_path/includes/reports", |
|
| 292 | + "$plugin_path/includes/api", |
|
| 293 | + "$plugin_path/includes/admin", |
|
| 294 | + "$plugin_path/includes/admin/meta-boxes", |
|
| 295 | + ); |
|
| 296 | + |
|
| 297 | + foreach ( apply_filters( 'getpaid_autoload_locations', $locations ) as $location ) { |
|
| 298 | + |
|
| 299 | + if ( file_exists( trailingslashit( $location ) . $file_name ) ) { |
|
| 300 | + include trailingslashit( $location ) . $file_name; |
|
| 301 | + break; |
|
| 302 | + } |
|
| 303 | + |
|
| 304 | + } |
|
| 305 | + |
|
| 306 | + } |
|
| 307 | + |
|
| 308 | + /** |
|
| 309 | + * Inits hooks etc. |
|
| 310 | + */ |
|
| 311 | + public function init() { |
|
| 312 | + |
|
| 313 | + // Fires before getpaid inits. |
|
| 314 | + do_action( 'before_getpaid_init', $this ); |
|
| 315 | + |
|
| 316 | + // Maybe upgrade. |
|
| 317 | + $this->maybe_upgrade_database(); |
|
| 318 | + |
|
| 319 | + // Load default gateways. |
|
| 320 | + $gateways = apply_filters( |
|
| 321 | + 'getpaid_default_gateways', |
|
| 322 | + array( |
|
| 323 | + 'manual' => 'GetPaid_Manual_Gateway', |
|
| 324 | + 'paypal' => 'GetPaid_Paypal_Gateway', |
|
| 325 | + 'worldpay' => 'GetPaid_Worldpay_Gateway', |
|
| 326 | + 'bank_transfer' => 'GetPaid_Bank_Transfer_Gateway', |
|
| 327 | + 'authorizenet' => 'GetPaid_Authorize_Net_Gateway', |
|
| 328 | + ) |
|
| 329 | + ); |
|
| 330 | + |
|
| 331 | + foreach ( $gateways as $id => $class ) { |
|
| 332 | + $this->gateways[ $id ] = new $class(); |
|
| 333 | + } |
|
| 334 | + |
|
| 335 | + if ( 'yes' != get_option( 'wpinv_renamed_gateways' ) ) { |
|
| 336 | + GetPaid_Installer::rename_gateways_label(); |
|
| 337 | + update_option( 'wpinv_renamed_gateways', 'yes' ); |
|
| 338 | + } |
|
| 339 | + |
|
| 340 | + // Fires after getpaid inits. |
|
| 341 | + do_action( 'getpaid_init', $this ); |
|
| 342 | + |
|
| 343 | + } |
|
| 395 | 344 | |
| 396 | - /** |
|
| 345 | + /** |
|
| 346 | + * Checks if this is an IPN request and processes it. |
|
| 347 | + */ |
|
| 348 | + public function maybe_process_ipn() { |
|
| 349 | + |
|
| 350 | + // Ensure that this is an IPN request. |
|
| 351 | + if ( empty( $_GET['wpi-listener'] ) || 'IPN' !== $_GET['wpi-listener'] || empty( $_GET['wpi-gateway'] ) ) { |
|
| 352 | + return; |
|
| 353 | + } |
|
| 354 | + |
|
| 355 | + $gateway = wpinv_clean( $_GET['wpi-gateway'] ); |
|
| 356 | + |
|
| 357 | + do_action( 'wpinv_verify_payment_ipn', $gateway ); |
|
| 358 | + do_action( "wpinv_verify_{$gateway}_ipn" ); |
|
| 359 | + exit; |
|
| 360 | + |
|
| 361 | + } |
|
| 362 | + |
|
| 363 | + public function enqueue_scripts() { |
|
| 364 | + |
|
| 365 | + // Fires before adding scripts. |
|
| 366 | + do_action( 'getpaid_enqueue_scripts' ); |
|
| 367 | + |
|
| 368 | + $localize = array(); |
|
| 369 | + $localize['ajax_url'] = admin_url( 'admin-ajax.php' ); |
|
| 370 | + $localize['thousands'] = wpinv_thousands_separator(); |
|
| 371 | + $localize['decimals'] = wpinv_decimal_separator(); |
|
| 372 | + $localize['nonce'] = wp_create_nonce( 'wpinv-nonce' ); |
|
| 373 | + $localize['txtComplete'] = __( 'Continue', 'invoicing' ); |
|
| 374 | + $localize['UseTaxes'] = wpinv_use_taxes(); |
|
| 375 | + $localize['formNonce'] = wp_create_nonce( 'getpaid_form_nonce' ); |
|
| 376 | + $localize['loading'] = __( 'Loading...', 'invoicing' ); |
|
| 377 | + $localize['connectionError'] = __( 'Could not establish a connection to the server.', 'invoicing' ); |
|
| 378 | + |
|
| 379 | + $localize = apply_filters( 'wpinv_front_js_localize', $localize ); |
|
| 380 | + |
|
| 381 | + $version = filemtime( WPINV_PLUGIN_DIR . 'assets/js/payment-forms.js' ); |
|
| 382 | + wp_enqueue_script( 'wpinv-front-script', WPINV_PLUGIN_URL . 'assets/js/payment-forms.js', array( 'jquery' ), $version, true ); |
|
| 383 | + wp_localize_script( 'wpinv-front-script', 'WPInv', $localize ); |
|
| 384 | + } |
|
| 385 | + |
|
| 386 | + public function wpinv_actions() { |
|
| 387 | + if ( isset( $_REQUEST['wpi_action'] ) ) { |
|
| 388 | + do_action( 'wpinv_' . wpinv_sanitize_key( $_REQUEST['wpi_action'] ), $_REQUEST ); |
|
| 389 | + } |
|
| 390 | + |
|
| 391 | + if ( defined( 'WP_ALL_IMPORT_ROOT_DIR' ) ) { |
|
| 392 | + include plugin_dir_path( __FILE__ ) . 'libraries/wp-all-import/class-getpaid-wp-all-import.php'; |
|
| 393 | + } |
|
| 394 | + } |
|
| 395 | + |
|
| 396 | + /** |
|
| 397 | 397 | * Fires an action after verifying that a user can fire them. |
| 398 | - * |
|
| 399 | - * Note: If the action is on an invoice, subscription etc, esure that the |
|
| 400 | - * current user owns the invoice/subscription. |
|
| 398 | + * |
|
| 399 | + * Note: If the action is on an invoice, subscription etc, esure that the |
|
| 400 | + * current user owns the invoice/subscription. |
|
| 401 | 401 | */ |
| 402 | 402 | public function maybe_do_authenticated_action() { |
| 403 | 403 | |
| 404 | - if ( isset( $_REQUEST['getpaid-action'] ) && isset( $_REQUEST['getpaid-nonce'] ) && wp_verify_nonce( $_REQUEST['getpaid-nonce'], 'getpaid-nonce' ) ) { |
|
| 404 | + if ( isset( $_REQUEST['getpaid-action'] ) && isset( $_REQUEST['getpaid-nonce'] ) && wp_verify_nonce( $_REQUEST['getpaid-nonce'], 'getpaid-nonce' ) ) { |
|
| 405 | + |
|
| 406 | + $key = sanitize_key( $_REQUEST['getpaid-action'] ); |
|
| 407 | + $data = wp_unslash( $_REQUEST ); |
|
| 408 | + if ( is_user_logged_in() ) { |
|
| 409 | + do_action( "getpaid_authenticated_action_$key", $data ); |
|
| 410 | + } |
|
| 411 | + |
|
| 412 | + do_action( "getpaid_unauthenticated_action_$key", $data ); |
|
| 413 | + |
|
| 414 | + } |
|
| 415 | + |
|
| 416 | + } |
|
| 417 | + |
|
| 418 | + public function pre_get_posts( $wp_query ) { |
|
| 419 | + |
|
| 420 | + if ( ! is_admin() && ! empty( $wp_query->query_vars['post_type'] ) && getpaid_is_invoice_post_type( $wp_query->query_vars['post_type'] ) && is_user_logged_in() && is_single() && $wp_query->is_main_query() ) { |
|
| 421 | + $wp_query->query_vars['post_status'] = array_keys( wpinv_get_invoice_statuses( false, false, $wp_query->query_vars['post_type'] ) ); |
|
| 422 | + } |
|
| 423 | + |
|
| 424 | + return $wp_query; |
|
| 425 | + } |
|
| 426 | + |
|
| 427 | + /** |
|
| 428 | + * Register widgets |
|
| 429 | + * |
|
| 430 | + */ |
|
| 431 | + public function register_widgets() { |
|
| 432 | + global $pagenow; |
|
| 433 | + |
|
| 434 | + // Currently, UX Builder does not work particulaly well with SuperDuper. |
|
| 435 | + // So we disable our widgets when editing a page with UX Builder. |
|
| 436 | + if ( function_exists( 'ux_builder_is_active' ) && ux_builder_is_active() ) { |
|
| 437 | + return; |
|
| 438 | + } |
|
| 439 | + |
|
| 440 | + $block_widget_init_screens = function_exists('sd_pagenow_exclude') ? sd_pagenow_exclude() : array(); |
|
| 441 | + |
|
| 442 | + if ( is_admin() && $pagenow && in_array($pagenow, $block_widget_init_screens)) { |
|
| 443 | + // don't initiate in these conditions. |
|
| 444 | + }else{ |
|
| 445 | + |
|
| 446 | + // Only load allowed widgets. |
|
| 447 | + $exclude = function_exists( 'sd_widget_exclude' ) ? sd_widget_exclude() : array(); |
|
| 448 | + $widgets = apply_filters( |
|
| 449 | + 'getpaid_widget_classes', |
|
| 450 | + array( |
|
| 451 | + 'WPInv_Checkout_Widget', |
|
| 452 | + 'WPInv_History_Widget', |
|
| 453 | + 'WPInv_Receipt_Widget', |
|
| 454 | + 'WPInv_Subscriptions_Widget', |
|
| 455 | + 'WPInv_Buy_Item_Widget', |
|
| 456 | + 'WPInv_Messages_Widget', |
|
| 457 | + 'WPInv_GetPaid_Widget', |
|
| 458 | + 'WPInv_Invoice_Widget' |
|
| 459 | + ) |
|
| 460 | + ); |
|
| 461 | + |
|
| 462 | + // For each widget... |
|
| 463 | + foreach ( $widgets as $widget ) { |
|
| 464 | + |
|
| 465 | + // Abort early if it is excluded for this page. |
|
| 466 | + if ( in_array( $widget, $exclude ) ) { |
|
| 467 | + continue; |
|
| 468 | + } |
|
| 469 | + |
|
| 470 | + // SD V1 used to extend the widget class. V2 does not, so we cannot call register widget on it. |
|
| 471 | + if ( is_subclass_of( $widget, 'WP_Widget' ) ) { |
|
| 472 | + register_widget( $widget ); |
|
| 473 | + } else { |
|
| 474 | + new $widget(); |
|
| 475 | + } |
|
| 476 | + |
|
| 477 | + } |
|
| 478 | + |
|
| 479 | + } |
|
| 480 | + |
|
| 481 | + } |
|
| 482 | + |
|
| 483 | + /** |
|
| 484 | + * Upgrades the database. |
|
| 485 | + * |
|
| 486 | + * @since 2.0.2 |
|
| 487 | + */ |
|
| 488 | + public function maybe_upgrade_database() { |
|
| 489 | + |
|
| 490 | + $wpi_version = get_option( 'wpinv_version', 0 ); |
|
| 491 | + |
|
| 492 | + if ( $wpi_version == WPINV_VERSION ) { |
|
| 493 | + return; |
|
| 494 | + } |
|
| 495 | + |
|
| 496 | + $installer = new GetPaid_Installer(); |
|
| 497 | + |
|
| 498 | + if ( empty( $wpi_version ) ) { |
|
| 499 | + return $installer->upgrade_db( 0 ); |
|
| 500 | + } |
|
| 501 | + |
|
| 502 | + $upgrades = array( |
|
| 503 | + '0.0.5' => '004', |
|
| 504 | + '1.0.3' => '102', |
|
| 505 | + '2.0.0' => '118', |
|
| 506 | + '2.0.8' => '207', |
|
| 507 | + ); |
|
| 508 | + |
|
| 509 | + foreach ( $upgrades as $key => $method ) { |
|
| 510 | + |
|
| 511 | + if ( version_compare( $wpi_version, $key, '<' ) ) { |
|
| 512 | + return $installer->upgrade_db( $method ); |
|
| 513 | + } |
|
| 514 | + |
|
| 515 | + } |
|
| 405 | 516 | |
| 406 | - $key = sanitize_key( $_REQUEST['getpaid-action'] ); |
|
| 407 | - $data = wp_unslash( $_REQUEST ); |
|
| 408 | - if ( is_user_logged_in() ) { |
|
| 409 | - do_action( "getpaid_authenticated_action_$key", $data ); |
|
| 410 | - } |
|
| 517 | + } |
|
| 411 | 518 | |
| 412 | - do_action( "getpaid_unauthenticated_action_$key", $data ); |
|
| 519 | + /** |
|
| 520 | + * Flushes the permalinks if needed. |
|
| 521 | + * |
|
| 522 | + * @since 2.0.8 |
|
| 523 | + */ |
|
| 524 | + public function maybe_flush_permalinks() { |
|
| 413 | 525 | |
| 414 | - } |
|
| 526 | + $flush = get_option( 'wpinv_flush_permalinks', 0 ); |
|
| 527 | + |
|
| 528 | + if ( ! empty( $flush ) ) { |
|
| 529 | + flush_rewrite_rules(); |
|
| 530 | + delete_option( 'wpinv_flush_permalinks' ); |
|
| 531 | + } |
|
| 415 | 532 | |
| 416 | 533 | } |
| 417 | 534 | |
| 418 | - public function pre_get_posts( $wp_query ) { |
|
| 535 | + /** |
|
| 536 | + * Remove our pages from yoast sitemaps. |
|
| 537 | + * |
|
| 538 | + * @since 1.0.19 |
|
| 539 | + * @param int[] $excluded_posts_ids |
|
| 540 | + */ |
|
| 541 | + public function wpseo_exclude_from_sitemap_by_post_ids( $excluded_posts_ids ){ |
|
| 419 | 542 | |
| 420 | - if ( ! is_admin() && ! empty( $wp_query->query_vars['post_type'] ) && getpaid_is_invoice_post_type( $wp_query->query_vars['post_type'] ) && is_user_logged_in() && is_single() && $wp_query->is_main_query() ) { |
|
| 421 | - $wp_query->query_vars['post_status'] = array_keys( wpinv_get_invoice_statuses( false, false, $wp_query->query_vars['post_type'] ) ); |
|
| 422 | - } |
|
| 423 | - |
|
| 424 | - return $wp_query; |
|
| 425 | - } |
|
| 426 | - |
|
| 427 | - /** |
|
| 428 | - * Register widgets |
|
| 429 | - * |
|
| 430 | - */ |
|
| 431 | - public function register_widgets() { |
|
| 432 | - global $pagenow; |
|
| 433 | - |
|
| 434 | - // Currently, UX Builder does not work particulaly well with SuperDuper. |
|
| 435 | - // So we disable our widgets when editing a page with UX Builder. |
|
| 436 | - if ( function_exists( 'ux_builder_is_active' ) && ux_builder_is_active() ) { |
|
| 437 | - return; |
|
| 438 | - } |
|
| 439 | - |
|
| 440 | - $block_widget_init_screens = function_exists('sd_pagenow_exclude') ? sd_pagenow_exclude() : array(); |
|
| 441 | - |
|
| 442 | - if ( is_admin() && $pagenow && in_array($pagenow, $block_widget_init_screens)) { |
|
| 443 | - // don't initiate in these conditions. |
|
| 444 | - }else{ |
|
| 445 | - |
|
| 446 | - // Only load allowed widgets. |
|
| 447 | - $exclude = function_exists( 'sd_widget_exclude' ) ? sd_widget_exclude() : array(); |
|
| 448 | - $widgets = apply_filters( |
|
| 449 | - 'getpaid_widget_classes', |
|
| 450 | - array( |
|
| 451 | - 'WPInv_Checkout_Widget', |
|
| 452 | - 'WPInv_History_Widget', |
|
| 453 | - 'WPInv_Receipt_Widget', |
|
| 454 | - 'WPInv_Subscriptions_Widget', |
|
| 455 | - 'WPInv_Buy_Item_Widget', |
|
| 456 | - 'WPInv_Messages_Widget', |
|
| 457 | - 'WPInv_GetPaid_Widget', |
|
| 458 | - 'WPInv_Invoice_Widget' |
|
| 459 | - ) |
|
| 460 | - ); |
|
| 461 | - |
|
| 462 | - // For each widget... |
|
| 463 | - foreach ( $widgets as $widget ) { |
|
| 464 | - |
|
| 465 | - // Abort early if it is excluded for this page. |
|
| 466 | - if ( in_array( $widget, $exclude ) ) { |
|
| 467 | - continue; |
|
| 468 | - } |
|
| 543 | + // Ensure that we have an array. |
|
| 544 | + if ( ! is_array( $excluded_posts_ids ) ) { |
|
| 545 | + $excluded_posts_ids = array(); |
|
| 546 | + } |
|
| 469 | 547 | |
| 470 | - // SD V1 used to extend the widget class. V2 does not, so we cannot call register widget on it. |
|
| 471 | - if ( is_subclass_of( $widget, 'WP_Widget' ) ) { |
|
| 472 | - register_widget( $widget ); |
|
| 473 | - } else { |
|
| 474 | - new $widget(); |
|
| 475 | - } |
|
| 548 | + // Prepare our pages. |
|
| 549 | + $our_pages = array(); |
|
| 476 | 550 | |
| 477 | - } |
|
| 551 | + // Checkout page. |
|
| 552 | + $our_pages[] = wpinv_get_option( 'checkout_page', false ); |
|
| 478 | 553 | |
| 479 | - } |
|
| 480 | - |
|
| 481 | - } |
|
| 554 | + // Success page. |
|
| 555 | + $our_pages[] = wpinv_get_option( 'success_page', false ); |
|
| 482 | 556 | |
| 483 | - /** |
|
| 484 | - * Upgrades the database. |
|
| 485 | - * |
|
| 486 | - * @since 2.0.2 |
|
| 487 | - */ |
|
| 488 | - public function maybe_upgrade_database() { |
|
| 489 | - |
|
| 490 | - $wpi_version = get_option( 'wpinv_version', 0 ); |
|
| 491 | - |
|
| 492 | - if ( $wpi_version == WPINV_VERSION ) { |
|
| 493 | - return; |
|
| 494 | - } |
|
| 495 | - |
|
| 496 | - $installer = new GetPaid_Installer(); |
|
| 497 | - |
|
| 498 | - if ( empty( $wpi_version ) ) { |
|
| 499 | - return $installer->upgrade_db( 0 ); |
|
| 500 | - } |
|
| 501 | - |
|
| 502 | - $upgrades = array( |
|
| 503 | - '0.0.5' => '004', |
|
| 504 | - '1.0.3' => '102', |
|
| 505 | - '2.0.0' => '118', |
|
| 506 | - '2.0.8' => '207', |
|
| 507 | - ); |
|
| 508 | - |
|
| 509 | - foreach ( $upgrades as $key => $method ) { |
|
| 510 | - |
|
| 511 | - if ( version_compare( $wpi_version, $key, '<' ) ) { |
|
| 512 | - return $installer->upgrade_db( $method ); |
|
| 513 | - } |
|
| 514 | - |
|
| 515 | - } |
|
| 516 | - |
|
| 517 | - } |
|
| 518 | - |
|
| 519 | - /** |
|
| 520 | - * Flushes the permalinks if needed. |
|
| 521 | - * |
|
| 522 | - * @since 2.0.8 |
|
| 523 | - */ |
|
| 524 | - public function maybe_flush_permalinks() { |
|
| 525 | - |
|
| 526 | - $flush = get_option( 'wpinv_flush_permalinks', 0 ); |
|
| 527 | - |
|
| 528 | - if ( ! empty( $flush ) ) { |
|
| 529 | - flush_rewrite_rules(); |
|
| 530 | - delete_option( 'wpinv_flush_permalinks' ); |
|
| 531 | - } |
|
| 532 | - |
|
| 533 | - } |
|
| 534 | - |
|
| 535 | - /** |
|
| 536 | - * Remove our pages from yoast sitemaps. |
|
| 537 | - * |
|
| 538 | - * @since 1.0.19 |
|
| 539 | - * @param int[] $excluded_posts_ids |
|
| 540 | - */ |
|
| 541 | - public function wpseo_exclude_from_sitemap_by_post_ids( $excluded_posts_ids ){ |
|
| 542 | - |
|
| 543 | - // Ensure that we have an array. |
|
| 544 | - if ( ! is_array( $excluded_posts_ids ) ) { |
|
| 545 | - $excluded_posts_ids = array(); |
|
| 546 | - } |
|
| 547 | - |
|
| 548 | - // Prepare our pages. |
|
| 549 | - $our_pages = array(); |
|
| 550 | - |
|
| 551 | - // Checkout page. |
|
| 552 | - $our_pages[] = wpinv_get_option( 'checkout_page', false ); |
|
| 553 | - |
|
| 554 | - // Success page. |
|
| 555 | - $our_pages[] = wpinv_get_option( 'success_page', false ); |
|
| 556 | - |
|
| 557 | - // Failure page. |
|
| 558 | - $our_pages[] = wpinv_get_option( 'failure_page', false ); |
|
| 557 | + // Failure page. |
|
| 558 | + $our_pages[] = wpinv_get_option( 'failure_page', false ); |
|
| 559 | 559 | |
| 560 | - // History page. |
|
| 561 | - $our_pages[] = wpinv_get_option( 'invoice_history_page', false ); |
|
| 560 | + // History page. |
|
| 561 | + $our_pages[] = wpinv_get_option( 'invoice_history_page', false ); |
|
| 562 | 562 | |
| 563 | - // Subscriptions page. |
|
| 564 | - $our_pages[] = wpinv_get_option( 'invoice_subscription_page', false ); |
|
| 563 | + // Subscriptions page. |
|
| 564 | + $our_pages[] = wpinv_get_option( 'invoice_subscription_page', false ); |
|
| 565 | 565 | |
| 566 | - $our_pages = array_map( 'intval', array_filter( $our_pages ) ); |
|
| 566 | + $our_pages = array_map( 'intval', array_filter( $our_pages ) ); |
|
| 567 | 567 | |
| 568 | - $excluded_posts_ids = $excluded_posts_ids + $our_pages; |
|
| 569 | - return array_unique( $excluded_posts_ids ); |
|
| 568 | + $excluded_posts_ids = $excluded_posts_ids + $our_pages; |
|
| 569 | + return array_unique( $excluded_posts_ids ); |
|
| 570 | 570 | |
| 571 | - } |
|
| 571 | + } |
|
| 572 | 572 | |
| 573 | - /** |
|
| 574 | - * Displays additional footer code. |
|
| 575 | - * |
|
| 576 | - * @since 2.0.0 |
|
| 577 | - */ |
|
| 578 | - public function wp_footer() { |
|
| 579 | - wpinv_get_template( 'frontend-footer.php' ); |
|
| 580 | - } |
|
| 573 | + /** |
|
| 574 | + * Displays additional footer code. |
|
| 575 | + * |
|
| 576 | + * @since 2.0.0 |
|
| 577 | + */ |
|
| 578 | + public function wp_footer() { |
|
| 579 | + wpinv_get_template( 'frontend-footer.php' ); |
|
| 580 | + } |
|
| 581 | 581 | |
| 582 | - /** |
|
| 583 | - * Displays additional header code. |
|
| 584 | - * |
|
| 585 | - * @since 2.0.0 |
|
| 586 | - */ |
|
| 587 | - public function wp_head() { |
|
| 588 | - wpinv_get_template( 'frontend-head.php' ); |
|
| 589 | - } |
|
| 582 | + /** |
|
| 583 | + * Displays additional header code. |
|
| 584 | + * |
|
| 585 | + * @since 2.0.0 |
|
| 586 | + */ |
|
| 587 | + public function wp_head() { |
|
| 588 | + wpinv_get_template( 'frontend-head.php' ); |
|
| 589 | + } |
|
| 590 | 590 | |
| 591 | - /** |
|
| 592 | - * Custom query vars. |
|
| 593 | - * |
|
| 594 | - */ |
|
| 595 | - public function custom_query_vars( $vars ) { |
|
| 591 | + /** |
|
| 592 | + * Custom query vars. |
|
| 593 | + * |
|
| 594 | + */ |
|
| 595 | + public function custom_query_vars( $vars ) { |
|
| 596 | 596 | $vars[] = 'getpaid-ipn'; |
| 597 | 597 | return $vars; |
| 598 | - } |
|
| 598 | + } |
|
| 599 | 599 | |
| 600 | - /** |
|
| 601 | - * Add rewrite tags and rules. |
|
| 602 | - * |
|
| 603 | - */ |
|
| 604 | - public function add_rewrite_rule() { |
|
| 600 | + /** |
|
| 601 | + * Add rewrite tags and rules. |
|
| 602 | + * |
|
| 603 | + */ |
|
| 604 | + public function add_rewrite_rule() { |
|
| 605 | 605 | $tag = 'getpaid-ipn'; |
| 606 | 606 | add_rewrite_tag( "%$tag%", '([^&]+)' ); |
| 607 | 607 | add_rewrite_rule( "^$tag/([^/]*)/?", "index.php?$tag=\$matches[1]",'top' ); |
| 608 | - } |
|
| 608 | + } |
|
| 609 | 609 | |
| 610 | - /** |
|
| 611 | - * Processes non-query string ipns. |
|
| 612 | - * |
|
| 613 | - */ |
|
| 614 | - public function maybe_process_new_ipn( $query ) { |
|
| 610 | + /** |
|
| 611 | + * Processes non-query string ipns. |
|
| 612 | + * |
|
| 613 | + */ |
|
| 614 | + public function maybe_process_new_ipn( $query ) { |
|
| 615 | 615 | |
| 616 | 616 | if ( is_admin() || ! $query->is_main_query() ) { |
| 617 | 617 | return; |
| 618 | 618 | } |
| 619 | 619 | |
| 620 | - $gateway = get_query_var( 'getpaid-ipn' ); |
|
| 620 | + $gateway = get_query_var( 'getpaid-ipn' ); |
|
| 621 | 621 | |
| 622 | 622 | if ( ! empty( $gateway ) ){ |
| 623 | 623 | |
| 624 | - $gateway = sanitize_text_field( $gateway ); |
|
| 625 | - nocache_headers(); |
|
| 626 | - do_action( 'wpinv_verify_payment_ipn', $gateway ); |
|
| 627 | - do_action( "wpinv_verify_{$gateway}_ipn" ); |
|
| 628 | - exit; |
|
| 624 | + $gateway = sanitize_text_field( $gateway ); |
|
| 625 | + nocache_headers(); |
|
| 626 | + do_action( 'wpinv_verify_payment_ipn', $gateway ); |
|
| 627 | + do_action( "wpinv_verify_{$gateway}_ipn" ); |
|
| 628 | + exit; |
|
| 629 | 629 | |
| 630 | 630 | } |
| 631 | 631 | |
| 632 | - } |
|
| 632 | + } |
|
| 633 | 633 | |
| 634 | 634 | } |
