@@ -14,30 +14,30 @@ discard block |
||
14 | 14 | class WPInv_Invoice extends GetPaid_Data { |
15 | 15 | |
16 | 16 | /** |
17 | - * Which data store to load. |
|
18 | - * |
|
19 | - * @var string |
|
20 | - */ |
|
17 | + * Which data store to load. |
|
18 | + * |
|
19 | + * @var string |
|
20 | + */ |
|
21 | 21 | protected $data_store_name = 'invoice'; |
22 | 22 | |
23 | 23 | /** |
24 | - * This is the name of this object type. |
|
25 | - * |
|
26 | - * @var string |
|
27 | - */ |
|
24 | + * This is the name of this object type. |
|
25 | + * |
|
26 | + * @var string |
|
27 | + */ |
|
28 | 28 | protected $object_type = 'invoice'; |
29 | 29 | |
30 | 30 | /** |
31 | - * Item Data array. This is the core item data exposed in APIs. |
|
32 | - * |
|
33 | - * @since 1.0.19 |
|
34 | - * @var array |
|
35 | - */ |
|
36 | - protected $data = array( |
|
37 | - 'parent_id' => 0, |
|
38 | - 'status' => 'wpi-pending', |
|
39 | - 'version' => '', |
|
40 | - 'date_created' => null, |
|
31 | + * Item Data array. This is the core item data exposed in APIs. |
|
32 | + * |
|
33 | + * @since 1.0.19 |
|
34 | + * @var array |
|
35 | + */ |
|
36 | + protected $data = array( |
|
37 | + 'parent_id' => 0, |
|
38 | + 'status' => 'wpi-pending', |
|
39 | + 'version' => '', |
|
40 | + 'date_created' => null, |
|
41 | 41 | 'date_modified' => null, |
42 | 42 | 'due_date' => null, |
43 | 43 | 'completed_date' => null, |
@@ -60,7 +60,7 @@ discard block |
||
60 | 60 | 'state' => null, |
61 | 61 | 'zip' => null, |
62 | 62 | 'company' => null, |
63 | - 'company_id' => null, |
|
63 | + 'company_id' => null, |
|
64 | 64 | 'vat_number' => null, |
65 | 65 | 'vat_rate' => null, |
66 | 66 | 'address' => null, |
@@ -68,8 +68,8 @@ discard block |
||
68 | 68 | 'subtotal' => 0, |
69 | 69 | 'total_discount' => 0, |
70 | 70 | 'total_tax' => 0, |
71 | - 'total_fees' => 0, |
|
72 | - 'total' => 0, |
|
71 | + 'total_fees' => 0, |
|
72 | + 'total' => 0, |
|
73 | 73 | 'fees' => array(), |
74 | 74 | 'discounts' => array(), |
75 | 75 | 'taxes' => array(), |
@@ -81,22 +81,22 @@ discard block |
||
81 | 81 | 'transaction_id' => '', |
82 | 82 | 'currency' => '', |
83 | 83 | 'disable_taxes' => false, |
84 | - 'subscription_id' => null, |
|
85 | - 'remote_subscription_id' => null, |
|
86 | - 'is_viewed' => false, |
|
87 | - 'email_cc' => '', |
|
88 | - 'template' => 'quantity', // hours, amount only |
|
89 | - 'created_via' => null, |
|
84 | + 'subscription_id' => null, |
|
85 | + 'remote_subscription_id' => null, |
|
86 | + 'is_viewed' => false, |
|
87 | + 'email_cc' => '', |
|
88 | + 'template' => 'quantity', // hours, amount only |
|
89 | + 'created_via' => null, |
|
90 | 90 | ); |
91 | 91 | |
92 | 92 | /** |
93 | - * Stores meta in cache for future reads. |
|
94 | - * |
|
95 | - * A group must be set to to enable caching. |
|
96 | - * |
|
97 | - * @var string |
|
98 | - */ |
|
99 | - protected $cache_group = 'getpaid_invoices'; |
|
93 | + * Stores meta in cache for future reads. |
|
94 | + * |
|
95 | + * A group must be set to to enable caching. |
|
96 | + * |
|
97 | + * @var string |
|
98 | + */ |
|
99 | + protected $cache_group = 'getpaid_invoices'; |
|
100 | 100 | |
101 | 101 | /** |
102 | 102 | * Stores a reference to the original WP_Post object |
@@ -110,111 +110,111 @@ discard block |
||
110 | 110 | * |
111 | 111 | * @var int |
112 | 112 | */ |
113 | - protected $recurring_item = null; |
|
113 | + protected $recurring_item = null; |
|
114 | 114 | |
115 | - /** |
|
115 | + /** |
|
116 | 116 | * Stores an array of item totals. |
117 | - * |
|
118 | - * e.g $totals['discount'] = array( |
|
119 | - * 'initial' => 10, |
|
120 | - * 'recurring' => 10, |
|
121 | - * ) |
|
117 | + * |
|
118 | + * e.g $totals['discount'] = array( |
|
119 | + * 'initial' => 10, |
|
120 | + * 'recurring' => 10, |
|
121 | + * ) |
|
122 | 122 | * |
123 | 123 | * @var array |
124 | 124 | */ |
125 | - protected $totals = array(); |
|
125 | + protected $totals = array(); |
|
126 | 126 | |
127 | - /** |
|
127 | + /** |
|
128 | 128 | * Tax rate. |
129 | - * |
|
129 | + * |
|
130 | 130 | * @var float |
131 | 131 | */ |
132 | - protected $tax_rate = 0; |
|
132 | + protected $tax_rate = 0; |
|
133 | 133 | |
134 | - /** |
|
135 | - * Stores the status transition information. |
|
136 | - * |
|
137 | - * @since 1.0.19 |
|
138 | - * @var bool|array |
|
139 | - */ |
|
140 | - protected $status_transition = false; |
|
134 | + /** |
|
135 | + * Stores the status transition information. |
|
136 | + * |
|
137 | + * @since 1.0.19 |
|
138 | + * @var bool|array |
|
139 | + */ |
|
140 | + protected $status_transition = false; |
|
141 | 141 | |
142 | 142 | /** |
143 | - * Get the invoice if ID is passed, otherwise the invoice is new and empty. |
|
144 | - * |
|
145 | - * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object to read. |
|
146 | - */ |
|
143 | + * Get the invoice if ID is passed, otherwise the invoice is new and empty. |
|
144 | + * |
|
145 | + * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object to read. |
|
146 | + */ |
|
147 | 147 | public function __construct( $invoice = 0 ) { |
148 | 148 | |
149 | 149 | parent::__construct( $invoice ); |
150 | 150 | |
151 | - if ( ! empty( $invoice ) && is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( (int) $invoice ) ) ) { |
|
152 | - $this->set_id( (int) $invoice ); |
|
153 | - } elseif ( $invoice instanceof self ) { |
|
154 | - $this->set_id( $invoice->get_id() ); |
|
155 | - } elseif ( ! empty( $invoice->ID ) ) { |
|
156 | - $this->set_id( $invoice->ID ); |
|
157 | - } elseif ( is_array( $invoice ) ) { |
|
158 | - $this->set_props( $invoice ); |
|
159 | - |
|
160 | - if ( isset( $invoice['ID'] ) ) { |
|
161 | - $this->set_id( $invoice['ID'] ); |
|
162 | - } |
|
163 | - |
|
164 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'key' ) ) { |
|
165 | - $this->set_id( $invoice_id ); |
|
166 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'number' ) ) { |
|
167 | - $this->set_id( $invoice_id ); |
|
168 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'transaction_id' ) ) { |
|
169 | - $this->set_id( $invoice_id ); |
|
170 | - } else { |
|
171 | - $this->set_object_read( true ); |
|
172 | - } |
|
151 | + if ( ! empty( $invoice ) && is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( (int) $invoice ) ) ) { |
|
152 | + $this->set_id( (int) $invoice ); |
|
153 | + } elseif ( $invoice instanceof self ) { |
|
154 | + $this->set_id( $invoice->get_id() ); |
|
155 | + } elseif ( ! empty( $invoice->ID ) ) { |
|
156 | + $this->set_id( $invoice->ID ); |
|
157 | + } elseif ( is_array( $invoice ) ) { |
|
158 | + $this->set_props( $invoice ); |
|
159 | + |
|
160 | + if ( isset( $invoice['ID'] ) ) { |
|
161 | + $this->set_id( $invoice['ID'] ); |
|
162 | + } |
|
163 | + |
|
164 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'key' ) ) { |
|
165 | + $this->set_id( $invoice_id ); |
|
166 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'number' ) ) { |
|
167 | + $this->set_id( $invoice_id ); |
|
168 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'transaction_id' ) ) { |
|
169 | + $this->set_id( $invoice_id ); |
|
170 | + } else { |
|
171 | + $this->set_object_read( true ); |
|
172 | + } |
|
173 | 173 | |
174 | 174 | // Load the datastore. |
175 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
175 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
176 | 176 | |
177 | - if ( $this->get_id() > 0 ) { |
|
177 | + if ( $this->get_id() > 0 ) { |
|
178 | 178 | $this->post = get_post( $this->get_id() ); |
179 | 179 | $this->ID = $this->get_id(); |
180 | - $this->data_store->read( $this ); |
|
180 | + $this->data_store->read( $this ); |
|
181 | 181 | } |
182 | 182 | |
183 | 183 | } |
184 | 184 | |
185 | 185 | /** |
186 | - * Given an invoice key/number, it returns its id. |
|
187 | - * |
|
188 | - * |
|
189 | - * @static |
|
190 | - * @param string $value The invoice key or number |
|
191 | - * @param string $field Either key, transaction_id or number. |
|
192 | - * @since 1.0.15 |
|
193 | - * @return int |
|
194 | - */ |
|
195 | - public static function get_invoice_id_by_field( $value, $field = 'key' ) { |
|
186 | + * Given an invoice key/number, it returns its id. |
|
187 | + * |
|
188 | + * |
|
189 | + * @static |
|
190 | + * @param string $value The invoice key or number |
|
191 | + * @param string $field Either key, transaction_id or number. |
|
192 | + * @since 1.0.15 |
|
193 | + * @return int |
|
194 | + */ |
|
195 | + public static function get_invoice_id_by_field( $value, $field = 'key' ) { |
|
196 | 196 | global $wpdb; |
197 | 197 | |
198 | - // Trim the value. |
|
199 | - $value = trim( $value ); |
|
198 | + // Trim the value. |
|
199 | + $value = trim( $value ); |
|
200 | 200 | |
201 | - if ( empty( $value ) ) { |
|
202 | - return 0; |
|
203 | - } |
|
201 | + if ( empty( $value ) ) { |
|
202 | + return 0; |
|
203 | + } |
|
204 | 204 | |
205 | 205 | // Valid fields. |
206 | 206 | $fields = array( 'key', 'number', 'transaction_id' ); |
207 | 207 | |
208 | - // Ensure a field has been passed. |
|
209 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
210 | - return 0; |
|
211 | - } |
|
208 | + // Ensure a field has been passed. |
|
209 | + if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
210 | + return 0; |
|
211 | + } |
|
212 | 212 | |
213 | - // Maybe retrieve from the cache. |
|
214 | - $invoice_id = wp_cache_get( $value, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
215 | - if ( false !== $invoice_id ) { |
|
216 | - return $invoice_id; |
|
217 | - } |
|
213 | + // Maybe retrieve from the cache. |
|
214 | + $invoice_id = wp_cache_get( $value, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
215 | + if ( false !== $invoice_id ) { |
|
216 | + return $invoice_id; |
|
217 | + } |
|
218 | 218 | |
219 | 219 | // Fetch from the db. |
220 | 220 | $table = $wpdb->prefix . 'getpaid_invoices'; |
@@ -222,10 +222,10 @@ discard block |
||
222 | 222 | $wpdb->prepare( "SELECT `post_id` FROM $table WHERE `$field`=%s LIMIT 1", $value ) |
223 | 223 | ); |
224 | 224 | |
225 | - // Update the cache with our data |
|
226 | - wp_cache_set( $value, $invoice_id, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
225 | + // Update the cache with our data |
|
226 | + wp_cache_set( $value, $invoice_id, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
227 | 227 | |
228 | - return $invoice_id; |
|
228 | + return $invoice_id; |
|
229 | 229 | } |
230 | 230 | |
231 | 231 | /** |
@@ -251,83 +251,83 @@ discard block |
||
251 | 251 | */ |
252 | 252 | |
253 | 253 | /** |
254 | - * Get parent invoice ID. |
|
255 | - * |
|
256 | - * @since 1.0.19 |
|
257 | - * @param string $context View or edit context. |
|
258 | - * @return int |
|
259 | - */ |
|
260 | - public function get_parent_id( $context = 'view' ) { |
|
261 | - return (int) $this->get_prop( 'parent_id', $context ); |
|
254 | + * Get parent invoice ID. |
|
255 | + * |
|
256 | + * @since 1.0.19 |
|
257 | + * @param string $context View or edit context. |
|
258 | + * @return int |
|
259 | + */ |
|
260 | + public function get_parent_id( $context = 'view' ) { |
|
261 | + return (int) $this->get_prop( 'parent_id', $context ); |
|
262 | 262 | } |
263 | 263 | |
264 | 264 | /** |
265 | - * Get parent invoice. |
|
266 | - * |
|
267 | - * @since 1.0.19 |
|
268 | - * @return WPInv_Invoice |
|
269 | - */ |
|
265 | + * Get parent invoice. |
|
266 | + * |
|
267 | + * @since 1.0.19 |
|
268 | + * @return WPInv_Invoice |
|
269 | + */ |
|
270 | 270 | public function get_parent_payment() { |
271 | 271 | return new WPInv_Invoice( $this->get_parent_id() ); |
272 | 272 | } |
273 | 273 | |
274 | 274 | /** |
275 | - * Alias for self::get_parent_payment(). |
|
276 | - * |
|
277 | - * @since 1.0.19 |
|
278 | - * @return WPInv_Invoice |
|
279 | - */ |
|
275 | + * Alias for self::get_parent_payment(). |
|
276 | + * |
|
277 | + * @since 1.0.19 |
|
278 | + * @return WPInv_Invoice |
|
279 | + */ |
|
280 | 280 | public function get_parent() { |
281 | 281 | return $this->get_parent_payment(); |
282 | 282 | } |
283 | 283 | |
284 | 284 | /** |
285 | - * Get invoice status. |
|
286 | - * |
|
287 | - * @since 1.0.19 |
|
288 | - * @param string $context View or edit context. |
|
289 | - * @return string |
|
290 | - */ |
|
291 | - public function get_status( $context = 'view' ) { |
|
292 | - return $this->get_prop( 'status', $context ); |
|
293 | - } |
|
285 | + * Get invoice status. |
|
286 | + * |
|
287 | + * @since 1.0.19 |
|
288 | + * @param string $context View or edit context. |
|
289 | + * @return string |
|
290 | + */ |
|
291 | + public function get_status( $context = 'view' ) { |
|
292 | + return $this->get_prop( 'status', $context ); |
|
293 | + } |
|
294 | 294 | |
295 | - /** |
|
296 | - * Retrieves an array of possible invoice statuses. |
|
297 | - * |
|
298 | - * @since 1.0.19 |
|
299 | - * @return array |
|
300 | - */ |
|
301 | - public function get_all_statuses() { |
|
302 | - return wpinv_get_invoice_statuses( true, true, $this ); |
|
303 | - } |
|
304 | - |
|
305 | - /** |
|
306 | - * Get invoice status nice name. |
|
307 | - * |
|
308 | - * @since 1.0.19 |
|
309 | - * @return string |
|
310 | - */ |
|
295 | + /** |
|
296 | + * Retrieves an array of possible invoice statuses. |
|
297 | + * |
|
298 | + * @since 1.0.19 |
|
299 | + * @return array |
|
300 | + */ |
|
301 | + public function get_all_statuses() { |
|
302 | + return wpinv_get_invoice_statuses( true, true, $this ); |
|
303 | + } |
|
304 | + |
|
305 | + /** |
|
306 | + * Get invoice status nice name. |
|
307 | + * |
|
308 | + * @since 1.0.19 |
|
309 | + * @return string |
|
310 | + */ |
|
311 | 311 | public function get_status_nicename() { |
312 | - $statuses = $this->get_all_statuses(); |
|
312 | + $statuses = $this->get_all_statuses(); |
|
313 | 313 | |
314 | 314 | $status = isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : $this->get_status(); |
315 | 315 | |
316 | 316 | return apply_filters( 'wpinv_get_invoice_status_nicename', $status, $this ); |
317 | 317 | } |
318 | 318 | |
319 | - /** |
|
320 | - * Retrieves the invoice status class |
|
321 | - * |
|
322 | - * @since 1.0.19 |
|
323 | - * @return string |
|
324 | - */ |
|
325 | - public function get_status_class() { |
|
326 | - $statuses = getpaid_get_invoice_status_classes(); |
|
327 | - return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
328 | - } |
|
319 | + /** |
|
320 | + * Retrieves the invoice status class |
|
321 | + * |
|
322 | + * @since 1.0.19 |
|
323 | + * @return string |
|
324 | + */ |
|
325 | + public function get_status_class() { |
|
326 | + $statuses = getpaid_get_invoice_status_classes(); |
|
327 | + return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
328 | + } |
|
329 | 329 | |
330 | - /** |
|
330 | + /** |
|
331 | 331 | * Retrieves the invoice status label html |
332 | 332 | * |
333 | 333 | * @since 1.0.0 |
@@ -335,263 +335,263 @@ discard block |
||
335 | 335 | */ |
336 | 336 | public function get_status_label_html() { |
337 | 337 | |
338 | - $status_label = sanitize_text_field( $this->get_status_nicename() ); |
|
339 | - $status = sanitize_html_class( $this->get_status() ); |
|
340 | - $class = esc_attr( $this->get_status_class() ); |
|
338 | + $status_label = sanitize_text_field( $this->get_status_nicename() ); |
|
339 | + $status = sanitize_html_class( $this->get_status() ); |
|
340 | + $class = esc_attr( $this->get_status_class() ); |
|
341 | 341 | |
342 | - return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
343 | - } |
|
342 | + return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
343 | + } |
|
344 | 344 | |
345 | 345 | /** |
346 | - * Get plugin version when the invoice was created. |
|
347 | - * |
|
348 | - * @since 1.0.19 |
|
349 | - * @param string $context View or edit context. |
|
350 | - * @return string |
|
351 | - */ |
|
352 | - public function get_version( $context = 'view' ) { |
|
353 | - return $this->get_prop( 'version', $context ); |
|
354 | - } |
|
346 | + * Get plugin version when the invoice was created. |
|
347 | + * |
|
348 | + * @since 1.0.19 |
|
349 | + * @param string $context View or edit context. |
|
350 | + * @return string |
|
351 | + */ |
|
352 | + public function get_version( $context = 'view' ) { |
|
353 | + return $this->get_prop( 'version', $context ); |
|
354 | + } |
|
355 | 355 | |
356 | - /** |
|
357 | - * @deprecated |
|
358 | - */ |
|
359 | - public function get_invoice_date( $format = true ) { |
|
360 | - $date = getpaid_format_date( $this->get_date_completed() ); |
|
361 | - $date = empty( $date ) ? $this->get_date_created() : $this->get_date_completed(); |
|
362 | - $formatted = getpaid_format_date( $date ); |
|
356 | + /** |
|
357 | + * @deprecated |
|
358 | + */ |
|
359 | + public function get_invoice_date( $format = true ) { |
|
360 | + $date = getpaid_format_date( $this->get_date_completed() ); |
|
361 | + $date = empty( $date ) ? $this->get_date_created() : $this->get_date_completed(); |
|
362 | + $formatted = getpaid_format_date( $date ); |
|
363 | 363 | |
364 | - if ( $format ) { |
|
365 | - return $formatted; |
|
366 | - } |
|
364 | + if ( $format ) { |
|
365 | + return $formatted; |
|
366 | + } |
|
367 | 367 | |
368 | - return empty( $formatted ) ? '' : $date; |
|
368 | + return empty( $formatted ) ? '' : $date; |
|
369 | 369 | |
370 | 370 | } |
371 | 371 | |
372 | 372 | /** |
373 | - * Get date when the invoice was created. |
|
374 | - * |
|
375 | - * @since 1.0.19 |
|
376 | - * @param string $context View or edit context. |
|
377 | - * @return string |
|
378 | - */ |
|
379 | - public function get_date_created( $context = 'view' ) { |
|
380 | - return $this->get_prop( 'date_created', $context ); |
|
381 | - } |
|
373 | + * Get date when the invoice was created. |
|
374 | + * |
|
375 | + * @since 1.0.19 |
|
376 | + * @param string $context View or edit context. |
|
377 | + * @return string |
|
378 | + */ |
|
379 | + public function get_date_created( $context = 'view' ) { |
|
380 | + return $this->get_prop( 'date_created', $context ); |
|
381 | + } |
|
382 | 382 | |
383 | - /** |
|
384 | - * Alias for self::get_date_created(). |
|
385 | - * |
|
386 | - * @since 1.0.19 |
|
387 | - * @param string $context View or edit context. |
|
388 | - * @return string |
|
389 | - */ |
|
390 | - public function get_created_date( $context = 'view' ) { |
|
391 | - return $this->get_date_created( $context ); |
|
392 | - } |
|
393 | - |
|
394 | - /** |
|
395 | - * Get GMT date when the invoice was created. |
|
396 | - * |
|
397 | - * @since 1.0.19 |
|
398 | - * @param string $context View or edit context. |
|
399 | - * @return string |
|
400 | - */ |
|
401 | - public function get_date_created_gmt( $context = 'view' ) { |
|
383 | + /** |
|
384 | + * Alias for self::get_date_created(). |
|
385 | + * |
|
386 | + * @since 1.0.19 |
|
387 | + * @param string $context View or edit context. |
|
388 | + * @return string |
|
389 | + */ |
|
390 | + public function get_created_date( $context = 'view' ) { |
|
391 | + return $this->get_date_created( $context ); |
|
392 | + } |
|
393 | + |
|
394 | + /** |
|
395 | + * Get GMT date when the invoice was created. |
|
396 | + * |
|
397 | + * @since 1.0.19 |
|
398 | + * @param string $context View or edit context. |
|
399 | + * @return string |
|
400 | + */ |
|
401 | + public function get_date_created_gmt( $context = 'view' ) { |
|
402 | 402 | $date = $this->get_date_created( $context ); |
403 | 403 | |
404 | 404 | if ( $date ) { |
405 | 405 | $date = get_gmt_from_date( $date ); |
406 | 406 | } |
407 | - return $date; |
|
407 | + return $date; |
|
408 | 408 | } |
409 | 409 | |
410 | 410 | /** |
411 | - * Get date when the invoice was last modified. |
|
412 | - * |
|
413 | - * @since 1.0.19 |
|
414 | - * @param string $context View or edit context. |
|
415 | - * @return string |
|
416 | - */ |
|
417 | - public function get_date_modified( $context = 'view' ) { |
|
418 | - return $this->get_prop( 'date_modified', $context ); |
|
419 | - } |
|
411 | + * Get date when the invoice was last modified. |
|
412 | + * |
|
413 | + * @since 1.0.19 |
|
414 | + * @param string $context View or edit context. |
|
415 | + * @return string |
|
416 | + */ |
|
417 | + public function get_date_modified( $context = 'view' ) { |
|
418 | + return $this->get_prop( 'date_modified', $context ); |
|
419 | + } |
|
420 | 420 | |
421 | - /** |
|
422 | - * Alias for self::get_date_modified(). |
|
423 | - * |
|
424 | - * @since 1.0.19 |
|
425 | - * @param string $context View or edit context. |
|
426 | - * @return string |
|
427 | - */ |
|
428 | - public function get_modified_date( $context = 'view' ) { |
|
429 | - return $this->get_date_modified( $context ); |
|
421 | + /** |
|
422 | + * Alias for self::get_date_modified(). |
|
423 | + * |
|
424 | + * @since 1.0.19 |
|
425 | + * @param string $context View or edit context. |
|
426 | + * @return string |
|
427 | + */ |
|
428 | + public function get_modified_date( $context = 'view' ) { |
|
429 | + return $this->get_date_modified( $context ); |
|
430 | 430 | } |
431 | 431 | |
432 | 432 | /** |
433 | - * Get GMT date when the invoice was last modified. |
|
434 | - * |
|
435 | - * @since 1.0.19 |
|
436 | - * @param string $context View or edit context. |
|
437 | - * @return string |
|
438 | - */ |
|
439 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
433 | + * Get GMT date when the invoice was last modified. |
|
434 | + * |
|
435 | + * @since 1.0.19 |
|
436 | + * @param string $context View or edit context. |
|
437 | + * @return string |
|
438 | + */ |
|
439 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
440 | 440 | $date = $this->get_date_modified( $context ); |
441 | 441 | |
442 | 442 | if ( $date ) { |
443 | 443 | $date = get_gmt_from_date( $date ); |
444 | 444 | } |
445 | - return $date; |
|
445 | + return $date; |
|
446 | 446 | } |
447 | 447 | |
448 | 448 | /** |
449 | - * Get the invoice due date. |
|
450 | - * |
|
451 | - * @since 1.0.19 |
|
452 | - * @param string $context View or edit context. |
|
453 | - * @return string |
|
454 | - */ |
|
455 | - public function get_due_date( $context = 'view' ) { |
|
456 | - return $this->get_prop( 'due_date', $context ); |
|
449 | + * Get the invoice due date. |
|
450 | + * |
|
451 | + * @since 1.0.19 |
|
452 | + * @param string $context View or edit context. |
|
453 | + * @return string |
|
454 | + */ |
|
455 | + public function get_due_date( $context = 'view' ) { |
|
456 | + return $this->get_prop( 'due_date', $context ); |
|
457 | 457 | } |
458 | 458 | |
459 | 459 | /** |
460 | - * Alias for self::get_due_date(). |
|
461 | - * |
|
462 | - * @since 1.0.19 |
|
463 | - * @param string $context View or edit context. |
|
464 | - * @return string |
|
465 | - */ |
|
466 | - public function get_date_due( $context = 'view' ) { |
|
467 | - return $this->get_due_date( $context ); |
|
460 | + * Alias for self::get_due_date(). |
|
461 | + * |
|
462 | + * @since 1.0.19 |
|
463 | + * @param string $context View or edit context. |
|
464 | + * @return string |
|
465 | + */ |
|
466 | + public function get_date_due( $context = 'view' ) { |
|
467 | + return $this->get_due_date( $context ); |
|
468 | 468 | } |
469 | 469 | |
470 | 470 | /** |
471 | - * Get the invoice GMT due date. |
|
472 | - * |
|
473 | - * @since 1.0.19 |
|
474 | - * @param string $context View or edit context. |
|
475 | - * @return string |
|
476 | - */ |
|
477 | - public function get_due_date_gmt( $context = 'view' ) { |
|
471 | + * Get the invoice GMT due date. |
|
472 | + * |
|
473 | + * @since 1.0.19 |
|
474 | + * @param string $context View or edit context. |
|
475 | + * @return string |
|
476 | + */ |
|
477 | + public function get_due_date_gmt( $context = 'view' ) { |
|
478 | 478 | $date = $this->get_due_date( $context ); |
479 | 479 | |
480 | 480 | if ( $date ) { |
481 | 481 | $date = get_gmt_from_date( $date ); |
482 | 482 | } |
483 | - return $date; |
|
483 | + return $date; |
|
484 | 484 | } |
485 | 485 | |
486 | 486 | /** |
487 | - * Alias for self::get_due_date_gmt(). |
|
488 | - * |
|
489 | - * @since 1.0.19 |
|
490 | - * @param string $context View or edit context. |
|
491 | - * @return string |
|
492 | - */ |
|
493 | - public function get_gmt_date_due( $context = 'view' ) { |
|
494 | - return $this->get_due_date_gmt( $context ); |
|
487 | + * Alias for self::get_due_date_gmt(). |
|
488 | + * |
|
489 | + * @since 1.0.19 |
|
490 | + * @param string $context View or edit context. |
|
491 | + * @return string |
|
492 | + */ |
|
493 | + public function get_gmt_date_due( $context = 'view' ) { |
|
494 | + return $this->get_due_date_gmt( $context ); |
|
495 | 495 | } |
496 | 496 | |
497 | 497 | /** |
498 | - * Get date when the invoice was completed. |
|
499 | - * |
|
500 | - * @since 1.0.19 |
|
501 | - * @param string $context View or edit context. |
|
502 | - * @return string |
|
503 | - */ |
|
504 | - public function get_completed_date( $context = 'view' ) { |
|
505 | - return $this->get_prop( 'completed_date', $context ); |
|
498 | + * Get date when the invoice was completed. |
|
499 | + * |
|
500 | + * @since 1.0.19 |
|
501 | + * @param string $context View or edit context. |
|
502 | + * @return string |
|
503 | + */ |
|
504 | + public function get_completed_date( $context = 'view' ) { |
|
505 | + return $this->get_prop( 'completed_date', $context ); |
|
506 | 506 | } |
507 | 507 | |
508 | 508 | /** |
509 | - * Alias for self::get_completed_date(). |
|
510 | - * |
|
511 | - * @since 1.0.19 |
|
512 | - * @param string $context View or edit context. |
|
513 | - * @return string |
|
514 | - */ |
|
515 | - public function get_date_completed( $context = 'view' ) { |
|
516 | - return $this->get_completed_date( $context ); |
|
509 | + * Alias for self::get_completed_date(). |
|
510 | + * |
|
511 | + * @since 1.0.19 |
|
512 | + * @param string $context View or edit context. |
|
513 | + * @return string |
|
514 | + */ |
|
515 | + public function get_date_completed( $context = 'view' ) { |
|
516 | + return $this->get_completed_date( $context ); |
|
517 | 517 | } |
518 | 518 | |
519 | 519 | /** |
520 | - * Get GMT date when the invoice was was completed. |
|
521 | - * |
|
522 | - * @since 1.0.19 |
|
523 | - * @param string $context View or edit context. |
|
524 | - * @return string |
|
525 | - */ |
|
526 | - public function get_completed_date_gmt( $context = 'view' ) { |
|
520 | + * Get GMT date when the invoice was was completed. |
|
521 | + * |
|
522 | + * @since 1.0.19 |
|
523 | + * @param string $context View or edit context. |
|
524 | + * @return string |
|
525 | + */ |
|
526 | + public function get_completed_date_gmt( $context = 'view' ) { |
|
527 | 527 | $date = $this->get_completed_date( $context ); |
528 | 528 | |
529 | 529 | if ( $date ) { |
530 | 530 | $date = get_gmt_from_date( $date ); |
531 | 531 | } |
532 | - return $date; |
|
532 | + return $date; |
|
533 | 533 | } |
534 | 534 | |
535 | 535 | /** |
536 | - * Alias for self::get_completed_date_gmt(). |
|
537 | - * |
|
538 | - * @since 1.0.19 |
|
539 | - * @param string $context View or edit context. |
|
540 | - * @return string |
|
541 | - */ |
|
542 | - public function get_gmt_completed_date( $context = 'view' ) { |
|
543 | - return $this->get_completed_date_gmt( $context ); |
|
536 | + * Alias for self::get_completed_date_gmt(). |
|
537 | + * |
|
538 | + * @since 1.0.19 |
|
539 | + * @param string $context View or edit context. |
|
540 | + * @return string |
|
541 | + */ |
|
542 | + public function get_gmt_completed_date( $context = 'view' ) { |
|
543 | + return $this->get_completed_date_gmt( $context ); |
|
544 | 544 | } |
545 | 545 | |
546 | 546 | /** |
547 | - * Get the invoice number. |
|
548 | - * |
|
549 | - * @since 1.0.19 |
|
550 | - * @param string $context View or edit context. |
|
551 | - * @return string |
|
552 | - */ |
|
553 | - public function get_number( $context = 'view' ) { |
|
554 | - $number = $this->get_prop( 'number', $context ); |
|
547 | + * Get the invoice number. |
|
548 | + * |
|
549 | + * @since 1.0.19 |
|
550 | + * @param string $context View or edit context. |
|
551 | + * @return string |
|
552 | + */ |
|
553 | + public function get_number( $context = 'view' ) { |
|
554 | + $number = $this->get_prop( 'number', $context ); |
|
555 | 555 | |
556 | - if ( empty( $number ) ) { |
|
557 | - $number = $this->generate_number(); |
|
558 | - $this->set_number( $this->generate_number() ); |
|
559 | - } |
|
556 | + if ( empty( $number ) ) { |
|
557 | + $number = $this->generate_number(); |
|
558 | + $this->set_number( $this->generate_number() ); |
|
559 | + } |
|
560 | 560 | |
561 | - return $number; |
|
561 | + return $number; |
|
562 | 562 | } |
563 | 563 | |
564 | - /** |
|
565 | - * Set the invoice number. |
|
566 | - * |
|
567 | - * @since 1.0.19 |
|
568 | - */ |
|
569 | - public function maybe_set_number() { |
|
564 | + /** |
|
565 | + * Set the invoice number. |
|
566 | + * |
|
567 | + * @since 1.0.19 |
|
568 | + */ |
|
569 | + public function maybe_set_number() { |
|
570 | 570 | $number = $this->get_number(); |
571 | 571 | |
572 | 572 | if ( empty( $number ) || $this->get_id() == $number ) { |
573 | - $this->set_number( $this->generate_number() ); |
|
573 | + $this->set_number( $this->generate_number() ); |
|
574 | 574 | } |
575 | 575 | |
576 | - } |
|
576 | + } |
|
577 | 577 | |
578 | 578 | /** |
579 | - * Get the invoice key. |
|
580 | - * |
|
581 | - * @since 1.0.19 |
|
582 | - * @param string $context View or edit context. |
|
583 | - * @return string |
|
584 | - */ |
|
585 | - public function get_key( $context = 'view' ) { |
|
579 | + * Get the invoice key. |
|
580 | + * |
|
581 | + * @since 1.0.19 |
|
582 | + * @param string $context View or edit context. |
|
583 | + * @return string |
|
584 | + */ |
|
585 | + public function get_key( $context = 'view' ) { |
|
586 | 586 | return $this->get_prop( 'key', $context ); |
587 | - } |
|
588 | - |
|
589 | - /** |
|
590 | - * Set the invoice key. |
|
591 | - * |
|
592 | - * @since 1.0.19 |
|
593 | - */ |
|
594 | - public function maybe_set_key() { |
|
587 | + } |
|
588 | + |
|
589 | + /** |
|
590 | + * Set the invoice key. |
|
591 | + * |
|
592 | + * @since 1.0.19 |
|
593 | + */ |
|
594 | + public function maybe_set_key() { |
|
595 | 595 | $key = $this->get_key(); |
596 | 596 | |
597 | 597 | if ( empty( $key ) ) { |
@@ -602,140 +602,140 @@ discard block |
||
602 | 602 | } |
603 | 603 | |
604 | 604 | /** |
605 | - * Get the invoice type. |
|
606 | - * |
|
607 | - * @since 1.0.19 |
|
608 | - * @param string $context View or edit context. |
|
609 | - * @return string |
|
610 | - */ |
|
611 | - public function get_type( $context = 'view' ) { |
|
605 | + * Get the invoice type. |
|
606 | + * |
|
607 | + * @since 1.0.19 |
|
608 | + * @param string $context View or edit context. |
|
609 | + * @return string |
|
610 | + */ |
|
611 | + public function get_type( $context = 'view' ) { |
|
612 | 612 | return $this->get_prop( 'type', $context ); |
613 | - } |
|
614 | - |
|
615 | - /** |
|
616 | - * Returns the post type name. |
|
617 | - * |
|
618 | - * @since 1.0.19 |
|
619 | - * @return string |
|
620 | - */ |
|
621 | - public function get_invoice_quote_type() { |
|
613 | + } |
|
614 | + |
|
615 | + /** |
|
616 | + * Returns the post type name. |
|
617 | + * |
|
618 | + * @since 1.0.19 |
|
619 | + * @return string |
|
620 | + */ |
|
621 | + public function get_invoice_quote_type() { |
|
622 | 622 | return getpaid_get_post_type_label( $this->get_post_type(), false ); |
623 | 623 | } |
624 | 624 | |
625 | 625 | /** |
626 | - * Get the invoice post type label. |
|
627 | - * |
|
628 | - * @since 1.0.19 |
|
629 | - * @param string $context View or edit context. |
|
630 | - * @return string |
|
631 | - */ |
|
632 | - public function get_label( $context = 'view' ) { |
|
626 | + * Get the invoice post type label. |
|
627 | + * |
|
628 | + * @since 1.0.19 |
|
629 | + * @param string $context View or edit context. |
|
630 | + * @return string |
|
631 | + */ |
|
632 | + public function get_label( $context = 'view' ) { |
|
633 | 633 | return getpaid_get_post_type_label( $this->get_post_type( $context ), false ); |
634 | - } |
|
635 | - |
|
636 | - /** |
|
637 | - * Get the invoice post type. |
|
638 | - * |
|
639 | - * @since 1.0.19 |
|
640 | - * @param string $context View or edit context. |
|
641 | - * @return string |
|
642 | - */ |
|
643 | - public function get_post_type( $context = 'view' ) { |
|
634 | + } |
|
635 | + |
|
636 | + /** |
|
637 | + * Get the invoice post type. |
|
638 | + * |
|
639 | + * @since 1.0.19 |
|
640 | + * @param string $context View or edit context. |
|
641 | + * @return string |
|
642 | + */ |
|
643 | + public function get_post_type( $context = 'view' ) { |
|
644 | 644 | return $this->get_prop( 'post_type', $context ); |
645 | 645 | } |
646 | 646 | |
647 | 647 | /** |
648 | - * Get the invoice mode. |
|
649 | - * |
|
650 | - * @since 1.0.19 |
|
651 | - * @param string $context View or edit context. |
|
652 | - * @return string |
|
653 | - */ |
|
654 | - public function get_mode( $context = 'view' ) { |
|
648 | + * Get the invoice mode. |
|
649 | + * |
|
650 | + * @since 1.0.19 |
|
651 | + * @param string $context View or edit context. |
|
652 | + * @return string |
|
653 | + */ |
|
654 | + public function get_mode( $context = 'view' ) { |
|
655 | 655 | return $this->get_prop( 'mode', $context ); |
656 | 656 | } |
657 | 657 | |
658 | 658 | /** |
659 | - * Get the invoice path. |
|
660 | - * |
|
661 | - * @since 1.0.19 |
|
662 | - * @param string $context View or edit context. |
|
663 | - * @return string |
|
664 | - */ |
|
665 | - public function get_path( $context = 'view' ) { |
|
659 | + * Get the invoice path. |
|
660 | + * |
|
661 | + * @since 1.0.19 |
|
662 | + * @param string $context View or edit context. |
|
663 | + * @return string |
|
664 | + */ |
|
665 | + public function get_path( $context = 'view' ) { |
|
666 | 666 | $path = $this->get_prop( 'path', $context ); |
667 | - $prefix = $this->get_type(); |
|
667 | + $prefix = $this->get_type(); |
|
668 | 668 | |
669 | - if ( 0 !== strpos( $path, $prefix ) ) { |
|
670 | - $path = sanitize_title( $prefix . '-' . $this->get_id() ); |
|
671 | - $this->set_path( $path ); |
|
672 | - } |
|
669 | + if ( 0 !== strpos( $path, $prefix ) ) { |
|
670 | + $path = sanitize_title( $prefix . '-' . $this->get_id() ); |
|
671 | + $this->set_path( $path ); |
|
672 | + } |
|
673 | 673 | |
674 | - return $path; |
|
674 | + return $path; |
|
675 | 675 | } |
676 | 676 | |
677 | 677 | /** |
678 | - * Get the invoice name/title. |
|
679 | - * |
|
680 | - * @since 1.0.19 |
|
681 | - * @param string $context View or edit context. |
|
682 | - * @return string |
|
683 | - */ |
|
684 | - public function get_name( $context = 'view' ) { |
|
678 | + * Get the invoice name/title. |
|
679 | + * |
|
680 | + * @since 1.0.19 |
|
681 | + * @param string $context View or edit context. |
|
682 | + * @return string |
|
683 | + */ |
|
684 | + public function get_name( $context = 'view' ) { |
|
685 | 685 | return $this->get_prop( 'title', $context ); |
686 | 686 | } |
687 | 687 | |
688 | 688 | /** |
689 | - * Alias of self::get_name(). |
|
690 | - * |
|
691 | - * @since 1.0.19 |
|
692 | - * @param string $context View or edit context. |
|
693 | - * @return string |
|
694 | - */ |
|
695 | - public function get_title( $context = 'view' ) { |
|
696 | - return $this->get_name( $context ); |
|
689 | + * Alias of self::get_name(). |
|
690 | + * |
|
691 | + * @since 1.0.19 |
|
692 | + * @param string $context View or edit context. |
|
693 | + * @return string |
|
694 | + */ |
|
695 | + public function get_title( $context = 'view' ) { |
|
696 | + return $this->get_name( $context ); |
|
697 | 697 | } |
698 | 698 | |
699 | 699 | /** |
700 | - * Get the invoice description. |
|
701 | - * |
|
702 | - * @since 1.0.19 |
|
703 | - * @param string $context View or edit context. |
|
704 | - * @return string |
|
705 | - */ |
|
706 | - public function get_description( $context = 'view' ) { |
|
707 | - return $this->get_prop( 'description', $context ); |
|
700 | + * Get the invoice description. |
|
701 | + * |
|
702 | + * @since 1.0.19 |
|
703 | + * @param string $context View or edit context. |
|
704 | + * @return string |
|
705 | + */ |
|
706 | + public function get_description( $context = 'view' ) { |
|
707 | + return $this->get_prop( 'description', $context ); |
|
708 | 708 | } |
709 | 709 | |
710 | 710 | /** |
711 | - * Alias of self::get_description(). |
|
712 | - * |
|
713 | - * @since 1.0.19 |
|
714 | - * @param string $context View or edit context. |
|
715 | - * @return string |
|
716 | - */ |
|
717 | - public function get_excerpt( $context = 'view' ) { |
|
718 | - return $this->get_description( $context ); |
|
711 | + * Alias of self::get_description(). |
|
712 | + * |
|
713 | + * @since 1.0.19 |
|
714 | + * @param string $context View or edit context. |
|
715 | + * @return string |
|
716 | + */ |
|
717 | + public function get_excerpt( $context = 'view' ) { |
|
718 | + return $this->get_description( $context ); |
|
719 | 719 | } |
720 | 720 | |
721 | 721 | /** |
722 | - * Alias of self::get_description(). |
|
723 | - * |
|
724 | - * @since 1.0.19 |
|
725 | - * @param string $context View or edit context. |
|
726 | - * @return string |
|
727 | - */ |
|
728 | - public function get_summary( $context = 'view' ) { |
|
729 | - return $this->get_description( $context ); |
|
722 | + * Alias of self::get_description(). |
|
723 | + * |
|
724 | + * @since 1.0.19 |
|
725 | + * @param string $context View or edit context. |
|
726 | + * @return string |
|
727 | + */ |
|
728 | + public function get_summary( $context = 'view' ) { |
|
729 | + return $this->get_description( $context ); |
|
730 | 730 | } |
731 | 731 | |
732 | 732 | /** |
733 | - * Returns the user info. |
|
734 | - * |
|
735 | - * @since 1.0.19 |
|
733 | + * Returns the user info. |
|
734 | + * |
|
735 | + * @since 1.0.19 |
|
736 | 736 | * @param string $context View or edit context. |
737 | - * @return array |
|
738 | - */ |
|
737 | + * @return array |
|
738 | + */ |
|
739 | 739 | public function get_user_info( $context = 'view' ) { |
740 | 740 | |
741 | 741 | $user_info = array( |
@@ -750,630 +750,630 @@ discard block |
||
750 | 750 | 'state' => $this->get_state( $context ), |
751 | 751 | 'zip' => $this->get_zip( $context ), |
752 | 752 | 'company' => $this->get_company( $context ), |
753 | - 'company_id' => $this->get_company_id( $context ), |
|
753 | + 'company_id' => $this->get_company_id( $context ), |
|
754 | 754 | 'vat_number' => $this->get_vat_number( $context ), |
755 | 755 | 'discount' => $this->get_discount_code( $context ), |
756 | - ); |
|
756 | + ); |
|
757 | 757 | |
758 | - return apply_filters( 'wpinv_user_info', $user_info, $this->get_id(), $this ); |
|
758 | + return apply_filters( 'wpinv_user_info', $user_info, $this->get_id(), $this ); |
|
759 | 759 | |
760 | 760 | } |
761 | 761 | |
762 | 762 | /** |
763 | - * Get the customer id. |
|
764 | - * |
|
765 | - * @since 1.0.19 |
|
766 | - * @param string $context View or edit context. |
|
767 | - * @return int |
|
768 | - */ |
|
769 | - public function get_author( $context = 'view' ) { |
|
770 | - return (int) $this->get_prop( 'author', $context ); |
|
763 | + * Get the customer id. |
|
764 | + * |
|
765 | + * @since 1.0.19 |
|
766 | + * @param string $context View or edit context. |
|
767 | + * @return int |
|
768 | + */ |
|
769 | + public function get_author( $context = 'view' ) { |
|
770 | + return (int) $this->get_prop( 'author', $context ); |
|
771 | 771 | } |
772 | 772 | |
773 | 773 | /** |
774 | - * Alias of self::get_author(). |
|
775 | - * |
|
776 | - * @since 1.0.19 |
|
777 | - * @param string $context View or edit context. |
|
778 | - * @return int |
|
779 | - */ |
|
780 | - public function get_user_id( $context = 'view' ) { |
|
781 | - return $this->get_author( $context ); |
|
774 | + * Alias of self::get_author(). |
|
775 | + * |
|
776 | + * @since 1.0.19 |
|
777 | + * @param string $context View or edit context. |
|
778 | + * @return int |
|
779 | + */ |
|
780 | + public function get_user_id( $context = 'view' ) { |
|
781 | + return $this->get_author( $context ); |
|
782 | 782 | } |
783 | 783 | |
784 | - /** |
|
785 | - * Alias of self::get_author(). |
|
786 | - * |
|
787 | - * @since 1.0.19 |
|
788 | - * @param string $context View or edit context. |
|
789 | - * @return int |
|
790 | - */ |
|
791 | - public function get_customer_id( $context = 'view' ) { |
|
792 | - return $this->get_author( $context ); |
|
784 | + /** |
|
785 | + * Alias of self::get_author(). |
|
786 | + * |
|
787 | + * @since 1.0.19 |
|
788 | + * @param string $context View or edit context. |
|
789 | + * @return int |
|
790 | + */ |
|
791 | + public function get_customer_id( $context = 'view' ) { |
|
792 | + return $this->get_author( $context ); |
|
793 | 793 | } |
794 | 794 | |
795 | 795 | /** |
796 | - * Get the customer's ip. |
|
797 | - * |
|
798 | - * @since 1.0.19 |
|
799 | - * @param string $context View or edit context. |
|
800 | - * @return string |
|
801 | - */ |
|
802 | - public function get_ip( $context = 'view' ) { |
|
803 | - return $this->get_prop( 'user_ip', $context ); |
|
796 | + * Get the customer's ip. |
|
797 | + * |
|
798 | + * @since 1.0.19 |
|
799 | + * @param string $context View or edit context. |
|
800 | + * @return string |
|
801 | + */ |
|
802 | + public function get_ip( $context = 'view' ) { |
|
803 | + return $this->get_prop( 'user_ip', $context ); |
|
804 | 804 | } |
805 | 805 | |
806 | 806 | /** |
807 | - * Alias of self::get_ip(). |
|
808 | - * |
|
809 | - * @since 1.0.19 |
|
810 | - * @param string $context View or edit context. |
|
811 | - * @return string |
|
812 | - */ |
|
813 | - public function get_user_ip( $context = 'view' ) { |
|
814 | - return $this->get_ip( $context ); |
|
807 | + * Alias of self::get_ip(). |
|
808 | + * |
|
809 | + * @since 1.0.19 |
|
810 | + * @param string $context View or edit context. |
|
811 | + * @return string |
|
812 | + */ |
|
813 | + public function get_user_ip( $context = 'view' ) { |
|
814 | + return $this->get_ip( $context ); |
|
815 | 815 | } |
816 | 816 | |
817 | - /** |
|
818 | - * Alias of self::get_ip(). |
|
819 | - * |
|
820 | - * @since 1.0.19 |
|
821 | - * @param string $context View or edit context. |
|
822 | - * @return string |
|
823 | - */ |
|
824 | - public function get_customer_ip( $context = 'view' ) { |
|
825 | - return $this->get_ip( $context ); |
|
817 | + /** |
|
818 | + * Alias of self::get_ip(). |
|
819 | + * |
|
820 | + * @since 1.0.19 |
|
821 | + * @param string $context View or edit context. |
|
822 | + * @return string |
|
823 | + */ |
|
824 | + public function get_customer_ip( $context = 'view' ) { |
|
825 | + return $this->get_ip( $context ); |
|
826 | 826 | } |
827 | 827 | |
828 | 828 | /** |
829 | - * Get the customer's first name. |
|
830 | - * |
|
831 | - * @since 1.0.19 |
|
832 | - * @param string $context View or edit context. |
|
833 | - * @return string |
|
834 | - */ |
|
835 | - public function get_first_name( $context = 'view' ) { |
|
836 | - return $this->get_prop( 'first_name', $context ); |
|
829 | + * Get the customer's first name. |
|
830 | + * |
|
831 | + * @since 1.0.19 |
|
832 | + * @param string $context View or edit context. |
|
833 | + * @return string |
|
834 | + */ |
|
835 | + public function get_first_name( $context = 'view' ) { |
|
836 | + return $this->get_prop( 'first_name', $context ); |
|
837 | 837 | } |
838 | 838 | |
839 | 839 | /** |
840 | - * Alias of self::get_first_name(). |
|
841 | - * |
|
842 | - * @since 1.0.19 |
|
843 | - * @param string $context View or edit context. |
|
844 | - * @return string |
|
845 | - */ |
|
846 | - public function get_user_first_name( $context = 'view' ) { |
|
847 | - return $this->get_first_name( $context ); |
|
840 | + * Alias of self::get_first_name(). |
|
841 | + * |
|
842 | + * @since 1.0.19 |
|
843 | + * @param string $context View or edit context. |
|
844 | + * @return string |
|
845 | + */ |
|
846 | + public function get_user_first_name( $context = 'view' ) { |
|
847 | + return $this->get_first_name( $context ); |
|
848 | 848 | } |
849 | 849 | |
850 | - /** |
|
851 | - * Alias of self::get_first_name(). |
|
852 | - * |
|
853 | - * @since 1.0.19 |
|
854 | - * @param string $context View or edit context. |
|
855 | - * @return string |
|
856 | - */ |
|
857 | - public function get_customer_first_name( $context = 'view' ) { |
|
858 | - return $this->get_first_name( $context ); |
|
850 | + /** |
|
851 | + * Alias of self::get_first_name(). |
|
852 | + * |
|
853 | + * @since 1.0.19 |
|
854 | + * @param string $context View or edit context. |
|
855 | + * @return string |
|
856 | + */ |
|
857 | + public function get_customer_first_name( $context = 'view' ) { |
|
858 | + return $this->get_first_name( $context ); |
|
859 | 859 | } |
860 | 860 | |
861 | 861 | /** |
862 | - * Get the customer's last name. |
|
863 | - * |
|
864 | - * @since 1.0.19 |
|
865 | - * @param string $context View or edit context. |
|
866 | - * @return string |
|
867 | - */ |
|
868 | - public function get_last_name( $context = 'view' ) { |
|
869 | - return $this->get_prop( 'last_name', $context ); |
|
862 | + * Get the customer's last name. |
|
863 | + * |
|
864 | + * @since 1.0.19 |
|
865 | + * @param string $context View or edit context. |
|
866 | + * @return string |
|
867 | + */ |
|
868 | + public function get_last_name( $context = 'view' ) { |
|
869 | + return $this->get_prop( 'last_name', $context ); |
|
870 | 870 | } |
871 | 871 | |
872 | 872 | /** |
873 | - * Alias of self::get_last_name(). |
|
874 | - * |
|
875 | - * @since 1.0.19 |
|
876 | - * @param string $context View or edit context. |
|
877 | - * @return string |
|
878 | - */ |
|
879 | - public function get_user_last_name( $context = 'view' ) { |
|
880 | - return $this->get_last_name( $context ); |
|
873 | + * Alias of self::get_last_name(). |
|
874 | + * |
|
875 | + * @since 1.0.19 |
|
876 | + * @param string $context View or edit context. |
|
877 | + * @return string |
|
878 | + */ |
|
879 | + public function get_user_last_name( $context = 'view' ) { |
|
880 | + return $this->get_last_name( $context ); |
|
881 | 881 | } |
882 | 882 | |
883 | 883 | /** |
884 | - * Alias of self::get_last_name(). |
|
885 | - * |
|
886 | - * @since 1.0.19 |
|
887 | - * @param string $context View or edit context. |
|
888 | - * @return string |
|
889 | - */ |
|
890 | - public function get_customer_last_name( $context = 'view' ) { |
|
891 | - return $this->get_last_name( $context ); |
|
884 | + * Alias of self::get_last_name(). |
|
885 | + * |
|
886 | + * @since 1.0.19 |
|
887 | + * @param string $context View or edit context. |
|
888 | + * @return string |
|
889 | + */ |
|
890 | + public function get_customer_last_name( $context = 'view' ) { |
|
891 | + return $this->get_last_name( $context ); |
|
892 | 892 | } |
893 | 893 | |
894 | 894 | /** |
895 | - * Get the customer's full name. |
|
896 | - * |
|
897 | - * @since 1.0.19 |
|
898 | - * @param string $context View or edit context. |
|
899 | - * @return string |
|
900 | - */ |
|
901 | - public function get_full_name( $context = 'view' ) { |
|
902 | - return trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) ); |
|
895 | + * Get the customer's full name. |
|
896 | + * |
|
897 | + * @since 1.0.19 |
|
898 | + * @param string $context View or edit context. |
|
899 | + * @return string |
|
900 | + */ |
|
901 | + public function get_full_name( $context = 'view' ) { |
|
902 | + return trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) ); |
|
903 | 903 | } |
904 | 904 | |
905 | 905 | /** |
906 | - * Alias of self::get_full_name(). |
|
907 | - * |
|
908 | - * @since 1.0.19 |
|
909 | - * @param string $context View or edit context. |
|
910 | - * @return string |
|
911 | - */ |
|
912 | - public function get_user_full_name( $context = 'view' ) { |
|
913 | - return $this->get_full_name( $context ); |
|
906 | + * Alias of self::get_full_name(). |
|
907 | + * |
|
908 | + * @since 1.0.19 |
|
909 | + * @param string $context View or edit context. |
|
910 | + * @return string |
|
911 | + */ |
|
912 | + public function get_user_full_name( $context = 'view' ) { |
|
913 | + return $this->get_full_name( $context ); |
|
914 | 914 | } |
915 | 915 | |
916 | 916 | /** |
917 | - * Alias of self::get_full_name(). |
|
918 | - * |
|
919 | - * @since 1.0.19 |
|
920 | - * @param string $context View or edit context. |
|
921 | - * @return string |
|
922 | - */ |
|
923 | - public function get_customer_full_name( $context = 'view' ) { |
|
924 | - return $this->get_full_name( $context ); |
|
917 | + * Alias of self::get_full_name(). |
|
918 | + * |
|
919 | + * @since 1.0.19 |
|
920 | + * @param string $context View or edit context. |
|
921 | + * @return string |
|
922 | + */ |
|
923 | + public function get_customer_full_name( $context = 'view' ) { |
|
924 | + return $this->get_full_name( $context ); |
|
925 | 925 | } |
926 | 926 | |
927 | 927 | /** |
928 | - * Get the customer's phone number. |
|
929 | - * |
|
930 | - * @since 1.0.19 |
|
931 | - * @param string $context View or edit context. |
|
932 | - * @return string |
|
933 | - */ |
|
934 | - public function get_phone( $context = 'view' ) { |
|
935 | - return $this->get_prop( 'phone', $context ); |
|
928 | + * Get the customer's phone number. |
|
929 | + * |
|
930 | + * @since 1.0.19 |
|
931 | + * @param string $context View or edit context. |
|
932 | + * @return string |
|
933 | + */ |
|
934 | + public function get_phone( $context = 'view' ) { |
|
935 | + return $this->get_prop( 'phone', $context ); |
|
936 | 936 | } |
937 | 937 | |
938 | 938 | /** |
939 | - * Alias of self::get_phone(). |
|
940 | - * |
|
941 | - * @since 1.0.19 |
|
942 | - * @param string $context View or edit context. |
|
943 | - * @return string |
|
944 | - */ |
|
945 | - public function get_phone_number( $context = 'view' ) { |
|
946 | - return $this->get_phone( $context ); |
|
939 | + * Alias of self::get_phone(). |
|
940 | + * |
|
941 | + * @since 1.0.19 |
|
942 | + * @param string $context View or edit context. |
|
943 | + * @return string |
|
944 | + */ |
|
945 | + public function get_phone_number( $context = 'view' ) { |
|
946 | + return $this->get_phone( $context ); |
|
947 | 947 | } |
948 | 948 | |
949 | 949 | /** |
950 | - * Alias of self::get_phone(). |
|
951 | - * |
|
952 | - * @since 1.0.19 |
|
953 | - * @param string $context View or edit context. |
|
954 | - * @return string |
|
955 | - */ |
|
956 | - public function get_user_phone( $context = 'view' ) { |
|
957 | - return $this->get_phone( $context ); |
|
958 | - } |
|
959 | - |
|
950 | + * Alias of self::get_phone(). |
|
951 | + * |
|
952 | + * @since 1.0.19 |
|
953 | + * @param string $context View or edit context. |
|
954 | + * @return string |
|
955 | + */ |
|
956 | + public function get_user_phone( $context = 'view' ) { |
|
957 | + return $this->get_phone( $context ); |
|
958 | + } |
|
959 | + |
|
960 | + /** |
|
961 | + * Alias of self::get_phone(). |
|
962 | + * |
|
963 | + * @since 1.0.19 |
|
964 | + * @param string $context View or edit context. |
|
965 | + * @return string |
|
966 | + */ |
|
967 | + public function get_customer_phone( $context = 'view' ) { |
|
968 | + return $this->get_phone( $context ); |
|
969 | + } |
|
970 | + |
|
971 | + /** |
|
972 | + * Get the customer's email address. |
|
973 | + * |
|
974 | + * @since 1.0.19 |
|
975 | + * @param string $context View or edit context. |
|
976 | + * @return string |
|
977 | + */ |
|
978 | + public function get_email( $context = 'view' ) { |
|
979 | + return $this->get_prop( 'email', $context ); |
|
980 | + } |
|
981 | + |
|
982 | + /** |
|
983 | + * Alias of self::get_email(). |
|
984 | + * |
|
985 | + * @since 1.0.19 |
|
986 | + * @param string $context View or edit context. |
|
987 | + * @return string |
|
988 | + */ |
|
989 | + public function get_email_address( $context = 'view' ) { |
|
990 | + return $this->get_email( $context ); |
|
991 | + } |
|
992 | + |
|
993 | + /** |
|
994 | + * Alias of self::get_email(). |
|
995 | + * |
|
996 | + * @since 1.0.19 |
|
997 | + * @param string $context View or edit context. |
|
998 | + * @return string |
|
999 | + */ |
|
1000 | + public function get_user_email( $context = 'view' ) { |
|
1001 | + return $this->get_email( $context ); |
|
1002 | + } |
|
1003 | + |
|
960 | 1004 | /** |
961 | - * Alias of self::get_phone(). |
|
962 | - * |
|
963 | - * @since 1.0.19 |
|
964 | - * @param string $context View or edit context. |
|
965 | - * @return string |
|
966 | - */ |
|
967 | - public function get_customer_phone( $context = 'view' ) { |
|
968 | - return $this->get_phone( $context ); |
|
1005 | + * Alias of self::get_email(). |
|
1006 | + * |
|
1007 | + * @since 1.0.19 |
|
1008 | + * @param string $context View or edit context. |
|
1009 | + * @return string |
|
1010 | + */ |
|
1011 | + public function get_customer_email( $context = 'view' ) { |
|
1012 | + return $this->get_email( $context ); |
|
969 | 1013 | } |
970 | 1014 | |
971 | 1015 | /** |
972 | - * Get the customer's email address. |
|
973 | - * |
|
974 | - * @since 1.0.19 |
|
975 | - * @param string $context View or edit context. |
|
976 | - * @return string |
|
977 | - */ |
|
978 | - public function get_email( $context = 'view' ) { |
|
979 | - return $this->get_prop( 'email', $context ); |
|
1016 | + * Get the customer's country. |
|
1017 | + * |
|
1018 | + * @since 1.0.19 |
|
1019 | + * @param string $context View or edit context. |
|
1020 | + * @return string |
|
1021 | + */ |
|
1022 | + public function get_country( $context = 'view' ) { |
|
1023 | + $country = $this->get_prop( 'country', $context ); |
|
1024 | + return empty( $country ) ? wpinv_get_default_country() : $country; |
|
980 | 1025 | } |
981 | 1026 | |
982 | 1027 | /** |
983 | - * Alias of self::get_email(). |
|
984 | - * |
|
985 | - * @since 1.0.19 |
|
986 | - * @param string $context View or edit context. |
|
987 | - * @return string |
|
988 | - */ |
|
989 | - public function get_email_address( $context = 'view' ) { |
|
990 | - return $this->get_email( $context ); |
|
1028 | + * Alias of self::get_country(). |
|
1029 | + * |
|
1030 | + * @since 1.0.19 |
|
1031 | + * @param string $context View or edit context. |
|
1032 | + * @return string |
|
1033 | + */ |
|
1034 | + public function get_user_country( $context = 'view' ) { |
|
1035 | + return $this->get_country( $context ); |
|
991 | 1036 | } |
992 | 1037 | |
993 | 1038 | /** |
994 | - * Alias of self::get_email(). |
|
995 | - * |
|
996 | - * @since 1.0.19 |
|
997 | - * @param string $context View or edit context. |
|
998 | - * @return string |
|
999 | - */ |
|
1000 | - public function get_user_email( $context = 'view' ) { |
|
1001 | - return $this->get_email( $context ); |
|
1039 | + * Alias of self::get_country(). |
|
1040 | + * |
|
1041 | + * @since 1.0.19 |
|
1042 | + * @param string $context View or edit context. |
|
1043 | + * @return string |
|
1044 | + */ |
|
1045 | + public function get_customer_country( $context = 'view' ) { |
|
1046 | + return $this->get_country( $context ); |
|
1002 | 1047 | } |
1003 | 1048 | |
1004 | 1049 | /** |
1005 | - * Alias of self::get_email(). |
|
1006 | - * |
|
1007 | - * @since 1.0.19 |
|
1008 | - * @param string $context View or edit context. |
|
1009 | - * @return string |
|
1010 | - */ |
|
1011 | - public function get_customer_email( $context = 'view' ) { |
|
1012 | - return $this->get_email( $context ); |
|
1050 | + * Get the customer's state. |
|
1051 | + * |
|
1052 | + * @since 1.0.19 |
|
1053 | + * @param string $context View or edit context. |
|
1054 | + * @return string |
|
1055 | + */ |
|
1056 | + public function get_state( $context = 'view' ) { |
|
1057 | + $state = $this->get_prop( 'state', $context ); |
|
1058 | + return empty( $state ) ? wpinv_get_default_state() : $state; |
|
1013 | 1059 | } |
1014 | 1060 | |
1015 | 1061 | /** |
1016 | - * Get the customer's country. |
|
1017 | - * |
|
1018 | - * @since 1.0.19 |
|
1019 | - * @param string $context View or edit context. |
|
1020 | - * @return string |
|
1021 | - */ |
|
1022 | - public function get_country( $context = 'view' ) { |
|
1023 | - $country = $this->get_prop( 'country', $context ); |
|
1024 | - return empty( $country ) ? wpinv_get_default_country() : $country; |
|
1062 | + * Alias of self::get_state(). |
|
1063 | + * |
|
1064 | + * @since 1.0.19 |
|
1065 | + * @param string $context View or edit context. |
|
1066 | + * @return string |
|
1067 | + */ |
|
1068 | + public function get_user_state( $context = 'view' ) { |
|
1069 | + return $this->get_state( $context ); |
|
1025 | 1070 | } |
1026 | 1071 | |
1027 | 1072 | /** |
1028 | - * Alias of self::get_country(). |
|
1029 | - * |
|
1030 | - * @since 1.0.19 |
|
1031 | - * @param string $context View or edit context. |
|
1032 | - * @return string |
|
1033 | - */ |
|
1034 | - public function get_user_country( $context = 'view' ) { |
|
1035 | - return $this->get_country( $context ); |
|
1073 | + * Alias of self::get_state(). |
|
1074 | + * |
|
1075 | + * @since 1.0.19 |
|
1076 | + * @param string $context View or edit context. |
|
1077 | + * @return string |
|
1078 | + */ |
|
1079 | + public function get_customer_state( $context = 'view' ) { |
|
1080 | + return $this->get_state( $context ); |
|
1036 | 1081 | } |
1037 | 1082 | |
1038 | 1083 | /** |
1039 | - * Alias of self::get_country(). |
|
1040 | - * |
|
1041 | - * @since 1.0.19 |
|
1042 | - * @param string $context View or edit context. |
|
1043 | - * @return string |
|
1044 | - */ |
|
1045 | - public function get_customer_country( $context = 'view' ) { |
|
1046 | - return $this->get_country( $context ); |
|
1084 | + * Get the customer's city. |
|
1085 | + * |
|
1086 | + * @since 1.0.19 |
|
1087 | + * @param string $context View or edit context. |
|
1088 | + * @return string |
|
1089 | + */ |
|
1090 | + public function get_city( $context = 'view' ) { |
|
1091 | + return $this->get_prop( 'city', $context ); |
|
1047 | 1092 | } |
1048 | 1093 | |
1049 | 1094 | /** |
1050 | - * Get the customer's state. |
|
1051 | - * |
|
1052 | - * @since 1.0.19 |
|
1053 | - * @param string $context View or edit context. |
|
1054 | - * @return string |
|
1055 | - */ |
|
1056 | - public function get_state( $context = 'view' ) { |
|
1057 | - $state = $this->get_prop( 'state', $context ); |
|
1058 | - return empty( $state ) ? wpinv_get_default_state() : $state; |
|
1095 | + * Alias of self::get_city(). |
|
1096 | + * |
|
1097 | + * @since 1.0.19 |
|
1098 | + * @param string $context View or edit context. |
|
1099 | + * @return string |
|
1100 | + */ |
|
1101 | + public function get_user_city( $context = 'view' ) { |
|
1102 | + return $this->get_city( $context ); |
|
1103 | + } |
|
1104 | + |
|
1105 | + /** |
|
1106 | + * Alias of self::get_city(). |
|
1107 | + * |
|
1108 | + * @since 1.0.19 |
|
1109 | + * @param string $context View or edit context. |
|
1110 | + * @return string |
|
1111 | + */ |
|
1112 | + public function get_customer_city( $context = 'view' ) { |
|
1113 | + return $this->get_city( $context ); |
|
1114 | + } |
|
1115 | + |
|
1116 | + /** |
|
1117 | + * Get the customer's zip. |
|
1118 | + * |
|
1119 | + * @since 1.0.19 |
|
1120 | + * @param string $context View or edit context. |
|
1121 | + * @return string |
|
1122 | + */ |
|
1123 | + public function get_zip( $context = 'view' ) { |
|
1124 | + return $this->get_prop( 'zip', $context ); |
|
1125 | + } |
|
1126 | + |
|
1127 | + /** |
|
1128 | + * Alias of self::get_zip(). |
|
1129 | + * |
|
1130 | + * @since 1.0.19 |
|
1131 | + * @param string $context View or edit context. |
|
1132 | + * @return string |
|
1133 | + */ |
|
1134 | + public function get_user_zip( $context = 'view' ) { |
|
1135 | + return $this->get_zip( $context ); |
|
1136 | + } |
|
1137 | + |
|
1138 | + /** |
|
1139 | + * Alias of self::get_zip(). |
|
1140 | + * |
|
1141 | + * @since 1.0.19 |
|
1142 | + * @param string $context View or edit context. |
|
1143 | + * @return string |
|
1144 | + */ |
|
1145 | + public function get_customer_zip( $context = 'view' ) { |
|
1146 | + return $this->get_zip( $context ); |
|
1147 | + } |
|
1148 | + |
|
1149 | + /** |
|
1150 | + * Get the customer's company. |
|
1151 | + * |
|
1152 | + * @since 1.0.19 |
|
1153 | + * @param string $context View or edit context. |
|
1154 | + * @return string |
|
1155 | + */ |
|
1156 | + public function get_company( $context = 'view' ) { |
|
1157 | + return $this->get_prop( 'company', $context ); |
|
1158 | + } |
|
1159 | + |
|
1160 | + /** |
|
1161 | + * Alias of self::get_company(). |
|
1162 | + * |
|
1163 | + * @since 1.0.19 |
|
1164 | + * @param string $context View or edit context. |
|
1165 | + * @return string |
|
1166 | + */ |
|
1167 | + public function get_user_company( $context = 'view' ) { |
|
1168 | + return $this->get_company( $context ); |
|
1169 | + } |
|
1170 | + |
|
1171 | + /** |
|
1172 | + * Alias of self::get_company(). |
|
1173 | + * |
|
1174 | + * @since 1.0.19 |
|
1175 | + * @param string $context View or edit context. |
|
1176 | + * @return string |
|
1177 | + */ |
|
1178 | + public function get_customer_company( $context = 'view' ) { |
|
1179 | + return $this->get_company( $context ); |
|
1180 | + } |
|
1181 | + |
|
1182 | + /** |
|
1183 | + * Get the customer's company id. |
|
1184 | + * |
|
1185 | + * @since 1.0.19 |
|
1186 | + * @param string $context View or edit context. |
|
1187 | + * @return string |
|
1188 | + */ |
|
1189 | + public function get_company_id( $context = 'view' ) { |
|
1190 | + return $this->get_prop( 'company_id', $context ); |
|
1191 | + } |
|
1192 | + |
|
1193 | + /** |
|
1194 | + * Get the customer's vat number. |
|
1195 | + * |
|
1196 | + * @since 1.0.19 |
|
1197 | + * @param string $context View or edit context. |
|
1198 | + * @return string |
|
1199 | + */ |
|
1200 | + public function get_vat_number( $context = 'view' ) { |
|
1201 | + return $this->get_prop( 'vat_number', $context ); |
|
1059 | 1202 | } |
1060 | 1203 | |
1061 | 1204 | /** |
1062 | - * Alias of self::get_state(). |
|
1063 | - * |
|
1064 | - * @since 1.0.19 |
|
1065 | - * @param string $context View or edit context. |
|
1066 | - * @return string |
|
1067 | - */ |
|
1068 | - public function get_user_state( $context = 'view' ) { |
|
1069 | - return $this->get_state( $context ); |
|
1205 | + * Alias of self::get_vat_number(). |
|
1206 | + * |
|
1207 | + * @since 1.0.19 |
|
1208 | + * @param string $context View or edit context. |
|
1209 | + * @return string |
|
1210 | + */ |
|
1211 | + public function get_user_vat_number( $context = 'view' ) { |
|
1212 | + return $this->get_vat_number( $context ); |
|
1070 | 1213 | } |
1071 | 1214 | |
1072 | 1215 | /** |
1073 | - * Alias of self::get_state(). |
|
1074 | - * |
|
1075 | - * @since 1.0.19 |
|
1076 | - * @param string $context View or edit context. |
|
1077 | - * @return string |
|
1078 | - */ |
|
1079 | - public function get_customer_state( $context = 'view' ) { |
|
1080 | - return $this->get_state( $context ); |
|
1216 | + * Alias of self::get_vat_number(). |
|
1217 | + * |
|
1218 | + * @since 1.0.19 |
|
1219 | + * @param string $context View or edit context. |
|
1220 | + * @return string |
|
1221 | + */ |
|
1222 | + public function get_customer_vat_number( $context = 'view' ) { |
|
1223 | + return $this->get_vat_number( $context ); |
|
1081 | 1224 | } |
1082 | 1225 | |
1083 | 1226 | /** |
1084 | - * Get the customer's city. |
|
1085 | - * |
|
1086 | - * @since 1.0.19 |
|
1087 | - * @param string $context View or edit context. |
|
1088 | - * @return string |
|
1089 | - */ |
|
1090 | - public function get_city( $context = 'view' ) { |
|
1091 | - return $this->get_prop( 'city', $context ); |
|
1227 | + * Get the customer's vat rate. |
|
1228 | + * |
|
1229 | + * @since 1.0.19 |
|
1230 | + * @param string $context View or edit context. |
|
1231 | + * @return string |
|
1232 | + */ |
|
1233 | + public function get_vat_rate( $context = 'view' ) { |
|
1234 | + return $this->get_prop( 'vat_rate', $context ); |
|
1092 | 1235 | } |
1093 | 1236 | |
1094 | 1237 | /** |
1095 | - * Alias of self::get_city(). |
|
1096 | - * |
|
1097 | - * @since 1.0.19 |
|
1098 | - * @param string $context View or edit context. |
|
1099 | - * @return string |
|
1100 | - */ |
|
1101 | - public function get_user_city( $context = 'view' ) { |
|
1102 | - return $this->get_city( $context ); |
|
1238 | + * Alias of self::get_vat_rate(). |
|
1239 | + * |
|
1240 | + * @since 1.0.19 |
|
1241 | + * @param string $context View or edit context. |
|
1242 | + * @return string |
|
1243 | + */ |
|
1244 | + public function get_user_vat_rate( $context = 'view' ) { |
|
1245 | + return $this->get_vat_rate( $context ); |
|
1103 | 1246 | } |
1104 | 1247 | |
1105 | 1248 | /** |
1106 | - * Alias of self::get_city(). |
|
1107 | - * |
|
1108 | - * @since 1.0.19 |
|
1109 | - * @param string $context View or edit context. |
|
1110 | - * @return string |
|
1111 | - */ |
|
1112 | - public function get_customer_city( $context = 'view' ) { |
|
1113 | - return $this->get_city( $context ); |
|
1249 | + * Alias of self::get_vat_rate(). |
|
1250 | + * |
|
1251 | + * @since 1.0.19 |
|
1252 | + * @param string $context View or edit context. |
|
1253 | + * @return string |
|
1254 | + */ |
|
1255 | + public function get_customer_vat_rate( $context = 'view' ) { |
|
1256 | + return $this->get_vat_rate( $context ); |
|
1114 | 1257 | } |
1115 | 1258 | |
1116 | 1259 | /** |
1117 | - * Get the customer's zip. |
|
1118 | - * |
|
1119 | - * @since 1.0.19 |
|
1120 | - * @param string $context View or edit context. |
|
1121 | - * @return string |
|
1122 | - */ |
|
1123 | - public function get_zip( $context = 'view' ) { |
|
1124 | - return $this->get_prop( 'zip', $context ); |
|
1260 | + * Get the customer's address. |
|
1261 | + * |
|
1262 | + * @since 1.0.19 |
|
1263 | + * @param string $context View or edit context. |
|
1264 | + * @return string |
|
1265 | + */ |
|
1266 | + public function get_address( $context = 'view' ) { |
|
1267 | + return $this->get_prop( 'address', $context ); |
|
1125 | 1268 | } |
1126 | 1269 | |
1127 | 1270 | /** |
1128 | - * Alias of self::get_zip(). |
|
1129 | - * |
|
1130 | - * @since 1.0.19 |
|
1131 | - * @param string $context View or edit context. |
|
1132 | - * @return string |
|
1133 | - */ |
|
1134 | - public function get_user_zip( $context = 'view' ) { |
|
1135 | - return $this->get_zip( $context ); |
|
1271 | + * Alias of self::get_address(). |
|
1272 | + * |
|
1273 | + * @since 1.0.19 |
|
1274 | + * @param string $context View or edit context. |
|
1275 | + * @return string |
|
1276 | + */ |
|
1277 | + public function get_user_address( $context = 'view' ) { |
|
1278 | + return $this->get_address( $context ); |
|
1136 | 1279 | } |
1137 | 1280 | |
1138 | 1281 | /** |
1139 | - * Alias of self::get_zip(). |
|
1140 | - * |
|
1141 | - * @since 1.0.19 |
|
1142 | - * @param string $context View or edit context. |
|
1143 | - * @return string |
|
1144 | - */ |
|
1145 | - public function get_customer_zip( $context = 'view' ) { |
|
1146 | - return $this->get_zip( $context ); |
|
1282 | + * Alias of self::get_address(). |
|
1283 | + * |
|
1284 | + * @since 1.0.19 |
|
1285 | + * @param string $context View or edit context. |
|
1286 | + * @return string |
|
1287 | + */ |
|
1288 | + public function get_customer_address( $context = 'view' ) { |
|
1289 | + return $this->get_address( $context ); |
|
1147 | 1290 | } |
1148 | 1291 | |
1149 | 1292 | /** |
1150 | - * Get the customer's company. |
|
1151 | - * |
|
1152 | - * @since 1.0.19 |
|
1153 | - * @param string $context View or edit context. |
|
1154 | - * @return string |
|
1155 | - */ |
|
1156 | - public function get_company( $context = 'view' ) { |
|
1157 | - return $this->get_prop( 'company', $context ); |
|
1293 | + * Get whether the customer has viewed the invoice or not. |
|
1294 | + * |
|
1295 | + * @since 1.0.19 |
|
1296 | + * @param string $context View or edit context. |
|
1297 | + * @return bool |
|
1298 | + */ |
|
1299 | + public function get_is_viewed( $context = 'view' ) { |
|
1300 | + return (bool) $this->get_prop( 'is_viewed', $context ); |
|
1158 | 1301 | } |
1159 | 1302 | |
1160 | 1303 | /** |
1161 | - * Alias of self::get_company(). |
|
1162 | - * |
|
1163 | - * @since 1.0.19 |
|
1164 | - * @param string $context View or edit context. |
|
1165 | - * @return string |
|
1166 | - */ |
|
1167 | - public function get_user_company( $context = 'view' ) { |
|
1168 | - return $this->get_company( $context ); |
|
1304 | + * Get other recipients for invoice communications. |
|
1305 | + * |
|
1306 | + * @since 1.0.19 |
|
1307 | + * @param string $context View or edit context. |
|
1308 | + * @return bool |
|
1309 | + */ |
|
1310 | + public function get_email_cc( $context = 'view' ) { |
|
1311 | + return $this->get_prop( 'email_cc', $context ); |
|
1169 | 1312 | } |
1170 | 1313 | |
1171 | 1314 | /** |
1172 | - * Alias of self::get_company(). |
|
1173 | - * |
|
1174 | - * @since 1.0.19 |
|
1175 | - * @param string $context View or edit context. |
|
1176 | - * @return string |
|
1177 | - */ |
|
1178 | - public function get_customer_company( $context = 'view' ) { |
|
1179 | - return $this->get_company( $context ); |
|
1315 | + * Get invoice template. |
|
1316 | + * |
|
1317 | + * @since 1.0.19 |
|
1318 | + * @param string $context View or edit context. |
|
1319 | + * @return bool |
|
1320 | + */ |
|
1321 | + public function get_template( $context = 'view' ) { |
|
1322 | + return $this->get_prop( 'template', $context ); |
|
1180 | 1323 | } |
1181 | 1324 | |
1182 | - /** |
|
1183 | - * Get the customer's company id. |
|
1184 | - * |
|
1185 | - * @since 1.0.19 |
|
1186 | - * @param string $context View or edit context. |
|
1187 | - * @return string |
|
1188 | - */ |
|
1189 | - public function get_company_id( $context = 'view' ) { |
|
1190 | - return $this->get_prop( 'company_id', $context ); |
|
1325 | + /** |
|
1326 | + * Get invoice source. |
|
1327 | + * |
|
1328 | + * @since 1.0.19 |
|
1329 | + * @param string $context View or edit context. |
|
1330 | + * @return bool |
|
1331 | + */ |
|
1332 | + public function get_created_via( $context = 'view' ) { |
|
1333 | + return $this->get_prop( 'created_via', $context ); |
|
1191 | 1334 | } |
1192 | 1335 | |
1193 | 1336 | /** |
1194 | - * Get the customer's vat number. |
|
1195 | - * |
|
1196 | - * @since 1.0.19 |
|
1197 | - * @param string $context View or edit context. |
|
1198 | - * @return string |
|
1199 | - */ |
|
1200 | - public function get_vat_number( $context = 'view' ) { |
|
1201 | - return $this->get_prop( 'vat_number', $context ); |
|
1337 | + * Get whether the customer has confirmed their address. |
|
1338 | + * |
|
1339 | + * @since 1.0.19 |
|
1340 | + * @param string $context View or edit context. |
|
1341 | + * @return bool |
|
1342 | + */ |
|
1343 | + public function get_address_confirmed( $context = 'view' ) { |
|
1344 | + return (bool) $this->get_prop( 'address_confirmed', $context ); |
|
1202 | 1345 | } |
1203 | 1346 | |
1204 | 1347 | /** |
1205 | - * Alias of self::get_vat_number(). |
|
1206 | - * |
|
1207 | - * @since 1.0.19 |
|
1208 | - * @param string $context View or edit context. |
|
1209 | - * @return string |
|
1210 | - */ |
|
1211 | - public function get_user_vat_number( $context = 'view' ) { |
|
1212 | - return $this->get_vat_number( $context ); |
|
1348 | + * Alias of self::get_address_confirmed(). |
|
1349 | + * |
|
1350 | + * @since 1.0.19 |
|
1351 | + * @param string $context View or edit context. |
|
1352 | + * @return bool |
|
1353 | + */ |
|
1354 | + public function get_user_address_confirmed( $context = 'view' ) { |
|
1355 | + return $this->get_address_confirmed( $context ); |
|
1213 | 1356 | } |
1214 | 1357 | |
1215 | 1358 | /** |
1216 | - * Alias of self::get_vat_number(). |
|
1217 | - * |
|
1218 | - * @since 1.0.19 |
|
1219 | - * @param string $context View or edit context. |
|
1220 | - * @return string |
|
1221 | - */ |
|
1222 | - public function get_customer_vat_number( $context = 'view' ) { |
|
1223 | - return $this->get_vat_number( $context ); |
|
1359 | + * Alias of self::get_address(). |
|
1360 | + * |
|
1361 | + * @since 1.0.19 |
|
1362 | + * @param string $context View or edit context. |
|
1363 | + * @return bool |
|
1364 | + */ |
|
1365 | + public function get_customer_address_confirmed( $context = 'view' ) { |
|
1366 | + return $this->get_address_confirmed( $context ); |
|
1224 | 1367 | } |
1225 | 1368 | |
1226 | - /** |
|
1227 | - * Get the customer's vat rate. |
|
1228 | - * |
|
1229 | - * @since 1.0.19 |
|
1230 | - * @param string $context View or edit context. |
|
1231 | - * @return string |
|
1232 | - */ |
|
1233 | - public function get_vat_rate( $context = 'view' ) { |
|
1234 | - return $this->get_prop( 'vat_rate', $context ); |
|
1235 | - } |
|
1236 | - |
|
1237 | - /** |
|
1238 | - * Alias of self::get_vat_rate(). |
|
1239 | - * |
|
1240 | - * @since 1.0.19 |
|
1241 | - * @param string $context View or edit context. |
|
1242 | - * @return string |
|
1243 | - */ |
|
1244 | - public function get_user_vat_rate( $context = 'view' ) { |
|
1245 | - return $this->get_vat_rate( $context ); |
|
1246 | - } |
|
1247 | - |
|
1248 | - /** |
|
1249 | - * Alias of self::get_vat_rate(). |
|
1250 | - * |
|
1251 | - * @since 1.0.19 |
|
1252 | - * @param string $context View or edit context. |
|
1253 | - * @return string |
|
1254 | - */ |
|
1255 | - public function get_customer_vat_rate( $context = 'view' ) { |
|
1256 | - return $this->get_vat_rate( $context ); |
|
1257 | - } |
|
1258 | - |
|
1259 | - /** |
|
1260 | - * Get the customer's address. |
|
1261 | - * |
|
1262 | - * @since 1.0.19 |
|
1263 | - * @param string $context View or edit context. |
|
1264 | - * @return string |
|
1265 | - */ |
|
1266 | - public function get_address( $context = 'view' ) { |
|
1267 | - return $this->get_prop( 'address', $context ); |
|
1268 | - } |
|
1269 | - |
|
1270 | - /** |
|
1271 | - * Alias of self::get_address(). |
|
1272 | - * |
|
1273 | - * @since 1.0.19 |
|
1274 | - * @param string $context View or edit context. |
|
1275 | - * @return string |
|
1276 | - */ |
|
1277 | - public function get_user_address( $context = 'view' ) { |
|
1278 | - return $this->get_address( $context ); |
|
1279 | - } |
|
1280 | - |
|
1281 | - /** |
|
1282 | - * Alias of self::get_address(). |
|
1283 | - * |
|
1284 | - * @since 1.0.19 |
|
1285 | - * @param string $context View or edit context. |
|
1286 | - * @return string |
|
1287 | - */ |
|
1288 | - public function get_customer_address( $context = 'view' ) { |
|
1289 | - return $this->get_address( $context ); |
|
1290 | - } |
|
1291 | - |
|
1292 | - /** |
|
1293 | - * Get whether the customer has viewed the invoice or not. |
|
1294 | - * |
|
1295 | - * @since 1.0.19 |
|
1296 | - * @param string $context View or edit context. |
|
1297 | - * @return bool |
|
1298 | - */ |
|
1299 | - public function get_is_viewed( $context = 'view' ) { |
|
1300 | - return (bool) $this->get_prop( 'is_viewed', $context ); |
|
1301 | - } |
|
1302 | - |
|
1303 | - /** |
|
1304 | - * Get other recipients for invoice communications. |
|
1305 | - * |
|
1306 | - * @since 1.0.19 |
|
1307 | - * @param string $context View or edit context. |
|
1308 | - * @return bool |
|
1309 | - */ |
|
1310 | - public function get_email_cc( $context = 'view' ) { |
|
1311 | - return $this->get_prop( 'email_cc', $context ); |
|
1312 | - } |
|
1313 | - |
|
1314 | - /** |
|
1315 | - * Get invoice template. |
|
1316 | - * |
|
1317 | - * @since 1.0.19 |
|
1318 | - * @param string $context View or edit context. |
|
1319 | - * @return bool |
|
1320 | - */ |
|
1321 | - public function get_template( $context = 'view' ) { |
|
1322 | - return $this->get_prop( 'template', $context ); |
|
1323 | - } |
|
1324 | - |
|
1325 | - /** |
|
1326 | - * Get invoice source. |
|
1327 | - * |
|
1328 | - * @since 1.0.19 |
|
1329 | - * @param string $context View or edit context. |
|
1330 | - * @return bool |
|
1331 | - */ |
|
1332 | - public function get_created_via( $context = 'view' ) { |
|
1333 | - return $this->get_prop( 'created_via', $context ); |
|
1334 | - } |
|
1335 | - |
|
1336 | - /** |
|
1337 | - * Get whether the customer has confirmed their address. |
|
1338 | - * |
|
1339 | - * @since 1.0.19 |
|
1340 | - * @param string $context View or edit context. |
|
1341 | - * @return bool |
|
1342 | - */ |
|
1343 | - public function get_address_confirmed( $context = 'view' ) { |
|
1344 | - return (bool) $this->get_prop( 'address_confirmed', $context ); |
|
1345 | - } |
|
1346 | - |
|
1347 | - /** |
|
1348 | - * Alias of self::get_address_confirmed(). |
|
1349 | - * |
|
1350 | - * @since 1.0.19 |
|
1351 | - * @param string $context View or edit context. |
|
1352 | - * @return bool |
|
1353 | - */ |
|
1354 | - public function get_user_address_confirmed( $context = 'view' ) { |
|
1355 | - return $this->get_address_confirmed( $context ); |
|
1356 | - } |
|
1357 | - |
|
1358 | - /** |
|
1359 | - * Alias of self::get_address(). |
|
1360 | - * |
|
1361 | - * @since 1.0.19 |
|
1362 | - * @param string $context View or edit context. |
|
1363 | - * @return bool |
|
1364 | - */ |
|
1365 | - public function get_customer_address_confirmed( $context = 'view' ) { |
|
1366 | - return $this->get_address_confirmed( $context ); |
|
1367 | - } |
|
1368 | - |
|
1369 | - /** |
|
1370 | - * Get the invoice subtotal. |
|
1371 | - * |
|
1372 | - * @since 1.0.19 |
|
1373 | - * @param string $context View or edit context. |
|
1374 | - * @return float |
|
1375 | - */ |
|
1376 | - public function get_subtotal( $context = 'view' ) { |
|
1369 | + /** |
|
1370 | + * Get the invoice subtotal. |
|
1371 | + * |
|
1372 | + * @since 1.0.19 |
|
1373 | + * @param string $context View or edit context. |
|
1374 | + * @return float |
|
1375 | + */ |
|
1376 | + public function get_subtotal( $context = 'view' ) { |
|
1377 | 1377 | $subtotal = (float) $this->get_prop( 'subtotal', $context ); |
1378 | 1378 | |
1379 | 1379 | // Backwards compatibility. |
@@ -1385,192 +1385,192 @@ discard block |
||
1385 | 1385 | } |
1386 | 1386 | |
1387 | 1387 | /** |
1388 | - * Get the invoice discount total. |
|
1389 | - * |
|
1390 | - * @since 1.0.19 |
|
1391 | - * @param string $context View or edit context. |
|
1392 | - * @return float |
|
1393 | - */ |
|
1394 | - public function get_total_discount( $context = 'view' ) { |
|
1395 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_discount', $context ) ) ); |
|
1388 | + * Get the invoice discount total. |
|
1389 | + * |
|
1390 | + * @since 1.0.19 |
|
1391 | + * @param string $context View or edit context. |
|
1392 | + * @return float |
|
1393 | + */ |
|
1394 | + public function get_total_discount( $context = 'view' ) { |
|
1395 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_discount', $context ) ) ); |
|
1396 | 1396 | } |
1397 | 1397 | |
1398 | 1398 | /** |
1399 | - * Get the invoice tax total. |
|
1400 | - * |
|
1401 | - * @since 1.0.19 |
|
1402 | - * @param string $context View or edit context. |
|
1403 | - * @return float |
|
1404 | - */ |
|
1405 | - public function get_total_tax( $context = 'view' ) { |
|
1406 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_tax', $context ) ) ); |
|
1407 | - } |
|
1399 | + * Get the invoice tax total. |
|
1400 | + * |
|
1401 | + * @since 1.0.19 |
|
1402 | + * @param string $context View or edit context. |
|
1403 | + * @return float |
|
1404 | + */ |
|
1405 | + public function get_total_tax( $context = 'view' ) { |
|
1406 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_tax', $context ) ) ); |
|
1407 | + } |
|
1408 | 1408 | |
1409 | - /** |
|
1410 | - * @deprecated |
|
1411 | - */ |
|
1412 | - public function get_final_tax( $currency = false ) { |
|
1413 | - $tax = $this->get_total_tax(); |
|
1409 | + /** |
|
1410 | + * @deprecated |
|
1411 | + */ |
|
1412 | + public function get_final_tax( $currency = false ) { |
|
1413 | + $tax = $this->get_total_tax(); |
|
1414 | 1414 | |
1415 | 1415 | if ( $currency ) { |
1416 | - return wpinv_price( $tax, $this->get_currency() ); |
|
1416 | + return wpinv_price( $tax, $this->get_currency() ); |
|
1417 | 1417 | } |
1418 | 1418 | |
1419 | 1419 | return $tax; |
1420 | 1420 | } |
1421 | 1421 | |
1422 | 1422 | /** |
1423 | - * Get the invoice fees total. |
|
1424 | - * |
|
1425 | - * @since 1.0.19 |
|
1426 | - * @param string $context View or edit context. |
|
1427 | - * @return float |
|
1428 | - */ |
|
1429 | - public function get_total_fees( $context = 'view' ) { |
|
1430 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_fees', $context ) ) ); |
|
1423 | + * Get the invoice fees total. |
|
1424 | + * |
|
1425 | + * @since 1.0.19 |
|
1426 | + * @param string $context View or edit context. |
|
1427 | + * @return float |
|
1428 | + */ |
|
1429 | + public function get_total_fees( $context = 'view' ) { |
|
1430 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_fees', $context ) ) ); |
|
1431 | 1431 | } |
1432 | 1432 | |
1433 | 1433 | /** |
1434 | - * Alias for self::get_total_fees(). |
|
1435 | - * |
|
1436 | - * @since 1.0.19 |
|
1437 | - * @param string $context View or edit context. |
|
1438 | - * @return float |
|
1439 | - */ |
|
1440 | - public function get_fees_total( $context = 'view' ) { |
|
1441 | - return $this->get_total_fees( $context ); |
|
1434 | + * Alias for self::get_total_fees(). |
|
1435 | + * |
|
1436 | + * @since 1.0.19 |
|
1437 | + * @param string $context View or edit context. |
|
1438 | + * @return float |
|
1439 | + */ |
|
1440 | + public function get_fees_total( $context = 'view' ) { |
|
1441 | + return $this->get_total_fees( $context ); |
|
1442 | 1442 | } |
1443 | 1443 | |
1444 | 1444 | /** |
1445 | - * Get the invoice total. |
|
1446 | - * |
|
1447 | - * @since 1.0.19 |
|
1445 | + * Get the invoice total. |
|
1446 | + * |
|
1447 | + * @since 1.0.19 |
|
1448 | 1448 | * @return float |
1449 | - */ |
|
1450 | - public function get_total( $context = 'view' ) { |
|
1451 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total', $context ) ) ); |
|
1452 | - } |
|
1453 | - |
|
1454 | - /** |
|
1455 | - * Retrieves the non-recurring total of items. |
|
1456 | - * |
|
1457 | - * @since 2.3.0 |
|
1458 | - * @return float |
|
1459 | - */ |
|
1460 | - public function get_non_recurring_total() { |
|
1461 | - |
|
1462 | - $subtotal = 0; |
|
1463 | - foreach ( $this->get_items() as $item ) { |
|
1464 | - if ( ! $item->is_recurring() ) { |
|
1465 | - $subtotal += $item->get_sub_total(); |
|
1466 | - } |
|
1467 | - } |
|
1468 | - |
|
1469 | - foreach ( $this->get_fees() as $fee ) { |
|
1470 | - if ( empty( $fee['recurring_fee'] ) ) { |
|
1471 | - $subtotal += wpinv_sanitize_amount( $fee['initial_fee'] ); |
|
1472 | - } |
|
1473 | - } |
|
1474 | - |
|
1475 | - $subtotal = wpinv_round_amount( wpinv_sanitize_amount( $subtotal ) ); |
|
1449 | + */ |
|
1450 | + public function get_total( $context = 'view' ) { |
|
1451 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total', $context ) ) ); |
|
1452 | + } |
|
1453 | + |
|
1454 | + /** |
|
1455 | + * Retrieves the non-recurring total of items. |
|
1456 | + * |
|
1457 | + * @since 2.3.0 |
|
1458 | + * @return float |
|
1459 | + */ |
|
1460 | + public function get_non_recurring_total() { |
|
1461 | + |
|
1462 | + $subtotal = 0; |
|
1463 | + foreach ( $this->get_items() as $item ) { |
|
1464 | + if ( ! $item->is_recurring() ) { |
|
1465 | + $subtotal += $item->get_sub_total(); |
|
1466 | + } |
|
1467 | + } |
|
1468 | + |
|
1469 | + foreach ( $this->get_fees() as $fee ) { |
|
1470 | + if ( empty( $fee['recurring_fee'] ) ) { |
|
1471 | + $subtotal += wpinv_sanitize_amount( $fee['initial_fee'] ); |
|
1472 | + } |
|
1473 | + } |
|
1474 | + |
|
1475 | + $subtotal = wpinv_round_amount( wpinv_sanitize_amount( $subtotal ) ); |
|
1476 | 1476 | return apply_filters( 'wpinv_get_non_recurring_invoice_total', $subtotal, $this ); |
1477 | 1477 | |
1478 | 1478 | } |
1479 | 1479 | |
1480 | - /** |
|
1481 | - * Get the invoice totals. |
|
1482 | - * |
|
1483 | - * @since 1.0.19 |
|
1480 | + /** |
|
1481 | + * Get the invoice totals. |
|
1482 | + * |
|
1483 | + * @since 1.0.19 |
|
1484 | 1484 | * @return array |
1485 | - */ |
|
1486 | - public function get_totals() { |
|
1487 | - return $this->totals; |
|
1485 | + */ |
|
1486 | + public function get_totals() { |
|
1487 | + return $this->totals; |
|
1488 | 1488 | } |
1489 | 1489 | |
1490 | 1490 | /** |
1491 | - * Get the initial invoice total. |
|
1492 | - * |
|
1493 | - * @since 1.0.19 |
|
1491 | + * Get the initial invoice total. |
|
1492 | + * |
|
1493 | + * @since 1.0.19 |
|
1494 | 1494 | * @param string $context View or edit context. |
1495 | 1495 | * @return float |
1496 | - */ |
|
1496 | + */ |
|
1497 | 1497 | public function get_initial_total() { |
1498 | 1498 | |
1499 | - if ( empty( $this->totals ) ) { |
|
1500 | - $this->recalculate_total(); |
|
1501 | - } |
|
1499 | + if ( empty( $this->totals ) ) { |
|
1500 | + $this->recalculate_total(); |
|
1501 | + } |
|
1502 | 1502 | |
1503 | - $tax = $this->totals['tax']['initial']; |
|
1504 | - $fee = $this->totals['fee']['initial']; |
|
1505 | - $discount = $this->totals['discount']['initial']; |
|
1506 | - $subtotal = $this->totals['subtotal']['initial']; |
|
1507 | - $total = $tax + $fee - $discount + $subtotal; |
|
1503 | + $tax = $this->totals['tax']['initial']; |
|
1504 | + $fee = $this->totals['fee']['initial']; |
|
1505 | + $discount = $this->totals['discount']['initial']; |
|
1506 | + $subtotal = $this->totals['subtotal']['initial']; |
|
1507 | + $total = $tax + $fee - $discount + $subtotal; |
|
1508 | 1508 | |
1509 | - if ( 0 > $total ) { |
|
1510 | - $total = 0; |
|
1511 | - } |
|
1509 | + if ( 0 > $total ) { |
|
1510 | + $total = 0; |
|
1511 | + } |
|
1512 | 1512 | |
1513 | - $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1513 | + $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1514 | 1514 | return apply_filters( 'wpinv_get_initial_invoice_total', $total, $this ); |
1515 | - } |
|
1515 | + } |
|
1516 | 1516 | |
1517 | - /** |
|
1518 | - * Get the recurring invoice total. |
|
1519 | - * |
|
1520 | - * @since 1.0.19 |
|
1517 | + /** |
|
1518 | + * Get the recurring invoice total. |
|
1519 | + * |
|
1520 | + * @since 1.0.19 |
|
1521 | 1521 | * @param string $context View or edit context. |
1522 | 1522 | * @return float |
1523 | - */ |
|
1523 | + */ |
|
1524 | 1524 | public function get_recurring_total() { |
1525 | 1525 | |
1526 | - if ( empty( $this->totals ) ) { |
|
1527 | - $this->recalculate_total(); |
|
1528 | - } |
|
1526 | + if ( empty( $this->totals ) ) { |
|
1527 | + $this->recalculate_total(); |
|
1528 | + } |
|
1529 | 1529 | |
1530 | - $tax = $this->totals['tax']['recurring']; |
|
1531 | - $fee = $this->totals['fee']['recurring']; |
|
1532 | - $discount = $this->totals['discount']['recurring']; |
|
1533 | - $subtotal = $this->totals['subtotal']['recurring']; |
|
1534 | - $total = $tax + $fee - $discount + $subtotal; |
|
1530 | + $tax = $this->totals['tax']['recurring']; |
|
1531 | + $fee = $this->totals['fee']['recurring']; |
|
1532 | + $discount = $this->totals['discount']['recurring']; |
|
1533 | + $subtotal = $this->totals['subtotal']['recurring']; |
|
1534 | + $total = $tax + $fee - $discount + $subtotal; |
|
1535 | 1535 | |
1536 | - if ( 0 > $total ) { |
|
1537 | - $total = 0; |
|
1538 | - } |
|
1536 | + if ( 0 > $total ) { |
|
1537 | + $total = 0; |
|
1538 | + } |
|
1539 | 1539 | |
1540 | - $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1540 | + $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1541 | 1541 | return apply_filters( 'wpinv_get_recurring_invoice_total', $total, $this ); |
1542 | - } |
|
1542 | + } |
|
1543 | 1543 | |
1544 | - /** |
|
1545 | - * Returns recurring payment details. |
|
1546 | - * |
|
1547 | - * @since 1.0.19 |
|
1544 | + /** |
|
1545 | + * Returns recurring payment details. |
|
1546 | + * |
|
1547 | + * @since 1.0.19 |
|
1548 | 1548 | * @param string $field Optionally provide a field to return. |
1549 | - * @param string $currency Whether to include the currency. |
|
1549 | + * @param string $currency Whether to include the currency. |
|
1550 | 1550 | * @return float|string |
1551 | - */ |
|
1551 | + */ |
|
1552 | 1552 | public function get_recurring_details( $field = '', $currency = false ) { |
1553 | 1553 | |
1554 | - // Maybe recalculate totals. |
|
1555 | - if ( empty( $this->totals ) ) { |
|
1556 | - $this->recalculate_total(); |
|
1557 | - } |
|
1554 | + // Maybe recalculate totals. |
|
1555 | + if ( empty( $this->totals ) ) { |
|
1556 | + $this->recalculate_total(); |
|
1557 | + } |
|
1558 | 1558 | |
1559 | - // Prepare recurring totals. |
|
1559 | + // Prepare recurring totals. |
|
1560 | 1560 | $data = apply_filters( |
1561 | - 'wpinv_get_invoice_recurring_details', |
|
1562 | - array( |
|
1563 | - 'cart_details' => $this->get_cart_details(), |
|
1564 | - 'subtotal' => $this->totals['subtotal']['recurring'], |
|
1565 | - 'discount' => $this->totals['discount']['recurring'], |
|
1566 | - 'tax' => $this->totals['tax']['recurring'], |
|
1567 | - 'fee' => $this->totals['fee']['recurring'], |
|
1568 | - 'total' => $this->get_recurring_total(), |
|
1569 | - ), |
|
1570 | - $this, |
|
1571 | - $field, |
|
1572 | - $currency |
|
1573 | - ); |
|
1561 | + 'wpinv_get_invoice_recurring_details', |
|
1562 | + array( |
|
1563 | + 'cart_details' => $this->get_cart_details(), |
|
1564 | + 'subtotal' => $this->totals['subtotal']['recurring'], |
|
1565 | + 'discount' => $this->totals['discount']['recurring'], |
|
1566 | + 'tax' => $this->totals['tax']['recurring'], |
|
1567 | + 'fee' => $this->totals['fee']['recurring'], |
|
1568 | + 'total' => $this->get_recurring_total(), |
|
1569 | + ), |
|
1570 | + $this, |
|
1571 | + $field, |
|
1572 | + $currency |
|
1573 | + ); |
|
1574 | 1574 | |
1575 | 1575 | if ( isset( $data[$field] ) ) { |
1576 | 1576 | return ( $currency ? wpinv_price( $data[$field], $this->get_currency() ) : $data[$field] ); |
@@ -1580,166 +1580,166 @@ discard block |
||
1580 | 1580 | } |
1581 | 1581 | |
1582 | 1582 | /** |
1583 | - * Get the invoice fees. |
|
1584 | - * |
|
1585 | - * @since 1.0.19 |
|
1586 | - * @param string $context View or edit context. |
|
1587 | - * @return array |
|
1588 | - */ |
|
1589 | - public function get_fees( $context = 'view' ) { |
|
1590 | - return wpinv_parse_list( $this->get_prop( 'fees', $context ) ); |
|
1583 | + * Get the invoice fees. |
|
1584 | + * |
|
1585 | + * @since 1.0.19 |
|
1586 | + * @param string $context View or edit context. |
|
1587 | + * @return array |
|
1588 | + */ |
|
1589 | + public function get_fees( $context = 'view' ) { |
|
1590 | + return wpinv_parse_list( $this->get_prop( 'fees', $context ) ); |
|
1591 | + } |
|
1592 | + |
|
1593 | + /** |
|
1594 | + * Get the invoice discounts. |
|
1595 | + * |
|
1596 | + * @since 1.0.19 |
|
1597 | + * @param string $context View or edit context. |
|
1598 | + * @return array |
|
1599 | + */ |
|
1600 | + public function get_discounts( $context = 'view' ) { |
|
1601 | + return wpinv_parse_list( $this->get_prop( 'discounts', $context ) ); |
|
1591 | 1602 | } |
1592 | 1603 | |
1593 | 1604 | /** |
1594 | - * Get the invoice discounts. |
|
1595 | - * |
|
1596 | - * @since 1.0.19 |
|
1597 | - * @param string $context View or edit context. |
|
1598 | - * @return array |
|
1599 | - */ |
|
1600 | - public function get_discounts( $context = 'view' ) { |
|
1601 | - return wpinv_parse_list( $this->get_prop( 'discounts', $context ) ); |
|
1605 | + * Get the invoice taxes. |
|
1606 | + * |
|
1607 | + * @since 1.0.19 |
|
1608 | + * @param string $context View or edit context. |
|
1609 | + * @return array |
|
1610 | + */ |
|
1611 | + public function get_taxes( $context = 'view' ) { |
|
1612 | + return wpinv_parse_list( $this->get_prop( 'taxes', $context ) ); |
|
1602 | 1613 | } |
1603 | 1614 | |
1604 | 1615 | /** |
1605 | - * Get the invoice taxes. |
|
1606 | - * |
|
1607 | - * @since 1.0.19 |
|
1608 | - * @param string $context View or edit context. |
|
1609 | - * @return array |
|
1610 | - */ |
|
1611 | - public function get_taxes( $context = 'view' ) { |
|
1612 | - return wpinv_parse_list( $this->get_prop( 'taxes', $context ) ); |
|
1616 | + * Get the invoice items. |
|
1617 | + * |
|
1618 | + * @since 1.0.19 |
|
1619 | + * @param string $context View or edit context. |
|
1620 | + * @return GetPaid_Form_Item[] |
|
1621 | + */ |
|
1622 | + public function get_items( $context = 'view' ) { |
|
1623 | + return $this->get_prop( 'items', $context ); |
|
1613 | 1624 | } |
1614 | 1625 | |
1615 | 1626 | /** |
1616 | - * Get the invoice items. |
|
1617 | - * |
|
1618 | - * @since 1.0.19 |
|
1619 | - * @param string $context View or edit context. |
|
1620 | - * @return GetPaid_Form_Item[] |
|
1621 | - */ |
|
1622 | - public function get_items( $context = 'view' ) { |
|
1623 | - return $this->get_prop( 'items', $context ); |
|
1624 | - } |
|
1625 | - |
|
1626 | - /** |
|
1627 | - * Get the invoice item ids. |
|
1628 | - * |
|
1629 | - * @since 1.0.19 |
|
1630 | - * @return string |
|
1631 | - */ |
|
1632 | - public function get_item_ids() { |
|
1633 | - return implode( ', ', wp_list_pluck( $this->get_cart_details(), 'item_id' ) ); |
|
1627 | + * Get the invoice item ids. |
|
1628 | + * |
|
1629 | + * @since 1.0.19 |
|
1630 | + * @return string |
|
1631 | + */ |
|
1632 | + public function get_item_ids() { |
|
1633 | + return implode( ', ', wp_list_pluck( $this->get_cart_details(), 'item_id' ) ); |
|
1634 | 1634 | } |
1635 | 1635 | |
1636 | 1636 | /** |
1637 | - * Get the invoice's payment form. |
|
1638 | - * |
|
1639 | - * @since 1.0.19 |
|
1640 | - * @param string $context View or edit context. |
|
1641 | - * @return int |
|
1642 | - */ |
|
1643 | - public function get_payment_form( $context = 'view' ) { |
|
1644 | - return intval( $this->get_prop( 'payment_form', $context ) ); |
|
1637 | + * Get the invoice's payment form. |
|
1638 | + * |
|
1639 | + * @since 1.0.19 |
|
1640 | + * @param string $context View or edit context. |
|
1641 | + * @return int |
|
1642 | + */ |
|
1643 | + public function get_payment_form( $context = 'view' ) { |
|
1644 | + return intval( $this->get_prop( 'payment_form', $context ) ); |
|
1645 | 1645 | } |
1646 | 1646 | |
1647 | 1647 | /** |
1648 | - * Get the invoice's submission id. |
|
1649 | - * |
|
1650 | - * @since 1.0.19 |
|
1651 | - * @param string $context View or edit context. |
|
1652 | - * @return string |
|
1653 | - */ |
|
1654 | - public function get_submission_id( $context = 'view' ) { |
|
1655 | - return $this->get_prop( 'submission_id', $context ); |
|
1648 | + * Get the invoice's submission id. |
|
1649 | + * |
|
1650 | + * @since 1.0.19 |
|
1651 | + * @param string $context View or edit context. |
|
1652 | + * @return string |
|
1653 | + */ |
|
1654 | + public function get_submission_id( $context = 'view' ) { |
|
1655 | + return $this->get_prop( 'submission_id', $context ); |
|
1656 | 1656 | } |
1657 | 1657 | |
1658 | 1658 | /** |
1659 | - * Get the invoice's discount code. |
|
1660 | - * |
|
1661 | - * @since 1.0.19 |
|
1662 | - * @param string $context View or edit context. |
|
1663 | - * @return string |
|
1664 | - */ |
|
1665 | - public function get_discount_code( $context = 'view' ) { |
|
1666 | - return $this->get_prop( 'discount_code', $context ); |
|
1659 | + * Get the invoice's discount code. |
|
1660 | + * |
|
1661 | + * @since 1.0.19 |
|
1662 | + * @param string $context View or edit context. |
|
1663 | + * @return string |
|
1664 | + */ |
|
1665 | + public function get_discount_code( $context = 'view' ) { |
|
1666 | + return $this->get_prop( 'discount_code', $context ); |
|
1667 | 1667 | } |
1668 | 1668 | |
1669 | 1669 | /** |
1670 | - * Get the invoice's gateway. |
|
1671 | - * |
|
1672 | - * @since 1.0.19 |
|
1673 | - * @param string $context View or edit context. |
|
1674 | - * @return string |
|
1675 | - */ |
|
1676 | - public function get_gateway( $context = 'view' ) { |
|
1677 | - return $this->get_prop( 'gateway', $context ); |
|
1670 | + * Get the invoice's gateway. |
|
1671 | + * |
|
1672 | + * @since 1.0.19 |
|
1673 | + * @param string $context View or edit context. |
|
1674 | + * @return string |
|
1675 | + */ |
|
1676 | + public function get_gateway( $context = 'view' ) { |
|
1677 | + return $this->get_prop( 'gateway', $context ); |
|
1678 | 1678 | } |
1679 | 1679 | |
1680 | 1680 | /** |
1681 | - * Get the invoice's gateway display title. |
|
1682 | - * |
|
1683 | - * @since 1.0.19 |
|
1684 | - * @return string |
|
1685 | - */ |
|
1681 | + * Get the invoice's gateway display title. |
|
1682 | + * |
|
1683 | + * @since 1.0.19 |
|
1684 | + * @return string |
|
1685 | + */ |
|
1686 | 1686 | public function get_gateway_title() { |
1687 | 1687 | $title = wpinv_get_gateway_checkout_label( $this->get_gateway() ); |
1688 | 1688 | return apply_filters( 'wpinv_gateway_title', $title, $this->get_id(), $this ); |
1689 | 1689 | } |
1690 | 1690 | |
1691 | 1691 | /** |
1692 | - * Get the invoice's transaction id. |
|
1693 | - * |
|
1694 | - * @since 1.0.19 |
|
1695 | - * @param string $context View or edit context. |
|
1696 | - * @return string |
|
1697 | - */ |
|
1698 | - public function get_transaction_id( $context = 'view' ) { |
|
1699 | - return $this->get_prop( 'transaction_id', $context ); |
|
1692 | + * Get the invoice's transaction id. |
|
1693 | + * |
|
1694 | + * @since 1.0.19 |
|
1695 | + * @param string $context View or edit context. |
|
1696 | + * @return string |
|
1697 | + */ |
|
1698 | + public function get_transaction_id( $context = 'view' ) { |
|
1699 | + return $this->get_prop( 'transaction_id', $context ); |
|
1700 | 1700 | } |
1701 | 1701 | |
1702 | 1702 | /** |
1703 | - * Get the invoice's currency. |
|
1704 | - * |
|
1705 | - * @since 1.0.19 |
|
1706 | - * @param string $context View or edit context. |
|
1707 | - * @return string |
|
1708 | - */ |
|
1709 | - public function get_currency( $context = 'view' ) { |
|
1703 | + * Get the invoice's currency. |
|
1704 | + * |
|
1705 | + * @since 1.0.19 |
|
1706 | + * @param string $context View or edit context. |
|
1707 | + * @return string |
|
1708 | + */ |
|
1709 | + public function get_currency( $context = 'view' ) { |
|
1710 | 1710 | $currency = $this->get_prop( 'currency', $context ); |
1711 | 1711 | return empty( $currency ) ? wpinv_get_currency() : $currency; |
1712 | 1712 | } |
1713 | 1713 | |
1714 | 1714 | /** |
1715 | - * Checks if we are charging taxes for this invoice. |
|
1716 | - * |
|
1717 | - * @since 1.0.19 |
|
1718 | - * @param string $context View or edit context. |
|
1719 | - * @return bool |
|
1720 | - */ |
|
1721 | - public function get_disable_taxes( $context = 'view' ) { |
|
1715 | + * Checks if we are charging taxes for this invoice. |
|
1716 | + * |
|
1717 | + * @since 1.0.19 |
|
1718 | + * @param string $context View or edit context. |
|
1719 | + * @return bool |
|
1720 | + */ |
|
1721 | + public function get_disable_taxes( $context = 'view' ) { |
|
1722 | 1722 | return (bool) $this->get_prop( 'disable_taxes', $context ); |
1723 | 1723 | } |
1724 | 1724 | |
1725 | 1725 | /** |
1726 | - * Retrieves the subscription id for an invoice. |
|
1727 | - * |
|
1728 | - * @since 1.0.19 |
|
1729 | - * @param string $context View or edit context. |
|
1730 | - * @return int |
|
1731 | - */ |
|
1726 | + * Retrieves the subscription id for an invoice. |
|
1727 | + * |
|
1728 | + * @since 1.0.19 |
|
1729 | + * @param string $context View or edit context. |
|
1730 | + * @return int |
|
1731 | + */ |
|
1732 | 1732 | public function get_subscription_id( $context = 'view' ) { |
1733 | - return $this->is_renewal() ? $this->get_parent()->get_subscription_id( $context ) : $this->get_prop( 'subscription_id', $context ); |
|
1734 | - } |
|
1735 | - |
|
1736 | - /** |
|
1737 | - * Retrieves the remote subscription id for an invoice. |
|
1738 | - * |
|
1739 | - * @since 1.0.19 |
|
1740 | - * @param string $context View or edit context. |
|
1741 | - * @return int |
|
1742 | - */ |
|
1733 | + return $this->is_renewal() ? $this->get_parent()->get_subscription_id( $context ) : $this->get_prop( 'subscription_id', $context ); |
|
1734 | + } |
|
1735 | + |
|
1736 | + /** |
|
1737 | + * Retrieves the remote subscription id for an invoice. |
|
1738 | + * |
|
1739 | + * @since 1.0.19 |
|
1740 | + * @param string $context View or edit context. |
|
1741 | + * @return int |
|
1742 | + */ |
|
1743 | 1743 | public function get_remote_subscription_id( $context = 'view' ) { |
1744 | 1744 | $subscription_id = $this->get_prop( 'remote_subscription_id', $context ); |
1745 | 1745 | |
@@ -1752,12 +1752,12 @@ discard block |
||
1752 | 1752 | } |
1753 | 1753 | |
1754 | 1754 | /** |
1755 | - * Retrieves the payment meta for an invoice. |
|
1756 | - * |
|
1757 | - * @since 1.0.19 |
|
1758 | - * @param string $context View or edit context. |
|
1759 | - * @return array |
|
1760 | - */ |
|
1755 | + * Retrieves the payment meta for an invoice. |
|
1756 | + * |
|
1757 | + * @since 1.0.19 |
|
1758 | + * @param string $context View or edit context. |
|
1759 | + * @return array |
|
1760 | + */ |
|
1761 | 1761 | public function get_payment_meta( $context = 'view' ) { |
1762 | 1762 | |
1763 | 1763 | return array( |
@@ -1777,31 +1777,31 @@ discard block |
||
1777 | 1777 | } |
1778 | 1778 | |
1779 | 1779 | /** |
1780 | - * Retrieves the cart details for an invoice. |
|
1781 | - * |
|
1782 | - * @since 1.0.19 |
|
1783 | - * @return array |
|
1784 | - */ |
|
1780 | + * Retrieves the cart details for an invoice. |
|
1781 | + * |
|
1782 | + * @since 1.0.19 |
|
1783 | + * @return array |
|
1784 | + */ |
|
1785 | 1785 | public function get_cart_details() { |
1786 | 1786 | $items = $this->get_items(); |
1787 | 1787 | $cart_details = array(); |
1788 | 1788 | |
1789 | 1789 | foreach ( $items as $item ) { |
1790 | - $item->invoice_id = $this->get_id(); |
|
1790 | + $item->invoice_id = $this->get_id(); |
|
1791 | 1791 | $cart_details[] = $item->prepare_data_for_saving(); |
1792 | 1792 | } |
1793 | 1793 | |
1794 | 1794 | return $cart_details; |
1795 | - } |
|
1795 | + } |
|
1796 | 1796 | |
1797 | - /** |
|
1798 | - * Retrieves the recurring item. |
|
1799 | - * |
|
1800 | - * @return null|GetPaid_Form_Item|int |
|
1801 | - */ |
|
1802 | - public function get_recurring( $object = false ) { |
|
1797 | + /** |
|
1798 | + * Retrieves the recurring item. |
|
1799 | + * |
|
1800 | + * @return null|GetPaid_Form_Item|int |
|
1801 | + */ |
|
1802 | + public function get_recurring( $object = false ) { |
|
1803 | 1803 | |
1804 | - // Are we returning an object? |
|
1804 | + // Are we returning an object? |
|
1805 | 1805 | if ( $object ) { |
1806 | 1806 | return $this->get_item( $this->recurring_item ); |
1807 | 1807 | } |
@@ -1809,114 +1809,114 @@ discard block |
||
1809 | 1809 | return $this->recurring_item; |
1810 | 1810 | } |
1811 | 1811 | |
1812 | - /** |
|
1813 | - * Retrieves the subscription name. |
|
1814 | - * |
|
1815 | - * @since 1.0.19 |
|
1816 | - * @return string |
|
1817 | - */ |
|
1818 | - public function get_subscription_name() { |
|
1812 | + /** |
|
1813 | + * Retrieves the subscription name. |
|
1814 | + * |
|
1815 | + * @since 1.0.19 |
|
1816 | + * @return string |
|
1817 | + */ |
|
1818 | + public function get_subscription_name() { |
|
1819 | 1819 | |
1820 | - // Retrieve the recurring name |
|
1820 | + // Retrieve the recurring name |
|
1821 | 1821 | $item = $this->get_recurring( true ); |
1822 | 1822 | |
1823 | - // Abort if it does not exist. |
|
1823 | + // Abort if it does not exist. |
|
1824 | 1824 | if ( empty( $item ) ) { |
1825 | 1825 | return ''; |
1826 | 1826 | } |
1827 | 1827 | |
1828 | - // Return the item name. |
|
1828 | + // Return the item name. |
|
1829 | 1829 | return apply_filters( 'wpinv_invoice_get_subscription_name', $item->get_name(), $this ); |
1830 | - } |
|
1831 | - |
|
1832 | - /** |
|
1833 | - * Retrieves the view url. |
|
1834 | - * |
|
1835 | - * @since 1.0.19 |
|
1836 | - * @return string |
|
1837 | - */ |
|
1838 | - public function get_view_url() { |
|
1830 | + } |
|
1831 | + |
|
1832 | + /** |
|
1833 | + * Retrieves the view url. |
|
1834 | + * |
|
1835 | + * @since 1.0.19 |
|
1836 | + * @return string |
|
1837 | + */ |
|
1838 | + public function get_view_url() { |
|
1839 | 1839 | $invoice_url = get_permalink( $this->get_id() ); |
1840 | - $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url ); |
|
1840 | + $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url ); |
|
1841 | 1841 | return apply_filters( 'wpinv_get_view_url', $invoice_url, $this ); |
1842 | - } |
|
1842 | + } |
|
1843 | 1843 | |
1844 | - /** |
|
1845 | - * Retrieves the payment url. |
|
1846 | - * |
|
1847 | - * @since 1.0.19 |
|
1848 | - * @return string |
|
1849 | - */ |
|
1850 | - public function get_checkout_payment_url( $deprecated = false, $secret = false ) { |
|
1844 | + /** |
|
1845 | + * Retrieves the payment url. |
|
1846 | + * |
|
1847 | + * @since 1.0.19 |
|
1848 | + * @return string |
|
1849 | + */ |
|
1850 | + public function get_checkout_payment_url( $deprecated = false, $secret = false ) { |
|
1851 | 1851 | |
1852 | - // Retrieve the checkout url. |
|
1852 | + // Retrieve the checkout url. |
|
1853 | 1853 | $pay_url = wpinv_get_checkout_uri(); |
1854 | 1854 | |
1855 | - // Maybe force ssl. |
|
1855 | + // Maybe force ssl. |
|
1856 | 1856 | if ( is_ssl() ) { |
1857 | 1857 | $pay_url = str_replace( 'http:', 'https:', $pay_url ); |
1858 | 1858 | } |
1859 | 1859 | |
1860 | - // Add the invoice key. |
|
1861 | - $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url ); |
|
1860 | + // Add the invoice key. |
|
1861 | + $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url ); |
|
1862 | 1862 | |
1863 | - // (Maybe?) add a secret |
|
1863 | + // (Maybe?) add a secret |
|
1864 | 1864 | if ( $secret ) { |
1865 | 1865 | $pay_url = add_query_arg( array( '_wpipay' => md5( $this->get_user_id() . '::' . $this->get_email() . '::' . $this->get_key() ) ), $pay_url ); |
1866 | 1866 | } |
1867 | 1867 | |
1868 | 1868 | return apply_filters( 'wpinv_get_checkout_payment_url', $pay_url, $this, $deprecated, $secret ); |
1869 | - } |
|
1869 | + } |
|
1870 | 1870 | |
1871 | - /** |
|
1872 | - * Retrieves the receipt url. |
|
1873 | - * |
|
1874 | - * @since 1.0.19 |
|
1875 | - * @return string |
|
1876 | - */ |
|
1877 | - public function get_receipt_url() { |
|
1878 | - |
|
1879 | - // Retrieve the checkout url. |
|
1871 | + /** |
|
1872 | + * Retrieves the receipt url. |
|
1873 | + * |
|
1874 | + * @since 1.0.19 |
|
1875 | + * @return string |
|
1876 | + */ |
|
1877 | + public function get_receipt_url() { |
|
1878 | + |
|
1879 | + // Retrieve the checkout url. |
|
1880 | 1880 | $receipt_url = wpinv_get_success_page_uri(); |
1881 | 1881 | |
1882 | - // Maybe force ssl. |
|
1882 | + // Maybe force ssl. |
|
1883 | 1883 | if ( is_ssl() ) { |
1884 | 1884 | $receipt_url = str_replace( 'http:', 'https:', $receipt_url ); |
1885 | 1885 | } |
1886 | 1886 | |
1887 | - // Add the invoice key. |
|
1888 | - $receipt_url = add_query_arg( 'invoice_key', $this->get_key(), $receipt_url ); |
|
1887 | + // Add the invoice key. |
|
1888 | + $receipt_url = add_query_arg( 'invoice_key', $this->get_key(), $receipt_url ); |
|
1889 | 1889 | |
1890 | 1890 | return apply_filters( 'getpaid_get_invoice_receipt_url', $receipt_url, $this ); |
1891 | - } |
|
1891 | + } |
|
1892 | 1892 | |
1893 | - /** |
|
1894 | - * Retrieves the default status. |
|
1895 | - * |
|
1896 | - * @since 1.0.19 |
|
1897 | - * @return string |
|
1898 | - */ |
|
1899 | - public function get_default_status() { |
|
1900 | - |
|
1901 | - $type = $this->get_type(); |
|
1902 | - $status = "wpi-$type-pending"; |
|
1903 | - return str_replace( '-invoice', '', $status ); |
|
1904 | - |
|
1905 | - } |
|
1906 | - |
|
1907 | - /** |
|
1908 | - * Magic method for accessing invoice properties. |
|
1909 | - * |
|
1910 | - * @since 1.0.15 |
|
1911 | - * @access public |
|
1912 | - * |
|
1913 | - * @param string $key Discount data to retrieve |
|
1914 | - * @param string $context View or edit context. |
|
1915 | - * @return mixed Value of the given invoice property (if set). |
|
1916 | - */ |
|
1917 | - public function get( $key, $context = 'view' ) { |
|
1893 | + /** |
|
1894 | + * Retrieves the default status. |
|
1895 | + * |
|
1896 | + * @since 1.0.19 |
|
1897 | + * @return string |
|
1898 | + */ |
|
1899 | + public function get_default_status() { |
|
1900 | + |
|
1901 | + $type = $this->get_type(); |
|
1902 | + $status = "wpi-$type-pending"; |
|
1903 | + return str_replace( '-invoice', '', $status ); |
|
1904 | + |
|
1905 | + } |
|
1906 | + |
|
1907 | + /** |
|
1908 | + * Magic method for accessing invoice properties. |
|
1909 | + * |
|
1910 | + * @since 1.0.15 |
|
1911 | + * @access public |
|
1912 | + * |
|
1913 | + * @param string $key Discount data to retrieve |
|
1914 | + * @param string $context View or edit context. |
|
1915 | + * @return mixed Value of the given invoice property (if set). |
|
1916 | + */ |
|
1917 | + public function get( $key, $context = 'view' ) { |
|
1918 | 1918 | return $this->get_prop( $key, $context ); |
1919 | - } |
|
1919 | + } |
|
1920 | 1920 | |
1921 | 1921 | /* |
1922 | 1922 | |-------------------------------------------------------------------------- |
@@ -1929,130 +1929,130 @@ discard block |
||
1929 | 1929 | */ |
1930 | 1930 | |
1931 | 1931 | /** |
1932 | - * Magic method for setting invoice properties. |
|
1933 | - * |
|
1934 | - * @since 1.0.19 |
|
1935 | - * @access public |
|
1936 | - * |
|
1937 | - * @param string $key Discount data to retrieve |
|
1938 | - * @param mixed $value new value. |
|
1939 | - * @return mixed Value of the given invoice property (if set). |
|
1940 | - */ |
|
1941 | - public function set( $key, $value ) { |
|
1932 | + * Magic method for setting invoice properties. |
|
1933 | + * |
|
1934 | + * @since 1.0.19 |
|
1935 | + * @access public |
|
1936 | + * |
|
1937 | + * @param string $key Discount data to retrieve |
|
1938 | + * @param mixed $value new value. |
|
1939 | + * @return mixed Value of the given invoice property (if set). |
|
1940 | + */ |
|
1941 | + public function set( $key, $value ) { |
|
1942 | 1942 | |
1943 | 1943 | $setter = "set_$key"; |
1944 | 1944 | if ( is_callable( array( $this, $setter ) ) ) { |
1945 | 1945 | $this->{$setter}( $value ); |
1946 | 1946 | } |
1947 | 1947 | |
1948 | - } |
|
1948 | + } |
|
1949 | 1949 | |
1950 | - /** |
|
1951 | - * Sets item status. |
|
1952 | - * |
|
1953 | - * @since 1.0.19 |
|
1954 | - * @param string $new_status New status. |
|
1955 | - * @param string $note Optional note to add. |
|
1956 | - * @param bool $manual_update Is this a manual status change?. |
|
1957 | - * @return array details of change. |
|
1958 | - */ |
|
1959 | - public function set_status( $new_status, $note = '', $manual_update = false ) { |
|
1960 | - $old_status = $this->get_status(); |
|
1950 | + /** |
|
1951 | + * Sets item status. |
|
1952 | + * |
|
1953 | + * @since 1.0.19 |
|
1954 | + * @param string $new_status New status. |
|
1955 | + * @param string $note Optional note to add. |
|
1956 | + * @param bool $manual_update Is this a manual status change?. |
|
1957 | + * @return array details of change. |
|
1958 | + */ |
|
1959 | + public function set_status( $new_status, $note = '', $manual_update = false ) { |
|
1960 | + $old_status = $this->get_status(); |
|
1961 | 1961 | |
1962 | - $statuses = $this->get_all_statuses(); |
|
1962 | + $statuses = $this->get_all_statuses(); |
|
1963 | 1963 | |
1964 | - if ( isset( $statuses[ 'draft' ] ) ) { |
|
1965 | - unset( $statuses[ 'draft' ] ); |
|
1966 | - } |
|
1964 | + if ( isset( $statuses[ 'draft' ] ) ) { |
|
1965 | + unset( $statuses[ 'draft' ] ); |
|
1966 | + } |
|
1967 | 1967 | |
1968 | - $this->set_prop( 'status', $new_status ); |
|
1968 | + $this->set_prop( 'status', $new_status ); |
|
1969 | 1969 | |
1970 | - // If setting the status, ensure it's set to a valid status. |
|
1971 | - if ( true === $this->object_read ) { |
|
1970 | + // If setting the status, ensure it's set to a valid status. |
|
1971 | + if ( true === $this->object_read ) { |
|
1972 | 1972 | |
1973 | - // Only allow valid new status. |
|
1974 | - if ( ! array_key_exists( $new_status, $statuses ) ) { |
|
1975 | - $new_status = $this->get_default_status(); |
|
1976 | - } |
|
1973 | + // Only allow valid new status. |
|
1974 | + if ( ! array_key_exists( $new_status, $statuses ) ) { |
|
1975 | + $new_status = $this->get_default_status(); |
|
1976 | + } |
|
1977 | 1977 | |
1978 | - // If the old status is set but unknown (e.g. draft) assume its pending for action usage. |
|
1979 | - if ( $old_status && ! array_key_exists( $new_status, $statuses ) ) { |
|
1980 | - $old_status = $this->get_default_status(); |
|
1981 | - } |
|
1978 | + // If the old status is set but unknown (e.g. draft) assume its pending for action usage. |
|
1979 | + if ( $old_status && ! array_key_exists( $new_status, $statuses ) ) { |
|
1980 | + $old_status = $this->get_default_status(); |
|
1981 | + } |
|
1982 | 1982 | |
1983 | - // Paid - Renewal (i.e when duplicating a parent invoice ) |
|
1984 | - if ( $new_status == 'wpi-pending' && $old_status == 'publish' && ! $this->get_id() ) { |
|
1985 | - $old_status = 'wpi-pending'; |
|
1986 | - } |
|
1983 | + // Paid - Renewal (i.e when duplicating a parent invoice ) |
|
1984 | + if ( $new_status == 'wpi-pending' && $old_status == 'publish' && ! $this->get_id() ) { |
|
1985 | + $old_status = 'wpi-pending'; |
|
1986 | + } |
|
1987 | 1987 | |
1988 | - if ( $old_status !== $new_status ) { |
|
1989 | - $this->status_transition = array( |
|
1990 | - 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
1991 | - 'to' => $new_status, |
|
1992 | - 'note' => $note, |
|
1993 | - 'manual' => (bool) $manual_update, |
|
1994 | - ); |
|
1988 | + if ( $old_status !== $new_status ) { |
|
1989 | + $this->status_transition = array( |
|
1990 | + 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
1991 | + 'to' => $new_status, |
|
1992 | + 'note' => $note, |
|
1993 | + 'manual' => (bool) $manual_update, |
|
1994 | + ); |
|
1995 | 1995 | |
1996 | - if ( $manual_update ) { |
|
1997 | - do_action( 'getpaid_' . $this->object_type .'_edit_status', $this->get_id(), $new_status ); |
|
1998 | - } |
|
1996 | + if ( $manual_update ) { |
|
1997 | + do_action( 'getpaid_' . $this->object_type .'_edit_status', $this->get_id(), $new_status ); |
|
1998 | + } |
|
1999 | 1999 | |
2000 | - $this->maybe_set_date_paid(); |
|
2000 | + $this->maybe_set_date_paid(); |
|
2001 | 2001 | |
2002 | - } |
|
2002 | + } |
|
2003 | 2003 | |
2004 | - } |
|
2004 | + } |
|
2005 | 2005 | |
2006 | - return array( |
|
2007 | - 'from' => $old_status, |
|
2008 | - 'to' => $new_status, |
|
2009 | - ); |
|
2010 | - } |
|
2006 | + return array( |
|
2007 | + 'from' => $old_status, |
|
2008 | + 'to' => $new_status, |
|
2009 | + ); |
|
2010 | + } |
|
2011 | 2011 | |
2012 | - /** |
|
2013 | - * Maybe set date paid. |
|
2014 | - * |
|
2015 | - * Sets the date paid variable when transitioning to the payment complete |
|
2016 | - * order status. |
|
2017 | - * |
|
2018 | - * @since 1.0.19 |
|
2019 | - */ |
|
2020 | - public function maybe_set_date_paid() { |
|
2012 | + /** |
|
2013 | + * Maybe set date paid. |
|
2014 | + * |
|
2015 | + * Sets the date paid variable when transitioning to the payment complete |
|
2016 | + * order status. |
|
2017 | + * |
|
2018 | + * @since 1.0.19 |
|
2019 | + */ |
|
2020 | + public function maybe_set_date_paid() { |
|
2021 | 2021 | |
2022 | - if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) { |
|
2023 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
2024 | - } |
|
2025 | - } |
|
2022 | + if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) { |
|
2023 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
2024 | + } |
|
2025 | + } |
|
2026 | 2026 | |
2027 | 2027 | /** |
2028 | - * Set parent invoice ID. |
|
2029 | - * |
|
2030 | - * @since 1.0.19 |
|
2031 | - */ |
|
2032 | - public function set_parent_id( $value ) { |
|
2033 | - if ( $value && ( $value === $this->get_id() ) ) { |
|
2034 | - return; |
|
2035 | - } |
|
2036 | - $this->set_prop( 'parent_id', absint( $value ) ); |
|
2028 | + * Set parent invoice ID. |
|
2029 | + * |
|
2030 | + * @since 1.0.19 |
|
2031 | + */ |
|
2032 | + public function set_parent_id( $value ) { |
|
2033 | + if ( $value && ( $value === $this->get_id() ) ) { |
|
2034 | + return; |
|
2035 | + } |
|
2036 | + $this->set_prop( 'parent_id', absint( $value ) ); |
|
2037 | 2037 | } |
2038 | 2038 | |
2039 | 2039 | /** |
2040 | - * Set plugin version when the invoice was created. |
|
2041 | - * |
|
2042 | - * @since 1.0.19 |
|
2043 | - */ |
|
2044 | - public function set_version( $value ) { |
|
2045 | - $this->set_prop( 'version', $value ); |
|
2040 | + * Set plugin version when the invoice was created. |
|
2041 | + * |
|
2042 | + * @since 1.0.19 |
|
2043 | + */ |
|
2044 | + public function set_version( $value ) { |
|
2045 | + $this->set_prop( 'version', $value ); |
|
2046 | 2046 | } |
2047 | - |
|
2048 | - /** |
|
2049 | - * Set date when the invoice was created. |
|
2050 | - * |
|
2051 | - * @since 1.0.19 |
|
2052 | - * @param string $value Value to set. |
|
2047 | + |
|
2048 | + /** |
|
2049 | + * Set date when the invoice was created. |
|
2050 | + * |
|
2051 | + * @since 1.0.19 |
|
2052 | + * @param string $value Value to set. |
|
2053 | 2053 | * @return bool Whether or not the date was set. |
2054 | - */ |
|
2055 | - public function set_date_created( $value ) { |
|
2054 | + */ |
|
2055 | + public function set_date_created( $value ) { |
|
2056 | 2056 | $date = strtotime( $value ); |
2057 | 2057 | |
2058 | 2058 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2060,19 +2060,19 @@ discard block |
||
2060 | 2060 | return true; |
2061 | 2061 | } |
2062 | 2062 | |
2063 | - $this->set_prop( 'date_created', '' ); |
|
2064 | - return false; |
|
2063 | + $this->set_prop( 'date_created', '' ); |
|
2064 | + return false; |
|
2065 | 2065 | |
2066 | 2066 | } |
2067 | 2067 | |
2068 | 2068 | /** |
2069 | - * Set date invoice due date. |
|
2070 | - * |
|
2071 | - * @since 1.0.19 |
|
2072 | - * @param string $value Value to set. |
|
2069 | + * Set date invoice due date. |
|
2070 | + * |
|
2071 | + * @since 1.0.19 |
|
2072 | + * @param string $value Value to set. |
|
2073 | 2073 | * @return bool Whether or not the date was set. |
2074 | - */ |
|
2075 | - public function set_due_date( $value ) { |
|
2074 | + */ |
|
2075 | + public function set_due_date( $value ) { |
|
2076 | 2076 | $date = strtotime( $value ); |
2077 | 2077 | |
2078 | 2078 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2080,29 +2080,29 @@ discard block |
||
2080 | 2080 | return true; |
2081 | 2081 | } |
2082 | 2082 | |
2083 | - $this->set_prop( 'due_date', '' ); |
|
2083 | + $this->set_prop( 'due_date', '' ); |
|
2084 | 2084 | return false; |
2085 | 2085 | |
2086 | 2086 | } |
2087 | 2087 | |
2088 | 2088 | /** |
2089 | - * Alias of self::set_due_date(). |
|
2090 | - * |
|
2091 | - * @since 1.0.19 |
|
2092 | - * @param string $value New name. |
|
2093 | - */ |
|
2094 | - public function set_date_due( $value ) { |
|
2095 | - $this->set_due_date( $value ); |
|
2089 | + * Alias of self::set_due_date(). |
|
2090 | + * |
|
2091 | + * @since 1.0.19 |
|
2092 | + * @param string $value New name. |
|
2093 | + */ |
|
2094 | + public function set_date_due( $value ) { |
|
2095 | + $this->set_due_date( $value ); |
|
2096 | 2096 | } |
2097 | 2097 | |
2098 | 2098 | /** |
2099 | - * Set date invoice was completed. |
|
2100 | - * |
|
2101 | - * @since 1.0.19 |
|
2102 | - * @param string $value Value to set. |
|
2099 | + * Set date invoice was completed. |
|
2100 | + * |
|
2101 | + * @since 1.0.19 |
|
2102 | + * @param string $value Value to set. |
|
2103 | 2103 | * @return bool Whether or not the date was set. |
2104 | - */ |
|
2105 | - public function set_completed_date( $value ) { |
|
2104 | + */ |
|
2105 | + public function set_completed_date( $value ) { |
|
2106 | 2106 | $date = strtotime( $value ); |
2107 | 2107 | |
2108 | 2108 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2110,29 +2110,29 @@ discard block |
||
2110 | 2110 | return true; |
2111 | 2111 | } |
2112 | 2112 | |
2113 | - $this->set_prop( 'completed_date', '' ); |
|
2113 | + $this->set_prop( 'completed_date', '' ); |
|
2114 | 2114 | return false; |
2115 | 2115 | |
2116 | 2116 | } |
2117 | 2117 | |
2118 | 2118 | /** |
2119 | - * Alias of self::set_completed_date(). |
|
2120 | - * |
|
2121 | - * @since 1.0.19 |
|
2122 | - * @param string $value New name. |
|
2123 | - */ |
|
2124 | - public function set_date_completed( $value ) { |
|
2125 | - $this->set_completed_date( $value ); |
|
2119 | + * Alias of self::set_completed_date(). |
|
2120 | + * |
|
2121 | + * @since 1.0.19 |
|
2122 | + * @param string $value New name. |
|
2123 | + */ |
|
2124 | + public function set_date_completed( $value ) { |
|
2125 | + $this->set_completed_date( $value ); |
|
2126 | 2126 | } |
2127 | 2127 | |
2128 | 2128 | /** |
2129 | - * Set date when the invoice was last modified. |
|
2130 | - * |
|
2131 | - * @since 1.0.19 |
|
2132 | - * @param string $value Value to set. |
|
2129 | + * Set date when the invoice was last modified. |
|
2130 | + * |
|
2131 | + * @since 1.0.19 |
|
2132 | + * @param string $value Value to set. |
|
2133 | 2133 | * @return bool Whether or not the date was set. |
2134 | - */ |
|
2135 | - public function set_date_modified( $value ) { |
|
2134 | + */ |
|
2135 | + public function set_date_modified( $value ) { |
|
2136 | 2136 | $date = strtotime( $value ); |
2137 | 2137 | |
2138 | 2138 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2140,798 +2140,798 @@ discard block |
||
2140 | 2140 | return true; |
2141 | 2141 | } |
2142 | 2142 | |
2143 | - $this->set_prop( 'date_modified', '' ); |
|
2143 | + $this->set_prop( 'date_modified', '' ); |
|
2144 | 2144 | return false; |
2145 | 2145 | |
2146 | 2146 | } |
2147 | 2147 | |
2148 | 2148 | /** |
2149 | - * Set the invoice number. |
|
2150 | - * |
|
2151 | - * @since 1.0.19 |
|
2152 | - * @param string $value New number. |
|
2153 | - */ |
|
2154 | - public function set_number( $value ) { |
|
2149 | + * Set the invoice number. |
|
2150 | + * |
|
2151 | + * @since 1.0.19 |
|
2152 | + * @param string $value New number. |
|
2153 | + */ |
|
2154 | + public function set_number( $value ) { |
|
2155 | 2155 | $number = sanitize_text_field( $value ); |
2156 | - $this->set_prop( 'number', $number ); |
|
2156 | + $this->set_prop( 'number', $number ); |
|
2157 | 2157 | } |
2158 | 2158 | |
2159 | 2159 | /** |
2160 | - * Set the invoice type. |
|
2161 | - * |
|
2162 | - * @since 1.0.19 |
|
2163 | - * @param string $value Type. |
|
2164 | - */ |
|
2165 | - public function set_type( $value ) { |
|
2160 | + * Set the invoice type. |
|
2161 | + * |
|
2162 | + * @since 1.0.19 |
|
2163 | + * @param string $value Type. |
|
2164 | + */ |
|
2165 | + public function set_type( $value ) { |
|
2166 | 2166 | $type = sanitize_text_field( str_replace( 'wpi_', '', $value ) ); |
2167 | - $this->set_prop( 'type', $type ); |
|
2168 | - } |
|
2167 | + $this->set_prop( 'type', $type ); |
|
2168 | + } |
|
2169 | 2169 | |
2170 | 2170 | /** |
2171 | - * Set the invoice post type. |
|
2172 | - * |
|
2173 | - * @since 1.0.19 |
|
2174 | - * @param string $value Post type. |
|
2175 | - */ |
|
2176 | - public function set_post_type( $value ) { |
|
2171 | + * Set the invoice post type. |
|
2172 | + * |
|
2173 | + * @since 1.0.19 |
|
2174 | + * @param string $value Post type. |
|
2175 | + */ |
|
2176 | + public function set_post_type( $value ) { |
|
2177 | 2177 | if ( getpaid_is_invoice_post_type( $value ) ) { |
2178 | - $this->set_type( $value ); |
|
2178 | + $this->set_type( $value ); |
|
2179 | 2179 | $this->set_prop( 'post_type', $value ); |
2180 | 2180 | } |
2181 | 2181 | } |
2182 | 2182 | |
2183 | 2183 | /** |
2184 | - * Set the invoice key. |
|
2185 | - * |
|
2186 | - * @since 1.0.19 |
|
2187 | - * @param string $value New key. |
|
2188 | - */ |
|
2189 | - public function set_key( $value ) { |
|
2184 | + * Set the invoice key. |
|
2185 | + * |
|
2186 | + * @since 1.0.19 |
|
2187 | + * @param string $value New key. |
|
2188 | + */ |
|
2189 | + public function set_key( $value ) { |
|
2190 | 2190 | $key = sanitize_text_field( $value ); |
2191 | - $this->set_prop( 'key', $key ); |
|
2191 | + $this->set_prop( 'key', $key ); |
|
2192 | 2192 | } |
2193 | 2193 | |
2194 | 2194 | /** |
2195 | - * Set the invoice mode. |
|
2196 | - * |
|
2197 | - * @since 1.0.19 |
|
2198 | - * @param string $value mode. |
|
2199 | - */ |
|
2200 | - public function set_mode( $value ) { |
|
2195 | + * Set the invoice mode. |
|
2196 | + * |
|
2197 | + * @since 1.0.19 |
|
2198 | + * @param string $value mode. |
|
2199 | + */ |
|
2200 | + public function set_mode( $value ) { |
|
2201 | 2201 | if ( in_array( $value, array( 'live', 'test' ) ) ) { |
2202 | 2202 | $this->set_prop( 'mode', $value ); |
2203 | 2203 | } |
2204 | 2204 | } |
2205 | 2205 | |
2206 | 2206 | /** |
2207 | - * Set the invoice path. |
|
2208 | - * |
|
2209 | - * @since 1.0.19 |
|
2210 | - * @param string $value path. |
|
2211 | - */ |
|
2212 | - public function set_path( $value ) { |
|
2207 | + * Set the invoice path. |
|
2208 | + * |
|
2209 | + * @since 1.0.19 |
|
2210 | + * @param string $value path. |
|
2211 | + */ |
|
2212 | + public function set_path( $value ) { |
|
2213 | 2213 | $this->set_prop( 'path', $value ); |
2214 | 2214 | } |
2215 | 2215 | |
2216 | 2216 | /** |
2217 | - * Set the invoice name. |
|
2218 | - * |
|
2219 | - * @since 1.0.19 |
|
2220 | - * @param string $value New name. |
|
2221 | - */ |
|
2222 | - public function set_name( $value ) { |
|
2217 | + * Set the invoice name. |
|
2218 | + * |
|
2219 | + * @since 1.0.19 |
|
2220 | + * @param string $value New name. |
|
2221 | + */ |
|
2222 | + public function set_name( $value ) { |
|
2223 | 2223 | $name = sanitize_text_field( $value ); |
2224 | - $this->set_prop( 'name', $name ); |
|
2224 | + $this->set_prop( 'name', $name ); |
|
2225 | 2225 | } |
2226 | 2226 | |
2227 | 2227 | /** |
2228 | - * Alias of self::set_name(). |
|
2229 | - * |
|
2230 | - * @since 1.0.19 |
|
2231 | - * @param string $value New name. |
|
2232 | - */ |
|
2233 | - public function set_title( $value ) { |
|
2234 | - $this->set_name( $value ); |
|
2228 | + * Alias of self::set_name(). |
|
2229 | + * |
|
2230 | + * @since 1.0.19 |
|
2231 | + * @param string $value New name. |
|
2232 | + */ |
|
2233 | + public function set_title( $value ) { |
|
2234 | + $this->set_name( $value ); |
|
2235 | 2235 | } |
2236 | 2236 | |
2237 | 2237 | /** |
2238 | - * Set the invoice description. |
|
2239 | - * |
|
2240 | - * @since 1.0.19 |
|
2241 | - * @param string $value New description. |
|
2242 | - */ |
|
2243 | - public function set_description( $value ) { |
|
2238 | + * Set the invoice description. |
|
2239 | + * |
|
2240 | + * @since 1.0.19 |
|
2241 | + * @param string $value New description. |
|
2242 | + */ |
|
2243 | + public function set_description( $value ) { |
|
2244 | 2244 | $description = wp_kses_post( $value ); |
2245 | - $this->set_prop( 'description', $description ); |
|
2245 | + $this->set_prop( 'description', $description ); |
|
2246 | + } |
|
2247 | + |
|
2248 | + /** |
|
2249 | + * Alias of self::set_description(). |
|
2250 | + * |
|
2251 | + * @since 1.0.19 |
|
2252 | + * @param string $value New description. |
|
2253 | + */ |
|
2254 | + public function set_excerpt( $value ) { |
|
2255 | + $this->set_description( $value ); |
|
2256 | + } |
|
2257 | + |
|
2258 | + /** |
|
2259 | + * Alias of self::set_description(). |
|
2260 | + * |
|
2261 | + * @since 1.0.19 |
|
2262 | + * @param string $value New description. |
|
2263 | + */ |
|
2264 | + public function set_summary( $value ) { |
|
2265 | + $this->set_description( $value ); |
|
2266 | + } |
|
2267 | + |
|
2268 | + /** |
|
2269 | + * Set the receiver of the invoice. |
|
2270 | + * |
|
2271 | + * @since 1.0.19 |
|
2272 | + * @param int $value New author. |
|
2273 | + */ |
|
2274 | + public function set_author( $value ) { |
|
2275 | + $user = get_user_by( 'id', (int) $value ); |
|
2276 | + |
|
2277 | + if ( $user && $user->ID ) { |
|
2278 | + $this->set_prop( 'author', $user->ID ); |
|
2279 | + $this->set_prop( 'email', $user->user_email ); |
|
2280 | + } |
|
2281 | + |
|
2282 | + } |
|
2283 | + |
|
2284 | + /** |
|
2285 | + * Alias of self::set_author(). |
|
2286 | + * |
|
2287 | + * @since 1.0.19 |
|
2288 | + * @param int $value New user id. |
|
2289 | + */ |
|
2290 | + public function set_user_id( $value ) { |
|
2291 | + $this->set_author( $value ); |
|
2292 | + } |
|
2293 | + |
|
2294 | + /** |
|
2295 | + * Alias of self::set_author(). |
|
2296 | + * |
|
2297 | + * @since 1.0.19 |
|
2298 | + * @param int $value New user id. |
|
2299 | + */ |
|
2300 | + public function set_customer_id( $value ) { |
|
2301 | + $this->set_author( $value ); |
|
2302 | + } |
|
2303 | + |
|
2304 | + /** |
|
2305 | + * Set the customer's ip. |
|
2306 | + * |
|
2307 | + * @since 1.0.19 |
|
2308 | + * @param string $value ip address. |
|
2309 | + */ |
|
2310 | + public function set_ip( $value ) { |
|
2311 | + $this->set_prop( 'ip', $value ); |
|
2312 | + } |
|
2313 | + |
|
2314 | + /** |
|
2315 | + * Alias of self::set_ip(). |
|
2316 | + * |
|
2317 | + * @since 1.0.19 |
|
2318 | + * @param string $value ip address. |
|
2319 | + */ |
|
2320 | + public function set_user_ip( $value ) { |
|
2321 | + $this->set_ip( $value ); |
|
2322 | + } |
|
2323 | + |
|
2324 | + /** |
|
2325 | + * Set the customer's first name. |
|
2326 | + * |
|
2327 | + * @since 1.0.19 |
|
2328 | + * @param string $value first name. |
|
2329 | + */ |
|
2330 | + public function set_first_name( $value ) { |
|
2331 | + $this->set_prop( 'first_name', $value ); |
|
2332 | + } |
|
2333 | + |
|
2334 | + /** |
|
2335 | + * Alias of self::set_first_name(). |
|
2336 | + * |
|
2337 | + * @since 1.0.19 |
|
2338 | + * @param string $value first name. |
|
2339 | + */ |
|
2340 | + public function set_user_first_name( $value ) { |
|
2341 | + $this->set_first_name( $value ); |
|
2342 | + } |
|
2343 | + |
|
2344 | + /** |
|
2345 | + * Alias of self::set_first_name(). |
|
2346 | + * |
|
2347 | + * @since 1.0.19 |
|
2348 | + * @param string $value first name. |
|
2349 | + */ |
|
2350 | + public function set_customer_first_name( $value ) { |
|
2351 | + $this->set_first_name( $value ); |
|
2352 | + } |
|
2353 | + |
|
2354 | + /** |
|
2355 | + * Set the customer's last name. |
|
2356 | + * |
|
2357 | + * @since 1.0.19 |
|
2358 | + * @param string $value last name. |
|
2359 | + */ |
|
2360 | + public function set_last_name( $value ) { |
|
2361 | + $this->set_prop( 'last_name', $value ); |
|
2246 | 2362 | } |
2247 | 2363 | |
2248 | 2364 | /** |
2249 | - * Alias of self::set_description(). |
|
2250 | - * |
|
2251 | - * @since 1.0.19 |
|
2252 | - * @param string $value New description. |
|
2253 | - */ |
|
2254 | - public function set_excerpt( $value ) { |
|
2255 | - $this->set_description( $value ); |
|
2365 | + * Alias of self::set_last_name(). |
|
2366 | + * |
|
2367 | + * @since 1.0.19 |
|
2368 | + * @param string $value last name. |
|
2369 | + */ |
|
2370 | + public function set_user_last_name( $value ) { |
|
2371 | + $this->set_last_name( $value ); |
|
2372 | + } |
|
2373 | + |
|
2374 | + /** |
|
2375 | + * Alias of self::set_last_name(). |
|
2376 | + * |
|
2377 | + * @since 1.0.19 |
|
2378 | + * @param string $value last name. |
|
2379 | + */ |
|
2380 | + public function set_customer_last_name( $value ) { |
|
2381 | + $this->set_last_name( $value ); |
|
2382 | + } |
|
2383 | + |
|
2384 | + /** |
|
2385 | + * Set the customer's phone number. |
|
2386 | + * |
|
2387 | + * @since 1.0.19 |
|
2388 | + * @param string $value phone. |
|
2389 | + */ |
|
2390 | + public function set_phone( $value ) { |
|
2391 | + $this->set_prop( 'phone', $value ); |
|
2256 | 2392 | } |
2257 | 2393 | |
2258 | 2394 | /** |
2259 | - * Alias of self::set_description(). |
|
2260 | - * |
|
2261 | - * @since 1.0.19 |
|
2262 | - * @param string $value New description. |
|
2263 | - */ |
|
2264 | - public function set_summary( $value ) { |
|
2265 | - $this->set_description( $value ); |
|
2395 | + * Alias of self::set_phone(). |
|
2396 | + * |
|
2397 | + * @since 1.0.19 |
|
2398 | + * @param string $value phone. |
|
2399 | + */ |
|
2400 | + public function set_user_phone( $value ) { |
|
2401 | + $this->set_phone( $value ); |
|
2266 | 2402 | } |
2267 | 2403 | |
2268 | 2404 | /** |
2269 | - * Set the receiver of the invoice. |
|
2270 | - * |
|
2271 | - * @since 1.0.19 |
|
2272 | - * @param int $value New author. |
|
2273 | - */ |
|
2274 | - public function set_author( $value ) { |
|
2275 | - $user = get_user_by( 'id', (int) $value ); |
|
2405 | + * Alias of self::set_phone(). |
|
2406 | + * |
|
2407 | + * @since 1.0.19 |
|
2408 | + * @param string $value phone. |
|
2409 | + */ |
|
2410 | + public function set_customer_phone( $value ) { |
|
2411 | + $this->set_phone( $value ); |
|
2412 | + } |
|
2276 | 2413 | |
2277 | - if ( $user && $user->ID ) { |
|
2278 | - $this->set_prop( 'author', $user->ID ); |
|
2279 | - $this->set_prop( 'email', $user->user_email ); |
|
2280 | - } |
|
2414 | + /** |
|
2415 | + * Alias of self::set_phone(). |
|
2416 | + * |
|
2417 | + * @since 1.0.19 |
|
2418 | + * @param string $value phone. |
|
2419 | + */ |
|
2420 | + public function set_phone_number( $value ) { |
|
2421 | + $this->set_phone( $value ); |
|
2422 | + } |
|
2281 | 2423 | |
2424 | + /** |
|
2425 | + * Set the customer's email address. |
|
2426 | + * |
|
2427 | + * @since 1.0.19 |
|
2428 | + * @param string $value email address. |
|
2429 | + */ |
|
2430 | + public function set_email( $value ) { |
|
2431 | + $this->set_prop( 'email', $value ); |
|
2282 | 2432 | } |
2283 | 2433 | |
2284 | 2434 | /** |
2285 | - * Alias of self::set_author(). |
|
2286 | - * |
|
2287 | - * @since 1.0.19 |
|
2288 | - * @param int $value New user id. |
|
2289 | - */ |
|
2290 | - public function set_user_id( $value ) { |
|
2291 | - $this->set_author( $value ); |
|
2435 | + * Alias of self::set_email(). |
|
2436 | + * |
|
2437 | + * @since 1.0.19 |
|
2438 | + * @param string $value email address. |
|
2439 | + */ |
|
2440 | + public function set_user_email( $value ) { |
|
2441 | + $this->set_email( $value ); |
|
2292 | 2442 | } |
2293 | 2443 | |
2294 | 2444 | /** |
2295 | - * Alias of self::set_author(). |
|
2296 | - * |
|
2297 | - * @since 1.0.19 |
|
2298 | - * @param int $value New user id. |
|
2299 | - */ |
|
2300 | - public function set_customer_id( $value ) { |
|
2301 | - $this->set_author( $value ); |
|
2445 | + * Alias of self::set_email(). |
|
2446 | + * |
|
2447 | + * @since 1.0.19 |
|
2448 | + * @param string $value email address. |
|
2449 | + */ |
|
2450 | + public function set_email_address( $value ) { |
|
2451 | + $this->set_email( $value ); |
|
2302 | 2452 | } |
2303 | 2453 | |
2304 | 2454 | /** |
2305 | - * Set the customer's ip. |
|
2306 | - * |
|
2307 | - * @since 1.0.19 |
|
2308 | - * @param string $value ip address. |
|
2309 | - */ |
|
2310 | - public function set_ip( $value ) { |
|
2311 | - $this->set_prop( 'ip', $value ); |
|
2455 | + * Alias of self::set_email(). |
|
2456 | + * |
|
2457 | + * @since 1.0.19 |
|
2458 | + * @param string $value email address. |
|
2459 | + */ |
|
2460 | + public function set_customer_email( $value ) { |
|
2461 | + $this->set_email( $value ); |
|
2312 | 2462 | } |
2313 | 2463 | |
2314 | 2464 | /** |
2315 | - * Alias of self::set_ip(). |
|
2316 | - * |
|
2317 | - * @since 1.0.19 |
|
2318 | - * @param string $value ip address. |
|
2319 | - */ |
|
2320 | - public function set_user_ip( $value ) { |
|
2321 | - $this->set_ip( $value ); |
|
2465 | + * Set the customer's country. |
|
2466 | + * |
|
2467 | + * @since 1.0.19 |
|
2468 | + * @param string $value country. |
|
2469 | + */ |
|
2470 | + public function set_country( $value ) { |
|
2471 | + $this->set_prop( 'country', $value ); |
|
2322 | 2472 | } |
2323 | 2473 | |
2324 | 2474 | /** |
2325 | - * Set the customer's first name. |
|
2326 | - * |
|
2327 | - * @since 1.0.19 |
|
2328 | - * @param string $value first name. |
|
2329 | - */ |
|
2330 | - public function set_first_name( $value ) { |
|
2331 | - $this->set_prop( 'first_name', $value ); |
|
2475 | + * Alias of self::set_country(). |
|
2476 | + * |
|
2477 | + * @since 1.0.19 |
|
2478 | + * @param string $value country. |
|
2479 | + */ |
|
2480 | + public function set_user_country( $value ) { |
|
2481 | + $this->set_country( $value ); |
|
2332 | 2482 | } |
2333 | 2483 | |
2334 | 2484 | /** |
2335 | - * Alias of self::set_first_name(). |
|
2336 | - * |
|
2337 | - * @since 1.0.19 |
|
2338 | - * @param string $value first name. |
|
2339 | - */ |
|
2340 | - public function set_user_first_name( $value ) { |
|
2341 | - $this->set_first_name( $value ); |
|
2485 | + * Alias of self::set_country(). |
|
2486 | + * |
|
2487 | + * @since 1.0.19 |
|
2488 | + * @param string $value country. |
|
2489 | + */ |
|
2490 | + public function set_customer_country( $value ) { |
|
2491 | + $this->set_country( $value ); |
|
2342 | 2492 | } |
2343 | 2493 | |
2344 | 2494 | /** |
2345 | - * Alias of self::set_first_name(). |
|
2346 | - * |
|
2347 | - * @since 1.0.19 |
|
2348 | - * @param string $value first name. |
|
2349 | - */ |
|
2350 | - public function set_customer_first_name( $value ) { |
|
2351 | - $this->set_first_name( $value ); |
|
2495 | + * Set the customer's state. |
|
2496 | + * |
|
2497 | + * @since 1.0.19 |
|
2498 | + * @param string $value state. |
|
2499 | + */ |
|
2500 | + public function set_state( $value ) { |
|
2501 | + $this->set_prop( 'state', $value ); |
|
2352 | 2502 | } |
2353 | 2503 | |
2354 | 2504 | /** |
2355 | - * Set the customer's last name. |
|
2356 | - * |
|
2357 | - * @since 1.0.19 |
|
2358 | - * @param string $value last name. |
|
2359 | - */ |
|
2360 | - public function set_last_name( $value ) { |
|
2361 | - $this->set_prop( 'last_name', $value ); |
|
2505 | + * Alias of self::set_state(). |
|
2506 | + * |
|
2507 | + * @since 1.0.19 |
|
2508 | + * @param string $value state. |
|
2509 | + */ |
|
2510 | + public function set_user_state( $value ) { |
|
2511 | + $this->set_state( $value ); |
|
2362 | 2512 | } |
2363 | 2513 | |
2364 | 2514 | /** |
2365 | - * Alias of self::set_last_name(). |
|
2366 | - * |
|
2367 | - * @since 1.0.19 |
|
2368 | - * @param string $value last name. |
|
2369 | - */ |
|
2370 | - public function set_user_last_name( $value ) { |
|
2371 | - $this->set_last_name( $value ); |
|
2515 | + * Alias of self::set_state(). |
|
2516 | + * |
|
2517 | + * @since 1.0.19 |
|
2518 | + * @param string $value state. |
|
2519 | + */ |
|
2520 | + public function set_customer_state( $value ) { |
|
2521 | + $this->set_state( $value ); |
|
2372 | 2522 | } |
2373 | 2523 | |
2374 | 2524 | /** |
2375 | - * Alias of self::set_last_name(). |
|
2376 | - * |
|
2377 | - * @since 1.0.19 |
|
2378 | - * @param string $value last name. |
|
2379 | - */ |
|
2380 | - public function set_customer_last_name( $value ) { |
|
2381 | - $this->set_last_name( $value ); |
|
2525 | + * Set the customer's city. |
|
2526 | + * |
|
2527 | + * @since 1.0.19 |
|
2528 | + * @param string $value city. |
|
2529 | + */ |
|
2530 | + public function set_city( $value ) { |
|
2531 | + $this->set_prop( 'city', $value ); |
|
2382 | 2532 | } |
2383 | 2533 | |
2384 | 2534 | /** |
2385 | - * Set the customer's phone number. |
|
2386 | - * |
|
2387 | - * @since 1.0.19 |
|
2388 | - * @param string $value phone. |
|
2389 | - */ |
|
2390 | - public function set_phone( $value ) { |
|
2391 | - $this->set_prop( 'phone', $value ); |
|
2535 | + * Alias of self::set_city(). |
|
2536 | + * |
|
2537 | + * @since 1.0.19 |
|
2538 | + * @param string $value city. |
|
2539 | + */ |
|
2540 | + public function set_user_city( $value ) { |
|
2541 | + $this->set_city( $value ); |
|
2392 | 2542 | } |
2393 | 2543 | |
2394 | 2544 | /** |
2395 | - * Alias of self::set_phone(). |
|
2396 | - * |
|
2397 | - * @since 1.0.19 |
|
2398 | - * @param string $value phone. |
|
2399 | - */ |
|
2400 | - public function set_user_phone( $value ) { |
|
2401 | - $this->set_phone( $value ); |
|
2545 | + * Alias of self::set_city(). |
|
2546 | + * |
|
2547 | + * @since 1.0.19 |
|
2548 | + * @param string $value city. |
|
2549 | + */ |
|
2550 | + public function set_customer_city( $value ) { |
|
2551 | + $this->set_city( $value ); |
|
2402 | 2552 | } |
2403 | 2553 | |
2404 | 2554 | /** |
2405 | - * Alias of self::set_phone(). |
|
2406 | - * |
|
2407 | - * @since 1.0.19 |
|
2408 | - * @param string $value phone. |
|
2409 | - */ |
|
2410 | - public function set_customer_phone( $value ) { |
|
2411 | - $this->set_phone( $value ); |
|
2555 | + * Set the customer's zip code. |
|
2556 | + * |
|
2557 | + * @since 1.0.19 |
|
2558 | + * @param string $value zip. |
|
2559 | + */ |
|
2560 | + public function set_zip( $value ) { |
|
2561 | + $this->set_prop( 'zip', $value ); |
|
2412 | 2562 | } |
2413 | 2563 | |
2414 | 2564 | /** |
2415 | - * Alias of self::set_phone(). |
|
2416 | - * |
|
2417 | - * @since 1.0.19 |
|
2418 | - * @param string $value phone. |
|
2419 | - */ |
|
2420 | - public function set_phone_number( $value ) { |
|
2421 | - $this->set_phone( $value ); |
|
2565 | + * Alias of self::set_zip(). |
|
2566 | + * |
|
2567 | + * @since 1.0.19 |
|
2568 | + * @param string $value zip. |
|
2569 | + */ |
|
2570 | + public function set_user_zip( $value ) { |
|
2571 | + $this->set_zip( $value ); |
|
2422 | 2572 | } |
2423 | 2573 | |
2424 | 2574 | /** |
2425 | - * Set the customer's email address. |
|
2426 | - * |
|
2427 | - * @since 1.0.19 |
|
2428 | - * @param string $value email address. |
|
2429 | - */ |
|
2430 | - public function set_email( $value ) { |
|
2431 | - $this->set_prop( 'email', $value ); |
|
2575 | + * Alias of self::set_zip(). |
|
2576 | + * |
|
2577 | + * @since 1.0.19 |
|
2578 | + * @param string $value zip. |
|
2579 | + */ |
|
2580 | + public function set_customer_zip( $value ) { |
|
2581 | + $this->set_zip( $value ); |
|
2432 | 2582 | } |
2433 | 2583 | |
2434 | 2584 | /** |
2435 | - * Alias of self::set_email(). |
|
2436 | - * |
|
2437 | - * @since 1.0.19 |
|
2438 | - * @param string $value email address. |
|
2439 | - */ |
|
2440 | - public function set_user_email( $value ) { |
|
2441 | - $this->set_email( $value ); |
|
2585 | + * Set the customer's company. |
|
2586 | + * |
|
2587 | + * @since 1.0.19 |
|
2588 | + * @param string $value company. |
|
2589 | + */ |
|
2590 | + public function set_company( $value ) { |
|
2591 | + $this->set_prop( 'company', $value ); |
|
2442 | 2592 | } |
2443 | 2593 | |
2444 | 2594 | /** |
2445 | - * Alias of self::set_email(). |
|
2446 | - * |
|
2447 | - * @since 1.0.19 |
|
2448 | - * @param string $value email address. |
|
2449 | - */ |
|
2450 | - public function set_email_address( $value ) { |
|
2451 | - $this->set_email( $value ); |
|
2595 | + * Alias of self::set_company(). |
|
2596 | + * |
|
2597 | + * @since 1.0.19 |
|
2598 | + * @param string $value company. |
|
2599 | + */ |
|
2600 | + public function set_user_company( $value ) { |
|
2601 | + $this->set_company( $value ); |
|
2452 | 2602 | } |
2453 | 2603 | |
2454 | 2604 | /** |
2455 | - * Alias of self::set_email(). |
|
2456 | - * |
|
2457 | - * @since 1.0.19 |
|
2458 | - * @param string $value email address. |
|
2459 | - */ |
|
2460 | - public function set_customer_email( $value ) { |
|
2461 | - $this->set_email( $value ); |
|
2605 | + * Alias of self::set_company(). |
|
2606 | + * |
|
2607 | + * @since 1.0.19 |
|
2608 | + * @param string $value company. |
|
2609 | + */ |
|
2610 | + public function set_customer_company( $value ) { |
|
2611 | + $this->set_company( $value ); |
|
2462 | 2612 | } |
2463 | 2613 | |
2464 | 2614 | /** |
2465 | - * Set the customer's country. |
|
2466 | - * |
|
2467 | - * @since 1.0.19 |
|
2468 | - * @param string $value country. |
|
2469 | - */ |
|
2470 | - public function set_country( $value ) { |
|
2471 | - $this->set_prop( 'country', $value ); |
|
2615 | + * Set the customer's company id. |
|
2616 | + * |
|
2617 | + * @since 1.0.19 |
|
2618 | + * @param string $value company id. |
|
2619 | + */ |
|
2620 | + public function set_company_id( $value ) { |
|
2621 | + $this->set_prop( 'company_id', $value ); |
|
2472 | 2622 | } |
2473 | 2623 | |
2474 | 2624 | /** |
2475 | - * Alias of self::set_country(). |
|
2476 | - * |
|
2477 | - * @since 1.0.19 |
|
2478 | - * @param string $value country. |
|
2479 | - */ |
|
2480 | - public function set_user_country( $value ) { |
|
2481 | - $this->set_country( $value ); |
|
2625 | + * Set the customer's var number. |
|
2626 | + * |
|
2627 | + * @since 1.0.19 |
|
2628 | + * @param string $value var number. |
|
2629 | + */ |
|
2630 | + public function set_vat_number( $value ) { |
|
2631 | + $this->set_prop( 'vat_number', $value ); |
|
2482 | 2632 | } |
2483 | 2633 | |
2484 | 2634 | /** |
2485 | - * Alias of self::set_country(). |
|
2486 | - * |
|
2487 | - * @since 1.0.19 |
|
2488 | - * @param string $value country. |
|
2489 | - */ |
|
2490 | - public function set_customer_country( $value ) { |
|
2491 | - $this->set_country( $value ); |
|
2635 | + * Alias of self::set_vat_number(). |
|
2636 | + * |
|
2637 | + * @since 1.0.19 |
|
2638 | + * @param string $value var number. |
|
2639 | + */ |
|
2640 | + public function set_user_vat_number( $value ) { |
|
2641 | + $this->set_vat_number( $value ); |
|
2492 | 2642 | } |
2493 | 2643 | |
2494 | 2644 | /** |
2495 | - * Set the customer's state. |
|
2496 | - * |
|
2497 | - * @since 1.0.19 |
|
2498 | - * @param string $value state. |
|
2499 | - */ |
|
2500 | - public function set_state( $value ) { |
|
2501 | - $this->set_prop( 'state', $value ); |
|
2645 | + * Alias of self::set_vat_number(). |
|
2646 | + * |
|
2647 | + * @since 1.0.19 |
|
2648 | + * @param string $value var number. |
|
2649 | + */ |
|
2650 | + public function set_customer_vat_number( $value ) { |
|
2651 | + $this->set_vat_number( $value ); |
|
2502 | 2652 | } |
2503 | 2653 | |
2504 | 2654 | /** |
2505 | - * Alias of self::set_state(). |
|
2506 | - * |
|
2507 | - * @since 1.0.19 |
|
2508 | - * @param string $value state. |
|
2509 | - */ |
|
2510 | - public function set_user_state( $value ) { |
|
2511 | - $this->set_state( $value ); |
|
2655 | + * Set the customer's vat rate. |
|
2656 | + * |
|
2657 | + * @since 1.0.19 |
|
2658 | + * @param string $value var rate. |
|
2659 | + */ |
|
2660 | + public function set_vat_rate( $value ) { |
|
2661 | + $this->set_prop( 'vat_rate', $value ); |
|
2512 | 2662 | } |
2513 | 2663 | |
2514 | 2664 | /** |
2515 | - * Alias of self::set_state(). |
|
2516 | - * |
|
2517 | - * @since 1.0.19 |
|
2518 | - * @param string $value state. |
|
2519 | - */ |
|
2520 | - public function set_customer_state( $value ) { |
|
2521 | - $this->set_state( $value ); |
|
2665 | + * Alias of self::set_vat_rate(). |
|
2666 | + * |
|
2667 | + * @since 1.0.19 |
|
2668 | + * @param string $value var number. |
|
2669 | + */ |
|
2670 | + public function set_user_vat_rate( $value ) { |
|
2671 | + $this->set_vat_rate( $value ); |
|
2522 | 2672 | } |
2523 | 2673 | |
2524 | 2674 | /** |
2525 | - * Set the customer's city. |
|
2526 | - * |
|
2527 | - * @since 1.0.19 |
|
2528 | - * @param string $value city. |
|
2529 | - */ |
|
2530 | - public function set_city( $value ) { |
|
2531 | - $this->set_prop( 'city', $value ); |
|
2675 | + * Alias of self::set_vat_rate(). |
|
2676 | + * |
|
2677 | + * @since 1.0.19 |
|
2678 | + * @param string $value var number. |
|
2679 | + */ |
|
2680 | + public function set_customer_vat_rate( $value ) { |
|
2681 | + $this->set_vat_rate( $value ); |
|
2532 | 2682 | } |
2533 | 2683 | |
2534 | 2684 | /** |
2535 | - * Alias of self::set_city(). |
|
2536 | - * |
|
2537 | - * @since 1.0.19 |
|
2538 | - * @param string $value city. |
|
2539 | - */ |
|
2540 | - public function set_user_city( $value ) { |
|
2541 | - $this->set_city( $value ); |
|
2685 | + * Set the customer's address. |
|
2686 | + * |
|
2687 | + * @since 1.0.19 |
|
2688 | + * @param string $value address. |
|
2689 | + */ |
|
2690 | + public function set_address( $value ) { |
|
2691 | + $this->set_prop( 'address', $value ); |
|
2542 | 2692 | } |
2543 | 2693 | |
2544 | 2694 | /** |
2545 | - * Alias of self::set_city(). |
|
2546 | - * |
|
2547 | - * @since 1.0.19 |
|
2548 | - * @param string $value city. |
|
2549 | - */ |
|
2550 | - public function set_customer_city( $value ) { |
|
2551 | - $this->set_city( $value ); |
|
2695 | + * Alias of self::set_address(). |
|
2696 | + * |
|
2697 | + * @since 1.0.19 |
|
2698 | + * @param string $value address. |
|
2699 | + */ |
|
2700 | + public function set_user_address( $value ) { |
|
2701 | + $this->set_address( $value ); |
|
2552 | 2702 | } |
2553 | 2703 | |
2554 | 2704 | /** |
2555 | - * Set the customer's zip code. |
|
2556 | - * |
|
2557 | - * @since 1.0.19 |
|
2558 | - * @param string $value zip. |
|
2559 | - */ |
|
2560 | - public function set_zip( $value ) { |
|
2561 | - $this->set_prop( 'zip', $value ); |
|
2705 | + * Alias of self::set_address(). |
|
2706 | + * |
|
2707 | + * @since 1.0.19 |
|
2708 | + * @param string $value address. |
|
2709 | + */ |
|
2710 | + public function set_customer_address( $value ) { |
|
2711 | + $this->set_address( $value ); |
|
2562 | 2712 | } |
2563 | 2713 | |
2564 | 2714 | /** |
2565 | - * Alias of self::set_zip(). |
|
2566 | - * |
|
2567 | - * @since 1.0.19 |
|
2568 | - * @param string $value zip. |
|
2569 | - */ |
|
2570 | - public function set_user_zip( $value ) { |
|
2571 | - $this->set_zip( $value ); |
|
2715 | + * Set whether the customer has viewed the invoice or not. |
|
2716 | + * |
|
2717 | + * @since 1.0.19 |
|
2718 | + * @param int|bool $value confirmed. |
|
2719 | + */ |
|
2720 | + public function set_is_viewed( $value ) { |
|
2721 | + $this->set_prop( 'is_viewed', $value ); |
|
2572 | 2722 | } |
2573 | 2723 | |
2574 | 2724 | /** |
2575 | - * Alias of self::set_zip(). |
|
2576 | - * |
|
2577 | - * @since 1.0.19 |
|
2578 | - * @param string $value zip. |
|
2579 | - */ |
|
2580 | - public function set_customer_zip( $value ) { |
|
2581 | - $this->set_zip( $value ); |
|
2725 | + * Set extra email recipients. |
|
2726 | + * |
|
2727 | + * @since 1.0.19 |
|
2728 | + * @param string $value email recipients. |
|
2729 | + */ |
|
2730 | + public function set_email_cc( $value ) { |
|
2731 | + $this->set_prop( 'email_cc', $value ); |
|
2582 | 2732 | } |
2583 | 2733 | |
2584 | 2734 | /** |
2585 | - * Set the customer's company. |
|
2586 | - * |
|
2587 | - * @since 1.0.19 |
|
2588 | - * @param string $value company. |
|
2589 | - */ |
|
2590 | - public function set_company( $value ) { |
|
2591 | - $this->set_prop( 'company', $value ); |
|
2735 | + * Set the invoice template. |
|
2736 | + * |
|
2737 | + * @since 1.0.19 |
|
2738 | + * @param string $value template. |
|
2739 | + */ |
|
2740 | + public function set_template( $value ) { |
|
2741 | + if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) { |
|
2742 | + $this->set_prop( 'template', $value ); |
|
2743 | + } |
|
2592 | 2744 | } |
2593 | 2745 | |
2594 | 2746 | /** |
2595 | - * Alias of self::set_company(). |
|
2596 | - * |
|
2597 | - * @since 1.0.19 |
|
2598 | - * @param string $value company. |
|
2599 | - */ |
|
2600 | - public function set_user_company( $value ) { |
|
2601 | - $this->set_company( $value ); |
|
2747 | + * Set the invoice source. |
|
2748 | + * |
|
2749 | + * @since 1.0.19 |
|
2750 | + * @param string $value source. |
|
2751 | + * @deprecated |
|
2752 | + */ |
|
2753 | + public function created_via( $value ) { |
|
2754 | + $this->set_created_via( sanitize_text_field( $value ) ); |
|
2602 | 2755 | } |
2603 | 2756 | |
2604 | 2757 | /** |
2605 | - * Alias of self::set_company(). |
|
2606 | - * |
|
2607 | - * @since 1.0.19 |
|
2608 | - * @param string $value company. |
|
2609 | - */ |
|
2610 | - public function set_customer_company( $value ) { |
|
2611 | - $this->set_company( $value ); |
|
2758 | + * Set the invoice source. |
|
2759 | + * |
|
2760 | + * @since 1.0.19 |
|
2761 | + * @param string $value source. |
|
2762 | + */ |
|
2763 | + public function set_created_via( $value ) { |
|
2764 | + $this->set_prop( 'created_via', sanitize_text_field( $value ) ); |
|
2612 | 2765 | } |
2613 | 2766 | |
2614 | - /** |
|
2615 | - * Set the customer's company id. |
|
2616 | - * |
|
2617 | - * @since 1.0.19 |
|
2618 | - * @param string $value company id. |
|
2619 | - */ |
|
2620 | - public function set_company_id( $value ) { |
|
2621 | - $this->set_prop( 'company_id', $value ); |
|
2767 | + /** |
|
2768 | + * Set the customer's address confirmed status. |
|
2769 | + * |
|
2770 | + * @since 1.0.19 |
|
2771 | + * @param int|bool $value confirmed. |
|
2772 | + */ |
|
2773 | + public function set_address_confirmed( $value ) { |
|
2774 | + $this->set_prop( 'address_confirmed', $value ); |
|
2622 | 2775 | } |
2623 | 2776 | |
2624 | 2777 | /** |
2625 | - * Set the customer's var number. |
|
2626 | - * |
|
2627 | - * @since 1.0.19 |
|
2628 | - * @param string $value var number. |
|
2629 | - */ |
|
2630 | - public function set_vat_number( $value ) { |
|
2631 | - $this->set_prop( 'vat_number', $value ); |
|
2778 | + * Alias of self::set_address_confirmed(). |
|
2779 | + * |
|
2780 | + * @since 1.0.19 |
|
2781 | + * @param int|bool $value confirmed. |
|
2782 | + */ |
|
2783 | + public function set_user_address_confirmed( $value ) { |
|
2784 | + $this->set_address_confirmed( $value ); |
|
2632 | 2785 | } |
2633 | 2786 | |
2634 | 2787 | /** |
2635 | - * Alias of self::set_vat_number(). |
|
2636 | - * |
|
2637 | - * @since 1.0.19 |
|
2638 | - * @param string $value var number. |
|
2639 | - */ |
|
2640 | - public function set_user_vat_number( $value ) { |
|
2641 | - $this->set_vat_number( $value ); |
|
2788 | + * Alias of self::set_address_confirmed(). |
|
2789 | + * |
|
2790 | + * @since 1.0.19 |
|
2791 | + * @param int|bool $value confirmed. |
|
2792 | + */ |
|
2793 | + public function set_customer_address_confirmed( $value ) { |
|
2794 | + $this->set_address_confirmed( $value ); |
|
2642 | 2795 | } |
2643 | 2796 | |
2644 | 2797 | /** |
2645 | - * Alias of self::set_vat_number(). |
|
2646 | - * |
|
2647 | - * @since 1.0.19 |
|
2648 | - * @param string $value var number. |
|
2649 | - */ |
|
2650 | - public function set_customer_vat_number( $value ) { |
|
2651 | - $this->set_vat_number( $value ); |
|
2798 | + * Set the invoice sub total. |
|
2799 | + * |
|
2800 | + * @since 1.0.19 |
|
2801 | + * @param float $value sub total. |
|
2802 | + */ |
|
2803 | + public function set_subtotal( $value ) { |
|
2804 | + $this->set_prop( 'subtotal', max( 0, $value ) ); |
|
2652 | 2805 | } |
2653 | 2806 | |
2654 | 2807 | /** |
2655 | - * Set the customer's vat rate. |
|
2656 | - * |
|
2657 | - * @since 1.0.19 |
|
2658 | - * @param string $value var rate. |
|
2659 | - */ |
|
2660 | - public function set_vat_rate( $value ) { |
|
2661 | - $this->set_prop( 'vat_rate', $value ); |
|
2808 | + * Set the invoice total. |
|
2809 | + * |
|
2810 | + * @since 1.0.19 |
|
2811 | + * @param float $value sub total. |
|
2812 | + */ |
|
2813 | + public function set_total( $value ) { |
|
2814 | + $this->set_prop( 'total', max( 0, $value ) ); |
|
2662 | 2815 | } |
2663 | 2816 | |
2664 | - /** |
|
2665 | - * Alias of self::set_vat_rate(). |
|
2666 | - * |
|
2667 | - * @since 1.0.19 |
|
2668 | - * @param string $value var number. |
|
2669 | - */ |
|
2670 | - public function set_user_vat_rate( $value ) { |
|
2671 | - $this->set_vat_rate( $value ); |
|
2672 | - } |
|
2673 | - |
|
2674 | - /** |
|
2675 | - * Alias of self::set_vat_rate(). |
|
2676 | - * |
|
2677 | - * @since 1.0.19 |
|
2678 | - * @param string $value var number. |
|
2679 | - */ |
|
2680 | - public function set_customer_vat_rate( $value ) { |
|
2681 | - $this->set_vat_rate( $value ); |
|
2682 | - } |
|
2683 | - |
|
2684 | - /** |
|
2685 | - * Set the customer's address. |
|
2686 | - * |
|
2687 | - * @since 1.0.19 |
|
2688 | - * @param string $value address. |
|
2689 | - */ |
|
2690 | - public function set_address( $value ) { |
|
2691 | - $this->set_prop( 'address', $value ); |
|
2692 | - } |
|
2693 | - |
|
2694 | - /** |
|
2695 | - * Alias of self::set_address(). |
|
2696 | - * |
|
2697 | - * @since 1.0.19 |
|
2698 | - * @param string $value address. |
|
2699 | - */ |
|
2700 | - public function set_user_address( $value ) { |
|
2701 | - $this->set_address( $value ); |
|
2702 | - } |
|
2703 | - |
|
2704 | - /** |
|
2705 | - * Alias of self::set_address(). |
|
2706 | - * |
|
2707 | - * @since 1.0.19 |
|
2708 | - * @param string $value address. |
|
2709 | - */ |
|
2710 | - public function set_customer_address( $value ) { |
|
2711 | - $this->set_address( $value ); |
|
2712 | - } |
|
2713 | - |
|
2714 | - /** |
|
2715 | - * Set whether the customer has viewed the invoice or not. |
|
2716 | - * |
|
2717 | - * @since 1.0.19 |
|
2718 | - * @param int|bool $value confirmed. |
|
2719 | - */ |
|
2720 | - public function set_is_viewed( $value ) { |
|
2721 | - $this->set_prop( 'is_viewed', $value ); |
|
2722 | - } |
|
2723 | - |
|
2724 | - /** |
|
2725 | - * Set extra email recipients. |
|
2726 | - * |
|
2727 | - * @since 1.0.19 |
|
2728 | - * @param string $value email recipients. |
|
2729 | - */ |
|
2730 | - public function set_email_cc( $value ) { |
|
2731 | - $this->set_prop( 'email_cc', $value ); |
|
2732 | - } |
|
2733 | - |
|
2734 | - /** |
|
2735 | - * Set the invoice template. |
|
2736 | - * |
|
2737 | - * @since 1.0.19 |
|
2738 | - * @param string $value template. |
|
2739 | - */ |
|
2740 | - public function set_template( $value ) { |
|
2741 | - if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) { |
|
2742 | - $this->set_prop( 'template', $value ); |
|
2743 | - } |
|
2744 | - } |
|
2745 | - |
|
2746 | - /** |
|
2747 | - * Set the invoice source. |
|
2748 | - * |
|
2749 | - * @since 1.0.19 |
|
2750 | - * @param string $value source. |
|
2751 | - * @deprecated |
|
2752 | - */ |
|
2753 | - public function created_via( $value ) { |
|
2754 | - $this->set_created_via( sanitize_text_field( $value ) ); |
|
2755 | - } |
|
2756 | - |
|
2757 | - /** |
|
2758 | - * Set the invoice source. |
|
2759 | - * |
|
2760 | - * @since 1.0.19 |
|
2761 | - * @param string $value source. |
|
2762 | - */ |
|
2763 | - public function set_created_via( $value ) { |
|
2764 | - $this->set_prop( 'created_via', sanitize_text_field( $value ) ); |
|
2765 | - } |
|
2766 | - |
|
2767 | - /** |
|
2768 | - * Set the customer's address confirmed status. |
|
2769 | - * |
|
2770 | - * @since 1.0.19 |
|
2771 | - * @param int|bool $value confirmed. |
|
2772 | - */ |
|
2773 | - public function set_address_confirmed( $value ) { |
|
2774 | - $this->set_prop( 'address_confirmed', $value ); |
|
2775 | - } |
|
2776 | - |
|
2777 | - /** |
|
2778 | - * Alias of self::set_address_confirmed(). |
|
2779 | - * |
|
2780 | - * @since 1.0.19 |
|
2781 | - * @param int|bool $value confirmed. |
|
2782 | - */ |
|
2783 | - public function set_user_address_confirmed( $value ) { |
|
2784 | - $this->set_address_confirmed( $value ); |
|
2785 | - } |
|
2786 | - |
|
2787 | - /** |
|
2788 | - * Alias of self::set_address_confirmed(). |
|
2789 | - * |
|
2790 | - * @since 1.0.19 |
|
2791 | - * @param int|bool $value confirmed. |
|
2792 | - */ |
|
2793 | - public function set_customer_address_confirmed( $value ) { |
|
2794 | - $this->set_address_confirmed( $value ); |
|
2795 | - } |
|
2796 | - |
|
2797 | - /** |
|
2798 | - * Set the invoice sub total. |
|
2799 | - * |
|
2800 | - * @since 1.0.19 |
|
2801 | - * @param float $value sub total. |
|
2802 | - */ |
|
2803 | - public function set_subtotal( $value ) { |
|
2804 | - $this->set_prop( 'subtotal', max( 0, $value ) ); |
|
2805 | - } |
|
2806 | - |
|
2807 | - /** |
|
2808 | - * Set the invoice total. |
|
2809 | - * |
|
2810 | - * @since 1.0.19 |
|
2811 | - * @param float $value sub total. |
|
2812 | - */ |
|
2813 | - public function set_total( $value ) { |
|
2814 | - $this->set_prop( 'total', max( 0, $value ) ); |
|
2815 | - } |
|
2816 | - |
|
2817 | - /** |
|
2818 | - * Set the invoice discount amount. |
|
2819 | - * |
|
2820 | - * @since 1.0.19 |
|
2821 | - * @param float $value discount total. |
|
2822 | - */ |
|
2823 | - public function set_total_discount( $value ) { |
|
2824 | - $this->set_prop( 'total_discount', max( 0, $value ) ); |
|
2817 | + /** |
|
2818 | + * Set the invoice discount amount. |
|
2819 | + * |
|
2820 | + * @since 1.0.19 |
|
2821 | + * @param float $value discount total. |
|
2822 | + */ |
|
2823 | + public function set_total_discount( $value ) { |
|
2824 | + $this->set_prop( 'total_discount', max( 0, $value ) ); |
|
2825 | 2825 | } |
2826 | 2826 | |
2827 | 2827 | /** |
2828 | - * Alias of self::set_total_discount(). |
|
2829 | - * |
|
2830 | - * @since 1.0.19 |
|
2831 | - * @param float $value discount total. |
|
2832 | - */ |
|
2833 | - public function set_discount( $value ) { |
|
2834 | - $this->set_total_discount( $value ); |
|
2828 | + * Alias of self::set_total_discount(). |
|
2829 | + * |
|
2830 | + * @since 1.0.19 |
|
2831 | + * @param float $value discount total. |
|
2832 | + */ |
|
2833 | + public function set_discount( $value ) { |
|
2834 | + $this->set_total_discount( $value ); |
|
2835 | 2835 | } |
2836 | 2836 | |
2837 | 2837 | /** |
2838 | - * Set the invoice tax amount. |
|
2839 | - * |
|
2840 | - * @since 1.0.19 |
|
2841 | - * @param float $value tax total. |
|
2842 | - */ |
|
2843 | - public function set_total_tax( $value ) { |
|
2844 | - $this->set_prop( 'total_tax', max( 0, $value ) ); |
|
2838 | + * Set the invoice tax amount. |
|
2839 | + * |
|
2840 | + * @since 1.0.19 |
|
2841 | + * @param float $value tax total. |
|
2842 | + */ |
|
2843 | + public function set_total_tax( $value ) { |
|
2844 | + $this->set_prop( 'total_tax', max( 0, $value ) ); |
|
2845 | 2845 | } |
2846 | 2846 | |
2847 | 2847 | /** |
2848 | - * Alias of self::set_total_tax(). |
|
2849 | - * |
|
2850 | - * @since 1.0.19 |
|
2851 | - * @param float $value tax total. |
|
2852 | - */ |
|
2853 | - public function set_tax_total( $value ) { |
|
2854 | - $this->set_total_tax( $value ); |
|
2848 | + * Alias of self::set_total_tax(). |
|
2849 | + * |
|
2850 | + * @since 1.0.19 |
|
2851 | + * @param float $value tax total. |
|
2852 | + */ |
|
2853 | + public function set_tax_total( $value ) { |
|
2854 | + $this->set_total_tax( $value ); |
|
2855 | 2855 | } |
2856 | 2856 | |
2857 | 2857 | /** |
2858 | - * Set the invoice fees amount. |
|
2859 | - * |
|
2860 | - * @since 1.0.19 |
|
2861 | - * @param float $value fees total. |
|
2862 | - */ |
|
2863 | - public function set_total_fees( $value ) { |
|
2864 | - $this->set_prop( 'total_fees', max( 0, $value ) ); |
|
2858 | + * Set the invoice fees amount. |
|
2859 | + * |
|
2860 | + * @since 1.0.19 |
|
2861 | + * @param float $value fees total. |
|
2862 | + */ |
|
2863 | + public function set_total_fees( $value ) { |
|
2864 | + $this->set_prop( 'total_fees', max( 0, $value ) ); |
|
2865 | 2865 | } |
2866 | 2866 | |
2867 | 2867 | /** |
2868 | - * Alias of self::set_total_fees(). |
|
2869 | - * |
|
2870 | - * @since 1.0.19 |
|
2871 | - * @param float $value fees total. |
|
2872 | - */ |
|
2873 | - public function set_fees_total( $value ) { |
|
2874 | - $this->set_total_fees( $value ); |
|
2868 | + * Alias of self::set_total_fees(). |
|
2869 | + * |
|
2870 | + * @since 1.0.19 |
|
2871 | + * @param float $value fees total. |
|
2872 | + */ |
|
2873 | + public function set_fees_total( $value ) { |
|
2874 | + $this->set_total_fees( $value ); |
|
2875 | 2875 | } |
2876 | 2876 | |
2877 | 2877 | /** |
2878 | - * Set the invoice fees. |
|
2879 | - * |
|
2880 | - * @since 1.0.19 |
|
2881 | - * @param array $value fees. |
|
2882 | - */ |
|
2883 | - public function set_fees( $value ) { |
|
2878 | + * Set the invoice fees. |
|
2879 | + * |
|
2880 | + * @since 1.0.19 |
|
2881 | + * @param array $value fees. |
|
2882 | + */ |
|
2883 | + public function set_fees( $value ) { |
|
2884 | 2884 | |
2885 | - if ( ! is_array( $value ) ) { |
|
2886 | - $value = array(); |
|
2887 | - } |
|
2885 | + if ( ! is_array( $value ) ) { |
|
2886 | + $value = array(); |
|
2887 | + } |
|
2888 | 2888 | |
2889 | - $this->set_prop( 'fees', $value ); |
|
2889 | + $this->set_prop( 'fees', $value ); |
|
2890 | 2890 | |
2891 | 2891 | } |
2892 | 2892 | |
2893 | 2893 | /** |
2894 | - * Set the invoice taxes. |
|
2895 | - * |
|
2896 | - * @since 1.0.19 |
|
2897 | - * @param array $value taxes. |
|
2898 | - */ |
|
2899 | - public function set_taxes( $value ) { |
|
2894 | + * Set the invoice taxes. |
|
2895 | + * |
|
2896 | + * @since 1.0.19 |
|
2897 | + * @param array $value taxes. |
|
2898 | + */ |
|
2899 | + public function set_taxes( $value ) { |
|
2900 | 2900 | |
2901 | - if ( ! is_array( $value ) ) { |
|
2902 | - $value = array(); |
|
2903 | - } |
|
2901 | + if ( ! is_array( $value ) ) { |
|
2902 | + $value = array(); |
|
2903 | + } |
|
2904 | 2904 | |
2905 | - $this->set_prop( 'taxes', $value ); |
|
2905 | + $this->set_prop( 'taxes', $value ); |
|
2906 | 2906 | |
2907 | 2907 | } |
2908 | 2908 | |
2909 | 2909 | /** |
2910 | - * Set the invoice discounts. |
|
2911 | - * |
|
2912 | - * @since 1.0.19 |
|
2913 | - * @param array $value discounts. |
|
2914 | - */ |
|
2915 | - public function set_discounts( $value ) { |
|
2910 | + * Set the invoice discounts. |
|
2911 | + * |
|
2912 | + * @since 1.0.19 |
|
2913 | + * @param array $value discounts. |
|
2914 | + */ |
|
2915 | + public function set_discounts( $value ) { |
|
2916 | 2916 | |
2917 | - if ( ! is_array( $value ) ) { |
|
2918 | - $value = array(); |
|
2919 | - } |
|
2917 | + if ( ! is_array( $value ) ) { |
|
2918 | + $value = array(); |
|
2919 | + } |
|
2920 | 2920 | |
2921 | - $this->set_prop( 'discounts', $value ); |
|
2921 | + $this->set_prop( 'discounts', $value ); |
|
2922 | 2922 | } |
2923 | 2923 | |
2924 | 2924 | /** |
2925 | - * Set the invoice items. |
|
2926 | - * |
|
2927 | - * @since 1.0.19 |
|
2928 | - * @param GetPaid_Form_Item[] $value items. |
|
2929 | - */ |
|
2930 | - public function set_items( $value ) { |
|
2925 | + * Set the invoice items. |
|
2926 | + * |
|
2927 | + * @since 1.0.19 |
|
2928 | + * @param GetPaid_Form_Item[] $value items. |
|
2929 | + */ |
|
2930 | + public function set_items( $value ) { |
|
2931 | 2931 | |
2932 | 2932 | // Remove existing items. |
2933 | 2933 | $this->set_prop( 'items', array() ); |
2934 | - $this->recurring_item = null; |
|
2934 | + $this->recurring_item = null; |
|
2935 | 2935 | |
2936 | 2936 | // Ensure that we have an array. |
2937 | 2937 | if ( ! is_array( $value ) ) { |
@@ -2945,95 +2945,95 @@ discard block |
||
2945 | 2945 | } |
2946 | 2946 | |
2947 | 2947 | /** |
2948 | - * Set the payment form. |
|
2949 | - * |
|
2950 | - * @since 1.0.19 |
|
2951 | - * @param int $value payment form. |
|
2952 | - */ |
|
2953 | - public function set_payment_form( $value ) { |
|
2954 | - $this->set_prop( 'payment_form', $value ); |
|
2948 | + * Set the payment form. |
|
2949 | + * |
|
2950 | + * @since 1.0.19 |
|
2951 | + * @param int $value payment form. |
|
2952 | + */ |
|
2953 | + public function set_payment_form( $value ) { |
|
2954 | + $this->set_prop( 'payment_form', $value ); |
|
2955 | 2955 | } |
2956 | 2956 | |
2957 | 2957 | /** |
2958 | - * Set the submission id. |
|
2959 | - * |
|
2960 | - * @since 1.0.19 |
|
2961 | - * @param string $value submission id. |
|
2962 | - */ |
|
2963 | - public function set_submission_id( $value ) { |
|
2964 | - $this->set_prop( 'submission_id', $value ); |
|
2958 | + * Set the submission id. |
|
2959 | + * |
|
2960 | + * @since 1.0.19 |
|
2961 | + * @param string $value submission id. |
|
2962 | + */ |
|
2963 | + public function set_submission_id( $value ) { |
|
2964 | + $this->set_prop( 'submission_id', $value ); |
|
2965 | 2965 | } |
2966 | 2966 | |
2967 | 2967 | /** |
2968 | - * Set the discount code. |
|
2969 | - * |
|
2970 | - * @since 1.0.19 |
|
2971 | - * @param string $value discount code. |
|
2972 | - */ |
|
2973 | - public function set_discount_code( $value ) { |
|
2974 | - $this->set_prop( 'discount_code', sanitize_text_field( $value ) ); |
|
2968 | + * Set the discount code. |
|
2969 | + * |
|
2970 | + * @since 1.0.19 |
|
2971 | + * @param string $value discount code. |
|
2972 | + */ |
|
2973 | + public function set_discount_code( $value ) { |
|
2974 | + $this->set_prop( 'discount_code', sanitize_text_field( $value ) ); |
|
2975 | 2975 | } |
2976 | 2976 | |
2977 | 2977 | /** |
2978 | - * Set the gateway. |
|
2979 | - * |
|
2980 | - * @since 1.0.19 |
|
2981 | - * @param string $value gateway. |
|
2982 | - */ |
|
2983 | - public function set_gateway( $value ) { |
|
2984 | - $this->set_prop( 'gateway', $value ); |
|
2978 | + * Set the gateway. |
|
2979 | + * |
|
2980 | + * @since 1.0.19 |
|
2981 | + * @param string $value gateway. |
|
2982 | + */ |
|
2983 | + public function set_gateway( $value ) { |
|
2984 | + $this->set_prop( 'gateway', $value ); |
|
2985 | 2985 | } |
2986 | 2986 | |
2987 | 2987 | /** |
2988 | - * Set the transaction id. |
|
2989 | - * |
|
2990 | - * @since 1.0.19 |
|
2991 | - * @param string $value transaction id. |
|
2992 | - */ |
|
2993 | - public function set_transaction_id( $value ) { |
|
2994 | - if ( ! empty( $value ) ) { |
|
2995 | - $this->set_prop( 'transaction_id', $value ); |
|
2996 | - } |
|
2988 | + * Set the transaction id. |
|
2989 | + * |
|
2990 | + * @since 1.0.19 |
|
2991 | + * @param string $value transaction id. |
|
2992 | + */ |
|
2993 | + public function set_transaction_id( $value ) { |
|
2994 | + if ( ! empty( $value ) ) { |
|
2995 | + $this->set_prop( 'transaction_id', $value ); |
|
2996 | + } |
|
2997 | 2997 | } |
2998 | 2998 | |
2999 | 2999 | /** |
3000 | - * Set the currency id. |
|
3001 | - * |
|
3002 | - * @since 1.0.19 |
|
3003 | - * @param string $value currency id. |
|
3004 | - */ |
|
3005 | - public function set_currency( $value ) { |
|
3006 | - $this->set_prop( 'currency', $value ); |
|
3000 | + * Set the currency id. |
|
3001 | + * |
|
3002 | + * @since 1.0.19 |
|
3003 | + * @param string $value currency id. |
|
3004 | + */ |
|
3005 | + public function set_currency( $value ) { |
|
3006 | + $this->set_prop( 'currency', $value ); |
|
3007 | 3007 | } |
3008 | 3008 | |
3009 | - /** |
|
3010 | - * Set whether to disable taxes. |
|
3011 | - * |
|
3012 | - * @since 1.0.19 |
|
3013 | - * @param bool $value value. |
|
3014 | - */ |
|
3015 | - public function set_disable_taxes( $value ) { |
|
3016 | - $this->set_prop( 'disable_taxes', (bool) $value ); |
|
3017 | - } |
|
3009 | + /** |
|
3010 | + * Set whether to disable taxes. |
|
3011 | + * |
|
3012 | + * @since 1.0.19 |
|
3013 | + * @param bool $value value. |
|
3014 | + */ |
|
3015 | + public function set_disable_taxes( $value ) { |
|
3016 | + $this->set_prop( 'disable_taxes', (bool) $value ); |
|
3017 | + } |
|
3018 | 3018 | |
3019 | 3019 | /** |
3020 | - * Set the subscription id. |
|
3021 | - * |
|
3022 | - * @since 1.0.19 |
|
3023 | - * @param string $value subscription id. |
|
3024 | - */ |
|
3025 | - public function set_subscription_id( $value ) { |
|
3026 | - $this->set_prop( 'subscription_id', $value ); |
|
3027 | - } |
|
3020 | + * Set the subscription id. |
|
3021 | + * |
|
3022 | + * @since 1.0.19 |
|
3023 | + * @param string $value subscription id. |
|
3024 | + */ |
|
3025 | + public function set_subscription_id( $value ) { |
|
3026 | + $this->set_prop( 'subscription_id', $value ); |
|
3027 | + } |
|
3028 | 3028 | |
3029 | - /** |
|
3030 | - * Set the remote subscription id. |
|
3031 | - * |
|
3032 | - * @since 1.0.19 |
|
3033 | - * @param string $value subscription id. |
|
3034 | - */ |
|
3035 | - public function set_remote_subscription_id( $value ) { |
|
3036 | - $this->set_prop( 'remote_subscription_id', $value ); |
|
3029 | + /** |
|
3030 | + * Set the remote subscription id. |
|
3031 | + * |
|
3032 | + * @since 1.0.19 |
|
3033 | + * @param string $value subscription id. |
|
3034 | + */ |
|
3035 | + public function set_remote_subscription_id( $value ) { |
|
3036 | + $this->set_prop( 'remote_subscription_id', $value ); |
|
3037 | 3037 | } |
3038 | 3038 | |
3039 | 3039 | /* |
@@ -3072,24 +3072,24 @@ discard block |
||
3072 | 3072 | */ |
3073 | 3073 | public function is_taxable() { |
3074 | 3074 | return ! $this->get_disable_taxes(); |
3075 | - } |
|
3075 | + } |
|
3076 | 3076 | |
3077 | - /** |
|
3078 | - * @deprecated |
|
3079 | - */ |
|
3080 | - public function has_vat() { |
|
3077 | + /** |
|
3078 | + * @deprecated |
|
3079 | + */ |
|
3080 | + public function has_vat() { |
|
3081 | 3081 | return $this->is_taxable(); |
3082 | - } |
|
3082 | + } |
|
3083 | 3083 | |
3084 | - /** |
|
3085 | - * Checks to see if the invoice requires payment. |
|
3086 | - */ |
|
3087 | - public function is_free() { |
|
3084 | + /** |
|
3085 | + * Checks to see if the invoice requires payment. |
|
3086 | + */ |
|
3087 | + public function is_free() { |
|
3088 | 3088 | $is_free = ( (float) wpinv_round_amount( $this->get_initial_total() ) == 0 ); |
3089 | 3089 | |
3090 | - if ( $this->is_recurring() && $this->get_recurring_total() > 0 ) { |
|
3091 | - $is_free = false; |
|
3092 | - } |
|
3090 | + if ( $this->is_recurring() && $this->get_recurring_total() > 0 ) { |
|
3091 | + $is_free = false; |
|
3092 | + } |
|
3093 | 3093 | |
3094 | 3094 | return apply_filters( 'wpinv_invoice_is_free', $is_free, $this ); |
3095 | 3095 | } |
@@ -3100,46 +3100,46 @@ discard block |
||
3100 | 3100 | public function is_paid() { |
3101 | 3101 | $is_paid = $this->has_status( array( 'publish', 'wpi-processing', 'wpi-renewal' ) ); |
3102 | 3102 | return apply_filters( 'wpinv_invoice_is_paid', $is_paid, $this ); |
3103 | - } |
|
3103 | + } |
|
3104 | 3104 | |
3105 | - /** |
|
3105 | + /** |
|
3106 | 3106 | * Checks if the invoice needs payment. |
3107 | 3107 | */ |
3108 | - public function needs_payment() { |
|
3109 | - $needs_payment = ! $this->is_paid() && ! $this->is_refunded() && ! $this->is_free(); |
|
3108 | + public function needs_payment() { |
|
3109 | + $needs_payment = ! $this->is_paid() && ! $this->is_refunded() && ! $this->is_free(); |
|
3110 | 3110 | return apply_filters( 'wpinv_needs_payment', $needs_payment, $this ); |
3111 | 3111 | } |
3112 | 3112 | |
3113 | - /** |
|
3113 | + /** |
|
3114 | 3114 | * Checks if the invoice is refunded. |
3115 | 3115 | */ |
3116 | - public function is_refunded() { |
|
3116 | + public function is_refunded() { |
|
3117 | 3117 | $is_refunded = $this->has_status( 'wpi-refunded' ); |
3118 | 3118 | return apply_filters( 'wpinv_invoice_is_refunded', $is_refunded, $this ); |
3119 | - } |
|
3119 | + } |
|
3120 | 3120 | |
3121 | - /** |
|
3121 | + /** |
|
3122 | 3122 | * Checks if the invoice is held. |
3123 | 3123 | */ |
3124 | - public function is_held() { |
|
3124 | + public function is_held() { |
|
3125 | 3125 | $is_held = $this->has_status( 'wpi-onhold' ); |
3126 | 3126 | return apply_filters( 'wpinv_invoice_is_held', $is_held, $this ); |
3127 | - } |
|
3127 | + } |
|
3128 | 3128 | |
3129 | - /** |
|
3129 | + /** |
|
3130 | 3130 | * Checks if the invoice is due. |
3131 | 3131 | */ |
3132 | - public function is_due() { |
|
3133 | - $due_date = $this->get_due_date(); |
|
3134 | - return empty( $due_date ) ? false : current_time( 'timestamp' ) > strtotime( $due_date ); |
|
3135 | - } |
|
3132 | + public function is_due() { |
|
3133 | + $due_date = $this->get_due_date(); |
|
3134 | + return empty( $due_date ) ? false : current_time( 'timestamp' ) > strtotime( $due_date ); |
|
3135 | + } |
|
3136 | 3136 | |
3137 | - /** |
|
3137 | + /** |
|
3138 | 3138 | * Checks if the invoice is draft. |
3139 | 3139 | */ |
3140 | - public function is_draft() { |
|
3140 | + public function is_draft() { |
|
3141 | 3141 | return $this->has_status( 'draft, auto-draft' ); |
3142 | - } |
|
3142 | + } |
|
3143 | 3143 | |
3144 | 3144 | /** |
3145 | 3145 | * Checks if the invoice has a given status. |
@@ -3147,9 +3147,9 @@ discard block |
||
3147 | 3147 | public function has_status( $status ) { |
3148 | 3148 | $status = wpinv_parse_list( $status ); |
3149 | 3149 | return apply_filters( 'wpinv_has_status', in_array( $this->get_status(), $status ), $status ); |
3150 | - } |
|
3150 | + } |
|
3151 | 3151 | |
3152 | - /** |
|
3152 | + /** |
|
3153 | 3153 | * Checks if the invoice is of a given type. |
3154 | 3154 | */ |
3155 | 3155 | public function is_type( $type ) { |
@@ -3172,25 +3172,25 @@ discard block |
||
3172 | 3172 | */ |
3173 | 3173 | public function has_free_trial() { |
3174 | 3174 | return $this->is_recurring() && 0 == $this->get_initial_total(); |
3175 | - } |
|
3175 | + } |
|
3176 | 3176 | |
3177 | - /** |
|
3177 | + /** |
|
3178 | 3178 | * @deprecated |
3179 | 3179 | */ |
3180 | 3180 | public function is_free_trial() { |
3181 | 3181 | $this->has_free_trial(); |
3182 | 3182 | } |
3183 | 3183 | |
3184 | - /** |
|
3184 | + /** |
|
3185 | 3185 | * Check if the initial payment if 0. |
3186 | 3186 | * |
3187 | 3187 | */ |
3188 | - public function is_initial_free() { |
|
3188 | + public function is_initial_free() { |
|
3189 | 3189 | $is_initial_free = ! ( (float) wpinv_round_amount( $this->get_initial_total() ) > 0 ); |
3190 | 3190 | return apply_filters( 'wpinv_invoice_is_initial_free', $is_initial_free, $this->get_cart_details(), $this ); |
3191 | 3191 | } |
3192 | 3192 | |
3193 | - /** |
|
3193 | + /** |
|
3194 | 3194 | * Check if the recurring item has a free trial. |
3195 | 3195 | * |
3196 | 3196 | */ |
@@ -3203,21 +3203,21 @@ discard block |
||
3203 | 3203 | |
3204 | 3204 | $item = $this->get_recurring( true ); |
3205 | 3205 | return $item->has_free_trial(); |
3206 | - } |
|
3206 | + } |
|
3207 | 3207 | |
3208 | - /** |
|
3208 | + /** |
|
3209 | 3209 | * Check if the free trial is a result of a discount. |
3210 | 3210 | */ |
3211 | 3211 | public function is_free_trial_from_discount() { |
3212 | - return $this->has_free_trial() && ! $this->item_has_free_trial(); |
|
3213 | - } |
|
3212 | + return $this->has_free_trial() && ! $this->item_has_free_trial(); |
|
3213 | + } |
|
3214 | 3214 | |
3215 | - /** |
|
3215 | + /** |
|
3216 | 3216 | * @deprecated |
3217 | 3217 | */ |
3218 | 3218 | public function discount_first_payment_only() { |
3219 | 3219 | |
3220 | - $discount = wpinv_get_discount_obj( $this->get_discount_code() ); |
|
3220 | + $discount = wpinv_get_discount_obj( $this->get_discount_code() ); |
|
3221 | 3221 | if ( ! $discount->exists() || ! $this->is_recurring() ) { |
3222 | 3222 | return true; |
3223 | 3223 | } |
@@ -3242,147 +3242,147 @@ discard block |
||
3242 | 3242 | */ |
3243 | 3243 | public function add_item( $item ) { |
3244 | 3244 | |
3245 | - if ( is_array( $item ) ) { |
|
3246 | - $item = $this->process_array_item( $item ); |
|
3247 | - } |
|
3245 | + if ( is_array( $item ) ) { |
|
3246 | + $item = $this->process_array_item( $item ); |
|
3247 | + } |
|
3248 | 3248 | |
3249 | - if ( is_numeric( $item ) ) { |
|
3250 | - $item = new GetPaid_Form_Item( $item ); |
|
3251 | - } |
|
3249 | + if ( is_numeric( $item ) ) { |
|
3250 | + $item = new GetPaid_Form_Item( $item ); |
|
3251 | + } |
|
3252 | 3252 | |
3253 | 3253 | // Make sure that it is available for purchase. |
3254 | - if ( $item->get_id() > 0 && ! $item->can_purchase() ) { |
|
3255 | - return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) ); |
|
3254 | + if ( $item->get_id() > 0 && ! $item->can_purchase() ) { |
|
3255 | + return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) ); |
|
3256 | 3256 | } |
3257 | 3257 | |
3258 | 3258 | // Do we have a recurring item? |
3259 | - if ( $item->is_recurring() ) { |
|
3260 | - $this->recurring_item = $item->get_id(); |
|
3259 | + if ( $item->is_recurring() ) { |
|
3260 | + $this->recurring_item = $item->get_id(); |
|
3261 | 3261 | } |
3262 | 3262 | |
3263 | 3263 | // Invoice id. |
3264 | 3264 | $item->invoice_id = (int) $this->get_id(); |
3265 | 3265 | |
3266 | - // Remove duplicates. |
|
3267 | - $this->remove_item( $item->get_id() ); |
|
3266 | + // Remove duplicates. |
|
3267 | + $this->remove_item( $item->get_id() ); |
|
3268 | 3268 | |
3269 | - if ( 0 == $item->get_quantity() ) { |
|
3270 | - return; |
|
3271 | - } |
|
3269 | + if ( 0 == $item->get_quantity() ) { |
|
3270 | + return; |
|
3271 | + } |
|
3272 | 3272 | |
3273 | - // Retrieve all items. |
|
3273 | + // Retrieve all items. |
|
3274 | 3274 | $items = $this->get_items(); |
3275 | 3275 | |
3276 | - // Add new item. |
|
3276 | + // Add new item. |
|
3277 | 3277 | $items[] = $item; |
3278 | 3278 | |
3279 | 3279 | $this->set_prop( 'items', $items ); |
3280 | 3280 | |
3281 | - return true; |
|
3282 | - } |
|
3281 | + return true; |
|
3282 | + } |
|
3283 | 3283 | |
3284 | - /** |
|
3285 | - * Converts an array to an item. |
|
3286 | - * |
|
3287 | - * @since 1.0.19 |
|
3288 | - * @return GetPaid_Form_Item |
|
3289 | - */ |
|
3290 | - protected function process_array_item( $array ) { |
|
3284 | + /** |
|
3285 | + * Converts an array to an item. |
|
3286 | + * |
|
3287 | + * @since 1.0.19 |
|
3288 | + * @return GetPaid_Form_Item |
|
3289 | + */ |
|
3290 | + protected function process_array_item( $array ) { |
|
3291 | 3291 | |
3292 | - $item_id = isset( $array['item_id'] ) ? $array['item_id'] : 0; |
|
3293 | - $item = new GetPaid_Form_Item( $item_id ); |
|
3292 | + $item_id = isset( $array['item_id'] ) ? $array['item_id'] : 0; |
|
3293 | + $item = new GetPaid_Form_Item( $item_id ); |
|
3294 | 3294 | |
3295 | - // Set item data. |
|
3296 | - foreach ( array( 'name', 'price', 'description' ) as $key ) { |
|
3297 | - if ( isset( $array[ "item_$key" ] ) ) { |
|
3298 | - $method = "set_$key"; |
|
3299 | - $item->$method( $array[ "item_$key" ] ); |
|
3300 | - } |
|
3301 | - } |
|
3295 | + // Set item data. |
|
3296 | + foreach ( array( 'name', 'price', 'description' ) as $key ) { |
|
3297 | + if ( isset( $array[ "item_$key" ] ) ) { |
|
3298 | + $method = "set_$key"; |
|
3299 | + $item->$method( $array[ "item_$key" ] ); |
|
3300 | + } |
|
3301 | + } |
|
3302 | 3302 | |
3303 | - if ( isset( $array['quantity'] ) ) { |
|
3304 | - $item->set_quantity( $array['quantity'] ); |
|
3305 | - } |
|
3303 | + if ( isset( $array['quantity'] ) ) { |
|
3304 | + $item->set_quantity( $array['quantity'] ); |
|
3305 | + } |
|
3306 | 3306 | |
3307 | - // Set item meta. |
|
3308 | - if ( isset( $array['meta'] ) && is_array( $array['meta'] ) ) { |
|
3309 | - $item->set_item_meta( $array['meta'] ); |
|
3310 | - } |
|
3307 | + // Set item meta. |
|
3308 | + if ( isset( $array['meta'] ) && is_array( $array['meta'] ) ) { |
|
3309 | + $item->set_item_meta( $array['meta'] ); |
|
3310 | + } |
|
3311 | 3311 | |
3312 | - return $item; |
|
3312 | + return $item; |
|
3313 | 3313 | |
3314 | - } |
|
3314 | + } |
|
3315 | 3315 | |
3316 | 3316 | /** |
3317 | - * Retrieves a specific item. |
|
3318 | - * |
|
3319 | - * @since 1.0.19 |
|
3320 | - * @return GetPaid_Form_Item|null |
|
3321 | - */ |
|
3322 | - public function get_item( $item_id ) { |
|
3317 | + * Retrieves a specific item. |
|
3318 | + * |
|
3319 | + * @since 1.0.19 |
|
3320 | + * @return GetPaid_Form_Item|null |
|
3321 | + */ |
|
3322 | + public function get_item( $item_id ) { |
|
3323 | 3323 | |
3324 | - foreach ( $this->get_items() as $item ) { |
|
3325 | - if ( (int) $item_id == $item->get_id() ) { |
|
3326 | - return $item; |
|
3327 | - } |
|
3328 | - } |
|
3324 | + foreach ( $this->get_items() as $item ) { |
|
3325 | + if ( (int) $item_id == $item->get_id() ) { |
|
3326 | + return $item; |
|
3327 | + } |
|
3328 | + } |
|
3329 | 3329 | |
3330 | - return null; |
|
3330 | + return null; |
|
3331 | 3331 | } |
3332 | 3332 | |
3333 | 3333 | /** |
3334 | - * Removes a specific item. |
|
3335 | - * |
|
3336 | - * @since 1.0.19 |
|
3337 | - */ |
|
3338 | - public function remove_item( $item_id ) { |
|
3339 | - $items = $this->get_items(); |
|
3340 | - $item_id = (int) $item_id; |
|
3334 | + * Removes a specific item. |
|
3335 | + * |
|
3336 | + * @since 1.0.19 |
|
3337 | + */ |
|
3338 | + public function remove_item( $item_id ) { |
|
3339 | + $items = $this->get_items(); |
|
3340 | + $item_id = (int) $item_id; |
|
3341 | 3341 | |
3342 | - foreach ( $items as $index => $item ) { |
|
3343 | - if ( (int) $item_id == $item->get_id() ) { |
|
3344 | - unset( $items[ $index ] ); |
|
3345 | - $this->set_prop( 'items', $items ); |
|
3342 | + foreach ( $items as $index => $item ) { |
|
3343 | + if ( (int) $item_id == $item->get_id() ) { |
|
3344 | + unset( $items[ $index ] ); |
|
3345 | + $this->set_prop( 'items', $items ); |
|
3346 | 3346 | |
3347 | - if ( $item_id == $this->recurring_item ) { |
|
3348 | - $this->recurring_item = null; |
|
3349 | - } |
|
3347 | + if ( $item_id == $this->recurring_item ) { |
|
3348 | + $this->recurring_item = null; |
|
3349 | + } |
|
3350 | 3350 | |
3351 | - } |
|
3352 | - } |
|
3351 | + } |
|
3352 | + } |
|
3353 | 3353 | |
3354 | 3354 | } |
3355 | 3355 | |
3356 | 3356 | /** |
3357 | - * Adds a fee to the invoice. |
|
3358 | - * |
|
3359 | - * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
3360 | - * @since 1.0.19 |
|
3361 | - */ |
|
3357 | + * Adds a fee to the invoice. |
|
3358 | + * |
|
3359 | + * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
3360 | + * @since 1.0.19 |
|
3361 | + */ |
|
3362 | 3362 | public function add_fee( $fee ) { |
3363 | 3363 | |
3364 | - $fees = $this->get_fees(); |
|
3365 | - $fees[ $fee['name'] ] = $fee; |
|
3366 | - $this->set_prop( 'fees', $fees ); |
|
3364 | + $fees = $this->get_fees(); |
|
3365 | + $fees[ $fee['name'] ] = $fee; |
|
3366 | + $this->set_prop( 'fees', $fees ); |
|
3367 | 3367 | |
3368 | 3368 | } |
3369 | 3369 | |
3370 | 3370 | /** |
3371 | - * Retrieves a specific fee. |
|
3372 | - * |
|
3373 | - * @since 1.0.19 |
|
3374 | - */ |
|
3375 | - public function get_fee( $fee ) { |
|
3371 | + * Retrieves a specific fee. |
|
3372 | + * |
|
3373 | + * @since 1.0.19 |
|
3374 | + */ |
|
3375 | + public function get_fee( $fee ) { |
|
3376 | 3376 | $fees = $this->get_fees(); |
3377 | - return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null; |
|
3377 | + return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null; |
|
3378 | 3378 | } |
3379 | 3379 | |
3380 | 3380 | /** |
3381 | - * Removes a specific fee. |
|
3382 | - * |
|
3383 | - * @since 1.0.19 |
|
3384 | - */ |
|
3385 | - public function remove_fee( $fee ) { |
|
3381 | + * Removes a specific fee. |
|
3382 | + * |
|
3383 | + * @since 1.0.19 |
|
3384 | + */ |
|
3385 | + public function remove_fee( $fee ) { |
|
3386 | 3386 | $fees = $this->get_fees(); |
3387 | 3387 | if ( isset( $fees[ $fee ] ) ) { |
3388 | 3388 | unset( $fees[ $fee ] ); |
@@ -3390,55 +3390,55 @@ discard block |
||
3390 | 3390 | } |
3391 | 3391 | } |
3392 | 3392 | |
3393 | - /** |
|
3394 | - * Adds a discount to the invoice. |
|
3395 | - * |
|
3396 | - * @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. |
|
3397 | - * @since 1.0.19 |
|
3398 | - */ |
|
3399 | - public function add_discount( $discount ) { |
|
3393 | + /** |
|
3394 | + * Adds a discount to the invoice. |
|
3395 | + * |
|
3396 | + * @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. |
|
3397 | + * @since 1.0.19 |
|
3398 | + */ |
|
3399 | + public function add_discount( $discount ) { |
|
3400 | 3400 | |
3401 | - $discounts = $this->get_discounts(); |
|
3402 | - $discounts[ $discount['name'] ] = $discount; |
|
3403 | - $this->set_prop( 'discounts', $discounts ); |
|
3401 | + $discounts = $this->get_discounts(); |
|
3402 | + $discounts[ $discount['name'] ] = $discount; |
|
3403 | + $this->set_prop( 'discounts', $discounts ); |
|
3404 | 3404 | |
3405 | - } |
|
3405 | + } |
|
3406 | 3406 | |
3407 | 3407 | /** |
3408 | - * Retrieves a specific discount. |
|
3409 | - * |
|
3410 | - * @since 1.0.19 |
|
3411 | - * @return float |
|
3412 | - */ |
|
3413 | - public function get_discount( $discount = false ) { |
|
3408 | + * Retrieves a specific discount. |
|
3409 | + * |
|
3410 | + * @since 1.0.19 |
|
3411 | + * @return float |
|
3412 | + */ |
|
3413 | + public function get_discount( $discount = false ) { |
|
3414 | 3414 | |
3415 | - // Backwards compatibilty. |
|
3416 | - if ( empty( $discount ) ) { |
|
3417 | - return $this->get_total_discount(); |
|
3418 | - } |
|
3415 | + // Backwards compatibilty. |
|
3416 | + if ( empty( $discount ) ) { |
|
3417 | + return $this->get_total_discount(); |
|
3418 | + } |
|
3419 | 3419 | |
3420 | 3420 | $discounts = $this->get_discounts(); |
3421 | - return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null; |
|
3421 | + return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null; |
|
3422 | 3422 | } |
3423 | 3423 | |
3424 | 3424 | /** |
3425 | - * Removes a specific discount. |
|
3426 | - * |
|
3427 | - * @since 1.0.19 |
|
3428 | - */ |
|
3429 | - public function remove_discount( $discount ) { |
|
3425 | + * Removes a specific discount. |
|
3426 | + * |
|
3427 | + * @since 1.0.19 |
|
3428 | + */ |
|
3429 | + public function remove_discount( $discount ) { |
|
3430 | 3430 | $discounts = $this->get_discounts(); |
3431 | 3431 | if ( isset( $discounts[ $discount ] ) ) { |
3432 | 3432 | unset( $discounts[ $discount ] ); |
3433 | 3433 | $this->set_prop( 'discounts', $discounts ); |
3434 | 3434 | } |
3435 | 3435 | |
3436 | - if ( 'discount_code' == $discount ) { |
|
3437 | - foreach ( $this->get_items() as $item ) { |
|
3438 | - $item->item_discount = 0; |
|
3439 | - $item->recurring_item_discount = 0; |
|
3440 | - } |
|
3441 | - } |
|
3436 | + if ( 'discount_code' == $discount ) { |
|
3437 | + foreach ( $this->get_items() as $item ) { |
|
3438 | + $item->item_discount = 0; |
|
3439 | + $item->recurring_item_discount = 0; |
|
3440 | + } |
|
3441 | + } |
|
3442 | 3442 | |
3443 | 3443 | } |
3444 | 3444 | |
@@ -3451,34 +3451,34 @@ discard block |
||
3451 | 3451 | if ( $this->is_taxable() ) { |
3452 | 3452 | |
3453 | 3453 | $taxes = $this->get_taxes(); |
3454 | - $taxes[ $tax['name'] ] = $tax; |
|
3455 | - $this->set_prop( 'taxes', $tax ); |
|
3454 | + $taxes[ $tax['name'] ] = $tax; |
|
3455 | + $this->set_prop( 'taxes', $tax ); |
|
3456 | 3456 | |
3457 | 3457 | } |
3458 | 3458 | } |
3459 | 3459 | |
3460 | 3460 | /** |
3461 | - * Retrieves a specific tax. |
|
3462 | - * |
|
3463 | - * @since 1.0.19 |
|
3464 | - */ |
|
3465 | - public function get_tax( $tax = null ) { |
|
3461 | + * Retrieves a specific tax. |
|
3462 | + * |
|
3463 | + * @since 1.0.19 |
|
3464 | + */ |
|
3465 | + public function get_tax( $tax = null ) { |
|
3466 | 3466 | |
3467 | - // Backwards compatility. |
|
3468 | - if ( empty( $tax ) ) { |
|
3469 | - return $this->get_total_tax(); |
|
3470 | - } |
|
3467 | + // Backwards compatility. |
|
3468 | + if ( empty( $tax ) ) { |
|
3469 | + return $this->get_total_tax(); |
|
3470 | + } |
|
3471 | 3471 | |
3472 | 3472 | $taxes = $this->get_taxes(); |
3473 | - return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null; |
|
3473 | + return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null; |
|
3474 | 3474 | } |
3475 | 3475 | |
3476 | 3476 | /** |
3477 | - * Removes a specific tax. |
|
3478 | - * |
|
3479 | - * @since 1.0.19 |
|
3480 | - */ |
|
3481 | - public function remove_tax( $tax ) { |
|
3477 | + * Removes a specific tax. |
|
3478 | + * |
|
3479 | + * @since 1.0.19 |
|
3480 | + */ |
|
3481 | + public function remove_tax( $tax ) { |
|
3482 | 3482 | $taxes = $this->get_taxes(); |
3483 | 3483 | if ( isset( $taxes[ $tax ] ) ) { |
3484 | 3484 | unset( $taxes[ $tax ] ); |
@@ -3487,185 +3487,185 @@ discard block |
||
3487 | 3487 | } |
3488 | 3488 | |
3489 | 3489 | /** |
3490 | - * Recalculates the invoice subtotal. |
|
3491 | - * |
|
3492 | - * @since 1.0.19 |
|
3493 | - * @return float The recalculated subtotal |
|
3494 | - */ |
|
3495 | - public function recalculate_subtotal() { |
|
3490 | + * Recalculates the invoice subtotal. |
|
3491 | + * |
|
3492 | + * @since 1.0.19 |
|
3493 | + * @return float The recalculated subtotal |
|
3494 | + */ |
|
3495 | + public function recalculate_subtotal() { |
|
3496 | 3496 | $items = $this->get_items(); |
3497 | - $subtotal = 0; |
|
3498 | - $recurring = 0; |
|
3497 | + $subtotal = 0; |
|
3498 | + $recurring = 0; |
|
3499 | 3499 | |
3500 | 3500 | foreach ( $items as $item ) { |
3501 | - $subtotal += $item->get_sub_total(); |
|
3502 | - $recurring += $item->get_recurring_sub_total(); |
|
3501 | + $subtotal += $item->get_sub_total(); |
|
3502 | + $recurring += $item->get_recurring_sub_total(); |
|
3503 | 3503 | } |
3504 | 3504 | |
3505 | - if ( wpinv_prices_include_tax() ) { |
|
3506 | - $subtotal = max( 0, $subtotal - $this->totals['tax']['initial'] ); |
|
3507 | - $recurring = max( 0, $recurring - $this->totals['tax']['recurring'] ); |
|
3508 | - } |
|
3505 | + if ( wpinv_prices_include_tax() ) { |
|
3506 | + $subtotal = max( 0, $subtotal - $this->totals['tax']['initial'] ); |
|
3507 | + $recurring = max( 0, $recurring - $this->totals['tax']['recurring'] ); |
|
3508 | + } |
|
3509 | 3509 | |
3510 | - $current = $this->is_renewal() ? $recurring : $subtotal; |
|
3511 | - $this->set_subtotal( $current ); |
|
3510 | + $current = $this->is_renewal() ? $recurring : $subtotal; |
|
3511 | + $this->set_subtotal( $current ); |
|
3512 | 3512 | |
3513 | - $this->totals['subtotal'] = array( |
|
3514 | - 'initial' => $subtotal, |
|
3515 | - 'recurring' => $recurring, |
|
3516 | - ); |
|
3513 | + $this->totals['subtotal'] = array( |
|
3514 | + 'initial' => $subtotal, |
|
3515 | + 'recurring' => $recurring, |
|
3516 | + ); |
|
3517 | 3517 | |
3518 | 3518 | return $current; |
3519 | 3519 | } |
3520 | 3520 | |
3521 | 3521 | /** |
3522 | - * Recalculates the invoice discount total. |
|
3523 | - * |
|
3524 | - * @since 1.0.19 |
|
3525 | - * @return float The recalculated discount |
|
3526 | - */ |
|
3527 | - public function recalculate_total_discount() { |
|
3522 | + * Recalculates the invoice discount total. |
|
3523 | + * |
|
3524 | + * @since 1.0.19 |
|
3525 | + * @return float The recalculated discount |
|
3526 | + */ |
|
3527 | + public function recalculate_total_discount() { |
|
3528 | 3528 | $discounts = $this->get_discounts(); |
3529 | - $discount = 0; |
|
3530 | - $recurring = 0; |
|
3529 | + $discount = 0; |
|
3530 | + $recurring = 0; |
|
3531 | 3531 | |
3532 | 3532 | foreach ( $discounts as $data ) { |
3533 | - $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
3534 | - $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
3535 | - } |
|
3533 | + $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
3534 | + $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
3535 | + } |
|
3536 | 3536 | |
3537 | - $current = $this->is_renewal() ? $recurring : $discount; |
|
3537 | + $current = $this->is_renewal() ? $recurring : $discount; |
|
3538 | 3538 | |
3539 | - $this->set_total_discount( $current ); |
|
3539 | + $this->set_total_discount( $current ); |
|
3540 | 3540 | |
3541 | - $this->totals['discount'] = array( |
|
3542 | - 'initial' => $discount, |
|
3543 | - 'recurring' => $recurring, |
|
3544 | - ); |
|
3541 | + $this->totals['discount'] = array( |
|
3542 | + 'initial' => $discount, |
|
3543 | + 'recurring' => $recurring, |
|
3544 | + ); |
|
3545 | 3545 | |
3546 | - return $current; |
|
3546 | + return $current; |
|
3547 | 3547 | |
3548 | 3548 | } |
3549 | 3549 | |
3550 | 3550 | /** |
3551 | - * Recalculates the invoice tax total. |
|
3552 | - * |
|
3553 | - * @since 1.0.19 |
|
3554 | - * @return float The recalculated tax |
|
3555 | - */ |
|
3556 | - public function recalculate_total_tax() { |
|
3551 | + * Recalculates the invoice tax total. |
|
3552 | + * |
|
3553 | + * @since 1.0.19 |
|
3554 | + * @return float The recalculated tax |
|
3555 | + */ |
|
3556 | + public function recalculate_total_tax() { |
|
3557 | 3557 | |
3558 | - // Maybe disable taxes. |
|
3559 | - $vat_number = $this->get_vat_number(); |
|
3560 | - $skip_tax = GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $this->get_country() ) && ! empty( $vat_number ); |
|
3558 | + // Maybe disable taxes. |
|
3559 | + $vat_number = $this->get_vat_number(); |
|
3560 | + $skip_tax = GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $this->get_country() ) && ! empty( $vat_number ); |
|
3561 | 3561 | |
3562 | - if ( wpinv_is_base_country( $this->get_country() ) && 'vat_too' == wpinv_get_option( 'vat_same_country_rule', 'vat_too' ) ) { |
|
3563 | - $skip_tax = false; |
|
3564 | - } |
|
3562 | + if ( wpinv_is_base_country( $this->get_country() ) && 'vat_too' == wpinv_get_option( 'vat_same_country_rule', 'vat_too' ) ) { |
|
3563 | + $skip_tax = false; |
|
3564 | + } |
|
3565 | 3565 | |
3566 | - if ( ! wpinv_use_taxes() || $this->get_disable_taxes() || ! wpinv_is_country_taxable( $this->get_country() ) || $skip_tax ) { |
|
3566 | + if ( ! wpinv_use_taxes() || $this->get_disable_taxes() || ! wpinv_is_country_taxable( $this->get_country() ) || $skip_tax ) { |
|
3567 | 3567 | |
3568 | - $this->totals['tax'] = array( |
|
3569 | - 'initial' => 0, |
|
3570 | - 'recurring' => 0, |
|
3571 | - ); |
|
3568 | + $this->totals['tax'] = array( |
|
3569 | + 'initial' => 0, |
|
3570 | + 'recurring' => 0, |
|
3571 | + ); |
|
3572 | 3572 | |
3573 | - $this->tax_rate = 0; |
|
3573 | + $this->tax_rate = 0; |
|
3574 | 3574 | |
3575 | - $this->set_taxes( array() ); |
|
3576 | - $current = 0; |
|
3577 | - } else { |
|
3575 | + $this->set_taxes( array() ); |
|
3576 | + $current = 0; |
|
3577 | + } else { |
|
3578 | 3578 | |
3579 | - $item_taxes = array(); |
|
3579 | + $item_taxes = array(); |
|
3580 | 3580 | |
3581 | - foreach ( $this->get_items() as $item ) { |
|
3582 | - $rates = getpaid_get_item_tax_rates( $item, $this->get_country(), $this->get_state() ); |
|
3583 | - $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
3584 | - $taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, false ), $rates ); |
|
3585 | - $r_taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, true ), $rates ); |
|
3586 | - foreach ( $taxes as $name => $amount ) { |
|
3587 | - $recurring = isset( $r_taxes[ $name ] ) ? $r_taxes[ $name ] : 0; |
|
3588 | - $tax = getpaid_prepare_item_tax( $item, $name, $amount, $recurring ); |
|
3581 | + foreach ( $this->get_items() as $item ) { |
|
3582 | + $rates = getpaid_get_item_tax_rates( $item, $this->get_country(), $this->get_state() ); |
|
3583 | + $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
3584 | + $taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, false ), $rates ); |
|
3585 | + $r_taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, true ), $rates ); |
|
3586 | + foreach ( $taxes as $name => $amount ) { |
|
3587 | + $recurring = isset( $r_taxes[ $name ] ) ? $r_taxes[ $name ] : 0; |
|
3588 | + $tax = getpaid_prepare_item_tax( $item, $name, $amount, $recurring ); |
|
3589 | 3589 | |
3590 | - if ( ! isset( $item_taxes[ $name ] ) ) { |
|
3591 | - $item_taxes[ $name ] = $tax; |
|
3592 | - continue; |
|
3593 | - } |
|
3590 | + if ( ! isset( $item_taxes[ $name ] ) ) { |
|
3591 | + $item_taxes[ $name ] = $tax; |
|
3592 | + continue; |
|
3593 | + } |
|
3594 | 3594 | |
3595 | - $item_taxes[ $name ]['initial_tax'] += $tax['initial_tax']; |
|
3596 | - $item_taxes[ $name ]['recurring_tax'] += $tax['recurring_tax']; |
|
3595 | + $item_taxes[ $name ]['initial_tax'] += $tax['initial_tax']; |
|
3596 | + $item_taxes[ $name ]['recurring_tax'] += $tax['recurring_tax']; |
|
3597 | 3597 | |
3598 | - } |
|
3598 | + } |
|
3599 | 3599 | |
3600 | - } |
|
3600 | + } |
|
3601 | 3601 | |
3602 | - $item_taxes = array_replace( $this->get_taxes(), $item_taxes ); |
|
3603 | - $this->set_taxes( $item_taxes ); |
|
3602 | + $item_taxes = array_replace( $this->get_taxes(), $item_taxes ); |
|
3603 | + $this->set_taxes( $item_taxes ); |
|
3604 | 3604 | |
3605 | - $initial_tax = array_sum( wp_list_pluck( $item_taxes, 'initial_tax' ) ); |
|
3606 | - $recurring_tax = array_sum( wp_list_pluck( $item_taxes, 'recurring_tax' ) ); |
|
3605 | + $initial_tax = array_sum( wp_list_pluck( $item_taxes, 'initial_tax' ) ); |
|
3606 | + $recurring_tax = array_sum( wp_list_pluck( $item_taxes, 'recurring_tax' ) ); |
|
3607 | 3607 | |
3608 | - $current = $this->is_renewal() ? $recurring_tax : $initial_tax; |
|
3608 | + $current = $this->is_renewal() ? $recurring_tax : $initial_tax; |
|
3609 | 3609 | |
3610 | - $this->totals['tax'] = array( |
|
3611 | - 'initial' => $initial_tax, |
|
3612 | - 'recurring' => $recurring_tax, |
|
3613 | - ); |
|
3610 | + $this->totals['tax'] = array( |
|
3611 | + 'initial' => $initial_tax, |
|
3612 | + 'recurring' => $recurring_tax, |
|
3613 | + ); |
|
3614 | 3614 | |
3615 | - } |
|
3615 | + } |
|
3616 | 3616 | |
3617 | - $this->set_total_tax( $current ); |
|
3617 | + $this->set_total_tax( $current ); |
|
3618 | 3618 | |
3619 | - return $current; |
|
3619 | + return $current; |
|
3620 | 3620 | |
3621 | 3621 | } |
3622 | 3622 | |
3623 | 3623 | /** |
3624 | - * Recalculates the invoice fees total. |
|
3625 | - * |
|
3626 | - * @since 1.0.19 |
|
3627 | - * @return float The recalculated fee |
|
3628 | - */ |
|
3629 | - public function recalculate_total_fees() { |
|
3630 | - $fees = $this->get_fees(); |
|
3631 | - $fee = 0; |
|
3632 | - $recurring = 0; |
|
3624 | + * Recalculates the invoice fees total. |
|
3625 | + * |
|
3626 | + * @since 1.0.19 |
|
3627 | + * @return float The recalculated fee |
|
3628 | + */ |
|
3629 | + public function recalculate_total_fees() { |
|
3630 | + $fees = $this->get_fees(); |
|
3631 | + $fee = 0; |
|
3632 | + $recurring = 0; |
|
3633 | 3633 | |
3634 | 3634 | foreach ( $fees as $data ) { |
3635 | - $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
3636 | - $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
3637 | - } |
|
3635 | + $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
3636 | + $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
3637 | + } |
|
3638 | 3638 | |
3639 | - $current = $this->is_renewal() ? $recurring : $fee; |
|
3640 | - $this->set_total_fees( $current ); |
|
3639 | + $current = $this->is_renewal() ? $recurring : $fee; |
|
3640 | + $this->set_total_fees( $current ); |
|
3641 | 3641 | |
3642 | - $this->totals['fee'] = array( |
|
3643 | - 'initial' => $fee, |
|
3644 | - 'recurring' => $recurring, |
|
3645 | - ); |
|
3642 | + $this->totals['fee'] = array( |
|
3643 | + 'initial' => $fee, |
|
3644 | + 'recurring' => $recurring, |
|
3645 | + ); |
|
3646 | 3646 | |
3647 | 3647 | $this->set_total_fees( $fee ); |
3648 | 3648 | return $current; |
3649 | 3649 | } |
3650 | 3650 | |
3651 | 3651 | /** |
3652 | - * Recalculates the invoice total. |
|
3653 | - * |
|
3654 | - * @since 1.0.19 |
|
3652 | + * Recalculates the invoice total. |
|
3653 | + * |
|
3654 | + * @since 1.0.19 |
|
3655 | 3655 | * @return float The invoice total |
3656 | - */ |
|
3657 | - public function recalculate_total() { |
|
3656 | + */ |
|
3657 | + public function recalculate_total() { |
|
3658 | 3658 | $this->recalculate_total_fees(); |
3659 | 3659 | $this->recalculate_total_discount(); |
3660 | - $this->recalculate_total_tax(); |
|
3661 | - $this->recalculate_subtotal(); |
|
3662 | - $this->set_total( $this->get_total_tax() + $this->get_total_fees() + $this->get_subtotal() - $this->get_total_discount() ); |
|
3663 | - return $this->get_total(); |
|
3664 | - } |
|
3665 | - |
|
3666 | - /** |
|
3667 | - * @deprecated |
|
3668 | - */ |
|
3660 | + $this->recalculate_total_tax(); |
|
3661 | + $this->recalculate_subtotal(); |
|
3662 | + $this->set_total( $this->get_total_tax() + $this->get_total_fees() + $this->get_subtotal() - $this->get_total_discount() ); |
|
3663 | + return $this->get_total(); |
|
3664 | + } |
|
3665 | + |
|
3666 | + /** |
|
3667 | + * @deprecated |
|
3668 | + */ |
|
3669 | 3669 | public function recalculate_totals() { |
3670 | 3670 | $this->recalculate_total(); |
3671 | 3671 | $this->save( true ); |
@@ -3679,22 +3679,22 @@ discard block |
||
3679 | 3679 | return $this->get_data(); |
3680 | 3680 | } |
3681 | 3681 | |
3682 | - /** |
|
3682 | + /** |
|
3683 | 3683 | * Adds a system note to an invoice. |
3684 | 3684 | * |
3685 | 3685 | * @param string $note The note being added. |
3686 | - * @return int|false The new note's ID on success, false on failure. |
|
3686 | + * @return int|false The new note's ID on success, false on failure. |
|
3687 | 3687 | * |
3688 | 3688 | */ |
3689 | 3689 | public function add_system_note( $note ) { |
3690 | - return $this->add_note( $note, false, false, true ); |
|
3691 | - } |
|
3690 | + return $this->add_note( $note, false, false, true ); |
|
3691 | + } |
|
3692 | 3692 | |
3693 | 3693 | /** |
3694 | 3694 | * Adds a note to an invoice. |
3695 | 3695 | * |
3696 | 3696 | * @param string $note The note being added. |
3697 | - * @return int|false The new note's ID on success, false on failure. |
|
3697 | + * @return int|false The new note's ID on success, false on failure. |
|
3698 | 3698 | * |
3699 | 3699 | */ |
3700 | 3700 | public function add_note( $note = '', $customer_type = false, $added_by_user = false, $system = false ) { |
@@ -3704,21 +3704,21 @@ discard block |
||
3704 | 3704 | return false; |
3705 | 3705 | } |
3706 | 3706 | |
3707 | - $author = 'System'; |
|
3708 | - $author_email = '[email protected]'; |
|
3707 | + $author = 'System'; |
|
3708 | + $author_email = '[email protected]'; |
|
3709 | 3709 | |
3710 | - // If this is an admin comment or it has been added by the user. |
|
3711 | - if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
3712 | - $user = get_user_by( 'id', get_current_user_id() ); |
|
3710 | + // If this is an admin comment or it has been added by the user. |
|
3711 | + if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
3712 | + $user = get_user_by( 'id', get_current_user_id() ); |
|
3713 | 3713 | $author = $user->display_name; |
3714 | 3714 | $author_email = $user->user_email; |
3715 | - } |
|
3715 | + } |
|
3716 | 3716 | |
3717 | - return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
3717 | + return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
3718 | 3718 | |
3719 | - } |
|
3719 | + } |
|
3720 | 3720 | |
3721 | - /** |
|
3721 | + /** |
|
3722 | 3722 | * Generates a unique key for the invoice. |
3723 | 3723 | */ |
3724 | 3724 | public function generate_key( $string = '' ) { |
@@ -3738,113 +3738,113 @@ discard block |
||
3738 | 3738 | $number = wpinv_get_next_invoice_number( $this->get_post_type() ); |
3739 | 3739 | } |
3740 | 3740 | |
3741 | - return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
3742 | - |
|
3743 | - } |
|
3744 | - |
|
3745 | - /** |
|
3746 | - * Handle the status transition. |
|
3747 | - */ |
|
3748 | - protected function status_transition() { |
|
3749 | - $status_transition = $this->status_transition; |
|
3750 | - |
|
3751 | - // Reset status transition variable. |
|
3752 | - $this->status_transition = false; |
|
3741 | + return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
3753 | 3742 | |
3754 | - if ( $status_transition ) { |
|
3755 | - try { |
|
3756 | - |
|
3757 | - // Fire a hook for the status change. |
|
3758 | - do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
3759 | - |
|
3760 | - // @deprecated this is deprecated and will be removed in the future. |
|
3761 | - do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3762 | - |
|
3763 | - if ( ! empty( $status_transition['from'] ) ) { |
|
3764 | - |
|
3765 | - /* translators: 1: old invoice status 2: new invoice status */ |
|
3766 | - $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 ) ); |
|
3767 | - |
|
3768 | - // Fire another hook. |
|
3769 | - do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
3770 | - do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
3771 | - |
|
3772 | - // @deprecated this is deprecated and will be removed in the future. |
|
3773 | - do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3774 | - |
|
3775 | - // Note the transition occurred. |
|
3776 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), false, $status_transition['manual'] ); |
|
3777 | - |
|
3778 | - // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
3779 | - if ( |
|
3780 | - in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3781 | - && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3782 | - ) { |
|
3783 | - do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
3784 | - } |
|
3785 | - |
|
3786 | - // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
3787 | - if ( |
|
3788 | - in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3789 | - && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3790 | - ) { |
|
3791 | - do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
3792 | - } |
|
3793 | - } else { |
|
3794 | - /* translators: %s: new invoice status */ |
|
3795 | - $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
3796 | - |
|
3797 | - // Note the transition occurred. |
|
3798 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
3743 | + } |
|
3799 | 3744 | |
3800 | - } |
|
3801 | - } catch ( Exception $e ) { |
|
3802 | - $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
3803 | - } |
|
3804 | - } |
|
3805 | - } |
|
3745 | + /** |
|
3746 | + * Handle the status transition. |
|
3747 | + */ |
|
3748 | + protected function status_transition() { |
|
3749 | + $status_transition = $this->status_transition; |
|
3750 | + |
|
3751 | + // Reset status transition variable. |
|
3752 | + $this->status_transition = false; |
|
3753 | + |
|
3754 | + if ( $status_transition ) { |
|
3755 | + try { |
|
3756 | + |
|
3757 | + // Fire a hook for the status change. |
|
3758 | + do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
3759 | + |
|
3760 | + // @deprecated this is deprecated and will be removed in the future. |
|
3761 | + do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3762 | + |
|
3763 | + if ( ! empty( $status_transition['from'] ) ) { |
|
3764 | + |
|
3765 | + /* translators: 1: old invoice status 2: new invoice status */ |
|
3766 | + $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 ) ); |
|
3767 | + |
|
3768 | + // Fire another hook. |
|
3769 | + do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
3770 | + do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
3771 | + |
|
3772 | + // @deprecated this is deprecated and will be removed in the future. |
|
3773 | + do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3774 | + |
|
3775 | + // Note the transition occurred. |
|
3776 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), false, $status_transition['manual'] ); |
|
3777 | + |
|
3778 | + // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
3779 | + if ( |
|
3780 | + in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3781 | + && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3782 | + ) { |
|
3783 | + do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
3784 | + } |
|
3785 | + |
|
3786 | + // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
3787 | + if ( |
|
3788 | + in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3789 | + && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3790 | + ) { |
|
3791 | + do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
3792 | + } |
|
3793 | + } else { |
|
3794 | + /* translators: %s: new invoice status */ |
|
3795 | + $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
3796 | + |
|
3797 | + // Note the transition occurred. |
|
3798 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
3799 | + |
|
3800 | + } |
|
3801 | + } catch ( Exception $e ) { |
|
3802 | + $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
3803 | + } |
|
3804 | + } |
|
3805 | + } |
|
3806 | 3806 | |
3807 | - /** |
|
3808 | - * Updates an invoice status. |
|
3809 | - */ |
|
3810 | - public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
3807 | + /** |
|
3808 | + * Updates an invoice status. |
|
3809 | + */ |
|
3810 | + public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
3811 | 3811 | |
3812 | - // Fires before updating a status. |
|
3813 | - do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
3812 | + // Fires before updating a status. |
|
3813 | + do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
3814 | 3814 | |
3815 | - // Update the status. |
|
3816 | - $this->set_status( $new_status, $note, $manual ); |
|
3815 | + // Update the status. |
|
3816 | + $this->set_status( $new_status, $note, $manual ); |
|
3817 | 3817 | |
3818 | - // Save the order. |
|
3819 | - return $this->save(); |
|
3818 | + // Save the order. |
|
3819 | + return $this->save(); |
|
3820 | 3820 | |
3821 | - } |
|
3821 | + } |
|
3822 | 3822 | |
3823 | - /** |
|
3824 | - * @deprecated |
|
3825 | - */ |
|
3826 | - public function refresh_item_ids() { |
|
3823 | + /** |
|
3824 | + * @deprecated |
|
3825 | + */ |
|
3826 | + public function refresh_item_ids() { |
|
3827 | 3827 | $item_ids = implode( ',', array_unique( wp_list_pluck( $this->get_cart_details(), 'item_id' ) ) ); |
3828 | 3828 | update_post_meta( $this->get_id(), '_wpinv_item_ids', $item_ids ); |
3829 | - } |
|
3829 | + } |
|
3830 | 3830 | |
3831 | - /** |
|
3832 | - * @deprecated |
|
3833 | - */ |
|
3834 | - public function update_items( $temp = false ) { |
|
3831 | + /** |
|
3832 | + * @deprecated |
|
3833 | + */ |
|
3834 | + public function update_items( $temp = false ) { |
|
3835 | 3835 | |
3836 | - $this->set_items( $this->get_items() ); |
|
3836 | + $this->set_items( $this->get_items() ); |
|
3837 | 3837 | |
3838 | - if ( ! $temp ) { |
|
3839 | - $this->save(); |
|
3840 | - } |
|
3838 | + if ( ! $temp ) { |
|
3839 | + $this->save(); |
|
3840 | + } |
|
3841 | 3841 | |
3842 | 3842 | return $this; |
3843 | - } |
|
3843 | + } |
|
3844 | 3844 | |
3845 | - /** |
|
3846 | - * @deprecated |
|
3847 | - */ |
|
3845 | + /** |
|
3846 | + * @deprecated |
|
3847 | + */ |
|
3848 | 3848 | public function validate_discount() { |
3849 | 3849 | |
3850 | 3850 | $discount_code = $this->get_discount_code(); |
@@ -3860,93 +3860,93 @@ discard block |
||
3860 | 3860 | |
3861 | 3861 | } |
3862 | 3862 | |
3863 | - /** |
|
3864 | - * Refunds an invoice. |
|
3865 | - */ |
|
3863 | + /** |
|
3864 | + * Refunds an invoice. |
|
3865 | + */ |
|
3866 | 3866 | public function refund() { |
3867 | - $this->set_status( 'wpi-refunded' ); |
|
3867 | + $this->set_status( 'wpi-refunded' ); |
|
3868 | 3868 | $this->save(); |
3869 | - } |
|
3869 | + } |
|
3870 | 3870 | |
3871 | - /** |
|
3872 | - * Marks an invoice as paid. |
|
3873 | - * |
|
3874 | - * @param string $transaction_id |
|
3875 | - */ |
|
3871 | + /** |
|
3872 | + * Marks an invoice as paid. |
|
3873 | + * |
|
3874 | + * @param string $transaction_id |
|
3875 | + */ |
|
3876 | 3876 | public function mark_paid( $transaction_id = null, $note = '' ) { |
3877 | 3877 | |
3878 | - // Set the transaction id. |
|
3879 | - if ( empty( $transaction_id ) ) { |
|
3880 | - $transaction_id = $this->generate_key('trans_'); |
|
3881 | - } |
|
3878 | + // Set the transaction id. |
|
3879 | + if ( empty( $transaction_id ) ) { |
|
3880 | + $transaction_id = $this->generate_key('trans_'); |
|
3881 | + } |
|
3882 | 3882 | |
3883 | - if ( ! $this->get_transaction_id() ) { |
|
3884 | - $this->set_transaction_id( $transaction_id ); |
|
3885 | - } |
|
3883 | + if ( ! $this->get_transaction_id() ) { |
|
3884 | + $this->set_transaction_id( $transaction_id ); |
|
3885 | + } |
|
3886 | 3886 | |
3887 | - if ( $this->is_paid() && 'wpi-processing' != $this->get_status() ) { |
|
3888 | - return $this->save(); |
|
3889 | - } |
|
3887 | + if ( $this->is_paid() && 'wpi-processing' != $this->get_status() ) { |
|
3888 | + return $this->save(); |
|
3889 | + } |
|
3890 | 3890 | |
3891 | - // Set the completed date. |
|
3892 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
3891 | + // Set the completed date. |
|
3892 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
3893 | 3893 | |
3894 | - // Set the new status. |
|
3895 | - $gateway = sanitize_text_field( $this->get_gateway_title() ); |
|
3896 | - if ( $this->is_renewal() || ! $this->is_parent() ) { |
|
3894 | + // Set the new status. |
|
3895 | + $gateway = sanitize_text_field( $this->get_gateway_title() ); |
|
3896 | + if ( $this->is_renewal() || ! $this->is_parent() ) { |
|
3897 | 3897 | |
3898 | - $_note = wp_sprintf( __( 'Renewed via %s', 'invoicing' ), $gateway ); |
|
3899 | - $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
3898 | + $_note = wp_sprintf( __( 'Renewed via %s', 'invoicing' ), $gateway ); |
|
3899 | + $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
3900 | 3900 | |
3901 | - if ( 'none' == $this->get_gateway() ) { |
|
3902 | - $_note = $note; |
|
3903 | - } |
|
3901 | + if ( 'none' == $this->get_gateway() ) { |
|
3902 | + $_note = $note; |
|
3903 | + } |
|
3904 | 3904 | |
3905 | - $this->set_status( 'wpi-renewal', $_note ); |
|
3905 | + $this->set_status( 'wpi-renewal', $_note ); |
|
3906 | 3906 | |
3907 | - } else { |
|
3907 | + } else { |
|
3908 | 3908 | |
3909 | - $_note = wp_sprintf( __( 'Paid via %s', 'invoicing' ), $gateway ); |
|
3910 | - $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
3909 | + $_note = wp_sprintf( __( 'Paid via %s', 'invoicing' ), $gateway ); |
|
3910 | + $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
3911 | 3911 | |
3912 | - if ( 'none' == $this->get_gateway() ) { |
|
3913 | - $_note = $note; |
|
3914 | - } |
|
3912 | + if ( 'none' == $this->get_gateway() ) { |
|
3913 | + $_note = $note; |
|
3914 | + } |
|
3915 | 3915 | |
3916 | - $this->set_status( 'publish', $_note ); |
|
3916 | + $this->set_status( 'publish', $_note ); |
|
3917 | 3917 | |
3918 | - } |
|
3918 | + } |
|
3919 | 3919 | |
3920 | - // Set checkout mode. |
|
3921 | - $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
3922 | - $this->set_mode( $mode ); |
|
3920 | + // Set checkout mode. |
|
3921 | + $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
3922 | + $this->set_mode( $mode ); |
|
3923 | 3923 | |
3924 | - // Save the invoice. |
|
3924 | + // Save the invoice. |
|
3925 | 3925 | $this->save(); |
3926 | - } |
|
3927 | - |
|
3928 | - /** |
|
3929 | - * Save data to the database. |
|
3930 | - * |
|
3931 | - * @since 1.0.19 |
|
3932 | - * @return int invoice ID |
|
3933 | - */ |
|
3934 | - public function save() { |
|
3935 | - $this->maybe_set_date_paid(); |
|
3936 | - $this->maybe_set_key(); |
|
3937 | - parent::save(); |
|
3938 | - $this->clear_cache(); |
|
3939 | - $this->status_transition(); |
|
3940 | - return $this->get_id(); |
|
3941 | - } |
|
3942 | - |
|
3943 | - /** |
|
3926 | + } |
|
3927 | + |
|
3928 | + /** |
|
3929 | + * Save data to the database. |
|
3930 | + * |
|
3931 | + * @since 1.0.19 |
|
3932 | + * @return int invoice ID |
|
3933 | + */ |
|
3934 | + public function save() { |
|
3935 | + $this->maybe_set_date_paid(); |
|
3936 | + $this->maybe_set_key(); |
|
3937 | + parent::save(); |
|
3938 | + $this->clear_cache(); |
|
3939 | + $this->status_transition(); |
|
3940 | + return $this->get_id(); |
|
3941 | + } |
|
3942 | + |
|
3943 | + /** |
|
3944 | 3944 | * Clears the subscription's cache. |
3945 | 3945 | */ |
3946 | 3946 | public function clear_cache() { |
3947 | - wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
3948 | - wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
3949 | - wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
3950 | - } |
|
3947 | + wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
3948 | + wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
3949 | + wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
3950 | + } |
|
3951 | 3951 | |
3952 | 3952 | } |
@@ -1,6 +1,6 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | if ( ! defined( 'ABSPATH' ) ) { |
3 | - exit; |
|
3 | + exit; |
|
4 | 4 | } |
5 | 5 | |
6 | 6 | /** |
@@ -10,67 +10,67 @@ discard block |
||
10 | 10 | class GetPaid_Form_Item extends WPInv_Item { |
11 | 11 | |
12 | 12 | /** |
13 | - * Stores a custom description for the item. |
|
14 | - * |
|
15 | - * @var string |
|
16 | - */ |
|
17 | - protected $custom_description = null; |
|
18 | - |
|
19 | - /** |
|
20 | - * Stores the item quantity. |
|
21 | - * |
|
22 | - * @var float |
|
23 | - */ |
|
24 | - protected $quantity = 1; |
|
25 | - |
|
26 | - /** |
|
27 | - * Stores the item meta. |
|
28 | - * |
|
29 | - * @var array |
|
30 | - */ |
|
31 | - protected $meta = array(); |
|
32 | - |
|
33 | - /** |
|
34 | - * Is this item required? |
|
35 | - * |
|
36 | - * @var int |
|
37 | - */ |
|
38 | - protected $is_required = true; |
|
39 | - |
|
40 | - /** |
|
41 | - * Are quantities allowed? |
|
42 | - * |
|
43 | - * @var int |
|
44 | - */ |
|
45 | - protected $allow_quantities = false; |
|
46 | - |
|
47 | - /** |
|
48 | - * Associated invoice. |
|
49 | - * |
|
50 | - * @var int |
|
51 | - */ |
|
52 | - public $invoice_id = 0; |
|
53 | - |
|
54 | - /** |
|
55 | - * Item discount. |
|
56 | - * |
|
57 | - * @var float |
|
58 | - */ |
|
59 | - public $item_discount = 0; |
|
60 | - |
|
61 | - /** |
|
62 | - * Recurring item discount. |
|
63 | - * |
|
64 | - * @var float |
|
65 | - */ |
|
66 | - public $recurring_item_discount = 0; |
|
67 | - |
|
68 | - /** |
|
69 | - * Item tax. |
|
70 | - * |
|
71 | - * @var float |
|
72 | - */ |
|
73 | - public $item_tax = 0; |
|
13 | + * Stores a custom description for the item. |
|
14 | + * |
|
15 | + * @var string |
|
16 | + */ |
|
17 | + protected $custom_description = null; |
|
18 | + |
|
19 | + /** |
|
20 | + * Stores the item quantity. |
|
21 | + * |
|
22 | + * @var float |
|
23 | + */ |
|
24 | + protected $quantity = 1; |
|
25 | + |
|
26 | + /** |
|
27 | + * Stores the item meta. |
|
28 | + * |
|
29 | + * @var array |
|
30 | + */ |
|
31 | + protected $meta = array(); |
|
32 | + |
|
33 | + /** |
|
34 | + * Is this item required? |
|
35 | + * |
|
36 | + * @var int |
|
37 | + */ |
|
38 | + protected $is_required = true; |
|
39 | + |
|
40 | + /** |
|
41 | + * Are quantities allowed? |
|
42 | + * |
|
43 | + * @var int |
|
44 | + */ |
|
45 | + protected $allow_quantities = false; |
|
46 | + |
|
47 | + /** |
|
48 | + * Associated invoice. |
|
49 | + * |
|
50 | + * @var int |
|
51 | + */ |
|
52 | + public $invoice_id = 0; |
|
53 | + |
|
54 | + /** |
|
55 | + * Item discount. |
|
56 | + * |
|
57 | + * @var float |
|
58 | + */ |
|
59 | + public $item_discount = 0; |
|
60 | + |
|
61 | + /** |
|
62 | + * Recurring item discount. |
|
63 | + * |
|
64 | + * @var float |
|
65 | + */ |
|
66 | + public $recurring_item_discount = 0; |
|
67 | + |
|
68 | + /** |
|
69 | + * Item tax. |
|
70 | + * |
|
71 | + * @var float |
|
72 | + */ |
|
73 | + public $item_tax = 0; |
|
74 | 74 | |
75 | 75 | /* |
76 | 76 | |-------------------------------------------------------------------------- |
@@ -88,230 +88,230 @@ discard block |
||
88 | 88 | */ |
89 | 89 | |
90 | 90 | /** |
91 | - * Get the item name. |
|
92 | - * |
|
93 | - * @since 1.0.19 |
|
94 | - * @param string $context View or edit context. |
|
95 | - * @return string |
|
96 | - */ |
|
97 | - public function get_name( $context = 'view' ) { |
|
98 | - $name = parent::get_name( $context ); |
|
99 | - return $name . wpinv_get_item_suffix( $this ); |
|
100 | - } |
|
101 | - |
|
102 | - /** |
|
103 | - * Get the item name without a suffix. |
|
104 | - * |
|
105 | - * @since 1.0.19 |
|
106 | - * @param string $context View or edit context. |
|
107 | - * @return string |
|
108 | - */ |
|
109 | - public function get_raw_name( $context = 'view' ) { |
|
110 | - return parent::get_name( $context ); |
|
111 | - } |
|
112 | - |
|
113 | - /** |
|
114 | - * Get the item description. |
|
115 | - * |
|
116 | - * @since 1.0.19 |
|
117 | - * @param string $context View or edit context. |
|
118 | - * @return string |
|
119 | - */ |
|
120 | - public function get_description( $context = 'view' ) { |
|
121 | - |
|
122 | - if ( isset( $this->custom_description ) ) { |
|
123 | - return $this->custom_description; |
|
124 | - } |
|
125 | - |
|
126 | - return parent::get_description( $context ); |
|
127 | - } |
|
128 | - |
|
129 | - /** |
|
130 | - * Returns the sub total. |
|
131 | - * |
|
132 | - * @since 1.0.19 |
|
133 | - * @param string $context View or edit context. |
|
134 | - * @return float |
|
135 | - */ |
|
136 | - public function get_sub_total( $context = 'view' ) { |
|
137 | - return $this->get_quantity( $context ) * $this->get_initial_price( $context ); |
|
138 | - } |
|
139 | - |
|
140 | - /** |
|
141 | - * Returns the recurring sub total. |
|
142 | - * |
|
143 | - * @since 1.0.19 |
|
144 | - * @param string $context View or edit context. |
|
145 | - * @return float |
|
146 | - */ |
|
147 | - public function get_recurring_sub_total( $context = 'view' ) { |
|
148 | - |
|
149 | - if ( $this->is_recurring() ) { |
|
150 | - return $this->get_quantity( $context ) * $this->get_price( $context ); |
|
151 | - } |
|
152 | - |
|
153 | - return 0; |
|
154 | - } |
|
155 | - |
|
156 | - /** |
|
157 | - * @deprecated |
|
158 | - */ |
|
159 | - public function get_qantity( $context = 'view' ) { |
|
160 | - return $this->get_quantity( $context ); |
|
161 | - } |
|
162 | - |
|
163 | - /** |
|
164 | - * Get the item quantity. |
|
165 | - * |
|
166 | - * @since 1.0.19 |
|
167 | - * @param string $context View or edit context. |
|
168 | - * @return float |
|
169 | - */ |
|
170 | - public function get_quantity( $context = 'view' ) { |
|
171 | - $quantity = (float) $this->quantity; |
|
172 | - |
|
173 | - if ( 'view' == $context ) { |
|
174 | - return apply_filters( 'getpaid_payment_form_item_quantity', $quantity, $this ); |
|
175 | - } |
|
176 | - |
|
177 | - return $quantity; |
|
178 | - |
|
179 | - } |
|
180 | - |
|
181 | - /** |
|
182 | - * Get the item meta data. |
|
183 | - * |
|
184 | - * @since 1.0.19 |
|
185 | - * @param string $context View or edit context. |
|
186 | - * @return meta |
|
187 | - */ |
|
188 | - public function get_item_meta( $context = 'view' ) { |
|
189 | - $meta = $this->meta; |
|
190 | - |
|
191 | - if ( 'view' == $context ) { |
|
192 | - return apply_filters( 'getpaid_payment_form_item_meta', $meta, $this ); |
|
193 | - } |
|
194 | - |
|
195 | - return $meta; |
|
196 | - |
|
197 | - } |
|
198 | - |
|
199 | - /** |
|
200 | - * Returns whether or not customers can update the item quantity. |
|
201 | - * |
|
202 | - * @since 1.0.19 |
|
203 | - * @param string $context View or edit context. |
|
204 | - * @return bool |
|
205 | - */ |
|
206 | - public function get_allow_quantities( $context = 'view' ) { |
|
207 | - $allow_quantities = (bool) $this->allow_quantities; |
|
208 | - |
|
209 | - if ( 'view' == $context ) { |
|
210 | - return apply_filters( 'getpaid_payment_form_item_allow_quantities', $allow_quantities, $this ); |
|
211 | - } |
|
212 | - |
|
213 | - return $allow_quantities; |
|
214 | - |
|
215 | - } |
|
216 | - |
|
217 | - /** |
|
218 | - * Returns whether or not the item is required. |
|
219 | - * |
|
220 | - * @since 1.0.19 |
|
221 | - * @param string $context View or edit context. |
|
222 | - * @return bool |
|
223 | - */ |
|
224 | - public function get_is_required( $context = 'view' ) { |
|
225 | - $is_required = (bool) $this->is_required; |
|
226 | - |
|
227 | - if ( 'view' == $context ) { |
|
228 | - return apply_filters( 'getpaid_payment_form_item_is_required', $is_required, $this ); |
|
229 | - } |
|
230 | - |
|
231 | - return $is_required; |
|
232 | - |
|
233 | - } |
|
234 | - |
|
235 | - /** |
|
236 | - * Prepares form data for use. |
|
237 | - * |
|
238 | - * @since 1.0.19 |
|
239 | - * @return array |
|
240 | - */ |
|
241 | - public function prepare_data_for_use( $required = null ) { |
|
242 | - |
|
243 | - $required = is_null( $required ) ? $this->is_required() : $required; |
|
244 | - return array( |
|
245 | - 'title' => strip_tags( $this->get_name() ), |
|
246 | - 'id' => $this->get_id(), |
|
247 | - 'price' => $this->get_price(), |
|
248 | - 'recurring' => $this->is_recurring(), |
|
249 | - 'description' => $this->get_description(), |
|
250 | - 'allow_quantities' => $this->allows_quantities(), |
|
251 | - 'required' => $required, |
|
252 | - ); |
|
253 | - |
|
254 | - } |
|
255 | - |
|
256 | - /** |
|
257 | - * Prepares form data for ajax use. |
|
258 | - * |
|
259 | - * @since 1.0.19 |
|
260 | - * @return array |
|
261 | - */ |
|
262 | - public function prepare_data_for_invoice_edit_ajax( $currency = '', $is_renewal = false ) { |
|
263 | - |
|
264 | - $description = getpaid_item_recurring_price_help_text( $this, $currency ); |
|
265 | - |
|
266 | - if ( $description ) { |
|
267 | - $description = "<div class='getpaid-subscription-help-text'>$description</div>"; |
|
268 | - } |
|
269 | - |
|
270 | - $price = ! $is_renewal ? $this->get_price() : $this->get_recurring_price(); |
|
271 | - $subtotal = ! $is_renewal ? $this->get_sub_total() : $this->get_recurring_sub_total(); |
|
272 | - return array( |
|
273 | - 'id' => $this->get_id(), |
|
274 | - 'texts' => array( |
|
275 | - 'item-name' => sanitize_text_field( $this->get_name() ), |
|
276 | - 'item-description' => wp_kses_post( $this->get_description() ) . $description, |
|
277 | - 'item-quantity' => floatval( $this->get_quantity() ), |
|
278 | - 'item-price' => wpinv_price( $price, $currency ), |
|
279 | - 'item-total' => wpinv_price( $subtotal, $currency ), |
|
280 | - ), |
|
281 | - 'inputs' => array( |
|
282 | - 'item-id' => $this->get_id(), |
|
283 | - 'item-name' => sanitize_text_field( $this->get_name() ), |
|
284 | - 'item-description' => wp_kses_post( $this->get_description() ), |
|
285 | - 'item-quantity' => floatval( $this->get_quantity() ), |
|
286 | - 'item-price' => $price, |
|
287 | - ) |
|
288 | - ); |
|
289 | - |
|
290 | - } |
|
291 | - |
|
292 | - /** |
|
293 | - * Prepares form data for saving (cart_details). |
|
294 | - * |
|
295 | - * @since 1.0.19 |
|
296 | - * @return array |
|
297 | - */ |
|
298 | - public function prepare_data_for_saving() { |
|
299 | - |
|
300 | - return array( |
|
301 | - 'post_id' => $this->invoice_id, |
|
302 | - 'item_id' => $this->get_id(), |
|
303 | - 'item_name' => sanitize_text_field( $this->get_raw_name() ), |
|
304 | - 'item_description' => $this->get_description(), |
|
305 | - 'tax' => $this->item_tax, |
|
306 | - 'item_price' => $this->get_price(), |
|
307 | - 'quantity' => (float) $this->get_quantity(), |
|
308 | - 'discount' => $this->item_discount, |
|
309 | - 'subtotal' => $this->get_sub_total(), |
|
310 | - 'price' => $this->get_sub_total() + $this->item_tax - $this->item_discount, |
|
311 | - 'meta' => $this->get_item_meta(), |
|
312 | - ); |
|
313 | - |
|
314 | - } |
|
91 | + * Get the item name. |
|
92 | + * |
|
93 | + * @since 1.0.19 |
|
94 | + * @param string $context View or edit context. |
|
95 | + * @return string |
|
96 | + */ |
|
97 | + public function get_name( $context = 'view' ) { |
|
98 | + $name = parent::get_name( $context ); |
|
99 | + return $name . wpinv_get_item_suffix( $this ); |
|
100 | + } |
|
101 | + |
|
102 | + /** |
|
103 | + * Get the item name without a suffix. |
|
104 | + * |
|
105 | + * @since 1.0.19 |
|
106 | + * @param string $context View or edit context. |
|
107 | + * @return string |
|
108 | + */ |
|
109 | + public function get_raw_name( $context = 'view' ) { |
|
110 | + return parent::get_name( $context ); |
|
111 | + } |
|
112 | + |
|
113 | + /** |
|
114 | + * Get the item description. |
|
115 | + * |
|
116 | + * @since 1.0.19 |
|
117 | + * @param string $context View or edit context. |
|
118 | + * @return string |
|
119 | + */ |
|
120 | + public function get_description( $context = 'view' ) { |
|
121 | + |
|
122 | + if ( isset( $this->custom_description ) ) { |
|
123 | + return $this->custom_description; |
|
124 | + } |
|
125 | + |
|
126 | + return parent::get_description( $context ); |
|
127 | + } |
|
128 | + |
|
129 | + /** |
|
130 | + * Returns the sub total. |
|
131 | + * |
|
132 | + * @since 1.0.19 |
|
133 | + * @param string $context View or edit context. |
|
134 | + * @return float |
|
135 | + */ |
|
136 | + public function get_sub_total( $context = 'view' ) { |
|
137 | + return $this->get_quantity( $context ) * $this->get_initial_price( $context ); |
|
138 | + } |
|
139 | + |
|
140 | + /** |
|
141 | + * Returns the recurring sub total. |
|
142 | + * |
|
143 | + * @since 1.0.19 |
|
144 | + * @param string $context View or edit context. |
|
145 | + * @return float |
|
146 | + */ |
|
147 | + public function get_recurring_sub_total( $context = 'view' ) { |
|
148 | + |
|
149 | + if ( $this->is_recurring() ) { |
|
150 | + return $this->get_quantity( $context ) * $this->get_price( $context ); |
|
151 | + } |
|
152 | + |
|
153 | + return 0; |
|
154 | + } |
|
155 | + |
|
156 | + /** |
|
157 | + * @deprecated |
|
158 | + */ |
|
159 | + public function get_qantity( $context = 'view' ) { |
|
160 | + return $this->get_quantity( $context ); |
|
161 | + } |
|
162 | + |
|
163 | + /** |
|
164 | + * Get the item quantity. |
|
165 | + * |
|
166 | + * @since 1.0.19 |
|
167 | + * @param string $context View or edit context. |
|
168 | + * @return float |
|
169 | + */ |
|
170 | + public function get_quantity( $context = 'view' ) { |
|
171 | + $quantity = (float) $this->quantity; |
|
172 | + |
|
173 | + if ( 'view' == $context ) { |
|
174 | + return apply_filters( 'getpaid_payment_form_item_quantity', $quantity, $this ); |
|
175 | + } |
|
176 | + |
|
177 | + return $quantity; |
|
178 | + |
|
179 | + } |
|
180 | + |
|
181 | + /** |
|
182 | + * Get the item meta data. |
|
183 | + * |
|
184 | + * @since 1.0.19 |
|
185 | + * @param string $context View or edit context. |
|
186 | + * @return meta |
|
187 | + */ |
|
188 | + public function get_item_meta( $context = 'view' ) { |
|
189 | + $meta = $this->meta; |
|
190 | + |
|
191 | + if ( 'view' == $context ) { |
|
192 | + return apply_filters( 'getpaid_payment_form_item_meta', $meta, $this ); |
|
193 | + } |
|
194 | + |
|
195 | + return $meta; |
|
196 | + |
|
197 | + } |
|
198 | + |
|
199 | + /** |
|
200 | + * Returns whether or not customers can update the item quantity. |
|
201 | + * |
|
202 | + * @since 1.0.19 |
|
203 | + * @param string $context View or edit context. |
|
204 | + * @return bool |
|
205 | + */ |
|
206 | + public function get_allow_quantities( $context = 'view' ) { |
|
207 | + $allow_quantities = (bool) $this->allow_quantities; |
|
208 | + |
|
209 | + if ( 'view' == $context ) { |
|
210 | + return apply_filters( 'getpaid_payment_form_item_allow_quantities', $allow_quantities, $this ); |
|
211 | + } |
|
212 | + |
|
213 | + return $allow_quantities; |
|
214 | + |
|
215 | + } |
|
216 | + |
|
217 | + /** |
|
218 | + * Returns whether or not the item is required. |
|
219 | + * |
|
220 | + * @since 1.0.19 |
|
221 | + * @param string $context View or edit context. |
|
222 | + * @return bool |
|
223 | + */ |
|
224 | + public function get_is_required( $context = 'view' ) { |
|
225 | + $is_required = (bool) $this->is_required; |
|
226 | + |
|
227 | + if ( 'view' == $context ) { |
|
228 | + return apply_filters( 'getpaid_payment_form_item_is_required', $is_required, $this ); |
|
229 | + } |
|
230 | + |
|
231 | + return $is_required; |
|
232 | + |
|
233 | + } |
|
234 | + |
|
235 | + /** |
|
236 | + * Prepares form data for use. |
|
237 | + * |
|
238 | + * @since 1.0.19 |
|
239 | + * @return array |
|
240 | + */ |
|
241 | + public function prepare_data_for_use( $required = null ) { |
|
242 | + |
|
243 | + $required = is_null( $required ) ? $this->is_required() : $required; |
|
244 | + return array( |
|
245 | + 'title' => strip_tags( $this->get_name() ), |
|
246 | + 'id' => $this->get_id(), |
|
247 | + 'price' => $this->get_price(), |
|
248 | + 'recurring' => $this->is_recurring(), |
|
249 | + 'description' => $this->get_description(), |
|
250 | + 'allow_quantities' => $this->allows_quantities(), |
|
251 | + 'required' => $required, |
|
252 | + ); |
|
253 | + |
|
254 | + } |
|
255 | + |
|
256 | + /** |
|
257 | + * Prepares form data for ajax use. |
|
258 | + * |
|
259 | + * @since 1.0.19 |
|
260 | + * @return array |
|
261 | + */ |
|
262 | + public function prepare_data_for_invoice_edit_ajax( $currency = '', $is_renewal = false ) { |
|
263 | + |
|
264 | + $description = getpaid_item_recurring_price_help_text( $this, $currency ); |
|
265 | + |
|
266 | + if ( $description ) { |
|
267 | + $description = "<div class='getpaid-subscription-help-text'>$description</div>"; |
|
268 | + } |
|
269 | + |
|
270 | + $price = ! $is_renewal ? $this->get_price() : $this->get_recurring_price(); |
|
271 | + $subtotal = ! $is_renewal ? $this->get_sub_total() : $this->get_recurring_sub_total(); |
|
272 | + return array( |
|
273 | + 'id' => $this->get_id(), |
|
274 | + 'texts' => array( |
|
275 | + 'item-name' => sanitize_text_field( $this->get_name() ), |
|
276 | + 'item-description' => wp_kses_post( $this->get_description() ) . $description, |
|
277 | + 'item-quantity' => floatval( $this->get_quantity() ), |
|
278 | + 'item-price' => wpinv_price( $price, $currency ), |
|
279 | + 'item-total' => wpinv_price( $subtotal, $currency ), |
|
280 | + ), |
|
281 | + 'inputs' => array( |
|
282 | + 'item-id' => $this->get_id(), |
|
283 | + 'item-name' => sanitize_text_field( $this->get_name() ), |
|
284 | + 'item-description' => wp_kses_post( $this->get_description() ), |
|
285 | + 'item-quantity' => floatval( $this->get_quantity() ), |
|
286 | + 'item-price' => $price, |
|
287 | + ) |
|
288 | + ); |
|
289 | + |
|
290 | + } |
|
291 | + |
|
292 | + /** |
|
293 | + * Prepares form data for saving (cart_details). |
|
294 | + * |
|
295 | + * @since 1.0.19 |
|
296 | + * @return array |
|
297 | + */ |
|
298 | + public function prepare_data_for_saving() { |
|
299 | + |
|
300 | + return array( |
|
301 | + 'post_id' => $this->invoice_id, |
|
302 | + 'item_id' => $this->get_id(), |
|
303 | + 'item_name' => sanitize_text_field( $this->get_raw_name() ), |
|
304 | + 'item_description' => $this->get_description(), |
|
305 | + 'tax' => $this->item_tax, |
|
306 | + 'item_price' => $this->get_price(), |
|
307 | + 'quantity' => (float) $this->get_quantity(), |
|
308 | + 'discount' => $this->item_discount, |
|
309 | + 'subtotal' => $this->get_sub_total(), |
|
310 | + 'price' => $this->get_sub_total() + $this->item_tax - $this->item_discount, |
|
311 | + 'meta' => $this->get_item_meta(), |
|
312 | + ); |
|
313 | + |
|
314 | + } |
|
315 | 315 | |
316 | 316 | /* |
317 | 317 | |-------------------------------------------------------------------------- |
@@ -323,70 +323,70 @@ discard block |
||
323 | 323 | | object. |
324 | 324 | */ |
325 | 325 | |
326 | - /** |
|
327 | - * Set the item qantity. |
|
328 | - * |
|
329 | - * @since 1.0.19 |
|
330 | - * @param float $quantity The item quantity. |
|
331 | - */ |
|
332 | - public function set_quantity( $quantity ) { |
|
333 | - |
|
334 | - if ( ! is_numeric( $quantity ) ) { |
|
335 | - $quantity = 1; |
|
336 | - } |
|
337 | - |
|
338 | - $this->quantity = (float) $quantity; |
|
339 | - |
|
340 | - } |
|
341 | - |
|
342 | - /** |
|
343 | - * Set the item meta data. |
|
344 | - * |
|
345 | - * @since 1.0.19 |
|
346 | - * @param array $meta The item meta data. |
|
347 | - */ |
|
348 | - public function set_item_meta( $meta ) { |
|
349 | - $this->meta = maybe_unserialize( $meta ); |
|
350 | - } |
|
351 | - |
|
352 | - /** |
|
353 | - * Set whether or not the quantities are allowed. |
|
354 | - * |
|
355 | - * @since 1.0.19 |
|
356 | - * @param bool $allow_quantities |
|
357 | - */ |
|
358 | - public function set_allow_quantities( $allow_quantities ) { |
|
359 | - $this->allow_quantities = (bool) $allow_quantities; |
|
360 | - } |
|
361 | - |
|
362 | - /** |
|
363 | - * Set whether or not the item is required. |
|
364 | - * |
|
365 | - * @since 1.0.19 |
|
366 | - * @param bool $is_required |
|
367 | - */ |
|
368 | - public function set_is_required( $is_required ) { |
|
369 | - $this->is_required = (bool) $is_required; |
|
370 | - } |
|
371 | - |
|
372 | - /** |
|
373 | - * Sets the custom item description. |
|
374 | - * |
|
375 | - * @since 1.0.19 |
|
376 | - * @param string $description |
|
377 | - */ |
|
378 | - public function set_custom_description( $description ) { |
|
379 | - $this->custom_description = $description; |
|
380 | - } |
|
326 | + /** |
|
327 | + * Set the item qantity. |
|
328 | + * |
|
329 | + * @since 1.0.19 |
|
330 | + * @param float $quantity The item quantity. |
|
331 | + */ |
|
332 | + public function set_quantity( $quantity ) { |
|
333 | + |
|
334 | + if ( ! is_numeric( $quantity ) ) { |
|
335 | + $quantity = 1; |
|
336 | + } |
|
337 | + |
|
338 | + $this->quantity = (float) $quantity; |
|
339 | + |
|
340 | + } |
|
341 | + |
|
342 | + /** |
|
343 | + * Set the item meta data. |
|
344 | + * |
|
345 | + * @since 1.0.19 |
|
346 | + * @param array $meta The item meta data. |
|
347 | + */ |
|
348 | + public function set_item_meta( $meta ) { |
|
349 | + $this->meta = maybe_unserialize( $meta ); |
|
350 | + } |
|
351 | + |
|
352 | + /** |
|
353 | + * Set whether or not the quantities are allowed. |
|
354 | + * |
|
355 | + * @since 1.0.19 |
|
356 | + * @param bool $allow_quantities |
|
357 | + */ |
|
358 | + public function set_allow_quantities( $allow_quantities ) { |
|
359 | + $this->allow_quantities = (bool) $allow_quantities; |
|
360 | + } |
|
361 | + |
|
362 | + /** |
|
363 | + * Set whether or not the item is required. |
|
364 | + * |
|
365 | + * @since 1.0.19 |
|
366 | + * @param bool $is_required |
|
367 | + */ |
|
368 | + public function set_is_required( $is_required ) { |
|
369 | + $this->is_required = (bool) $is_required; |
|
370 | + } |
|
371 | + |
|
372 | + /** |
|
373 | + * Sets the custom item description. |
|
374 | + * |
|
375 | + * @since 1.0.19 |
|
376 | + * @param string $description |
|
377 | + */ |
|
378 | + public function set_custom_description( $description ) { |
|
379 | + $this->custom_description = $description; |
|
380 | + } |
|
381 | 381 | |
382 | 382 | /** |
383 | 383 | * We do not want to save items to the database. |
384 | 384 | * |
385 | - * @return int item id |
|
385 | + * @return int item id |
|
386 | 386 | */ |
387 | 387 | public function save( $data = array() ) { |
388 | 388 | return $this->get_id(); |
389 | - } |
|
389 | + } |
|
390 | 390 | |
391 | 391 | /* |
392 | 392 | |-------------------------------------------------------------------------- |
@@ -398,23 +398,23 @@ discard block |
||
398 | 398 | */ |
399 | 399 | |
400 | 400 | /** |
401 | - * Checks whether the item has enabled dynamic pricing. |
|
402 | - * |
|
403 | - * @since 1.0.19 |
|
404 | - * @return bool |
|
405 | - */ |
|
406 | - public function is_required() { |
|
401 | + * Checks whether the item has enabled dynamic pricing. |
|
402 | + * |
|
403 | + * @since 1.0.19 |
|
404 | + * @return bool |
|
405 | + */ |
|
406 | + public function is_required() { |
|
407 | 407 | return (bool) $this->get_is_required(); |
408 | - } |
|
409 | - |
|
410 | - /** |
|
411 | - * Checks whether users can edit the quantities. |
|
412 | - * |
|
413 | - * @since 1.0.19 |
|
414 | - * @return bool |
|
415 | - */ |
|
416 | - public function allows_quantities() { |
|
408 | + } |
|
409 | + |
|
410 | + /** |
|
411 | + * Checks whether users can edit the quantities. |
|
412 | + * |
|
413 | + * @since 1.0.19 |
|
414 | + * @return bool |
|
415 | + */ |
|
416 | + public function allows_quantities() { |
|
417 | 417 | return (bool) $this->get_allow_quantities(); |
418 | - } |
|
418 | + } |
|
419 | 419 | |
420 | 420 | } |
@@ -12,84 +12,84 @@ |
||
12 | 12 | */ |
13 | 13 | class GetPaid_Payment_Form_Submission_Items { |
14 | 14 | |
15 | - /** |
|
16 | - * Submission items. |
|
17 | - * @var GetPaid_Form_Item[] |
|
18 | - */ |
|
19 | - public $items = array(); |
|
15 | + /** |
|
16 | + * Submission items. |
|
17 | + * @var GetPaid_Form_Item[] |
|
18 | + */ |
|
19 | + public $items = array(); |
|
20 | + |
|
21 | + /** |
|
22 | + * Class constructor |
|
23 | + * |
|
24 | + * @param GetPaid_Payment_Form_Submission $submission |
|
25 | + */ |
|
26 | + public function __construct( $submission ) { |
|
27 | + |
|
28 | + $data = $submission->get_data(); |
|
29 | + $payment_form = $submission->get_payment_form(); |
|
30 | + |
|
31 | + // Prepare the selected items. |
|
32 | + $selected_items = array(); |
|
33 | + if ( ! empty( $data['getpaid-items'] ) ) { |
|
34 | + $selected_items = wpinv_clean( $data['getpaid-items'] ); |
|
35 | + } |
|
36 | + |
|
37 | + // For default forms, ensure that an item has been set. |
|
38 | + if ( $payment_form->is_default() && ( ! $submission->has_invoice() || 'payment_form' == $submission->get_invoice()->get_created_via() ) && isset( $data['getpaid-form-items'] ) ) { |
|
39 | + $form_items = wpinv_clean( $data['getpaid-form-items'] ); |
|
40 | + $payment_form->set_items( getpaid_convert_items_to_array( $form_items ) ); |
|
41 | + } |
|
42 | + |
|
43 | + // Process each individual item. |
|
44 | + foreach ( $payment_form->get_items() as $item ) { |
|
45 | + $this->process_item( $item, $selected_items, $submission ); |
|
46 | + } |
|
47 | + |
|
48 | + } |
|
20 | 49 | |
21 | 50 | /** |
22 | - * Class constructor |
|
23 | - * |
|
24 | - * @param GetPaid_Payment_Form_Submission $submission |
|
25 | - */ |
|
26 | - public function __construct( $submission ) { |
|
27 | - |
|
28 | - $data = $submission->get_data(); |
|
29 | - $payment_form = $submission->get_payment_form(); |
|
30 | - |
|
31 | - // Prepare the selected items. |
|
32 | - $selected_items = array(); |
|
33 | - if ( ! empty( $data['getpaid-items'] ) ) { |
|
34 | - $selected_items = wpinv_clean( $data['getpaid-items'] ); |
|
35 | - } |
|
36 | - |
|
37 | - // For default forms, ensure that an item has been set. |
|
38 | - if ( $payment_form->is_default() && ( ! $submission->has_invoice() || 'payment_form' == $submission->get_invoice()->get_created_via() ) && isset( $data['getpaid-form-items'] ) ) { |
|
39 | - $form_items = wpinv_clean( $data['getpaid-form-items'] ); |
|
40 | - $payment_form->set_items( getpaid_convert_items_to_array( $form_items ) ); |
|
41 | - } |
|
42 | - |
|
43 | - // Process each individual item. |
|
44 | - foreach ( $payment_form->get_items() as $item ) { |
|
45 | - $this->process_item( $item, $selected_items, $submission ); |
|
46 | - } |
|
47 | - |
|
48 | - } |
|
49 | - |
|
50 | - /** |
|
51 | - * Process a single item. |
|
52 | - * |
|
53 | - * @param GetPaid_Form_Item $item |
|
54 | - * @param array $selected_items |
|
55 | - * @param GetPaid_Payment_Form_Submission $submission |
|
56 | - */ |
|
57 | - public function process_item( $item, $selected_items, $submission ) { |
|
58 | - |
|
59 | - // Abort if this is an optional item and it has not been selected. |
|
60 | - if ( ! $item->is_required() && ! isset( $selected_items[ $item->get_id() ] ) ) { |
|
61 | - return; |
|
62 | - } |
|
63 | - |
|
64 | - // (maybe) let customers change the quantities and prices. |
|
65 | - if ( isset( $selected_items[ $item->get_id() ] ) ) { |
|
66 | - |
|
67 | - // Maybe change the quantities. |
|
68 | - if ( $item->allows_quantities() ) { |
|
69 | - $item->set_quantity( (float) $selected_items[ $item->get_id() ]['quantity'] ); |
|
70 | - } |
|
71 | - |
|
72 | - // Maybe change the price. |
|
73 | - if ( $item->user_can_set_their_price() ) { |
|
74 | - $price = (float) wpinv_sanitize_amount( $selected_items[ $item->get_id() ]['price'] ); |
|
75 | - |
|
76 | - if ( $item->get_minimum_price() > $price ) { |
|
77 | - throw new Exception( sprintf( __( 'The minimum allowed amount is %s', 'invoicing' ), getpaid_unstandardize_amount( $item->get_minimum_price() ) ) ); |
|
78 | - } |
|
79 | - |
|
80 | - $item->set_price( $price ); |
|
81 | - |
|
82 | - } |
|
83 | - |
|
84 | - } |
|
85 | - |
|
86 | - if ( 0 == $item->get_quantity() ) { |
|
87 | - return; |
|
88 | - } |
|
89 | - |
|
90 | - // Save the item. |
|
91 | - $this->items[] = apply_filters( 'getpaid_payment_form_submission_processed_item' , $item, $submission ); |
|
92 | - |
|
93 | - } |
|
51 | + * Process a single item. |
|
52 | + * |
|
53 | + * @param GetPaid_Form_Item $item |
|
54 | + * @param array $selected_items |
|
55 | + * @param GetPaid_Payment_Form_Submission $submission |
|
56 | + */ |
|
57 | + public function process_item( $item, $selected_items, $submission ) { |
|
58 | + |
|
59 | + // Abort if this is an optional item and it has not been selected. |
|
60 | + if ( ! $item->is_required() && ! isset( $selected_items[ $item->get_id() ] ) ) { |
|
61 | + return; |
|
62 | + } |
|
63 | + |
|
64 | + // (maybe) let customers change the quantities and prices. |
|
65 | + if ( isset( $selected_items[ $item->get_id() ] ) ) { |
|
66 | + |
|
67 | + // Maybe change the quantities. |
|
68 | + if ( $item->allows_quantities() ) { |
|
69 | + $item->set_quantity( (float) $selected_items[ $item->get_id() ]['quantity'] ); |
|
70 | + } |
|
71 | + |
|
72 | + // Maybe change the price. |
|
73 | + if ( $item->user_can_set_their_price() ) { |
|
74 | + $price = (float) wpinv_sanitize_amount( $selected_items[ $item->get_id() ]['price'] ); |
|
75 | + |
|
76 | + if ( $item->get_minimum_price() > $price ) { |
|
77 | + throw new Exception( sprintf( __( 'The minimum allowed amount is %s', 'invoicing' ), getpaid_unstandardize_amount( $item->get_minimum_price() ) ) ); |
|
78 | + } |
|
79 | + |
|
80 | + $item->set_price( $price ); |
|
81 | + |
|
82 | + } |
|
83 | + |
|
84 | + } |
|
85 | + |
|
86 | + if ( 0 == $item->get_quantity() ) { |
|
87 | + return; |
|
88 | + } |
|
89 | + |
|
90 | + // Save the item. |
|
91 | + $this->items[] = apply_filters( 'getpaid_payment_form_submission_processed_item' , $item, $submission ); |
|
92 | + |
|
93 | + } |
|
94 | 94 | |
95 | 95 | } |