@@ -15,30 +15,30 @@ discard block |
||
15 | 15 | */ |
16 | 16 | class WPInv_Discount extends GetPaid_Data { |
17 | 17 | |
18 | - /** |
|
19 | - * Which data store to load. |
|
20 | - * |
|
21 | - * @var string |
|
22 | - */ |
|
18 | + /** |
|
19 | + * Which data store to load. |
|
20 | + * |
|
21 | + * @var string |
|
22 | + */ |
|
23 | 23 | protected $data_store_name = 'discount'; |
24 | 24 | |
25 | 25 | /** |
26 | - * This is the name of this object type. |
|
27 | - * |
|
28 | - * @var string |
|
29 | - */ |
|
30 | - protected $object_type = 'discount'; |
|
31 | - |
|
32 | - /** |
|
33 | - * Discount Data array. This is the core item data exposed in APIs. |
|
34 | - * |
|
35 | - * @since 1.0.19 |
|
36 | - * @var array |
|
37 | - */ |
|
38 | - protected $data = array( |
|
39 | - 'status' => 'draft', |
|
40 | - 'version' => '', |
|
41 | - 'date_created' => null, |
|
26 | + * This is the name of this object type. |
|
27 | + * |
|
28 | + * @var string |
|
29 | + */ |
|
30 | + protected $object_type = 'discount'; |
|
31 | + |
|
32 | + /** |
|
33 | + * Discount Data array. This is the core item data exposed in APIs. |
|
34 | + * |
|
35 | + * @since 1.0.19 |
|
36 | + * @var array |
|
37 | + */ |
|
38 | + protected $data = array( |
|
39 | + 'status' => 'draft', |
|
40 | + 'version' => '', |
|
41 | + 'date_created' => null, |
|
42 | 42 | 'date_modified' => null, |
43 | 43 | 'name' => 'no-name', |
44 | 44 | 'description' => '', |
@@ -58,144 +58,144 @@ discard block |
||
58 | 58 | 'amount' => null, |
59 | 59 | ); |
60 | 60 | |
61 | - /** |
|
62 | - * Stores meta in cache for future reads. |
|
63 | - * |
|
64 | - * A group must be set to to enable caching. |
|
65 | - * |
|
66 | - * @var string |
|
67 | - */ |
|
68 | - protected $cache_group = 'getpaid_discounts'; |
|
61 | + /** |
|
62 | + * Stores meta in cache for future reads. |
|
63 | + * |
|
64 | + * A group must be set to to enable caching. |
|
65 | + * |
|
66 | + * @var string |
|
67 | + */ |
|
68 | + protected $cache_group = 'getpaid_discounts'; |
|
69 | 69 | |
70 | 70 | /** |
71 | 71 | * Stores a reference to the original WP_Post object |
72 | 72 | * |
73 | 73 | * @var WP_Post |
74 | 74 | */ |
75 | - protected $post = null; |
|
76 | - |
|
77 | - /** |
|
78 | - * Get the discount if ID is passed, otherwise the discount is new and empty. |
|
79 | - * |
|
80 | - * @param int|array|string|WPInv_Discount|WP_Post $discount discount data, object, ID or code. |
|
81 | - */ |
|
82 | - public function __construct( $discount = 0 ) { |
|
83 | - parent::__construct( $discount ); |
|
84 | - |
|
85 | - if ( is_numeric( $discount ) && 'wpi_discount' === get_post_type( $discount ) ) { |
|
86 | - $this->set_id( $discount ); |
|
87 | - } elseif ( $discount instanceof self ) { |
|
88 | - $this->set_id( $discount->get_id() ); |
|
89 | - } elseif ( ! empty( $discount->ID ) ) { |
|
90 | - $this->set_id( $discount->ID ); |
|
91 | - } elseif ( is_array( $discount ) ) { |
|
92 | - $this->set_props( $discount ); |
|
93 | - |
|
94 | - if ( isset( $discount['ID'] ) ) { |
|
95 | - $this->set_id( $discount['ID'] ); |
|
96 | - } |
|
97 | - |
|
98 | - } elseif ( is_scalar( $discount ) && $discount = self::get_discount_id_by_code( $discount ) ) { |
|
99 | - $this->set_id( $discount ); |
|
100 | - } else { |
|
101 | - $this->set_object_read( true ); |
|
102 | - } |
|
75 | + protected $post = null; |
|
76 | + |
|
77 | + /** |
|
78 | + * Get the discount if ID is passed, otherwise the discount is new and empty. |
|
79 | + * |
|
80 | + * @param int|array|string|WPInv_Discount|WP_Post $discount discount data, object, ID or code. |
|
81 | + */ |
|
82 | + public function __construct( $discount = 0 ) { |
|
83 | + parent::__construct( $discount ); |
|
84 | + |
|
85 | + if ( is_numeric( $discount ) && 'wpi_discount' === get_post_type( $discount ) ) { |
|
86 | + $this->set_id( $discount ); |
|
87 | + } elseif ( $discount instanceof self ) { |
|
88 | + $this->set_id( $discount->get_id() ); |
|
89 | + } elseif ( ! empty( $discount->ID ) ) { |
|
90 | + $this->set_id( $discount->ID ); |
|
91 | + } elseif ( is_array( $discount ) ) { |
|
92 | + $this->set_props( $discount ); |
|
93 | + |
|
94 | + if ( isset( $discount['ID'] ) ) { |
|
95 | + $this->set_id( $discount['ID'] ); |
|
96 | + } |
|
97 | + |
|
98 | + } elseif ( is_scalar( $discount ) && $discount = self::get_discount_id_by_code( $discount ) ) { |
|
99 | + $this->set_id( $discount ); |
|
100 | + } else { |
|
101 | + $this->set_object_read( true ); |
|
102 | + } |
|
103 | 103 | |
104 | 104 | // Load the datastore. |
105 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
105 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
106 | 106 | |
107 | - if ( $this->get_id() > 0 ) { |
|
107 | + if ( $this->get_id() > 0 ) { |
|
108 | 108 | $this->post = get_post( $this->get_id() ); |
109 | 109 | $this->ID = $this->get_id(); |
110 | - $this->data_store->read( $this ); |
|
110 | + $this->data_store->read( $this ); |
|
111 | + } |
|
112 | + |
|
113 | + } |
|
114 | + |
|
115 | + /** |
|
116 | + * Fetch a discount from the db/cache |
|
117 | + * |
|
118 | + * |
|
119 | + * @static |
|
120 | + * @param string $field The field to query against: 'ID', 'discount_code' |
|
121 | + * @param string|int $value The field value |
|
122 | + * @deprecated |
|
123 | + * @since 1.0.15 |
|
124 | + * @return array|bool array of discount details on success. False otherwise. |
|
125 | + */ |
|
126 | + public static function get_data_by( $field, $value ) { |
|
127 | + |
|
128 | + if ( 'id' == strtolower( $field ) ) { |
|
129 | + // Make sure the value is numeric to avoid casting objects, for example, |
|
130 | + // to int 1. |
|
131 | + if ( ! is_numeric( $value ) ) |
|
132 | + return false; |
|
133 | + $value = intval( $value ); |
|
134 | + if ( $value < 1 ) |
|
135 | + return false; |
|
136 | + } |
|
137 | + |
|
138 | + if ( ! $value || ! is_string( $field ) ) { |
|
139 | + return false; |
|
140 | + } |
|
141 | + |
|
142 | + $field = trim( $field ); |
|
143 | + |
|
144 | + // prepare query args |
|
145 | + switch ( strtolower( $field ) ) { |
|
146 | + case 'id': |
|
147 | + $discount_id = $value; |
|
148 | + $args = array( 'include' => array( $value ) ); |
|
149 | + break; |
|
150 | + case 'discount_code': |
|
151 | + case 'code': |
|
152 | + $value = trim( $value ); |
|
153 | + $discount_id = wp_cache_get( $value, 'WPInv_Discount_Codes' ); |
|
154 | + $args = array( 'meta_key' => '_wpi_discount_code', 'meta_value' => $value ); |
|
155 | + break; |
|
156 | + case 'name': |
|
157 | + $discount_id = 0; |
|
158 | + $args = array( 'name' => trim( $value ) ); |
|
159 | + break; |
|
160 | + default: |
|
161 | + $args = apply_filters( "wpinv_discount_get_data_by_{$field}_args", null, $value ); |
|
162 | + if ( ! is_array( $args ) ) { |
|
163 | + return apply_filters( "wpinv_discount_get_data_by_$field", false, $value ); |
|
164 | + } |
|
165 | + |
|
166 | + } |
|
167 | + |
|
168 | + // Check if there is a cached value. |
|
169 | + if ( ! empty( $discount_id ) && $discount = wp_cache_get( (int) $discount_id, 'WPInv_Discounts' ) ) { |
|
170 | + return $discount; |
|
171 | + } |
|
172 | + |
|
173 | + $args = array_merge( |
|
174 | + $args, |
|
175 | + array( |
|
176 | + 'post_type' => 'wpi_discount', |
|
177 | + 'posts_per_page' => 1, |
|
178 | + 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ) |
|
179 | + ) |
|
180 | + ); |
|
181 | + |
|
182 | + $discount = get_posts( $args ); |
|
183 | + |
|
184 | + if( empty( $discount ) ) { |
|
185 | + return false; |
|
111 | 186 | } |
112 | 187 | |
113 | - } |
|
114 | - |
|
115 | - /** |
|
116 | - * Fetch a discount from the db/cache |
|
117 | - * |
|
118 | - * |
|
119 | - * @static |
|
120 | - * @param string $field The field to query against: 'ID', 'discount_code' |
|
121 | - * @param string|int $value The field value |
|
122 | - * @deprecated |
|
123 | - * @since 1.0.15 |
|
124 | - * @return array|bool array of discount details on success. False otherwise. |
|
125 | - */ |
|
126 | - public static function get_data_by( $field, $value ) { |
|
127 | - |
|
128 | - if ( 'id' == strtolower( $field ) ) { |
|
129 | - // Make sure the value is numeric to avoid casting objects, for example, |
|
130 | - // to int 1. |
|
131 | - if ( ! is_numeric( $value ) ) |
|
132 | - return false; |
|
133 | - $value = intval( $value ); |
|
134 | - if ( $value < 1 ) |
|
135 | - return false; |
|
136 | - } |
|
137 | - |
|
138 | - if ( ! $value || ! is_string( $field ) ) { |
|
139 | - return false; |
|
140 | - } |
|
141 | - |
|
142 | - $field = trim( $field ); |
|
143 | - |
|
144 | - // prepare query args |
|
145 | - switch ( strtolower( $field ) ) { |
|
146 | - case 'id': |
|
147 | - $discount_id = $value; |
|
148 | - $args = array( 'include' => array( $value ) ); |
|
149 | - break; |
|
150 | - case 'discount_code': |
|
151 | - case 'code': |
|
152 | - $value = trim( $value ); |
|
153 | - $discount_id = wp_cache_get( $value, 'WPInv_Discount_Codes' ); |
|
154 | - $args = array( 'meta_key' => '_wpi_discount_code', 'meta_value' => $value ); |
|
155 | - break; |
|
156 | - case 'name': |
|
157 | - $discount_id = 0; |
|
158 | - $args = array( 'name' => trim( $value ) ); |
|
159 | - break; |
|
160 | - default: |
|
161 | - $args = apply_filters( "wpinv_discount_get_data_by_{$field}_args", null, $value ); |
|
162 | - if ( ! is_array( $args ) ) { |
|
163 | - return apply_filters( "wpinv_discount_get_data_by_$field", false, $value ); |
|
164 | - } |
|
165 | - |
|
166 | - } |
|
167 | - |
|
168 | - // Check if there is a cached value. |
|
169 | - if ( ! empty( $discount_id ) && $discount = wp_cache_get( (int) $discount_id, 'WPInv_Discounts' ) ) { |
|
170 | - return $discount; |
|
171 | - } |
|
172 | - |
|
173 | - $args = array_merge( |
|
174 | - $args, |
|
175 | - array( |
|
176 | - 'post_type' => 'wpi_discount', |
|
177 | - 'posts_per_page' => 1, |
|
178 | - 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ) |
|
179 | - ) |
|
180 | - ); |
|
181 | - |
|
182 | - $discount = get_posts( $args ); |
|
183 | - |
|
184 | - if( empty( $discount ) ) { |
|
185 | - return false; |
|
186 | - } |
|
187 | - |
|
188 | - $discount = $discount[0]; |
|
189 | - |
|
190 | - // Prepare the return data. |
|
191 | - $return = array( |
|
188 | + $discount = $discount[0]; |
|
189 | + |
|
190 | + // Prepare the return data. |
|
191 | + $return = array( |
|
192 | 192 | 'ID' => $discount->ID, |
193 | 193 | 'code' => get_post_meta( $discount->ID, '_wpi_discount_code', true ), |
194 | 194 | 'amount' => get_post_meta( $discount->ID, '_wpi_discount_amount', true ), |
195 | 195 | 'date_created' => $discount->post_date, |
196 | - 'date_modified' => $discount->post_modified, |
|
197 | - 'status' => $discount->post_status, |
|
198 | - 'start' => get_post_meta( $discount->ID, '_wpi_discount_start', true ), |
|
196 | + 'date_modified' => $discount->post_modified, |
|
197 | + 'status' => $discount->post_status, |
|
198 | + 'start' => get_post_meta( $discount->ID, '_wpi_discount_start', true ), |
|
199 | 199 | 'expiration' => get_post_meta( $discount->ID, '_wpi_discount_expiration', true ), |
200 | 200 | 'type' => get_post_meta( $discount->ID, '_wpi_discount_type', true ), |
201 | 201 | 'description' => $discount->post_excerpt, |
@@ -209,77 +209,77 @@ discard block |
||
209 | 209 | 'max_total' => get_post_meta( $discount->ID, '_wpi_discount_max_total', true ), |
210 | 210 | ); |
211 | 211 | |
212 | - $return = apply_filters( 'wpinv_discount_properties', $return ); |
|
213 | - |
|
214 | - // Update the cache with our data |
|
215 | - wp_cache_add( $discount->ID, $return, 'WPInv_Discounts' ); |
|
216 | - wp_cache_add( $return['code'], $discount->ID, 'WPInv_Discount_Codes' ); |
|
217 | - |
|
218 | - return $return; |
|
219 | - } |
|
220 | - |
|
221 | - /** |
|
222 | - * Given a discount code, it returns a discount id. |
|
223 | - * |
|
224 | - * |
|
225 | - * @static |
|
226 | - * @param string $discount_code |
|
227 | - * @since 1.0.15 |
|
228 | - * @return int |
|
229 | - */ |
|
230 | - public static function get_discount_id_by_code( $discount_code ) { |
|
231 | - |
|
232 | - // Trim the code. |
|
233 | - $discount_code = trim( $discount_code ); |
|
234 | - |
|
235 | - // Ensure a value has been passed. |
|
236 | - if ( empty( $discount_code ) ) { |
|
237 | - return 0; |
|
238 | - } |
|
239 | - |
|
240 | - // Maybe retrieve from the cache. |
|
241 | - $discount_id = wp_cache_get( $discount_code, 'getpaid_discount_codes' ); |
|
242 | - if ( ! empty( $discount_id ) ) { |
|
243 | - return $discount_id; |
|
244 | - } |
|
245 | - |
|
246 | - // Fetch the first discount codes. |
|
247 | - $discounts = get_posts( |
|
248 | - array( |
|
249 | - 'meta_key' => '_wpi_discount_code', |
|
250 | - 'meta_value' => $discount_code, |
|
251 | - 'post_type' => 'wpi_discount', |
|
252 | - 'posts_per_page' => 1, |
|
253 | - 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ), |
|
254 | - 'fields' => 'ids', |
|
255 | - ) |
|
256 | - ); |
|
257 | - |
|
258 | - if ( empty( $discounts ) ) { |
|
259 | - return 0; |
|
260 | - } |
|
261 | - |
|
262 | - $discount_id = $discounts[0]; |
|
263 | - |
|
264 | - // Update the cache with our data |
|
265 | - wp_cache_add( get_post_meta( $discount_id, '_wpi_discount_code', true ), $discount_id, 'getpaid_discount_codes' ); |
|
266 | - |
|
267 | - return $discount_id; |
|
268 | - } |
|
269 | - |
|
270 | - /** |
|
271 | - * Magic method for checking the existence of a certain custom field. |
|
272 | - * |
|
273 | - * @since 1.0.15 |
|
274 | - * @access public |
|
275 | - * |
|
276 | - * @return bool Whether the given discount field is set. |
|
277 | - */ |
|
278 | - public function __isset( $key ){ |
|
279 | - return isset( $this->data[$key] ) || method_exists( $this, "get_$key"); |
|
280 | - } |
|
281 | - |
|
282 | - /* |
|
212 | + $return = apply_filters( 'wpinv_discount_properties', $return ); |
|
213 | + |
|
214 | + // Update the cache with our data |
|
215 | + wp_cache_add( $discount->ID, $return, 'WPInv_Discounts' ); |
|
216 | + wp_cache_add( $return['code'], $discount->ID, 'WPInv_Discount_Codes' ); |
|
217 | + |
|
218 | + return $return; |
|
219 | + } |
|
220 | + |
|
221 | + /** |
|
222 | + * Given a discount code, it returns a discount id. |
|
223 | + * |
|
224 | + * |
|
225 | + * @static |
|
226 | + * @param string $discount_code |
|
227 | + * @since 1.0.15 |
|
228 | + * @return int |
|
229 | + */ |
|
230 | + public static function get_discount_id_by_code( $discount_code ) { |
|
231 | + |
|
232 | + // Trim the code. |
|
233 | + $discount_code = trim( $discount_code ); |
|
234 | + |
|
235 | + // Ensure a value has been passed. |
|
236 | + if ( empty( $discount_code ) ) { |
|
237 | + return 0; |
|
238 | + } |
|
239 | + |
|
240 | + // Maybe retrieve from the cache. |
|
241 | + $discount_id = wp_cache_get( $discount_code, 'getpaid_discount_codes' ); |
|
242 | + if ( ! empty( $discount_id ) ) { |
|
243 | + return $discount_id; |
|
244 | + } |
|
245 | + |
|
246 | + // Fetch the first discount codes. |
|
247 | + $discounts = get_posts( |
|
248 | + array( |
|
249 | + 'meta_key' => '_wpi_discount_code', |
|
250 | + 'meta_value' => $discount_code, |
|
251 | + 'post_type' => 'wpi_discount', |
|
252 | + 'posts_per_page' => 1, |
|
253 | + 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ), |
|
254 | + 'fields' => 'ids', |
|
255 | + ) |
|
256 | + ); |
|
257 | + |
|
258 | + if ( empty( $discounts ) ) { |
|
259 | + return 0; |
|
260 | + } |
|
261 | + |
|
262 | + $discount_id = $discounts[0]; |
|
263 | + |
|
264 | + // Update the cache with our data |
|
265 | + wp_cache_add( get_post_meta( $discount_id, '_wpi_discount_code', true ), $discount_id, 'getpaid_discount_codes' ); |
|
266 | + |
|
267 | + return $discount_id; |
|
268 | + } |
|
269 | + |
|
270 | + /** |
|
271 | + * Magic method for checking the existence of a certain custom field. |
|
272 | + * |
|
273 | + * @since 1.0.15 |
|
274 | + * @access public |
|
275 | + * |
|
276 | + * @return bool Whether the given discount field is set. |
|
277 | + */ |
|
278 | + public function __isset( $key ){ |
|
279 | + return isset( $this->data[$key] ) || method_exists( $this, "get_$key"); |
|
280 | + } |
|
281 | + |
|
282 | + /* |
|
283 | 283 | |-------------------------------------------------------------------------- |
284 | 284 | | CRUD methods |
285 | 285 | |-------------------------------------------------------------------------- |
@@ -294,430 +294,430 @@ discard block |
||
294 | 294 | |-------------------------------------------------------------------------- |
295 | 295 | */ |
296 | 296 | |
297 | - /** |
|
298 | - * Get discount status. |
|
299 | - * |
|
300 | - * @since 1.0.19 |
|
301 | - * @param string $context View or edit context. |
|
302 | - * @return string |
|
303 | - */ |
|
304 | - public function get_status( $context = 'view' ) { |
|
305 | - return $this->get_prop( 'status', $context ); |
|
297 | + /** |
|
298 | + * Get discount status. |
|
299 | + * |
|
300 | + * @since 1.0.19 |
|
301 | + * @param string $context View or edit context. |
|
302 | + * @return string |
|
303 | + */ |
|
304 | + public function get_status( $context = 'view' ) { |
|
305 | + return $this->get_prop( 'status', $context ); |
|
306 | 306 | } |
307 | 307 | |
308 | 308 | /** |
309 | - * Get plugin version when the discount was created. |
|
310 | - * |
|
311 | - * @since 1.0.19 |
|
312 | - * @param string $context View or edit context. |
|
313 | - * @return string |
|
314 | - */ |
|
315 | - public function get_version( $context = 'view' ) { |
|
316 | - return $this->get_prop( 'version', $context ); |
|
309 | + * Get plugin version when the discount was created. |
|
310 | + * |
|
311 | + * @since 1.0.19 |
|
312 | + * @param string $context View or edit context. |
|
313 | + * @return string |
|
314 | + */ |
|
315 | + public function get_version( $context = 'view' ) { |
|
316 | + return $this->get_prop( 'version', $context ); |
|
317 | 317 | } |
318 | 318 | |
319 | 319 | /** |
320 | - * Get date when the discount was created. |
|
321 | - * |
|
322 | - * @since 1.0.19 |
|
323 | - * @param string $context View or edit context. |
|
324 | - * @return string |
|
325 | - */ |
|
326 | - public function get_date_created( $context = 'view' ) { |
|
327 | - return $this->get_prop( 'date_created', $context ); |
|
320 | + * Get date when the discount was created. |
|
321 | + * |
|
322 | + * @since 1.0.19 |
|
323 | + * @param string $context View or edit context. |
|
324 | + * @return string |
|
325 | + */ |
|
326 | + public function get_date_created( $context = 'view' ) { |
|
327 | + return $this->get_prop( 'date_created', $context ); |
|
328 | 328 | } |
329 | 329 | |
330 | 330 | /** |
331 | - * Get GMT date when the discount was created. |
|
332 | - * |
|
333 | - * @since 1.0.19 |
|
334 | - * @param string $context View or edit context. |
|
335 | - * @return string |
|
336 | - */ |
|
337 | - public function get_date_created_gmt( $context = 'view' ) { |
|
331 | + * Get GMT date when the discount was created. |
|
332 | + * |
|
333 | + * @since 1.0.19 |
|
334 | + * @param string $context View or edit context. |
|
335 | + * @return string |
|
336 | + */ |
|
337 | + public function get_date_created_gmt( $context = 'view' ) { |
|
338 | 338 | $date = $this->get_date_created( $context ); |
339 | 339 | |
340 | 340 | if ( $date ) { |
341 | 341 | $date = get_gmt_from_date( $date ); |
342 | 342 | } |
343 | - return $date; |
|
343 | + return $date; |
|
344 | 344 | } |
345 | 345 | |
346 | 346 | /** |
347 | - * Get date when the discount was last modified. |
|
348 | - * |
|
349 | - * @since 1.0.19 |
|
350 | - * @param string $context View or edit context. |
|
351 | - * @return string |
|
352 | - */ |
|
353 | - public function get_date_modified( $context = 'view' ) { |
|
354 | - return $this->get_prop( 'date_modified', $context ); |
|
347 | + * Get date when the discount was last modified. |
|
348 | + * |
|
349 | + * @since 1.0.19 |
|
350 | + * @param string $context View or edit context. |
|
351 | + * @return string |
|
352 | + */ |
|
353 | + public function get_date_modified( $context = 'view' ) { |
|
354 | + return $this->get_prop( 'date_modified', $context ); |
|
355 | 355 | } |
356 | 356 | |
357 | 357 | /** |
358 | - * Get GMT date when the discount was last modified. |
|
359 | - * |
|
360 | - * @since 1.0.19 |
|
361 | - * @param string $context View or edit context. |
|
362 | - * @return string |
|
363 | - */ |
|
364 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
358 | + * Get GMT date when the discount was last modified. |
|
359 | + * |
|
360 | + * @since 1.0.19 |
|
361 | + * @param string $context View or edit context. |
|
362 | + * @return string |
|
363 | + */ |
|
364 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
365 | 365 | $date = $this->get_date_modified( $context ); |
366 | 366 | |
367 | 367 | if ( $date ) { |
368 | 368 | $date = get_gmt_from_date( $date ); |
369 | 369 | } |
370 | - return $date; |
|
370 | + return $date; |
|
371 | 371 | } |
372 | 372 | |
373 | 373 | /** |
374 | - * Get the discount name. |
|
375 | - * |
|
376 | - * @since 1.0.19 |
|
377 | - * @param string $context View or edit context. |
|
378 | - * @return string |
|
379 | - */ |
|
380 | - public function get_name( $context = 'view' ) { |
|
381 | - return $this->get_prop( 'name', $context ); |
|
374 | + * Get the discount name. |
|
375 | + * |
|
376 | + * @since 1.0.19 |
|
377 | + * @param string $context View or edit context. |
|
378 | + * @return string |
|
379 | + */ |
|
380 | + public function get_name( $context = 'view' ) { |
|
381 | + return $this->get_prop( 'name', $context ); |
|
382 | 382 | } |
383 | 383 | |
384 | 384 | /** |
385 | - * Alias of self::get_name(). |
|
386 | - * |
|
387 | - * @since 1.0.19 |
|
388 | - * @param string $context View or edit context. |
|
389 | - * @return string |
|
390 | - */ |
|
391 | - public function get_title( $context = 'view' ) { |
|
392 | - return $this->get_name( $context ); |
|
385 | + * Alias of self::get_name(). |
|
386 | + * |
|
387 | + * @since 1.0.19 |
|
388 | + * @param string $context View or edit context. |
|
389 | + * @return string |
|
390 | + */ |
|
391 | + public function get_title( $context = 'view' ) { |
|
392 | + return $this->get_name( $context ); |
|
393 | 393 | } |
394 | 394 | |
395 | 395 | /** |
396 | - * Get the discount description. |
|
397 | - * |
|
398 | - * @since 1.0.19 |
|
399 | - * @param string $context View or edit context. |
|
400 | - * @return string |
|
401 | - */ |
|
402 | - public function get_description( $context = 'view' ) { |
|
403 | - return $this->get_prop( 'description', $context ); |
|
396 | + * Get the discount description. |
|
397 | + * |
|
398 | + * @since 1.0.19 |
|
399 | + * @param string $context View or edit context. |
|
400 | + * @return string |
|
401 | + */ |
|
402 | + public function get_description( $context = 'view' ) { |
|
403 | + return $this->get_prop( 'description', $context ); |
|
404 | 404 | } |
405 | 405 | |
406 | 406 | /** |
407 | - * Alias of self::get_description(). |
|
408 | - * |
|
409 | - * @since 1.0.19 |
|
410 | - * @param string $context View or edit context. |
|
411 | - * @return string |
|
412 | - */ |
|
413 | - public function get_excerpt( $context = 'view' ) { |
|
414 | - return $this->get_description( $context ); |
|
407 | + * Alias of self::get_description(). |
|
408 | + * |
|
409 | + * @since 1.0.19 |
|
410 | + * @param string $context View or edit context. |
|
411 | + * @return string |
|
412 | + */ |
|
413 | + public function get_excerpt( $context = 'view' ) { |
|
414 | + return $this->get_description( $context ); |
|
415 | 415 | } |
416 | 416 | |
417 | 417 | /** |
418 | - * Alias of self::get_description(). |
|
419 | - * |
|
420 | - * @since 1.0.19 |
|
421 | - * @param string $context View or edit context. |
|
422 | - * @return string |
|
423 | - */ |
|
424 | - public function get_summary( $context = 'view' ) { |
|
425 | - return $this->get_description( $context ); |
|
418 | + * Alias of self::get_description(). |
|
419 | + * |
|
420 | + * @since 1.0.19 |
|
421 | + * @param string $context View or edit context. |
|
422 | + * @return string |
|
423 | + */ |
|
424 | + public function get_summary( $context = 'view' ) { |
|
425 | + return $this->get_description( $context ); |
|
426 | 426 | } |
427 | 427 | |
428 | 428 | /** |
429 | - * Get the owner of the discount. |
|
430 | - * |
|
431 | - * @since 1.0.19 |
|
432 | - * @param string $context View or edit context. |
|
433 | - * @return string |
|
434 | - */ |
|
435 | - public function get_author( $context = 'view' ) { |
|
436 | - return (int) $this->get_prop( 'author', $context ); |
|
437 | - } |
|
429 | + * Get the owner of the discount. |
|
430 | + * |
|
431 | + * @since 1.0.19 |
|
432 | + * @param string $context View or edit context. |
|
433 | + * @return string |
|
434 | + */ |
|
435 | + public function get_author( $context = 'view' ) { |
|
436 | + return (int) $this->get_prop( 'author', $context ); |
|
437 | + } |
|
438 | 438 | |
439 | - /** |
|
440 | - * Get the discount code. |
|
441 | - * |
|
442 | - * @since 1.0.19 |
|
443 | - * @param string $context View or edit context. |
|
444 | - * @return string |
|
445 | - */ |
|
446 | - public function get_code( $context = 'view' ) { |
|
447 | - return $this->get_prop( 'code', $context ); |
|
448 | - } |
|
439 | + /** |
|
440 | + * Get the discount code. |
|
441 | + * |
|
442 | + * @since 1.0.19 |
|
443 | + * @param string $context View or edit context. |
|
444 | + * @return string |
|
445 | + */ |
|
446 | + public function get_code( $context = 'view' ) { |
|
447 | + return $this->get_prop( 'code', $context ); |
|
448 | + } |
|
449 | 449 | |
450 | - /** |
|
451 | - * Alias for self::get_code(). |
|
452 | - * |
|
453 | - * @since 1.0.19 |
|
454 | - * @param string $context View or edit context. |
|
455 | - * @return string |
|
456 | - */ |
|
457 | - public function get_coupon_code( $context = 'view' ) { |
|
458 | - return $this->get_code( $context ); |
|
459 | - } |
|
450 | + /** |
|
451 | + * Alias for self::get_code(). |
|
452 | + * |
|
453 | + * @since 1.0.19 |
|
454 | + * @param string $context View or edit context. |
|
455 | + * @return string |
|
456 | + */ |
|
457 | + public function get_coupon_code( $context = 'view' ) { |
|
458 | + return $this->get_code( $context ); |
|
459 | + } |
|
460 | 460 | |
461 | - /** |
|
462 | - * Alias for self::get_code(). |
|
463 | - * |
|
464 | - * @since 1.0.19 |
|
465 | - * @param string $context View or edit context. |
|
466 | - * @return string |
|
467 | - */ |
|
468 | - public function get_discount_code( $context = 'view' ) { |
|
469 | - return $this->get_code( $context ); |
|
470 | - } |
|
461 | + /** |
|
462 | + * Alias for self::get_code(). |
|
463 | + * |
|
464 | + * @since 1.0.19 |
|
465 | + * @param string $context View or edit context. |
|
466 | + * @return string |
|
467 | + */ |
|
468 | + public function get_discount_code( $context = 'view' ) { |
|
469 | + return $this->get_code( $context ); |
|
470 | + } |
|
471 | 471 | |
472 | - /** |
|
473 | - * Get the discount's amount. |
|
474 | - * |
|
475 | - * @since 1.0.19 |
|
476 | - * @param string $context View or edit context. |
|
477 | - * @return float |
|
478 | - */ |
|
479 | - public function get_amount( $context = 'view' ) { |
|
480 | - return $context == 'view' ? floatval( $this->get_prop( 'amount', $context ) ) : $this->get_prop( 'amount', $context ); |
|
481 | - } |
|
482 | - |
|
483 | - /** |
|
484 | - * Get the discount's formated amount/rate. |
|
485 | - * |
|
486 | - * @since 1.0.19 |
|
487 | - * @return string |
|
488 | - */ |
|
489 | - public function get_formatted_amount() { |
|
490 | - |
|
491 | - if ( $this->is_type( 'flat' ) ) { |
|
492 | - $rate = wpinv_price( $this->get_amount() ); |
|
493 | - } else { |
|
494 | - $rate = $this->get_amount() . '%'; |
|
495 | - } |
|
496 | - |
|
497 | - return apply_filters( 'wpinv_format_discount_rate', $rate, $this->get_type(), $this->get_amount() ); |
|
498 | - } |
|
472 | + /** |
|
473 | + * Get the discount's amount. |
|
474 | + * |
|
475 | + * @since 1.0.19 |
|
476 | + * @param string $context View or edit context. |
|
477 | + * @return float |
|
478 | + */ |
|
479 | + public function get_amount( $context = 'view' ) { |
|
480 | + return $context == 'view' ? floatval( $this->get_prop( 'amount', $context ) ) : $this->get_prop( 'amount', $context ); |
|
481 | + } |
|
482 | + |
|
483 | + /** |
|
484 | + * Get the discount's formated amount/rate. |
|
485 | + * |
|
486 | + * @since 1.0.19 |
|
487 | + * @return string |
|
488 | + */ |
|
489 | + public function get_formatted_amount() { |
|
490 | + |
|
491 | + if ( $this->is_type( 'flat' ) ) { |
|
492 | + $rate = wpinv_price( $this->get_amount() ); |
|
493 | + } else { |
|
494 | + $rate = $this->get_amount() . '%'; |
|
495 | + } |
|
496 | + |
|
497 | + return apply_filters( 'wpinv_format_discount_rate', $rate, $this->get_type(), $this->get_amount() ); |
|
498 | + } |
|
499 | 499 | |
500 | - /** |
|
501 | - * Get the discount's start date. |
|
502 | - * |
|
503 | - * @since 1.0.19 |
|
504 | - * @param string $context View or edit context. |
|
505 | - * @return string |
|
506 | - */ |
|
507 | - public function get_start( $context = 'view' ) { |
|
508 | - return $this->get_prop( 'start', $context ); |
|
509 | - } |
|
500 | + /** |
|
501 | + * Get the discount's start date. |
|
502 | + * |
|
503 | + * @since 1.0.19 |
|
504 | + * @param string $context View or edit context. |
|
505 | + * @return string |
|
506 | + */ |
|
507 | + public function get_start( $context = 'view' ) { |
|
508 | + return $this->get_prop( 'start', $context ); |
|
509 | + } |
|
510 | 510 | |
511 | - /** |
|
512 | - * Alias for self::get_start(). |
|
513 | - * |
|
514 | - * @since 1.0.19 |
|
515 | - * @param string $context View or edit context. |
|
516 | - * @return string |
|
517 | - */ |
|
518 | - public function get_start_date( $context = 'view' ) { |
|
519 | - return $this->get_start( $context ); |
|
520 | - } |
|
511 | + /** |
|
512 | + * Alias for self::get_start(). |
|
513 | + * |
|
514 | + * @since 1.0.19 |
|
515 | + * @param string $context View or edit context. |
|
516 | + * @return string |
|
517 | + */ |
|
518 | + public function get_start_date( $context = 'view' ) { |
|
519 | + return $this->get_start( $context ); |
|
520 | + } |
|
521 | 521 | |
522 | - /** |
|
523 | - * Get the discount's expiration date. |
|
524 | - * |
|
525 | - * @since 1.0.19 |
|
526 | - * @param string $context View or edit context. |
|
527 | - * @return string |
|
528 | - */ |
|
529 | - public function get_expiration( $context = 'view' ) { |
|
530 | - return $this->get_prop( 'expiration', $context ); |
|
531 | - } |
|
522 | + /** |
|
523 | + * Get the discount's expiration date. |
|
524 | + * |
|
525 | + * @since 1.0.19 |
|
526 | + * @param string $context View or edit context. |
|
527 | + * @return string |
|
528 | + */ |
|
529 | + public function get_expiration( $context = 'view' ) { |
|
530 | + return $this->get_prop( 'expiration', $context ); |
|
531 | + } |
|
532 | 532 | |
533 | - /** |
|
534 | - * Alias for self::get_expiration(). |
|
535 | - * |
|
536 | - * @since 1.0.19 |
|
537 | - * @param string $context View or edit context. |
|
538 | - * @return string |
|
539 | - */ |
|
540 | - public function get_expiration_date( $context = 'view' ) { |
|
541 | - return $this->get_expiration( $context ); |
|
542 | - } |
|
543 | - |
|
544 | - /** |
|
545 | - * Alias for self::get_expiration(). |
|
546 | - * |
|
547 | - * @since 1.0.19 |
|
548 | - * @param string $context View or edit context. |
|
549 | - * @return string |
|
550 | - */ |
|
551 | - public function get_end_date( $context = 'view' ) { |
|
552 | - return $this->get_expiration( $context ); |
|
553 | - } |
|
533 | + /** |
|
534 | + * Alias for self::get_expiration(). |
|
535 | + * |
|
536 | + * @since 1.0.19 |
|
537 | + * @param string $context View or edit context. |
|
538 | + * @return string |
|
539 | + */ |
|
540 | + public function get_expiration_date( $context = 'view' ) { |
|
541 | + return $this->get_expiration( $context ); |
|
542 | + } |
|
543 | + |
|
544 | + /** |
|
545 | + * Alias for self::get_expiration(). |
|
546 | + * |
|
547 | + * @since 1.0.19 |
|
548 | + * @param string $context View or edit context. |
|
549 | + * @return string |
|
550 | + */ |
|
551 | + public function get_end_date( $context = 'view' ) { |
|
552 | + return $this->get_expiration( $context ); |
|
553 | + } |
|
554 | 554 | |
555 | - /** |
|
556 | - * Get the discount's type. |
|
557 | - * |
|
558 | - * @since 1.0.19 |
|
559 | - * @param string $context View or edit context. |
|
560 | - * @return string |
|
561 | - */ |
|
562 | - public function get_type( $context = 'view' ) { |
|
563 | - return $this->get_prop( 'type', $context ); |
|
564 | - } |
|
565 | - |
|
566 | - /** |
|
567 | - * Get the number of times a discount has been used. |
|
568 | - * |
|
569 | - * @since 1.0.19 |
|
570 | - * @param string $context View or edit context. |
|
571 | - * @return int |
|
572 | - */ |
|
573 | - public function get_uses( $context = 'view' ) { |
|
574 | - return (int) $this->get_prop( 'uses', $context ); |
|
575 | - } |
|
576 | - |
|
577 | - /** |
|
578 | - * Get the discount's usage, i.e uses / max uses. |
|
579 | - * |
|
580 | - * @since 1.0.19 |
|
581 | - * @return string |
|
582 | - */ |
|
583 | - public function get_usage() { |
|
584 | - |
|
585 | - if ( ! $this->has_limit() ) { |
|
586 | - return $this->get_uses() . ' / ' . ' ∞'; |
|
587 | - } |
|
588 | - |
|
589 | - return $this->get_uses() . ' / ' . (int) $this->get_max_uses(); |
|
590 | - |
|
591 | - } |
|
592 | - |
|
593 | - /** |
|
594 | - * Get the maximum number of time a discount can be used. |
|
595 | - * |
|
596 | - * @since 1.0.19 |
|
597 | - * @param string $context View or edit context. |
|
598 | - * @return int |
|
599 | - */ |
|
600 | - public function get_max_uses( $context = 'view' ) { |
|
601 | - $max_uses = $this->get_prop( 'max_uses', $context ); |
|
602 | - return empty( $max_uses ) ? null : $max_uses; |
|
603 | - } |
|
604 | - |
|
605 | - /** |
|
606 | - * Checks if this is a single use discount or not. |
|
607 | - * |
|
608 | - * @since 1.0.19 |
|
609 | - * @param string $context View or edit context. |
|
610 | - * @return bool |
|
611 | - */ |
|
612 | - public function get_is_single_use( $context = 'view' ) { |
|
613 | - return $this->get_prop( 'is_single_use', $context ); |
|
614 | - } |
|
615 | - |
|
616 | - /** |
|
617 | - * Get the items that can be used with this discount. |
|
618 | - * |
|
619 | - * @since 1.0.19 |
|
620 | - * @param string $context View or edit context. |
|
621 | - * @return array |
|
622 | - */ |
|
623 | - public function get_items( $context = 'view' ) { |
|
624 | - return wpinv_parse_list( $this->get_prop( 'items', $context ) ); |
|
625 | - } |
|
626 | - |
|
627 | - /** |
|
628 | - * Alias for self::get_items(). |
|
629 | - * |
|
630 | - * @since 1.0.19 |
|
631 | - * @param string $context View or edit context. |
|
632 | - * @return array |
|
633 | - */ |
|
634 | - public function get_allowed_items( $context = 'view' ) { |
|
635 | - return $this->get_items( $context ); |
|
636 | - } |
|
637 | - |
|
638 | - /** |
|
639 | - * Get the items that are not allowed to use this discount. |
|
640 | - * |
|
641 | - * @since 1.0.19 |
|
642 | - * @param string $context View or edit context. |
|
643 | - * @return array |
|
644 | - */ |
|
645 | - public function get_excluded_items( $context = 'view' ) { |
|
646 | - return wpinv_parse_list( $this->get_prop( 'excluded_items', $context ) ); |
|
647 | - } |
|
648 | - |
|
649 | - /** |
|
650 | - * Checks if this is a recurring discount or not. |
|
651 | - * |
|
652 | - * @since 1.0.19 |
|
653 | - * @param string $context View or edit context. |
|
654 | - * @return int|string|bool |
|
655 | - */ |
|
656 | - public function get_is_recurring( $context = 'view' ) { |
|
657 | - return $this->get_prop( 'is_recurring', $context ); |
|
658 | - } |
|
659 | - |
|
660 | - /** |
|
661 | - * Get's the minimum total amount allowed for this discount. |
|
662 | - * |
|
663 | - * @since 1.0.19 |
|
664 | - * @param string $context View or edit context. |
|
665 | - * @return float |
|
666 | - */ |
|
667 | - public function get_min_total( $context = 'view' ) { |
|
668 | - $minimum = $this->get_prop( 'min_total', $context ); |
|
669 | - return empty( $minimum ) ? null : $minimum; |
|
670 | - } |
|
671 | - |
|
672 | - /** |
|
673 | - * Alias for self::get_min_total(). |
|
674 | - * |
|
675 | - * @since 1.0.19 |
|
676 | - * @param string $context View or edit context. |
|
677 | - * @return float |
|
678 | - */ |
|
679 | - public function get_minimum_total( $context = 'view' ) { |
|
680 | - return $this->get_min_total( $context ); |
|
681 | - } |
|
682 | - |
|
683 | - /** |
|
684 | - * Get's the maximum total amount allowed for this discount. |
|
685 | - * |
|
686 | - * @since 1.0.19 |
|
687 | - * @param string $context View or edit context. |
|
688 | - * @return float |
|
689 | - */ |
|
690 | - public function get_max_total( $context = 'view' ) { |
|
691 | - $maximum = $this->get_prop( 'max_total', $context ); |
|
692 | - return empty( $maximum ) ? null : $maximum; |
|
693 | - } |
|
694 | - |
|
695 | - /** |
|
696 | - * Alias for self::get_max_total(). |
|
697 | - * |
|
698 | - * @since 1.0.19 |
|
699 | - * @param string $context View or edit context. |
|
700 | - * @return float |
|
701 | - */ |
|
702 | - public function get_maximum_total( $context = 'view' ) { |
|
703 | - return $this->get_max_total( $context ); |
|
704 | - } |
|
705 | - |
|
706 | - /** |
|
707 | - * Magic method for accessing discount properties. |
|
708 | - * |
|
709 | - * @since 1.0.15 |
|
710 | - * @access public |
|
711 | - * |
|
712 | - * @param string $key Discount data to retrieve |
|
713 | - * @param string $context View or edit context. |
|
714 | - * @return mixed Value of the given discount property (if set). |
|
715 | - */ |
|
716 | - public function get( $key, $context = 'view' ) { |
|
555 | + /** |
|
556 | + * Get the discount's type. |
|
557 | + * |
|
558 | + * @since 1.0.19 |
|
559 | + * @param string $context View or edit context. |
|
560 | + * @return string |
|
561 | + */ |
|
562 | + public function get_type( $context = 'view' ) { |
|
563 | + return $this->get_prop( 'type', $context ); |
|
564 | + } |
|
565 | + |
|
566 | + /** |
|
567 | + * Get the number of times a discount has been used. |
|
568 | + * |
|
569 | + * @since 1.0.19 |
|
570 | + * @param string $context View or edit context. |
|
571 | + * @return int |
|
572 | + */ |
|
573 | + public function get_uses( $context = 'view' ) { |
|
574 | + return (int) $this->get_prop( 'uses', $context ); |
|
575 | + } |
|
576 | + |
|
577 | + /** |
|
578 | + * Get the discount's usage, i.e uses / max uses. |
|
579 | + * |
|
580 | + * @since 1.0.19 |
|
581 | + * @return string |
|
582 | + */ |
|
583 | + public function get_usage() { |
|
584 | + |
|
585 | + if ( ! $this->has_limit() ) { |
|
586 | + return $this->get_uses() . ' / ' . ' ∞'; |
|
587 | + } |
|
588 | + |
|
589 | + return $this->get_uses() . ' / ' . (int) $this->get_max_uses(); |
|
590 | + |
|
591 | + } |
|
592 | + |
|
593 | + /** |
|
594 | + * Get the maximum number of time a discount can be used. |
|
595 | + * |
|
596 | + * @since 1.0.19 |
|
597 | + * @param string $context View or edit context. |
|
598 | + * @return int |
|
599 | + */ |
|
600 | + public function get_max_uses( $context = 'view' ) { |
|
601 | + $max_uses = $this->get_prop( 'max_uses', $context ); |
|
602 | + return empty( $max_uses ) ? null : $max_uses; |
|
603 | + } |
|
604 | + |
|
605 | + /** |
|
606 | + * Checks if this is a single use discount or not. |
|
607 | + * |
|
608 | + * @since 1.0.19 |
|
609 | + * @param string $context View or edit context. |
|
610 | + * @return bool |
|
611 | + */ |
|
612 | + public function get_is_single_use( $context = 'view' ) { |
|
613 | + return $this->get_prop( 'is_single_use', $context ); |
|
614 | + } |
|
615 | + |
|
616 | + /** |
|
617 | + * Get the items that can be used with this discount. |
|
618 | + * |
|
619 | + * @since 1.0.19 |
|
620 | + * @param string $context View or edit context. |
|
621 | + * @return array |
|
622 | + */ |
|
623 | + public function get_items( $context = 'view' ) { |
|
624 | + return wpinv_parse_list( $this->get_prop( 'items', $context ) ); |
|
625 | + } |
|
626 | + |
|
627 | + /** |
|
628 | + * Alias for self::get_items(). |
|
629 | + * |
|
630 | + * @since 1.0.19 |
|
631 | + * @param string $context View or edit context. |
|
632 | + * @return array |
|
633 | + */ |
|
634 | + public function get_allowed_items( $context = 'view' ) { |
|
635 | + return $this->get_items( $context ); |
|
636 | + } |
|
637 | + |
|
638 | + /** |
|
639 | + * Get the items that are not allowed to use this discount. |
|
640 | + * |
|
641 | + * @since 1.0.19 |
|
642 | + * @param string $context View or edit context. |
|
643 | + * @return array |
|
644 | + */ |
|
645 | + public function get_excluded_items( $context = 'view' ) { |
|
646 | + return wpinv_parse_list( $this->get_prop( 'excluded_items', $context ) ); |
|
647 | + } |
|
648 | + |
|
649 | + /** |
|
650 | + * Checks if this is a recurring discount or not. |
|
651 | + * |
|
652 | + * @since 1.0.19 |
|
653 | + * @param string $context View or edit context. |
|
654 | + * @return int|string|bool |
|
655 | + */ |
|
656 | + public function get_is_recurring( $context = 'view' ) { |
|
657 | + return $this->get_prop( 'is_recurring', $context ); |
|
658 | + } |
|
659 | + |
|
660 | + /** |
|
661 | + * Get's the minimum total amount allowed for this discount. |
|
662 | + * |
|
663 | + * @since 1.0.19 |
|
664 | + * @param string $context View or edit context. |
|
665 | + * @return float |
|
666 | + */ |
|
667 | + public function get_min_total( $context = 'view' ) { |
|
668 | + $minimum = $this->get_prop( 'min_total', $context ); |
|
669 | + return empty( $minimum ) ? null : $minimum; |
|
670 | + } |
|
671 | + |
|
672 | + /** |
|
673 | + * Alias for self::get_min_total(). |
|
674 | + * |
|
675 | + * @since 1.0.19 |
|
676 | + * @param string $context View or edit context. |
|
677 | + * @return float |
|
678 | + */ |
|
679 | + public function get_minimum_total( $context = 'view' ) { |
|
680 | + return $this->get_min_total( $context ); |
|
681 | + } |
|
682 | + |
|
683 | + /** |
|
684 | + * Get's the maximum total amount allowed for this discount. |
|
685 | + * |
|
686 | + * @since 1.0.19 |
|
687 | + * @param string $context View or edit context. |
|
688 | + * @return float |
|
689 | + */ |
|
690 | + public function get_max_total( $context = 'view' ) { |
|
691 | + $maximum = $this->get_prop( 'max_total', $context ); |
|
692 | + return empty( $maximum ) ? null : $maximum; |
|
693 | + } |
|
694 | + |
|
695 | + /** |
|
696 | + * Alias for self::get_max_total(). |
|
697 | + * |
|
698 | + * @since 1.0.19 |
|
699 | + * @param string $context View or edit context. |
|
700 | + * @return float |
|
701 | + */ |
|
702 | + public function get_maximum_total( $context = 'view' ) { |
|
703 | + return $this->get_max_total( $context ); |
|
704 | + } |
|
705 | + |
|
706 | + /** |
|
707 | + * Magic method for accessing discount properties. |
|
708 | + * |
|
709 | + * @since 1.0.15 |
|
710 | + * @access public |
|
711 | + * |
|
712 | + * @param string $key Discount data to retrieve |
|
713 | + * @param string $context View or edit context. |
|
714 | + * @return mixed Value of the given discount property (if set). |
|
715 | + */ |
|
716 | + public function get( $key, $context = 'view' ) { |
|
717 | 717 | return $this->get_prop( $key, $context ); |
718 | - } |
|
718 | + } |
|
719 | 719 | |
720 | - /* |
|
720 | + /* |
|
721 | 721 | |-------------------------------------------------------------------------- |
722 | 722 | | Setters |
723 | 723 | |-------------------------------------------------------------------------- |
@@ -727,41 +727,41 @@ discard block |
||
727 | 727 | | object. |
728 | 728 | */ |
729 | 729 | |
730 | - /** |
|
731 | - * Sets discount status. |
|
732 | - * |
|
733 | - * @since 1.0.19 |
|
734 | - * @param string $status New status. |
|
735 | - * @return array details of change. |
|
736 | - */ |
|
737 | - public function set_status( $status ) { |
|
730 | + /** |
|
731 | + * Sets discount status. |
|
732 | + * |
|
733 | + * @since 1.0.19 |
|
734 | + * @param string $status New status. |
|
735 | + * @return array details of change. |
|
736 | + */ |
|
737 | + public function set_status( $status ) { |
|
738 | 738 | $old_status = $this->get_status(); |
739 | 739 | |
740 | 740 | $this->set_prop( 'status', $status ); |
741 | 741 | |
742 | - return array( |
|
743 | - 'from' => $old_status, |
|
744 | - 'to' => $status, |
|
745 | - ); |
|
742 | + return array( |
|
743 | + 'from' => $old_status, |
|
744 | + 'to' => $status, |
|
745 | + ); |
|
746 | 746 | } |
747 | 747 | |
748 | 748 | /** |
749 | - * Set plugin version when the discount was created. |
|
750 | - * |
|
751 | - * @since 1.0.19 |
|
752 | - */ |
|
753 | - public function set_version( $value ) { |
|
754 | - $this->set_prop( 'version', $value ); |
|
749 | + * Set plugin version when the discount was created. |
|
750 | + * |
|
751 | + * @since 1.0.19 |
|
752 | + */ |
|
753 | + public function set_version( $value ) { |
|
754 | + $this->set_prop( 'version', $value ); |
|
755 | 755 | } |
756 | 756 | |
757 | 757 | /** |
758 | - * Set date when the discount was created. |
|
759 | - * |
|
760 | - * @since 1.0.19 |
|
761 | - * @param string $value Value to set. |
|
758 | + * Set date when the discount was created. |
|
759 | + * |
|
760 | + * @since 1.0.19 |
|
761 | + * @param string $value Value to set. |
|
762 | 762 | * @return bool Whether or not the date was set. |
763 | - */ |
|
764 | - public function set_date_created( $value ) { |
|
763 | + */ |
|
764 | + public function set_date_created( $value ) { |
|
765 | 765 | $date = strtotime( $value ); |
766 | 766 | |
767 | 767 | if ( $date ) { |
@@ -774,13 +774,13 @@ discard block |
||
774 | 774 | } |
775 | 775 | |
776 | 776 | /** |
777 | - * Set date when the discount was last modified. |
|
778 | - * |
|
779 | - * @since 1.0.19 |
|
780 | - * @param string $value Value to set. |
|
777 | + * Set date when the discount was last modified. |
|
778 | + * |
|
779 | + * @since 1.0.19 |
|
780 | + * @param string $value Value to set. |
|
781 | 781 | * @return bool Whether or not the date was set. |
782 | - */ |
|
783 | - public function set_date_modified( $value ) { |
|
782 | + */ |
|
783 | + public function set_date_modified( $value ) { |
|
784 | 784 | $date = strtotime( $value ); |
785 | 785 | |
786 | 786 | if ( $date ) { |
@@ -793,324 +793,324 @@ discard block |
||
793 | 793 | } |
794 | 794 | |
795 | 795 | /** |
796 | - * Set the discount name. |
|
797 | - * |
|
798 | - * @since 1.0.19 |
|
799 | - * @param string $value New name. |
|
800 | - */ |
|
801 | - public function set_name( $value ) { |
|
796 | + * Set the discount name. |
|
797 | + * |
|
798 | + * @since 1.0.19 |
|
799 | + * @param string $value New name. |
|
800 | + */ |
|
801 | + public function set_name( $value ) { |
|
802 | 802 | $name = sanitize_text_field( $value ); |
803 | - $this->set_prop( 'name', $name ); |
|
803 | + $this->set_prop( 'name', $name ); |
|
804 | 804 | } |
805 | 805 | |
806 | 806 | /** |
807 | - * Alias of self::set_name(). |
|
808 | - * |
|
809 | - * @since 1.0.19 |
|
810 | - * @param string $value New name. |
|
811 | - */ |
|
812 | - public function set_title( $value ) { |
|
813 | - $this->set_name( $value ); |
|
807 | + * Alias of self::set_name(). |
|
808 | + * |
|
809 | + * @since 1.0.19 |
|
810 | + * @param string $value New name. |
|
811 | + */ |
|
812 | + public function set_title( $value ) { |
|
813 | + $this->set_name( $value ); |
|
814 | 814 | } |
815 | 815 | |
816 | 816 | /** |
817 | - * Set the discount description. |
|
818 | - * |
|
819 | - * @since 1.0.19 |
|
820 | - * @param string $value New description. |
|
821 | - */ |
|
822 | - public function set_description( $value ) { |
|
817 | + * Set the discount description. |
|
818 | + * |
|
819 | + * @since 1.0.19 |
|
820 | + * @param string $value New description. |
|
821 | + */ |
|
822 | + public function set_description( $value ) { |
|
823 | 823 | $description = wp_kses_post( $value ); |
824 | - return $this->set_prop( 'description', $description ); |
|
824 | + return $this->set_prop( 'description', $description ); |
|
825 | 825 | } |
826 | 826 | |
827 | 827 | /** |
828 | - * Alias of self::set_description(). |
|
829 | - * |
|
830 | - * @since 1.0.19 |
|
831 | - * @param string $value New description. |
|
832 | - */ |
|
833 | - public function set_excerpt( $value ) { |
|
834 | - $this->set_description( $value ); |
|
828 | + * Alias of self::set_description(). |
|
829 | + * |
|
830 | + * @since 1.0.19 |
|
831 | + * @param string $value New description. |
|
832 | + */ |
|
833 | + public function set_excerpt( $value ) { |
|
834 | + $this->set_description( $value ); |
|
835 | 835 | } |
836 | 836 | |
837 | 837 | /** |
838 | - * Alias of self::set_description(). |
|
839 | - * |
|
840 | - * @since 1.0.19 |
|
841 | - * @param string $value New description. |
|
842 | - */ |
|
843 | - public function set_summary( $value ) { |
|
844 | - $this->set_description( $value ); |
|
838 | + * Alias of self::set_description(). |
|
839 | + * |
|
840 | + * @since 1.0.19 |
|
841 | + * @param string $value New description. |
|
842 | + */ |
|
843 | + public function set_summary( $value ) { |
|
844 | + $this->set_description( $value ); |
|
845 | 845 | } |
846 | 846 | |
847 | 847 | /** |
848 | - * Set the owner of the discount. |
|
849 | - * |
|
850 | - * @since 1.0.19 |
|
851 | - * @param int $value New author. |
|
852 | - */ |
|
853 | - public function set_author( $value ) { |
|
854 | - $this->set_prop( 'author', (int) $value ); |
|
855 | - } |
|
848 | + * Set the owner of the discount. |
|
849 | + * |
|
850 | + * @since 1.0.19 |
|
851 | + * @param int $value New author. |
|
852 | + */ |
|
853 | + public function set_author( $value ) { |
|
854 | + $this->set_prop( 'author', (int) $value ); |
|
855 | + } |
|
856 | 856 | |
857 | - /** |
|
858 | - * Sets the discount code. |
|
859 | - * |
|
860 | - * @since 1.0.19 |
|
861 | - * @param string $value New discount code. |
|
862 | - */ |
|
863 | - public function set_code( $value ) { |
|
864 | - $code = sanitize_text_field( $value ); |
|
865 | - $this->set_prop( 'code', $code ); |
|
866 | - } |
|
857 | + /** |
|
858 | + * Sets the discount code. |
|
859 | + * |
|
860 | + * @since 1.0.19 |
|
861 | + * @param string $value New discount code. |
|
862 | + */ |
|
863 | + public function set_code( $value ) { |
|
864 | + $code = sanitize_text_field( $value ); |
|
865 | + $this->set_prop( 'code', $code ); |
|
866 | + } |
|
867 | 867 | |
868 | - /** |
|
869 | - * Alias of self::set_code(). |
|
870 | - * |
|
871 | - * @since 1.0.19 |
|
872 | - * @param string $value New discount code. |
|
873 | - */ |
|
874 | - public function set_coupon_code( $value ) { |
|
875 | - $this->set_code( $value ); |
|
876 | - } |
|
868 | + /** |
|
869 | + * Alias of self::set_code(). |
|
870 | + * |
|
871 | + * @since 1.0.19 |
|
872 | + * @param string $value New discount code. |
|
873 | + */ |
|
874 | + public function set_coupon_code( $value ) { |
|
875 | + $this->set_code( $value ); |
|
876 | + } |
|
877 | 877 | |
878 | - /** |
|
879 | - * Alias of self::set_code(). |
|
880 | - * |
|
881 | - * @since 1.0.19 |
|
882 | - * @param string $value New discount code. |
|
883 | - */ |
|
884 | - public function set_discount_code( $value ) { |
|
885 | - $this->set_code( $value ); |
|
886 | - } |
|
878 | + /** |
|
879 | + * Alias of self::set_code(). |
|
880 | + * |
|
881 | + * @since 1.0.19 |
|
882 | + * @param string $value New discount code. |
|
883 | + */ |
|
884 | + public function set_discount_code( $value ) { |
|
885 | + $this->set_code( $value ); |
|
886 | + } |
|
887 | 887 | |
888 | - /** |
|
889 | - * Sets the discount amount. |
|
890 | - * |
|
891 | - * @since 1.0.19 |
|
892 | - * @param float $value New discount code. |
|
893 | - */ |
|
894 | - public function set_amount( $value ) { |
|
895 | - $amount = floatval( wpinv_sanitize_amount( $value ) ); |
|
896 | - $this->set_prop( 'amount', $amount ); |
|
897 | - } |
|
898 | - |
|
899 | - /** |
|
900 | - * Sets the discount's start date. |
|
901 | - * |
|
902 | - * @since 1.0.19 |
|
903 | - * @param float $value New start date. |
|
904 | - */ |
|
905 | - public function set_start( $value ) { |
|
906 | - $date = strtotime( $value ); |
|
888 | + /** |
|
889 | + * Sets the discount amount. |
|
890 | + * |
|
891 | + * @since 1.0.19 |
|
892 | + * @param float $value New discount code. |
|
893 | + */ |
|
894 | + public function set_amount( $value ) { |
|
895 | + $amount = floatval( wpinv_sanitize_amount( $value ) ); |
|
896 | + $this->set_prop( 'amount', $amount ); |
|
897 | + } |
|
907 | 898 | |
908 | - if ( $date ) { |
|
909 | - $this->set_prop( 'start', date( 'Y-m-d H:i', $date ) ); |
|
910 | - return true; |
|
911 | - } |
|
899 | + /** |
|
900 | + * Sets the discount's start date. |
|
901 | + * |
|
902 | + * @since 1.0.19 |
|
903 | + * @param float $value New start date. |
|
904 | + */ |
|
905 | + public function set_start( $value ) { |
|
906 | + $date = strtotime( $value ); |
|
907 | + |
|
908 | + if ( $date ) { |
|
909 | + $this->set_prop( 'start', date( 'Y-m-d H:i', $date ) ); |
|
910 | + return true; |
|
911 | + } |
|
912 | 912 | |
913 | - $this->set_prop( 'start', '' ); |
|
913 | + $this->set_prop( 'start', '' ); |
|
914 | 914 | |
915 | 915 | return false; |
916 | - } |
|
917 | - |
|
918 | - /** |
|
919 | - * Alias of self::set_start(). |
|
920 | - * |
|
921 | - * @since 1.0.19 |
|
922 | - * @param string $value New start date. |
|
923 | - */ |
|
924 | - public function set_start_date( $value ) { |
|
925 | - $this->set_start( $value ); |
|
926 | - } |
|
927 | - |
|
928 | - /** |
|
929 | - * Sets the discount's expiration date. |
|
930 | - * |
|
931 | - * @since 1.0.19 |
|
932 | - * @param float $value New expiration date. |
|
933 | - */ |
|
934 | - public function set_expiration( $value ) { |
|
935 | - $date = strtotime( $value ); |
|
916 | + } |
|
917 | + |
|
918 | + /** |
|
919 | + * Alias of self::set_start(). |
|
920 | + * |
|
921 | + * @since 1.0.19 |
|
922 | + * @param string $value New start date. |
|
923 | + */ |
|
924 | + public function set_start_date( $value ) { |
|
925 | + $this->set_start( $value ); |
|
926 | + } |
|
927 | + |
|
928 | + /** |
|
929 | + * Sets the discount's expiration date. |
|
930 | + * |
|
931 | + * @since 1.0.19 |
|
932 | + * @param float $value New expiration date. |
|
933 | + */ |
|
934 | + public function set_expiration( $value ) { |
|
935 | + $date = strtotime( $value ); |
|
936 | 936 | |
937 | 937 | if ( $date ) { |
938 | 938 | $this->set_prop( 'expiration', date( 'Y-m-d H:i', $date ) ); |
939 | 939 | return true; |
940 | 940 | } |
941 | 941 | |
942 | - $this->set_prop( 'expiration', '' ); |
|
942 | + $this->set_prop( 'expiration', '' ); |
|
943 | 943 | return false; |
944 | - } |
|
945 | - |
|
946 | - /** |
|
947 | - * Alias of self::set_expiration(). |
|
948 | - * |
|
949 | - * @since 1.0.19 |
|
950 | - * @param string $value New expiration date. |
|
951 | - */ |
|
952 | - public function set_expiration_date( $value ) { |
|
953 | - $this->set_expiration( $value ); |
|
954 | - } |
|
955 | - |
|
956 | - /** |
|
957 | - * Alias of self::set_expiration(). |
|
958 | - * |
|
959 | - * @since 1.0.19 |
|
960 | - * @param string $value New expiration date. |
|
961 | - */ |
|
962 | - public function set_end_date( $value ) { |
|
963 | - $this->set_expiration( $value ); |
|
964 | - } |
|
965 | - |
|
966 | - /** |
|
967 | - * Sets the discount type. |
|
968 | - * |
|
969 | - * @since 1.0.19 |
|
970 | - * @param string $value New discount type. |
|
971 | - */ |
|
972 | - public function set_type( $value ) { |
|
973 | - if ( $value && array_key_exists( sanitize_text_field( $value ), wpinv_get_discount_types() ) ) { |
|
974 | - $this->set_prop( 'type', sanitize_text_field( $value ) ); |
|
975 | - } |
|
976 | - } |
|
977 | - |
|
978 | - /** |
|
979 | - * Sets the number of times a discount has been used. |
|
980 | - * |
|
981 | - * @since 1.0.19 |
|
982 | - * @param int $value usage count. |
|
983 | - */ |
|
984 | - public function set_uses( $value ) { |
|
985 | - |
|
986 | - $value = (int) $value; |
|
987 | - |
|
988 | - if ( $value < 0 ) { |
|
989 | - $value = 0; |
|
990 | - } |
|
991 | - |
|
992 | - $this->set_prop( 'uses', (int) $value ); |
|
993 | - } |
|
994 | - |
|
995 | - /** |
|
996 | - * Sets the maximum number of times a discount can be used. |
|
997 | - * |
|
998 | - * @since 1.0.19 |
|
999 | - * @param int $value maximum usage count. |
|
1000 | - */ |
|
1001 | - public function set_max_uses( $value ) { |
|
1002 | - $this->set_prop( 'max_uses', absint( $value ) ); |
|
1003 | - } |
|
1004 | - |
|
1005 | - /** |
|
1006 | - * Sets if this is a single use discount or not. |
|
1007 | - * |
|
1008 | - * @since 1.0.19 |
|
1009 | - * @param int|bool $value is single use. |
|
1010 | - */ |
|
1011 | - public function set_is_single_use( $value ) { |
|
1012 | - $this->set_prop( 'is_single_use', (bool) $value ); |
|
1013 | - } |
|
1014 | - |
|
1015 | - /** |
|
1016 | - * Sets the items that can be used with this discount. |
|
1017 | - * |
|
1018 | - * @since 1.0.19 |
|
1019 | - * @param array $value items. |
|
1020 | - */ |
|
1021 | - public function set_items( $value ) { |
|
1022 | - $this->set_prop( 'items', wpinv_parse_list( $value ) ); |
|
1023 | - } |
|
1024 | - |
|
1025 | - /** |
|
1026 | - * Alias for self::set_items(). |
|
1027 | - * |
|
1028 | - * @since 1.0.19 |
|
1029 | - * @param array $value items. |
|
1030 | - */ |
|
1031 | - public function set_allowed_items( $value ) { |
|
1032 | - $this->set_items( $value ); |
|
1033 | - } |
|
1034 | - |
|
1035 | - /** |
|
1036 | - * Sets the items that can not be used with this discount. |
|
1037 | - * |
|
1038 | - * @since 1.0.19 |
|
1039 | - * @param array $value items. |
|
1040 | - */ |
|
1041 | - public function set_excluded_items( $value ) { |
|
1042 | - $this->set_prop( 'excluded_items', wpinv_parse_list( $value ) ); |
|
1043 | - } |
|
1044 | - |
|
1045 | - /** |
|
1046 | - * Sets if this is a recurring discounts or not. |
|
1047 | - * |
|
1048 | - * @since 1.0.19 |
|
1049 | - * @param int|bool $value is recurring. |
|
1050 | - */ |
|
1051 | - public function set_is_recurring( $value ) { |
|
1052 | - $this->set_prop( 'is_recurring', (bool) $value ); |
|
1053 | - } |
|
1054 | - |
|
1055 | - /** |
|
1056 | - * Sets the minimum total that can not be used with this discount. |
|
1057 | - * |
|
1058 | - * @since 1.0.19 |
|
1059 | - * @param float $value minimum total. |
|
1060 | - */ |
|
1061 | - public function set_min_total( $value ) { |
|
1062 | - $this->set_prop( 'min_total', (float) wpinv_sanitize_amount( $value ) ); |
|
1063 | - } |
|
1064 | - |
|
1065 | - /** |
|
1066 | - * Alias for self::set_min_total(). |
|
1067 | - * |
|
1068 | - * @since 1.0.19 |
|
1069 | - * @param float $value minimum total. |
|
1070 | - */ |
|
1071 | - public function set_minimum_total( $value ) { |
|
1072 | - $this->set_min_total( $value ); |
|
1073 | - } |
|
1074 | - |
|
1075 | - /** |
|
1076 | - * Sets the maximum total that can not be used with this discount. |
|
1077 | - * |
|
1078 | - * @since 1.0.19 |
|
1079 | - * @param float $value maximum total. |
|
1080 | - */ |
|
1081 | - public function set_max_total( $value ) { |
|
1082 | - $this->set_prop( 'max_total', (float) wpinv_sanitize_amount( $value ) ); |
|
1083 | - } |
|
1084 | - |
|
1085 | - /** |
|
1086 | - * Alias for self::set_max_total(). |
|
1087 | - * |
|
1088 | - * @since 1.0.19 |
|
1089 | - * @param float $value maximum total. |
|
1090 | - */ |
|
1091 | - public function set_maximum_total( $value ) { |
|
1092 | - $this->set_max_total( $value ); |
|
1093 | - } |
|
1094 | - |
|
1095 | - /** |
|
1096 | - * @deprecated |
|
1097 | - */ |
|
1098 | - public function refresh(){} |
|
1099 | - |
|
1100 | - /** |
|
1101 | - * @deprecated |
|
1102 | - * |
|
1103 | - */ |
|
1104 | - public function update_status( $status = 'publish' ){ |
|
1105 | - |
|
1106 | - if ( $this->exists() && $this->get_status() != $status ) { |
|
1107 | - $this->set_status( $status ); |
|
1108 | - $this->save(); |
|
1109 | - } |
|
1110 | - |
|
1111 | - } |
|
1112 | - |
|
1113 | - /* |
|
944 | + } |
|
945 | + |
|
946 | + /** |
|
947 | + * Alias of self::set_expiration(). |
|
948 | + * |
|
949 | + * @since 1.0.19 |
|
950 | + * @param string $value New expiration date. |
|
951 | + */ |
|
952 | + public function set_expiration_date( $value ) { |
|
953 | + $this->set_expiration( $value ); |
|
954 | + } |
|
955 | + |
|
956 | + /** |
|
957 | + * Alias of self::set_expiration(). |
|
958 | + * |
|
959 | + * @since 1.0.19 |
|
960 | + * @param string $value New expiration date. |
|
961 | + */ |
|
962 | + public function set_end_date( $value ) { |
|
963 | + $this->set_expiration( $value ); |
|
964 | + } |
|
965 | + |
|
966 | + /** |
|
967 | + * Sets the discount type. |
|
968 | + * |
|
969 | + * @since 1.0.19 |
|
970 | + * @param string $value New discount type. |
|
971 | + */ |
|
972 | + public function set_type( $value ) { |
|
973 | + if ( $value && array_key_exists( sanitize_text_field( $value ), wpinv_get_discount_types() ) ) { |
|
974 | + $this->set_prop( 'type', sanitize_text_field( $value ) ); |
|
975 | + } |
|
976 | + } |
|
977 | + |
|
978 | + /** |
|
979 | + * Sets the number of times a discount has been used. |
|
980 | + * |
|
981 | + * @since 1.0.19 |
|
982 | + * @param int $value usage count. |
|
983 | + */ |
|
984 | + public function set_uses( $value ) { |
|
985 | + |
|
986 | + $value = (int) $value; |
|
987 | + |
|
988 | + if ( $value < 0 ) { |
|
989 | + $value = 0; |
|
990 | + } |
|
991 | + |
|
992 | + $this->set_prop( 'uses', (int) $value ); |
|
993 | + } |
|
994 | + |
|
995 | + /** |
|
996 | + * Sets the maximum number of times a discount can be used. |
|
997 | + * |
|
998 | + * @since 1.0.19 |
|
999 | + * @param int $value maximum usage count. |
|
1000 | + */ |
|
1001 | + public function set_max_uses( $value ) { |
|
1002 | + $this->set_prop( 'max_uses', absint( $value ) ); |
|
1003 | + } |
|
1004 | + |
|
1005 | + /** |
|
1006 | + * Sets if this is a single use discount or not. |
|
1007 | + * |
|
1008 | + * @since 1.0.19 |
|
1009 | + * @param int|bool $value is single use. |
|
1010 | + */ |
|
1011 | + public function set_is_single_use( $value ) { |
|
1012 | + $this->set_prop( 'is_single_use', (bool) $value ); |
|
1013 | + } |
|
1014 | + |
|
1015 | + /** |
|
1016 | + * Sets the items that can be used with this discount. |
|
1017 | + * |
|
1018 | + * @since 1.0.19 |
|
1019 | + * @param array $value items. |
|
1020 | + */ |
|
1021 | + public function set_items( $value ) { |
|
1022 | + $this->set_prop( 'items', wpinv_parse_list( $value ) ); |
|
1023 | + } |
|
1024 | + |
|
1025 | + /** |
|
1026 | + * Alias for self::set_items(). |
|
1027 | + * |
|
1028 | + * @since 1.0.19 |
|
1029 | + * @param array $value items. |
|
1030 | + */ |
|
1031 | + public function set_allowed_items( $value ) { |
|
1032 | + $this->set_items( $value ); |
|
1033 | + } |
|
1034 | + |
|
1035 | + /** |
|
1036 | + * Sets the items that can not be used with this discount. |
|
1037 | + * |
|
1038 | + * @since 1.0.19 |
|
1039 | + * @param array $value items. |
|
1040 | + */ |
|
1041 | + public function set_excluded_items( $value ) { |
|
1042 | + $this->set_prop( 'excluded_items', wpinv_parse_list( $value ) ); |
|
1043 | + } |
|
1044 | + |
|
1045 | + /** |
|
1046 | + * Sets if this is a recurring discounts or not. |
|
1047 | + * |
|
1048 | + * @since 1.0.19 |
|
1049 | + * @param int|bool $value is recurring. |
|
1050 | + */ |
|
1051 | + public function set_is_recurring( $value ) { |
|
1052 | + $this->set_prop( 'is_recurring', (bool) $value ); |
|
1053 | + } |
|
1054 | + |
|
1055 | + /** |
|
1056 | + * Sets the minimum total that can not be used with this discount. |
|
1057 | + * |
|
1058 | + * @since 1.0.19 |
|
1059 | + * @param float $value minimum total. |
|
1060 | + */ |
|
1061 | + public function set_min_total( $value ) { |
|
1062 | + $this->set_prop( 'min_total', (float) wpinv_sanitize_amount( $value ) ); |
|
1063 | + } |
|
1064 | + |
|
1065 | + /** |
|
1066 | + * Alias for self::set_min_total(). |
|
1067 | + * |
|
1068 | + * @since 1.0.19 |
|
1069 | + * @param float $value minimum total. |
|
1070 | + */ |
|
1071 | + public function set_minimum_total( $value ) { |
|
1072 | + $this->set_min_total( $value ); |
|
1073 | + } |
|
1074 | + |
|
1075 | + /** |
|
1076 | + * Sets the maximum total that can not be used with this discount. |
|
1077 | + * |
|
1078 | + * @since 1.0.19 |
|
1079 | + * @param float $value maximum total. |
|
1080 | + */ |
|
1081 | + public function set_max_total( $value ) { |
|
1082 | + $this->set_prop( 'max_total', (float) wpinv_sanitize_amount( $value ) ); |
|
1083 | + } |
|
1084 | + |
|
1085 | + /** |
|
1086 | + * Alias for self::set_max_total(). |
|
1087 | + * |
|
1088 | + * @since 1.0.19 |
|
1089 | + * @param float $value maximum total. |
|
1090 | + */ |
|
1091 | + public function set_maximum_total( $value ) { |
|
1092 | + $this->set_max_total( $value ); |
|
1093 | + } |
|
1094 | + |
|
1095 | + /** |
|
1096 | + * @deprecated |
|
1097 | + */ |
|
1098 | + public function refresh(){} |
|
1099 | + |
|
1100 | + /** |
|
1101 | + * @deprecated |
|
1102 | + * |
|
1103 | + */ |
|
1104 | + public function update_status( $status = 'publish' ){ |
|
1105 | + |
|
1106 | + if ( $this->exists() && $this->get_status() != $status ) { |
|
1107 | + $this->set_status( $status ); |
|
1108 | + $this->save(); |
|
1109 | + } |
|
1110 | + |
|
1111 | + } |
|
1112 | + |
|
1113 | + /* |
|
1114 | 1114 | |-------------------------------------------------------------------------- |
1115 | 1115 | | Conditionals |
1116 | 1116 | |-------------------------------------------------------------------------- |
@@ -1119,263 +1119,263 @@ discard block |
||
1119 | 1119 | | |
1120 | 1120 | */ |
1121 | 1121 | |
1122 | - /** |
|
1123 | - * Checks whether a discount exists in the database or not |
|
1124 | - * |
|
1125 | - * @since 1.0.15 |
|
1126 | - */ |
|
1127 | - public function exists(){ |
|
1128 | - $id = $this->get_id(); |
|
1129 | - return ! empty( $id ); |
|
1130 | - } |
|
1131 | - |
|
1132 | - /** |
|
1133 | - * Checks the discount type. |
|
1134 | - * |
|
1135 | - * |
|
1136 | - * @param string $type the discount type to check against |
|
1137 | - * @since 1.0.15 |
|
1138 | - * @return bool |
|
1139 | - */ |
|
1140 | - public function is_type( $type ) { |
|
1141 | - return $this->get_type() == $type; |
|
1142 | - } |
|
1143 | - |
|
1144 | - /** |
|
1145 | - * Checks whether the discount is published or not |
|
1146 | - * |
|
1147 | - * @since 1.0.15 |
|
1148 | - * @return bool |
|
1149 | - */ |
|
1150 | - public function is_active() { |
|
1151 | - return $this->get_status() == 'publish'; |
|
1152 | - } |
|
1153 | - |
|
1154 | - /** |
|
1155 | - * Checks whether the discount has max uses |
|
1156 | - * |
|
1157 | - * @since 1.0.15 |
|
1158 | - * @return bool |
|
1159 | - */ |
|
1160 | - public function has_limit() { |
|
1161 | - $limit = $this->get_max_uses(); |
|
1162 | - return ! empty( $limit ); |
|
1163 | - } |
|
1164 | - |
|
1165 | - /** |
|
1166 | - * Checks whether the discount has ever been used. |
|
1167 | - * |
|
1168 | - * @since 1.0.15 |
|
1169 | - * @return bool |
|
1170 | - */ |
|
1171 | - public function has_uses() { |
|
1172 | - return $this->get_uses() > 0; |
|
1173 | - } |
|
1174 | - |
|
1175 | - /** |
|
1176 | - * Checks whether the discount is has exided the usage limit or not |
|
1177 | - * |
|
1178 | - * @since 1.0.15 |
|
1179 | - * @return bool |
|
1180 | - */ |
|
1181 | - public function has_exceeded_limit() { |
|
1182 | - |
|
1183 | - if ( ! $this->has_limit() || ! $this->has_uses() ) { |
|
1184 | - $exceeded = false ; |
|
1185 | - } else { |
|
1186 | - $exceeded = (int) $this->get_max_uses() <= $this->get_uses(); |
|
1187 | - } |
|
1188 | - |
|
1189 | - return apply_filters( 'wpinv_is_discount_maxed_out', $exceeded, $this->get_id(), $this, $this->get_code() ); |
|
1190 | - } |
|
1191 | - |
|
1192 | - /** |
|
1193 | - * Checks whether the discount has an expiration date. |
|
1194 | - * |
|
1195 | - * @since 1.0.15 |
|
1196 | - * @return bool |
|
1197 | - */ |
|
1198 | - public function has_expiration_date() { |
|
1199 | - $date = $this->get_expiration_date(); |
|
1200 | - return ! empty( $date ); |
|
1201 | - } |
|
1202 | - |
|
1203 | - /** |
|
1204 | - * Checks if the discount is expired |
|
1205 | - * |
|
1206 | - * @since 1.0.15 |
|
1207 | - * @return bool |
|
1208 | - */ |
|
1209 | - public function is_expired() { |
|
1210 | - $expired = $this->has_expiration_date() ? current_time( 'timestamp' ) > strtotime( $this->get_expiration_date() ) : false; |
|
1211 | - return apply_filters( 'wpinv_is_discount_expired', $expired, $this->get_id(), $this, $this->get_code() ); |
|
1212 | - } |
|
1213 | - |
|
1214 | - /** |
|
1215 | - * Checks whether the discount has a start date. |
|
1216 | - * |
|
1217 | - * @since 1.0.15 |
|
1218 | - * @return bool |
|
1219 | - */ |
|
1220 | - public function has_start_date() { |
|
1221 | - $date = $this->get_start_date(); |
|
1222 | - return ! empty( $date ); |
|
1223 | - } |
|
1224 | - |
|
1225 | - /** |
|
1226 | - * Checks the discount start date. |
|
1227 | - * |
|
1228 | - * @since 1.0.15 |
|
1229 | - * @return bool |
|
1230 | - */ |
|
1231 | - public function has_started() { |
|
1232 | - $started = $this->has_start_date() ? true : current_time( 'timestamp' ) > strtotime( $this->get_start_date() ); |
|
1233 | - return apply_filters( 'wpinv_is_discount_started', $started, $this->get_id(), $this, $this->get_code() ); |
|
1234 | - } |
|
1235 | - |
|
1236 | - /** |
|
1237 | - * Checks the discount has allowed items or not. |
|
1238 | - * |
|
1239 | - * @since 1.0.15 |
|
1240 | - * @return bool |
|
1241 | - */ |
|
1242 | - public function has_allowed_items() { |
|
1243 | - $allowed_items = $this->get_allowed_items(); |
|
1244 | - return ! empty( $allowed_items ); |
|
1245 | - } |
|
1246 | - |
|
1247 | - /** |
|
1248 | - * Checks the discount has excluded items or not. |
|
1249 | - * |
|
1250 | - * @since 1.0.15 |
|
1251 | - * @return bool |
|
1252 | - */ |
|
1253 | - public function has_excluded_items() { |
|
1254 | - $excluded_items = $this->get_excluded_items(); |
|
1255 | - return ! empty( $excluded_items ); |
|
1256 | - } |
|
1257 | - |
|
1258 | - /** |
|
1259 | - * Check if a discount is valid for a given item id. |
|
1260 | - * |
|
1261 | - * @param int|int[] $item_ids |
|
1262 | - * @since 1.0.15 |
|
1263 | - * @return boolean |
|
1264 | - */ |
|
1265 | - public function is_valid_for_items( $item_ids ) { |
|
1266 | - |
|
1267 | - $item_ids = wp_parse_id_list( $item_ids ); |
|
1268 | - $included = array_intersect( $item_ids, $this->get_allowed_items() ); |
|
1269 | - $excluded = array_intersect( $item_ids, $this->get_excluded_items() ); |
|
1270 | - |
|
1271 | - if ( $this->has_excluded_items() && ! empty( $excluded ) ) { |
|
1272 | - return false; |
|
1273 | - } |
|
1274 | - |
|
1275 | - if ( $this->has_allowed_items() && empty( $included ) ) { |
|
1276 | - return false; |
|
1277 | - } |
|
1278 | - |
|
1279 | - return true; |
|
1280 | - } |
|
1281 | - |
|
1282 | - /** |
|
1283 | - * Check if a discount is valid for the given amount |
|
1284 | - * |
|
1285 | - * @param float $amount The amount to check against |
|
1286 | - * @since 1.0.15 |
|
1287 | - * @return boolean |
|
1288 | - */ |
|
1289 | - public function is_valid_for_amount( $amount ) { |
|
1290 | - return $this->is_minimum_amount_met( $amount ) && $this->is_maximum_amount_met( $amount ); |
|
1291 | - } |
|
1292 | - |
|
1293 | - /** |
|
1294 | - * Checks if the minimum amount is set |
|
1295 | - * |
|
1296 | - * @since 1.0.15 |
|
1297 | - * @return boolean |
|
1298 | - */ |
|
1299 | - public function has_minimum_amount() { |
|
1300 | - $minimum = $this->get_minimum_total(); |
|
1301 | - return ! empty( $minimum ); |
|
1302 | - } |
|
1303 | - |
|
1304 | - /** |
|
1305 | - * Checks if the minimum amount is met |
|
1306 | - * |
|
1307 | - * @param float $amount The amount to check against |
|
1308 | - * @since 1.0.15 |
|
1309 | - * @return boolean |
|
1310 | - */ |
|
1311 | - public function is_minimum_amount_met( $amount ) { |
|
1312 | - $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
1313 | - $min_met= ! ( $this->has_minimum_amount() && $amount < floatval( wpinv_sanitize_amount( $this->get_minimum_total() ) ) ); |
|
1314 | - return apply_filters( 'wpinv_is_discount_min_met', $min_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
1315 | - } |
|
1316 | - |
|
1317 | - /** |
|
1318 | - * Checks if the maximum amount is set |
|
1319 | - * |
|
1320 | - * @since 1.0.15 |
|
1321 | - * @return boolean |
|
1322 | - */ |
|
1323 | - public function has_maximum_amount() { |
|
1324 | - $maximum = $this->get_maximum_total(); |
|
1325 | - return ! empty( $maximum ); |
|
1326 | - } |
|
1327 | - |
|
1328 | - /** |
|
1329 | - * Checks if the maximum amount is met |
|
1330 | - * |
|
1331 | - * @param float $amount The amount to check against |
|
1332 | - * @since 1.0.15 |
|
1333 | - * @return boolean |
|
1334 | - */ |
|
1335 | - public function is_maximum_amount_met( $amount ) { |
|
1336 | - $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
1337 | - $max_met= ! ( $this->has_maximum_amount() && $amount > floatval( wpinv_sanitize_amount( $this->get_maximum_total() ) ) ); |
|
1338 | - return apply_filters( 'wpinv_is_discount_max_met', $max_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
1339 | - } |
|
1340 | - |
|
1341 | - /** |
|
1342 | - * Checks if the discount is recurring. |
|
1343 | - * |
|
1344 | - * @since 1.0.15 |
|
1345 | - * @return boolean |
|
1346 | - */ |
|
1347 | - public function is_recurring() { |
|
1348 | - $recurring = $this->get_is_recurring(); |
|
1349 | - return ! empty( $recurring ); |
|
1350 | - } |
|
1351 | - |
|
1352 | - /** |
|
1353 | - * Checks if the discount is single use. |
|
1354 | - * |
|
1355 | - * @since 1.0.15 |
|
1356 | - * @return boolean |
|
1357 | - */ |
|
1358 | - public function is_single_use() { |
|
1359 | - $usage = $this->get_is_single_use(); |
|
1360 | - return ! empty( $usage ); |
|
1361 | - } |
|
1362 | - |
|
1363 | - /** |
|
1364 | - * Check if a discount is valid for the given user |
|
1365 | - * |
|
1366 | - * @param int|string $user |
|
1367 | - * @since 1.0.15 |
|
1368 | - * @return boolean |
|
1369 | - */ |
|
1370 | - public function is_valid_for_user( $user ) { |
|
1371 | - |
|
1372 | - // Ensure that the discount is single use. |
|
1373 | - if ( empty( $user ) || ! $this->is_single_use() ) { |
|
1374 | - return true; |
|
1375 | - } |
|
1376 | - |
|
1377 | - // Prepare the user id. |
|
1378 | - $user_id = 0; |
|
1122 | + /** |
|
1123 | + * Checks whether a discount exists in the database or not |
|
1124 | + * |
|
1125 | + * @since 1.0.15 |
|
1126 | + */ |
|
1127 | + public function exists(){ |
|
1128 | + $id = $this->get_id(); |
|
1129 | + return ! empty( $id ); |
|
1130 | + } |
|
1131 | + |
|
1132 | + /** |
|
1133 | + * Checks the discount type. |
|
1134 | + * |
|
1135 | + * |
|
1136 | + * @param string $type the discount type to check against |
|
1137 | + * @since 1.0.15 |
|
1138 | + * @return bool |
|
1139 | + */ |
|
1140 | + public function is_type( $type ) { |
|
1141 | + return $this->get_type() == $type; |
|
1142 | + } |
|
1143 | + |
|
1144 | + /** |
|
1145 | + * Checks whether the discount is published or not |
|
1146 | + * |
|
1147 | + * @since 1.0.15 |
|
1148 | + * @return bool |
|
1149 | + */ |
|
1150 | + public function is_active() { |
|
1151 | + return $this->get_status() == 'publish'; |
|
1152 | + } |
|
1153 | + |
|
1154 | + /** |
|
1155 | + * Checks whether the discount has max uses |
|
1156 | + * |
|
1157 | + * @since 1.0.15 |
|
1158 | + * @return bool |
|
1159 | + */ |
|
1160 | + public function has_limit() { |
|
1161 | + $limit = $this->get_max_uses(); |
|
1162 | + return ! empty( $limit ); |
|
1163 | + } |
|
1164 | + |
|
1165 | + /** |
|
1166 | + * Checks whether the discount has ever been used. |
|
1167 | + * |
|
1168 | + * @since 1.0.15 |
|
1169 | + * @return bool |
|
1170 | + */ |
|
1171 | + public function has_uses() { |
|
1172 | + return $this->get_uses() > 0; |
|
1173 | + } |
|
1174 | + |
|
1175 | + /** |
|
1176 | + * Checks whether the discount is has exided the usage limit or not |
|
1177 | + * |
|
1178 | + * @since 1.0.15 |
|
1179 | + * @return bool |
|
1180 | + */ |
|
1181 | + public function has_exceeded_limit() { |
|
1182 | + |
|
1183 | + if ( ! $this->has_limit() || ! $this->has_uses() ) { |
|
1184 | + $exceeded = false ; |
|
1185 | + } else { |
|
1186 | + $exceeded = (int) $this->get_max_uses() <= $this->get_uses(); |
|
1187 | + } |
|
1188 | + |
|
1189 | + return apply_filters( 'wpinv_is_discount_maxed_out', $exceeded, $this->get_id(), $this, $this->get_code() ); |
|
1190 | + } |
|
1191 | + |
|
1192 | + /** |
|
1193 | + * Checks whether the discount has an expiration date. |
|
1194 | + * |
|
1195 | + * @since 1.0.15 |
|
1196 | + * @return bool |
|
1197 | + */ |
|
1198 | + public function has_expiration_date() { |
|
1199 | + $date = $this->get_expiration_date(); |
|
1200 | + return ! empty( $date ); |
|
1201 | + } |
|
1202 | + |
|
1203 | + /** |
|
1204 | + * Checks if the discount is expired |
|
1205 | + * |
|
1206 | + * @since 1.0.15 |
|
1207 | + * @return bool |
|
1208 | + */ |
|
1209 | + public function is_expired() { |
|
1210 | + $expired = $this->has_expiration_date() ? current_time( 'timestamp' ) > strtotime( $this->get_expiration_date() ) : false; |
|
1211 | + return apply_filters( 'wpinv_is_discount_expired', $expired, $this->get_id(), $this, $this->get_code() ); |
|
1212 | + } |
|
1213 | + |
|
1214 | + /** |
|
1215 | + * Checks whether the discount has a start date. |
|
1216 | + * |
|
1217 | + * @since 1.0.15 |
|
1218 | + * @return bool |
|
1219 | + */ |
|
1220 | + public function has_start_date() { |
|
1221 | + $date = $this->get_start_date(); |
|
1222 | + return ! empty( $date ); |
|
1223 | + } |
|
1224 | + |
|
1225 | + /** |
|
1226 | + * Checks the discount start date. |
|
1227 | + * |
|
1228 | + * @since 1.0.15 |
|
1229 | + * @return bool |
|
1230 | + */ |
|
1231 | + public function has_started() { |
|
1232 | + $started = $this->has_start_date() ? true : current_time( 'timestamp' ) > strtotime( $this->get_start_date() ); |
|
1233 | + return apply_filters( 'wpinv_is_discount_started', $started, $this->get_id(), $this, $this->get_code() ); |
|
1234 | + } |
|
1235 | + |
|
1236 | + /** |
|
1237 | + * Checks the discount has allowed items or not. |
|
1238 | + * |
|
1239 | + * @since 1.0.15 |
|
1240 | + * @return bool |
|
1241 | + */ |
|
1242 | + public function has_allowed_items() { |
|
1243 | + $allowed_items = $this->get_allowed_items(); |
|
1244 | + return ! empty( $allowed_items ); |
|
1245 | + } |
|
1246 | + |
|
1247 | + /** |
|
1248 | + * Checks the discount has excluded items or not. |
|
1249 | + * |
|
1250 | + * @since 1.0.15 |
|
1251 | + * @return bool |
|
1252 | + */ |
|
1253 | + public function has_excluded_items() { |
|
1254 | + $excluded_items = $this->get_excluded_items(); |
|
1255 | + return ! empty( $excluded_items ); |
|
1256 | + } |
|
1257 | + |
|
1258 | + /** |
|
1259 | + * Check if a discount is valid for a given item id. |
|
1260 | + * |
|
1261 | + * @param int|int[] $item_ids |
|
1262 | + * @since 1.0.15 |
|
1263 | + * @return boolean |
|
1264 | + */ |
|
1265 | + public function is_valid_for_items( $item_ids ) { |
|
1266 | + |
|
1267 | + $item_ids = wp_parse_id_list( $item_ids ); |
|
1268 | + $included = array_intersect( $item_ids, $this->get_allowed_items() ); |
|
1269 | + $excluded = array_intersect( $item_ids, $this->get_excluded_items() ); |
|
1270 | + |
|
1271 | + if ( $this->has_excluded_items() && ! empty( $excluded ) ) { |
|
1272 | + return false; |
|
1273 | + } |
|
1274 | + |
|
1275 | + if ( $this->has_allowed_items() && empty( $included ) ) { |
|
1276 | + return false; |
|
1277 | + } |
|
1278 | + |
|
1279 | + return true; |
|
1280 | + } |
|
1281 | + |
|
1282 | + /** |
|
1283 | + * Check if a discount is valid for the given amount |
|
1284 | + * |
|
1285 | + * @param float $amount The amount to check against |
|
1286 | + * @since 1.0.15 |
|
1287 | + * @return boolean |
|
1288 | + */ |
|
1289 | + public function is_valid_for_amount( $amount ) { |
|
1290 | + return $this->is_minimum_amount_met( $amount ) && $this->is_maximum_amount_met( $amount ); |
|
1291 | + } |
|
1292 | + |
|
1293 | + /** |
|
1294 | + * Checks if the minimum amount is set |
|
1295 | + * |
|
1296 | + * @since 1.0.15 |
|
1297 | + * @return boolean |
|
1298 | + */ |
|
1299 | + public function has_minimum_amount() { |
|
1300 | + $minimum = $this->get_minimum_total(); |
|
1301 | + return ! empty( $minimum ); |
|
1302 | + } |
|
1303 | + |
|
1304 | + /** |
|
1305 | + * Checks if the minimum amount is met |
|
1306 | + * |
|
1307 | + * @param float $amount The amount to check against |
|
1308 | + * @since 1.0.15 |
|
1309 | + * @return boolean |
|
1310 | + */ |
|
1311 | + public function is_minimum_amount_met( $amount ) { |
|
1312 | + $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
1313 | + $min_met= ! ( $this->has_minimum_amount() && $amount < floatval( wpinv_sanitize_amount( $this->get_minimum_total() ) ) ); |
|
1314 | + return apply_filters( 'wpinv_is_discount_min_met', $min_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
1315 | + } |
|
1316 | + |
|
1317 | + /** |
|
1318 | + * Checks if the maximum amount is set |
|
1319 | + * |
|
1320 | + * @since 1.0.15 |
|
1321 | + * @return boolean |
|
1322 | + */ |
|
1323 | + public function has_maximum_amount() { |
|
1324 | + $maximum = $this->get_maximum_total(); |
|
1325 | + return ! empty( $maximum ); |
|
1326 | + } |
|
1327 | + |
|
1328 | + /** |
|
1329 | + * Checks if the maximum amount is met |
|
1330 | + * |
|
1331 | + * @param float $amount The amount to check against |
|
1332 | + * @since 1.0.15 |
|
1333 | + * @return boolean |
|
1334 | + */ |
|
1335 | + public function is_maximum_amount_met( $amount ) { |
|
1336 | + $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
1337 | + $max_met= ! ( $this->has_maximum_amount() && $amount > floatval( wpinv_sanitize_amount( $this->get_maximum_total() ) ) ); |
|
1338 | + return apply_filters( 'wpinv_is_discount_max_met', $max_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
1339 | + } |
|
1340 | + |
|
1341 | + /** |
|
1342 | + * Checks if the discount is recurring. |
|
1343 | + * |
|
1344 | + * @since 1.0.15 |
|
1345 | + * @return boolean |
|
1346 | + */ |
|
1347 | + public function is_recurring() { |
|
1348 | + $recurring = $this->get_is_recurring(); |
|
1349 | + return ! empty( $recurring ); |
|
1350 | + } |
|
1351 | + |
|
1352 | + /** |
|
1353 | + * Checks if the discount is single use. |
|
1354 | + * |
|
1355 | + * @since 1.0.15 |
|
1356 | + * @return boolean |
|
1357 | + */ |
|
1358 | + public function is_single_use() { |
|
1359 | + $usage = $this->get_is_single_use(); |
|
1360 | + return ! empty( $usage ); |
|
1361 | + } |
|
1362 | + |
|
1363 | + /** |
|
1364 | + * Check if a discount is valid for the given user |
|
1365 | + * |
|
1366 | + * @param int|string $user |
|
1367 | + * @since 1.0.15 |
|
1368 | + * @return boolean |
|
1369 | + */ |
|
1370 | + public function is_valid_for_user( $user ) { |
|
1371 | + |
|
1372 | + // Ensure that the discount is single use. |
|
1373 | + if ( empty( $user ) || ! $this->is_single_use() ) { |
|
1374 | + return true; |
|
1375 | + } |
|
1376 | + |
|
1377 | + // Prepare the user id. |
|
1378 | + $user_id = 0; |
|
1379 | 1379 | if ( is_numeric( $user ) ) { |
1380 | 1380 | $user_id = absint( $user ); |
1381 | 1381 | } else if ( is_email( $user ) && $user_data = get_user_by( 'email', $user ) ) { |
@@ -1384,117 +1384,117 @@ discard block |
||
1384 | 1384 | $user_id = $user_data->ID; |
1385 | 1385 | } |
1386 | 1386 | |
1387 | - // Ensure that we have a user. |
|
1388 | - if ( empty( $user_id ) ) { |
|
1389 | - return true; |
|
1390 | - } |
|
1387 | + // Ensure that we have a user. |
|
1388 | + if ( empty( $user_id ) ) { |
|
1389 | + return true; |
|
1390 | + } |
|
1391 | 1391 | |
1392 | - // Get all payments with matching user id. |
|
1392 | + // Get all payments with matching user id. |
|
1393 | 1393 | $payments = wpinv_get_invoices( array( 'user' => $user_id, 'limit' => false, 'paginate' => false ) ); |
1394 | - $code = strtolower( $this->get_code() ); |
|
1395 | - |
|
1396 | - // For each payment... |
|
1397 | - foreach ( $payments as $payment ) { |
|
1398 | - |
|
1399 | - // Only check for paid invoices. |
|
1400 | - if ( $payment->is_paid() && strtolower( $payment->get_discount_code() ) == $code ) { |
|
1401 | - return false; |
|
1402 | - } |
|
1403 | - |
|
1404 | - } |
|
1405 | - |
|
1406 | - return true; |
|
1407 | - } |
|
1408 | - |
|
1409 | - /** |
|
1410 | - * Deletes the discount from the database |
|
1411 | - * |
|
1412 | - * @since 1.0.15 |
|
1413 | - * @return boolean |
|
1414 | - */ |
|
1415 | - public function remove() { |
|
1416 | - return $this->delete(); |
|
1417 | - } |
|
1418 | - |
|
1419 | - /** |
|
1420 | - * Increases a discount's usage. |
|
1421 | - * |
|
1422 | - * @since 1.0.15 |
|
1423 | - * @param int $by The number of usages to increas by. |
|
1424 | - * @return int |
|
1425 | - */ |
|
1426 | - public function increase_usage( $by = 1 ) { |
|
1427 | - |
|
1428 | - // Abort if zero. |
|
1429 | - if ( empty( $by ) ) { |
|
1430 | - return; |
|
1431 | - } |
|
1432 | - |
|
1433 | - // Increase the usage. |
|
1434 | - $this->set_uses( $this->get_uses() + (int) $by ); |
|
1435 | - |
|
1436 | - // Save the discount. |
|
1437 | - $this->save(); |
|
1438 | - |
|
1439 | - // Fire relevant hooks. |
|
1440 | - if( (int) $by > 0 ) { |
|
1441 | - do_action( 'wpinv_discount_increase_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
1442 | - } else { |
|
1443 | - do_action( 'wpinv_discount_decrease_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
1444 | - } |
|
1445 | - |
|
1446 | - // Return the number of times the discount has been used. |
|
1447 | - return $this->get_uses(); |
|
1448 | - } |
|
1449 | - |
|
1450 | - /** |
|
1451 | - * Alias of self::__toString() |
|
1452 | - * |
|
1453 | - * @since 1.0.15 |
|
1454 | - * @return string|false |
|
1455 | - */ |
|
1456 | - public function get_data_as_json() { |
|
1457 | - return $this->__toString(); |
|
1458 | - } |
|
1459 | - |
|
1460 | - /** |
|
1461 | - * Returns a discount's discounted amount. |
|
1462 | - * |
|
1463 | - * @since 1.0.15 |
|
1464 | - * @param float $amount |
|
1465 | - * @return float |
|
1466 | - */ |
|
1467 | - public function get_discounted_amount( $amount ) { |
|
1468 | - |
|
1469 | - // Convert amount to float. |
|
1470 | - $amount = (float) $amount; |
|
1471 | - |
|
1472 | - // Get discount amount. |
|
1473 | - $discount_amount = $this->get_amount(); |
|
1474 | - |
|
1475 | - if ( empty( $discount_amount ) ) { |
|
1476 | - return 0; |
|
1477 | - } |
|
1478 | - |
|
1479 | - // Format the amount. |
|
1480 | - $discount_amount = floatval( wpinv_sanitize_amount( $discount_amount ) ); |
|
1394 | + $code = strtolower( $this->get_code() ); |
|
1395 | + |
|
1396 | + // For each payment... |
|
1397 | + foreach ( $payments as $payment ) { |
|
1398 | + |
|
1399 | + // Only check for paid invoices. |
|
1400 | + if ( $payment->is_paid() && strtolower( $payment->get_discount_code() ) == $code ) { |
|
1401 | + return false; |
|
1402 | + } |
|
1403 | + |
|
1404 | + } |
|
1405 | + |
|
1406 | + return true; |
|
1407 | + } |
|
1408 | + |
|
1409 | + /** |
|
1410 | + * Deletes the discount from the database |
|
1411 | + * |
|
1412 | + * @since 1.0.15 |
|
1413 | + * @return boolean |
|
1414 | + */ |
|
1415 | + public function remove() { |
|
1416 | + return $this->delete(); |
|
1417 | + } |
|
1418 | + |
|
1419 | + /** |
|
1420 | + * Increases a discount's usage. |
|
1421 | + * |
|
1422 | + * @since 1.0.15 |
|
1423 | + * @param int $by The number of usages to increas by. |
|
1424 | + * @return int |
|
1425 | + */ |
|
1426 | + public function increase_usage( $by = 1 ) { |
|
1427 | + |
|
1428 | + // Abort if zero. |
|
1429 | + if ( empty( $by ) ) { |
|
1430 | + return; |
|
1431 | + } |
|
1432 | + |
|
1433 | + // Increase the usage. |
|
1434 | + $this->set_uses( $this->get_uses() + (int) $by ); |
|
1435 | + |
|
1436 | + // Save the discount. |
|
1437 | + $this->save(); |
|
1438 | + |
|
1439 | + // Fire relevant hooks. |
|
1440 | + if( (int) $by > 0 ) { |
|
1441 | + do_action( 'wpinv_discount_increase_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
1442 | + } else { |
|
1443 | + do_action( 'wpinv_discount_decrease_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
1444 | + } |
|
1445 | + |
|
1446 | + // Return the number of times the discount has been used. |
|
1447 | + return $this->get_uses(); |
|
1448 | + } |
|
1449 | + |
|
1450 | + /** |
|
1451 | + * Alias of self::__toString() |
|
1452 | + * |
|
1453 | + * @since 1.0.15 |
|
1454 | + * @return string|false |
|
1455 | + */ |
|
1456 | + public function get_data_as_json() { |
|
1457 | + return $this->__toString(); |
|
1458 | + } |
|
1459 | + |
|
1460 | + /** |
|
1461 | + * Returns a discount's discounted amount. |
|
1462 | + * |
|
1463 | + * @since 1.0.15 |
|
1464 | + * @param float $amount |
|
1465 | + * @return float |
|
1466 | + */ |
|
1467 | + public function get_discounted_amount( $amount ) { |
|
1468 | + |
|
1469 | + // Convert amount to float. |
|
1470 | + $amount = (float) $amount; |
|
1471 | + |
|
1472 | + // Get discount amount. |
|
1473 | + $discount_amount = $this->get_amount(); |
|
1474 | + |
|
1475 | + if ( empty( $discount_amount ) ) { |
|
1476 | + return 0; |
|
1477 | + } |
|
1478 | + |
|
1479 | + // Format the amount. |
|
1480 | + $discount_amount = floatval( wpinv_sanitize_amount( $discount_amount ) ); |
|
1481 | 1481 | |
1482 | - // If this is a percentage discount. |
|
1483 | - if ( $this->is_type( 'percent' ) ) { |
|
1482 | + // If this is a percentage discount. |
|
1483 | + if ( $this->is_type( 'percent' ) ) { |
|
1484 | 1484 | $discount_amount = $amount * ( $discount_amount / 100 ); |
1485 | - } |
|
1485 | + } |
|
1486 | 1486 | |
1487 | - // Discount can not be less than zero... |
|
1488 | - if ( $discount_amount < 0 ) { |
|
1489 | - $discount_amount = 0; |
|
1490 | - } |
|
1487 | + // Discount can not be less than zero... |
|
1488 | + if ( $discount_amount < 0 ) { |
|
1489 | + $discount_amount = 0; |
|
1490 | + } |
|
1491 | 1491 | |
1492 | - // ... or more than the amount. |
|
1493 | - if ( $discount_amount > $amount ) { |
|
1494 | - $discount_amount = $amount; |
|
1495 | - } |
|
1492 | + // ... or more than the amount. |
|
1493 | + if ( $discount_amount > $amount ) { |
|
1494 | + $discount_amount = $amount; |
|
1495 | + } |
|
1496 | 1496 | |
1497 | - return apply_filters( 'wpinv_discount_total_discount_amount', $discount_amount, $amount, $this ); |
|
1498 | - } |
|
1497 | + return apply_filters( 'wpinv_discount_total_discount_amount', $discount_amount, $amount, $this ); |
|
1498 | + } |
|
1499 | 1499 | |
1500 | 1500 | } |
@@ -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, |
@@ -67,8 +67,8 @@ discard block |
||
67 | 67 | 'subtotal' => 0, |
68 | 68 | 'total_discount' => 0, |
69 | 69 | 'total_tax' => 0, |
70 | - 'total_fees' => 0, |
|
71 | - 'total' => 0, |
|
70 | + 'total_fees' => 0, |
|
71 | + 'total' => 0, |
|
72 | 72 | 'fees' => array(), |
73 | 73 | 'discounts' => array(), |
74 | 74 | 'taxes' => array(), |
@@ -80,22 +80,22 @@ discard block |
||
80 | 80 | 'transaction_id' => '', |
81 | 81 | 'currency' => '', |
82 | 82 | 'disable_taxes' => false, |
83 | - 'subscription_id' => null, |
|
84 | - 'remote_subscription_id' => null, |
|
85 | - 'is_viewed' => false, |
|
86 | - 'email_cc' => '', |
|
87 | - 'template' => 'quantity', // hours, amount only |
|
88 | - 'created_via' => null, |
|
83 | + 'subscription_id' => null, |
|
84 | + 'remote_subscription_id' => null, |
|
85 | + 'is_viewed' => false, |
|
86 | + 'email_cc' => '', |
|
87 | + 'template' => 'quantity', // hours, amount only |
|
88 | + 'created_via' => null, |
|
89 | 89 | ); |
90 | 90 | |
91 | 91 | /** |
92 | - * Stores meta in cache for future reads. |
|
93 | - * |
|
94 | - * A group must be set to to enable caching. |
|
95 | - * |
|
96 | - * @var string |
|
97 | - */ |
|
98 | - protected $cache_group = 'getpaid_invoices'; |
|
92 | + * Stores meta in cache for future reads. |
|
93 | + * |
|
94 | + * A group must be set to to enable caching. |
|
95 | + * |
|
96 | + * @var string |
|
97 | + */ |
|
98 | + protected $cache_group = 'getpaid_invoices'; |
|
99 | 99 | |
100 | 100 | /** |
101 | 101 | * Stores a reference to the original WP_Post object |
@@ -109,104 +109,104 @@ discard block |
||
109 | 109 | * |
110 | 110 | * @var int |
111 | 111 | */ |
112 | - protected $recurring_item = null; |
|
112 | + protected $recurring_item = null; |
|
113 | 113 | |
114 | - /** |
|
114 | + /** |
|
115 | 115 | * Stores an array of item totals. |
116 | - * |
|
117 | - * e.g $totals['discount'] = array( |
|
118 | - * 'initial' => 10, |
|
119 | - * 'recurring' => 10, |
|
120 | - * ) |
|
116 | + * |
|
117 | + * e.g $totals['discount'] = array( |
|
118 | + * 'initial' => 10, |
|
119 | + * 'recurring' => 10, |
|
120 | + * ) |
|
121 | 121 | * |
122 | 122 | * @var array |
123 | 123 | */ |
124 | - protected $totals = array(); |
|
124 | + protected $totals = array(); |
|
125 | 125 | |
126 | - /** |
|
127 | - * Stores the status transition information. |
|
128 | - * |
|
129 | - * @since 1.0.19 |
|
130 | - * @var bool|array |
|
131 | - */ |
|
132 | - protected $status_transition = false; |
|
126 | + /** |
|
127 | + * Stores the status transition information. |
|
128 | + * |
|
129 | + * @since 1.0.19 |
|
130 | + * @var bool|array |
|
131 | + */ |
|
132 | + protected $status_transition = false; |
|
133 | 133 | |
134 | 134 | /** |
135 | - * Get the invoice if ID is passed, otherwise the invoice is new and empty. |
|
136 | - * |
|
137 | - * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object to read. |
|
138 | - */ |
|
135 | + * Get the invoice if ID is passed, otherwise the invoice is new and empty. |
|
136 | + * |
|
137 | + * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object to read. |
|
138 | + */ |
|
139 | 139 | public function __construct( $invoice = 0 ) { |
140 | 140 | |
141 | 141 | parent::__construct( $invoice ); |
142 | 142 | |
143 | - if ( ! empty( $invoice ) && is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( (int) $invoice ) ) ) { |
|
144 | - $this->set_id( (int) $invoice ); |
|
145 | - } elseif ( $invoice instanceof self ) { |
|
146 | - $this->set_id( $invoice->get_id() ); |
|
147 | - } elseif ( ! empty( $invoice->ID ) ) { |
|
148 | - $this->set_id( $invoice->ID ); |
|
149 | - } elseif ( is_array( $invoice ) ) { |
|
150 | - $this->set_props( $invoice ); |
|
151 | - |
|
152 | - if ( isset( $invoice['ID'] ) ) { |
|
153 | - $this->set_id( $invoice['ID'] ); |
|
154 | - } |
|
155 | - |
|
156 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'key' ) ) { |
|
157 | - $this->set_id( $invoice_id ); |
|
158 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'number' ) ) { |
|
159 | - $this->set_id( $invoice_id ); |
|
160 | - } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'transaction_id' ) ) { |
|
161 | - $this->set_id( $invoice_id ); |
|
162 | - } else { |
|
163 | - $this->set_object_read( true ); |
|
164 | - } |
|
143 | + if ( ! empty( $invoice ) && is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( (int) $invoice ) ) ) { |
|
144 | + $this->set_id( (int) $invoice ); |
|
145 | + } elseif ( $invoice instanceof self ) { |
|
146 | + $this->set_id( $invoice->get_id() ); |
|
147 | + } elseif ( ! empty( $invoice->ID ) ) { |
|
148 | + $this->set_id( $invoice->ID ); |
|
149 | + } elseif ( is_array( $invoice ) ) { |
|
150 | + $this->set_props( $invoice ); |
|
151 | + |
|
152 | + if ( isset( $invoice['ID'] ) ) { |
|
153 | + $this->set_id( $invoice['ID'] ); |
|
154 | + } |
|
155 | + |
|
156 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'key' ) ) { |
|
157 | + $this->set_id( $invoice_id ); |
|
158 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'number' ) ) { |
|
159 | + $this->set_id( $invoice_id ); |
|
160 | + } elseif ( is_string( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'transaction_id' ) ) { |
|
161 | + $this->set_id( $invoice_id ); |
|
162 | + } else { |
|
163 | + $this->set_object_read( true ); |
|
164 | + } |
|
165 | 165 | |
166 | 166 | // Load the datastore. |
167 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
167 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
168 | 168 | |
169 | - if ( $this->get_id() > 0 ) { |
|
169 | + if ( $this->get_id() > 0 ) { |
|
170 | 170 | $this->post = get_post( $this->get_id() ); |
171 | 171 | $this->ID = $this->get_id(); |
172 | - $this->data_store->read( $this ); |
|
172 | + $this->data_store->read( $this ); |
|
173 | 173 | } |
174 | 174 | |
175 | 175 | } |
176 | 176 | |
177 | 177 | /** |
178 | - * Given an invoice key/number, it returns its id. |
|
179 | - * |
|
180 | - * |
|
181 | - * @static |
|
182 | - * @param string $value The invoice key or number |
|
183 | - * @param string $field Either key, transaction_id or number. |
|
184 | - * @since 1.0.15 |
|
185 | - * @return int |
|
186 | - */ |
|
187 | - public static function get_invoice_id_by_field( $value, $field = 'key' ) { |
|
178 | + * Given an invoice key/number, it returns its id. |
|
179 | + * |
|
180 | + * |
|
181 | + * @static |
|
182 | + * @param string $value The invoice key or number |
|
183 | + * @param string $field Either key, transaction_id or number. |
|
184 | + * @since 1.0.15 |
|
185 | + * @return int |
|
186 | + */ |
|
187 | + public static function get_invoice_id_by_field( $value, $field = 'key' ) { |
|
188 | 188 | global $wpdb; |
189 | 189 | |
190 | - // Trim the value. |
|
191 | - $value = trim( $value ); |
|
190 | + // Trim the value. |
|
191 | + $value = trim( $value ); |
|
192 | 192 | |
193 | - if ( empty( $value ) ) { |
|
194 | - return 0; |
|
195 | - } |
|
193 | + if ( empty( $value ) ) { |
|
194 | + return 0; |
|
195 | + } |
|
196 | 196 | |
197 | 197 | // Valid fields. |
198 | 198 | $fields = array( 'key', 'number', 'transaction_id' ); |
199 | 199 | |
200 | - // Ensure a field has been passed. |
|
201 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
202 | - return 0; |
|
203 | - } |
|
200 | + // Ensure a field has been passed. |
|
201 | + if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
202 | + return 0; |
|
203 | + } |
|
204 | 204 | |
205 | - // Maybe retrieve from the cache. |
|
206 | - $invoice_id = wp_cache_get( $value, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
207 | - if ( false !== $invoice_id ) { |
|
208 | - return $invoice_id; |
|
209 | - } |
|
205 | + // Maybe retrieve from the cache. |
|
206 | + $invoice_id = wp_cache_get( $value, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
207 | + if ( false !== $invoice_id ) { |
|
208 | + return $invoice_id; |
|
209 | + } |
|
210 | 210 | |
211 | 211 | // Fetch from the db. |
212 | 212 | $table = $wpdb->prefix . 'getpaid_invoices'; |
@@ -214,10 +214,10 @@ discard block |
||
214 | 214 | $wpdb->prepare( "SELECT `post_id` FROM $table WHERE `$field`=%s LIMIT 1", $value ) |
215 | 215 | ); |
216 | 216 | |
217 | - // Update the cache with our data |
|
218 | - wp_cache_set( $value, $invoice_id, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
217 | + // Update the cache with our data |
|
218 | + wp_cache_set( $value, $invoice_id, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
219 | 219 | |
220 | - return $invoice_id; |
|
220 | + return $invoice_id; |
|
221 | 221 | } |
222 | 222 | |
223 | 223 | /** |
@@ -243,83 +243,83 @@ discard block |
||
243 | 243 | */ |
244 | 244 | |
245 | 245 | /** |
246 | - * Get parent invoice ID. |
|
247 | - * |
|
248 | - * @since 1.0.19 |
|
249 | - * @param string $context View or edit context. |
|
250 | - * @return int |
|
251 | - */ |
|
252 | - public function get_parent_id( $context = 'view' ) { |
|
253 | - return (int) $this->get_prop( 'parent_id', $context ); |
|
246 | + * Get parent invoice ID. |
|
247 | + * |
|
248 | + * @since 1.0.19 |
|
249 | + * @param string $context View or edit context. |
|
250 | + * @return int |
|
251 | + */ |
|
252 | + public function get_parent_id( $context = 'view' ) { |
|
253 | + return (int) $this->get_prop( 'parent_id', $context ); |
|
254 | 254 | } |
255 | 255 | |
256 | 256 | /** |
257 | - * Get parent invoice. |
|
258 | - * |
|
259 | - * @since 1.0.19 |
|
260 | - * @return WPInv_Invoice |
|
261 | - */ |
|
257 | + * Get parent invoice. |
|
258 | + * |
|
259 | + * @since 1.0.19 |
|
260 | + * @return WPInv_Invoice |
|
261 | + */ |
|
262 | 262 | public function get_parent_payment() { |
263 | 263 | return new WPInv_Invoice( $this->get_parent_id() ); |
264 | 264 | } |
265 | 265 | |
266 | 266 | /** |
267 | - * Alias for self::get_parent_payment(). |
|
268 | - * |
|
269 | - * @since 1.0.19 |
|
270 | - * @return WPInv_Invoice |
|
271 | - */ |
|
267 | + * Alias for self::get_parent_payment(). |
|
268 | + * |
|
269 | + * @since 1.0.19 |
|
270 | + * @return WPInv_Invoice |
|
271 | + */ |
|
272 | 272 | public function get_parent() { |
273 | 273 | return $this->get_parent_payment(); |
274 | 274 | } |
275 | 275 | |
276 | 276 | /** |
277 | - * Get invoice status. |
|
278 | - * |
|
279 | - * @since 1.0.19 |
|
280 | - * @param string $context View or edit context. |
|
281 | - * @return string |
|
282 | - */ |
|
283 | - public function get_status( $context = 'view' ) { |
|
284 | - return $this->get_prop( 'status', $context ); |
|
285 | - } |
|
277 | + * Get invoice status. |
|
278 | + * |
|
279 | + * @since 1.0.19 |
|
280 | + * @param string $context View or edit context. |
|
281 | + * @return string |
|
282 | + */ |
|
283 | + public function get_status( $context = 'view' ) { |
|
284 | + return $this->get_prop( 'status', $context ); |
|
285 | + } |
|
286 | 286 | |
287 | - /** |
|
288 | - * Retrieves an array of possible invoice statuses. |
|
289 | - * |
|
290 | - * @since 1.0.19 |
|
291 | - * @return array |
|
292 | - */ |
|
293 | - public function get_all_statuses() { |
|
294 | - return wpinv_get_invoice_statuses( true, true, $this ); |
|
295 | - } |
|
296 | - |
|
297 | - /** |
|
298 | - * Get invoice status nice name. |
|
299 | - * |
|
300 | - * @since 1.0.19 |
|
301 | - * @return string |
|
302 | - */ |
|
287 | + /** |
|
288 | + * Retrieves an array of possible invoice statuses. |
|
289 | + * |
|
290 | + * @since 1.0.19 |
|
291 | + * @return array |
|
292 | + */ |
|
293 | + public function get_all_statuses() { |
|
294 | + return wpinv_get_invoice_statuses( true, true, $this ); |
|
295 | + } |
|
296 | + |
|
297 | + /** |
|
298 | + * Get invoice status nice name. |
|
299 | + * |
|
300 | + * @since 1.0.19 |
|
301 | + * @return string |
|
302 | + */ |
|
303 | 303 | public function get_status_nicename() { |
304 | - $statuses = $this->get_all_statuses(); |
|
304 | + $statuses = $this->get_all_statuses(); |
|
305 | 305 | |
306 | 306 | $status = isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : $this->get_status(); |
307 | 307 | |
308 | 308 | return apply_filters( 'wpinv_get_invoice_status_nicename', $status, $this ); |
309 | 309 | } |
310 | 310 | |
311 | - /** |
|
312 | - * Retrieves the invoice status class |
|
313 | - * |
|
314 | - * @since 1.0.19 |
|
315 | - * @return string |
|
316 | - */ |
|
317 | - public function get_status_class() { |
|
318 | - $statuses = getpaid_get_invoice_status_classes(); |
|
319 | - return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
320 | - } |
|
311 | + /** |
|
312 | + * Retrieves the invoice status class |
|
313 | + * |
|
314 | + * @since 1.0.19 |
|
315 | + * @return string |
|
316 | + */ |
|
317 | + public function get_status_class() { |
|
318 | + $statuses = getpaid_get_invoice_status_classes(); |
|
319 | + return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'badge-dark'; |
|
320 | + } |
|
321 | 321 | |
322 | - /** |
|
322 | + /** |
|
323 | 323 | * Retrieves the invoice status label html |
324 | 324 | * |
325 | 325 | * @since 1.0.0 |
@@ -327,263 +327,263 @@ discard block |
||
327 | 327 | */ |
328 | 328 | public function get_status_label_html() { |
329 | 329 | |
330 | - $status_label = sanitize_text_field( $this->get_status_nicename() ); |
|
331 | - $status = sanitize_html_class( $this->get_status() ); |
|
332 | - $class = esc_attr( $this->get_status_class() ); |
|
330 | + $status_label = sanitize_text_field( $this->get_status_nicename() ); |
|
331 | + $status = sanitize_html_class( $this->get_status() ); |
|
332 | + $class = esc_attr( $this->get_status_class() ); |
|
333 | 333 | |
334 | - return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
335 | - } |
|
334 | + return "<span class='bsui'><span class='badge $class $status'>$status_label</span></span>"; |
|
335 | + } |
|
336 | 336 | |
337 | 337 | /** |
338 | - * Get plugin version when the invoice was created. |
|
339 | - * |
|
340 | - * @since 1.0.19 |
|
341 | - * @param string $context View or edit context. |
|
342 | - * @return string |
|
343 | - */ |
|
344 | - public function get_version( $context = 'view' ) { |
|
345 | - return $this->get_prop( 'version', $context ); |
|
346 | - } |
|
338 | + * Get plugin version when the invoice was created. |
|
339 | + * |
|
340 | + * @since 1.0.19 |
|
341 | + * @param string $context View or edit context. |
|
342 | + * @return string |
|
343 | + */ |
|
344 | + public function get_version( $context = 'view' ) { |
|
345 | + return $this->get_prop( 'version', $context ); |
|
346 | + } |
|
347 | 347 | |
348 | - /** |
|
349 | - * @deprecated |
|
350 | - */ |
|
351 | - public function get_invoice_date( $format = true ) { |
|
352 | - $date = getpaid_format_date( $this->get_date_completed() ); |
|
353 | - $date = empty( $date ) ? $this->get_date_created() : $this->get_date_completed(); |
|
354 | - $formatted = getpaid_format_date( $date ); |
|
348 | + /** |
|
349 | + * @deprecated |
|
350 | + */ |
|
351 | + public function get_invoice_date( $format = true ) { |
|
352 | + $date = getpaid_format_date( $this->get_date_completed() ); |
|
353 | + $date = empty( $date ) ? $this->get_date_created() : $this->get_date_completed(); |
|
354 | + $formatted = getpaid_format_date( $date ); |
|
355 | 355 | |
356 | - if ( $format ) { |
|
357 | - return $formatted; |
|
358 | - } |
|
356 | + if ( $format ) { |
|
357 | + return $formatted; |
|
358 | + } |
|
359 | 359 | |
360 | - return empty( $formatted ) ? '' : $date; |
|
360 | + return empty( $formatted ) ? '' : $date; |
|
361 | 361 | |
362 | 362 | } |
363 | 363 | |
364 | 364 | /** |
365 | - * Get date when the invoice was created. |
|
366 | - * |
|
367 | - * @since 1.0.19 |
|
368 | - * @param string $context View or edit context. |
|
369 | - * @return string |
|
370 | - */ |
|
371 | - public function get_date_created( $context = 'view' ) { |
|
372 | - return $this->get_prop( 'date_created', $context ); |
|
373 | - } |
|
365 | + * Get date when the invoice was created. |
|
366 | + * |
|
367 | + * @since 1.0.19 |
|
368 | + * @param string $context View or edit context. |
|
369 | + * @return string |
|
370 | + */ |
|
371 | + public function get_date_created( $context = 'view' ) { |
|
372 | + return $this->get_prop( 'date_created', $context ); |
|
373 | + } |
|
374 | 374 | |
375 | - /** |
|
376 | - * Alias for self::get_date_created(). |
|
377 | - * |
|
378 | - * @since 1.0.19 |
|
379 | - * @param string $context View or edit context. |
|
380 | - * @return string |
|
381 | - */ |
|
382 | - public function get_created_date( $context = 'view' ) { |
|
383 | - return $this->get_date_created( $context ); |
|
384 | - } |
|
385 | - |
|
386 | - /** |
|
387 | - * Get GMT date when the invoice was created. |
|
388 | - * |
|
389 | - * @since 1.0.19 |
|
390 | - * @param string $context View or edit context. |
|
391 | - * @return string |
|
392 | - */ |
|
393 | - public function get_date_created_gmt( $context = 'view' ) { |
|
375 | + /** |
|
376 | + * Alias for self::get_date_created(). |
|
377 | + * |
|
378 | + * @since 1.0.19 |
|
379 | + * @param string $context View or edit context. |
|
380 | + * @return string |
|
381 | + */ |
|
382 | + public function get_created_date( $context = 'view' ) { |
|
383 | + return $this->get_date_created( $context ); |
|
384 | + } |
|
385 | + |
|
386 | + /** |
|
387 | + * Get GMT date when the invoice was created. |
|
388 | + * |
|
389 | + * @since 1.0.19 |
|
390 | + * @param string $context View or edit context. |
|
391 | + * @return string |
|
392 | + */ |
|
393 | + public function get_date_created_gmt( $context = 'view' ) { |
|
394 | 394 | $date = $this->get_date_created( $context ); |
395 | 395 | |
396 | 396 | if ( $date ) { |
397 | 397 | $date = get_gmt_from_date( $date ); |
398 | 398 | } |
399 | - return $date; |
|
399 | + return $date; |
|
400 | 400 | } |
401 | 401 | |
402 | 402 | /** |
403 | - * Get date when the invoice was last modified. |
|
404 | - * |
|
405 | - * @since 1.0.19 |
|
406 | - * @param string $context View or edit context. |
|
407 | - * @return string |
|
408 | - */ |
|
409 | - public function get_date_modified( $context = 'view' ) { |
|
410 | - return $this->get_prop( 'date_modified', $context ); |
|
411 | - } |
|
403 | + * Get date when the invoice was last modified. |
|
404 | + * |
|
405 | + * @since 1.0.19 |
|
406 | + * @param string $context View or edit context. |
|
407 | + * @return string |
|
408 | + */ |
|
409 | + public function get_date_modified( $context = 'view' ) { |
|
410 | + return $this->get_prop( 'date_modified', $context ); |
|
411 | + } |
|
412 | 412 | |
413 | - /** |
|
414 | - * Alias for self::get_date_modified(). |
|
415 | - * |
|
416 | - * @since 1.0.19 |
|
417 | - * @param string $context View or edit context. |
|
418 | - * @return string |
|
419 | - */ |
|
420 | - public function get_modified_date( $context = 'view' ) { |
|
421 | - return $this->get_date_modified( $context ); |
|
413 | + /** |
|
414 | + * Alias for self::get_date_modified(). |
|
415 | + * |
|
416 | + * @since 1.0.19 |
|
417 | + * @param string $context View or edit context. |
|
418 | + * @return string |
|
419 | + */ |
|
420 | + public function get_modified_date( $context = 'view' ) { |
|
421 | + return $this->get_date_modified( $context ); |
|
422 | 422 | } |
423 | 423 | |
424 | 424 | /** |
425 | - * Get GMT date when the invoice was last modified. |
|
426 | - * |
|
427 | - * @since 1.0.19 |
|
428 | - * @param string $context View or edit context. |
|
429 | - * @return string |
|
430 | - */ |
|
431 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
425 | + * Get GMT date when the invoice was last modified. |
|
426 | + * |
|
427 | + * @since 1.0.19 |
|
428 | + * @param string $context View or edit context. |
|
429 | + * @return string |
|
430 | + */ |
|
431 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
432 | 432 | $date = $this->get_date_modified( $context ); |
433 | 433 | |
434 | 434 | if ( $date ) { |
435 | 435 | $date = get_gmt_from_date( $date ); |
436 | 436 | } |
437 | - return $date; |
|
437 | + return $date; |
|
438 | 438 | } |
439 | 439 | |
440 | 440 | /** |
441 | - * Get the invoice due date. |
|
442 | - * |
|
443 | - * @since 1.0.19 |
|
444 | - * @param string $context View or edit context. |
|
445 | - * @return string |
|
446 | - */ |
|
447 | - public function get_due_date( $context = 'view' ) { |
|
448 | - return $this->get_prop( 'due_date', $context ); |
|
441 | + * Get the invoice due date. |
|
442 | + * |
|
443 | + * @since 1.0.19 |
|
444 | + * @param string $context View or edit context. |
|
445 | + * @return string |
|
446 | + */ |
|
447 | + public function get_due_date( $context = 'view' ) { |
|
448 | + return $this->get_prop( 'due_date', $context ); |
|
449 | 449 | } |
450 | 450 | |
451 | 451 | /** |
452 | - * Alias for self::get_due_date(). |
|
453 | - * |
|
454 | - * @since 1.0.19 |
|
455 | - * @param string $context View or edit context. |
|
456 | - * @return string |
|
457 | - */ |
|
458 | - public function get_date_due( $context = 'view' ) { |
|
459 | - return $this->get_due_date( $context ); |
|
452 | + * Alias for self::get_due_date(). |
|
453 | + * |
|
454 | + * @since 1.0.19 |
|
455 | + * @param string $context View or edit context. |
|
456 | + * @return string |
|
457 | + */ |
|
458 | + public function get_date_due( $context = 'view' ) { |
|
459 | + return $this->get_due_date( $context ); |
|
460 | 460 | } |
461 | 461 | |
462 | 462 | /** |
463 | - * Get the invoice GMT due date. |
|
464 | - * |
|
465 | - * @since 1.0.19 |
|
466 | - * @param string $context View or edit context. |
|
467 | - * @return string |
|
468 | - */ |
|
469 | - public function get_due_date_gmt( $context = 'view' ) { |
|
463 | + * Get the invoice GMT due date. |
|
464 | + * |
|
465 | + * @since 1.0.19 |
|
466 | + * @param string $context View or edit context. |
|
467 | + * @return string |
|
468 | + */ |
|
469 | + public function get_due_date_gmt( $context = 'view' ) { |
|
470 | 470 | $date = $this->get_due_date( $context ); |
471 | 471 | |
472 | 472 | if ( $date ) { |
473 | 473 | $date = get_gmt_from_date( $date ); |
474 | 474 | } |
475 | - return $date; |
|
475 | + return $date; |
|
476 | 476 | } |
477 | 477 | |
478 | 478 | /** |
479 | - * Alias for self::get_due_date_gmt(). |
|
480 | - * |
|
481 | - * @since 1.0.19 |
|
482 | - * @param string $context View or edit context. |
|
483 | - * @return string |
|
484 | - */ |
|
485 | - public function get_gmt_date_due( $context = 'view' ) { |
|
486 | - return $this->get_due_date_gmt( $context ); |
|
479 | + * Alias for self::get_due_date_gmt(). |
|
480 | + * |
|
481 | + * @since 1.0.19 |
|
482 | + * @param string $context View or edit context. |
|
483 | + * @return string |
|
484 | + */ |
|
485 | + public function get_gmt_date_due( $context = 'view' ) { |
|
486 | + return $this->get_due_date_gmt( $context ); |
|
487 | 487 | } |
488 | 488 | |
489 | 489 | /** |
490 | - * Get date when the invoice was completed. |
|
491 | - * |
|
492 | - * @since 1.0.19 |
|
493 | - * @param string $context View or edit context. |
|
494 | - * @return string |
|
495 | - */ |
|
496 | - public function get_completed_date( $context = 'view' ) { |
|
497 | - return $this->get_prop( 'completed_date', $context ); |
|
490 | + * Get date when the invoice was completed. |
|
491 | + * |
|
492 | + * @since 1.0.19 |
|
493 | + * @param string $context View or edit context. |
|
494 | + * @return string |
|
495 | + */ |
|
496 | + public function get_completed_date( $context = 'view' ) { |
|
497 | + return $this->get_prop( 'completed_date', $context ); |
|
498 | 498 | } |
499 | 499 | |
500 | 500 | /** |
501 | - * Alias for self::get_completed_date(). |
|
502 | - * |
|
503 | - * @since 1.0.19 |
|
504 | - * @param string $context View or edit context. |
|
505 | - * @return string |
|
506 | - */ |
|
507 | - public function get_date_completed( $context = 'view' ) { |
|
508 | - return $this->get_completed_date( $context ); |
|
501 | + * Alias for self::get_completed_date(). |
|
502 | + * |
|
503 | + * @since 1.0.19 |
|
504 | + * @param string $context View or edit context. |
|
505 | + * @return string |
|
506 | + */ |
|
507 | + public function get_date_completed( $context = 'view' ) { |
|
508 | + return $this->get_completed_date( $context ); |
|
509 | 509 | } |
510 | 510 | |
511 | 511 | /** |
512 | - * Get GMT date when the invoice was was completed. |
|
513 | - * |
|
514 | - * @since 1.0.19 |
|
515 | - * @param string $context View or edit context. |
|
516 | - * @return string |
|
517 | - */ |
|
518 | - public function get_completed_date_gmt( $context = 'view' ) { |
|
512 | + * Get GMT date when the invoice was was completed. |
|
513 | + * |
|
514 | + * @since 1.0.19 |
|
515 | + * @param string $context View or edit context. |
|
516 | + * @return string |
|
517 | + */ |
|
518 | + public function get_completed_date_gmt( $context = 'view' ) { |
|
519 | 519 | $date = $this->get_completed_date( $context ); |
520 | 520 | |
521 | 521 | if ( $date ) { |
522 | 522 | $date = get_gmt_from_date( $date ); |
523 | 523 | } |
524 | - return $date; |
|
524 | + return $date; |
|
525 | 525 | } |
526 | 526 | |
527 | 527 | /** |
528 | - * Alias for self::get_completed_date_gmt(). |
|
529 | - * |
|
530 | - * @since 1.0.19 |
|
531 | - * @param string $context View or edit context. |
|
532 | - * @return string |
|
533 | - */ |
|
534 | - public function get_gmt_completed_date( $context = 'view' ) { |
|
535 | - return $this->get_completed_date_gmt( $context ); |
|
528 | + * Alias for self::get_completed_date_gmt(). |
|
529 | + * |
|
530 | + * @since 1.0.19 |
|
531 | + * @param string $context View or edit context. |
|
532 | + * @return string |
|
533 | + */ |
|
534 | + public function get_gmt_completed_date( $context = 'view' ) { |
|
535 | + return $this->get_completed_date_gmt( $context ); |
|
536 | 536 | } |
537 | 537 | |
538 | 538 | /** |
539 | - * Get the invoice number. |
|
540 | - * |
|
541 | - * @since 1.0.19 |
|
542 | - * @param string $context View or edit context. |
|
543 | - * @return string |
|
544 | - */ |
|
545 | - public function get_number( $context = 'view' ) { |
|
546 | - $number = $this->get_prop( 'number', $context ); |
|
539 | + * Get the invoice number. |
|
540 | + * |
|
541 | + * @since 1.0.19 |
|
542 | + * @param string $context View or edit context. |
|
543 | + * @return string |
|
544 | + */ |
|
545 | + public function get_number( $context = 'view' ) { |
|
546 | + $number = $this->get_prop( 'number', $context ); |
|
547 | 547 | |
548 | - if ( empty( $number ) ) { |
|
549 | - $number = $this->generate_number(); |
|
550 | - $this->set_number( $this->generate_number() ); |
|
551 | - } |
|
548 | + if ( empty( $number ) ) { |
|
549 | + $number = $this->generate_number(); |
|
550 | + $this->set_number( $this->generate_number() ); |
|
551 | + } |
|
552 | 552 | |
553 | - return $number; |
|
553 | + return $number; |
|
554 | 554 | } |
555 | 555 | |
556 | - /** |
|
557 | - * Set the invoice number. |
|
558 | - * |
|
559 | - * @since 1.0.19 |
|
560 | - */ |
|
561 | - public function maybe_set_number() { |
|
556 | + /** |
|
557 | + * Set the invoice number. |
|
558 | + * |
|
559 | + * @since 1.0.19 |
|
560 | + */ |
|
561 | + public function maybe_set_number() { |
|
562 | 562 | $number = $this->get_number(); |
563 | 563 | |
564 | 564 | if ( empty( $number ) || $this->get_id() == $number ) { |
565 | - $this->set_number( $this->generate_number() ); |
|
565 | + $this->set_number( $this->generate_number() ); |
|
566 | 566 | } |
567 | 567 | |
568 | - } |
|
568 | + } |
|
569 | 569 | |
570 | 570 | /** |
571 | - * Get the invoice key. |
|
572 | - * |
|
573 | - * @since 1.0.19 |
|
574 | - * @param string $context View or edit context. |
|
575 | - * @return string |
|
576 | - */ |
|
577 | - public function get_key( $context = 'view' ) { |
|
571 | + * Get the invoice key. |
|
572 | + * |
|
573 | + * @since 1.0.19 |
|
574 | + * @param string $context View or edit context. |
|
575 | + * @return string |
|
576 | + */ |
|
577 | + public function get_key( $context = 'view' ) { |
|
578 | 578 | return $this->get_prop( 'key', $context ); |
579 | - } |
|
580 | - |
|
581 | - /** |
|
582 | - * Set the invoice key. |
|
583 | - * |
|
584 | - * @since 1.0.19 |
|
585 | - */ |
|
586 | - public function maybe_set_key() { |
|
579 | + } |
|
580 | + |
|
581 | + /** |
|
582 | + * Set the invoice key. |
|
583 | + * |
|
584 | + * @since 1.0.19 |
|
585 | + */ |
|
586 | + public function maybe_set_key() { |
|
587 | 587 | $key = $this->get_key(); |
588 | 588 | |
589 | 589 | if ( empty( $key ) ) { |
@@ -594,140 +594,140 @@ discard block |
||
594 | 594 | } |
595 | 595 | |
596 | 596 | /** |
597 | - * Get the invoice type. |
|
598 | - * |
|
599 | - * @since 1.0.19 |
|
600 | - * @param string $context View or edit context. |
|
601 | - * @return string |
|
602 | - */ |
|
603 | - public function get_type( $context = 'view' ) { |
|
597 | + * Get the invoice type. |
|
598 | + * |
|
599 | + * @since 1.0.19 |
|
600 | + * @param string $context View or edit context. |
|
601 | + * @return string |
|
602 | + */ |
|
603 | + public function get_type( $context = 'view' ) { |
|
604 | 604 | return $this->get_prop( 'type', $context ); |
605 | - } |
|
606 | - |
|
607 | - /** |
|
608 | - * Returns the post type name. |
|
609 | - * |
|
610 | - * @since 1.0.19 |
|
611 | - * @return string |
|
612 | - */ |
|
613 | - public function get_invoice_quote_type() { |
|
605 | + } |
|
606 | + |
|
607 | + /** |
|
608 | + * Returns the post type name. |
|
609 | + * |
|
610 | + * @since 1.0.19 |
|
611 | + * @return string |
|
612 | + */ |
|
613 | + public function get_invoice_quote_type() { |
|
614 | 614 | return getpaid_get_post_type_label( $this->get_post_type(), false ); |
615 | 615 | } |
616 | 616 | |
617 | 617 | /** |
618 | - * Get the invoice post type label. |
|
619 | - * |
|
620 | - * @since 1.0.19 |
|
621 | - * @param string $context View or edit context. |
|
622 | - * @return string |
|
623 | - */ |
|
624 | - public function get_label( $context = 'view' ) { |
|
618 | + * Get the invoice post type label. |
|
619 | + * |
|
620 | + * @since 1.0.19 |
|
621 | + * @param string $context View or edit context. |
|
622 | + * @return string |
|
623 | + */ |
|
624 | + public function get_label( $context = 'view' ) { |
|
625 | 625 | return getpaid_get_post_type_label( $this->get_post_type( $context ), false ); |
626 | - } |
|
627 | - |
|
628 | - /** |
|
629 | - * Get the invoice post type. |
|
630 | - * |
|
631 | - * @since 1.0.19 |
|
632 | - * @param string $context View or edit context. |
|
633 | - * @return string |
|
634 | - */ |
|
635 | - public function get_post_type( $context = 'view' ) { |
|
626 | + } |
|
627 | + |
|
628 | + /** |
|
629 | + * Get the invoice post type. |
|
630 | + * |
|
631 | + * @since 1.0.19 |
|
632 | + * @param string $context View or edit context. |
|
633 | + * @return string |
|
634 | + */ |
|
635 | + public function get_post_type( $context = 'view' ) { |
|
636 | 636 | return $this->get_prop( 'post_type', $context ); |
637 | 637 | } |
638 | 638 | |
639 | 639 | /** |
640 | - * Get the invoice mode. |
|
641 | - * |
|
642 | - * @since 1.0.19 |
|
643 | - * @param string $context View or edit context. |
|
644 | - * @return string |
|
645 | - */ |
|
646 | - public function get_mode( $context = 'view' ) { |
|
640 | + * Get the invoice mode. |
|
641 | + * |
|
642 | + * @since 1.0.19 |
|
643 | + * @param string $context View or edit context. |
|
644 | + * @return string |
|
645 | + */ |
|
646 | + public function get_mode( $context = 'view' ) { |
|
647 | 647 | return $this->get_prop( 'mode', $context ); |
648 | 648 | } |
649 | 649 | |
650 | 650 | /** |
651 | - * Get the invoice path. |
|
652 | - * |
|
653 | - * @since 1.0.19 |
|
654 | - * @param string $context View or edit context. |
|
655 | - * @return string |
|
656 | - */ |
|
657 | - public function get_path( $context = 'view' ) { |
|
651 | + * Get the invoice path. |
|
652 | + * |
|
653 | + * @since 1.0.19 |
|
654 | + * @param string $context View or edit context. |
|
655 | + * @return string |
|
656 | + */ |
|
657 | + public function get_path( $context = 'view' ) { |
|
658 | 658 | $path = $this->get_prop( 'path', $context ); |
659 | - $prefix = $this->get_type(); |
|
659 | + $prefix = $this->get_type(); |
|
660 | 660 | |
661 | - if ( 0 !== strpos( $path, $prefix ) ) { |
|
662 | - $path = sanitize_title( $prefix . '-' . $this->get_id() ); |
|
663 | - $this->set_path( $path ); |
|
664 | - } |
|
661 | + if ( 0 !== strpos( $path, $prefix ) ) { |
|
662 | + $path = sanitize_title( $prefix . '-' . $this->get_id() ); |
|
663 | + $this->set_path( $path ); |
|
664 | + } |
|
665 | 665 | |
666 | - return $path; |
|
666 | + return $path; |
|
667 | 667 | } |
668 | 668 | |
669 | 669 | /** |
670 | - * Get the invoice name/title. |
|
671 | - * |
|
672 | - * @since 1.0.19 |
|
673 | - * @param string $context View or edit context. |
|
674 | - * @return string |
|
675 | - */ |
|
676 | - public function get_name( $context = 'view' ) { |
|
670 | + * Get the invoice name/title. |
|
671 | + * |
|
672 | + * @since 1.0.19 |
|
673 | + * @param string $context View or edit context. |
|
674 | + * @return string |
|
675 | + */ |
|
676 | + public function get_name( $context = 'view' ) { |
|
677 | 677 | return $this->get_prop( 'title', $context ); |
678 | 678 | } |
679 | 679 | |
680 | 680 | /** |
681 | - * Alias of self::get_name(). |
|
682 | - * |
|
683 | - * @since 1.0.19 |
|
684 | - * @param string $context View or edit context. |
|
685 | - * @return string |
|
686 | - */ |
|
687 | - public function get_title( $context = 'view' ) { |
|
688 | - return $this->get_name( $context ); |
|
681 | + * Alias of self::get_name(). |
|
682 | + * |
|
683 | + * @since 1.0.19 |
|
684 | + * @param string $context View or edit context. |
|
685 | + * @return string |
|
686 | + */ |
|
687 | + public function get_title( $context = 'view' ) { |
|
688 | + return $this->get_name( $context ); |
|
689 | 689 | } |
690 | 690 | |
691 | 691 | /** |
692 | - * Get the invoice description. |
|
693 | - * |
|
694 | - * @since 1.0.19 |
|
695 | - * @param string $context View or edit context. |
|
696 | - * @return string |
|
697 | - */ |
|
698 | - public function get_description( $context = 'view' ) { |
|
699 | - return $this->get_prop( 'description', $context ); |
|
692 | + * Get the invoice description. |
|
693 | + * |
|
694 | + * @since 1.0.19 |
|
695 | + * @param string $context View or edit context. |
|
696 | + * @return string |
|
697 | + */ |
|
698 | + public function get_description( $context = 'view' ) { |
|
699 | + return $this->get_prop( 'description', $context ); |
|
700 | 700 | } |
701 | 701 | |
702 | 702 | /** |
703 | - * Alias of self::get_description(). |
|
704 | - * |
|
705 | - * @since 1.0.19 |
|
706 | - * @param string $context View or edit context. |
|
707 | - * @return string |
|
708 | - */ |
|
709 | - public function get_excerpt( $context = 'view' ) { |
|
710 | - return $this->get_description( $context ); |
|
703 | + * Alias of self::get_description(). |
|
704 | + * |
|
705 | + * @since 1.0.19 |
|
706 | + * @param string $context View or edit context. |
|
707 | + * @return string |
|
708 | + */ |
|
709 | + public function get_excerpt( $context = 'view' ) { |
|
710 | + return $this->get_description( $context ); |
|
711 | 711 | } |
712 | 712 | |
713 | 713 | /** |
714 | - * Alias of self::get_description(). |
|
715 | - * |
|
716 | - * @since 1.0.19 |
|
717 | - * @param string $context View or edit context. |
|
718 | - * @return string |
|
719 | - */ |
|
720 | - public function get_summary( $context = 'view' ) { |
|
721 | - return $this->get_description( $context ); |
|
714 | + * Alias of self::get_description(). |
|
715 | + * |
|
716 | + * @since 1.0.19 |
|
717 | + * @param string $context View or edit context. |
|
718 | + * @return string |
|
719 | + */ |
|
720 | + public function get_summary( $context = 'view' ) { |
|
721 | + return $this->get_description( $context ); |
|
722 | 722 | } |
723 | 723 | |
724 | 724 | /** |
725 | - * Returns the user info. |
|
726 | - * |
|
727 | - * @since 1.0.19 |
|
725 | + * Returns the user info. |
|
726 | + * |
|
727 | + * @since 1.0.19 |
|
728 | 728 | * @param string $context View or edit context. |
729 | - * @return array |
|
730 | - */ |
|
729 | + * @return array |
|
730 | + */ |
|
731 | 731 | public function get_user_info( $context = 'view' ) { |
732 | 732 | |
733 | 733 | $user_info = array( |
@@ -744,616 +744,616 @@ discard block |
||
744 | 744 | 'company' => $this->get_company( $context ), |
745 | 745 | 'vat_number' => $this->get_vat_number( $context ), |
746 | 746 | 'discount' => $this->get_discount_code( $context ), |
747 | - ); |
|
747 | + ); |
|
748 | 748 | |
749 | - return apply_filters( 'wpinv_user_info', $user_info, $this->get_id(), $this ); |
|
749 | + return apply_filters( 'wpinv_user_info', $user_info, $this->get_id(), $this ); |
|
750 | 750 | |
751 | 751 | } |
752 | 752 | |
753 | 753 | /** |
754 | - * Get the customer id. |
|
755 | - * |
|
756 | - * @since 1.0.19 |
|
757 | - * @param string $context View or edit context. |
|
758 | - * @return int |
|
759 | - */ |
|
760 | - public function get_author( $context = 'view' ) { |
|
761 | - return (int) $this->get_prop( 'author', $context ); |
|
754 | + * Get the customer id. |
|
755 | + * |
|
756 | + * @since 1.0.19 |
|
757 | + * @param string $context View or edit context. |
|
758 | + * @return int |
|
759 | + */ |
|
760 | + public function get_author( $context = 'view' ) { |
|
761 | + return (int) $this->get_prop( 'author', $context ); |
|
762 | 762 | } |
763 | 763 | |
764 | 764 | /** |
765 | - * Alias of self::get_author(). |
|
766 | - * |
|
767 | - * @since 1.0.19 |
|
768 | - * @param string $context View or edit context. |
|
769 | - * @return int |
|
770 | - */ |
|
771 | - public function get_user_id( $context = 'view' ) { |
|
772 | - return $this->get_author( $context ); |
|
765 | + * Alias of self::get_author(). |
|
766 | + * |
|
767 | + * @since 1.0.19 |
|
768 | + * @param string $context View or edit context. |
|
769 | + * @return int |
|
770 | + */ |
|
771 | + public function get_user_id( $context = 'view' ) { |
|
772 | + return $this->get_author( $context ); |
|
773 | 773 | } |
774 | 774 | |
775 | - /** |
|
776 | - * Alias of self::get_author(). |
|
777 | - * |
|
778 | - * @since 1.0.19 |
|
779 | - * @param string $context View or edit context. |
|
780 | - * @return int |
|
781 | - */ |
|
782 | - public function get_customer_id( $context = 'view' ) { |
|
783 | - return $this->get_author( $context ); |
|
775 | + /** |
|
776 | + * Alias of self::get_author(). |
|
777 | + * |
|
778 | + * @since 1.0.19 |
|
779 | + * @param string $context View or edit context. |
|
780 | + * @return int |
|
781 | + */ |
|
782 | + public function get_customer_id( $context = 'view' ) { |
|
783 | + return $this->get_author( $context ); |
|
784 | 784 | } |
785 | 785 | |
786 | 786 | /** |
787 | - * Get the customer's ip. |
|
788 | - * |
|
789 | - * @since 1.0.19 |
|
790 | - * @param string $context View or edit context. |
|
791 | - * @return string |
|
792 | - */ |
|
793 | - public function get_ip( $context = 'view' ) { |
|
794 | - return $this->get_prop( 'user_ip', $context ); |
|
787 | + * Get the customer's ip. |
|
788 | + * |
|
789 | + * @since 1.0.19 |
|
790 | + * @param string $context View or edit context. |
|
791 | + * @return string |
|
792 | + */ |
|
793 | + public function get_ip( $context = 'view' ) { |
|
794 | + return $this->get_prop( 'user_ip', $context ); |
|
795 | 795 | } |
796 | 796 | |
797 | 797 | /** |
798 | - * Alias of self::get_ip(). |
|
799 | - * |
|
800 | - * @since 1.0.19 |
|
801 | - * @param string $context View or edit context. |
|
802 | - * @return string |
|
803 | - */ |
|
804 | - public function get_user_ip( $context = 'view' ) { |
|
805 | - return $this->get_ip( $context ); |
|
798 | + * Alias of self::get_ip(). |
|
799 | + * |
|
800 | + * @since 1.0.19 |
|
801 | + * @param string $context View or edit context. |
|
802 | + * @return string |
|
803 | + */ |
|
804 | + public function get_user_ip( $context = 'view' ) { |
|
805 | + return $this->get_ip( $context ); |
|
806 | 806 | } |
807 | 807 | |
808 | - /** |
|
809 | - * Alias of self::get_ip(). |
|
810 | - * |
|
811 | - * @since 1.0.19 |
|
812 | - * @param string $context View or edit context. |
|
813 | - * @return string |
|
814 | - */ |
|
815 | - public function get_customer_ip( $context = 'view' ) { |
|
816 | - return $this->get_ip( $context ); |
|
808 | + /** |
|
809 | + * Alias of self::get_ip(). |
|
810 | + * |
|
811 | + * @since 1.0.19 |
|
812 | + * @param string $context View or edit context. |
|
813 | + * @return string |
|
814 | + */ |
|
815 | + public function get_customer_ip( $context = 'view' ) { |
|
816 | + return $this->get_ip( $context ); |
|
817 | 817 | } |
818 | 818 | |
819 | 819 | /** |
820 | - * Get the customer's first name. |
|
821 | - * |
|
822 | - * @since 1.0.19 |
|
823 | - * @param string $context View or edit context. |
|
824 | - * @return string |
|
825 | - */ |
|
826 | - public function get_first_name( $context = 'view' ) { |
|
827 | - return $this->get_prop( 'first_name', $context ); |
|
820 | + * Get the customer's first name. |
|
821 | + * |
|
822 | + * @since 1.0.19 |
|
823 | + * @param string $context View or edit context. |
|
824 | + * @return string |
|
825 | + */ |
|
826 | + public function get_first_name( $context = 'view' ) { |
|
827 | + return $this->get_prop( 'first_name', $context ); |
|
828 | 828 | } |
829 | 829 | |
830 | 830 | /** |
831 | - * Alias of self::get_first_name(). |
|
832 | - * |
|
833 | - * @since 1.0.19 |
|
834 | - * @param string $context View or edit context. |
|
835 | - * @return string |
|
836 | - */ |
|
837 | - public function get_user_first_name( $context = 'view' ) { |
|
838 | - return $this->get_first_name( $context ); |
|
831 | + * Alias of self::get_first_name(). |
|
832 | + * |
|
833 | + * @since 1.0.19 |
|
834 | + * @param string $context View or edit context. |
|
835 | + * @return string |
|
836 | + */ |
|
837 | + public function get_user_first_name( $context = 'view' ) { |
|
838 | + return $this->get_first_name( $context ); |
|
839 | 839 | } |
840 | 840 | |
841 | - /** |
|
842 | - * Alias of self::get_first_name(). |
|
843 | - * |
|
844 | - * @since 1.0.19 |
|
845 | - * @param string $context View or edit context. |
|
846 | - * @return string |
|
847 | - */ |
|
848 | - public function get_customer_first_name( $context = 'view' ) { |
|
849 | - return $this->get_first_name( $context ); |
|
841 | + /** |
|
842 | + * Alias of self::get_first_name(). |
|
843 | + * |
|
844 | + * @since 1.0.19 |
|
845 | + * @param string $context View or edit context. |
|
846 | + * @return string |
|
847 | + */ |
|
848 | + public function get_customer_first_name( $context = 'view' ) { |
|
849 | + return $this->get_first_name( $context ); |
|
850 | 850 | } |
851 | 851 | |
852 | 852 | /** |
853 | - * Get the customer's last name. |
|
854 | - * |
|
855 | - * @since 1.0.19 |
|
856 | - * @param string $context View or edit context. |
|
857 | - * @return string |
|
858 | - */ |
|
859 | - public function get_last_name( $context = 'view' ) { |
|
860 | - return $this->get_prop( 'last_name', $context ); |
|
853 | + * Get the customer's last name. |
|
854 | + * |
|
855 | + * @since 1.0.19 |
|
856 | + * @param string $context View or edit context. |
|
857 | + * @return string |
|
858 | + */ |
|
859 | + public function get_last_name( $context = 'view' ) { |
|
860 | + return $this->get_prop( 'last_name', $context ); |
|
861 | 861 | } |
862 | 862 | |
863 | 863 | /** |
864 | - * Alias of self::get_last_name(). |
|
865 | - * |
|
866 | - * @since 1.0.19 |
|
867 | - * @param string $context View or edit context. |
|
868 | - * @return string |
|
869 | - */ |
|
870 | - public function get_user_last_name( $context = 'view' ) { |
|
871 | - return $this->get_last_name( $context ); |
|
864 | + * Alias of self::get_last_name(). |
|
865 | + * |
|
866 | + * @since 1.0.19 |
|
867 | + * @param string $context View or edit context. |
|
868 | + * @return string |
|
869 | + */ |
|
870 | + public function get_user_last_name( $context = 'view' ) { |
|
871 | + return $this->get_last_name( $context ); |
|
872 | 872 | } |
873 | 873 | |
874 | 874 | /** |
875 | - * Alias of self::get_last_name(). |
|
876 | - * |
|
877 | - * @since 1.0.19 |
|
878 | - * @param string $context View or edit context. |
|
879 | - * @return string |
|
880 | - */ |
|
881 | - public function get_customer_last_name( $context = 'view' ) { |
|
882 | - return $this->get_last_name( $context ); |
|
875 | + * Alias of self::get_last_name(). |
|
876 | + * |
|
877 | + * @since 1.0.19 |
|
878 | + * @param string $context View or edit context. |
|
879 | + * @return string |
|
880 | + */ |
|
881 | + public function get_customer_last_name( $context = 'view' ) { |
|
882 | + return $this->get_last_name( $context ); |
|
883 | 883 | } |
884 | 884 | |
885 | 885 | /** |
886 | - * Get the customer's full name. |
|
887 | - * |
|
888 | - * @since 1.0.19 |
|
889 | - * @param string $context View or edit context. |
|
890 | - * @return string |
|
891 | - */ |
|
892 | - public function get_full_name( $context = 'view' ) { |
|
893 | - return trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) ); |
|
886 | + * Get the customer's full name. |
|
887 | + * |
|
888 | + * @since 1.0.19 |
|
889 | + * @param string $context View or edit context. |
|
890 | + * @return string |
|
891 | + */ |
|
892 | + public function get_full_name( $context = 'view' ) { |
|
893 | + return trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) ); |
|
894 | 894 | } |
895 | 895 | |
896 | 896 | /** |
897 | - * Alias of self::get_full_name(). |
|
898 | - * |
|
899 | - * @since 1.0.19 |
|
900 | - * @param string $context View or edit context. |
|
901 | - * @return string |
|
902 | - */ |
|
903 | - public function get_user_full_name( $context = 'view' ) { |
|
904 | - return $this->get_full_name( $context ); |
|
897 | + * Alias of self::get_full_name(). |
|
898 | + * |
|
899 | + * @since 1.0.19 |
|
900 | + * @param string $context View or edit context. |
|
901 | + * @return string |
|
902 | + */ |
|
903 | + public function get_user_full_name( $context = 'view' ) { |
|
904 | + return $this->get_full_name( $context ); |
|
905 | 905 | } |
906 | 906 | |
907 | 907 | /** |
908 | - * Alias of self::get_full_name(). |
|
909 | - * |
|
910 | - * @since 1.0.19 |
|
911 | - * @param string $context View or edit context. |
|
912 | - * @return string |
|
913 | - */ |
|
914 | - public function get_customer_full_name( $context = 'view' ) { |
|
915 | - return $this->get_full_name( $context ); |
|
908 | + * Alias of self::get_full_name(). |
|
909 | + * |
|
910 | + * @since 1.0.19 |
|
911 | + * @param string $context View or edit context. |
|
912 | + * @return string |
|
913 | + */ |
|
914 | + public function get_customer_full_name( $context = 'view' ) { |
|
915 | + return $this->get_full_name( $context ); |
|
916 | 916 | } |
917 | 917 | |
918 | 918 | /** |
919 | - * Get the customer's phone number. |
|
920 | - * |
|
921 | - * @since 1.0.19 |
|
922 | - * @param string $context View or edit context. |
|
923 | - * @return string |
|
924 | - */ |
|
925 | - public function get_phone( $context = 'view' ) { |
|
926 | - return $this->get_prop( 'phone', $context ); |
|
919 | + * Get the customer's phone number. |
|
920 | + * |
|
921 | + * @since 1.0.19 |
|
922 | + * @param string $context View or edit context. |
|
923 | + * @return string |
|
924 | + */ |
|
925 | + public function get_phone( $context = 'view' ) { |
|
926 | + return $this->get_prop( 'phone', $context ); |
|
927 | 927 | } |
928 | 928 | |
929 | 929 | /** |
930 | - * Alias of self::get_phone(). |
|
931 | - * |
|
932 | - * @since 1.0.19 |
|
933 | - * @param string $context View or edit context. |
|
934 | - * @return string |
|
935 | - */ |
|
936 | - public function get_phone_number( $context = 'view' ) { |
|
937 | - return $this->get_phone( $context ); |
|
930 | + * Alias of self::get_phone(). |
|
931 | + * |
|
932 | + * @since 1.0.19 |
|
933 | + * @param string $context View or edit context. |
|
934 | + * @return string |
|
935 | + */ |
|
936 | + public function get_phone_number( $context = 'view' ) { |
|
937 | + return $this->get_phone( $context ); |
|
938 | 938 | } |
939 | 939 | |
940 | 940 | /** |
941 | - * Alias of self::get_phone(). |
|
942 | - * |
|
943 | - * @since 1.0.19 |
|
944 | - * @param string $context View or edit context. |
|
945 | - * @return string |
|
946 | - */ |
|
947 | - public function get_user_phone( $context = 'view' ) { |
|
948 | - return $this->get_phone( $context ); |
|
941 | + * Alias of self::get_phone(). |
|
942 | + * |
|
943 | + * @since 1.0.19 |
|
944 | + * @param string $context View or edit context. |
|
945 | + * @return string |
|
946 | + */ |
|
947 | + public function get_user_phone( $context = 'view' ) { |
|
948 | + return $this->get_phone( $context ); |
|
949 | 949 | } |
950 | 950 | |
951 | 951 | /** |
952 | - * Alias of self::get_phone(). |
|
953 | - * |
|
954 | - * @since 1.0.19 |
|
955 | - * @param string $context View or edit context. |
|
956 | - * @return string |
|
957 | - */ |
|
958 | - public function get_customer_phone( $context = 'view' ) { |
|
959 | - return $this->get_phone( $context ); |
|
952 | + * Alias of self::get_phone(). |
|
953 | + * |
|
954 | + * @since 1.0.19 |
|
955 | + * @param string $context View or edit context. |
|
956 | + * @return string |
|
957 | + */ |
|
958 | + public function get_customer_phone( $context = 'view' ) { |
|
959 | + return $this->get_phone( $context ); |
|
960 | 960 | } |
961 | 961 | |
962 | 962 | /** |
963 | - * Get the customer's email address. |
|
964 | - * |
|
965 | - * @since 1.0.19 |
|
966 | - * @param string $context View or edit context. |
|
967 | - * @return string |
|
968 | - */ |
|
969 | - public function get_email( $context = 'view' ) { |
|
970 | - return $this->get_prop( 'email', $context ); |
|
963 | + * Get the customer's email address. |
|
964 | + * |
|
965 | + * @since 1.0.19 |
|
966 | + * @param string $context View or edit context. |
|
967 | + * @return string |
|
968 | + */ |
|
969 | + public function get_email( $context = 'view' ) { |
|
970 | + return $this->get_prop( 'email', $context ); |
|
971 | 971 | } |
972 | 972 | |
973 | 973 | /** |
974 | - * Alias of self::get_email(). |
|
975 | - * |
|
976 | - * @since 1.0.19 |
|
977 | - * @param string $context View or edit context. |
|
978 | - * @return string |
|
979 | - */ |
|
980 | - public function get_email_address( $context = 'view' ) { |
|
981 | - return $this->get_email( $context ); |
|
974 | + * Alias of self::get_email(). |
|
975 | + * |
|
976 | + * @since 1.0.19 |
|
977 | + * @param string $context View or edit context. |
|
978 | + * @return string |
|
979 | + */ |
|
980 | + public function get_email_address( $context = 'view' ) { |
|
981 | + return $this->get_email( $context ); |
|
982 | 982 | } |
983 | 983 | |
984 | 984 | /** |
985 | - * Alias of self::get_email(). |
|
986 | - * |
|
987 | - * @since 1.0.19 |
|
988 | - * @param string $context View or edit context. |
|
989 | - * @return string |
|
990 | - */ |
|
991 | - public function get_user_email( $context = 'view' ) { |
|
992 | - return $this->get_email( $context ); |
|
985 | + * Alias of self::get_email(). |
|
986 | + * |
|
987 | + * @since 1.0.19 |
|
988 | + * @param string $context View or edit context. |
|
989 | + * @return string |
|
990 | + */ |
|
991 | + public function get_user_email( $context = 'view' ) { |
|
992 | + return $this->get_email( $context ); |
|
993 | 993 | } |
994 | 994 | |
995 | 995 | /** |
996 | - * Alias of self::get_email(). |
|
997 | - * |
|
998 | - * @since 1.0.19 |
|
999 | - * @param string $context View or edit context. |
|
1000 | - * @return string |
|
1001 | - */ |
|
1002 | - public function get_customer_email( $context = 'view' ) { |
|
1003 | - return $this->get_email( $context ); |
|
996 | + * Alias of self::get_email(). |
|
997 | + * |
|
998 | + * @since 1.0.19 |
|
999 | + * @param string $context View or edit context. |
|
1000 | + * @return string |
|
1001 | + */ |
|
1002 | + public function get_customer_email( $context = 'view' ) { |
|
1003 | + return $this->get_email( $context ); |
|
1004 | 1004 | } |
1005 | 1005 | |
1006 | 1006 | /** |
1007 | - * Get the customer's country. |
|
1008 | - * |
|
1009 | - * @since 1.0.19 |
|
1010 | - * @param string $context View or edit context. |
|
1011 | - * @return string |
|
1012 | - */ |
|
1013 | - public function get_country( $context = 'view' ) { |
|
1014 | - $country = $this->get_prop( 'country', $context ); |
|
1015 | - return empty( $country ) ? wpinv_get_default_country() : $country; |
|
1007 | + * Get the customer's country. |
|
1008 | + * |
|
1009 | + * @since 1.0.19 |
|
1010 | + * @param string $context View or edit context. |
|
1011 | + * @return string |
|
1012 | + */ |
|
1013 | + public function get_country( $context = 'view' ) { |
|
1014 | + $country = $this->get_prop( 'country', $context ); |
|
1015 | + return empty( $country ) ? wpinv_get_default_country() : $country; |
|
1016 | 1016 | } |
1017 | 1017 | |
1018 | 1018 | /** |
1019 | - * Alias of self::get_country(). |
|
1020 | - * |
|
1021 | - * @since 1.0.19 |
|
1022 | - * @param string $context View or edit context. |
|
1023 | - * @return string |
|
1024 | - */ |
|
1025 | - public function get_user_country( $context = 'view' ) { |
|
1026 | - return $this->get_country( $context ); |
|
1019 | + * Alias of self::get_country(). |
|
1020 | + * |
|
1021 | + * @since 1.0.19 |
|
1022 | + * @param string $context View or edit context. |
|
1023 | + * @return string |
|
1024 | + */ |
|
1025 | + public function get_user_country( $context = 'view' ) { |
|
1026 | + return $this->get_country( $context ); |
|
1027 | 1027 | } |
1028 | 1028 | |
1029 | 1029 | /** |
1030 | - * Alias of self::get_country(). |
|
1031 | - * |
|
1032 | - * @since 1.0.19 |
|
1033 | - * @param string $context View or edit context. |
|
1034 | - * @return string |
|
1035 | - */ |
|
1036 | - public function get_customer_country( $context = 'view' ) { |
|
1037 | - return $this->get_country( $context ); |
|
1030 | + * Alias of self::get_country(). |
|
1031 | + * |
|
1032 | + * @since 1.0.19 |
|
1033 | + * @param string $context View or edit context. |
|
1034 | + * @return string |
|
1035 | + */ |
|
1036 | + public function get_customer_country( $context = 'view' ) { |
|
1037 | + return $this->get_country( $context ); |
|
1038 | 1038 | } |
1039 | 1039 | |
1040 | 1040 | /** |
1041 | - * Get the customer's state. |
|
1042 | - * |
|
1043 | - * @since 1.0.19 |
|
1044 | - * @param string $context View or edit context. |
|
1045 | - * @return string |
|
1046 | - */ |
|
1047 | - public function get_state( $context = 'view' ) { |
|
1048 | - $state = $this->get_prop( 'state', $context ); |
|
1049 | - return empty( $state ) ? wpinv_get_default_state() : $state; |
|
1041 | + * Get the customer's state. |
|
1042 | + * |
|
1043 | + * @since 1.0.19 |
|
1044 | + * @param string $context View or edit context. |
|
1045 | + * @return string |
|
1046 | + */ |
|
1047 | + public function get_state( $context = 'view' ) { |
|
1048 | + $state = $this->get_prop( 'state', $context ); |
|
1049 | + return empty( $state ) ? wpinv_get_default_state() : $state; |
|
1050 | 1050 | } |
1051 | 1051 | |
1052 | 1052 | /** |
1053 | - * Alias of self::get_state(). |
|
1054 | - * |
|
1055 | - * @since 1.0.19 |
|
1056 | - * @param string $context View or edit context. |
|
1057 | - * @return string |
|
1058 | - */ |
|
1059 | - public function get_user_state( $context = 'view' ) { |
|
1060 | - return $this->get_state( $context ); |
|
1053 | + * Alias of self::get_state(). |
|
1054 | + * |
|
1055 | + * @since 1.0.19 |
|
1056 | + * @param string $context View or edit context. |
|
1057 | + * @return string |
|
1058 | + */ |
|
1059 | + public function get_user_state( $context = 'view' ) { |
|
1060 | + return $this->get_state( $context ); |
|
1061 | 1061 | } |
1062 | 1062 | |
1063 | 1063 | /** |
1064 | - * Alias of self::get_state(). |
|
1065 | - * |
|
1066 | - * @since 1.0.19 |
|
1067 | - * @param string $context View or edit context. |
|
1068 | - * @return string |
|
1069 | - */ |
|
1070 | - public function get_customer_state( $context = 'view' ) { |
|
1071 | - return $this->get_state( $context ); |
|
1064 | + * Alias of self::get_state(). |
|
1065 | + * |
|
1066 | + * @since 1.0.19 |
|
1067 | + * @param string $context View or edit context. |
|
1068 | + * @return string |
|
1069 | + */ |
|
1070 | + public function get_customer_state( $context = 'view' ) { |
|
1071 | + return $this->get_state( $context ); |
|
1072 | 1072 | } |
1073 | 1073 | |
1074 | 1074 | /** |
1075 | - * Get the customer's city. |
|
1076 | - * |
|
1077 | - * @since 1.0.19 |
|
1078 | - * @param string $context View or edit context. |
|
1079 | - * @return string |
|
1080 | - */ |
|
1081 | - public function get_city( $context = 'view' ) { |
|
1082 | - return $this->get_prop( 'city', $context ); |
|
1075 | + * Get the customer's city. |
|
1076 | + * |
|
1077 | + * @since 1.0.19 |
|
1078 | + * @param string $context View or edit context. |
|
1079 | + * @return string |
|
1080 | + */ |
|
1081 | + public function get_city( $context = 'view' ) { |
|
1082 | + return $this->get_prop( 'city', $context ); |
|
1083 | 1083 | } |
1084 | 1084 | |
1085 | 1085 | /** |
1086 | - * Alias of self::get_city(). |
|
1087 | - * |
|
1088 | - * @since 1.0.19 |
|
1089 | - * @param string $context View or edit context. |
|
1090 | - * @return string |
|
1091 | - */ |
|
1092 | - public function get_user_city( $context = 'view' ) { |
|
1093 | - return $this->get_city( $context ); |
|
1086 | + * Alias of self::get_city(). |
|
1087 | + * |
|
1088 | + * @since 1.0.19 |
|
1089 | + * @param string $context View or edit context. |
|
1090 | + * @return string |
|
1091 | + */ |
|
1092 | + public function get_user_city( $context = 'view' ) { |
|
1093 | + return $this->get_city( $context ); |
|
1094 | 1094 | } |
1095 | 1095 | |
1096 | 1096 | /** |
1097 | - * Alias of self::get_city(). |
|
1098 | - * |
|
1099 | - * @since 1.0.19 |
|
1100 | - * @param string $context View or edit context. |
|
1101 | - * @return string |
|
1102 | - */ |
|
1103 | - public function get_customer_city( $context = 'view' ) { |
|
1104 | - return $this->get_city( $context ); |
|
1097 | + * Alias of self::get_city(). |
|
1098 | + * |
|
1099 | + * @since 1.0.19 |
|
1100 | + * @param string $context View or edit context. |
|
1101 | + * @return string |
|
1102 | + */ |
|
1103 | + public function get_customer_city( $context = 'view' ) { |
|
1104 | + return $this->get_city( $context ); |
|
1105 | 1105 | } |
1106 | 1106 | |
1107 | 1107 | /** |
1108 | - * Get the customer's zip. |
|
1109 | - * |
|
1110 | - * @since 1.0.19 |
|
1111 | - * @param string $context View or edit context. |
|
1112 | - * @return string |
|
1113 | - */ |
|
1114 | - public function get_zip( $context = 'view' ) { |
|
1115 | - return $this->get_prop( 'zip', $context ); |
|
1108 | + * Get the customer's zip. |
|
1109 | + * |
|
1110 | + * @since 1.0.19 |
|
1111 | + * @param string $context View or edit context. |
|
1112 | + * @return string |
|
1113 | + */ |
|
1114 | + public function get_zip( $context = 'view' ) { |
|
1115 | + return $this->get_prop( 'zip', $context ); |
|
1116 | 1116 | } |
1117 | 1117 | |
1118 | 1118 | /** |
1119 | - * Alias of self::get_zip(). |
|
1120 | - * |
|
1121 | - * @since 1.0.19 |
|
1122 | - * @param string $context View or edit context. |
|
1123 | - * @return string |
|
1124 | - */ |
|
1125 | - public function get_user_zip( $context = 'view' ) { |
|
1126 | - return $this->get_zip( $context ); |
|
1119 | + * Alias of self::get_zip(). |
|
1120 | + * |
|
1121 | + * @since 1.0.19 |
|
1122 | + * @param string $context View or edit context. |
|
1123 | + * @return string |
|
1124 | + */ |
|
1125 | + public function get_user_zip( $context = 'view' ) { |
|
1126 | + return $this->get_zip( $context ); |
|
1127 | 1127 | } |
1128 | 1128 | |
1129 | 1129 | /** |
1130 | - * Alias of self::get_zip(). |
|
1131 | - * |
|
1132 | - * @since 1.0.19 |
|
1133 | - * @param string $context View or edit context. |
|
1134 | - * @return string |
|
1135 | - */ |
|
1136 | - public function get_customer_zip( $context = 'view' ) { |
|
1137 | - return $this->get_zip( $context ); |
|
1130 | + * Alias of self::get_zip(). |
|
1131 | + * |
|
1132 | + * @since 1.0.19 |
|
1133 | + * @param string $context View or edit context. |
|
1134 | + * @return string |
|
1135 | + */ |
|
1136 | + public function get_customer_zip( $context = 'view' ) { |
|
1137 | + return $this->get_zip( $context ); |
|
1138 | 1138 | } |
1139 | 1139 | |
1140 | 1140 | /** |
1141 | - * Get the customer's company. |
|
1142 | - * |
|
1143 | - * @since 1.0.19 |
|
1144 | - * @param string $context View or edit context. |
|
1145 | - * @return string |
|
1146 | - */ |
|
1147 | - public function get_company( $context = 'view' ) { |
|
1148 | - return $this->get_prop( 'company', $context ); |
|
1141 | + * Get the customer's company. |
|
1142 | + * |
|
1143 | + * @since 1.0.19 |
|
1144 | + * @param string $context View or edit context. |
|
1145 | + * @return string |
|
1146 | + */ |
|
1147 | + public function get_company( $context = 'view' ) { |
|
1148 | + return $this->get_prop( 'company', $context ); |
|
1149 | 1149 | } |
1150 | 1150 | |
1151 | 1151 | /** |
1152 | - * Alias of self::get_company(). |
|
1153 | - * |
|
1154 | - * @since 1.0.19 |
|
1155 | - * @param string $context View or edit context. |
|
1156 | - * @return string |
|
1157 | - */ |
|
1158 | - public function get_user_company( $context = 'view' ) { |
|
1159 | - return $this->get_company( $context ); |
|
1152 | + * Alias of self::get_company(). |
|
1153 | + * |
|
1154 | + * @since 1.0.19 |
|
1155 | + * @param string $context View or edit context. |
|
1156 | + * @return string |
|
1157 | + */ |
|
1158 | + public function get_user_company( $context = 'view' ) { |
|
1159 | + return $this->get_company( $context ); |
|
1160 | 1160 | } |
1161 | 1161 | |
1162 | 1162 | /** |
1163 | - * Alias of self::get_company(). |
|
1164 | - * |
|
1165 | - * @since 1.0.19 |
|
1166 | - * @param string $context View or edit context. |
|
1167 | - * @return string |
|
1168 | - */ |
|
1169 | - public function get_customer_company( $context = 'view' ) { |
|
1170 | - return $this->get_company( $context ); |
|
1163 | + * Alias of self::get_company(). |
|
1164 | + * |
|
1165 | + * @since 1.0.19 |
|
1166 | + * @param string $context View or edit context. |
|
1167 | + * @return string |
|
1168 | + */ |
|
1169 | + public function get_customer_company( $context = 'view' ) { |
|
1170 | + return $this->get_company( $context ); |
|
1171 | 1171 | } |
1172 | 1172 | |
1173 | 1173 | /** |
1174 | - * Get the customer's vat number. |
|
1175 | - * |
|
1176 | - * @since 1.0.19 |
|
1177 | - * @param string $context View or edit context. |
|
1178 | - * @return string |
|
1179 | - */ |
|
1180 | - public function get_vat_number( $context = 'view' ) { |
|
1181 | - return $this->get_prop( 'vat_number', $context ); |
|
1174 | + * Get the customer's vat number. |
|
1175 | + * |
|
1176 | + * @since 1.0.19 |
|
1177 | + * @param string $context View or edit context. |
|
1178 | + * @return string |
|
1179 | + */ |
|
1180 | + public function get_vat_number( $context = 'view' ) { |
|
1181 | + return $this->get_prop( 'vat_number', $context ); |
|
1182 | 1182 | } |
1183 | 1183 | |
1184 | 1184 | /** |
1185 | - * Alias of self::get_vat_number(). |
|
1186 | - * |
|
1187 | - * @since 1.0.19 |
|
1188 | - * @param string $context View or edit context. |
|
1189 | - * @return string |
|
1190 | - */ |
|
1191 | - public function get_user_vat_number( $context = 'view' ) { |
|
1192 | - return $this->get_vat_number( $context ); |
|
1185 | + * Alias of self::get_vat_number(). |
|
1186 | + * |
|
1187 | + * @since 1.0.19 |
|
1188 | + * @param string $context View or edit context. |
|
1189 | + * @return string |
|
1190 | + */ |
|
1191 | + public function get_user_vat_number( $context = 'view' ) { |
|
1192 | + return $this->get_vat_number( $context ); |
|
1193 | 1193 | } |
1194 | 1194 | |
1195 | 1195 | /** |
1196 | - * Alias of self::get_vat_number(). |
|
1197 | - * |
|
1198 | - * @since 1.0.19 |
|
1199 | - * @param string $context View or edit context. |
|
1200 | - * @return string |
|
1201 | - */ |
|
1202 | - public function get_customer_vat_number( $context = 'view' ) { |
|
1203 | - return $this->get_vat_number( $context ); |
|
1196 | + * Alias of self::get_vat_number(). |
|
1197 | + * |
|
1198 | + * @since 1.0.19 |
|
1199 | + * @param string $context View or edit context. |
|
1200 | + * @return string |
|
1201 | + */ |
|
1202 | + public function get_customer_vat_number( $context = 'view' ) { |
|
1203 | + return $this->get_vat_number( $context ); |
|
1204 | 1204 | } |
1205 | 1205 | |
1206 | 1206 | /** |
1207 | - * Get the customer's vat rate. |
|
1208 | - * |
|
1209 | - * @since 1.0.19 |
|
1210 | - * @param string $context View or edit context. |
|
1211 | - * @return string |
|
1212 | - */ |
|
1213 | - public function get_vat_rate( $context = 'view' ) { |
|
1214 | - return $this->get_prop( 'vat_rate', $context ); |
|
1215 | - } |
|
1216 | - |
|
1217 | - /** |
|
1218 | - * Alias of self::get_vat_rate(). |
|
1219 | - * |
|
1220 | - * @since 1.0.19 |
|
1221 | - * @param string $context View or edit context. |
|
1222 | - * @return string |
|
1223 | - */ |
|
1224 | - public function get_user_vat_rate( $context = 'view' ) { |
|
1225 | - return $this->get_vat_rate( $context ); |
|
1226 | - } |
|
1227 | - |
|
1228 | - /** |
|
1229 | - * Alias of self::get_vat_rate(). |
|
1230 | - * |
|
1231 | - * @since 1.0.19 |
|
1232 | - * @param string $context View or edit context. |
|
1233 | - * @return string |
|
1234 | - */ |
|
1235 | - public function get_customer_vat_rate( $context = 'view' ) { |
|
1236 | - return $this->get_vat_rate( $context ); |
|
1237 | - } |
|
1238 | - |
|
1239 | - /** |
|
1240 | - * Get the customer's address. |
|
1241 | - * |
|
1242 | - * @since 1.0.19 |
|
1243 | - * @param string $context View or edit context. |
|
1244 | - * @return string |
|
1245 | - */ |
|
1246 | - public function get_address( $context = 'view' ) { |
|
1247 | - return $this->get_prop( 'address', $context ); |
|
1248 | - } |
|
1249 | - |
|
1250 | - /** |
|
1251 | - * Alias of self::get_address(). |
|
1252 | - * |
|
1253 | - * @since 1.0.19 |
|
1254 | - * @param string $context View or edit context. |
|
1255 | - * @return string |
|
1256 | - */ |
|
1257 | - public function get_user_address( $context = 'view' ) { |
|
1258 | - return $this->get_address( $context ); |
|
1259 | - } |
|
1260 | - |
|
1261 | - /** |
|
1262 | - * Alias of self::get_address(). |
|
1263 | - * |
|
1264 | - * @since 1.0.19 |
|
1265 | - * @param string $context View or edit context. |
|
1266 | - * @return string |
|
1267 | - */ |
|
1268 | - public function get_customer_address( $context = 'view' ) { |
|
1269 | - return $this->get_address( $context ); |
|
1270 | - } |
|
1271 | - |
|
1272 | - /** |
|
1273 | - * Get whether the customer has viewed the invoice or not. |
|
1274 | - * |
|
1275 | - * @since 1.0.19 |
|
1276 | - * @param string $context View or edit context. |
|
1277 | - * @return bool |
|
1278 | - */ |
|
1279 | - public function get_is_viewed( $context = 'view' ) { |
|
1280 | - return (bool) $this->get_prop( 'is_viewed', $context ); |
|
1281 | - } |
|
1282 | - |
|
1283 | - /** |
|
1284 | - * Get other recipients for invoice communications. |
|
1285 | - * |
|
1286 | - * @since 1.0.19 |
|
1287 | - * @param string $context View or edit context. |
|
1288 | - * @return bool |
|
1289 | - */ |
|
1290 | - public function get_email_cc( $context = 'view' ) { |
|
1291 | - return $this->get_prop( 'email_cc', $context ); |
|
1292 | - } |
|
1293 | - |
|
1294 | - /** |
|
1295 | - * Get invoice template. |
|
1296 | - * |
|
1297 | - * @since 1.0.19 |
|
1298 | - * @param string $context View or edit context. |
|
1299 | - * @return bool |
|
1300 | - */ |
|
1301 | - public function get_template( $context = 'view' ) { |
|
1302 | - return $this->get_prop( 'template', $context ); |
|
1303 | - } |
|
1304 | - |
|
1305 | - /** |
|
1306 | - * Get invoice source. |
|
1307 | - * |
|
1308 | - * @since 1.0.19 |
|
1309 | - * @param string $context View or edit context. |
|
1310 | - * @return bool |
|
1311 | - */ |
|
1312 | - public function get_created_via( $context = 'view' ) { |
|
1313 | - return $this->get_prop( 'created_via', $context ); |
|
1314 | - } |
|
1315 | - |
|
1316 | - /** |
|
1317 | - * Get whether the customer has confirmed their address. |
|
1318 | - * |
|
1319 | - * @since 1.0.19 |
|
1320 | - * @param string $context View or edit context. |
|
1321 | - * @return bool |
|
1322 | - */ |
|
1323 | - public function get_address_confirmed( $context = 'view' ) { |
|
1324 | - return (bool) $this->get_prop( 'address_confirmed', $context ); |
|
1325 | - } |
|
1326 | - |
|
1327 | - /** |
|
1328 | - * Alias of self::get_address_confirmed(). |
|
1329 | - * |
|
1330 | - * @since 1.0.19 |
|
1331 | - * @param string $context View or edit context. |
|
1332 | - * @return bool |
|
1333 | - */ |
|
1334 | - public function get_user_address_confirmed( $context = 'view' ) { |
|
1335 | - return $this->get_address_confirmed( $context ); |
|
1336 | - } |
|
1337 | - |
|
1338 | - /** |
|
1339 | - * Alias of self::get_address(). |
|
1340 | - * |
|
1341 | - * @since 1.0.19 |
|
1342 | - * @param string $context View or edit context. |
|
1343 | - * @return bool |
|
1344 | - */ |
|
1345 | - public function get_customer_address_confirmed( $context = 'view' ) { |
|
1346 | - return $this->get_address_confirmed( $context ); |
|
1347 | - } |
|
1348 | - |
|
1349 | - /** |
|
1350 | - * Get the invoice subtotal. |
|
1351 | - * |
|
1352 | - * @since 1.0.19 |
|
1353 | - * @param string $context View or edit context. |
|
1354 | - * @return float |
|
1355 | - */ |
|
1356 | - public function get_subtotal( $context = 'view' ) { |
|
1207 | + * Get the customer's vat rate. |
|
1208 | + * |
|
1209 | + * @since 1.0.19 |
|
1210 | + * @param string $context View or edit context. |
|
1211 | + * @return string |
|
1212 | + */ |
|
1213 | + public function get_vat_rate( $context = 'view' ) { |
|
1214 | + return $this->get_prop( 'vat_rate', $context ); |
|
1215 | + } |
|
1216 | + |
|
1217 | + /** |
|
1218 | + * Alias of self::get_vat_rate(). |
|
1219 | + * |
|
1220 | + * @since 1.0.19 |
|
1221 | + * @param string $context View or edit context. |
|
1222 | + * @return string |
|
1223 | + */ |
|
1224 | + public function get_user_vat_rate( $context = 'view' ) { |
|
1225 | + return $this->get_vat_rate( $context ); |
|
1226 | + } |
|
1227 | + |
|
1228 | + /** |
|
1229 | + * Alias of self::get_vat_rate(). |
|
1230 | + * |
|
1231 | + * @since 1.0.19 |
|
1232 | + * @param string $context View or edit context. |
|
1233 | + * @return string |
|
1234 | + */ |
|
1235 | + public function get_customer_vat_rate( $context = 'view' ) { |
|
1236 | + return $this->get_vat_rate( $context ); |
|
1237 | + } |
|
1238 | + |
|
1239 | + /** |
|
1240 | + * Get the customer's address. |
|
1241 | + * |
|
1242 | + * @since 1.0.19 |
|
1243 | + * @param string $context View or edit context. |
|
1244 | + * @return string |
|
1245 | + */ |
|
1246 | + public function get_address( $context = 'view' ) { |
|
1247 | + return $this->get_prop( 'address', $context ); |
|
1248 | + } |
|
1249 | + |
|
1250 | + /** |
|
1251 | + * Alias of self::get_address(). |
|
1252 | + * |
|
1253 | + * @since 1.0.19 |
|
1254 | + * @param string $context View or edit context. |
|
1255 | + * @return string |
|
1256 | + */ |
|
1257 | + public function get_user_address( $context = 'view' ) { |
|
1258 | + return $this->get_address( $context ); |
|
1259 | + } |
|
1260 | + |
|
1261 | + /** |
|
1262 | + * Alias of self::get_address(). |
|
1263 | + * |
|
1264 | + * @since 1.0.19 |
|
1265 | + * @param string $context View or edit context. |
|
1266 | + * @return string |
|
1267 | + */ |
|
1268 | + public function get_customer_address( $context = 'view' ) { |
|
1269 | + return $this->get_address( $context ); |
|
1270 | + } |
|
1271 | + |
|
1272 | + /** |
|
1273 | + * Get whether the customer has viewed the invoice or not. |
|
1274 | + * |
|
1275 | + * @since 1.0.19 |
|
1276 | + * @param string $context View or edit context. |
|
1277 | + * @return bool |
|
1278 | + */ |
|
1279 | + public function get_is_viewed( $context = 'view' ) { |
|
1280 | + return (bool) $this->get_prop( 'is_viewed', $context ); |
|
1281 | + } |
|
1282 | + |
|
1283 | + /** |
|
1284 | + * Get other recipients for invoice communications. |
|
1285 | + * |
|
1286 | + * @since 1.0.19 |
|
1287 | + * @param string $context View or edit context. |
|
1288 | + * @return bool |
|
1289 | + */ |
|
1290 | + public function get_email_cc( $context = 'view' ) { |
|
1291 | + return $this->get_prop( 'email_cc', $context ); |
|
1292 | + } |
|
1293 | + |
|
1294 | + /** |
|
1295 | + * Get invoice template. |
|
1296 | + * |
|
1297 | + * @since 1.0.19 |
|
1298 | + * @param string $context View or edit context. |
|
1299 | + * @return bool |
|
1300 | + */ |
|
1301 | + public function get_template( $context = 'view' ) { |
|
1302 | + return $this->get_prop( 'template', $context ); |
|
1303 | + } |
|
1304 | + |
|
1305 | + /** |
|
1306 | + * Get invoice source. |
|
1307 | + * |
|
1308 | + * @since 1.0.19 |
|
1309 | + * @param string $context View or edit context. |
|
1310 | + * @return bool |
|
1311 | + */ |
|
1312 | + public function get_created_via( $context = 'view' ) { |
|
1313 | + return $this->get_prop( 'created_via', $context ); |
|
1314 | + } |
|
1315 | + |
|
1316 | + /** |
|
1317 | + * Get whether the customer has confirmed their address. |
|
1318 | + * |
|
1319 | + * @since 1.0.19 |
|
1320 | + * @param string $context View or edit context. |
|
1321 | + * @return bool |
|
1322 | + */ |
|
1323 | + public function get_address_confirmed( $context = 'view' ) { |
|
1324 | + return (bool) $this->get_prop( 'address_confirmed', $context ); |
|
1325 | + } |
|
1326 | + |
|
1327 | + /** |
|
1328 | + * Alias of self::get_address_confirmed(). |
|
1329 | + * |
|
1330 | + * @since 1.0.19 |
|
1331 | + * @param string $context View or edit context. |
|
1332 | + * @return bool |
|
1333 | + */ |
|
1334 | + public function get_user_address_confirmed( $context = 'view' ) { |
|
1335 | + return $this->get_address_confirmed( $context ); |
|
1336 | + } |
|
1337 | + |
|
1338 | + /** |
|
1339 | + * Alias of self::get_address(). |
|
1340 | + * |
|
1341 | + * @since 1.0.19 |
|
1342 | + * @param string $context View or edit context. |
|
1343 | + * @return bool |
|
1344 | + */ |
|
1345 | + public function get_customer_address_confirmed( $context = 'view' ) { |
|
1346 | + return $this->get_address_confirmed( $context ); |
|
1347 | + } |
|
1348 | + |
|
1349 | + /** |
|
1350 | + * Get the invoice subtotal. |
|
1351 | + * |
|
1352 | + * @since 1.0.19 |
|
1353 | + * @param string $context View or edit context. |
|
1354 | + * @return float |
|
1355 | + */ |
|
1356 | + public function get_subtotal( $context = 'view' ) { |
|
1357 | 1357 | $subtotal = (float) $this->get_prop( 'subtotal', $context ); |
1358 | 1358 | |
1359 | 1359 | // Backwards compatibility. |
@@ -1365,166 +1365,166 @@ discard block |
||
1365 | 1365 | } |
1366 | 1366 | |
1367 | 1367 | /** |
1368 | - * Get the invoice discount total. |
|
1369 | - * |
|
1370 | - * @since 1.0.19 |
|
1371 | - * @param string $context View or edit context. |
|
1372 | - * @return float |
|
1373 | - */ |
|
1374 | - public function get_total_discount( $context = 'view' ) { |
|
1375 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_discount', $context ) ) ); |
|
1368 | + * Get the invoice discount total. |
|
1369 | + * |
|
1370 | + * @since 1.0.19 |
|
1371 | + * @param string $context View or edit context. |
|
1372 | + * @return float |
|
1373 | + */ |
|
1374 | + public function get_total_discount( $context = 'view' ) { |
|
1375 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_discount', $context ) ) ); |
|
1376 | 1376 | } |
1377 | 1377 | |
1378 | 1378 | /** |
1379 | - * Get the invoice tax total. |
|
1380 | - * |
|
1381 | - * @since 1.0.19 |
|
1382 | - * @param string $context View or edit context. |
|
1383 | - * @return float |
|
1384 | - */ |
|
1385 | - public function get_total_tax( $context = 'view' ) { |
|
1386 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_tax', $context ) ) ); |
|
1387 | - } |
|
1379 | + * Get the invoice tax total. |
|
1380 | + * |
|
1381 | + * @since 1.0.19 |
|
1382 | + * @param string $context View or edit context. |
|
1383 | + * @return float |
|
1384 | + */ |
|
1385 | + public function get_total_tax( $context = 'view' ) { |
|
1386 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_tax', $context ) ) ); |
|
1387 | + } |
|
1388 | 1388 | |
1389 | - /** |
|
1390 | - * @deprecated |
|
1391 | - */ |
|
1392 | - public function get_final_tax( $currency = false ) { |
|
1393 | - $tax = $this->get_total_tax(); |
|
1389 | + /** |
|
1390 | + * @deprecated |
|
1391 | + */ |
|
1392 | + public function get_final_tax( $currency = false ) { |
|
1393 | + $tax = $this->get_total_tax(); |
|
1394 | 1394 | |
1395 | 1395 | if ( $currency ) { |
1396 | - return wpinv_price( $tax, $this->get_currency() ); |
|
1396 | + return wpinv_price( $tax, $this->get_currency() ); |
|
1397 | 1397 | } |
1398 | 1398 | |
1399 | 1399 | return $tax; |
1400 | 1400 | } |
1401 | 1401 | |
1402 | 1402 | /** |
1403 | - * Get the invoice fees total. |
|
1404 | - * |
|
1405 | - * @since 1.0.19 |
|
1406 | - * @param string $context View or edit context. |
|
1407 | - * @return float |
|
1408 | - */ |
|
1409 | - public function get_total_fees( $context = 'view' ) { |
|
1410 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_fees', $context ) ) ); |
|
1403 | + * Get the invoice fees total. |
|
1404 | + * |
|
1405 | + * @since 1.0.19 |
|
1406 | + * @param string $context View or edit context. |
|
1407 | + * @return float |
|
1408 | + */ |
|
1409 | + public function get_total_fees( $context = 'view' ) { |
|
1410 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total_fees', $context ) ) ); |
|
1411 | 1411 | } |
1412 | 1412 | |
1413 | 1413 | /** |
1414 | - * Alias for self::get_total_fees(). |
|
1415 | - * |
|
1416 | - * @since 1.0.19 |
|
1417 | - * @param string $context View or edit context. |
|
1418 | - * @return float |
|
1419 | - */ |
|
1420 | - public function get_fees_total( $context = 'view' ) { |
|
1421 | - return $this->get_total_fees( $context ); |
|
1414 | + * Alias for self::get_total_fees(). |
|
1415 | + * |
|
1416 | + * @since 1.0.19 |
|
1417 | + * @param string $context View or edit context. |
|
1418 | + * @return float |
|
1419 | + */ |
|
1420 | + public function get_fees_total( $context = 'view' ) { |
|
1421 | + return $this->get_total_fees( $context ); |
|
1422 | 1422 | } |
1423 | 1423 | |
1424 | 1424 | /** |
1425 | - * Get the invoice total. |
|
1426 | - * |
|
1427 | - * @since 1.0.19 |
|
1425 | + * Get the invoice total. |
|
1426 | + * |
|
1427 | + * @since 1.0.19 |
|
1428 | 1428 | * @return float |
1429 | - */ |
|
1430 | - public function get_total( $context = 'view' ) { |
|
1431 | - return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total', $context ) ) ); |
|
1432 | - } |
|
1433 | - |
|
1434 | - /** |
|
1435 | - * Get the invoice totals. |
|
1436 | - * |
|
1437 | - * @since 1.0.19 |
|
1429 | + */ |
|
1430 | + public function get_total( $context = 'view' ) { |
|
1431 | + return wpinv_round_amount( wpinv_sanitize_amount( $this->get_prop( 'total', $context ) ) ); |
|
1432 | + } |
|
1433 | + |
|
1434 | + /** |
|
1435 | + * Get the invoice totals. |
|
1436 | + * |
|
1437 | + * @since 1.0.19 |
|
1438 | 1438 | * @return array |
1439 | - */ |
|
1440 | - public function get_totals() { |
|
1441 | - return $this->totals; |
|
1439 | + */ |
|
1440 | + public function get_totals() { |
|
1441 | + return $this->totals; |
|
1442 | 1442 | } |
1443 | 1443 | |
1444 | 1444 | /** |
1445 | - * Get the initial invoice total. |
|
1446 | - * |
|
1447 | - * @since 1.0.19 |
|
1445 | + * Get the initial invoice total. |
|
1446 | + * |
|
1447 | + * @since 1.0.19 |
|
1448 | 1448 | * @param string $context View or edit context. |
1449 | 1449 | * @return float |
1450 | - */ |
|
1450 | + */ |
|
1451 | 1451 | public function get_initial_total() { |
1452 | 1452 | |
1453 | - if ( empty( $this->totals ) ) { |
|
1454 | - $this->recalculate_total(); |
|
1455 | - } |
|
1453 | + if ( empty( $this->totals ) ) { |
|
1454 | + $this->recalculate_total(); |
|
1455 | + } |
|
1456 | 1456 | |
1457 | - $tax = $this->totals['tax']['initial']; |
|
1458 | - $fee = $this->totals['fee']['initial']; |
|
1459 | - $discount = $this->totals['discount']['initial']; |
|
1460 | - $subtotal = $this->totals['subtotal']['initial']; |
|
1461 | - $total = $tax + $fee - $discount + $subtotal; |
|
1457 | + $tax = $this->totals['tax']['initial']; |
|
1458 | + $fee = $this->totals['fee']['initial']; |
|
1459 | + $discount = $this->totals['discount']['initial']; |
|
1460 | + $subtotal = $this->totals['subtotal']['initial']; |
|
1461 | + $total = $tax + $fee - $discount + $subtotal; |
|
1462 | 1462 | |
1463 | - if ( 0 > $total ) { |
|
1464 | - $total = 0; |
|
1465 | - } |
|
1463 | + if ( 0 > $total ) { |
|
1464 | + $total = 0; |
|
1465 | + } |
|
1466 | 1466 | |
1467 | - $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1467 | + $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1468 | 1468 | return apply_filters( 'wpinv_get_initial_invoice_total', $total, $this ); |
1469 | - } |
|
1469 | + } |
|
1470 | 1470 | |
1471 | - /** |
|
1472 | - * Get the recurring invoice total. |
|
1473 | - * |
|
1474 | - * @since 1.0.19 |
|
1471 | + /** |
|
1472 | + * Get the recurring invoice total. |
|
1473 | + * |
|
1474 | + * @since 1.0.19 |
|
1475 | 1475 | * @param string $context View or edit context. |
1476 | 1476 | * @return float |
1477 | - */ |
|
1477 | + */ |
|
1478 | 1478 | public function get_recurring_total() { |
1479 | 1479 | |
1480 | - if ( empty( $this->totals ) ) { |
|
1481 | - $this->recalculate_total(); |
|
1482 | - } |
|
1480 | + if ( empty( $this->totals ) ) { |
|
1481 | + $this->recalculate_total(); |
|
1482 | + } |
|
1483 | 1483 | |
1484 | - $tax = $this->totals['tax']['recurring']; |
|
1485 | - $fee = $this->totals['fee']['recurring']; |
|
1486 | - $discount = $this->totals['discount']['recurring']; |
|
1487 | - $subtotal = $this->totals['subtotal']['recurring']; |
|
1488 | - $total = $tax + $fee - $discount + $subtotal; |
|
1484 | + $tax = $this->totals['tax']['recurring']; |
|
1485 | + $fee = $this->totals['fee']['recurring']; |
|
1486 | + $discount = $this->totals['discount']['recurring']; |
|
1487 | + $subtotal = $this->totals['subtotal']['recurring']; |
|
1488 | + $total = $tax + $fee - $discount + $subtotal; |
|
1489 | 1489 | |
1490 | - if ( 0 > $total ) { |
|
1491 | - $total = 0; |
|
1492 | - } |
|
1490 | + if ( 0 > $total ) { |
|
1491 | + $total = 0; |
|
1492 | + } |
|
1493 | 1493 | |
1494 | - $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1494 | + $total = wpinv_round_amount( wpinv_sanitize_amount( $total ) ); |
|
1495 | 1495 | return apply_filters( 'wpinv_get_recurring_invoice_total', $total, $this ); |
1496 | - } |
|
1496 | + } |
|
1497 | 1497 | |
1498 | - /** |
|
1499 | - * Returns recurring payment details. |
|
1500 | - * |
|
1501 | - * @since 1.0.19 |
|
1498 | + /** |
|
1499 | + * Returns recurring payment details. |
|
1500 | + * |
|
1501 | + * @since 1.0.19 |
|
1502 | 1502 | * @param string $field Optionally provide a field to return. |
1503 | - * @param string $currency Whether to include the currency. |
|
1503 | + * @param string $currency Whether to include the currency. |
|
1504 | 1504 | * @return float|string |
1505 | - */ |
|
1505 | + */ |
|
1506 | 1506 | public function get_recurring_details( $field = '', $currency = false ) { |
1507 | 1507 | |
1508 | - // Maybe recalculate totals. |
|
1509 | - if ( empty( $this->totals ) ) { |
|
1510 | - $this->recalculate_total(); |
|
1511 | - } |
|
1508 | + // Maybe recalculate totals. |
|
1509 | + if ( empty( $this->totals ) ) { |
|
1510 | + $this->recalculate_total(); |
|
1511 | + } |
|
1512 | 1512 | |
1513 | - // Prepare recurring totals. |
|
1513 | + // Prepare recurring totals. |
|
1514 | 1514 | $data = apply_filters( |
1515 | - 'wpinv_get_invoice_recurring_details', |
|
1516 | - array( |
|
1517 | - 'cart_details' => $this->get_cart_details(), |
|
1518 | - 'subtotal' => $this->totals['subtotal']['recurring'], |
|
1519 | - 'discount' => $this->totals['discount']['recurring'], |
|
1520 | - 'tax' => $this->totals['tax']['recurring'], |
|
1521 | - 'fee' => $this->totals['fee']['recurring'], |
|
1522 | - 'total' => $this->get_recurring_total(), |
|
1523 | - ), |
|
1524 | - $this, |
|
1525 | - $field, |
|
1526 | - $currency |
|
1527 | - ); |
|
1515 | + 'wpinv_get_invoice_recurring_details', |
|
1516 | + array( |
|
1517 | + 'cart_details' => $this->get_cart_details(), |
|
1518 | + 'subtotal' => $this->totals['subtotal']['recurring'], |
|
1519 | + 'discount' => $this->totals['discount']['recurring'], |
|
1520 | + 'tax' => $this->totals['tax']['recurring'], |
|
1521 | + 'fee' => $this->totals['fee']['recurring'], |
|
1522 | + 'total' => $this->get_recurring_total(), |
|
1523 | + ), |
|
1524 | + $this, |
|
1525 | + $field, |
|
1526 | + $currency |
|
1527 | + ); |
|
1528 | 1528 | |
1529 | 1529 | if ( isset( $data[$field] ) ) { |
1530 | 1530 | return ( $currency ? wpinv_price( $data[$field], $this->get_currency() ) : $data[$field] ); |
@@ -1534,166 +1534,166 @@ discard block |
||
1534 | 1534 | } |
1535 | 1535 | |
1536 | 1536 | /** |
1537 | - * Get the invoice fees. |
|
1538 | - * |
|
1539 | - * @since 1.0.19 |
|
1540 | - * @param string $context View or edit context. |
|
1541 | - * @return array |
|
1542 | - */ |
|
1543 | - public function get_fees( $context = 'view' ) { |
|
1544 | - return wpinv_parse_list( $this->get_prop( 'fees', $context ) ); |
|
1537 | + * Get the invoice fees. |
|
1538 | + * |
|
1539 | + * @since 1.0.19 |
|
1540 | + * @param string $context View or edit context. |
|
1541 | + * @return array |
|
1542 | + */ |
|
1543 | + public function get_fees( $context = 'view' ) { |
|
1544 | + return wpinv_parse_list( $this->get_prop( 'fees', $context ) ); |
|
1545 | 1545 | } |
1546 | 1546 | |
1547 | 1547 | /** |
1548 | - * Get the invoice discounts. |
|
1549 | - * |
|
1550 | - * @since 1.0.19 |
|
1551 | - * @param string $context View or edit context. |
|
1552 | - * @return array |
|
1553 | - */ |
|
1554 | - public function get_discounts( $context = 'view' ) { |
|
1555 | - return wpinv_parse_list( $this->get_prop( 'discounts', $context ) ); |
|
1548 | + * Get the invoice discounts. |
|
1549 | + * |
|
1550 | + * @since 1.0.19 |
|
1551 | + * @param string $context View or edit context. |
|
1552 | + * @return array |
|
1553 | + */ |
|
1554 | + public function get_discounts( $context = 'view' ) { |
|
1555 | + return wpinv_parse_list( $this->get_prop( 'discounts', $context ) ); |
|
1556 | 1556 | } |
1557 | 1557 | |
1558 | 1558 | /** |
1559 | - * Get the invoice taxes. |
|
1560 | - * |
|
1561 | - * @since 1.0.19 |
|
1562 | - * @param string $context View or edit context. |
|
1563 | - * @return array |
|
1564 | - */ |
|
1565 | - public function get_taxes( $context = 'view' ) { |
|
1566 | - return wpinv_parse_list( $this->get_prop( 'taxes', $context ) ); |
|
1559 | + * Get the invoice taxes. |
|
1560 | + * |
|
1561 | + * @since 1.0.19 |
|
1562 | + * @param string $context View or edit context. |
|
1563 | + * @return array |
|
1564 | + */ |
|
1565 | + public function get_taxes( $context = 'view' ) { |
|
1566 | + return wpinv_parse_list( $this->get_prop( 'taxes', $context ) ); |
|
1567 | 1567 | } |
1568 | 1568 | |
1569 | 1569 | /** |
1570 | - * Get the invoice items. |
|
1571 | - * |
|
1572 | - * @since 1.0.19 |
|
1573 | - * @param string $context View or edit context. |
|
1574 | - * @return GetPaid_Form_Item[] |
|
1575 | - */ |
|
1576 | - public function get_items( $context = 'view' ) { |
|
1570 | + * Get the invoice items. |
|
1571 | + * |
|
1572 | + * @since 1.0.19 |
|
1573 | + * @param string $context View or edit context. |
|
1574 | + * @return GetPaid_Form_Item[] |
|
1575 | + */ |
|
1576 | + public function get_items( $context = 'view' ) { |
|
1577 | 1577 | return $this->get_prop( 'items', $context ); |
1578 | - } |
|
1578 | + } |
|
1579 | 1579 | |
1580 | - /** |
|
1581 | - * Get the invoice item ids. |
|
1582 | - * |
|
1583 | - * @since 1.0.19 |
|
1584 | - * @return string |
|
1585 | - */ |
|
1586 | - public function get_item_ids() { |
|
1587 | - return implode( ', ', wp_list_pluck( $this->get_cart_details(), 'item_id' ) ); |
|
1580 | + /** |
|
1581 | + * Get the invoice item ids. |
|
1582 | + * |
|
1583 | + * @since 1.0.19 |
|
1584 | + * @return string |
|
1585 | + */ |
|
1586 | + public function get_item_ids() { |
|
1587 | + return implode( ', ', wp_list_pluck( $this->get_cart_details(), 'item_id' ) ); |
|
1588 | 1588 | } |
1589 | 1589 | |
1590 | 1590 | /** |
1591 | - * Get the invoice's payment form. |
|
1592 | - * |
|
1593 | - * @since 1.0.19 |
|
1594 | - * @param string $context View or edit context. |
|
1595 | - * @return int |
|
1596 | - */ |
|
1597 | - public function get_payment_form( $context = 'view' ) { |
|
1598 | - return intval( $this->get_prop( 'payment_form', $context ) ); |
|
1591 | + * Get the invoice's payment form. |
|
1592 | + * |
|
1593 | + * @since 1.0.19 |
|
1594 | + * @param string $context View or edit context. |
|
1595 | + * @return int |
|
1596 | + */ |
|
1597 | + public function get_payment_form( $context = 'view' ) { |
|
1598 | + return intval( $this->get_prop( 'payment_form', $context ) ); |
|
1599 | 1599 | } |
1600 | 1600 | |
1601 | 1601 | /** |
1602 | - * Get the invoice's submission id. |
|
1603 | - * |
|
1604 | - * @since 1.0.19 |
|
1605 | - * @param string $context View or edit context. |
|
1606 | - * @return string |
|
1607 | - */ |
|
1608 | - public function get_submission_id( $context = 'view' ) { |
|
1609 | - return $this->get_prop( 'submission_id', $context ); |
|
1602 | + * Get the invoice's submission id. |
|
1603 | + * |
|
1604 | + * @since 1.0.19 |
|
1605 | + * @param string $context View or edit context. |
|
1606 | + * @return string |
|
1607 | + */ |
|
1608 | + public function get_submission_id( $context = 'view' ) { |
|
1609 | + return $this->get_prop( 'submission_id', $context ); |
|
1610 | 1610 | } |
1611 | 1611 | |
1612 | 1612 | /** |
1613 | - * Get the invoice's discount code. |
|
1614 | - * |
|
1615 | - * @since 1.0.19 |
|
1616 | - * @param string $context View or edit context. |
|
1617 | - * @return string |
|
1618 | - */ |
|
1619 | - public function get_discount_code( $context = 'view' ) { |
|
1620 | - return $this->get_prop( 'discount_code', $context ); |
|
1613 | + * Get the invoice's discount code. |
|
1614 | + * |
|
1615 | + * @since 1.0.19 |
|
1616 | + * @param string $context View or edit context. |
|
1617 | + * @return string |
|
1618 | + */ |
|
1619 | + public function get_discount_code( $context = 'view' ) { |
|
1620 | + return $this->get_prop( 'discount_code', $context ); |
|
1621 | 1621 | } |
1622 | 1622 | |
1623 | 1623 | /** |
1624 | - * Get the invoice's gateway. |
|
1625 | - * |
|
1626 | - * @since 1.0.19 |
|
1627 | - * @param string $context View or edit context. |
|
1628 | - * @return string |
|
1629 | - */ |
|
1630 | - public function get_gateway( $context = 'view' ) { |
|
1631 | - return $this->get_prop( 'gateway', $context ); |
|
1624 | + * Get the invoice's gateway. |
|
1625 | + * |
|
1626 | + * @since 1.0.19 |
|
1627 | + * @param string $context View or edit context. |
|
1628 | + * @return string |
|
1629 | + */ |
|
1630 | + public function get_gateway( $context = 'view' ) { |
|
1631 | + return $this->get_prop( 'gateway', $context ); |
|
1632 | 1632 | } |
1633 | 1633 | |
1634 | 1634 | /** |
1635 | - * Get the invoice's gateway display title. |
|
1636 | - * |
|
1637 | - * @since 1.0.19 |
|
1638 | - * @return string |
|
1639 | - */ |
|
1635 | + * Get the invoice's gateway display title. |
|
1636 | + * |
|
1637 | + * @since 1.0.19 |
|
1638 | + * @return string |
|
1639 | + */ |
|
1640 | 1640 | public function get_gateway_title() { |
1641 | 1641 | $title = wpinv_get_gateway_checkout_label( $this->get_gateway() ); |
1642 | 1642 | return apply_filters( 'wpinv_gateway_title', $title, $this->get_id(), $this ); |
1643 | 1643 | } |
1644 | 1644 | |
1645 | 1645 | /** |
1646 | - * Get the invoice's transaction id. |
|
1647 | - * |
|
1648 | - * @since 1.0.19 |
|
1649 | - * @param string $context View or edit context. |
|
1650 | - * @return string |
|
1651 | - */ |
|
1652 | - public function get_transaction_id( $context = 'view' ) { |
|
1653 | - return $this->get_prop( 'transaction_id', $context ); |
|
1646 | + * Get the invoice's transaction id. |
|
1647 | + * |
|
1648 | + * @since 1.0.19 |
|
1649 | + * @param string $context View or edit context. |
|
1650 | + * @return string |
|
1651 | + */ |
|
1652 | + public function get_transaction_id( $context = 'view' ) { |
|
1653 | + return $this->get_prop( 'transaction_id', $context ); |
|
1654 | 1654 | } |
1655 | 1655 | |
1656 | 1656 | /** |
1657 | - * Get the invoice's currency. |
|
1658 | - * |
|
1659 | - * @since 1.0.19 |
|
1660 | - * @param string $context View or edit context. |
|
1661 | - * @return string |
|
1662 | - */ |
|
1663 | - public function get_currency( $context = 'view' ) { |
|
1657 | + * Get the invoice's currency. |
|
1658 | + * |
|
1659 | + * @since 1.0.19 |
|
1660 | + * @param string $context View or edit context. |
|
1661 | + * @return string |
|
1662 | + */ |
|
1663 | + public function get_currency( $context = 'view' ) { |
|
1664 | 1664 | $currency = $this->get_prop( 'currency', $context ); |
1665 | 1665 | return empty( $currency ) ? wpinv_get_currency() : $currency; |
1666 | 1666 | } |
1667 | 1667 | |
1668 | 1668 | /** |
1669 | - * Checks if we are charging taxes for this invoice. |
|
1670 | - * |
|
1671 | - * @since 1.0.19 |
|
1672 | - * @param string $context View or edit context. |
|
1673 | - * @return bool |
|
1674 | - */ |
|
1675 | - public function get_disable_taxes( $context = 'view' ) { |
|
1669 | + * Checks if we are charging taxes for this invoice. |
|
1670 | + * |
|
1671 | + * @since 1.0.19 |
|
1672 | + * @param string $context View or edit context. |
|
1673 | + * @return bool |
|
1674 | + */ |
|
1675 | + public function get_disable_taxes( $context = 'view' ) { |
|
1676 | 1676 | return (bool) $this->get_prop( 'disable_taxes', $context ); |
1677 | 1677 | } |
1678 | 1678 | |
1679 | 1679 | /** |
1680 | - * Retrieves the subscription id for an invoice. |
|
1681 | - * |
|
1682 | - * @since 1.0.19 |
|
1683 | - * @param string $context View or edit context. |
|
1684 | - * @return int |
|
1685 | - */ |
|
1680 | + * Retrieves the subscription id for an invoice. |
|
1681 | + * |
|
1682 | + * @since 1.0.19 |
|
1683 | + * @param string $context View or edit context. |
|
1684 | + * @return int |
|
1685 | + */ |
|
1686 | 1686 | public function get_subscription_id( $context = 'view' ) { |
1687 | - return $this->is_renewal() ? $this->get_parent()->get_subscription_id( $context ) : $this->get_prop( 'subscription_id', $context ); |
|
1688 | - } |
|
1689 | - |
|
1690 | - /** |
|
1691 | - * Retrieves the remote subscription id for an invoice. |
|
1692 | - * |
|
1693 | - * @since 1.0.19 |
|
1694 | - * @param string $context View or edit context. |
|
1695 | - * @return int |
|
1696 | - */ |
|
1687 | + return $this->is_renewal() ? $this->get_parent()->get_subscription_id( $context ) : $this->get_prop( 'subscription_id', $context ); |
|
1688 | + } |
|
1689 | + |
|
1690 | + /** |
|
1691 | + * Retrieves the remote subscription id for an invoice. |
|
1692 | + * |
|
1693 | + * @since 1.0.19 |
|
1694 | + * @param string $context View or edit context. |
|
1695 | + * @return int |
|
1696 | + */ |
|
1697 | 1697 | public function get_remote_subscription_id( $context = 'view' ) { |
1698 | 1698 | $subscription_id = $this->get_prop( 'remote_subscription_id', $context ); |
1699 | 1699 | |
@@ -1706,12 +1706,12 @@ discard block |
||
1706 | 1706 | } |
1707 | 1707 | |
1708 | 1708 | /** |
1709 | - * Retrieves the payment meta for an invoice. |
|
1710 | - * |
|
1711 | - * @since 1.0.19 |
|
1712 | - * @param string $context View or edit context. |
|
1713 | - * @return array |
|
1714 | - */ |
|
1709 | + * Retrieves the payment meta for an invoice. |
|
1710 | + * |
|
1711 | + * @since 1.0.19 |
|
1712 | + * @param string $context View or edit context. |
|
1713 | + * @return array |
|
1714 | + */ |
|
1715 | 1715 | public function get_payment_meta( $context = 'view' ) { |
1716 | 1716 | |
1717 | 1717 | return array( |
@@ -1731,31 +1731,31 @@ discard block |
||
1731 | 1731 | } |
1732 | 1732 | |
1733 | 1733 | /** |
1734 | - * Retrieves the cart details for an invoice. |
|
1735 | - * |
|
1736 | - * @since 1.0.19 |
|
1737 | - * @return array |
|
1738 | - */ |
|
1734 | + * Retrieves the cart details for an invoice. |
|
1735 | + * |
|
1736 | + * @since 1.0.19 |
|
1737 | + * @return array |
|
1738 | + */ |
|
1739 | 1739 | public function get_cart_details() { |
1740 | 1740 | $items = $this->get_items(); |
1741 | 1741 | $cart_details = array(); |
1742 | 1742 | |
1743 | 1743 | foreach ( $items as $item ) { |
1744 | - $item->invoice_id = $this->get_id(); |
|
1744 | + $item->invoice_id = $this->get_id(); |
|
1745 | 1745 | $cart_details[] = $item->prepare_data_for_saving(); |
1746 | 1746 | } |
1747 | 1747 | |
1748 | 1748 | return $cart_details; |
1749 | - } |
|
1749 | + } |
|
1750 | 1750 | |
1751 | - /** |
|
1752 | - * Retrieves the recurring item. |
|
1753 | - * |
|
1754 | - * @return null|GetPaid_Form_Item|int |
|
1755 | - */ |
|
1756 | - public function get_recurring( $object = false ) { |
|
1751 | + /** |
|
1752 | + * Retrieves the recurring item. |
|
1753 | + * |
|
1754 | + * @return null|GetPaid_Form_Item|int |
|
1755 | + */ |
|
1756 | + public function get_recurring( $object = false ) { |
|
1757 | 1757 | |
1758 | - // Are we returning an object? |
|
1758 | + // Are we returning an object? |
|
1759 | 1759 | if ( $object ) { |
1760 | 1760 | return $this->get_item( $this->recurring_item ); |
1761 | 1761 | } |
@@ -1763,114 +1763,114 @@ discard block |
||
1763 | 1763 | return $this->recurring_item; |
1764 | 1764 | } |
1765 | 1765 | |
1766 | - /** |
|
1767 | - * Retrieves the subscription name. |
|
1768 | - * |
|
1769 | - * @since 1.0.19 |
|
1770 | - * @return string |
|
1771 | - */ |
|
1772 | - public function get_subscription_name() { |
|
1766 | + /** |
|
1767 | + * Retrieves the subscription name. |
|
1768 | + * |
|
1769 | + * @since 1.0.19 |
|
1770 | + * @return string |
|
1771 | + */ |
|
1772 | + public function get_subscription_name() { |
|
1773 | 1773 | |
1774 | - // Retrieve the recurring name |
|
1774 | + // Retrieve the recurring name |
|
1775 | 1775 | $item = $this->get_recurring( true ); |
1776 | 1776 | |
1777 | - // Abort if it does not exist. |
|
1777 | + // Abort if it does not exist. |
|
1778 | 1778 | if ( empty( $item ) ) { |
1779 | 1779 | return ''; |
1780 | 1780 | } |
1781 | 1781 | |
1782 | - // Return the item name. |
|
1782 | + // Return the item name. |
|
1783 | 1783 | return apply_filters( 'wpinv_invoice_get_subscription_name', $item->get_name(), $this ); |
1784 | - } |
|
1785 | - |
|
1786 | - /** |
|
1787 | - * Retrieves the view url. |
|
1788 | - * |
|
1789 | - * @since 1.0.19 |
|
1790 | - * @return string |
|
1791 | - */ |
|
1792 | - public function get_view_url() { |
|
1784 | + } |
|
1785 | + |
|
1786 | + /** |
|
1787 | + * Retrieves the view url. |
|
1788 | + * |
|
1789 | + * @since 1.0.19 |
|
1790 | + * @return string |
|
1791 | + */ |
|
1792 | + public function get_view_url() { |
|
1793 | 1793 | $invoice_url = get_permalink( $this->get_id() ); |
1794 | - $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url ); |
|
1794 | + $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url ); |
|
1795 | 1795 | return apply_filters( 'wpinv_get_view_url', $invoice_url, $this ); |
1796 | - } |
|
1796 | + } |
|
1797 | 1797 | |
1798 | - /** |
|
1799 | - * Retrieves the payment url. |
|
1800 | - * |
|
1801 | - * @since 1.0.19 |
|
1802 | - * @return string |
|
1803 | - */ |
|
1804 | - public function get_checkout_payment_url( $deprecated = false, $secret = false ) { |
|
1798 | + /** |
|
1799 | + * Retrieves the payment url. |
|
1800 | + * |
|
1801 | + * @since 1.0.19 |
|
1802 | + * @return string |
|
1803 | + */ |
|
1804 | + public function get_checkout_payment_url( $deprecated = false, $secret = false ) { |
|
1805 | 1805 | |
1806 | - // Retrieve the checkout url. |
|
1806 | + // Retrieve the checkout url. |
|
1807 | 1807 | $pay_url = wpinv_get_checkout_uri(); |
1808 | 1808 | |
1809 | - // Maybe force ssl. |
|
1809 | + // Maybe force ssl. |
|
1810 | 1810 | if ( is_ssl() ) { |
1811 | 1811 | $pay_url = str_replace( 'http:', 'https:', $pay_url ); |
1812 | 1812 | } |
1813 | 1813 | |
1814 | - // Add the invoice key. |
|
1815 | - $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url ); |
|
1814 | + // Add the invoice key. |
|
1815 | + $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url ); |
|
1816 | 1816 | |
1817 | - // (Maybe?) add a secret |
|
1817 | + // (Maybe?) add a secret |
|
1818 | 1818 | if ( $secret ) { |
1819 | 1819 | $pay_url = add_query_arg( array( '_wpipay' => md5( $this->get_user_id() . '::' . $this->get_email() . '::' . $this->get_key() ) ), $pay_url ); |
1820 | 1820 | } |
1821 | 1821 | |
1822 | 1822 | return apply_filters( 'wpinv_get_checkout_payment_url', $pay_url, $this, $deprecated, $secret ); |
1823 | - } |
|
1823 | + } |
|
1824 | 1824 | |
1825 | - /** |
|
1826 | - * Retrieves the receipt url. |
|
1827 | - * |
|
1828 | - * @since 1.0.19 |
|
1829 | - * @return string |
|
1830 | - */ |
|
1831 | - public function get_receipt_url() { |
|
1832 | - |
|
1833 | - // Retrieve the checkout url. |
|
1825 | + /** |
|
1826 | + * Retrieves the receipt url. |
|
1827 | + * |
|
1828 | + * @since 1.0.19 |
|
1829 | + * @return string |
|
1830 | + */ |
|
1831 | + public function get_receipt_url() { |
|
1832 | + |
|
1833 | + // Retrieve the checkout url. |
|
1834 | 1834 | $receipt_url = wpinv_get_success_page_uri(); |
1835 | 1835 | |
1836 | - // Maybe force ssl. |
|
1836 | + // Maybe force ssl. |
|
1837 | 1837 | if ( is_ssl() ) { |
1838 | 1838 | $receipt_url = str_replace( 'http:', 'https:', $receipt_url ); |
1839 | 1839 | } |
1840 | 1840 | |
1841 | - // Add the invoice key. |
|
1842 | - $receipt_url = add_query_arg( 'invoice_key', $this->get_key(), $receipt_url ); |
|
1841 | + // Add the invoice key. |
|
1842 | + $receipt_url = add_query_arg( 'invoice_key', $this->get_key(), $receipt_url ); |
|
1843 | 1843 | |
1844 | 1844 | return apply_filters( 'getpaid_get_invoice_receipt_url', $receipt_url, $this ); |
1845 | - } |
|
1845 | + } |
|
1846 | 1846 | |
1847 | - /** |
|
1848 | - * Retrieves the default status. |
|
1849 | - * |
|
1850 | - * @since 1.0.19 |
|
1851 | - * @return string |
|
1852 | - */ |
|
1853 | - public function get_default_status() { |
|
1854 | - |
|
1855 | - $type = $this->get_type(); |
|
1856 | - $status = "wpi-$type-pending"; |
|
1857 | - return str_replace( '-invoice', '', $status ); |
|
1858 | - |
|
1859 | - } |
|
1860 | - |
|
1861 | - /** |
|
1862 | - * Magic method for accessing invoice properties. |
|
1863 | - * |
|
1864 | - * @since 1.0.15 |
|
1865 | - * @access public |
|
1866 | - * |
|
1867 | - * @param string $key Discount data to retrieve |
|
1868 | - * @param string $context View or edit context. |
|
1869 | - * @return mixed Value of the given invoice property (if set). |
|
1870 | - */ |
|
1871 | - public function get( $key, $context = 'view' ) { |
|
1847 | + /** |
|
1848 | + * Retrieves the default status. |
|
1849 | + * |
|
1850 | + * @since 1.0.19 |
|
1851 | + * @return string |
|
1852 | + */ |
|
1853 | + public function get_default_status() { |
|
1854 | + |
|
1855 | + $type = $this->get_type(); |
|
1856 | + $status = "wpi-$type-pending"; |
|
1857 | + return str_replace( '-invoice', '', $status ); |
|
1858 | + |
|
1859 | + } |
|
1860 | + |
|
1861 | + /** |
|
1862 | + * Magic method for accessing invoice properties. |
|
1863 | + * |
|
1864 | + * @since 1.0.15 |
|
1865 | + * @access public |
|
1866 | + * |
|
1867 | + * @param string $key Discount data to retrieve |
|
1868 | + * @param string $context View or edit context. |
|
1869 | + * @return mixed Value of the given invoice property (if set). |
|
1870 | + */ |
|
1871 | + public function get( $key, $context = 'view' ) { |
|
1872 | 1872 | return $this->get_prop( $key, $context ); |
1873 | - } |
|
1873 | + } |
|
1874 | 1874 | |
1875 | 1875 | /* |
1876 | 1876 | |-------------------------------------------------------------------------- |
@@ -1883,130 +1883,130 @@ discard block |
||
1883 | 1883 | */ |
1884 | 1884 | |
1885 | 1885 | /** |
1886 | - * Magic method for setting invoice properties. |
|
1887 | - * |
|
1888 | - * @since 1.0.19 |
|
1889 | - * @access public |
|
1890 | - * |
|
1891 | - * @param string $key Discount data to retrieve |
|
1892 | - * @param mixed $value new value. |
|
1893 | - * @return mixed Value of the given invoice property (if set). |
|
1894 | - */ |
|
1895 | - public function set( $key, $value ) { |
|
1886 | + * Magic method for setting invoice properties. |
|
1887 | + * |
|
1888 | + * @since 1.0.19 |
|
1889 | + * @access public |
|
1890 | + * |
|
1891 | + * @param string $key Discount data to retrieve |
|
1892 | + * @param mixed $value new value. |
|
1893 | + * @return mixed Value of the given invoice property (if set). |
|
1894 | + */ |
|
1895 | + public function set( $key, $value ) { |
|
1896 | 1896 | |
1897 | 1897 | $setter = "set_$key"; |
1898 | 1898 | if ( is_callable( array( $this, $setter ) ) ) { |
1899 | 1899 | $this->{$setter}( $value ); |
1900 | 1900 | } |
1901 | 1901 | |
1902 | - } |
|
1902 | + } |
|
1903 | 1903 | |
1904 | - /** |
|
1905 | - * Sets item status. |
|
1906 | - * |
|
1907 | - * @since 1.0.19 |
|
1908 | - * @param string $new_status New status. |
|
1909 | - * @param string $note Optional note to add. |
|
1910 | - * @param bool $manual_update Is this a manual status change?. |
|
1911 | - * @return array details of change. |
|
1912 | - */ |
|
1913 | - public function set_status( $new_status, $note = '', $manual_update = false ) { |
|
1914 | - $old_status = $this->get_status(); |
|
1904 | + /** |
|
1905 | + * Sets item status. |
|
1906 | + * |
|
1907 | + * @since 1.0.19 |
|
1908 | + * @param string $new_status New status. |
|
1909 | + * @param string $note Optional note to add. |
|
1910 | + * @param bool $manual_update Is this a manual status change?. |
|
1911 | + * @return array details of change. |
|
1912 | + */ |
|
1913 | + public function set_status( $new_status, $note = '', $manual_update = false ) { |
|
1914 | + $old_status = $this->get_status(); |
|
1915 | 1915 | |
1916 | - $statuses = $this->get_all_statuses(); |
|
1916 | + $statuses = $this->get_all_statuses(); |
|
1917 | 1917 | |
1918 | - if ( isset( $statuses[ 'draft' ] ) ) { |
|
1919 | - unset( $statuses[ 'draft' ] ); |
|
1920 | - } |
|
1918 | + if ( isset( $statuses[ 'draft' ] ) ) { |
|
1919 | + unset( $statuses[ 'draft' ] ); |
|
1920 | + } |
|
1921 | 1921 | |
1922 | - $this->set_prop( 'status', $new_status ); |
|
1922 | + $this->set_prop( 'status', $new_status ); |
|
1923 | 1923 | |
1924 | - // If setting the status, ensure it's set to a valid status. |
|
1925 | - if ( true === $this->object_read ) { |
|
1924 | + // If setting the status, ensure it's set to a valid status. |
|
1925 | + if ( true === $this->object_read ) { |
|
1926 | 1926 | |
1927 | - // Only allow valid new status. |
|
1928 | - if ( ! array_key_exists( $new_status, $statuses ) ) { |
|
1929 | - $new_status = $this->get_default_status(); |
|
1930 | - } |
|
1927 | + // Only allow valid new status. |
|
1928 | + if ( ! array_key_exists( $new_status, $statuses ) ) { |
|
1929 | + $new_status = $this->get_default_status(); |
|
1930 | + } |
|
1931 | 1931 | |
1932 | - // If the old status is set but unknown (e.g. draft) assume its pending for action usage. |
|
1933 | - if ( $old_status && ! array_key_exists( $new_status, $statuses ) ) { |
|
1934 | - $old_status = $this->get_default_status(); |
|
1935 | - } |
|
1932 | + // If the old status is set but unknown (e.g. draft) assume its pending for action usage. |
|
1933 | + if ( $old_status && ! array_key_exists( $new_status, $statuses ) ) { |
|
1934 | + $old_status = $this->get_default_status(); |
|
1935 | + } |
|
1936 | 1936 | |
1937 | - // Paid - Renewal (i.e when duplicating a parent invoice ) |
|
1938 | - if ( $new_status == 'wpi-pending' && $old_status == 'publish' && ! $this->get_id() ) { |
|
1939 | - $old_status = 'wpi-pending'; |
|
1940 | - } |
|
1937 | + // Paid - Renewal (i.e when duplicating a parent invoice ) |
|
1938 | + if ( $new_status == 'wpi-pending' && $old_status == 'publish' && ! $this->get_id() ) { |
|
1939 | + $old_status = 'wpi-pending'; |
|
1940 | + } |
|
1941 | 1941 | |
1942 | - } |
|
1942 | + } |
|
1943 | 1943 | |
1944 | - if ( true === $this->object_read && $old_status !== $new_status ) { |
|
1945 | - $this->status_transition = array( |
|
1946 | - 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
1947 | - 'to' => $new_status, |
|
1948 | - 'note' => $note, |
|
1949 | - 'manual' => (bool) $manual_update, |
|
1950 | - ); |
|
1944 | + if ( true === $this->object_read && $old_status !== $new_status ) { |
|
1945 | + $this->status_transition = array( |
|
1946 | + 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
1947 | + 'to' => $new_status, |
|
1948 | + 'note' => $note, |
|
1949 | + 'manual' => (bool) $manual_update, |
|
1950 | + ); |
|
1951 | 1951 | |
1952 | - if ( $manual_update ) { |
|
1953 | - do_action( 'getpaid_' . $this->object_type .'_edit_status', $this->get_id(), $new_status ); |
|
1954 | - } |
|
1952 | + if ( $manual_update ) { |
|
1953 | + do_action( 'getpaid_' . $this->object_type .'_edit_status', $this->get_id(), $new_status ); |
|
1954 | + } |
|
1955 | 1955 | |
1956 | - $this->maybe_set_date_paid(); |
|
1956 | + $this->maybe_set_date_paid(); |
|
1957 | 1957 | |
1958 | - } |
|
1958 | + } |
|
1959 | 1959 | |
1960 | - return array( |
|
1961 | - 'from' => $old_status, |
|
1962 | - 'to' => $new_status, |
|
1963 | - ); |
|
1964 | - } |
|
1960 | + return array( |
|
1961 | + 'from' => $old_status, |
|
1962 | + 'to' => $new_status, |
|
1963 | + ); |
|
1964 | + } |
|
1965 | 1965 | |
1966 | - /** |
|
1967 | - * Maybe set date paid. |
|
1968 | - * |
|
1969 | - * Sets the date paid variable when transitioning to the payment complete |
|
1970 | - * order status. |
|
1971 | - * |
|
1972 | - * @since 1.0.19 |
|
1973 | - */ |
|
1974 | - public function maybe_set_date_paid() { |
|
1966 | + /** |
|
1967 | + * Maybe set date paid. |
|
1968 | + * |
|
1969 | + * Sets the date paid variable when transitioning to the payment complete |
|
1970 | + * order status. |
|
1971 | + * |
|
1972 | + * @since 1.0.19 |
|
1973 | + */ |
|
1974 | + public function maybe_set_date_paid() { |
|
1975 | 1975 | |
1976 | - if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) { |
|
1977 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
1978 | - } |
|
1979 | - } |
|
1976 | + if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) { |
|
1977 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
1978 | + } |
|
1979 | + } |
|
1980 | 1980 | |
1981 | 1981 | /** |
1982 | - * Set parent invoice ID. |
|
1983 | - * |
|
1984 | - * @since 1.0.19 |
|
1985 | - */ |
|
1986 | - public function set_parent_id( $value ) { |
|
1987 | - if ( $value && ( $value === $this->get_id() ) ) { |
|
1988 | - return; |
|
1989 | - } |
|
1990 | - $this->set_prop( 'parent_id', absint( $value ) ); |
|
1982 | + * Set parent invoice ID. |
|
1983 | + * |
|
1984 | + * @since 1.0.19 |
|
1985 | + */ |
|
1986 | + public function set_parent_id( $value ) { |
|
1987 | + if ( $value && ( $value === $this->get_id() ) ) { |
|
1988 | + return; |
|
1989 | + } |
|
1990 | + $this->set_prop( 'parent_id', absint( $value ) ); |
|
1991 | 1991 | } |
1992 | 1992 | |
1993 | 1993 | /** |
1994 | - * Set plugin version when the invoice was created. |
|
1995 | - * |
|
1996 | - * @since 1.0.19 |
|
1997 | - */ |
|
1998 | - public function set_version( $value ) { |
|
1999 | - $this->set_prop( 'version', $value ); |
|
1994 | + * Set plugin version when the invoice was created. |
|
1995 | + * |
|
1996 | + * @since 1.0.19 |
|
1997 | + */ |
|
1998 | + public function set_version( $value ) { |
|
1999 | + $this->set_prop( 'version', $value ); |
|
2000 | 2000 | } |
2001 | - |
|
2002 | - /** |
|
2003 | - * Set date when the invoice was created. |
|
2004 | - * |
|
2005 | - * @since 1.0.19 |
|
2006 | - * @param string $value Value to set. |
|
2001 | + |
|
2002 | + /** |
|
2003 | + * Set date when the invoice was created. |
|
2004 | + * |
|
2005 | + * @since 1.0.19 |
|
2006 | + * @param string $value Value to set. |
|
2007 | 2007 | * @return bool Whether or not the date was set. |
2008 | - */ |
|
2009 | - public function set_date_created( $value ) { |
|
2008 | + */ |
|
2009 | + public function set_date_created( $value ) { |
|
2010 | 2010 | $date = strtotime( $value ); |
2011 | 2011 | |
2012 | 2012 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2014,19 +2014,19 @@ discard block |
||
2014 | 2014 | return true; |
2015 | 2015 | } |
2016 | 2016 | |
2017 | - $this->set_prop( 'date_created', '' ); |
|
2018 | - return false; |
|
2017 | + $this->set_prop( 'date_created', '' ); |
|
2018 | + return false; |
|
2019 | 2019 | |
2020 | 2020 | } |
2021 | 2021 | |
2022 | 2022 | /** |
2023 | - * Set date invoice due date. |
|
2024 | - * |
|
2025 | - * @since 1.0.19 |
|
2026 | - * @param string $value Value to set. |
|
2023 | + * Set date invoice due date. |
|
2024 | + * |
|
2025 | + * @since 1.0.19 |
|
2026 | + * @param string $value Value to set. |
|
2027 | 2027 | * @return bool Whether or not the date was set. |
2028 | - */ |
|
2029 | - public function set_due_date( $value ) { |
|
2028 | + */ |
|
2029 | + public function set_due_date( $value ) { |
|
2030 | 2030 | $date = strtotime( $value ); |
2031 | 2031 | |
2032 | 2032 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2034,29 +2034,29 @@ discard block |
||
2034 | 2034 | return true; |
2035 | 2035 | } |
2036 | 2036 | |
2037 | - $this->set_prop( 'due_date', '' ); |
|
2037 | + $this->set_prop( 'due_date', '' ); |
|
2038 | 2038 | return false; |
2039 | 2039 | |
2040 | 2040 | } |
2041 | 2041 | |
2042 | 2042 | /** |
2043 | - * Alias of self::set_due_date(). |
|
2044 | - * |
|
2045 | - * @since 1.0.19 |
|
2046 | - * @param string $value New name. |
|
2047 | - */ |
|
2048 | - public function set_date_due( $value ) { |
|
2049 | - $this->set_due_date( $value ); |
|
2043 | + * Alias of self::set_due_date(). |
|
2044 | + * |
|
2045 | + * @since 1.0.19 |
|
2046 | + * @param string $value New name. |
|
2047 | + */ |
|
2048 | + public function set_date_due( $value ) { |
|
2049 | + $this->set_due_date( $value ); |
|
2050 | 2050 | } |
2051 | 2051 | |
2052 | 2052 | /** |
2053 | - * Set date invoice was completed. |
|
2054 | - * |
|
2055 | - * @since 1.0.19 |
|
2056 | - * @param string $value Value to set. |
|
2053 | + * Set date invoice was completed. |
|
2054 | + * |
|
2055 | + * @since 1.0.19 |
|
2056 | + * @param string $value Value to set. |
|
2057 | 2057 | * @return bool Whether or not the date was set. |
2058 | - */ |
|
2059 | - public function set_completed_date( $value ) { |
|
2058 | + */ |
|
2059 | + public function set_completed_date( $value ) { |
|
2060 | 2060 | $date = strtotime( $value ); |
2061 | 2061 | |
2062 | 2062 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2064,29 +2064,29 @@ discard block |
||
2064 | 2064 | return true; |
2065 | 2065 | } |
2066 | 2066 | |
2067 | - $this->set_prop( 'completed_date', '' ); |
|
2067 | + $this->set_prop( 'completed_date', '' ); |
|
2068 | 2068 | return false; |
2069 | 2069 | |
2070 | 2070 | } |
2071 | 2071 | |
2072 | 2072 | /** |
2073 | - * Alias of self::set_completed_date(). |
|
2074 | - * |
|
2075 | - * @since 1.0.19 |
|
2076 | - * @param string $value New name. |
|
2077 | - */ |
|
2078 | - public function set_date_completed( $value ) { |
|
2079 | - $this->set_completed_date( $value ); |
|
2073 | + * Alias of self::set_completed_date(). |
|
2074 | + * |
|
2075 | + * @since 1.0.19 |
|
2076 | + * @param string $value New name. |
|
2077 | + */ |
|
2078 | + public function set_date_completed( $value ) { |
|
2079 | + $this->set_completed_date( $value ); |
|
2080 | 2080 | } |
2081 | 2081 | |
2082 | 2082 | /** |
2083 | - * Set date when the invoice was last modified. |
|
2084 | - * |
|
2085 | - * @since 1.0.19 |
|
2086 | - * @param string $value Value to set. |
|
2083 | + * Set date when the invoice was last modified. |
|
2084 | + * |
|
2085 | + * @since 1.0.19 |
|
2086 | + * @param string $value Value to set. |
|
2087 | 2087 | * @return bool Whether or not the date was set. |
2088 | - */ |
|
2089 | - public function set_date_modified( $value ) { |
|
2088 | + */ |
|
2089 | + public function set_date_modified( $value ) { |
|
2090 | 2090 | $date = strtotime( $value ); |
2091 | 2091 | |
2092 | 2092 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2094,788 +2094,788 @@ discard block |
||
2094 | 2094 | return true; |
2095 | 2095 | } |
2096 | 2096 | |
2097 | - $this->set_prop( 'date_modified', '' ); |
|
2097 | + $this->set_prop( 'date_modified', '' ); |
|
2098 | 2098 | return false; |
2099 | 2099 | |
2100 | 2100 | } |
2101 | 2101 | |
2102 | 2102 | /** |
2103 | - * Set the invoice number. |
|
2104 | - * |
|
2105 | - * @since 1.0.19 |
|
2106 | - * @param string $value New number. |
|
2107 | - */ |
|
2108 | - public function set_number( $value ) { |
|
2103 | + * Set the invoice number. |
|
2104 | + * |
|
2105 | + * @since 1.0.19 |
|
2106 | + * @param string $value New number. |
|
2107 | + */ |
|
2108 | + public function set_number( $value ) { |
|
2109 | 2109 | $number = sanitize_text_field( $value ); |
2110 | - $this->set_prop( 'number', $number ); |
|
2110 | + $this->set_prop( 'number', $number ); |
|
2111 | 2111 | } |
2112 | 2112 | |
2113 | 2113 | /** |
2114 | - * Set the invoice type. |
|
2115 | - * |
|
2116 | - * @since 1.0.19 |
|
2117 | - * @param string $value Type. |
|
2118 | - */ |
|
2119 | - public function set_type( $value ) { |
|
2114 | + * Set the invoice type. |
|
2115 | + * |
|
2116 | + * @since 1.0.19 |
|
2117 | + * @param string $value Type. |
|
2118 | + */ |
|
2119 | + public function set_type( $value ) { |
|
2120 | 2120 | $type = sanitize_text_field( str_replace( 'wpi_', '', $value ) ); |
2121 | - $this->set_prop( 'type', $type ); |
|
2122 | - } |
|
2121 | + $this->set_prop( 'type', $type ); |
|
2122 | + } |
|
2123 | 2123 | |
2124 | 2124 | /** |
2125 | - * Set the invoice post type. |
|
2126 | - * |
|
2127 | - * @since 1.0.19 |
|
2128 | - * @param string $value Post type. |
|
2129 | - */ |
|
2130 | - public function set_post_type( $value ) { |
|
2125 | + * Set the invoice post type. |
|
2126 | + * |
|
2127 | + * @since 1.0.19 |
|
2128 | + * @param string $value Post type. |
|
2129 | + */ |
|
2130 | + public function set_post_type( $value ) { |
|
2131 | 2131 | if ( getpaid_is_invoice_post_type( $value ) ) { |
2132 | - $this->set_type( $value ); |
|
2132 | + $this->set_type( $value ); |
|
2133 | 2133 | $this->set_prop( 'post_type', $value ); |
2134 | 2134 | } |
2135 | 2135 | } |
2136 | 2136 | |
2137 | 2137 | /** |
2138 | - * Set the invoice key. |
|
2139 | - * |
|
2140 | - * @since 1.0.19 |
|
2141 | - * @param string $value New key. |
|
2142 | - */ |
|
2143 | - public function set_key( $value ) { |
|
2138 | + * Set the invoice key. |
|
2139 | + * |
|
2140 | + * @since 1.0.19 |
|
2141 | + * @param string $value New key. |
|
2142 | + */ |
|
2143 | + public function set_key( $value ) { |
|
2144 | 2144 | $key = sanitize_text_field( $value ); |
2145 | - $this->set_prop( 'key', $key ); |
|
2145 | + $this->set_prop( 'key', $key ); |
|
2146 | 2146 | } |
2147 | 2147 | |
2148 | 2148 | /** |
2149 | - * Set the invoice mode. |
|
2150 | - * |
|
2151 | - * @since 1.0.19 |
|
2152 | - * @param string $value mode. |
|
2153 | - */ |
|
2154 | - public function set_mode( $value ) { |
|
2149 | + * Set the invoice mode. |
|
2150 | + * |
|
2151 | + * @since 1.0.19 |
|
2152 | + * @param string $value mode. |
|
2153 | + */ |
|
2154 | + public function set_mode( $value ) { |
|
2155 | 2155 | if ( in_array( $value, array( 'live', 'test' ) ) ) { |
2156 | 2156 | $this->set_prop( 'mode', $value ); |
2157 | 2157 | } |
2158 | 2158 | } |
2159 | 2159 | |
2160 | 2160 | /** |
2161 | - * Set the invoice path. |
|
2162 | - * |
|
2163 | - * @since 1.0.19 |
|
2164 | - * @param string $value path. |
|
2165 | - */ |
|
2166 | - public function set_path( $value ) { |
|
2161 | + * Set the invoice path. |
|
2162 | + * |
|
2163 | + * @since 1.0.19 |
|
2164 | + * @param string $value path. |
|
2165 | + */ |
|
2166 | + public function set_path( $value ) { |
|
2167 | 2167 | $this->set_prop( 'path', $value ); |
2168 | 2168 | } |
2169 | 2169 | |
2170 | 2170 | /** |
2171 | - * Set the invoice name. |
|
2172 | - * |
|
2173 | - * @since 1.0.19 |
|
2174 | - * @param string $value New name. |
|
2175 | - */ |
|
2176 | - public function set_name( $value ) { |
|
2171 | + * Set the invoice name. |
|
2172 | + * |
|
2173 | + * @since 1.0.19 |
|
2174 | + * @param string $value New name. |
|
2175 | + */ |
|
2176 | + public function set_name( $value ) { |
|
2177 | 2177 | $name = sanitize_text_field( $value ); |
2178 | - $this->set_prop( 'name', $name ); |
|
2178 | + $this->set_prop( 'name', $name ); |
|
2179 | 2179 | } |
2180 | 2180 | |
2181 | 2181 | /** |
2182 | - * Alias of self::set_name(). |
|
2183 | - * |
|
2184 | - * @since 1.0.19 |
|
2185 | - * @param string $value New name. |
|
2186 | - */ |
|
2187 | - public function set_title( $value ) { |
|
2188 | - $this->set_name( $value ); |
|
2182 | + * Alias of self::set_name(). |
|
2183 | + * |
|
2184 | + * @since 1.0.19 |
|
2185 | + * @param string $value New name. |
|
2186 | + */ |
|
2187 | + public function set_title( $value ) { |
|
2188 | + $this->set_name( $value ); |
|
2189 | 2189 | } |
2190 | 2190 | |
2191 | 2191 | /** |
2192 | - * Set the invoice description. |
|
2193 | - * |
|
2194 | - * @since 1.0.19 |
|
2195 | - * @param string $value New description. |
|
2196 | - */ |
|
2197 | - public function set_description( $value ) { |
|
2192 | + * Set the invoice description. |
|
2193 | + * |
|
2194 | + * @since 1.0.19 |
|
2195 | + * @param string $value New description. |
|
2196 | + */ |
|
2197 | + public function set_description( $value ) { |
|
2198 | 2198 | $description = wp_kses_post( $value ); |
2199 | - $this->set_prop( 'description', $description ); |
|
2199 | + $this->set_prop( 'description', $description ); |
|
2200 | + } |
|
2201 | + |
|
2202 | + /** |
|
2203 | + * Alias of self::set_description(). |
|
2204 | + * |
|
2205 | + * @since 1.0.19 |
|
2206 | + * @param string $value New description. |
|
2207 | + */ |
|
2208 | + public function set_excerpt( $value ) { |
|
2209 | + $this->set_description( $value ); |
|
2210 | + } |
|
2211 | + |
|
2212 | + /** |
|
2213 | + * Alias of self::set_description(). |
|
2214 | + * |
|
2215 | + * @since 1.0.19 |
|
2216 | + * @param string $value New description. |
|
2217 | + */ |
|
2218 | + public function set_summary( $value ) { |
|
2219 | + $this->set_description( $value ); |
|
2220 | + } |
|
2221 | + |
|
2222 | + /** |
|
2223 | + * Set the receiver of the invoice. |
|
2224 | + * |
|
2225 | + * @since 1.0.19 |
|
2226 | + * @param int $value New author. |
|
2227 | + */ |
|
2228 | + public function set_author( $value ) { |
|
2229 | + $user = get_user_by( 'id', (int) $value ); |
|
2230 | + |
|
2231 | + if ( $user && $user->ID ) { |
|
2232 | + $this->set_prop( 'author', $user->ID ); |
|
2233 | + $this->set_prop( 'email', $user->user_email ); |
|
2234 | + } |
|
2235 | + |
|
2236 | + } |
|
2237 | + |
|
2238 | + /** |
|
2239 | + * Alias of self::set_author(). |
|
2240 | + * |
|
2241 | + * @since 1.0.19 |
|
2242 | + * @param int $value New user id. |
|
2243 | + */ |
|
2244 | + public function set_user_id( $value ) { |
|
2245 | + $this->set_author( $value ); |
|
2246 | + } |
|
2247 | + |
|
2248 | + /** |
|
2249 | + * Alias of self::set_author(). |
|
2250 | + * |
|
2251 | + * @since 1.0.19 |
|
2252 | + * @param int $value New user id. |
|
2253 | + */ |
|
2254 | + public function set_customer_id( $value ) { |
|
2255 | + $this->set_author( $value ); |
|
2256 | + } |
|
2257 | + |
|
2258 | + /** |
|
2259 | + * Set the customer's ip. |
|
2260 | + * |
|
2261 | + * @since 1.0.19 |
|
2262 | + * @param string $value ip address. |
|
2263 | + */ |
|
2264 | + public function set_ip( $value ) { |
|
2265 | + $this->set_prop( 'ip', $value ); |
|
2266 | + } |
|
2267 | + |
|
2268 | + /** |
|
2269 | + * Alias of self::set_ip(). |
|
2270 | + * |
|
2271 | + * @since 1.0.19 |
|
2272 | + * @param string $value ip address. |
|
2273 | + */ |
|
2274 | + public function set_user_ip( $value ) { |
|
2275 | + $this->set_ip( $value ); |
|
2276 | + } |
|
2277 | + |
|
2278 | + /** |
|
2279 | + * Set the customer's first name. |
|
2280 | + * |
|
2281 | + * @since 1.0.19 |
|
2282 | + * @param string $value first name. |
|
2283 | + */ |
|
2284 | + public function set_first_name( $value ) { |
|
2285 | + $this->set_prop( 'first_name', $value ); |
|
2200 | 2286 | } |
2201 | 2287 | |
2202 | 2288 | /** |
2203 | - * Alias of self::set_description(). |
|
2204 | - * |
|
2205 | - * @since 1.0.19 |
|
2206 | - * @param string $value New description. |
|
2207 | - */ |
|
2208 | - public function set_excerpt( $value ) { |
|
2209 | - $this->set_description( $value ); |
|
2289 | + * Alias of self::set_first_name(). |
|
2290 | + * |
|
2291 | + * @since 1.0.19 |
|
2292 | + * @param string $value first name. |
|
2293 | + */ |
|
2294 | + public function set_user_first_name( $value ) { |
|
2295 | + $this->set_first_name( $value ); |
|
2210 | 2296 | } |
2211 | 2297 | |
2212 | 2298 | /** |
2213 | - * Alias of self::set_description(). |
|
2214 | - * |
|
2215 | - * @since 1.0.19 |
|
2216 | - * @param string $value New description. |
|
2217 | - */ |
|
2218 | - public function set_summary( $value ) { |
|
2219 | - $this->set_description( $value ); |
|
2299 | + * Alias of self::set_first_name(). |
|
2300 | + * |
|
2301 | + * @since 1.0.19 |
|
2302 | + * @param string $value first name. |
|
2303 | + */ |
|
2304 | + public function set_customer_first_name( $value ) { |
|
2305 | + $this->set_first_name( $value ); |
|
2220 | 2306 | } |
2221 | 2307 | |
2222 | 2308 | /** |
2223 | - * Set the receiver of the invoice. |
|
2224 | - * |
|
2225 | - * @since 1.0.19 |
|
2226 | - * @param int $value New author. |
|
2227 | - */ |
|
2228 | - public function set_author( $value ) { |
|
2229 | - $user = get_user_by( 'id', (int) $value ); |
|
2309 | + * Set the customer's last name. |
|
2310 | + * |
|
2311 | + * @since 1.0.19 |
|
2312 | + * @param string $value last name. |
|
2313 | + */ |
|
2314 | + public function set_last_name( $value ) { |
|
2315 | + $this->set_prop( 'last_name', $value ); |
|
2316 | + } |
|
2230 | 2317 | |
2231 | - if ( $user && $user->ID ) { |
|
2232 | - $this->set_prop( 'author', $user->ID ); |
|
2233 | - $this->set_prop( 'email', $user->user_email ); |
|
2234 | - } |
|
2318 | + /** |
|
2319 | + * Alias of self::set_last_name(). |
|
2320 | + * |
|
2321 | + * @since 1.0.19 |
|
2322 | + * @param string $value last name. |
|
2323 | + */ |
|
2324 | + public function set_user_last_name( $value ) { |
|
2325 | + $this->set_last_name( $value ); |
|
2326 | + } |
|
2235 | 2327 | |
2328 | + /** |
|
2329 | + * Alias of self::set_last_name(). |
|
2330 | + * |
|
2331 | + * @since 1.0.19 |
|
2332 | + * @param string $value last name. |
|
2333 | + */ |
|
2334 | + public function set_customer_last_name( $value ) { |
|
2335 | + $this->set_last_name( $value ); |
|
2236 | 2336 | } |
2237 | 2337 | |
2238 | 2338 | /** |
2239 | - * Alias of self::set_author(). |
|
2240 | - * |
|
2241 | - * @since 1.0.19 |
|
2242 | - * @param int $value New user id. |
|
2243 | - */ |
|
2244 | - public function set_user_id( $value ) { |
|
2245 | - $this->set_author( $value ); |
|
2339 | + * Set the customer's phone number. |
|
2340 | + * |
|
2341 | + * @since 1.0.19 |
|
2342 | + * @param string $value phone. |
|
2343 | + */ |
|
2344 | + public function set_phone( $value ) { |
|
2345 | + $this->set_prop( 'phone', $value ); |
|
2246 | 2346 | } |
2247 | 2347 | |
2248 | 2348 | /** |
2249 | - * Alias of self::set_author(). |
|
2250 | - * |
|
2251 | - * @since 1.0.19 |
|
2252 | - * @param int $value New user id. |
|
2253 | - */ |
|
2254 | - public function set_customer_id( $value ) { |
|
2255 | - $this->set_author( $value ); |
|
2349 | + * Alias of self::set_phone(). |
|
2350 | + * |
|
2351 | + * @since 1.0.19 |
|
2352 | + * @param string $value phone. |
|
2353 | + */ |
|
2354 | + public function set_user_phone( $value ) { |
|
2355 | + $this->set_phone( $value ); |
|
2256 | 2356 | } |
2257 | 2357 | |
2258 | 2358 | /** |
2259 | - * Set the customer's ip. |
|
2260 | - * |
|
2261 | - * @since 1.0.19 |
|
2262 | - * @param string $value ip address. |
|
2263 | - */ |
|
2264 | - public function set_ip( $value ) { |
|
2265 | - $this->set_prop( 'ip', $value ); |
|
2359 | + * Alias of self::set_phone(). |
|
2360 | + * |
|
2361 | + * @since 1.0.19 |
|
2362 | + * @param string $value phone. |
|
2363 | + */ |
|
2364 | + public function set_customer_phone( $value ) { |
|
2365 | + $this->set_phone( $value ); |
|
2266 | 2366 | } |
2267 | 2367 | |
2268 | 2368 | /** |
2269 | - * Alias of self::set_ip(). |
|
2270 | - * |
|
2271 | - * @since 1.0.19 |
|
2272 | - * @param string $value ip address. |
|
2273 | - */ |
|
2274 | - public function set_user_ip( $value ) { |
|
2275 | - $this->set_ip( $value ); |
|
2369 | + * Alias of self::set_phone(). |
|
2370 | + * |
|
2371 | + * @since 1.0.19 |
|
2372 | + * @param string $value phone. |
|
2373 | + */ |
|
2374 | + public function set_phone_number( $value ) { |
|
2375 | + $this->set_phone( $value ); |
|
2276 | 2376 | } |
2277 | 2377 | |
2278 | 2378 | /** |
2279 | - * Set the customer's first name. |
|
2280 | - * |
|
2281 | - * @since 1.0.19 |
|
2282 | - * @param string $value first name. |
|
2283 | - */ |
|
2284 | - public function set_first_name( $value ) { |
|
2285 | - $this->set_prop( 'first_name', $value ); |
|
2379 | + * Set the customer's email address. |
|
2380 | + * |
|
2381 | + * @since 1.0.19 |
|
2382 | + * @param string $value email address. |
|
2383 | + */ |
|
2384 | + public function set_email( $value ) { |
|
2385 | + $this->set_prop( 'email', $value ); |
|
2286 | 2386 | } |
2287 | 2387 | |
2288 | 2388 | /** |
2289 | - * Alias of self::set_first_name(). |
|
2290 | - * |
|
2291 | - * @since 1.0.19 |
|
2292 | - * @param string $value first name. |
|
2293 | - */ |
|
2294 | - public function set_user_first_name( $value ) { |
|
2295 | - $this->set_first_name( $value ); |
|
2389 | + * Alias of self::set_email(). |
|
2390 | + * |
|
2391 | + * @since 1.0.19 |
|
2392 | + * @param string $value email address. |
|
2393 | + */ |
|
2394 | + public function set_user_email( $value ) { |
|
2395 | + $this->set_email( $value ); |
|
2296 | 2396 | } |
2297 | 2397 | |
2298 | 2398 | /** |
2299 | - * Alias of self::set_first_name(). |
|
2300 | - * |
|
2301 | - * @since 1.0.19 |
|
2302 | - * @param string $value first name. |
|
2303 | - */ |
|
2304 | - public function set_customer_first_name( $value ) { |
|
2305 | - $this->set_first_name( $value ); |
|
2399 | + * Alias of self::set_email(). |
|
2400 | + * |
|
2401 | + * @since 1.0.19 |
|
2402 | + * @param string $value email address. |
|
2403 | + */ |
|
2404 | + public function set_email_address( $value ) { |
|
2405 | + $this->set_email( $value ); |
|
2306 | 2406 | } |
2307 | 2407 | |
2308 | 2408 | /** |
2309 | - * Set the customer's last name. |
|
2310 | - * |
|
2311 | - * @since 1.0.19 |
|
2312 | - * @param string $value last name. |
|
2313 | - */ |
|
2314 | - public function set_last_name( $value ) { |
|
2315 | - $this->set_prop( 'last_name', $value ); |
|
2409 | + * Alias of self::set_email(). |
|
2410 | + * |
|
2411 | + * @since 1.0.19 |
|
2412 | + * @param string $value email address. |
|
2413 | + */ |
|
2414 | + public function set_customer_email( $value ) { |
|
2415 | + $this->set_email( $value ); |
|
2416 | + } |
|
2417 | + |
|
2418 | + /** |
|
2419 | + * Set the customer's country. |
|
2420 | + * |
|
2421 | + * @since 1.0.19 |
|
2422 | + * @param string $value country. |
|
2423 | + */ |
|
2424 | + public function set_country( $value ) { |
|
2425 | + $this->set_prop( 'country', $value ); |
|
2426 | + } |
|
2427 | + |
|
2428 | + /** |
|
2429 | + * Alias of self::set_country(). |
|
2430 | + * |
|
2431 | + * @since 1.0.19 |
|
2432 | + * @param string $value country. |
|
2433 | + */ |
|
2434 | + public function set_user_country( $value ) { |
|
2435 | + $this->set_country( $value ); |
|
2436 | + } |
|
2437 | + |
|
2438 | + /** |
|
2439 | + * Alias of self::set_country(). |
|
2440 | + * |
|
2441 | + * @since 1.0.19 |
|
2442 | + * @param string $value country. |
|
2443 | + */ |
|
2444 | + public function set_customer_country( $value ) { |
|
2445 | + $this->set_country( $value ); |
|
2446 | + } |
|
2447 | + |
|
2448 | + /** |
|
2449 | + * Set the customer's state. |
|
2450 | + * |
|
2451 | + * @since 1.0.19 |
|
2452 | + * @param string $value state. |
|
2453 | + */ |
|
2454 | + public function set_state( $value ) { |
|
2455 | + $this->set_prop( 'state', $value ); |
|
2316 | 2456 | } |
2317 | 2457 | |
2318 | 2458 | /** |
2319 | - * Alias of self::set_last_name(). |
|
2320 | - * |
|
2321 | - * @since 1.0.19 |
|
2322 | - * @param string $value last name. |
|
2323 | - */ |
|
2324 | - public function set_user_last_name( $value ) { |
|
2325 | - $this->set_last_name( $value ); |
|
2459 | + * Alias of self::set_state(). |
|
2460 | + * |
|
2461 | + * @since 1.0.19 |
|
2462 | + * @param string $value state. |
|
2463 | + */ |
|
2464 | + public function set_user_state( $value ) { |
|
2465 | + $this->set_state( $value ); |
|
2326 | 2466 | } |
2327 | 2467 | |
2328 | 2468 | /** |
2329 | - * Alias of self::set_last_name(). |
|
2330 | - * |
|
2331 | - * @since 1.0.19 |
|
2332 | - * @param string $value last name. |
|
2333 | - */ |
|
2334 | - public function set_customer_last_name( $value ) { |
|
2335 | - $this->set_last_name( $value ); |
|
2469 | + * Alias of self::set_state(). |
|
2470 | + * |
|
2471 | + * @since 1.0.19 |
|
2472 | + * @param string $value state. |
|
2473 | + */ |
|
2474 | + public function set_customer_state( $value ) { |
|
2475 | + $this->set_state( $value ); |
|
2476 | + } |
|
2477 | + |
|
2478 | + /** |
|
2479 | + * Set the customer's city. |
|
2480 | + * |
|
2481 | + * @since 1.0.19 |
|
2482 | + * @param string $value city. |
|
2483 | + */ |
|
2484 | + public function set_city( $value ) { |
|
2485 | + $this->set_prop( 'city', $value ); |
|
2336 | 2486 | } |
2337 | 2487 | |
2338 | 2488 | /** |
2339 | - * Set the customer's phone number. |
|
2340 | - * |
|
2341 | - * @since 1.0.19 |
|
2342 | - * @param string $value phone. |
|
2343 | - */ |
|
2344 | - public function set_phone( $value ) { |
|
2345 | - $this->set_prop( 'phone', $value ); |
|
2489 | + * Alias of self::set_city(). |
|
2490 | + * |
|
2491 | + * @since 1.0.19 |
|
2492 | + * @param string $value city. |
|
2493 | + */ |
|
2494 | + public function set_user_city( $value ) { |
|
2495 | + $this->set_city( $value ); |
|
2346 | 2496 | } |
2347 | 2497 | |
2348 | 2498 | /** |
2349 | - * Alias of self::set_phone(). |
|
2350 | - * |
|
2351 | - * @since 1.0.19 |
|
2352 | - * @param string $value phone. |
|
2353 | - */ |
|
2354 | - public function set_user_phone( $value ) { |
|
2355 | - $this->set_phone( $value ); |
|
2499 | + * Alias of self::set_city(). |
|
2500 | + * |
|
2501 | + * @since 1.0.19 |
|
2502 | + * @param string $value city. |
|
2503 | + */ |
|
2504 | + public function set_customer_city( $value ) { |
|
2505 | + $this->set_city( $value ); |
|
2356 | 2506 | } |
2357 | 2507 | |
2358 | 2508 | /** |
2359 | - * Alias of self::set_phone(). |
|
2360 | - * |
|
2361 | - * @since 1.0.19 |
|
2362 | - * @param string $value phone. |
|
2363 | - */ |
|
2364 | - public function set_customer_phone( $value ) { |
|
2365 | - $this->set_phone( $value ); |
|
2509 | + * Set the customer's zip code. |
|
2510 | + * |
|
2511 | + * @since 1.0.19 |
|
2512 | + * @param string $value zip. |
|
2513 | + */ |
|
2514 | + public function set_zip( $value ) { |
|
2515 | + $this->set_prop( 'zip', $value ); |
|
2366 | 2516 | } |
2367 | 2517 | |
2368 | 2518 | /** |
2369 | - * Alias of self::set_phone(). |
|
2370 | - * |
|
2371 | - * @since 1.0.19 |
|
2372 | - * @param string $value phone. |
|
2373 | - */ |
|
2374 | - public function set_phone_number( $value ) { |
|
2375 | - $this->set_phone( $value ); |
|
2519 | + * Alias of self::set_zip(). |
|
2520 | + * |
|
2521 | + * @since 1.0.19 |
|
2522 | + * @param string $value zip. |
|
2523 | + */ |
|
2524 | + public function set_user_zip( $value ) { |
|
2525 | + $this->set_zip( $value ); |
|
2376 | 2526 | } |
2377 | 2527 | |
2378 | 2528 | /** |
2379 | - * Set the customer's email address. |
|
2380 | - * |
|
2381 | - * @since 1.0.19 |
|
2382 | - * @param string $value email address. |
|
2383 | - */ |
|
2384 | - public function set_email( $value ) { |
|
2385 | - $this->set_prop( 'email', $value ); |
|
2529 | + * Alias of self::set_zip(). |
|
2530 | + * |
|
2531 | + * @since 1.0.19 |
|
2532 | + * @param string $value zip. |
|
2533 | + */ |
|
2534 | + public function set_customer_zip( $value ) { |
|
2535 | + $this->set_zip( $value ); |
|
2386 | 2536 | } |
2387 | 2537 | |
2388 | 2538 | /** |
2389 | - * Alias of self::set_email(). |
|
2390 | - * |
|
2391 | - * @since 1.0.19 |
|
2392 | - * @param string $value email address. |
|
2393 | - */ |
|
2394 | - public function set_user_email( $value ) { |
|
2395 | - $this->set_email( $value ); |
|
2539 | + * Set the customer's company. |
|
2540 | + * |
|
2541 | + * @since 1.0.19 |
|
2542 | + * @param string $value company. |
|
2543 | + */ |
|
2544 | + public function set_company( $value ) { |
|
2545 | + $this->set_prop( 'company', $value ); |
|
2396 | 2546 | } |
2397 | 2547 | |
2398 | 2548 | /** |
2399 | - * Alias of self::set_email(). |
|
2400 | - * |
|
2401 | - * @since 1.0.19 |
|
2402 | - * @param string $value email address. |
|
2403 | - */ |
|
2404 | - public function set_email_address( $value ) { |
|
2405 | - $this->set_email( $value ); |
|
2549 | + * Alias of self::set_company(). |
|
2550 | + * |
|
2551 | + * @since 1.0.19 |
|
2552 | + * @param string $value company. |
|
2553 | + */ |
|
2554 | + public function set_user_company( $value ) { |
|
2555 | + $this->set_company( $value ); |
|
2406 | 2556 | } |
2407 | 2557 | |
2408 | 2558 | /** |
2409 | - * Alias of self::set_email(). |
|
2410 | - * |
|
2411 | - * @since 1.0.19 |
|
2412 | - * @param string $value email address. |
|
2413 | - */ |
|
2414 | - public function set_customer_email( $value ) { |
|
2415 | - $this->set_email( $value ); |
|
2559 | + * Alias of self::set_company(). |
|
2560 | + * |
|
2561 | + * @since 1.0.19 |
|
2562 | + * @param string $value company. |
|
2563 | + */ |
|
2564 | + public function set_customer_company( $value ) { |
|
2565 | + $this->set_company( $value ); |
|
2416 | 2566 | } |
2417 | 2567 | |
2418 | 2568 | /** |
2419 | - * Set the customer's country. |
|
2420 | - * |
|
2421 | - * @since 1.0.19 |
|
2422 | - * @param string $value country. |
|
2423 | - */ |
|
2424 | - public function set_country( $value ) { |
|
2425 | - $this->set_prop( 'country', $value ); |
|
2569 | + * Set the customer's var number. |
|
2570 | + * |
|
2571 | + * @since 1.0.19 |
|
2572 | + * @param string $value var number. |
|
2573 | + */ |
|
2574 | + public function set_vat_number( $value ) { |
|
2575 | + $this->set_prop( 'vat_number', $value ); |
|
2426 | 2576 | } |
2427 | 2577 | |
2428 | 2578 | /** |
2429 | - * Alias of self::set_country(). |
|
2430 | - * |
|
2431 | - * @since 1.0.19 |
|
2432 | - * @param string $value country. |
|
2433 | - */ |
|
2434 | - public function set_user_country( $value ) { |
|
2435 | - $this->set_country( $value ); |
|
2579 | + * Alias of self::set_vat_number(). |
|
2580 | + * |
|
2581 | + * @since 1.0.19 |
|
2582 | + * @param string $value var number. |
|
2583 | + */ |
|
2584 | + public function set_user_vat_number( $value ) { |
|
2585 | + $this->set_vat_number( $value ); |
|
2436 | 2586 | } |
2437 | 2587 | |
2438 | 2588 | /** |
2439 | - * Alias of self::set_country(). |
|
2440 | - * |
|
2441 | - * @since 1.0.19 |
|
2442 | - * @param string $value country. |
|
2443 | - */ |
|
2444 | - public function set_customer_country( $value ) { |
|
2445 | - $this->set_country( $value ); |
|
2589 | + * Alias of self::set_vat_number(). |
|
2590 | + * |
|
2591 | + * @since 1.0.19 |
|
2592 | + * @param string $value var number. |
|
2593 | + */ |
|
2594 | + public function set_customer_vat_number( $value ) { |
|
2595 | + $this->set_vat_number( $value ); |
|
2446 | 2596 | } |
2447 | 2597 | |
2448 | 2598 | /** |
2449 | - * Set the customer's state. |
|
2450 | - * |
|
2451 | - * @since 1.0.19 |
|
2452 | - * @param string $value state. |
|
2453 | - */ |
|
2454 | - public function set_state( $value ) { |
|
2455 | - $this->set_prop( 'state', $value ); |
|
2599 | + * Set the customer's vat rate. |
|
2600 | + * |
|
2601 | + * @since 1.0.19 |
|
2602 | + * @param string $value var rate. |
|
2603 | + */ |
|
2604 | + public function set_vat_rate( $value ) { |
|
2605 | + $this->set_prop( 'vat_rate', $value ); |
|
2456 | 2606 | } |
2457 | 2607 | |
2458 | 2608 | /** |
2459 | - * Alias of self::set_state(). |
|
2460 | - * |
|
2461 | - * @since 1.0.19 |
|
2462 | - * @param string $value state. |
|
2463 | - */ |
|
2464 | - public function set_user_state( $value ) { |
|
2465 | - $this->set_state( $value ); |
|
2609 | + * Alias of self::set_vat_rate(). |
|
2610 | + * |
|
2611 | + * @since 1.0.19 |
|
2612 | + * @param string $value var number. |
|
2613 | + */ |
|
2614 | + public function set_user_vat_rate( $value ) { |
|
2615 | + $this->set_vat_rate( $value ); |
|
2466 | 2616 | } |
2467 | 2617 | |
2468 | 2618 | /** |
2469 | - * Alias of self::set_state(). |
|
2470 | - * |
|
2471 | - * @since 1.0.19 |
|
2472 | - * @param string $value state. |
|
2473 | - */ |
|
2474 | - public function set_customer_state( $value ) { |
|
2475 | - $this->set_state( $value ); |
|
2619 | + * Alias of self::set_vat_rate(). |
|
2620 | + * |
|
2621 | + * @since 1.0.19 |
|
2622 | + * @param string $value var number. |
|
2623 | + */ |
|
2624 | + public function set_customer_vat_rate( $value ) { |
|
2625 | + $this->set_vat_rate( $value ); |
|
2476 | 2626 | } |
2477 | 2627 | |
2478 | 2628 | /** |
2479 | - * Set the customer's city. |
|
2480 | - * |
|
2481 | - * @since 1.0.19 |
|
2482 | - * @param string $value city. |
|
2483 | - */ |
|
2484 | - public function set_city( $value ) { |
|
2485 | - $this->set_prop( 'city', $value ); |
|
2629 | + * Set the customer's address. |
|
2630 | + * |
|
2631 | + * @since 1.0.19 |
|
2632 | + * @param string $value address. |
|
2633 | + */ |
|
2634 | + public function set_address( $value ) { |
|
2635 | + $this->set_prop( 'address', $value ); |
|
2486 | 2636 | } |
2487 | 2637 | |
2488 | 2638 | /** |
2489 | - * Alias of self::set_city(). |
|
2490 | - * |
|
2491 | - * @since 1.0.19 |
|
2492 | - * @param string $value city. |
|
2493 | - */ |
|
2494 | - public function set_user_city( $value ) { |
|
2495 | - $this->set_city( $value ); |
|
2639 | + * Alias of self::set_address(). |
|
2640 | + * |
|
2641 | + * @since 1.0.19 |
|
2642 | + * @param string $value address. |
|
2643 | + */ |
|
2644 | + public function set_user_address( $value ) { |
|
2645 | + $this->set_address( $value ); |
|
2496 | 2646 | } |
2497 | 2647 | |
2498 | 2648 | /** |
2499 | - * Alias of self::set_city(). |
|
2500 | - * |
|
2501 | - * @since 1.0.19 |
|
2502 | - * @param string $value city. |
|
2503 | - */ |
|
2504 | - public function set_customer_city( $value ) { |
|
2505 | - $this->set_city( $value ); |
|
2649 | + * Alias of self::set_address(). |
|
2650 | + * |
|
2651 | + * @since 1.0.19 |
|
2652 | + * @param string $value address. |
|
2653 | + */ |
|
2654 | + public function set_customer_address( $value ) { |
|
2655 | + $this->set_address( $value ); |
|
2506 | 2656 | } |
2507 | 2657 | |
2508 | 2658 | /** |
2509 | - * Set the customer's zip code. |
|
2510 | - * |
|
2511 | - * @since 1.0.19 |
|
2512 | - * @param string $value zip. |
|
2513 | - */ |
|
2514 | - public function set_zip( $value ) { |
|
2515 | - $this->set_prop( 'zip', $value ); |
|
2659 | + * Set whether the customer has viewed the invoice or not. |
|
2660 | + * |
|
2661 | + * @since 1.0.19 |
|
2662 | + * @param int|bool $value confirmed. |
|
2663 | + */ |
|
2664 | + public function set_is_viewed( $value ) { |
|
2665 | + $this->set_prop( 'is_viewed', $value ); |
|
2516 | 2666 | } |
2517 | 2667 | |
2518 | 2668 | /** |
2519 | - * Alias of self::set_zip(). |
|
2520 | - * |
|
2521 | - * @since 1.0.19 |
|
2522 | - * @param string $value zip. |
|
2523 | - */ |
|
2524 | - public function set_user_zip( $value ) { |
|
2525 | - $this->set_zip( $value ); |
|
2669 | + * Set extra email recipients. |
|
2670 | + * |
|
2671 | + * @since 1.0.19 |
|
2672 | + * @param string $value email recipients. |
|
2673 | + */ |
|
2674 | + public function set_email_cc( $value ) { |
|
2675 | + $this->set_prop( 'email_cc', $value ); |
|
2526 | 2676 | } |
2527 | 2677 | |
2528 | 2678 | /** |
2529 | - * Alias of self::set_zip(). |
|
2530 | - * |
|
2531 | - * @since 1.0.19 |
|
2532 | - * @param string $value zip. |
|
2533 | - */ |
|
2534 | - public function set_customer_zip( $value ) { |
|
2535 | - $this->set_zip( $value ); |
|
2679 | + * Set the invoice template. |
|
2680 | + * |
|
2681 | + * @since 1.0.19 |
|
2682 | + * @param string $value template. |
|
2683 | + */ |
|
2684 | + public function set_template( $value ) { |
|
2685 | + if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) { |
|
2686 | + $this->set_prop( 'template', $value ); |
|
2687 | + } |
|
2536 | 2688 | } |
2537 | 2689 | |
2538 | 2690 | /** |
2539 | - * Set the customer's company. |
|
2540 | - * |
|
2541 | - * @since 1.0.19 |
|
2542 | - * @param string $value company. |
|
2543 | - */ |
|
2544 | - public function set_company( $value ) { |
|
2545 | - $this->set_prop( 'company', $value ); |
|
2691 | + * Set the invoice source. |
|
2692 | + * |
|
2693 | + * @since 1.0.19 |
|
2694 | + * @param string $value source. |
|
2695 | + * @deprecated |
|
2696 | + */ |
|
2697 | + public function created_via( $value ) { |
|
2698 | + $this->set_created_via( sanitize_text_field( $value ) ); |
|
2546 | 2699 | } |
2547 | 2700 | |
2548 | 2701 | /** |
2549 | - * Alias of self::set_company(). |
|
2550 | - * |
|
2551 | - * @since 1.0.19 |
|
2552 | - * @param string $value company. |
|
2553 | - */ |
|
2554 | - public function set_user_company( $value ) { |
|
2555 | - $this->set_company( $value ); |
|
2702 | + * Set the invoice source. |
|
2703 | + * |
|
2704 | + * @since 1.0.19 |
|
2705 | + * @param string $value source. |
|
2706 | + */ |
|
2707 | + public function set_created_via( $value ) { |
|
2708 | + $this->set_prop( 'created_via', sanitize_text_field( $value ) ); |
|
2556 | 2709 | } |
2557 | 2710 | |
2558 | 2711 | /** |
2559 | - * Alias of self::set_company(). |
|
2560 | - * |
|
2561 | - * @since 1.0.19 |
|
2562 | - * @param string $value company. |
|
2563 | - */ |
|
2564 | - public function set_customer_company( $value ) { |
|
2565 | - $this->set_company( $value ); |
|
2712 | + * Set the customer's address confirmed status. |
|
2713 | + * |
|
2714 | + * @since 1.0.19 |
|
2715 | + * @param int|bool $value confirmed. |
|
2716 | + */ |
|
2717 | + public function set_address_confirmed( $value ) { |
|
2718 | + $this->set_prop( 'address_confirmed', $value ); |
|
2566 | 2719 | } |
2567 | 2720 | |
2568 | 2721 | /** |
2569 | - * Set the customer's var number. |
|
2570 | - * |
|
2571 | - * @since 1.0.19 |
|
2572 | - * @param string $value var number. |
|
2573 | - */ |
|
2574 | - public function set_vat_number( $value ) { |
|
2575 | - $this->set_prop( 'vat_number', $value ); |
|
2722 | + * Alias of self::set_address_confirmed(). |
|
2723 | + * |
|
2724 | + * @since 1.0.19 |
|
2725 | + * @param int|bool $value confirmed. |
|
2726 | + */ |
|
2727 | + public function set_user_address_confirmed( $value ) { |
|
2728 | + $this->set_address_confirmed( $value ); |
|
2576 | 2729 | } |
2577 | 2730 | |
2578 | 2731 | /** |
2579 | - * Alias of self::set_vat_number(). |
|
2580 | - * |
|
2581 | - * @since 1.0.19 |
|
2582 | - * @param string $value var number. |
|
2583 | - */ |
|
2584 | - public function set_user_vat_number( $value ) { |
|
2585 | - $this->set_vat_number( $value ); |
|
2732 | + * Alias of self::set_address_confirmed(). |
|
2733 | + * |
|
2734 | + * @since 1.0.19 |
|
2735 | + * @param int|bool $value confirmed. |
|
2736 | + */ |
|
2737 | + public function set_customer_address_confirmed( $value ) { |
|
2738 | + $this->set_address_confirmed( $value ); |
|
2586 | 2739 | } |
2587 | 2740 | |
2588 | 2741 | /** |
2589 | - * Alias of self::set_vat_number(). |
|
2590 | - * |
|
2591 | - * @since 1.0.19 |
|
2592 | - * @param string $value var number. |
|
2593 | - */ |
|
2594 | - public function set_customer_vat_number( $value ) { |
|
2595 | - $this->set_vat_number( $value ); |
|
2742 | + * Set the invoice sub total. |
|
2743 | + * |
|
2744 | + * @since 1.0.19 |
|
2745 | + * @param float $value sub total. |
|
2746 | + */ |
|
2747 | + public function set_subtotal( $value ) { |
|
2748 | + $this->set_prop( 'subtotal', max( 0, $value ) ); |
|
2596 | 2749 | } |
2597 | 2750 | |
2598 | 2751 | /** |
2599 | - * Set the customer's vat rate. |
|
2600 | - * |
|
2601 | - * @since 1.0.19 |
|
2602 | - * @param string $value var rate. |
|
2603 | - */ |
|
2604 | - public function set_vat_rate( $value ) { |
|
2605 | - $this->set_prop( 'vat_rate', $value ); |
|
2752 | + * Set the invoice total. |
|
2753 | + * |
|
2754 | + * @since 1.0.19 |
|
2755 | + * @param float $value sub total. |
|
2756 | + */ |
|
2757 | + public function set_total( $value ) { |
|
2758 | + $this->set_prop( 'total', max( 0, $value ) ); |
|
2606 | 2759 | } |
2607 | 2760 | |
2608 | 2761 | /** |
2609 | - * Alias of self::set_vat_rate(). |
|
2610 | - * |
|
2611 | - * @since 1.0.19 |
|
2612 | - * @param string $value var number. |
|
2613 | - */ |
|
2614 | - public function set_user_vat_rate( $value ) { |
|
2615 | - $this->set_vat_rate( $value ); |
|
2616 | - } |
|
2617 | - |
|
2618 | - /** |
|
2619 | - * Alias of self::set_vat_rate(). |
|
2620 | - * |
|
2621 | - * @since 1.0.19 |
|
2622 | - * @param string $value var number. |
|
2623 | - */ |
|
2624 | - public function set_customer_vat_rate( $value ) { |
|
2625 | - $this->set_vat_rate( $value ); |
|
2626 | - } |
|
2627 | - |
|
2628 | - /** |
|
2629 | - * Set the customer's address. |
|
2630 | - * |
|
2631 | - * @since 1.0.19 |
|
2632 | - * @param string $value address. |
|
2633 | - */ |
|
2634 | - public function set_address( $value ) { |
|
2635 | - $this->set_prop( 'address', $value ); |
|
2636 | - } |
|
2637 | - |
|
2638 | - /** |
|
2639 | - * Alias of self::set_address(). |
|
2640 | - * |
|
2641 | - * @since 1.0.19 |
|
2642 | - * @param string $value address. |
|
2643 | - */ |
|
2644 | - public function set_user_address( $value ) { |
|
2645 | - $this->set_address( $value ); |
|
2646 | - } |
|
2647 | - |
|
2648 | - /** |
|
2649 | - * Alias of self::set_address(). |
|
2650 | - * |
|
2651 | - * @since 1.0.19 |
|
2652 | - * @param string $value address. |
|
2653 | - */ |
|
2654 | - public function set_customer_address( $value ) { |
|
2655 | - $this->set_address( $value ); |
|
2656 | - } |
|
2657 | - |
|
2658 | - /** |
|
2659 | - * Set whether the customer has viewed the invoice or not. |
|
2660 | - * |
|
2661 | - * @since 1.0.19 |
|
2662 | - * @param int|bool $value confirmed. |
|
2663 | - */ |
|
2664 | - public function set_is_viewed( $value ) { |
|
2665 | - $this->set_prop( 'is_viewed', $value ); |
|
2666 | - } |
|
2667 | - |
|
2668 | - /** |
|
2669 | - * Set extra email recipients. |
|
2670 | - * |
|
2671 | - * @since 1.0.19 |
|
2672 | - * @param string $value email recipients. |
|
2673 | - */ |
|
2674 | - public function set_email_cc( $value ) { |
|
2675 | - $this->set_prop( 'email_cc', $value ); |
|
2676 | - } |
|
2677 | - |
|
2678 | - /** |
|
2679 | - * Set the invoice template. |
|
2680 | - * |
|
2681 | - * @since 1.0.19 |
|
2682 | - * @param string $value template. |
|
2683 | - */ |
|
2684 | - public function set_template( $value ) { |
|
2685 | - if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) { |
|
2686 | - $this->set_prop( 'template', $value ); |
|
2687 | - } |
|
2688 | - } |
|
2689 | - |
|
2690 | - /** |
|
2691 | - * Set the invoice source. |
|
2692 | - * |
|
2693 | - * @since 1.0.19 |
|
2694 | - * @param string $value source. |
|
2695 | - * @deprecated |
|
2696 | - */ |
|
2697 | - public function created_via( $value ) { |
|
2698 | - $this->set_created_via( sanitize_text_field( $value ) ); |
|
2699 | - } |
|
2700 | - |
|
2701 | - /** |
|
2702 | - * Set the invoice source. |
|
2703 | - * |
|
2704 | - * @since 1.0.19 |
|
2705 | - * @param string $value source. |
|
2706 | - */ |
|
2707 | - public function set_created_via( $value ) { |
|
2708 | - $this->set_prop( 'created_via', sanitize_text_field( $value ) ); |
|
2709 | - } |
|
2710 | - |
|
2711 | - /** |
|
2712 | - * Set the customer's address confirmed status. |
|
2713 | - * |
|
2714 | - * @since 1.0.19 |
|
2715 | - * @param int|bool $value confirmed. |
|
2716 | - */ |
|
2717 | - public function set_address_confirmed( $value ) { |
|
2718 | - $this->set_prop( 'address_confirmed', $value ); |
|
2719 | - } |
|
2720 | - |
|
2721 | - /** |
|
2722 | - * Alias of self::set_address_confirmed(). |
|
2723 | - * |
|
2724 | - * @since 1.0.19 |
|
2725 | - * @param int|bool $value confirmed. |
|
2726 | - */ |
|
2727 | - public function set_user_address_confirmed( $value ) { |
|
2728 | - $this->set_address_confirmed( $value ); |
|
2729 | - } |
|
2730 | - |
|
2731 | - /** |
|
2732 | - * Alias of self::set_address_confirmed(). |
|
2733 | - * |
|
2734 | - * @since 1.0.19 |
|
2735 | - * @param int|bool $value confirmed. |
|
2736 | - */ |
|
2737 | - public function set_customer_address_confirmed( $value ) { |
|
2738 | - $this->set_address_confirmed( $value ); |
|
2739 | - } |
|
2740 | - |
|
2741 | - /** |
|
2742 | - * Set the invoice sub total. |
|
2743 | - * |
|
2744 | - * @since 1.0.19 |
|
2745 | - * @param float $value sub total. |
|
2746 | - */ |
|
2747 | - public function set_subtotal( $value ) { |
|
2748 | - $this->set_prop( 'subtotal', max( 0, $value ) ); |
|
2749 | - } |
|
2750 | - |
|
2751 | - /** |
|
2752 | - * Set the invoice total. |
|
2753 | - * |
|
2754 | - * @since 1.0.19 |
|
2755 | - * @param float $value sub total. |
|
2756 | - */ |
|
2757 | - public function set_total( $value ) { |
|
2758 | - $this->set_prop( 'total', max( 0, $value ) ); |
|
2759 | - } |
|
2760 | - |
|
2761 | - /** |
|
2762 | - * Set the invoice discount amount. |
|
2763 | - * |
|
2764 | - * @since 1.0.19 |
|
2765 | - * @param float $value discount total. |
|
2766 | - */ |
|
2767 | - public function set_total_discount( $value ) { |
|
2768 | - $this->set_prop( 'total_discount', max( 0, $value ) ); |
|
2762 | + * Set the invoice discount amount. |
|
2763 | + * |
|
2764 | + * @since 1.0.19 |
|
2765 | + * @param float $value discount total. |
|
2766 | + */ |
|
2767 | + public function set_total_discount( $value ) { |
|
2768 | + $this->set_prop( 'total_discount', max( 0, $value ) ); |
|
2769 | 2769 | } |
2770 | 2770 | |
2771 | 2771 | /** |
2772 | - * Alias of self::set_total_discount(). |
|
2773 | - * |
|
2774 | - * @since 1.0.19 |
|
2775 | - * @param float $value discount total. |
|
2776 | - */ |
|
2777 | - public function set_discount( $value ) { |
|
2778 | - $this->set_total_discount( $value ); |
|
2772 | + * Alias of self::set_total_discount(). |
|
2773 | + * |
|
2774 | + * @since 1.0.19 |
|
2775 | + * @param float $value discount total. |
|
2776 | + */ |
|
2777 | + public function set_discount( $value ) { |
|
2778 | + $this->set_total_discount( $value ); |
|
2779 | 2779 | } |
2780 | 2780 | |
2781 | 2781 | /** |
2782 | - * Set the invoice tax amount. |
|
2783 | - * |
|
2784 | - * @since 1.0.19 |
|
2785 | - * @param float $value tax total. |
|
2786 | - */ |
|
2787 | - public function set_total_tax( $value ) { |
|
2788 | - $this->set_prop( 'total_tax', max( 0, $value ) ); |
|
2782 | + * Set the invoice tax amount. |
|
2783 | + * |
|
2784 | + * @since 1.0.19 |
|
2785 | + * @param float $value tax total. |
|
2786 | + */ |
|
2787 | + public function set_total_tax( $value ) { |
|
2788 | + $this->set_prop( 'total_tax', max( 0, $value ) ); |
|
2789 | 2789 | } |
2790 | 2790 | |
2791 | 2791 | /** |
2792 | - * Alias of self::set_total_tax(). |
|
2793 | - * |
|
2794 | - * @since 1.0.19 |
|
2795 | - * @param float $value tax total. |
|
2796 | - */ |
|
2797 | - public function set_tax_total( $value ) { |
|
2798 | - $this->set_total_tax( $value ); |
|
2792 | + * Alias of self::set_total_tax(). |
|
2793 | + * |
|
2794 | + * @since 1.0.19 |
|
2795 | + * @param float $value tax total. |
|
2796 | + */ |
|
2797 | + public function set_tax_total( $value ) { |
|
2798 | + $this->set_total_tax( $value ); |
|
2799 | 2799 | } |
2800 | 2800 | |
2801 | 2801 | /** |
2802 | - * Set the invoice fees amount. |
|
2803 | - * |
|
2804 | - * @since 1.0.19 |
|
2805 | - * @param float $value fees total. |
|
2806 | - */ |
|
2807 | - public function set_total_fees( $value ) { |
|
2808 | - $this->set_prop( 'total_fees', max( 0, $value ) ); |
|
2802 | + * Set the invoice fees amount. |
|
2803 | + * |
|
2804 | + * @since 1.0.19 |
|
2805 | + * @param float $value fees total. |
|
2806 | + */ |
|
2807 | + public function set_total_fees( $value ) { |
|
2808 | + $this->set_prop( 'total_fees', max( 0, $value ) ); |
|
2809 | 2809 | } |
2810 | 2810 | |
2811 | 2811 | /** |
2812 | - * Alias of self::set_total_fees(). |
|
2813 | - * |
|
2814 | - * @since 1.0.19 |
|
2815 | - * @param float $value fees total. |
|
2816 | - */ |
|
2817 | - public function set_fees_total( $value ) { |
|
2818 | - $this->set_total_fees( $value ); |
|
2812 | + * Alias of self::set_total_fees(). |
|
2813 | + * |
|
2814 | + * @since 1.0.19 |
|
2815 | + * @param float $value fees total. |
|
2816 | + */ |
|
2817 | + public function set_fees_total( $value ) { |
|
2818 | + $this->set_total_fees( $value ); |
|
2819 | 2819 | } |
2820 | 2820 | |
2821 | 2821 | /** |
2822 | - * Set the invoice fees. |
|
2823 | - * |
|
2824 | - * @since 1.0.19 |
|
2825 | - * @param array $value fees. |
|
2826 | - */ |
|
2827 | - public function set_fees( $value ) { |
|
2822 | + * Set the invoice fees. |
|
2823 | + * |
|
2824 | + * @since 1.0.19 |
|
2825 | + * @param array $value fees. |
|
2826 | + */ |
|
2827 | + public function set_fees( $value ) { |
|
2828 | 2828 | |
2829 | - if ( ! is_array( $value ) ) { |
|
2830 | - $value = array(); |
|
2831 | - } |
|
2829 | + if ( ! is_array( $value ) ) { |
|
2830 | + $value = array(); |
|
2831 | + } |
|
2832 | 2832 | |
2833 | - $this->set_prop( 'fees', $value ); |
|
2833 | + $this->set_prop( 'fees', $value ); |
|
2834 | 2834 | |
2835 | 2835 | } |
2836 | 2836 | |
2837 | 2837 | /** |
2838 | - * Set the invoice taxes. |
|
2839 | - * |
|
2840 | - * @since 1.0.19 |
|
2841 | - * @param array $value taxes. |
|
2842 | - */ |
|
2843 | - public function set_taxes( $value ) { |
|
2838 | + * Set the invoice taxes. |
|
2839 | + * |
|
2840 | + * @since 1.0.19 |
|
2841 | + * @param array $value taxes. |
|
2842 | + */ |
|
2843 | + public function set_taxes( $value ) { |
|
2844 | 2844 | |
2845 | - if ( ! is_array( $value ) ) { |
|
2846 | - $value = array(); |
|
2847 | - } |
|
2845 | + if ( ! is_array( $value ) ) { |
|
2846 | + $value = array(); |
|
2847 | + } |
|
2848 | 2848 | |
2849 | - $this->set_prop( 'taxes', $value ); |
|
2849 | + $this->set_prop( 'taxes', $value ); |
|
2850 | 2850 | |
2851 | 2851 | } |
2852 | 2852 | |
2853 | 2853 | /** |
2854 | - * Set the invoice discounts. |
|
2855 | - * |
|
2856 | - * @since 1.0.19 |
|
2857 | - * @param array $value discounts. |
|
2858 | - */ |
|
2859 | - public function set_discounts( $value ) { |
|
2854 | + * Set the invoice discounts. |
|
2855 | + * |
|
2856 | + * @since 1.0.19 |
|
2857 | + * @param array $value discounts. |
|
2858 | + */ |
|
2859 | + public function set_discounts( $value ) { |
|
2860 | 2860 | |
2861 | - if ( ! is_array( $value ) ) { |
|
2862 | - $value = array(); |
|
2863 | - } |
|
2861 | + if ( ! is_array( $value ) ) { |
|
2862 | + $value = array(); |
|
2863 | + } |
|
2864 | 2864 | |
2865 | - $this->set_prop( 'discounts', $value ); |
|
2865 | + $this->set_prop( 'discounts', $value ); |
|
2866 | 2866 | } |
2867 | 2867 | |
2868 | 2868 | /** |
2869 | - * Set the invoice items. |
|
2870 | - * |
|
2871 | - * @since 1.0.19 |
|
2872 | - * @param GetPaid_Form_Item[] $value items. |
|
2873 | - */ |
|
2874 | - public function set_items( $value ) { |
|
2869 | + * Set the invoice items. |
|
2870 | + * |
|
2871 | + * @since 1.0.19 |
|
2872 | + * @param GetPaid_Form_Item[] $value items. |
|
2873 | + */ |
|
2874 | + public function set_items( $value ) { |
|
2875 | 2875 | |
2876 | 2876 | // Remove existing items. |
2877 | 2877 | $this->set_prop( 'items', array() ); |
2878 | - $this->recurring_item = null; |
|
2878 | + $this->recurring_item = null; |
|
2879 | 2879 | |
2880 | 2880 | // Ensure that we have an array. |
2881 | 2881 | if ( ! is_array( $value ) ) { |
@@ -2889,95 +2889,95 @@ discard block |
||
2889 | 2889 | } |
2890 | 2890 | |
2891 | 2891 | /** |
2892 | - * Set the payment form. |
|
2893 | - * |
|
2894 | - * @since 1.0.19 |
|
2895 | - * @param int $value payment form. |
|
2896 | - */ |
|
2897 | - public function set_payment_form( $value ) { |
|
2898 | - $this->set_prop( 'payment_form', $value ); |
|
2892 | + * Set the payment form. |
|
2893 | + * |
|
2894 | + * @since 1.0.19 |
|
2895 | + * @param int $value payment form. |
|
2896 | + */ |
|
2897 | + public function set_payment_form( $value ) { |
|
2898 | + $this->set_prop( 'payment_form', $value ); |
|
2899 | 2899 | } |
2900 | 2900 | |
2901 | 2901 | /** |
2902 | - * Set the submission id. |
|
2903 | - * |
|
2904 | - * @since 1.0.19 |
|
2905 | - * @param string $value submission id. |
|
2906 | - */ |
|
2907 | - public function set_submission_id( $value ) { |
|
2908 | - $this->set_prop( 'submission_id', $value ); |
|
2902 | + * Set the submission id. |
|
2903 | + * |
|
2904 | + * @since 1.0.19 |
|
2905 | + * @param string $value submission id. |
|
2906 | + */ |
|
2907 | + public function set_submission_id( $value ) { |
|
2908 | + $this->set_prop( 'submission_id', $value ); |
|
2909 | 2909 | } |
2910 | 2910 | |
2911 | 2911 | /** |
2912 | - * Set the discount code. |
|
2913 | - * |
|
2914 | - * @since 1.0.19 |
|
2915 | - * @param string $value discount code. |
|
2916 | - */ |
|
2917 | - public function set_discount_code( $value ) { |
|
2918 | - $this->set_prop( 'discount_code', sanitize_text_field( $value ) ); |
|
2912 | + * Set the discount code. |
|
2913 | + * |
|
2914 | + * @since 1.0.19 |
|
2915 | + * @param string $value discount code. |
|
2916 | + */ |
|
2917 | + public function set_discount_code( $value ) { |
|
2918 | + $this->set_prop( 'discount_code', sanitize_text_field( $value ) ); |
|
2919 | 2919 | } |
2920 | 2920 | |
2921 | 2921 | /** |
2922 | - * Set the gateway. |
|
2923 | - * |
|
2924 | - * @since 1.0.19 |
|
2925 | - * @param string $value gateway. |
|
2926 | - */ |
|
2927 | - public function set_gateway( $value ) { |
|
2928 | - $this->set_prop( 'gateway', $value ); |
|
2922 | + * Set the gateway. |
|
2923 | + * |
|
2924 | + * @since 1.0.19 |
|
2925 | + * @param string $value gateway. |
|
2926 | + */ |
|
2927 | + public function set_gateway( $value ) { |
|
2928 | + $this->set_prop( 'gateway', $value ); |
|
2929 | 2929 | } |
2930 | 2930 | |
2931 | 2931 | /** |
2932 | - * Set the transaction id. |
|
2933 | - * |
|
2934 | - * @since 1.0.19 |
|
2935 | - * @param string $value transaction id. |
|
2936 | - */ |
|
2937 | - public function set_transaction_id( $value ) { |
|
2938 | - if ( ! empty( $value ) ) { |
|
2939 | - $this->set_prop( 'transaction_id', $value ); |
|
2940 | - } |
|
2932 | + * Set the transaction id. |
|
2933 | + * |
|
2934 | + * @since 1.0.19 |
|
2935 | + * @param string $value transaction id. |
|
2936 | + */ |
|
2937 | + public function set_transaction_id( $value ) { |
|
2938 | + if ( ! empty( $value ) ) { |
|
2939 | + $this->set_prop( 'transaction_id', $value ); |
|
2940 | + } |
|
2941 | 2941 | } |
2942 | 2942 | |
2943 | 2943 | /** |
2944 | - * Set the currency id. |
|
2945 | - * |
|
2946 | - * @since 1.0.19 |
|
2947 | - * @param string $value currency id. |
|
2948 | - */ |
|
2949 | - public function set_currency( $value ) { |
|
2950 | - $this->set_prop( 'currency', $value ); |
|
2944 | + * Set the currency id. |
|
2945 | + * |
|
2946 | + * @since 1.0.19 |
|
2947 | + * @param string $value currency id. |
|
2948 | + */ |
|
2949 | + public function set_currency( $value ) { |
|
2950 | + $this->set_prop( 'currency', $value ); |
|
2951 | 2951 | } |
2952 | 2952 | |
2953 | - /** |
|
2954 | - * Set whether to disable taxes. |
|
2955 | - * |
|
2956 | - * @since 1.0.19 |
|
2957 | - * @param bool $value value. |
|
2958 | - */ |
|
2959 | - public function set_disable_taxes( $value ) { |
|
2960 | - $this->set_prop( 'disable_taxes', (bool) $value ); |
|
2961 | - } |
|
2953 | + /** |
|
2954 | + * Set whether to disable taxes. |
|
2955 | + * |
|
2956 | + * @since 1.0.19 |
|
2957 | + * @param bool $value value. |
|
2958 | + */ |
|
2959 | + public function set_disable_taxes( $value ) { |
|
2960 | + $this->set_prop( 'disable_taxes', (bool) $value ); |
|
2961 | + } |
|
2962 | 2962 | |
2963 | 2963 | /** |
2964 | - * Set the subscription id. |
|
2965 | - * |
|
2966 | - * @since 1.0.19 |
|
2967 | - * @param string $value subscription id. |
|
2968 | - */ |
|
2969 | - public function set_subscription_id( $value ) { |
|
2970 | - $this->set_prop( 'subscription_id', $value ); |
|
2971 | - } |
|
2964 | + * Set the subscription id. |
|
2965 | + * |
|
2966 | + * @since 1.0.19 |
|
2967 | + * @param string $value subscription id. |
|
2968 | + */ |
|
2969 | + public function set_subscription_id( $value ) { |
|
2970 | + $this->set_prop( 'subscription_id', $value ); |
|
2971 | + } |
|
2972 | 2972 | |
2973 | - /** |
|
2974 | - * Set the remote subscription id. |
|
2975 | - * |
|
2976 | - * @since 1.0.19 |
|
2977 | - * @param string $value subscription id. |
|
2978 | - */ |
|
2979 | - public function set_remote_subscription_id( $value ) { |
|
2980 | - $this->set_prop( 'remote_subscription_id', $value ); |
|
2973 | + /** |
|
2974 | + * Set the remote subscription id. |
|
2975 | + * |
|
2976 | + * @since 1.0.19 |
|
2977 | + * @param string $value subscription id. |
|
2978 | + */ |
|
2979 | + public function set_remote_subscription_id( $value ) { |
|
2980 | + $this->set_prop( 'remote_subscription_id', $value ); |
|
2981 | 2981 | } |
2982 | 2982 | |
2983 | 2983 | /* |
@@ -3016,24 +3016,24 @@ discard block |
||
3016 | 3016 | */ |
3017 | 3017 | public function is_taxable() { |
3018 | 3018 | return ! $this->get_disable_taxes(); |
3019 | - } |
|
3019 | + } |
|
3020 | 3020 | |
3021 | - /** |
|
3022 | - * @deprecated |
|
3023 | - */ |
|
3024 | - public function has_vat() { |
|
3021 | + /** |
|
3022 | + * @deprecated |
|
3023 | + */ |
|
3024 | + public function has_vat() { |
|
3025 | 3025 | return $this->is_taxable(); |
3026 | - } |
|
3026 | + } |
|
3027 | 3027 | |
3028 | - /** |
|
3029 | - * Checks to see if the invoice requires payment. |
|
3030 | - */ |
|
3031 | - public function is_free() { |
|
3028 | + /** |
|
3029 | + * Checks to see if the invoice requires payment. |
|
3030 | + */ |
|
3031 | + public function is_free() { |
|
3032 | 3032 | $is_free = ( (float) wpinv_round_amount( $this->get_initial_total() ) == 0 ); |
3033 | 3033 | |
3034 | - if ( $this->is_recurring() && $this->get_recurring_total() > 0 ) { |
|
3035 | - $is_free = false; |
|
3036 | - } |
|
3034 | + if ( $this->is_recurring() && $this->get_recurring_total() > 0 ) { |
|
3035 | + $is_free = false; |
|
3036 | + } |
|
3037 | 3037 | |
3038 | 3038 | return apply_filters( 'wpinv_invoice_is_free', $is_free, $this ); |
3039 | 3039 | } |
@@ -3044,46 +3044,46 @@ discard block |
||
3044 | 3044 | public function is_paid() { |
3045 | 3045 | $is_paid = $this->has_status( array( 'publish', 'wpi-processing', 'wpi-renewal' ) ); |
3046 | 3046 | return apply_filters( 'wpinv_invoice_is_paid', $is_paid, $this ); |
3047 | - } |
|
3047 | + } |
|
3048 | 3048 | |
3049 | - /** |
|
3049 | + /** |
|
3050 | 3050 | * Checks if the invoice needs payment. |
3051 | 3051 | */ |
3052 | - public function needs_payment() { |
|
3053 | - $needs_payment = ! $this->is_paid() && ! $this->is_refunded() && ! $this->is_free(); |
|
3052 | + public function needs_payment() { |
|
3053 | + $needs_payment = ! $this->is_paid() && ! $this->is_refunded() && ! $this->is_free(); |
|
3054 | 3054 | return apply_filters( 'wpinv_needs_payment', $needs_payment, $this ); |
3055 | 3055 | } |
3056 | 3056 | |
3057 | - /** |
|
3057 | + /** |
|
3058 | 3058 | * Checks if the invoice is refunded. |
3059 | 3059 | */ |
3060 | - public function is_refunded() { |
|
3060 | + public function is_refunded() { |
|
3061 | 3061 | $is_refunded = $this->has_status( 'wpi-refunded' ); |
3062 | 3062 | return apply_filters( 'wpinv_invoice_is_refunded', $is_refunded, $this ); |
3063 | - } |
|
3063 | + } |
|
3064 | 3064 | |
3065 | - /** |
|
3065 | + /** |
|
3066 | 3066 | * Checks if the invoice is held. |
3067 | 3067 | */ |
3068 | - public function is_held() { |
|
3068 | + public function is_held() { |
|
3069 | 3069 | $is_held = $this->has_status( 'wpi-onhold' ); |
3070 | 3070 | return apply_filters( 'wpinv_invoice_is_held', $is_held, $this ); |
3071 | - } |
|
3071 | + } |
|
3072 | 3072 | |
3073 | - /** |
|
3073 | + /** |
|
3074 | 3074 | * Checks if the invoice is due. |
3075 | 3075 | */ |
3076 | - public function is_due() { |
|
3077 | - $due_date = $this->get_due_date(); |
|
3078 | - return empty( $due_date ) ? false : current_time( 'timestamp' ) > strtotime( $due_date ); |
|
3079 | - } |
|
3076 | + public function is_due() { |
|
3077 | + $due_date = $this->get_due_date(); |
|
3078 | + return empty( $due_date ) ? false : current_time( 'timestamp' ) > strtotime( $due_date ); |
|
3079 | + } |
|
3080 | 3080 | |
3081 | - /** |
|
3081 | + /** |
|
3082 | 3082 | * Checks if the invoice is draft. |
3083 | 3083 | */ |
3084 | - public function is_draft() { |
|
3084 | + public function is_draft() { |
|
3085 | 3085 | return $this->has_status( 'draft, auto-draft' ); |
3086 | - } |
|
3086 | + } |
|
3087 | 3087 | |
3088 | 3088 | /** |
3089 | 3089 | * Checks if the invoice has a given status. |
@@ -3091,9 +3091,9 @@ discard block |
||
3091 | 3091 | public function has_status( $status ) { |
3092 | 3092 | $status = wpinv_parse_list( $status ); |
3093 | 3093 | return apply_filters( 'wpinv_has_status', in_array( $this->get_status(), $status ), $status ); |
3094 | - } |
|
3094 | + } |
|
3095 | 3095 | |
3096 | - /** |
|
3096 | + /** |
|
3097 | 3097 | * Checks if the invoice is of a given type. |
3098 | 3098 | */ |
3099 | 3099 | public function is_type( $type ) { |
@@ -3116,25 +3116,25 @@ discard block |
||
3116 | 3116 | */ |
3117 | 3117 | public function has_free_trial() { |
3118 | 3118 | return $this->is_recurring() && 0 == $this->get_initial_total(); |
3119 | - } |
|
3119 | + } |
|
3120 | 3120 | |
3121 | - /** |
|
3121 | + /** |
|
3122 | 3122 | * @deprecated |
3123 | 3123 | */ |
3124 | 3124 | public function is_free_trial() { |
3125 | 3125 | $this->has_free_trial(); |
3126 | 3126 | } |
3127 | 3127 | |
3128 | - /** |
|
3128 | + /** |
|
3129 | 3129 | * Check if the initial payment if 0. |
3130 | 3130 | * |
3131 | 3131 | */ |
3132 | - public function is_initial_free() { |
|
3132 | + public function is_initial_free() { |
|
3133 | 3133 | $is_initial_free = ! ( (float) wpinv_round_amount( $this->get_initial_total() ) > 0 ); |
3134 | 3134 | return apply_filters( 'wpinv_invoice_is_initial_free', $is_initial_free, $this->get_cart_details(), $this ); |
3135 | 3135 | } |
3136 | 3136 | |
3137 | - /** |
|
3137 | + /** |
|
3138 | 3138 | * Check if the recurring item has a free trial. |
3139 | 3139 | * |
3140 | 3140 | */ |
@@ -3147,21 +3147,21 @@ discard block |
||
3147 | 3147 | |
3148 | 3148 | $item = $this->get_recurring( true ); |
3149 | 3149 | return $item->has_free_trial(); |
3150 | - } |
|
3150 | + } |
|
3151 | 3151 | |
3152 | - /** |
|
3152 | + /** |
|
3153 | 3153 | * Check if the free trial is a result of a discount. |
3154 | 3154 | */ |
3155 | 3155 | public function is_free_trial_from_discount() { |
3156 | - return $this->has_free_trial() && ! $this->item_has_free_trial(); |
|
3157 | - } |
|
3156 | + return $this->has_free_trial() && ! $this->item_has_free_trial(); |
|
3157 | + } |
|
3158 | 3158 | |
3159 | - /** |
|
3159 | + /** |
|
3160 | 3160 | * @deprecated |
3161 | 3161 | */ |
3162 | 3162 | public function discount_first_payment_only() { |
3163 | 3163 | |
3164 | - $discount = wpinv_get_discount_obj( $this->get_discount_code() ); |
|
3164 | + $discount = wpinv_get_discount_obj( $this->get_discount_code() ); |
|
3165 | 3165 | if ( ! $discount->exists() || ! $this->is_recurring() ) { |
3166 | 3166 | return true; |
3167 | 3167 | } |
@@ -3186,149 +3186,149 @@ discard block |
||
3186 | 3186 | */ |
3187 | 3187 | public function add_item( $item ) { |
3188 | 3188 | |
3189 | - if ( is_array( $item ) ) { |
|
3190 | - $item = $this->process_array_item( $item ); |
|
3191 | - } |
|
3189 | + if ( is_array( $item ) ) { |
|
3190 | + $item = $this->process_array_item( $item ); |
|
3191 | + } |
|
3192 | 3192 | |
3193 | - if ( is_numeric( $item ) ) { |
|
3194 | - $item = new GetPaid_Form_Item( $item ); |
|
3195 | - } |
|
3193 | + if ( is_numeric( $item ) ) { |
|
3194 | + $item = new GetPaid_Form_Item( $item ); |
|
3195 | + } |
|
3196 | 3196 | |
3197 | 3197 | // Make sure that it is available for purchase. |
3198 | - if ( $item->get_id() > 0 && ! $item->can_purchase() ) { |
|
3199 | - return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) ); |
|
3198 | + if ( $item->get_id() > 0 && ! $item->can_purchase() ) { |
|
3199 | + return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) ); |
|
3200 | 3200 | } |
3201 | 3201 | |
3202 | 3202 | // Do we have a recurring item? |
3203 | - if ( $item->is_recurring() ) { |
|
3203 | + if ( $item->is_recurring() ) { |
|
3204 | 3204 | |
3205 | - // An invoice can only contain one recurring item. |
|
3206 | - if ( ! empty( $this->recurring_item ) && $this->recurring_item != (int) $item->get_id() ) { |
|
3207 | - return new WP_Error( 'recurring_item', __( 'An invoice can only contain one recurring item', 'invoicing' ) ); |
|
3208 | - } |
|
3205 | + // An invoice can only contain one recurring item. |
|
3206 | + if ( ! empty( $this->recurring_item ) && $this->recurring_item != (int) $item->get_id() ) { |
|
3207 | + return new WP_Error( 'recurring_item', __( 'An invoice can only contain one recurring item', 'invoicing' ) ); |
|
3208 | + } |
|
3209 | 3209 | |
3210 | - $this->recurring_item = $item->get_id(); |
|
3210 | + $this->recurring_item = $item->get_id(); |
|
3211 | 3211 | } |
3212 | 3212 | |
3213 | 3213 | // Invoice id. |
3214 | 3214 | $item->invoice_id = (int) $this->get_id(); |
3215 | 3215 | |
3216 | - // Remove duplicates. |
|
3217 | - $this->remove_item( $item->get_id() ); |
|
3216 | + // Remove duplicates. |
|
3217 | + $this->remove_item( $item->get_id() ); |
|
3218 | 3218 | |
3219 | - // Retrieve all items. |
|
3219 | + // Retrieve all items. |
|
3220 | 3220 | $items = $this->get_items(); |
3221 | 3221 | |
3222 | - // Add new item. |
|
3222 | + // Add new item. |
|
3223 | 3223 | $items[] = $item; |
3224 | 3224 | |
3225 | 3225 | $this->set_prop( 'items', $items ); |
3226 | 3226 | |
3227 | - return true; |
|
3228 | - } |
|
3227 | + return true; |
|
3228 | + } |
|
3229 | 3229 | |
3230 | - /** |
|
3231 | - * Converts an array to an item. |
|
3232 | - * |
|
3233 | - * @since 1.0.19 |
|
3234 | - * @return GetPaid_Form_Item |
|
3235 | - */ |
|
3236 | - protected function process_array_item( $array ) { |
|
3230 | + /** |
|
3231 | + * Converts an array to an item. |
|
3232 | + * |
|
3233 | + * @since 1.0.19 |
|
3234 | + * @return GetPaid_Form_Item |
|
3235 | + */ |
|
3236 | + protected function process_array_item( $array ) { |
|
3237 | 3237 | |
3238 | - $item_id = isset( $array['item_id'] ) ? $array['item_id'] : 0; |
|
3239 | - $item = new GetPaid_Form_Item( $item_id ); |
|
3238 | + $item_id = isset( $array['item_id'] ) ? $array['item_id'] : 0; |
|
3239 | + $item = new GetPaid_Form_Item( $item_id ); |
|
3240 | 3240 | |
3241 | - // Set item data. |
|
3242 | - foreach ( array( 'name', 'price', 'description' ) as $key ) { |
|
3243 | - if ( isset( $array[ "item_$key" ] ) ) { |
|
3244 | - $method = "set_$key"; |
|
3245 | - $item->$method( $array[ "item_$key" ] ); |
|
3246 | - } |
|
3247 | - } |
|
3241 | + // Set item data. |
|
3242 | + foreach ( array( 'name', 'price', 'description' ) as $key ) { |
|
3243 | + if ( isset( $array[ "item_$key" ] ) ) { |
|
3244 | + $method = "set_$key"; |
|
3245 | + $item->$method( $array[ "item_$key" ] ); |
|
3246 | + } |
|
3247 | + } |
|
3248 | 3248 | |
3249 | - if ( isset( $array['quantity'] ) ) { |
|
3250 | - $item->set_quantity( $array['quantity'] ); |
|
3251 | - } |
|
3249 | + if ( isset( $array['quantity'] ) ) { |
|
3250 | + $item->set_quantity( $array['quantity'] ); |
|
3251 | + } |
|
3252 | 3252 | |
3253 | - // Set item meta. |
|
3254 | - if ( isset( $array['meta'] ) && is_array( $array['meta'] ) ) { |
|
3255 | - $item->set_item_meta( $array['meta'] ); |
|
3256 | - } |
|
3253 | + // Set item meta. |
|
3254 | + if ( isset( $array['meta'] ) && is_array( $array['meta'] ) ) { |
|
3255 | + $item->set_item_meta( $array['meta'] ); |
|
3256 | + } |
|
3257 | 3257 | |
3258 | - return $item; |
|
3258 | + return $item; |
|
3259 | 3259 | |
3260 | - } |
|
3260 | + } |
|
3261 | 3261 | |
3262 | 3262 | /** |
3263 | - * Retrieves a specific item. |
|
3264 | - * |
|
3265 | - * @since 1.0.19 |
|
3266 | - * @return GetPaid_Form_Item|null |
|
3267 | - */ |
|
3268 | - public function get_item( $item_id ) { |
|
3263 | + * Retrieves a specific item. |
|
3264 | + * |
|
3265 | + * @since 1.0.19 |
|
3266 | + * @return GetPaid_Form_Item|null |
|
3267 | + */ |
|
3268 | + public function get_item( $item_id ) { |
|
3269 | 3269 | |
3270 | - foreach ( $this->get_items() as $item ) { |
|
3271 | - if ( (int) $item_id == $item->get_id() ) { |
|
3272 | - return $item; |
|
3273 | - } |
|
3274 | - } |
|
3270 | + foreach ( $this->get_items() as $item ) { |
|
3271 | + if ( (int) $item_id == $item->get_id() ) { |
|
3272 | + return $item; |
|
3273 | + } |
|
3274 | + } |
|
3275 | 3275 | |
3276 | - return null; |
|
3276 | + return null; |
|
3277 | 3277 | } |
3278 | 3278 | |
3279 | 3279 | /** |
3280 | - * Removes a specific item. |
|
3281 | - * |
|
3282 | - * @since 1.0.19 |
|
3283 | - */ |
|
3284 | - public function remove_item( $item_id ) { |
|
3285 | - $items = $this->get_items(); |
|
3286 | - $item_id = (int) $item_id; |
|
3280 | + * Removes a specific item. |
|
3281 | + * |
|
3282 | + * @since 1.0.19 |
|
3283 | + */ |
|
3284 | + public function remove_item( $item_id ) { |
|
3285 | + $items = $this->get_items(); |
|
3286 | + $item_id = (int) $item_id; |
|
3287 | 3287 | |
3288 | - foreach ( $items as $index => $item ) { |
|
3289 | - if ( (int) $item_id == $item->get_id() ) { |
|
3290 | - unset( $items[ $index ] ); |
|
3291 | - $this->set_prop( 'items', $items ); |
|
3288 | + foreach ( $items as $index => $item ) { |
|
3289 | + if ( (int) $item_id == $item->get_id() ) { |
|
3290 | + unset( $items[ $index ] ); |
|
3291 | + $this->set_prop( 'items', $items ); |
|
3292 | 3292 | |
3293 | - if ( $item_id == $this->recurring_item ) { |
|
3294 | - $this->recurring_item = null; |
|
3295 | - } |
|
3293 | + if ( $item_id == $this->recurring_item ) { |
|
3294 | + $this->recurring_item = null; |
|
3295 | + } |
|
3296 | 3296 | |
3297 | - } |
|
3298 | - } |
|
3297 | + } |
|
3298 | + } |
|
3299 | 3299 | |
3300 | 3300 | } |
3301 | 3301 | |
3302 | 3302 | /** |
3303 | - * Adds a fee to the invoice. |
|
3304 | - * |
|
3305 | - * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
3306 | - * @since 1.0.19 |
|
3307 | - */ |
|
3303 | + * Adds a fee to the invoice. |
|
3304 | + * |
|
3305 | + * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
3306 | + * @since 1.0.19 |
|
3307 | + */ |
|
3308 | 3308 | public function add_fee( $fee ) { |
3309 | 3309 | |
3310 | - $fees = $this->get_fees(); |
|
3311 | - $fees[ $fee['name'] ] = $fee; |
|
3312 | - $this->set_prop( 'fees', $fees ); |
|
3310 | + $fees = $this->get_fees(); |
|
3311 | + $fees[ $fee['name'] ] = $fee; |
|
3312 | + $this->set_prop( 'fees', $fees ); |
|
3313 | 3313 | |
3314 | 3314 | } |
3315 | 3315 | |
3316 | 3316 | /** |
3317 | - * Retrieves a specific fee. |
|
3318 | - * |
|
3319 | - * @since 1.0.19 |
|
3320 | - */ |
|
3321 | - public function get_fee( $fee ) { |
|
3317 | + * Retrieves a specific fee. |
|
3318 | + * |
|
3319 | + * @since 1.0.19 |
|
3320 | + */ |
|
3321 | + public function get_fee( $fee ) { |
|
3322 | 3322 | $fees = $this->get_fees(); |
3323 | - return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null; |
|
3323 | + return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null; |
|
3324 | 3324 | } |
3325 | 3325 | |
3326 | 3326 | /** |
3327 | - * Removes a specific fee. |
|
3328 | - * |
|
3329 | - * @since 1.0.19 |
|
3330 | - */ |
|
3331 | - public function remove_fee( $fee ) { |
|
3327 | + * Removes a specific fee. |
|
3328 | + * |
|
3329 | + * @since 1.0.19 |
|
3330 | + */ |
|
3331 | + public function remove_fee( $fee ) { |
|
3332 | 3332 | $fees = $this->get_fees(); |
3333 | 3333 | if ( isset( $fees[ $fee ] ) ) { |
3334 | 3334 | unset( $fees[ $fee ] ); |
@@ -3336,55 +3336,55 @@ discard block |
||
3336 | 3336 | } |
3337 | 3337 | } |
3338 | 3338 | |
3339 | - /** |
|
3340 | - * Adds a discount to the invoice. |
|
3341 | - * |
|
3342 | - * @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. |
|
3343 | - * @since 1.0.19 |
|
3344 | - */ |
|
3345 | - public function add_discount( $discount ) { |
|
3339 | + /** |
|
3340 | + * Adds a discount to the invoice. |
|
3341 | + * |
|
3342 | + * @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. |
|
3343 | + * @since 1.0.19 |
|
3344 | + */ |
|
3345 | + public function add_discount( $discount ) { |
|
3346 | 3346 | |
3347 | - $discounts = $this->get_discounts(); |
|
3348 | - $discounts[ $discount['name'] ] = $discount; |
|
3349 | - $this->set_prop( 'discounts', $discounts ); |
|
3347 | + $discounts = $this->get_discounts(); |
|
3348 | + $discounts[ $discount['name'] ] = $discount; |
|
3349 | + $this->set_prop( 'discounts', $discounts ); |
|
3350 | 3350 | |
3351 | - } |
|
3351 | + } |
|
3352 | 3352 | |
3353 | 3353 | /** |
3354 | - * Retrieves a specific discount. |
|
3355 | - * |
|
3356 | - * @since 1.0.19 |
|
3357 | - * @return float |
|
3358 | - */ |
|
3359 | - public function get_discount( $discount = false ) { |
|
3354 | + * Retrieves a specific discount. |
|
3355 | + * |
|
3356 | + * @since 1.0.19 |
|
3357 | + * @return float |
|
3358 | + */ |
|
3359 | + public function get_discount( $discount = false ) { |
|
3360 | 3360 | |
3361 | - // Backwards compatibilty. |
|
3362 | - if ( empty( $discount ) ) { |
|
3363 | - return $this->get_total_discount(); |
|
3364 | - } |
|
3361 | + // Backwards compatibilty. |
|
3362 | + if ( empty( $discount ) ) { |
|
3363 | + return $this->get_total_discount(); |
|
3364 | + } |
|
3365 | 3365 | |
3366 | 3366 | $discounts = $this->get_discounts(); |
3367 | - return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null; |
|
3367 | + return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null; |
|
3368 | 3368 | } |
3369 | 3369 | |
3370 | 3370 | /** |
3371 | - * Removes a specific discount. |
|
3372 | - * |
|
3373 | - * @since 1.0.19 |
|
3374 | - */ |
|
3375 | - public function remove_discount( $discount ) { |
|
3371 | + * Removes a specific discount. |
|
3372 | + * |
|
3373 | + * @since 1.0.19 |
|
3374 | + */ |
|
3375 | + public function remove_discount( $discount ) { |
|
3376 | 3376 | $discounts = $this->get_discounts(); |
3377 | 3377 | if ( isset( $discounts[ $discount ] ) ) { |
3378 | 3378 | unset( $discounts[ $discount ] ); |
3379 | 3379 | $this->set_prop( 'discounts', $discounts ); |
3380 | 3380 | } |
3381 | 3381 | |
3382 | - if ( 'discount_code' == $discount ) { |
|
3383 | - foreach ( $this->get_items() as $item ) { |
|
3384 | - $item->item_discount = 0; |
|
3385 | - $item->recurring_item_discount = 0; |
|
3386 | - } |
|
3387 | - } |
|
3382 | + if ( 'discount_code' == $discount ) { |
|
3383 | + foreach ( $this->get_items() as $item ) { |
|
3384 | + $item->item_discount = 0; |
|
3385 | + $item->recurring_item_discount = 0; |
|
3386 | + } |
|
3387 | + } |
|
3388 | 3388 | |
3389 | 3389 | } |
3390 | 3390 | |
@@ -3397,34 +3397,34 @@ discard block |
||
3397 | 3397 | if ( $this->is_taxable() ) { |
3398 | 3398 | |
3399 | 3399 | $taxes = $this->get_taxes(); |
3400 | - $taxes[ $tax['name'] ] = $tax; |
|
3401 | - $this->set_prop( 'taxes', $tax ); |
|
3400 | + $taxes[ $tax['name'] ] = $tax; |
|
3401 | + $this->set_prop( 'taxes', $tax ); |
|
3402 | 3402 | |
3403 | 3403 | } |
3404 | 3404 | } |
3405 | 3405 | |
3406 | 3406 | /** |
3407 | - * Retrieves a specific tax. |
|
3408 | - * |
|
3409 | - * @since 1.0.19 |
|
3410 | - */ |
|
3411 | - public function get_tax( $tax = null ) { |
|
3407 | + * Retrieves a specific tax. |
|
3408 | + * |
|
3409 | + * @since 1.0.19 |
|
3410 | + */ |
|
3411 | + public function get_tax( $tax = null ) { |
|
3412 | 3412 | |
3413 | - // Backwards compatility. |
|
3414 | - if ( empty( $tax ) ) { |
|
3415 | - return $this->get_total_tax(); |
|
3416 | - } |
|
3413 | + // Backwards compatility. |
|
3414 | + if ( empty( $tax ) ) { |
|
3415 | + return $this->get_total_tax(); |
|
3416 | + } |
|
3417 | 3417 | |
3418 | 3418 | $taxes = $this->get_taxes(); |
3419 | - return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null; |
|
3419 | + return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null; |
|
3420 | 3420 | } |
3421 | 3421 | |
3422 | 3422 | /** |
3423 | - * Removes a specific tax. |
|
3424 | - * |
|
3425 | - * @since 1.0.19 |
|
3426 | - */ |
|
3427 | - public function remove_tax( $tax ) { |
|
3423 | + * Removes a specific tax. |
|
3424 | + * |
|
3425 | + * @since 1.0.19 |
|
3426 | + */ |
|
3427 | + public function remove_tax( $tax ) { |
|
3428 | 3428 | $taxes = $this->get_taxes(); |
3429 | 3429 | if ( isset( $taxes[ $tax ] ) ) { |
3430 | 3430 | unset( $taxes[ $tax ] ); |
@@ -3433,183 +3433,183 @@ discard block |
||
3433 | 3433 | } |
3434 | 3434 | |
3435 | 3435 | /** |
3436 | - * Recalculates the invoice subtotal. |
|
3437 | - * |
|
3438 | - * @since 1.0.19 |
|
3439 | - * @return float The recalculated subtotal |
|
3440 | - */ |
|
3441 | - public function recalculate_subtotal() { |
|
3436 | + * Recalculates the invoice subtotal. |
|
3437 | + * |
|
3438 | + * @since 1.0.19 |
|
3439 | + * @return float The recalculated subtotal |
|
3440 | + */ |
|
3441 | + public function recalculate_subtotal() { |
|
3442 | 3442 | $items = $this->get_items(); |
3443 | - $subtotal = 0; |
|
3444 | - $recurring = 0; |
|
3443 | + $subtotal = 0; |
|
3444 | + $recurring = 0; |
|
3445 | 3445 | |
3446 | 3446 | foreach ( $items as $item ) { |
3447 | - $subtotal += $item->get_sub_total(); |
|
3448 | - $recurring += $item->get_recurring_sub_total(); |
|
3447 | + $subtotal += $item->get_sub_total(); |
|
3448 | + $recurring += $item->get_recurring_sub_total(); |
|
3449 | 3449 | } |
3450 | 3450 | |
3451 | - if ( wpinv_prices_include_tax() ) { |
|
3452 | - $subtotal = max( 0, $subtotal - $this->totals['tax']['initial'] ); |
|
3453 | - $recurring = max( 0, $recurring - $this->totals['tax']['recurring'] ); |
|
3454 | - } |
|
3451 | + if ( wpinv_prices_include_tax() ) { |
|
3452 | + $subtotal = max( 0, $subtotal - $this->totals['tax']['initial'] ); |
|
3453 | + $recurring = max( 0, $recurring - $this->totals['tax']['recurring'] ); |
|
3454 | + } |
|
3455 | 3455 | |
3456 | - $current = $this->is_renewal() ? $recurring : $subtotal; |
|
3457 | - $this->set_subtotal( $current ); |
|
3456 | + $current = $this->is_renewal() ? $recurring : $subtotal; |
|
3457 | + $this->set_subtotal( $current ); |
|
3458 | 3458 | |
3459 | - $this->totals['subtotal'] = array( |
|
3460 | - 'initial' => $subtotal, |
|
3461 | - 'recurring' => $recurring, |
|
3462 | - ); |
|
3459 | + $this->totals['subtotal'] = array( |
|
3460 | + 'initial' => $subtotal, |
|
3461 | + 'recurring' => $recurring, |
|
3462 | + ); |
|
3463 | 3463 | |
3464 | 3464 | return $current; |
3465 | 3465 | } |
3466 | 3466 | |
3467 | 3467 | /** |
3468 | - * Recalculates the invoice discount total. |
|
3469 | - * |
|
3470 | - * @since 1.0.19 |
|
3471 | - * @return float The recalculated discount |
|
3472 | - */ |
|
3473 | - public function recalculate_total_discount() { |
|
3468 | + * Recalculates the invoice discount total. |
|
3469 | + * |
|
3470 | + * @since 1.0.19 |
|
3471 | + * @return float The recalculated discount |
|
3472 | + */ |
|
3473 | + public function recalculate_total_discount() { |
|
3474 | 3474 | $discounts = $this->get_discounts(); |
3475 | - $discount = 0; |
|
3476 | - $recurring = 0; |
|
3475 | + $discount = 0; |
|
3476 | + $recurring = 0; |
|
3477 | 3477 | |
3478 | 3478 | foreach ( $discounts as $data ) { |
3479 | - $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
3480 | - $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
3481 | - } |
|
3479 | + $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
3480 | + $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
3481 | + } |
|
3482 | 3482 | |
3483 | - $current = $this->is_renewal() ? $recurring : $discount; |
|
3483 | + $current = $this->is_renewal() ? $recurring : $discount; |
|
3484 | 3484 | |
3485 | - $this->set_total_discount( $current ); |
|
3485 | + $this->set_total_discount( $current ); |
|
3486 | 3486 | |
3487 | - $this->totals['discount'] = array( |
|
3488 | - 'initial' => $discount, |
|
3489 | - 'recurring' => $recurring, |
|
3490 | - ); |
|
3487 | + $this->totals['discount'] = array( |
|
3488 | + 'initial' => $discount, |
|
3489 | + 'recurring' => $recurring, |
|
3490 | + ); |
|
3491 | 3491 | |
3492 | - return $current; |
|
3492 | + return $current; |
|
3493 | 3493 | |
3494 | 3494 | } |
3495 | 3495 | |
3496 | 3496 | /** |
3497 | - * Recalculates the invoice tax total. |
|
3498 | - * |
|
3499 | - * @since 1.0.19 |
|
3500 | - * @return float The recalculated tax |
|
3501 | - */ |
|
3502 | - public function recalculate_total_tax() { |
|
3497 | + * Recalculates the invoice tax total. |
|
3498 | + * |
|
3499 | + * @since 1.0.19 |
|
3500 | + * @return float The recalculated tax |
|
3501 | + */ |
|
3502 | + public function recalculate_total_tax() { |
|
3503 | 3503 | |
3504 | - // Maybe disable taxes. |
|
3505 | - $vat_number = $this->get_vat_number(); |
|
3506 | - $skip_tax = GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $this->get_country() ) && ! empty( $vat_number ); |
|
3504 | + // Maybe disable taxes. |
|
3505 | + $vat_number = $this->get_vat_number(); |
|
3506 | + $skip_tax = GetPaid_Payment_Form_Submission_Taxes::is_eu_transaction( $this->get_country() ) && ! empty( $vat_number ); |
|
3507 | 3507 | |
3508 | - if ( wpinv_is_base_country( $this->get_country() ) && 'vat_too' == wpinv_get_option( 'vat_same_country_rule', 'vat_too' ) ) { |
|
3509 | - $skip_tax = false; |
|
3510 | - } |
|
3508 | + if ( wpinv_is_base_country( $this->get_country() ) && 'vat_too' == wpinv_get_option( 'vat_same_country_rule', 'vat_too' ) ) { |
|
3509 | + $skip_tax = false; |
|
3510 | + } |
|
3511 | 3511 | |
3512 | - if ( ! wpinv_use_taxes() || $this->get_disable_taxes() || ! wpinv_is_country_taxable( $this->get_country() ) || $skip_tax ) { |
|
3512 | + if ( ! wpinv_use_taxes() || $this->get_disable_taxes() || ! wpinv_is_country_taxable( $this->get_country() ) || $skip_tax ) { |
|
3513 | 3513 | |
3514 | - $this->totals['tax'] = array( |
|
3515 | - 'initial' => 0, |
|
3516 | - 'recurring' => 0, |
|
3517 | - ); |
|
3514 | + $this->totals['tax'] = array( |
|
3515 | + 'initial' => 0, |
|
3516 | + 'recurring' => 0, |
|
3517 | + ); |
|
3518 | 3518 | |
3519 | - $this->set_taxes( array() ); |
|
3520 | - $current = 0; |
|
3521 | - } else { |
|
3519 | + $this->set_taxes( array() ); |
|
3520 | + $current = 0; |
|
3521 | + } else { |
|
3522 | 3522 | |
3523 | - $item_taxes = array(); |
|
3523 | + $item_taxes = array(); |
|
3524 | 3524 | |
3525 | - foreach ( $this->get_items() as $item ) { |
|
3526 | - $rates = getpaid_get_item_tax_rates( $item, $this->get_country(), $this->get_state() ); |
|
3527 | - $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
3528 | - $taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, false ), $rates ); |
|
3529 | - $r_taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, true ), $rates ); |
|
3530 | - foreach ( $taxes as $name => $amount ) { |
|
3531 | - $recurring = isset( $r_taxes[ $name ] ) ? $r_taxes[ $name ] : 0; |
|
3532 | - $tax = getpaid_prepare_item_tax( $item, $name, $amount, $recurring ); |
|
3525 | + foreach ( $this->get_items() as $item ) { |
|
3526 | + $rates = getpaid_get_item_tax_rates( $item, $this->get_country(), $this->get_state() ); |
|
3527 | + $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
3528 | + $taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, false ), $rates ); |
|
3529 | + $r_taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, true ), $rates ); |
|
3530 | + foreach ( $taxes as $name => $amount ) { |
|
3531 | + $recurring = isset( $r_taxes[ $name ] ) ? $r_taxes[ $name ] : 0; |
|
3532 | + $tax = getpaid_prepare_item_tax( $item, $name, $amount, $recurring ); |
|
3533 | 3533 | |
3534 | - if ( ! isset( $item_taxes[ $name ] ) ) { |
|
3535 | - $item_taxes[ $name ] = $tax; |
|
3536 | - continue; |
|
3537 | - } |
|
3534 | + if ( ! isset( $item_taxes[ $name ] ) ) { |
|
3535 | + $item_taxes[ $name ] = $tax; |
|
3536 | + continue; |
|
3537 | + } |
|
3538 | 3538 | |
3539 | - $item_taxes[ $name ]['initial_tax'] += $tax['initial_tax']; |
|
3540 | - $item_taxes[ $name ]['recurring_tax'] += $tax['recurring_tax']; |
|
3539 | + $item_taxes[ $name ]['initial_tax'] += $tax['initial_tax']; |
|
3540 | + $item_taxes[ $name ]['recurring_tax'] += $tax['recurring_tax']; |
|
3541 | 3541 | |
3542 | - } |
|
3542 | + } |
|
3543 | 3543 | |
3544 | - } |
|
3544 | + } |
|
3545 | 3545 | |
3546 | - $item_taxes = array_replace( $this->get_taxes(), $item_taxes ); |
|
3547 | - $this->set_taxes( $item_taxes ); |
|
3546 | + $item_taxes = array_replace( $this->get_taxes(), $item_taxes ); |
|
3547 | + $this->set_taxes( $item_taxes ); |
|
3548 | 3548 | |
3549 | - $initial_tax = array_sum( wp_list_pluck( $item_taxes, 'initial_tax' ) ); |
|
3550 | - $recurring_tax = array_sum( wp_list_pluck( $item_taxes, 'recurring_tax' ) ); |
|
3549 | + $initial_tax = array_sum( wp_list_pluck( $item_taxes, 'initial_tax' ) ); |
|
3550 | + $recurring_tax = array_sum( wp_list_pluck( $item_taxes, 'recurring_tax' ) ); |
|
3551 | 3551 | |
3552 | - $current = $this->is_renewal() ? $recurring_tax : $initial_tax; |
|
3552 | + $current = $this->is_renewal() ? $recurring_tax : $initial_tax; |
|
3553 | 3553 | |
3554 | - $this->totals['tax'] = array( |
|
3555 | - 'initial' => $initial_tax, |
|
3556 | - 'recurring' => $recurring_tax, |
|
3557 | - ); |
|
3554 | + $this->totals['tax'] = array( |
|
3555 | + 'initial' => $initial_tax, |
|
3556 | + 'recurring' => $recurring_tax, |
|
3557 | + ); |
|
3558 | 3558 | |
3559 | - } |
|
3559 | + } |
|
3560 | 3560 | |
3561 | - $this->set_total_tax( $current ); |
|
3561 | + $this->set_total_tax( $current ); |
|
3562 | 3562 | |
3563 | - return $current; |
|
3563 | + return $current; |
|
3564 | 3564 | |
3565 | 3565 | } |
3566 | 3566 | |
3567 | 3567 | /** |
3568 | - * Recalculates the invoice fees total. |
|
3569 | - * |
|
3570 | - * @since 1.0.19 |
|
3571 | - * @return float The recalculated fee |
|
3572 | - */ |
|
3573 | - public function recalculate_total_fees() { |
|
3574 | - $fees = $this->get_fees(); |
|
3575 | - $fee = 0; |
|
3576 | - $recurring = 0; |
|
3568 | + * Recalculates the invoice fees total. |
|
3569 | + * |
|
3570 | + * @since 1.0.19 |
|
3571 | + * @return float The recalculated fee |
|
3572 | + */ |
|
3573 | + public function recalculate_total_fees() { |
|
3574 | + $fees = $this->get_fees(); |
|
3575 | + $fee = 0; |
|
3576 | + $recurring = 0; |
|
3577 | 3577 | |
3578 | 3578 | foreach ( $fees as $data ) { |
3579 | - $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
3580 | - $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
3581 | - } |
|
3579 | + $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
3580 | + $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
3581 | + } |
|
3582 | 3582 | |
3583 | - $current = $this->is_renewal() ? $recurring : $fee; |
|
3584 | - $this->set_total_fees( $current ); |
|
3583 | + $current = $this->is_renewal() ? $recurring : $fee; |
|
3584 | + $this->set_total_fees( $current ); |
|
3585 | 3585 | |
3586 | - $this->totals['fee'] = array( |
|
3587 | - 'initial' => $fee, |
|
3588 | - 'recurring' => $recurring, |
|
3589 | - ); |
|
3586 | + $this->totals['fee'] = array( |
|
3587 | + 'initial' => $fee, |
|
3588 | + 'recurring' => $recurring, |
|
3589 | + ); |
|
3590 | 3590 | |
3591 | 3591 | $this->set_total_fees( $fee ); |
3592 | 3592 | return $current; |
3593 | 3593 | } |
3594 | 3594 | |
3595 | 3595 | /** |
3596 | - * Recalculates the invoice total. |
|
3597 | - * |
|
3598 | - * @since 1.0.19 |
|
3596 | + * Recalculates the invoice total. |
|
3597 | + * |
|
3598 | + * @since 1.0.19 |
|
3599 | 3599 | * @return float The invoice total |
3600 | - */ |
|
3601 | - public function recalculate_total() { |
|
3600 | + */ |
|
3601 | + public function recalculate_total() { |
|
3602 | 3602 | $this->recalculate_total_fees(); |
3603 | 3603 | $this->recalculate_total_discount(); |
3604 | - $this->recalculate_total_tax(); |
|
3605 | - $this->recalculate_subtotal(); |
|
3606 | - $this->set_total( $this->get_total_tax() + $this->get_total_fees() + $this->get_subtotal() - $this->get_total_discount() ); |
|
3607 | - return $this->get_total(); |
|
3608 | - } |
|
3609 | - |
|
3610 | - /** |
|
3611 | - * @deprecated |
|
3612 | - */ |
|
3604 | + $this->recalculate_total_tax(); |
|
3605 | + $this->recalculate_subtotal(); |
|
3606 | + $this->set_total( $this->get_total_tax() + $this->get_total_fees() + $this->get_subtotal() - $this->get_total_discount() ); |
|
3607 | + return $this->get_total(); |
|
3608 | + } |
|
3609 | + |
|
3610 | + /** |
|
3611 | + * @deprecated |
|
3612 | + */ |
|
3613 | 3613 | public function recalculate_totals() { |
3614 | 3614 | $this->recalculate_total(); |
3615 | 3615 | $this->save( true ); |
@@ -3627,7 +3627,7 @@ discard block |
||
3627 | 3627 | * Adds a note to an invoice. |
3628 | 3628 | * |
3629 | 3629 | * @param string $note The note being added. |
3630 | - * @return int|false The new note's ID on success, false on failure. |
|
3630 | + * @return int|false The new note's ID on success, false on failure. |
|
3631 | 3631 | * |
3632 | 3632 | */ |
3633 | 3633 | public function add_note( $note = '', $customer_type = false, $added_by_user = false, $system = false ) { |
@@ -3637,21 +3637,21 @@ discard block |
||
3637 | 3637 | return false; |
3638 | 3638 | } |
3639 | 3639 | |
3640 | - $author = 'System'; |
|
3641 | - $author_email = '[email protected]'; |
|
3640 | + $author = 'System'; |
|
3641 | + $author_email = '[email protected]'; |
|
3642 | 3642 | |
3643 | - // If this is an admin comment or it has been added by the user. |
|
3644 | - if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
3645 | - $user = get_user_by( 'id', get_current_user_id() ); |
|
3643 | + // If this is an admin comment or it has been added by the user. |
|
3644 | + if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
3645 | + $user = get_user_by( 'id', get_current_user_id() ); |
|
3646 | 3646 | $author = $user->display_name; |
3647 | 3647 | $author_email = $user->user_email; |
3648 | - } |
|
3648 | + } |
|
3649 | 3649 | |
3650 | - return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
3650 | + return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
3651 | 3651 | |
3652 | - } |
|
3652 | + } |
|
3653 | 3653 | |
3654 | - /** |
|
3654 | + /** |
|
3655 | 3655 | * Generates a unique key for the invoice. |
3656 | 3656 | */ |
3657 | 3657 | public function generate_key( $string = '' ) { |
@@ -3671,113 +3671,113 @@ discard block |
||
3671 | 3671 | $number = wpinv_get_next_invoice_number( $this->get_post_type() ); |
3672 | 3672 | } |
3673 | 3673 | |
3674 | - return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
3675 | - |
|
3676 | - } |
|
3677 | - |
|
3678 | - /** |
|
3679 | - * Handle the status transition. |
|
3680 | - */ |
|
3681 | - protected function status_transition() { |
|
3682 | - $status_transition = $this->status_transition; |
|
3683 | - |
|
3684 | - // Reset status transition variable. |
|
3685 | - $this->status_transition = false; |
|
3674 | + return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
3686 | 3675 | |
3687 | - if ( $status_transition ) { |
|
3688 | - try { |
|
3689 | - |
|
3690 | - // Fire a hook for the status change. |
|
3691 | - do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
3692 | - |
|
3693 | - // @deprecated this is deprecated and will be removed in the future. |
|
3694 | - do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3695 | - |
|
3696 | - if ( ! empty( $status_transition['from'] ) ) { |
|
3697 | - |
|
3698 | - /* translators: 1: old invoice status 2: new invoice status */ |
|
3699 | - $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 ) ); |
|
3700 | - |
|
3701 | - // Fire another hook. |
|
3702 | - do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
3703 | - do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
3704 | - |
|
3705 | - // @deprecated this is deprecated and will be removed in the future. |
|
3706 | - do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3707 | - |
|
3708 | - // Note the transition occurred. |
|
3709 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), false, $status_transition['manual'] ); |
|
3710 | - |
|
3711 | - // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
3712 | - if ( |
|
3713 | - in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3714 | - && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3715 | - ) { |
|
3716 | - do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
3717 | - } |
|
3718 | - |
|
3719 | - // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
3720 | - if ( |
|
3721 | - in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3722 | - && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3723 | - ) { |
|
3724 | - do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
3725 | - } |
|
3726 | - } else { |
|
3727 | - /* translators: %s: new invoice status */ |
|
3728 | - $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
3729 | - |
|
3730 | - // Note the transition occurred. |
|
3731 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
3676 | + } |
|
3732 | 3677 | |
3733 | - } |
|
3734 | - } catch ( Exception $e ) { |
|
3735 | - $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
3736 | - } |
|
3737 | - } |
|
3738 | - } |
|
3678 | + /** |
|
3679 | + * Handle the status transition. |
|
3680 | + */ |
|
3681 | + protected function status_transition() { |
|
3682 | + $status_transition = $this->status_transition; |
|
3683 | + |
|
3684 | + // Reset status transition variable. |
|
3685 | + $this->status_transition = false; |
|
3686 | + |
|
3687 | + if ( $status_transition ) { |
|
3688 | + try { |
|
3689 | + |
|
3690 | + // Fire a hook for the status change. |
|
3691 | + do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
3692 | + |
|
3693 | + // @deprecated this is deprecated and will be removed in the future. |
|
3694 | + do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3695 | + |
|
3696 | + if ( ! empty( $status_transition['from'] ) ) { |
|
3697 | + |
|
3698 | + /* translators: 1: old invoice status 2: new invoice status */ |
|
3699 | + $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 ) ); |
|
3700 | + |
|
3701 | + // Fire another hook. |
|
3702 | + do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
3703 | + do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
3704 | + |
|
3705 | + // @deprecated this is deprecated and will be removed in the future. |
|
3706 | + do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
3707 | + |
|
3708 | + // Note the transition occurred. |
|
3709 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), false, $status_transition['manual'] ); |
|
3710 | + |
|
3711 | + // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
3712 | + if ( |
|
3713 | + in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3714 | + && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3715 | + ) { |
|
3716 | + do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
3717 | + } |
|
3718 | + |
|
3719 | + // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
3720 | + if ( |
|
3721 | + in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
3722 | + && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
3723 | + ) { |
|
3724 | + do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
3725 | + } |
|
3726 | + } else { |
|
3727 | + /* translators: %s: new invoice status */ |
|
3728 | + $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'], $this ) ); |
|
3729 | + |
|
3730 | + // Note the transition occurred. |
|
3731 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
3732 | + |
|
3733 | + } |
|
3734 | + } catch ( Exception $e ) { |
|
3735 | + $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
3736 | + } |
|
3737 | + } |
|
3738 | + } |
|
3739 | 3739 | |
3740 | - /** |
|
3741 | - * Updates an invoice status. |
|
3742 | - */ |
|
3743 | - public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
3740 | + /** |
|
3741 | + * Updates an invoice status. |
|
3742 | + */ |
|
3743 | + public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
3744 | 3744 | |
3745 | - // Fires before updating a status. |
|
3746 | - do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
3745 | + // Fires before updating a status. |
|
3746 | + do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
3747 | 3747 | |
3748 | - // Update the status. |
|
3749 | - $this->set_status( $new_status, $note, $manual ); |
|
3748 | + // Update the status. |
|
3749 | + $this->set_status( $new_status, $note, $manual ); |
|
3750 | 3750 | |
3751 | - // Save the order. |
|
3752 | - return $this->save(); |
|
3751 | + // Save the order. |
|
3752 | + return $this->save(); |
|
3753 | 3753 | |
3754 | - } |
|
3754 | + } |
|
3755 | 3755 | |
3756 | - /** |
|
3757 | - * @deprecated |
|
3758 | - */ |
|
3759 | - public function refresh_item_ids() { |
|
3756 | + /** |
|
3757 | + * @deprecated |
|
3758 | + */ |
|
3759 | + public function refresh_item_ids() { |
|
3760 | 3760 | $item_ids = implode( ',', array_unique( wp_list_pluck( $this->get_cart_details(), 'item_id' ) ) ); |
3761 | 3761 | update_post_meta( $this->get_id(), '_wpinv_item_ids', $item_ids ); |
3762 | - } |
|
3762 | + } |
|
3763 | 3763 | |
3764 | - /** |
|
3765 | - * @deprecated |
|
3766 | - */ |
|
3767 | - public function update_items( $temp = false ) { |
|
3764 | + /** |
|
3765 | + * @deprecated |
|
3766 | + */ |
|
3767 | + public function update_items( $temp = false ) { |
|
3768 | 3768 | |
3769 | - $this->set_items( $this->get_items() ); |
|
3769 | + $this->set_items( $this->get_items() ); |
|
3770 | 3770 | |
3771 | - if ( ! $temp ) { |
|
3772 | - $this->save(); |
|
3773 | - } |
|
3771 | + if ( ! $temp ) { |
|
3772 | + $this->save(); |
|
3773 | + } |
|
3774 | 3774 | |
3775 | 3775 | return $this; |
3776 | - } |
|
3776 | + } |
|
3777 | 3777 | |
3778 | - /** |
|
3779 | - * @deprecated |
|
3780 | - */ |
|
3778 | + /** |
|
3779 | + * @deprecated |
|
3780 | + */ |
|
3781 | 3781 | public function validate_discount() { |
3782 | 3782 | |
3783 | 3783 | $discount_code = $this->get_discount_code(); |
@@ -3793,93 +3793,93 @@ discard block |
||
3793 | 3793 | |
3794 | 3794 | } |
3795 | 3795 | |
3796 | - /** |
|
3797 | - * Refunds an invoice. |
|
3798 | - */ |
|
3796 | + /** |
|
3797 | + * Refunds an invoice. |
|
3798 | + */ |
|
3799 | 3799 | public function refund() { |
3800 | - $this->set_status( 'wpi-refunded' ); |
|
3800 | + $this->set_status( 'wpi-refunded' ); |
|
3801 | 3801 | $this->save(); |
3802 | - } |
|
3802 | + } |
|
3803 | 3803 | |
3804 | - /** |
|
3805 | - * Marks an invoice as paid. |
|
3806 | - * |
|
3807 | - * @param string $transaction_id |
|
3808 | - */ |
|
3804 | + /** |
|
3805 | + * Marks an invoice as paid. |
|
3806 | + * |
|
3807 | + * @param string $transaction_id |
|
3808 | + */ |
|
3809 | 3809 | public function mark_paid( $transaction_id = null, $note = '' ) { |
3810 | 3810 | |
3811 | - // Set the transaction id. |
|
3812 | - if ( empty( $transaction_id ) ) { |
|
3813 | - $transaction_id = $this->generate_key('trans_'); |
|
3814 | - } |
|
3811 | + // Set the transaction id. |
|
3812 | + if ( empty( $transaction_id ) ) { |
|
3813 | + $transaction_id = $this->generate_key('trans_'); |
|
3814 | + } |
|
3815 | 3815 | |
3816 | - if ( ! $this->get_transaction_id() ) { |
|
3817 | - $this->set_transaction_id( $transaction_id ); |
|
3818 | - } |
|
3816 | + if ( ! $this->get_transaction_id() ) { |
|
3817 | + $this->set_transaction_id( $transaction_id ); |
|
3818 | + } |
|
3819 | 3819 | |
3820 | - if ( $this->is_paid() && 'wpi-processing' != $this->get_status() ) { |
|
3821 | - return $this->save(); |
|
3822 | - } |
|
3820 | + if ( $this->is_paid() && 'wpi-processing' != $this->get_status() ) { |
|
3821 | + return $this->save(); |
|
3822 | + } |
|
3823 | 3823 | |
3824 | - // Set the completed date. |
|
3825 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
3824 | + // Set the completed date. |
|
3825 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
3826 | 3826 | |
3827 | - // Set the new status. |
|
3828 | - $gateway = sanitize_text_field( $this->get_gateway_title() ); |
|
3829 | - if ( $this->is_renewal() ) { |
|
3827 | + // Set the new status. |
|
3828 | + $gateway = sanitize_text_field( $this->get_gateway_title() ); |
|
3829 | + if ( $this->is_renewal() ) { |
|
3830 | 3830 | |
3831 | - $_note = wp_sprintf( __( 'Renewed via %s', 'invoicing' ), $gateway ); |
|
3832 | - $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
3831 | + $_note = wp_sprintf( __( 'Renewed via %s', 'invoicing' ), $gateway ); |
|
3832 | + $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
3833 | 3833 | |
3834 | - if ( 'none' == $this->get_gateway() ) { |
|
3835 | - $_note = $note; |
|
3836 | - } |
|
3834 | + if ( 'none' == $this->get_gateway() ) { |
|
3835 | + $_note = $note; |
|
3836 | + } |
|
3837 | 3837 | |
3838 | - $this->set_status( 'wpi-renewal', $_note ); |
|
3838 | + $this->set_status( 'wpi-renewal', $_note ); |
|
3839 | 3839 | |
3840 | - } else { |
|
3840 | + } else { |
|
3841 | 3841 | |
3842 | - $_note = wp_sprintf( __( 'Paid via %s', 'invoicing' ), $gateway ); |
|
3843 | - $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
3842 | + $_note = wp_sprintf( __( 'Paid via %s', 'invoicing' ), $gateway ); |
|
3843 | + $_note = $_note . empty( $note ) ? '' : " ($note)"; |
|
3844 | 3844 | |
3845 | - if ( 'none' == $this->get_gateway() ) { |
|
3846 | - $_note = $note; |
|
3847 | - } |
|
3845 | + if ( 'none' == $this->get_gateway() ) { |
|
3846 | + $_note = $note; |
|
3847 | + } |
|
3848 | 3848 | |
3849 | - $this->set_status( 'publish', $_note ); |
|
3849 | + $this->set_status( 'publish', $_note ); |
|
3850 | 3850 | |
3851 | - } |
|
3851 | + } |
|
3852 | 3852 | |
3853 | - // Set checkout mode. |
|
3854 | - $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
3855 | - $this->set_mode( $mode ); |
|
3853 | + // Set checkout mode. |
|
3854 | + $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
3855 | + $this->set_mode( $mode ); |
|
3856 | 3856 | |
3857 | - // Save the invoice. |
|
3857 | + // Save the invoice. |
|
3858 | 3858 | $this->save(); |
3859 | - } |
|
3860 | - |
|
3861 | - /** |
|
3862 | - * Save data to the database. |
|
3863 | - * |
|
3864 | - * @since 1.0.19 |
|
3865 | - * @return int invoice ID |
|
3866 | - */ |
|
3867 | - public function save() { |
|
3868 | - $this->maybe_set_date_paid(); |
|
3869 | - $this->maybe_set_key(); |
|
3870 | - parent::save(); |
|
3871 | - $this->clear_cache(); |
|
3872 | - $this->status_transition(); |
|
3873 | - return $this->get_id(); |
|
3874 | - } |
|
3875 | - |
|
3876 | - /** |
|
3859 | + } |
|
3860 | + |
|
3861 | + /** |
|
3862 | + * Save data to the database. |
|
3863 | + * |
|
3864 | + * @since 1.0.19 |
|
3865 | + * @return int invoice ID |
|
3866 | + */ |
|
3867 | + public function save() { |
|
3868 | + $this->maybe_set_date_paid(); |
|
3869 | + $this->maybe_set_key(); |
|
3870 | + parent::save(); |
|
3871 | + $this->clear_cache(); |
|
3872 | + $this->status_transition(); |
|
3873 | + return $this->get_id(); |
|
3874 | + } |
|
3875 | + |
|
3876 | + /** |
|
3877 | 3877 | * Clears the subscription's cache. |
3878 | 3878 | */ |
3879 | 3879 | public function clear_cache() { |
3880 | - wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
3881 | - wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
3882 | - wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
3883 | - } |
|
3880 | + wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
3881 | + wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
3882 | + wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
3883 | + } |
|
3884 | 3884 | |
3885 | 3885 | } |
@@ -160,50 +160,50 @@ |
||
160 | 160 | */ |
161 | 161 | function getpaid_calculate_invoice_discount( $invoice, $discount ) { |
162 | 162 | |
163 | - $initial_discount = 0; |
|
164 | - $recurring_discount = 0; |
|
163 | + $initial_discount = 0; |
|
164 | + $recurring_discount = 0; |
|
165 | 165 | |
166 | - foreach ( $invoice->get_items() as $item ) { |
|
166 | + foreach ( $invoice->get_items() as $item ) { |
|
167 | 167 | |
168 | - // Abort if it is not valid for this item. |
|
169 | - if ( ! $discount->is_valid_for_items( array( $item->get_id() ) ) ) { |
|
170 | - continue; |
|
171 | - } |
|
168 | + // Abort if it is not valid for this item. |
|
169 | + if ( ! $discount->is_valid_for_items( array( $item->get_id() ) ) ) { |
|
170 | + continue; |
|
171 | + } |
|
172 | 172 | |
173 | - // Calculate the initial amount... |
|
174 | - $item_discount = $discount->get_discounted_amount( $item->get_sub_total() ); |
|
175 | - $recurring_item_discount = 0; |
|
173 | + // Calculate the initial amount... |
|
174 | + $item_discount = $discount->get_discounted_amount( $item->get_sub_total() ); |
|
175 | + $recurring_item_discount = 0; |
|
176 | 176 | |
177 | - // ... and maybe the recurring amount. |
|
178 | - if ( $item->is_recurring() && $discount->is_recurring() ) { |
|
179 | - $recurring_item_discount = $discount->get_discounted_amount( $item->get_recurring_sub_total() ); |
|
180 | - } |
|
177 | + // ... and maybe the recurring amount. |
|
178 | + if ( $item->is_recurring() && $discount->is_recurring() ) { |
|
179 | + $recurring_item_discount = $discount->get_discounted_amount( $item->get_recurring_sub_total() ); |
|
180 | + } |
|
181 | 181 | |
182 | - // Discount should not exceed discounted amount. |
|
183 | - if ( ! $discount->is_type( 'percent' ) ) { |
|
182 | + // Discount should not exceed discounted amount. |
|
183 | + if ( ! $discount->is_type( 'percent' ) ) { |
|
184 | 184 | |
185 | - if ( ( $initial_discount + $item_discount ) > $discount->get_amount() ) { |
|
186 | - $item_discount = $discount->get_amount() - $initial_discount; |
|
187 | - } |
|
185 | + if ( ( $initial_discount + $item_discount ) > $discount->get_amount() ) { |
|
186 | + $item_discount = $discount->get_amount() - $initial_discount; |
|
187 | + } |
|
188 | 188 | |
189 | - if ( ( $recurring_discount + $recurring_item_discount ) > $discount->get_amount() ) { |
|
190 | - $recurring_item_discount = $discount->get_amount() - $recurring_discount; |
|
191 | - } |
|
189 | + if ( ( $recurring_discount + $recurring_item_discount ) > $discount->get_amount() ) { |
|
190 | + $recurring_item_discount = $discount->get_amount() - $recurring_discount; |
|
191 | + } |
|
192 | 192 | |
193 | - } |
|
193 | + } |
|
194 | 194 | |
195 | - $initial_discount += $item_discount; |
|
196 | - $recurring_discount += $recurring_discount; |
|
197 | - $item->item_discount = $item_discount; |
|
198 | - $item->recurring_item_discount = $recurring_item_discount; |
|
195 | + $initial_discount += $item_discount; |
|
196 | + $recurring_discount += $recurring_discount; |
|
197 | + $item->item_discount = $item_discount; |
|
198 | + $item->recurring_item_discount = $recurring_item_discount; |
|
199 | 199 | |
200 | - } |
|
200 | + } |
|
201 | 201 | |
202 | - return array( |
|
203 | - 'name' => 'discount_code', |
|
204 | - 'discount_code' => $discount->get_code(), |
|
205 | - 'initial_discount' => $initial_discount, |
|
206 | - 'recurring_discount' => $recurring_discount, |
|
207 | - ); |
|
202 | + return array( |
|
203 | + 'name' => 'discount_code', |
|
204 | + 'discount_code' => $discount->get_code(), |
|
205 | + 'initial_discount' => $initial_discount, |
|
206 | + 'recurring_discount' => $recurring_discount, |
|
207 | + ); |
|
208 | 208 | |
209 | 209 | } |
@@ -12,257 +12,257 @@ |
||
12 | 12 | */ |
13 | 13 | class GetPaid_Payment_Form_Submission_Refresh_Prices { |
14 | 14 | |
15 | - /** |
|
16 | - * Contains the response for refreshing prices. |
|
17 | - * @var array |
|
18 | - */ |
|
19 | - public $response = array(); |
|
15 | + /** |
|
16 | + * Contains the response for refreshing prices. |
|
17 | + * @var array |
|
18 | + */ |
|
19 | + public $response = array(); |
|
20 | 20 | |
21 | 21 | /** |
22 | - * Class constructor |
|
23 | - * |
|
24 | - * @param GetPaid_Payment_Form_Submission $submission |
|
25 | - */ |
|
26 | - public function __construct( $submission ) { |
|
27 | - |
|
28 | - $this->response = array( |
|
29 | - 'submission_id' => $submission->id, |
|
22 | + * Class constructor |
|
23 | + * |
|
24 | + * @param GetPaid_Payment_Form_Submission $submission |
|
25 | + */ |
|
26 | + public function __construct( $submission ) { |
|
27 | + |
|
28 | + $this->response = array( |
|
29 | + 'submission_id' => $submission->id, |
|
30 | 30 | 'has_recurring' => $submission->has_recurring, |
31 | 31 | 'is_free' => ! $submission->should_collect_payment_details(), |
32 | - ); |
|
33 | - |
|
34 | - $this->add_totals( $submission ); |
|
35 | - $this->add_texts( $submission ); |
|
36 | - $this->add_items( $submission ); |
|
37 | - $this->add_fees( $submission ); |
|
38 | - $this->add_discounts( $submission ); |
|
39 | - $this->add_taxes( $submission ); |
|
40 | - $this->add_gateways( $submission ); |
|
41 | - |
|
42 | - } |
|
43 | - |
|
44 | - /** |
|
45 | - * Adds totals to a response for submission refresh prices. |
|
46 | - * |
|
47 | - * @param GetPaid_Payment_Form_Submission $submission |
|
48 | - */ |
|
49 | - public function add_totals( $submission ) { |
|
50 | - |
|
51 | - $this->response = array_merge( |
|
52 | - $this->response, |
|
53 | - array( |
|
54 | - |
|
55 | - 'totals' => array( |
|
56 | - 'subtotal' => $submission->format_amount( $submission->get_subtotal() ), |
|
57 | - 'discount' => $submission->format_amount( $submission->get_discount() ), |
|
58 | - 'fees' => $submission->format_amount( $submission->get_fee() ), |
|
59 | - 'tax' => $submission->format_amount( $submission->get_tax() ), |
|
60 | - 'total' => $submission->format_amount( $submission->get_total() ), |
|
61 | - 'raw_total' => html_entity_decode( sanitize_text_field( $submission->format_amount( $submission->get_total() ) ), ENT_QUOTES ), |
|
62 | - ), |
|
63 | - |
|
64 | - 'recurring' => array( |
|
65 | - 'subtotal' => $submission->format_amount( $submission->get_recurring_subtotal() ), |
|
66 | - 'discount' => $submission->format_amount( $submission->get_recurring_discount() ), |
|
67 | - 'fees' => $submission->format_amount( $submission->get_recurring_fee() ), |
|
68 | - 'tax' => $submission->format_amount( $submission->get_recurring_tax() ), |
|
69 | - 'total' => $submission->format_amount( $submission->get_recurring_total() ), |
|
70 | - ), |
|
71 | - |
|
72 | - 'initial_amt' => wpinv_round_amount( $submission->get_total(), null, true ), |
|
73 | - 'currency' => $submission->get_currency(), |
|
74 | - |
|
75 | - ) |
|
76 | - ); |
|
77 | - |
|
78 | - } |
|
79 | - |
|
80 | - /** |
|
81 | - * Adds texts to a response for submission refresh prices. |
|
82 | - * |
|
83 | - * @param GetPaid_Payment_Form_Submission $submission |
|
84 | - */ |
|
85 | - public function add_texts( $submission ) { |
|
86 | - |
|
87 | - $payable = $submission->format_amount( $submission->get_total() ); |
|
88 | - |
|
89 | - if ( $submission->has_recurring != 0 ) { |
|
90 | - |
|
91 | - $recurring = new WPInv_Item( $submission->has_recurring ); |
|
92 | - $period = getpaid_get_subscription_period_label( $recurring->get_recurring_period( true ), $recurring->get_recurring_interval(), '' ); |
|
93 | - |
|
94 | - if ( $submission->get_total() == $submission->get_recurring_total() ) { |
|
95 | - $payable = "$payable / $period"; |
|
96 | - } else { |
|
97 | - $payable = sprintf( |
|
98 | - __( '%1$s (renews at %2$s / %3$s)', 'invoicing' ), |
|
99 | - $submission->format_amount( $submission->get_total() ), |
|
100 | - $submission->format_amount( $submission->get_recurring_total() ), |
|
101 | - $period |
|
102 | - ); |
|
103 | - } |
|
104 | - |
|
105 | - } |
|
106 | - |
|
107 | - $texts = array( |
|
108 | - '.getpaid-checkout-total-payable' => $payable, |
|
109 | - ); |
|
110 | - |
|
111 | - foreach ( $submission->get_items() as $item ) { |
|
112 | - $item_id = $item->get_id(); |
|
113 | - $initial_price = $submission->format_amount( $this->standardize_price( $item->get_id(), $item->get_sub_total(), $submission->get_discount_code(), false ) ); |
|
114 | - $recurring_price = $submission->format_amount( $this->standardize_price( $item->get_id(), $item->get_recurring_sub_total(), $submission->get_discount_code(), true ) ); |
|
115 | - $texts[".item-$item_id .getpaid-form-item-price-desc"] = getpaid_item_recurring_price_help_text( $item, $submission->get_currency(), $initial_price, $recurring_price ); |
|
116 | - } |
|
117 | - |
|
118 | - $this->response = array_merge( $this->response, array( 'texts' => $texts ) ); |
|
119 | - |
|
120 | - } |
|
121 | - |
|
122 | - /** |
|
123 | - * Adds items to a response for submission refresh prices. |
|
124 | - * |
|
125 | - * @param GetPaid_Payment_Form_Submission $submission |
|
126 | - */ |
|
127 | - public function add_items( $submission ) { |
|
128 | - |
|
129 | - // Add items. |
|
130 | - $items = array(); |
|
32 | + ); |
|
33 | + |
|
34 | + $this->add_totals( $submission ); |
|
35 | + $this->add_texts( $submission ); |
|
36 | + $this->add_items( $submission ); |
|
37 | + $this->add_fees( $submission ); |
|
38 | + $this->add_discounts( $submission ); |
|
39 | + $this->add_taxes( $submission ); |
|
40 | + $this->add_gateways( $submission ); |
|
41 | + |
|
42 | + } |
|
43 | + |
|
44 | + /** |
|
45 | + * Adds totals to a response for submission refresh prices. |
|
46 | + * |
|
47 | + * @param GetPaid_Payment_Form_Submission $submission |
|
48 | + */ |
|
49 | + public function add_totals( $submission ) { |
|
50 | + |
|
51 | + $this->response = array_merge( |
|
52 | + $this->response, |
|
53 | + array( |
|
54 | + |
|
55 | + 'totals' => array( |
|
56 | + 'subtotal' => $submission->format_amount( $submission->get_subtotal() ), |
|
57 | + 'discount' => $submission->format_amount( $submission->get_discount() ), |
|
58 | + 'fees' => $submission->format_amount( $submission->get_fee() ), |
|
59 | + 'tax' => $submission->format_amount( $submission->get_tax() ), |
|
60 | + 'total' => $submission->format_amount( $submission->get_total() ), |
|
61 | + 'raw_total' => html_entity_decode( sanitize_text_field( $submission->format_amount( $submission->get_total() ) ), ENT_QUOTES ), |
|
62 | + ), |
|
63 | + |
|
64 | + 'recurring' => array( |
|
65 | + 'subtotal' => $submission->format_amount( $submission->get_recurring_subtotal() ), |
|
66 | + 'discount' => $submission->format_amount( $submission->get_recurring_discount() ), |
|
67 | + 'fees' => $submission->format_amount( $submission->get_recurring_fee() ), |
|
68 | + 'tax' => $submission->format_amount( $submission->get_recurring_tax() ), |
|
69 | + 'total' => $submission->format_amount( $submission->get_recurring_total() ), |
|
70 | + ), |
|
71 | + |
|
72 | + 'initial_amt' => wpinv_round_amount( $submission->get_total(), null, true ), |
|
73 | + 'currency' => $submission->get_currency(), |
|
74 | + |
|
75 | + ) |
|
76 | + ); |
|
77 | + |
|
78 | + } |
|
79 | + |
|
80 | + /** |
|
81 | + * Adds texts to a response for submission refresh prices. |
|
82 | + * |
|
83 | + * @param GetPaid_Payment_Form_Submission $submission |
|
84 | + */ |
|
85 | + public function add_texts( $submission ) { |
|
86 | + |
|
87 | + $payable = $submission->format_amount( $submission->get_total() ); |
|
88 | + |
|
89 | + if ( $submission->has_recurring != 0 ) { |
|
90 | + |
|
91 | + $recurring = new WPInv_Item( $submission->has_recurring ); |
|
92 | + $period = getpaid_get_subscription_period_label( $recurring->get_recurring_period( true ), $recurring->get_recurring_interval(), '' ); |
|
93 | + |
|
94 | + if ( $submission->get_total() == $submission->get_recurring_total() ) { |
|
95 | + $payable = "$payable / $period"; |
|
96 | + } else { |
|
97 | + $payable = sprintf( |
|
98 | + __( '%1$s (renews at %2$s / %3$s)', 'invoicing' ), |
|
99 | + $submission->format_amount( $submission->get_total() ), |
|
100 | + $submission->format_amount( $submission->get_recurring_total() ), |
|
101 | + $period |
|
102 | + ); |
|
103 | + } |
|
104 | + |
|
105 | + } |
|
106 | + |
|
107 | + $texts = array( |
|
108 | + '.getpaid-checkout-total-payable' => $payable, |
|
109 | + ); |
|
131 | 110 | |
132 | 111 | foreach ( $submission->get_items() as $item ) { |
133 | - $item_id = $item->get_id(); |
|
134 | - $items["$item_id"] = $submission->format_amount( $item->get_sub_total() ); |
|
135 | - } |
|
112 | + $item_id = $item->get_id(); |
|
113 | + $initial_price = $submission->format_amount( $this->standardize_price( $item->get_id(), $item->get_sub_total(), $submission->get_discount_code(), false ) ); |
|
114 | + $recurring_price = $submission->format_amount( $this->standardize_price( $item->get_id(), $item->get_recurring_sub_total(), $submission->get_discount_code(), true ) ); |
|
115 | + $texts[".item-$item_id .getpaid-form-item-price-desc"] = getpaid_item_recurring_price_help_text( $item, $submission->get_currency(), $initial_price, $recurring_price ); |
|
116 | + } |
|
136 | 117 | |
137 | - $this->response = array_merge( |
|
138 | - $this->response, |
|
139 | - array( 'items' => $items ) |
|
140 | - ); |
|
118 | + $this->response = array_merge( $this->response, array( 'texts' => $texts ) ); |
|
141 | 119 | |
142 | - } |
|
120 | + } |
|
143 | 121 | |
144 | - /** |
|
145 | - * Adds fees to a response for submission refresh prices. |
|
146 | - * |
|
147 | - * @param GetPaid_Payment_Form_Submission $submission |
|
148 | - */ |
|
149 | - public function add_fees( $submission ) { |
|
122 | + /** |
|
123 | + * Adds items to a response for submission refresh prices. |
|
124 | + * |
|
125 | + * @param GetPaid_Payment_Form_Submission $submission |
|
126 | + */ |
|
127 | + public function add_items( $submission ) { |
|
128 | + |
|
129 | + // Add items. |
|
130 | + $items = array(); |
|
131 | + |
|
132 | + foreach ( $submission->get_items() as $item ) { |
|
133 | + $item_id = $item->get_id(); |
|
134 | + $items["$item_id"] = $submission->format_amount( $item->get_sub_total() ); |
|
135 | + } |
|
150 | 136 | |
151 | - $fees = array(); |
|
137 | + $this->response = array_merge( |
|
138 | + $this->response, |
|
139 | + array( 'items' => $items ) |
|
140 | + ); |
|
141 | + |
|
142 | + } |
|
143 | + |
|
144 | + /** |
|
145 | + * Adds fees to a response for submission refresh prices. |
|
146 | + * |
|
147 | + * @param GetPaid_Payment_Form_Submission $submission |
|
148 | + */ |
|
149 | + public function add_fees( $submission ) { |
|
150 | + |
|
151 | + $fees = array(); |
|
152 | 152 | |
153 | 153 | foreach ( $submission->get_fees() as $name => $data ) { |
154 | - $fees[$name] = $submission->format_amount( $data['initial_fee'] ); |
|
155 | - } |
|
154 | + $fees[$name] = $submission->format_amount( $data['initial_fee'] ); |
|
155 | + } |
|
156 | 156 | |
157 | - $this->response = array_merge( |
|
158 | - $this->response, |
|
159 | - array( 'fees' => $fees ) |
|
160 | - ); |
|
157 | + $this->response = array_merge( |
|
158 | + $this->response, |
|
159 | + array( 'fees' => $fees ) |
|
160 | + ); |
|
161 | 161 | |
162 | - } |
|
162 | + } |
|
163 | 163 | |
164 | - /** |
|
165 | - * Adds discounts to a response for submission refresh prices. |
|
166 | - * |
|
167 | - * @param GetPaid_Payment_Form_Submission $submission |
|
168 | - */ |
|
169 | - public function add_discounts( $submission ) { |
|
164 | + /** |
|
165 | + * Adds discounts to a response for submission refresh prices. |
|
166 | + * |
|
167 | + * @param GetPaid_Payment_Form_Submission $submission |
|
168 | + */ |
|
169 | + public function add_discounts( $submission ) { |
|
170 | 170 | |
171 | - $discounts = array(); |
|
171 | + $discounts = array(); |
|
172 | 172 | |
173 | 173 | foreach ( $submission->get_discounts() as $name => $data ) { |
174 | - $discounts[$name] = $submission->format_amount( $data['initial_discount'] ); |
|
175 | - } |
|
176 | - |
|
177 | - $this->response = array_merge( |
|
178 | - $this->response, |
|
179 | - array( 'discounts' => $discounts ) |
|
180 | - ); |
|
174 | + $discounts[$name] = $submission->format_amount( $data['initial_discount'] ); |
|
175 | + } |
|
181 | 176 | |
182 | - } |
|
177 | + $this->response = array_merge( |
|
178 | + $this->response, |
|
179 | + array( 'discounts' => $discounts ) |
|
180 | + ); |
|
183 | 181 | |
184 | - /** |
|
185 | - * Adds taxes to a response for submission refresh prices. |
|
186 | - * |
|
187 | - * @param GetPaid_Payment_Form_Submission $submission |
|
188 | - */ |
|
189 | - public function add_taxes( $submission ) { |
|
182 | + } |
|
190 | 183 | |
191 | - $taxes = array(); |
|
192 | - $markup = ''; |
|
184 | + /** |
|
185 | + * Adds taxes to a response for submission refresh prices. |
|
186 | + * |
|
187 | + * @param GetPaid_Payment_Form_Submission $submission |
|
188 | + */ |
|
189 | + public function add_taxes( $submission ) { |
|
190 | + |
|
191 | + $taxes = array(); |
|
192 | + $markup = ''; |
|
193 | 193 | foreach ( $submission->get_taxes() as $name => $data ) { |
194 | - $name = sanitize_text_field( $name ); |
|
195 | - $amount = $submission->format_amount( $data['initial_tax'] ); |
|
196 | - $taxes[$name] = $amount; |
|
197 | - $markup .= "<small class='form-text'>$name : $amount</small>"; |
|
198 | - } |
|
194 | + $name = sanitize_text_field( $name ); |
|
195 | + $amount = $submission->format_amount( $data['initial_tax'] ); |
|
196 | + $taxes[$name] = $amount; |
|
197 | + $markup .= "<small class='form-text'>$name : $amount</small>"; |
|
198 | + } |
|
199 | 199 | |
200 | - if ( wpinv_display_individual_tax_rates() && ! empty( $taxes ) ) { |
|
201 | - $this->response['texts']['.getpaid-form-cart-totals-total-tax'] = $markup; |
|
202 | - } |
|
200 | + if ( wpinv_display_individual_tax_rates() && ! empty( $taxes ) ) { |
|
201 | + $this->response['texts']['.getpaid-form-cart-totals-total-tax'] = $markup; |
|
202 | + } |
|
203 | 203 | |
204 | - $this->response = array_merge( |
|
205 | - $this->response, |
|
206 | - array( 'taxes' => $taxes ) |
|
207 | - ); |
|
204 | + $this->response = array_merge( |
|
205 | + $this->response, |
|
206 | + array( 'taxes' => $taxes ) |
|
207 | + ); |
|
208 | 208 | |
209 | - } |
|
209 | + } |
|
210 | 210 | |
211 | - /** |
|
212 | - * Adds gateways to a response for submission refresh prices. |
|
213 | - * |
|
214 | - * @param GetPaid_Payment_Form_Submission $submission |
|
215 | - */ |
|
216 | - public function add_gateways( $submission ) { |
|
211 | + /** |
|
212 | + * Adds gateways to a response for submission refresh prices. |
|
213 | + * |
|
214 | + * @param GetPaid_Payment_Form_Submission $submission |
|
215 | + */ |
|
216 | + public function add_gateways( $submission ) { |
|
217 | 217 | |
218 | - $gateways = array_keys( wpinv_get_enabled_payment_gateways() ); |
|
218 | + $gateways = array_keys( wpinv_get_enabled_payment_gateways() ); |
|
219 | 219 | |
220 | - if ( $this->response['has_recurring'] ) { |
|
220 | + if ( $this->response['has_recurring'] ) { |
|
221 | 221 | |
222 | - foreach ( $gateways as $i => $gateway ) { |
|
222 | + foreach ( $gateways as $i => $gateway ) { |
|
223 | 223 | |
224 | - if ( ! wpinv_gateway_support_subscription( $gateway ) ) { |
|
225 | - unset( $gateways[ $i ] ); |
|
226 | - } |
|
224 | + if ( ! wpinv_gateway_support_subscription( $gateway ) ) { |
|
225 | + unset( $gateways[ $i ] ); |
|
226 | + } |
|
227 | 227 | |
228 | - } |
|
228 | + } |
|
229 | 229 | |
230 | - } |
|
230 | + } |
|
231 | 231 | |
232 | 232 | |
233 | - $gateways = apply_filters( 'getpaid_submission_gateways', $gateways, $submission ); |
|
234 | - $this->response = array_merge( |
|
235 | - $this->response, |
|
236 | - array( 'gateways' => $gateways ) |
|
237 | - ); |
|
233 | + $gateways = apply_filters( 'getpaid_submission_gateways', $gateways, $submission ); |
|
234 | + $this->response = array_merge( |
|
235 | + $this->response, |
|
236 | + array( 'gateways' => $gateways ) |
|
237 | + ); |
|
238 | 238 | |
239 | - } |
|
239 | + } |
|
240 | 240 | |
241 | - /** |
|
242 | - * Standardizes prices. |
|
243 | - * |
|
244 | - * @param int $item_id |
|
245 | - * @param float $item_total |
|
246 | - * @param string $discount_code |
|
247 | - * @param bool $recurring |
|
248 | - */ |
|
249 | - public function standardize_price( $item_id, $item_total, $discount_code, $recurring = false ) { |
|
241 | + /** |
|
242 | + * Standardizes prices. |
|
243 | + * |
|
244 | + * @param int $item_id |
|
245 | + * @param float $item_total |
|
246 | + * @param string $discount_code |
|
247 | + * @param bool $recurring |
|
248 | + */ |
|
249 | + public function standardize_price( $item_id, $item_total, $discount_code, $recurring = false ) { |
|
250 | 250 | |
251 | - $standardadized_price = $item_total; |
|
251 | + $standardadized_price = $item_total; |
|
252 | 252 | |
253 | - // Do we have a $discount_code? |
|
254 | - if ( ! empty( $discount_code ) ) { |
|
253 | + // Do we have a $discount_code? |
|
254 | + if ( ! empty( $discount_code ) ) { |
|
255 | 255 | |
256 | - $discount = new WPInv_Discount( $discount_code ); |
|
256 | + $discount = new WPInv_Discount( $discount_code ); |
|
257 | 257 | |
258 | - if ( $discount->exists() && $discount->is_valid_for_items( $item_id ) && ( ! $recurring || $discount->is_recurring() ) ) { |
|
259 | - $standardadized_price = $item_total - $discount->get_discounted_amount( $item_total ); |
|
260 | - } |
|
258 | + if ( $discount->exists() && $discount->is_valid_for_items( $item_id ) && ( ! $recurring || $discount->is_recurring() ) ) { |
|
259 | + $standardadized_price = $item_total - $discount->get_discounted_amount( $item_total ); |
|
260 | + } |
|
261 | 261 | |
262 | - } |
|
262 | + } |
|
263 | 263 | |
264 | - return max( 0, $standardadized_price ); |
|
264 | + return max( 0, $standardadized_price ); |
|
265 | 265 | |
266 | - } |
|
266 | + } |
|
267 | 267 | |
268 | 268 | } |
@@ -12,162 +12,162 @@ |
||
12 | 12 | */ |
13 | 13 | class GetPaid_Payment_Form_Submission_Discount { |
14 | 14 | |
15 | - /** |
|
16 | - * Submission discounts. |
|
17 | - * @var array |
|
18 | - */ |
|
19 | - public $discounts = array(); |
|
15 | + /** |
|
16 | + * Submission discounts. |
|
17 | + * @var array |
|
18 | + */ |
|
19 | + public $discounts = array(); |
|
20 | + |
|
21 | + /** |
|
22 | + * Class constructor |
|
23 | + * |
|
24 | + * @param GetPaid_Payment_Form_Submission $submission |
|
25 | + * @param float $initial_total |
|
26 | + * @param float $recurring_total |
|
27 | + */ |
|
28 | + public function __construct( $submission, $initial_total, $recurring_total ) { |
|
29 | + |
|
30 | + // Process any existing invoice discounts. |
|
31 | + if ( $submission->has_invoice() ) { |
|
32 | + $this->discounts = $submission->get_invoice()->get_discounts(); |
|
33 | + } |
|
34 | + |
|
35 | + // Do we have a discount? |
|
36 | + $discount = $submission->get_field( 'discount' ); |
|
37 | + |
|
38 | + if ( empty( $discount ) ) { |
|
39 | + |
|
40 | + if ( isset( $this->discounts['discount_code'] ) ) { |
|
41 | + unset( $this->discounts['discount_code'] ); |
|
42 | + } |
|
43 | + |
|
44 | + return; |
|
45 | + } |
|
46 | + |
|
47 | + // Processes the discount code. |
|
48 | + $amount = max( $initial_total, $recurring_total ); |
|
49 | + $this->process_discount( $submission, $discount, $amount ); |
|
50 | + |
|
51 | + } |
|
20 | 52 | |
21 | 53 | /** |
22 | - * Class constructor |
|
23 | - * |
|
24 | - * @param GetPaid_Payment_Form_Submission $submission |
|
25 | - * @param float $initial_total |
|
26 | - * @param float $recurring_total |
|
27 | - */ |
|
28 | - public function __construct( $submission, $initial_total, $recurring_total ) { |
|
29 | - |
|
30 | - // Process any existing invoice discounts. |
|
31 | - if ( $submission->has_invoice() ) { |
|
32 | - $this->discounts = $submission->get_invoice()->get_discounts(); |
|
33 | - } |
|
34 | - |
|
35 | - // Do we have a discount? |
|
36 | - $discount = $submission->get_field( 'discount' ); |
|
37 | - |
|
38 | - if ( empty( $discount ) ) { |
|
39 | - |
|
40 | - if ( isset( $this->discounts['discount_code'] ) ) { |
|
41 | - unset( $this->discounts['discount_code'] ); |
|
42 | - } |
|
43 | - |
|
44 | - return; |
|
45 | - } |
|
46 | - |
|
47 | - // Processes the discount code. |
|
48 | - $amount = max( $initial_total, $recurring_total ); |
|
49 | - $this->process_discount( $submission, $discount, $amount ); |
|
50 | - |
|
51 | - } |
|
52 | - |
|
53 | - /** |
|
54 | - * Processes a submission discount. |
|
55 | - * |
|
56 | - * @param GetPaid_Payment_Form_Submission $submission |
|
57 | - * @param string $discount |
|
58 | - * @param float $amount |
|
59 | - */ |
|
60 | - public function process_discount( $submission, $discount, $amount ) { |
|
61 | - |
|
62 | - // Fetch the discount. |
|
63 | - $discount = new WPInv_Discount( $discount ); |
|
64 | - |
|
65 | - // Ensure it is active. |
|
54 | + * Processes a submission discount. |
|
55 | + * |
|
56 | + * @param GetPaid_Payment_Form_Submission $submission |
|
57 | + * @param string $discount |
|
58 | + * @param float $amount |
|
59 | + */ |
|
60 | + public function process_discount( $submission, $discount, $amount ) { |
|
61 | + |
|
62 | + // Fetch the discount. |
|
63 | + $discount = new WPInv_Discount( $discount ); |
|
64 | + |
|
65 | + // Ensure it is active. |
|
66 | 66 | if ( ! $this->is_discount_active( $discount ) ) { |
67 | - throw new Exception( __( 'Invalid or expired discount code', 'invoicing' ) ); |
|
68 | - } |
|
69 | - |
|
70 | - // Exceeded limit. |
|
71 | - if ( $discount->has_exceeded_limit() ) { |
|
72 | - throw new Exception( __( 'This discount code has been used up', 'invoicing' ) ); |
|
73 | - } |
|
74 | - |
|
75 | - // Validate usages. |
|
76 | - $this->validate_single_use_discount( $submission, $discount ); |
|
77 | - |
|
78 | - // Validate amount. |
|
79 | - $this->validate_discount_amount( $submission, $discount, $amount ); |
|
80 | - |
|
81 | - // Save the discount. |
|
82 | - $this->discounts['discount_code'] = $this->calculate_discount( $submission, $discount ); |
|
83 | - } |
|
84 | - |
|
85 | - /** |
|
86 | - * Validates a single use discount. |
|
87 | - * |
|
88 | - * @param WPInv_Discount $discount |
|
89 | - * @return bool |
|
90 | - */ |
|
91 | - public function is_discount_active( $discount ) { |
|
92 | - return $discount->exists() && $discount->is_active() && $discount->has_started() && ! $discount->is_expired(); |
|
93 | - } |
|
94 | - |
|
95 | - /** |
|
96 | - * Returns a user's id or email. |
|
97 | - * |
|
98 | - * @param string $email |
|
99 | - * @return int|string|false |
|
100 | - */ |
|
101 | - public function get_user_id_or_email( $email ) { |
|
102 | - |
|
103 | - if ( is_user_logged_in() ) { |
|
104 | - return get_current_user_id(); |
|
105 | - } |
|
106 | - |
|
107 | - return empty( $email ) ? false : sanitize_email( $email ); |
|
108 | - } |
|
109 | - |
|
110 | - /** |
|
111 | - * Validates a single use discount. |
|
112 | - * |
|
113 | - * @param GetPaid_Payment_Form_Submission $submission |
|
114 | - * @param WPInv_Discount $discount |
|
115 | - */ |
|
116 | - public function validate_single_use_discount( $submission, $discount ) { |
|
117 | - |
|
118 | - // Abort if it is not a single use discount. |
|
119 | - if ( ! $discount->is_single_use() ) { |
|
120 | - return; |
|
121 | - } |
|
122 | - |
|
123 | - // Ensure there is a valid billing email. |
|
124 | - $user = $this->get_user_id_or_email( $submission->get_billing_email() ); |
|
125 | - |
|
126 | - if ( empty( $user ) ) { |
|
127 | - throw new Exception( __( 'You need to either log in or enter your billing email before applying this discount', 'invoicing' ) ); |
|
128 | - } |
|
129 | - |
|
130 | - // Has the user used this discount code before? |
|
131 | - if ( ! $discount->is_valid_for_user( $user ) ) { |
|
132 | - throw new Exception( __( 'You have already used this discount', 'invoicing' ) ); |
|
133 | - } |
|
134 | - |
|
135 | - } |
|
136 | - |
|
137 | - /** |
|
138 | - * Validates the discount's amount. |
|
139 | - * |
|
140 | - * @param GetPaid_Payment_Form_Submission $submission |
|
141 | - * @param WPInv_Discount $discount |
|
142 | - * @param float $amount |
|
143 | - */ |
|
144 | - public function validate_discount_amount( $submission, $discount, $amount ) { |
|
145 | - |
|
146 | - // Validate minimum amount. |
|
147 | - if ( ! $discount->is_minimum_amount_met( $amount ) ) { |
|
148 | - $min = wpinv_price( $discount->get_minimum_total(), $submission->get_currency() ); |
|
149 | - throw new Exception( sprintf( __( 'The minimum total for using this discount is %s', 'invoicing' ), $min ) ); |
|
150 | - } |
|
151 | - |
|
152 | - // Validate the maximum amount. |
|
153 | - if ( ! $discount->is_maximum_amount_met( $amount ) ) { |
|
154 | - $max = wpinv_price( $discount->get_maximum_total(), $submission->get_currency() ); |
|
155 | - throw new Exception( sprintf( __( 'The maximum total for using this discount is %s', 'invoicing' ), $max ) ); |
|
156 | - } |
|
157 | - |
|
158 | - } |
|
159 | - |
|
160 | - /** |
|
161 | - * Calculates the discount code's amount. |
|
162 | - * |
|
163 | - * Ensure that the discount exists and has been validated before calling this method. |
|
164 | - * |
|
165 | - * @param GetPaid_Payment_Form_Submission $submission |
|
166 | - * @param WPInv_Discount $discount |
|
167 | - * @return array |
|
168 | - */ |
|
169 | - public function calculate_discount( $submission, $discount ) { |
|
170 | - return getpaid_calculate_invoice_discount( $submission, $discount ); |
|
171 | - } |
|
67 | + throw new Exception( __( 'Invalid or expired discount code', 'invoicing' ) ); |
|
68 | + } |
|
69 | + |
|
70 | + // Exceeded limit. |
|
71 | + if ( $discount->has_exceeded_limit() ) { |
|
72 | + throw new Exception( __( 'This discount code has been used up', 'invoicing' ) ); |
|
73 | + } |
|
74 | + |
|
75 | + // Validate usages. |
|
76 | + $this->validate_single_use_discount( $submission, $discount ); |
|
77 | + |
|
78 | + // Validate amount. |
|
79 | + $this->validate_discount_amount( $submission, $discount, $amount ); |
|
80 | + |
|
81 | + // Save the discount. |
|
82 | + $this->discounts['discount_code'] = $this->calculate_discount( $submission, $discount ); |
|
83 | + } |
|
84 | + |
|
85 | + /** |
|
86 | + * Validates a single use discount. |
|
87 | + * |
|
88 | + * @param WPInv_Discount $discount |
|
89 | + * @return bool |
|
90 | + */ |
|
91 | + public function is_discount_active( $discount ) { |
|
92 | + return $discount->exists() && $discount->is_active() && $discount->has_started() && ! $discount->is_expired(); |
|
93 | + } |
|
94 | + |
|
95 | + /** |
|
96 | + * Returns a user's id or email. |
|
97 | + * |
|
98 | + * @param string $email |
|
99 | + * @return int|string|false |
|
100 | + */ |
|
101 | + public function get_user_id_or_email( $email ) { |
|
102 | + |
|
103 | + if ( is_user_logged_in() ) { |
|
104 | + return get_current_user_id(); |
|
105 | + } |
|
106 | + |
|
107 | + return empty( $email ) ? false : sanitize_email( $email ); |
|
108 | + } |
|
109 | + |
|
110 | + /** |
|
111 | + * Validates a single use discount. |
|
112 | + * |
|
113 | + * @param GetPaid_Payment_Form_Submission $submission |
|
114 | + * @param WPInv_Discount $discount |
|
115 | + */ |
|
116 | + public function validate_single_use_discount( $submission, $discount ) { |
|
117 | + |
|
118 | + // Abort if it is not a single use discount. |
|
119 | + if ( ! $discount->is_single_use() ) { |
|
120 | + return; |
|
121 | + } |
|
122 | + |
|
123 | + // Ensure there is a valid billing email. |
|
124 | + $user = $this->get_user_id_or_email( $submission->get_billing_email() ); |
|
125 | + |
|
126 | + if ( empty( $user ) ) { |
|
127 | + throw new Exception( __( 'You need to either log in or enter your billing email before applying this discount', 'invoicing' ) ); |
|
128 | + } |
|
129 | + |
|
130 | + // Has the user used this discount code before? |
|
131 | + if ( ! $discount->is_valid_for_user( $user ) ) { |
|
132 | + throw new Exception( __( 'You have already used this discount', 'invoicing' ) ); |
|
133 | + } |
|
134 | + |
|
135 | + } |
|
136 | + |
|
137 | + /** |
|
138 | + * Validates the discount's amount. |
|
139 | + * |
|
140 | + * @param GetPaid_Payment_Form_Submission $submission |
|
141 | + * @param WPInv_Discount $discount |
|
142 | + * @param float $amount |
|
143 | + */ |
|
144 | + public function validate_discount_amount( $submission, $discount, $amount ) { |
|
145 | + |
|
146 | + // Validate minimum amount. |
|
147 | + if ( ! $discount->is_minimum_amount_met( $amount ) ) { |
|
148 | + $min = wpinv_price( $discount->get_minimum_total(), $submission->get_currency() ); |
|
149 | + throw new Exception( sprintf( __( 'The minimum total for using this discount is %s', 'invoicing' ), $min ) ); |
|
150 | + } |
|
151 | + |
|
152 | + // Validate the maximum amount. |
|
153 | + if ( ! $discount->is_maximum_amount_met( $amount ) ) { |
|
154 | + $max = wpinv_price( $discount->get_maximum_total(), $submission->get_currency() ); |
|
155 | + throw new Exception( sprintf( __( 'The maximum total for using this discount is %s', 'invoicing' ), $max ) ); |
|
156 | + } |
|
157 | + |
|
158 | + } |
|
159 | + |
|
160 | + /** |
|
161 | + * Calculates the discount code's amount. |
|
162 | + * |
|
163 | + * Ensure that the discount exists and has been validated before calling this method. |
|
164 | + * |
|
165 | + * @param GetPaid_Payment_Form_Submission $submission |
|
166 | + * @param WPInv_Discount $discount |
|
167 | + * @return array |
|
168 | + */ |
|
169 | + public function calculate_discount( $submission, $discount ) { |
|
170 | + return getpaid_calculate_invoice_discount( $submission, $discount ); |
|
171 | + } |
|
172 | 172 | |
173 | 173 | } |
@@ -12,228 +12,228 @@ |
||
12 | 12 | */ |
13 | 13 | class GetPaid_Payment_Form_Submission_Taxes { |
14 | 14 | |
15 | - /** |
|
16 | - * Submission taxes. |
|
17 | - * @var array |
|
18 | - */ |
|
19 | - public $taxes = array(); |
|
20 | - |
|
21 | - /** |
|
22 | - * Whether or not we should skip the taxes. |
|
23 | - * @var bool |
|
24 | - */ |
|
25 | - protected $skip_taxes = false; |
|
15 | + /** |
|
16 | + * Submission taxes. |
|
17 | + * @var array |
|
18 | + */ |
|
19 | + public $taxes = array(); |
|
20 | + |
|
21 | + /** |
|
22 | + * Whether or not we should skip the taxes. |
|
23 | + * @var bool |
|
24 | + */ |
|
25 | + protected $skip_taxes = false; |
|
26 | + |
|
27 | + /** |
|
28 | + * Class constructor |
|
29 | + * |
|
30 | + * @param GetPaid_Payment_Form_Submission $submission |
|
31 | + */ |
|
32 | + public function __construct( $submission ) { |
|
33 | + |
|
34 | + // Validate VAT number. |
|
35 | + $this->validate_vat( $submission ); |
|
36 | + |
|
37 | + if ( $this->skip_taxes ) { |
|
38 | + return; |
|
39 | + } |
|
40 | + |
|
41 | + foreach ( $submission->get_items() as $item ) { |
|
42 | + $this->process_item_tax( $item, $submission ); |
|
43 | + } |
|
44 | + |
|
45 | + // Process any existing invoice taxes. |
|
46 | + if ( $submission->has_invoice() ) { |
|
47 | + $this->taxes = array_replace( $submission->get_invoice()->get_taxes(), $this->taxes ); |
|
48 | + } |
|
49 | + |
|
50 | + } |
|
51 | + |
|
52 | + /** |
|
53 | + * Maybe process tax. |
|
54 | + * |
|
55 | + * @since 1.0.19 |
|
56 | + * @param GetPaid_Form_Item $item |
|
57 | + * @param GetPaid_Payment_Form_Submission $submission |
|
58 | + */ |
|
59 | + public function process_item_tax( $item, $submission ) { |
|
60 | + |
|
61 | + $rates = getpaid_get_item_tax_rates( $item, $submission->country, $submission->state ); |
|
62 | + $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
63 | + $taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, false ), $rates ); |
|
64 | + $r_taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, true ), $rates ); |
|
65 | + |
|
66 | + foreach ( $taxes as $name => $amount ) { |
|
67 | + $recurring = isset( $r_taxes[ $name ] ) ? $r_taxes[ $name ] : 0; |
|
68 | + $tax = getpaid_prepare_item_tax( $item, $name, $amount, $recurring ); |
|
69 | + |
|
70 | + if ( ! isset( $this->taxes[ $name ] ) ) { |
|
71 | + $this->taxes[ $name ] = $tax; |
|
72 | + continue; |
|
73 | + } |
|
74 | + |
|
75 | + $this->taxes[ $name ]['initial_tax'] += $tax['initial_tax']; |
|
76 | + $this->taxes[ $name ]['recurring_tax'] += $tax['recurring_tax']; |
|
77 | + |
|
78 | + } |
|
79 | + |
|
80 | + } |
|
81 | + |
|
82 | + /** |
|
83 | + * Checks if the submission has a digital item. |
|
84 | + * |
|
85 | + * @param GetPaid_Payment_Form_Submission $submission |
|
86 | + * @since 1.0.19 |
|
87 | + * @return bool |
|
88 | + */ |
|
89 | + public function has_digital_item( $submission ) { |
|
90 | + |
|
91 | + foreach ( $submission->get_items() as $item ) { |
|
92 | + |
|
93 | + if ( 'digital' == $item->get_vat_rule() ) { |
|
94 | + return true; |
|
95 | + } |
|
96 | + |
|
97 | + } |
|
98 | + |
|
99 | + return false; |
|
100 | + } |
|
101 | + |
|
102 | + /** |
|
103 | + * Checks if this is an eu store. |
|
104 | + * |
|
105 | + * @since 1.0.19 |
|
106 | + * @return bool |
|
107 | + */ |
|
108 | + public static function is_eu_store() { |
|
109 | + return self::is_eu_country( wpinv_get_default_country() ); |
|
110 | + } |
|
26 | 111 | |
27 | 112 | /** |
28 | - * Class constructor |
|
29 | - * |
|
30 | - * @param GetPaid_Payment_Form_Submission $submission |
|
31 | - */ |
|
32 | - public function __construct( $submission ) { |
|
33 | - |
|
34 | - // Validate VAT number. |
|
35 | - $this->validate_vat( $submission ); |
|
36 | - |
|
37 | - if ( $this->skip_taxes ) { |
|
38 | - return; |
|
39 | - } |
|
40 | - |
|
41 | - foreach ( $submission->get_items() as $item ) { |
|
42 | - $this->process_item_tax( $item, $submission ); |
|
43 | - } |
|
44 | - |
|
45 | - // Process any existing invoice taxes. |
|
46 | - if ( $submission->has_invoice() ) { |
|
47 | - $this->taxes = array_replace( $submission->get_invoice()->get_taxes(), $this->taxes ); |
|
48 | - } |
|
49 | - |
|
50 | - } |
|
51 | - |
|
52 | - /** |
|
53 | - * Maybe process tax. |
|
54 | - * |
|
55 | - * @since 1.0.19 |
|
56 | - * @param GetPaid_Form_Item $item |
|
57 | - * @param GetPaid_Payment_Form_Submission $submission |
|
58 | - */ |
|
59 | - public function process_item_tax( $item, $submission ) { |
|
60 | - |
|
61 | - $rates = getpaid_get_item_tax_rates( $item, $submission->country, $submission->state ); |
|
62 | - $rates = getpaid_filter_item_tax_rates( $item, $rates ); |
|
63 | - $taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, false ), $rates ); |
|
64 | - $r_taxes = getpaid_calculate_item_taxes( getpaid_get_taxable_amount( $item, true ), $rates ); |
|
65 | - |
|
66 | - foreach ( $taxes as $name => $amount ) { |
|
67 | - $recurring = isset( $r_taxes[ $name ] ) ? $r_taxes[ $name ] : 0; |
|
68 | - $tax = getpaid_prepare_item_tax( $item, $name, $amount, $recurring ); |
|
69 | - |
|
70 | - if ( ! isset( $this->taxes[ $name ] ) ) { |
|
71 | - $this->taxes[ $name ] = $tax; |
|
72 | - continue; |
|
73 | - } |
|
74 | - |
|
75 | - $this->taxes[ $name ]['initial_tax'] += $tax['initial_tax']; |
|
76 | - $this->taxes[ $name ]['recurring_tax'] += $tax['recurring_tax']; |
|
77 | - |
|
78 | - } |
|
79 | - |
|
80 | - } |
|
81 | - |
|
82 | - /** |
|
83 | - * Checks if the submission has a digital item. |
|
84 | - * |
|
85 | - * @param GetPaid_Payment_Form_Submission $submission |
|
86 | - * @since 1.0.19 |
|
87 | - * @return bool |
|
88 | - */ |
|
89 | - public function has_digital_item( $submission ) { |
|
90 | - |
|
91 | - foreach ( $submission->get_items() as $item ) { |
|
92 | - |
|
93 | - if ( 'digital' == $item->get_vat_rule() ) { |
|
94 | - return true; |
|
95 | - } |
|
96 | - |
|
97 | - } |
|
98 | - |
|
99 | - return false; |
|
100 | - } |
|
101 | - |
|
102 | - /** |
|
103 | - * Checks if this is an eu store. |
|
104 | - * |
|
105 | - * @since 1.0.19 |
|
106 | - * @return bool |
|
107 | - */ |
|
108 | - public static function is_eu_store() { |
|
109 | - return self::is_eu_country( wpinv_get_default_country() ); |
|
110 | - } |
|
111 | - |
|
112 | - /** |
|
113 | - * Checks if this is an eu country. |
|
114 | - * |
|
115 | - * @param string $country |
|
116 | - * @since 1.0.19 |
|
117 | - * @return bool |
|
118 | - */ |
|
119 | - public static function is_eu_country( $country ) { |
|
120 | - return getpaid_is_eu_state( $country ) || getpaid_is_gst_country( $country ); |
|
121 | - } |
|
122 | - |
|
123 | - /** |
|
124 | - * Checks if this is an eu purchase. |
|
125 | - * |
|
126 | - * @param string $customer_country |
|
127 | - * @since 1.0.19 |
|
128 | - * @return bool |
|
129 | - */ |
|
130 | - public static function is_eu_transaction( $customer_country ) { |
|
131 | - return self::is_eu_country( $customer_country ) && self::is_eu_store(); |
|
132 | - } |
|
133 | - |
|
134 | - /** |
|
135 | - * Retrieves the vat number. |
|
136 | - * |
|
137 | - * @param GetPaid_Payment_Form_Submission $submission |
|
138 | - * @since 1.0.19 |
|
139 | - * @return string |
|
140 | - */ |
|
141 | - public function get_vat_number( $submission ) { |
|
142 | - |
|
143 | - // Retrieve from the posted number. |
|
144 | - $vat_number = $submission->get_field( 'wpinv_vat_number', 'billing' ); |
|
145 | - if ( ! is_null( $vat_number ) ) { |
|
146 | - return wpinv_clean( $vat_number ); |
|
147 | - } |
|
148 | - |
|
149 | - return $submission->has_invoice() ? $submission->get_invoice()->get_vat_number() : ''; |
|
150 | - } |
|
151 | - |
|
152 | - /** |
|
153 | - * Retrieves the company. |
|
154 | - * |
|
155 | - * @param GetPaid_Payment_Form_Submission $submission |
|
156 | - * @since 1.0.19 |
|
157 | - * @return string |
|
158 | - */ |
|
159 | - public function get_company( $submission ) { |
|
160 | - |
|
161 | - // Retrieve from the posted data. |
|
162 | - $company = $submission->get_field( 'wpinv_company', 'billing' ); |
|
163 | - if ( ! empty( $company ) ) { |
|
164 | - return wpinv_clean( $company ); |
|
165 | - } |
|
166 | - |
|
167 | - // Retrieve from the invoice. |
|
168 | - return $submission->has_invoice() ? $submission->get_invoice()->get_company() : ''; |
|
169 | - } |
|
170 | - |
|
171 | - /** |
|
172 | - * Checks if we require a VAT number. |
|
173 | - * |
|
174 | - * @param bool $ip_in_eu Whether the customer IP is from the EU |
|
175 | - * @param bool $country_in_eu Whether the customer country is from the EU |
|
176 | - * @since 1.0.19 |
|
177 | - * @return string |
|
178 | - */ |
|
179 | - public function requires_vat( $ip_in_eu, $country_in_eu ) { |
|
180 | - |
|
181 | - $prevent_b2c = wpinv_get_option( 'vat_prevent_b2c_purchase' ); |
|
182 | - $prevent_b2c = ! empty( $prevent_b2c ); |
|
183 | - $is_eu = $ip_in_eu || $country_in_eu; |
|
184 | - |
|
185 | - return $prevent_b2c && $is_eu; |
|
186 | - } |
|
187 | - |
|
188 | - /** |
|
189 | - * Validate VAT data. |
|
190 | - * |
|
191 | - * @param GetPaid_Payment_Form_Submission $submission |
|
192 | - * @since 1.0.19 |
|
193 | - */ |
|
194 | - public function validate_vat( $submission ) { |
|
195 | - |
|
196 | - $in_eu = $this->is_eu_transaction( $submission->country ); |
|
197 | - |
|
198 | - // Abort if we are not validating vat numbers. |
|
199 | - if ( ! $in_eu ) { |
|
113 | + * Checks if this is an eu country. |
|
114 | + * |
|
115 | + * @param string $country |
|
116 | + * @since 1.0.19 |
|
117 | + * @return bool |
|
118 | + */ |
|
119 | + public static function is_eu_country( $country ) { |
|
120 | + return getpaid_is_eu_state( $country ) || getpaid_is_gst_country( $country ); |
|
121 | + } |
|
122 | + |
|
123 | + /** |
|
124 | + * Checks if this is an eu purchase. |
|
125 | + * |
|
126 | + * @param string $customer_country |
|
127 | + * @since 1.0.19 |
|
128 | + * @return bool |
|
129 | + */ |
|
130 | + public static function is_eu_transaction( $customer_country ) { |
|
131 | + return self::is_eu_country( $customer_country ) && self::is_eu_store(); |
|
132 | + } |
|
133 | + |
|
134 | + /** |
|
135 | + * Retrieves the vat number. |
|
136 | + * |
|
137 | + * @param GetPaid_Payment_Form_Submission $submission |
|
138 | + * @since 1.0.19 |
|
139 | + * @return string |
|
140 | + */ |
|
141 | + public function get_vat_number( $submission ) { |
|
142 | + |
|
143 | + // Retrieve from the posted number. |
|
144 | + $vat_number = $submission->get_field( 'wpinv_vat_number', 'billing' ); |
|
145 | + if ( ! is_null( $vat_number ) ) { |
|
146 | + return wpinv_clean( $vat_number ); |
|
147 | + } |
|
148 | + |
|
149 | + return $submission->has_invoice() ? $submission->get_invoice()->get_vat_number() : ''; |
|
150 | + } |
|
151 | + |
|
152 | + /** |
|
153 | + * Retrieves the company. |
|
154 | + * |
|
155 | + * @param GetPaid_Payment_Form_Submission $submission |
|
156 | + * @since 1.0.19 |
|
157 | + * @return string |
|
158 | + */ |
|
159 | + public function get_company( $submission ) { |
|
160 | + |
|
161 | + // Retrieve from the posted data. |
|
162 | + $company = $submission->get_field( 'wpinv_company', 'billing' ); |
|
163 | + if ( ! empty( $company ) ) { |
|
164 | + return wpinv_clean( $company ); |
|
165 | + } |
|
166 | + |
|
167 | + // Retrieve from the invoice. |
|
168 | + return $submission->has_invoice() ? $submission->get_invoice()->get_company() : ''; |
|
169 | + } |
|
170 | + |
|
171 | + /** |
|
172 | + * Checks if we require a VAT number. |
|
173 | + * |
|
174 | + * @param bool $ip_in_eu Whether the customer IP is from the EU |
|
175 | + * @param bool $country_in_eu Whether the customer country is from the EU |
|
176 | + * @since 1.0.19 |
|
177 | + * @return string |
|
178 | + */ |
|
179 | + public function requires_vat( $ip_in_eu, $country_in_eu ) { |
|
180 | + |
|
181 | + $prevent_b2c = wpinv_get_option( 'vat_prevent_b2c_purchase' ); |
|
182 | + $prevent_b2c = ! empty( $prevent_b2c ); |
|
183 | + $is_eu = $ip_in_eu || $country_in_eu; |
|
184 | + |
|
185 | + return $prevent_b2c && $is_eu; |
|
186 | + } |
|
187 | + |
|
188 | + /** |
|
189 | + * Validate VAT data. |
|
190 | + * |
|
191 | + * @param GetPaid_Payment_Form_Submission $submission |
|
192 | + * @since 1.0.19 |
|
193 | + */ |
|
194 | + public function validate_vat( $submission ) { |
|
195 | + |
|
196 | + $in_eu = $this->is_eu_transaction( $submission->country ); |
|
197 | + |
|
198 | + // Abort if we are not validating vat numbers. |
|
199 | + if ( ! $in_eu ) { |
|
200 | 200 | return; |
201 | - } |
|
201 | + } |
|
202 | 202 | |
203 | - // Prepare variables. |
|
204 | - $vat_number = $this->get_vat_number( $submission ); |
|
205 | - $ip_country = getpaid_get_ip_country(); |
|
203 | + // Prepare variables. |
|
204 | + $vat_number = $this->get_vat_number( $submission ); |
|
205 | + $ip_country = getpaid_get_ip_country(); |
|
206 | 206 | $is_eu = $this->is_eu_country( $submission->country ); |
207 | 207 | $is_ip_eu = $this->is_eu_country( $ip_country ); |
208 | 208 | |
209 | - // Maybe abort early for initial fetches. |
|
210 | - if ( $submission->is_initial_fetch() && empty( $vat_number ) ) { |
|
211 | - return; |
|
212 | - } |
|
209 | + // Maybe abort early for initial fetches. |
|
210 | + if ( $submission->is_initial_fetch() && empty( $vat_number ) ) { |
|
211 | + return; |
|
212 | + } |
|
213 | 213 | |
214 | - // If we're preventing business to consumer purchases, |
|
215 | - if ( $this->requires_vat( $is_ip_eu, $is_eu ) && empty( $vat_number ) ) { |
|
214 | + // If we're preventing business to consumer purchases, |
|
215 | + if ( $this->requires_vat( $is_ip_eu, $is_eu ) && empty( $vat_number ) ) { |
|
216 | 216 | |
217 | - // Ensure that a vat number has been specified. |
|
218 | - throw new Exception( |
|
219 | - __( 'Please enter your VAT number to verify your purchase is by an EU business.', 'invoicing' ) |
|
220 | - ); |
|
217 | + // Ensure that a vat number has been specified. |
|
218 | + throw new Exception( |
|
219 | + __( 'Please enter your VAT number to verify your purchase is by an EU business.', 'invoicing' ) |
|
220 | + ); |
|
221 | 221 | |
222 | - } |
|
222 | + } |
|
223 | 223 | |
224 | - if ( empty( $vat_number ) ) { |
|
225 | - return; |
|
226 | - } |
|
224 | + if ( empty( $vat_number ) ) { |
|
225 | + return; |
|
226 | + } |
|
227 | 227 | |
228 | - if ( wpinv_should_validate_vat_number() && ! wpinv_validate_vat_number( $vat_number, $submission->country ) ) { |
|
229 | - throw new Exception( __( 'Your VAT number is invalid', 'invoicing' ) ); |
|
230 | - } |
|
228 | + if ( wpinv_should_validate_vat_number() && ! wpinv_validate_vat_number( $vat_number, $submission->country ) ) { |
|
229 | + throw new Exception( __( 'Your VAT number is invalid', 'invoicing' ) ); |
|
230 | + } |
|
231 | 231 | |
232 | - if ( wpinv_default_billing_country() == $submission->country && 'vat_too' == wpinv_get_option( 'vat_same_country_rule', 'vat_too' ) ) { |
|
233 | - return; |
|
234 | - } |
|
232 | + if ( wpinv_default_billing_country() == $submission->country && 'vat_too' == wpinv_get_option( 'vat_same_country_rule', 'vat_too' ) ) { |
|
233 | + return; |
|
234 | + } |
|
235 | 235 | |
236 | - $this->skip_taxes = true; |
|
237 | - } |
|
236 | + $this->skip_taxes = true; |
|
237 | + } |
|
238 | 238 | |
239 | 239 | } |
@@ -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,234 +88,234 @@ 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 ( empty( $quantity ) || 1 > $quantity ) { |
|
174 | - $quantity = 1; |
|
175 | - } |
|
176 | - |
|
177 | - if ( 'view' == $context ) { |
|
178 | - return apply_filters( 'getpaid_payment_form_item_quantity', $quantity, $this ); |
|
179 | - } |
|
180 | - |
|
181 | - return $quantity; |
|
182 | - |
|
183 | - } |
|
184 | - |
|
185 | - /** |
|
186 | - * Get the item meta data. |
|
187 | - * |
|
188 | - * @since 1.0.19 |
|
189 | - * @param string $context View or edit context. |
|
190 | - * @return meta |
|
191 | - */ |
|
192 | - public function get_item_meta( $context = 'view' ) { |
|
193 | - $meta = $this->meta; |
|
194 | - |
|
195 | - if ( 'view' == $context ) { |
|
196 | - return apply_filters( 'getpaid_payment_form_item_meta', $meta, $this ); |
|
197 | - } |
|
198 | - |
|
199 | - return $meta; |
|
200 | - |
|
201 | - } |
|
202 | - |
|
203 | - /** |
|
204 | - * Returns whether or not customers can update the item quantity. |
|
205 | - * |
|
206 | - * @since 1.0.19 |
|
207 | - * @param string $context View or edit context. |
|
208 | - * @return bool |
|
209 | - */ |
|
210 | - public function get_allow_quantities( $context = 'view' ) { |
|
211 | - $allow_quantities = (bool) $this->allow_quantities; |
|
212 | - |
|
213 | - if ( 'view' == $context ) { |
|
214 | - return apply_filters( 'getpaid_payment_form_item_allow_quantities', $allow_quantities, $this ); |
|
215 | - } |
|
216 | - |
|
217 | - return $allow_quantities; |
|
218 | - |
|
219 | - } |
|
220 | - |
|
221 | - /** |
|
222 | - * Returns whether or not the item is required. |
|
223 | - * |
|
224 | - * @since 1.0.19 |
|
225 | - * @param string $context View or edit context. |
|
226 | - * @return bool |
|
227 | - */ |
|
228 | - public function get_is_required( $context = 'view' ) { |
|
229 | - $is_required = (bool) $this->is_required; |
|
230 | - |
|
231 | - if ( 'view' == $context ) { |
|
232 | - return apply_filters( 'getpaid_payment_form_item_is_required', $is_required, $this ); |
|
233 | - } |
|
234 | - |
|
235 | - return $is_required; |
|
236 | - |
|
237 | - } |
|
238 | - |
|
239 | - /** |
|
240 | - * Prepares form data for use. |
|
241 | - * |
|
242 | - * @since 1.0.19 |
|
243 | - * @return array |
|
244 | - */ |
|
245 | - public function prepare_data_for_use( $required = null ) { |
|
246 | - |
|
247 | - $required = is_null( $required ) ? $this->is_required() : $required; |
|
248 | - return array( |
|
249 | - 'title' => strip_tags( $this->get_name() ), |
|
250 | - 'id' => $this->get_id(), |
|
251 | - 'price' => $this->get_price(), |
|
252 | - 'recurring' => $this->is_recurring(), |
|
253 | - 'description' => $this->get_description(), |
|
254 | - 'allow_quantities' => $this->allows_quantities(), |
|
255 | - 'required' => $required, |
|
256 | - ); |
|
257 | - |
|
258 | - } |
|
259 | - |
|
260 | - /** |
|
261 | - * Prepares form data for ajax use. |
|
262 | - * |
|
263 | - * @since 1.0.19 |
|
264 | - * @return array |
|
265 | - */ |
|
266 | - public function prepare_data_for_invoice_edit_ajax( $currency = '', $is_renewal = false ) { |
|
267 | - |
|
268 | - $description = getpaid_item_recurring_price_help_text( $this, $currency ); |
|
269 | - |
|
270 | - if ( $description ) { |
|
271 | - $description = "<div class='getpaid-subscription-help-text'>$description</div>"; |
|
272 | - } |
|
273 | - |
|
274 | - $price = ! $is_renewal ? $this->get_price() : $this->get_recurring_price(); |
|
275 | - $subtotal = ! $is_renewal ? $this->get_sub_total() : $this->get_recurring_sub_total(); |
|
276 | - return array( |
|
277 | - 'id' => $this->get_id(), |
|
278 | - 'texts' => array( |
|
279 | - 'item-name' => sanitize_text_field( $this->get_name() ), |
|
280 | - 'item-description' => wp_kses_post( $this->get_description() ) . $description, |
|
281 | - 'item-quantity' => floatval( $this->get_quantity() ), |
|
282 | - 'item-price' => wpinv_price( $price, $currency ), |
|
283 | - 'item-total' => wpinv_price( $subtotal, $currency ), |
|
284 | - ), |
|
285 | - 'inputs' => array( |
|
286 | - 'item-id' => $this->get_id(), |
|
287 | - 'item-name' => sanitize_text_field( $this->get_name() ), |
|
288 | - 'item-description' => wp_kses_post( $this->get_description() ), |
|
289 | - 'item-quantity' => floatval( $this->get_quantity() ), |
|
290 | - 'item-price' => $price, |
|
291 | - ) |
|
292 | - ); |
|
293 | - |
|
294 | - } |
|
295 | - |
|
296 | - /** |
|
297 | - * Prepares form data for saving (cart_details). |
|
298 | - * |
|
299 | - * @since 1.0.19 |
|
300 | - * @return array |
|
301 | - */ |
|
302 | - public function prepare_data_for_saving() { |
|
303 | - |
|
304 | - return array( |
|
305 | - 'post_id' => $this->invoice_id, |
|
306 | - 'item_id' => $this->get_id(), |
|
307 | - 'item_name' => sanitize_text_field( $this->get_raw_name() ), |
|
308 | - 'item_description' => $this->get_description(), |
|
309 | - 'tax' => $this->item_tax, |
|
310 | - 'item_price' => $this->get_price(), |
|
311 | - 'quantity' => (float) $this->get_quantity(), |
|
312 | - 'discount' => $this->item_discount, |
|
313 | - 'subtotal' => $this->get_sub_total(), |
|
314 | - 'price' => $this->get_sub_total() + $this->item_tax - $this->item_discount, |
|
315 | - 'meta' => $this->get_item_meta(), |
|
316 | - ); |
|
317 | - |
|
318 | - } |
|
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 ( empty( $quantity ) || 1 > $quantity ) { |
|
174 | + $quantity = 1; |
|
175 | + } |
|
176 | + |
|
177 | + if ( 'view' == $context ) { |
|
178 | + return apply_filters( 'getpaid_payment_form_item_quantity', $quantity, $this ); |
|
179 | + } |
|
180 | + |
|
181 | + return $quantity; |
|
182 | + |
|
183 | + } |
|
184 | + |
|
185 | + /** |
|
186 | + * Get the item meta data. |
|
187 | + * |
|
188 | + * @since 1.0.19 |
|
189 | + * @param string $context View or edit context. |
|
190 | + * @return meta |
|
191 | + */ |
|
192 | + public function get_item_meta( $context = 'view' ) { |
|
193 | + $meta = $this->meta; |
|
194 | + |
|
195 | + if ( 'view' == $context ) { |
|
196 | + return apply_filters( 'getpaid_payment_form_item_meta', $meta, $this ); |
|
197 | + } |
|
198 | + |
|
199 | + return $meta; |
|
200 | + |
|
201 | + } |
|
202 | + |
|
203 | + /** |
|
204 | + * Returns whether or not customers can update the item quantity. |
|
205 | + * |
|
206 | + * @since 1.0.19 |
|
207 | + * @param string $context View or edit context. |
|
208 | + * @return bool |
|
209 | + */ |
|
210 | + public function get_allow_quantities( $context = 'view' ) { |
|
211 | + $allow_quantities = (bool) $this->allow_quantities; |
|
212 | + |
|
213 | + if ( 'view' == $context ) { |
|
214 | + return apply_filters( 'getpaid_payment_form_item_allow_quantities', $allow_quantities, $this ); |
|
215 | + } |
|
216 | + |
|
217 | + return $allow_quantities; |
|
218 | + |
|
219 | + } |
|
220 | + |
|
221 | + /** |
|
222 | + * Returns whether or not the item is required. |
|
223 | + * |
|
224 | + * @since 1.0.19 |
|
225 | + * @param string $context View or edit context. |
|
226 | + * @return bool |
|
227 | + */ |
|
228 | + public function get_is_required( $context = 'view' ) { |
|
229 | + $is_required = (bool) $this->is_required; |
|
230 | + |
|
231 | + if ( 'view' == $context ) { |
|
232 | + return apply_filters( 'getpaid_payment_form_item_is_required', $is_required, $this ); |
|
233 | + } |
|
234 | + |
|
235 | + return $is_required; |
|
236 | + |
|
237 | + } |
|
238 | + |
|
239 | + /** |
|
240 | + * Prepares form data for use. |
|
241 | + * |
|
242 | + * @since 1.0.19 |
|
243 | + * @return array |
|
244 | + */ |
|
245 | + public function prepare_data_for_use( $required = null ) { |
|
246 | + |
|
247 | + $required = is_null( $required ) ? $this->is_required() : $required; |
|
248 | + return array( |
|
249 | + 'title' => strip_tags( $this->get_name() ), |
|
250 | + 'id' => $this->get_id(), |
|
251 | + 'price' => $this->get_price(), |
|
252 | + 'recurring' => $this->is_recurring(), |
|
253 | + 'description' => $this->get_description(), |
|
254 | + 'allow_quantities' => $this->allows_quantities(), |
|
255 | + 'required' => $required, |
|
256 | + ); |
|
257 | + |
|
258 | + } |
|
259 | + |
|
260 | + /** |
|
261 | + * Prepares form data for ajax use. |
|
262 | + * |
|
263 | + * @since 1.0.19 |
|
264 | + * @return array |
|
265 | + */ |
|
266 | + public function prepare_data_for_invoice_edit_ajax( $currency = '', $is_renewal = false ) { |
|
267 | + |
|
268 | + $description = getpaid_item_recurring_price_help_text( $this, $currency ); |
|
269 | + |
|
270 | + if ( $description ) { |
|
271 | + $description = "<div class='getpaid-subscription-help-text'>$description</div>"; |
|
272 | + } |
|
273 | + |
|
274 | + $price = ! $is_renewal ? $this->get_price() : $this->get_recurring_price(); |
|
275 | + $subtotal = ! $is_renewal ? $this->get_sub_total() : $this->get_recurring_sub_total(); |
|
276 | + return array( |
|
277 | + 'id' => $this->get_id(), |
|
278 | + 'texts' => array( |
|
279 | + 'item-name' => sanitize_text_field( $this->get_name() ), |
|
280 | + 'item-description' => wp_kses_post( $this->get_description() ) . $description, |
|
281 | + 'item-quantity' => floatval( $this->get_quantity() ), |
|
282 | + 'item-price' => wpinv_price( $price, $currency ), |
|
283 | + 'item-total' => wpinv_price( $subtotal, $currency ), |
|
284 | + ), |
|
285 | + 'inputs' => array( |
|
286 | + 'item-id' => $this->get_id(), |
|
287 | + 'item-name' => sanitize_text_field( $this->get_name() ), |
|
288 | + 'item-description' => wp_kses_post( $this->get_description() ), |
|
289 | + 'item-quantity' => floatval( $this->get_quantity() ), |
|
290 | + 'item-price' => $price, |
|
291 | + ) |
|
292 | + ); |
|
293 | + |
|
294 | + } |
|
295 | + |
|
296 | + /** |
|
297 | + * Prepares form data for saving (cart_details). |
|
298 | + * |
|
299 | + * @since 1.0.19 |
|
300 | + * @return array |
|
301 | + */ |
|
302 | + public function prepare_data_for_saving() { |
|
303 | + |
|
304 | + return array( |
|
305 | + 'post_id' => $this->invoice_id, |
|
306 | + 'item_id' => $this->get_id(), |
|
307 | + 'item_name' => sanitize_text_field( $this->get_raw_name() ), |
|
308 | + 'item_description' => $this->get_description(), |
|
309 | + 'tax' => $this->item_tax, |
|
310 | + 'item_price' => $this->get_price(), |
|
311 | + 'quantity' => (float) $this->get_quantity(), |
|
312 | + 'discount' => $this->item_discount, |
|
313 | + 'subtotal' => $this->get_sub_total(), |
|
314 | + 'price' => $this->get_sub_total() + $this->item_tax - $this->item_discount, |
|
315 | + 'meta' => $this->get_item_meta(), |
|
316 | + ); |
|
317 | + |
|
318 | + } |
|
319 | 319 | |
320 | 320 | /* |
321 | 321 | |-------------------------------------------------------------------------- |
@@ -327,70 +327,70 @@ discard block |
||
327 | 327 | | object. |
328 | 328 | */ |
329 | 329 | |
330 | - /** |
|
331 | - * Set the item qantity. |
|
332 | - * |
|
333 | - * @since 1.0.19 |
|
334 | - * @param float $quantity The item quantity. |
|
335 | - */ |
|
336 | - public function set_quantity( $quantity ) { |
|
337 | - |
|
338 | - if ( empty( $quantity ) || ! is_numeric( $quantity ) ) { |
|
339 | - $quantity = 1; |
|
340 | - } |
|
341 | - |
|
342 | - $this->quantity = (float) $quantity; |
|
343 | - |
|
344 | - } |
|
345 | - |
|
346 | - /** |
|
347 | - * Set the item meta data. |
|
348 | - * |
|
349 | - * @since 1.0.19 |
|
350 | - * @param array $meta The item meta data. |
|
351 | - */ |
|
352 | - public function set_item_meta( $meta ) { |
|
353 | - $this->meta = maybe_unserialize( $meta ); |
|
354 | - } |
|
355 | - |
|
356 | - /** |
|
357 | - * Set whether or not the quantities are allowed. |
|
358 | - * |
|
359 | - * @since 1.0.19 |
|
360 | - * @param bool $allow_quantities |
|
361 | - */ |
|
362 | - public function set_allow_quantities( $allow_quantities ) { |
|
363 | - $this->allow_quantities = (bool) $allow_quantities; |
|
364 | - } |
|
365 | - |
|
366 | - /** |
|
367 | - * Set whether or not the item is required. |
|
368 | - * |
|
369 | - * @since 1.0.19 |
|
370 | - * @param bool $is_required |
|
371 | - */ |
|
372 | - public function set_is_required( $is_required ) { |
|
373 | - $this->is_required = (bool) $is_required; |
|
374 | - } |
|
375 | - |
|
376 | - /** |
|
377 | - * Sets the custom item description. |
|
378 | - * |
|
379 | - * @since 1.0.19 |
|
380 | - * @param string $description |
|
381 | - */ |
|
382 | - public function set_custom_description( $description ) { |
|
383 | - $this->custom_description = $description; |
|
384 | - } |
|
330 | + /** |
|
331 | + * Set the item qantity. |
|
332 | + * |
|
333 | + * @since 1.0.19 |
|
334 | + * @param float $quantity The item quantity. |
|
335 | + */ |
|
336 | + public function set_quantity( $quantity ) { |
|
337 | + |
|
338 | + if ( empty( $quantity ) || ! is_numeric( $quantity ) ) { |
|
339 | + $quantity = 1; |
|
340 | + } |
|
341 | + |
|
342 | + $this->quantity = (float) $quantity; |
|
343 | + |
|
344 | + } |
|
345 | + |
|
346 | + /** |
|
347 | + * Set the item meta data. |
|
348 | + * |
|
349 | + * @since 1.0.19 |
|
350 | + * @param array $meta The item meta data. |
|
351 | + */ |
|
352 | + public function set_item_meta( $meta ) { |
|
353 | + $this->meta = maybe_unserialize( $meta ); |
|
354 | + } |
|
355 | + |
|
356 | + /** |
|
357 | + * Set whether or not the quantities are allowed. |
|
358 | + * |
|
359 | + * @since 1.0.19 |
|
360 | + * @param bool $allow_quantities |
|
361 | + */ |
|
362 | + public function set_allow_quantities( $allow_quantities ) { |
|
363 | + $this->allow_quantities = (bool) $allow_quantities; |
|
364 | + } |
|
365 | + |
|
366 | + /** |
|
367 | + * Set whether or not the item is required. |
|
368 | + * |
|
369 | + * @since 1.0.19 |
|
370 | + * @param bool $is_required |
|
371 | + */ |
|
372 | + public function set_is_required( $is_required ) { |
|
373 | + $this->is_required = (bool) $is_required; |
|
374 | + } |
|
375 | + |
|
376 | + /** |
|
377 | + * Sets the custom item description. |
|
378 | + * |
|
379 | + * @since 1.0.19 |
|
380 | + * @param string $description |
|
381 | + */ |
|
382 | + public function set_custom_description( $description ) { |
|
383 | + $this->custom_description = $description; |
|
384 | + } |
|
385 | 385 | |
386 | 386 | /** |
387 | 387 | * We do not want to save items to the database. |
388 | 388 | * |
389 | - * @return int item id |
|
389 | + * @return int item id |
|
390 | 390 | */ |
391 | 391 | public function save( $data = array() ) { |
392 | 392 | return $this->get_id(); |
393 | - } |
|
393 | + } |
|
394 | 394 | |
395 | 395 | /* |
396 | 396 | |-------------------------------------------------------------------------- |
@@ -402,23 +402,23 @@ discard block |
||
402 | 402 | */ |
403 | 403 | |
404 | 404 | /** |
405 | - * Checks whether the item has enabled dynamic pricing. |
|
406 | - * |
|
407 | - * @since 1.0.19 |
|
408 | - * @return bool |
|
409 | - */ |
|
410 | - public function is_required() { |
|
405 | + * Checks whether the item has enabled dynamic pricing. |
|
406 | + * |
|
407 | + * @since 1.0.19 |
|
408 | + * @return bool |
|
409 | + */ |
|
410 | + public function is_required() { |
|
411 | 411 | return (bool) $this->get_is_required(); |
412 | - } |
|
413 | - |
|
414 | - /** |
|
415 | - * Checks whether users can edit the quantities. |
|
416 | - * |
|
417 | - * @since 1.0.19 |
|
418 | - * @return bool |
|
419 | - */ |
|
420 | - public function allows_quantities() { |
|
412 | + } |
|
413 | + |
|
414 | + /** |
|
415 | + * Checks whether users can edit the quantities. |
|
416 | + * |
|
417 | + * @since 1.0.19 |
|
418 | + * @return bool |
|
419 | + */ |
|
420 | + public function allows_quantities() { |
|
421 | 421 | return (bool) $this->get_allow_quantities(); |
422 | - } |
|
422 | + } |
|
423 | 423 | |
424 | 424 | } |