AyeCode /
invoicing
@@ -19,28 +19,28 @@ discard block |
||
| 19 | 19 | */ |
| 20 | 20 | function getpaid_get_customers( $args = array(), $return = 'results' ) { |
| 21 | 21 | |
| 22 | - // Do not retrieve all fields if we just want the count. |
|
| 23 | - if ( 'count' === $return ) { |
|
| 24 | - $args['fields'] = 'id'; |
|
| 25 | - $args['number'] = 1; |
|
| 26 | - } |
|
| 22 | + // Do not retrieve all fields if we just want the count. |
|
| 23 | + if ( 'count' === $return ) { |
|
| 24 | + $args['fields'] = 'id'; |
|
| 25 | + $args['number'] = 1; |
|
| 26 | + } |
|
| 27 | 27 | |
| 28 | - // Do not count all matches if we just want the results. |
|
| 29 | - if ( 'results' === $return ) { |
|
| 30 | - $args['count_total'] = false; |
|
| 31 | - } |
|
| 28 | + // Do not count all matches if we just want the results. |
|
| 29 | + if ( 'results' === $return ) { |
|
| 30 | + $args['count_total'] = false; |
|
| 31 | + } |
|
| 32 | 32 | |
| 33 | - $query = new GetPaid_Customers_Query( $args ); |
|
| 33 | + $query = new GetPaid_Customers_Query( $args ); |
|
| 34 | 34 | |
| 35 | - if ( 'results' === $return ) { |
|
| 36 | - return $query->get_results(); |
|
| 37 | - } |
|
| 35 | + if ( 'results' === $return ) { |
|
| 36 | + return $query->get_results(); |
|
| 37 | + } |
|
| 38 | 38 | |
| 39 | - if ( 'count' === $return ) { |
|
| 40 | - return $query->get_total(); |
|
| 41 | - } |
|
| 39 | + if ( 'count' === $return ) { |
|
| 40 | + return $query->get_total(); |
|
| 41 | + } |
|
| 42 | 42 | |
| 43 | - return $query; |
|
| 43 | + return $query; |
|
| 44 | 44 | } |
| 45 | 45 | |
| 46 | 46 | /** |
@@ -106,11 +106,11 @@ discard block |
||
| 106 | 106 | */ |
| 107 | 107 | function wpinv_get_capability( $capalibilty = 'manage_invoicing' ) { |
| 108 | 108 | |
| 109 | - if ( current_user_can( 'manage_options' ) ) { |
|
| 110 | - return 'manage_options'; |
|
| 111 | - }; |
|
| 109 | + if ( current_user_can( 'manage_options' ) ) { |
|
| 110 | + return 'manage_options'; |
|
| 111 | + }; |
|
| 112 | 112 | |
| 113 | - return $capalibilty; |
|
| 113 | + return $capalibilty; |
|
| 114 | 114 | } |
| 115 | 115 | |
| 116 | 116 | /** |
@@ -133,9 +133,9 @@ discard block |
||
| 133 | 133 | * @return bool Whether the current user has the given capability. |
| 134 | 134 | */ |
| 135 | 135 | function wpinv_current_user_can( $capability, $args = array() ) { |
| 136 | - $can = wpinv_current_user_can_manage_invoicing(); |
|
| 136 | + $can = wpinv_current_user_can_manage_invoicing(); |
|
| 137 | 137 | |
| 138 | - return apply_filters( 'getpaid_current_user_can', $can, $capability, $args ); |
|
| 138 | + return apply_filters( 'getpaid_current_user_can', $can, $capability, $args ); |
|
| 139 | 139 | } |
| 140 | 140 | |
| 141 | 141 | /** |
@@ -149,10 +149,10 @@ discard block |
||
| 149 | 149 | // Prepare user values. |
| 150 | 150 | $prefix = preg_replace( '/\s+/', '', $prefix ); |
| 151 | 151 | $prefix = empty( $prefix ) ? $email : $prefix; |
| 152 | - $args = array( |
|
| 153 | - 'user_login' => wpinv_generate_user_name( $prefix ), |
|
| 154 | - 'user_pass' => wp_generate_password(), |
|
| 155 | - 'user_email' => $email, |
|
| 152 | + $args = array( |
|
| 153 | + 'user_login' => wpinv_generate_user_name( $prefix ), |
|
| 154 | + 'user_pass' => wp_generate_password(), |
|
| 155 | + 'user_email' => $email, |
|
| 156 | 156 | 'role' => 'subscriber', |
| 157 | 157 | ); |
| 158 | 158 | |
@@ -169,16 +169,16 @@ discard block |
||
| 169 | 169 | function wpinv_generate_user_name( $prefix = '' ) { |
| 170 | 170 | |
| 171 | 171 | // If prefix is an email, retrieve the part before the email. |
| 172 | - $prefix = strtok( $prefix, '@' ); |
|
| 172 | + $prefix = strtok( $prefix, '@' ); |
|
| 173 | 173 | $prefix = trim( $prefix, '.' ); |
| 174 | 174 | |
| 175 | - // Sanitize the username. |
|
| 176 | - $prefix = sanitize_user( $prefix, true ); |
|
| 175 | + // Sanitize the username. |
|
| 176 | + $prefix = sanitize_user( $prefix, true ); |
|
| 177 | 177 | |
| 178 | - $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() ); |
|
| 179 | - if ( empty( $prefix ) || in_array( strtolower( $prefix ), array_map( 'strtolower', $illegal_logins ), true ) ) { |
|
| 180 | - $prefix = 'gtp_' . zeroise( wp_rand( 0, 9999 ), 4 ); |
|
| 181 | - } |
|
| 178 | + $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() ); |
|
| 179 | + if ( empty( $prefix ) || in_array( strtolower( $prefix ), array_map( 'strtolower', $illegal_logins ), true ) ) { |
|
| 180 | + $prefix = 'gtp_' . zeroise( wp_rand( 0, 9999 ), 4 ); |
|
| 181 | + } |
|
| 182 | 182 | |
| 183 | 183 | $username = $prefix; |
| 184 | 184 | $postfix = 2; |
@@ -317,43 +317,43 @@ discard block |
||
| 317 | 317 | |
| 318 | 318 | $value = $customer->get( $key ); |
| 319 | 319 | |
| 320 | - // Display the country. |
|
| 321 | - if ( 'country' == $key ) { |
|
| 322 | - |
|
| 323 | - aui()->select( |
|
| 324 | - array( |
|
| 325 | - 'options' => wpinv_get_country_list(), |
|
| 326 | - 'name' => 'getpaid_address[' . esc_attr( $key ) . ']', |
|
| 327 | - 'id' => 'wpinv-' . sanitize_html_class( $key ), |
|
| 328 | - 'value' => sanitize_text_field( $value ), |
|
| 329 | - 'placeholder' => $label, |
|
| 330 | - 'label' => wp_kses_post( $label ), |
|
| 331 | - 'label_type' => 'vertical', |
|
| 332 | - 'class' => 'getpaid-address-field', |
|
| 320 | + // Display the country. |
|
| 321 | + if ( 'country' == $key ) { |
|
| 322 | + |
|
| 323 | + aui()->select( |
|
| 324 | + array( |
|
| 325 | + 'options' => wpinv_get_country_list(), |
|
| 326 | + 'name' => 'getpaid_address[' . esc_attr( $key ) . ']', |
|
| 327 | + 'id' => 'wpinv-' . sanitize_html_class( $key ), |
|
| 328 | + 'value' => sanitize_text_field( $value ), |
|
| 329 | + 'placeholder' => $label, |
|
| 330 | + 'label' => wp_kses_post( $label ), |
|
| 331 | + 'label_type' => 'vertical', |
|
| 332 | + 'class' => 'getpaid-address-field', |
|
| 333 | 333 | ), |
| 334 | 334 | true |
| 335 | - ); |
|
| 335 | + ); |
|
| 336 | 336 | |
| 337 | - } |
|
| 337 | + } |
|
| 338 | 338 | |
| 339 | - // Display the state. |
|
| 340 | - elseif ( 'state' == $key ) { |
|
| 339 | + // Display the state. |
|
| 340 | + elseif ( 'state' == $key ) { |
|
| 341 | 341 | |
| 342 | - getpaid_get_states_select_markup( |
|
| 342 | + getpaid_get_states_select_markup( |
|
| 343 | 343 | $customer->get( 'country' ), |
| 344 | - $value, |
|
| 345 | - $label, |
|
| 346 | - $label, |
|
| 347 | - '', |
|
| 348 | - false, |
|
| 349 | - '', |
|
| 350 | - 'getpaid_address[' . esc_attr( $key ) . ']', |
|
| 344 | + $value, |
|
| 345 | + $label, |
|
| 346 | + $label, |
|
| 347 | + '', |
|
| 348 | + false, |
|
| 349 | + '', |
|
| 350 | + 'getpaid_address[' . esc_attr( $key ) . ']', |
|
| 351 | 351 | true |
| 352 | - ); |
|
| 352 | + ); |
|
| 353 | 353 | |
| 354 | 354 | } else { |
| 355 | 355 | |
| 356 | - aui()->input( |
|
| 356 | + aui()->input( |
|
| 357 | 357 | array( |
| 358 | 358 | 'name' => 'getpaid_address[' . esc_attr( $key ) . ']', |
| 359 | 359 | 'id' => 'wpinv-' . sanitize_html_class( $key ), |
@@ -365,7 +365,7 @@ discard block |
||
| 365 | 365 | 'class' => 'getpaid-address-field', |
| 366 | 366 | ), |
| 367 | 367 | true |
| 368 | - ); |
|
| 368 | + ); |
|
| 369 | 369 | |
| 370 | 370 | } |
| 371 | 371 | } |
@@ -509,7 +509,7 @@ discard block |
||
| 509 | 509 | function getpaid_allowed_html() { |
| 510 | 510 | $allowed_html = wp_kses_allowed_html( 'post' ); |
| 511 | 511 | |
| 512 | - // form fields |
|
| 512 | + // form fields |
|
| 513 | 513 | $allowed_html['form'] = array( |
| 514 | 514 | 'action' => true, |
| 515 | 515 | 'accept' => true, |
@@ -521,12 +521,12 @@ discard block |
||
| 521 | 521 | ); |
| 522 | 522 | |
| 523 | 523 | // - input |
| 524 | - $allowed_html['input'] = array( |
|
| 525 | - 'class' => array(), |
|
| 526 | - 'id' => array(), |
|
| 527 | - 'name' => array(), |
|
| 528 | - 'value' => array(), |
|
| 529 | - 'type' => array(), |
|
| 524 | + $allowed_html['input'] = array( |
|
| 525 | + 'class' => array(), |
|
| 526 | + 'id' => array(), |
|
| 527 | + 'name' => array(), |
|
| 528 | + 'value' => array(), |
|
| 529 | + 'type' => array(), |
|
| 530 | 530 | 'placeholder' => array(), |
| 531 | 531 | 'autocomplete' => array(), |
| 532 | 532 | 'autofocus' => array(), |
@@ -540,33 +540,33 @@ discard block |
||
| 540 | 540 | 'max' => array(), |
| 541 | 541 | 'step' => array(), |
| 542 | 542 | 'size' => array(), |
| 543 | - ); |
|
| 543 | + ); |
|
| 544 | 544 | |
| 545 | 545 | // - input |
| 546 | - $allowed_html['textarea'] = array( |
|
| 547 | - 'class' => array(), |
|
| 548 | - 'id' => array(), |
|
| 549 | - 'name' => array(), |
|
| 550 | - 'value' => array(), |
|
| 551 | - ); |
|
| 552 | - |
|
| 553 | - // select |
|
| 554 | - $allowed_html['select'] = array( |
|
| 555 | - 'class' => array(), |
|
| 556 | - 'id' => array(), |
|
| 557 | - 'name' => array(), |
|
| 546 | + $allowed_html['textarea'] = array( |
|
| 547 | + 'class' => array(), |
|
| 548 | + 'id' => array(), |
|
| 549 | + 'name' => array(), |
|
| 550 | + 'value' => array(), |
|
| 551 | + ); |
|
| 552 | + |
|
| 553 | + // select |
|
| 554 | + $allowed_html['select'] = array( |
|
| 555 | + 'class' => array(), |
|
| 556 | + 'id' => array(), |
|
| 557 | + 'name' => array(), |
|
| 558 | 558 | 'autocomplete' => array(), |
| 559 | 559 | 'multiple' => array(), |
| 560 | - ); |
|
| 560 | + ); |
|
| 561 | 561 | |
| 562 | - // select options |
|
| 563 | - $allowed_html['option'] = array( |
|
| 564 | - 'selected' => array(), |
|
| 562 | + // select options |
|
| 563 | + $allowed_html['option'] = array( |
|
| 564 | + 'selected' => array(), |
|
| 565 | 565 | 'disabled' => array(), |
| 566 | 566 | 'value' => array(), |
| 567 | - ); |
|
| 567 | + ); |
|
| 568 | 568 | |
| 569 | - return $allowed_html; |
|
| 569 | + return $allowed_html; |
|
| 570 | 570 | |
| 571 | 571 | } |
| 572 | 572 | |
@@ -16,469 +16,469 @@ |
||
| 16 | 16 | */ |
| 17 | 17 | class GetPaid_Customers_Query { |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * Query vars, after parsing |
|
| 21 | - * |
|
| 22 | - * @since 1.0.19 |
|
| 23 | - * @var array |
|
| 24 | - */ |
|
| 25 | - public $query_vars = array(); |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * List of found customers. |
|
| 29 | - * |
|
| 30 | - * @since 1.0.19 |
|
| 31 | - * @var array |
|
| 32 | - */ |
|
| 33 | - private $results; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * Total number of found customers for the current query |
|
| 37 | - * |
|
| 38 | - * @since 1.0.19 |
|
| 39 | - * @var int |
|
| 40 | - */ |
|
| 41 | - private $total_customers = 0; |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * The SQL query used to fetch matching customers. |
|
| 45 | - * |
|
| 46 | - * @since 1.0.19 |
|
| 47 | - * @var string |
|
| 48 | - */ |
|
| 49 | - public $request; |
|
| 50 | - |
|
| 51 | - // SQL clauses |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * Contains the 'FIELDS' sql clause |
|
| 55 | - * |
|
| 56 | - * @since 1.0.19 |
|
| 57 | - * @var string |
|
| 58 | - */ |
|
| 59 | - public $query_fields; |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * Contains the 'FROM' sql clause |
|
| 63 | - * |
|
| 64 | - * @since 1.0.19 |
|
| 65 | - * @var string |
|
| 66 | - */ |
|
| 67 | - public $query_from; |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * Contains the 'WHERE' sql clause |
|
| 71 | - * |
|
| 72 | - * @since 1.0.19 |
|
| 73 | - * @var string |
|
| 74 | - */ |
|
| 75 | - public $query_where; |
|
| 76 | - |
|
| 77 | - /** |
|
| 78 | - * Contains the 'ORDER BY' sql clause |
|
| 79 | - * |
|
| 80 | - * @since 1.0.19 |
|
| 81 | - * @var string |
|
| 82 | - */ |
|
| 83 | - public $query_orderby; |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Contains the 'LIMIT' sql clause |
|
| 87 | - * |
|
| 88 | - * @since 1.0.19 |
|
| 89 | - * @var string |
|
| 90 | - */ |
|
| 91 | - public $query_limit; |
|
| 92 | - |
|
| 93 | - /** |
|
| 94 | - * Class constructor. |
|
| 95 | - * |
|
| 96 | - * @since 1.0.19 |
|
| 97 | - * |
|
| 98 | - * @param null|string|array $query Optional. The query variables. |
|
| 99 | - */ |
|
| 100 | - public function __construct( $query = null ) { |
|
| 101 | - if ( ! is_null( $query ) ) { |
|
| 102 | - $this->prepare_query( $query ); |
|
| 103 | - $this->query(); |
|
| 104 | - } |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Fills in missing query variables with default values. |
|
| 109 | - * |
|
| 110 | - * @since 1.0.19 |
|
| 111 | - * |
|
| 112 | - * @param string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`. |
|
| 113 | - * @return array Complete query variables with undefined ones filled in with defaults. |
|
| 114 | - */ |
|
| 115 | - public static function fill_query_vars( $args ) { |
|
| 116 | - $defaults = array( |
|
| 117 | - 'include' => array(), |
|
| 118 | - 'exclude' => array(), |
|
| 119 | - 'orderby' => 'id', |
|
| 120 | - 'order' => 'DESC', |
|
| 121 | - 'offset' => '', |
|
| 122 | - 'number' => 10, |
|
| 123 | - 'paged' => 1, |
|
| 124 | - 'count_total' => true, |
|
| 125 | - 'fields' => 'all', |
|
| 126 | - ); |
|
| 127 | - |
|
| 128 | - foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) { |
|
| 129 | - $defaults[ $field ] = 'any'; |
|
| 130 | - |
|
| 131 | - if ( '%f' === $type || '%d' === $type ) { |
|
| 132 | - $defaults[ $field . '_min' ] = ''; |
|
| 133 | - $defaults[ $field . '_max' ] = ''; |
|
| 134 | - } |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - return wp_parse_args( $args, $defaults ); |
|
| 138 | - } |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * Prepare the query variables. |
|
| 142 | - * |
|
| 143 | - * @since 1.0.19 |
|
| 144 | - * |
|
| 145 | - * @see self::fill_query_vars() For allowede args and their defaults. |
|
| 146 | - */ |
|
| 147 | - public function prepare_query( $query = array() ) { |
|
| 148 | - global $wpdb; |
|
| 149 | - |
|
| 150 | - if ( empty( $this->query_vars ) || ! empty( $query ) ) { |
|
| 151 | - $this->query_limit = null; |
|
| 152 | - $this->query_vars = $this->fill_query_vars( $query ); |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) { |
|
| 156 | - $this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] ); |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - do_action( 'getpaid_pre_get_customers', array( &$this ) ); |
|
| 160 | - |
|
| 161 | - // Ensure that query vars are filled after 'getpaid_pre_get_customers'. |
|
| 162 | - $qv = & $this->query_vars; |
|
| 163 | - $qv = $this->fill_query_vars( $qv ); |
|
| 164 | - $table = $wpdb->prefix . 'getpaid_customers'; |
|
| 165 | - $this->query_from = "FROM $table"; |
|
| 166 | - |
|
| 167 | - // Prepare query fields. |
|
| 168 | - $this->prepare_query_fields( $qv, $table ); |
|
| 169 | - |
|
| 170 | - // Prepare query where. |
|
| 171 | - $this->prepare_query_where( $qv, $table ); |
|
| 172 | - |
|
| 173 | - // Prepare query order. |
|
| 174 | - $this->prepare_query_order( $qv, $table ); |
|
| 175 | - |
|
| 176 | - // limit |
|
| 177 | - if ( isset( $qv['number'] ) && $qv['number'] > 0 ) { |
|
| 178 | - if ( $qv['offset'] ) { |
|
| 179 | - $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] ); |
|
| 180 | - } else { |
|
| 181 | - $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] ); |
|
| 182 | - } |
|
| 183 | - } |
|
| 184 | - |
|
| 185 | - do_action_ref_array( 'getpaid_after_customers_query', array( &$this ) ); |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - /** |
|
| 189 | - * Prepares the query fields. |
|
| 190 | - * |
|
| 191 | - * @since 1.0.19 |
|
| 192 | - * |
|
| 193 | - * @param array $qv Query vars. |
|
| 194 | - * @param string $table Table name. |
|
| 195 | - */ |
|
| 196 | - protected function prepare_query_fields( &$qv, $table ) { |
|
| 197 | - |
|
| 198 | - if ( is_array( $qv['fields'] ) ) { |
|
| 199 | - $qv['fields'] = array_unique( $qv['fields'] ); |
|
| 200 | - $allowed_fields = array_keys( GetPaid_Customer_Data_Store::get_database_fields() ); |
|
| 201 | - |
|
| 202 | - $query_fields = array(); |
|
| 203 | - foreach ( $qv['fields'] as $field ) { |
|
| 204 | - if ( ! in_array( $field, $allowed_fields ) ) { |
|
| 205 | - continue; |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - $field = sanitize_key( $field ); |
|
| 209 | - $query_fields[] = "$table.`$field`"; |
|
| 210 | - } |
|
| 211 | - $this->query_fields = implode( ',', $query_fields ); |
|
| 212 | - } else { |
|
| 213 | - $this->query_fields = "$table.*"; |
|
| 214 | - } |
|
| 215 | - |
|
| 216 | - if ( isset( $qv['count_total'] ) && $qv['count_total'] ) { |
|
| 217 | - $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields; |
|
| 218 | - } |
|
| 219 | - |
|
| 220 | - } |
|
| 221 | - |
|
| 222 | - /** |
|
| 223 | - * Prepares the query where. |
|
| 224 | - * |
|
| 225 | - * @since 1.0.19 |
|
| 226 | - * |
|
| 227 | - * @param array $qv Query vars. |
|
| 228 | - * @param string $table Table name. |
|
| 229 | - */ |
|
| 230 | - protected function prepare_query_where( &$qv, $table ) { |
|
| 231 | - global $wpdb; |
|
| 232 | - $this->query_where = 'WHERE 1=1'; |
|
| 233 | - |
|
| 234 | - // Fields. |
|
| 235 | - foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) { |
|
| 236 | - if ( 'any' !== $qv[ $field ] ) { |
|
| 237 | - |
|
| 238 | - // In. |
|
| 239 | - if ( is_array( $qv[ $field ] ) ) { |
|
| 240 | - $in = join( ',', array_fill( 0, count( $qv[ $field ] ), $type ) ); |
|
| 241 | - $this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $in )", $qv[ $field ] ); |
|
| 242 | - } elseif ( ! empty( $qv[ $field ] ) ) { |
|
| 243 | - $this->query_where .= $wpdb->prepare( " AND $table.`$field` = $type", $qv[ $field ] ); |
|
| 244 | - } |
|
| 245 | - } |
|
| 246 | - |
|
| 247 | - // Min/Max. |
|
| 248 | - if ( '%f' === $type || '%d' === $type ) { |
|
| 249 | - |
|
| 250 | - // Min. |
|
| 251 | - if ( is_numeric( $qv[ $field . '_min' ] ) ) { |
|
| 252 | - $this->query_where .= $wpdb->prepare( " AND $table.`$field` >= $type", $qv[ $field . '_min' ] ); |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - // Max. |
|
| 256 | - if ( is_numeric( $qv[ $field . '_max' ] ) ) { |
|
| 257 | - $this->query_where .= $wpdb->prepare( " AND $table.`$field` <= $type", $qv[ $field . '_max' ] ); |
|
| 258 | - } |
|
| 259 | - } |
|
| 260 | - } |
|
| 261 | - |
|
| 262 | - if ( ! empty( $qv['include'] ) ) { |
|
| 263 | - $include = implode( ',', wp_parse_id_list( $qv['include'] ) ); |
|
| 264 | - $this->query_where .= " AND $table.`id` IN ($include)"; |
|
| 265 | - } elseif ( ! empty( $qv['exclude'] ) ) { |
|
| 266 | - $exclude = implode( ',', wp_parse_id_list( $qv['exclude'] ) ); |
|
| 267 | - $this->query_where .= " AND $table.`id` NOT IN ($exclude)"; |
|
| 268 | - } |
|
| 269 | - |
|
| 270 | - // Date queries are allowed for the customer creation date. |
|
| 271 | - if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) { |
|
| 272 | - $date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.date_created" ); |
|
| 273 | - $this->query_where .= $date_created_query->get_sql(); |
|
| 274 | - } |
|
| 275 | - |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - /** |
|
| 279 | - * Prepares the query order. |
|
| 280 | - * |
|
| 281 | - * @since 1.0.19 |
|
| 282 | - * |
|
| 283 | - * @param array $qv Query vars. |
|
| 284 | - * @param string $table Table name. |
|
| 285 | - */ |
|
| 286 | - protected function prepare_query_order( &$qv, $table ) { |
|
| 287 | - |
|
| 288 | - // sorting. |
|
| 289 | - $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : ''; |
|
| 290 | - $order = $this->parse_order( $qv['order'] ); |
|
| 291 | - |
|
| 292 | - // Default order is by 'id' (latest customers). |
|
| 293 | - if ( empty( $qv['orderby'] ) ) { |
|
| 294 | - $qv['orderby'] = array( 'id' ); |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - // 'orderby' values may be an array, comma- or space-separated list. |
|
| 298 | - $ordersby = array_filter( wpinv_parse_list( $qv['orderby'] ) ); |
|
| 299 | - |
|
| 300 | - $orderby_array = array(); |
|
| 301 | - foreach ( $ordersby as $_key => $_value ) { |
|
| 302 | - |
|
| 303 | - if ( is_int( $_key ) ) { |
|
| 304 | - // Integer key means this is a flat array of 'orderby' fields. |
|
| 305 | - $_orderby = $_value; |
|
| 306 | - $_order = $order; |
|
| 307 | - } else { |
|
| 308 | - // Non-integer key means that the key is the field and the value is ASC/DESC. |
|
| 309 | - $_orderby = $_key; |
|
| 310 | - $_order = $_value; |
|
| 311 | - } |
|
| 312 | - |
|
| 313 | - $parsed = $this->parse_orderby( $_orderby, $table ); |
|
| 314 | - |
|
| 315 | - if ( $parsed ) { |
|
| 316 | - $orderby_array[] = $parsed . ' ' . $this->parse_order( $_order ); |
|
| 317 | - } |
|
| 318 | - } |
|
| 319 | - |
|
| 320 | - // If no valid clauses were found, order by id. |
|
| 321 | - if ( empty( $orderby_array ) ) { |
|
| 322 | - $orderby_array[] = "id $order"; |
|
| 323 | - } |
|
| 324 | - |
|
| 325 | - $this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array ); |
|
| 326 | - |
|
| 327 | - } |
|
| 328 | - |
|
| 329 | - /** |
|
| 330 | - * Execute the query, with the current variables. |
|
| 331 | - * |
|
| 332 | - * @since 1.0.19 |
|
| 333 | - * |
|
| 334 | - * @global wpdb $wpdb WordPress database abstraction object. |
|
| 335 | - */ |
|
| 336 | - public function query() { |
|
| 337 | - global $wpdb; |
|
| 338 | - |
|
| 339 | - $qv =& $this->query_vars; |
|
| 340 | - |
|
| 341 | - // Return a non-null value to bypass the default GetPaid customers query and remember to set the |
|
| 342 | - // total_customers property. |
|
| 343 | - $this->results = apply_filters_ref_array( 'getpaid_customers_pre_query', array( null, &$this ) ); |
|
| 344 | - |
|
| 345 | - if ( null === $this->results ) { |
|
| 346 | - $this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit"; |
|
| 347 | - |
|
| 348 | - if ( ( is_array( $qv['fields'] ) && 1 !== count( $qv['fields'] ) ) || 'all' === $qv['fields'] ) { |
|
| 349 | - $this->results = $wpdb->get_results( $this->request ); |
|
| 350 | - } else { |
|
| 351 | - $this->results = $wpdb->get_col( $this->request ); |
|
| 352 | - } |
|
| 353 | - |
|
| 354 | - if ( isset( $qv['count_total'] ) && $qv['count_total'] ) { |
|
| 355 | - $found_customers_query = apply_filters( 'getpaid_found_customers_query', 'SELECT FOUND_ROWS()', $this ); |
|
| 356 | - $this->total_customers = (int) $wpdb->get_var( $found_customers_query ); |
|
| 357 | - } |
|
| 358 | - } |
|
| 359 | - |
|
| 360 | - if ( 'all' === $qv['fields'] ) { |
|
| 361 | - foreach ( $this->results as $key => $customer ) { |
|
| 362 | - $this->set_cache( $customer->id, $customer, 'getpaid_customers' ); |
|
| 363 | - $this->set_cache( $customer->user_id, $customer->id, 'getpaid_customer_ids_by_user_id' ); |
|
| 364 | - $this->set_cache( $customer->email, $customer->id, 'getpaid_customer_ids_by_email' ); |
|
| 365 | - $this->results[ $key ] = new GetPaid_Customer( $customer ); |
|
| 366 | - } |
|
| 367 | - } |
|
| 368 | - |
|
| 369 | - } |
|
| 370 | - |
|
| 371 | - /** |
|
| 372 | - * Set cache |
|
| 373 | - * |
|
| 374 | - * @param string $id |
|
| 375 | - * @param mixed $data |
|
| 376 | - * @param string $group |
|
| 377 | - * @param integer $expire |
|
| 378 | - * @return boolean |
|
| 379 | - */ |
|
| 380 | - public function set_cache( $key, $data, $group = '', $expire = 0 ) { |
|
| 381 | - |
|
| 382 | - if ( empty( $key ) ) { |
|
| 383 | - return false; |
|
| 384 | - } |
|
| 385 | - |
|
| 386 | - wp_cache_set( $key, $data, $group, $expire ); |
|
| 387 | - } |
|
| 388 | - |
|
| 389 | - /** |
|
| 390 | - * Retrieve query variable. |
|
| 391 | - * |
|
| 392 | - * @since 1.0.19 |
|
| 393 | - * |
|
| 394 | - * @param string $query_var Query variable key. |
|
| 395 | - * @return mixed |
|
| 396 | - */ |
|
| 397 | - public function get( $query_var ) { |
|
| 398 | - if ( isset( $this->query_vars[ $query_var ] ) ) { |
|
| 399 | - return $this->query_vars[ $query_var ]; |
|
| 400 | - } |
|
| 401 | - |
|
| 402 | - return null; |
|
| 403 | - } |
|
| 404 | - |
|
| 405 | - /** |
|
| 406 | - * Set query variable. |
|
| 407 | - * |
|
| 408 | - * @since 1.0.19 |
|
| 409 | - * |
|
| 410 | - * @param string $query_var Query variable key. |
|
| 411 | - * @param mixed $value Query variable value. |
|
| 412 | - */ |
|
| 413 | - public function set( $query_var, $value ) { |
|
| 414 | - $this->query_vars[ $query_var ] = $value; |
|
| 415 | - } |
|
| 416 | - |
|
| 417 | - /** |
|
| 418 | - * Return the list of customers. |
|
| 419 | - * |
|
| 420 | - * @since 1.0.19 |
|
| 421 | - * |
|
| 422 | - * @return GetPaid_Customer[]|array Found customers. |
|
| 423 | - */ |
|
| 424 | - public function get_results() { |
|
| 425 | - return $this->results; |
|
| 426 | - } |
|
| 427 | - |
|
| 428 | - /** |
|
| 429 | - * Return the total number of customers for the current query. |
|
| 430 | - * |
|
| 431 | - * @since 1.0.19 |
|
| 432 | - * |
|
| 433 | - * @return int Number of total customers. |
|
| 434 | - */ |
|
| 435 | - public function get_total() { |
|
| 436 | - return $this->total_customers; |
|
| 437 | - } |
|
| 438 | - |
|
| 439 | - /** |
|
| 440 | - * Parse and sanitize 'orderby' keys passed to the customers query. |
|
| 441 | - * |
|
| 442 | - * @since 1.0.19 |
|
| 443 | - * |
|
| 444 | - * @param string $orderby Alias for the field to order by. |
|
| 445 | - * @param string $table The current table. |
|
| 446 | - * @return string Value to use in the ORDER clause, if `$orderby` is valid. |
|
| 447 | - */ |
|
| 448 | - protected function parse_orderby( $orderby, $table ) { |
|
| 449 | - |
|
| 450 | - $_orderby = ''; |
|
| 451 | - if ( in_array( $orderby, array_keys( GetPaid_Customer_Data_Store::get_database_fields() ), true ) ) { |
|
| 452 | - $_orderby = "$table.`$orderby`"; |
|
| 453 | - } elseif ( 'id' === strtolower( $orderby ) ) { |
|
| 454 | - $_orderby = "$table.id"; |
|
| 455 | - } elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) { |
|
| 456 | - $include = wp_parse_id_list( $this->query_vars['include'] ); |
|
| 457 | - $include_sql = implode( ',', $include ); |
|
| 458 | - $_orderby = "FIELD( $table.id, $include_sql )"; |
|
| 459 | - } |
|
| 460 | - |
|
| 461 | - return $_orderby; |
|
| 462 | - } |
|
| 463 | - |
|
| 464 | - /** |
|
| 465 | - * Parse an 'order' query variable and cast it to ASC or DESC as necessary. |
|
| 466 | - * |
|
| 467 | - * @since 1.0.19 |
|
| 468 | - * |
|
| 469 | - * @param string $order The 'order' query variable. |
|
| 470 | - * @return string The sanitized 'order' query variable. |
|
| 471 | - */ |
|
| 472 | - protected function parse_order( $order ) { |
|
| 473 | - if ( ! is_string( $order ) || empty( $order ) ) { |
|
| 474 | - return 'DESC'; |
|
| 475 | - } |
|
| 476 | - |
|
| 477 | - if ( 'ASC' === strtoupper( $order ) ) { |
|
| 478 | - return 'ASC'; |
|
| 479 | - } else { |
|
| 480 | - return 'DESC'; |
|
| 481 | - } |
|
| 482 | - } |
|
| 19 | + /** |
|
| 20 | + * Query vars, after parsing |
|
| 21 | + * |
|
| 22 | + * @since 1.0.19 |
|
| 23 | + * @var array |
|
| 24 | + */ |
|
| 25 | + public $query_vars = array(); |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * List of found customers. |
|
| 29 | + * |
|
| 30 | + * @since 1.0.19 |
|
| 31 | + * @var array |
|
| 32 | + */ |
|
| 33 | + private $results; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * Total number of found customers for the current query |
|
| 37 | + * |
|
| 38 | + * @since 1.0.19 |
|
| 39 | + * @var int |
|
| 40 | + */ |
|
| 41 | + private $total_customers = 0; |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * The SQL query used to fetch matching customers. |
|
| 45 | + * |
|
| 46 | + * @since 1.0.19 |
|
| 47 | + * @var string |
|
| 48 | + */ |
|
| 49 | + public $request; |
|
| 50 | + |
|
| 51 | + // SQL clauses |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * Contains the 'FIELDS' sql clause |
|
| 55 | + * |
|
| 56 | + * @since 1.0.19 |
|
| 57 | + * @var string |
|
| 58 | + */ |
|
| 59 | + public $query_fields; |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * Contains the 'FROM' sql clause |
|
| 63 | + * |
|
| 64 | + * @since 1.0.19 |
|
| 65 | + * @var string |
|
| 66 | + */ |
|
| 67 | + public $query_from; |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * Contains the 'WHERE' sql clause |
|
| 71 | + * |
|
| 72 | + * @since 1.0.19 |
|
| 73 | + * @var string |
|
| 74 | + */ |
|
| 75 | + public $query_where; |
|
| 76 | + |
|
| 77 | + /** |
|
| 78 | + * Contains the 'ORDER BY' sql clause |
|
| 79 | + * |
|
| 80 | + * @since 1.0.19 |
|
| 81 | + * @var string |
|
| 82 | + */ |
|
| 83 | + public $query_orderby; |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Contains the 'LIMIT' sql clause |
|
| 87 | + * |
|
| 88 | + * @since 1.0.19 |
|
| 89 | + * @var string |
|
| 90 | + */ |
|
| 91 | + public $query_limit; |
|
| 92 | + |
|
| 93 | + /** |
|
| 94 | + * Class constructor. |
|
| 95 | + * |
|
| 96 | + * @since 1.0.19 |
|
| 97 | + * |
|
| 98 | + * @param null|string|array $query Optional. The query variables. |
|
| 99 | + */ |
|
| 100 | + public function __construct( $query = null ) { |
|
| 101 | + if ( ! is_null( $query ) ) { |
|
| 102 | + $this->prepare_query( $query ); |
|
| 103 | + $this->query(); |
|
| 104 | + } |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Fills in missing query variables with default values. |
|
| 109 | + * |
|
| 110 | + * @since 1.0.19 |
|
| 111 | + * |
|
| 112 | + * @param string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`. |
|
| 113 | + * @return array Complete query variables with undefined ones filled in with defaults. |
|
| 114 | + */ |
|
| 115 | + public static function fill_query_vars( $args ) { |
|
| 116 | + $defaults = array( |
|
| 117 | + 'include' => array(), |
|
| 118 | + 'exclude' => array(), |
|
| 119 | + 'orderby' => 'id', |
|
| 120 | + 'order' => 'DESC', |
|
| 121 | + 'offset' => '', |
|
| 122 | + 'number' => 10, |
|
| 123 | + 'paged' => 1, |
|
| 124 | + 'count_total' => true, |
|
| 125 | + 'fields' => 'all', |
|
| 126 | + ); |
|
| 127 | + |
|
| 128 | + foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) { |
|
| 129 | + $defaults[ $field ] = 'any'; |
|
| 130 | + |
|
| 131 | + if ( '%f' === $type || '%d' === $type ) { |
|
| 132 | + $defaults[ $field . '_min' ] = ''; |
|
| 133 | + $defaults[ $field . '_max' ] = ''; |
|
| 134 | + } |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + return wp_parse_args( $args, $defaults ); |
|
| 138 | + } |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * Prepare the query variables. |
|
| 142 | + * |
|
| 143 | + * @since 1.0.19 |
|
| 144 | + * |
|
| 145 | + * @see self::fill_query_vars() For allowede args and their defaults. |
|
| 146 | + */ |
|
| 147 | + public function prepare_query( $query = array() ) { |
|
| 148 | + global $wpdb; |
|
| 149 | + |
|
| 150 | + if ( empty( $this->query_vars ) || ! empty( $query ) ) { |
|
| 151 | + $this->query_limit = null; |
|
| 152 | + $this->query_vars = $this->fill_query_vars( $query ); |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) { |
|
| 156 | + $this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] ); |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + do_action( 'getpaid_pre_get_customers', array( &$this ) ); |
|
| 160 | + |
|
| 161 | + // Ensure that query vars are filled after 'getpaid_pre_get_customers'. |
|
| 162 | + $qv = & $this->query_vars; |
|
| 163 | + $qv = $this->fill_query_vars( $qv ); |
|
| 164 | + $table = $wpdb->prefix . 'getpaid_customers'; |
|
| 165 | + $this->query_from = "FROM $table"; |
|
| 166 | + |
|
| 167 | + // Prepare query fields. |
|
| 168 | + $this->prepare_query_fields( $qv, $table ); |
|
| 169 | + |
|
| 170 | + // Prepare query where. |
|
| 171 | + $this->prepare_query_where( $qv, $table ); |
|
| 172 | + |
|
| 173 | + // Prepare query order. |
|
| 174 | + $this->prepare_query_order( $qv, $table ); |
|
| 175 | + |
|
| 176 | + // limit |
|
| 177 | + if ( isset( $qv['number'] ) && $qv['number'] > 0 ) { |
|
| 178 | + if ( $qv['offset'] ) { |
|
| 179 | + $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] ); |
|
| 180 | + } else { |
|
| 181 | + $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] ); |
|
| 182 | + } |
|
| 183 | + } |
|
| 184 | + |
|
| 185 | + do_action_ref_array( 'getpaid_after_customers_query', array( &$this ) ); |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + /** |
|
| 189 | + * Prepares the query fields. |
|
| 190 | + * |
|
| 191 | + * @since 1.0.19 |
|
| 192 | + * |
|
| 193 | + * @param array $qv Query vars. |
|
| 194 | + * @param string $table Table name. |
|
| 195 | + */ |
|
| 196 | + protected function prepare_query_fields( &$qv, $table ) { |
|
| 197 | + |
|
| 198 | + if ( is_array( $qv['fields'] ) ) { |
|
| 199 | + $qv['fields'] = array_unique( $qv['fields'] ); |
|
| 200 | + $allowed_fields = array_keys( GetPaid_Customer_Data_Store::get_database_fields() ); |
|
| 201 | + |
|
| 202 | + $query_fields = array(); |
|
| 203 | + foreach ( $qv['fields'] as $field ) { |
|
| 204 | + if ( ! in_array( $field, $allowed_fields ) ) { |
|
| 205 | + continue; |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + $field = sanitize_key( $field ); |
|
| 209 | + $query_fields[] = "$table.`$field`"; |
|
| 210 | + } |
|
| 211 | + $this->query_fields = implode( ',', $query_fields ); |
|
| 212 | + } else { |
|
| 213 | + $this->query_fields = "$table.*"; |
|
| 214 | + } |
|
| 215 | + |
|
| 216 | + if ( isset( $qv['count_total'] ) && $qv['count_total'] ) { |
|
| 217 | + $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields; |
|
| 218 | + } |
|
| 219 | + |
|
| 220 | + } |
|
| 221 | + |
|
| 222 | + /** |
|
| 223 | + * Prepares the query where. |
|
| 224 | + * |
|
| 225 | + * @since 1.0.19 |
|
| 226 | + * |
|
| 227 | + * @param array $qv Query vars. |
|
| 228 | + * @param string $table Table name. |
|
| 229 | + */ |
|
| 230 | + protected function prepare_query_where( &$qv, $table ) { |
|
| 231 | + global $wpdb; |
|
| 232 | + $this->query_where = 'WHERE 1=1'; |
|
| 233 | + |
|
| 234 | + // Fields. |
|
| 235 | + foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) { |
|
| 236 | + if ( 'any' !== $qv[ $field ] ) { |
|
| 237 | + |
|
| 238 | + // In. |
|
| 239 | + if ( is_array( $qv[ $field ] ) ) { |
|
| 240 | + $in = join( ',', array_fill( 0, count( $qv[ $field ] ), $type ) ); |
|
| 241 | + $this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $in )", $qv[ $field ] ); |
|
| 242 | + } elseif ( ! empty( $qv[ $field ] ) ) { |
|
| 243 | + $this->query_where .= $wpdb->prepare( " AND $table.`$field` = $type", $qv[ $field ] ); |
|
| 244 | + } |
|
| 245 | + } |
|
| 246 | + |
|
| 247 | + // Min/Max. |
|
| 248 | + if ( '%f' === $type || '%d' === $type ) { |
|
| 249 | + |
|
| 250 | + // Min. |
|
| 251 | + if ( is_numeric( $qv[ $field . '_min' ] ) ) { |
|
| 252 | + $this->query_where .= $wpdb->prepare( " AND $table.`$field` >= $type", $qv[ $field . '_min' ] ); |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + // Max. |
|
| 256 | + if ( is_numeric( $qv[ $field . '_max' ] ) ) { |
|
| 257 | + $this->query_where .= $wpdb->prepare( " AND $table.`$field` <= $type", $qv[ $field . '_max' ] ); |
|
| 258 | + } |
|
| 259 | + } |
|
| 260 | + } |
|
| 261 | + |
|
| 262 | + if ( ! empty( $qv['include'] ) ) { |
|
| 263 | + $include = implode( ',', wp_parse_id_list( $qv['include'] ) ); |
|
| 264 | + $this->query_where .= " AND $table.`id` IN ($include)"; |
|
| 265 | + } elseif ( ! empty( $qv['exclude'] ) ) { |
|
| 266 | + $exclude = implode( ',', wp_parse_id_list( $qv['exclude'] ) ); |
|
| 267 | + $this->query_where .= " AND $table.`id` NOT IN ($exclude)"; |
|
| 268 | + } |
|
| 269 | + |
|
| 270 | + // Date queries are allowed for the customer creation date. |
|
| 271 | + if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) { |
|
| 272 | + $date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.date_created" ); |
|
| 273 | + $this->query_where .= $date_created_query->get_sql(); |
|
| 274 | + } |
|
| 275 | + |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + /** |
|
| 279 | + * Prepares the query order. |
|
| 280 | + * |
|
| 281 | + * @since 1.0.19 |
|
| 282 | + * |
|
| 283 | + * @param array $qv Query vars. |
|
| 284 | + * @param string $table Table name. |
|
| 285 | + */ |
|
| 286 | + protected function prepare_query_order( &$qv, $table ) { |
|
| 287 | + |
|
| 288 | + // sorting. |
|
| 289 | + $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : ''; |
|
| 290 | + $order = $this->parse_order( $qv['order'] ); |
|
| 291 | + |
|
| 292 | + // Default order is by 'id' (latest customers). |
|
| 293 | + if ( empty( $qv['orderby'] ) ) { |
|
| 294 | + $qv['orderby'] = array( 'id' ); |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + // 'orderby' values may be an array, comma- or space-separated list. |
|
| 298 | + $ordersby = array_filter( wpinv_parse_list( $qv['orderby'] ) ); |
|
| 299 | + |
|
| 300 | + $orderby_array = array(); |
|
| 301 | + foreach ( $ordersby as $_key => $_value ) { |
|
| 302 | + |
|
| 303 | + if ( is_int( $_key ) ) { |
|
| 304 | + // Integer key means this is a flat array of 'orderby' fields. |
|
| 305 | + $_orderby = $_value; |
|
| 306 | + $_order = $order; |
|
| 307 | + } else { |
|
| 308 | + // Non-integer key means that the key is the field and the value is ASC/DESC. |
|
| 309 | + $_orderby = $_key; |
|
| 310 | + $_order = $_value; |
|
| 311 | + } |
|
| 312 | + |
|
| 313 | + $parsed = $this->parse_orderby( $_orderby, $table ); |
|
| 314 | + |
|
| 315 | + if ( $parsed ) { |
|
| 316 | + $orderby_array[] = $parsed . ' ' . $this->parse_order( $_order ); |
|
| 317 | + } |
|
| 318 | + } |
|
| 319 | + |
|
| 320 | + // If no valid clauses were found, order by id. |
|
| 321 | + if ( empty( $orderby_array ) ) { |
|
| 322 | + $orderby_array[] = "id $order"; |
|
| 323 | + } |
|
| 324 | + |
|
| 325 | + $this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array ); |
|
| 326 | + |
|
| 327 | + } |
|
| 328 | + |
|
| 329 | + /** |
|
| 330 | + * Execute the query, with the current variables. |
|
| 331 | + * |
|
| 332 | + * @since 1.0.19 |
|
| 333 | + * |
|
| 334 | + * @global wpdb $wpdb WordPress database abstraction object. |
|
| 335 | + */ |
|
| 336 | + public function query() { |
|
| 337 | + global $wpdb; |
|
| 338 | + |
|
| 339 | + $qv =& $this->query_vars; |
|
| 340 | + |
|
| 341 | + // Return a non-null value to bypass the default GetPaid customers query and remember to set the |
|
| 342 | + // total_customers property. |
|
| 343 | + $this->results = apply_filters_ref_array( 'getpaid_customers_pre_query', array( null, &$this ) ); |
|
| 344 | + |
|
| 345 | + if ( null === $this->results ) { |
|
| 346 | + $this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit"; |
|
| 347 | + |
|
| 348 | + if ( ( is_array( $qv['fields'] ) && 1 !== count( $qv['fields'] ) ) || 'all' === $qv['fields'] ) { |
|
| 349 | + $this->results = $wpdb->get_results( $this->request ); |
|
| 350 | + } else { |
|
| 351 | + $this->results = $wpdb->get_col( $this->request ); |
|
| 352 | + } |
|
| 353 | + |
|
| 354 | + if ( isset( $qv['count_total'] ) && $qv['count_total'] ) { |
|
| 355 | + $found_customers_query = apply_filters( 'getpaid_found_customers_query', 'SELECT FOUND_ROWS()', $this ); |
|
| 356 | + $this->total_customers = (int) $wpdb->get_var( $found_customers_query ); |
|
| 357 | + } |
|
| 358 | + } |
|
| 359 | + |
|
| 360 | + if ( 'all' === $qv['fields'] ) { |
|
| 361 | + foreach ( $this->results as $key => $customer ) { |
|
| 362 | + $this->set_cache( $customer->id, $customer, 'getpaid_customers' ); |
|
| 363 | + $this->set_cache( $customer->user_id, $customer->id, 'getpaid_customer_ids_by_user_id' ); |
|
| 364 | + $this->set_cache( $customer->email, $customer->id, 'getpaid_customer_ids_by_email' ); |
|
| 365 | + $this->results[ $key ] = new GetPaid_Customer( $customer ); |
|
| 366 | + } |
|
| 367 | + } |
|
| 368 | + |
|
| 369 | + } |
|
| 370 | + |
|
| 371 | + /** |
|
| 372 | + * Set cache |
|
| 373 | + * |
|
| 374 | + * @param string $id |
|
| 375 | + * @param mixed $data |
|
| 376 | + * @param string $group |
|
| 377 | + * @param integer $expire |
|
| 378 | + * @return boolean |
|
| 379 | + */ |
|
| 380 | + public function set_cache( $key, $data, $group = '', $expire = 0 ) { |
|
| 381 | + |
|
| 382 | + if ( empty( $key ) ) { |
|
| 383 | + return false; |
|
| 384 | + } |
|
| 385 | + |
|
| 386 | + wp_cache_set( $key, $data, $group, $expire ); |
|
| 387 | + } |
|
| 388 | + |
|
| 389 | + /** |
|
| 390 | + * Retrieve query variable. |
|
| 391 | + * |
|
| 392 | + * @since 1.0.19 |
|
| 393 | + * |
|
| 394 | + * @param string $query_var Query variable key. |
|
| 395 | + * @return mixed |
|
| 396 | + */ |
|
| 397 | + public function get( $query_var ) { |
|
| 398 | + if ( isset( $this->query_vars[ $query_var ] ) ) { |
|
| 399 | + return $this->query_vars[ $query_var ]; |
|
| 400 | + } |
|
| 401 | + |
|
| 402 | + return null; |
|
| 403 | + } |
|
| 404 | + |
|
| 405 | + /** |
|
| 406 | + * Set query variable. |
|
| 407 | + * |
|
| 408 | + * @since 1.0.19 |
|
| 409 | + * |
|
| 410 | + * @param string $query_var Query variable key. |
|
| 411 | + * @param mixed $value Query variable value. |
|
| 412 | + */ |
|
| 413 | + public function set( $query_var, $value ) { |
|
| 414 | + $this->query_vars[ $query_var ] = $value; |
|
| 415 | + } |
|
| 416 | + |
|
| 417 | + /** |
|
| 418 | + * Return the list of customers. |
|
| 419 | + * |
|
| 420 | + * @since 1.0.19 |
|
| 421 | + * |
|
| 422 | + * @return GetPaid_Customer[]|array Found customers. |
|
| 423 | + */ |
|
| 424 | + public function get_results() { |
|
| 425 | + return $this->results; |
|
| 426 | + } |
|
| 427 | + |
|
| 428 | + /** |
|
| 429 | + * Return the total number of customers for the current query. |
|
| 430 | + * |
|
| 431 | + * @since 1.0.19 |
|
| 432 | + * |
|
| 433 | + * @return int Number of total customers. |
|
| 434 | + */ |
|
| 435 | + public function get_total() { |
|
| 436 | + return $this->total_customers; |
|
| 437 | + } |
|
| 438 | + |
|
| 439 | + /** |
|
| 440 | + * Parse and sanitize 'orderby' keys passed to the customers query. |
|
| 441 | + * |
|
| 442 | + * @since 1.0.19 |
|
| 443 | + * |
|
| 444 | + * @param string $orderby Alias for the field to order by. |
|
| 445 | + * @param string $table The current table. |
|
| 446 | + * @return string Value to use in the ORDER clause, if `$orderby` is valid. |
|
| 447 | + */ |
|
| 448 | + protected function parse_orderby( $orderby, $table ) { |
|
| 449 | + |
|
| 450 | + $_orderby = ''; |
|
| 451 | + if ( in_array( $orderby, array_keys( GetPaid_Customer_Data_Store::get_database_fields() ), true ) ) { |
|
| 452 | + $_orderby = "$table.`$orderby`"; |
|
| 453 | + } elseif ( 'id' === strtolower( $orderby ) ) { |
|
| 454 | + $_orderby = "$table.id"; |
|
| 455 | + } elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) { |
|
| 456 | + $include = wp_parse_id_list( $this->query_vars['include'] ); |
|
| 457 | + $include_sql = implode( ',', $include ); |
|
| 458 | + $_orderby = "FIELD( $table.id, $include_sql )"; |
|
| 459 | + } |
|
| 460 | + |
|
| 461 | + return $_orderby; |
|
| 462 | + } |
|
| 463 | + |
|
| 464 | + /** |
|
| 465 | + * Parse an 'order' query variable and cast it to ASC or DESC as necessary. |
|
| 466 | + * |
|
| 467 | + * @since 1.0.19 |
|
| 468 | + * |
|
| 469 | + * @param string $order The 'order' query variable. |
|
| 470 | + * @return string The sanitized 'order' query variable. |
|
| 471 | + */ |
|
| 472 | + protected function parse_order( $order ) { |
|
| 473 | + if ( ! is_string( $order ) || empty( $order ) ) { |
|
| 474 | + return 'DESC'; |
|
| 475 | + } |
|
| 476 | + |
|
| 477 | + if ( 'ASC' === strtoupper( $order ) ) { |
|
| 478 | + return 'ASC'; |
|
| 479 | + } else { |
|
| 480 | + return 'DESC'; |
|
| 481 | + } |
|
| 482 | + } |
|
| 483 | 483 | |
| 484 | 484 | } |
@@ -14,93 +14,93 @@ 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; |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * Reports components. |
|
| 32 | - * |
|
| 33 | - * @var GetPaid_Reports |
|
| 34 | - */ |
|
| 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 | + |
|
| 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_reset_form_stats', array( $this, 'reset_form_stats' ) ); |
|
| 66 | - add_action( 'getpaid_authenticated_admin_action_duplicate_invoice', array( $this, 'duplicate_invoice' ) ); |
|
| 67 | - add_action( 'getpaid_authenticated_admin_action_send_invoice', array( $this, 'send_customer_invoice' ) ); |
|
| 68 | - 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_reset_form_stats', array( $this, 'reset_form_stats' ) ); |
|
| 66 | + add_action( 'getpaid_authenticated_admin_action_duplicate_invoice', array( $this, 'duplicate_invoice' ) ); |
|
| 67 | + add_action( 'getpaid_authenticated_admin_action_send_invoice', array( $this, 'send_customer_invoice' ) ); |
|
| 68 | + add_action( 'getpaid_authenticated_admin_action_send_invoice_reminder', array( $this, 'send_customer_payment_reminder' ) ); |
|
| 69 | 69 | add_action( 'getpaid_authenticated_admin_action_reset_tax_rates', array( $this, 'admin_reset_tax_rates' ) ); |
| 70 | - add_action( 'getpaid_authenticated_admin_action_create_missing_pages', array( $this, 'admin_create_missing_pages' ) ); |
|
| 71 | - add_action( 'getpaid_authenticated_admin_action_refresh_permalinks', array( $this, 'admin_refresh_permalinks' ) ); |
|
| 72 | - add_action( 'getpaid_authenticated_admin_action_create_missing_tables', array( $this, 'admin_create_missing_tables' ) ); |
|
| 73 | - add_action( 'getpaid_authenticated_admin_action_migrate_old_invoices', array( $this, 'admin_migrate_old_invoices' ) ); |
|
| 74 | - add_action( 'getpaid_authenticated_admin_action_download_customers', array( $this, 'admin_download_customers' ) ); |
|
| 75 | - add_action( 'getpaid_authenticated_admin_action_recalculate_discounts', array( $this, 'admin_recalculate_discounts' ) ); |
|
| 76 | - add_action( 'getpaid_authenticated_admin_action_install_plugin', array( $this, 'admin_install_plugin' ) ); |
|
| 77 | - add_action( 'getpaid_authenticated_admin_action_connect_gateway', array( $this, 'admin_connect_gateway' ) ); |
|
| 78 | - add_filter( 'admin_footer_text', array( $this, 'admin_footer_text' ) ); |
|
| 79 | - do_action( 'getpaid_init_admin_hooks', $this ); |
|
| 80 | - |
|
| 81 | - // Setup/welcome |
|
| 82 | - if ( ! empty( $_GET['page'] ) ) { |
|
| 83 | - switch ( sanitize_text_field( $_GET['page'] ) ) { |
|
| 84 | - case 'gp-setup': |
|
| 85 | - include_once dirname( __FILE__ ) . '/class-getpaid-admin-setup-wizard.php'; |
|
| 86 | - break; |
|
| 87 | - } |
|
| 88 | - } |
|
| 89 | - |
|
| 90 | - } |
|
| 91 | - |
|
| 92 | - /** |
|
| 93 | - * Register admin scripts |
|
| 94 | - * |
|
| 95 | - */ |
|
| 96 | - public function enqeue_scripts() { |
|
| 70 | + add_action( 'getpaid_authenticated_admin_action_create_missing_pages', array( $this, 'admin_create_missing_pages' ) ); |
|
| 71 | + add_action( 'getpaid_authenticated_admin_action_refresh_permalinks', array( $this, 'admin_refresh_permalinks' ) ); |
|
| 72 | + add_action( 'getpaid_authenticated_admin_action_create_missing_tables', array( $this, 'admin_create_missing_tables' ) ); |
|
| 73 | + add_action( 'getpaid_authenticated_admin_action_migrate_old_invoices', array( $this, 'admin_migrate_old_invoices' ) ); |
|
| 74 | + add_action( 'getpaid_authenticated_admin_action_download_customers', array( $this, 'admin_download_customers' ) ); |
|
| 75 | + add_action( 'getpaid_authenticated_admin_action_recalculate_discounts', array( $this, 'admin_recalculate_discounts' ) ); |
|
| 76 | + add_action( 'getpaid_authenticated_admin_action_install_plugin', array( $this, 'admin_install_plugin' ) ); |
|
| 77 | + add_action( 'getpaid_authenticated_admin_action_connect_gateway', array( $this, 'admin_connect_gateway' ) ); |
|
| 78 | + add_filter( 'admin_footer_text', array( $this, 'admin_footer_text' ) ); |
|
| 79 | + do_action( 'getpaid_init_admin_hooks', $this ); |
|
| 80 | + |
|
| 81 | + // Setup/welcome |
|
| 82 | + if ( ! empty( $_GET['page'] ) ) { |
|
| 83 | + switch ( sanitize_text_field( $_GET['page'] ) ) { |
|
| 84 | + case 'gp-setup': |
|
| 85 | + include_once dirname( __FILE__ ) . '/class-getpaid-admin-setup-wizard.php'; |
|
| 86 | + break; |
|
| 87 | + } |
|
| 88 | + } |
|
| 89 | + |
|
| 90 | + } |
|
| 91 | + |
|
| 92 | + /** |
|
| 93 | + * Register admin scripts |
|
| 94 | + * |
|
| 95 | + */ |
|
| 96 | + public function enqeue_scripts() { |
|
| 97 | 97 | global $current_screen, $pagenow; |
| 98 | 98 | |
| 99 | - $page = isset( $_GET['page'] ) ? sanitize_text_field( $_GET['page'] ) : ''; |
|
| 100 | - $editing = $pagenow == 'post.php' || $pagenow == 'post-new.php'; |
|
| 99 | + $page = isset( $_GET['page'] ) ? sanitize_text_field( $_GET['page'] ) : ''; |
|
| 100 | + $editing = $pagenow == 'post.php' || $pagenow == 'post-new.php'; |
|
| 101 | 101 | |
| 102 | 102 | if ( ! empty( $current_screen->post_type ) ) { |
| 103 | - $page = $current_screen->post_type; |
|
| 103 | + $page = $current_screen->post_type; |
|
| 104 | 104 | } |
| 105 | 105 | |
| 106 | 106 | // General styles. |
@@ -121,53 +121,53 @@ discard block |
||
| 121 | 121 | } |
| 122 | 122 | |
| 123 | 123 | // Payment form scripts. |
| 124 | - if ( 'wpi_payment_form' == $page && $editing ) { |
|
| 124 | + if ( 'wpi_payment_form' == $page && $editing ) { |
|
| 125 | 125 | $this->load_payment_form_scripts(); |
| 126 | 126 | } |
| 127 | 127 | |
| 128 | - if ( $page == 'wpinv-subscriptions' ) { |
|
| 129 | - wp_enqueue_script( 'postbox' ); |
|
| 130 | - } |
|
| 128 | + if ( $page == 'wpinv-subscriptions' ) { |
|
| 129 | + wp_enqueue_script( 'postbox' ); |
|
| 130 | + } |
|
| 131 | 131 | |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | 134 | /** |
| 135 | - * Returns admin js translations. |
|
| 136 | - * |
|
| 137 | - */ |
|
| 138 | - protected function get_admin_i18() { |
|
| 135 | + * Returns admin js translations. |
|
| 136 | + * |
|
| 137 | + */ |
|
| 138 | + protected function get_admin_i18() { |
|
| 139 | 139 | global $post; |
| 140 | 140 | |
| 141 | - $date_range = array( |
|
| 142 | - 'period' => isset( $_GET['date_range'] ) ? sanitize_text_field( $_GET['date_range'] ) : '7_days', |
|
| 143 | - ); |
|
| 141 | + $date_range = array( |
|
| 142 | + 'period' => isset( $_GET['date_range'] ) ? sanitize_text_field( $_GET['date_range'] ) : '7_days', |
|
| 143 | + ); |
|
| 144 | 144 | |
| 145 | - if ( $date_range['period'] == 'custom' ) { |
|
| 145 | + if ( $date_range['period'] == 'custom' ) { |
|
| 146 | 146 | |
| 147 | - if ( isset( $_GET['from'] ) ) { |
|
| 148 | - $date_range['after'] = date( 'Y-m-d', strtotime( sanitize_text_field( $_GET['from'] ), current_time( 'timestamp' ) ) - DAY_IN_SECONDS ); |
|
| 149 | - } |
|
| 147 | + if ( isset( $_GET['from'] ) ) { |
|
| 148 | + $date_range['after'] = date( 'Y-m-d', strtotime( sanitize_text_field( $_GET['from'] ), current_time( 'timestamp' ) ) - DAY_IN_SECONDS ); |
|
| 149 | + } |
|
| 150 | 150 | |
| 151 | - if ( isset( $_GET['to'] ) ) { |
|
| 152 | - $date_range['before'] = date( 'Y-m-d', strtotime( sanitize_text_field( $_GET['to'] ), current_time( 'timestamp' ) ) + DAY_IN_SECONDS ); |
|
| 153 | - } |
|
| 151 | + if ( isset( $_GET['to'] ) ) { |
|
| 152 | + $date_range['before'] = date( 'Y-m-d', strtotime( sanitize_text_field( $_GET['to'] ), current_time( 'timestamp' ) ) + DAY_IN_SECONDS ); |
|
| 153 | + } |
|
| 154 | 154 | } |
| 155 | 155 | |
| 156 | 156 | $i18n = array( |
| 157 | 157 | 'ajax_url' => admin_url( 'admin-ajax.php' ), |
| 158 | 158 | 'post_ID' => isset( $post->ID ) ? $post->ID : '', |
| 159 | - 'wpinv_nonce' => wp_create_nonce( 'wpinv-nonce' ), |
|
| 160 | - 'rest_nonce' => wp_create_nonce( 'wp_rest' ), |
|
| 161 | - 'rest_root' => esc_url_raw( rest_url() ), |
|
| 162 | - 'date_range' => $date_range, |
|
| 159 | + 'wpinv_nonce' => wp_create_nonce( 'wpinv-nonce' ), |
|
| 160 | + 'rest_nonce' => wp_create_nonce( 'wp_rest' ), |
|
| 161 | + 'rest_root' => esc_url_raw( rest_url() ), |
|
| 162 | + 'date_range' => $date_range, |
|
| 163 | 163 | 'add_invoice_note_nonce' => wp_create_nonce( 'add-invoice-note' ), |
| 164 | 164 | 'delete_invoice_note_nonce' => wp_create_nonce( 'delete-invoice-note' ), |
| 165 | 165 | 'invoice_item_nonce' => wp_create_nonce( 'invoice-item' ), |
| 166 | 166 | 'billing_details_nonce' => wp_create_nonce( 'get-billing-details' ), |
| 167 | 167 | 'tax' => wpinv_tax_amount(), |
| 168 | 168 | 'discount' => 0, |
| 169 | - 'currency_symbol' => wpinv_currency_symbol(), |
|
| 170 | - 'currency' => wpinv_get_currency(), |
|
| 169 | + 'currency_symbol' => wpinv_currency_symbol(), |
|
| 170 | + 'currency' => wpinv_get_currency(), |
|
| 171 | 171 | 'currency_pos' => wpinv_currency_position(), |
| 172 | 172 | 'thousand_sep' => wpinv_thousands_separator(), |
| 173 | 173 | 'decimal_sep' => wpinv_decimal_separator(), |
@@ -187,118 +187,118 @@ discard block |
||
| 187 | 187 | 'item_description' => __( 'Item Description', 'invoicing' ), |
| 188 | 188 | 'invoice_description' => __( 'Invoice Description', 'invoicing' ), |
| 189 | 189 | 'discount_description' => __( 'Discount Description', 'invoicing' ), |
| 190 | - 'searching' => __( 'Searching', 'invoicing' ), |
|
| 191 | - 'loading' => __( 'Loading...', 'invoicing' ), |
|
| 192 | - 'search_customers' => __( 'Enter customer name or email', 'invoicing' ), |
|
| 193 | - 'search_items' => __( 'Enter item name', 'invoicing' ), |
|
| 194 | - 'graphs' => array_merge( array( 'refunded_fees', 'refunded_items', 'refunded_subtotal', 'refunded_tax' ), array_keys( wpinv_get_report_graphs() ) ), |
|
| 190 | + 'searching' => __( 'Searching', 'invoicing' ), |
|
| 191 | + 'loading' => __( 'Loading...', 'invoicing' ), |
|
| 192 | + 'search_customers' => __( 'Enter customer name or email', 'invoicing' ), |
|
| 193 | + 'search_items' => __( 'Enter item name', 'invoicing' ), |
|
| 194 | + 'graphs' => array_merge( array( 'refunded_fees', 'refunded_items', 'refunded_subtotal', 'refunded_tax' ), array_keys( wpinv_get_report_graphs() ) ), |
|
| 195 | 195 | ); |
| 196 | 196 | |
| 197 | - if ( ! empty( $post ) && getpaid_is_invoice_post_type( $post->post_type ) ) { |
|
| 197 | + if ( ! empty( $post ) && getpaid_is_invoice_post_type( $post->post_type ) ) { |
|
| 198 | 198 | |
| 199 | - $invoice = new WPInv_Invoice( $post ); |
|
| 200 | - $i18n['save_invoice'] = sprintf( |
|
| 201 | - __( 'Save %s', 'invoicing' ), |
|
| 202 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 203 | - ); |
|
| 199 | + $invoice = new WPInv_Invoice( $post ); |
|
| 200 | + $i18n['save_invoice'] = sprintf( |
|
| 201 | + __( 'Save %s', 'invoicing' ), |
|
| 202 | + ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 203 | + ); |
|
| 204 | 204 | |
| 205 | - $i18n['invoice_description'] = sprintf( |
|
| 206 | - __( '%s Description', 'invoicing' ), |
|
| 207 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 208 | - ); |
|
| 205 | + $i18n['invoice_description'] = sprintf( |
|
| 206 | + __( '%s Description', 'invoicing' ), |
|
| 207 | + ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 208 | + ); |
|
| 209 | 209 | |
| 210 | - } |
|
| 211 | - return $i18n; |
|
| 212 | - } |
|
| 210 | + } |
|
| 211 | + return $i18n; |
|
| 212 | + } |
|
| 213 | 213 | |
| 214 | - /** |
|
| 215 | - * Change the admin footer text on GetPaid admin pages. |
|
| 216 | - * |
|
| 217 | - * @since 2.0.0 |
|
| 218 | - * @param string $footer_text |
|
| 219 | - * @return string |
|
| 220 | - */ |
|
| 221 | - public function admin_footer_text( $footer_text ) { |
|
| 222 | - global $current_screen; |
|
| 214 | + /** |
|
| 215 | + * Change the admin footer text on GetPaid admin pages. |
|
| 216 | + * |
|
| 217 | + * @since 2.0.0 |
|
| 218 | + * @param string $footer_text |
|
| 219 | + * @return string |
|
| 220 | + */ |
|
| 221 | + public function admin_footer_text( $footer_text ) { |
|
| 222 | + global $current_screen; |
|
| 223 | 223 | |
| 224 | - $page = isset( $_GET['page'] ) ? sanitize_text_field( $_GET['page'] ) : ''; |
|
| 224 | + $page = isset( $_GET['page'] ) ? sanitize_text_field( $_GET['page'] ) : ''; |
|
| 225 | 225 | |
| 226 | 226 | if ( ! empty( $current_screen->post_type ) ) { |
| 227 | - $page = $current_screen->post_type; |
|
| 227 | + $page = $current_screen->post_type; |
|
| 228 | 228 | } |
| 229 | 229 | |
| 230 | 230 | // General styles. |
| 231 | 231 | if ( apply_filters( 'getpaid_display_admin_footer_text', wpinv_current_user_can_manage_invoicing() ) && false !== stripos( $page, 'wpi' ) ) { |
| 232 | 232 | |
| 233 | - // Change the footer text |
|
| 234 | - if ( ! get_user_meta( get_current_user_id(), 'getpaid_admin_footer_text_rated', true ) ) { |
|
| 233 | + // Change the footer text |
|
| 234 | + if ( ! get_user_meta( get_current_user_id(), 'getpaid_admin_footer_text_rated', true ) ) { |
|
| 235 | 235 | |
| 236 | - $rating_url = esc_url( |
|
| 237 | - wp_nonce_url( |
|
| 238 | - admin_url( 'admin.php?page=wpinv-reports&getpaid-admin-action=rate_plugin' ), |
|
| 239 | - 'getpaid-nonce', |
|
| 240 | - 'getpaid-nonce' |
|
| 236 | + $rating_url = esc_url( |
|
| 237 | + wp_nonce_url( |
|
| 238 | + admin_url( 'admin.php?page=wpinv-reports&getpaid-admin-action=rate_plugin' ), |
|
| 239 | + 'getpaid-nonce', |
|
| 240 | + 'getpaid-nonce' |
|
| 241 | 241 | ) |
| 242 | - ); |
|
| 242 | + ); |
|
| 243 | 243 | |
| 244 | - $footer_text = sprintf( |
|
| 245 | - /* translators: %s: five stars */ |
|
| 246 | - __( 'If you like <strong>GetPaid</strong>, please leave us a %s rating. A huge thanks in advance!', 'invoicing' ), |
|
| 247 | - "<a href='$rating_url'>★★★★★</a>" |
|
| 248 | - ); |
|
| 244 | + $footer_text = sprintf( |
|
| 245 | + /* translators: %s: five stars */ |
|
| 246 | + __( 'If you like <strong>GetPaid</strong>, please leave us a %s rating. A huge thanks in advance!', 'invoicing' ), |
|
| 247 | + "<a href='$rating_url'>★★★★★</a>" |
|
| 248 | + ); |
|
| 249 | 249 | |
| 250 | - } else { |
|
| 250 | + } else { |
|
| 251 | 251 | |
| 252 | - $footer_text = sprintf( |
|
| 253 | - /* translators: %s: GetPaid */ |
|
| 254 | - __( 'Thank you for using %s!', 'invoicing' ), |
|
| 255 | - "<a href='https://wpgetpaid.com/' target='_blank'><strong>GetPaid</strong></a>" |
|
| 256 | - ); |
|
| 252 | + $footer_text = sprintf( |
|
| 253 | + /* translators: %s: GetPaid */ |
|
| 254 | + __( 'Thank you for using %s!', 'invoicing' ), |
|
| 255 | + "<a href='https://wpgetpaid.com/' target='_blank'><strong>GetPaid</strong></a>" |
|
| 256 | + ); |
|
| 257 | 257 | |
| 258 | - } |
|
| 258 | + } |
|
| 259 | 259 | } |
| 260 | 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() { |
|
| 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,19 +307,19 @@ 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 | $page = isset( $_GET['page'] ) ? sanitize_text_field( $_GET['page'] ) : ''; |
| 320 | 320 | |
| 321 | 321 | if ( ! empty( $current_screen->post_type ) ) { |
| 322 | - $page = $current_screen->post_type; |
|
| 322 | + $page = $current_screen->post_type; |
|
| 323 | 323 | } |
| 324 | 324 | |
| 325 | 325 | if ( false !== stripos( $page, 'wpi' ) ) { |
@@ -328,70 +328,70 @@ discard block |
||
| 328 | 328 | |
| 329 | 329 | if ( in_array( $page, wpinv_parse_list( 'wpi_invoice wpi_payment_form wpi_quote' ) ) ) { |
| 330 | 330 | $classes .= ' wpinv-cpt wpinv'; |
| 331 | - } |
|
| 331 | + } |
|
| 332 | 332 | |
| 333 | - if ( getpaid_is_invoice_post_type( $page ) ) { |
|
| 333 | + if ( getpaid_is_invoice_post_type( $page ) ) { |
|
| 334 | 334 | $classes .= ' getpaid-is-invoice-cpt'; |
| 335 | 335 | } |
| 336 | 336 | |
| 337 | - return $classes; |
|
| 337 | + return $classes; |
|
| 338 | 338 | } |
| 339 | 339 | |
| 340 | 340 | /** |
| 341 | - * Maybe show the AyeCode Connect Notice. |
|
| 342 | - */ |
|
| 343 | - public function init_ayecode_connect_helper() { |
|
| 341 | + * Maybe show the AyeCode Connect Notice. |
|
| 342 | + */ |
|
| 343 | + public function init_ayecode_connect_helper() { |
|
| 344 | 344 | |
| 345 | - // Register with the deactivation survey class. |
|
| 346 | - AyeCode_Deactivation_Survey::instance( |
|
| 345 | + // Register with the deactivation survey class. |
|
| 346 | + AyeCode_Deactivation_Survey::instance( |
|
| 347 | 347 | 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' ), |
|
| 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 | 353 | ) |
| 354 | 354 | ); |
| 355 | 355 | |
| 356 | 356 | new AyeCode_Connect_Helper( |
| 357 | 357 | array( |
| 358 | - 'connect_title' => __( 'WP Invoicing - an AyeCode product!', 'invoicing' ), |
|
| 359 | - 'connect_external' => __( 'Please confirm you wish to connect your site?', 'invoicing' ), |
|
| 360 | - 'connect' => sprintf( __( '<strong>Have a license?</strong> Forget about entering license keys or downloading zip files, connect your site for instant access. %1$slearn more%2$s', 'invoicing' ), "<a href='https://ayecode.io/introducing-ayecode-connect/' target='_blank'>", '</a>' ), |
|
| 361 | - 'connect_button' => __( 'Connect Site', 'invoicing' ), |
|
| 362 | - 'connecting_button' => __( 'Connecting...', 'invoicing' ), |
|
| 363 | - 'error_localhost' => __( 'This service will only work with a live domain, not a localhost.', 'invoicing' ), |
|
| 364 | - 'error' => __( 'Something went wrong, please refresh and try again.', 'invoicing' ), |
|
| 358 | + 'connect_title' => __( 'WP Invoicing - an AyeCode product!', 'invoicing' ), |
|
| 359 | + 'connect_external' => __( 'Please confirm you wish to connect your site?', 'invoicing' ), |
|
| 360 | + 'connect' => sprintf( __( '<strong>Have a license?</strong> Forget about entering license keys or downloading zip files, connect your site for instant access. %1$slearn more%2$s', 'invoicing' ), "<a href='https://ayecode.io/introducing-ayecode-connect/' target='_blank'>", '</a>' ), |
|
| 361 | + 'connect_button' => __( 'Connect Site', 'invoicing' ), |
|
| 362 | + 'connecting_button' => __( 'Connecting...', 'invoicing' ), |
|
| 363 | + 'error_localhost' => __( 'This service will only work with a live domain, not a localhost.', 'invoicing' ), |
|
| 364 | + 'error' => __( 'Something went wrong, please refresh and try again.', 'invoicing' ), |
|
| 365 | 365 | ), |
| 366 | 366 | array( 'wpi-addons' ) |
| 367 | 367 | ); |
| 368 | 368 | |
| 369 | 369 | } |
| 370 | 370 | |
| 371 | - /** |
|
| 372 | - * Redirect users to settings on activation. |
|
| 373 | - * |
|
| 374 | - * @return void |
|
| 375 | - */ |
|
| 376 | - public function activation_redirect() { |
|
| 371 | + /** |
|
| 372 | + * Redirect users to settings on activation. |
|
| 373 | + * |
|
| 374 | + * @return void |
|
| 375 | + */ |
|
| 376 | + public function activation_redirect() { |
|
| 377 | 377 | |
| 378 | - $redirected = get_option( 'wpinv_redirected_to_settings' ); |
|
| 378 | + $redirected = get_option( 'wpinv_redirected_to_settings' ); |
|
| 379 | 379 | |
| 380 | - if ( ! empty( $redirected ) || wp_doing_ajax() || ! current_user_can( 'manage_options' ) ) { |
|
| 381 | - return; |
|
| 382 | - } |
|
| 380 | + if ( ! empty( $redirected ) || wp_doing_ajax() || ! current_user_can( 'manage_options' ) ) { |
|
| 381 | + return; |
|
| 382 | + } |
|
| 383 | 383 | |
| 384 | - // Bail if activating from network, or bulk |
|
| 385 | - if ( is_network_admin() || isset( $_GET['activate-multi'] ) ) { |
|
| 386 | - return; |
|
| 387 | - } |
|
| 384 | + // Bail if activating from network, or bulk |
|
| 385 | + if ( is_network_admin() || isset( $_GET['activate-multi'] ) ) { |
|
| 386 | + return; |
|
| 387 | + } |
|
| 388 | 388 | |
| 389 | - update_option( 'wpinv_redirected_to_settings', 1 ); |
|
| 389 | + update_option( 'wpinv_redirected_to_settings', 1 ); |
|
| 390 | 390 | |
| 391 | 391 | wp_safe_redirect( admin_url( 'index.php?page=gp-setup' ) ); |
| 392 | 392 | exit; |
| 393 | 393 | |
| 394 | - } |
|
| 394 | + } |
|
| 395 | 395 | |
| 396 | 396 | /** |
| 397 | 397 | * Fires an admin action after verifying that a user can fire them. |
@@ -404,544 +404,544 @@ 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.', 'invoicing' ) ); |
|
| 429 | + getpaid_admin()->show_success( __( 'Invoice duplicated successfully.', 'invoicing' ) ); |
|
| 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.', 'invoicing' ) ); |
|
| 444 | + getpaid_admin()->show_error( __( 'There was an error duplicating this invoice. Please try again.', 'invoicing' ) ); |
|
| 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 | * Resets form stats. |
| 486 | - * |
|
| 487 | - * @param array $args |
|
| 486 | + * |
|
| 487 | + * @param array $args |
|
| 488 | 488 | */ |
| 489 | 489 | public function reset_form_stats( $args ) { |
| 490 | 490 | |
| 491 | - if ( empty( $args['form_id'] ) ) { |
|
| 492 | - return; |
|
| 493 | - } |
|
| 491 | + if ( empty( $args['form_id'] ) ) { |
|
| 492 | + return; |
|
| 493 | + } |
|
| 494 | 494 | |
| 495 | - $form = new GetPaid_Payment_Form( (int) $args['form_id'] ); |
|
| 495 | + $form = new GetPaid_Payment_Form( (int) $args['form_id'] ); |
|
| 496 | 496 | |
| 497 | - if ( ! $form->exists() ) { |
|
| 498 | - return; |
|
| 499 | - } |
|
| 497 | + if ( ! $form->exists() ) { |
|
| 498 | + return; |
|
| 499 | + } |
|
| 500 | 500 | |
| 501 | - $form->set_earned( 0 ); |
|
| 502 | - $form->set_refunded( 0 ); |
|
| 503 | - $form->set_cancelled( 0 ); |
|
| 504 | - $form->set_failed( 0 ); |
|
| 505 | - $form->save(); |
|
| 501 | + $form->set_earned( 0 ); |
|
| 502 | + $form->set_refunded( 0 ); |
|
| 503 | + $form->set_cancelled( 0 ); |
|
| 504 | + $form->set_failed( 0 ); |
|
| 505 | + $form->save(); |
|
| 506 | 506 | |
| 507 | - $this->show_success( __( 'Form stats reset successfully', 'invoicing' ) ); |
|
| 507 | + $this->show_success( __( 'Form stats reset successfully', 'invoicing' ) ); |
|
| 508 | 508 | |
| 509 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'form_id', 'getpaid-nonce' ) ) ); |
|
| 510 | - exit; |
|
| 511 | - } |
|
| 509 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'form_id', 'getpaid-nonce' ) ) ); |
|
| 510 | + exit; |
|
| 511 | + } |
|
| 512 | 512 | |
| 513 | - /** |
|
| 513 | + /** |
|
| 514 | 514 | * Sends a payment reminder to a customer. |
| 515 | - * |
|
| 516 | - * @param array $args |
|
| 515 | + * |
|
| 516 | + * @param array $args |
|
| 517 | 517 | */ |
| 518 | 518 | public function send_customer_invoice( $args ) { |
| 519 | - getpaid()->get( 'invoice_emails' )->user_invoice( new WPInv_Invoice( $args['invoice_id'] ), true ); |
|
| 520 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce', 'invoice_id' ) ) ); |
|
| 521 | - exit; |
|
| 522 | - } |
|
| 519 | + getpaid()->get( 'invoice_emails' )->user_invoice( new WPInv_Invoice( $args['invoice_id'] ), true ); |
|
| 520 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce', 'invoice_id' ) ) ); |
|
| 521 | + exit; |
|
| 522 | + } |
|
| 523 | 523 | |
| 524 | - /** |
|
| 524 | + /** |
|
| 525 | 525 | * Sends a payment reminder to a customer. |
| 526 | - * |
|
| 527 | - * @param array $args |
|
| 526 | + * |
|
| 527 | + * @param array $args |
|
| 528 | 528 | */ |
| 529 | 529 | public function send_customer_payment_reminder( $args ) { |
| 530 | - $sent = getpaid()->get( 'invoice_emails' )->force_send_overdue_notice( new WPInv_Invoice( $args['invoice_id'] ) ); |
|
| 530 | + $sent = getpaid()->get( 'invoice_emails' )->force_send_overdue_notice( new WPInv_Invoice( $args['invoice_id'] ) ); |
|
| 531 | 531 | |
| 532 | - if ( $sent ) { |
|
| 533 | - $this->show_success( __( 'Payment reminder was successfully sent to the customer', 'invoicing' ) ); |
|
| 534 | - } else { |
|
| 535 | - $this->show_error( __( 'Could not sent payment reminder to the customer', 'invoicing' ) ); |
|
| 536 | - } |
|
| 532 | + if ( $sent ) { |
|
| 533 | + $this->show_success( __( 'Payment reminder was successfully sent to the customer', 'invoicing' ) ); |
|
| 534 | + } else { |
|
| 535 | + $this->show_error( __( 'Could not sent payment reminder to the customer', 'invoicing' ) ); |
|
| 536 | + } |
|
| 537 | 537 | |
| 538 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce', 'invoice_id' ) ) ); |
|
| 539 | - exit; |
|
| 540 | - } |
|
| 538 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce', 'invoice_id' ) ) ); |
|
| 539 | + exit; |
|
| 540 | + } |
|
| 541 | 541 | |
| 542 | - /** |
|
| 542 | + /** |
|
| 543 | 543 | * Resets tax rates. |
| 544 | - * |
|
| 544 | + * |
|
| 545 | 545 | */ |
| 546 | 546 | public function admin_reset_tax_rates() { |
| 547 | 547 | |
| 548 | - update_option( 'wpinv_tax_rates', wpinv_get_data( 'tax-rates' ) ); |
|
| 549 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 550 | - exit; |
|
| 548 | + update_option( 'wpinv_tax_rates', wpinv_get_data( 'tax-rates' ) ); |
|
| 549 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 550 | + exit; |
|
| 551 | 551 | |
| 552 | - } |
|
| 552 | + } |
|
| 553 | 553 | |
| 554 | - /** |
|
| 554 | + /** |
|
| 555 | 555 | * Resets admin pages. |
| 556 | - * |
|
| 556 | + * |
|
| 557 | 557 | */ |
| 558 | 558 | public function admin_create_missing_pages() { |
| 559 | - $installer = new GetPaid_Installer(); |
|
| 560 | - $installer->create_pages(); |
|
| 561 | - $this->show_success( __( 'GetPaid pages updated.', 'invoicing' ) ); |
|
| 562 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 563 | - exit; |
|
| 564 | - } |
|
| 565 | - |
|
| 566 | - /** |
|
| 567 | - * Refreshes the permalinks. |
|
| 568 | - */ |
|
| 569 | - public function admin_refresh_permalinks() { |
|
| 570 | - flush_rewrite_rules(); |
|
| 571 | - $this->show_success( __( 'Permalinks refreshed.', 'invoicing' ) ); |
|
| 572 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 573 | - exit; |
|
| 574 | - } |
|
| 575 | - |
|
| 576 | - /** |
|
| 559 | + $installer = new GetPaid_Installer(); |
|
| 560 | + $installer->create_pages(); |
|
| 561 | + $this->show_success( __( 'GetPaid pages updated.', 'invoicing' ) ); |
|
| 562 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 563 | + exit; |
|
| 564 | + } |
|
| 565 | + |
|
| 566 | + /** |
|
| 567 | + * Refreshes the permalinks. |
|
| 568 | + */ |
|
| 569 | + public function admin_refresh_permalinks() { |
|
| 570 | + flush_rewrite_rules(); |
|
| 571 | + $this->show_success( __( 'Permalinks refreshed.', 'invoicing' ) ); |
|
| 572 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 573 | + exit; |
|
| 574 | + } |
|
| 575 | + |
|
| 576 | + /** |
|
| 577 | 577 | * Creates missing admin tables. |
| 578 | - * |
|
| 578 | + * |
|
| 579 | 579 | */ |
| 580 | 580 | public function admin_create_missing_tables() { |
| 581 | - global $wpdb; |
|
| 581 | + global $wpdb; |
|
| 582 | 582 | |
| 583 | - GetPaid_Installer::create_db_tables(); |
|
| 584 | - GetPaid_Installer::migrate_old_customers(); |
|
| 583 | + GetPaid_Installer::create_db_tables(); |
|
| 584 | + GetPaid_Installer::migrate_old_customers(); |
|
| 585 | 585 | |
| 586 | - if ( '' !== $wpdb->last_error ) { |
|
| 587 | - $this->show_error( __( 'Your GetPaid tables have been updated:', 'invoicing' ) . ' ' . $wpdb->last_error ); |
|
| 588 | - } else { |
|
| 589 | - $this->show_success( __( 'Your GetPaid tables have been updated.', 'invoicing' ) ); |
|
| 590 | - } |
|
| 586 | + if ( '' !== $wpdb->last_error ) { |
|
| 587 | + $this->show_error( __( 'Your GetPaid tables have been updated:', 'invoicing' ) . ' ' . $wpdb->last_error ); |
|
| 588 | + } else { |
|
| 589 | + $this->show_success( __( 'Your GetPaid tables have been updated.', 'invoicing' ) ); |
|
| 590 | + } |
|
| 591 | 591 | |
| 592 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 593 | - exit; |
|
| 594 | - } |
|
| 592 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 593 | + exit; |
|
| 594 | + } |
|
| 595 | 595 | |
| 596 | - /** |
|
| 596 | + /** |
|
| 597 | 597 | * Migrates old invoices to the new database tables. |
| 598 | - * |
|
| 598 | + * |
|
| 599 | 599 | */ |
| 600 | 600 | public function admin_migrate_old_invoices() { |
| 601 | 601 | |
| 602 | - // Migrate the invoices. |
|
| 603 | - $installer = new GetPaid_Installer(); |
|
| 604 | - $installer->migrate_old_invoices(); |
|
| 602 | + // Migrate the invoices. |
|
| 603 | + $installer = new GetPaid_Installer(); |
|
| 604 | + $installer->migrate_old_invoices(); |
|
| 605 | 605 | |
| 606 | - // Show an admin message. |
|
| 607 | - $this->show_success( __( 'Your invoices have been migrated.', 'invoicing' ) ); |
|
| 606 | + // Show an admin message. |
|
| 607 | + $this->show_success( __( 'Your invoices have been migrated.', 'invoicing' ) ); |
|
| 608 | 608 | |
| 609 | - // Redirect the admin. |
|
| 610 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 611 | - exit; |
|
| 609 | + // Redirect the admin. |
|
| 610 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 611 | + exit; |
|
| 612 | 612 | |
| 613 | - } |
|
| 613 | + } |
|
| 614 | 614 | |
| 615 | - /** |
|
| 615 | + /** |
|
| 616 | 616 | * Download customers. |
| 617 | - * |
|
| 617 | + * |
|
| 618 | 618 | */ |
| 619 | 619 | public function admin_download_customers() { |
| 620 | - global $wpdb; |
|
| 621 | - |
|
| 622 | - $output = fopen( 'php://output', 'w' ); |
|
| 623 | - |
|
| 624 | - if ( false === $output ) { |
|
| 625 | - wp_die( esc_html__( 'Unsupported server', 'invoicing' ), 500 ); |
|
| 626 | - } |
|
| 620 | + global $wpdb; |
|
| 627 | 621 | |
| 628 | - header( 'Content-Type:text/csv' ); |
|
| 629 | - header( 'Content-Disposition:attachment;filename=customers.csv' ); |
|
| 622 | + $output = fopen( 'php://output', 'w' ); |
|
| 630 | 623 | |
| 631 | - $post_types = ''; |
|
| 624 | + if ( false === $output ) { |
|
| 625 | + wp_die( esc_html__( 'Unsupported server', 'invoicing' ), 500 ); |
|
| 626 | + } |
|
| 632 | 627 | |
| 633 | - foreach ( array_keys( getpaid_get_invoice_post_types() ) as $post_type ) { |
|
| 634 | - $post_types .= $wpdb->prepare( 'post_type=%s OR ', $post_type ); |
|
| 635 | - } |
|
| 628 | + header( 'Content-Type:text/csv' ); |
|
| 629 | + header( 'Content-Disposition:attachment;filename=customers.csv' ); |
|
| 636 | 630 | |
| 637 | - $post_types = rtrim( $post_types, ' OR' ); |
|
| 631 | + $post_types = ''; |
|
| 638 | 632 | |
| 639 | - $customers = $wpdb->get_col( "SELECT DISTINCT( post_author ) FROM $wpdb->posts WHERE $post_types" ); |
|
| 633 | + foreach ( array_keys( getpaid_get_invoice_post_types() ) as $post_type ) { |
|
| 634 | + $post_types .= $wpdb->prepare( 'post_type=%s OR ', $post_type ); |
|
| 635 | + } |
|
| 640 | 636 | |
| 641 | - $columns = array( |
|
| 642 | - 'name' => __( 'Name', 'invoicing' ), |
|
| 643 | - 'email' => __( 'Email', 'invoicing' ), |
|
| 644 | - 'country' => __( 'Country', 'invoicing' ), |
|
| 645 | - 'state' => __( 'State', 'invoicing' ), |
|
| 646 | - 'city' => __( 'City', 'invoicing' ), |
|
| 647 | - 'zip' => __( 'ZIP', 'invoicing' ), |
|
| 648 | - 'address' => __( 'Address', 'invoicing' ), |
|
| 649 | - 'phone' => __( 'Phone', 'invoicing' ), |
|
| 650 | - 'company' => __( 'Company', 'invoicing' ), |
|
| 651 | - 'company_id' => __( 'Company ID', 'invoicing' ), |
|
| 652 | - 'invoices' => __( 'Invoices', 'invoicing' ), |
|
| 653 | - 'total_raw' => __( 'Total Spend', 'invoicing' ), |
|
| 654 | - 'signup' => __( 'Date created', 'invoicing' ), |
|
| 655 | - ); |
|
| 637 | + $post_types = rtrim( $post_types, ' OR' ); |
|
| 638 | + |
|
| 639 | + $customers = $wpdb->get_col( "SELECT DISTINCT( post_author ) FROM $wpdb->posts WHERE $post_types" ); |
|
| 640 | + |
|
| 641 | + $columns = array( |
|
| 642 | + 'name' => __( 'Name', 'invoicing' ), |
|
| 643 | + 'email' => __( 'Email', 'invoicing' ), |
|
| 644 | + 'country' => __( 'Country', 'invoicing' ), |
|
| 645 | + 'state' => __( 'State', 'invoicing' ), |
|
| 646 | + 'city' => __( 'City', 'invoicing' ), |
|
| 647 | + 'zip' => __( 'ZIP', 'invoicing' ), |
|
| 648 | + 'address' => __( 'Address', 'invoicing' ), |
|
| 649 | + 'phone' => __( 'Phone', 'invoicing' ), |
|
| 650 | + 'company' => __( 'Company', 'invoicing' ), |
|
| 651 | + 'company_id' => __( 'Company ID', 'invoicing' ), |
|
| 652 | + 'invoices' => __( 'Invoices', 'invoicing' ), |
|
| 653 | + 'total_raw' => __( 'Total Spend', 'invoicing' ), |
|
| 654 | + 'signup' => __( 'Date created', 'invoicing' ), |
|
| 655 | + ); |
|
| 656 | 656 | |
| 657 | - // Output the csv column headers. |
|
| 658 | - fputcsv( $output, array_values( $columns ) ); |
|
| 657 | + // Output the csv column headers. |
|
| 658 | + fputcsv( $output, array_values( $columns ) ); |
|
| 659 | 659 | |
| 660 | - // Loop through |
|
| 661 | - $table = new WPInv_Customers_Table(); |
|
| 662 | - foreach ( $customers as $customer_id ) { |
|
| 660 | + // Loop through |
|
| 661 | + $table = new WPInv_Customers_Table(); |
|
| 662 | + foreach ( $customers as $customer_id ) { |
|
| 663 | 663 | |
| 664 | - $user = get_user_by( 'id', $customer_id ); |
|
| 665 | - $row = array(); |
|
| 666 | - if ( empty( $user ) ) { |
|
| 667 | - continue; |
|
| 668 | - } |
|
| 664 | + $user = get_user_by( 'id', $customer_id ); |
|
| 665 | + $row = array(); |
|
| 666 | + if ( empty( $user ) ) { |
|
| 667 | + continue; |
|
| 668 | + } |
|
| 669 | 669 | |
| 670 | - foreach ( array_keys( $columns ) as $column ) { |
|
| 670 | + foreach ( array_keys( $columns ) as $column ) { |
|
| 671 | 671 | |
| 672 | - $method = 'column_' . $column; |
|
| 672 | + $method = 'column_' . $column; |
|
| 673 | 673 | |
| 674 | - if ( 'name' == $column ) { |
|
| 675 | - $value = esc_html( $user->display_name ); |
|
| 676 | - } elseif ( 'email' == $column ) { |
|
| 677 | - $value = sanitize_email( $user->user_email ); |
|
| 678 | - } elseif ( is_callable( array( $table, $method ) ) ) { |
|
| 679 | - $value = wp_strip_all_tags( $table->$method( $user ) ); |
|
| 680 | - } |
|
| 674 | + if ( 'name' == $column ) { |
|
| 675 | + $value = esc_html( $user->display_name ); |
|
| 676 | + } elseif ( 'email' == $column ) { |
|
| 677 | + $value = sanitize_email( $user->user_email ); |
|
| 678 | + } elseif ( is_callable( array( $table, $method ) ) ) { |
|
| 679 | + $value = wp_strip_all_tags( $table->$method( $user ) ); |
|
| 680 | + } |
|
| 681 | 681 | |
| 682 | - if ( empty( $value ) ) { |
|
| 683 | - $value = esc_html( get_user_meta( $user->ID, '_wpinv_' . $column, true ) ); |
|
| 684 | - } |
|
| 682 | + if ( empty( $value ) ) { |
|
| 683 | + $value = esc_html( get_user_meta( $user->ID, '_wpinv_' . $column, true ) ); |
|
| 684 | + } |
|
| 685 | 685 | |
| 686 | - $row[] = $value; |
|
| 686 | + $row[] = $value; |
|
| 687 | 687 | |
| 688 | - } |
|
| 688 | + } |
|
| 689 | 689 | |
| 690 | - fputcsv( $output, $row ); |
|
| 691 | - } |
|
| 690 | + fputcsv( $output, $row ); |
|
| 691 | + } |
|
| 692 | 692 | |
| 693 | - fclose( $output ); |
|
| 694 | - exit; |
|
| 693 | + fclose( $output ); |
|
| 694 | + exit; |
|
| 695 | 695 | |
| 696 | - } |
|
| 696 | + } |
|
| 697 | 697 | |
| 698 | - /** |
|
| 698 | + /** |
|
| 699 | 699 | * Installs a plugin. |
| 700 | - * |
|
| 701 | - * @param array $data |
|
| 700 | + * |
|
| 701 | + * @param array $data |
|
| 702 | 702 | */ |
| 703 | 703 | public function admin_install_plugin( $data ) { |
| 704 | 704 | |
| 705 | - if ( ! empty( $data['plugins'] ) ) { |
|
| 706 | - include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; |
|
| 707 | - wp_cache_flush(); |
|
| 705 | + if ( ! empty( $data['plugins'] ) ) { |
|
| 706 | + include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; |
|
| 707 | + wp_cache_flush(); |
|
| 708 | 708 | |
| 709 | - foreach ( $data['plugins'] as $slug => $file ) { |
|
| 710 | - $plugin_zip = esc_url( 'https://downloads.wordpress.org/plugin/' . $slug . '.latest-stable.zip' ); |
|
| 711 | - $upgrader = new Plugin_Upgrader( new Automatic_Upgrader_Skin() ); |
|
| 712 | - $installed = $upgrader->install( $plugin_zip ); |
|
| 709 | + foreach ( $data['plugins'] as $slug => $file ) { |
|
| 710 | + $plugin_zip = esc_url( 'https://downloads.wordpress.org/plugin/' . $slug . '.latest-stable.zip' ); |
|
| 711 | + $upgrader = new Plugin_Upgrader( new Automatic_Upgrader_Skin() ); |
|
| 712 | + $installed = $upgrader->install( $plugin_zip ); |
|
| 713 | 713 | |
| 714 | - if ( ! is_wp_error( $installed ) && $installed ) { |
|
| 715 | - activate_plugin( $file, '', false, true ); |
|
| 716 | - } else { |
|
| 717 | - wpinv_error_log( $upgrader->skin->get_upgrade_messages(), false ); |
|
| 718 | - } |
|
| 714 | + if ( ! is_wp_error( $installed ) && $installed ) { |
|
| 715 | + activate_plugin( $file, '', false, true ); |
|
| 716 | + } else { |
|
| 717 | + wpinv_error_log( $upgrader->skin->get_upgrade_messages(), false ); |
|
| 718 | + } |
|
| 719 | 719 | } |
| 720 | 720 | } |
| 721 | 721 | |
| 722 | - $redirect = isset( $data['redirect'] ) ? esc_url_raw( $data['redirect'] ) : admin_url( 'plugins.php' ); |
|
| 723 | - wp_safe_redirect( $redirect ); |
|
| 724 | - exit; |
|
| 722 | + $redirect = isset( $data['redirect'] ) ? esc_url_raw( $data['redirect'] ) : admin_url( 'plugins.php' ); |
|
| 723 | + wp_safe_redirect( $redirect ); |
|
| 724 | + exit; |
|
| 725 | 725 | |
| 726 | - } |
|
| 726 | + } |
|
| 727 | 727 | |
| 728 | - /** |
|
| 728 | + /** |
|
| 729 | 729 | * Connects a gateway. |
| 730 | - * |
|
| 731 | - * @param array $data |
|
| 730 | + * |
|
| 731 | + * @param array $data |
|
| 732 | 732 | */ |
| 733 | 733 | public function admin_connect_gateway( $data ) { |
| 734 | 734 | |
| 735 | - if ( ! empty( $data['plugin'] ) ) { |
|
| 735 | + if ( ! empty( $data['plugin'] ) ) { |
|
| 736 | 736 | |
| 737 | - $gateway = sanitize_key( $data['plugin'] ); |
|
| 738 | - $connect_url = apply_filters( "getpaid_get_{$gateway}_connect_url", false, $data ); |
|
| 737 | + $gateway = sanitize_key( $data['plugin'] ); |
|
| 738 | + $connect_url = apply_filters( "getpaid_get_{$gateway}_connect_url", false, $data ); |
|
| 739 | 739 | |
| 740 | - if ( ! empty( $connect_url ) ) { |
|
| 741 | - wp_redirect( $connect_url ); |
|
| 742 | - exit; |
|
| 743 | - } |
|
| 740 | + if ( ! empty( $connect_url ) ) { |
|
| 741 | + wp_redirect( $connect_url ); |
|
| 742 | + exit; |
|
| 743 | + } |
|
| 744 | 744 | |
| 745 | - if ( 'stripe' == $data['plugin'] ) { |
|
| 746 | - require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
| 747 | - include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; |
|
| 748 | - wp_cache_flush(); |
|
| 745 | + if ( 'stripe' == $data['plugin'] ) { |
|
| 746 | + require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
| 747 | + include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; |
|
| 748 | + wp_cache_flush(); |
|
| 749 | 749 | |
| 750 | - if ( ! array_key_exists( 'getpaid-stripe-payments/getpaid-stripe-payments.php', get_plugins() ) ) { |
|
| 751 | - $plugin_zip = esc_url( 'https://downloads.wordpress.org/plugin/getpaid-stripe-payments.latest-stable.zip' ); |
|
| 752 | - $upgrader = new Plugin_Upgrader( new Automatic_Upgrader_Skin() ); |
|
| 753 | - $upgrader->install( $plugin_zip ); |
|
| 754 | - } |
|
| 750 | + if ( ! array_key_exists( 'getpaid-stripe-payments/getpaid-stripe-payments.php', get_plugins() ) ) { |
|
| 751 | + $plugin_zip = esc_url( 'https://downloads.wordpress.org/plugin/getpaid-stripe-payments.latest-stable.zip' ); |
|
| 752 | + $upgrader = new Plugin_Upgrader( new Automatic_Upgrader_Skin() ); |
|
| 753 | + $upgrader->install( $plugin_zip ); |
|
| 754 | + } |
|
| 755 | 755 | |
| 756 | - activate_plugin( 'getpaid-stripe-payments/getpaid-stripe-payments.php', '', false, true ); |
|
| 757 | - } |
|
| 756 | + activate_plugin( 'getpaid-stripe-payments/getpaid-stripe-payments.php', '', false, true ); |
|
| 757 | + } |
|
| 758 | 758 | |
| 759 | - $connect_url = apply_filters( "getpaid_get_{$gateway}_connect_url", false, $data ); |
|
| 760 | - if ( ! empty( $connect_url ) ) { |
|
| 761 | - wp_redirect( $connect_url ); |
|
| 762 | - exit; |
|
| 763 | - } |
|
| 759 | + $connect_url = apply_filters( "getpaid_get_{$gateway}_connect_url", false, $data ); |
|
| 760 | + if ( ! empty( $connect_url ) ) { |
|
| 761 | + wp_redirect( $connect_url ); |
|
| 762 | + exit; |
|
| 763 | + } |
|
| 764 | 764 | } |
| 765 | 765 | |
| 766 | - $redirect = isset( $data['redirect'] ) ? esc_url_raw( urldecode( $data['redirect'] ) ) : admin_url( 'admin.php?page=wpinv-settings&tab=gateways' ); |
|
| 767 | - wp_safe_redirect( $redirect ); |
|
| 768 | - exit; |
|
| 766 | + $redirect = isset( $data['redirect'] ) ? esc_url_raw( urldecode( $data['redirect'] ) ) : admin_url( 'admin.php?page=wpinv-settings&tab=gateways' ); |
|
| 767 | + wp_safe_redirect( $redirect ); |
|
| 768 | + exit; |
|
| 769 | 769 | |
| 770 | - } |
|
| 770 | + } |
|
| 771 | 771 | |
| 772 | - /** |
|
| 772 | + /** |
|
| 773 | 773 | * Recalculates discounts. |
| 774 | - * |
|
| 774 | + * |
|
| 775 | 775 | */ |
| 776 | 776 | public function admin_recalculate_discounts() { |
| 777 | - global $wpdb; |
|
| 777 | + global $wpdb; |
|
| 778 | 778 | |
| 779 | - // Fetch all invoices that have discount codes. |
|
| 780 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 781 | - $invoices = $wpdb->get_col( "SELECT `post_id` FROM `$table` WHERE `discount` = 0 && `discount_code` <> ''" ); |
|
| 779 | + // Fetch all invoices that have discount codes. |
|
| 780 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 781 | + $invoices = $wpdb->get_col( "SELECT `post_id` FROM `$table` WHERE `discount` = 0 && `discount_code` <> ''" ); |
|
| 782 | 782 | |
| 783 | - foreach ( $invoices as $invoice ) { |
|
| 783 | + foreach ( $invoices as $invoice ) { |
|
| 784 | 784 | |
| 785 | - $invoice = new WPInv_Invoice( $invoice ); |
|
| 785 | + $invoice = new WPInv_Invoice( $invoice ); |
|
| 786 | 786 | |
| 787 | - if ( ! $invoice->exists() ) { |
|
| 788 | - continue; |
|
| 789 | - } |
|
| 787 | + if ( ! $invoice->exists() ) { |
|
| 788 | + continue; |
|
| 789 | + } |
|
| 790 | 790 | |
| 791 | - // Abort if the discount does not exist or does not apply here. |
|
| 792 | - $discount = new WPInv_Discount( $invoice->get_discount_code() ); |
|
| 793 | - if ( ! $discount->exists() ) { |
|
| 794 | - continue; |
|
| 795 | - } |
|
| 791 | + // Abort if the discount does not exist or does not apply here. |
|
| 792 | + $discount = new WPInv_Discount( $invoice->get_discount_code() ); |
|
| 793 | + if ( ! $discount->exists() ) { |
|
| 794 | + continue; |
|
| 795 | + } |
|
| 796 | 796 | |
| 797 | - $invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) ); |
|
| 798 | - $invoice->recalculate_total(); |
|
| 797 | + $invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) ); |
|
| 798 | + $invoice->recalculate_total(); |
|
| 799 | 799 | |
| 800 | - if ( $invoice->get_total_discount() > 0 ) { |
|
| 801 | - $invoice->save(); |
|
| 802 | - } |
|
| 800 | + if ( $invoice->get_total_discount() > 0 ) { |
|
| 801 | + $invoice->save(); |
|
| 802 | + } |
|
| 803 | 803 | } |
| 804 | 804 | |
| 805 | - // Show an admin message. |
|
| 806 | - $this->show_success( __( 'Discounts have been recalculated.', 'invoicing' ) ); |
|
| 805 | + // Show an admin message. |
|
| 806 | + $this->show_success( __( 'Discounts have been recalculated.', 'invoicing' ) ); |
|
| 807 | 807 | |
| 808 | - // Redirect the admin. |
|
| 809 | - wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 810 | - exit; |
|
| 808 | + // Redirect the admin. |
|
| 809 | + wp_safe_redirect( remove_query_arg( array( 'getpaid-admin-action', 'getpaid-nonce' ) ) ); |
|
| 810 | + exit; |
|
| 811 | 811 | |
| 812 | - } |
|
| 812 | + } |
|
| 813 | 813 | |
| 814 | 814 | /** |
| 815 | - * Returns an array of admin notices. |
|
| 816 | - * |
|
| 817 | - * @since 1.0.19 |
|
| 815 | + * Returns an array of admin notices. |
|
| 816 | + * |
|
| 817 | + * @since 1.0.19 |
|
| 818 | 818 | * @return array |
| 819 | - */ |
|
| 820 | - public function get_notices() { |
|
| 821 | - $notices = get_option( 'wpinv_admin_notices' ); |
|
| 819 | + */ |
|
| 820 | + public function get_notices() { |
|
| 821 | + $notices = get_option( 'wpinv_admin_notices' ); |
|
| 822 | 822 | return is_array( $notices ) ? $notices : array(); |
| 823 | - } |
|
| 823 | + } |
|
| 824 | 824 | |
| 825 | - /** |
|
| 826 | - * Checks if we have any admin notices. |
|
| 827 | - * |
|
| 828 | - * @since 2.0.4 |
|
| 825 | + /** |
|
| 826 | + * Checks if we have any admin notices. |
|
| 827 | + * |
|
| 828 | + * @since 2.0.4 |
|
| 829 | 829 | * @return array |
| 830 | - */ |
|
| 831 | - public function has_notices() { |
|
| 832 | - return count( $this->get_notices() ) > 0; |
|
| 833 | - } |
|
| 834 | - |
|
| 835 | - /** |
|
| 836 | - * Clears all admin notices |
|
| 837 | - * |
|
| 838 | - * @access public |
|
| 839 | - * @since 1.0.19 |
|
| 840 | - */ |
|
| 841 | - public function clear_notices() { |
|
| 842 | - delete_option( 'wpinv_admin_notices' ); |
|
| 843 | - } |
|
| 844 | - |
|
| 845 | - /** |
|
| 846 | - * Saves a new admin notice |
|
| 847 | - * |
|
| 848 | - * @access public |
|
| 849 | - * @since 1.0.19 |
|
| 850 | - */ |
|
| 851 | - public function save_notice( $type, $message ) { |
|
| 852 | - $notices = $this->get_notices(); |
|
| 853 | - |
|
| 854 | - if ( empty( $notices[ $type ] ) || ! is_array( $notices[ $type ] ) ) { |
|
| 855 | - $notices[ $type ] = array(); |
|
| 856 | - } |
|
| 857 | - |
|
| 858 | - $notices[ $type ][] = $message; |
|
| 859 | - |
|
| 860 | - update_option( 'wpinv_admin_notices', $notices ); |
|
| 861 | - } |
|
| 862 | - |
|
| 863 | - /** |
|
| 864 | - * Displays a success notice |
|
| 865 | - * |
|
| 866 | - * @param string $msg The message to qeue. |
|
| 867 | - * @access public |
|
| 868 | - * @since 1.0.19 |
|
| 869 | - */ |
|
| 870 | - public function show_success( $msg ) { |
|
| 871 | - $this->save_notice( 'success', $msg ); |
|
| 872 | - } |
|
| 873 | - |
|
| 874 | - /** |
|
| 875 | - * Displays a error notice |
|
| 876 | - * |
|
| 877 | - * @access public |
|
| 878 | - * @param string $msg The message to qeue. |
|
| 879 | - * @since 1.0.19 |
|
| 880 | - */ |
|
| 881 | - public function show_error( $msg ) { |
|
| 882 | - $this->save_notice( 'error', $msg ); |
|
| 883 | - } |
|
| 884 | - |
|
| 885 | - /** |
|
| 886 | - * Displays a warning notice |
|
| 887 | - * |
|
| 888 | - * @access public |
|
| 889 | - * @param string $msg The message to qeue. |
|
| 890 | - * @since 1.0.19 |
|
| 891 | - */ |
|
| 892 | - public function show_warning( $msg ) { |
|
| 893 | - $this->save_notice( 'warning', $msg ); |
|
| 894 | - } |
|
| 895 | - |
|
| 896 | - /** |
|
| 897 | - * Displays a info notice |
|
| 898 | - * |
|
| 899 | - * @access public |
|
| 900 | - * @param string $msg The message to qeue. |
|
| 901 | - * @since 1.0.19 |
|
| 902 | - */ |
|
| 903 | - public function show_info( $msg ) { |
|
| 904 | - $this->save_notice( 'info', $msg ); |
|
| 905 | - } |
|
| 906 | - |
|
| 907 | - /** |
|
| 908 | - * Show notices |
|
| 909 | - * |
|
| 910 | - * @access public |
|
| 911 | - * @since 1.0.19 |
|
| 912 | - */ |
|
| 913 | - public function show_notices() { |
|
| 830 | + */ |
|
| 831 | + public function has_notices() { |
|
| 832 | + return count( $this->get_notices() ) > 0; |
|
| 833 | + } |
|
| 834 | + |
|
| 835 | + /** |
|
| 836 | + * Clears all admin notices |
|
| 837 | + * |
|
| 838 | + * @access public |
|
| 839 | + * @since 1.0.19 |
|
| 840 | + */ |
|
| 841 | + public function clear_notices() { |
|
| 842 | + delete_option( 'wpinv_admin_notices' ); |
|
| 843 | + } |
|
| 844 | + |
|
| 845 | + /** |
|
| 846 | + * Saves a new admin notice |
|
| 847 | + * |
|
| 848 | + * @access public |
|
| 849 | + * @since 1.0.19 |
|
| 850 | + */ |
|
| 851 | + public function save_notice( $type, $message ) { |
|
| 852 | + $notices = $this->get_notices(); |
|
| 853 | + |
|
| 854 | + if ( empty( $notices[ $type ] ) || ! is_array( $notices[ $type ] ) ) { |
|
| 855 | + $notices[ $type ] = array(); |
|
| 856 | + } |
|
| 857 | + |
|
| 858 | + $notices[ $type ][] = $message; |
|
| 859 | + |
|
| 860 | + update_option( 'wpinv_admin_notices', $notices ); |
|
| 861 | + } |
|
| 862 | + |
|
| 863 | + /** |
|
| 864 | + * Displays a success notice |
|
| 865 | + * |
|
| 866 | + * @param string $msg The message to qeue. |
|
| 867 | + * @access public |
|
| 868 | + * @since 1.0.19 |
|
| 869 | + */ |
|
| 870 | + public function show_success( $msg ) { |
|
| 871 | + $this->save_notice( 'success', $msg ); |
|
| 872 | + } |
|
| 873 | + |
|
| 874 | + /** |
|
| 875 | + * Displays a error notice |
|
| 876 | + * |
|
| 877 | + * @access public |
|
| 878 | + * @param string $msg The message to qeue. |
|
| 879 | + * @since 1.0.19 |
|
| 880 | + */ |
|
| 881 | + public function show_error( $msg ) { |
|
| 882 | + $this->save_notice( 'error', $msg ); |
|
| 883 | + } |
|
| 884 | + |
|
| 885 | + /** |
|
| 886 | + * Displays a warning notice |
|
| 887 | + * |
|
| 888 | + * @access public |
|
| 889 | + * @param string $msg The message to qeue. |
|
| 890 | + * @since 1.0.19 |
|
| 891 | + */ |
|
| 892 | + public function show_warning( $msg ) { |
|
| 893 | + $this->save_notice( 'warning', $msg ); |
|
| 894 | + } |
|
| 895 | + |
|
| 896 | + /** |
|
| 897 | + * Displays a info notice |
|
| 898 | + * |
|
| 899 | + * @access public |
|
| 900 | + * @param string $msg The message to qeue. |
|
| 901 | + * @since 1.0.19 |
|
| 902 | + */ |
|
| 903 | + public function show_info( $msg ) { |
|
| 904 | + $this->save_notice( 'info', $msg ); |
|
| 905 | + } |
|
| 906 | + |
|
| 907 | + /** |
|
| 908 | + * Show notices |
|
| 909 | + * |
|
| 910 | + * @access public |
|
| 911 | + * @since 1.0.19 |
|
| 912 | + */ |
|
| 913 | + public function show_notices() { |
|
| 914 | 914 | |
| 915 | 915 | $notices = $this->get_notices(); |
| 916 | 916 | $this->clear_notices(); |
| 917 | 917 | |
| 918 | - foreach ( $notices as $type => $messages ) { |
|
| 918 | + foreach ( $notices as $type => $messages ) { |
|
| 919 | 919 | |
| 920 | - if ( ! is_array( $messages ) ) { |
|
| 921 | - continue; |
|
| 922 | - } |
|
| 920 | + if ( ! is_array( $messages ) ) { |
|
| 921 | + continue; |
|
| 922 | + } |
|
| 923 | 923 | |
| 924 | 924 | $type = esc_attr( $type ); |
| 925 | - foreach ( $messages as $message ) { |
|
| 926 | - echo wp_kses_post( "<div class='notice notice-$type is-dismissible'><p>$message</p></div>" ); |
|
| 925 | + foreach ( $messages as $message ) { |
|
| 926 | + echo wp_kses_post( "<div class='notice notice-$type is-dismissible'><p>$message</p></div>" ); |
|
| 927 | 927 | } |
| 928 | 928 | } |
| 929 | 929 | |
| 930 | - foreach ( array( 'checkout_page', 'invoice_history_page', 'success_page', 'failure_page', 'invoice_subscription_page' ) as $page ) { |
|
| 931 | - |
|
| 932 | - if ( ! is_numeric( wpinv_get_option( $page, false ) ) ) { |
|
| 933 | - $url = wp_nonce_url( |
|
| 934 | - add_query_arg( 'getpaid-admin-action', 'create_missing_pages' ), |
|
| 935 | - 'getpaid-nonce', |
|
| 936 | - 'getpaid-nonce' |
|
| 937 | - ); |
|
| 938 | - $message = __( 'Some GetPaid pages are missing. To use GetPaid without any issues, click the button below to generate the missing pages.', 'invoicing' ); |
|
| 939 | - $message2 = __( 'Generate Pages', 'invoicing' ); |
|
| 940 | - echo wp_kses_post( "<div class='notice notice-warning is-dismissible'><p>$message<br><br><a href='$url' class='button button-primary'>$message2</a></p></div>" ); |
|
| 941 | - break; |
|
| 942 | - } |
|
| 930 | + foreach ( array( 'checkout_page', 'invoice_history_page', 'success_page', 'failure_page', 'invoice_subscription_page' ) as $page ) { |
|
| 931 | + |
|
| 932 | + if ( ! is_numeric( wpinv_get_option( $page, false ) ) ) { |
|
| 933 | + $url = wp_nonce_url( |
|
| 934 | + add_query_arg( 'getpaid-admin-action', 'create_missing_pages' ), |
|
| 935 | + 'getpaid-nonce', |
|
| 936 | + 'getpaid-nonce' |
|
| 937 | + ); |
|
| 938 | + $message = __( 'Some GetPaid pages are missing. To use GetPaid without any issues, click the button below to generate the missing pages.', 'invoicing' ); |
|
| 939 | + $message2 = __( 'Generate Pages', 'invoicing' ); |
|
| 940 | + echo wp_kses_post( "<div class='notice notice-warning is-dismissible'><p>$message<br><br><a href='$url' class='button button-primary'>$message2</a></p></div>" ); |
|
| 941 | + break; |
|
| 942 | + } |
|
| 943 | 943 | } |
| 944 | 944 | |
| 945 | - } |
|
| 945 | + } |
|
| 946 | 946 | |
| 947 | 947 | } |
@@ -20,402 +20,402 @@ discard block |
||
| 20 | 20 | */ |
| 21 | 21 | class GetPaid_Installer { |
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * Upgrades the install. |
|
| 25 | - * |
|
| 26 | - * @param string $upgrade_from The current invoicing version. |
|
| 27 | - */ |
|
| 28 | - public function upgrade_db( $upgrade_from ) { |
|
| 29 | - |
|
| 30 | - // Save the current invoicing version. |
|
| 31 | - update_option( 'wpinv_version', WPINV_VERSION ); |
|
| 32 | - |
|
| 33 | - // Setup the invoice Custom Post Type. |
|
| 34 | - GetPaid_Post_Types::register_post_types(); |
|
| 35 | - |
|
| 36 | - // Clear the permalinks |
|
| 37 | - flush_rewrite_rules(); |
|
| 38 | - |
|
| 39 | - // Maybe create new/missing pages. |
|
| 40 | - $this->create_pages(); |
|
| 41 | - |
|
| 42 | - // Maybe re(add) admin capabilities. |
|
| 43 | - $this->add_capabilities(); |
|
| 44 | - |
|
| 45 | - // Maybe create the default payment form. |
|
| 46 | - wpinv_get_default_payment_form(); |
|
| 47 | - |
|
| 48 | - // Create any missing database tables. |
|
| 49 | - $method = "upgrade_from_$upgrade_from"; |
|
| 50 | - |
|
| 51 | - $installed = get_option( 'gepaid_installed_on' ); |
|
| 52 | - |
|
| 53 | - if ( empty( $installed ) ) { |
|
| 54 | - update_option( 'gepaid_installed_on', time() ); |
|
| 55 | - } |
|
| 56 | - |
|
| 57 | - if ( method_exists( $this, $method ) ) { |
|
| 58 | - $this->$method(); |
|
| 59 | - } |
|
| 60 | - |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Do a fresh install. |
|
| 65 | - * |
|
| 66 | - */ |
|
| 67 | - public function upgrade_from_0() { |
|
| 68 | - |
|
| 69 | - // Save default tax rates. |
|
| 70 | - update_option( 'wpinv_tax_rates', wpinv_get_data( 'tax-rates' ) ); |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - /** |
|
| 74 | - * Upgrade to 0.0.5 |
|
| 75 | - * |
|
| 76 | - */ |
|
| 77 | - public function upgrade_from_004() { |
|
| 78 | - global $wpdb; |
|
| 79 | - |
|
| 80 | - // Invoices. |
|
| 81 | - $results = $wpdb->get_results( "SELECT ID FROM {$wpdb->posts} WHERE post_type = 'wpi_invoice' AND post_status IN( 'pending', 'processing', 'onhold', 'refunded', 'cancelled', 'failed', 'renewal' )" ); |
|
| 82 | - if ( ! empty( $results ) ) { |
|
| 83 | - $wpdb->query( "UPDATE {$wpdb->posts} SET post_status = CONCAT( 'wpi-', post_status ) WHERE post_type = 'wpi_invoice' AND post_status IN( 'pending', 'processing', 'onhold', 'refunded', 'cancelled', 'failed', 'renewal' )" ); |
|
| 84 | - |
|
| 85 | - // Clean post cache |
|
| 86 | - foreach ( $results as $row ) { |
|
| 87 | - clean_post_cache( $row->ID ); |
|
| 88 | - } |
|
| 89 | - } |
|
| 90 | - |
|
| 91 | - // Item meta key changes |
|
| 92 | - $query = 'SELECT DISTINCT post_id FROM ' . $wpdb->postmeta . " WHERE meta_key IN( '_wpinv_item_id', '_wpinv_package_id', '_wpinv_post_id', '_wpinv_cpt_name', '_wpinv_cpt_singular_name' )"; |
|
| 93 | - $results = $wpdb->get_results( $query ); |
|
| 94 | - |
|
| 95 | - if ( ! empty( $results ) ) { |
|
| 96 | - $wpdb->query( 'UPDATE ' . $wpdb->postmeta . " SET meta_key = '_wpinv_custom_id' WHERE meta_key IN( '_wpinv_item_id', '_wpinv_package_id', '_wpinv_post_id' )" ); |
|
| 97 | - $wpdb->query( 'UPDATE ' . $wpdb->postmeta . " SET meta_key = '_wpinv_custom_name' WHERE meta_key = '_wpinv_cpt_name'" ); |
|
| 98 | - $wpdb->query( 'UPDATE ' . $wpdb->postmeta . " SET meta_key = '_wpinv_custom_singular_name' WHERE meta_key = '_wpinv_cpt_singular_name'" ); |
|
| 99 | - |
|
| 100 | - foreach ( $results as $row ) { |
|
| 101 | - clean_post_cache( $row->post_id ); |
|
| 102 | - } |
|
| 103 | - } |
|
| 104 | - |
|
| 105 | - $this->upgrade_from_118(); |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * Upgrade to version 2.0.0. |
|
| 110 | - * |
|
| 111 | - */ |
|
| 112 | - public function upgrade_from_118() { |
|
| 113 | - $this->migrate_old_invoices(); |
|
| 114 | - $this->upgrade_from_279(); |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * Upgrade to version 2.0.0. |
|
| 119 | - * |
|
| 120 | - */ |
|
| 121 | - public function upgrade_from_279() { |
|
| 122 | - self::migrate_old_customers(); |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - /** |
|
| 126 | - * Give administrators the capability to manage GetPaid. |
|
| 127 | - * |
|
| 128 | - */ |
|
| 129 | - public function add_capabilities() { |
|
| 130 | - $GLOBALS['wp_roles']->add_cap( 'administrator', 'manage_invoicing' ); |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Retreives GetPaid pages. |
|
| 135 | - * |
|
| 136 | - */ |
|
| 137 | - public static function get_pages() { |
|
| 138 | - |
|
| 139 | - return apply_filters( |
|
| 140 | - 'wpinv_create_pages', |
|
| 141 | - array( |
|
| 142 | - |
|
| 143 | - // Checkout page. |
|
| 144 | - 'checkout_page' => array( |
|
| 145 | - 'name' => _x( 'gp-checkout', 'Page slug', 'invoicing' ), |
|
| 146 | - 'title' => _x( 'Checkout', 'Page title', 'invoicing' ), |
|
| 147 | - 'content' => ' |
|
| 23 | + /** |
|
| 24 | + * Upgrades the install. |
|
| 25 | + * |
|
| 26 | + * @param string $upgrade_from The current invoicing version. |
|
| 27 | + */ |
|
| 28 | + public function upgrade_db( $upgrade_from ) { |
|
| 29 | + |
|
| 30 | + // Save the current invoicing version. |
|
| 31 | + update_option( 'wpinv_version', WPINV_VERSION ); |
|
| 32 | + |
|
| 33 | + // Setup the invoice Custom Post Type. |
|
| 34 | + GetPaid_Post_Types::register_post_types(); |
|
| 35 | + |
|
| 36 | + // Clear the permalinks |
|
| 37 | + flush_rewrite_rules(); |
|
| 38 | + |
|
| 39 | + // Maybe create new/missing pages. |
|
| 40 | + $this->create_pages(); |
|
| 41 | + |
|
| 42 | + // Maybe re(add) admin capabilities. |
|
| 43 | + $this->add_capabilities(); |
|
| 44 | + |
|
| 45 | + // Maybe create the default payment form. |
|
| 46 | + wpinv_get_default_payment_form(); |
|
| 47 | + |
|
| 48 | + // Create any missing database tables. |
|
| 49 | + $method = "upgrade_from_$upgrade_from"; |
|
| 50 | + |
|
| 51 | + $installed = get_option( 'gepaid_installed_on' ); |
|
| 52 | + |
|
| 53 | + if ( empty( $installed ) ) { |
|
| 54 | + update_option( 'gepaid_installed_on', time() ); |
|
| 55 | + } |
|
| 56 | + |
|
| 57 | + if ( method_exists( $this, $method ) ) { |
|
| 58 | + $this->$method(); |
|
| 59 | + } |
|
| 60 | + |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Do a fresh install. |
|
| 65 | + * |
|
| 66 | + */ |
|
| 67 | + public function upgrade_from_0() { |
|
| 68 | + |
|
| 69 | + // Save default tax rates. |
|
| 70 | + update_option( 'wpinv_tax_rates', wpinv_get_data( 'tax-rates' ) ); |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + /** |
|
| 74 | + * Upgrade to 0.0.5 |
|
| 75 | + * |
|
| 76 | + */ |
|
| 77 | + public function upgrade_from_004() { |
|
| 78 | + global $wpdb; |
|
| 79 | + |
|
| 80 | + // Invoices. |
|
| 81 | + $results = $wpdb->get_results( "SELECT ID FROM {$wpdb->posts} WHERE post_type = 'wpi_invoice' AND post_status IN( 'pending', 'processing', 'onhold', 'refunded', 'cancelled', 'failed', 'renewal' )" ); |
|
| 82 | + if ( ! empty( $results ) ) { |
|
| 83 | + $wpdb->query( "UPDATE {$wpdb->posts} SET post_status = CONCAT( 'wpi-', post_status ) WHERE post_type = 'wpi_invoice' AND post_status IN( 'pending', 'processing', 'onhold', 'refunded', 'cancelled', 'failed', 'renewal' )" ); |
|
| 84 | + |
|
| 85 | + // Clean post cache |
|
| 86 | + foreach ( $results as $row ) { |
|
| 87 | + clean_post_cache( $row->ID ); |
|
| 88 | + } |
|
| 89 | + } |
|
| 90 | + |
|
| 91 | + // Item meta key changes |
|
| 92 | + $query = 'SELECT DISTINCT post_id FROM ' . $wpdb->postmeta . " WHERE meta_key IN( '_wpinv_item_id', '_wpinv_package_id', '_wpinv_post_id', '_wpinv_cpt_name', '_wpinv_cpt_singular_name' )"; |
|
| 93 | + $results = $wpdb->get_results( $query ); |
|
| 94 | + |
|
| 95 | + if ( ! empty( $results ) ) { |
|
| 96 | + $wpdb->query( 'UPDATE ' . $wpdb->postmeta . " SET meta_key = '_wpinv_custom_id' WHERE meta_key IN( '_wpinv_item_id', '_wpinv_package_id', '_wpinv_post_id' )" ); |
|
| 97 | + $wpdb->query( 'UPDATE ' . $wpdb->postmeta . " SET meta_key = '_wpinv_custom_name' WHERE meta_key = '_wpinv_cpt_name'" ); |
|
| 98 | + $wpdb->query( 'UPDATE ' . $wpdb->postmeta . " SET meta_key = '_wpinv_custom_singular_name' WHERE meta_key = '_wpinv_cpt_singular_name'" ); |
|
| 99 | + |
|
| 100 | + foreach ( $results as $row ) { |
|
| 101 | + clean_post_cache( $row->post_id ); |
|
| 102 | + } |
|
| 103 | + } |
|
| 104 | + |
|
| 105 | + $this->upgrade_from_118(); |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * Upgrade to version 2.0.0. |
|
| 110 | + * |
|
| 111 | + */ |
|
| 112 | + public function upgrade_from_118() { |
|
| 113 | + $this->migrate_old_invoices(); |
|
| 114 | + $this->upgrade_from_279(); |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * Upgrade to version 2.0.0. |
|
| 119 | + * |
|
| 120 | + */ |
|
| 121 | + public function upgrade_from_279() { |
|
| 122 | + self::migrate_old_customers(); |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + /** |
|
| 126 | + * Give administrators the capability to manage GetPaid. |
|
| 127 | + * |
|
| 128 | + */ |
|
| 129 | + public function add_capabilities() { |
|
| 130 | + $GLOBALS['wp_roles']->add_cap( 'administrator', 'manage_invoicing' ); |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Retreives GetPaid pages. |
|
| 135 | + * |
|
| 136 | + */ |
|
| 137 | + public static function get_pages() { |
|
| 138 | + |
|
| 139 | + return apply_filters( |
|
| 140 | + 'wpinv_create_pages', |
|
| 141 | + array( |
|
| 142 | + |
|
| 143 | + // Checkout page. |
|
| 144 | + 'checkout_page' => array( |
|
| 145 | + 'name' => _x( 'gp-checkout', 'Page slug', 'invoicing' ), |
|
| 146 | + 'title' => _x( 'Checkout', 'Page title', 'invoicing' ), |
|
| 147 | + 'content' => ' |
|
| 148 | 148 | <!-- wp:shortcode --> |
| 149 | 149 | [wpinv_checkout] |
| 150 | 150 | <!-- /wp:shortcode --> |
| 151 | 151 | ', |
| 152 | - 'parent' => '', |
|
| 153 | - ), |
|
| 154 | - |
|
| 155 | - // Invoice history page. |
|
| 156 | - 'invoice_history_page' => array( |
|
| 157 | - 'name' => _x( 'gp-invoices', 'Page slug', 'invoicing' ), |
|
| 158 | - 'title' => _x( 'My Invoices', 'Page title', 'invoicing' ), |
|
| 159 | - 'content' => ' |
|
| 152 | + 'parent' => '', |
|
| 153 | + ), |
|
| 154 | + |
|
| 155 | + // Invoice history page. |
|
| 156 | + 'invoice_history_page' => array( |
|
| 157 | + 'name' => _x( 'gp-invoices', 'Page slug', 'invoicing' ), |
|
| 158 | + 'title' => _x( 'My Invoices', 'Page title', 'invoicing' ), |
|
| 159 | + 'content' => ' |
|
| 160 | 160 | <!-- wp:shortcode --> |
| 161 | 161 | [wpinv_history] |
| 162 | 162 | <!-- /wp:shortcode --> |
| 163 | 163 | ', |
| 164 | - 'parent' => '', |
|
| 165 | - ), |
|
| 166 | - |
|
| 167 | - // Success page content. |
|
| 168 | - 'success_page' => array( |
|
| 169 | - 'name' => _x( 'gp-receipt', 'Page slug', 'invoicing' ), |
|
| 170 | - 'title' => _x( 'Payment Confirmation', 'Page title', 'invoicing' ), |
|
| 171 | - 'content' => ' |
|
| 164 | + 'parent' => '', |
|
| 165 | + ), |
|
| 166 | + |
|
| 167 | + // Success page content. |
|
| 168 | + 'success_page' => array( |
|
| 169 | + 'name' => _x( 'gp-receipt', 'Page slug', 'invoicing' ), |
|
| 170 | + 'title' => _x( 'Payment Confirmation', 'Page title', 'invoicing' ), |
|
| 171 | + 'content' => ' |
|
| 172 | 172 | <!-- wp:shortcode --> |
| 173 | 173 | [wpinv_receipt] |
| 174 | 174 | <!-- /wp:shortcode --> |
| 175 | 175 | ', |
| 176 | - 'parent' => 'gp-checkout', |
|
| 177 | - ), |
|
| 178 | - |
|
| 179 | - // Failure page content. |
|
| 180 | - 'failure_page' => array( |
|
| 181 | - 'name' => _x( 'gp-transaction-failed', 'Page slug', 'invoicing' ), |
|
| 182 | - 'title' => _x( 'Transaction Failed', 'Page title', 'invoicing' ), |
|
| 183 | - 'content' => __( 'Your transaction failed, please try again or contact site support.', 'invoicing' ), |
|
| 184 | - 'parent' => 'gp-checkout', |
|
| 185 | - ), |
|
| 186 | - |
|
| 187 | - // Subscriptions history page. |
|
| 188 | - 'invoice_subscription_page' => array( |
|
| 189 | - 'name' => _x( 'gp-subscriptions', 'Page slug', 'invoicing' ), |
|
| 190 | - 'title' => _x( 'My Subscriptions', 'Page title', 'invoicing' ), |
|
| 191 | - 'content' => ' |
|
| 176 | + 'parent' => 'gp-checkout', |
|
| 177 | + ), |
|
| 178 | + |
|
| 179 | + // Failure page content. |
|
| 180 | + 'failure_page' => array( |
|
| 181 | + 'name' => _x( 'gp-transaction-failed', 'Page slug', 'invoicing' ), |
|
| 182 | + 'title' => _x( 'Transaction Failed', 'Page title', 'invoicing' ), |
|
| 183 | + 'content' => __( 'Your transaction failed, please try again or contact site support.', 'invoicing' ), |
|
| 184 | + 'parent' => 'gp-checkout', |
|
| 185 | + ), |
|
| 186 | + |
|
| 187 | + // Subscriptions history page. |
|
| 188 | + 'invoice_subscription_page' => array( |
|
| 189 | + 'name' => _x( 'gp-subscriptions', 'Page slug', 'invoicing' ), |
|
| 190 | + 'title' => _x( 'My Subscriptions', 'Page title', 'invoicing' ), |
|
| 191 | + 'content' => ' |
|
| 192 | 192 | <!-- wp:shortcode --> |
| 193 | 193 | [wpinv_subscriptions] |
| 194 | 194 | <!-- /wp:shortcode --> |
| 195 | 195 | ', |
| 196 | - 'parent' => '', |
|
| 197 | - ), |
|
| 198 | - |
|
| 199 | - ) |
|
| 200 | - ); |
|
| 201 | - |
|
| 202 | - } |
|
| 203 | - |
|
| 204 | - /** |
|
| 205 | - * Re-create GetPaid pages. |
|
| 206 | - * |
|
| 207 | - */ |
|
| 208 | - public function create_pages() { |
|
| 209 | - |
|
| 210 | - foreach ( self::get_pages() as $key => $page ) { |
|
| 211 | - wpinv_create_page( esc_sql( $page['name'] ), $key, $page['title'], $page['content'], $page['parent'] ); |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - } |
|
| 215 | - |
|
| 216 | - /** |
|
| 217 | - * Migrates old invoices to new invoices. |
|
| 218 | - * |
|
| 219 | - */ |
|
| 220 | - public function migrate_old_invoices() { |
|
| 221 | - global $wpdb; |
|
| 222 | - |
|
| 223 | - $invoices_table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 224 | - $invoice_items_table = $wpdb->prefix . 'getpaid_invoice_items'; |
|
| 225 | - $migrated = $wpdb->get_col( "SELECT post_id FROM $invoices_table" ); |
|
| 226 | - $invoices = array_unique( |
|
| 227 | - get_posts( |
|
| 228 | - array( |
|
| 229 | - 'post_type' => array( 'wpi_invoice', 'wpi_quote' ), |
|
| 230 | - 'posts_per_page' => -1, |
|
| 231 | - 'fields' => 'ids', |
|
| 232 | - 'post_status' => array_keys( get_post_stati() ), |
|
| 233 | - 'exclude' => (array) $migrated, |
|
| 234 | - ) |
|
| 235 | - ) |
|
| 236 | - ); |
|
| 237 | - |
|
| 238 | - // Abort if we do not have any invoices. |
|
| 239 | - if ( empty( $invoices ) ) { |
|
| 240 | - return; |
|
| 241 | - } |
|
| 242 | - |
|
| 243 | - require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-legacy-invoice.php'; |
|
| 244 | - |
|
| 245 | - $invoice_rows = array(); |
|
| 246 | - foreach ( $invoices as $invoice ) { |
|
| 247 | - |
|
| 248 | - $invoice = new WPInv_Legacy_Invoice( $invoice ); |
|
| 249 | - |
|
| 250 | - if ( empty( $invoice->ID ) ) { |
|
| 251 | - return; |
|
| 252 | - } |
|
| 253 | - |
|
| 254 | - $fields = array( |
|
| 255 | - 'post_id' => $invoice->ID, |
|
| 256 | - 'number' => $invoice->get_number(), |
|
| 257 | - 'key' => $invoice->get_key(), |
|
| 258 | - 'type' => str_replace( 'wpi_', '', $invoice->post_type ), |
|
| 259 | - 'mode' => $invoice->mode, |
|
| 260 | - 'user_ip' => $invoice->get_ip(), |
|
| 261 | - 'first_name' => $invoice->get_first_name(), |
|
| 262 | - 'last_name' => $invoice->get_last_name(), |
|
| 263 | - 'address' => $invoice->get_address(), |
|
| 264 | - 'city' => $invoice->city, |
|
| 265 | - 'state' => $invoice->state, |
|
| 266 | - 'country' => $invoice->country, |
|
| 267 | - 'zip' => $invoice->zip, |
|
| 268 | - 'adddress_confirmed' => (int) $invoice->adddress_confirmed, |
|
| 269 | - 'gateway' => $invoice->get_gateway(), |
|
| 270 | - 'transaction_id' => $invoice->get_transaction_id(), |
|
| 271 | - 'currency' => $invoice->get_currency(), |
|
| 272 | - 'subtotal' => $invoice->get_subtotal(), |
|
| 273 | - 'tax' => $invoice->get_tax(), |
|
| 274 | - 'fees_total' => $invoice->get_fees_total(), |
|
| 275 | - 'total' => $invoice->get_total(), |
|
| 276 | - 'discount' => $invoice->get_discount(), |
|
| 277 | - 'discount_code' => $invoice->get_discount_code(), |
|
| 278 | - 'disable_taxes' => $invoice->disable_taxes, |
|
| 279 | - 'due_date' => $invoice->get_due_date(), |
|
| 280 | - 'completed_date' => $invoice->get_completed_date(), |
|
| 281 | - 'company' => $invoice->company, |
|
| 282 | - 'vat_number' => $invoice->vat_number, |
|
| 283 | - 'vat_rate' => $invoice->vat_rate, |
|
| 284 | - 'custom_meta' => $invoice->payment_meta, |
|
| 285 | - ); |
|
| 286 | - |
|
| 287 | - foreach ( $fields as $key => $val ) { |
|
| 288 | - if ( is_null( $val ) ) { |
|
| 289 | - $val = ''; |
|
| 290 | - } |
|
| 291 | - $val = maybe_serialize( $val ); |
|
| 292 | - $fields[ $key ] = $wpdb->prepare( '%s', $val ); |
|
| 293 | - } |
|
| 294 | - |
|
| 295 | - $fields = implode( ', ', $fields ); |
|
| 296 | - $invoice_rows[] = "($fields)"; |
|
| 297 | - |
|
| 298 | - $item_rows = array(); |
|
| 299 | - $item_columns = array(); |
|
| 300 | - foreach ( $invoice->get_cart_details() as $details ) { |
|
| 301 | - $fields = array( |
|
| 302 | - 'post_id' => $invoice->ID, |
|
| 303 | - 'item_id' => $details['id'], |
|
| 304 | - 'item_name' => $details['name'], |
|
| 305 | - 'item_description' => empty( $details['meta']['description'] ) ? '' : $details['meta']['description'], |
|
| 306 | - 'vat_rate' => $details['vat_rate'], |
|
| 307 | - 'vat_class' => empty( $details['vat_class'] ) ? '_standard' : $details['vat_class'], |
|
| 308 | - 'tax' => $details['tax'], |
|
| 309 | - 'item_price' => $details['item_price'], |
|
| 310 | - 'custom_price' => $details['custom_price'], |
|
| 311 | - 'quantity' => $details['quantity'], |
|
| 312 | - 'discount' => $details['discount'], |
|
| 313 | - 'subtotal' => $details['subtotal'], |
|
| 314 | - 'price' => $details['price'], |
|
| 315 | - 'meta' => $details['meta'], |
|
| 316 | - 'fees' => $details['fees'], |
|
| 317 | - ); |
|
| 318 | - |
|
| 319 | - $item_columns = array_keys( $fields ); |
|
| 320 | - |
|
| 321 | - foreach ( $fields as $key => $val ) { |
|
| 322 | - if ( is_null( $val ) ) { |
|
| 323 | - $val = ''; |
|
| 324 | - } |
|
| 325 | - $val = maybe_serialize( $val ); |
|
| 326 | - $fields[ $key ] = $wpdb->prepare( '%s', $val ); |
|
| 327 | - } |
|
| 328 | - |
|
| 329 | - $fields = implode( ', ', $fields ); |
|
| 330 | - $item_rows[] = "($fields)"; |
|
| 331 | - } |
|
| 332 | - |
|
| 333 | - $item_rows = implode( ', ', $item_rows ); |
|
| 334 | - $item_columns = implode( ', ', $item_columns ); |
|
| 335 | - $wpdb->query( "INSERT INTO $invoice_items_table ($item_columns) VALUES $item_rows" ); |
|
| 336 | - } |
|
| 337 | - |
|
| 338 | - if ( empty( $invoice_rows ) ) { |
|
| 339 | - return; |
|
| 340 | - } |
|
| 341 | - |
|
| 342 | - $invoice_rows = implode( ', ', $invoice_rows ); |
|
| 343 | - $wpdb->query( "INSERT INTO $invoices_table VALUES $invoice_rows" ); |
|
| 344 | - |
|
| 345 | - } |
|
| 346 | - |
|
| 347 | - /** |
|
| 348 | - * Migrates old customers to new table. |
|
| 349 | - * |
|
| 350 | - */ |
|
| 351 | - public static function migrate_old_customers() { |
|
| 352 | - global $wpdb; |
|
| 353 | - |
|
| 354 | - // Fetch post_id from $wpdb->prefix . 'getpaid_invoices' where customer_id = 0 or null. |
|
| 355 | - $invoice_ids = $wpdb->get_col( "SELECT post_id FROM {$wpdb->prefix}getpaid_invoices WHERE customer_id = 0 OR customer_id IS NULL" ); |
|
| 356 | - |
|
| 357 | - foreach ( $invoice_ids as $invoice_id ) { |
|
| 358 | - $invoice = wpinv_get_invoice( $invoice_id ); |
|
| 359 | - |
|
| 360 | - if ( empty( $invoice ) ) { |
|
| 361 | - continue; |
|
| 362 | - } |
|
| 363 | - |
|
| 364 | - // Fetch customer from the user ID. |
|
| 365 | - $user_id = $invoice->get_user_id(); |
|
| 366 | - |
|
| 367 | - if ( empty( $user_id ) ) { |
|
| 368 | - continue; |
|
| 369 | - } |
|
| 370 | - |
|
| 371 | - $customer = getpaid_get_customer_by_user_id( $user_id ); |
|
| 372 | - |
|
| 373 | - // Create if not exists. |
|
| 374 | - if ( empty( $customer ) ) { |
|
| 375 | - $customer = new GetPaid_Customer( 0 ); |
|
| 376 | - $customer->clone_user( $user_id ); |
|
| 377 | - $customer->save(); |
|
| 378 | - } |
|
| 379 | - |
|
| 380 | - $invoice->set_customer_id( $customer->get_id() ); |
|
| 381 | - $invoice->save(); |
|
| 382 | - } |
|
| 383 | - |
|
| 384 | - } |
|
| 385 | - |
|
| 386 | - /** |
|
| 387 | - * Migrates old invoices to new invoices. |
|
| 388 | - * |
|
| 389 | - */ |
|
| 390 | - public static function rename_gateways_label() { |
|
| 391 | - global $wpdb; |
|
| 392 | - |
|
| 393 | - foreach ( array_keys( wpinv_get_payment_gateways() ) as $gateway ) { |
|
| 394 | - |
|
| 395 | - $wpdb->update( |
|
| 396 | - $wpdb->prefix . 'getpaid_invoices', |
|
| 397 | - array( 'gateway' => $gateway ), |
|
| 398 | - array( 'gateway' => wpinv_get_gateway_admin_label( $gateway ) ), |
|
| 399 | - '%s', |
|
| 400 | - '%s' |
|
| 401 | - ); |
|
| 402 | - |
|
| 403 | - } |
|
| 404 | - } |
|
| 405 | - |
|
| 406 | - /** |
|
| 407 | - * Returns the DB schema. |
|
| 408 | - * |
|
| 409 | - */ |
|
| 410 | - public static function get_db_schema() { |
|
| 411 | - global $wpdb; |
|
| 412 | - |
|
| 413 | - require_once ABSPATH . 'wp-admin/includes/upgrade.php'; |
|
| 414 | - |
|
| 415 | - $charset_collate = $wpdb->get_charset_collate(); |
|
| 196 | + 'parent' => '', |
|
| 197 | + ), |
|
| 198 | + |
|
| 199 | + ) |
|
| 200 | + ); |
|
| 201 | + |
|
| 202 | + } |
|
| 203 | + |
|
| 204 | + /** |
|
| 205 | + * Re-create GetPaid pages. |
|
| 206 | + * |
|
| 207 | + */ |
|
| 208 | + public function create_pages() { |
|
| 209 | + |
|
| 210 | + foreach ( self::get_pages() as $key => $page ) { |
|
| 211 | + wpinv_create_page( esc_sql( $page['name'] ), $key, $page['title'], $page['content'], $page['parent'] ); |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + } |
|
| 215 | + |
|
| 216 | + /** |
|
| 217 | + * Migrates old invoices to new invoices. |
|
| 218 | + * |
|
| 219 | + */ |
|
| 220 | + public function migrate_old_invoices() { |
|
| 221 | + global $wpdb; |
|
| 222 | + |
|
| 223 | + $invoices_table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 224 | + $invoice_items_table = $wpdb->prefix . 'getpaid_invoice_items'; |
|
| 225 | + $migrated = $wpdb->get_col( "SELECT post_id FROM $invoices_table" ); |
|
| 226 | + $invoices = array_unique( |
|
| 227 | + get_posts( |
|
| 228 | + array( |
|
| 229 | + 'post_type' => array( 'wpi_invoice', 'wpi_quote' ), |
|
| 230 | + 'posts_per_page' => -1, |
|
| 231 | + 'fields' => 'ids', |
|
| 232 | + 'post_status' => array_keys( get_post_stati() ), |
|
| 233 | + 'exclude' => (array) $migrated, |
|
| 234 | + ) |
|
| 235 | + ) |
|
| 236 | + ); |
|
| 237 | + |
|
| 238 | + // Abort if we do not have any invoices. |
|
| 239 | + if ( empty( $invoices ) ) { |
|
| 240 | + return; |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-legacy-invoice.php'; |
|
| 244 | + |
|
| 245 | + $invoice_rows = array(); |
|
| 246 | + foreach ( $invoices as $invoice ) { |
|
| 247 | + |
|
| 248 | + $invoice = new WPInv_Legacy_Invoice( $invoice ); |
|
| 249 | + |
|
| 250 | + if ( empty( $invoice->ID ) ) { |
|
| 251 | + return; |
|
| 252 | + } |
|
| 253 | + |
|
| 254 | + $fields = array( |
|
| 255 | + 'post_id' => $invoice->ID, |
|
| 256 | + 'number' => $invoice->get_number(), |
|
| 257 | + 'key' => $invoice->get_key(), |
|
| 258 | + 'type' => str_replace( 'wpi_', '', $invoice->post_type ), |
|
| 259 | + 'mode' => $invoice->mode, |
|
| 260 | + 'user_ip' => $invoice->get_ip(), |
|
| 261 | + 'first_name' => $invoice->get_first_name(), |
|
| 262 | + 'last_name' => $invoice->get_last_name(), |
|
| 263 | + 'address' => $invoice->get_address(), |
|
| 264 | + 'city' => $invoice->city, |
|
| 265 | + 'state' => $invoice->state, |
|
| 266 | + 'country' => $invoice->country, |
|
| 267 | + 'zip' => $invoice->zip, |
|
| 268 | + 'adddress_confirmed' => (int) $invoice->adddress_confirmed, |
|
| 269 | + 'gateway' => $invoice->get_gateway(), |
|
| 270 | + 'transaction_id' => $invoice->get_transaction_id(), |
|
| 271 | + 'currency' => $invoice->get_currency(), |
|
| 272 | + 'subtotal' => $invoice->get_subtotal(), |
|
| 273 | + 'tax' => $invoice->get_tax(), |
|
| 274 | + 'fees_total' => $invoice->get_fees_total(), |
|
| 275 | + 'total' => $invoice->get_total(), |
|
| 276 | + 'discount' => $invoice->get_discount(), |
|
| 277 | + 'discount_code' => $invoice->get_discount_code(), |
|
| 278 | + 'disable_taxes' => $invoice->disable_taxes, |
|
| 279 | + 'due_date' => $invoice->get_due_date(), |
|
| 280 | + 'completed_date' => $invoice->get_completed_date(), |
|
| 281 | + 'company' => $invoice->company, |
|
| 282 | + 'vat_number' => $invoice->vat_number, |
|
| 283 | + 'vat_rate' => $invoice->vat_rate, |
|
| 284 | + 'custom_meta' => $invoice->payment_meta, |
|
| 285 | + ); |
|
| 286 | + |
|
| 287 | + foreach ( $fields as $key => $val ) { |
|
| 288 | + if ( is_null( $val ) ) { |
|
| 289 | + $val = ''; |
|
| 290 | + } |
|
| 291 | + $val = maybe_serialize( $val ); |
|
| 292 | + $fields[ $key ] = $wpdb->prepare( '%s', $val ); |
|
| 293 | + } |
|
| 294 | + |
|
| 295 | + $fields = implode( ', ', $fields ); |
|
| 296 | + $invoice_rows[] = "($fields)"; |
|
| 297 | + |
|
| 298 | + $item_rows = array(); |
|
| 299 | + $item_columns = array(); |
|
| 300 | + foreach ( $invoice->get_cart_details() as $details ) { |
|
| 301 | + $fields = array( |
|
| 302 | + 'post_id' => $invoice->ID, |
|
| 303 | + 'item_id' => $details['id'], |
|
| 304 | + 'item_name' => $details['name'], |
|
| 305 | + 'item_description' => empty( $details['meta']['description'] ) ? '' : $details['meta']['description'], |
|
| 306 | + 'vat_rate' => $details['vat_rate'], |
|
| 307 | + 'vat_class' => empty( $details['vat_class'] ) ? '_standard' : $details['vat_class'], |
|
| 308 | + 'tax' => $details['tax'], |
|
| 309 | + 'item_price' => $details['item_price'], |
|
| 310 | + 'custom_price' => $details['custom_price'], |
|
| 311 | + 'quantity' => $details['quantity'], |
|
| 312 | + 'discount' => $details['discount'], |
|
| 313 | + 'subtotal' => $details['subtotal'], |
|
| 314 | + 'price' => $details['price'], |
|
| 315 | + 'meta' => $details['meta'], |
|
| 316 | + 'fees' => $details['fees'], |
|
| 317 | + ); |
|
| 318 | + |
|
| 319 | + $item_columns = array_keys( $fields ); |
|
| 320 | + |
|
| 321 | + foreach ( $fields as $key => $val ) { |
|
| 322 | + if ( is_null( $val ) ) { |
|
| 323 | + $val = ''; |
|
| 324 | + } |
|
| 325 | + $val = maybe_serialize( $val ); |
|
| 326 | + $fields[ $key ] = $wpdb->prepare( '%s', $val ); |
|
| 327 | + } |
|
| 328 | + |
|
| 329 | + $fields = implode( ', ', $fields ); |
|
| 330 | + $item_rows[] = "($fields)"; |
|
| 331 | + } |
|
| 332 | + |
|
| 333 | + $item_rows = implode( ', ', $item_rows ); |
|
| 334 | + $item_columns = implode( ', ', $item_columns ); |
|
| 335 | + $wpdb->query( "INSERT INTO $invoice_items_table ($item_columns) VALUES $item_rows" ); |
|
| 336 | + } |
|
| 337 | + |
|
| 338 | + if ( empty( $invoice_rows ) ) { |
|
| 339 | + return; |
|
| 340 | + } |
|
| 341 | + |
|
| 342 | + $invoice_rows = implode( ', ', $invoice_rows ); |
|
| 343 | + $wpdb->query( "INSERT INTO $invoices_table VALUES $invoice_rows" ); |
|
| 344 | + |
|
| 345 | + } |
|
| 346 | + |
|
| 347 | + /** |
|
| 348 | + * Migrates old customers to new table. |
|
| 349 | + * |
|
| 350 | + */ |
|
| 351 | + public static function migrate_old_customers() { |
|
| 352 | + global $wpdb; |
|
| 353 | + |
|
| 354 | + // Fetch post_id from $wpdb->prefix . 'getpaid_invoices' where customer_id = 0 or null. |
|
| 355 | + $invoice_ids = $wpdb->get_col( "SELECT post_id FROM {$wpdb->prefix}getpaid_invoices WHERE customer_id = 0 OR customer_id IS NULL" ); |
|
| 356 | + |
|
| 357 | + foreach ( $invoice_ids as $invoice_id ) { |
|
| 358 | + $invoice = wpinv_get_invoice( $invoice_id ); |
|
| 359 | + |
|
| 360 | + if ( empty( $invoice ) ) { |
|
| 361 | + continue; |
|
| 362 | + } |
|
| 363 | + |
|
| 364 | + // Fetch customer from the user ID. |
|
| 365 | + $user_id = $invoice->get_user_id(); |
|
| 366 | + |
|
| 367 | + if ( empty( $user_id ) ) { |
|
| 368 | + continue; |
|
| 369 | + } |
|
| 370 | + |
|
| 371 | + $customer = getpaid_get_customer_by_user_id( $user_id ); |
|
| 372 | + |
|
| 373 | + // Create if not exists. |
|
| 374 | + if ( empty( $customer ) ) { |
|
| 375 | + $customer = new GetPaid_Customer( 0 ); |
|
| 376 | + $customer->clone_user( $user_id ); |
|
| 377 | + $customer->save(); |
|
| 378 | + } |
|
| 379 | + |
|
| 380 | + $invoice->set_customer_id( $customer->get_id() ); |
|
| 381 | + $invoice->save(); |
|
| 382 | + } |
|
| 383 | + |
|
| 384 | + } |
|
| 385 | + |
|
| 386 | + /** |
|
| 387 | + * Migrates old invoices to new invoices. |
|
| 388 | + * |
|
| 389 | + */ |
|
| 390 | + public static function rename_gateways_label() { |
|
| 391 | + global $wpdb; |
|
| 392 | + |
|
| 393 | + foreach ( array_keys( wpinv_get_payment_gateways() ) as $gateway ) { |
|
| 394 | + |
|
| 395 | + $wpdb->update( |
|
| 396 | + $wpdb->prefix . 'getpaid_invoices', |
|
| 397 | + array( 'gateway' => $gateway ), |
|
| 398 | + array( 'gateway' => wpinv_get_gateway_admin_label( $gateway ) ), |
|
| 399 | + '%s', |
|
| 400 | + '%s' |
|
| 401 | + ); |
|
| 402 | + |
|
| 403 | + } |
|
| 404 | + } |
|
| 405 | + |
|
| 406 | + /** |
|
| 407 | + * Returns the DB schema. |
|
| 408 | + * |
|
| 409 | + */ |
|
| 410 | + public static function get_db_schema() { |
|
| 411 | + global $wpdb; |
|
| 412 | + |
|
| 413 | + require_once ABSPATH . 'wp-admin/includes/upgrade.php'; |
|
| 414 | + |
|
| 415 | + $charset_collate = $wpdb->get_charset_collate(); |
|
| 416 | 416 | |
| 417 | - // Subscriptions. |
|
| 418 | - $schema = "CREATE TABLE {$wpdb->prefix}wpinv_subscriptions ( |
|
| 417 | + // Subscriptions. |
|
| 418 | + $schema = "CREATE TABLE {$wpdb->prefix}wpinv_subscriptions ( |
|
| 419 | 419 | id bigint(20) unsigned NOT NULL auto_increment, |
| 420 | 420 | customer_id bigint(20) NOT NULL, |
| 421 | 421 | frequency int(11) NOT NULL DEFAULT '1', |
@@ -438,8 +438,8 @@ discard block |
||
| 438 | 438 | KEY customer_and_status (customer_id, status) |
| 439 | 439 | ) $charset_collate;"; |
| 440 | 440 | |
| 441 | - // Invoices. |
|
| 442 | - $schema .= "CREATE TABLE {$wpdb->prefix}getpaid_invoices ( |
|
| 441 | + // Invoices. |
|
| 442 | + $schema .= "CREATE TABLE {$wpdb->prefix}getpaid_invoices ( |
|
| 443 | 443 | post_id BIGINT(20) NOT NULL, |
| 444 | 444 | customer_id BIGINT(20) NOT NULL DEFAULT 0, |
| 445 | 445 | `number` VARCHAR(100), |
@@ -476,8 +476,8 @@ discard block |
||
| 476 | 476 | KEY invoice_key (invoice_key) |
| 477 | 477 | ) $charset_collate;"; |
| 478 | 478 | |
| 479 | - // Invoice items. |
|
| 480 | - $schema .= "CREATE TABLE {$wpdb->prefix}getpaid_invoice_items ( |
|
| 479 | + // Invoice items. |
|
| 480 | + $schema .= "CREATE TABLE {$wpdb->prefix}getpaid_invoice_items ( |
|
| 481 | 481 | ID BIGINT(20) NOT NULL AUTO_INCREMENT, |
| 482 | 482 | post_id BIGINT(20) NOT NULL, |
| 483 | 483 | item_id BIGINT(20) NOT NULL, |
@@ -499,8 +499,8 @@ discard block |
||
| 499 | 499 | KEY post_id (post_id) |
| 500 | 500 | ) $charset_collate;"; |
| 501 | 501 | |
| 502 | - // Customers. |
|
| 503 | - $schema .= "CREATE TABLE {$wpdb->prefix}getpaid_customers ( |
|
| 502 | + // Customers. |
|
| 503 | + $schema .= "CREATE TABLE {$wpdb->prefix}getpaid_customers ( |
|
| 504 | 504 | id BIGINT(20) NOT NULL AUTO_INCREMENT, |
| 505 | 505 | user_id BIGINT(20) NOT NULL, |
| 506 | 506 | email VARCHAR(100) NOT NULL, |
@@ -510,38 +510,38 @@ discard block |
||
| 510 | 510 | purchase_count BIGINT(20) NOT NULL DEFAULT 0, |
| 511 | 511 | "; |
| 512 | 512 | |
| 513 | - // Add address fields. |
|
| 514 | - foreach ( array_keys( getpaid_user_address_fields() ) as $field ) { |
|
| 515 | - // Skip id, user_id and email. |
|
| 516 | - if ( in_array( $field, array( 'id', 'user_id', 'email', 'purchase_value', 'purchase_count', 'date_created', 'date_modified', 'uuid' ), true ) ) { |
|
| 517 | - continue; |
|
| 518 | - } |
|
| 519 | - |
|
| 520 | - $field = sanitize_key( $field ); |
|
| 521 | - $length = 100; |
|
| 522 | - $default = ''; |
|
| 523 | - |
|
| 524 | - // Country. |
|
| 525 | - if ( 'country' === $field ) { |
|
| 526 | - $length = 2; |
|
| 527 | - $default = wpinv_get_default_country(); |
|
| 528 | - } |
|
| 529 | - |
|
| 530 | - // State. |
|
| 531 | - if ( 'state' === $field ) { |
|
| 532 | - $default = wpinv_get_default_state(); |
|
| 533 | - } |
|
| 534 | - |
|
| 535 | - // Phone, zip. |
|
| 536 | - if ( in_array( $field, array( 'phone', 'zip' ), true ) ) { |
|
| 537 | - $length = 20; |
|
| 538 | - } |
|
| 539 | - |
|
| 540 | - $schema .= "`$field` VARCHAR($length) NOT NULL DEFAULT '$default', |
|
| 513 | + // Add address fields. |
|
| 514 | + foreach ( array_keys( getpaid_user_address_fields() ) as $field ) { |
|
| 515 | + // Skip id, user_id and email. |
|
| 516 | + if ( in_array( $field, array( 'id', 'user_id', 'email', 'purchase_value', 'purchase_count', 'date_created', 'date_modified', 'uuid' ), true ) ) { |
|
| 517 | + continue; |
|
| 518 | + } |
|
| 519 | + |
|
| 520 | + $field = sanitize_key( $field ); |
|
| 521 | + $length = 100; |
|
| 522 | + $default = ''; |
|
| 523 | + |
|
| 524 | + // Country. |
|
| 525 | + if ( 'country' === $field ) { |
|
| 526 | + $length = 2; |
|
| 527 | + $default = wpinv_get_default_country(); |
|
| 528 | + } |
|
| 529 | + |
|
| 530 | + // State. |
|
| 531 | + if ( 'state' === $field ) { |
|
| 532 | + $default = wpinv_get_default_state(); |
|
| 533 | + } |
|
| 534 | + |
|
| 535 | + // Phone, zip. |
|
| 536 | + if ( in_array( $field, array( 'phone', 'zip' ), true ) ) { |
|
| 537 | + $length = 20; |
|
| 538 | + } |
|
| 539 | + |
|
| 540 | + $schema .= "`$field` VARCHAR($length) NOT NULL DEFAULT '$default', |
|
| 541 | 541 | "; |
| 542 | - } |
|
| 542 | + } |
|
| 543 | 543 | |
| 544 | - $schema .= "date_created DATETIME NOT NULL, |
|
| 544 | + $schema .= "date_created DATETIME NOT NULL, |
|
| 545 | 545 | date_modified DATETIME NOT NULL, |
| 546 | 546 | uuid VARCHAR(100) NOT NULL, |
| 547 | 547 | PRIMARY KEY (id), |
@@ -549,8 +549,8 @@ discard block |
||
| 549 | 549 | KEY email (email) |
| 550 | 550 | ) $charset_collate;"; |
| 551 | 551 | |
| 552 | - // Customer meta. |
|
| 553 | - $schema .= "CREATE TABLE {$wpdb->prefix}getpaid_customer_meta ( |
|
| 552 | + // Customer meta. |
|
| 553 | + $schema .= "CREATE TABLE {$wpdb->prefix}getpaid_customer_meta ( |
|
| 554 | 554 | meta_id BIGINT(20) NOT NULL AUTO_INCREMENT, |
| 555 | 555 | customer_id BIGINT(20) NOT NULL, |
| 556 | 556 | meta_key VARCHAR(255) NOT NULL, |
@@ -560,55 +560,55 @@ discard block |
||
| 560 | 560 | KEY meta_key (meta_key(191)) |
| 561 | 561 | ) $charset_collate;"; |
| 562 | 562 | |
| 563 | - return $schema; |
|
| 564 | - } |
|
| 565 | - |
|
| 566 | - /** |
|
| 567 | - * Checks if the db schema is up to date. |
|
| 568 | - * |
|
| 569 | - * @return bool |
|
| 570 | - */ |
|
| 571 | - public static function is_db_schema_up_to_date() { |
|
| 572 | - return md5( self::get_db_schema() ) === get_option( 'getpaid_db_schema' ); |
|
| 573 | - } |
|
| 574 | - |
|
| 575 | - /** |
|
| 576 | - * Set up the database tables which the plugin needs to function. |
|
| 577 | - */ |
|
| 578 | - public static function create_db_tables() { |
|
| 579 | - global $wpdb; |
|
| 580 | - |
|
| 581 | - $wpdb->hide_errors(); |
|
| 582 | - |
|
| 583 | - require_once ABSPATH . 'wp-admin/includes/upgrade.php'; |
|
| 584 | - |
|
| 585 | - $schema = self::get_db_schema(); |
|
| 586 | - |
|
| 587 | - // If invoices table exists, rename key to invoice_key. |
|
| 588 | - $invoices_table = "{$wpdb->prefix}getpaid_invoices"; |
|
| 589 | - |
|
| 590 | - if ( $wpdb->get_var( "SHOW TABLES LIKE '{$wpdb->prefix}getpaid_invoices'" ) === $invoices_table ) { |
|
| 591 | - $fields = $wpdb->get_results( "SHOW COLUMNS FROM {$wpdb->prefix}getpaid_invoices" ); |
|
| 592 | - |
|
| 593 | - foreach ( $fields as $field ) { |
|
| 594 | - if ( 'key' === $field->Field ) { |
|
| 595 | - $wpdb->query( "ALTER TABLE {$wpdb->prefix}getpaid_invoices CHANGE `key` `invoice_key` VARCHAR(100)" ); |
|
| 596 | - break; |
|
| 597 | - } |
|
| 598 | - } |
|
| 599 | - } |
|
| 600 | - |
|
| 601 | - dbDelta( $schema ); |
|
| 602 | - wp_cache_flush(); |
|
| 603 | - update_option( 'getpaid_db_schema', md5( self::get_db_schema() ) ); |
|
| 604 | - } |
|
| 605 | - |
|
| 606 | - /** |
|
| 607 | - * Creates tables if schema is not up to date. |
|
| 608 | - */ |
|
| 609 | - public static function maybe_create_db_tables() { |
|
| 610 | - if ( ! self::is_db_schema_up_to_date() ) { |
|
| 611 | - self::create_db_tables(); |
|
| 612 | - } |
|
| 613 | - } |
|
| 563 | + return $schema; |
|
| 564 | + } |
|
| 565 | + |
|
| 566 | + /** |
|
| 567 | + * Checks if the db schema is up to date. |
|
| 568 | + * |
|
| 569 | + * @return bool |
|
| 570 | + */ |
|
| 571 | + public static function is_db_schema_up_to_date() { |
|
| 572 | + return md5( self::get_db_schema() ) === get_option( 'getpaid_db_schema' ); |
|
| 573 | + } |
|
| 574 | + |
|
| 575 | + /** |
|
| 576 | + * Set up the database tables which the plugin needs to function. |
|
| 577 | + */ |
|
| 578 | + public static function create_db_tables() { |
|
| 579 | + global $wpdb; |
|
| 580 | + |
|
| 581 | + $wpdb->hide_errors(); |
|
| 582 | + |
|
| 583 | + require_once ABSPATH . 'wp-admin/includes/upgrade.php'; |
|
| 584 | + |
|
| 585 | + $schema = self::get_db_schema(); |
|
| 586 | + |
|
| 587 | + // If invoices table exists, rename key to invoice_key. |
|
| 588 | + $invoices_table = "{$wpdb->prefix}getpaid_invoices"; |
|
| 589 | + |
|
| 590 | + if ( $wpdb->get_var( "SHOW TABLES LIKE '{$wpdb->prefix}getpaid_invoices'" ) === $invoices_table ) { |
|
| 591 | + $fields = $wpdb->get_results( "SHOW COLUMNS FROM {$wpdb->prefix}getpaid_invoices" ); |
|
| 592 | + |
|
| 593 | + foreach ( $fields as $field ) { |
|
| 594 | + if ( 'key' === $field->Field ) { |
|
| 595 | + $wpdb->query( "ALTER TABLE {$wpdb->prefix}getpaid_invoices CHANGE `key` `invoice_key` VARCHAR(100)" ); |
|
| 596 | + break; |
|
| 597 | + } |
|
| 598 | + } |
|
| 599 | + } |
|
| 600 | + |
|
| 601 | + dbDelta( $schema ); |
|
| 602 | + wp_cache_flush(); |
|
| 603 | + update_option( 'getpaid_db_schema', md5( self::get_db_schema() ) ); |
|
| 604 | + } |
|
| 605 | + |
|
| 606 | + /** |
|
| 607 | + * Creates tables if schema is not up to date. |
|
| 608 | + */ |
|
| 609 | + public static function maybe_create_db_tables() { |
|
| 610 | + if ( ! self::is_db_schema_up_to_date() ) { |
|
| 611 | + self::create_db_tables(); |
|
| 612 | + } |
|
| 613 | + } |
|
| 614 | 614 | } |
@@ -11,7 +11,7 @@ discard block |
||
| 11 | 11 | |
| 12 | 12 | // Load WP_List_Table if not loaded |
| 13 | 13 | if ( ! class_exists( 'WP_List_Table' ) ) { |
| 14 | - require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php'; |
|
| 14 | + require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php'; |
|
| 15 | 15 | } |
| 16 | 16 | |
| 17 | 17 | /** |
@@ -23,304 +23,304 @@ discard block |
||
| 23 | 23 | */ |
| 24 | 24 | class WPInv_Customers_Table extends WP_List_Table { |
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * @var int Number of items per page |
|
| 28 | - * @since 1.0.19 |
|
| 29 | - */ |
|
| 30 | - public $per_page = 25; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * @var int Number of items |
|
| 34 | - * @since 1.0.19 |
|
| 35 | - */ |
|
| 36 | - public $total_count = 0; |
|
| 37 | - |
|
| 38 | - public $query; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Get things started |
|
| 42 | - * |
|
| 43 | - * @since 1.0.19 |
|
| 44 | - * @see WP_List_Table::__construct() |
|
| 45 | - */ |
|
| 46 | - public function __construct() { |
|
| 47 | - |
|
| 48 | - // Set parent defaults |
|
| 49 | - parent::__construct( |
|
| 26 | + /** |
|
| 27 | + * @var int Number of items per page |
|
| 28 | + * @since 1.0.19 |
|
| 29 | + */ |
|
| 30 | + public $per_page = 25; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * @var int Number of items |
|
| 34 | + * @since 1.0.19 |
|
| 35 | + */ |
|
| 36 | + public $total_count = 0; |
|
| 37 | + |
|
| 38 | + public $query; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * Get things started |
|
| 42 | + * |
|
| 43 | + * @since 1.0.19 |
|
| 44 | + * @see WP_List_Table::__construct() |
|
| 45 | + */ |
|
| 46 | + public function __construct() { |
|
| 47 | + |
|
| 48 | + // Set parent defaults |
|
| 49 | + parent::__construct( |
|
| 50 | 50 | array( |
| 51 | - 'singular' => 'id', |
|
| 52 | - 'plural' => 'ids', |
|
| 53 | - 'ajax' => false, |
|
| 51 | + 'singular' => 'id', |
|
| 52 | + 'plural' => 'ids', |
|
| 53 | + 'ajax' => false, |
|
| 54 | 54 | ) |
| 55 | 55 | ); |
| 56 | 56 | |
| 57 | - } |
|
| 58 | - |
|
| 59 | - /** |
|
| 60 | - * Gets the name of the primary column. |
|
| 61 | - * |
|
| 62 | - * @since 1.0.19 |
|
| 63 | - * @access protected |
|
| 64 | - * |
|
| 65 | - * @return string Name of the primary column. |
|
| 66 | - */ |
|
| 67 | - protected function get_primary_column_name() { |
|
| 68 | - return 'customer'; |
|
| 69 | - } |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * This function renders most of the columns in the list table. |
|
| 73 | - * |
|
| 74 | - * @since 1.0.19 |
|
| 75 | - * |
|
| 76 | - * @param GetPaid_Customer $customer |
|
| 77 | - * @param string $column_name The name of the column |
|
| 78 | - * |
|
| 79 | - * @return string Column Name |
|
| 80 | - */ |
|
| 81 | - public function column_default( $customer, $column_name ) { |
|
| 82 | - $value = esc_html( $customer->get( $column_name ) ); |
|
| 83 | - return apply_filters( 'wpinv_customers_table_column' . $column_name, $value, $customer ); |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * Displays the country column. |
|
| 88 | - * |
|
| 89 | - * @since 1.0.19 |
|
| 90 | - * |
|
| 91 | - * @param GetPaid_Customer $customer |
|
| 92 | - * |
|
| 93 | - * @return string Column Name |
|
| 94 | - */ |
|
| 95 | - public function column_country( $customer ) { |
|
| 96 | - $country = wpinv_sanitize_country( $customer->get( 'country' ) ); |
|
| 97 | - if ( $country ) { |
|
| 98 | - $country = wpinv_country_name( $country ); |
|
| 99 | - } |
|
| 100 | - return esc_html( $country ); |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - /** |
|
| 104 | - * Displays the state column. |
|
| 105 | - * |
|
| 106 | - * @since 1.0.19 |
|
| 107 | - * |
|
| 108 | - * @param GetPaid_Customer $customer |
|
| 109 | - * |
|
| 110 | - * @return string Column Name |
|
| 111 | - */ |
|
| 112 | - public function column_state( $customer ) { |
|
| 113 | - $country = wpinv_sanitize_country( $customer->get( 'country' ) ); |
|
| 114 | - $state = $customer->get( 'state' ); |
|
| 115 | - if ( $state ) { |
|
| 116 | - $state = wpinv_state_name( $state, $country ); |
|
| 117 | - } |
|
| 118 | - |
|
| 119 | - return esc_html( $state ); |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * Displays the signup column. |
|
| 124 | - * |
|
| 125 | - * @since 1.0.19 |
|
| 126 | - * |
|
| 127 | - * @param GetPaid_Customer $customer |
|
| 128 | - * |
|
| 129 | - * @return string Column Name |
|
| 130 | - */ |
|
| 131 | - public function column_date_created( $customer ) { |
|
| 132 | - return getpaid_format_date_value( $customer->get( 'date_created' ) ); |
|
| 133 | - } |
|
| 134 | - |
|
| 135 | - /** |
|
| 136 | - * Displays the total spent column. |
|
| 137 | - * |
|
| 138 | - * @since 1.0.19 |
|
| 139 | - * |
|
| 140 | - * @param GetPaid_Customer $customer |
|
| 141 | - * |
|
| 142 | - * @return string Column Name |
|
| 143 | - */ |
|
| 144 | - public function column_purchase_value( $customer ) { |
|
| 145 | - return wpinv_price( (float) $customer->get( 'purchase_value' ) ); |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - /** |
|
| 149 | - * Displays the total spent column. |
|
| 150 | - * |
|
| 151 | - * @since 1.0.19 |
|
| 152 | - * |
|
| 153 | - * @param GetPaid_Customer $customer |
|
| 154 | - * |
|
| 155 | - * @return string Column Name |
|
| 156 | - */ |
|
| 157 | - public function column_purchase_count( $customer ) { |
|
| 158 | - $value = $customer->get( 'purchase_count' ); |
|
| 159 | - $url = $customer->get( 'user_id' ) ? add_query_arg( array( 'post_type' => 'wpi_invoice', 'author' => $customer->get( 'user_id' ), ), admin_url( 'edit.php' ) ) : ''; |
|
| 160 | - |
|
| 161 | - return ( empty( $value ) || empty( $url ) ) ? (int) $value : '<a href="' . esc_url( $url ) . '">' . absint( $value ) . '</a>'; |
|
| 162 | - |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - /** |
|
| 166 | - * Displays the customers name |
|
| 167 | - * |
|
| 168 | - * @param GetPaid_Customer $customer customer. |
|
| 169 | - * @return string |
|
| 170 | - */ |
|
| 171 | - public function column_customer( $customer ) { |
|
| 172 | - |
|
| 173 | - $first_name = $customer->get( 'first_name' ); |
|
| 174 | - $last_name = $customer->get( 'last_name' ); |
|
| 175 | - $email = $customer->get( 'email' ); |
|
| 176 | - $avatar = get_avatar( $customer->get( 'user_id' ) ? $customer->get( 'user_id' ) : $email, 32 ); |
|
| 177 | - |
|
| 178 | - // Customer view URL. |
|
| 179 | - $view_url = $customer->get( 'user_id' ) ? esc_url( add_query_arg( 'user_id', $customer->get( 'user_id' ), admin_url( 'user-edit.php' ) ) ) : false; |
|
| 180 | - $row_actions = $view_url ? $this->row_actions( |
|
| 181 | - array( |
|
| 182 | - 'view' => '<a href="' . $view_url . '#getpaid-fieldset-billing">' . __( 'Edit Details', 'invoicing' ) . '</a>', |
|
| 183 | - ) |
|
| 184 | - ) : ''; |
|
| 185 | - |
|
| 186 | - // Customer's name. |
|
| 187 | - $name = esc_html( trim( "$first_name $last_name" ) ); |
|
| 188 | - |
|
| 189 | - if ( ! empty( $name ) ) { |
|
| 190 | - $name = "<div style='overflow: hidden;height: 18px;'>$name</div>"; |
|
| 191 | - } |
|
| 192 | - |
|
| 193 | - $email = "<div class='row-title'><a href='mailto:$email'>$email</a></div>"; |
|
| 194 | - |
|
| 195 | - return "<div style='display: flex;'><div>$avatar</div><div style='margin-left: 10px;'>$name<strong>$email</strong>$row_actions</div></div>"; |
|
| 196 | - |
|
| 197 | - } |
|
| 198 | - |
|
| 199 | - /** |
|
| 200 | - * Retrieve the current page number |
|
| 201 | - * |
|
| 202 | - * @since 1.0.19 |
|
| 203 | - * @return int Current page number |
|
| 204 | - */ |
|
| 205 | - public function get_paged() { |
|
| 206 | - return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1; |
|
| 207 | - } |
|
| 208 | - |
|
| 209 | - /** |
|
| 210 | - * Returns bulk actions. |
|
| 211 | - * |
|
| 212 | - * @since 1.0.19 |
|
| 213 | - * @return void |
|
| 214 | - */ |
|
| 215 | - public function bulk_actions( $which = '' ) { |
|
| 216 | - return array(); |
|
| 217 | - } |
|
| 218 | - |
|
| 219 | - /** |
|
| 220 | - * Prepares the display query |
|
| 221 | - */ |
|
| 222 | - public function prepare_query() { |
|
| 223 | - |
|
| 224 | - // Prepare query args. |
|
| 225 | - $query = array( |
|
| 226 | - 'number' => $this->per_page, |
|
| 227 | - 'paged' => $this->get_paged(), |
|
| 228 | - ); |
|
| 229 | - |
|
| 230 | - foreach ( array( 'orderby', 'order', 's' ) as $field ) { |
|
| 231 | - if ( isset( $_GET[ $field ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 232 | - $query[ $field ] = wpinv_clean( rawurlencode_deep( $_GET[ $field ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 233 | - } |
|
| 234 | - } |
|
| 235 | - |
|
| 236 | - foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) { |
|
| 237 | - |
|
| 238 | - if ( isset( $_GET[ $field ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 239 | - $query[ $field ] = wpinv_clean( rawurlencode_deep( $_GET[ $field ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 240 | - } |
|
| 241 | - |
|
| 242 | - // Min max. |
|
| 243 | - if ( '%f' === $type || '%d' === $type ) { |
|
| 244 | - |
|
| 245 | - if ( isset( $_GET[ $field . '_min' ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 246 | - $query[ $field . '_min' ] = floatval( $_GET[ $field . '_min' ] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 247 | - } |
|
| 248 | - |
|
| 249 | - if ( isset( $_GET[ $field . '_max' ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 250 | - $query[ $field . '_max' ] = floatval( $_GET[ $field . '_max' ] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 251 | - } |
|
| 252 | - } |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - // Prepare class properties. |
|
| 256 | - $this->query = getpaid_get_customers( $query, 'query' ); |
|
| 257 | - $this->total_count = $this->query->get_total(); |
|
| 258 | - $this->items = $this->query->get_results(); |
|
| 259 | - } |
|
| 260 | - |
|
| 261 | - /** |
|
| 262 | - * Setup the final data for the table |
|
| 263 | - * |
|
| 264 | - */ |
|
| 265 | - public function prepare_items() { |
|
| 266 | - |
|
| 267 | - $columns = $this->get_columns(); |
|
| 268 | - $hidden = array(); |
|
| 269 | - $sortable = $this->get_sortable_columns(); |
|
| 270 | - $this->prepare_query(); |
|
| 271 | - |
|
| 272 | - $this->_column_headers = array( $columns, $hidden, $sortable ); |
|
| 273 | - |
|
| 274 | - $this->set_pagination_args( |
|
| 275 | - array( |
|
| 276 | - 'total_items' => $this->total_count, |
|
| 277 | - 'per_page' => $this->per_page, |
|
| 278 | - 'total_pages' => ceil( $this->total_count / $this->per_page ), |
|
| 279 | - ) |
|
| 280 | - ); |
|
| 281 | - } |
|
| 282 | - |
|
| 283 | - /** |
|
| 284 | - * Sortable table columns. |
|
| 285 | - * |
|
| 286 | - * @return array |
|
| 287 | - */ |
|
| 288 | - public function get_sortable_columns() { |
|
| 289 | - $sortable = array( |
|
| 290 | - 'customer' => array( 'first_name', true ), |
|
| 291 | - ); |
|
| 292 | - |
|
| 293 | - foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) { |
|
| 294 | - $sortable[ $field ] = array( $field, true ); |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - return apply_filters( 'manage_getpaid_customers_sortable_table_columns', $sortable ); |
|
| 298 | - } |
|
| 299 | - |
|
| 300 | - /** |
|
| 301 | - * Table columns |
|
| 302 | - * |
|
| 303 | - * @return array |
|
| 304 | - */ |
|
| 305 | - public function get_columns() { |
|
| 306 | - $columns = array( |
|
| 307 | - 'cb' => '<input type="checkbox" />', |
|
| 308 | - 'customer' => __( 'Customer', 'invoicing' ), |
|
| 309 | - ); |
|
| 310 | - |
|
| 311 | - // Add address fields. |
|
| 312 | - foreach ( getpaid_user_address_fields() as $key => $value ) { |
|
| 313 | - |
|
| 314 | - // Skip id, user_id and email. |
|
| 315 | - if ( ! in_array( $key, array( 'id', 'user_id', 'email', 'purchase_value', 'purchase_count', 'date_created', 'date_modified', 'uuid', 'first_name', 'last_name' ), true ) ) { |
|
| 316 | - $columns[ $key ] = $value; |
|
| 317 | - } |
|
| 318 | - } |
|
| 319 | - |
|
| 320 | - $columns['purchase_value'] = __( 'Total Spend', 'invoicing' ); |
|
| 321 | - $columns['purchase_count'] = __( 'Invoices', 'invoicing' ); |
|
| 322 | - $columns['date_created'] = __( 'Date created', 'invoicing' ); |
|
| 323 | - |
|
| 324 | - return apply_filters( 'manage_getpaid_customers_table_columns', $columns ); |
|
| 325 | - } |
|
| 57 | + } |
|
| 58 | + |
|
| 59 | + /** |
|
| 60 | + * Gets the name of the primary column. |
|
| 61 | + * |
|
| 62 | + * @since 1.0.19 |
|
| 63 | + * @access protected |
|
| 64 | + * |
|
| 65 | + * @return string Name of the primary column. |
|
| 66 | + */ |
|
| 67 | + protected function get_primary_column_name() { |
|
| 68 | + return 'customer'; |
|
| 69 | + } |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * This function renders most of the columns in the list table. |
|
| 73 | + * |
|
| 74 | + * @since 1.0.19 |
|
| 75 | + * |
|
| 76 | + * @param GetPaid_Customer $customer |
|
| 77 | + * @param string $column_name The name of the column |
|
| 78 | + * |
|
| 79 | + * @return string Column Name |
|
| 80 | + */ |
|
| 81 | + public function column_default( $customer, $column_name ) { |
|
| 82 | + $value = esc_html( $customer->get( $column_name ) ); |
|
| 83 | + return apply_filters( 'wpinv_customers_table_column' . $column_name, $value, $customer ); |
|
| 84 | + } |
|
| 85 | + |
|
| 86 | + /** |
|
| 87 | + * Displays the country column. |
|
| 88 | + * |
|
| 89 | + * @since 1.0.19 |
|
| 90 | + * |
|
| 91 | + * @param GetPaid_Customer $customer |
|
| 92 | + * |
|
| 93 | + * @return string Column Name |
|
| 94 | + */ |
|
| 95 | + public function column_country( $customer ) { |
|
| 96 | + $country = wpinv_sanitize_country( $customer->get( 'country' ) ); |
|
| 97 | + if ( $country ) { |
|
| 98 | + $country = wpinv_country_name( $country ); |
|
| 99 | + } |
|
| 100 | + return esc_html( $country ); |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + /** |
|
| 104 | + * Displays the state column. |
|
| 105 | + * |
|
| 106 | + * @since 1.0.19 |
|
| 107 | + * |
|
| 108 | + * @param GetPaid_Customer $customer |
|
| 109 | + * |
|
| 110 | + * @return string Column Name |
|
| 111 | + */ |
|
| 112 | + public function column_state( $customer ) { |
|
| 113 | + $country = wpinv_sanitize_country( $customer->get( 'country' ) ); |
|
| 114 | + $state = $customer->get( 'state' ); |
|
| 115 | + if ( $state ) { |
|
| 116 | + $state = wpinv_state_name( $state, $country ); |
|
| 117 | + } |
|
| 118 | + |
|
| 119 | + return esc_html( $state ); |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * Displays the signup column. |
|
| 124 | + * |
|
| 125 | + * @since 1.0.19 |
|
| 126 | + * |
|
| 127 | + * @param GetPaid_Customer $customer |
|
| 128 | + * |
|
| 129 | + * @return string Column Name |
|
| 130 | + */ |
|
| 131 | + public function column_date_created( $customer ) { |
|
| 132 | + return getpaid_format_date_value( $customer->get( 'date_created' ) ); |
|
| 133 | + } |
|
| 134 | + |
|
| 135 | + /** |
|
| 136 | + * Displays the total spent column. |
|
| 137 | + * |
|
| 138 | + * @since 1.0.19 |
|
| 139 | + * |
|
| 140 | + * @param GetPaid_Customer $customer |
|
| 141 | + * |
|
| 142 | + * @return string Column Name |
|
| 143 | + */ |
|
| 144 | + public function column_purchase_value( $customer ) { |
|
| 145 | + return wpinv_price( (float) $customer->get( 'purchase_value' ) ); |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + /** |
|
| 149 | + * Displays the total spent column. |
|
| 150 | + * |
|
| 151 | + * @since 1.0.19 |
|
| 152 | + * |
|
| 153 | + * @param GetPaid_Customer $customer |
|
| 154 | + * |
|
| 155 | + * @return string Column Name |
|
| 156 | + */ |
|
| 157 | + public function column_purchase_count( $customer ) { |
|
| 158 | + $value = $customer->get( 'purchase_count' ); |
|
| 159 | + $url = $customer->get( 'user_id' ) ? add_query_arg( array( 'post_type' => 'wpi_invoice', 'author' => $customer->get( 'user_id' ), ), admin_url( 'edit.php' ) ) : ''; |
|
| 160 | + |
|
| 161 | + return ( empty( $value ) || empty( $url ) ) ? (int) $value : '<a href="' . esc_url( $url ) . '">' . absint( $value ) . '</a>'; |
|
| 162 | + |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + /** |
|
| 166 | + * Displays the customers name |
|
| 167 | + * |
|
| 168 | + * @param GetPaid_Customer $customer customer. |
|
| 169 | + * @return string |
|
| 170 | + */ |
|
| 171 | + public function column_customer( $customer ) { |
|
| 172 | + |
|
| 173 | + $first_name = $customer->get( 'first_name' ); |
|
| 174 | + $last_name = $customer->get( 'last_name' ); |
|
| 175 | + $email = $customer->get( 'email' ); |
|
| 176 | + $avatar = get_avatar( $customer->get( 'user_id' ) ? $customer->get( 'user_id' ) : $email, 32 ); |
|
| 177 | + |
|
| 178 | + // Customer view URL. |
|
| 179 | + $view_url = $customer->get( 'user_id' ) ? esc_url( add_query_arg( 'user_id', $customer->get( 'user_id' ), admin_url( 'user-edit.php' ) ) ) : false; |
|
| 180 | + $row_actions = $view_url ? $this->row_actions( |
|
| 181 | + array( |
|
| 182 | + 'view' => '<a href="' . $view_url . '#getpaid-fieldset-billing">' . __( 'Edit Details', 'invoicing' ) . '</a>', |
|
| 183 | + ) |
|
| 184 | + ) : ''; |
|
| 185 | + |
|
| 186 | + // Customer's name. |
|
| 187 | + $name = esc_html( trim( "$first_name $last_name" ) ); |
|
| 188 | + |
|
| 189 | + if ( ! empty( $name ) ) { |
|
| 190 | + $name = "<div style='overflow: hidden;height: 18px;'>$name</div>"; |
|
| 191 | + } |
|
| 192 | + |
|
| 193 | + $email = "<div class='row-title'><a href='mailto:$email'>$email</a></div>"; |
|
| 194 | + |
|
| 195 | + return "<div style='display: flex;'><div>$avatar</div><div style='margin-left: 10px;'>$name<strong>$email</strong>$row_actions</div></div>"; |
|
| 196 | + |
|
| 197 | + } |
|
| 198 | + |
|
| 199 | + /** |
|
| 200 | + * Retrieve the current page number |
|
| 201 | + * |
|
| 202 | + * @since 1.0.19 |
|
| 203 | + * @return int Current page number |
|
| 204 | + */ |
|
| 205 | + public function get_paged() { |
|
| 206 | + return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1; |
|
| 207 | + } |
|
| 208 | + |
|
| 209 | + /** |
|
| 210 | + * Returns bulk actions. |
|
| 211 | + * |
|
| 212 | + * @since 1.0.19 |
|
| 213 | + * @return void |
|
| 214 | + */ |
|
| 215 | + public function bulk_actions( $which = '' ) { |
|
| 216 | + return array(); |
|
| 217 | + } |
|
| 218 | + |
|
| 219 | + /** |
|
| 220 | + * Prepares the display query |
|
| 221 | + */ |
|
| 222 | + public function prepare_query() { |
|
| 223 | + |
|
| 224 | + // Prepare query args. |
|
| 225 | + $query = array( |
|
| 226 | + 'number' => $this->per_page, |
|
| 227 | + 'paged' => $this->get_paged(), |
|
| 228 | + ); |
|
| 229 | + |
|
| 230 | + foreach ( array( 'orderby', 'order', 's' ) as $field ) { |
|
| 231 | + if ( isset( $_GET[ $field ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 232 | + $query[ $field ] = wpinv_clean( rawurlencode_deep( $_GET[ $field ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 233 | + } |
|
| 234 | + } |
|
| 235 | + |
|
| 236 | + foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) { |
|
| 237 | + |
|
| 238 | + if ( isset( $_GET[ $field ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 239 | + $query[ $field ] = wpinv_clean( rawurlencode_deep( $_GET[ $field ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 240 | + } |
|
| 241 | + |
|
| 242 | + // Min max. |
|
| 243 | + if ( '%f' === $type || '%d' === $type ) { |
|
| 244 | + |
|
| 245 | + if ( isset( $_GET[ $field . '_min' ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 246 | + $query[ $field . '_min' ] = floatval( $_GET[ $field . '_min' ] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 247 | + } |
|
| 248 | + |
|
| 249 | + if ( isset( $_GET[ $field . '_max' ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 250 | + $query[ $field . '_max' ] = floatval( $_GET[ $field . '_max' ] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
|
| 251 | + } |
|
| 252 | + } |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + // Prepare class properties. |
|
| 256 | + $this->query = getpaid_get_customers( $query, 'query' ); |
|
| 257 | + $this->total_count = $this->query->get_total(); |
|
| 258 | + $this->items = $this->query->get_results(); |
|
| 259 | + } |
|
| 260 | + |
|
| 261 | + /** |
|
| 262 | + * Setup the final data for the table |
|
| 263 | + * |
|
| 264 | + */ |
|
| 265 | + public function prepare_items() { |
|
| 266 | + |
|
| 267 | + $columns = $this->get_columns(); |
|
| 268 | + $hidden = array(); |
|
| 269 | + $sortable = $this->get_sortable_columns(); |
|
| 270 | + $this->prepare_query(); |
|
| 271 | + |
|
| 272 | + $this->_column_headers = array( $columns, $hidden, $sortable ); |
|
| 273 | + |
|
| 274 | + $this->set_pagination_args( |
|
| 275 | + array( |
|
| 276 | + 'total_items' => $this->total_count, |
|
| 277 | + 'per_page' => $this->per_page, |
|
| 278 | + 'total_pages' => ceil( $this->total_count / $this->per_page ), |
|
| 279 | + ) |
|
| 280 | + ); |
|
| 281 | + } |
|
| 282 | + |
|
| 283 | + /** |
|
| 284 | + * Sortable table columns. |
|
| 285 | + * |
|
| 286 | + * @return array |
|
| 287 | + */ |
|
| 288 | + public function get_sortable_columns() { |
|
| 289 | + $sortable = array( |
|
| 290 | + 'customer' => array( 'first_name', true ), |
|
| 291 | + ); |
|
| 292 | + |
|
| 293 | + foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) { |
|
| 294 | + $sortable[ $field ] = array( $field, true ); |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + return apply_filters( 'manage_getpaid_customers_sortable_table_columns', $sortable ); |
|
| 298 | + } |
|
| 299 | + |
|
| 300 | + /** |
|
| 301 | + * Table columns |
|
| 302 | + * |
|
| 303 | + * @return array |
|
| 304 | + */ |
|
| 305 | + public function get_columns() { |
|
| 306 | + $columns = array( |
|
| 307 | + 'cb' => '<input type="checkbox" />', |
|
| 308 | + 'customer' => __( 'Customer', 'invoicing' ), |
|
| 309 | + ); |
|
| 310 | + |
|
| 311 | + // Add address fields. |
|
| 312 | + foreach ( getpaid_user_address_fields() as $key => $value ) { |
|
| 313 | + |
|
| 314 | + // Skip id, user_id and email. |
|
| 315 | + if ( ! in_array( $key, array( 'id', 'user_id', 'email', 'purchase_value', 'purchase_count', 'date_created', 'date_modified', 'uuid', 'first_name', 'last_name' ), true ) ) { |
|
| 316 | + $columns[ $key ] = $value; |
|
| 317 | + } |
|
| 318 | + } |
|
| 319 | + |
|
| 320 | + $columns['purchase_value'] = __( 'Total Spend', 'invoicing' ); |
|
| 321 | + $columns['purchase_count'] = __( 'Invoices', 'invoicing' ); |
|
| 322 | + $columns['date_created'] = __( 'Date created', 'invoicing' ); |
|
| 323 | + |
|
| 324 | + return apply_filters( 'manage_getpaid_customers_table_columns', $columns ); |
|
| 325 | + } |
|
| 326 | 326 | } |
@@ -15,69 +15,69 @@ discard block |
||
| 15 | 15 | */ |
| 16 | 16 | class GetPaid_Customer extends GetPaid_Data { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * Which data store to load. |
|
| 20 | - * |
|
| 21 | - * @var string |
|
| 22 | - */ |
|
| 18 | + /** |
|
| 19 | + * Which data store to load. |
|
| 20 | + * |
|
| 21 | + * @var string |
|
| 22 | + */ |
|
| 23 | 23 | protected $data_store_name = 'customer'; |
| 24 | 24 | |
| 25 | 25 | /** |
| 26 | - * This is the name of this object type. |
|
| 27 | - * |
|
| 28 | - * @var string |
|
| 29 | - */ |
|
| 30 | - protected $object_type = 'customer'; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Get the customer if ID is passed, otherwise the customer is new and empty. |
|
| 34 | - * |
|
| 35 | - * @param int|string|GetPaid_Customer|object $customer customer id, object, or email. |
|
| 36 | - */ |
|
| 37 | - public function __construct( $customer = 0 ) { |
|
| 26 | + * This is the name of this object type. |
|
| 27 | + * |
|
| 28 | + * @var string |
|
| 29 | + */ |
|
| 30 | + protected $object_type = 'customer'; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Get the customer if ID is passed, otherwise the customer is new and empty. |
|
| 34 | + * |
|
| 35 | + * @param int|string|GetPaid_Customer|object $customer customer id, object, or email. |
|
| 36 | + */ |
|
| 37 | + public function __construct( $customer = 0 ) { |
|
| 38 | 38 | |
| 39 | 39 | // Setup default customer data. |
| 40 | 40 | $this->setup_default_data(); |
| 41 | 41 | |
| 42 | - if ( is_numeric( $customer ) ) { |
|
| 43 | - $this->set_id( $customer ); |
|
| 44 | - } elseif ( $customer instanceof self ) { |
|
| 45 | - $this->set_id( $customer->get_id() ); |
|
| 46 | - } elseif ( is_string( $customer ) && $customer_id = self::get_customer_id_by( $customer, 'email' ) ) { |
|
| 47 | - $this->set_id( $customer_id ); |
|
| 48 | - } elseif ( ! empty( $customer->id ) ) { |
|
| 49 | - $this->set_id( $customer->id ); |
|
| 50 | - } |
|
| 42 | + if ( is_numeric( $customer ) ) { |
|
| 43 | + $this->set_id( $customer ); |
|
| 44 | + } elseif ( $customer instanceof self ) { |
|
| 45 | + $this->set_id( $customer->get_id() ); |
|
| 46 | + } elseif ( is_string( $customer ) && $customer_id = self::get_customer_id_by( $customer, 'email' ) ) { |
|
| 47 | + $this->set_id( $customer_id ); |
|
| 48 | + } elseif ( ! empty( $customer->id ) ) { |
|
| 49 | + $this->set_id( $customer->id ); |
|
| 50 | + } |
|
| 51 | 51 | |
| 52 | 52 | // Load the datastore. |
| 53 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 53 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 54 | 54 | |
| 55 | - if ( $this->get_id() > 0 ) { |
|
| 56 | - $this->data_store->read( $this ); |
|
| 55 | + if ( $this->get_id() > 0 ) { |
|
| 56 | + $this->data_store->read( $this ); |
|
| 57 | 57 | } |
| 58 | 58 | |
| 59 | 59 | $this->set_object_read( true ); |
| 60 | - } |
|
| 60 | + } |
|
| 61 | 61 | |
| 62 | 62 | /** |
| 63 | - * Sets up default customer data. |
|
| 64 | - */ |
|
| 65 | - private function setup_default_data() { |
|
| 63 | + * Sets up default customer data. |
|
| 64 | + */ |
|
| 65 | + private function setup_default_data() { |
|
| 66 | 66 | |
| 67 | 67 | $this->data = array( |
| 68 | - 'user_id' => 0, |
|
| 69 | - 'email' => '', |
|
| 70 | - 'email_cc' => '', |
|
| 71 | - 'status' => 'active', |
|
| 72 | - 'purchase_value' => 0, |
|
| 73 | - 'purchase_count' => 0, |
|
| 74 | - 'date_created' => current_time( 'mysql' ), |
|
| 75 | - 'date_modified' => current_time( 'mysql' ), |
|
| 76 | - 'uuid' => wp_generate_uuid4(), |
|
| 77 | - ); |
|
| 68 | + 'user_id' => 0, |
|
| 69 | + 'email' => '', |
|
| 70 | + 'email_cc' => '', |
|
| 71 | + 'status' => 'active', |
|
| 72 | + 'purchase_value' => 0, |
|
| 73 | + 'purchase_count' => 0, |
|
| 74 | + 'date_created' => current_time( 'mysql' ), |
|
| 75 | + 'date_modified' => current_time( 'mysql' ), |
|
| 76 | + 'uuid' => wp_generate_uuid4(), |
|
| 77 | + ); |
|
| 78 | 78 | |
| 79 | 79 | // Add address fields. |
| 80 | - foreach ( array_keys( getpaid_user_address_fields() ) as $field ) { |
|
| 80 | + foreach ( array_keys( getpaid_user_address_fields() ) as $field ) { |
|
| 81 | 81 | |
| 82 | 82 | if ( isset( $this->data[ $field ] ) ) { |
| 83 | 83 | continue; |
@@ -95,22 +95,22 @@ discard block |
||
| 95 | 95 | continue; |
| 96 | 96 | } |
| 97 | 97 | |
| 98 | - $this->data[ $field ] = ''; |
|
| 99 | - } |
|
| 98 | + $this->data[ $field ] = ''; |
|
| 99 | + } |
|
| 100 | 100 | |
| 101 | 101 | $this->default_data = $this->data; |
| 102 | - } |
|
| 103 | - |
|
| 104 | - /** |
|
| 105 | - * Given a customer email or user id, it returns a customer id. |
|
| 106 | - * |
|
| 107 | - * @static |
|
| 108 | - * @param string $value |
|
| 109 | - * @since 1.0.15 |
|
| 110 | - * @return int |
|
| 111 | - */ |
|
| 112 | - public static function get_customer_id_by( $value, $by = 'email' ) { |
|
| 113 | - global $wpdb; |
|
| 102 | + } |
|
| 103 | + |
|
| 104 | + /** |
|
| 105 | + * Given a customer email or user id, it returns a customer id. |
|
| 106 | + * |
|
| 107 | + * @static |
|
| 108 | + * @param string $value |
|
| 109 | + * @since 1.0.15 |
|
| 110 | + * @return int |
|
| 111 | + */ |
|
| 112 | + public static function get_customer_id_by( $value, $by = 'email' ) { |
|
| 113 | + global $wpdb; |
|
| 114 | 114 | |
| 115 | 115 | // Prepare value. |
| 116 | 116 | if ( 'email' === $by ) { |
@@ -125,12 +125,12 @@ discard block |
||
| 125 | 125 | return 0; |
| 126 | 126 | } |
| 127 | 127 | |
| 128 | - // Maybe retrieve from the cache. |
|
| 128 | + // Maybe retrieve from the cache. |
|
| 129 | 129 | $cache_key = 'getpaid_customer_ids_by_' . $by; |
| 130 | - $customer_id = wp_cache_get( $value, $cache_key ); |
|
| 131 | - if ( false !== $customer_id ) { |
|
| 132 | - return $customer_id; |
|
| 133 | - } |
|
| 130 | + $customer_id = wp_cache_get( $value, $cache_key ); |
|
| 131 | + if ( false !== $customer_id ) { |
|
| 132 | + return $customer_id; |
|
| 133 | + } |
|
| 134 | 134 | |
| 135 | 135 | if ( 'email' === $by ) { |
| 136 | 136 | $customer_id = (int) $wpdb->get_var( |
@@ -142,23 +142,23 @@ discard block |
||
| 142 | 142 | ); |
| 143 | 143 | } |
| 144 | 144 | |
| 145 | - // Update the cache with our data |
|
| 146 | - wp_cache_set( $value, $customer_id, $cache_key ); |
|
| 145 | + // Update the cache with our data |
|
| 146 | + wp_cache_set( $value, $customer_id, $cache_key ); |
|
| 147 | 147 | |
| 148 | - return $customer_id; |
|
| 148 | + return $customer_id; |
|
| 149 | 149 | |
| 150 | - } |
|
| 150 | + } |
|
| 151 | 151 | |
| 152 | - /** |
|
| 152 | + /** |
|
| 153 | 153 | * Clears the customer's cache. |
| 154 | 154 | */ |
| 155 | 155 | public function clear_cache() { |
| 156 | 156 | wp_cache_delete( $this->get( 'email' ), 'getpaid_customer_ids_by_email' ); |
| 157 | 157 | wp_cache_delete( $this->get( 'user_id' ), 'getpaid_customer_ids_by_user_id' ); |
| 158 | - wp_cache_delete( $this->get_id(), 'getpaid_customers' ); |
|
| 159 | - } |
|
| 158 | + wp_cache_delete( $this->get_id(), 'getpaid_customers' ); |
|
| 159 | + } |
|
| 160 | 160 | |
| 161 | - /* |
|
| 161 | + /* |
|
| 162 | 162 | |-------------------------------------------------------------------------- |
| 163 | 163 | | CRUD methods |
| 164 | 164 | |-------------------------------------------------------------------------- |
@@ -189,11 +189,11 @@ discard block |
||
| 189 | 189 | return call_user_func( array( $this, 'get_' . $key ), $context ); |
| 190 | 190 | } |
| 191 | 191 | |
| 192 | - return $this->get_prop( $key, $context ); |
|
| 192 | + return $this->get_prop( $key, $context ); |
|
| 193 | 193 | |
| 194 | 194 | } |
| 195 | 195 | |
| 196 | - /* |
|
| 196 | + /* |
|
| 197 | 197 | |-------------------------------------------------------------------------- |
| 198 | 198 | | Setters |
| 199 | 199 | |-------------------------------------------------------------------------- |
@@ -216,114 +216,114 @@ discard block |
||
| 216 | 216 | return call_user_func( array( $this, 'set_' . $key ), $value ); |
| 217 | 217 | } |
| 218 | 218 | |
| 219 | - return $this->set_prop( $key, $value ); |
|
| 219 | + return $this->set_prop( $key, $value ); |
|
| 220 | 220 | |
| 221 | 221 | } |
| 222 | 222 | |
| 223 | - /** |
|
| 224 | - * Sets customer status. |
|
| 225 | - * |
|
| 226 | - * @since 1.0.0 |
|
| 227 | - * @param string $status New status. |
|
| 228 | - */ |
|
| 229 | - public function set_status( $status ) { |
|
| 230 | - |
|
| 231 | - if ( in_array( $status, array( 'active', 'inactive', 'blocked' ), true ) ) { |
|
| 232 | - return $this->set_prop( 'status', $status ); |
|
| 233 | - } |
|
| 234 | - |
|
| 235 | - $this->set_prop( 'status', 'inactive' ); |
|
| 236 | - } |
|
| 237 | - |
|
| 238 | - /** |
|
| 239 | - * Sets the purchase value. |
|
| 240 | - * |
|
| 241 | - * @since 1.0.0 |
|
| 242 | - * @param float $purchase_value. |
|
| 243 | - */ |
|
| 244 | - public function set_purchase_value( $purchase_value ) { |
|
| 245 | - $this->set_prop( 'purchase_value', (float) $purchase_value ); |
|
| 246 | - } |
|
| 223 | + /** |
|
| 224 | + * Sets customer status. |
|
| 225 | + * |
|
| 226 | + * @since 1.0.0 |
|
| 227 | + * @param string $status New status. |
|
| 228 | + */ |
|
| 229 | + public function set_status( $status ) { |
|
| 230 | + |
|
| 231 | + if ( in_array( $status, array( 'active', 'inactive', 'blocked' ), true ) ) { |
|
| 232 | + return $this->set_prop( 'status', $status ); |
|
| 233 | + } |
|
| 234 | + |
|
| 235 | + $this->set_prop( 'status', 'inactive' ); |
|
| 236 | + } |
|
| 237 | + |
|
| 238 | + /** |
|
| 239 | + * Sets the purchase value. |
|
| 240 | + * |
|
| 241 | + * @since 1.0.0 |
|
| 242 | + * @param float $purchase_value. |
|
| 243 | + */ |
|
| 244 | + public function set_purchase_value( $purchase_value ) { |
|
| 245 | + $this->set_prop( 'purchase_value', (float) $purchase_value ); |
|
| 246 | + } |
|
| 247 | 247 | |
| 248 | 248 | /** |
| 249 | - * Sets the purchase count. |
|
| 250 | - * |
|
| 251 | - * @since 1.0.0 |
|
| 252 | - * @param int $purchase_count. |
|
| 253 | - */ |
|
| 254 | - public function set_purchase_count( $purchase_count ) { |
|
| 255 | - $this->set_prop( 'purchase_count', absint( $purchase_count ) ); |
|
| 256 | - } |
|
| 249 | + * Sets the purchase count. |
|
| 250 | + * |
|
| 251 | + * @since 1.0.0 |
|
| 252 | + * @param int $purchase_count. |
|
| 253 | + */ |
|
| 254 | + public function set_purchase_count( $purchase_count ) { |
|
| 255 | + $this->set_prop( 'purchase_count', absint( $purchase_count ) ); |
|
| 256 | + } |
|
| 257 | 257 | |
| 258 | 258 | /** |
| 259 | - * Sets the user id. |
|
| 260 | - * |
|
| 261 | - * @since 1.0.0 |
|
| 262 | - * @param int $user_id. |
|
| 263 | - */ |
|
| 264 | - public function set_user_id( $user_id ) { |
|
| 265 | - $this->set_prop( 'user_id', absint( $user_id ) ); |
|
| 266 | - } |
|
| 259 | + * Sets the user id. |
|
| 260 | + * |
|
| 261 | + * @since 1.0.0 |
|
| 262 | + * @param int $user_id. |
|
| 263 | + */ |
|
| 264 | + public function set_user_id( $user_id ) { |
|
| 265 | + $this->set_prop( 'user_id', absint( $user_id ) ); |
|
| 266 | + } |
|
| 267 | 267 | |
| 268 | 268 | /** |
| 269 | - * Sets the email. |
|
| 270 | - * |
|
| 271 | - * @since 1.0.0 |
|
| 272 | - * @param string $email. |
|
| 273 | - */ |
|
| 274 | - public function set_email( $email ) { |
|
| 269 | + * Sets the email. |
|
| 270 | + * |
|
| 271 | + * @since 1.0.0 |
|
| 272 | + * @param string $email. |
|
| 273 | + */ |
|
| 274 | + public function set_email( $email ) { |
|
| 275 | 275 | $email = is_string( $email ) ? sanitize_email( $email ) : ''; |
| 276 | - $this->set_prop( 'email', $email ); |
|
| 277 | - } |
|
| 276 | + $this->set_prop( 'email', $email ); |
|
| 277 | + } |
|
| 278 | 278 | |
| 279 | 279 | /** |
| 280 | - * Sets the email cc. |
|
| 281 | - * |
|
| 282 | - * @since 1.0.0 |
|
| 283 | - * @param string $email_cc. |
|
| 284 | - */ |
|
| 285 | - public function set_email_cc( $email_cc ) { |
|
| 280 | + * Sets the email cc. |
|
| 281 | + * |
|
| 282 | + * @since 1.0.0 |
|
| 283 | + * @param string $email_cc. |
|
| 284 | + */ |
|
| 285 | + public function set_email_cc( $email_cc ) { |
|
| 286 | 286 | $email_cc = implode( ', ', wp_parse_list( $email_cc ) ); |
| 287 | - $this->set_prop( 'email_cc', $email_cc ); |
|
| 288 | - } |
|
| 287 | + $this->set_prop( 'email_cc', $email_cc ); |
|
| 288 | + } |
|
| 289 | 289 | |
| 290 | 290 | /** |
| 291 | - * Sets the created date. |
|
| 292 | - * |
|
| 293 | - * @since 1.0.0 |
|
| 294 | - * @param string $date_created date created. |
|
| 295 | - */ |
|
| 296 | - public function set_date_created( $date_created ) { |
|
| 291 | + * Sets the created date. |
|
| 292 | + * |
|
| 293 | + * @since 1.0.0 |
|
| 294 | + * @param string $date_created date created. |
|
| 295 | + */ |
|
| 296 | + public function set_date_created( $date_created ) { |
|
| 297 | 297 | |
| 298 | - $date = strtotime( $date_created ); |
|
| 298 | + $date = strtotime( $date_created ); |
|
| 299 | 299 | |
| 300 | 300 | if ( $date && $date_created !== '0000-00-00 00:00:00' && $date_created !== '0000-00-00 00:00' ) { |
| 301 | 301 | $this->set_prop( 'date_created', gmdate( 'Y-m-d H:i:s', $date ) ); |
| 302 | 302 | return; |
| 303 | - } |
|
| 303 | + } |
|
| 304 | 304 | |
| 305 | - $this->set_prop( 'date_created', null ); |
|
| 306 | - } |
|
| 305 | + $this->set_prop( 'date_created', null ); |
|
| 306 | + } |
|
| 307 | 307 | |
| 308 | 308 | /** |
| 309 | - * Sets the created date. |
|
| 310 | - * |
|
| 311 | - * @since 1.0.0 |
|
| 312 | - * @param string $date_modified date created. |
|
| 313 | - */ |
|
| 314 | - public function set_date_modified( $date_modified ) { |
|
| 309 | + * Sets the created date. |
|
| 310 | + * |
|
| 311 | + * @since 1.0.0 |
|
| 312 | + * @param string $date_modified date created. |
|
| 313 | + */ |
|
| 314 | + public function set_date_modified( $date_modified ) { |
|
| 315 | 315 | |
| 316 | - $date = strtotime( $date_modified ); |
|
| 316 | + $date = strtotime( $date_modified ); |
|
| 317 | 317 | |
| 318 | 318 | if ( $date && $date_modified !== '0000-00-00 00:00:00' && $date_modified !== '0000-00-00 00:00' ) { |
| 319 | 319 | $this->set_prop( 'date_modified', gmdate( 'Y-m-d H:i:s', $date ) ); |
| 320 | 320 | return; |
| 321 | - } |
|
| 321 | + } |
|
| 322 | 322 | |
| 323 | - $this->set_prop( 'date_modified', null ); |
|
| 324 | - } |
|
| 323 | + $this->set_prop( 'date_modified', null ); |
|
| 324 | + } |
|
| 325 | 325 | |
| 326 | - /* |
|
| 326 | + /* |
|
| 327 | 327 | |-------------------------------------------------------------------------- |
| 328 | 328 | | Additional methods |
| 329 | 329 | |-------------------------------------------------------------------------- |
@@ -332,12 +332,12 @@ discard block |
||
| 332 | 332 | | |
| 333 | 333 | */ |
| 334 | 334 | |
| 335 | - /** |
|
| 336 | - * Saves the customer. |
|
| 337 | - * |
|
| 338 | - * @since 1.0.0 |
|
| 339 | - */ |
|
| 340 | - public function save() { |
|
| 335 | + /** |
|
| 336 | + * Saves the customer. |
|
| 337 | + * |
|
| 338 | + * @since 1.0.0 |
|
| 339 | + */ |
|
| 340 | + public function save() { |
|
| 341 | 341 | |
| 342 | 342 | $maybe_set = array( |
| 343 | 343 | 'uuid' => wp_generate_uuid4(), |
@@ -354,23 +354,23 @@ discard block |
||
| 354 | 354 | |
| 355 | 355 | $this->set( 'date_modified', current_time( 'mysql' ) ); |
| 356 | 356 | |
| 357 | - return parent::save(); |
|
| 358 | - } |
|
| 357 | + return parent::save(); |
|
| 358 | + } |
|
| 359 | 359 | |
| 360 | 360 | /** |
| 361 | - * Helper method to clone a customer from a user ID. |
|
| 362 | - * |
|
| 363 | - * @since 1.0.0 |
|
| 364 | - * @param int $user_id. |
|
| 365 | - */ |
|
| 366 | - public function clone_user( $user_id ) { |
|
| 361 | + * Helper method to clone a customer from a user ID. |
|
| 362 | + * |
|
| 363 | + * @since 1.0.0 |
|
| 364 | + * @param int $user_id. |
|
| 365 | + */ |
|
| 366 | + public function clone_user( $user_id ) { |
|
| 367 | 367 | $user = get_userdata( $user_id ); |
| 368 | 368 | |
| 369 | 369 | if ( empty( $user ) ) { |
| 370 | 370 | return; |
| 371 | 371 | } |
| 372 | 372 | |
| 373 | - $this->set_user_id( $user->ID ); |
|
| 373 | + $this->set_user_id( $user->ID ); |
|
| 374 | 374 | $this->set_email( $user->user_email ); |
| 375 | 375 | $this->set_purchase_value( getpaid_get_user_total_spend( $user->ID ) ); |
| 376 | 376 | $this->set_purchase_count( getpaid_count_user_invoices( $user->ID ) ); |
@@ -399,18 +399,18 @@ discard block |
||
| 399 | 399 | continue; |
| 400 | 400 | } |
| 401 | 401 | } |
| 402 | - } |
|
| 403 | - } |
|
| 402 | + } |
|
| 403 | + } |
|
| 404 | 404 | |
| 405 | 405 | /** |
| 406 | - * Helper method to migrate an existing user ID to the new customers table. |
|
| 407 | - * |
|
| 408 | - * @since 1.0.0 |
|
| 409 | - * @param int $user_id. |
|
| 410 | - */ |
|
| 411 | - public function migrate_from_user( $user_id ) { |
|
| 406 | + * Helper method to migrate an existing user ID to the new customers table. |
|
| 407 | + * |
|
| 408 | + * @since 1.0.0 |
|
| 409 | + * @param int $user_id. |
|
| 410 | + */ |
|
| 411 | + public function migrate_from_user( $user_id ) { |
|
| 412 | 412 | $this->clone_user( $user_id ); |
| 413 | 413 | do_action( 'getpaid_customer_migrated_from_user', $this, $user_id ); |
| 414 | 414 | $this->save(); |
| 415 | - } |
|
| 415 | + } |
|
| 416 | 416 | } |
@@ -14,31 +14,31 @@ 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 | - 'customer_id' => 0, |
|
| 39 | - 'status' => 'wpi-pending', |
|
| 40 | - 'version' => '', |
|
| 41 | - '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 | + 'customer_id' => 0, |
|
| 39 | + 'status' => 'wpi-pending', |
|
| 40 | + 'version' => '', |
|
| 41 | + 'date_created' => null, |
|
| 42 | 42 | 'date_modified' => null, |
| 43 | 43 | 'due_date' => null, |
| 44 | 44 | 'completed_date' => null, |
@@ -61,17 +61,17 @@ discard block |
||
| 61 | 61 | 'state' => null, |
| 62 | 62 | 'zip' => null, |
| 63 | 63 | 'company' => null, |
| 64 | - 'company_id' => null, |
|
| 64 | + 'company_id' => null, |
|
| 65 | 65 | 'vat_number' => null, |
| 66 | 66 | 'vat_rate' => null, |
| 67 | 67 | 'address' => null, |
| 68 | 68 | 'address_confirmed' => false, |
| 69 | 69 | 'shipping' => null, |
| 70 | - 'subtotal' => 0, |
|
| 70 | + 'subtotal' => 0, |
|
| 71 | 71 | 'total_discount' => 0, |
| 72 | 72 | 'total_tax' => 0, |
| 73 | - 'total_fees' => 0, |
|
| 74 | - 'total' => 0, |
|
| 73 | + 'total_fees' => 0, |
|
| 74 | + 'total' => 0, |
|
| 75 | 75 | 'fees' => array(), |
| 76 | 76 | 'discounts' => array(), |
| 77 | 77 | 'taxes' => array(), |
@@ -83,22 +83,22 @@ discard block |
||
| 83 | 83 | 'transaction_id' => '', |
| 84 | 84 | 'currency' => '', |
| 85 | 85 | 'disable_taxes' => false, |
| 86 | - 'subscription_id' => null, |
|
| 87 | - 'remote_subscription_id' => null, |
|
| 88 | - 'is_viewed' => false, |
|
| 89 | - 'email_cc' => '', |
|
| 90 | - 'template' => 'quantity', // hours, amount only |
|
| 91 | - 'created_via' => null, |
|
| 86 | + 'subscription_id' => null, |
|
| 87 | + 'remote_subscription_id' => null, |
|
| 88 | + 'is_viewed' => false, |
|
| 89 | + 'email_cc' => '', |
|
| 90 | + 'template' => 'quantity', // hours, amount only |
|
| 91 | + 'created_via' => null, |
|
| 92 | 92 | ); |
| 93 | 93 | |
| 94 | 94 | /** |
| 95 | - * Stores meta in cache for future reads. |
|
| 96 | - * |
|
| 97 | - * A group must be set to to enable caching. |
|
| 98 | - * |
|
| 99 | - * @var string |
|
| 100 | - */ |
|
| 101 | - protected $cache_group = 'getpaid_invoices'; |
|
| 95 | + * Stores meta in cache for future reads. |
|
| 96 | + * |
|
| 97 | + * A group must be set to to enable caching. |
|
| 98 | + * |
|
| 99 | + * @var string |
|
| 100 | + */ |
|
| 101 | + protected $cache_group = 'getpaid_invoices'; |
|
| 102 | 102 | |
| 103 | 103 | /** |
| 104 | 104 | * Stores a reference to the original WP_Post object |
@@ -112,122 +112,122 @@ discard block |
||
| 112 | 112 | * |
| 113 | 113 | * @var int |
| 114 | 114 | */ |
| 115 | - protected $recurring_item = null; |
|
| 115 | + protected $recurring_item = null; |
|
| 116 | 116 | |
| 117 | - /** |
|
| 117 | + /** |
|
| 118 | 118 | * Stores an array of item totals. |
| 119 | - * |
|
| 120 | - * e.g $totals['discount'] = array( |
|
| 121 | - * 'initial' => 10, |
|
| 122 | - * 'recurring' => 10, |
|
| 123 | - * ) |
|
| 119 | + * |
|
| 120 | + * e.g $totals['discount'] = array( |
|
| 121 | + * 'initial' => 10, |
|
| 122 | + * 'recurring' => 10, |
|
| 123 | + * ) |
|
| 124 | 124 | * |
| 125 | 125 | * @var array |
| 126 | 126 | */ |
| 127 | - protected $totals = array(); |
|
| 127 | + protected $totals = array(); |
|
| 128 | 128 | |
| 129 | - /** |
|
| 129 | + /** |
|
| 130 | 130 | * Tax rate. |
| 131 | - * |
|
| 131 | + * |
|
| 132 | 132 | * @var float |
| 133 | 133 | */ |
| 134 | - protected $tax_rate = 0; |
|
| 134 | + protected $tax_rate = 0; |
|
| 135 | 135 | |
| 136 | - /** |
|
| 137 | - * Stores the status transition information. |
|
| 138 | - * |
|
| 139 | - * @since 1.0.19 |
|
| 140 | - * @var bool|array |
|
| 141 | - */ |
|
| 142 | - protected $status_transition = false; |
|
| 136 | + /** |
|
| 137 | + * Stores the status transition information. |
|
| 138 | + * |
|
| 139 | + * @since 1.0.19 |
|
| 140 | + * @var bool|array |
|
| 141 | + */ |
|
| 142 | + protected $status_transition = false; |
|
| 143 | 143 | |
| 144 | 144 | /** |
| 145 | - * Get the invoice if ID is passed, otherwise the invoice is new and empty. |
|
| 146 | - * |
|
| 147 | - * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object to read. |
|
| 148 | - */ |
|
| 145 | + * Get the invoice if ID is passed, otherwise the invoice is new and empty. |
|
| 146 | + * |
|
| 147 | + * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object to read. |
|
| 148 | + */ |
|
| 149 | 149 | public function __construct( $invoice = 0 ) { |
| 150 | 150 | |
| 151 | 151 | parent::__construct( $invoice ); |
| 152 | 152 | |
| 153 | - if ( ! empty( $invoice ) && is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( (int) $invoice ) ) ) { |
|
| 154 | - $this->set_id( (int) $invoice ); |
|
| 155 | - } elseif ( $invoice instanceof self ) { |
|
| 156 | - $this->set_id( $invoice->get_id() ); |
|
| 157 | - } elseif ( ! empty( $invoice->ID ) ) { |
|
| 158 | - $this->set_id( $invoice->ID ); |
|
| 159 | - } elseif ( is_array( $invoice ) ) { |
|
| 160 | - $this->set_props( $invoice ); |
|
| 161 | - |
|
| 162 | - if ( isset( $invoice['ID'] ) ) { |
|
| 163 | - $this->set_id( $invoice['ID'] ); |
|
| 164 | - } |
|
| 153 | + if ( ! empty( $invoice ) && is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( (int) $invoice ) ) ) { |
|
| 154 | + $this->set_id( (int) $invoice ); |
|
| 155 | + } elseif ( $invoice instanceof self ) { |
|
| 156 | + $this->set_id( $invoice->get_id() ); |
|
| 157 | + } elseif ( ! empty( $invoice->ID ) ) { |
|
| 158 | + $this->set_id( $invoice->ID ); |
|
| 159 | + } elseif ( is_array( $invoice ) ) { |
|
| 160 | + $this->set_props( $invoice ); |
|
| 161 | + |
|
| 162 | + if ( isset( $invoice['ID'] ) ) { |
|
| 163 | + $this->set_id( $invoice['ID'] ); |
|
| 164 | + } |
|
| 165 | 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 | - } |
|
| 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'; |
| 222 | - $db_field = 'key' === $field ? 'invoice_key' : $field; |
|
| 222 | + $db_field = 'key' === $field ? 'invoice_key' : $field; |
|
| 223 | 223 | $invoice_id = (int) $wpdb->get_var( |
| 224 | 224 | $wpdb->prepare( "SELECT `post_id` FROM $table WHERE `$db_field`=%s LIMIT 1", $value ) |
| 225 | 225 | ); |
| 226 | 226 | |
| 227 | - // Update the cache with our data |
|
| 228 | - wp_cache_set( $value, $invoice_id, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
| 227 | + // Update the cache with our data |
|
| 228 | + wp_cache_set( $value, $invoice_id, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
| 229 | 229 | |
| 230 | - return $invoice_id; |
|
| 230 | + return $invoice_id; |
|
| 231 | 231 | } |
| 232 | 232 | |
| 233 | 233 | /** |
@@ -253,83 +253,83 @@ discard block |
||
| 253 | 253 | */ |
| 254 | 254 | |
| 255 | 255 | /** |
| 256 | - * Get parent invoice ID. |
|
| 257 | - * |
|
| 258 | - * @since 1.0.19 |
|
| 259 | - * @param string $context View or edit context. |
|
| 260 | - * @return int |
|
| 261 | - */ |
|
| 262 | - public function get_parent_id( $context = 'view' ) { |
|
| 263 | - return (int) $this->get_prop( 'parent_id', $context ); |
|
| 256 | + * Get parent invoice ID. |
|
| 257 | + * |
|
| 258 | + * @since 1.0.19 |
|
| 259 | + * @param string $context View or edit context. |
|
| 260 | + * @return int |
|
| 261 | + */ |
|
| 262 | + public function get_parent_id( $context = 'view' ) { |
|
| 263 | + return (int) $this->get_prop( 'parent_id', $context ); |
|
| 264 | 264 | } |
| 265 | 265 | |
| 266 | 266 | /** |
| 267 | - * Get parent invoice. |
|
| 268 | - * |
|
| 269 | - * @since 1.0.19 |
|
| 270 | - * @return WPInv_Invoice |
|
| 271 | - */ |
|
| 267 | + * Get parent invoice. |
|
| 268 | + * |
|
| 269 | + * @since 1.0.19 |
|
| 270 | + * @return WPInv_Invoice |
|
| 271 | + */ |
|
| 272 | 272 | public function get_parent_payment() { |
| 273 | 273 | return new WPInv_Invoice( $this->get_parent_id() ); |
| 274 | 274 | } |
| 275 | 275 | |
| 276 | 276 | /** |
| 277 | - * Alias for self::get_parent_payment(). |
|
| 278 | - * |
|
| 279 | - * @since 1.0.19 |
|
| 280 | - * @return WPInv_Invoice |
|
| 281 | - */ |
|
| 277 | + * Alias for self::get_parent_payment(). |
|
| 278 | + * |
|
| 279 | + * @since 1.0.19 |
|
| 280 | + * @return WPInv_Invoice |
|
| 281 | + */ |
|
| 282 | 282 | public function get_parent() { |
| 283 | 283 | return $this->get_parent_payment(); |
| 284 | 284 | } |
| 285 | 285 | |
| 286 | 286 | /** |
| 287 | - * Get invoice status. |
|
| 288 | - * |
|
| 289 | - * @since 1.0.19 |
|
| 290 | - * @param string $context View or edit context. |
|
| 291 | - * @return string |
|
| 292 | - */ |
|
| 293 | - public function get_status( $context = 'view' ) { |
|
| 294 | - return $this->get_prop( 'status', $context ); |
|
| 295 | - } |
|
| 287 | + * Get invoice status. |
|
| 288 | + * |
|
| 289 | + * @since 1.0.19 |
|
| 290 | + * @param string $context View or edit context. |
|
| 291 | + * @return string |
|
| 292 | + */ |
|
| 293 | + public function get_status( $context = 'view' ) { |
|
| 294 | + return $this->get_prop( 'status', $context ); |
|
| 295 | + } |
|
| 296 | 296 | |
| 297 | - /** |
|
| 298 | - * Retrieves an array of possible invoice statuses. |
|
| 299 | - * |
|
| 300 | - * @since 1.0.19 |
|
| 301 | - * @return array |
|
| 302 | - */ |
|
| 303 | - public function get_all_statuses() { |
|
| 304 | - return wpinv_get_invoice_statuses( true, true, $this ); |
|
| 297 | + /** |
|
| 298 | + * Retrieves an array of possible invoice statuses. |
|
| 299 | + * |
|
| 300 | + * @since 1.0.19 |
|
| 301 | + * @return array |
|
| 302 | + */ |
|
| 303 | + public function get_all_statuses() { |
|
| 304 | + return wpinv_get_invoice_statuses( true, true, $this ); |
|
| 305 | 305 | } |
| 306 | 306 | |
| 307 | 307 | /** |
| 308 | - * Get invoice status nice name. |
|
| 309 | - * |
|
| 310 | - * @since 1.0.19 |
|
| 311 | - * @return string |
|
| 312 | - */ |
|
| 308 | + * Get invoice status nice name. |
|
| 309 | + * |
|
| 310 | + * @since 1.0.19 |
|
| 311 | + * @return string |
|
| 312 | + */ |
|
| 313 | 313 | public function get_status_nicename() { |
| 314 | - $statuses = $this->get_all_statuses(); |
|
| 314 | + $statuses = $this->get_all_statuses(); |
|
| 315 | 315 | |
| 316 | 316 | $status = isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : $this->get_status(); |
| 317 | 317 | |
| 318 | 318 | return apply_filters( 'wpinv_get_invoice_status_nicename', $status, $this ); |
| 319 | 319 | } |
| 320 | 320 | |
| 321 | - /** |
|
| 322 | - * Retrieves the invoice status class |
|
| 323 | - * |
|
| 324 | - * @since 1.0.19 |
|
| 325 | - * @return string |
|
| 326 | - */ |
|
| 327 | - public function get_status_class() { |
|
| 328 | - $statuses = getpaid_get_invoice_status_classes(); |
|
| 329 | - return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'bg-dark'; |
|
| 330 | - } |
|
| 321 | + /** |
|
| 322 | + * Retrieves the invoice status class |
|
| 323 | + * |
|
| 324 | + * @since 1.0.19 |
|
| 325 | + * @return string |
|
| 326 | + */ |
|
| 327 | + public function get_status_class() { |
|
| 328 | + $statuses = getpaid_get_invoice_status_classes(); |
|
| 329 | + return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'bg-dark'; |
|
| 330 | + } |
|
| 331 | 331 | |
| 332 | - /** |
|
| 332 | + /** |
|
| 333 | 333 | * Retrieves the invoice status label html |
| 334 | 334 | * |
| 335 | 335 | * @since 1.0.0 |
@@ -337,263 +337,263 @@ discard block |
||
| 337 | 337 | */ |
| 338 | 338 | public function get_status_label_html() { |
| 339 | 339 | |
| 340 | - $status_label = sanitize_text_field( $this->get_status_nicename() ); |
|
| 341 | - $status = sanitize_html_class( $this->get_status() ); |
|
| 342 | - $class = esc_attr( $this->get_status_class() ); |
|
| 343 | - |
|
| 344 | - return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
| 345 | - } |
|
| 346 | - |
|
| 347 | - /** |
|
| 348 | - * Get plugin version when the invoice was created. |
|
| 349 | - * |
|
| 350 | - * @since 1.0.19 |
|
| 351 | - * @param string $context View or edit context. |
|
| 352 | - * @return string |
|
| 353 | - */ |
|
| 354 | - public function get_version( $context = 'view' ) { |
|
| 355 | - return $this->get_prop( 'version', $context ); |
|
| 356 | - } |
|
| 357 | - |
|
| 358 | - /** |
|
| 359 | - * @deprecated |
|
| 360 | - */ |
|
| 361 | - public function get_invoice_date( $format = true ) { |
|
| 362 | - $date = getpaid_format_date( $this->get_date_completed() ); |
|
| 363 | - $date = empty( $date ) ? $this->get_date_created() : $this->get_date_completed(); |
|
| 364 | - $formatted = getpaid_format_date( $date ); |
|
| 365 | - |
|
| 366 | - if ( $format ) { |
|
| 367 | - return $formatted; |
|
| 368 | - } |
|
| 369 | - |
|
| 370 | - return empty( $formatted ) ? '' : $date; |
|
| 371 | - |
|
| 372 | - } |
|
| 373 | - |
|
| 374 | - /** |
|
| 375 | - * Get date when the invoice was created. |
|
| 376 | - * |
|
| 377 | - * @since 1.0.19 |
|
| 378 | - * @param string $context View or edit context. |
|
| 379 | - * @return string |
|
| 380 | - */ |
|
| 381 | - public function get_date_created( $context = 'view' ) { |
|
| 382 | - return $this->get_prop( 'date_created', $context ); |
|
| 383 | - } |
|
| 384 | - |
|
| 385 | - /** |
|
| 386 | - * Alias for self::get_date_created(). |
|
| 387 | - * |
|
| 388 | - * @since 1.0.19 |
|
| 389 | - * @param string $context View or edit context. |
|
| 390 | - * @return string |
|
| 391 | - */ |
|
| 392 | - public function get_created_date( $context = 'view' ) { |
|
| 393 | - return $this->get_date_created( $context ); |
|
| 394 | - } |
|
| 395 | - |
|
| 396 | - /** |
|
| 397 | - * Get GMT date when the invoice was created. |
|
| 398 | - * |
|
| 399 | - * @since 1.0.19 |
|
| 400 | - * @param string $context View or edit context. |
|
| 401 | - * @return string |
|
| 402 | - */ |
|
| 403 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 340 | + $status_label = sanitize_text_field( $this->get_status_nicename() ); |
|
| 341 | + $status = sanitize_html_class( $this->get_status() ); |
|
| 342 | + $class = esc_attr( $this->get_status_class() ); |
|
| 343 | + |
|
| 344 | + return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
| 345 | + } |
|
| 346 | + |
|
| 347 | + /** |
|
| 348 | + * Get plugin version when the invoice was created. |
|
| 349 | + * |
|
| 350 | + * @since 1.0.19 |
|
| 351 | + * @param string $context View or edit context. |
|
| 352 | + * @return string |
|
| 353 | + */ |
|
| 354 | + public function get_version( $context = 'view' ) { |
|
| 355 | + return $this->get_prop( 'version', $context ); |
|
| 356 | + } |
|
| 357 | + |
|
| 358 | + /** |
|
| 359 | + * @deprecated |
|
| 360 | + */ |
|
| 361 | + public function get_invoice_date( $format = true ) { |
|
| 362 | + $date = getpaid_format_date( $this->get_date_completed() ); |
|
| 363 | + $date = empty( $date ) ? $this->get_date_created() : $this->get_date_completed(); |
|
| 364 | + $formatted = getpaid_format_date( $date ); |
|
| 365 | + |
|
| 366 | + if ( $format ) { |
|
| 367 | + return $formatted; |
|
| 368 | + } |
|
| 369 | + |
|
| 370 | + return empty( $formatted ) ? '' : $date; |
|
| 371 | + |
|
| 372 | + } |
|
| 373 | + |
|
| 374 | + /** |
|
| 375 | + * Get date when the invoice was created. |
|
| 376 | + * |
|
| 377 | + * @since 1.0.19 |
|
| 378 | + * @param string $context View or edit context. |
|
| 379 | + * @return string |
|
| 380 | + */ |
|
| 381 | + public function get_date_created( $context = 'view' ) { |
|
| 382 | + return $this->get_prop( 'date_created', $context ); |
|
| 383 | + } |
|
| 384 | + |
|
| 385 | + /** |
|
| 386 | + * Alias for self::get_date_created(). |
|
| 387 | + * |
|
| 388 | + * @since 1.0.19 |
|
| 389 | + * @param string $context View or edit context. |
|
| 390 | + * @return string |
|
| 391 | + */ |
|
| 392 | + public function get_created_date( $context = 'view' ) { |
|
| 393 | + return $this->get_date_created( $context ); |
|
| 394 | + } |
|
| 395 | + |
|
| 396 | + /** |
|
| 397 | + * Get GMT date when the invoice was created. |
|
| 398 | + * |
|
| 399 | + * @since 1.0.19 |
|
| 400 | + * @param string $context View or edit context. |
|
| 401 | + * @return string |
|
| 402 | + */ |
|
| 403 | + public function get_date_created_gmt( $context = 'view' ) { |
|
| 404 | 404 | $date = $this->get_date_created( $context ); |
| 405 | 405 | |
| 406 | 406 | if ( $date ) { |
| 407 | 407 | $date = get_gmt_from_date( $date ); |
| 408 | 408 | } |
| 409 | - return $date; |
|
| 409 | + return $date; |
|
| 410 | 410 | } |
| 411 | 411 | |
| 412 | 412 | /** |
| 413 | - * Get date when the invoice was last modified. |
|
| 414 | - * |
|
| 415 | - * @since 1.0.19 |
|
| 416 | - * @param string $context View or edit context. |
|
| 417 | - * @return string |
|
| 418 | - */ |
|
| 419 | - public function get_date_modified( $context = 'view' ) { |
|
| 420 | - return $this->get_prop( 'date_modified', $context ); |
|
| 421 | - } |
|
| 413 | + * Get date when the invoice was last modified. |
|
| 414 | + * |
|
| 415 | + * @since 1.0.19 |
|
| 416 | + * @param string $context View or edit context. |
|
| 417 | + * @return string |
|
| 418 | + */ |
|
| 419 | + public function get_date_modified( $context = 'view' ) { |
|
| 420 | + return $this->get_prop( 'date_modified', $context ); |
|
| 421 | + } |
|
| 422 | 422 | |
| 423 | - /** |
|
| 424 | - * Alias for self::get_date_modified(). |
|
| 425 | - * |
|
| 426 | - * @since 1.0.19 |
|
| 427 | - * @param string $context View or edit context. |
|
| 428 | - * @return string |
|
| 429 | - */ |
|
| 430 | - public function get_modified_date( $context = 'view' ) { |
|
| 431 | - return $this->get_date_modified( $context ); |
|
| 423 | + /** |
|
| 424 | + * Alias for self::get_date_modified(). |
|
| 425 | + * |
|
| 426 | + * @since 1.0.19 |
|
| 427 | + * @param string $context View or edit context. |
|
| 428 | + * @return string |
|
| 429 | + */ |
|
| 430 | + public function get_modified_date( $context = 'view' ) { |
|
| 431 | + return $this->get_date_modified( $context ); |
|
| 432 | 432 | } |
| 433 | 433 | |
| 434 | 434 | /** |
| 435 | - * Get GMT date when the invoice was last modified. |
|
| 436 | - * |
|
| 437 | - * @since 1.0.19 |
|
| 438 | - * @param string $context View or edit context. |
|
| 439 | - * @return string |
|
| 440 | - */ |
|
| 441 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
| 435 | + * Get GMT date when the invoice was last modified. |
|
| 436 | + * |
|
| 437 | + * @since 1.0.19 |
|
| 438 | + * @param string $context View or edit context. |
|
| 439 | + * @return string |
|
| 440 | + */ |
|
| 441 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
| 442 | 442 | $date = $this->get_date_modified( $context ); |
| 443 | 443 | |
| 444 | 444 | if ( $date ) { |
| 445 | 445 | $date = get_gmt_from_date( $date ); |
| 446 | 446 | } |
| 447 | - return $date; |
|
| 447 | + return $date; |
|
| 448 | 448 | } |
| 449 | 449 | |
| 450 | 450 | /** |
| 451 | - * Get the invoice due date. |
|
| 452 | - * |
|
| 453 | - * @since 1.0.19 |
|
| 454 | - * @param string $context View or edit context. |
|
| 455 | - * @return string |
|
| 456 | - */ |
|
| 457 | - public function get_due_date( $context = 'view' ) { |
|
| 458 | - return $this->get_prop( 'due_date', $context ); |
|
| 451 | + * Get the invoice due date. |
|
| 452 | + * |
|
| 453 | + * @since 1.0.19 |
|
| 454 | + * @param string $context View or edit context. |
|
| 455 | + * @return string |
|
| 456 | + */ |
|
| 457 | + public function get_due_date( $context = 'view' ) { |
|
| 458 | + return $this->get_prop( 'due_date', $context ); |
|
| 459 | 459 | } |
| 460 | 460 | |
| 461 | 461 | /** |
| 462 | - * Alias for self::get_due_date(). |
|
| 463 | - * |
|
| 464 | - * @since 1.0.19 |
|
| 465 | - * @param string $context View or edit context. |
|
| 466 | - * @return string |
|
| 467 | - */ |
|
| 468 | - public function get_date_due( $context = 'view' ) { |
|
| 469 | - return $this->get_due_date( $context ); |
|
| 462 | + * Alias for self::get_due_date(). |
|
| 463 | + * |
|
| 464 | + * @since 1.0.19 |
|
| 465 | + * @param string $context View or edit context. |
|
| 466 | + * @return string |
|
| 467 | + */ |
|
| 468 | + public function get_date_due( $context = 'view' ) { |
|
| 469 | + return $this->get_due_date( $context ); |
|
| 470 | 470 | } |
| 471 | 471 | |
| 472 | 472 | /** |
| 473 | - * Get the invoice GMT due date. |
|
| 474 | - * |
|
| 475 | - * @since 1.0.19 |
|
| 476 | - * @param string $context View or edit context. |
|
| 477 | - * @return string |
|
| 478 | - */ |
|
| 479 | - public function get_due_date_gmt( $context = 'view' ) { |
|
| 473 | + * Get the invoice GMT due date. |
|
| 474 | + * |
|
| 475 | + * @since 1.0.19 |
|
| 476 | + * @param string $context View or edit context. |
|
| 477 | + * @return string |
|
| 478 | + */ |
|
| 479 | + public function get_due_date_gmt( $context = 'view' ) { |
|
| 480 | 480 | $date = $this->get_due_date( $context ); |
| 481 | 481 | |
| 482 | 482 | if ( $date ) { |
| 483 | 483 | $date = get_gmt_from_date( $date ); |
| 484 | 484 | } |
| 485 | - return $date; |
|
| 485 | + return $date; |
|
| 486 | 486 | } |
| 487 | 487 | |
| 488 | 488 | /** |
| 489 | - * Alias for self::get_due_date_gmt(). |
|
| 490 | - * |
|
| 491 | - * @since 1.0.19 |
|
| 492 | - * @param string $context View or edit context. |
|
| 493 | - * @return string |
|
| 494 | - */ |
|
| 495 | - public function get_gmt_date_due( $context = 'view' ) { |
|
| 496 | - return $this->get_due_date_gmt( $context ); |
|
| 489 | + * Alias for self::get_due_date_gmt(). |
|
| 490 | + * |
|
| 491 | + * @since 1.0.19 |
|
| 492 | + * @param string $context View or edit context. |
|
| 493 | + * @return string |
|
| 494 | + */ |
|
| 495 | + public function get_gmt_date_due( $context = 'view' ) { |
|
| 496 | + return $this->get_due_date_gmt( $context ); |
|
| 497 | 497 | } |
| 498 | 498 | |
| 499 | 499 | /** |
| 500 | - * Get date when the invoice was completed. |
|
| 501 | - * |
|
| 502 | - * @since 1.0.19 |
|
| 503 | - * @param string $context View or edit context. |
|
| 504 | - * @return string |
|
| 505 | - */ |
|
| 506 | - public function get_completed_date( $context = 'view' ) { |
|
| 507 | - return $this->get_prop( 'completed_date', $context ); |
|
| 500 | + * Get date when the invoice was completed. |
|
| 501 | + * |
|
| 502 | + * @since 1.0.19 |
|
| 503 | + * @param string $context View or edit context. |
|
| 504 | + * @return string |
|
| 505 | + */ |
|
| 506 | + public function get_completed_date( $context = 'view' ) { |
|
| 507 | + return $this->get_prop( 'completed_date', $context ); |
|
| 508 | 508 | } |
| 509 | 509 | |
| 510 | 510 | /** |
| 511 | - * Alias for self::get_completed_date(). |
|
| 512 | - * |
|
| 513 | - * @since 1.0.19 |
|
| 514 | - * @param string $context View or edit context. |
|
| 515 | - * @return string |
|
| 516 | - */ |
|
| 517 | - public function get_date_completed( $context = 'view' ) { |
|
| 518 | - return $this->get_completed_date( $context ); |
|
| 511 | + * Alias for self::get_completed_date(). |
|
| 512 | + * |
|
| 513 | + * @since 1.0.19 |
|
| 514 | + * @param string $context View or edit context. |
|
| 515 | + * @return string |
|
| 516 | + */ |
|
| 517 | + public function get_date_completed( $context = 'view' ) { |
|
| 518 | + return $this->get_completed_date( $context ); |
|
| 519 | 519 | } |
| 520 | 520 | |
| 521 | 521 | /** |
| 522 | - * Get GMT date when the invoice was was completed. |
|
| 523 | - * |
|
| 524 | - * @since 1.0.19 |
|
| 525 | - * @param string $context View or edit context. |
|
| 526 | - * @return string |
|
| 527 | - */ |
|
| 528 | - public function get_completed_date_gmt( $context = 'view' ) { |
|
| 522 | + * Get GMT date when the invoice was was completed. |
|
| 523 | + * |
|
| 524 | + * @since 1.0.19 |
|
| 525 | + * @param string $context View or edit context. |
|
| 526 | + * @return string |
|
| 527 | + */ |
|
| 528 | + public function get_completed_date_gmt( $context = 'view' ) { |
|
| 529 | 529 | $date = $this->get_completed_date( $context ); |
| 530 | 530 | |
| 531 | 531 | if ( $date ) { |
| 532 | 532 | $date = get_gmt_from_date( $date ); |
| 533 | 533 | } |
| 534 | - return $date; |
|
| 534 | + return $date; |
|
| 535 | 535 | } |
| 536 | 536 | |
| 537 | 537 | /** |
| 538 | - * Alias for self::get_completed_date_gmt(). |
|
| 539 | - * |
|
| 540 | - * @since 1.0.19 |
|
| 541 | - * @param string $context View or edit context. |
|
| 542 | - * @return string |
|
| 543 | - */ |
|
| 544 | - public function get_gmt_completed_date( $context = 'view' ) { |
|
| 545 | - return $this->get_completed_date_gmt( $context ); |
|
| 538 | + * Alias for self::get_completed_date_gmt(). |
|
| 539 | + * |
|
| 540 | + * @since 1.0.19 |
|
| 541 | + * @param string $context View or edit context. |
|
| 542 | + * @return string |
|
| 543 | + */ |
|
| 544 | + public function get_gmt_completed_date( $context = 'view' ) { |
|
| 545 | + return $this->get_completed_date_gmt( $context ); |
|
| 546 | 546 | } |
| 547 | 547 | |
| 548 | 548 | /** |
| 549 | - * Get the invoice number. |
|
| 550 | - * |
|
| 551 | - * @since 1.0.19 |
|
| 552 | - * @param string $context View or edit context. |
|
| 553 | - * @return string |
|
| 554 | - */ |
|
| 555 | - public function get_number( $context = 'view' ) { |
|
| 556 | - $number = $this->get_prop( 'number', $context ); |
|
| 549 | + * Get the invoice number. |
|
| 550 | + * |
|
| 551 | + * @since 1.0.19 |
|
| 552 | + * @param string $context View or edit context. |
|
| 553 | + * @return string |
|
| 554 | + */ |
|
| 555 | + public function get_number( $context = 'view' ) { |
|
| 556 | + $number = $this->get_prop( 'number', $context ); |
|
| 557 | 557 | |
| 558 | - if ( empty( $number ) ) { |
|
| 559 | - $number = $this->generate_number(); |
|
| 560 | - $this->set_number( $this->generate_number() ); |
|
| 561 | - } |
|
| 558 | + if ( empty( $number ) ) { |
|
| 559 | + $number = $this->generate_number(); |
|
| 560 | + $this->set_number( $this->generate_number() ); |
|
| 561 | + } |
|
| 562 | 562 | |
| 563 | - return $number; |
|
| 563 | + return $number; |
|
| 564 | 564 | } |
| 565 | 565 | |
| 566 | - /** |
|
| 567 | - * Set the invoice number. |
|
| 568 | - * |
|
| 569 | - * @since 1.0.19 |
|
| 570 | - */ |
|
| 571 | - public function maybe_set_number() { |
|
| 566 | + /** |
|
| 567 | + * Set the invoice number. |
|
| 568 | + * |
|
| 569 | + * @since 1.0.19 |
|
| 570 | + */ |
|
| 571 | + public function maybe_set_number() { |
|
| 572 | 572 | $number = $this->get_number(); |
| 573 | 573 | |
| 574 | 574 | if ( empty( $number ) || $this->get_id() == $number ) { |
| 575 | - $this->set_number( $this->generate_number() ); |
|
| 575 | + $this->set_number( $this->generate_number() ); |
|
| 576 | 576 | } |
| 577 | 577 | |
| 578 | - } |
|
| 578 | + } |
|
| 579 | 579 | |
| 580 | 580 | /** |
| 581 | - * Get the invoice key. |
|
| 582 | - * |
|
| 583 | - * @since 1.0.19 |
|
| 584 | - * @param string $context View or edit context. |
|
| 585 | - * @return string |
|
| 586 | - */ |
|
| 587 | - public function get_key( $context = 'view' ) { |
|
| 581 | + * Get the invoice key. |
|
| 582 | + * |
|
| 583 | + * @since 1.0.19 |
|
| 584 | + * @param string $context View or edit context. |
|
| 585 | + * @return string |
|
| 586 | + */ |
|
| 587 | + public function get_key( $context = 'view' ) { |
|
| 588 | 588 | return $this->get_prop( 'key', $context ); |
| 589 | - } |
|
| 590 | - |
|
| 591 | - /** |
|
| 592 | - * Set the invoice key. |
|
| 593 | - * |
|
| 594 | - * @since 1.0.19 |
|
| 595 | - */ |
|
| 596 | - public function maybe_set_key() { |
|
| 589 | + } |
|
| 590 | + |
|
| 591 | + /** |
|
| 592 | + * Set the invoice key. |
|
| 593 | + * |
|
| 594 | + * @since 1.0.19 |
|
| 595 | + */ |
|
| 596 | + public function maybe_set_key() { |
|
| 597 | 597 | $key = $this->get_key(); |
| 598 | 598 | |
| 599 | 599 | if ( empty( $key ) ) { |
@@ -604,140 +604,140 @@ discard block |
||
| 604 | 604 | } |
| 605 | 605 | |
| 606 | 606 | /** |
| 607 | - * Get the invoice type. |
|
| 608 | - * |
|
| 609 | - * @since 1.0.19 |
|
| 610 | - * @param string $context View or edit context. |
|
| 611 | - * @return string |
|
| 612 | - */ |
|
| 613 | - public function get_type( $context = 'view' ) { |
|
| 607 | + * Get the invoice type. |
|
| 608 | + * |
|
| 609 | + * @since 1.0.19 |
|
| 610 | + * @param string $context View or edit context. |
|
| 611 | + * @return string |
|
| 612 | + */ |
|
| 613 | + public function get_type( $context = 'view' ) { |
|
| 614 | 614 | return $this->get_prop( 'type', $context ); |
| 615 | - } |
|
| 616 | - |
|
| 617 | - /** |
|
| 618 | - * Returns the post type name. |
|
| 619 | - * |
|
| 620 | - * @since 1.0.19 |
|
| 621 | - * @return string |
|
| 622 | - */ |
|
| 623 | - public function get_invoice_quote_type() { |
|
| 615 | + } |
|
| 616 | + |
|
| 617 | + /** |
|
| 618 | + * Returns the post type name. |
|
| 619 | + * |
|
| 620 | + * @since 1.0.19 |
|
| 621 | + * @return string |
|
| 622 | + */ |
|
| 623 | + public function get_invoice_quote_type() { |
|
| 624 | 624 | return getpaid_get_post_type_label( $this->get_post_type(), false ); |
| 625 | 625 | } |
| 626 | 626 | |
| 627 | 627 | /** |
| 628 | - * Get the invoice post type label. |
|
| 629 | - * |
|
| 630 | - * @since 1.0.19 |
|
| 631 | - * @param string $context View or edit context. |
|
| 632 | - * @return string |
|
| 633 | - */ |
|
| 634 | - public function get_label( $context = 'view' ) { |
|
| 628 | + * Get the invoice post type label. |
|
| 629 | + * |
|
| 630 | + * @since 1.0.19 |
|
| 631 | + * @param string $context View or edit context. |
|
| 632 | + * @return string |
|
| 633 | + */ |
|
| 634 | + public function get_label( $context = 'view' ) { |
|
| 635 | 635 | return getpaid_get_post_type_label( $this->get_post_type( $context ), false ); |
| 636 | - } |
|
| 637 | - |
|
| 638 | - /** |
|
| 639 | - * Get the invoice post type. |
|
| 640 | - * |
|
| 641 | - * @since 1.0.19 |
|
| 642 | - * @param string $context View or edit context. |
|
| 643 | - * @return string |
|
| 644 | - */ |
|
| 645 | - public function get_post_type( $context = 'view' ) { |
|
| 636 | + } |
|
| 637 | + |
|
| 638 | + /** |
|
| 639 | + * Get the invoice post type. |
|
| 640 | + * |
|
| 641 | + * @since 1.0.19 |
|
| 642 | + * @param string $context View or edit context. |
|
| 643 | + * @return string |
|
| 644 | + */ |
|
| 645 | + public function get_post_type( $context = 'view' ) { |
|
| 646 | 646 | return $this->get_prop( 'post_type', $context ); |
| 647 | 647 | } |
| 648 | 648 | |
| 649 | 649 | /** |
| 650 | - * Get the invoice mode. |
|
| 651 | - * |
|
| 652 | - * @since 1.0.19 |
|
| 653 | - * @param string $context View or edit context. |
|
| 654 | - * @return string |
|
| 655 | - */ |
|
| 656 | - public function get_mode( $context = 'view' ) { |
|
| 650 | + * Get the invoice mode. |
|
| 651 | + * |
|
| 652 | + * @since 1.0.19 |
|
| 653 | + * @param string $context View or edit context. |
|
| 654 | + * @return string |
|
| 655 | + */ |
|
| 656 | + public function get_mode( $context = 'view' ) { |
|
| 657 | 657 | return $this->get_prop( 'mode', $context ); |
| 658 | 658 | } |
| 659 | 659 | |
| 660 | 660 | /** |
| 661 | - * Get the invoice path. |
|
| 662 | - * |
|
| 663 | - * @since 1.0.19 |
|
| 664 | - * @param string $context View or edit context. |
|
| 665 | - * @return string |
|
| 666 | - */ |
|
| 667 | - public function get_path( $context = 'view' ) { |
|
| 661 | + * Get the invoice path. |
|
| 662 | + * |
|
| 663 | + * @since 1.0.19 |
|
| 664 | + * @param string $context View or edit context. |
|
| 665 | + * @return string |
|
| 666 | + */ |
|
| 667 | + public function get_path( $context = 'view' ) { |
|
| 668 | 668 | $path = $this->get_prop( 'path', $context ); |
| 669 | - $prefix = $this->get_type(); |
|
| 669 | + $prefix = $this->get_type(); |
|
| 670 | 670 | |
| 671 | - if ( 0 !== strpos( $path, $prefix ) ) { |
|
| 672 | - $path = sanitize_title( $prefix . '-' . $this->get_id() ); |
|
| 673 | - $this->set_path( $path ); |
|
| 674 | - } |
|
| 671 | + if ( 0 !== strpos( $path, $prefix ) ) { |
|
| 672 | + $path = sanitize_title( $prefix . '-' . $this->get_id() ); |
|
| 673 | + $this->set_path( $path ); |
|
| 674 | + } |
|
| 675 | 675 | |
| 676 | - return $path; |
|
| 676 | + return $path; |
|
| 677 | 677 | } |
| 678 | 678 | |
| 679 | 679 | /** |
| 680 | - * Get the invoice name/title. |
|
| 681 | - * |
|
| 682 | - * @since 1.0.19 |
|
| 683 | - * @param string $context View or edit context. |
|
| 684 | - * @return string |
|
| 685 | - */ |
|
| 686 | - public function get_name( $context = 'view' ) { |
|
| 680 | + * Get the invoice name/title. |
|
| 681 | + * |
|
| 682 | + * @since 1.0.19 |
|
| 683 | + * @param string $context View or edit context. |
|
| 684 | + * @return string |
|
| 685 | + */ |
|
| 686 | + public function get_name( $context = 'view' ) { |
|
| 687 | 687 | return $this->get_prop( 'title', $context ); |
| 688 | 688 | } |
| 689 | 689 | |
| 690 | 690 | /** |
| 691 | - * Alias of self::get_name(). |
|
| 692 | - * |
|
| 693 | - * @since 1.0.19 |
|
| 694 | - * @param string $context View or edit context. |
|
| 695 | - * @return string |
|
| 696 | - */ |
|
| 697 | - public function get_title( $context = 'view' ) { |
|
| 698 | - return $this->get_name( $context ); |
|
| 691 | + * Alias of self::get_name(). |
|
| 692 | + * |
|
| 693 | + * @since 1.0.19 |
|
| 694 | + * @param string $context View or edit context. |
|
| 695 | + * @return string |
|
| 696 | + */ |
|
| 697 | + public function get_title( $context = 'view' ) { |
|
| 698 | + return $this->get_name( $context ); |
|
| 699 | 699 | } |
| 700 | 700 | |
| 701 | 701 | /** |
| 702 | - * Get the invoice description. |
|
| 703 | - * |
|
| 704 | - * @since 1.0.19 |
|
| 705 | - * @param string $context View or edit context. |
|
| 706 | - * @return string |
|
| 707 | - */ |
|
| 708 | - public function get_description( $context = 'view' ) { |
|
| 709 | - return $this->get_prop( 'description', $context ); |
|
| 702 | + * Get the invoice description. |
|
| 703 | + * |
|
| 704 | + * @since 1.0.19 |
|
| 705 | + * @param string $context View or edit context. |
|
| 706 | + * @return string |
|
| 707 | + */ |
|
| 708 | + public function get_description( $context = 'view' ) { |
|
| 709 | + return $this->get_prop( 'description', $context ); |
|
| 710 | 710 | } |
| 711 | 711 | |
| 712 | 712 | /** |
| 713 | - * Alias of self::get_description(). |
|
| 714 | - * |
|
| 715 | - * @since 1.0.19 |
|
| 716 | - * @param string $context View or edit context. |
|
| 717 | - * @return string |
|
| 718 | - */ |
|
| 719 | - public function get_excerpt( $context = 'view' ) { |
|
| 720 | - return $this->get_description( $context ); |
|
| 713 | + * Alias of self::get_description(). |
|
| 714 | + * |
|
| 715 | + * @since 1.0.19 |
|
| 716 | + * @param string $context View or edit context. |
|
| 717 | + * @return string |
|
| 718 | + */ |
|
| 719 | + public function get_excerpt( $context = 'view' ) { |
|
| 720 | + return $this->get_description( $context ); |
|
| 721 | 721 | } |
| 722 | 722 | |
| 723 | 723 | /** |
| 724 | - * Alias of self::get_description(). |
|
| 725 | - * |
|
| 726 | - * @since 1.0.19 |
|
| 727 | - * @param string $context View or edit context. |
|
| 728 | - * @return string |
|
| 729 | - */ |
|
| 730 | - public function get_summary( $context = 'view' ) { |
|
| 731 | - return $this->get_description( $context ); |
|
| 724 | + * Alias of self::get_description(). |
|
| 725 | + * |
|
| 726 | + * @since 1.0.19 |
|
| 727 | + * @param string $context View or edit context. |
|
| 728 | + * @return string |
|
| 729 | + */ |
|
| 730 | + public function get_summary( $context = 'view' ) { |
|
| 731 | + return $this->get_description( $context ); |
|
| 732 | 732 | } |
| 733 | 733 | |
| 734 | 734 | /** |
| 735 | - * Returns the user info. |
|
| 736 | - * |
|
| 737 | - * @since 1.0.19 |
|
| 735 | + * Returns the user info. |
|
| 736 | + * |
|
| 737 | + * @since 1.0.19 |
|
| 738 | 738 | * @param string $context View or edit context. |
| 739 | - * @return array |
|
| 740 | - */ |
|
| 739 | + * @return array |
|
| 740 | + */ |
|
| 741 | 741 | public function get_user_info( $context = 'view' ) { |
| 742 | 742 | |
| 743 | 743 | $user_info = array( |
@@ -752,683 +752,683 @@ discard block |
||
| 752 | 752 | 'state' => $this->get_state( $context ), |
| 753 | 753 | 'zip' => $this->get_zip( $context ), |
| 754 | 754 | 'company' => $this->get_company( $context ), |
| 755 | - 'company_id' => $this->get_company_id( $context ), |
|
| 755 | + 'company_id' => $this->get_company_id( $context ), |
|
| 756 | 756 | 'vat_number' => $this->get_vat_number( $context ), |
| 757 | 757 | 'discount' => $this->get_discount_code( $context ), |
| 758 | - ); |
|
| 758 | + ); |
|
| 759 | 759 | |
| 760 | - return apply_filters( 'wpinv_user_info', $user_info, $this->get_id(), $this ); |
|
| 760 | + return apply_filters( 'wpinv_user_info', $user_info, $this->get_id(), $this ); |
|
| 761 | 761 | |
| 762 | 762 | } |
| 763 | 763 | |
| 764 | 764 | /** |
| 765 | - * Get the user id. |
|
| 766 | - * |
|
| 767 | - * @since 1.0.19 |
|
| 768 | - * @param string $context View or edit context. |
|
| 769 | - * @return int |
|
| 770 | - */ |
|
| 771 | - public function get_author( $context = 'view' ) { |
|
| 772 | - return (int) $this->get_prop( 'author', $context ); |
|
| 765 | + * Get the user id. |
|
| 766 | + * |
|
| 767 | + * @since 1.0.19 |
|
| 768 | + * @param string $context View or edit context. |
|
| 769 | + * @return int |
|
| 770 | + */ |
|
| 771 | + public function get_author( $context = 'view' ) { |
|
| 772 | + return (int) $this->get_prop( 'author', $context ); |
|
| 773 | 773 | } |
| 774 | 774 | |
| 775 | 775 | /** |
| 776 | - * Alias of self::get_author(). |
|
| 777 | - * |
|
| 778 | - * @since 1.0.19 |
|
| 779 | - * @param string $context View or edit context. |
|
| 780 | - * @return int |
|
| 781 | - */ |
|
| 782 | - public function get_user_id( $context = 'view' ) { |
|
| 783 | - return $this->get_author( $context ); |
|
| 776 | + * Alias of self::get_author(). |
|
| 777 | + * |
|
| 778 | + * @since 1.0.19 |
|
| 779 | + * @param string $context View or edit context. |
|
| 780 | + * @return int |
|
| 781 | + */ |
|
| 782 | + public function get_user_id( $context = 'view' ) { |
|
| 783 | + return $this->get_author( $context ); |
|
| 784 | 784 | } |
| 785 | 785 | |
| 786 | - /** |
|
| 787 | - * Get customer ID. |
|
| 788 | - * |
|
| 789 | - * @since 1.0.19 |
|
| 790 | - * @param string $context View or edit context. |
|
| 791 | - * @return int |
|
| 792 | - */ |
|
| 793 | - public function get_customer_id( $context = 'view' ) { |
|
| 794 | - return (int) $this->get_prop( 'customer_id', $context ); |
|
| 786 | + /** |
|
| 787 | + * Get customer ID. |
|
| 788 | + * |
|
| 789 | + * @since 1.0.19 |
|
| 790 | + * @param string $context View or edit context. |
|
| 791 | + * @return int |
|
| 792 | + */ |
|
| 793 | + public function get_customer_id( $context = 'view' ) { |
|
| 794 | + return (int) $this->get_prop( 'customer_id', $context ); |
|
| 795 | 795 | } |
| 796 | 796 | |
| 797 | 797 | /** |
| 798 | - * Get the customer's ip. |
|
| 799 | - * |
|
| 800 | - * @since 1.0.19 |
|
| 801 | - * @param string $context View or edit context. |
|
| 802 | - * @return string |
|
| 803 | - */ |
|
| 804 | - public function get_ip( $context = 'view' ) { |
|
| 805 | - return $this->get_prop( 'user_ip', $context ); |
|
| 798 | + * Get the customer's ip. |
|
| 799 | + * |
|
| 800 | + * @since 1.0.19 |
|
| 801 | + * @param string $context View or edit context. |
|
| 802 | + * @return string |
|
| 803 | + */ |
|
| 804 | + public function get_ip( $context = 'view' ) { |
|
| 805 | + return $this->get_prop( 'user_ip', $context ); |
|
| 806 | 806 | } |
| 807 | 807 | |
| 808 | 808 | /** |
| 809 | - * Alias of self::get_ip(). |
|
| 810 | - * |
|
| 811 | - * @since 1.0.19 |
|
| 812 | - * @param string $context View or edit context. |
|
| 813 | - * @return string |
|
| 814 | - */ |
|
| 815 | - public function get_user_ip( $context = 'view' ) { |
|
| 816 | - return $this->get_ip( $context ); |
|
| 809 | + * Alias of self::get_ip(). |
|
| 810 | + * |
|
| 811 | + * @since 1.0.19 |
|
| 812 | + * @param string $context View or edit context. |
|
| 813 | + * @return string |
|
| 814 | + */ |
|
| 815 | + public function get_user_ip( $context = 'view' ) { |
|
| 816 | + return $this->get_ip( $context ); |
|
| 817 | 817 | } |
| 818 | 818 | |
| 819 | - /** |
|
| 820 | - * Alias of self::get_ip(). |
|
| 821 | - * |
|
| 822 | - * @since 1.0.19 |
|
| 823 | - * @param string $context View or edit context. |
|
| 824 | - * @return string |
|
| 825 | - */ |
|
| 826 | - public function get_customer_ip( $context = 'view' ) { |
|
| 827 | - return $this->get_ip( $context ); |
|
| 819 | + /** |
|
| 820 | + * Alias of self::get_ip(). |
|
| 821 | + * |
|
| 822 | + * @since 1.0.19 |
|
| 823 | + * @param string $context View or edit context. |
|
| 824 | + * @return string |
|
| 825 | + */ |
|
| 826 | + public function get_customer_ip( $context = 'view' ) { |
|
| 827 | + return $this->get_ip( $context ); |
|
| 828 | 828 | } |
| 829 | 829 | |
| 830 | 830 | /** |
| 831 | - * Get the customer's first name. |
|
| 832 | - * |
|
| 833 | - * @since 1.0.19 |
|
| 834 | - * @param string $context View or edit context. |
|
| 835 | - * @return string |
|
| 836 | - */ |
|
| 837 | - public function get_first_name( $context = 'view' ) { |
|
| 838 | - return $this->get_prop( 'first_name', $context ); |
|
| 831 | + * Get the customer's first name. |
|
| 832 | + * |
|
| 833 | + * @since 1.0.19 |
|
| 834 | + * @param string $context View or edit context. |
|
| 835 | + * @return string |
|
| 836 | + */ |
|
| 837 | + public function get_first_name( $context = 'view' ) { |
|
| 838 | + return $this->get_prop( 'first_name', $context ); |
|
| 839 | 839 | } |
| 840 | 840 | |
| 841 | 841 | /** |
| 842 | - * Alias of self::get_first_name(). |
|
| 843 | - * |
|
| 844 | - * @since 1.0.19 |
|
| 845 | - * @param string $context View or edit context. |
|
| 846 | - * @return string |
|
| 847 | - */ |
|
| 848 | - public function get_user_first_name( $context = 'view' ) { |
|
| 849 | - return $this->get_first_name( $context ); |
|
| 842 | + * Alias of self::get_first_name(). |
|
| 843 | + * |
|
| 844 | + * @since 1.0.19 |
|
| 845 | + * @param string $context View or edit context. |
|
| 846 | + * @return string |
|
| 847 | + */ |
|
| 848 | + public function get_user_first_name( $context = 'view' ) { |
|
| 849 | + return $this->get_first_name( $context ); |
|
| 850 | 850 | } |
| 851 | 851 | |
| 852 | - /** |
|
| 853 | - * Alias of self::get_first_name(). |
|
| 854 | - * |
|
| 855 | - * @since 1.0.19 |
|
| 856 | - * @param string $context View or edit context. |
|
| 857 | - * @return string |
|
| 858 | - */ |
|
| 859 | - public function get_customer_first_name( $context = 'view' ) { |
|
| 860 | - return $this->get_first_name( $context ); |
|
| 852 | + /** |
|
| 853 | + * Alias of self::get_first_name(). |
|
| 854 | + * |
|
| 855 | + * @since 1.0.19 |
|
| 856 | + * @param string $context View or edit context. |
|
| 857 | + * @return string |
|
| 858 | + */ |
|
| 859 | + public function get_customer_first_name( $context = 'view' ) { |
|
| 860 | + return $this->get_first_name( $context ); |
|
| 861 | 861 | } |
| 862 | 862 | |
| 863 | 863 | /** |
| 864 | - * Get the customer's last name. |
|
| 865 | - * |
|
| 866 | - * @since 1.0.19 |
|
| 867 | - * @param string $context View or edit context. |
|
| 868 | - * @return string |
|
| 869 | - */ |
|
| 870 | - public function get_last_name( $context = 'view' ) { |
|
| 871 | - return $this->get_prop( 'last_name', $context ); |
|
| 864 | + * Get the customer's last name. |
|
| 865 | + * |
|
| 866 | + * @since 1.0.19 |
|
| 867 | + * @param string $context View or edit context. |
|
| 868 | + * @return string |
|
| 869 | + */ |
|
| 870 | + public function get_last_name( $context = 'view' ) { |
|
| 871 | + return $this->get_prop( 'last_name', $context ); |
|
| 872 | 872 | } |
| 873 | 873 | |
| 874 | 874 | /** |
| 875 | - * Alias of self::get_last_name(). |
|
| 876 | - * |
|
| 877 | - * @since 1.0.19 |
|
| 878 | - * @param string $context View or edit context. |
|
| 879 | - * @return string |
|
| 880 | - */ |
|
| 881 | - public function get_user_last_name( $context = 'view' ) { |
|
| 882 | - return $this->get_last_name( $context ); |
|
| 875 | + * Alias of self::get_last_name(). |
|
| 876 | + * |
|
| 877 | + * @since 1.0.19 |
|
| 878 | + * @param string $context View or edit context. |
|
| 879 | + * @return string |
|
| 880 | + */ |
|
| 881 | + public function get_user_last_name( $context = 'view' ) { |
|
| 882 | + return $this->get_last_name( $context ); |
|
| 883 | 883 | } |
| 884 | 884 | |
| 885 | 885 | /** |
| 886 | - * Alias of self::get_last_name(). |
|
| 887 | - * |
|
| 888 | - * @since 1.0.19 |
|
| 889 | - * @param string $context View or edit context. |
|
| 890 | - * @return string |
|
| 891 | - */ |
|
| 892 | - public function get_customer_last_name( $context = 'view' ) { |
|
| 893 | - return $this->get_last_name( $context ); |
|
| 886 | + * Alias of self::get_last_name(). |
|
| 887 | + * |
|
| 888 | + * @since 1.0.19 |
|
| 889 | + * @param string $context View or edit context. |
|
| 890 | + * @return string |
|
| 891 | + */ |
|
| 892 | + public function get_customer_last_name( $context = 'view' ) { |
|
| 893 | + return $this->get_last_name( $context ); |
|
| 894 | 894 | } |
| 895 | 895 | |
| 896 | 896 | /** |
| 897 | - * Get the customer's full name. |
|
| 898 | - * |
|
| 899 | - * @since 1.0.19 |
|
| 900 | - * @param string $context View or edit context. |
|
| 901 | - * @return string |
|
| 902 | - */ |
|
| 903 | - public function get_full_name( $context = 'view' ) { |
|
| 904 | - $name = trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) ); |
|
| 897 | + * Get the customer's full name. |
|
| 898 | + * |
|
| 899 | + * @since 1.0.19 |
|
| 900 | + * @param string $context View or edit context. |
|
| 901 | + * @return string |
|
| 902 | + */ |
|
| 903 | + public function get_full_name( $context = 'view' ) { |
|
| 904 | + $name = trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) ); |
|
| 905 | 905 | |
| 906 | - if ( ! $name ) { |
|
| 907 | - $user = get_userdata( $this->get_author( $context ) ); |
|
| 906 | + if ( ! $name ) { |
|
| 907 | + $user = get_userdata( $this->get_author( $context ) ); |
|
| 908 | 908 | |
| 909 | - if ( $user ) { |
|
| 910 | - $name = $user->display_name; |
|
| 911 | - } |
|
| 912 | - } |
|
| 909 | + if ( $user ) { |
|
| 910 | + $name = $user->display_name; |
|
| 911 | + } |
|
| 912 | + } |
|
| 913 | 913 | |
| 914 | - if ( ! $name ) { |
|
| 915 | - $name = $this->get_email( $context ); |
|
| 916 | - } |
|
| 914 | + if ( ! $name ) { |
|
| 915 | + $name = $this->get_email( $context ); |
|
| 916 | + } |
|
| 917 | 917 | |
| 918 | - return apply_filters( 'wpinv_invoice_user_full_name', $name, $this ); |
|
| 918 | + return apply_filters( 'wpinv_invoice_user_full_name', $name, $this ); |
|
| 919 | 919 | } |
| 920 | 920 | |
| 921 | 921 | /** |
| 922 | - * Alias of self::get_full_name(). |
|
| 923 | - * |
|
| 924 | - * @since 1.0.19 |
|
| 925 | - * @param string $context View or edit context. |
|
| 926 | - * @return string |
|
| 927 | - */ |
|
| 928 | - public function get_user_full_name( $context = 'view' ) { |
|
| 929 | - return $this->get_full_name( $context ); |
|
| 922 | + * Alias of self::get_full_name(). |
|
| 923 | + * |
|
| 924 | + * @since 1.0.19 |
|
| 925 | + * @param string $context View or edit context. |
|
| 926 | + * @return string |
|
| 927 | + */ |
|
| 928 | + public function get_user_full_name( $context = 'view' ) { |
|
| 929 | + return $this->get_full_name( $context ); |
|
| 930 | 930 | } |
| 931 | 931 | |
| 932 | 932 | /** |
| 933 | - * Alias of self::get_full_name(). |
|
| 934 | - * |
|
| 935 | - * @since 1.0.19 |
|
| 936 | - * @param string $context View or edit context. |
|
| 937 | - * @return string |
|
| 938 | - */ |
|
| 939 | - public function get_customer_full_name( $context = 'view' ) { |
|
| 940 | - return $this->get_full_name( $context ); |
|
| 933 | + * Alias of self::get_full_name(). |
|
| 934 | + * |
|
| 935 | + * @since 1.0.19 |
|
| 936 | + * @param string $context View or edit context. |
|
| 937 | + * @return string |
|
| 938 | + */ |
|
| 939 | + public function get_customer_full_name( $context = 'view' ) { |
|
| 940 | + return $this->get_full_name( $context ); |
|
| 941 | 941 | } |
| 942 | 942 | |
| 943 | 943 | /** |
| 944 | - * Get the customer's phone number. |
|
| 945 | - * |
|
| 946 | - * @since 1.0.19 |
|
| 947 | - * @param string $context View or edit context. |
|
| 948 | - * @return string |
|
| 949 | - */ |
|
| 950 | - public function get_phone( $context = 'view' ) { |
|
| 951 | - return $this->get_prop( 'phone', $context ); |
|
| 944 | + * Get the customer's phone number. |
|
| 945 | + * |
|
| 946 | + * @since 1.0.19 |
|
| 947 | + * @param string $context View or edit context. |
|
| 948 | + * @return string |
|
| 949 | + */ |
|
| 950 | + public function get_phone( $context = 'view' ) { |
|
| 951 | + return $this->get_prop( 'phone', $context ); |
|
| 952 | 952 | } |
| 953 | 953 | |
| 954 | 954 | /** |
| 955 | - * Alias of self::get_phone(). |
|
| 956 | - * |
|
| 957 | - * @since 1.0.19 |
|
| 958 | - * @param string $context View or edit context. |
|
| 959 | - * @return string |
|
| 960 | - */ |
|
| 961 | - public function get_phone_number( $context = 'view' ) { |
|
| 962 | - return $this->get_phone( $context ); |
|
| 955 | + * Alias of self::get_phone(). |
|
| 956 | + * |
|
| 957 | + * @since 1.0.19 |
|
| 958 | + * @param string $context View or edit context. |
|
| 959 | + * @return string |
|
| 960 | + */ |
|
| 961 | + public function get_phone_number( $context = 'view' ) { |
|
| 962 | + return $this->get_phone( $context ); |
|
| 963 | 963 | } |
| 964 | 964 | |
| 965 | 965 | /** |
| 966 | - * Alias of self::get_phone(). |
|
| 967 | - * |
|
| 968 | - * @since 1.0.19 |
|
| 969 | - * @param string $context View or edit context. |
|
| 970 | - * @return string |
|
| 971 | - */ |
|
| 972 | - public function get_user_phone( $context = 'view' ) { |
|
| 973 | - return $this->get_phone( $context ); |
|
| 966 | + * Alias of self::get_phone(). |
|
| 967 | + * |
|
| 968 | + * @since 1.0.19 |
|
| 969 | + * @param string $context View or edit context. |
|
| 970 | + * @return string |
|
| 971 | + */ |
|
| 972 | + public function get_user_phone( $context = 'view' ) { |
|
| 973 | + return $this->get_phone( $context ); |
|
| 974 | 974 | } |
| 975 | 975 | |
| 976 | 976 | /** |
| 977 | - * Alias of self::get_phone(). |
|
| 978 | - * |
|
| 979 | - * @since 1.0.19 |
|
| 980 | - * @param string $context View or edit context. |
|
| 981 | - * @return string |
|
| 982 | - */ |
|
| 983 | - public function get_customer_phone( $context = 'view' ) { |
|
| 984 | - return $this->get_phone( $context ); |
|
| 977 | + * Alias of self::get_phone(). |
|
| 978 | + * |
|
| 979 | + * @since 1.0.19 |
|
| 980 | + * @param string $context View or edit context. |
|
| 981 | + * @return string |
|
| 982 | + */ |
|
| 983 | + public function get_customer_phone( $context = 'view' ) { |
|
| 984 | + return $this->get_phone( $context ); |
|
| 985 | 985 | } |
| 986 | 986 | |
| 987 | 987 | /** |
| 988 | - * Get the customer's email address. |
|
| 989 | - * |
|
| 990 | - * @since 1.0.19 |
|
| 991 | - * @param string $context View or edit context. |
|
| 992 | - * @return string |
|
| 993 | - */ |
|
| 994 | - public function get_email( $context = 'view' ) { |
|
| 995 | - return $this->get_prop( 'email', $context ); |
|
| 988 | + * Get the customer's email address. |
|
| 989 | + * |
|
| 990 | + * @since 1.0.19 |
|
| 991 | + * @param string $context View or edit context. |
|
| 992 | + * @return string |
|
| 993 | + */ |
|
| 994 | + public function get_email( $context = 'view' ) { |
|
| 995 | + return $this->get_prop( 'email', $context ); |
|
| 996 | 996 | } |
| 997 | 997 | |
| 998 | 998 | /** |
| 999 | - * Alias of self::get_email(). |
|
| 1000 | - * |
|
| 1001 | - * @since 1.0.19 |
|
| 1002 | - * @param string $context View or edit context. |
|
| 1003 | - * @return string |
|
| 1004 | - */ |
|
| 1005 | - public function get_email_address( $context = 'view' ) { |
|
| 1006 | - return $this->get_email( $context ); |
|
| 999 | + * Alias of self::get_email(). |
|
| 1000 | + * |
|
| 1001 | + * @since 1.0.19 |
|
| 1002 | + * @param string $context View or edit context. |
|
| 1003 | + * @return string |
|
| 1004 | + */ |
|
| 1005 | + public function get_email_address( $context = 'view' ) { |
|
| 1006 | + return $this->get_email( $context ); |
|
| 1007 | 1007 | } |
| 1008 | 1008 | |
| 1009 | 1009 | /** |
| 1010 | - * Alias of self::get_email(). |
|
| 1011 | - * |
|
| 1012 | - * @since 1.0.19 |
|
| 1013 | - * @param string $context View or edit context. |
|
| 1014 | - * @return string |
|
| 1015 | - */ |
|
| 1016 | - public function get_user_email( $context = 'view' ) { |
|
| 1017 | - return $this->get_email( $context ); |
|
| 1010 | + * Alias of self::get_email(). |
|
| 1011 | + * |
|
| 1012 | + * @since 1.0.19 |
|
| 1013 | + * @param string $context View or edit context. |
|
| 1014 | + * @return string |
|
| 1015 | + */ |
|
| 1016 | + public function get_user_email( $context = 'view' ) { |
|
| 1017 | + return $this->get_email( $context ); |
|
| 1018 | 1018 | } |
| 1019 | 1019 | |
| 1020 | 1020 | /** |
| 1021 | - * Alias of self::get_email(). |
|
| 1022 | - * |
|
| 1023 | - * @since 1.0.19 |
|
| 1024 | - * @param string $context View or edit context. |
|
| 1025 | - * @return string |
|
| 1026 | - */ |
|
| 1027 | - public function get_customer_email( $context = 'view' ) { |
|
| 1028 | - return $this->get_email( $context ); |
|
| 1021 | + * Alias of self::get_email(). |
|
| 1022 | + * |
|
| 1023 | + * @since 1.0.19 |
|
| 1024 | + * @param string $context View or edit context. |
|
| 1025 | + * @return string |
|
| 1026 | + */ |
|
| 1027 | + public function get_customer_email( $context = 'view' ) { |
|
| 1028 | + return $this->get_email( $context ); |
|
| 1029 | 1029 | } |
| 1030 | 1030 | |
| 1031 | 1031 | /** |
| 1032 | - * Get the customer's country. |
|
| 1033 | - * |
|
| 1034 | - * @since 1.0.19 |
|
| 1035 | - * @param string $context View or edit context. |
|
| 1036 | - * @return string |
|
| 1037 | - */ |
|
| 1038 | - public function get_country( $context = 'view' ) { |
|
| 1039 | - $country = $this->get_prop( 'country', $context ); |
|
| 1040 | - return empty( $country ) ? wpinv_get_default_country() : $country; |
|
| 1032 | + * Get the customer's country. |
|
| 1033 | + * |
|
| 1034 | + * @since 1.0.19 |
|
| 1035 | + * @param string $context View or edit context. |
|
| 1036 | + * @return string |
|
| 1037 | + */ |
|
| 1038 | + public function get_country( $context = 'view' ) { |
|
| 1039 | + $country = $this->get_prop( 'country', $context ); |
|
| 1040 | + return empty( $country ) ? wpinv_get_default_country() : $country; |
|
| 1041 | 1041 | } |
| 1042 | 1042 | |
| 1043 | 1043 | /** |
| 1044 | - * Alias of self::get_country(). |
|
| 1045 | - * |
|
| 1046 | - * @since 1.0.19 |
|
| 1047 | - * @param string $context View or edit context. |
|
| 1048 | - * @return string |
|
| 1049 | - */ |
|
| 1050 | - public function get_user_country( $context = 'view' ) { |
|
| 1051 | - return $this->get_country( $context ); |
|
| 1044 | + * Alias of self::get_country(). |
|
| 1045 | + * |
|
| 1046 | + * @since 1.0.19 |
|
| 1047 | + * @param string $context View or edit context. |
|
| 1048 | + * @return string |
|
| 1049 | + */ |
|
| 1050 | + public function get_user_country( $context = 'view' ) { |
|
| 1051 | + return $this->get_country( $context ); |
|
| 1052 | 1052 | } |
| 1053 | 1053 | |
| 1054 | 1054 | /** |
| 1055 | - * Alias of self::get_country(). |
|
| 1056 | - * |
|
| 1057 | - * @since 1.0.19 |
|
| 1058 | - * @param string $context View or edit context. |
|
| 1059 | - * @return string |
|
| 1060 | - */ |
|
| 1061 | - public function get_customer_country( $context = 'view' ) { |
|
| 1062 | - return $this->get_country( $context ); |
|
| 1055 | + * Alias of self::get_country(). |
|
| 1056 | + * |
|
| 1057 | + * @since 1.0.19 |
|
| 1058 | + * @param string $context View or edit context. |
|
| 1059 | + * @return string |
|
| 1060 | + */ |
|
| 1061 | + public function get_customer_country( $context = 'view' ) { |
|
| 1062 | + return $this->get_country( $context ); |
|
| 1063 | 1063 | } |
| 1064 | 1064 | |
| 1065 | 1065 | /** |
| 1066 | - * Get the customer's state. |
|
| 1067 | - * |
|
| 1068 | - * @since 1.0.19 |
|
| 1069 | - * @param string $context View or edit context. |
|
| 1070 | - * @return string |
|
| 1071 | - */ |
|
| 1072 | - public function get_state( $context = 'view' ) { |
|
| 1073 | - $state = $this->get_prop( 'state', $context ); |
|
| 1074 | - return empty( $state ) ? wpinv_get_default_state() : $state; |
|
| 1066 | + * Get the customer's state. |
|
| 1067 | + * |
|
| 1068 | + * @since 1.0.19 |
|
| 1069 | + * @param string $context View or edit context. |
|
| 1070 | + * @return string |
|
| 1071 | + */ |
|
| 1072 | + public function get_state( $context = 'view' ) { |
|
| 1073 | + $state = $this->get_prop( 'state', $context ); |
|
| 1074 | + return empty( $state ) ? wpinv_get_default_state() : $state; |
|
| 1075 | 1075 | } |
| 1076 | 1076 | |
| 1077 | 1077 | /** |
| 1078 | - * Alias of self::get_state(). |
|
| 1079 | - * |
|
| 1080 | - * @since 1.0.19 |
|
| 1081 | - * @param string $context View or edit context. |
|
| 1082 | - * @return string |
|
| 1083 | - */ |
|
| 1084 | - public function get_user_state( $context = 'view' ) { |
|
| 1085 | - return $this->get_state( $context ); |
|
| 1078 | + * Alias of self::get_state(). |
|
| 1079 | + * |
|
| 1080 | + * @since 1.0.19 |
|
| 1081 | + * @param string $context View or edit context. |
|
| 1082 | + * @return string |
|
| 1083 | + */ |
|
| 1084 | + public function get_user_state( $context = 'view' ) { |
|
| 1085 | + return $this->get_state( $context ); |
|
| 1086 | 1086 | } |
| 1087 | 1087 | |
| 1088 | 1088 | /** |
| 1089 | - * Alias of self::get_state(). |
|
| 1090 | - * |
|
| 1091 | - * @since 1.0.19 |
|
| 1092 | - * @param string $context View or edit context. |
|
| 1093 | - * @return string |
|
| 1094 | - */ |
|
| 1095 | - public function get_customer_state( $context = 'view' ) { |
|
| 1096 | - return $this->get_state( $context ); |
|
| 1089 | + * Alias of self::get_state(). |
|
| 1090 | + * |
|
| 1091 | + * @since 1.0.19 |
|
| 1092 | + * @param string $context View or edit context. |
|
| 1093 | + * @return string |
|
| 1094 | + */ |
|
| 1095 | + public function get_customer_state( $context = 'view' ) { |
|
| 1096 | + return $this->get_state( $context ); |
|
| 1097 | 1097 | } |
| 1098 | 1098 | |
| 1099 | 1099 | /** |
| 1100 | - * Get the customer's city. |
|
| 1101 | - * |
|
| 1102 | - * @since 1.0.19 |
|
| 1103 | - * @param string $context View or edit context. |
|
| 1104 | - * @return string |
|
| 1105 | - */ |
|
| 1106 | - public function get_city( $context = 'view' ) { |
|
| 1107 | - return $this->get_prop( 'city', $context ); |
|
| 1100 | + * Get the customer's city. |
|
| 1101 | + * |
|
| 1102 | + * @since 1.0.19 |
|
| 1103 | + * @param string $context View or edit context. |
|
| 1104 | + * @return string |
|
| 1105 | + */ |
|
| 1106 | + public function get_city( $context = 'view' ) { |
|
| 1107 | + return $this->get_prop( 'city', $context ); |
|
| 1108 | 1108 | } |
| 1109 | 1109 | |
| 1110 | 1110 | /** |
| 1111 | - * Alias of self::get_city(). |
|
| 1112 | - * |
|
| 1113 | - * @since 1.0.19 |
|
| 1114 | - * @param string $context View or edit context. |
|
| 1115 | - * @return string |
|
| 1116 | - */ |
|
| 1117 | - public function get_user_city( $context = 'view' ) { |
|
| 1118 | - return $this->get_city( $context ); |
|
| 1111 | + * Alias of self::get_city(). |
|
| 1112 | + * |
|
| 1113 | + * @since 1.0.19 |
|
| 1114 | + * @param string $context View or edit context. |
|
| 1115 | + * @return string |
|
| 1116 | + */ |
|
| 1117 | + public function get_user_city( $context = 'view' ) { |
|
| 1118 | + return $this->get_city( $context ); |
|
| 1119 | 1119 | } |
| 1120 | 1120 | |
| 1121 | 1121 | /** |
| 1122 | - * Alias of self::get_city(). |
|
| 1123 | - * |
|
| 1124 | - * @since 1.0.19 |
|
| 1125 | - * @param string $context View or edit context. |
|
| 1126 | - * @return string |
|
| 1127 | - */ |
|
| 1128 | - public function get_customer_city( $context = 'view' ) { |
|
| 1129 | - return $this->get_city( $context ); |
|
| 1122 | + * Alias of self::get_city(). |
|
| 1123 | + * |
|
| 1124 | + * @since 1.0.19 |
|
| 1125 | + * @param string $context View or edit context. |
|
| 1126 | + * @return string |
|
| 1127 | + */ |
|
| 1128 | + public function get_customer_city( $context = 'view' ) { |
|
| 1129 | + return $this->get_city( $context ); |
|
| 1130 | 1130 | } |
| 1131 | 1131 | |
| 1132 | 1132 | /** |
| 1133 | - * Get the customer's zip. |
|
| 1134 | - * |
|
| 1135 | - * @since 1.0.19 |
|
| 1136 | - * @param string $context View or edit context. |
|
| 1137 | - * @return string |
|
| 1138 | - */ |
|
| 1139 | - public function get_zip( $context = 'view' ) { |
|
| 1140 | - return $this->get_prop( 'zip', $context ); |
|
| 1133 | + * Get the customer's zip. |
|
| 1134 | + * |
|
| 1135 | + * @since 1.0.19 |
|
| 1136 | + * @param string $context View or edit context. |
|
| 1137 | + * @return string |
|
| 1138 | + */ |
|
| 1139 | + public function get_zip( $context = 'view' ) { |
|
| 1140 | + return $this->get_prop( 'zip', $context ); |
|
| 1141 | 1141 | } |
| 1142 | 1142 | |
| 1143 | 1143 | /** |
| 1144 | - * Alias of self::get_zip(). |
|
| 1145 | - * |
|
| 1146 | - * @since 1.0.19 |
|
| 1147 | - * @param string $context View or edit context. |
|
| 1148 | - * @return string |
|
| 1149 | - */ |
|
| 1150 | - public function get_user_zip( $context = 'view' ) { |
|
| 1151 | - return $this->get_zip( $context ); |
|
| 1144 | + * Alias of self::get_zip(). |
|
| 1145 | + * |
|
| 1146 | + * @since 1.0.19 |
|
| 1147 | + * @param string $context View or edit context. |
|
| 1148 | + * @return string |
|
| 1149 | + */ |
|
| 1150 | + public function get_user_zip( $context = 'view' ) { |
|
| 1151 | + return $this->get_zip( $context ); |
|
| 1152 | 1152 | } |
| 1153 | 1153 | |
| 1154 | 1154 | /** |
| 1155 | - * Alias of self::get_zip(). |
|
| 1156 | - * |
|
| 1157 | - * @since 1.0.19 |
|
| 1158 | - * @param string $context View or edit context. |
|
| 1159 | - * @return string |
|
| 1160 | - */ |
|
| 1161 | - public function get_customer_zip( $context = 'view' ) { |
|
| 1162 | - return $this->get_zip( $context ); |
|
| 1155 | + * Alias of self::get_zip(). |
|
| 1156 | + * |
|
| 1157 | + * @since 1.0.19 |
|
| 1158 | + * @param string $context View or edit context. |
|
| 1159 | + * @return string |
|
| 1160 | + */ |
|
| 1161 | + public function get_customer_zip( $context = 'view' ) { |
|
| 1162 | + return $this->get_zip( $context ); |
|
| 1163 | 1163 | } |
| 1164 | 1164 | |
| 1165 | 1165 | /** |
| 1166 | - * Get the customer's company. |
|
| 1167 | - * |
|
| 1168 | - * @since 1.0.19 |
|
| 1169 | - * @param string $context View or edit context. |
|
| 1170 | - * @return string |
|
| 1171 | - */ |
|
| 1172 | - public function get_company( $context = 'view' ) { |
|
| 1173 | - return $this->get_prop( 'company', $context ); |
|
| 1166 | + * Get the customer's company. |
|
| 1167 | + * |
|
| 1168 | + * @since 1.0.19 |
|
| 1169 | + * @param string $context View or edit context. |
|
| 1170 | + * @return string |
|
| 1171 | + */ |
|
| 1172 | + public function get_company( $context = 'view' ) { |
|
| 1173 | + return $this->get_prop( 'company', $context ); |
|
| 1174 | 1174 | } |
| 1175 | 1175 | |
| 1176 | 1176 | /** |
| 1177 | - * Alias of self::get_company(). |
|
| 1178 | - * |
|
| 1179 | - * @since 1.0.19 |
|
| 1180 | - * @param string $context View or edit context. |
|
| 1181 | - * @return string |
|
| 1182 | - */ |
|
| 1183 | - public function get_user_company( $context = 'view' ) { |
|
| 1184 | - return $this->get_company( $context ); |
|
| 1177 | + * Alias of self::get_company(). |
|
| 1178 | + * |
|
| 1179 | + * @since 1.0.19 |
|
| 1180 | + * @param string $context View or edit context. |
|
| 1181 | + * @return string |
|
| 1182 | + */ |
|
| 1183 | + public function get_user_company( $context = 'view' ) { |
|
| 1184 | + return $this->get_company( $context ); |
|
| 1185 | + } |
|
| 1186 | + |
|
| 1187 | + /** |
|
| 1188 | + * Alias of self::get_company(). |
|
| 1189 | + * |
|
| 1190 | + * @since 1.0.19 |
|
| 1191 | + * @param string $context View or edit context. |
|
| 1192 | + * @return string |
|
| 1193 | + */ |
|
| 1194 | + public function get_customer_company( $context = 'view' ) { |
|
| 1195 | + return $this->get_company( $context ); |
|
| 1185 | 1196 | } |
| 1186 | 1197 | |
| 1187 | 1198 | /** |
| 1188 | - * Alias of self::get_company(). |
|
| 1189 | - * |
|
| 1190 | - * @since 1.0.19 |
|
| 1191 | - * @param string $context View or edit context. |
|
| 1192 | - * @return string |
|
| 1193 | - */ |
|
| 1194 | - public function get_customer_company( $context = 'view' ) { |
|
| 1195 | - return $this->get_company( $context ); |
|
| 1199 | + * Get the customer's company id. |
|
| 1200 | + * |
|
| 1201 | + * @since 1.0.19 |
|
| 1202 | + * @param string $context View or edit context. |
|
| 1203 | + * @return string |
|
| 1204 | + */ |
|
| 1205 | + public function get_company_id( $context = 'view' ) { |
|
| 1206 | + return $this->get_prop( 'company_id', $context ); |
|
| 1207 | + } |
|
| 1208 | + |
|
| 1209 | + /** |
|
| 1210 | + * Get the customer's vat number. |
|
| 1211 | + * |
|
| 1212 | + * @since 1.0.19 |
|
| 1213 | + * @param string $context View or edit context. |
|
| 1214 | + * @return string |
|
| 1215 | + */ |
|
| 1216 | + public function get_vat_number( $context = 'view' ) { |
|
| 1217 | + return $this->get_prop( 'vat_number', $context ); |
|
| 1196 | 1218 | } |
| 1197 | 1219 | |
| 1198 | - /** |
|
| 1199 | - * Get the customer's company id. |
|
| 1200 | - * |
|
| 1201 | - * @since 1.0.19 |
|
| 1202 | - * @param string $context View or edit context. |
|
| 1203 | - * @return string |
|
| 1204 | - */ |
|
| 1205 | - public function get_company_id( $context = 'view' ) { |
|
| 1206 | - return $this->get_prop( 'company_id', $context ); |
|
| 1220 | + /** |
|
| 1221 | + * Alias of self::get_vat_number(). |
|
| 1222 | + * |
|
| 1223 | + * @since 1.0.19 |
|
| 1224 | + * @param string $context View or edit context. |
|
| 1225 | + * @return string |
|
| 1226 | + */ |
|
| 1227 | + public function get_user_vat_number( $context = 'view' ) { |
|
| 1228 | + return $this->get_vat_number( $context ); |
|
| 1207 | 1229 | } |
| 1208 | 1230 | |
| 1209 | 1231 | /** |
| 1210 | - * Get the customer's vat number. |
|
| 1211 | - * |
|
| 1212 | - * @since 1.0.19 |
|
| 1213 | - * @param string $context View or edit context. |
|
| 1214 | - * @return string |
|
| 1215 | - */ |
|
| 1216 | - public function get_vat_number( $context = 'view' ) { |
|
| 1217 | - return $this->get_prop( 'vat_number', $context ); |
|
| 1232 | + * Alias of self::get_vat_number(). |
|
| 1233 | + * |
|
| 1234 | + * @since 1.0.19 |
|
| 1235 | + * @param string $context View or edit context. |
|
| 1236 | + * @return string |
|
| 1237 | + */ |
|
| 1238 | + public function get_customer_vat_number( $context = 'view' ) { |
|
| 1239 | + return $this->get_vat_number( $context ); |
|
| 1218 | 1240 | } |
| 1219 | 1241 | |
| 1220 | 1242 | /** |
| 1221 | - * Alias of self::get_vat_number(). |
|
| 1222 | - * |
|
| 1223 | - * @since 1.0.19 |
|
| 1224 | - * @param string $context View or edit context. |
|
| 1225 | - * @return string |
|
| 1226 | - */ |
|
| 1227 | - public function get_user_vat_number( $context = 'view' ) { |
|
| 1228 | - return $this->get_vat_number( $context ); |
|
| 1243 | + * Get the customer's vat rate. |
|
| 1244 | + * |
|
| 1245 | + * @since 1.0.19 |
|
| 1246 | + * @param string $context View or edit context. |
|
| 1247 | + * @return string |
|
| 1248 | + */ |
|
| 1249 | + public function get_vat_rate( $context = 'view' ) { |
|
| 1250 | + return $this->get_prop( 'vat_rate', $context ); |
|
| 1229 | 1251 | } |
| 1230 | 1252 | |
| 1231 | 1253 | /** |
| 1232 | - * Alias of self::get_vat_number(). |
|
| 1233 | - * |
|
| 1234 | - * @since 1.0.19 |
|
| 1235 | - * @param string $context View or edit context. |
|
| 1236 | - * @return string |
|
| 1237 | - */ |
|
| 1238 | - public function get_customer_vat_number( $context = 'view' ) { |
|
| 1239 | - return $this->get_vat_number( $context ); |
|
| 1254 | + * Alias of self::get_vat_rate(). |
|
| 1255 | + * |
|
| 1256 | + * @since 1.0.19 |
|
| 1257 | + * @param string $context View or edit context. |
|
| 1258 | + * @return string |
|
| 1259 | + */ |
|
| 1260 | + public function get_user_vat_rate( $context = 'view' ) { |
|
| 1261 | + return $this->get_vat_rate( $context ); |
|
| 1240 | 1262 | } |
| 1241 | 1263 | |
| 1242 | - /** |
|
| 1243 | - * Get the customer's vat rate. |
|
| 1244 | - * |
|
| 1245 | - * @since 1.0.19 |
|
| 1246 | - * @param string $context View or edit context. |
|
| 1247 | - * @return string |
|
| 1248 | - */ |
|
| 1249 | - public function get_vat_rate( $context = 'view' ) { |
|
| 1250 | - return $this->get_prop( 'vat_rate', $context ); |
|
| 1251 | - } |
|
| 1252 | - |
|
| 1253 | - /** |
|
| 1254 | - * Alias of self::get_vat_rate(). |
|
| 1255 | - * |
|
| 1256 | - * @since 1.0.19 |
|
| 1257 | - * @param string $context View or edit context. |
|
| 1258 | - * @return string |
|
| 1259 | - */ |
|
| 1260 | - public function get_user_vat_rate( $context = 'view' ) { |
|
| 1261 | - return $this->get_vat_rate( $context ); |
|
| 1262 | - } |
|
| 1263 | - |
|
| 1264 | - /** |
|
| 1265 | - * Alias of self::get_vat_rate(). |
|
| 1266 | - * |
|
| 1267 | - * @since 1.0.19 |
|
| 1268 | - * @param string $context View or edit context. |
|
| 1269 | - * @return string |
|
| 1270 | - */ |
|
| 1271 | - public function get_customer_vat_rate( $context = 'view' ) { |
|
| 1272 | - return $this->get_vat_rate( $context ); |
|
| 1273 | - } |
|
| 1274 | - |
|
| 1275 | - /** |
|
| 1276 | - * Get the customer's address. |
|
| 1277 | - * |
|
| 1278 | - * @since 1.0.19 |
|
| 1279 | - * @param string $context View or edit context. |
|
| 1280 | - * @return string |
|
| 1281 | - */ |
|
| 1282 | - public function get_address( $context = 'view' ) { |
|
| 1283 | - return $this->get_prop( 'address', $context ); |
|
| 1284 | - } |
|
| 1285 | - |
|
| 1286 | - /** |
|
| 1287 | - * Alias of self::get_address(). |
|
| 1288 | - * |
|
| 1289 | - * @since 1.0.19 |
|
| 1290 | - * @param string $context View or edit context. |
|
| 1291 | - * @return string |
|
| 1292 | - */ |
|
| 1293 | - public function get_user_address( $context = 'view' ) { |
|
| 1294 | - return $this->get_address( $context ); |
|
| 1295 | - } |
|
| 1296 | - |
|
| 1297 | - /** |
|
| 1298 | - * Alias of self::get_address(). |
|
| 1299 | - * |
|
| 1300 | - * @since 1.0.19 |
|
| 1301 | - * @param string $context View or edit context. |
|
| 1302 | - * @return string |
|
| 1303 | - */ |
|
| 1304 | - public function get_customer_address( $context = 'view' ) { |
|
| 1305 | - return $this->get_address( $context ); |
|
| 1306 | - } |
|
| 1307 | - |
|
| 1308 | - /** |
|
| 1309 | - * Get whether the customer has viewed the invoice or not. |
|
| 1310 | - * |
|
| 1311 | - * @since 1.0.19 |
|
| 1312 | - * @param string $context View or edit context. |
|
| 1313 | - * @return bool |
|
| 1314 | - */ |
|
| 1315 | - public function get_is_viewed( $context = 'view' ) { |
|
| 1316 | - return (bool) $this->get_prop( 'is_viewed', $context ); |
|
| 1317 | - } |
|
| 1318 | - |
|
| 1319 | - /** |
|
| 1320 | - * Get other recipients for invoice communications. |
|
| 1321 | - * |
|
| 1322 | - * @since 1.0.19 |
|
| 1323 | - * @param string $context View or edit context. |
|
| 1324 | - * @return bool |
|
| 1325 | - */ |
|
| 1326 | - public function get_email_cc( $context = 'view' ) { |
|
| 1327 | - return $this->get_prop( 'email_cc', $context ); |
|
| 1328 | - } |
|
| 1329 | - |
|
| 1330 | - /** |
|
| 1331 | - * Get invoice template. |
|
| 1332 | - * |
|
| 1333 | - * @since 1.0.19 |
|
| 1334 | - * @param string $context View or edit context. |
|
| 1335 | - * @return bool |
|
| 1336 | - */ |
|
| 1337 | - public function get_template( $context = 'view' ) { |
|
| 1338 | - return $this->get_prop( 'template', $context ); |
|
| 1339 | - } |
|
| 1340 | - |
|
| 1341 | - /** |
|
| 1342 | - * Get invoice source. |
|
| 1343 | - * |
|
| 1344 | - * @since 1.0.19 |
|
| 1345 | - * @param string $context View or edit context. |
|
| 1346 | - * @return bool |
|
| 1347 | - */ |
|
| 1348 | - public function get_created_via( $context = 'view' ) { |
|
| 1349 | - return $this->get_prop( 'created_via', $context ); |
|
| 1350 | - } |
|
| 1351 | - |
|
| 1352 | - /** |
|
| 1353 | - * Get whether the customer has confirmed their address. |
|
| 1354 | - * |
|
| 1355 | - * @since 1.0.19 |
|
| 1356 | - * @param string $context View or edit context. |
|
| 1357 | - * @return bool |
|
| 1358 | - */ |
|
| 1359 | - public function get_address_confirmed( $context = 'view' ) { |
|
| 1360 | - return (bool) $this->get_prop( 'address_confirmed', $context ); |
|
| 1361 | - } |
|
| 1362 | - |
|
| 1363 | - /** |
|
| 1364 | - * Alias of self::get_address_confirmed(). |
|
| 1365 | - * |
|
| 1366 | - * @since 1.0.19 |
|
| 1367 | - * @param string $context View or edit context. |
|
| 1368 | - * @return bool |
|
| 1369 | - */ |
|
| 1370 | - public function get_user_address_confirmed( $context = 'view' ) { |
|
| 1371 | - return $this->get_address_confirmed( $context ); |
|
| 1372 | - } |
|
| 1373 | - |
|
| 1374 | - /** |
|
| 1375 | - * Alias of self::get_address(). |
|
| 1376 | - * |
|
| 1377 | - * @since 1.0.19 |
|
| 1378 | - * @param string $context View or edit context. |
|
| 1379 | - * @return bool |
|
| 1380 | - */ |
|
| 1381 | - public function get_customer_address_confirmed( $context = 'view' ) { |
|
| 1382 | - return $this->get_address_confirmed( $context ); |
|
| 1383 | - } |
|
| 1384 | - |
|
| 1385 | - /** |
|
| 1386 | - * Get the shipping address. |
|
| 1387 | - * |
|
| 1388 | - * @since 1.0.19 |
|
| 1389 | - * @return array|false |
|
| 1390 | - */ |
|
| 1391 | - public function get_shipping_address() { |
|
| 1392 | - |
|
| 1393 | - $shipping_address = get_post_meta( $this->get_id(), 'shipping_address', true ); |
|
| 1394 | - return is_array( $shipping_address ) ? $shipping_address : false; |
|
| 1395 | - } |
|
| 1396 | - |
|
| 1397 | - /** |
|
| 1398 | - * Check if the invoice has a shipping address. |
|
| 1399 | - */ |
|
| 1400 | - public function has_shipping_address() { |
|
| 1401 | - return false !== $this->get_shipping_address(); |
|
| 1402 | - } |
|
| 1403 | - |
|
| 1404 | - /** |
|
| 1405 | - * Get the shipping amount. |
|
| 1406 | - * |
|
| 1407 | - * @since 1.0.19 |
|
| 1408 | - * @param string $context View or edit context. |
|
| 1409 | - * @return float |
|
| 1410 | - */ |
|
| 1411 | - public function get_shipping( $context = 'view' ) { |
|
| 1412 | - |
|
| 1413 | - if ( $context = 'view' ) { |
|
| 1414 | - return floatval( $this->get_prop( 'shipping', $context ) ); |
|
| 1415 | - } |
|
| 1416 | - |
|
| 1417 | - return $this->get_prop( 'shipping', $context ); |
|
| 1418 | - } |
|
| 1419 | - |
|
| 1420 | - public function has_shipping() { |
|
| 1421 | - return defined( 'GETPAID_SHIPPING_CALCULATOR_VERSION' ) && null !== $this->get_prop( 'shipping', 'edit' ); |
|
| 1422 | - } |
|
| 1423 | - |
|
| 1424 | - /** |
|
| 1425 | - * Get the invoice subtotal. |
|
| 1426 | - * |
|
| 1427 | - * @since 1.0.19 |
|
| 1428 | - * @param string $context View or edit context. |
|
| 1429 | - * @return float |
|
| 1430 | - */ |
|
| 1431 | - public function get_subtotal( $context = 'view' ) { |
|
| 1264 | + /** |
|
| 1265 | + * Alias of self::get_vat_rate(). |
|
| 1266 | + * |
|
| 1267 | + * @since 1.0.19 |
|
| 1268 | + * @param string $context View or edit context. |
|
| 1269 | + * @return string |
|
| 1270 | + */ |
|
| 1271 | + public function get_customer_vat_rate( $context = 'view' ) { |
|
| 1272 | + return $this->get_vat_rate( $context ); |
|
| 1273 | + } |
|
| 1274 | + |
|
| 1275 | + /** |
|
| 1276 | + * Get the customer's address. |
|
| 1277 | + * |
|
| 1278 | + * @since 1.0.19 |
|
| 1279 | + * @param string $context View or edit context. |
|
| 1280 | + * @return string |
|
| 1281 | + */ |
|
| 1282 | + public function get_address( $context = 'view' ) { |
|
| 1283 | + return $this->get_prop( 'address', $context ); |
|
| 1284 | + } |
|
| 1285 | + |
|
| 1286 | + /** |
|
| 1287 | + * Alias of self::get_address(). |
|
| 1288 | + * |
|
| 1289 | + * @since 1.0.19 |
|
| 1290 | + * @param string $context View or edit context. |
|
| 1291 | + * @return string |
|
| 1292 | + */ |
|
| 1293 | + public function get_user_address( $context = 'view' ) { |
|
| 1294 | + return $this->get_address( $context ); |
|
| 1295 | + } |
|
| 1296 | + |
|
| 1297 | + /** |
|
| 1298 | + * Alias of self::get_address(). |
|
| 1299 | + * |
|
| 1300 | + * @since 1.0.19 |
|
| 1301 | + * @param string $context View or edit context. |
|
| 1302 | + * @return string |
|
| 1303 | + */ |
|
| 1304 | + public function get_customer_address( $context = 'view' ) { |
|
| 1305 | + return $this->get_address( $context ); |
|
| 1306 | + } |
|
| 1307 | + |
|
| 1308 | + /** |
|
| 1309 | + * Get whether the customer has viewed the invoice or not. |
|
| 1310 | + * |
|
| 1311 | + * @since 1.0.19 |
|
| 1312 | + * @param string $context View or edit context. |
|
| 1313 | + * @return bool |
|
| 1314 | + */ |
|
| 1315 | + public function get_is_viewed( $context = 'view' ) { |
|
| 1316 | + return (bool) $this->get_prop( 'is_viewed', $context ); |
|
| 1317 | + } |
|
| 1318 | + |
|
| 1319 | + /** |
|
| 1320 | + * Get other recipients for invoice communications. |
|
| 1321 | + * |
|
| 1322 | + * @since 1.0.19 |
|
| 1323 | + * @param string $context View or edit context. |
|
| 1324 | + * @return bool |
|
| 1325 | + */ |
|
| 1326 | + public function get_email_cc( $context = 'view' ) { |
|
| 1327 | + return $this->get_prop( 'email_cc', $context ); |
|
| 1328 | + } |
|
| 1329 | + |
|
| 1330 | + /** |
|
| 1331 | + * Get invoice template. |
|
| 1332 | + * |
|
| 1333 | + * @since 1.0.19 |
|
| 1334 | + * @param string $context View or edit context. |
|
| 1335 | + * @return bool |
|
| 1336 | + */ |
|
| 1337 | + public function get_template( $context = 'view' ) { |
|
| 1338 | + return $this->get_prop( 'template', $context ); |
|
| 1339 | + } |
|
| 1340 | + |
|
| 1341 | + /** |
|
| 1342 | + * Get invoice source. |
|
| 1343 | + * |
|
| 1344 | + * @since 1.0.19 |
|
| 1345 | + * @param string $context View or edit context. |
|
| 1346 | + * @return bool |
|
| 1347 | + */ |
|
| 1348 | + public function get_created_via( $context = 'view' ) { |
|
| 1349 | + return $this->get_prop( 'created_via', $context ); |
|
| 1350 | + } |
|
| 1351 | + |
|
| 1352 | + /** |
|
| 1353 | + * Get whether the customer has confirmed their address. |
|
| 1354 | + * |
|
| 1355 | + * @since 1.0.19 |
|
| 1356 | + * @param string $context View or edit context. |
|
| 1357 | + * @return bool |
|
| 1358 | + */ |
|
| 1359 | + public function get_address_confirmed( $context = 'view' ) { |
|
| 1360 | + return (bool) $this->get_prop( 'address_confirmed', $context ); |
|
| 1361 | + } |
|
| 1362 | + |
|
| 1363 | + /** |
|
| 1364 | + * Alias of self::get_address_confirmed(). |
|
| 1365 | + * |
|
| 1366 | + * @since 1.0.19 |
|
| 1367 | + * @param string $context View or edit context. |
|
| 1368 | + * @return bool |
|
| 1369 | + */ |
|
| 1370 | + public function get_user_address_confirmed( $context = 'view' ) { |
|
| 1371 | + return $this->get_address_confirmed( $context ); |
|
| 1372 | + } |
|
| 1373 | + |
|
| 1374 | + /** |
|
| 1375 | + * Alias of self::get_address(). |
|
| 1376 | + * |
|
| 1377 | + * @since 1.0.19 |
|
| 1378 | + * @param string $context View or edit context. |
|
| 1379 | + * @return bool |
|
| 1380 | + */ |
|
| 1381 | + public function get_customer_address_confirmed( $context = 'view' ) { |
|
| 1382 | + return $this->get_address_confirmed( $context ); |
|
| 1383 | + } |
|
| 1384 | + |
|
| 1385 | + /** |
|
| 1386 | + * Get the shipping address. |
|
| 1387 | + * |
|
| 1388 | + * @since 1.0.19 |
|
| 1389 | + * @return array|false |
|
| 1390 | + */ |
|
| 1391 | + public function get_shipping_address() { |
|
| 1392 | + |
|
| 1393 | + $shipping_address = get_post_meta( $this->get_id(), 'shipping_address', true ); |
|
| 1394 | + return is_array( $shipping_address ) ? $shipping_address : false; |
|
| 1395 | + } |
|
| 1396 | + |
|
| 1397 | + /** |
|
| 1398 | + * Check if the invoice has a shipping address. |
|
| 1399 | + */ |
|
| 1400 | + public function has_shipping_address() { |
|
| 1401 | + return false !== $this->get_shipping_address(); |
|
| 1402 | + } |
|
| 1403 | + |
|
| 1404 | + /** |
|
| 1405 | + * Get the shipping amount. |
|
| 1406 | + * |
|
| 1407 | + * @since 1.0.19 |
|
| 1408 | + * @param string $context View or edit context. |
|
| 1409 | + * @return float |
|
| 1410 | + */ |
|
| 1411 | + public function get_shipping( $context = 'view' ) { |
|
| 1412 | + |
|
| 1413 | + if ( $context = 'view' ) { |
|
| 1414 | + return floatval( $this->get_prop( 'shipping', $context ) ); |
|
| 1415 | + } |
|
| 1416 | + |
|
| 1417 | + return $this->get_prop( 'shipping', $context ); |
|
| 1418 | + } |
|
| 1419 | + |
|
| 1420 | + public function has_shipping() { |
|
| 1421 | + return defined( 'GETPAID_SHIPPING_CALCULATOR_VERSION' ) && null !== $this->get_prop( 'shipping', 'edit' ); |
|
| 1422 | + } |
|
| 1423 | + |
|
| 1424 | + /** |
|
| 1425 | + * Get the invoice subtotal. |
|
| 1426 | + * |
|
| 1427 | + * @since 1.0.19 |
|
| 1428 | + * @param string $context View or edit context. |
|
| 1429 | + * @return float |
|
| 1430 | + */ |
|
| 1431 | + public function get_subtotal( $context = 'view' ) { |
|
| 1432 | 1432 | $subtotal = (float) $this->get_prop( 'subtotal', $context ); |
| 1433 | 1433 | |
| 1434 | 1434 | // Backwards compatibility. |
@@ -1440,198 +1440,198 @@ discard block |
||
| 1440 | 1440 | } |
| 1441 | 1441 | |
| 1442 | 1442 | /** |
| 1443 | - * Get the invoice discount total. |
|
| 1444 | - * |
|
| 1445 | - * @since 1.0.19 |
|
| 1446 | - * @param string $context View or edit context. |
|
| 1447 | - * @return float |
|
| 1448 | - */ |
|
| 1449 | - public function get_total_discount( $context = 'view' ) { |
|
| 1450 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_discount', $context ) ) ); |
|
| 1443 | + * Get the invoice discount total. |
|
| 1444 | + * |
|
| 1445 | + * @since 1.0.19 |
|
| 1446 | + * @param string $context View or edit context. |
|
| 1447 | + * @return float |
|
| 1448 | + */ |
|
| 1449 | + public function get_total_discount( $context = 'view' ) { |
|
| 1450 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_discount', $context ) ) ); |
|
| 1451 | 1451 | } |
| 1452 | 1452 | |
| 1453 | 1453 | /** |
| 1454 | - * Get the invoice tax total. |
|
| 1455 | - * |
|
| 1456 | - * @since 1.0.19 |
|
| 1457 | - * @param string $context View or edit context. |
|
| 1458 | - * @return float |
|
| 1459 | - */ |
|
| 1460 | - public function get_total_tax( $context = 'view' ) { |
|
| 1461 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_tax', $context ) ) ); |
|
| 1462 | - } |
|
| 1454 | + * Get the invoice tax total. |
|
| 1455 | + * |
|
| 1456 | + * @since 1.0.19 |
|
| 1457 | + * @param string $context View or edit context. |
|
| 1458 | + * @return float |
|
| 1459 | + */ |
|
| 1460 | + public function get_total_tax( $context = 'view' ) { |
|
| 1461 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_tax', $context ) ) ); |
|
| 1462 | + } |
|
| 1463 | 1463 | |
| 1464 | - /** |
|
| 1465 | - * @deprecated |
|
| 1466 | - */ |
|
| 1467 | - public function get_final_tax( $currency = false ) { |
|
| 1468 | - $tax = $this->get_total_tax(); |
|
| 1464 | + /** |
|
| 1465 | + * @deprecated |
|
| 1466 | + */ |
|
| 1467 | + public function get_final_tax( $currency = false ) { |
|
| 1468 | + $tax = $this->get_total_tax(); |
|
| 1469 | 1469 | |
| 1470 | 1470 | if ( $currency ) { |
| 1471 | - return wpinv_price( $tax, $this->get_currency() ); |
|
| 1471 | + return wpinv_price( $tax, $this->get_currency() ); |
|
| 1472 | 1472 | } |
| 1473 | 1473 | |
| 1474 | 1474 | return $tax; |
| 1475 | 1475 | } |
| 1476 | 1476 | |
| 1477 | 1477 | /** |
| 1478 | - * Get the invoice fees total. |
|
| 1479 | - * |
|
| 1480 | - * @since 1.0.19 |
|
| 1481 | - * @param string $context View or edit context. |
|
| 1482 | - * @return float |
|
| 1483 | - */ |
|
| 1484 | - public function get_total_fees( $context = 'view' ) { |
|
| 1485 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_fees', $context ) ) ); |
|
| 1478 | + * Get the invoice fees total. |
|
| 1479 | + * |
|
| 1480 | + * @since 1.0.19 |
|
| 1481 | + * @param string $context View or edit context. |
|
| 1482 | + * @return float |
|
| 1483 | + */ |
|
| 1484 | + public function get_total_fees( $context = 'view' ) { |
|
| 1485 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_fees', $context ) ) ); |
|
| 1486 | + } |
|
| 1487 | + |
|
| 1488 | + /** |
|
| 1489 | + * Alias for self::get_total_fees(). |
|
| 1490 | + * |
|
| 1491 | + * @since 1.0.19 |
|
| 1492 | + * @param string $context View or edit context. |
|
| 1493 | + * @return float |
|
| 1494 | + */ |
|
| 1495 | + public function get_fees_total( $context = 'view' ) { |
|
| 1496 | + return $this->get_total_fees( $context ); |
|
| 1486 | 1497 | } |
| 1487 | 1498 | |
| 1488 | 1499 | /** |
| 1489 | - * Alias for self::get_total_fees(). |
|
| 1490 | - * |
|
| 1491 | - * @since 1.0.19 |
|
| 1492 | - * @param string $context View or edit context. |
|
| 1493 | - * @return float |
|
| 1494 | - */ |
|
| 1495 | - public function get_fees_total( $context = 'view' ) { |
|
| 1496 | - return $this->get_total_fees( $context ); |
|
| 1500 | + * Get the invoice total. |
|
| 1501 | + * |
|
| 1502 | + * @since 1.0.19 |
|
| 1503 | + * @return float |
|
| 1504 | + */ |
|
| 1505 | + public function get_total( $context = 'view' ) { |
|
| 1506 | + $total = $this->get_prop( 'total', $context ); |
|
| 1507 | + |
|
| 1508 | + if ( $this->has_shipping() && $context == 'view' ) { |
|
| 1509 | + $total = $this->get_prop( 'total', $context ) + $this->get_shipping( $context ); |
|
| 1510 | + } |
|
| 1511 | + |
|
| 1512 | + return wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
| 1497 | 1513 | } |
| 1498 | 1514 | |
| 1499 | 1515 | /** |
| 1500 | - * Get the invoice total. |
|
| 1501 | - * |
|
| 1502 | - * @since 1.0.19 |
|
| 1516 | + * Retrieves the non-recurring total of items. |
|
| 1517 | + * |
|
| 1518 | + * @since 2.3.0 |
|
| 1503 | 1519 | * @return float |
| 1504 | - */ |
|
| 1505 | - public function get_total( $context = 'view' ) { |
|
| 1506 | - $total = $this->get_prop( 'total', $context ); |
|
| 1507 | - |
|
| 1508 | - if ( $this->has_shipping() && $context == 'view' ) { |
|
| 1509 | - $total = $this->get_prop( 'total', $context ) + $this->get_shipping( $context ); |
|
| 1510 | - } |
|
| 1511 | - |
|
| 1512 | - return wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
| 1513 | - } |
|
| 1514 | - |
|
| 1515 | - /** |
|
| 1516 | - * Retrieves the non-recurring total of items. |
|
| 1517 | - * |
|
| 1518 | - * @since 2.3.0 |
|
| 1519 | - * @return float |
|
| 1520 | - */ |
|
| 1521 | - public function get_non_recurring_total() { |
|
| 1522 | - |
|
| 1523 | - $subtotal = 0; |
|
| 1524 | - foreach ( $this->get_items() as $item ) { |
|
| 1525 | - if ( ! $item->is_recurring() ) { |
|
| 1526 | - $subtotal += $item->get_sub_total(); |
|
| 1527 | - } |
|
| 1528 | - } |
|
| 1529 | - |
|
| 1530 | - foreach ( $this->get_fees() as $fee ) { |
|
| 1531 | - if ( empty( $fee['recurring_fee'] ) ) { |
|
| 1532 | - $subtotal += wpinv_sanitize_amount( $fee['initial_fee'] ); |
|
| 1533 | - } |
|
| 1534 | - } |
|
| 1535 | - |
|
| 1536 | - $subtotal = wpinv_round_amount( wpinv_sanitize_amount( $subtotal ) ); |
|
| 1520 | + */ |
|
| 1521 | + public function get_non_recurring_total() { |
|
| 1522 | + |
|
| 1523 | + $subtotal = 0; |
|
| 1524 | + foreach ( $this->get_items() as $item ) { |
|
| 1525 | + if ( ! $item->is_recurring() ) { |
|
| 1526 | + $subtotal += $item->get_sub_total(); |
|
| 1527 | + } |
|
| 1528 | + } |
|
| 1529 | + |
|
| 1530 | + foreach ( $this->get_fees() as $fee ) { |
|
| 1531 | + if ( empty( $fee['recurring_fee'] ) ) { |
|
| 1532 | + $subtotal += wpinv_sanitize_amount( $fee['initial_fee'] ); |
|
| 1533 | + } |
|
| 1534 | + } |
|
| 1535 | + |
|
| 1536 | + $subtotal = wpinv_round_amount( wpinv_sanitize_amount( $subtotal ) ); |
|
| 1537 | 1537 | return apply_filters( 'wpinv_get_non_recurring_invoice_total', $subtotal, $this ); |
| 1538 | 1538 | |
| 1539 | 1539 | } |
| 1540 | 1540 | |
| 1541 | - /** |
|
| 1542 | - * Get the invoice totals. |
|
| 1543 | - * |
|
| 1544 | - * @since 1.0.19 |
|
| 1541 | + /** |
|
| 1542 | + * Get the invoice totals. |
|
| 1543 | + * |
|
| 1544 | + * @since 1.0.19 |
|
| 1545 | 1545 | * @return array |
| 1546 | - */ |
|
| 1547 | - public function get_totals() { |
|
| 1548 | - return $this->totals; |
|
| 1546 | + */ |
|
| 1547 | + public function get_totals() { |
|
| 1548 | + return $this->totals; |
|
| 1549 | 1549 | } |
| 1550 | 1550 | |
| 1551 | 1551 | /** |
| 1552 | - * Get the initial invoice total. |
|
| 1553 | - * |
|
| 1554 | - * @since 1.0.19 |
|
| 1552 | + * Get the initial invoice total. |
|
| 1553 | + * |
|
| 1554 | + * @since 1.0.19 |
|
| 1555 | 1555 | * @param string $context View or edit context. |
| 1556 | 1556 | * @return float |
| 1557 | - */ |
|
| 1557 | + */ |
|
| 1558 | 1558 | public function get_initial_total() { |
| 1559 | 1559 | |
| 1560 | - if ( empty( $this->totals ) ) { |
|
| 1561 | - $this->recalculate_total(); |
|
| 1562 | - } |
|
| 1560 | + if ( empty( $this->totals ) ) { |
|
| 1561 | + $this->recalculate_total(); |
|
| 1562 | + } |
|
| 1563 | 1563 | |
| 1564 | - $tax = $this->totals['tax']['initial']; |
|
| 1565 | - $fee = $this->totals['fee']['initial']; |
|
| 1566 | - $discount = $this->totals['discount']['initial']; |
|
| 1567 | - $subtotal = $this->totals['subtotal']['initial']; |
|
| 1568 | - $total = $tax + $fee - $discount + $subtotal; |
|
| 1564 | + $tax = $this->totals['tax']['initial']; |
|
| 1565 | + $fee = $this->totals['fee']['initial']; |
|
| 1566 | + $discount = $this->totals['discount']['initial']; |
|
| 1567 | + $subtotal = $this->totals['subtotal']['initial']; |
|
| 1568 | + $total = $tax + $fee - $discount + $subtotal; |
|
| 1569 | 1569 | |
| 1570 | - if ( 0 > $total ) { |
|
| 1571 | - $total = 0; |
|
| 1572 | - } |
|
| 1570 | + if ( 0 > $total ) { |
|
| 1571 | + $total = 0; |
|
| 1572 | + } |
|
| 1573 | 1573 | |
| 1574 | - $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
| 1574 | + $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
| 1575 | 1575 | return apply_filters( 'wpinv_get_initial_invoice_total', $total, $this ); |
| 1576 | - } |
|
| 1576 | + } |
|
| 1577 | 1577 | |
| 1578 | - /** |
|
| 1579 | - * Get the recurring invoice total. |
|
| 1580 | - * |
|
| 1581 | - * @since 1.0.19 |
|
| 1578 | + /** |
|
| 1579 | + * Get the recurring invoice total. |
|
| 1580 | + * |
|
| 1581 | + * @since 1.0.19 |
|
| 1582 | 1582 | * @param string $context View or edit context. |
| 1583 | 1583 | * @return float |
| 1584 | - */ |
|
| 1584 | + */ |
|
| 1585 | 1585 | public function get_recurring_total() { |
| 1586 | 1586 | |
| 1587 | - if ( empty( $this->totals ) ) { |
|
| 1588 | - $this->recalculate_total(); |
|
| 1589 | - } |
|
| 1587 | + if ( empty( $this->totals ) ) { |
|
| 1588 | + $this->recalculate_total(); |
|
| 1589 | + } |
|
| 1590 | 1590 | |
| 1591 | - $tax = $this->totals['tax']['recurring']; |
|
| 1592 | - $fee = $this->totals['fee']['recurring']; |
|
| 1593 | - $discount = $this->totals['discount']['recurring']; |
|
| 1594 | - $subtotal = $this->totals['subtotal']['recurring']; |
|
| 1595 | - $total = $tax + $fee - $discount + $subtotal; |
|
| 1591 | + $tax = $this->totals['tax']['recurring']; |
|
| 1592 | + $fee = $this->totals['fee']['recurring']; |
|
| 1593 | + $discount = $this->totals['discount']['recurring']; |
|
| 1594 | + $subtotal = $this->totals['subtotal']['recurring']; |
|
| 1595 | + $total = $tax + $fee - $discount + $subtotal; |
|
| 1596 | 1596 | |
| 1597 | - if ( 0 > $total ) { |
|
| 1598 | - $total = 0; |
|
| 1599 | - } |
|
| 1597 | + if ( 0 > $total ) { |
|
| 1598 | + $total = 0; |
|
| 1599 | + } |
|
| 1600 | 1600 | |
| 1601 | - $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
| 1601 | + $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
| 1602 | 1602 | return apply_filters( 'wpinv_get_recurring_invoice_total', $total, $this ); |
| 1603 | - } |
|
| 1603 | + } |
|
| 1604 | 1604 | |
| 1605 | - /** |
|
| 1606 | - * Returns recurring payment details. |
|
| 1607 | - * |
|
| 1608 | - * @since 1.0.19 |
|
| 1605 | + /** |
|
| 1606 | + * Returns recurring payment details. |
|
| 1607 | + * |
|
| 1608 | + * @since 1.0.19 |
|
| 1609 | 1609 | * @param string $field Optionally provide a field to return. |
| 1610 | - * @param string $currency Whether to include the currency. |
|
| 1610 | + * @param string $currency Whether to include the currency. |
|
| 1611 | 1611 | * @return float|string |
| 1612 | - */ |
|
| 1612 | + */ |
|
| 1613 | 1613 | public function get_recurring_details( $field = '', $currency = false ) { |
| 1614 | 1614 | |
| 1615 | - // Maybe recalculate totals. |
|
| 1616 | - if ( empty( $this->totals ) ) { |
|
| 1617 | - $this->recalculate_total(); |
|
| 1618 | - } |
|
| 1615 | + // Maybe recalculate totals. |
|
| 1616 | + if ( empty( $this->totals ) ) { |
|
| 1617 | + $this->recalculate_total(); |
|
| 1618 | + } |
|
| 1619 | 1619 | |
| 1620 | - // Prepare recurring totals. |
|
| 1620 | + // Prepare recurring totals. |
|
| 1621 | 1621 | $data = apply_filters( |
| 1622 | - 'wpinv_get_invoice_recurring_details', |
|
| 1623 | - array( |
|
| 1624 | - 'cart_details' => $this->get_cart_details(), |
|
| 1625 | - 'subtotal' => $this->totals['subtotal']['recurring'], |
|
| 1626 | - 'discount' => $this->totals['discount']['recurring'], |
|
| 1627 | - 'tax' => $this->totals['tax']['recurring'], |
|
| 1628 | - 'fee' => $this->totals['fee']['recurring'], |
|
| 1629 | - 'total' => $this->get_recurring_total(), |
|
| 1630 | - ), |
|
| 1631 | - $this, |
|
| 1632 | - $field, |
|
| 1633 | - $currency |
|
| 1634 | - ); |
|
| 1622 | + 'wpinv_get_invoice_recurring_details', |
|
| 1623 | + array( |
|
| 1624 | + 'cart_details' => $this->get_cart_details(), |
|
| 1625 | + 'subtotal' => $this->totals['subtotal']['recurring'], |
|
| 1626 | + 'discount' => $this->totals['discount']['recurring'], |
|
| 1627 | + 'tax' => $this->totals['tax']['recurring'], |
|
| 1628 | + 'fee' => $this->totals['fee']['recurring'], |
|
| 1629 | + 'total' => $this->get_recurring_total(), |
|
| 1630 | + ), |
|
| 1631 | + $this, |
|
| 1632 | + $field, |
|
| 1633 | + $currency |
|
| 1634 | + ); |
|
| 1635 | 1635 | |
| 1636 | 1636 | if ( isset( $data[ $field ] ) ) { |
| 1637 | 1637 | return ( $currency ? wpinv_price( $data[ $field ], $this->get_currency() ) : $data[ $field ] ); |
@@ -1641,166 +1641,166 @@ discard block |
||
| 1641 | 1641 | } |
| 1642 | 1642 | |
| 1643 | 1643 | /** |
| 1644 | - * Get the invoice fees. |
|
| 1645 | - * |
|
| 1646 | - * @since 1.0.19 |
|
| 1647 | - * @param string $context View or edit context. |
|
| 1648 | - * @return array |
|
| 1649 | - */ |
|
| 1650 | - public function get_fees( $context = 'view' ) { |
|
| 1651 | - return wpinv_parse_list( $this->get_prop( 'fees', $context ) ); |
|
| 1644 | + * Get the invoice fees. |
|
| 1645 | + * |
|
| 1646 | + * @since 1.0.19 |
|
| 1647 | + * @param string $context View or edit context. |
|
| 1648 | + * @return array |
|
| 1649 | + */ |
|
| 1650 | + public function get_fees( $context = 'view' ) { |
|
| 1651 | + return wpinv_parse_list( $this->get_prop( 'fees', $context ) ); |
|
| 1652 | 1652 | } |
| 1653 | 1653 | |
| 1654 | 1654 | /** |
| 1655 | - * Get the invoice discounts. |
|
| 1656 | - * |
|
| 1657 | - * @since 1.0.19 |
|
| 1658 | - * @param string $context View or edit context. |
|
| 1659 | - * @return array |
|
| 1660 | - */ |
|
| 1661 | - public function get_discounts( $context = 'view' ) { |
|
| 1662 | - return wpinv_parse_list( $this->get_prop( 'discounts', $context ) ); |
|
| 1655 | + * Get the invoice discounts. |
|
| 1656 | + * |
|
| 1657 | + * @since 1.0.19 |
|
| 1658 | + * @param string $context View or edit context. |
|
| 1659 | + * @return array |
|
| 1660 | + */ |
|
| 1661 | + public function get_discounts( $context = 'view' ) { |
|
| 1662 | + return wpinv_parse_list( $this->get_prop( 'discounts', $context ) ); |
|
| 1663 | 1663 | } |
| 1664 | 1664 | |
| 1665 | 1665 | /** |
| 1666 | - * Get the invoice taxes. |
|
| 1667 | - * |
|
| 1668 | - * @since 1.0.19 |
|
| 1669 | - * @param string $context View or edit context. |
|
| 1670 | - * @return array |
|
| 1671 | - */ |
|
| 1672 | - public function get_taxes( $context = 'view' ) { |
|
| 1673 | - return wpinv_parse_list( $this->get_prop( 'taxes', $context ) ); |
|
| 1666 | + * Get the invoice taxes. |
|
| 1667 | + * |
|
| 1668 | + * @since 1.0.19 |
|
| 1669 | + * @param string $context View or edit context. |
|
| 1670 | + * @return array |
|
| 1671 | + */ |
|
| 1672 | + public function get_taxes( $context = 'view' ) { |
|
| 1673 | + return wpinv_parse_list( $this->get_prop( 'taxes', $context ) ); |
|
| 1674 | 1674 | } |
| 1675 | 1675 | |
| 1676 | 1676 | /** |
| 1677 | - * Get the invoice items. |
|
| 1678 | - * |
|
| 1679 | - * @since 1.0.19 |
|
| 1680 | - * @param string $context View or edit context. |
|
| 1681 | - * @return GetPaid_Form_Item[] |
|
| 1682 | - */ |
|
| 1683 | - public function get_items( $context = 'view' ) { |
|
| 1677 | + * Get the invoice items. |
|
| 1678 | + * |
|
| 1679 | + * @since 1.0.19 |
|
| 1680 | + * @param string $context View or edit context. |
|
| 1681 | + * @return GetPaid_Form_Item[] |
|
| 1682 | + */ |
|
| 1683 | + public function get_items( $context = 'view' ) { |
|
| 1684 | 1684 | return $this->get_prop( 'items', $context ); |
| 1685 | - } |
|
| 1685 | + } |
|
| 1686 | 1686 | |
| 1687 | - /** |
|
| 1688 | - * Get the invoice item ids. |
|
| 1689 | - * |
|
| 1690 | - * @since 1.0.19 |
|
| 1691 | - * @return string |
|
| 1692 | - */ |
|
| 1693 | - public function get_item_ids() { |
|
| 1694 | - return implode( ', ', wp_list_pluck( $this->get_cart_details(), 'item_id' ) ); |
|
| 1687 | + /** |
|
| 1688 | + * Get the invoice item ids. |
|
| 1689 | + * |
|
| 1690 | + * @since 1.0.19 |
|
| 1691 | + * @return string |
|
| 1692 | + */ |
|
| 1693 | + public function get_item_ids() { |
|
| 1694 | + return implode( ', ', wp_list_pluck( $this->get_cart_details(), 'item_id' ) ); |
|
| 1695 | 1695 | } |
| 1696 | 1696 | |
| 1697 | 1697 | /** |
| 1698 | - * Get the invoice's payment form. |
|
| 1699 | - * |
|
| 1700 | - * @since 1.0.19 |
|
| 1701 | - * @param string $context View or edit context. |
|
| 1702 | - * @return int |
|
| 1703 | - */ |
|
| 1704 | - public function get_payment_form( $context = 'view' ) { |
|
| 1705 | - return intval( $this->get_prop( 'payment_form', $context ) ); |
|
| 1698 | + * Get the invoice's payment form. |
|
| 1699 | + * |
|
| 1700 | + * @since 1.0.19 |
|
| 1701 | + * @param string $context View or edit context. |
|
| 1702 | + * @return int |
|
| 1703 | + */ |
|
| 1704 | + public function get_payment_form( $context = 'view' ) { |
|
| 1705 | + return intval( $this->get_prop( 'payment_form', $context ) ); |
|
| 1706 | 1706 | } |
| 1707 | 1707 | |
| 1708 | 1708 | /** |
| 1709 | - * Get the invoice's submission id. |
|
| 1710 | - * |
|
| 1711 | - * @since 1.0.19 |
|
| 1712 | - * @param string $context View or edit context. |
|
| 1713 | - * @return string |
|
| 1714 | - */ |
|
| 1715 | - public function get_submission_id( $context = 'view' ) { |
|
| 1716 | - return $this->get_prop( 'submission_id', $context ); |
|
| 1709 | + * Get the invoice's submission id. |
|
| 1710 | + * |
|
| 1711 | + * @since 1.0.19 |
|
| 1712 | + * @param string $context View or edit context. |
|
| 1713 | + * @return string |
|
| 1714 | + */ |
|
| 1715 | + public function get_submission_id( $context = 'view' ) { |
|
| 1716 | + return $this->get_prop( 'submission_id', $context ); |
|
| 1717 | 1717 | } |
| 1718 | 1718 | |
| 1719 | 1719 | /** |
| 1720 | - * Get the invoice's discount code. |
|
| 1721 | - * |
|
| 1722 | - * @since 1.0.19 |
|
| 1723 | - * @param string $context View or edit context. |
|
| 1724 | - * @return string |
|
| 1725 | - */ |
|
| 1726 | - public function get_discount_code( $context = 'view' ) { |
|
| 1727 | - return $this->get_prop( 'discount_code', $context ); |
|
| 1720 | + * Get the invoice's discount code. |
|
| 1721 | + * |
|
| 1722 | + * @since 1.0.19 |
|
| 1723 | + * @param string $context View or edit context. |
|
| 1724 | + * @return string |
|
| 1725 | + */ |
|
| 1726 | + public function get_discount_code( $context = 'view' ) { |
|
| 1727 | + return $this->get_prop( 'discount_code', $context ); |
|
| 1728 | 1728 | } |
| 1729 | 1729 | |
| 1730 | 1730 | /** |
| 1731 | - * Get the invoice's gateway. |
|
| 1732 | - * |
|
| 1733 | - * @since 1.0.19 |
|
| 1734 | - * @param string $context View or edit context. |
|
| 1735 | - * @return string |
|
| 1736 | - */ |
|
| 1737 | - public function get_gateway( $context = 'view' ) { |
|
| 1738 | - return $this->get_prop( 'gateway', $context ); |
|
| 1731 | + * Get the invoice's gateway. |
|
| 1732 | + * |
|
| 1733 | + * @since 1.0.19 |
|
| 1734 | + * @param string $context View or edit context. |
|
| 1735 | + * @return string |
|
| 1736 | + */ |
|
| 1737 | + public function get_gateway( $context = 'view' ) { |
|
| 1738 | + return $this->get_prop( 'gateway', $context ); |
|
| 1739 | 1739 | } |
| 1740 | 1740 | |
| 1741 | 1741 | /** |
| 1742 | - * Get the invoice's gateway display title. |
|
| 1743 | - * |
|
| 1744 | - * @since 1.0.19 |
|
| 1745 | - * @return string |
|
| 1746 | - */ |
|
| 1742 | + * Get the invoice's gateway display title. |
|
| 1743 | + * |
|
| 1744 | + * @since 1.0.19 |
|
| 1745 | + * @return string |
|
| 1746 | + */ |
|
| 1747 | 1747 | public function get_gateway_title() { |
| 1748 | 1748 | $title = wpinv_get_gateway_checkout_label( $this->get_gateway() ); |
| 1749 | 1749 | return apply_filters( 'wpinv_gateway_title', $title, $this->get_id(), $this ); |
| 1750 | 1750 | } |
| 1751 | 1751 | |
| 1752 | 1752 | /** |
| 1753 | - * Get the invoice's transaction id. |
|
| 1754 | - * |
|
| 1755 | - * @since 1.0.19 |
|
| 1756 | - * @param string $context View or edit context. |
|
| 1757 | - * @return string |
|
| 1758 | - */ |
|
| 1759 | - public function get_transaction_id( $context = 'view' ) { |
|
| 1760 | - return $this->get_prop( 'transaction_id', $context ); |
|
| 1753 | + * Get the invoice's transaction id. |
|
| 1754 | + * |
|
| 1755 | + * @since 1.0.19 |
|
| 1756 | + * @param string $context View or edit context. |
|
| 1757 | + * @return string |
|
| 1758 | + */ |
|
| 1759 | + public function get_transaction_id( $context = 'view' ) { |
|
| 1760 | + return $this->get_prop( 'transaction_id', $context ); |
|
| 1761 | 1761 | } |
| 1762 | 1762 | |
| 1763 | 1763 | /** |
| 1764 | - * Get the invoice's currency. |
|
| 1765 | - * |
|
| 1766 | - * @since 1.0.19 |
|
| 1767 | - * @param string $context View or edit context. |
|
| 1768 | - * @return string |
|
| 1769 | - */ |
|
| 1770 | - public function get_currency( $context = 'view' ) { |
|
| 1764 | + * Get the invoice's currency. |
|
| 1765 | + * |
|
| 1766 | + * @since 1.0.19 |
|
| 1767 | + * @param string $context View or edit context. |
|
| 1768 | + * @return string |
|
| 1769 | + */ |
|
| 1770 | + public function get_currency( $context = 'view' ) { |
|
| 1771 | 1771 | $currency = $this->get_prop( 'currency', $context ); |
| 1772 | 1772 | return empty( $currency ) ? wpinv_get_currency() : $currency; |
| 1773 | 1773 | } |
| 1774 | 1774 | |
| 1775 | 1775 | /** |
| 1776 | - * Checks if we are charging taxes for this invoice. |
|
| 1777 | - * |
|
| 1778 | - * @since 1.0.19 |
|
| 1779 | - * @param string $context View or edit context. |
|
| 1780 | - * @return bool |
|
| 1781 | - */ |
|
| 1782 | - public function get_disable_taxes( $context = 'view' ) { |
|
| 1776 | + * Checks if we are charging taxes for this invoice. |
|
| 1777 | + * |
|
| 1778 | + * @since 1.0.19 |
|
| 1779 | + * @param string $context View or edit context. |
|
| 1780 | + * @return bool |
|
| 1781 | + */ |
|
| 1782 | + public function get_disable_taxes( $context = 'view' ) { |
|
| 1783 | 1783 | return (bool) $this->get_prop( 'disable_taxes', $context ); |
| 1784 | 1784 | } |
| 1785 | 1785 | |
| 1786 | 1786 | /** |
| 1787 | - * Retrieves the subscription id for an invoice. |
|
| 1788 | - * |
|
| 1789 | - * @since 1.0.19 |
|
| 1790 | - * @param string $context View or edit context. |
|
| 1791 | - * @return int |
|
| 1792 | - */ |
|
| 1787 | + * Retrieves the subscription id for an invoice. |
|
| 1788 | + * |
|
| 1789 | + * @since 1.0.19 |
|
| 1790 | + * @param string $context View or edit context. |
|
| 1791 | + * @return int |
|
| 1792 | + */ |
|
| 1793 | 1793 | public function get_subscription_id( $context = 'view' ) { |
| 1794 | - return $this->is_renewal() ? $this->get_parent()->get_subscription_id( $context ) : $this->get_prop( 'subscription_id', $context ); |
|
| 1795 | - } |
|
| 1796 | - |
|
| 1797 | - /** |
|
| 1798 | - * Retrieves the remote subscription id for an invoice. |
|
| 1799 | - * |
|
| 1800 | - * @since 1.0.19 |
|
| 1801 | - * @param string $context View or edit context. |
|
| 1802 | - * @return int |
|
| 1803 | - */ |
|
| 1794 | + return $this->is_renewal() ? $this->get_parent()->get_subscription_id( $context ) : $this->get_prop( 'subscription_id', $context ); |
|
| 1795 | + } |
|
| 1796 | + |
|
| 1797 | + /** |
|
| 1798 | + * Retrieves the remote subscription id for an invoice. |
|
| 1799 | + * |
|
| 1800 | + * @since 1.0.19 |
|
| 1801 | + * @param string $context View or edit context. |
|
| 1802 | + * @return int |
|
| 1803 | + */ |
|
| 1804 | 1804 | public function get_remote_subscription_id( $context = 'view' ) { |
| 1805 | 1805 | $subscription_id = $this->get_prop( 'remote_subscription_id', $context ); |
| 1806 | 1806 | |
@@ -1813,12 +1813,12 @@ discard block |
||
| 1813 | 1813 | } |
| 1814 | 1814 | |
| 1815 | 1815 | /** |
| 1816 | - * Retrieves the payment meta for an invoice. |
|
| 1817 | - * |
|
| 1818 | - * @since 1.0.19 |
|
| 1819 | - * @param string $context View or edit context. |
|
| 1820 | - * @return array |
|
| 1821 | - */ |
|
| 1816 | + * Retrieves the payment meta for an invoice. |
|
| 1817 | + * |
|
| 1818 | + * @since 1.0.19 |
|
| 1819 | + * @param string $context View or edit context. |
|
| 1820 | + * @return array |
|
| 1821 | + */ |
|
| 1822 | 1822 | public function get_payment_meta( $context = 'view' ) { |
| 1823 | 1823 | |
| 1824 | 1824 | return array( |
@@ -1838,31 +1838,31 @@ discard block |
||
| 1838 | 1838 | } |
| 1839 | 1839 | |
| 1840 | 1840 | /** |
| 1841 | - * Retrieves the cart details for an invoice. |
|
| 1842 | - * |
|
| 1843 | - * @since 1.0.19 |
|
| 1844 | - * @return array |
|
| 1845 | - */ |
|
| 1841 | + * Retrieves the cart details for an invoice. |
|
| 1842 | + * |
|
| 1843 | + * @since 1.0.19 |
|
| 1844 | + * @return array |
|
| 1845 | + */ |
|
| 1846 | 1846 | public function get_cart_details() { |
| 1847 | 1847 | $items = $this->get_items(); |
| 1848 | 1848 | $cart_details = array(); |
| 1849 | 1849 | |
| 1850 | 1850 | foreach ( $items as $item ) { |
| 1851 | - $item->invoice_id = $this->get_id(); |
|
| 1851 | + $item->invoice_id = $this->get_id(); |
|
| 1852 | 1852 | $cart_details[] = $item->prepare_data_for_saving(); |
| 1853 | 1853 | } |
| 1854 | 1854 | |
| 1855 | 1855 | return $cart_details; |
| 1856 | - } |
|
| 1856 | + } |
|
| 1857 | 1857 | |
| 1858 | - /** |
|
| 1859 | - * Retrieves the recurring item. |
|
| 1860 | - * |
|
| 1861 | - * @return null|GetPaid_Form_Item|int |
|
| 1862 | - */ |
|
| 1863 | - public function get_recurring( $object = false ) { |
|
| 1858 | + /** |
|
| 1859 | + * Retrieves the recurring item. |
|
| 1860 | + * |
|
| 1861 | + * @return null|GetPaid_Form_Item|int |
|
| 1862 | + */ |
|
| 1863 | + public function get_recurring( $object = false ) { |
|
| 1864 | 1864 | |
| 1865 | - // Are we returning an object? |
|
| 1865 | + // Are we returning an object? |
|
| 1866 | 1866 | if ( $object ) { |
| 1867 | 1867 | return $this->get_item( $this->recurring_item ); |
| 1868 | 1868 | } |
@@ -1870,130 +1870,130 @@ discard block |
||
| 1870 | 1870 | return $this->recurring_item; |
| 1871 | 1871 | } |
| 1872 | 1872 | |
| 1873 | - /** |
|
| 1874 | - * Retrieves the subscription name. |
|
| 1875 | - * |
|
| 1876 | - * @since 1.0.19 |
|
| 1877 | - * @return string |
|
| 1878 | - */ |
|
| 1879 | - public function get_subscription_name() { |
|
| 1873 | + /** |
|
| 1874 | + * Retrieves the subscription name. |
|
| 1875 | + * |
|
| 1876 | + * @since 1.0.19 |
|
| 1877 | + * @return string |
|
| 1878 | + */ |
|
| 1879 | + public function get_subscription_name() { |
|
| 1880 | 1880 | |
| 1881 | - // Retrieve the recurring name |
|
| 1881 | + // Retrieve the recurring name |
|
| 1882 | 1882 | $item = $this->get_recurring( true ); |
| 1883 | 1883 | |
| 1884 | - // Abort if it does not exist. |
|
| 1884 | + // Abort if it does not exist. |
|
| 1885 | 1885 | if ( empty( $item ) ) { |
| 1886 | 1886 | return ''; |
| 1887 | 1887 | } |
| 1888 | 1888 | |
| 1889 | - // Return the item name. |
|
| 1889 | + // Return the item name. |
|
| 1890 | 1890 | return apply_filters( 'wpinv_invoice_get_subscription_name', $item->get_name(), $this ); |
| 1891 | - } |
|
| 1892 | - |
|
| 1893 | - /** |
|
| 1894 | - * Retrieves the view url. |
|
| 1895 | - * |
|
| 1896 | - * @since 1.0.19 |
|
| 1897 | - * @return string |
|
| 1898 | - */ |
|
| 1899 | - public function get_view_url() { |
|
| 1891 | + } |
|
| 1892 | + |
|
| 1893 | + /** |
|
| 1894 | + * Retrieves the view url. |
|
| 1895 | + * |
|
| 1896 | + * @since 1.0.19 |
|
| 1897 | + * @return string |
|
| 1898 | + */ |
|
| 1899 | + public function get_view_url() { |
|
| 1900 | 1900 | $invoice_url = get_permalink( $this->get_id() ); |
| 1901 | - $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url ); |
|
| 1901 | + $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url ); |
|
| 1902 | 1902 | return apply_filters( 'wpinv_get_view_url', $invoice_url, $this ); |
| 1903 | - } |
|
| 1903 | + } |
|
| 1904 | 1904 | |
| 1905 | - /** |
|
| 1906 | - * Retrieves the payment url. |
|
| 1907 | - * |
|
| 1908 | - * @since 1.0.19 |
|
| 1909 | - * @return string |
|
| 1910 | - */ |
|
| 1911 | - public function get_checkout_payment_url( $deprecated = false, $secret = false ) { |
|
| 1905 | + /** |
|
| 1906 | + * Retrieves the payment url. |
|
| 1907 | + * |
|
| 1908 | + * @since 1.0.19 |
|
| 1909 | + * @return string |
|
| 1910 | + */ |
|
| 1911 | + public function get_checkout_payment_url( $deprecated = false, $secret = false ) { |
|
| 1912 | 1912 | |
| 1913 | - // Retrieve the checkout url. |
|
| 1913 | + // Retrieve the checkout url. |
|
| 1914 | 1914 | $pay_url = wpinv_get_checkout_uri(); |
| 1915 | 1915 | |
| 1916 | - // Maybe force ssl. |
|
| 1916 | + // Maybe force ssl. |
|
| 1917 | 1917 | if ( is_ssl() ) { |
| 1918 | 1918 | $pay_url = str_replace( 'http:', 'https:', $pay_url ); |
| 1919 | 1919 | } |
| 1920 | 1920 | |
| 1921 | - // Add the invoice key. |
|
| 1922 | - $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url ); |
|
| 1921 | + // Add the invoice key. |
|
| 1922 | + $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url ); |
|
| 1923 | 1923 | |
| 1924 | - // (Maybe?) add a secret |
|
| 1924 | + // (Maybe?) add a secret |
|
| 1925 | 1925 | if ( $secret ) { |
| 1926 | 1926 | $pay_url = add_query_arg( array( '_wpipay' => md5( $this->get_user_id() . '::' . $this->get_email() . '::' . $this->get_key() ) ), $pay_url ); |
| 1927 | 1927 | } |
| 1928 | 1928 | |
| 1929 | 1929 | return apply_filters( 'wpinv_get_checkout_payment_url', $pay_url, $this, $deprecated, $secret ); |
| 1930 | - } |
|
| 1930 | + } |
|
| 1931 | 1931 | |
| 1932 | - /** |
|
| 1933 | - * Retrieves the receipt url. |
|
| 1934 | - * |
|
| 1935 | - * @since 1.0.19 |
|
| 1936 | - * @return string |
|
| 1937 | - */ |
|
| 1938 | - public function get_receipt_url() { |
|
| 1932 | + /** |
|
| 1933 | + * Retrieves the receipt url. |
|
| 1934 | + * |
|
| 1935 | + * @since 1.0.19 |
|
| 1936 | + * @return string |
|
| 1937 | + */ |
|
| 1938 | + public function get_receipt_url() { |
|
| 1939 | 1939 | |
| 1940 | - // Retrieve the checkout url. |
|
| 1940 | + // Retrieve the checkout url. |
|
| 1941 | 1941 | $receipt_url = wpinv_get_success_page_uri(); |
| 1942 | 1942 | |
| 1943 | - // Maybe force ssl. |
|
| 1943 | + // Maybe force ssl. |
|
| 1944 | 1944 | if ( is_ssl() ) { |
| 1945 | 1945 | $receipt_url = str_replace( 'http:', 'https:', $receipt_url ); |
| 1946 | 1946 | } |
| 1947 | 1947 | |
| 1948 | - // Add the invoice key. |
|
| 1949 | - $receipt_url = add_query_arg( 'invoice_key', $this->get_key(), $receipt_url ); |
|
| 1948 | + // Add the invoice key. |
|
| 1949 | + $receipt_url = add_query_arg( 'invoice_key', $this->get_key(), $receipt_url ); |
|
| 1950 | 1950 | |
| 1951 | 1951 | return apply_filters( 'getpaid_get_invoice_receipt_url', $receipt_url, $this ); |
| 1952 | - } |
|
| 1953 | - |
|
| 1954 | - /** |
|
| 1955 | - * Retrieves the remote transaction url. |
|
| 1956 | - * |
|
| 1957 | - * @since 1.6.0 |
|
| 1958 | - * @return string |
|
| 1959 | - */ |
|
| 1960 | - public function get_transaction_url() { |
|
| 1961 | - return apply_filters( 'getpaid_gateway_' . $this->get_gateway() . '_transaction_url', '', $this ); |
|
| 1962 | - } |
|
| 1963 | - |
|
| 1964 | - /** |
|
| 1965 | - * Retrieves the default status. |
|
| 1966 | - * |
|
| 1967 | - * @since 1.0.19 |
|
| 1968 | - * @return string |
|
| 1969 | - */ |
|
| 1970 | - public function get_default_status() { |
|
| 1971 | - |
|
| 1972 | - $type = $this->get_type(); |
|
| 1973 | - $status = "wpi-$type-pending"; |
|
| 1974 | - return str_replace( '-invoice', '', $status ); |
|
| 1975 | - |
|
| 1976 | - } |
|
| 1977 | - |
|
| 1978 | - /** |
|
| 1979 | - * Magic method for accessing invoice properties. |
|
| 1980 | - * |
|
| 1981 | - * @since 1.0.15 |
|
| 1982 | - * @access public |
|
| 1983 | - * |
|
| 1984 | - * @param string $key Discount data to retrieve |
|
| 1985 | - * @param string $context View or edit context. |
|
| 1986 | - * @return mixed Value of the given invoice property (if set). |
|
| 1987 | - */ |
|
| 1988 | - public function get( $key, $context = 'view' ) { |
|
| 1989 | - $method = "get_$key"; |
|
| 1990 | - |
|
| 1991 | - if ( is_callable( array( $this, $method ) ) ) { |
|
| 1992 | - return $this->$method( $context ); |
|
| 1993 | - } |
|
| 1952 | + } |
|
| 1953 | + |
|
| 1954 | + /** |
|
| 1955 | + * Retrieves the remote transaction url. |
|
| 1956 | + * |
|
| 1957 | + * @since 1.6.0 |
|
| 1958 | + * @return string |
|
| 1959 | + */ |
|
| 1960 | + public function get_transaction_url() { |
|
| 1961 | + return apply_filters( 'getpaid_gateway_' . $this->get_gateway() . '_transaction_url', '', $this ); |
|
| 1962 | + } |
|
| 1963 | + |
|
| 1964 | + /** |
|
| 1965 | + * Retrieves the default status. |
|
| 1966 | + * |
|
| 1967 | + * @since 1.0.19 |
|
| 1968 | + * @return string |
|
| 1969 | + */ |
|
| 1970 | + public function get_default_status() { |
|
| 1971 | + |
|
| 1972 | + $type = $this->get_type(); |
|
| 1973 | + $status = "wpi-$type-pending"; |
|
| 1974 | + return str_replace( '-invoice', '', $status ); |
|
| 1975 | + |
|
| 1976 | + } |
|
| 1977 | + |
|
| 1978 | + /** |
|
| 1979 | + * Magic method for accessing invoice properties. |
|
| 1980 | + * |
|
| 1981 | + * @since 1.0.15 |
|
| 1982 | + * @access public |
|
| 1983 | + * |
|
| 1984 | + * @param string $key Discount data to retrieve |
|
| 1985 | + * @param string $context View or edit context. |
|
| 1986 | + * @return mixed Value of the given invoice property (if set). |
|
| 1987 | + */ |
|
| 1988 | + public function get( $key, $context = 'view' ) { |
|
| 1989 | + $method = "get_$key"; |
|
| 1990 | + |
|
| 1991 | + if ( is_callable( array( $this, $method ) ) ) { |
|
| 1992 | + return $this->$method( $context ); |
|
| 1993 | + } |
|
| 1994 | 1994 | |
| 1995 | 1995 | return $this->get_prop( $key, $context ); |
| 1996 | - } |
|
| 1996 | + } |
|
| 1997 | 1997 | |
| 1998 | 1998 | /* |
| 1999 | 1999 | |-------------------------------------------------------------------------- |
@@ -2006,129 +2006,129 @@ discard block |
||
| 2006 | 2006 | */ |
| 2007 | 2007 | |
| 2008 | 2008 | /** |
| 2009 | - * Magic method for setting invoice properties. |
|
| 2010 | - * |
|
| 2011 | - * @since 1.0.19 |
|
| 2012 | - * @access public |
|
| 2013 | - * |
|
| 2014 | - * @param string $key Discount data to retrieve |
|
| 2015 | - * @param mixed $value new value. |
|
| 2016 | - * @return mixed Value of the given invoice property (if set). |
|
| 2017 | - */ |
|
| 2018 | - public function set( $key, $value ) { |
|
| 2009 | + * Magic method for setting invoice properties. |
|
| 2010 | + * |
|
| 2011 | + * @since 1.0.19 |
|
| 2012 | + * @access public |
|
| 2013 | + * |
|
| 2014 | + * @param string $key Discount data to retrieve |
|
| 2015 | + * @param mixed $value new value. |
|
| 2016 | + * @return mixed Value of the given invoice property (if set). |
|
| 2017 | + */ |
|
| 2018 | + public function set( $key, $value ) { |
|
| 2019 | 2019 | |
| 2020 | 2020 | $setter = "set_$key"; |
| 2021 | 2021 | if ( is_callable( array( $this, $setter ) ) ) { |
| 2022 | 2022 | $this->{$setter}( $value ); |
| 2023 | 2023 | } |
| 2024 | 2024 | |
| 2025 | - } |
|
| 2026 | - |
|
| 2027 | - /** |
|
| 2028 | - * Sets item status. |
|
| 2029 | - * |
|
| 2030 | - * @since 1.0.19 |
|
| 2031 | - * @param string $new_status New status. |
|
| 2032 | - * @param string $note Optional note to add. |
|
| 2033 | - * @param bool $manual_update Is this a manual status change?. |
|
| 2034 | - * @return array details of change. |
|
| 2035 | - */ |
|
| 2036 | - public function set_status( $new_status, $note = '', $manual_update = false ) { |
|
| 2037 | - $old_status = $this->get_status(); |
|
| 2038 | - |
|
| 2039 | - $statuses = $this->get_all_statuses(); |
|
| 2040 | - |
|
| 2041 | - if ( isset( $statuses['draft'] ) ) { |
|
| 2042 | - unset( $statuses['draft'] ); |
|
| 2043 | - } |
|
| 2044 | - |
|
| 2045 | - $this->set_prop( 'status', $new_status ); |
|
| 2046 | - |
|
| 2047 | - // If setting the status, ensure it's set to a valid status. |
|
| 2048 | - if ( true === $this->object_read ) { |
|
| 2049 | - |
|
| 2050 | - // Only allow valid new status. |
|
| 2051 | - if ( ! array_key_exists( $new_status, $statuses ) ) { |
|
| 2052 | - $new_status = $this->get_default_status(); |
|
| 2053 | - } |
|
| 2054 | - |
|
| 2055 | - // If the old status is set but unknown (e.g. draft) assume its pending for action usage. |
|
| 2056 | - if ( $old_status && ! array_key_exists( $new_status, $statuses ) ) { |
|
| 2057 | - $old_status = $this->get_default_status(); |
|
| 2058 | - } |
|
| 2059 | - |
|
| 2060 | - // Paid - Renewal (i.e when duplicating a parent invoice ) |
|
| 2061 | - if ( $new_status == 'wpi-pending' && $old_status == 'publish' && ! $this->get_id() ) { |
|
| 2062 | - $old_status = 'wpi-pending'; |
|
| 2063 | - } |
|
| 2064 | - |
|
| 2065 | - if ( $old_status !== $new_status ) { |
|
| 2066 | - $this->status_transition = array( |
|
| 2067 | - 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
| 2068 | - 'to' => $new_status, |
|
| 2069 | - 'note' => $note, |
|
| 2070 | - 'manual' => (bool) $manual_update, |
|
| 2071 | - ); |
|
| 2072 | - |
|
| 2073 | - if ( $manual_update ) { |
|
| 2074 | - do_action( 'getpaid_' . $this->object_type . '_edit_status', $this->get_id(), $new_status ); |
|
| 2075 | - } |
|
| 2076 | - |
|
| 2077 | - $this->maybe_set_date_paid(); |
|
| 2078 | - |
|
| 2079 | - } |
|
| 2080 | - } |
|
| 2081 | - |
|
| 2082 | - return array( |
|
| 2083 | - 'from' => $old_status, |
|
| 2084 | - 'to' => $new_status, |
|
| 2085 | - ); |
|
| 2086 | - } |
|
| 2087 | - |
|
| 2088 | - /** |
|
| 2089 | - * Maybe set date paid. |
|
| 2090 | - * |
|
| 2091 | - * Sets the date paid variable when transitioning to the payment complete |
|
| 2092 | - * order status. |
|
| 2093 | - * |
|
| 2094 | - * @since 1.0.19 |
|
| 2095 | - */ |
|
| 2096 | - public function maybe_set_date_paid() { |
|
| 2097 | - |
|
| 2098 | - if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) { |
|
| 2099 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
| 2100 | - } |
|
| 2101 | - } |
|
| 2102 | - |
|
| 2103 | - /** |
|
| 2104 | - * Set parent invoice ID. |
|
| 2105 | - * |
|
| 2106 | - * @since 1.0.19 |
|
| 2107 | - */ |
|
| 2108 | - public function set_parent_id( $value ) { |
|
| 2109 | - if ( $value && ( $value === $this->get_id() ) ) { |
|
| 2110 | - return; |
|
| 2111 | - } |
|
| 2112 | - $this->set_prop( 'parent_id', absint( $value ) ); |
|
| 2113 | - } |
|
| 2114 | - |
|
| 2115 | - /** |
|
| 2116 | - * Set plugin version when the invoice was created. |
|
| 2117 | - * |
|
| 2118 | - * @since 1.0.19 |
|
| 2119 | - */ |
|
| 2120 | - public function set_version( $value ) { |
|
| 2121 | - $this->set_prop( 'version', $value ); |
|
| 2122 | - } |
|
| 2123 | - |
|
| 2124 | - /** |
|
| 2125 | - * Set date when the invoice was created. |
|
| 2126 | - * |
|
| 2127 | - * @since 1.0.19 |
|
| 2128 | - * @param string $value Value to set. |
|
| 2025 | + } |
|
| 2026 | + |
|
| 2027 | + /** |
|
| 2028 | + * Sets item status. |
|
| 2029 | + * |
|
| 2030 | + * @since 1.0.19 |
|
| 2031 | + * @param string $new_status New status. |
|
| 2032 | + * @param string $note Optional note to add. |
|
| 2033 | + * @param bool $manual_update Is this a manual status change?. |
|
| 2034 | + * @return array details of change. |
|
| 2035 | + */ |
|
| 2036 | + public function set_status( $new_status, $note = '', $manual_update = false ) { |
|
| 2037 | + $old_status = $this->get_status(); |
|
| 2038 | + |
|
| 2039 | + $statuses = $this->get_all_statuses(); |
|
| 2040 | + |
|
| 2041 | + if ( isset( $statuses['draft'] ) ) { |
|
| 2042 | + unset( $statuses['draft'] ); |
|
| 2043 | + } |
|
| 2044 | + |
|
| 2045 | + $this->set_prop( 'status', $new_status ); |
|
| 2046 | + |
|
| 2047 | + // If setting the status, ensure it's set to a valid status. |
|
| 2048 | + if ( true === $this->object_read ) { |
|
| 2049 | + |
|
| 2050 | + // Only allow valid new status. |
|
| 2051 | + if ( ! array_key_exists( $new_status, $statuses ) ) { |
|
| 2052 | + $new_status = $this->get_default_status(); |
|
| 2053 | + } |
|
| 2054 | + |
|
| 2055 | + // If the old status is set but unknown (e.g. draft) assume its pending for action usage. |
|
| 2056 | + if ( $old_status && ! array_key_exists( $new_status, $statuses ) ) { |
|
| 2057 | + $old_status = $this->get_default_status(); |
|
| 2058 | + } |
|
| 2059 | + |
|
| 2060 | + // Paid - Renewal (i.e when duplicating a parent invoice ) |
|
| 2061 | + if ( $new_status == 'wpi-pending' && $old_status == 'publish' && ! $this->get_id() ) { |
|
| 2062 | + $old_status = 'wpi-pending'; |
|
| 2063 | + } |
|
| 2064 | + |
|
| 2065 | + if ( $old_status !== $new_status ) { |
|
| 2066 | + $this->status_transition = array( |
|
| 2067 | + 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
| 2068 | + 'to' => $new_status, |
|
| 2069 | + 'note' => $note, |
|
| 2070 | + 'manual' => (bool) $manual_update, |
|
| 2071 | + ); |
|
| 2072 | + |
|
| 2073 | + if ( $manual_update ) { |
|
| 2074 | + do_action( 'getpaid_' . $this->object_type . '_edit_status', $this->get_id(), $new_status ); |
|
| 2075 | + } |
|
| 2076 | + |
|
| 2077 | + $this->maybe_set_date_paid(); |
|
| 2078 | + |
|
| 2079 | + } |
|
| 2080 | + } |
|
| 2081 | + |
|
| 2082 | + return array( |
|
| 2083 | + 'from' => $old_status, |
|
| 2084 | + 'to' => $new_status, |
|
| 2085 | + ); |
|
| 2086 | + } |
|
| 2087 | + |
|
| 2088 | + /** |
|
| 2089 | + * Maybe set date paid. |
|
| 2090 | + * |
|
| 2091 | + * Sets the date paid variable when transitioning to the payment complete |
|
| 2092 | + * order status. |
|
| 2093 | + * |
|
| 2094 | + * @since 1.0.19 |
|
| 2095 | + */ |
|
| 2096 | + public function maybe_set_date_paid() { |
|
| 2097 | + |
|
| 2098 | + if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) { |
|
| 2099 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
| 2100 | + } |
|
| 2101 | + } |
|
| 2102 | + |
|
| 2103 | + /** |
|
| 2104 | + * Set parent invoice ID. |
|
| 2105 | + * |
|
| 2106 | + * @since 1.0.19 |
|
| 2107 | + */ |
|
| 2108 | + public function set_parent_id( $value ) { |
|
| 2109 | + if ( $value && ( $value === $this->get_id() ) ) { |
|
| 2110 | + return; |
|
| 2111 | + } |
|
| 2112 | + $this->set_prop( 'parent_id', absint( $value ) ); |
|
| 2113 | + } |
|
| 2114 | + |
|
| 2115 | + /** |
|
| 2116 | + * Set plugin version when the invoice was created. |
|
| 2117 | + * |
|
| 2118 | + * @since 1.0.19 |
|
| 2119 | + */ |
|
| 2120 | + public function set_version( $value ) { |
|
| 2121 | + $this->set_prop( 'version', $value ); |
|
| 2122 | + } |
|
| 2123 | + |
|
| 2124 | + /** |
|
| 2125 | + * Set date when the invoice was created. |
|
| 2126 | + * |
|
| 2127 | + * @since 1.0.19 |
|
| 2128 | + * @param string $value Value to set. |
|
| 2129 | 2129 | * @return bool Whether or not the date was set. |
| 2130 | - */ |
|
| 2131 | - public function set_date_created( $value ) { |
|
| 2130 | + */ |
|
| 2131 | + public function set_date_created( $value ) { |
|
| 2132 | 2132 | $date = strtotime( $value ); |
| 2133 | 2133 | |
| 2134 | 2134 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2136,19 +2136,19 @@ discard block |
||
| 2136 | 2136 | return true; |
| 2137 | 2137 | } |
| 2138 | 2138 | |
| 2139 | - $this->set_prop( 'date_created', '' ); |
|
| 2140 | - return false; |
|
| 2139 | + $this->set_prop( 'date_created', '' ); |
|
| 2140 | + return false; |
|
| 2141 | 2141 | |
| 2142 | 2142 | } |
| 2143 | 2143 | |
| 2144 | 2144 | /** |
| 2145 | - * Set date invoice due date. |
|
| 2146 | - * |
|
| 2147 | - * @since 1.0.19 |
|
| 2148 | - * @param string $value Value to set. |
|
| 2145 | + * Set date invoice due date. |
|
| 2146 | + * |
|
| 2147 | + * @since 1.0.19 |
|
| 2148 | + * @param string $value Value to set. |
|
| 2149 | 2149 | * @return bool Whether or not the date was set. |
| 2150 | - */ |
|
| 2151 | - public function set_due_date( $value ) { |
|
| 2150 | + */ |
|
| 2151 | + public function set_due_date( $value ) { |
|
| 2152 | 2152 | $date = strtotime( $value ); |
| 2153 | 2153 | |
| 2154 | 2154 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2156,29 +2156,29 @@ discard block |
||
| 2156 | 2156 | return true; |
| 2157 | 2157 | } |
| 2158 | 2158 | |
| 2159 | - $this->set_prop( 'due_date', '' ); |
|
| 2159 | + $this->set_prop( 'due_date', '' ); |
|
| 2160 | 2160 | return false; |
| 2161 | 2161 | |
| 2162 | 2162 | } |
| 2163 | 2163 | |
| 2164 | 2164 | /** |
| 2165 | - * Alias of self::set_due_date(). |
|
| 2166 | - * |
|
| 2167 | - * @since 1.0.19 |
|
| 2168 | - * @param string $value New name. |
|
| 2169 | - */ |
|
| 2170 | - public function set_date_due( $value ) { |
|
| 2171 | - $this->set_due_date( $value ); |
|
| 2165 | + * Alias of self::set_due_date(). |
|
| 2166 | + * |
|
| 2167 | + * @since 1.0.19 |
|
| 2168 | + * @param string $value New name. |
|
| 2169 | + */ |
|
| 2170 | + public function set_date_due( $value ) { |
|
| 2171 | + $this->set_due_date( $value ); |
|
| 2172 | 2172 | } |
| 2173 | 2173 | |
| 2174 | 2174 | /** |
| 2175 | - * Set date invoice was completed. |
|
| 2176 | - * |
|
| 2177 | - * @since 1.0.19 |
|
| 2178 | - * @param string $value Value to set. |
|
| 2175 | + * Set date invoice was completed. |
|
| 2176 | + * |
|
| 2177 | + * @since 1.0.19 |
|
| 2178 | + * @param string $value Value to set. |
|
| 2179 | 2179 | * @return bool Whether or not the date was set. |
| 2180 | - */ |
|
| 2181 | - public function set_completed_date( $value ) { |
|
| 2180 | + */ |
|
| 2181 | + public function set_completed_date( $value ) { |
|
| 2182 | 2182 | $date = strtotime( $value ); |
| 2183 | 2183 | |
| 2184 | 2184 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2186,29 +2186,29 @@ discard block |
||
| 2186 | 2186 | return true; |
| 2187 | 2187 | } |
| 2188 | 2188 | |
| 2189 | - $this->set_prop( 'completed_date', '' ); |
|
| 2189 | + $this->set_prop( 'completed_date', '' ); |
|
| 2190 | 2190 | return false; |
| 2191 | 2191 | |
| 2192 | 2192 | } |
| 2193 | 2193 | |
| 2194 | 2194 | /** |
| 2195 | - * Alias of self::set_completed_date(). |
|
| 2196 | - * |
|
| 2197 | - * @since 1.0.19 |
|
| 2198 | - * @param string $value New name. |
|
| 2199 | - */ |
|
| 2200 | - public function set_date_completed( $value ) { |
|
| 2201 | - $this->set_completed_date( $value ); |
|
| 2195 | + * Alias of self::set_completed_date(). |
|
| 2196 | + * |
|
| 2197 | + * @since 1.0.19 |
|
| 2198 | + * @param string $value New name. |
|
| 2199 | + */ |
|
| 2200 | + public function set_date_completed( $value ) { |
|
| 2201 | + $this->set_completed_date( $value ); |
|
| 2202 | 2202 | } |
| 2203 | 2203 | |
| 2204 | 2204 | /** |
| 2205 | - * Set date when the invoice was last modified. |
|
| 2206 | - * |
|
| 2207 | - * @since 1.0.19 |
|
| 2208 | - * @param string $value Value to set. |
|
| 2205 | + * Set date when the invoice was last modified. |
|
| 2206 | + * |
|
| 2207 | + * @since 1.0.19 |
|
| 2208 | + * @param string $value Value to set. |
|
| 2209 | 2209 | * @return bool Whether or not the date was set. |
| 2210 | - */ |
|
| 2211 | - public function set_date_modified( $value ) { |
|
| 2210 | + */ |
|
| 2211 | + public function set_date_modified( $value ) { |
|
| 2212 | 2212 | $date = strtotime( $value ); |
| 2213 | 2213 | |
| 2214 | 2214 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2216,813 +2216,813 @@ discard block |
||
| 2216 | 2216 | return true; |
| 2217 | 2217 | } |
| 2218 | 2218 | |
| 2219 | - $this->set_prop( 'date_modified', '' ); |
|
| 2219 | + $this->set_prop( 'date_modified', '' ); |
|
| 2220 | 2220 | return false; |
| 2221 | 2221 | |
| 2222 | 2222 | } |
| 2223 | 2223 | |
| 2224 | 2224 | /** |
| 2225 | - * Set the invoice number. |
|
| 2226 | - * |
|
| 2227 | - * @since 1.0.19 |
|
| 2228 | - * @param string $value New number. |
|
| 2229 | - */ |
|
| 2230 | - public function set_number( $value ) { |
|
| 2225 | + * Set the invoice number. |
|
| 2226 | + * |
|
| 2227 | + * @since 1.0.19 |
|
| 2228 | + * @param string $value New number. |
|
| 2229 | + */ |
|
| 2230 | + public function set_number( $value ) { |
|
| 2231 | 2231 | $number = sanitize_text_field( $value ); |
| 2232 | - $this->set_prop( 'number', $number ); |
|
| 2232 | + $this->set_prop( 'number', $number ); |
|
| 2233 | 2233 | } |
| 2234 | 2234 | |
| 2235 | 2235 | /** |
| 2236 | - * Set the invoice type. |
|
| 2237 | - * |
|
| 2238 | - * @since 1.0.19 |
|
| 2239 | - * @param string $value Type. |
|
| 2240 | - */ |
|
| 2241 | - public function set_type( $value ) { |
|
| 2236 | + * Set the invoice type. |
|
| 2237 | + * |
|
| 2238 | + * @since 1.0.19 |
|
| 2239 | + * @param string $value Type. |
|
| 2240 | + */ |
|
| 2241 | + public function set_type( $value ) { |
|
| 2242 | 2242 | $type = sanitize_text_field( str_replace( 'wpi_', '', $value ) ); |
| 2243 | - $this->set_prop( 'type', $type ); |
|
| 2244 | - } |
|
| 2243 | + $this->set_prop( 'type', $type ); |
|
| 2244 | + } |
|
| 2245 | 2245 | |
| 2246 | 2246 | /** |
| 2247 | - * Set the invoice post type. |
|
| 2248 | - * |
|
| 2249 | - * @since 1.0.19 |
|
| 2250 | - * @param string $value Post type. |
|
| 2251 | - */ |
|
| 2252 | - public function set_post_type( $value ) { |
|
| 2247 | + * Set the invoice post type. |
|
| 2248 | + * |
|
| 2249 | + * @since 1.0.19 |
|
| 2250 | + * @param string $value Post type. |
|
| 2251 | + */ |
|
| 2252 | + public function set_post_type( $value ) { |
|
| 2253 | 2253 | if ( getpaid_is_invoice_post_type( $value ) ) { |
| 2254 | - $this->set_type( $value ); |
|
| 2254 | + $this->set_type( $value ); |
|
| 2255 | 2255 | $this->set_prop( 'post_type', $value ); |
| 2256 | 2256 | } |
| 2257 | 2257 | } |
| 2258 | 2258 | |
| 2259 | 2259 | /** |
| 2260 | - * Set the invoice key. |
|
| 2261 | - * |
|
| 2262 | - * @since 1.0.19 |
|
| 2263 | - * @param string $value New key. |
|
| 2264 | - */ |
|
| 2265 | - public function set_key( $value ) { |
|
| 2260 | + * Set the invoice key. |
|
| 2261 | + * |
|
| 2262 | + * @since 1.0.19 |
|
| 2263 | + * @param string $value New key. |
|
| 2264 | + */ |
|
| 2265 | + public function set_key( $value ) { |
|
| 2266 | 2266 | $key = sanitize_text_field( $value ); |
| 2267 | - $this->set_prop( 'key', $key ); |
|
| 2267 | + $this->set_prop( 'key', $key ); |
|
| 2268 | 2268 | } |
| 2269 | 2269 | |
| 2270 | 2270 | /** |
| 2271 | - * Set the invoice mode. |
|
| 2272 | - * |
|
| 2273 | - * @since 1.0.19 |
|
| 2274 | - * @param string $value mode. |
|
| 2275 | - */ |
|
| 2276 | - public function set_mode( $value ) { |
|
| 2271 | + * Set the invoice mode. |
|
| 2272 | + * |
|
| 2273 | + * @since 1.0.19 |
|
| 2274 | + * @param string $value mode. |
|
| 2275 | + */ |
|
| 2276 | + public function set_mode( $value ) { |
|
| 2277 | 2277 | if ( in_array( $value, array( 'live', 'test' ) ) ) { |
| 2278 | 2278 | $this->set_prop( 'mode', $value ); |
| 2279 | 2279 | } |
| 2280 | 2280 | } |
| 2281 | 2281 | |
| 2282 | 2282 | /** |
| 2283 | - * Set the invoice path. |
|
| 2284 | - * |
|
| 2285 | - * @since 1.0.19 |
|
| 2286 | - * @param string $value path. |
|
| 2287 | - */ |
|
| 2288 | - public function set_path( $value ) { |
|
| 2283 | + * Set the invoice path. |
|
| 2284 | + * |
|
| 2285 | + * @since 1.0.19 |
|
| 2286 | + * @param string $value path. |
|
| 2287 | + */ |
|
| 2288 | + public function set_path( $value ) { |
|
| 2289 | 2289 | $this->set_prop( 'path', $value ); |
| 2290 | 2290 | } |
| 2291 | 2291 | |
| 2292 | 2292 | /** |
| 2293 | - * Set the invoice name. |
|
| 2294 | - * |
|
| 2295 | - * @since 1.0.19 |
|
| 2296 | - * @param string $value New name. |
|
| 2297 | - */ |
|
| 2298 | - public function set_name( $value ) { |
|
| 2293 | + * Set the invoice name. |
|
| 2294 | + * |
|
| 2295 | + * @since 1.0.19 |
|
| 2296 | + * @param string $value New name. |
|
| 2297 | + */ |
|
| 2298 | + public function set_name( $value ) { |
|
| 2299 | 2299 | $name = sanitize_text_field( $value ); |
| 2300 | - $this->set_prop( 'name', $name ); |
|
| 2300 | + $this->set_prop( 'name', $name ); |
|
| 2301 | 2301 | } |
| 2302 | 2302 | |
| 2303 | 2303 | /** |
| 2304 | - * Alias of self::set_name(). |
|
| 2305 | - * |
|
| 2306 | - * @since 1.0.19 |
|
| 2307 | - * @param string $value New name. |
|
| 2308 | - */ |
|
| 2309 | - public function set_title( $value ) { |
|
| 2310 | - $this->set_name( $value ); |
|
| 2304 | + * Alias of self::set_name(). |
|
| 2305 | + * |
|
| 2306 | + * @since 1.0.19 |
|
| 2307 | + * @param string $value New name. |
|
| 2308 | + */ |
|
| 2309 | + public function set_title( $value ) { |
|
| 2310 | + $this->set_name( $value ); |
|
| 2311 | 2311 | } |
| 2312 | 2312 | |
| 2313 | 2313 | /** |
| 2314 | - * Set the invoice description. |
|
| 2315 | - * |
|
| 2316 | - * @since 1.0.19 |
|
| 2317 | - * @param string $value New description. |
|
| 2318 | - */ |
|
| 2319 | - public function set_description( $value ) { |
|
| 2314 | + * Set the invoice description. |
|
| 2315 | + * |
|
| 2316 | + * @since 1.0.19 |
|
| 2317 | + * @param string $value New description. |
|
| 2318 | + */ |
|
| 2319 | + public function set_description( $value ) { |
|
| 2320 | 2320 | $description = wp_kses_post( $value ); |
| 2321 | - $this->set_prop( 'description', $description ); |
|
| 2321 | + $this->set_prop( 'description', $description ); |
|
| 2322 | + } |
|
| 2323 | + |
|
| 2324 | + /** |
|
| 2325 | + * Alias of self::set_description(). |
|
| 2326 | + * |
|
| 2327 | + * @since 1.0.19 |
|
| 2328 | + * @param string $value New description. |
|
| 2329 | + */ |
|
| 2330 | + public function set_excerpt( $value ) { |
|
| 2331 | + $this->set_description( $value ); |
|
| 2332 | + } |
|
| 2333 | + |
|
| 2334 | + /** |
|
| 2335 | + * Alias of self::set_description(). |
|
| 2336 | + * |
|
| 2337 | + * @since 1.0.19 |
|
| 2338 | + * @param string $value New description. |
|
| 2339 | + */ |
|
| 2340 | + public function set_summary( $value ) { |
|
| 2341 | + $this->set_description( $value ); |
|
| 2342 | + } |
|
| 2343 | + |
|
| 2344 | + /** |
|
| 2345 | + * Set the receiver of the invoice. |
|
| 2346 | + * |
|
| 2347 | + * @since 1.0.19 |
|
| 2348 | + * @param int $value New author. |
|
| 2349 | + */ |
|
| 2350 | + public function set_author( $value ) { |
|
| 2351 | + $user = get_user_by( 'id', (int) $value ); |
|
| 2352 | + |
|
| 2353 | + if ( $user && $user->ID ) { |
|
| 2354 | + $this->set_prop( 'author', $user->ID ); |
|
| 2355 | + $this->set_prop( 'email', $user->user_email ); |
|
| 2356 | + } |
|
| 2357 | + |
|
| 2358 | + } |
|
| 2359 | + |
|
| 2360 | + /** |
|
| 2361 | + * Alias of self::set_author(). |
|
| 2362 | + * |
|
| 2363 | + * @since 1.0.19 |
|
| 2364 | + * @param int $value New user id. |
|
| 2365 | + */ |
|
| 2366 | + public function set_user_id( $value ) { |
|
| 2367 | + $this->set_author( $value ); |
|
| 2368 | + } |
|
| 2369 | + |
|
| 2370 | + /** |
|
| 2371 | + * Sets the customer ID. |
|
| 2372 | + * |
|
| 2373 | + * @since 1.0.19 |
|
| 2374 | + * @param int $value New user id. |
|
| 2375 | + */ |
|
| 2376 | + public function set_customer_id( $value ) { |
|
| 2377 | + $this->set_prop( 'customer_id', (int) $value ); |
|
| 2378 | + } |
|
| 2379 | + |
|
| 2380 | + /** |
|
| 2381 | + * Set the customer's ip. |
|
| 2382 | + * |
|
| 2383 | + * @since 1.0.19 |
|
| 2384 | + * @param string $value ip address. |
|
| 2385 | + */ |
|
| 2386 | + public function set_ip( $value ) { |
|
| 2387 | + $this->set_prop( 'ip', $value ); |
|
| 2388 | + } |
|
| 2389 | + |
|
| 2390 | + /** |
|
| 2391 | + * Alias of self::set_ip(). |
|
| 2392 | + * |
|
| 2393 | + * @since 1.0.19 |
|
| 2394 | + * @param string $value ip address. |
|
| 2395 | + */ |
|
| 2396 | + public function set_user_ip( $value ) { |
|
| 2397 | + $this->set_ip( $value ); |
|
| 2398 | + } |
|
| 2399 | + |
|
| 2400 | + /** |
|
| 2401 | + * Set the customer's first name. |
|
| 2402 | + * |
|
| 2403 | + * @since 1.0.19 |
|
| 2404 | + * @param string $value first name. |
|
| 2405 | + */ |
|
| 2406 | + public function set_first_name( $value ) { |
|
| 2407 | + $this->set_prop( 'first_name', $value ); |
|
| 2408 | + } |
|
| 2409 | + |
|
| 2410 | + /** |
|
| 2411 | + * Alias of self::set_first_name(). |
|
| 2412 | + * |
|
| 2413 | + * @since 1.0.19 |
|
| 2414 | + * @param string $value first name. |
|
| 2415 | + */ |
|
| 2416 | + public function set_user_first_name( $value ) { |
|
| 2417 | + $this->set_first_name( $value ); |
|
| 2418 | + } |
|
| 2419 | + |
|
| 2420 | + /** |
|
| 2421 | + * Alias of self::set_first_name(). |
|
| 2422 | + * |
|
| 2423 | + * @since 1.0.19 |
|
| 2424 | + * @param string $value first name. |
|
| 2425 | + */ |
|
| 2426 | + public function set_customer_first_name( $value ) { |
|
| 2427 | + $this->set_first_name( $value ); |
|
| 2428 | + } |
|
| 2429 | + |
|
| 2430 | + /** |
|
| 2431 | + * Set the customer's last name. |
|
| 2432 | + * |
|
| 2433 | + * @since 1.0.19 |
|
| 2434 | + * @param string $value last name. |
|
| 2435 | + */ |
|
| 2436 | + public function set_last_name( $value ) { |
|
| 2437 | + $this->set_prop( 'last_name', $value ); |
|
| 2438 | + } |
|
| 2439 | + |
|
| 2440 | + /** |
|
| 2441 | + * Alias of self::set_last_name(). |
|
| 2442 | + * |
|
| 2443 | + * @since 1.0.19 |
|
| 2444 | + * @param string $value last name. |
|
| 2445 | + */ |
|
| 2446 | + public function set_user_last_name( $value ) { |
|
| 2447 | + $this->set_last_name( $value ); |
|
| 2448 | + } |
|
| 2449 | + |
|
| 2450 | + /** |
|
| 2451 | + * Alias of self::set_last_name(). |
|
| 2452 | + * |
|
| 2453 | + * @since 1.0.19 |
|
| 2454 | + * @param string $value last name. |
|
| 2455 | + */ |
|
| 2456 | + public function set_customer_last_name( $value ) { |
|
| 2457 | + $this->set_last_name( $value ); |
|
| 2458 | + } |
|
| 2459 | + |
|
| 2460 | + /** |
|
| 2461 | + * Set the customer's phone number. |
|
| 2462 | + * |
|
| 2463 | + * @since 1.0.19 |
|
| 2464 | + * @param string $value phone. |
|
| 2465 | + */ |
|
| 2466 | + public function set_phone( $value ) { |
|
| 2467 | + $this->set_prop( 'phone', $value ); |
|
| 2322 | 2468 | } |
| 2323 | 2469 | |
| 2324 | 2470 | /** |
| 2325 | - * Alias of self::set_description(). |
|
| 2326 | - * |
|
| 2327 | - * @since 1.0.19 |
|
| 2328 | - * @param string $value New description. |
|
| 2329 | - */ |
|
| 2330 | - public function set_excerpt( $value ) { |
|
| 2331 | - $this->set_description( $value ); |
|
| 2471 | + * Alias of self::set_phone(). |
|
| 2472 | + * |
|
| 2473 | + * @since 1.0.19 |
|
| 2474 | + * @param string $value phone. |
|
| 2475 | + */ |
|
| 2476 | + public function set_user_phone( $value ) { |
|
| 2477 | + $this->set_phone( $value ); |
|
| 2332 | 2478 | } |
| 2333 | 2479 | |
| 2334 | 2480 | /** |
| 2335 | - * Alias of self::set_description(). |
|
| 2336 | - * |
|
| 2337 | - * @since 1.0.19 |
|
| 2338 | - * @param string $value New description. |
|
| 2339 | - */ |
|
| 2340 | - public function set_summary( $value ) { |
|
| 2341 | - $this->set_description( $value ); |
|
| 2481 | + * Alias of self::set_phone(). |
|
| 2482 | + * |
|
| 2483 | + * @since 1.0.19 |
|
| 2484 | + * @param string $value phone. |
|
| 2485 | + */ |
|
| 2486 | + public function set_customer_phone( $value ) { |
|
| 2487 | + $this->set_phone( $value ); |
|
| 2342 | 2488 | } |
| 2343 | 2489 | |
| 2344 | 2490 | /** |
| 2345 | - * Set the receiver of the invoice. |
|
| 2346 | - * |
|
| 2347 | - * @since 1.0.19 |
|
| 2348 | - * @param int $value New author. |
|
| 2349 | - */ |
|
| 2350 | - public function set_author( $value ) { |
|
| 2351 | - $user = get_user_by( 'id', (int) $value ); |
|
| 2491 | + * Alias of self::set_phone(). |
|
| 2492 | + * |
|
| 2493 | + * @since 1.0.19 |
|
| 2494 | + * @param string $value phone. |
|
| 2495 | + */ |
|
| 2496 | + public function set_phone_number( $value ) { |
|
| 2497 | + $this->set_phone( $value ); |
|
| 2498 | + } |
|
| 2352 | 2499 | |
| 2353 | - if ( $user && $user->ID ) { |
|
| 2354 | - $this->set_prop( 'author', $user->ID ); |
|
| 2355 | - $this->set_prop( 'email', $user->user_email ); |
|
| 2356 | - } |
|
| 2500 | + /** |
|
| 2501 | + * Set the customer's email address. |
|
| 2502 | + * |
|
| 2503 | + * @since 1.0.19 |
|
| 2504 | + * @param string $value email address. |
|
| 2505 | + */ |
|
| 2506 | + public function set_email( $value ) { |
|
| 2507 | + $this->set_prop( 'email', $value ); |
|
| 2508 | + } |
|
| 2357 | 2509 | |
| 2510 | + /** |
|
| 2511 | + * Alias of self::set_email(). |
|
| 2512 | + * |
|
| 2513 | + * @since 1.0.19 |
|
| 2514 | + * @param string $value email address. |
|
| 2515 | + */ |
|
| 2516 | + public function set_user_email( $value ) { |
|
| 2517 | + $this->set_email( $value ); |
|
| 2358 | 2518 | } |
| 2359 | 2519 | |
| 2360 | 2520 | /** |
| 2361 | - * Alias of self::set_author(). |
|
| 2362 | - * |
|
| 2363 | - * @since 1.0.19 |
|
| 2364 | - * @param int $value New user id. |
|
| 2365 | - */ |
|
| 2366 | - public function set_user_id( $value ) { |
|
| 2367 | - $this->set_author( $value ); |
|
| 2521 | + * Alias of self::set_email(). |
|
| 2522 | + * |
|
| 2523 | + * @since 1.0.19 |
|
| 2524 | + * @param string $value email address. |
|
| 2525 | + */ |
|
| 2526 | + public function set_email_address( $value ) { |
|
| 2527 | + $this->set_email( $value ); |
|
| 2368 | 2528 | } |
| 2369 | 2529 | |
| 2370 | 2530 | /** |
| 2371 | - * Sets the customer ID. |
|
| 2372 | - * |
|
| 2373 | - * @since 1.0.19 |
|
| 2374 | - * @param int $value New user id. |
|
| 2375 | - */ |
|
| 2376 | - public function set_customer_id( $value ) { |
|
| 2377 | - $this->set_prop( 'customer_id', (int) $value ); |
|
| 2531 | + * Alias of self::set_email(). |
|
| 2532 | + * |
|
| 2533 | + * @since 1.0.19 |
|
| 2534 | + * @param string $value email address. |
|
| 2535 | + */ |
|
| 2536 | + public function set_customer_email( $value ) { |
|
| 2537 | + $this->set_email( $value ); |
|
| 2378 | 2538 | } |
| 2379 | 2539 | |
| 2380 | 2540 | /** |
| 2381 | - * Set the customer's ip. |
|
| 2382 | - * |
|
| 2383 | - * @since 1.0.19 |
|
| 2384 | - * @param string $value ip address. |
|
| 2385 | - */ |
|
| 2386 | - public function set_ip( $value ) { |
|
| 2387 | - $this->set_prop( 'ip', $value ); |
|
| 2541 | + * Set the customer's country. |
|
| 2542 | + * |
|
| 2543 | + * @since 1.0.19 |
|
| 2544 | + * @param string $value country. |
|
| 2545 | + */ |
|
| 2546 | + public function set_country( $value ) { |
|
| 2547 | + $this->set_prop( 'country', $value ); |
|
| 2388 | 2548 | } |
| 2389 | 2549 | |
| 2390 | 2550 | /** |
| 2391 | - * Alias of self::set_ip(). |
|
| 2392 | - * |
|
| 2393 | - * @since 1.0.19 |
|
| 2394 | - * @param string $value ip address. |
|
| 2395 | - */ |
|
| 2396 | - public function set_user_ip( $value ) { |
|
| 2397 | - $this->set_ip( $value ); |
|
| 2551 | + * Alias of self::set_country(). |
|
| 2552 | + * |
|
| 2553 | + * @since 1.0.19 |
|
| 2554 | + * @param string $value country. |
|
| 2555 | + */ |
|
| 2556 | + public function set_user_country( $value ) { |
|
| 2557 | + $this->set_country( $value ); |
|
| 2398 | 2558 | } |
| 2399 | 2559 | |
| 2400 | 2560 | /** |
| 2401 | - * Set the customer's first name. |
|
| 2402 | - * |
|
| 2403 | - * @since 1.0.19 |
|
| 2404 | - * @param string $value first name. |
|
| 2405 | - */ |
|
| 2406 | - public function set_first_name( $value ) { |
|
| 2407 | - $this->set_prop( 'first_name', $value ); |
|
| 2561 | + * Alias of self::set_country(). |
|
| 2562 | + * |
|
| 2563 | + * @since 1.0.19 |
|
| 2564 | + * @param string $value country. |
|
| 2565 | + */ |
|
| 2566 | + public function set_customer_country( $value ) { |
|
| 2567 | + $this->set_country( $value ); |
|
| 2408 | 2568 | } |
| 2409 | 2569 | |
| 2410 | 2570 | /** |
| 2411 | - * Alias of self::set_first_name(). |
|
| 2412 | - * |
|
| 2413 | - * @since 1.0.19 |
|
| 2414 | - * @param string $value first name. |
|
| 2415 | - */ |
|
| 2416 | - public function set_user_first_name( $value ) { |
|
| 2417 | - $this->set_first_name( $value ); |
|
| 2571 | + * Set the customer's state. |
|
| 2572 | + * |
|
| 2573 | + * @since 1.0.19 |
|
| 2574 | + * @param string $value state. |
|
| 2575 | + */ |
|
| 2576 | + public function set_state( $value ) { |
|
| 2577 | + $this->set_prop( 'state', $value ); |
|
| 2418 | 2578 | } |
| 2419 | 2579 | |
| 2420 | 2580 | /** |
| 2421 | - * Alias of self::set_first_name(). |
|
| 2422 | - * |
|
| 2423 | - * @since 1.0.19 |
|
| 2424 | - * @param string $value first name. |
|
| 2425 | - */ |
|
| 2426 | - public function set_customer_first_name( $value ) { |
|
| 2427 | - $this->set_first_name( $value ); |
|
| 2581 | + * Alias of self::set_state(). |
|
| 2582 | + * |
|
| 2583 | + * @since 1.0.19 |
|
| 2584 | + * @param string $value state. |
|
| 2585 | + */ |
|
| 2586 | + public function set_user_state( $value ) { |
|
| 2587 | + $this->set_state( $value ); |
|
| 2428 | 2588 | } |
| 2429 | 2589 | |
| 2430 | 2590 | /** |
| 2431 | - * Set the customer's last name. |
|
| 2432 | - * |
|
| 2433 | - * @since 1.0.19 |
|
| 2434 | - * @param string $value last name. |
|
| 2435 | - */ |
|
| 2436 | - public function set_last_name( $value ) { |
|
| 2437 | - $this->set_prop( 'last_name', $value ); |
|
| 2591 | + * Alias of self::set_state(). |
|
| 2592 | + * |
|
| 2593 | + * @since 1.0.19 |
|
| 2594 | + * @param string $value state. |
|
| 2595 | + */ |
|
| 2596 | + public function set_customer_state( $value ) { |
|
| 2597 | + $this->set_state( $value ); |
|
| 2438 | 2598 | } |
| 2439 | 2599 | |
| 2440 | 2600 | /** |
| 2441 | - * Alias of self::set_last_name(). |
|
| 2442 | - * |
|
| 2443 | - * @since 1.0.19 |
|
| 2444 | - * @param string $value last name. |
|
| 2445 | - */ |
|
| 2446 | - public function set_user_last_name( $value ) { |
|
| 2447 | - $this->set_last_name( $value ); |
|
| 2601 | + * Set the customer's city. |
|
| 2602 | + * |
|
| 2603 | + * @since 1.0.19 |
|
| 2604 | + * @param string $value city. |
|
| 2605 | + */ |
|
| 2606 | + public function set_city( $value ) { |
|
| 2607 | + $this->set_prop( 'city', $value ); |
|
| 2448 | 2608 | } |
| 2449 | 2609 | |
| 2450 | 2610 | /** |
| 2451 | - * Alias of self::set_last_name(). |
|
| 2452 | - * |
|
| 2453 | - * @since 1.0.19 |
|
| 2454 | - * @param string $value last name. |
|
| 2455 | - */ |
|
| 2456 | - public function set_customer_last_name( $value ) { |
|
| 2457 | - $this->set_last_name( $value ); |
|
| 2611 | + * Alias of self::set_city(). |
|
| 2612 | + * |
|
| 2613 | + * @since 1.0.19 |
|
| 2614 | + * @param string $value city. |
|
| 2615 | + */ |
|
| 2616 | + public function set_user_city( $value ) { |
|
| 2617 | + $this->set_city( $value ); |
|
| 2458 | 2618 | } |
| 2459 | 2619 | |
| 2460 | 2620 | /** |
| 2461 | - * Set the customer's phone number. |
|
| 2462 | - * |
|
| 2463 | - * @since 1.0.19 |
|
| 2464 | - * @param string $value phone. |
|
| 2465 | - */ |
|
| 2466 | - public function set_phone( $value ) { |
|
| 2467 | - $this->set_prop( 'phone', $value ); |
|
| 2621 | + * Alias of self::set_city(). |
|
| 2622 | + * |
|
| 2623 | + * @since 1.0.19 |
|
| 2624 | + * @param string $value city. |
|
| 2625 | + */ |
|
| 2626 | + public function set_customer_city( $value ) { |
|
| 2627 | + $this->set_city( $value ); |
|
| 2468 | 2628 | } |
| 2469 | 2629 | |
| 2470 | 2630 | /** |
| 2471 | - * Alias of self::set_phone(). |
|
| 2472 | - * |
|
| 2473 | - * @since 1.0.19 |
|
| 2474 | - * @param string $value phone. |
|
| 2475 | - */ |
|
| 2476 | - public function set_user_phone( $value ) { |
|
| 2477 | - $this->set_phone( $value ); |
|
| 2631 | + * Set the customer's zip code. |
|
| 2632 | + * |
|
| 2633 | + * @since 1.0.19 |
|
| 2634 | + * @param string $value zip. |
|
| 2635 | + */ |
|
| 2636 | + public function set_zip( $value ) { |
|
| 2637 | + $this->set_prop( 'zip', $value ); |
|
| 2478 | 2638 | } |
| 2479 | 2639 | |
| 2480 | 2640 | /** |
| 2481 | - * Alias of self::set_phone(). |
|
| 2482 | - * |
|
| 2483 | - * @since 1.0.19 |
|
| 2484 | - * @param string $value phone. |
|
| 2485 | - */ |
|
| 2486 | - public function set_customer_phone( $value ) { |
|
| 2487 | - $this->set_phone( $value ); |
|
| 2641 | + * Alias of self::set_zip(). |
|
| 2642 | + * |
|
| 2643 | + * @since 1.0.19 |
|
| 2644 | + * @param string $value zip. |
|
| 2645 | + */ |
|
| 2646 | + public function set_user_zip( $value ) { |
|
| 2647 | + $this->set_zip( $value ); |
|
| 2488 | 2648 | } |
| 2489 | 2649 | |
| 2490 | 2650 | /** |
| 2491 | - * Alias of self::set_phone(). |
|
| 2492 | - * |
|
| 2493 | - * @since 1.0.19 |
|
| 2494 | - * @param string $value phone. |
|
| 2495 | - */ |
|
| 2496 | - public function set_phone_number( $value ) { |
|
| 2497 | - $this->set_phone( $value ); |
|
| 2651 | + * Alias of self::set_zip(). |
|
| 2652 | + * |
|
| 2653 | + * @since 1.0.19 |
|
| 2654 | + * @param string $value zip. |
|
| 2655 | + */ |
|
| 2656 | + public function set_customer_zip( $value ) { |
|
| 2657 | + $this->set_zip( $value ); |
|
| 2498 | 2658 | } |
| 2499 | 2659 | |
| 2500 | 2660 | /** |
| 2501 | - * Set the customer's email address. |
|
| 2502 | - * |
|
| 2503 | - * @since 1.0.19 |
|
| 2504 | - * @param string $value email address. |
|
| 2505 | - */ |
|
| 2506 | - public function set_email( $value ) { |
|
| 2507 | - $this->set_prop( 'email', $value ); |
|
| 2661 | + * Set the customer's company. |
|
| 2662 | + * |
|
| 2663 | + * @since 1.0.19 |
|
| 2664 | + * @param string $value company. |
|
| 2665 | + */ |
|
| 2666 | + public function set_company( $value ) { |
|
| 2667 | + $this->set_prop( 'company', $value ); |
|
| 2508 | 2668 | } |
| 2509 | 2669 | |
| 2510 | 2670 | /** |
| 2511 | - * Alias of self::set_email(). |
|
| 2512 | - * |
|
| 2513 | - * @since 1.0.19 |
|
| 2514 | - * @param string $value email address. |
|
| 2515 | - */ |
|
| 2516 | - public function set_user_email( $value ) { |
|
| 2517 | - $this->set_email( $value ); |
|
| 2671 | + * Alias of self::set_company(). |
|
| 2672 | + * |
|
| 2673 | + * @since 1.0.19 |
|
| 2674 | + * @param string $value company. |
|
| 2675 | + */ |
|
| 2676 | + public function set_user_company( $value ) { |
|
| 2677 | + $this->set_company( $value ); |
|
| 2518 | 2678 | } |
| 2519 | 2679 | |
| 2520 | 2680 | /** |
| 2521 | - * Alias of self::set_email(). |
|
| 2522 | - * |
|
| 2523 | - * @since 1.0.19 |
|
| 2524 | - * @param string $value email address. |
|
| 2525 | - */ |
|
| 2526 | - public function set_email_address( $value ) { |
|
| 2527 | - $this->set_email( $value ); |
|
| 2681 | + * Alias of self::set_company(). |
|
| 2682 | + * |
|
| 2683 | + * @since 1.0.19 |
|
| 2684 | + * @param string $value company. |
|
| 2685 | + */ |
|
| 2686 | + public function set_customer_company( $value ) { |
|
| 2687 | + $this->set_company( $value ); |
|
| 2528 | 2688 | } |
| 2529 | 2689 | |
| 2530 | 2690 | /** |
| 2531 | - * Alias of self::set_email(). |
|
| 2532 | - * |
|
| 2533 | - * @since 1.0.19 |
|
| 2534 | - * @param string $value email address. |
|
| 2535 | - */ |
|
| 2536 | - public function set_customer_email( $value ) { |
|
| 2537 | - $this->set_email( $value ); |
|
| 2691 | + * Set the customer's company id. |
|
| 2692 | + * |
|
| 2693 | + * @since 1.0.19 |
|
| 2694 | + * @param string $value company id. |
|
| 2695 | + */ |
|
| 2696 | + public function set_company_id( $value ) { |
|
| 2697 | + $this->set_prop( 'company_id', $value ); |
|
| 2538 | 2698 | } |
| 2539 | 2699 | |
| 2540 | 2700 | /** |
| 2541 | - * Set the customer's country. |
|
| 2542 | - * |
|
| 2543 | - * @since 1.0.19 |
|
| 2544 | - * @param string $value country. |
|
| 2545 | - */ |
|
| 2546 | - public function set_country( $value ) { |
|
| 2547 | - $this->set_prop( 'country', $value ); |
|
| 2701 | + * Set the customer's var number. |
|
| 2702 | + * |
|
| 2703 | + * @since 1.0.19 |
|
| 2704 | + * @param string $value var number. |
|
| 2705 | + */ |
|
| 2706 | + public function set_vat_number( $value ) { |
|
| 2707 | + $this->set_prop( 'vat_number', $value ); |
|
| 2548 | 2708 | } |
| 2549 | 2709 | |
| 2550 | 2710 | /** |
| 2551 | - * Alias of self::set_country(). |
|
| 2552 | - * |
|
| 2553 | - * @since 1.0.19 |
|
| 2554 | - * @param string $value country. |
|
| 2555 | - */ |
|
| 2556 | - public function set_user_country( $value ) { |
|
| 2557 | - $this->set_country( $value ); |
|
| 2711 | + * Alias of self::set_vat_number(). |
|
| 2712 | + * |
|
| 2713 | + * @since 1.0.19 |
|
| 2714 | + * @param string $value var number. |
|
| 2715 | + */ |
|
| 2716 | + public function set_user_vat_number( $value ) { |
|
| 2717 | + $this->set_vat_number( $value ); |
|
| 2558 | 2718 | } |
| 2559 | 2719 | |
| 2560 | 2720 | /** |
| 2561 | - * Alias of self::set_country(). |
|
| 2562 | - * |
|
| 2563 | - * @since 1.0.19 |
|
| 2564 | - * @param string $value country. |
|
| 2565 | - */ |
|
| 2566 | - public function set_customer_country( $value ) { |
|
| 2567 | - $this->set_country( $value ); |
|
| 2721 | + * Alias of self::set_vat_number(). |
|
| 2722 | + * |
|
| 2723 | + * @since 1.0.19 |
|
| 2724 | + * @param string $value var number. |
|
| 2725 | + */ |
|
| 2726 | + public function set_customer_vat_number( $value ) { |
|
| 2727 | + $this->set_vat_number( $value ); |
|
| 2568 | 2728 | } |
| 2569 | 2729 | |
| 2570 | 2730 | /** |
| 2571 | - * Set the customer's state. |
|
| 2572 | - * |
|
| 2573 | - * @since 1.0.19 |
|
| 2574 | - * @param string $value state. |
|
| 2575 | - */ |
|
| 2576 | - public function set_state( $value ) { |
|
| 2577 | - $this->set_prop( 'state', $value ); |
|
| 2731 | + * Set the customer's vat rate. |
|
| 2732 | + * |
|
| 2733 | + * @since 1.0.19 |
|
| 2734 | + * @param string $value var rate. |
|
| 2735 | + */ |
|
| 2736 | + public function set_vat_rate( $value ) { |
|
| 2737 | + $this->set_prop( 'vat_rate', $value ); |
|
| 2578 | 2738 | } |
| 2579 | 2739 | |
| 2580 | 2740 | /** |
| 2581 | - * Alias of self::set_state(). |
|
| 2582 | - * |
|
| 2583 | - * @since 1.0.19 |
|
| 2584 | - * @param string $value state. |
|
| 2585 | - */ |
|
| 2586 | - public function set_user_state( $value ) { |
|
| 2587 | - $this->set_state( $value ); |
|
| 2741 | + * Alias of self::set_vat_rate(). |
|
| 2742 | + * |
|
| 2743 | + * @since 1.0.19 |
|
| 2744 | + * @param string $value var number. |
|
| 2745 | + */ |
|
| 2746 | + public function set_user_vat_rate( $value ) { |
|
| 2747 | + $this->set_vat_rate( $value ); |
|
| 2588 | 2748 | } |
| 2589 | 2749 | |
| 2590 | 2750 | /** |
| 2591 | - * Alias of self::set_state(). |
|
| 2592 | - * |
|
| 2593 | - * @since 1.0.19 |
|
| 2594 | - * @param string $value state. |
|
| 2595 | - */ |
|
| 2596 | - public function set_customer_state( $value ) { |
|
| 2597 | - $this->set_state( $value ); |
|
| 2751 | + * Alias of self::set_vat_rate(). |
|
| 2752 | + * |
|
| 2753 | + * @since 1.0.19 |
|
| 2754 | + * @param string $value var number. |
|
| 2755 | + */ |
|
| 2756 | + public function set_customer_vat_rate( $value ) { |
|
| 2757 | + $this->set_vat_rate( $value ); |
|
| 2598 | 2758 | } |
| 2599 | 2759 | |
| 2600 | 2760 | /** |
| 2601 | - * Set the customer's city. |
|
| 2602 | - * |
|
| 2603 | - * @since 1.0.19 |
|
| 2604 | - * @param string $value city. |
|
| 2605 | - */ |
|
| 2606 | - public function set_city( $value ) { |
|
| 2607 | - $this->set_prop( 'city', $value ); |
|
| 2761 | + * Set the customer's address. |
|
| 2762 | + * |
|
| 2763 | + * @since 1.0.19 |
|
| 2764 | + * @param string $value address. |
|
| 2765 | + */ |
|
| 2766 | + public function set_address( $value ) { |
|
| 2767 | + $this->set_prop( 'address', $value ); |
|
| 2608 | 2768 | } |
| 2609 | 2769 | |
| 2610 | 2770 | /** |
| 2611 | - * Alias of self::set_city(). |
|
| 2612 | - * |
|
| 2613 | - * @since 1.0.19 |
|
| 2614 | - * @param string $value city. |
|
| 2615 | - */ |
|
| 2616 | - public function set_user_city( $value ) { |
|
| 2617 | - $this->set_city( $value ); |
|
| 2771 | + * Alias of self::set_address(). |
|
| 2772 | + * |
|
| 2773 | + * @since 1.0.19 |
|
| 2774 | + * @param string $value address. |
|
| 2775 | + */ |
|
| 2776 | + public function set_user_address( $value ) { |
|
| 2777 | + $this->set_address( $value ); |
|
| 2618 | 2778 | } |
| 2619 | 2779 | |
| 2620 | 2780 | /** |
| 2621 | - * Alias of self::set_city(). |
|
| 2622 | - * |
|
| 2623 | - * @since 1.0.19 |
|
| 2624 | - * @param string $value city. |
|
| 2625 | - */ |
|
| 2626 | - public function set_customer_city( $value ) { |
|
| 2627 | - $this->set_city( $value ); |
|
| 2781 | + * Alias of self::set_address(). |
|
| 2782 | + * |
|
| 2783 | + * @since 1.0.19 |
|
| 2784 | + * @param string $value address. |
|
| 2785 | + */ |
|
| 2786 | + public function set_customer_address( $value ) { |
|
| 2787 | + $this->set_address( $value ); |
|
| 2628 | 2788 | } |
| 2629 | 2789 | |
| 2630 | 2790 | /** |
| 2631 | - * Set the customer's zip code. |
|
| 2632 | - * |
|
| 2633 | - * @since 1.0.19 |
|
| 2634 | - * @param string $value zip. |
|
| 2635 | - */ |
|
| 2636 | - public function set_zip( $value ) { |
|
| 2637 | - $this->set_prop( 'zip', $value ); |
|
| 2791 | + * Set whether the customer has viewed the invoice or not. |
|
| 2792 | + * |
|
| 2793 | + * @since 1.0.19 |
|
| 2794 | + * @param int|bool $value confirmed. |
|
| 2795 | + */ |
|
| 2796 | + public function set_is_viewed( $value ) { |
|
| 2797 | + $this->set_prop( 'is_viewed', $value ); |
|
| 2638 | 2798 | } |
| 2639 | 2799 | |
| 2640 | 2800 | /** |
| 2641 | - * Alias of self::set_zip(). |
|
| 2642 | - * |
|
| 2643 | - * @since 1.0.19 |
|
| 2644 | - * @param string $value zip. |
|
| 2645 | - */ |
|
| 2646 | - public function set_user_zip( $value ) { |
|
| 2647 | - $this->set_zip( $value ); |
|
| 2801 | + * Set extra email recipients. |
|
| 2802 | + * |
|
| 2803 | + * @since 1.0.19 |
|
| 2804 | + * @param string $value email recipients. |
|
| 2805 | + */ |
|
| 2806 | + public function set_email_cc( $value ) { |
|
| 2807 | + $this->set_prop( 'email_cc', $value ); |
|
| 2648 | 2808 | } |
| 2649 | 2809 | |
| 2650 | 2810 | /** |
| 2651 | - * Alias of self::set_zip(). |
|
| 2652 | - * |
|
| 2653 | - * @since 1.0.19 |
|
| 2654 | - * @param string $value zip. |
|
| 2655 | - */ |
|
| 2656 | - public function set_customer_zip( $value ) { |
|
| 2657 | - $this->set_zip( $value ); |
|
| 2811 | + * Set the invoice template. |
|
| 2812 | + * |
|
| 2813 | + * @since 1.0.19 |
|
| 2814 | + * @param string $value template. |
|
| 2815 | + */ |
|
| 2816 | + public function set_template( $value ) { |
|
| 2817 | + if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) { |
|
| 2818 | + $this->set_prop( 'template', $value ); |
|
| 2819 | + } |
|
| 2658 | 2820 | } |
| 2659 | 2821 | |
| 2660 | 2822 | /** |
| 2661 | - * Set the customer's company. |
|
| 2662 | - * |
|
| 2663 | - * @since 1.0.19 |
|
| 2664 | - * @param string $value company. |
|
| 2665 | - */ |
|
| 2666 | - public function set_company( $value ) { |
|
| 2667 | - $this->set_prop( 'company', $value ); |
|
| 2823 | + * Set the invoice source. |
|
| 2824 | + * |
|
| 2825 | + * @since 1.0.19 |
|
| 2826 | + * @param string $value source. |
|
| 2827 | + * @deprecated |
|
| 2828 | + */ |
|
| 2829 | + public function created_via( $value ) { |
|
| 2830 | + $this->set_created_via( sanitize_text_field( $value ) ); |
|
| 2668 | 2831 | } |
| 2669 | 2832 | |
| 2670 | 2833 | /** |
| 2671 | - * Alias of self::set_company(). |
|
| 2672 | - * |
|
| 2673 | - * @since 1.0.19 |
|
| 2674 | - * @param string $value company. |
|
| 2675 | - */ |
|
| 2676 | - public function set_user_company( $value ) { |
|
| 2677 | - $this->set_company( $value ); |
|
| 2834 | + * Set the invoice source. |
|
| 2835 | + * |
|
| 2836 | + * @since 1.0.19 |
|
| 2837 | + * @param string $value source. |
|
| 2838 | + */ |
|
| 2839 | + public function set_created_via( $value ) { |
|
| 2840 | + $this->set_prop( 'created_via', sanitize_text_field( $value ) ); |
|
| 2678 | 2841 | } |
| 2679 | 2842 | |
| 2680 | 2843 | /** |
| 2681 | - * Alias of self::set_company(). |
|
| 2682 | - * |
|
| 2683 | - * @since 1.0.19 |
|
| 2684 | - * @param string $value company. |
|
| 2685 | - */ |
|
| 2686 | - public function set_customer_company( $value ) { |
|
| 2687 | - $this->set_company( $value ); |
|
| 2688 | - } |
|
| 2689 | - |
|
| 2690 | - /** |
|
| 2691 | - * Set the customer's company id. |
|
| 2692 | - * |
|
| 2693 | - * @since 1.0.19 |
|
| 2694 | - * @param string $value company id. |
|
| 2695 | - */ |
|
| 2696 | - public function set_company_id( $value ) { |
|
| 2697 | - $this->set_prop( 'company_id', $value ); |
|
| 2844 | + * Set the customer's address confirmed status. |
|
| 2845 | + * |
|
| 2846 | + * @since 1.0.19 |
|
| 2847 | + * @param int|bool $value confirmed. |
|
| 2848 | + */ |
|
| 2849 | + public function set_address_confirmed( $value ) { |
|
| 2850 | + $this->set_prop( 'address_confirmed', $value ); |
|
| 2698 | 2851 | } |
| 2699 | 2852 | |
| 2700 | 2853 | /** |
| 2701 | - * Set the customer's var number. |
|
| 2702 | - * |
|
| 2703 | - * @since 1.0.19 |
|
| 2704 | - * @param string $value var number. |
|
| 2705 | - */ |
|
| 2706 | - public function set_vat_number( $value ) { |
|
| 2707 | - $this->set_prop( 'vat_number', $value ); |
|
| 2854 | + * Alias of self::set_address_confirmed(). |
|
| 2855 | + * |
|
| 2856 | + * @since 1.0.19 |
|
| 2857 | + * @param int|bool $value confirmed. |
|
| 2858 | + */ |
|
| 2859 | + public function set_user_address_confirmed( $value ) { |
|
| 2860 | + $this->set_address_confirmed( $value ); |
|
| 2708 | 2861 | } |
| 2709 | 2862 | |
| 2710 | 2863 | /** |
| 2711 | - * Alias of self::set_vat_number(). |
|
| 2712 | - * |
|
| 2713 | - * @since 1.0.19 |
|
| 2714 | - * @param string $value var number. |
|
| 2715 | - */ |
|
| 2716 | - public function set_user_vat_number( $value ) { |
|
| 2717 | - $this->set_vat_number( $value ); |
|
| 2864 | + * Alias of self::set_address_confirmed(). |
|
| 2865 | + * |
|
| 2866 | + * @since 1.0.19 |
|
| 2867 | + * @param int|bool $value confirmed. |
|
| 2868 | + */ |
|
| 2869 | + public function set_customer_address_confirmed( $value ) { |
|
| 2870 | + $this->set_address_confirmed( $value ); |
|
| 2718 | 2871 | } |
| 2719 | 2872 | |
| 2720 | 2873 | /** |
| 2721 | - * Alias of self::set_vat_number(). |
|
| 2722 | - * |
|
| 2723 | - * @since 1.0.19 |
|
| 2724 | - * @param string $value var number. |
|
| 2725 | - */ |
|
| 2726 | - public function set_customer_vat_number( $value ) { |
|
| 2727 | - $this->set_vat_number( $value ); |
|
| 2874 | + * Set the shipping fee |
|
| 2875 | + * |
|
| 2876 | + * @since 1.0.19 |
|
| 2877 | + * @param float $value shipping amount. |
|
| 2878 | + */ |
|
| 2879 | + public function set_shipping( $value ) { |
|
| 2880 | + |
|
| 2881 | + if ( ! is_numeric( $value ) ) { |
|
| 2882 | + return $this->set_prop( 'shipping', null ); |
|
| 2883 | + } |
|
| 2884 | + |
|
| 2885 | + $this->set_prop( 'shipping', max( 0, floatval( $value ) ) ); |
|
| 2728 | 2886 | } |
| 2729 | 2887 | |
| 2730 | 2888 | /** |
| 2731 | - * Set the customer's vat rate. |
|
| 2732 | - * |
|
| 2733 | - * @since 1.0.19 |
|
| 2734 | - * @param string $value var rate. |
|
| 2735 | - */ |
|
| 2736 | - public function set_vat_rate( $value ) { |
|
| 2737 | - $this->set_prop( 'vat_rate', $value ); |
|
| 2889 | + * Set the invoice sub total. |
|
| 2890 | + * |
|
| 2891 | + * @since 1.0.19 |
|
| 2892 | + * @param float $value sub total. |
|
| 2893 | + */ |
|
| 2894 | + public function set_subtotal( $value ) { |
|
| 2895 | + $this->set_prop( 'subtotal', max( 0, $value ) ); |
|
| 2738 | 2896 | } |
| 2739 | 2897 | |
| 2740 | - /** |
|
| 2741 | - * Alias of self::set_vat_rate(). |
|
| 2742 | - * |
|
| 2743 | - * @since 1.0.19 |
|
| 2744 | - * @param string $value var number. |
|
| 2745 | - */ |
|
| 2746 | - public function set_user_vat_rate( $value ) { |
|
| 2747 | - $this->set_vat_rate( $value ); |
|
| 2748 | - } |
|
| 2749 | - |
|
| 2750 | - /** |
|
| 2751 | - * Alias of self::set_vat_rate(). |
|
| 2752 | - * |
|
| 2753 | - * @since 1.0.19 |
|
| 2754 | - * @param string $value var number. |
|
| 2755 | - */ |
|
| 2756 | - public function set_customer_vat_rate( $value ) { |
|
| 2757 | - $this->set_vat_rate( $value ); |
|
| 2758 | - } |
|
| 2759 | - |
|
| 2760 | - /** |
|
| 2761 | - * Set the customer's address. |
|
| 2762 | - * |
|
| 2763 | - * @since 1.0.19 |
|
| 2764 | - * @param string $value address. |
|
| 2765 | - */ |
|
| 2766 | - public function set_address( $value ) { |
|
| 2767 | - $this->set_prop( 'address', $value ); |
|
| 2768 | - } |
|
| 2769 | - |
|
| 2770 | - /** |
|
| 2771 | - * Alias of self::set_address(). |
|
| 2772 | - * |
|
| 2773 | - * @since 1.0.19 |
|
| 2774 | - * @param string $value address. |
|
| 2775 | - */ |
|
| 2776 | - public function set_user_address( $value ) { |
|
| 2777 | - $this->set_address( $value ); |
|
| 2778 | - } |
|
| 2779 | - |
|
| 2780 | - /** |
|
| 2781 | - * Alias of self::set_address(). |
|
| 2782 | - * |
|
| 2783 | - * @since 1.0.19 |
|
| 2784 | - * @param string $value address. |
|
| 2785 | - */ |
|
| 2786 | - public function set_customer_address( $value ) { |
|
| 2787 | - $this->set_address( $value ); |
|
| 2788 | - } |
|
| 2789 | - |
|
| 2790 | - /** |
|
| 2791 | - * Set whether the customer has viewed the invoice or not. |
|
| 2792 | - * |
|
| 2793 | - * @since 1.0.19 |
|
| 2794 | - * @param int|bool $value confirmed. |
|
| 2795 | - */ |
|
| 2796 | - public function set_is_viewed( $value ) { |
|
| 2797 | - $this->set_prop( 'is_viewed', $value ); |
|
| 2798 | - } |
|
| 2799 | - |
|
| 2800 | - /** |
|
| 2801 | - * Set extra email recipients. |
|
| 2802 | - * |
|
| 2803 | - * @since 1.0.19 |
|
| 2804 | - * @param string $value email recipients. |
|
| 2805 | - */ |
|
| 2806 | - public function set_email_cc( $value ) { |
|
| 2807 | - $this->set_prop( 'email_cc', $value ); |
|
| 2808 | - } |
|
| 2809 | - |
|
| 2810 | - /** |
|
| 2811 | - * Set the invoice template. |
|
| 2812 | - * |
|
| 2813 | - * @since 1.0.19 |
|
| 2814 | - * @param string $value template. |
|
| 2815 | - */ |
|
| 2816 | - public function set_template( $value ) { |
|
| 2817 | - if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) { |
|
| 2818 | - $this->set_prop( 'template', $value ); |
|
| 2819 | - } |
|
| 2820 | - } |
|
| 2821 | - |
|
| 2822 | - /** |
|
| 2823 | - * Set the invoice source. |
|
| 2824 | - * |
|
| 2825 | - * @since 1.0.19 |
|
| 2826 | - * @param string $value source. |
|
| 2827 | - * @deprecated |
|
| 2828 | - */ |
|
| 2829 | - public function created_via( $value ) { |
|
| 2830 | - $this->set_created_via( sanitize_text_field( $value ) ); |
|
| 2831 | - } |
|
| 2832 | - |
|
| 2833 | - /** |
|
| 2834 | - * Set the invoice source. |
|
| 2835 | - * |
|
| 2836 | - * @since 1.0.19 |
|
| 2837 | - * @param string $value source. |
|
| 2838 | - */ |
|
| 2839 | - public function set_created_via( $value ) { |
|
| 2840 | - $this->set_prop( 'created_via', sanitize_text_field( $value ) ); |
|
| 2841 | - } |
|
| 2842 | - |
|
| 2843 | - /** |
|
| 2844 | - * Set the customer's address confirmed status. |
|
| 2845 | - * |
|
| 2846 | - * @since 1.0.19 |
|
| 2847 | - * @param int|bool $value confirmed. |
|
| 2848 | - */ |
|
| 2849 | - public function set_address_confirmed( $value ) { |
|
| 2850 | - $this->set_prop( 'address_confirmed', $value ); |
|
| 2851 | - } |
|
| 2852 | - |
|
| 2853 | - /** |
|
| 2854 | - * Alias of self::set_address_confirmed(). |
|
| 2855 | - * |
|
| 2856 | - * @since 1.0.19 |
|
| 2857 | - * @param int|bool $value confirmed. |
|
| 2858 | - */ |
|
| 2859 | - public function set_user_address_confirmed( $value ) { |
|
| 2860 | - $this->set_address_confirmed( $value ); |
|
| 2861 | - } |
|
| 2862 | - |
|
| 2863 | - /** |
|
| 2864 | - * Alias of self::set_address_confirmed(). |
|
| 2865 | - * |
|
| 2866 | - * @since 1.0.19 |
|
| 2867 | - * @param int|bool $value confirmed. |
|
| 2868 | - */ |
|
| 2869 | - public function set_customer_address_confirmed( $value ) { |
|
| 2870 | - $this->set_address_confirmed( $value ); |
|
| 2871 | - } |
|
| 2872 | - |
|
| 2873 | - /** |
|
| 2874 | - * Set the shipping fee |
|
| 2875 | - * |
|
| 2876 | - * @since 1.0.19 |
|
| 2877 | - * @param float $value shipping amount. |
|
| 2878 | - */ |
|
| 2879 | - public function set_shipping( $value ) { |
|
| 2880 | - |
|
| 2881 | - if ( ! is_numeric( $value ) ) { |
|
| 2882 | - return $this->set_prop( 'shipping', null ); |
|
| 2883 | - } |
|
| 2884 | - |
|
| 2885 | - $this->set_prop( 'shipping', max( 0, floatval( $value ) ) ); |
|
| 2886 | - } |
|
| 2887 | - |
|
| 2888 | - /** |
|
| 2889 | - * Set the invoice sub total. |
|
| 2890 | - * |
|
| 2891 | - * @since 1.0.19 |
|
| 2892 | - * @param float $value sub total. |
|
| 2893 | - */ |
|
| 2894 | - public function set_subtotal( $value ) { |
|
| 2895 | - $this->set_prop( 'subtotal', max( 0, $value ) ); |
|
| 2896 | - } |
|
| 2897 | - |
|
| 2898 | - /** |
|
| 2899 | - * Set the invoice total. |
|
| 2900 | - * |
|
| 2901 | - * @since 1.0.19 |
|
| 2902 | - * @param float $value sub total. |
|
| 2903 | - */ |
|
| 2904 | - public function set_total( $value ) { |
|
| 2905 | - $this->set_prop( 'total', max( 0, $value ) ); |
|
| 2898 | + /** |
|
| 2899 | + * Set the invoice total. |
|
| 2900 | + * |
|
| 2901 | + * @since 1.0.19 |
|
| 2902 | + * @param float $value sub total. |
|
| 2903 | + */ |
|
| 2904 | + public function set_total( $value ) { |
|
| 2905 | + $this->set_prop( 'total', max( 0, $value ) ); |
|
| 2906 | 2906 | } |
| 2907 | 2907 | |
| 2908 | 2908 | /** |
| 2909 | - * Set the invoice discount amount. |
|
| 2910 | - * |
|
| 2911 | - * @since 1.0.19 |
|
| 2912 | - * @param float $value discount total. |
|
| 2913 | - */ |
|
| 2914 | - public function set_total_discount( $value ) { |
|
| 2915 | - $this->set_prop( 'total_discount', max( 0, $value ) ); |
|
| 2909 | + * Set the invoice discount amount. |
|
| 2910 | + * |
|
| 2911 | + * @since 1.0.19 |
|
| 2912 | + * @param float $value discount total. |
|
| 2913 | + */ |
|
| 2914 | + public function set_total_discount( $value ) { |
|
| 2915 | + $this->set_prop( 'total_discount', max( 0, $value ) ); |
|
| 2916 | 2916 | } |
| 2917 | 2917 | |
| 2918 | 2918 | /** |
| 2919 | - * Alias of self::set_total_discount(). |
|
| 2920 | - * |
|
| 2921 | - * @since 1.0.19 |
|
| 2922 | - * @param float $value discount total. |
|
| 2923 | - */ |
|
| 2924 | - public function set_discount( $value ) { |
|
| 2925 | - $this->set_total_discount( $value ); |
|
| 2919 | + * Alias of self::set_total_discount(). |
|
| 2920 | + * |
|
| 2921 | + * @since 1.0.19 |
|
| 2922 | + * @param float $value discount total. |
|
| 2923 | + */ |
|
| 2924 | + public function set_discount( $value ) { |
|
| 2925 | + $this->set_total_discount( $value ); |
|
| 2926 | 2926 | } |
| 2927 | 2927 | |
| 2928 | 2928 | /** |
| 2929 | - * Set the invoice tax amount. |
|
| 2930 | - * |
|
| 2931 | - * @since 1.0.19 |
|
| 2932 | - * @param float $value tax total. |
|
| 2933 | - */ |
|
| 2934 | - public function set_total_tax( $value ) { |
|
| 2935 | - $this->set_prop( 'total_tax', max( 0, $value ) ); |
|
| 2929 | + * Set the invoice tax amount. |
|
| 2930 | + * |
|
| 2931 | + * @since 1.0.19 |
|
| 2932 | + * @param float $value tax total. |
|
| 2933 | + */ |
|
| 2934 | + public function set_total_tax( $value ) { |
|
| 2935 | + $this->set_prop( 'total_tax', max( 0, $value ) ); |
|
| 2936 | 2936 | } |
| 2937 | 2937 | |
| 2938 | 2938 | /** |
| 2939 | - * Alias of self::set_total_tax(). |
|
| 2940 | - * |
|
| 2941 | - * @since 1.0.19 |
|
| 2942 | - * @param float $value tax total. |
|
| 2943 | - */ |
|
| 2944 | - public function set_tax_total( $value ) { |
|
| 2945 | - $this->set_total_tax( $value ); |
|
| 2939 | + * Alias of self::set_total_tax(). |
|
| 2940 | + * |
|
| 2941 | + * @since 1.0.19 |
|
| 2942 | + * @param float $value tax total. |
|
| 2943 | + */ |
|
| 2944 | + public function set_tax_total( $value ) { |
|
| 2945 | + $this->set_total_tax( $value ); |
|
| 2946 | 2946 | } |
| 2947 | 2947 | |
| 2948 | 2948 | /** |
| 2949 | - * Set the invoice fees amount. |
|
| 2950 | - * |
|
| 2951 | - * @since 1.0.19 |
|
| 2952 | - * @param float $value fees total. |
|
| 2953 | - */ |
|
| 2954 | - public function set_total_fees( $value ) { |
|
| 2955 | - $this->set_prop( 'total_fees', max( 0, $value ) ); |
|
| 2949 | + * Set the invoice fees amount. |
|
| 2950 | + * |
|
| 2951 | + * @since 1.0.19 |
|
| 2952 | + * @param float $value fees total. |
|
| 2953 | + */ |
|
| 2954 | + public function set_total_fees( $value ) { |
|
| 2955 | + $this->set_prop( 'total_fees', max( 0, $value ) ); |
|
| 2956 | 2956 | } |
| 2957 | 2957 | |
| 2958 | 2958 | /** |
| 2959 | - * Alias of self::set_total_fees(). |
|
| 2960 | - * |
|
| 2961 | - * @since 1.0.19 |
|
| 2962 | - * @param float $value fees total. |
|
| 2963 | - */ |
|
| 2964 | - public function set_fees_total( $value ) { |
|
| 2965 | - $this->set_total_fees( $value ); |
|
| 2959 | + * Alias of self::set_total_fees(). |
|
| 2960 | + * |
|
| 2961 | + * @since 1.0.19 |
|
| 2962 | + * @param float $value fees total. |
|
| 2963 | + */ |
|
| 2964 | + public function set_fees_total( $value ) { |
|
| 2965 | + $this->set_total_fees( $value ); |
|
| 2966 | 2966 | } |
| 2967 | 2967 | |
| 2968 | 2968 | /** |
| 2969 | - * Set the invoice fees. |
|
| 2970 | - * |
|
| 2971 | - * @since 1.0.19 |
|
| 2972 | - * @param array $value fees. |
|
| 2973 | - */ |
|
| 2974 | - public function set_fees( $value ) { |
|
| 2969 | + * Set the invoice fees. |
|
| 2970 | + * |
|
| 2971 | + * @since 1.0.19 |
|
| 2972 | + * @param array $value fees. |
|
| 2973 | + */ |
|
| 2974 | + public function set_fees( $value ) { |
|
| 2975 | 2975 | |
| 2976 | - if ( ! is_array( $value ) ) { |
|
| 2977 | - $value = array(); |
|
| 2978 | - } |
|
| 2976 | + if ( ! is_array( $value ) ) { |
|
| 2977 | + $value = array(); |
|
| 2978 | + } |
|
| 2979 | 2979 | |
| 2980 | - $this->set_prop( 'fees', $value ); |
|
| 2980 | + $this->set_prop( 'fees', $value ); |
|
| 2981 | 2981 | |
| 2982 | 2982 | } |
| 2983 | 2983 | |
| 2984 | 2984 | /** |
| 2985 | - * Set the invoice taxes. |
|
| 2986 | - * |
|
| 2987 | - * @since 1.0.19 |
|
| 2988 | - * @param array $value taxes. |
|
| 2989 | - */ |
|
| 2990 | - public function set_taxes( $value ) { |
|
| 2985 | + * Set the invoice taxes. |
|
| 2986 | + * |
|
| 2987 | + * @since 1.0.19 |
|
| 2988 | + * @param array $value taxes. |
|
| 2989 | + */ |
|
| 2990 | + public function set_taxes( $value ) { |
|
| 2991 | 2991 | |
| 2992 | - if ( ! is_array( $value ) ) { |
|
| 2993 | - $value = array(); |
|
| 2994 | - } |
|
| 2992 | + if ( ! is_array( $value ) ) { |
|
| 2993 | + $value = array(); |
|
| 2994 | + } |
|
| 2995 | 2995 | |
| 2996 | - $this->set_prop( 'taxes', $value ); |
|
| 2996 | + $this->set_prop( 'taxes', $value ); |
|
| 2997 | 2997 | |
| 2998 | 2998 | } |
| 2999 | 2999 | |
| 3000 | 3000 | /** |
| 3001 | - * Set the invoice discounts. |
|
| 3002 | - * |
|
| 3003 | - * @since 1.0.19 |
|
| 3004 | - * @param array $value discounts. |
|
| 3005 | - */ |
|
| 3006 | - public function set_discounts( $value ) { |
|
| 3001 | + * Set the invoice discounts. |
|
| 3002 | + * |
|
| 3003 | + * @since 1.0.19 |
|
| 3004 | + * @param array $value discounts. |
|
| 3005 | + */ |
|
| 3006 | + public function set_discounts( $value ) { |
|
| 3007 | 3007 | |
| 3008 | - if ( ! is_array( $value ) ) { |
|
| 3009 | - $value = array(); |
|
| 3010 | - } |
|
| 3008 | + if ( ! is_array( $value ) ) { |
|
| 3009 | + $value = array(); |
|
| 3010 | + } |
|
| 3011 | 3011 | |
| 3012 | - $this->set_prop( 'discounts', $value ); |
|
| 3012 | + $this->set_prop( 'discounts', $value ); |
|
| 3013 | 3013 | } |
| 3014 | 3014 | |
| 3015 | 3015 | /** |
| 3016 | - * Set the invoice items. |
|
| 3017 | - * |
|
| 3018 | - * @since 1.0.19 |
|
| 3019 | - * @param GetPaid_Form_Item[] $value items. |
|
| 3020 | - */ |
|
| 3021 | - public function set_items( $value ) { |
|
| 3016 | + * Set the invoice items. |
|
| 3017 | + * |
|
| 3018 | + * @since 1.0.19 |
|
| 3019 | + * @param GetPaid_Form_Item[] $value items. |
|
| 3020 | + */ |
|
| 3021 | + public function set_items( $value ) { |
|
| 3022 | 3022 | |
| 3023 | 3023 | // Remove existing items. |
| 3024 | 3024 | $this->set_prop( 'items', array() ); |
| 3025 | - $this->recurring_item = null; |
|
| 3025 | + $this->recurring_item = null; |
|
| 3026 | 3026 | |
| 3027 | 3027 | // Ensure that we have an array. |
| 3028 | 3028 | if ( ! is_array( $value ) ) { |
@@ -3036,95 +3036,95 @@ discard block |
||
| 3036 | 3036 | } |
| 3037 | 3037 | |
| 3038 | 3038 | /** |
| 3039 | - * Set the payment form. |
|
| 3040 | - * |
|
| 3041 | - * @since 1.0.19 |
|
| 3042 | - * @param int $value payment form. |
|
| 3043 | - */ |
|
| 3044 | - public function set_payment_form( $value ) { |
|
| 3045 | - $this->set_prop( 'payment_form', $value ); |
|
| 3039 | + * Set the payment form. |
|
| 3040 | + * |
|
| 3041 | + * @since 1.0.19 |
|
| 3042 | + * @param int $value payment form. |
|
| 3043 | + */ |
|
| 3044 | + public function set_payment_form( $value ) { |
|
| 3045 | + $this->set_prop( 'payment_form', $value ); |
|
| 3046 | 3046 | } |
| 3047 | 3047 | |
| 3048 | 3048 | /** |
| 3049 | - * Set the submission id. |
|
| 3050 | - * |
|
| 3051 | - * @since 1.0.19 |
|
| 3052 | - * @param string $value submission id. |
|
| 3053 | - */ |
|
| 3054 | - public function set_submission_id( $value ) { |
|
| 3055 | - $this->set_prop( 'submission_id', $value ); |
|
| 3049 | + * Set the submission id. |
|
| 3050 | + * |
|
| 3051 | + * @since 1.0.19 |
|
| 3052 | + * @param string $value submission id. |
|
| 3053 | + */ |
|
| 3054 | + public function set_submission_id( $value ) { |
|
| 3055 | + $this->set_prop( 'submission_id', $value ); |
|
| 3056 | 3056 | } |
| 3057 | 3057 | |
| 3058 | 3058 | /** |
| 3059 | - * Set the discount code. |
|
| 3060 | - * |
|
| 3061 | - * @since 1.0.19 |
|
| 3062 | - * @param string $value discount code. |
|
| 3063 | - */ |
|
| 3064 | - public function set_discount_code( $value ) { |
|
| 3065 | - $this->set_prop( 'discount_code', sanitize_text_field( $value ) ); |
|
| 3059 | + * Set the discount code. |
|
| 3060 | + * |
|
| 3061 | + * @since 1.0.19 |
|
| 3062 | + * @param string $value discount code. |
|
| 3063 | + */ |
|
| 3064 | + public function set_discount_code( $value ) { |
|
| 3065 | + $this->set_prop( 'discount_code', sanitize_text_field( $value ) ); |
|
| 3066 | 3066 | } |
| 3067 | 3067 | |
| 3068 | 3068 | /** |
| 3069 | - * Set the gateway. |
|
| 3070 | - * |
|
| 3071 | - * @since 1.0.19 |
|
| 3072 | - * @param string $value gateway. |
|
| 3073 | - */ |
|
| 3074 | - public function set_gateway( $value ) { |
|
| 3075 | - $this->set_prop( 'gateway', $value ); |
|
| 3069 | + * Set the gateway. |
|
| 3070 | + * |
|
| 3071 | + * @since 1.0.19 |
|
| 3072 | + * @param string $value gateway. |
|
| 3073 | + */ |
|
| 3074 | + public function set_gateway( $value ) { |
|
| 3075 | + $this->set_prop( 'gateway', $value ); |
|
| 3076 | 3076 | } |
| 3077 | 3077 | |
| 3078 | 3078 | /** |
| 3079 | - * Set the transaction id. |
|
| 3080 | - * |
|
| 3081 | - * @since 1.0.19 |
|
| 3082 | - * @param string $value transaction id. |
|
| 3083 | - */ |
|
| 3084 | - public function set_transaction_id( $value ) { |
|
| 3085 | - if ( ! empty( $value ) ) { |
|
| 3086 | - $this->set_prop( 'transaction_id', $value ); |
|
| 3087 | - } |
|
| 3079 | + * Set the transaction id. |
|
| 3080 | + * |
|
| 3081 | + * @since 1.0.19 |
|
| 3082 | + * @param string $value transaction id. |
|
| 3083 | + */ |
|
| 3084 | + public function set_transaction_id( $value ) { |
|
| 3085 | + if ( ! empty( $value ) ) { |
|
| 3086 | + $this->set_prop( 'transaction_id', $value ); |
|
| 3087 | + } |
|
| 3088 | 3088 | } |
| 3089 | 3089 | |
| 3090 | 3090 | /** |
| 3091 | - * Set the currency id. |
|
| 3092 | - * |
|
| 3093 | - * @since 1.0.19 |
|
| 3094 | - * @param string $value currency id. |
|
| 3095 | - */ |
|
| 3096 | - public function set_currency( $value ) { |
|
| 3097 | - $this->set_prop( 'currency', $value ); |
|
| 3091 | + * Set the currency id. |
|
| 3092 | + * |
|
| 3093 | + * @since 1.0.19 |
|
| 3094 | + * @param string $value currency id. |
|
| 3095 | + */ |
|
| 3096 | + public function set_currency( $value ) { |
|
| 3097 | + $this->set_prop( 'currency', $value ); |
|
| 3098 | 3098 | } |
| 3099 | 3099 | |
| 3100 | - /** |
|
| 3101 | - * Set whether to disable taxes. |
|
| 3102 | - * |
|
| 3103 | - * @since 1.0.19 |
|
| 3104 | - * @param bool $value value. |
|
| 3105 | - */ |
|
| 3106 | - public function set_disable_taxes( $value ) { |
|
| 3107 | - $this->set_prop( 'disable_taxes', (bool) $value ); |
|
| 3108 | - } |
|
| 3100 | + /** |
|
| 3101 | + * Set whether to disable taxes. |
|
| 3102 | + * |
|
| 3103 | + * @since 1.0.19 |
|
| 3104 | + * @param bool $value value. |
|
| 3105 | + */ |
|
| 3106 | + public function set_disable_taxes( $value ) { |
|
| 3107 | + $this->set_prop( 'disable_taxes', (bool) $value ); |
|
| 3108 | + } |
|
| 3109 | 3109 | |
| 3110 | 3110 | /** |
| 3111 | - * Set the subscription id. |
|
| 3112 | - * |
|
| 3113 | - * @since 1.0.19 |
|
| 3114 | - * @param string $value subscription id. |
|
| 3115 | - */ |
|
| 3116 | - public function set_subscription_id( $value ) { |
|
| 3117 | - $this->set_prop( 'subscription_id', $value ); |
|
| 3118 | - } |
|
| 3111 | + * Set the subscription id. |
|
| 3112 | + * |
|
| 3113 | + * @since 1.0.19 |
|
| 3114 | + * @param string $value subscription id. |
|
| 3115 | + */ |
|
| 3116 | + public function set_subscription_id( $value ) { |
|
| 3117 | + $this->set_prop( 'subscription_id', $value ); |
|
| 3118 | + } |
|
| 3119 | 3119 | |
| 3120 | - /** |
|
| 3121 | - * Set the remote subscription id. |
|
| 3122 | - * |
|
| 3123 | - * @since 1.0.19 |
|
| 3124 | - * @param string $value subscription id. |
|
| 3125 | - */ |
|
| 3126 | - public function set_remote_subscription_id( $value ) { |
|
| 3127 | - $this->set_prop( 'remote_subscription_id', $value ); |
|
| 3120 | + /** |
|
| 3121 | + * Set the remote subscription id. |
|
| 3122 | + * |
|
| 3123 | + * @since 1.0.19 |
|
| 3124 | + * @param string $value subscription id. |
|
| 3125 | + */ |
|
| 3126 | + public function set_remote_subscription_id( $value ) { |
|
| 3127 | + $this->set_prop( 'remote_subscription_id', $value ); |
|
| 3128 | 3128 | } |
| 3129 | 3129 | |
| 3130 | 3130 | /* |
@@ -3163,24 +3163,24 @@ discard block |
||
| 3163 | 3163 | */ |
| 3164 | 3164 | public function is_taxable() { |
| 3165 | 3165 | return ! $this->get_disable_taxes(); |
| 3166 | - } |
|
| 3166 | + } |
|
| 3167 | 3167 | |
| 3168 | - /** |
|
| 3169 | - * @deprecated |
|
| 3170 | - */ |
|
| 3171 | - public function has_vat() { |
|
| 3168 | + /** |
|
| 3169 | + * @deprecated |
|
| 3170 | + */ |
|
| 3171 | + public function has_vat() { |
|
| 3172 | 3172 | return $this->is_taxable(); |
| 3173 | - } |
|
| 3173 | + } |
|
| 3174 | 3174 | |
| 3175 | - /** |
|
| 3176 | - * Checks to see if the invoice requires payment. |
|
| 3177 | - */ |
|
| 3178 | - public function is_free() { |
|
| 3175 | + /** |
|
| 3176 | + * Checks to see if the invoice requires payment. |
|
| 3177 | + */ |
|
| 3178 | + public function is_free() { |
|
| 3179 | 3179 | $is_free = ( (float) wpinv_round_amount( $this->get_initial_total() ) == 0 ); |
| 3180 | 3180 | |
| 3181 | - if ( $this->is_recurring() && $this->get_recurring_total() > 0 ) { |
|
| 3182 | - $is_free = false; |
|
| 3183 | - } |
|
| 3181 | + if ( $this->is_recurring() && $this->get_recurring_total() > 0 ) { |
|
| 3182 | + $is_free = false; |
|
| 3183 | + } |
|
| 3184 | 3184 | |
| 3185 | 3185 | return apply_filters( 'wpinv_invoice_is_free', $is_free, $this ); |
| 3186 | 3186 | } |
@@ -3191,46 +3191,46 @@ discard block |
||
| 3191 | 3191 | public function is_paid() { |
| 3192 | 3192 | $is_paid = $this->has_status( array( 'publish', 'wpi-processing', 'wpi-renewal' ) ); |
| 3193 | 3193 | return apply_filters( 'wpinv_invoice_is_paid', $is_paid, $this ); |
| 3194 | - } |
|
| 3194 | + } |
|
| 3195 | 3195 | |
| 3196 | - /** |
|
| 3196 | + /** |
|
| 3197 | 3197 | * Checks if the invoice needs payment. |
| 3198 | 3198 | */ |
| 3199 | - public function needs_payment() { |
|
| 3200 | - $needs_payment = ! $this->is_paid() && ! $this->is_refunded() && ! $this->is_free(); |
|
| 3199 | + public function needs_payment() { |
|
| 3200 | + $needs_payment = ! $this->is_paid() && ! $this->is_refunded() && ! $this->is_free(); |
|
| 3201 | 3201 | return apply_filters( 'wpinv_needs_payment', $needs_payment, $this ); |
| 3202 | 3202 | } |
| 3203 | 3203 | |
| 3204 | - /** |
|
| 3204 | + /** |
|
| 3205 | 3205 | * Checks if the invoice is refunded. |
| 3206 | 3206 | */ |
| 3207 | - public function is_refunded() { |
|
| 3207 | + public function is_refunded() { |
|
| 3208 | 3208 | $is_refunded = $this->has_status( 'wpi-refunded' ); |
| 3209 | 3209 | return apply_filters( 'wpinv_invoice_is_refunded', $is_refunded, $this ); |
| 3210 | - } |
|
| 3210 | + } |
|
| 3211 | 3211 | |
| 3212 | - /** |
|
| 3212 | + /** |
|
| 3213 | 3213 | * Checks if the invoice is held. |
| 3214 | 3214 | */ |
| 3215 | - public function is_held() { |
|
| 3215 | + public function is_held() { |
|
| 3216 | 3216 | $is_held = $this->has_status( 'wpi-onhold' ); |
| 3217 | 3217 | return apply_filters( 'wpinv_invoice_is_held', $is_held, $this ); |
| 3218 | - } |
|
| 3218 | + } |
|
| 3219 | 3219 | |
| 3220 | - /** |
|
| 3220 | + /** |
|
| 3221 | 3221 | * Checks if the invoice is due. |
| 3222 | 3222 | */ |
| 3223 | - public function is_due() { |
|
| 3224 | - $due_date = $this->get_due_date(); |
|
| 3225 | - return empty( $due_date ) ? false : current_time( 'timestamp' ) > strtotime( $due_date ); |
|
| 3226 | - } |
|
| 3223 | + public function is_due() { |
|
| 3224 | + $due_date = $this->get_due_date(); |
|
| 3225 | + return empty( $due_date ) ? false : current_time( 'timestamp' ) > strtotime( $due_date ); |
|
| 3226 | + } |
|
| 3227 | 3227 | |
| 3228 | - /** |
|
| 3228 | + /** |
|
| 3229 | 3229 | * Checks if the invoice is draft. |
| 3230 | 3230 | */ |
| 3231 | - public function is_draft() { |
|
| 3231 | + public function is_draft() { |
|
| 3232 | 3232 | return $this->has_status( 'draft, auto-draft' ); |
| 3233 | - } |
|
| 3233 | + } |
|
| 3234 | 3234 | |
| 3235 | 3235 | /** |
| 3236 | 3236 | * Checks if the invoice has a given status. |
@@ -3238,9 +3238,9 @@ discard block |
||
| 3238 | 3238 | public function has_status( $status ) { |
| 3239 | 3239 | $status = wpinv_parse_list( $status ); |
| 3240 | 3240 | return apply_filters( 'wpinv_has_status', in_array( $this->get_status(), $status ), $status ); |
| 3241 | - } |
|
| 3241 | + } |
|
| 3242 | 3242 | |
| 3243 | - /** |
|
| 3243 | + /** |
|
| 3244 | 3244 | * Checks if the invoice is of a given type. |
| 3245 | 3245 | */ |
| 3246 | 3246 | public function is_type( $type ) { |
@@ -3263,25 +3263,25 @@ discard block |
||
| 3263 | 3263 | */ |
| 3264 | 3264 | public function has_free_trial() { |
| 3265 | 3265 | return $this->is_recurring() && 0 == $this->get_initial_total(); |
| 3266 | - } |
|
| 3266 | + } |
|
| 3267 | 3267 | |
| 3268 | - /** |
|
| 3268 | + /** |
|
| 3269 | 3269 | * @deprecated |
| 3270 | 3270 | */ |
| 3271 | 3271 | public function is_free_trial() { |
| 3272 | 3272 | return $this->has_free_trial(); |
| 3273 | 3273 | } |
| 3274 | 3274 | |
| 3275 | - /** |
|
| 3275 | + /** |
|
| 3276 | 3276 | * Check if the initial payment if 0. |
| 3277 | 3277 | * |
| 3278 | 3278 | */ |
| 3279 | - public function is_initial_free() { |
|
| 3279 | + public function is_initial_free() { |
|
| 3280 | 3280 | $is_initial_free = ! ( (float) wpinv_round_amount( $this->get_initial_total() ) > 0 ); |
| 3281 | 3281 | return apply_filters( 'wpinv_invoice_is_initial_free', $is_initial_free, $this->get_cart_details(), $this ); |
| 3282 | 3282 | } |
| 3283 | 3283 | |
| 3284 | - /** |
|
| 3284 | + /** |
|
| 3285 | 3285 | * Check if the recurring item has a free trial. |
| 3286 | 3286 | * |
| 3287 | 3287 | */ |
@@ -3294,21 +3294,21 @@ discard block |
||
| 3294 | 3294 | |
| 3295 | 3295 | $item = $this->get_recurring( true ); |
| 3296 | 3296 | return $item->has_free_trial(); |
| 3297 | - } |
|
| 3297 | + } |
|
| 3298 | 3298 | |
| 3299 | - /** |
|
| 3299 | + /** |
|
| 3300 | 3300 | * Check if the free trial is a result of a discount. |
| 3301 | 3301 | */ |
| 3302 | 3302 | public function is_free_trial_from_discount() { |
| 3303 | - return $this->has_free_trial() && ! $this->item_has_free_trial(); |
|
| 3304 | - } |
|
| 3303 | + return $this->has_free_trial() && ! $this->item_has_free_trial(); |
|
| 3304 | + } |
|
| 3305 | 3305 | |
| 3306 | - /** |
|
| 3306 | + /** |
|
| 3307 | 3307 | * @deprecated |
| 3308 | 3308 | */ |
| 3309 | 3309 | public function discount_first_payment_only() { |
| 3310 | 3310 | |
| 3311 | - $discount = wpinv_get_discount_obj( $this->get_discount_code() ); |
|
| 3311 | + $discount = wpinv_get_discount_obj( $this->get_discount_code() ); |
|
| 3312 | 3312 | if ( ! $discount->exists() || ! $this->is_recurring() ) { |
| 3313 | 3313 | return true; |
| 3314 | 3314 | } |
@@ -3333,146 +3333,146 @@ discard block |
||
| 3333 | 3333 | */ |
| 3334 | 3334 | public function add_item( $item ) { |
| 3335 | 3335 | |
| 3336 | - if ( is_array( $item ) ) { |
|
| 3337 | - $item = $this->process_array_item( $item ); |
|
| 3338 | - } |
|
| 3336 | + if ( is_array( $item ) ) { |
|
| 3337 | + $item = $this->process_array_item( $item ); |
|
| 3338 | + } |
|
| 3339 | 3339 | |
| 3340 | - if ( is_numeric( $item ) ) { |
|
| 3341 | - $item = new GetPaid_Form_Item( $item ); |
|
| 3342 | - } |
|
| 3340 | + if ( is_numeric( $item ) ) { |
|
| 3341 | + $item = new GetPaid_Form_Item( $item ); |
|
| 3342 | + } |
|
| 3343 | 3343 | |
| 3344 | 3344 | // Make sure that it is available for purchase. |
| 3345 | - if ( $item->get_id() > 0 && ! $item->can_purchase() ) { |
|
| 3346 | - return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) ); |
|
| 3345 | + if ( $item->get_id() > 0 && ! $item->can_purchase() ) { |
|
| 3346 | + return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) ); |
|
| 3347 | 3347 | } |
| 3348 | 3348 | |
| 3349 | 3349 | // Do we have a recurring item? |
| 3350 | - if ( $item->is_recurring() ) { |
|
| 3351 | - $this->recurring_item = $item->get_id(); |
|
| 3350 | + if ( $item->is_recurring() ) { |
|
| 3351 | + $this->recurring_item = $item->get_id(); |
|
| 3352 | 3352 | } |
| 3353 | 3353 | |
| 3354 | 3354 | // Invoice id. |
| 3355 | 3355 | $item->invoice_id = (int) $this->get_id(); |
| 3356 | 3356 | |
| 3357 | - // Remove duplicates. |
|
| 3358 | - $this->remove_item( $item->get_id() ); |
|
| 3357 | + // Remove duplicates. |
|
| 3358 | + $this->remove_item( $item->get_id() ); |
|
| 3359 | 3359 | |
| 3360 | - if ( 0 == $item->get_quantity() ) { |
|
| 3361 | - return; |
|
| 3362 | - } |
|
| 3360 | + if ( 0 == $item->get_quantity() ) { |
|
| 3361 | + return; |
|
| 3362 | + } |
|
| 3363 | 3363 | |
| 3364 | - // Retrieve all items. |
|
| 3364 | + // Retrieve all items. |
|
| 3365 | 3365 | $items = $this->get_items(); |
| 3366 | 3366 | |
| 3367 | - // Add new item. |
|
| 3367 | + // Add new item. |
|
| 3368 | 3368 | $items[] = $item; |
| 3369 | 3369 | |
| 3370 | 3370 | $this->set_prop( 'items', $items ); |
| 3371 | 3371 | |
| 3372 | - return true; |
|
| 3373 | - } |
|
| 3372 | + return true; |
|
| 3373 | + } |
|
| 3374 | 3374 | |
| 3375 | - /** |
|
| 3376 | - * Converts an array to an item. |
|
| 3377 | - * |
|
| 3378 | - * @since 1.0.19 |
|
| 3379 | - * @return GetPaid_Form_Item |
|
| 3380 | - */ |
|
| 3381 | - protected function process_array_item( $array ) { |
|
| 3375 | + /** |
|
| 3376 | + * Converts an array to an item. |
|
| 3377 | + * |
|
| 3378 | + * @since 1.0.19 |
|
| 3379 | + * @return GetPaid_Form_Item |
|
| 3380 | + */ |
|
| 3381 | + protected function process_array_item( $array ) { |
|
| 3382 | 3382 | |
| 3383 | - $item_id = isset( $array['item_id'] ) ? $array['item_id'] : 0; |
|
| 3384 | - $item = new GetPaid_Form_Item( $item_id ); |
|
| 3383 | + $item_id = isset( $array['item_id'] ) ? $array['item_id'] : 0; |
|
| 3384 | + $item = new GetPaid_Form_Item( $item_id ); |
|
| 3385 | 3385 | |
| 3386 | - // Set item data. |
|
| 3387 | - foreach ( array( 'name', 'price', 'description' ) as $key ) { |
|
| 3388 | - if ( isset( $array[ "item_$key" ] ) ) { |
|
| 3389 | - $method = "set_$key"; |
|
| 3390 | - $item->$method( $array[ "item_$key" ] ); |
|
| 3391 | - } |
|
| 3392 | - } |
|
| 3386 | + // Set item data. |
|
| 3387 | + foreach ( array( 'name', 'price', 'description' ) as $key ) { |
|
| 3388 | + if ( isset( $array[ "item_$key" ] ) ) { |
|
| 3389 | + $method = "set_$key"; |
|
| 3390 | + $item->$method( $array[ "item_$key" ] ); |
|
| 3391 | + } |
|
| 3392 | + } |
|
| 3393 | 3393 | |
| 3394 | - if ( isset( $array['quantity'] ) ) { |
|
| 3395 | - $item->set_quantity( $array['quantity'] ); |
|
| 3396 | - } |
|
| 3394 | + if ( isset( $array['quantity'] ) ) { |
|
| 3395 | + $item->set_quantity( $array['quantity'] ); |
|
| 3396 | + } |
|
| 3397 | 3397 | |
| 3398 | - // Set item meta. |
|
| 3399 | - if ( isset( $array['meta'] ) && is_array( $array['meta'] ) ) { |
|
| 3400 | - $item->set_item_meta( $array['meta'] ); |
|
| 3401 | - } |
|
| 3398 | + // Set item meta. |
|
| 3399 | + if ( isset( $array['meta'] ) && is_array( $array['meta'] ) ) { |
|
| 3400 | + $item->set_item_meta( $array['meta'] ); |
|
| 3401 | + } |
|
| 3402 | 3402 | |
| 3403 | - return $item; |
|
| 3403 | + return $item; |
|
| 3404 | 3404 | |
| 3405 | - } |
|
| 3405 | + } |
|
| 3406 | 3406 | |
| 3407 | 3407 | /** |
| 3408 | - * Retrieves a specific item. |
|
| 3409 | - * |
|
| 3410 | - * @since 1.0.19 |
|
| 3411 | - * @return GetPaid_Form_Item|null |
|
| 3412 | - */ |
|
| 3413 | - public function get_item( $item_id ) { |
|
| 3408 | + * Retrieves a specific item. |
|
| 3409 | + * |
|
| 3410 | + * @since 1.0.19 |
|
| 3411 | + * @return GetPaid_Form_Item|null |
|
| 3412 | + */ |
|
| 3413 | + public function get_item( $item_id ) { |
|
| 3414 | 3414 | |
| 3415 | - foreach ( $this->get_items() as $item ) { |
|
| 3416 | - if ( (int) $item_id == $item->get_id() ) { |
|
| 3417 | - return $item; |
|
| 3418 | - } |
|
| 3419 | - } |
|
| 3415 | + foreach ( $this->get_items() as $item ) { |
|
| 3416 | + if ( (int) $item_id == $item->get_id() ) { |
|
| 3417 | + return $item; |
|
| 3418 | + } |
|
| 3419 | + } |
|
| 3420 | 3420 | |
| 3421 | - return null; |
|
| 3421 | + return null; |
|
| 3422 | 3422 | } |
| 3423 | 3423 | |
| 3424 | 3424 | /** |
| 3425 | - * Removes a specific item. |
|
| 3426 | - * |
|
| 3427 | - * @since 1.0.19 |
|
| 3428 | - */ |
|
| 3429 | - public function remove_item( $item_id ) { |
|
| 3430 | - $items = $this->get_items(); |
|
| 3431 | - $item_id = (int) $item_id; |
|
| 3425 | + * Removes a specific item. |
|
| 3426 | + * |
|
| 3427 | + * @since 1.0.19 |
|
| 3428 | + */ |
|
| 3429 | + public function remove_item( $item_id ) { |
|
| 3430 | + $items = $this->get_items(); |
|
| 3431 | + $item_id = (int) $item_id; |
|
| 3432 | 3432 | |
| 3433 | - foreach ( $items as $index => $item ) { |
|
| 3434 | - if ( (int) $item_id == $item->get_id() ) { |
|
| 3435 | - unset( $items[ $index ] ); |
|
| 3436 | - $this->set_prop( 'items', $items ); |
|
| 3433 | + foreach ( $items as $index => $item ) { |
|
| 3434 | + if ( (int) $item_id == $item->get_id() ) { |
|
| 3435 | + unset( $items[ $index ] ); |
|
| 3436 | + $this->set_prop( 'items', $items ); |
|
| 3437 | 3437 | |
| 3438 | - if ( $item_id == $this->recurring_item ) { |
|
| 3439 | - $this->recurring_item = null; |
|
| 3440 | - } |
|
| 3438 | + if ( $item_id == $this->recurring_item ) { |
|
| 3439 | + $this->recurring_item = null; |
|
| 3440 | + } |
|
| 3441 | 3441 | } |
| 3442 | - } |
|
| 3442 | + } |
|
| 3443 | 3443 | |
| 3444 | 3444 | } |
| 3445 | 3445 | |
| 3446 | 3446 | /** |
| 3447 | - * Adds a fee to the invoice. |
|
| 3448 | - * |
|
| 3449 | - * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
| 3450 | - * @since 1.0.19 |
|
| 3451 | - */ |
|
| 3447 | + * Adds a fee to the invoice. |
|
| 3448 | + * |
|
| 3449 | + * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
| 3450 | + * @since 1.0.19 |
|
| 3451 | + */ |
|
| 3452 | 3452 | public function add_fee( $fee ) { |
| 3453 | 3453 | |
| 3454 | - $fees = $this->get_fees(); |
|
| 3455 | - $fees[ $fee['name'] ] = $fee; |
|
| 3456 | - $this->set_prop( 'fees', $fees ); |
|
| 3454 | + $fees = $this->get_fees(); |
|
| 3455 | + $fees[ $fee['name'] ] = $fee; |
|
| 3456 | + $this->set_prop( 'fees', $fees ); |
|
| 3457 | 3457 | |
| 3458 | 3458 | } |
| 3459 | 3459 | |
| 3460 | 3460 | /** |
| 3461 | - * Retrieves a specific fee. |
|
| 3462 | - * |
|
| 3463 | - * @since 1.0.19 |
|
| 3464 | - */ |
|
| 3465 | - public function get_fee( $fee ) { |
|
| 3461 | + * Retrieves a specific fee. |
|
| 3462 | + * |
|
| 3463 | + * @since 1.0.19 |
|
| 3464 | + */ |
|
| 3465 | + public function get_fee( $fee ) { |
|
| 3466 | 3466 | $fees = $this->get_fees(); |
| 3467 | - return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null; |
|
| 3467 | + return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null; |
|
| 3468 | 3468 | } |
| 3469 | 3469 | |
| 3470 | 3470 | /** |
| 3471 | - * Removes a specific fee. |
|
| 3472 | - * |
|
| 3473 | - * @since 1.0.19 |
|
| 3474 | - */ |
|
| 3475 | - public function remove_fee( $fee ) { |
|
| 3471 | + * Removes a specific fee. |
|
| 3472 | + * |
|
| 3473 | + * @since 1.0.19 |
|
| 3474 | + */ |
|
| 3475 | + public function remove_fee( $fee ) { |
|
| 3476 | 3476 | $fees = $this->get_fees(); |
| 3477 | 3477 | if ( isset( $fees[ $fee ] ) ) { |
| 3478 | 3478 | unset( $fees[ $fee ] ); |
@@ -3480,55 +3480,55 @@ discard block |
||
| 3480 | 3480 | } |
| 3481 | 3481 | } |
| 3482 | 3482 | |
| 3483 | - /** |
|
| 3484 | - * Adds a discount to the invoice. |
|
| 3485 | - * |
|
| 3486 | - * @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. |
|
| 3487 | - * @since 1.0.19 |
|
| 3488 | - */ |
|
| 3489 | - public function add_discount( $discount ) { |
|
| 3483 | + /** |
|
| 3484 | + * Adds a discount to the invoice. |
|
| 3485 | + * |
|
| 3486 | + * @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. |
|
| 3487 | + * @since 1.0.19 |
|
| 3488 | + */ |
|
| 3489 | + public function add_discount( $discount ) { |
|
| 3490 | 3490 | |
| 3491 | - $discounts = $this->get_discounts(); |
|
| 3492 | - $discounts[ $discount['name'] ] = $discount; |
|
| 3493 | - $this->set_prop( 'discounts', $discounts ); |
|
| 3491 | + $discounts = $this->get_discounts(); |
|
| 3492 | + $discounts[ $discount['name'] ] = $discount; |
|
| 3493 | + $this->set_prop( 'discounts', $discounts ); |
|
| 3494 | 3494 | |
| 3495 | - } |
|
| 3495 | + } |
|
| 3496 | 3496 | |
| 3497 | 3497 | /** |
| 3498 | - * Retrieves a specific discount. |
|
| 3499 | - * |
|
| 3500 | - * @since 1.0.19 |
|
| 3501 | - * @return float |
|
| 3502 | - */ |
|
| 3503 | - public function get_discount( $discount = false ) { |
|
| 3498 | + * Retrieves a specific discount. |
|
| 3499 | + * |
|
| 3500 | + * @since 1.0.19 |
|
| 3501 | + * @return float |
|
| 3502 | + */ |
|
| 3503 | + public function get_discount( $discount = false ) { |
|
| 3504 | 3504 | |
| 3505 | - // Backwards compatibilty. |
|
| 3506 | - if ( empty( $discount ) ) { |
|
| 3507 | - return $this->get_total_discount(); |
|
| 3508 | - } |
|
| 3505 | + // Backwards compatibilty. |
|
| 3506 | + if ( empty( $discount ) ) { |
|
| 3507 | + return $this->get_total_discount(); |
|
| 3508 | + } |
|
| 3509 | 3509 | |
| 3510 | 3510 | $discounts = $this->get_discounts(); |
| 3511 | - return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null; |
|
| 3511 | + return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null; |
|
| 3512 | 3512 | } |
| 3513 | 3513 | |
| 3514 | 3514 | /** |
| 3515 | - * Removes a specific discount. |
|
| 3516 | - * |
|
| 3517 | - * @since 1.0.19 |
|
| 3518 | - */ |
|
| 3519 | - public function remove_discount( $discount ) { |
|
| 3515 | + * Removes a specific discount. |
|
| 3516 | + * |
|
| 3517 | + * @since 1.0.19 |
|
| 3518 | + */ |
|
| 3519 | + public function remove_discount( $discount ) { |
|
| 3520 | 3520 | $discounts = $this->get_discounts(); |
| 3521 | 3521 | if ( isset( $discounts[ $discount ] ) ) { |
| 3522 | 3522 | unset( $discounts[ $discount ] ); |
| 3523 | 3523 | $this->set_prop( 'discounts', $discounts ); |
| 3524 | 3524 | } |
| 3525 | 3525 | |
| 3526 | - if ( 'discount_code' == $discount ) { |
|
| 3527 | - foreach ( $this->get_items() as $item ) { |
|
| 3528 | - $item->item_discount = 0; |
|
| 3529 | - $item->recurring_item_discount = 0; |
|
| 3530 | - } |
|
| 3531 | - } |
|
| 3526 | + if ( 'discount_code' == $discount ) { |
|
| 3527 | + foreach ( $this->get_items() as $item ) { |
|
| 3528 | + $item->item_discount = 0; |
|
| 3529 | + $item->recurring_item_discount = 0; |
|
| 3530 | + } |
|
| 3531 | + } |
|
| 3532 | 3532 | |
| 3533 | 3533 | } |
| 3534 | 3534 | |
@@ -3541,34 +3541,34 @@ discard block |
||
| 3541 | 3541 | if ( $this->is_taxable() ) { |
| 3542 | 3542 | |
| 3543 | 3543 | $taxes = $this->get_taxes(); |
| 3544 | - $taxes[ $tax['name'] ] = $tax; |
|
| 3545 | - $this->set_prop( 'taxes', $tax ); |
|
| 3544 | + $taxes[ $tax['name'] ] = $tax; |
|
| 3545 | + $this->set_prop( 'taxes', $tax ); |
|
| 3546 | 3546 | |
| 3547 | 3547 | } |
| 3548 | 3548 | } |
| 3549 | 3549 | |
| 3550 | 3550 | /** |
| 3551 | - * Retrieves a specific tax. |
|
| 3552 | - * |
|
| 3553 | - * @since 1.0.19 |
|
| 3554 | - */ |
|
| 3555 | - public function get_tax( $tax = null ) { |
|
| 3551 | + * Retrieves a specific tax. |
|
| 3552 | + * |
|
| 3553 | + * @since 1.0.19 |
|
| 3554 | + */ |
|
| 3555 | + public function get_tax( $tax = null ) { |
|
| 3556 | 3556 | |
| 3557 | - // Backwards compatility. |
|
| 3558 | - if ( empty( $tax ) ) { |
|
| 3559 | - return $this->get_total_tax(); |
|
| 3560 | - } |
|
| 3557 | + // Backwards compatility. |
|
| 3558 | + if ( empty( $tax ) ) { |
|
| 3559 | + return $this->get_total_tax(); |
|
| 3560 | + } |
|
| 3561 | 3561 | |
| 3562 | 3562 | $taxes = $this->get_taxes(); |
| 3563 | - return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null; |
|
| 3563 | + return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null; |
|
| 3564 | 3564 | } |
| 3565 | 3565 | |
| 3566 | 3566 | /** |
| 3567 | - * Removes a specific tax. |
|
| 3568 | - * |
|
| 3569 | - * @since 1.0.19 |
|
| 3570 | - */ |
|
| 3571 | - public function remove_tax( $tax ) { |
|
| 3567 | + * Removes a specific tax. |
|
| 3568 | + * |
|
| 3569 | + * @since 1.0.19 |
|
| 3570 | + */ |
|
| 3571 | + public function remove_tax( $tax ) { |
|
| 3572 | 3572 | $taxes = $this->get_taxes(); |
| 3573 | 3573 | if ( isset( $taxes[ $tax ] ) ) { |
| 3574 | 3574 | unset( $taxes[ $tax ] ); |
@@ -3577,184 +3577,184 @@ discard block |
||
| 3577 | 3577 | } |
| 3578 | 3578 | |
| 3579 | 3579 | /** |
| 3580 | - * Recalculates the invoice subtotal. |
|
| 3581 | - * |
|
| 3582 | - * @since 1.0.19 |
|
| 3583 | - * @return float The recalculated subtotal |
|
| 3584 | - */ |
|
| 3585 | - public function recalculate_subtotal() { |
|
| 3580 | + * Recalculates the invoice subtotal. |
|
| 3581 | + * |
|
| 3582 | + * @since 1.0.19 |
|
| 3583 | + * @return float The recalculated subtotal |
|
| 3584 | + */ |
|
| 3585 | + public function recalculate_subtotal() { |
|
| 3586 | 3586 | $items = $this->get_items(); |
| 3587 | - $subtotal = 0; |
|
| 3588 | - $recurring = 0; |
|
| 3587 | + $subtotal = 0; |
|
| 3588 | + $recurring = 0; |
|
| 3589 | 3589 | |
| 3590 | 3590 | foreach ( $items as $item ) { |
| 3591 | - $subtotal += $item->get_sub_total( 'edit' ); |
|
| 3592 | - $recurring += $item->get_recurring_sub_total( 'edit' ); |
|
| 3591 | + $subtotal += $item->get_sub_total( 'edit' ); |
|
| 3592 | + $recurring += $item->get_recurring_sub_total( 'edit' ); |
|
| 3593 | 3593 | } |
| 3594 | 3594 | |
| 3595 | - if ( wpinv_prices_include_tax() ) { |
|
| 3596 | - $subtotal = max( 0, $subtotal - $this->totals['tax']['initial'] ); |
|
| 3597 | - $recurring = max( 0, $recurring - $this->totals['tax']['recurring'] ); |
|
| 3598 | - } |
|
| 3595 | + if ( wpinv_prices_include_tax() ) { |
|
| 3596 | + $subtotal = max( 0, $subtotal - $this->totals['tax']['initial'] ); |
|
| 3597 | + $recurring = max( 0, $recurring - $this->totals['tax']['recurring'] ); |
|
| 3598 | + } |
|
| 3599 | 3599 | |
| 3600 | - $current = $this->is_renewal() ? $recurring : $subtotal; |
|
| 3601 | - $this->set_subtotal( $current ); |
|
| 3600 | + $current = $this->is_renewal() ? $recurring : $subtotal; |
|
| 3601 | + $this->set_subtotal( $current ); |
|
| 3602 | 3602 | |
| 3603 | - $this->totals['subtotal'] = array( |
|
| 3604 | - 'initial' => $subtotal, |
|
| 3605 | - 'recurring' => $recurring, |
|
| 3606 | - ); |
|
| 3603 | + $this->totals['subtotal'] = array( |
|
| 3604 | + 'initial' => $subtotal, |
|
| 3605 | + 'recurring' => $recurring, |
|
| 3606 | + ); |
|
| 3607 | 3607 | |
| 3608 | 3608 | return $current; |
| 3609 | 3609 | } |
| 3610 | 3610 | |
| 3611 | 3611 | /** |
| 3612 | - * Recalculates the invoice discount total. |
|
| 3613 | - * |
|
| 3614 | - * @since 1.0.19 |
|
| 3615 | - * @return float The recalculated discount |
|
| 3616 | - */ |
|
| 3617 | - public function recalculate_total_discount() { |
|
| 3612 | + * Recalculates the invoice discount total. |
|
| 3613 | + * |
|
| 3614 | + * @since 1.0.19 |
|
| 3615 | + * @return float The recalculated discount |
|
| 3616 | + */ |
|
| 3617 | + public function recalculate_total_discount() { |
|
| 3618 | 3618 | $discounts = $this->get_discounts(); |
| 3619 | - $discount = 0; |
|
| 3620 | - $recurring = 0; |
|
| 3619 | + $discount = 0; |
|
| 3620 | + $recurring = 0; |
|
| 3621 | 3621 | |
| 3622 | 3622 | foreach ( $discounts as $data ) { |
| 3623 | - $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
| 3624 | - $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
| 3625 | - } |
|
| 3623 | + $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
| 3624 | + $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
| 3625 | + } |
|
| 3626 | 3626 | |
| 3627 | - $current = $this->is_renewal() ? $recurring : $discount; |
|
| 3627 | + $current = $this->is_renewal() ? $recurring : $discount; |
|
| 3628 | 3628 | |
| 3629 | - $this->set_total_discount( $current ); |
|
| 3629 | + $this->set_total_discount( $current ); |
|
| 3630 | 3630 | |
| 3631 | - $this->totals['discount'] = array( |
|
| 3632 | - 'initial' => $discount, |
|
| 3633 | - 'recurring' => $recurring, |
|
| 3634 | - ); |
|
| 3631 | + $this->totals['discount'] = array( |
|
| 3632 | + 'initial' => $discount, |
|
| 3633 | + 'recurring' => $recurring, |
|
| 3634 | + ); |
|
| 3635 | 3635 | |
| 3636 | - return $current; |
|
| 3636 | + return $current; |
|
| 3637 | 3637 | |
| 3638 | 3638 | } |
| 3639 | 3639 | |
| 3640 | 3640 | /** |
| 3641 | - * Recalculates the invoice tax total. |
|
| 3642 | - * |
|
| 3643 | - * @since 1.0.19 |
|
| 3644 | - * @return float The recalculated tax |
|
| 3645 | - */ |
|
| 3646 | - public function recalculate_total_tax() { |
|
| 3641 | + * Recalculates the invoice tax total. |
|
| 3642 | + * |
|
| 3643 | + * @since 1.0.19 |
|
| 3644 | + * @return float The recalculated tax |
|
| 3645 | + */ |
|
| 3646 | + public function recalculate_total_tax() { |
|
| 3647 | 3647 | |
| 3648 | - // Maybe disable taxes. |
|
| 3649 | - $vat_number = $this->get_vat_number(); |
|
| 3650 | - $skip_tax = GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $this->get_country() ) && ! empty( $vat_number ); |
|
| 3648 | + // Maybe disable taxes. |
|
| 3649 | + $vat_number = $this->get_vat_number(); |
|
| 3650 | + $skip_tax = GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $this->get_country() ) && ! empty( $vat_number ); |
|
| 3651 | 3651 | |
| 3652 | - if ( wpinv_is_base_country( $this->get_country() ) && 'vat_too' === wpinv_get_option( 'vat_same_country_rule', 'vat_too' ) ) { |
|
| 3653 | - $skip_tax = false; |
|
| 3654 | - } |
|
| 3652 | + if ( wpinv_is_base_country( $this->get_country() ) && 'vat_too' === wpinv_get_option( 'vat_same_country_rule', 'vat_too' ) ) { |
|
| 3653 | + $skip_tax = false; |
|
| 3654 | + } |
|
| 3655 | 3655 | |
| 3656 | - if ( ! wpinv_use_taxes() || $this->get_disable_taxes() || ! wpinv_is_country_taxable( $this->get_country() ) || $skip_tax ) { |
|
| 3656 | + if ( ! wpinv_use_taxes() || $this->get_disable_taxes() || ! wpinv_is_country_taxable( $this->get_country() ) || $skip_tax ) { |
|
| 3657 | 3657 | |
| 3658 | - $this->totals['tax'] = array( |
|
| 3659 | - 'initial' => 0, |
|
| 3660 | - 'recurring' => 0, |
|
| 3661 | - ); |
|
| 3658 | + $this->totals['tax'] = array( |
|
| 3659 | + 'initial' => 0, |
|
| 3660 | + 'recurring' => 0, |
|
| 3661 | + ); |
|
| 3662 | 3662 | |
| 3663 | - $this->tax_rate = 0; |
|
| 3663 | + $this->tax_rate = 0; |
|
| 3664 | 3664 | |
| 3665 | - $this->set_taxes( array() ); |
|
| 3666 | - $current = 0; |
|
| 3667 | - } else { |
|
| 3665 | + $this->set_taxes( array() ); |
|
| 3666 | + $current = 0; |
|
| 3667 | + } else { |
|
| 3668 | 3668 | |
| 3669 | - $item_taxes = array(); |
|
| 3669 | + $item_taxes = array(); |
|
| 3670 | 3670 | |
| 3671 | - foreach ( $this->get_items() as $item ) { |
|
| 3672 | - $rates = getpaid_get_item_tax_rates( $item, $this->get_country(), $this->get_state() ); |
|
| 3673 | - $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
| 3674 | - $taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, false ), $rates ); |
|
| 3675 | - $r_taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, true ), $rates ); |
|
| 3676 | - foreach ( $taxes as $name => $amount ) { |
|
| 3677 | - $recurring = isset( $r_taxes[ $name ] ) ? $r_taxes[ $name ] : 0; |
|
| 3678 | - $tax = getpaid_prepare_item_tax( $item, $name, $amount, $recurring ); |
|
| 3671 | + foreach ( $this->get_items() as $item ) { |
|
| 3672 | + $rates = getpaid_get_item_tax_rates( $item, $this->get_country(), $this->get_state() ); |
|
| 3673 | + $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
| 3674 | + $taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, false ), $rates ); |
|
| 3675 | + $r_taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, true ), $rates ); |
|
| 3676 | + foreach ( $taxes as $name => $amount ) { |
|
| 3677 | + $recurring = isset( $r_taxes[ $name ] ) ? $r_taxes[ $name ] : 0; |
|
| 3678 | + $tax = getpaid_prepare_item_tax( $item, $name, $amount, $recurring ); |
|
| 3679 | 3679 | |
| 3680 | - if ( ! isset( $item_taxes[ $name ] ) ) { |
|
| 3681 | - $item_taxes[ $name ] = $tax; |
|
| 3682 | - continue; |
|
| 3683 | - } |
|
| 3680 | + if ( ! isset( $item_taxes[ $name ] ) ) { |
|
| 3681 | + $item_taxes[ $name ] = $tax; |
|
| 3682 | + continue; |
|
| 3683 | + } |
|
| 3684 | 3684 | |
| 3685 | - $item_taxes[ $name ]['initial_tax'] += $tax['initial_tax']; |
|
| 3686 | - $item_taxes[ $name ]['recurring_tax'] += $tax['recurring_tax']; |
|
| 3685 | + $item_taxes[ $name ]['initial_tax'] += $tax['initial_tax']; |
|
| 3686 | + $item_taxes[ $name ]['recurring_tax'] += $tax['recurring_tax']; |
|
| 3687 | 3687 | |
| 3688 | - } |
|
| 3689 | - } |
|
| 3688 | + } |
|
| 3689 | + } |
|
| 3690 | 3690 | |
| 3691 | - $item_taxes = array_replace( $this->get_taxes(), $item_taxes ); |
|
| 3692 | - $this->set_taxes( $item_taxes ); |
|
| 3691 | + $item_taxes = array_replace( $this->get_taxes(), $item_taxes ); |
|
| 3692 | + $this->set_taxes( $item_taxes ); |
|
| 3693 | 3693 | |
| 3694 | - $initial_tax = array_sum( wp_list_pluck( $item_taxes, 'initial_tax' ) ); |
|
| 3695 | - $recurring_tax = array_sum( wp_list_pluck( $item_taxes, 'recurring_tax' ) ); |
|
| 3694 | + $initial_tax = array_sum( wp_list_pluck( $item_taxes, 'initial_tax' ) ); |
|
| 3695 | + $recurring_tax = array_sum( wp_list_pluck( $item_taxes, 'recurring_tax' ) ); |
|
| 3696 | 3696 | |
| 3697 | - $current = $this->is_renewal() ? $recurring_tax : $initial_tax; |
|
| 3697 | + $current = $this->is_renewal() ? $recurring_tax : $initial_tax; |
|
| 3698 | 3698 | |
| 3699 | - $this->totals['tax'] = array( |
|
| 3700 | - 'initial' => $initial_tax, |
|
| 3701 | - 'recurring' => $recurring_tax, |
|
| 3702 | - ); |
|
| 3699 | + $this->totals['tax'] = array( |
|
| 3700 | + 'initial' => $initial_tax, |
|
| 3701 | + 'recurring' => $recurring_tax, |
|
| 3702 | + ); |
|
| 3703 | 3703 | |
| 3704 | - } |
|
| 3704 | + } |
|
| 3705 | 3705 | |
| 3706 | - $this->set_total_tax( $current ); |
|
| 3706 | + $this->set_total_tax( $current ); |
|
| 3707 | 3707 | |
| 3708 | - return $current; |
|
| 3708 | + return $current; |
|
| 3709 | 3709 | |
| 3710 | 3710 | } |
| 3711 | 3711 | |
| 3712 | 3712 | /** |
| 3713 | - * Recalculates the invoice fees total. |
|
| 3714 | - * |
|
| 3715 | - * @since 1.0.19 |
|
| 3716 | - * @return float The recalculated fee |
|
| 3717 | - */ |
|
| 3718 | - public function recalculate_total_fees() { |
|
| 3719 | - $fees = $this->get_fees(); |
|
| 3720 | - $fee = 0; |
|
| 3721 | - $recurring = 0; |
|
| 3713 | + * Recalculates the invoice fees total. |
|
| 3714 | + * |
|
| 3715 | + * @since 1.0.19 |
|
| 3716 | + * @return float The recalculated fee |
|
| 3717 | + */ |
|
| 3718 | + public function recalculate_total_fees() { |
|
| 3719 | + $fees = $this->get_fees(); |
|
| 3720 | + $fee = 0; |
|
| 3721 | + $recurring = 0; |
|
| 3722 | 3722 | |
| 3723 | 3723 | foreach ( $fees as $data ) { |
| 3724 | - $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
| 3725 | - $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
| 3726 | - } |
|
| 3724 | + $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
| 3725 | + $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
| 3726 | + } |
|
| 3727 | 3727 | |
| 3728 | - $current = $this->is_renewal() ? $recurring : $fee; |
|
| 3729 | - $this->set_total_fees( $current ); |
|
| 3728 | + $current = $this->is_renewal() ? $recurring : $fee; |
|
| 3729 | + $this->set_total_fees( $current ); |
|
| 3730 | 3730 | |
| 3731 | - $this->totals['fee'] = array( |
|
| 3732 | - 'initial' => $fee, |
|
| 3733 | - 'recurring' => $recurring, |
|
| 3734 | - ); |
|
| 3731 | + $this->totals['fee'] = array( |
|
| 3732 | + 'initial' => $fee, |
|
| 3733 | + 'recurring' => $recurring, |
|
| 3734 | + ); |
|
| 3735 | 3735 | |
| 3736 | 3736 | $this->set_total_fees( $fee ); |
| 3737 | 3737 | return $current; |
| 3738 | 3738 | } |
| 3739 | 3739 | |
| 3740 | 3740 | /** |
| 3741 | - * Recalculates the invoice total. |
|
| 3742 | - * |
|
| 3743 | - * @since 1.0.19 |
|
| 3741 | + * Recalculates the invoice total. |
|
| 3742 | + * |
|
| 3743 | + * @since 1.0.19 |
|
| 3744 | 3744 | * @return float The invoice total |
| 3745 | - */ |
|
| 3746 | - public function recalculate_total() { |
|
| 3745 | + */ |
|
| 3746 | + public function recalculate_total() { |
|
| 3747 | 3747 | $this->recalculate_total_fees(); |
| 3748 | 3748 | $this->recalculate_total_discount(); |
| 3749 | - $this->recalculate_total_tax(); |
|
| 3750 | - $this->recalculate_subtotal(); |
|
| 3751 | - $this->set_total( $this->get_total_tax( 'edit' ) + $this->get_total_fees( 'edit' ) + $this->get_subtotal( 'edit' ) - $this->get_total_discount( 'edit' ) ); |
|
| 3752 | - return $this->get_total(); |
|
| 3753 | - } |
|
| 3754 | - |
|
| 3755 | - /** |
|
| 3756 | - * @deprecated |
|
| 3757 | - */ |
|
| 3749 | + $this->recalculate_total_tax(); |
|
| 3750 | + $this->recalculate_subtotal(); |
|
| 3751 | + $this->set_total( $this->get_total_tax( 'edit' ) + $this->get_total_fees( 'edit' ) + $this->get_subtotal( 'edit' ) - $this->get_total_discount( 'edit' ) ); |
|
| 3752 | + return $this->get_total(); |
|
| 3753 | + } |
|
| 3754 | + |
|
| 3755 | + /** |
|
| 3756 | + * @deprecated |
|
| 3757 | + */ |
|
| 3758 | 3758 | public function recalculate_totals() { |
| 3759 | 3759 | $this->recalculate_total(); |
| 3760 | 3760 | $this->save( true ); |
@@ -3768,22 +3768,22 @@ discard block |
||
| 3768 | 3768 | return $this->get_data(); |
| 3769 | 3769 | } |
| 3770 | 3770 | |
| 3771 | - /** |
|
| 3771 | + /** |
|
| 3772 | 3772 | * Adds a system note to an invoice. |
| 3773 | 3773 | * |
| 3774 | 3774 | * @param string $note The note being added. |
| 3775 | - * @return int|false The new note's ID on success, false on failure. |
|
| 3775 | + * @return int|false The new note's ID on success, false on failure. |
|
| 3776 | 3776 | * |
| 3777 | 3777 | */ |
| 3778 | 3778 | public function add_system_note( $note ) { |
| 3779 | - return $this->add_note( $note, false, false, true ); |
|
| 3780 | - } |
|
| 3779 | + return $this->add_note( $note, false, false, true ); |
|
| 3780 | + } |
|
| 3781 | 3781 | |
| 3782 | 3782 | /** |
| 3783 | 3783 | * Adds a note to an invoice. |
| 3784 | 3784 | * |
| 3785 | 3785 | * @param string $note The note being added. |
| 3786 | - * @return int|false The new note's ID on success, false on failure. |
|
| 3786 | + * @return int|false The new note's ID on success, false on failure. |
|
| 3787 | 3787 | * |
| 3788 | 3788 | */ |
| 3789 | 3789 | public function add_note( $note = '', $customer_type = false, $added_by_user = false, $system = false ) { |
@@ -3793,21 +3793,21 @@ discard block |
||
| 3793 | 3793 | return false; |
| 3794 | 3794 | } |
| 3795 | 3795 | |
| 3796 | - $author = 'System'; |
|
| 3797 | - $author_email = '[email protected]'; |
|
| 3796 | + $author = 'System'; |
|
| 3797 | + $author_email = '[email protected]'; |
|
| 3798 | 3798 | |
| 3799 | - // If this is an admin comment or it has been added by the user. |
|
| 3800 | - if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
| 3801 | - $user = get_user_by( 'id', get_current_user_id() ); |
|
| 3799 | + // If this is an admin comment or it has been added by the user. |
|
| 3800 | + if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
| 3801 | + $user = get_user_by( 'id', get_current_user_id() ); |
|
| 3802 | 3802 | $author = $user->display_name; |
| 3803 | 3803 | $author_email = $user->user_email; |
| 3804 | - } |
|
| 3804 | + } |
|
| 3805 | 3805 | |
| 3806 | - return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
| 3806 | + return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
| 3807 | 3807 | |
| 3808 | - } |
|
| 3808 | + } |
|
| 3809 | 3809 | |
| 3810 | - /** |
|
| 3810 | + /** |
|
| 3811 | 3811 | * Generates a unique key for the invoice. |
| 3812 | 3812 | */ |
| 3813 | 3813 | public function generate_key( $string = '' ) { |
@@ -3827,113 +3827,113 @@ discard block |
||
| 3827 | 3827 | $number = wpinv_get_next_invoice_number( $this->get_post_type() ); |
| 3828 | 3828 | } |
| 3829 | 3829 | |
| 3830 | - return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
| 3831 | - |
|
| 3832 | - } |
|
| 3833 | - |
|
| 3834 | - /** |
|
| 3835 | - * Handle the status transition. |
|
| 3836 | - */ |
|
| 3837 | - protected function status_transition() { |
|
| 3838 | - $status_transition = $this->status_transition; |
|
| 3839 | - |
|
| 3840 | - // Reset status transition variable. |
|
| 3841 | - $this->status_transition = false; |
|
| 3842 | - |
|
| 3843 | - if ( $status_transition ) { |
|
| 3844 | - try { |
|
| 3845 | - |
|
| 3846 | - // Fire a hook for the status change. |
|
| 3847 | - do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
| 3848 | - |
|
| 3849 | - // @deprecated this is deprecated and will be removed in the future. |
|
| 3850 | - do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
| 3851 | - |
|
| 3852 | - if ( ! empty( $status_transition['from'] ) ) { |
|
| 3853 | - |
|
| 3854 | - /* translators: 1: old invoice status 2: new invoice status */ |
|
| 3855 | - $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 ) ); |
|
| 3856 | - |
|
| 3857 | - // Fire another hook. |
|
| 3858 | - do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
| 3859 | - do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
| 3830 | + return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
| 3860 | 3831 | |
| 3861 | - // @deprecated this is deprecated and will be removed in the future. |
|
| 3862 | - do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
| 3863 | - |
|
| 3864 | - // Note the transition occurred. |
|
| 3865 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), false, $status_transition['manual'] ); |
|
| 3866 | - |
|
| 3867 | - // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
| 3868 | - if ( |
|
| 3869 | - in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
| 3870 | - && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
| 3871 | - ) { |
|
| 3872 | - do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
| 3873 | - } |
|
| 3874 | - |
|
| 3875 | - // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
| 3876 | - if ( |
|
| 3877 | - in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
| 3878 | - && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
| 3879 | - ) { |
|
| 3880 | - do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
| 3881 | - } |
|
| 3882 | - } else { |
|
| 3883 | - /* translators: %s: new invoice status */ |
|
| 3884 | - $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
| 3885 | - |
|
| 3886 | - // Note the transition occurred. |
|
| 3887 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
| 3832 | + } |
|
| 3888 | 3833 | |
| 3889 | - } |
|
| 3890 | - } catch ( Exception $e ) { |
|
| 3891 | - $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
| 3892 | - } |
|
| 3893 | - } |
|
| 3894 | - } |
|
| 3834 | + /** |
|
| 3835 | + * Handle the status transition. |
|
| 3836 | + */ |
|
| 3837 | + protected function status_transition() { |
|
| 3838 | + $status_transition = $this->status_transition; |
|
| 3839 | + |
|
| 3840 | + // Reset status transition variable. |
|
| 3841 | + $this->status_transition = false; |
|
| 3842 | + |
|
| 3843 | + if ( $status_transition ) { |
|
| 3844 | + try { |
|
| 3845 | + |
|
| 3846 | + // Fire a hook for the status change. |
|
| 3847 | + do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
| 3848 | + |
|
| 3849 | + // @deprecated this is deprecated and will be removed in the future. |
|
| 3850 | + do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
| 3851 | + |
|
| 3852 | + if ( ! empty( $status_transition['from'] ) ) { |
|
| 3853 | + |
|
| 3854 | + /* translators: 1: old invoice status 2: new invoice status */ |
|
| 3855 | + $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 ) ); |
|
| 3856 | + |
|
| 3857 | + // Fire another hook. |
|
| 3858 | + do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
| 3859 | + do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
| 3860 | + |
|
| 3861 | + // @deprecated this is deprecated and will be removed in the future. |
|
| 3862 | + do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
| 3863 | + |
|
| 3864 | + // Note the transition occurred. |
|
| 3865 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), false, $status_transition['manual'] ); |
|
| 3866 | + |
|
| 3867 | + // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
| 3868 | + if ( |
|
| 3869 | + in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
| 3870 | + && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
| 3871 | + ) { |
|
| 3872 | + do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
| 3873 | + } |
|
| 3874 | + |
|
| 3875 | + // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
| 3876 | + if ( |
|
| 3877 | + in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
| 3878 | + && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
| 3879 | + ) { |
|
| 3880 | + do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
| 3881 | + } |
|
| 3882 | + } else { |
|
| 3883 | + /* translators: %s: new invoice status */ |
|
| 3884 | + $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
| 3885 | + |
|
| 3886 | + // Note the transition occurred. |
|
| 3887 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
| 3888 | + |
|
| 3889 | + } |
|
| 3890 | + } catch ( Exception $e ) { |
|
| 3891 | + $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
| 3892 | + } |
|
| 3893 | + } |
|
| 3894 | + } |
|
| 3895 | 3895 | |
| 3896 | - /** |
|
| 3897 | - * Updates an invoice status. |
|
| 3898 | - */ |
|
| 3899 | - public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
| 3896 | + /** |
|
| 3897 | + * Updates an invoice status. |
|
| 3898 | + */ |
|
| 3899 | + public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
| 3900 | 3900 | |
| 3901 | - // Fires before updating a status. |
|
| 3902 | - do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
| 3901 | + // Fires before updating a status. |
|
| 3902 | + do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
| 3903 | 3903 | |
| 3904 | - // Update the status. |
|
| 3905 | - $this->set_status( $new_status, $note, $manual ); |
|
| 3904 | + // Update the status. |
|
| 3905 | + $this->set_status( $new_status, $note, $manual ); |
|
| 3906 | 3906 | |
| 3907 | - // Save the order. |
|
| 3908 | - return $this->save(); |
|
| 3907 | + // Save the order. |
|
| 3908 | + return $this->save(); |
|
| 3909 | 3909 | |
| 3910 | - } |
|
| 3910 | + } |
|
| 3911 | 3911 | |
| 3912 | - /** |
|
| 3913 | - * @deprecated |
|
| 3914 | - */ |
|
| 3915 | - public function refresh_item_ids() { |
|
| 3912 | + /** |
|
| 3913 | + * @deprecated |
|
| 3914 | + */ |
|
| 3915 | + public function refresh_item_ids() { |
|
| 3916 | 3916 | $item_ids = implode( ',', array_unique( wp_list_pluck( $this->get_cart_details(), 'item_id' ) ) ); |
| 3917 | 3917 | update_post_meta( $this->get_id(), '_wpinv_item_ids', $item_ids ); |
| 3918 | - } |
|
| 3918 | + } |
|
| 3919 | 3919 | |
| 3920 | - /** |
|
| 3921 | - * @deprecated |
|
| 3922 | - */ |
|
| 3923 | - public function update_items( $temp = false ) { |
|
| 3920 | + /** |
|
| 3921 | + * @deprecated |
|
| 3922 | + */ |
|
| 3923 | + public function update_items( $temp = false ) { |
|
| 3924 | 3924 | |
| 3925 | - $this->set_items( $this->get_items() ); |
|
| 3925 | + $this->set_items( $this->get_items() ); |
|
| 3926 | 3926 | |
| 3927 | - if ( ! $temp ) { |
|
| 3928 | - $this->save(); |
|
| 3929 | - } |
|
| 3927 | + if ( ! $temp ) { |
|
| 3928 | + $this->save(); |
|
| 3929 | + } |
|
| 3930 | 3930 | |
| 3931 | 3931 | return $this; |
| 3932 | - } |
|
| 3932 | + } |
|
| 3933 | 3933 | |
| 3934 | - /** |
|
| 3935 | - * @deprecated |
|
| 3936 | - */ |
|
| 3934 | + /** |
|
| 3935 | + * @deprecated |
|
| 3936 | + */ |
|
| 3937 | 3937 | public function validate_discount() { |
| 3938 | 3938 | |
| 3939 | 3939 | $discount_code = $this->get_discount_code(); |
@@ -3949,101 +3949,101 @@ discard block |
||
| 3949 | 3949 | |
| 3950 | 3950 | } |
| 3951 | 3951 | |
| 3952 | - /** |
|
| 3953 | - * Refunds an invoice. |
|
| 3954 | - */ |
|
| 3952 | + /** |
|
| 3953 | + * Refunds an invoice. |
|
| 3954 | + */ |
|
| 3955 | 3955 | public function refund() { |
| 3956 | - $this->set_status( 'wpi-refunded' ); |
|
| 3956 | + $this->set_status( 'wpi-refunded' ); |
|
| 3957 | 3957 | $this->save(); |
| 3958 | - } |
|
| 3958 | + } |
|
| 3959 | 3959 | |
| 3960 | - /** |
|
| 3961 | - * Marks an invoice as paid. |
|
| 3962 | - * |
|
| 3963 | - * @param string $transaction_id |
|
| 3964 | - */ |
|
| 3960 | + /** |
|
| 3961 | + * Marks an invoice as paid. |
|
| 3962 | + * |
|
| 3963 | + * @param string $transaction_id |
|
| 3964 | + */ |
|
| 3965 | 3965 | public function mark_paid( $transaction_id = null, $note = '' ) { |
| 3966 | 3966 | |
| 3967 | - // Set the transaction id. |
|
| 3968 | - if ( empty( $transaction_id ) ) { |
|
| 3969 | - $transaction_id = $this->generate_key( 'trans_' ); |
|
| 3970 | - } |
|
| 3967 | + // Set the transaction id. |
|
| 3968 | + if ( empty( $transaction_id ) ) { |
|
| 3969 | + $transaction_id = $this->generate_key( 'trans_' ); |
|
| 3970 | + } |
|
| 3971 | 3971 | |
| 3972 | - if ( ! $this->get_transaction_id() ) { |
|
| 3973 | - $this->set_transaction_id( $transaction_id ); |
|
| 3974 | - } |
|
| 3972 | + if ( ! $this->get_transaction_id() ) { |
|
| 3973 | + $this->set_transaction_id( $transaction_id ); |
|
| 3974 | + } |
|
| 3975 | 3975 | |
| 3976 | - if ( $this->is_paid() && 'wpi-processing' !== $this->get_status() ) { |
|
| 3977 | - return $this->save(); |
|
| 3978 | - } |
|
| 3976 | + if ( $this->is_paid() && 'wpi-processing' !== $this->get_status() ) { |
|
| 3977 | + return $this->save(); |
|
| 3978 | + } |
|
| 3979 | 3979 | |
| 3980 | - // Set the completed date. |
|
| 3981 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
| 3980 | + // Set the completed date. |
|
| 3981 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
| 3982 | 3982 | |
| 3983 | - // Set the new status. |
|
| 3984 | - $gateway = sanitize_text_field( $this->get_gateway_title() ); |
|
| 3985 | - if ( $this->is_renewal() || ! $this->is_parent() ) { |
|
| 3983 | + // Set the new status. |
|
| 3984 | + $gateway = sanitize_text_field( $this->get_gateway_title() ); |
|
| 3985 | + if ( $this->is_renewal() || ! $this->is_parent() ) { |
|
| 3986 | 3986 | |
| 3987 | - $_note = wp_sprintf( __( 'Renewed via %s', 'invoicing' ), $gateway ); |
|
| 3988 | - $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
| 3987 | + $_note = wp_sprintf( __( 'Renewed via %s', 'invoicing' ), $gateway ); |
|
| 3988 | + $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
| 3989 | 3989 | |
| 3990 | - if ( 'none' == $this->get_gateway() ) { |
|
| 3991 | - $_note = $note; |
|
| 3992 | - } |
|
| 3990 | + if ( 'none' == $this->get_gateway() ) { |
|
| 3991 | + $_note = $note; |
|
| 3992 | + } |
|
| 3993 | 3993 | |
| 3994 | - $this->set_status( 'wpi-renewal', $_note ); |
|
| 3994 | + $this->set_status( 'wpi-renewal', $_note ); |
|
| 3995 | 3995 | |
| 3996 | - } else { |
|
| 3996 | + } else { |
|
| 3997 | 3997 | |
| 3998 | - $_note = wp_sprintf( __( 'Paid via %s', 'invoicing' ), $gateway ); |
|
| 3999 | - $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
| 3998 | + $_note = wp_sprintf( __( 'Paid via %s', 'invoicing' ), $gateway ); |
|
| 3999 | + $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
| 4000 | 4000 | |
| 4001 | - if ( 'none' == $this->get_gateway() ) { |
|
| 4002 | - $_note = $note; |
|
| 4003 | - } |
|
| 4001 | + if ( 'none' == $this->get_gateway() ) { |
|
| 4002 | + $_note = $note; |
|
| 4003 | + } |
|
| 4004 | 4004 | |
| 4005 | - $this->set_status( 'publish', $_note ); |
|
| 4005 | + $this->set_status( 'publish', $_note ); |
|
| 4006 | 4006 | |
| 4007 | - } |
|
| 4007 | + } |
|
| 4008 | 4008 | |
| 4009 | - // Set checkout mode. |
|
| 4010 | - $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
| 4011 | - $this->set_mode( $mode ); |
|
| 4009 | + // Set checkout mode. |
|
| 4010 | + $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
| 4011 | + $this->set_mode( $mode ); |
|
| 4012 | 4012 | |
| 4013 | - // Save the invoice. |
|
| 4013 | + // Save the invoice. |
|
| 4014 | 4014 | $this->save(); |
| 4015 | - } |
|
| 4016 | - |
|
| 4017 | - /** |
|
| 4018 | - * Save data to the database. |
|
| 4019 | - * |
|
| 4020 | - * @since 1.0.19 |
|
| 4021 | - * @return int invoice ID |
|
| 4022 | - */ |
|
| 4023 | - public function save() { |
|
| 4024 | - $this->maybe_set_date_paid(); |
|
| 4025 | - $this->maybe_set_key(); |
|
| 4026 | - parent::save(); |
|
| 4027 | - $this->clear_cache(); |
|
| 4028 | - $this->status_transition(); |
|
| 4029 | - return $this->get_id(); |
|
| 4030 | - } |
|
| 4031 | - |
|
| 4032 | - /** |
|
| 4015 | + } |
|
| 4016 | + |
|
| 4017 | + /** |
|
| 4018 | + * Save data to the database. |
|
| 4019 | + * |
|
| 4020 | + * @since 1.0.19 |
|
| 4021 | + * @return int invoice ID |
|
| 4022 | + */ |
|
| 4023 | + public function save() { |
|
| 4024 | + $this->maybe_set_date_paid(); |
|
| 4025 | + $this->maybe_set_key(); |
|
| 4026 | + parent::save(); |
|
| 4027 | + $this->clear_cache(); |
|
| 4028 | + $this->status_transition(); |
|
| 4029 | + return $this->get_id(); |
|
| 4030 | + } |
|
| 4031 | + |
|
| 4032 | + /** |
|
| 4033 | 4033 | * Clears the subscription's cache. |
| 4034 | 4034 | */ |
| 4035 | 4035 | public function clear_cache() { |
| 4036 | - if ( $this->get_key() ) { |
|
| 4037 | - wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
| 4038 | - } |
|
| 4039 | - |
|
| 4040 | - if ( $this->get_number() ) { |
|
| 4041 | - wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
| 4042 | - } |
|
| 4043 | - |
|
| 4044 | - if ( $this->get_transaction_id() ) { |
|
| 4045 | - wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
| 4046 | - } |
|
| 4047 | - } |
|
| 4036 | + if ( $this->get_key() ) { |
|
| 4037 | + wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
| 4038 | + } |
|
| 4039 | + |
|
| 4040 | + if ( $this->get_number() ) { |
|
| 4041 | + wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
| 4042 | + } |
|
| 4043 | + |
|
| 4044 | + if ( $this->get_transaction_id() ) { |
|
| 4045 | + wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
| 4046 | + } |
|
| 4047 | + } |
|
| 4048 | 4048 | |
| 4049 | 4049 | } |
@@ -5,7 +5,7 @@ discard block |
||
| 5 | 5 | * |
| 6 | 6 | */ |
| 7 | 7 | if ( ! defined( 'ABSPATH' ) ) { |
| 8 | - exit; |
|
| 8 | + exit; |
|
| 9 | 9 | } |
| 10 | 10 | |
| 11 | 11 | /** |
@@ -15,545 +15,545 @@ discard block |
||
| 15 | 15 | */ |
| 16 | 16 | class GetPaid_Invoice_Data_Store extends GetPaid_Data_Store_WP { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * Data stored in meta keys, but not considered "meta" for a discount. |
|
| 20 | - * |
|
| 21 | - * @since 1.0.19 |
|
| 22 | - * @var array |
|
| 23 | - */ |
|
| 24 | - protected $internal_meta_keys = array( |
|
| 25 | - '_wpinv_subscr_profile_id', |
|
| 26 | - '_wpinv_subscription_id', |
|
| 27 | - '_wpinv_taxes', |
|
| 28 | - '_wpinv_fees', |
|
| 29 | - '_wpinv_discounts', |
|
| 30 | - '_wpinv_submission_id', |
|
| 31 | - '_wpinv_payment_form', |
|
| 32 | - '_wpinv_is_viewed', |
|
| 33 | - '_wpinv_phone', |
|
| 34 | - '_wpinv_company_id', |
|
| 35 | - 'wpinv_shipping', |
|
| 36 | - 'wpinv_email_cc', |
|
| 37 | - 'wpinv_template', |
|
| 38 | - 'wpinv_created_via', |
|
| 39 | - ); |
|
| 40 | - |
|
| 41 | - /** |
|
| 42 | - * A map of meta keys to data props. |
|
| 43 | - * |
|
| 44 | - * @since 1.0.19 |
|
| 45 | - * |
|
| 46 | - * @var array |
|
| 47 | - */ |
|
| 48 | - protected $meta_key_to_props = array( |
|
| 49 | - '_wpinv_subscr_profile_id' => 'remote_subscription_id', |
|
| 50 | - '_wpinv_subscription_id' => 'subscription_id', |
|
| 51 | - '_wpinv_taxes' => 'taxes', |
|
| 52 | - '_wpinv_fees' => 'fees', |
|
| 53 | - '_wpinv_discounts' => 'discounts', |
|
| 54 | - '_wpinv_submission_id' => 'submission_id', |
|
| 55 | - '_wpinv_payment_form' => 'payment_form', |
|
| 56 | - '_wpinv_is_viewed' => 'is_viewed', |
|
| 57 | - 'wpinv_email_cc' => 'email_cc', |
|
| 58 | - 'wpinv_template' => 'template', |
|
| 59 | - 'wpinv_created_via' => 'created_via', |
|
| 60 | - '_wpinv_phone' => 'phone', |
|
| 61 | - '_wpinv_company_id' => 'company_id', |
|
| 62 | - 'wpinv_shipping' => 'shipping', |
|
| 63 | - ); |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * A map of database fields to data props. |
|
| 67 | - * |
|
| 68 | - * @since 1.0.19 |
|
| 69 | - * |
|
| 70 | - * @var array |
|
| 71 | - */ |
|
| 72 | - protected $database_fields_to_props = array( |
|
| 73 | - 'post_id' => 'id', |
|
| 74 | - 'number' => 'number', |
|
| 75 | - 'currency' => 'currency', |
|
| 76 | - 'invoice_key' => 'key', |
|
| 77 | - 'type' => 'type', |
|
| 78 | - 'mode' => 'mode', |
|
| 79 | - 'user_ip' => 'user_ip', |
|
| 80 | - 'first_name' => 'first_name', |
|
| 81 | - 'last_name' => 'last_name', |
|
| 82 | - 'address' => 'address', |
|
| 83 | - 'city' => 'city', |
|
| 84 | - 'state' => 'state', |
|
| 85 | - 'country' => 'country', |
|
| 86 | - 'zip' => 'zip', |
|
| 87 | - 'zip' => 'zip', |
|
| 88 | - 'adddress_confirmed' => 'address_confirmed', |
|
| 89 | - 'gateway' => 'gateway', |
|
| 90 | - 'transaction_id' => 'transaction_id', |
|
| 91 | - 'currency' => 'currency', |
|
| 92 | - 'subtotal' => 'subtotal', |
|
| 93 | - 'tax' => 'total_tax', |
|
| 94 | - 'fees_total' => 'total_fees', |
|
| 95 | - 'discount' => 'total_discount', |
|
| 96 | - 'total' => 'total', |
|
| 97 | - 'discount_code' => 'discount_code', |
|
| 98 | - 'disable_taxes' => 'disable_taxes', |
|
| 99 | - 'due_date' => 'due_date', |
|
| 100 | - 'completed_date' => 'completed_date', |
|
| 101 | - 'company' => 'company', |
|
| 102 | - 'vat_number' => 'vat_number', |
|
| 103 | - 'vat_rate' => 'vat_rate', |
|
| 104 | - 'customer_id' => 'customer_id', |
|
| 105 | - ); |
|
| 106 | - |
|
| 107 | - /* |
|
| 18 | + /** |
|
| 19 | + * Data stored in meta keys, but not considered "meta" for a discount. |
|
| 20 | + * |
|
| 21 | + * @since 1.0.19 |
|
| 22 | + * @var array |
|
| 23 | + */ |
|
| 24 | + protected $internal_meta_keys = array( |
|
| 25 | + '_wpinv_subscr_profile_id', |
|
| 26 | + '_wpinv_subscription_id', |
|
| 27 | + '_wpinv_taxes', |
|
| 28 | + '_wpinv_fees', |
|
| 29 | + '_wpinv_discounts', |
|
| 30 | + '_wpinv_submission_id', |
|
| 31 | + '_wpinv_payment_form', |
|
| 32 | + '_wpinv_is_viewed', |
|
| 33 | + '_wpinv_phone', |
|
| 34 | + '_wpinv_company_id', |
|
| 35 | + 'wpinv_shipping', |
|
| 36 | + 'wpinv_email_cc', |
|
| 37 | + 'wpinv_template', |
|
| 38 | + 'wpinv_created_via', |
|
| 39 | + ); |
|
| 40 | + |
|
| 41 | + /** |
|
| 42 | + * A map of meta keys to data props. |
|
| 43 | + * |
|
| 44 | + * @since 1.0.19 |
|
| 45 | + * |
|
| 46 | + * @var array |
|
| 47 | + */ |
|
| 48 | + protected $meta_key_to_props = array( |
|
| 49 | + '_wpinv_subscr_profile_id' => 'remote_subscription_id', |
|
| 50 | + '_wpinv_subscription_id' => 'subscription_id', |
|
| 51 | + '_wpinv_taxes' => 'taxes', |
|
| 52 | + '_wpinv_fees' => 'fees', |
|
| 53 | + '_wpinv_discounts' => 'discounts', |
|
| 54 | + '_wpinv_submission_id' => 'submission_id', |
|
| 55 | + '_wpinv_payment_form' => 'payment_form', |
|
| 56 | + '_wpinv_is_viewed' => 'is_viewed', |
|
| 57 | + 'wpinv_email_cc' => 'email_cc', |
|
| 58 | + 'wpinv_template' => 'template', |
|
| 59 | + 'wpinv_created_via' => 'created_via', |
|
| 60 | + '_wpinv_phone' => 'phone', |
|
| 61 | + '_wpinv_company_id' => 'company_id', |
|
| 62 | + 'wpinv_shipping' => 'shipping', |
|
| 63 | + ); |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * A map of database fields to data props. |
|
| 67 | + * |
|
| 68 | + * @since 1.0.19 |
|
| 69 | + * |
|
| 70 | + * @var array |
|
| 71 | + */ |
|
| 72 | + protected $database_fields_to_props = array( |
|
| 73 | + 'post_id' => 'id', |
|
| 74 | + 'number' => 'number', |
|
| 75 | + 'currency' => 'currency', |
|
| 76 | + 'invoice_key' => 'key', |
|
| 77 | + 'type' => 'type', |
|
| 78 | + 'mode' => 'mode', |
|
| 79 | + 'user_ip' => 'user_ip', |
|
| 80 | + 'first_name' => 'first_name', |
|
| 81 | + 'last_name' => 'last_name', |
|
| 82 | + 'address' => 'address', |
|
| 83 | + 'city' => 'city', |
|
| 84 | + 'state' => 'state', |
|
| 85 | + 'country' => 'country', |
|
| 86 | + 'zip' => 'zip', |
|
| 87 | + 'zip' => 'zip', |
|
| 88 | + 'adddress_confirmed' => 'address_confirmed', |
|
| 89 | + 'gateway' => 'gateway', |
|
| 90 | + 'transaction_id' => 'transaction_id', |
|
| 91 | + 'currency' => 'currency', |
|
| 92 | + 'subtotal' => 'subtotal', |
|
| 93 | + 'tax' => 'total_tax', |
|
| 94 | + 'fees_total' => 'total_fees', |
|
| 95 | + 'discount' => 'total_discount', |
|
| 96 | + 'total' => 'total', |
|
| 97 | + 'discount_code' => 'discount_code', |
|
| 98 | + 'disable_taxes' => 'disable_taxes', |
|
| 99 | + 'due_date' => 'due_date', |
|
| 100 | + 'completed_date' => 'completed_date', |
|
| 101 | + 'company' => 'company', |
|
| 102 | + 'vat_number' => 'vat_number', |
|
| 103 | + 'vat_rate' => 'vat_rate', |
|
| 104 | + 'customer_id' => 'customer_id', |
|
| 105 | + ); |
|
| 106 | + |
|
| 107 | + /* |
|
| 108 | 108 | |-------------------------------------------------------------------------- |
| 109 | 109 | | CRUD Methods |
| 110 | 110 | |-------------------------------------------------------------------------- |
| 111 | 111 | */ |
| 112 | 112 | |
| 113 | - /** |
|
| 114 | - * Method to create a new invoice in the database. |
|
| 115 | - * |
|
| 116 | - * @param WPInv_Invoice $invoice Invoice object. |
|
| 117 | - */ |
|
| 118 | - public function create( &$invoice ) { |
|
| 119 | - $invoice->set_version( WPINV_VERSION ); |
|
| 120 | - $invoice->set_date_created( current_time( 'mysql' ) ); |
|
| 121 | - |
|
| 122 | - // Create a new post. |
|
| 123 | - $id = wp_insert_post( |
|
| 124 | - apply_filters( |
|
| 125 | - 'getpaid_new_invoice_data', |
|
| 126 | - array( |
|
| 127 | - 'post_date' => $invoice->get_date_created( 'edit' ), |
|
| 128 | - 'post_type' => $invoice->get_post_type( 'edit' ), |
|
| 129 | - 'post_status' => $this->get_post_status( $invoice ), |
|
| 130 | - 'ping_status' => 'closed', |
|
| 131 | - 'post_author' => $invoice->get_user_id( 'edit' ), |
|
| 132 | - 'post_title' => $invoice->get_title( 'edit' ), |
|
| 133 | - 'post_excerpt' => $invoice->get_description( 'edit' ), |
|
| 134 | - 'post_parent' => $invoice->get_parent_id( 'edit' ), |
|
| 135 | - ) |
|
| 136 | - ), |
|
| 137 | - true |
|
| 138 | - ); |
|
| 139 | - |
|
| 140 | - if ( $id && ! is_wp_error( $id ) ) { |
|
| 141 | - |
|
| 142 | - // Update the new id and regenerate a title. |
|
| 143 | - $invoice->set_id( $id ); |
|
| 144 | - |
|
| 145 | - $invoice->maybe_set_number(); |
|
| 146 | - |
|
| 147 | - wp_update_post( |
|
| 148 | - array( |
|
| 149 | - 'ID' => $invoice->get_id(), |
|
| 150 | - 'post_title' => $invoice->get_number( 'edit' ), |
|
| 151 | - 'post_name' => $invoice->get_path( 'edit' ), |
|
| 152 | - ) |
|
| 153 | - ); |
|
| 154 | - |
|
| 155 | - // Save special fields and items. |
|
| 156 | - $this->save_special_fields( $invoice ); |
|
| 157 | - $this->save_items( $invoice ); |
|
| 158 | - |
|
| 159 | - // Update meta data. |
|
| 160 | - $this->update_post_meta( $invoice ); |
|
| 161 | - $invoice->save_meta_data(); |
|
| 162 | - |
|
| 163 | - // Apply changes. |
|
| 164 | - $invoice->apply_changes(); |
|
| 165 | - $this->clear_caches( $invoice ); |
|
| 166 | - |
|
| 167 | - // Fires after a new invoice is created. |
|
| 168 | - do_action( 'getpaid_new_invoice', $invoice ); |
|
| 169 | - return true; |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - if ( is_wp_error( $id ) ) { |
|
| 173 | - $invoice->last_error = $id->get_error_message(); |
|
| 174 | - } |
|
| 175 | - |
|
| 176 | - return false; |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - /** |
|
| 180 | - * Method to read an invoice from the database. |
|
| 181 | - * |
|
| 182 | - * @param WPInv_Invoice $invoice Invoice object. |
|
| 183 | - * |
|
| 184 | - */ |
|
| 185 | - public function read( &$invoice ) { |
|
| 186 | - |
|
| 187 | - $invoice->set_defaults(); |
|
| 188 | - $invoice_object = get_post( $invoice->get_id() ); |
|
| 189 | - |
|
| 190 | - if ( ! $invoice->get_id() || ! $invoice_object || ! getpaid_is_invoice_post_type( $invoice_object->post_type ) ) { |
|
| 191 | - $invoice->last_error = __( 'Invalid invoice.', 'invoicing' ); |
|
| 192 | - $invoice->set_id( 0 ); |
|
| 193 | - return false; |
|
| 194 | - } |
|
| 195 | - |
|
| 196 | - $invoice->set_props( |
|
| 197 | - array( |
|
| 198 | - 'date_created' => 0 < $invoice_object->post_date ? $invoice_object->post_date : null, |
|
| 199 | - 'date_modified' => 0 < $invoice_object->post_modified ? $invoice_object->post_modified : null, |
|
| 200 | - 'status' => $invoice_object->post_status, |
|
| 201 | - 'author' => $invoice_object->post_author, |
|
| 202 | - 'description' => $invoice_object->post_excerpt, |
|
| 203 | - 'parent_id' => $invoice_object->post_parent, |
|
| 204 | - 'name' => $invoice_object->post_title, |
|
| 205 | - 'path' => $invoice_object->post_name, |
|
| 206 | - 'post_type' => $invoice_object->post_type, |
|
| 207 | - ) |
|
| 208 | - ); |
|
| 209 | - |
|
| 210 | - $invoice->set_type( $invoice_object->post_type ); |
|
| 211 | - |
|
| 212 | - $this->read_object_data( $invoice, $invoice_object ); |
|
| 213 | - $this->add_special_fields( $invoice ); |
|
| 214 | - $this->add_items( $invoice ); |
|
| 215 | - $invoice->read_meta_data(); |
|
| 216 | - $invoice->set_object_read( true ); |
|
| 217 | - do_action( 'getpaid_read_invoice', $invoice ); |
|
| 218 | - |
|
| 219 | - } |
|
| 220 | - |
|
| 221 | - /** |
|
| 222 | - * Method to update an invoice in the database. |
|
| 223 | - * |
|
| 224 | - * @param WPInv_Invoice $invoice Invoice object. |
|
| 225 | - */ |
|
| 226 | - public function update( &$invoice ) { |
|
| 227 | - $invoice->save_meta_data(); |
|
| 228 | - $invoice->set_version( WPINV_VERSION ); |
|
| 229 | - |
|
| 230 | - if ( null === $invoice->get_date_created( 'edit' ) ) { |
|
| 231 | - $invoice->set_date_created( current_time( 'mysql' ) ); |
|
| 232 | - } |
|
| 233 | - |
|
| 234 | - // Ensure both the key and number are set. |
|
| 235 | - $invoice->get_path(); |
|
| 236 | - |
|
| 237 | - // Grab the current status so we can compare. |
|
| 238 | - $previous_status = get_post_status( $invoice->get_id() ); |
|
| 239 | - |
|
| 240 | - $changes = $invoice->get_changes(); |
|
| 241 | - |
|
| 242 | - // Only update the post when the post data changes. |
|
| 243 | - if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'description', 'parent_id', 'post_excerpt', 'path' ), array_keys( $changes ) ) ) { |
|
| 244 | - $post_data = array( |
|
| 245 | - 'post_date' => $invoice->get_date_created( 'edit' ), |
|
| 246 | - 'post_date_gmt' => $invoice->get_date_created_gmt( 'edit' ), |
|
| 247 | - 'post_status' => $invoice->get_status( 'edit' ), |
|
| 248 | - 'post_title' => $invoice->get_name( 'edit' ), |
|
| 249 | - 'post_author' => $invoice->get_user_id( 'edit' ), |
|
| 250 | - 'post_modified' => $invoice->get_date_modified( 'edit' ), |
|
| 251 | - 'post_excerpt' => $invoice->get_description( 'edit' ), |
|
| 252 | - 'post_parent' => $invoice->get_parent_id( 'edit' ), |
|
| 253 | - 'post_name' => $invoice->get_path( 'edit' ), |
|
| 254 | - 'post_type' => $invoice->get_post_type( 'edit' ), |
|
| 255 | - ); |
|
| 256 | - |
|
| 257 | - /** |
|
| 258 | - * When updating this object, to prevent infinite loops, use $wpdb |
|
| 259 | - * to update data, since wp_update_post spawns more calls to the |
|
| 260 | - * save_post action. |
|
| 261 | - * |
|
| 262 | - * This ensures hooks are fired by either WP itself (admin screen save), |
|
| 263 | - * or an update purely from CRUD. |
|
| 264 | - */ |
|
| 265 | - if ( doing_action( 'save_post' ) ) { |
|
| 266 | - $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $invoice->get_id() ) ); |
|
| 267 | - clean_post_cache( $invoice->get_id() ); |
|
| 268 | - } else { |
|
| 269 | - wp_update_post( array_merge( array( 'ID' => $invoice->get_id() ), $post_data ) ); |
|
| 270 | - } |
|
| 271 | - $invoice->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
| 272 | - } |
|
| 273 | - |
|
| 274 | - // Update meta data. |
|
| 275 | - $this->update_post_meta( $invoice ); |
|
| 276 | - |
|
| 277 | - // Save special fields and items. |
|
| 278 | - $this->save_special_fields( $invoice ); |
|
| 279 | - $this->save_items( $invoice ); |
|
| 280 | - |
|
| 281 | - // Apply the changes. |
|
| 282 | - $invoice->apply_changes(); |
|
| 283 | - |
|
| 284 | - // Clear caches. |
|
| 285 | - $this->clear_caches( $invoice ); |
|
| 286 | - |
|
| 287 | - // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
|
| 288 | - $new_status = $invoice->get_status( 'edit' ); |
|
| 289 | - |
|
| 290 | - if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
| 291 | - do_action( 'getpaid_new_invoice', $invoice ); |
|
| 292 | - } else { |
|
| 293 | - do_action( 'getpaid_update_invoice', $invoice ); |
|
| 294 | - } |
|
| 295 | - |
|
| 296 | - } |
|
| 297 | - |
|
| 298 | - /* |
|
| 113 | + /** |
|
| 114 | + * Method to create a new invoice in the database. |
|
| 115 | + * |
|
| 116 | + * @param WPInv_Invoice $invoice Invoice object. |
|
| 117 | + */ |
|
| 118 | + public function create( &$invoice ) { |
|
| 119 | + $invoice->set_version( WPINV_VERSION ); |
|
| 120 | + $invoice->set_date_created( current_time( 'mysql' ) ); |
|
| 121 | + |
|
| 122 | + // Create a new post. |
|
| 123 | + $id = wp_insert_post( |
|
| 124 | + apply_filters( |
|
| 125 | + 'getpaid_new_invoice_data', |
|
| 126 | + array( |
|
| 127 | + 'post_date' => $invoice->get_date_created( 'edit' ), |
|
| 128 | + 'post_type' => $invoice->get_post_type( 'edit' ), |
|
| 129 | + 'post_status' => $this->get_post_status( $invoice ), |
|
| 130 | + 'ping_status' => 'closed', |
|
| 131 | + 'post_author' => $invoice->get_user_id( 'edit' ), |
|
| 132 | + 'post_title' => $invoice->get_title( 'edit' ), |
|
| 133 | + 'post_excerpt' => $invoice->get_description( 'edit' ), |
|
| 134 | + 'post_parent' => $invoice->get_parent_id( 'edit' ), |
|
| 135 | + ) |
|
| 136 | + ), |
|
| 137 | + true |
|
| 138 | + ); |
|
| 139 | + |
|
| 140 | + if ( $id && ! is_wp_error( $id ) ) { |
|
| 141 | + |
|
| 142 | + // Update the new id and regenerate a title. |
|
| 143 | + $invoice->set_id( $id ); |
|
| 144 | + |
|
| 145 | + $invoice->maybe_set_number(); |
|
| 146 | + |
|
| 147 | + wp_update_post( |
|
| 148 | + array( |
|
| 149 | + 'ID' => $invoice->get_id(), |
|
| 150 | + 'post_title' => $invoice->get_number( 'edit' ), |
|
| 151 | + 'post_name' => $invoice->get_path( 'edit' ), |
|
| 152 | + ) |
|
| 153 | + ); |
|
| 154 | + |
|
| 155 | + // Save special fields and items. |
|
| 156 | + $this->save_special_fields( $invoice ); |
|
| 157 | + $this->save_items( $invoice ); |
|
| 158 | + |
|
| 159 | + // Update meta data. |
|
| 160 | + $this->update_post_meta( $invoice ); |
|
| 161 | + $invoice->save_meta_data(); |
|
| 162 | + |
|
| 163 | + // Apply changes. |
|
| 164 | + $invoice->apply_changes(); |
|
| 165 | + $this->clear_caches( $invoice ); |
|
| 166 | + |
|
| 167 | + // Fires after a new invoice is created. |
|
| 168 | + do_action( 'getpaid_new_invoice', $invoice ); |
|
| 169 | + return true; |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + if ( is_wp_error( $id ) ) { |
|
| 173 | + $invoice->last_error = $id->get_error_message(); |
|
| 174 | + } |
|
| 175 | + |
|
| 176 | + return false; |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + /** |
|
| 180 | + * Method to read an invoice from the database. |
|
| 181 | + * |
|
| 182 | + * @param WPInv_Invoice $invoice Invoice object. |
|
| 183 | + * |
|
| 184 | + */ |
|
| 185 | + public function read( &$invoice ) { |
|
| 186 | + |
|
| 187 | + $invoice->set_defaults(); |
|
| 188 | + $invoice_object = get_post( $invoice->get_id() ); |
|
| 189 | + |
|
| 190 | + if ( ! $invoice->get_id() || ! $invoice_object || ! getpaid_is_invoice_post_type( $invoice_object->post_type ) ) { |
|
| 191 | + $invoice->last_error = __( 'Invalid invoice.', 'invoicing' ); |
|
| 192 | + $invoice->set_id( 0 ); |
|
| 193 | + return false; |
|
| 194 | + } |
|
| 195 | + |
|
| 196 | + $invoice->set_props( |
|
| 197 | + array( |
|
| 198 | + 'date_created' => 0 < $invoice_object->post_date ? $invoice_object->post_date : null, |
|
| 199 | + 'date_modified' => 0 < $invoice_object->post_modified ? $invoice_object->post_modified : null, |
|
| 200 | + 'status' => $invoice_object->post_status, |
|
| 201 | + 'author' => $invoice_object->post_author, |
|
| 202 | + 'description' => $invoice_object->post_excerpt, |
|
| 203 | + 'parent_id' => $invoice_object->post_parent, |
|
| 204 | + 'name' => $invoice_object->post_title, |
|
| 205 | + 'path' => $invoice_object->post_name, |
|
| 206 | + 'post_type' => $invoice_object->post_type, |
|
| 207 | + ) |
|
| 208 | + ); |
|
| 209 | + |
|
| 210 | + $invoice->set_type( $invoice_object->post_type ); |
|
| 211 | + |
|
| 212 | + $this->read_object_data( $invoice, $invoice_object ); |
|
| 213 | + $this->add_special_fields( $invoice ); |
|
| 214 | + $this->add_items( $invoice ); |
|
| 215 | + $invoice->read_meta_data(); |
|
| 216 | + $invoice->set_object_read( true ); |
|
| 217 | + do_action( 'getpaid_read_invoice', $invoice ); |
|
| 218 | + |
|
| 219 | + } |
|
| 220 | + |
|
| 221 | + /** |
|
| 222 | + * Method to update an invoice in the database. |
|
| 223 | + * |
|
| 224 | + * @param WPInv_Invoice $invoice Invoice object. |
|
| 225 | + */ |
|
| 226 | + public function update( &$invoice ) { |
|
| 227 | + $invoice->save_meta_data(); |
|
| 228 | + $invoice->set_version( WPINV_VERSION ); |
|
| 229 | + |
|
| 230 | + if ( null === $invoice->get_date_created( 'edit' ) ) { |
|
| 231 | + $invoice->set_date_created( current_time( 'mysql' ) ); |
|
| 232 | + } |
|
| 233 | + |
|
| 234 | + // Ensure both the key and number are set. |
|
| 235 | + $invoice->get_path(); |
|
| 236 | + |
|
| 237 | + // Grab the current status so we can compare. |
|
| 238 | + $previous_status = get_post_status( $invoice->get_id() ); |
|
| 239 | + |
|
| 240 | + $changes = $invoice->get_changes(); |
|
| 241 | + |
|
| 242 | + // Only update the post when the post data changes. |
|
| 243 | + if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'description', 'parent_id', 'post_excerpt', 'path' ), array_keys( $changes ) ) ) { |
|
| 244 | + $post_data = array( |
|
| 245 | + 'post_date' => $invoice->get_date_created( 'edit' ), |
|
| 246 | + 'post_date_gmt' => $invoice->get_date_created_gmt( 'edit' ), |
|
| 247 | + 'post_status' => $invoice->get_status( 'edit' ), |
|
| 248 | + 'post_title' => $invoice->get_name( 'edit' ), |
|
| 249 | + 'post_author' => $invoice->get_user_id( 'edit' ), |
|
| 250 | + 'post_modified' => $invoice->get_date_modified( 'edit' ), |
|
| 251 | + 'post_excerpt' => $invoice->get_description( 'edit' ), |
|
| 252 | + 'post_parent' => $invoice->get_parent_id( 'edit' ), |
|
| 253 | + 'post_name' => $invoice->get_path( 'edit' ), |
|
| 254 | + 'post_type' => $invoice->get_post_type( 'edit' ), |
|
| 255 | + ); |
|
| 256 | + |
|
| 257 | + /** |
|
| 258 | + * When updating this object, to prevent infinite loops, use $wpdb |
|
| 259 | + * to update data, since wp_update_post spawns more calls to the |
|
| 260 | + * save_post action. |
|
| 261 | + * |
|
| 262 | + * This ensures hooks are fired by either WP itself (admin screen save), |
|
| 263 | + * or an update purely from CRUD. |
|
| 264 | + */ |
|
| 265 | + if ( doing_action( 'save_post' ) ) { |
|
| 266 | + $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $invoice->get_id() ) ); |
|
| 267 | + clean_post_cache( $invoice->get_id() ); |
|
| 268 | + } else { |
|
| 269 | + wp_update_post( array_merge( array( 'ID' => $invoice->get_id() ), $post_data ) ); |
|
| 270 | + } |
|
| 271 | + $invoice->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
| 272 | + } |
|
| 273 | + |
|
| 274 | + // Update meta data. |
|
| 275 | + $this->update_post_meta( $invoice ); |
|
| 276 | + |
|
| 277 | + // Save special fields and items. |
|
| 278 | + $this->save_special_fields( $invoice ); |
|
| 279 | + $this->save_items( $invoice ); |
|
| 280 | + |
|
| 281 | + // Apply the changes. |
|
| 282 | + $invoice->apply_changes(); |
|
| 283 | + |
|
| 284 | + // Clear caches. |
|
| 285 | + $this->clear_caches( $invoice ); |
|
| 286 | + |
|
| 287 | + // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
|
| 288 | + $new_status = $invoice->get_status( 'edit' ); |
|
| 289 | + |
|
| 290 | + if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
| 291 | + do_action( 'getpaid_new_invoice', $invoice ); |
|
| 292 | + } else { |
|
| 293 | + do_action( 'getpaid_update_invoice', $invoice ); |
|
| 294 | + } |
|
| 295 | + |
|
| 296 | + } |
|
| 297 | + |
|
| 298 | + /* |
|
| 299 | 299 | |-------------------------------------------------------------------------- |
| 300 | 300 | | Additional Methods |
| 301 | 301 | |-------------------------------------------------------------------------- |
| 302 | 302 | */ |
| 303 | 303 | |
| 304 | - /** |
|
| 304 | + /** |
|
| 305 | 305 | * Retrieves special fields and adds to the invoice. |
| 306 | - * |
|
| 307 | - * @param WPInv_Invoice $invoice Invoice object. |
|
| 306 | + * |
|
| 307 | + * @param WPInv_Invoice $invoice Invoice object. |
|
| 308 | 308 | */ |
| 309 | 309 | public function add_special_fields( &$invoice ) { |
| 310 | - global $wpdb; |
|
| 311 | - |
|
| 312 | - // Maybe retrieve from the cache. |
|
| 313 | - $data = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_special_fields' ); |
|
| 314 | - |
|
| 315 | - // If not found, retrieve from the db. |
|
| 316 | - if ( false === $data ) { |
|
| 317 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 318 | - |
|
| 319 | - $data = $wpdb->get_row( |
|
| 320 | - $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d LIMIT 1", $invoice->get_id() ), |
|
| 321 | - ARRAY_A |
|
| 322 | - ); |
|
| 323 | - |
|
| 324 | - // Update the cache with our data |
|
| 325 | - wp_cache_set( $invoice->get_id(), $data, 'getpaid_invoice_special_fields' ); |
|
| 326 | - |
|
| 327 | - } |
|
| 328 | - |
|
| 329 | - // Abort if the data does not exist. |
|
| 330 | - if ( empty( $data ) ) { |
|
| 331 | - $invoice->set_object_read( true ); |
|
| 332 | - $invoice->set_props( wpinv_get_user_address( $invoice->get_user_id() ) ); |
|
| 333 | - return; |
|
| 334 | - } |
|
| 335 | - |
|
| 336 | - $props = array(); |
|
| 337 | - |
|
| 338 | - foreach ( $this->database_fields_to_props as $db_field => $prop ) { |
|
| 339 | - |
|
| 340 | - if ( $db_field == 'post_id' ) { |
|
| 341 | - continue; |
|
| 342 | - } |
|
| 343 | - |
|
| 344 | - $props[ $prop ] = $data[ $db_field ]; |
|
| 345 | - } |
|
| 346 | - |
|
| 347 | - $invoice->set_props( $props ); |
|
| 348 | - |
|
| 349 | - } |
|
| 350 | - |
|
| 351 | - /** |
|
| 352 | - * Gets a list of special fields that need updated based on change state |
|
| 353 | - * or if they are present in the database or not. |
|
| 354 | - * |
|
| 355 | - * @param WPInv_Invoice $invoice The Invoice object. |
|
| 356 | - * @return array A mapping of field keys => prop names, filtered by ones that should be updated. |
|
| 357 | - */ |
|
| 358 | - protected function get_special_fields_to_update( $invoice ) { |
|
| 359 | - $fields_to_update = array(); |
|
| 360 | - $changed_props = $invoice->get_changes(); |
|
| 361 | - |
|
| 362 | - // Props should be updated if they are a part of the $changed array or don't exist yet. |
|
| 363 | - foreach ( $this->database_fields_to_props as $database_field => $prop ) { |
|
| 364 | - if ( array_key_exists( $prop, $changed_props ) ) { |
|
| 365 | - $fields_to_update[ $database_field ] = $prop; |
|
| 366 | - } |
|
| 367 | - } |
|
| 368 | - |
|
| 369 | - return $fields_to_update; |
|
| 370 | - } |
|
| 371 | - |
|
| 372 | - /** |
|
| 373 | - * Helper method that updates all the database fields for an invoice based on it's settings in the WPInv_Invoice class. |
|
| 374 | - * |
|
| 375 | - * @param WPInv_Invoice $invoice WPInv_Invoice object. |
|
| 376 | - * @since 1.0.19 |
|
| 377 | - */ |
|
| 378 | - protected function update_special_fields( &$invoice ) { |
|
| 379 | - global $wpdb; |
|
| 380 | - |
|
| 381 | - $updated_props = array(); |
|
| 382 | - $fields_to_update = $this->get_special_fields_to_update( $invoice ); |
|
| 383 | - |
|
| 384 | - foreach ( $fields_to_update as $database_field => $prop ) { |
|
| 385 | - $value = $invoice->{"get_$prop"}( 'edit' ); |
|
| 386 | - $value = is_string( $value ) ? wp_slash( $value ) : $value; |
|
| 387 | - $value = is_bool( $value ) ? (int) $value : $value; |
|
| 388 | - $updated_props[ $database_field ] = maybe_serialize( $value ); |
|
| 389 | - } |
|
| 390 | - |
|
| 391 | - if ( ! empty( $updated_props ) ) { |
|
| 392 | - |
|
| 393 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 394 | - $wpdb->update( $table, $updated_props, array( 'post_id' => $invoice->get_id() ) ); |
|
| 395 | - wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' ); |
|
| 396 | - do_action( 'getpaid_invoice_update_database_fields', $invoice, $updated_props ); |
|
| 397 | - |
|
| 398 | - } |
|
| 399 | - |
|
| 400 | - } |
|
| 401 | - |
|
| 402 | - /** |
|
| 403 | - * Helper method that inserts special fields to the database. |
|
| 404 | - * |
|
| 405 | - * @param WPInv_Invoice $invoice WPInv_Invoice object. |
|
| 406 | - * @since 1.0.19 |
|
| 407 | - */ |
|
| 408 | - protected function insert_special_fields( &$invoice ) { |
|
| 409 | - global $wpdb; |
|
| 410 | - |
|
| 411 | - $updated_props = array(); |
|
| 412 | - |
|
| 413 | - foreach ( $this->database_fields_to_props as $database_field => $prop ) { |
|
| 414 | - $value = $invoice->{"get_$prop"}( 'edit' ); |
|
| 415 | - $value = is_string( $value ) ? wp_slash( $value ) : $value; |
|
| 416 | - $value = is_bool( $value ) ? (int) $value : $value; |
|
| 417 | - $updated_props[ $database_field ] = maybe_serialize( $value ); |
|
| 418 | - } |
|
| 419 | - |
|
| 420 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 421 | - $wpdb->insert( $table, $updated_props ); |
|
| 422 | - wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' ); |
|
| 423 | - do_action( 'getpaid_invoice_insert_database_fields', $invoice, $updated_props ); |
|
| 424 | - |
|
| 425 | - } |
|
| 426 | - |
|
| 427 | - /** |
|
| 310 | + global $wpdb; |
|
| 311 | + |
|
| 312 | + // Maybe retrieve from the cache. |
|
| 313 | + $data = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_special_fields' ); |
|
| 314 | + |
|
| 315 | + // If not found, retrieve from the db. |
|
| 316 | + if ( false === $data ) { |
|
| 317 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 318 | + |
|
| 319 | + $data = $wpdb->get_row( |
|
| 320 | + $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d LIMIT 1", $invoice->get_id() ), |
|
| 321 | + ARRAY_A |
|
| 322 | + ); |
|
| 323 | + |
|
| 324 | + // Update the cache with our data |
|
| 325 | + wp_cache_set( $invoice->get_id(), $data, 'getpaid_invoice_special_fields' ); |
|
| 326 | + |
|
| 327 | + } |
|
| 328 | + |
|
| 329 | + // Abort if the data does not exist. |
|
| 330 | + if ( empty( $data ) ) { |
|
| 331 | + $invoice->set_object_read( true ); |
|
| 332 | + $invoice->set_props( wpinv_get_user_address( $invoice->get_user_id() ) ); |
|
| 333 | + return; |
|
| 334 | + } |
|
| 335 | + |
|
| 336 | + $props = array(); |
|
| 337 | + |
|
| 338 | + foreach ( $this->database_fields_to_props as $db_field => $prop ) { |
|
| 339 | + |
|
| 340 | + if ( $db_field == 'post_id' ) { |
|
| 341 | + continue; |
|
| 342 | + } |
|
| 343 | + |
|
| 344 | + $props[ $prop ] = $data[ $db_field ]; |
|
| 345 | + } |
|
| 346 | + |
|
| 347 | + $invoice->set_props( $props ); |
|
| 348 | + |
|
| 349 | + } |
|
| 350 | + |
|
| 351 | + /** |
|
| 352 | + * Gets a list of special fields that need updated based on change state |
|
| 353 | + * or if they are present in the database or not. |
|
| 354 | + * |
|
| 355 | + * @param WPInv_Invoice $invoice The Invoice object. |
|
| 356 | + * @return array A mapping of field keys => prop names, filtered by ones that should be updated. |
|
| 357 | + */ |
|
| 358 | + protected function get_special_fields_to_update( $invoice ) { |
|
| 359 | + $fields_to_update = array(); |
|
| 360 | + $changed_props = $invoice->get_changes(); |
|
| 361 | + |
|
| 362 | + // Props should be updated if they are a part of the $changed array or don't exist yet. |
|
| 363 | + foreach ( $this->database_fields_to_props as $database_field => $prop ) { |
|
| 364 | + if ( array_key_exists( $prop, $changed_props ) ) { |
|
| 365 | + $fields_to_update[ $database_field ] = $prop; |
|
| 366 | + } |
|
| 367 | + } |
|
| 368 | + |
|
| 369 | + return $fields_to_update; |
|
| 370 | + } |
|
| 371 | + |
|
| 372 | + /** |
|
| 373 | + * Helper method that updates all the database fields for an invoice based on it's settings in the WPInv_Invoice class. |
|
| 374 | + * |
|
| 375 | + * @param WPInv_Invoice $invoice WPInv_Invoice object. |
|
| 376 | + * @since 1.0.19 |
|
| 377 | + */ |
|
| 378 | + protected function update_special_fields( &$invoice ) { |
|
| 379 | + global $wpdb; |
|
| 380 | + |
|
| 381 | + $updated_props = array(); |
|
| 382 | + $fields_to_update = $this->get_special_fields_to_update( $invoice ); |
|
| 383 | + |
|
| 384 | + foreach ( $fields_to_update as $database_field => $prop ) { |
|
| 385 | + $value = $invoice->{"get_$prop"}( 'edit' ); |
|
| 386 | + $value = is_string( $value ) ? wp_slash( $value ) : $value; |
|
| 387 | + $value = is_bool( $value ) ? (int) $value : $value; |
|
| 388 | + $updated_props[ $database_field ] = maybe_serialize( $value ); |
|
| 389 | + } |
|
| 390 | + |
|
| 391 | + if ( ! empty( $updated_props ) ) { |
|
| 392 | + |
|
| 393 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 394 | + $wpdb->update( $table, $updated_props, array( 'post_id' => $invoice->get_id() ) ); |
|
| 395 | + wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' ); |
|
| 396 | + do_action( 'getpaid_invoice_update_database_fields', $invoice, $updated_props ); |
|
| 397 | + |
|
| 398 | + } |
|
| 399 | + |
|
| 400 | + } |
|
| 401 | + |
|
| 402 | + /** |
|
| 403 | + * Helper method that inserts special fields to the database. |
|
| 404 | + * |
|
| 405 | + * @param WPInv_Invoice $invoice WPInv_Invoice object. |
|
| 406 | + * @since 1.0.19 |
|
| 407 | + */ |
|
| 408 | + protected function insert_special_fields( &$invoice ) { |
|
| 409 | + global $wpdb; |
|
| 410 | + |
|
| 411 | + $updated_props = array(); |
|
| 412 | + |
|
| 413 | + foreach ( $this->database_fields_to_props as $database_field => $prop ) { |
|
| 414 | + $value = $invoice->{"get_$prop"}( 'edit' ); |
|
| 415 | + $value = is_string( $value ) ? wp_slash( $value ) : $value; |
|
| 416 | + $value = is_bool( $value ) ? (int) $value : $value; |
|
| 417 | + $updated_props[ $database_field ] = maybe_serialize( $value ); |
|
| 418 | + } |
|
| 419 | + |
|
| 420 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 421 | + $wpdb->insert( $table, $updated_props ); |
|
| 422 | + wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' ); |
|
| 423 | + do_action( 'getpaid_invoice_insert_database_fields', $invoice, $updated_props ); |
|
| 424 | + |
|
| 425 | + } |
|
| 426 | + |
|
| 427 | + /** |
|
| 428 | 428 | * Saves all special fields. |
| 429 | - * |
|
| 430 | - * @param WPInv_Invoice $invoice Invoice object. |
|
| 429 | + * |
|
| 430 | + * @param WPInv_Invoice $invoice Invoice object. |
|
| 431 | 431 | */ |
| 432 | 432 | public function save_special_fields( &$invoice ) { |
| 433 | - global $wpdb; |
|
| 433 | + global $wpdb; |
|
| 434 | 434 | |
| 435 | - // The invoices table. |
|
| 436 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 437 | - $id = (int) $invoice->get_id(); |
|
| 438 | - $invoice->maybe_set_key(); |
|
| 435 | + // The invoices table. |
|
| 436 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 437 | + $id = (int) $invoice->get_id(); |
|
| 438 | + $invoice->maybe_set_key(); |
|
| 439 | 439 | |
| 440 | - if ( $wpdb->get_var( "SELECT `post_id` FROM $table WHERE `post_id`= $id" ) ) { |
|
| 440 | + if ( $wpdb->get_var( "SELECT `post_id` FROM $table WHERE `post_id`= $id" ) ) { |
|
| 441 | 441 | |
| 442 | - $this->update_special_fields( $invoice ); |
|
| 442 | + $this->update_special_fields( $invoice ); |
|
| 443 | 443 | |
| 444 | - } else { |
|
| 444 | + } else { |
|
| 445 | 445 | |
| 446 | - $this->insert_special_fields( $invoice ); |
|
| 446 | + $this->insert_special_fields( $invoice ); |
|
| 447 | 447 | |
| 448 | - } |
|
| 448 | + } |
|
| 449 | 449 | |
| 450 | - } |
|
| 450 | + } |
|
| 451 | 451 | |
| 452 | - /** |
|
| 452 | + /** |
|
| 453 | 453 | * Set's up cart details. |
| 454 | - * |
|
| 455 | - * @param WPInv_Invoice $invoice Invoice object. |
|
| 454 | + * |
|
| 455 | + * @param WPInv_Invoice $invoice Invoice object. |
|
| 456 | 456 | */ |
| 457 | 457 | public function add_items( &$invoice ) { |
| 458 | - global $wpdb; |
|
| 458 | + global $wpdb; |
|
| 459 | 459 | |
| 460 | - // Maybe retrieve from the cache. |
|
| 461 | - $items = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_cart_details' ); |
|
| 460 | + // Maybe retrieve from the cache. |
|
| 461 | + $items = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_cart_details' ); |
|
| 462 | 462 | |
| 463 | - // If not found, retrieve from the db. |
|
| 464 | - if ( false === $items ) { |
|
| 465 | - $table = $wpdb->prefix . 'getpaid_invoice_items'; |
|
| 463 | + // If not found, retrieve from the db. |
|
| 464 | + if ( false === $items ) { |
|
| 465 | + $table = $wpdb->prefix . 'getpaid_invoice_items'; |
|
| 466 | 466 | |
| 467 | - $items = $wpdb->get_results( |
|
| 468 | - $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d", $invoice->get_id() ) |
|
| 469 | - ); |
|
| 467 | + $items = $wpdb->get_results( |
|
| 468 | + $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d", $invoice->get_id() ) |
|
| 469 | + ); |
|
| 470 | 470 | |
| 471 | - // Update the cache with our data |
|
| 472 | - wp_cache_set( $invoice->get_id(), $items, 'getpaid_invoice_cart_details' ); |
|
| 471 | + // Update the cache with our data |
|
| 472 | + wp_cache_set( $invoice->get_id(), $items, 'getpaid_invoice_cart_details' ); |
|
| 473 | 473 | |
| 474 | - } |
|
| 474 | + } |
|
| 475 | 475 | |
| 476 | - // Abort if no items found. |
|
| 476 | + // Abort if no items found. |
|
| 477 | 477 | if ( empty( $items ) ) { |
| 478 | 478 | return; |
| 479 | - } |
|
| 480 | - |
|
| 481 | - $_items = array(); |
|
| 482 | - foreach ( $items as $item_data ) { |
|
| 483 | - $item = new GetPaid_Form_Item( $item_data->item_id ); |
|
| 484 | - |
|
| 485 | - // Set item data. |
|
| 486 | - $item->item_tax = wpinv_sanitize_amount( $item_data->tax ); |
|
| 487 | - $item->item_discount = wpinv_sanitize_amount( $item_data->discount ); |
|
| 488 | - $item->set_name( $item_data->item_name ); |
|
| 489 | - $item->set_description( $item_data->item_description ); |
|
| 490 | - $item->set_price( $item_data->item_price ); |
|
| 491 | - $item->set_quantity( $item_data->quantity ); |
|
| 492 | - $item->set_item_meta( $item_data->meta ); |
|
| 493 | - $_items[] = $item; |
|
| 494 | - } |
|
| 495 | - |
|
| 496 | - $invoice->set_items( $_items ); |
|
| 497 | - } |
|
| 498 | - |
|
| 499 | - /** |
|
| 479 | + } |
|
| 480 | + |
|
| 481 | + $_items = array(); |
|
| 482 | + foreach ( $items as $item_data ) { |
|
| 483 | + $item = new GetPaid_Form_Item( $item_data->item_id ); |
|
| 484 | + |
|
| 485 | + // Set item data. |
|
| 486 | + $item->item_tax = wpinv_sanitize_amount( $item_data->tax ); |
|
| 487 | + $item->item_discount = wpinv_sanitize_amount( $item_data->discount ); |
|
| 488 | + $item->set_name( $item_data->item_name ); |
|
| 489 | + $item->set_description( $item_data->item_description ); |
|
| 490 | + $item->set_price( $item_data->item_price ); |
|
| 491 | + $item->set_quantity( $item_data->quantity ); |
|
| 492 | + $item->set_item_meta( $item_data->meta ); |
|
| 493 | + $_items[] = $item; |
|
| 494 | + } |
|
| 495 | + |
|
| 496 | + $invoice->set_items( $_items ); |
|
| 497 | + } |
|
| 498 | + |
|
| 499 | + /** |
|
| 500 | 500 | * Saves cart details. |
| 501 | - * |
|
| 502 | - * @param WPInv_Invoice $invoice Invoice object. |
|
| 501 | + * |
|
| 502 | + * @param WPInv_Invoice $invoice Invoice object. |
|
| 503 | 503 | */ |
| 504 | 504 | public function save_items( $invoice ) { |
| 505 | 505 | |
| 506 | - // Delete previously existing items. |
|
| 507 | - $this->delete_items( $invoice ); |
|
| 506 | + // Delete previously existing items. |
|
| 507 | + $this->delete_items( $invoice ); |
|
| 508 | 508 | |
| 509 | - $table = $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items'; |
|
| 509 | + $table = $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items'; |
|
| 510 | 510 | |
| 511 | - foreach ( $invoice->get_cart_details() as $item_data ) { |
|
| 512 | - $item_data = array_map( 'maybe_serialize', $item_data ); |
|
| 513 | - $GLOBALS['wpdb']->insert( $table, $item_data ); |
|
| 514 | - } |
|
| 511 | + foreach ( $invoice->get_cart_details() as $item_data ) { |
|
| 512 | + $item_data = array_map( 'maybe_serialize', $item_data ); |
|
| 513 | + $GLOBALS['wpdb']->insert( $table, $item_data ); |
|
| 514 | + } |
|
| 515 | 515 | |
| 516 | - wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_cart_details' ); |
|
| 517 | - do_action( 'getpaid_invoice_save_items', $invoice ); |
|
| 516 | + wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_cart_details' ); |
|
| 517 | + do_action( 'getpaid_invoice_save_items', $invoice ); |
|
| 518 | 518 | |
| 519 | - } |
|
| 519 | + } |
|
| 520 | 520 | |
| 521 | - /** |
|
| 521 | + /** |
|
| 522 | 522 | * Deletes an invoice's cart details from the database. |
| 523 | - * |
|
| 524 | - * @param WPInv_Invoice $invoice Invoice object. |
|
| 523 | + * |
|
| 524 | + * @param WPInv_Invoice $invoice Invoice object. |
|
| 525 | 525 | */ |
| 526 | 526 | public function delete_items( $invoice ) { |
| 527 | - $table = $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items'; |
|
| 528 | - return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) ); |
|
| 529 | - } |
|
| 527 | + $table = $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items'; |
|
| 528 | + return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) ); |
|
| 529 | + } |
|
| 530 | 530 | |
| 531 | - /** |
|
| 531 | + /** |
|
| 532 | 532 | * Deletes an invoice's special fields from the database. |
| 533 | - * |
|
| 534 | - * @param WPInv_Invoice $invoice Invoice object. |
|
| 533 | + * |
|
| 534 | + * @param WPInv_Invoice $invoice Invoice object. |
|
| 535 | 535 | */ |
| 536 | 536 | public function delete_special_fields( $invoice ) { |
| 537 | - $table = $GLOBALS['wpdb']->prefix . 'getpaid_invoices'; |
|
| 538 | - return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) ); |
|
| 539 | - } |
|
| 540 | - |
|
| 541 | - /** |
|
| 542 | - * Get the status to save to the post object. |
|
| 543 | - * |
|
| 544 | - * |
|
| 545 | - * @since 1.0.19 |
|
| 546 | - * @param WPInv_Invoice $object GetPaid_Data object. |
|
| 547 | - * @return string |
|
| 548 | - */ |
|
| 549 | - protected function get_post_status( $object ) { |
|
| 550 | - $object_status = $object->get_status( 'edit' ); |
|
| 551 | - |
|
| 552 | - if ( ! $object_status ) { |
|
| 553 | - $object_status = $object->get_default_status(); |
|
| 554 | - } |
|
| 555 | - |
|
| 556 | - return $object_status; |
|
| 557 | - } |
|
| 537 | + $table = $GLOBALS['wpdb']->prefix . 'getpaid_invoices'; |
|
| 538 | + return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) ); |
|
| 539 | + } |
|
| 540 | + |
|
| 541 | + /** |
|
| 542 | + * Get the status to save to the post object. |
|
| 543 | + * |
|
| 544 | + * |
|
| 545 | + * @since 1.0.19 |
|
| 546 | + * @param WPInv_Invoice $object GetPaid_Data object. |
|
| 547 | + * @return string |
|
| 548 | + */ |
|
| 549 | + protected function get_post_status( $object ) { |
|
| 550 | + $object_status = $object->get_status( 'edit' ); |
|
| 551 | + |
|
| 552 | + if ( ! $object_status ) { |
|
| 553 | + $object_status = $object->get_default_status(); |
|
| 554 | + } |
|
| 555 | + |
|
| 556 | + return $object_status; |
|
| 557 | + } |
|
| 558 | 558 | |
| 559 | 559 | } |
