@@ -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 text-white'; |
|
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 text-white'; |
|
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 | + } |
|
953 | + |
|
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 ); |
|
963 | + } |
|
964 | + |
|
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 ); |
|
974 | + } |
|
975 | + |
|
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 ); |
|
985 | + } |
|
986 | + |
|
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 ); |
|
996 | + } |
|
997 | + |
|
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 ); |
|
1007 | + } |
|
1008 | + |
|
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 ); |
|
1018 | + } |
|
1019 | + |
|
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 ); |
|
952 | 1029 | } |
953 | 1030 | |
954 | 1031 | /** |
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 ); |
|
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 | + } |
|
1042 | + |
|
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 ); |
|
963 | 1052 | } |
964 | 1053 | |
965 | 1054 | /** |
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 ); |
|
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 ); |
|
974 | 1063 | } |
975 | 1064 | |
976 | 1065 | /** |
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 ); |
|
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; |
|
985 | 1075 | } |
986 | 1076 | |
987 | 1077 | /** |
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 ); |
|
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 ); |
|
996 | 1086 | } |
997 | 1087 | |
998 | 1088 | /** |
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 ); |
|
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 ); |
|
1007 | 1097 | } |
1008 | 1098 | |
1009 | 1099 | /** |
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 ); |
|
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 ); |
|
1018 | 1108 | } |
1019 | 1109 | |
1020 | 1110 | /** |
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 ); |
|
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 ); |
|
1029 | 1119 | } |
1030 | 1120 | |
1031 | 1121 | /** |
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; |
|
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 ); |
|
1041 | 1130 | } |
1042 | 1131 | |
1043 | 1132 | /** |
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 ); |
|
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 ); |
|
1052 | 1141 | } |
1053 | 1142 | |
1054 | 1143 | /** |
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 ); |
|
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 ); |
|
1063 | 1152 | } |
1064 | 1153 | |
1065 | 1154 | /** |
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; |
|
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 ); |
|
1075 | 1163 | } |
1076 | 1164 | |
1077 | 1165 | /** |
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 ); |
|
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 ); |
|
1086 | 1174 | } |
1087 | 1175 | |
1088 | 1176 | /** |
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 ); |
|
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 ); |
|
1097 | 1185 | } |
1098 | 1186 | |
1099 | 1187 | /** |
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 ); |
|
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 ); |
|
1108 | 1196 | } |
1109 | 1197 | |
1110 | 1198 | /** |
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 ); |
|
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 ); |
|
1119 | 1207 | } |
1120 | 1208 | |
1121 | 1209 | /** |
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 ); |
|
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 ); |
|
1130 | 1218 | } |
1131 | 1219 | |
1132 | 1220 | /** |
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 ); |
|
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 ); |
|
1141 | 1229 | } |
1142 | 1230 | |
1143 | 1231 | /** |
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 ); |
|
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 ); |
|
1152 | 1240 | } |
1153 | 1241 | |
1154 | 1242 | /** |
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 ); |
|
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 ); |
|
1163 | 1251 | } |
1164 | 1252 | |
1165 | 1253 | /** |
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 ); |
|
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 ); |
|
1174 | 1262 | } |
1175 | 1263 | |
1176 | 1264 | /** |
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 ); |
|
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 ); |
|
1185 | 1273 | } |
1186 | 1274 | |
1187 | 1275 | /** |
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 ); |
|
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 ); |
|
1196 | 1284 | } |
1197 | 1285 | |
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 ); |
|
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 ); |
|
1207 | 1295 | } |
1208 | 1296 | |
1209 | 1297 | /** |
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 ); |
|
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 ); |
|
1218 | 1306 | } |
1219 | 1307 | |
1220 | 1308 | /** |
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 ); |
|
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 ); |
|
1229 | 1317 | } |
1230 | 1318 | |
1231 | 1319 | /** |
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 ); |
|
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 ); |
|
1240 | 1328 | } |
1241 | 1329 | |
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' ) && $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' ) { |
|
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' ) && $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 | 1486 | } |
1487 | 1487 | |
1488 | 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 ); |
|
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 ); |
|
1497 | 1497 | } |
1498 | 1498 | |
1499 | 1499 | /** |
1500 | - * Get the invoice total. |
|
1501 | - * |
|
1502 | - * @since 1.0.19 |
|
1500 | + * Get the invoice total. |
|
1501 | + * |
|
1502 | + * @since 1.0.19 |
|
1503 | 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 ) ); |
|
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 ) ); |
|
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 ) ); |
|
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,49 +3541,49 @@ 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 | - public function get_tax_total_by_name( $name ) { |
|
3566 | + public function get_tax_total_by_name( $name ) { |
|
3567 | 3567 | |
3568 | - if ( empty( $name ) ) { |
|
3569 | - return 0; |
|
3570 | - } |
|
3568 | + if ( empty( $name ) ) { |
|
3569 | + return 0; |
|
3570 | + } |
|
3571 | 3571 | |
3572 | - $tax = $this->get_tax( $name ); |
|
3572 | + $tax = $this->get_tax( $name ); |
|
3573 | 3573 | |
3574 | - if ( empty( $tax ) ) { |
|
3575 | - return 0; |
|
3576 | - } |
|
3574 | + if ( empty( $tax ) ) { |
|
3575 | + return 0; |
|
3576 | + } |
|
3577 | 3577 | |
3578 | 3578 | return $this->is_renewal() ? $tax['recurring_tax'] : $tax['initial_tax']; |
3579 | 3579 | } |
3580 | 3580 | |
3581 | 3581 | /** |
3582 | - * Removes a specific tax. |
|
3583 | - * |
|
3584 | - * @since 1.0.19 |
|
3585 | - */ |
|
3586 | - public function remove_tax( $tax ) { |
|
3582 | + * Removes a specific tax. |
|
3583 | + * |
|
3584 | + * @since 1.0.19 |
|
3585 | + */ |
|
3586 | + public function remove_tax( $tax ) { |
|
3587 | 3587 | $taxes = $this->get_taxes(); |
3588 | 3588 | if ( isset( $taxes[ $tax ] ) ) { |
3589 | 3589 | unset( $taxes[ $tax ] ); |
@@ -3592,183 +3592,183 @@ discard block |
||
3592 | 3592 | } |
3593 | 3593 | |
3594 | 3594 | /** |
3595 | - * Recalculates the invoice subtotal. |
|
3596 | - * |
|
3597 | - * @since 1.0.19 |
|
3598 | - * @return float The recalculated subtotal |
|
3599 | - */ |
|
3600 | - public function recalculate_subtotal() { |
|
3595 | + * Recalculates the invoice subtotal. |
|
3596 | + * |
|
3597 | + * @since 1.0.19 |
|
3598 | + * @return float The recalculated subtotal |
|
3599 | + */ |
|
3600 | + public function recalculate_subtotal() { |
|
3601 | 3601 | $items = $this->get_items(); |
3602 | - $subtotal = 0; |
|
3603 | - $recurring = 0; |
|
3602 | + $subtotal = 0; |
|
3603 | + $recurring = 0; |
|
3604 | 3604 | |
3605 | 3605 | foreach ( $items as $item ) { |
3606 | - $subtotal += $item->get_sub_total( 'edit' ); |
|
3607 | - $recurring += $item->get_recurring_sub_total( 'edit' ); |
|
3606 | + $subtotal += $item->get_sub_total( 'edit' ); |
|
3607 | + $recurring += $item->get_recurring_sub_total( 'edit' ); |
|
3608 | 3608 | } |
3609 | 3609 | |
3610 | - if ( wpinv_prices_include_tax() ) { |
|
3611 | - $subtotal = max( 0, $subtotal - $this->totals['tax']['initial'] ); |
|
3612 | - $recurring = max( 0, $recurring - $this->totals['tax']['recurring'] ); |
|
3613 | - } |
|
3610 | + if ( wpinv_prices_include_tax() ) { |
|
3611 | + $subtotal = max( 0, $subtotal - $this->totals['tax']['initial'] ); |
|
3612 | + $recurring = max( 0, $recurring - $this->totals['tax']['recurring'] ); |
|
3613 | + } |
|
3614 | 3614 | |
3615 | - $current = $this->is_renewal() ? $recurring : $subtotal; |
|
3616 | - $this->set_subtotal( $current ); |
|
3615 | + $current = $this->is_renewal() ? $recurring : $subtotal; |
|
3616 | + $this->set_subtotal( $current ); |
|
3617 | 3617 | |
3618 | - $this->totals['subtotal'] = array( |
|
3619 | - 'initial' => $subtotal, |
|
3620 | - 'recurring' => $recurring, |
|
3621 | - ); |
|
3618 | + $this->totals['subtotal'] = array( |
|
3619 | + 'initial' => $subtotal, |
|
3620 | + 'recurring' => $recurring, |
|
3621 | + ); |
|
3622 | 3622 | |
3623 | 3623 | return $current; |
3624 | 3624 | } |
3625 | 3625 | |
3626 | 3626 | /** |
3627 | - * Recalculates the invoice discount total. |
|
3628 | - * |
|
3629 | - * @since 1.0.19 |
|
3630 | - * @return float The recalculated discount |
|
3631 | - */ |
|
3632 | - public function recalculate_total_discount() { |
|
3627 | + * Recalculates the invoice discount total. |
|
3628 | + * |
|
3629 | + * @since 1.0.19 |
|
3630 | + * @return float The recalculated discount |
|
3631 | + */ |
|
3632 | + public function recalculate_total_discount() { |
|
3633 | 3633 | $discounts = $this->get_discounts(); |
3634 | - $discount = 0; |
|
3635 | - $recurring = 0; |
|
3634 | + $discount = 0; |
|
3635 | + $recurring = 0; |
|
3636 | 3636 | |
3637 | 3637 | foreach ( $discounts as $data ) { |
3638 | - $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
3639 | - $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
3640 | - } |
|
3638 | + $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
3639 | + $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
3640 | + } |
|
3641 | 3641 | |
3642 | - $current = $this->is_renewal() ? $recurring : $discount; |
|
3642 | + $current = $this->is_renewal() ? $recurring : $discount; |
|
3643 | 3643 | |
3644 | - $this->set_total_discount( $current ); |
|
3644 | + $this->set_total_discount( $current ); |
|
3645 | 3645 | |
3646 | - $this->totals['discount'] = array( |
|
3647 | - 'initial' => $discount, |
|
3648 | - 'recurring' => $recurring, |
|
3649 | - ); |
|
3646 | + $this->totals['discount'] = array( |
|
3647 | + 'initial' => $discount, |
|
3648 | + 'recurring' => $recurring, |
|
3649 | + ); |
|
3650 | 3650 | |
3651 | - return $current; |
|
3651 | + return $current; |
|
3652 | 3652 | |
3653 | 3653 | } |
3654 | 3654 | |
3655 | 3655 | /** |
3656 | - * Recalculates the invoice tax total. |
|
3657 | - * |
|
3658 | - * @since 1.0.19 |
|
3659 | - * @return float The recalculated tax |
|
3660 | - */ |
|
3661 | - public function recalculate_total_tax() { |
|
3656 | + * Recalculates the invoice tax total. |
|
3657 | + * |
|
3658 | + * @since 1.0.19 |
|
3659 | + * @return float The recalculated tax |
|
3660 | + */ |
|
3661 | + public function recalculate_total_tax() { |
|
3662 | 3662 | |
3663 | - // Maybe disable taxes. |
|
3664 | - $vat_number = $this->get_vat_number(); |
|
3665 | - $skip_tax = GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $this->get_country() ) && ! empty( $vat_number ); |
|
3663 | + // Maybe disable taxes. |
|
3664 | + $vat_number = $this->get_vat_number(); |
|
3665 | + $skip_tax = GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $this->get_country() ) && ! empty( $vat_number ); |
|
3666 | 3666 | |
3667 | - if ( wpinv_is_base_country( $this->get_country() ) && 'vat_too' === wpinv_get_option( 'vat_same_country_rule', 'vat_too' ) ) { |
|
3668 | - $skip_tax = false; |
|
3669 | - } |
|
3667 | + if ( wpinv_is_base_country( $this->get_country() ) && 'vat_too' === wpinv_get_option( 'vat_same_country_rule', 'vat_too' ) ) { |
|
3668 | + $skip_tax = false; |
|
3669 | + } |
|
3670 | 3670 | |
3671 | - if ( ! wpinv_use_taxes() || $this->get_disable_taxes() || ! wpinv_is_country_taxable( $this->get_country() ) || $skip_tax ) { |
|
3671 | + if ( ! wpinv_use_taxes() || $this->get_disable_taxes() || ! wpinv_is_country_taxable( $this->get_country() ) || $skip_tax ) { |
|
3672 | 3672 | |
3673 | - $this->totals['tax'] = array( |
|
3674 | - 'initial' => 0, |
|
3675 | - 'recurring' => 0, |
|
3676 | - ); |
|
3673 | + $this->totals['tax'] = array( |
|
3674 | + 'initial' => 0, |
|
3675 | + 'recurring' => 0, |
|
3676 | + ); |
|
3677 | 3677 | |
3678 | - $this->tax_rate = 0; |
|
3678 | + $this->tax_rate = 0; |
|
3679 | 3679 | |
3680 | - $this->set_taxes( array() ); |
|
3681 | - $current = 0; |
|
3682 | - } else { |
|
3680 | + $this->set_taxes( array() ); |
|
3681 | + $current = 0; |
|
3682 | + } else { |
|
3683 | 3683 | |
3684 | - $item_taxes = array(); |
|
3684 | + $item_taxes = array(); |
|
3685 | 3685 | |
3686 | - foreach ( $this->get_items() as $item ) { |
|
3687 | - $rates = getpaid_get_item_tax_rates( $item, $this->get_country(), $this->get_state() ); |
|
3688 | - $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
3689 | - $taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, false ), $rates ); |
|
3690 | - $r_taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, true ), $rates ); |
|
3691 | - foreach ( $taxes as $name => $amount ) { |
|
3692 | - $recurring = isset( $r_taxes[ $name ] ) ? $r_taxes[ $name ] : 0; |
|
3693 | - $tax = getpaid_prepare_item_tax( $item, $name, $amount, $recurring ); |
|
3686 | + foreach ( $this->get_items() as $item ) { |
|
3687 | + $rates = getpaid_get_item_tax_rates( $item, $this->get_country(), $this->get_state() ); |
|
3688 | + $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
3689 | + $taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, false ), $rates ); |
|
3690 | + $r_taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, true ), $rates ); |
|
3691 | + foreach ( $taxes as $name => $amount ) { |
|
3692 | + $recurring = isset( $r_taxes[ $name ] ) ? $r_taxes[ $name ] : 0; |
|
3693 | + $tax = getpaid_prepare_item_tax( $item, $name, $amount, $recurring ); |
|
3694 | 3694 | |
3695 | - if ( ! isset( $item_taxes[ $name ] ) ) { |
|
3696 | - $item_taxes[ $name ] = $tax; |
|
3697 | - continue; |
|
3698 | - } |
|
3695 | + if ( ! isset( $item_taxes[ $name ] ) ) { |
|
3696 | + $item_taxes[ $name ] = $tax; |
|
3697 | + continue; |
|
3698 | + } |
|
3699 | 3699 | |
3700 | - $item_taxes[ $name ]['initial_tax'] += $tax['initial_tax']; |
|
3701 | - $item_taxes[ $name ]['recurring_tax'] += $tax['recurring_tax']; |
|
3700 | + $item_taxes[ $name ]['initial_tax'] += $tax['initial_tax']; |
|
3701 | + $item_taxes[ $name ]['recurring_tax'] += $tax['recurring_tax']; |
|
3702 | 3702 | |
3703 | - } |
|
3704 | - } |
|
3703 | + } |
|
3704 | + } |
|
3705 | 3705 | |
3706 | - $this->set_taxes( $item_taxes ); |
|
3706 | + $this->set_taxes( $item_taxes ); |
|
3707 | 3707 | |
3708 | - $initial_tax = array_sum( wp_list_pluck( $item_taxes, 'initial_tax' ) ); |
|
3709 | - $recurring_tax = array_sum( wp_list_pluck( $item_taxes, 'recurring_tax' ) ); |
|
3708 | + $initial_tax = array_sum( wp_list_pluck( $item_taxes, 'initial_tax' ) ); |
|
3709 | + $recurring_tax = array_sum( wp_list_pluck( $item_taxes, 'recurring_tax' ) ); |
|
3710 | 3710 | |
3711 | - $current = $this->is_renewal() ? $recurring_tax : $initial_tax; |
|
3711 | + $current = $this->is_renewal() ? $recurring_tax : $initial_tax; |
|
3712 | 3712 | |
3713 | - $this->totals['tax'] = array( |
|
3714 | - 'initial' => $initial_tax, |
|
3715 | - 'recurring' => $recurring_tax, |
|
3716 | - ); |
|
3713 | + $this->totals['tax'] = array( |
|
3714 | + 'initial' => $initial_tax, |
|
3715 | + 'recurring' => $recurring_tax, |
|
3716 | + ); |
|
3717 | 3717 | |
3718 | - } |
|
3718 | + } |
|
3719 | 3719 | |
3720 | - $this->set_total_tax( $current ); |
|
3720 | + $this->set_total_tax( $current ); |
|
3721 | 3721 | |
3722 | - return $current; |
|
3722 | + return $current; |
|
3723 | 3723 | |
3724 | 3724 | } |
3725 | 3725 | |
3726 | 3726 | /** |
3727 | - * Recalculates the invoice fees total. |
|
3728 | - * |
|
3729 | - * @since 1.0.19 |
|
3730 | - * @return float The recalculated fee |
|
3731 | - */ |
|
3732 | - public function recalculate_total_fees() { |
|
3733 | - $fees = $this->get_fees(); |
|
3734 | - $fee = 0; |
|
3735 | - $recurring = 0; |
|
3727 | + * Recalculates the invoice fees total. |
|
3728 | + * |
|
3729 | + * @since 1.0.19 |
|
3730 | + * @return float The recalculated fee |
|
3731 | + */ |
|
3732 | + public function recalculate_total_fees() { |
|
3733 | + $fees = $this->get_fees(); |
|
3734 | + $fee = 0; |
|
3735 | + $recurring = 0; |
|
3736 | 3736 | |
3737 | 3737 | foreach ( $fees as $data ) { |
3738 | - $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
3739 | - $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
3740 | - } |
|
3738 | + $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
3739 | + $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
3740 | + } |
|
3741 | 3741 | |
3742 | - $current = $this->is_renewal() ? $recurring : $fee; |
|
3743 | - $this->set_total_fees( $current ); |
|
3742 | + $current = $this->is_renewal() ? $recurring : $fee; |
|
3743 | + $this->set_total_fees( $current ); |
|
3744 | 3744 | |
3745 | - $this->totals['fee'] = array( |
|
3746 | - 'initial' => $fee, |
|
3747 | - 'recurring' => $recurring, |
|
3748 | - ); |
|
3745 | + $this->totals['fee'] = array( |
|
3746 | + 'initial' => $fee, |
|
3747 | + 'recurring' => $recurring, |
|
3748 | + ); |
|
3749 | 3749 | |
3750 | 3750 | $this->set_total_fees( $fee ); |
3751 | 3751 | return $current; |
3752 | 3752 | } |
3753 | 3753 | |
3754 | 3754 | /** |
3755 | - * Recalculates the invoice total. |
|
3756 | - * |
|
3757 | - * @since 1.0.19 |
|
3755 | + * Recalculates the invoice total. |
|
3756 | + * |
|
3757 | + * @since 1.0.19 |
|
3758 | 3758 | * @return float The invoice total |
3759 | - */ |
|
3760 | - public function recalculate_total() { |
|
3759 | + */ |
|
3760 | + public function recalculate_total() { |
|
3761 | 3761 | $this->recalculate_total_fees(); |
3762 | 3762 | $this->recalculate_total_discount(); |
3763 | - $this->recalculate_total_tax(); |
|
3764 | - $this->recalculate_subtotal(); |
|
3765 | - $this->set_total( $this->get_total_tax( 'edit' ) + $this->get_total_fees( 'edit' ) + $this->get_subtotal( 'edit' ) - $this->get_total_discount( 'edit' ) ); |
|
3766 | - return $this->get_total(); |
|
3767 | - } |
|
3768 | - |
|
3769 | - /** |
|
3770 | - * @deprecated |
|
3771 | - */ |
|
3763 | + $this->recalculate_total_tax(); |
|
3764 | + $this->recalculate_subtotal(); |
|
3765 | + $this->set_total( $this->get_total_tax( 'edit' ) + $this->get_total_fees( 'edit' ) + $this->get_subtotal( 'edit' ) - $this->get_total_discount( 'edit' ) ); |
|
3766 | + return $this->get_total(); |
|
3767 | + } |
|
3768 | + |
|
3769 | + /** |
|
3770 | + * @deprecated |
|
3771 | + */ |
|
3772 | 3772 | public function recalculate_totals() { |
3773 | 3773 | $this->recalculate_total(); |
3774 | 3774 | $this->save( true ); |
@@ -3782,22 +3782,22 @@ discard block |
||
3782 | 3782 | return $this->get_data(); |
3783 | 3783 | } |
3784 | 3784 | |
3785 | - /** |
|
3785 | + /** |
|
3786 | 3786 | * Adds a system note to an invoice. |
3787 | 3787 | * |
3788 | 3788 | * @param string $note The note being added. |
3789 | - * @return int|false The new note's ID on success, false on failure. |
|
3789 | + * @return int|false The new note's ID on success, false on failure. |
|
3790 | 3790 | * |
3791 | 3791 | */ |
3792 | 3792 | public function add_system_note( $note ) { |
3793 | - return $this->add_note( $note, false, false, true ); |
|
3794 | - } |
|
3793 | + return $this->add_note( $note, false, false, true ); |
|
3794 | + } |
|
3795 | 3795 | |
3796 | 3796 | /** |
3797 | 3797 | * Adds a note to an invoice. |
3798 | 3798 | * |
3799 | 3799 | * @param string $note The note being added. |
3800 | - * @return int|false The new note's ID on success, false on failure. |
|
3800 | + * @return int|false The new note's ID on success, false on failure. |
|
3801 | 3801 | * |
3802 | 3802 | */ |
3803 | 3803 | public function add_note( $note = '', $customer_type = false, $added_by_user = false, $system = false ) { |
@@ -3807,21 +3807,21 @@ discard block |
||
3807 | 3807 | return false; |
3808 | 3808 | } |
3809 | 3809 | |
3810 | - $author = 'System'; |
|
3811 | - $author_email = '[email protected]'; |
|
3810 | + $author = 'System'; |
|
3811 | + $author_email = '[email protected]'; |
|
3812 | 3812 | |
3813 | - // If this is an admin comment or it has been added by the user. |
|
3814 | - if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
3815 | - $user = get_user_by( 'id', get_current_user_id() ); |
|
3813 | + // If this is an admin comment or it has been added by the user. |
|
3814 | + if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
3815 | + $user = get_user_by( 'id', get_current_user_id() ); |
|
3816 | 3816 | $author = $user->display_name; |
3817 | 3817 | $author_email = $user->user_email; |
3818 | - } |
|
3818 | + } |
|
3819 | 3819 | |
3820 | - return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
3820 | + return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
3821 | 3821 | |
3822 | - } |
|
3822 | + } |
|
3823 | 3823 | |
3824 | - /** |
|
3824 | + /** |
|
3825 | 3825 | * Generates a unique key for the invoice. |
3826 | 3826 | */ |
3827 | 3827 | public function generate_key( $string = '' ) { |
@@ -3841,113 +3841,113 @@ discard block |
||
3841 | 3841 | $number = wpinv_get_next_invoice_number( $this->get_post_type() ); |
3842 | 3842 | } |
3843 | 3843 | |
3844 | - return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
3845 | - |
|
3846 | - } |
|
3847 | - |
|
3848 | - /** |
|
3849 | - * Handle the status transition. |
|
3850 | - */ |
|
3851 | - protected function status_transition() { |
|
3852 | - $status_transition = $this->status_transition; |
|
3853 | - |
|
3854 | - // Reset status transition variable. |
|
3855 | - $this->status_transition = false; |
|
3856 | - |
|
3857 | - if ( $status_transition ) { |
|
3858 | - try { |
|
3859 | - |
|
3860 | - // Fire a hook for the status change. |
|
3861 | - do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
3862 | - |
|
3863 | - // @deprecated this is deprecated and will be removed in the future. |
|
3864 | - do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3865 | - |
|
3866 | - if ( ! empty( $status_transition['from'] ) ) { |
|
3867 | - |
|
3868 | - /* translators: 1: old invoice status 2: new invoice status */ |
|
3869 | - $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 ) ); |
|
3870 | - |
|
3871 | - // Fire another hook. |
|
3872 | - do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
3873 | - do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
3844 | + return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
3874 | 3845 | |
3875 | - // @deprecated this is deprecated and will be removed in the future. |
|
3876 | - do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3877 | - |
|
3878 | - // Note the transition occurred. |
|
3879 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), false, $status_transition['manual'] ); |
|
3880 | - |
|
3881 | - // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
3882 | - if ( |
|
3883 | - in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3884 | - && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3885 | - ) { |
|
3886 | - do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
3887 | - } |
|
3888 | - |
|
3889 | - // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
3890 | - if ( |
|
3891 | - in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3892 | - && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3893 | - ) { |
|
3894 | - do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
3895 | - } |
|
3896 | - } else { |
|
3897 | - /* translators: %s: new invoice status */ |
|
3898 | - $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
3899 | - |
|
3900 | - // Note the transition occurred. |
|
3901 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
3846 | + } |
|
3902 | 3847 | |
3903 | - } |
|
3904 | - } catch ( Exception $e ) { |
|
3905 | - $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
3906 | - } |
|
3907 | - } |
|
3908 | - } |
|
3848 | + /** |
|
3849 | + * Handle the status transition. |
|
3850 | + */ |
|
3851 | + protected function status_transition() { |
|
3852 | + $status_transition = $this->status_transition; |
|
3853 | + |
|
3854 | + // Reset status transition variable. |
|
3855 | + $this->status_transition = false; |
|
3856 | + |
|
3857 | + if ( $status_transition ) { |
|
3858 | + try { |
|
3859 | + |
|
3860 | + // Fire a hook for the status change. |
|
3861 | + do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
3862 | + |
|
3863 | + // @deprecated this is deprecated and will be removed in the future. |
|
3864 | + do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3865 | + |
|
3866 | + if ( ! empty( $status_transition['from'] ) ) { |
|
3867 | + |
|
3868 | + /* translators: 1: old invoice status 2: new invoice status */ |
|
3869 | + $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 ) ); |
|
3870 | + |
|
3871 | + // Fire another hook. |
|
3872 | + do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
3873 | + do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
3874 | + |
|
3875 | + // @deprecated this is deprecated and will be removed in the future. |
|
3876 | + do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3877 | + |
|
3878 | + // Note the transition occurred. |
|
3879 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), false, $status_transition['manual'] ); |
|
3880 | + |
|
3881 | + // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
3882 | + if ( |
|
3883 | + in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3884 | + && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3885 | + ) { |
|
3886 | + do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
3887 | + } |
|
3888 | + |
|
3889 | + // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
3890 | + if ( |
|
3891 | + in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3892 | + && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3893 | + ) { |
|
3894 | + do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
3895 | + } |
|
3896 | + } else { |
|
3897 | + /* translators: %s: new invoice status */ |
|
3898 | + $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
3899 | + |
|
3900 | + // Note the transition occurred. |
|
3901 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
3902 | + |
|
3903 | + } |
|
3904 | + } catch ( Exception $e ) { |
|
3905 | + $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
3906 | + } |
|
3907 | + } |
|
3908 | + } |
|
3909 | 3909 | |
3910 | - /** |
|
3911 | - * Updates an invoice status. |
|
3912 | - */ |
|
3913 | - public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
3910 | + /** |
|
3911 | + * Updates an invoice status. |
|
3912 | + */ |
|
3913 | + public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
3914 | 3914 | |
3915 | - // Fires before updating a status. |
|
3916 | - do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
3915 | + // Fires before updating a status. |
|
3916 | + do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
3917 | 3917 | |
3918 | - // Update the status. |
|
3919 | - $this->set_status( $new_status, $note, $manual ); |
|
3918 | + // Update the status. |
|
3919 | + $this->set_status( $new_status, $note, $manual ); |
|
3920 | 3920 | |
3921 | - // Save the order. |
|
3922 | - return $this->save(); |
|
3921 | + // Save the order. |
|
3922 | + return $this->save(); |
|
3923 | 3923 | |
3924 | - } |
|
3924 | + } |
|
3925 | 3925 | |
3926 | - /** |
|
3927 | - * @deprecated |
|
3928 | - */ |
|
3929 | - public function refresh_item_ids() { |
|
3926 | + /** |
|
3927 | + * @deprecated |
|
3928 | + */ |
|
3929 | + public function refresh_item_ids() { |
|
3930 | 3930 | $item_ids = implode( ',', array_unique( wp_list_pluck( $this->get_cart_details(), 'item_id' ) ) ); |
3931 | 3931 | update_post_meta( $this->get_id(), '_wpinv_item_ids', $item_ids ); |
3932 | - } |
|
3932 | + } |
|
3933 | 3933 | |
3934 | - /** |
|
3935 | - * @deprecated |
|
3936 | - */ |
|
3937 | - public function update_items( $temp = false ) { |
|
3934 | + /** |
|
3935 | + * @deprecated |
|
3936 | + */ |
|
3937 | + public function update_items( $temp = false ) { |
|
3938 | 3938 | |
3939 | - $this->set_items( $this->get_items() ); |
|
3939 | + $this->set_items( $this->get_items() ); |
|
3940 | 3940 | |
3941 | - if ( ! $temp ) { |
|
3942 | - $this->save(); |
|
3943 | - } |
|
3941 | + if ( ! $temp ) { |
|
3942 | + $this->save(); |
|
3943 | + } |
|
3944 | 3944 | |
3945 | 3945 | return $this; |
3946 | - } |
|
3946 | + } |
|
3947 | 3947 | |
3948 | - /** |
|
3949 | - * @deprecated |
|
3950 | - */ |
|
3948 | + /** |
|
3949 | + * @deprecated |
|
3950 | + */ |
|
3951 | 3951 | public function validate_discount() { |
3952 | 3952 | |
3953 | 3953 | $discount_code = $this->get_discount_code(); |
@@ -3963,101 +3963,101 @@ discard block |
||
3963 | 3963 | |
3964 | 3964 | } |
3965 | 3965 | |
3966 | - /** |
|
3967 | - * Refunds an invoice. |
|
3968 | - */ |
|
3966 | + /** |
|
3967 | + * Refunds an invoice. |
|
3968 | + */ |
|
3969 | 3969 | public function refund() { |
3970 | - $this->set_status( 'wpi-refunded' ); |
|
3970 | + $this->set_status( 'wpi-refunded' ); |
|
3971 | 3971 | $this->save(); |
3972 | - } |
|
3972 | + } |
|
3973 | 3973 | |
3974 | - /** |
|
3975 | - * Marks an invoice as paid. |
|
3976 | - * |
|
3977 | - * @param string $transaction_id |
|
3978 | - */ |
|
3974 | + /** |
|
3975 | + * Marks an invoice as paid. |
|
3976 | + * |
|
3977 | + * @param string $transaction_id |
|
3978 | + */ |
|
3979 | 3979 | public function mark_paid( $transaction_id = null, $note = '' ) { |
3980 | 3980 | |
3981 | - // Set the transaction id. |
|
3982 | - if ( empty( $transaction_id ) ) { |
|
3983 | - $transaction_id = $this->generate_key( 'trans_' ); |
|
3984 | - } |
|
3981 | + // Set the transaction id. |
|
3982 | + if ( empty( $transaction_id ) ) { |
|
3983 | + $transaction_id = $this->generate_key( 'trans_' ); |
|
3984 | + } |
|
3985 | 3985 | |
3986 | - if ( ! $this->get_transaction_id() ) { |
|
3987 | - $this->set_transaction_id( $transaction_id ); |
|
3988 | - } |
|
3986 | + if ( ! $this->get_transaction_id() ) { |
|
3987 | + $this->set_transaction_id( $transaction_id ); |
|
3988 | + } |
|
3989 | 3989 | |
3990 | - if ( $this->is_paid() && 'wpi-processing' !== $this->get_status() ) { |
|
3991 | - return $this->save(); |
|
3992 | - } |
|
3990 | + if ( $this->is_paid() && 'wpi-processing' !== $this->get_status() ) { |
|
3991 | + return $this->save(); |
|
3992 | + } |
|
3993 | 3993 | |
3994 | - // Set the completed date. |
|
3995 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
3994 | + // Set the completed date. |
|
3995 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
3996 | 3996 | |
3997 | - // Set the new status. |
|
3998 | - $gateway = sanitize_text_field( $this->get_gateway_title() ); |
|
3999 | - if ( $this->is_renewal() || ! $this->is_parent() ) { |
|
3997 | + // Set the new status. |
|
3998 | + $gateway = sanitize_text_field( $this->get_gateway_title() ); |
|
3999 | + if ( $this->is_renewal() || ! $this->is_parent() ) { |
|
4000 | 4000 | |
4001 | - $_note = wp_sprintf( __( 'Renewed via %s', 'invoicing' ), $gateway ); |
|
4002 | - $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
4001 | + $_note = wp_sprintf( __( 'Renewed via %s', 'invoicing' ), $gateway ); |
|
4002 | + $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
4003 | 4003 | |
4004 | - if ( 'none' == $this->get_gateway() ) { |
|
4005 | - $_note = $note; |
|
4006 | - } |
|
4004 | + if ( 'none' == $this->get_gateway() ) { |
|
4005 | + $_note = $note; |
|
4006 | + } |
|
4007 | 4007 | |
4008 | - $this->set_status( 'wpi-renewal', $_note ); |
|
4008 | + $this->set_status( 'wpi-renewal', $_note ); |
|
4009 | 4009 | |
4010 | - } else { |
|
4010 | + } else { |
|
4011 | 4011 | |
4012 | - $_note = wp_sprintf( __( 'Paid via %s', 'invoicing' ), $gateway ); |
|
4013 | - $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
4012 | + $_note = wp_sprintf( __( 'Paid via %s', 'invoicing' ), $gateway ); |
|
4013 | + $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
4014 | 4014 | |
4015 | - if ( 'none' == $this->get_gateway() ) { |
|
4016 | - $_note = $note; |
|
4017 | - } |
|
4015 | + if ( 'none' == $this->get_gateway() ) { |
|
4016 | + $_note = $note; |
|
4017 | + } |
|
4018 | 4018 | |
4019 | - $this->set_status( 'publish', $_note ); |
|
4019 | + $this->set_status( 'publish', $_note ); |
|
4020 | 4020 | |
4021 | - } |
|
4021 | + } |
|
4022 | 4022 | |
4023 | - // Set checkout mode. |
|
4024 | - $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
4025 | - $this->set_mode( $mode ); |
|
4023 | + // Set checkout mode. |
|
4024 | + $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
4025 | + $this->set_mode( $mode ); |
|
4026 | 4026 | |
4027 | - // Save the invoice. |
|
4027 | + // Save the invoice. |
|
4028 | 4028 | $this->save(); |
4029 | - } |
|
4030 | - |
|
4031 | - /** |
|
4032 | - * Save data to the database. |
|
4033 | - * |
|
4034 | - * @since 1.0.19 |
|
4035 | - * @return int invoice ID |
|
4036 | - */ |
|
4037 | - public function save() { |
|
4038 | - $this->maybe_set_date_paid(); |
|
4039 | - $this->maybe_set_key(); |
|
4040 | - parent::save(); |
|
4041 | - $this->clear_cache(); |
|
4042 | - $this->status_transition(); |
|
4043 | - return $this->get_id(); |
|
4044 | - } |
|
4045 | - |
|
4046 | - /** |
|
4029 | + } |
|
4030 | + |
|
4031 | + /** |
|
4032 | + * Save data to the database. |
|
4033 | + * |
|
4034 | + * @since 1.0.19 |
|
4035 | + * @return int invoice ID |
|
4036 | + */ |
|
4037 | + public function save() { |
|
4038 | + $this->maybe_set_date_paid(); |
|
4039 | + $this->maybe_set_key(); |
|
4040 | + parent::save(); |
|
4041 | + $this->clear_cache(); |
|
4042 | + $this->status_transition(); |
|
4043 | + return $this->get_id(); |
|
4044 | + } |
|
4045 | + |
|
4046 | + /** |
|
4047 | 4047 | * Clears the subscription's cache. |
4048 | 4048 | */ |
4049 | 4049 | public function clear_cache() { |
4050 | - if ( $this->get_key() ) { |
|
4051 | - wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
4052 | - } |
|
4053 | - |
|
4054 | - if ( $this->get_number() ) { |
|
4055 | - wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
4056 | - } |
|
4057 | - |
|
4058 | - if ( $this->get_transaction_id() ) { |
|
4059 | - wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
4060 | - } |
|
4061 | - } |
|
4050 | + if ( $this->get_key() ) { |
|
4051 | + wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
4052 | + } |
|
4053 | + |
|
4054 | + if ( $this->get_number() ) { |
|
4055 | + wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
4056 | + } |
|
4057 | + |
|
4058 | + if ( $this->get_transaction_id() ) { |
|
4059 | + wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
4060 | + } |
|
4061 | + } |
|
4062 | 4062 | |
4063 | 4063 | } |