@@ -9,7 +9,7 @@ discard block |
||
9 | 9 | */ |
10 | 10 | |
11 | 11 | if ( ! defined( 'ABSPATH' ) ) { |
12 | - exit; |
|
12 | + exit; |
|
13 | 13 | } |
14 | 14 | |
15 | 15 | /** |
@@ -21,356 +21,356 @@ discard block |
||
21 | 21 | */ |
22 | 22 | abstract class GetPaid_Data { |
23 | 23 | |
24 | - /** |
|
25 | - * ID for this object. |
|
26 | - * |
|
27 | - * @since 1.0.19 |
|
28 | - * @var int |
|
29 | - */ |
|
30 | - protected $id = 0; |
|
31 | - |
|
32 | - /** |
|
33 | - * Core data for this object. Name value pairs (name + default value). |
|
34 | - * |
|
35 | - * @since 1.0.19 |
|
36 | - * @var array |
|
37 | - */ |
|
38 | - protected $data = array(); |
|
39 | - |
|
40 | - /** |
|
41 | - * Core data changes for this object. |
|
42 | - * |
|
43 | - * @since 1.0.19 |
|
44 | - * @var array |
|
45 | - */ |
|
46 | - protected $changes = array(); |
|
47 | - |
|
48 | - /** |
|
49 | - * This is false until the object is read from the DB. |
|
50 | - * |
|
51 | - * @since 1.0.19 |
|
52 | - * @var bool |
|
53 | - */ |
|
54 | - protected $object_read = false; |
|
55 | - |
|
56 | - /** |
|
57 | - * This is the name of this object type. |
|
58 | - * |
|
59 | - * @since 1.0.19 |
|
60 | - * @var string |
|
61 | - */ |
|
62 | - protected $object_type = 'data'; |
|
63 | - |
|
64 | - /** |
|
65 | - * Extra data for this object. Name value pairs (name + default value). |
|
66 | - * Used as a standard way for sub classes (like item types) to add |
|
67 | - * additional information to an inherited class. |
|
68 | - * |
|
69 | - * @since 1.0.19 |
|
70 | - * @var array |
|
71 | - */ |
|
72 | - protected $extra_data = array(); |
|
73 | - |
|
74 | - /** |
|
75 | - * Set to _data on construct so we can track and reset data if needed. |
|
76 | - * |
|
77 | - * @since 1.0.19 |
|
78 | - * @var array |
|
79 | - */ |
|
80 | - protected $default_data = array(); |
|
81 | - |
|
82 | - /** |
|
83 | - * Contains a reference to the data store for this class. |
|
84 | - * |
|
85 | - * @since 1.0.19 |
|
86 | - * @var GetPaid_Data_Store |
|
87 | - */ |
|
88 | - protected $data_store; |
|
89 | - |
|
90 | - /** |
|
91 | - * Stores meta in cache for future reads. |
|
92 | - * A group must be set to to enable caching. |
|
93 | - * |
|
94 | - * @since 1.0.19 |
|
95 | - * @var string |
|
96 | - */ |
|
97 | - protected $cache_group = ''; |
|
98 | - |
|
99 | - /** |
|
100 | - * Stores the last error. |
|
101 | - * |
|
102 | - * @since 1.0.19 |
|
103 | - * @var string |
|
104 | - */ |
|
105 | - public $last_error = ''; |
|
106 | - |
|
107 | - /** |
|
108 | - * Stores additional meta data. |
|
109 | - * |
|
110 | - * @since 1.0.19 |
|
111 | - * @var array |
|
112 | - */ |
|
113 | - protected $meta_data = null; |
|
114 | - |
|
115 | - /** |
|
116 | - * Default constructor. |
|
117 | - * |
|
118 | - * @param int|object|array|string $read ID to load from the DB (optional) or already queried data. |
|
119 | - */ |
|
120 | - public function __construct( $read = 0 ) { |
|
121 | - $this->data = array_merge( $this->data, $this->extra_data ); |
|
122 | - $this->default_data = $this->data; |
|
123 | - } |
|
124 | - |
|
125 | - /** |
|
126 | - * Only store the object ID to avoid serializing the data object instance. |
|
127 | - * |
|
128 | - * @return array |
|
129 | - */ |
|
130 | - public function __sleep() { |
|
131 | - return array( 'id' ); |
|
132 | - } |
|
133 | - |
|
134 | - /** |
|
135 | - * Re-run the constructor with the object ID. |
|
136 | - * |
|
137 | - * If the object no longer exists, remove the ID. |
|
138 | - */ |
|
139 | - public function __wakeup() { |
|
140 | - $this->__construct( absint( $this->id ) ); |
|
141 | - |
|
142 | - if ( ! empty( $this->last_error ) ) { |
|
143 | - $this->set_id( 0 ); |
|
144 | - } |
|
145 | - |
|
146 | - } |
|
147 | - |
|
148 | - /** |
|
149 | - * When the object is cloned, make sure meta is duplicated correctly. |
|
150 | - * |
|
151 | - * @since 1.0.19 |
|
152 | - */ |
|
153 | - public function __clone() { |
|
154 | - $this->maybe_read_meta_data(); |
|
155 | - if ( ! empty( $this->meta_data ) ) { |
|
156 | - foreach ( $this->meta_data as $array_key => $meta ) { |
|
157 | - $this->meta_data[ $array_key ] = clone $meta; |
|
158 | - if ( ! empty( $meta->id ) ) { |
|
159 | - $this->meta_data[ $array_key ]->id = null; |
|
160 | - } |
|
161 | - } |
|
162 | - } |
|
163 | - } |
|
164 | - |
|
165 | - /** |
|
166 | - * Get the data store. |
|
167 | - * |
|
168 | - * @since 1.0.19 |
|
169 | - * @return object |
|
170 | - */ |
|
171 | - public function get_data_store() { |
|
172 | - return $this->data_store; |
|
173 | - } |
|
174 | - |
|
175 | - /** |
|
176 | - * Get the object type. |
|
177 | - * |
|
178 | - * @since 1.0.19 |
|
179 | - * @return string |
|
180 | - */ |
|
181 | - public function get_object_type() { |
|
182 | - return $this->object_type; |
|
183 | - } |
|
184 | - |
|
185 | - /** |
|
186 | - * Returns the unique ID for this object. |
|
187 | - * |
|
188 | - * @since 1.0.19 |
|
189 | - * @return int |
|
190 | - */ |
|
191 | - public function get_id() { |
|
192 | - return $this->id; |
|
193 | - } |
|
194 | - |
|
195 | - /** |
|
196 | - * Get form status. |
|
197 | - * |
|
198 | - * @since 1.0.19 |
|
199 | - * @param string $context View or edit context. |
|
200 | - * @return string |
|
201 | - */ |
|
202 | - public function get_status( $context = 'view' ) { |
|
203 | - return $this->get_prop( 'status', $context ); |
|
204 | - } |
|
205 | - |
|
206 | - /** |
|
207 | - * Delete an object, set the ID to 0, and return result. |
|
208 | - * |
|
209 | - * @since 1.0.19 |
|
210 | - * @param bool $force_delete Should the data be deleted permanently. |
|
211 | - * @return bool result |
|
212 | - */ |
|
213 | - public function delete( $force_delete = false ) { |
|
214 | - if ( $this->data_store && $this->exists() ) { |
|
215 | - $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) ); |
|
216 | - $this->set_id( 0 ); |
|
217 | - return true; |
|
218 | - } |
|
219 | - return false; |
|
220 | - } |
|
221 | - |
|
222 | - /** |
|
223 | - * Save should create or update based on object existence. |
|
224 | - * |
|
225 | - * @since 1.0.19 |
|
226 | - * @return int |
|
227 | - */ |
|
228 | - public function save() { |
|
229 | - if ( ! $this->data_store ) { |
|
230 | - return $this->get_id(); |
|
231 | - } |
|
232 | - |
|
233 | - /** |
|
234 | - * Trigger action before saving to the DB. Allows you to adjust object props before save. |
|
235 | - * |
|
236 | - * @param GetPaid_Data $this The object being saved. |
|
237 | - * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
238 | - */ |
|
239 | - do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
240 | - |
|
241 | - if ( $this->get_id() ) { |
|
242 | - $this->data_store->update( $this ); |
|
243 | - } else { |
|
244 | - $this->data_store->create( $this ); |
|
245 | - } |
|
246 | - |
|
247 | - /** |
|
248 | - * Trigger action after saving to the DB. |
|
249 | - * |
|
250 | - * @param GetPaid_Data $this The object being saved. |
|
251 | - * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
252 | - */ |
|
253 | - do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
254 | - |
|
255 | - return $this->get_id(); |
|
256 | - } |
|
257 | - |
|
258 | - /** |
|
259 | - * Change data to JSON format. |
|
260 | - * |
|
261 | - * @since 1.0.19 |
|
262 | - * @return string Data in JSON format. |
|
263 | - */ |
|
264 | - public function __toString() { |
|
265 | - return wp_json_encode( $this->get_data() ); |
|
266 | - } |
|
267 | - |
|
268 | - /** |
|
269 | - * Returns all data for this object. |
|
270 | - * |
|
271 | - * @since 1.0.19 |
|
272 | - * @return array |
|
273 | - */ |
|
274 | - public function get_data() { |
|
275 | - return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) ); |
|
276 | - } |
|
277 | - |
|
278 | - /** |
|
279 | - * Returns array of expected data keys for this object. |
|
280 | - * |
|
281 | - * @since 1.0.19 |
|
282 | - * @return array |
|
283 | - */ |
|
284 | - public function get_data_keys() { |
|
285 | - return array_keys( $this->data ); |
|
286 | - } |
|
287 | - |
|
288 | - /** |
|
289 | - * Returns all "extra" data keys for an object (for sub objects like item types). |
|
290 | - * |
|
291 | - * @since 1.0.19 |
|
292 | - * @return array |
|
293 | - */ |
|
294 | - public function get_extra_data_keys() { |
|
295 | - return array_keys( $this->extra_data ); |
|
296 | - } |
|
297 | - |
|
298 | - /** |
|
299 | - * Filter null meta values from array. |
|
300 | - * |
|
301 | - * @since 1.0.19 |
|
302 | - * @param mixed $meta Meta value to check. |
|
303 | - * @return bool |
|
304 | - */ |
|
305 | - protected function filter_null_meta( $meta ) { |
|
306 | - return ! is_null( $meta->value ); |
|
307 | - } |
|
308 | - |
|
309 | - /** |
|
310 | - * Get All Meta Data. |
|
311 | - * |
|
312 | - * @since 1.0.19 |
|
313 | - * @return array of objects. |
|
314 | - */ |
|
315 | - public function get_meta_data() { |
|
316 | - $this->maybe_read_meta_data(); |
|
317 | - return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) ); |
|
318 | - } |
|
319 | - |
|
320 | - /** |
|
321 | - * Check if the key is an internal one. |
|
322 | - * |
|
323 | - * @since 1.0.19 |
|
324 | - * @param string $key Key to check. |
|
325 | - * @return bool true if it's an internal key, false otherwise |
|
326 | - */ |
|
327 | - protected function is_internal_meta_key( $key ) { |
|
328 | - $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true ); |
|
329 | - |
|
330 | - if ( ! $internal_meta_key ) { |
|
331 | - return false; |
|
332 | - } |
|
333 | - |
|
334 | - $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) ); |
|
335 | - |
|
336 | - if ( ! $has_setter_or_getter ) { |
|
337 | - return false; |
|
338 | - } |
|
339 | - |
|
340 | - /* translators: %s: $key Key to check */ |
|
341 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
342 | - |
|
343 | - return true; |
|
344 | - } |
|
345 | - |
|
346 | - /** |
|
347 | - * Magic method for setting data fields. |
|
348 | - * |
|
349 | - * This method does not update custom fields in the database. |
|
350 | - * |
|
351 | - * @since 1.0.19 |
|
352 | - * @access public |
|
353 | - * |
|
354 | - */ |
|
355 | - public function __set( $key, $value ) { |
|
356 | - |
|
357 | - if ( 'id' == strtolower( $key ) ) { |
|
358 | - return $this->set_id( $value ); |
|
359 | - } |
|
360 | - |
|
361 | - if ( method_exists( $this, "set_$key") ) { |
|
362 | - |
|
363 | - /* translators: %s: $key Key to set */ |
|
364 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
365 | - |
|
366 | - call_user_func( array( $this, "set_$key" ), $value ); |
|
367 | - } else { |
|
368 | - $this->set_prop( $key, $value ); |
|
369 | - } |
|
370 | - |
|
371 | - } |
|
372 | - |
|
373 | - /** |
|
24 | + /** |
|
25 | + * ID for this object. |
|
26 | + * |
|
27 | + * @since 1.0.19 |
|
28 | + * @var int |
|
29 | + */ |
|
30 | + protected $id = 0; |
|
31 | + |
|
32 | + /** |
|
33 | + * Core data for this object. Name value pairs (name + default value). |
|
34 | + * |
|
35 | + * @since 1.0.19 |
|
36 | + * @var array |
|
37 | + */ |
|
38 | + protected $data = array(); |
|
39 | + |
|
40 | + /** |
|
41 | + * Core data changes for this object. |
|
42 | + * |
|
43 | + * @since 1.0.19 |
|
44 | + * @var array |
|
45 | + */ |
|
46 | + protected $changes = array(); |
|
47 | + |
|
48 | + /** |
|
49 | + * This is false until the object is read from the DB. |
|
50 | + * |
|
51 | + * @since 1.0.19 |
|
52 | + * @var bool |
|
53 | + */ |
|
54 | + protected $object_read = false; |
|
55 | + |
|
56 | + /** |
|
57 | + * This is the name of this object type. |
|
58 | + * |
|
59 | + * @since 1.0.19 |
|
60 | + * @var string |
|
61 | + */ |
|
62 | + protected $object_type = 'data'; |
|
63 | + |
|
64 | + /** |
|
65 | + * Extra data for this object. Name value pairs (name + default value). |
|
66 | + * Used as a standard way for sub classes (like item types) to add |
|
67 | + * additional information to an inherited class. |
|
68 | + * |
|
69 | + * @since 1.0.19 |
|
70 | + * @var array |
|
71 | + */ |
|
72 | + protected $extra_data = array(); |
|
73 | + |
|
74 | + /** |
|
75 | + * Set to _data on construct so we can track and reset data if needed. |
|
76 | + * |
|
77 | + * @since 1.0.19 |
|
78 | + * @var array |
|
79 | + */ |
|
80 | + protected $default_data = array(); |
|
81 | + |
|
82 | + /** |
|
83 | + * Contains a reference to the data store for this class. |
|
84 | + * |
|
85 | + * @since 1.0.19 |
|
86 | + * @var GetPaid_Data_Store |
|
87 | + */ |
|
88 | + protected $data_store; |
|
89 | + |
|
90 | + /** |
|
91 | + * Stores meta in cache for future reads. |
|
92 | + * A group must be set to to enable caching. |
|
93 | + * |
|
94 | + * @since 1.0.19 |
|
95 | + * @var string |
|
96 | + */ |
|
97 | + protected $cache_group = ''; |
|
98 | + |
|
99 | + /** |
|
100 | + * Stores the last error. |
|
101 | + * |
|
102 | + * @since 1.0.19 |
|
103 | + * @var string |
|
104 | + */ |
|
105 | + public $last_error = ''; |
|
106 | + |
|
107 | + /** |
|
108 | + * Stores additional meta data. |
|
109 | + * |
|
110 | + * @since 1.0.19 |
|
111 | + * @var array |
|
112 | + */ |
|
113 | + protected $meta_data = null; |
|
114 | + |
|
115 | + /** |
|
116 | + * Default constructor. |
|
117 | + * |
|
118 | + * @param int|object|array|string $read ID to load from the DB (optional) or already queried data. |
|
119 | + */ |
|
120 | + public function __construct( $read = 0 ) { |
|
121 | + $this->data = array_merge( $this->data, $this->extra_data ); |
|
122 | + $this->default_data = $this->data; |
|
123 | + } |
|
124 | + |
|
125 | + /** |
|
126 | + * Only store the object ID to avoid serializing the data object instance. |
|
127 | + * |
|
128 | + * @return array |
|
129 | + */ |
|
130 | + public function __sleep() { |
|
131 | + return array( 'id' ); |
|
132 | + } |
|
133 | + |
|
134 | + /** |
|
135 | + * Re-run the constructor with the object ID. |
|
136 | + * |
|
137 | + * If the object no longer exists, remove the ID. |
|
138 | + */ |
|
139 | + public function __wakeup() { |
|
140 | + $this->__construct( absint( $this->id ) ); |
|
141 | + |
|
142 | + if ( ! empty( $this->last_error ) ) { |
|
143 | + $this->set_id( 0 ); |
|
144 | + } |
|
145 | + |
|
146 | + } |
|
147 | + |
|
148 | + /** |
|
149 | + * When the object is cloned, make sure meta is duplicated correctly. |
|
150 | + * |
|
151 | + * @since 1.0.19 |
|
152 | + */ |
|
153 | + public function __clone() { |
|
154 | + $this->maybe_read_meta_data(); |
|
155 | + if ( ! empty( $this->meta_data ) ) { |
|
156 | + foreach ( $this->meta_data as $array_key => $meta ) { |
|
157 | + $this->meta_data[ $array_key ] = clone $meta; |
|
158 | + if ( ! empty( $meta->id ) ) { |
|
159 | + $this->meta_data[ $array_key ]->id = null; |
|
160 | + } |
|
161 | + } |
|
162 | + } |
|
163 | + } |
|
164 | + |
|
165 | + /** |
|
166 | + * Get the data store. |
|
167 | + * |
|
168 | + * @since 1.0.19 |
|
169 | + * @return object |
|
170 | + */ |
|
171 | + public function get_data_store() { |
|
172 | + return $this->data_store; |
|
173 | + } |
|
174 | + |
|
175 | + /** |
|
176 | + * Get the object type. |
|
177 | + * |
|
178 | + * @since 1.0.19 |
|
179 | + * @return string |
|
180 | + */ |
|
181 | + public function get_object_type() { |
|
182 | + return $this->object_type; |
|
183 | + } |
|
184 | + |
|
185 | + /** |
|
186 | + * Returns the unique ID for this object. |
|
187 | + * |
|
188 | + * @since 1.0.19 |
|
189 | + * @return int |
|
190 | + */ |
|
191 | + public function get_id() { |
|
192 | + return $this->id; |
|
193 | + } |
|
194 | + |
|
195 | + /** |
|
196 | + * Get form status. |
|
197 | + * |
|
198 | + * @since 1.0.19 |
|
199 | + * @param string $context View or edit context. |
|
200 | + * @return string |
|
201 | + */ |
|
202 | + public function get_status( $context = 'view' ) { |
|
203 | + return $this->get_prop( 'status', $context ); |
|
204 | + } |
|
205 | + |
|
206 | + /** |
|
207 | + * Delete an object, set the ID to 0, and return result. |
|
208 | + * |
|
209 | + * @since 1.0.19 |
|
210 | + * @param bool $force_delete Should the data be deleted permanently. |
|
211 | + * @return bool result |
|
212 | + */ |
|
213 | + public function delete( $force_delete = false ) { |
|
214 | + if ( $this->data_store && $this->exists() ) { |
|
215 | + $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) ); |
|
216 | + $this->set_id( 0 ); |
|
217 | + return true; |
|
218 | + } |
|
219 | + return false; |
|
220 | + } |
|
221 | + |
|
222 | + /** |
|
223 | + * Save should create or update based on object existence. |
|
224 | + * |
|
225 | + * @since 1.0.19 |
|
226 | + * @return int |
|
227 | + */ |
|
228 | + public function save() { |
|
229 | + if ( ! $this->data_store ) { |
|
230 | + return $this->get_id(); |
|
231 | + } |
|
232 | + |
|
233 | + /** |
|
234 | + * Trigger action before saving to the DB. Allows you to adjust object props before save. |
|
235 | + * |
|
236 | + * @param GetPaid_Data $this The object being saved. |
|
237 | + * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
238 | + */ |
|
239 | + do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
240 | + |
|
241 | + if ( $this->get_id() ) { |
|
242 | + $this->data_store->update( $this ); |
|
243 | + } else { |
|
244 | + $this->data_store->create( $this ); |
|
245 | + } |
|
246 | + |
|
247 | + /** |
|
248 | + * Trigger action after saving to the DB. |
|
249 | + * |
|
250 | + * @param GetPaid_Data $this The object being saved. |
|
251 | + * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
252 | + */ |
|
253 | + do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
254 | + |
|
255 | + return $this->get_id(); |
|
256 | + } |
|
257 | + |
|
258 | + /** |
|
259 | + * Change data to JSON format. |
|
260 | + * |
|
261 | + * @since 1.0.19 |
|
262 | + * @return string Data in JSON format. |
|
263 | + */ |
|
264 | + public function __toString() { |
|
265 | + return wp_json_encode( $this->get_data() ); |
|
266 | + } |
|
267 | + |
|
268 | + /** |
|
269 | + * Returns all data for this object. |
|
270 | + * |
|
271 | + * @since 1.0.19 |
|
272 | + * @return array |
|
273 | + */ |
|
274 | + public function get_data() { |
|
275 | + return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) ); |
|
276 | + } |
|
277 | + |
|
278 | + /** |
|
279 | + * Returns array of expected data keys for this object. |
|
280 | + * |
|
281 | + * @since 1.0.19 |
|
282 | + * @return array |
|
283 | + */ |
|
284 | + public function get_data_keys() { |
|
285 | + return array_keys( $this->data ); |
|
286 | + } |
|
287 | + |
|
288 | + /** |
|
289 | + * Returns all "extra" data keys for an object (for sub objects like item types). |
|
290 | + * |
|
291 | + * @since 1.0.19 |
|
292 | + * @return array |
|
293 | + */ |
|
294 | + public function get_extra_data_keys() { |
|
295 | + return array_keys( $this->extra_data ); |
|
296 | + } |
|
297 | + |
|
298 | + /** |
|
299 | + * Filter null meta values from array. |
|
300 | + * |
|
301 | + * @since 1.0.19 |
|
302 | + * @param mixed $meta Meta value to check. |
|
303 | + * @return bool |
|
304 | + */ |
|
305 | + protected function filter_null_meta( $meta ) { |
|
306 | + return ! is_null( $meta->value ); |
|
307 | + } |
|
308 | + |
|
309 | + /** |
|
310 | + * Get All Meta Data. |
|
311 | + * |
|
312 | + * @since 1.0.19 |
|
313 | + * @return array of objects. |
|
314 | + */ |
|
315 | + public function get_meta_data() { |
|
316 | + $this->maybe_read_meta_data(); |
|
317 | + return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) ); |
|
318 | + } |
|
319 | + |
|
320 | + /** |
|
321 | + * Check if the key is an internal one. |
|
322 | + * |
|
323 | + * @since 1.0.19 |
|
324 | + * @param string $key Key to check. |
|
325 | + * @return bool true if it's an internal key, false otherwise |
|
326 | + */ |
|
327 | + protected function is_internal_meta_key( $key ) { |
|
328 | + $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true ); |
|
329 | + |
|
330 | + if ( ! $internal_meta_key ) { |
|
331 | + return false; |
|
332 | + } |
|
333 | + |
|
334 | + $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) ); |
|
335 | + |
|
336 | + if ( ! $has_setter_or_getter ) { |
|
337 | + return false; |
|
338 | + } |
|
339 | + |
|
340 | + /* translators: %s: $key Key to check */ |
|
341 | + getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
342 | + |
|
343 | + return true; |
|
344 | + } |
|
345 | + |
|
346 | + /** |
|
347 | + * Magic method for setting data fields. |
|
348 | + * |
|
349 | + * This method does not update custom fields in the database. |
|
350 | + * |
|
351 | + * @since 1.0.19 |
|
352 | + * @access public |
|
353 | + * |
|
354 | + */ |
|
355 | + public function __set( $key, $value ) { |
|
356 | + |
|
357 | + if ( 'id' == strtolower( $key ) ) { |
|
358 | + return $this->set_id( $value ); |
|
359 | + } |
|
360 | + |
|
361 | + if ( method_exists( $this, "set_$key") ) { |
|
362 | + |
|
363 | + /* translators: %s: $key Key to set */ |
|
364 | + getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
365 | + |
|
366 | + call_user_func( array( $this, "set_$key" ), $value ); |
|
367 | + } else { |
|
368 | + $this->set_prop( $key, $value ); |
|
369 | + } |
|
370 | + |
|
371 | + } |
|
372 | + |
|
373 | + /** |
|
374 | 374 | * Margic method for retrieving a property. |
375 | 375 | */ |
376 | 376 | public function __get( $key ) { |
@@ -378,10 +378,10 @@ discard block |
||
378 | 378 | // Check if we have a helper method for that. |
379 | 379 | if ( method_exists( $this, 'get_' . $key ) ) { |
380 | 380 | |
381 | - if ( 'post_type' != $key ) { |
|
382 | - /* translators: %s: $key Key to set */ |
|
383 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
384 | - } |
|
381 | + if ( 'post_type' != $key ) { |
|
382 | + /* translators: %s: $key Key to set */ |
|
383 | + getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
384 | + } |
|
385 | 385 | |
386 | 386 | return call_user_func( array( $this, 'get_' . $key ) ); |
387 | 387 | } |
@@ -391,512 +391,512 @@ discard block |
||
391 | 391 | return $this->post->$key; |
392 | 392 | } |
393 | 393 | |
394 | - return $this->get_prop( $key ); |
|
395 | - |
|
396 | - } |
|
397 | - |
|
398 | - /** |
|
399 | - * Get Meta Data by Key. |
|
400 | - * |
|
401 | - * @since 1.0.19 |
|
402 | - * @param string $key Meta Key. |
|
403 | - * @param bool $single return first found meta with key, or all with $key. |
|
404 | - * @param string $context What the value is for. Valid values are view and edit. |
|
405 | - * @return mixed |
|
406 | - */ |
|
407 | - public function get_meta( $key = '', $single = true, $context = 'view' ) { |
|
408 | - |
|
409 | - // Check if this is an internal meta key. |
|
410 | - $_key = str_replace( '_wpinv', '', $key ); |
|
411 | - $_key = str_replace( 'wpinv', '', $_key ); |
|
412 | - if ( $this->is_internal_meta_key( $_key ) ) { |
|
413 | - $function = 'get_' . $_key; |
|
414 | - |
|
415 | - if ( is_callable( array( $this, $function ) ) ) { |
|
416 | - return $this->{$function}(); |
|
417 | - } |
|
418 | - } |
|
419 | - |
|
420 | - // Read the meta data if not yet read. |
|
421 | - $this->maybe_read_meta_data(); |
|
422 | - $meta_data = $this->get_meta_data(); |
|
423 | - $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true ); |
|
424 | - $value = $single ? '' : array(); |
|
425 | - |
|
426 | - if ( ! empty( $array_keys ) ) { |
|
427 | - // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()). |
|
428 | - if ( $single ) { |
|
429 | - $value = $meta_data[ current( $array_keys ) ]->value; |
|
430 | - } else { |
|
431 | - $value = array_intersect_key( $meta_data, array_flip( $array_keys ) ); |
|
432 | - } |
|
433 | - } |
|
434 | - |
|
435 | - if ( 'view' === $context ) { |
|
436 | - $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this ); |
|
437 | - } |
|
438 | - |
|
439 | - return $value; |
|
440 | - } |
|
441 | - |
|
442 | - /** |
|
443 | - * See if meta data exists, since get_meta always returns a '' or array(). |
|
444 | - * |
|
445 | - * @since 1.0.19 |
|
446 | - * @param string $key Meta Key. |
|
447 | - * @return boolean |
|
448 | - */ |
|
449 | - public function meta_exists( $key = '' ) { |
|
450 | - $this->maybe_read_meta_data(); |
|
451 | - $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' ); |
|
452 | - return in_array( $key, $array_keys, true ); |
|
453 | - } |
|
454 | - |
|
455 | - /** |
|
456 | - * Set all meta data from array. |
|
457 | - * |
|
458 | - * @since 1.0.19 |
|
459 | - * @param array $data Key/Value pairs. |
|
460 | - */ |
|
461 | - public function set_meta_data( $data ) { |
|
462 | - if ( ! empty( $data ) && is_array( $data ) ) { |
|
463 | - $this->maybe_read_meta_data(); |
|
464 | - foreach ( $data as $meta ) { |
|
465 | - $meta = (array) $meta; |
|
466 | - if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) { |
|
467 | - $this->meta_data[] = new GetPaid_Meta_Data( |
|
468 | - array( |
|
469 | - 'id' => $meta['id'], |
|
470 | - 'key' => $meta['key'], |
|
471 | - 'value' => $meta['value'], |
|
472 | - ) |
|
473 | - ); |
|
474 | - } |
|
475 | - } |
|
476 | - } |
|
477 | - } |
|
478 | - |
|
479 | - /** |
|
480 | - * Add meta data. |
|
481 | - * |
|
482 | - * @since 1.0.19 |
|
483 | - * |
|
484 | - * @param string $key Meta key. |
|
485 | - * @param string|array $value Meta value. |
|
486 | - * @param bool $unique Should this be a unique key?. |
|
487 | - */ |
|
488 | - public function add_meta_data( $key, $value, $unique = false ) { |
|
489 | - if ( $this->is_internal_meta_key( $key ) ) { |
|
490 | - $function = 'set_' . $key; |
|
491 | - |
|
492 | - if ( is_callable( array( $this, $function ) ) ) { |
|
493 | - return $this->{$function}( $value ); |
|
494 | - } |
|
495 | - } |
|
496 | - |
|
497 | - $this->maybe_read_meta_data(); |
|
498 | - if ( $unique ) { |
|
499 | - $this->delete_meta_data( $key ); |
|
500 | - } |
|
501 | - $this->meta_data[] = new GetPaid_Meta_Data( |
|
502 | - array( |
|
503 | - 'key' => $key, |
|
504 | - 'value' => $value, |
|
505 | - ) |
|
506 | - ); |
|
507 | - } |
|
508 | - |
|
509 | - /** |
|
510 | - * Update meta data by key or ID, if provided. |
|
511 | - * |
|
512 | - * @since 1.0.19 |
|
513 | - * |
|
514 | - * @param string $key Meta key. |
|
515 | - * @param string|array $value Meta value. |
|
516 | - * @param int $meta_id Meta ID. |
|
517 | - */ |
|
518 | - public function update_meta_data( $key, $value, $meta_id = 0 ) { |
|
519 | - if ( $this->is_internal_meta_key( $key ) ) { |
|
520 | - $function = 'set_' . $key; |
|
521 | - |
|
522 | - if ( is_callable( array( $this, $function ) ) ) { |
|
523 | - return $this->{$function}( $value ); |
|
524 | - } |
|
525 | - } |
|
526 | - |
|
527 | - $this->maybe_read_meta_data(); |
|
528 | - |
|
529 | - $array_key = false; |
|
530 | - |
|
531 | - if ( $meta_id ) { |
|
532 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true ); |
|
533 | - $array_key = $array_keys ? current( $array_keys ) : false; |
|
534 | - } else { |
|
535 | - // Find matches by key. |
|
536 | - $matches = array(); |
|
537 | - foreach ( $this->meta_data as $meta_data_array_key => $meta ) { |
|
538 | - if ( $meta->key === $key ) { |
|
539 | - $matches[] = $meta_data_array_key; |
|
540 | - } |
|
541 | - } |
|
542 | - |
|
543 | - if ( ! empty( $matches ) ) { |
|
544 | - // Set matches to null so only one key gets the new value. |
|
545 | - foreach ( $matches as $meta_data_array_key ) { |
|
546 | - $this->meta_data[ $meta_data_array_key ]->value = null; |
|
547 | - } |
|
548 | - $array_key = current( $matches ); |
|
549 | - } |
|
550 | - } |
|
551 | - |
|
552 | - if ( false !== $array_key ) { |
|
553 | - $meta = $this->meta_data[ $array_key ]; |
|
554 | - $meta->key = $key; |
|
555 | - $meta->value = $value; |
|
556 | - } else { |
|
557 | - $this->add_meta_data( $key, $value, true ); |
|
558 | - } |
|
559 | - } |
|
560 | - |
|
561 | - /** |
|
562 | - * Delete meta data. |
|
563 | - * |
|
564 | - * @since 1.0.19 |
|
565 | - * @param string $key Meta key. |
|
566 | - */ |
|
567 | - public function delete_meta_data( $key ) { |
|
568 | - $this->maybe_read_meta_data(); |
|
569 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true ); |
|
570 | - |
|
571 | - if ( $array_keys ) { |
|
572 | - foreach ( $array_keys as $array_key ) { |
|
573 | - $this->meta_data[ $array_key ]->value = null; |
|
574 | - } |
|
575 | - } |
|
576 | - } |
|
577 | - |
|
578 | - /** |
|
579 | - * Delete meta data. |
|
580 | - * |
|
581 | - * @since 1.0.19 |
|
582 | - * @param int $mid Meta ID. |
|
583 | - */ |
|
584 | - public function delete_meta_data_by_mid( $mid ) { |
|
585 | - $this->maybe_read_meta_data(); |
|
586 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true ); |
|
587 | - |
|
588 | - if ( $array_keys ) { |
|
589 | - foreach ( $array_keys as $array_key ) { |
|
590 | - $this->meta_data[ $array_key ]->value = null; |
|
591 | - } |
|
592 | - } |
|
593 | - } |
|
594 | - |
|
595 | - /** |
|
596 | - * Read meta data if null. |
|
597 | - * |
|
598 | - * @since 1.0.19 |
|
599 | - */ |
|
600 | - protected function maybe_read_meta_data() { |
|
601 | - if ( is_null( $this->meta_data ) ) { |
|
602 | - $this->read_meta_data(); |
|
603 | - } |
|
604 | - } |
|
605 | - |
|
606 | - /** |
|
607 | - * Read Meta Data from the database. Ignore any internal properties. |
|
608 | - * Uses it's own caches because get_metadata does not provide meta_ids. |
|
609 | - * |
|
610 | - * @since 1.0.19 |
|
611 | - * @param bool $force_read True to force a new DB read (and update cache). |
|
612 | - */ |
|
613 | - public function read_meta_data( $force_read = false ) { |
|
614 | - |
|
615 | - // Reset meta data. |
|
616 | - $this->meta_data = array(); |
|
617 | - |
|
618 | - // Maybe abort early. |
|
619 | - if ( ! $this->get_id() || ! $this->data_store ) { |
|
620 | - return; |
|
621 | - } |
|
622 | - |
|
623 | - // Only read from cache if the cache key is set. |
|
624 | - $cache_key = null; |
|
625 | - if ( ! $force_read && ! empty( $this->cache_group ) ) { |
|
626 | - $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
627 | - $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group ); |
|
628 | - } |
|
629 | - |
|
630 | - // Should we force read? |
|
631 | - if ( empty( $raw_meta_data ) ) { |
|
632 | - $raw_meta_data = $this->data_store->read_meta( $this ); |
|
633 | - |
|
634 | - if ( ! empty( $cache_key ) ) { |
|
635 | - wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group ); |
|
636 | - } |
|
637 | - |
|
638 | - } |
|
639 | - |
|
640 | - // Set meta data. |
|
641 | - if ( is_array( $raw_meta_data ) ) { |
|
642 | - |
|
643 | - foreach ( $raw_meta_data as $meta ) { |
|
644 | - $this->meta_data[] = new GetPaid_Meta_Data( |
|
645 | - array( |
|
646 | - 'id' => (int) $meta->meta_id, |
|
647 | - 'key' => $meta->meta_key, |
|
648 | - 'value' => maybe_unserialize( $meta->meta_value ), |
|
649 | - ) |
|
650 | - ); |
|
651 | - } |
|
652 | - |
|
653 | - } |
|
654 | - |
|
655 | - } |
|
656 | - |
|
657 | - /** |
|
658 | - * Update Meta Data in the database. |
|
659 | - * |
|
660 | - * @since 1.0.19 |
|
661 | - */ |
|
662 | - public function save_meta_data() { |
|
663 | - if ( ! $this->data_store || is_null( $this->meta_data ) ) { |
|
664 | - return; |
|
665 | - } |
|
666 | - foreach ( $this->meta_data as $array_key => $meta ) { |
|
667 | - if ( is_null( $meta->value ) ) { |
|
668 | - if ( ! empty( $meta->id ) ) { |
|
669 | - $this->data_store->delete_meta( $this, $meta ); |
|
670 | - unset( $this->meta_data[ $array_key ] ); |
|
671 | - } |
|
672 | - } elseif ( empty( $meta->id ) ) { |
|
673 | - $meta->id = $this->data_store->add_meta( $this, $meta ); |
|
674 | - $meta->apply_changes(); |
|
675 | - } else { |
|
676 | - if ( $meta->get_changes() ) { |
|
677 | - $this->data_store->update_meta( $this, $meta ); |
|
678 | - $meta->apply_changes(); |
|
679 | - } |
|
680 | - } |
|
681 | - } |
|
682 | - if ( ! empty( $this->cache_group ) ) { |
|
683 | - $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
684 | - wp_cache_delete( $cache_key, $this->cache_group ); |
|
685 | - } |
|
686 | - } |
|
687 | - |
|
688 | - /** |
|
689 | - * Set ID. |
|
690 | - * |
|
691 | - * @since 1.0.19 |
|
692 | - * @param int $id ID. |
|
693 | - */ |
|
694 | - public function set_id( $id ) { |
|
695 | - $this->id = absint( $id ); |
|
696 | - } |
|
697 | - |
|
698 | - /** |
|
699 | - * Sets item status. |
|
700 | - * |
|
701 | - * @since 1.0.19 |
|
702 | - * @param string $status New status. |
|
703 | - * @return array details of change. |
|
704 | - */ |
|
705 | - public function set_status( $status ) { |
|
394 | + return $this->get_prop( $key ); |
|
395 | + |
|
396 | + } |
|
397 | + |
|
398 | + /** |
|
399 | + * Get Meta Data by Key. |
|
400 | + * |
|
401 | + * @since 1.0.19 |
|
402 | + * @param string $key Meta Key. |
|
403 | + * @param bool $single return first found meta with key, or all with $key. |
|
404 | + * @param string $context What the value is for. Valid values are view and edit. |
|
405 | + * @return mixed |
|
406 | + */ |
|
407 | + public function get_meta( $key = '', $single = true, $context = 'view' ) { |
|
408 | + |
|
409 | + // Check if this is an internal meta key. |
|
410 | + $_key = str_replace( '_wpinv', '', $key ); |
|
411 | + $_key = str_replace( 'wpinv', '', $_key ); |
|
412 | + if ( $this->is_internal_meta_key( $_key ) ) { |
|
413 | + $function = 'get_' . $_key; |
|
414 | + |
|
415 | + if ( is_callable( array( $this, $function ) ) ) { |
|
416 | + return $this->{$function}(); |
|
417 | + } |
|
418 | + } |
|
419 | + |
|
420 | + // Read the meta data if not yet read. |
|
421 | + $this->maybe_read_meta_data(); |
|
422 | + $meta_data = $this->get_meta_data(); |
|
423 | + $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true ); |
|
424 | + $value = $single ? '' : array(); |
|
425 | + |
|
426 | + if ( ! empty( $array_keys ) ) { |
|
427 | + // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()). |
|
428 | + if ( $single ) { |
|
429 | + $value = $meta_data[ current( $array_keys ) ]->value; |
|
430 | + } else { |
|
431 | + $value = array_intersect_key( $meta_data, array_flip( $array_keys ) ); |
|
432 | + } |
|
433 | + } |
|
434 | + |
|
435 | + if ( 'view' === $context ) { |
|
436 | + $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this ); |
|
437 | + } |
|
438 | + |
|
439 | + return $value; |
|
440 | + } |
|
441 | + |
|
442 | + /** |
|
443 | + * See if meta data exists, since get_meta always returns a '' or array(). |
|
444 | + * |
|
445 | + * @since 1.0.19 |
|
446 | + * @param string $key Meta Key. |
|
447 | + * @return boolean |
|
448 | + */ |
|
449 | + public function meta_exists( $key = '' ) { |
|
450 | + $this->maybe_read_meta_data(); |
|
451 | + $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' ); |
|
452 | + return in_array( $key, $array_keys, true ); |
|
453 | + } |
|
454 | + |
|
455 | + /** |
|
456 | + * Set all meta data from array. |
|
457 | + * |
|
458 | + * @since 1.0.19 |
|
459 | + * @param array $data Key/Value pairs. |
|
460 | + */ |
|
461 | + public function set_meta_data( $data ) { |
|
462 | + if ( ! empty( $data ) && is_array( $data ) ) { |
|
463 | + $this->maybe_read_meta_data(); |
|
464 | + foreach ( $data as $meta ) { |
|
465 | + $meta = (array) $meta; |
|
466 | + if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) { |
|
467 | + $this->meta_data[] = new GetPaid_Meta_Data( |
|
468 | + array( |
|
469 | + 'id' => $meta['id'], |
|
470 | + 'key' => $meta['key'], |
|
471 | + 'value' => $meta['value'], |
|
472 | + ) |
|
473 | + ); |
|
474 | + } |
|
475 | + } |
|
476 | + } |
|
477 | + } |
|
478 | + |
|
479 | + /** |
|
480 | + * Add meta data. |
|
481 | + * |
|
482 | + * @since 1.0.19 |
|
483 | + * |
|
484 | + * @param string $key Meta key. |
|
485 | + * @param string|array $value Meta value. |
|
486 | + * @param bool $unique Should this be a unique key?. |
|
487 | + */ |
|
488 | + public function add_meta_data( $key, $value, $unique = false ) { |
|
489 | + if ( $this->is_internal_meta_key( $key ) ) { |
|
490 | + $function = 'set_' . $key; |
|
491 | + |
|
492 | + if ( is_callable( array( $this, $function ) ) ) { |
|
493 | + return $this->{$function}( $value ); |
|
494 | + } |
|
495 | + } |
|
496 | + |
|
497 | + $this->maybe_read_meta_data(); |
|
498 | + if ( $unique ) { |
|
499 | + $this->delete_meta_data( $key ); |
|
500 | + } |
|
501 | + $this->meta_data[] = new GetPaid_Meta_Data( |
|
502 | + array( |
|
503 | + 'key' => $key, |
|
504 | + 'value' => $value, |
|
505 | + ) |
|
506 | + ); |
|
507 | + } |
|
508 | + |
|
509 | + /** |
|
510 | + * Update meta data by key or ID, if provided. |
|
511 | + * |
|
512 | + * @since 1.0.19 |
|
513 | + * |
|
514 | + * @param string $key Meta key. |
|
515 | + * @param string|array $value Meta value. |
|
516 | + * @param int $meta_id Meta ID. |
|
517 | + */ |
|
518 | + public function update_meta_data( $key, $value, $meta_id = 0 ) { |
|
519 | + if ( $this->is_internal_meta_key( $key ) ) { |
|
520 | + $function = 'set_' . $key; |
|
521 | + |
|
522 | + if ( is_callable( array( $this, $function ) ) ) { |
|
523 | + return $this->{$function}( $value ); |
|
524 | + } |
|
525 | + } |
|
526 | + |
|
527 | + $this->maybe_read_meta_data(); |
|
528 | + |
|
529 | + $array_key = false; |
|
530 | + |
|
531 | + if ( $meta_id ) { |
|
532 | + $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true ); |
|
533 | + $array_key = $array_keys ? current( $array_keys ) : false; |
|
534 | + } else { |
|
535 | + // Find matches by key. |
|
536 | + $matches = array(); |
|
537 | + foreach ( $this->meta_data as $meta_data_array_key => $meta ) { |
|
538 | + if ( $meta->key === $key ) { |
|
539 | + $matches[] = $meta_data_array_key; |
|
540 | + } |
|
541 | + } |
|
542 | + |
|
543 | + if ( ! empty( $matches ) ) { |
|
544 | + // Set matches to null so only one key gets the new value. |
|
545 | + foreach ( $matches as $meta_data_array_key ) { |
|
546 | + $this->meta_data[ $meta_data_array_key ]->value = null; |
|
547 | + } |
|
548 | + $array_key = current( $matches ); |
|
549 | + } |
|
550 | + } |
|
551 | + |
|
552 | + if ( false !== $array_key ) { |
|
553 | + $meta = $this->meta_data[ $array_key ]; |
|
554 | + $meta->key = $key; |
|
555 | + $meta->value = $value; |
|
556 | + } else { |
|
557 | + $this->add_meta_data( $key, $value, true ); |
|
558 | + } |
|
559 | + } |
|
560 | + |
|
561 | + /** |
|
562 | + * Delete meta data. |
|
563 | + * |
|
564 | + * @since 1.0.19 |
|
565 | + * @param string $key Meta key. |
|
566 | + */ |
|
567 | + public function delete_meta_data( $key ) { |
|
568 | + $this->maybe_read_meta_data(); |
|
569 | + $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true ); |
|
570 | + |
|
571 | + if ( $array_keys ) { |
|
572 | + foreach ( $array_keys as $array_key ) { |
|
573 | + $this->meta_data[ $array_key ]->value = null; |
|
574 | + } |
|
575 | + } |
|
576 | + } |
|
577 | + |
|
578 | + /** |
|
579 | + * Delete meta data. |
|
580 | + * |
|
581 | + * @since 1.0.19 |
|
582 | + * @param int $mid Meta ID. |
|
583 | + */ |
|
584 | + public function delete_meta_data_by_mid( $mid ) { |
|
585 | + $this->maybe_read_meta_data(); |
|
586 | + $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true ); |
|
587 | + |
|
588 | + if ( $array_keys ) { |
|
589 | + foreach ( $array_keys as $array_key ) { |
|
590 | + $this->meta_data[ $array_key ]->value = null; |
|
591 | + } |
|
592 | + } |
|
593 | + } |
|
594 | + |
|
595 | + /** |
|
596 | + * Read meta data if null. |
|
597 | + * |
|
598 | + * @since 1.0.19 |
|
599 | + */ |
|
600 | + protected function maybe_read_meta_data() { |
|
601 | + if ( is_null( $this->meta_data ) ) { |
|
602 | + $this->read_meta_data(); |
|
603 | + } |
|
604 | + } |
|
605 | + |
|
606 | + /** |
|
607 | + * Read Meta Data from the database. Ignore any internal properties. |
|
608 | + * Uses it's own caches because get_metadata does not provide meta_ids. |
|
609 | + * |
|
610 | + * @since 1.0.19 |
|
611 | + * @param bool $force_read True to force a new DB read (and update cache). |
|
612 | + */ |
|
613 | + public function read_meta_data( $force_read = false ) { |
|
614 | + |
|
615 | + // Reset meta data. |
|
616 | + $this->meta_data = array(); |
|
617 | + |
|
618 | + // Maybe abort early. |
|
619 | + if ( ! $this->get_id() || ! $this->data_store ) { |
|
620 | + return; |
|
621 | + } |
|
622 | + |
|
623 | + // Only read from cache if the cache key is set. |
|
624 | + $cache_key = null; |
|
625 | + if ( ! $force_read && ! empty( $this->cache_group ) ) { |
|
626 | + $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
627 | + $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group ); |
|
628 | + } |
|
629 | + |
|
630 | + // Should we force read? |
|
631 | + if ( empty( $raw_meta_data ) ) { |
|
632 | + $raw_meta_data = $this->data_store->read_meta( $this ); |
|
633 | + |
|
634 | + if ( ! empty( $cache_key ) ) { |
|
635 | + wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group ); |
|
636 | + } |
|
637 | + |
|
638 | + } |
|
639 | + |
|
640 | + // Set meta data. |
|
641 | + if ( is_array( $raw_meta_data ) ) { |
|
642 | + |
|
643 | + foreach ( $raw_meta_data as $meta ) { |
|
644 | + $this->meta_data[] = new GetPaid_Meta_Data( |
|
645 | + array( |
|
646 | + 'id' => (int) $meta->meta_id, |
|
647 | + 'key' => $meta->meta_key, |
|
648 | + 'value' => maybe_unserialize( $meta->meta_value ), |
|
649 | + ) |
|
650 | + ); |
|
651 | + } |
|
652 | + |
|
653 | + } |
|
654 | + |
|
655 | + } |
|
656 | + |
|
657 | + /** |
|
658 | + * Update Meta Data in the database. |
|
659 | + * |
|
660 | + * @since 1.0.19 |
|
661 | + */ |
|
662 | + public function save_meta_data() { |
|
663 | + if ( ! $this->data_store || is_null( $this->meta_data ) ) { |
|
664 | + return; |
|
665 | + } |
|
666 | + foreach ( $this->meta_data as $array_key => $meta ) { |
|
667 | + if ( is_null( $meta->value ) ) { |
|
668 | + if ( ! empty( $meta->id ) ) { |
|
669 | + $this->data_store->delete_meta( $this, $meta ); |
|
670 | + unset( $this->meta_data[ $array_key ] ); |
|
671 | + } |
|
672 | + } elseif ( empty( $meta->id ) ) { |
|
673 | + $meta->id = $this->data_store->add_meta( $this, $meta ); |
|
674 | + $meta->apply_changes(); |
|
675 | + } else { |
|
676 | + if ( $meta->get_changes() ) { |
|
677 | + $this->data_store->update_meta( $this, $meta ); |
|
678 | + $meta->apply_changes(); |
|
679 | + } |
|
680 | + } |
|
681 | + } |
|
682 | + if ( ! empty( $this->cache_group ) ) { |
|
683 | + $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
684 | + wp_cache_delete( $cache_key, $this->cache_group ); |
|
685 | + } |
|
686 | + } |
|
687 | + |
|
688 | + /** |
|
689 | + * Set ID. |
|
690 | + * |
|
691 | + * @since 1.0.19 |
|
692 | + * @param int $id ID. |
|
693 | + */ |
|
694 | + public function set_id( $id ) { |
|
695 | + $this->id = absint( $id ); |
|
696 | + } |
|
697 | + |
|
698 | + /** |
|
699 | + * Sets item status. |
|
700 | + * |
|
701 | + * @since 1.0.19 |
|
702 | + * @param string $status New status. |
|
703 | + * @return array details of change. |
|
704 | + */ |
|
705 | + public function set_status( $status ) { |
|
706 | 706 | $old_status = $this->get_status(); |
707 | 707 | |
708 | - $this->set_prop( 'status', $status ); |
|
709 | - |
|
710 | - return array( |
|
711 | - 'from' => $old_status, |
|
712 | - 'to' => $status, |
|
713 | - ); |
|
714 | - } |
|
715 | - |
|
716 | - /** |
|
717 | - * Set all props to default values. |
|
718 | - * |
|
719 | - * @since 1.0.19 |
|
720 | - */ |
|
721 | - public function set_defaults() { |
|
722 | - $this->data = $this->default_data; |
|
723 | - $this->changes = array(); |
|
724 | - $this->set_object_read( false ); |
|
725 | - } |
|
726 | - |
|
727 | - /** |
|
728 | - * Set object read property. |
|
729 | - * |
|
730 | - * @since 1.0.19 |
|
731 | - * @param boolean $read Should read?. |
|
732 | - */ |
|
733 | - public function set_object_read( $read = true ) { |
|
734 | - $this->object_read = (bool) $read; |
|
735 | - } |
|
736 | - |
|
737 | - /** |
|
738 | - * Get object read property. |
|
739 | - * |
|
740 | - * @since 1.0.19 |
|
741 | - * @return boolean |
|
742 | - */ |
|
743 | - public function get_object_read() { |
|
744 | - return (bool) $this->object_read; |
|
745 | - } |
|
746 | - |
|
747 | - /** |
|
748 | - * Set a collection of props in one go, collect any errors, and return the result. |
|
749 | - * Only sets using public methods. |
|
750 | - * |
|
751 | - * @since 1.0.19 |
|
752 | - * |
|
753 | - * @param array $props Key value pairs to set. Key is the prop and should map to a setter function name. |
|
754 | - * @param string $context In what context to run this. |
|
755 | - * |
|
756 | - * @return bool|WP_Error |
|
757 | - */ |
|
758 | - public function set_props( $props, $context = 'set' ) { |
|
759 | - $errors = false; |
|
760 | - |
|
761 | - foreach ( $props as $prop => $value ) { |
|
762 | - try { |
|
763 | - /** |
|
764 | - * Checks if the prop being set is allowed, and the value is not null. |
|
765 | - */ |
|
766 | - if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) { |
|
767 | - continue; |
|
768 | - } |
|
769 | - $setter = "set_$prop"; |
|
770 | - |
|
771 | - if ( is_callable( array( $this, $setter ) ) ) { |
|
772 | - $this->{$setter}( $value ); |
|
773 | - } |
|
774 | - } catch ( Exception $e ) { |
|
775 | - if ( ! $errors ) { |
|
776 | - $errors = new WP_Error(); |
|
777 | - } |
|
778 | - $errors->add( $e->getCode(), $e->getMessage() ); |
|
779 | - $this->last_error = $e->getMessage(); |
|
780 | - } |
|
781 | - } |
|
782 | - |
|
783 | - return $errors && count( $errors->get_error_codes() ) ? $errors : true; |
|
784 | - } |
|
785 | - |
|
786 | - /** |
|
787 | - * Sets a prop for a setter method. |
|
788 | - * |
|
789 | - * This stores changes in a special array so we can track what needs saving |
|
790 | - * the the DB later. |
|
791 | - * |
|
792 | - * @since 1.0.19 |
|
793 | - * @param string $prop Name of prop to set. |
|
794 | - * @param mixed $value Value of the prop. |
|
795 | - */ |
|
796 | - protected function set_prop( $prop, $value ) { |
|
797 | - if ( array_key_exists( $prop, $this->data ) ) { |
|
798 | - if ( true === $this->object_read ) { |
|
799 | - if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) { |
|
800 | - $this->changes[ $prop ] = $value; |
|
801 | - } |
|
802 | - } else { |
|
803 | - $this->data[ $prop ] = $value; |
|
804 | - } |
|
805 | - } |
|
806 | - } |
|
807 | - |
|
808 | - /** |
|
809 | - * Return data changes only. |
|
810 | - * |
|
811 | - * @since 1.0.19 |
|
812 | - * @return array |
|
813 | - */ |
|
814 | - public function get_changes() { |
|
815 | - return $this->changes; |
|
816 | - } |
|
817 | - |
|
818 | - /** |
|
819 | - * Merge changes with data and clear. |
|
820 | - * |
|
821 | - * @since 1.0.19 |
|
822 | - */ |
|
823 | - public function apply_changes() { |
|
824 | - $this->data = array_replace_recursive( $this->data, $this->changes ); |
|
825 | - $this->changes = array(); |
|
826 | - } |
|
827 | - |
|
828 | - /** |
|
829 | - * Prefix for action and filter hooks on data. |
|
830 | - * |
|
831 | - * @since 1.0.19 |
|
832 | - * @return string |
|
833 | - */ |
|
834 | - protected function get_hook_prefix() { |
|
835 | - return 'wpinv_get_' . $this->object_type . '_'; |
|
836 | - } |
|
837 | - |
|
838 | - /** |
|
839 | - * Gets a prop for a getter method. |
|
840 | - * |
|
841 | - * Gets the value from either current pending changes, or the data itself. |
|
842 | - * Context controls what happens to the value before it's returned. |
|
843 | - * |
|
844 | - * @since 1.0.19 |
|
845 | - * @param string $prop Name of prop to get. |
|
846 | - * @param string $context What the value is for. Valid values are view and edit. |
|
847 | - * @return mixed |
|
848 | - */ |
|
849 | - protected function get_prop( $prop, $context = 'view' ) { |
|
850 | - $value = null; |
|
851 | - |
|
852 | - if ( array_key_exists( $prop, $this->data ) ) { |
|
853 | - $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ]; |
|
854 | - |
|
855 | - if ( 'view' === $context ) { |
|
856 | - $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this ); |
|
857 | - } |
|
858 | - } |
|
859 | - |
|
860 | - return $value; |
|
861 | - } |
|
862 | - |
|
863 | - /** |
|
864 | - * Sets a date prop whilst handling formatting and datetime objects. |
|
865 | - * |
|
866 | - * @since 1.0.19 |
|
867 | - * @param string $prop Name of prop to set. |
|
868 | - * @param string|integer $value Value of the prop. |
|
869 | - */ |
|
870 | - protected function set_date_prop( $prop, $value ) { |
|
871 | - |
|
872 | - if ( empty( $value ) ) { |
|
873 | - $this->set_prop( $prop, null ); |
|
874 | - return; |
|
875 | - } |
|
876 | - $this->set_prop( $prop, $value ); |
|
877 | - |
|
878 | - } |
|
879 | - |
|
880 | - /** |
|
881 | - * When invalid data is found, throw an exception unless reading from the DB. |
|
882 | - * |
|
883 | - * @since 1.0.19 |
|
884 | - * @param string $code Error code. |
|
885 | - * @param string $message Error message. |
|
886 | - */ |
|
887 | - protected function error( $code, $message ) { |
|
888 | - $this->last_error = $message; |
|
889 | - } |
|
890 | - |
|
891 | - /** |
|
892 | - * Checks if the object is saved in the database |
|
893 | - * |
|
894 | - * @since 1.0.19 |
|
895 | - * @return bool |
|
896 | - */ |
|
897 | - public function exists() { |
|
898 | - $id = $this->get_id(); |
|
899 | - return ! empty( $id ); |
|
900 | - } |
|
708 | + $this->set_prop( 'status', $status ); |
|
709 | + |
|
710 | + return array( |
|
711 | + 'from' => $old_status, |
|
712 | + 'to' => $status, |
|
713 | + ); |
|
714 | + } |
|
715 | + |
|
716 | + /** |
|
717 | + * Set all props to default values. |
|
718 | + * |
|
719 | + * @since 1.0.19 |
|
720 | + */ |
|
721 | + public function set_defaults() { |
|
722 | + $this->data = $this->default_data; |
|
723 | + $this->changes = array(); |
|
724 | + $this->set_object_read( false ); |
|
725 | + } |
|
726 | + |
|
727 | + /** |
|
728 | + * Set object read property. |
|
729 | + * |
|
730 | + * @since 1.0.19 |
|
731 | + * @param boolean $read Should read?. |
|
732 | + */ |
|
733 | + public function set_object_read( $read = true ) { |
|
734 | + $this->object_read = (bool) $read; |
|
735 | + } |
|
736 | + |
|
737 | + /** |
|
738 | + * Get object read property. |
|
739 | + * |
|
740 | + * @since 1.0.19 |
|
741 | + * @return boolean |
|
742 | + */ |
|
743 | + public function get_object_read() { |
|
744 | + return (bool) $this->object_read; |
|
745 | + } |
|
746 | + |
|
747 | + /** |
|
748 | + * Set a collection of props in one go, collect any errors, and return the result. |
|
749 | + * Only sets using public methods. |
|
750 | + * |
|
751 | + * @since 1.0.19 |
|
752 | + * |
|
753 | + * @param array $props Key value pairs to set. Key is the prop and should map to a setter function name. |
|
754 | + * @param string $context In what context to run this. |
|
755 | + * |
|
756 | + * @return bool|WP_Error |
|
757 | + */ |
|
758 | + public function set_props( $props, $context = 'set' ) { |
|
759 | + $errors = false; |
|
760 | + |
|
761 | + foreach ( $props as $prop => $value ) { |
|
762 | + try { |
|
763 | + /** |
|
764 | + * Checks if the prop being set is allowed, and the value is not null. |
|
765 | + */ |
|
766 | + if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) { |
|
767 | + continue; |
|
768 | + } |
|
769 | + $setter = "set_$prop"; |
|
770 | + |
|
771 | + if ( is_callable( array( $this, $setter ) ) ) { |
|
772 | + $this->{$setter}( $value ); |
|
773 | + } |
|
774 | + } catch ( Exception $e ) { |
|
775 | + if ( ! $errors ) { |
|
776 | + $errors = new WP_Error(); |
|
777 | + } |
|
778 | + $errors->add( $e->getCode(), $e->getMessage() ); |
|
779 | + $this->last_error = $e->getMessage(); |
|
780 | + } |
|
781 | + } |
|
782 | + |
|
783 | + return $errors && count( $errors->get_error_codes() ) ? $errors : true; |
|
784 | + } |
|
785 | + |
|
786 | + /** |
|
787 | + * Sets a prop for a setter method. |
|
788 | + * |
|
789 | + * This stores changes in a special array so we can track what needs saving |
|
790 | + * the the DB later. |
|
791 | + * |
|
792 | + * @since 1.0.19 |
|
793 | + * @param string $prop Name of prop to set. |
|
794 | + * @param mixed $value Value of the prop. |
|
795 | + */ |
|
796 | + protected function set_prop( $prop, $value ) { |
|
797 | + if ( array_key_exists( $prop, $this->data ) ) { |
|
798 | + if ( true === $this->object_read ) { |
|
799 | + if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) { |
|
800 | + $this->changes[ $prop ] = $value; |
|
801 | + } |
|
802 | + } else { |
|
803 | + $this->data[ $prop ] = $value; |
|
804 | + } |
|
805 | + } |
|
806 | + } |
|
807 | + |
|
808 | + /** |
|
809 | + * Return data changes only. |
|
810 | + * |
|
811 | + * @since 1.0.19 |
|
812 | + * @return array |
|
813 | + */ |
|
814 | + public function get_changes() { |
|
815 | + return $this->changes; |
|
816 | + } |
|
817 | + |
|
818 | + /** |
|
819 | + * Merge changes with data and clear. |
|
820 | + * |
|
821 | + * @since 1.0.19 |
|
822 | + */ |
|
823 | + public function apply_changes() { |
|
824 | + $this->data = array_replace_recursive( $this->data, $this->changes ); |
|
825 | + $this->changes = array(); |
|
826 | + } |
|
827 | + |
|
828 | + /** |
|
829 | + * Prefix for action and filter hooks on data. |
|
830 | + * |
|
831 | + * @since 1.0.19 |
|
832 | + * @return string |
|
833 | + */ |
|
834 | + protected function get_hook_prefix() { |
|
835 | + return 'wpinv_get_' . $this->object_type . '_'; |
|
836 | + } |
|
837 | + |
|
838 | + /** |
|
839 | + * Gets a prop for a getter method. |
|
840 | + * |
|
841 | + * Gets the value from either current pending changes, or the data itself. |
|
842 | + * Context controls what happens to the value before it's returned. |
|
843 | + * |
|
844 | + * @since 1.0.19 |
|
845 | + * @param string $prop Name of prop to get. |
|
846 | + * @param string $context What the value is for. Valid values are view and edit. |
|
847 | + * @return mixed |
|
848 | + */ |
|
849 | + protected function get_prop( $prop, $context = 'view' ) { |
|
850 | + $value = null; |
|
851 | + |
|
852 | + if ( array_key_exists( $prop, $this->data ) ) { |
|
853 | + $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ]; |
|
854 | + |
|
855 | + if ( 'view' === $context ) { |
|
856 | + $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this ); |
|
857 | + } |
|
858 | + } |
|
859 | + |
|
860 | + return $value; |
|
861 | + } |
|
862 | + |
|
863 | + /** |
|
864 | + * Sets a date prop whilst handling formatting and datetime objects. |
|
865 | + * |
|
866 | + * @since 1.0.19 |
|
867 | + * @param string $prop Name of prop to set. |
|
868 | + * @param string|integer $value Value of the prop. |
|
869 | + */ |
|
870 | + protected function set_date_prop( $prop, $value ) { |
|
871 | + |
|
872 | + if ( empty( $value ) ) { |
|
873 | + $this->set_prop( $prop, null ); |
|
874 | + return; |
|
875 | + } |
|
876 | + $this->set_prop( $prop, $value ); |
|
877 | + |
|
878 | + } |
|
879 | + |
|
880 | + /** |
|
881 | + * When invalid data is found, throw an exception unless reading from the DB. |
|
882 | + * |
|
883 | + * @since 1.0.19 |
|
884 | + * @param string $code Error code. |
|
885 | + * @param string $message Error message. |
|
886 | + */ |
|
887 | + protected function error( $code, $message ) { |
|
888 | + $this->last_error = $message; |
|
889 | + } |
|
890 | + |
|
891 | + /** |
|
892 | + * Checks if the object is saved in the database |
|
893 | + * |
|
894 | + * @since 1.0.19 |
|
895 | + * @return bool |
|
896 | + */ |
|
897 | + public function exists() { |
|
898 | + $id = $this->get_id(); |
|
899 | + return ! empty( $id ); |
|
900 | + } |
|
901 | 901 | |
902 | 902 | } |
@@ -5,7 +5,7 @@ discard block |
||
5 | 5 | * |
6 | 6 | */ |
7 | 7 | if ( ! defined( 'ABSPATH' ) ) { |
8 | - exit; |
|
8 | + exit; |
|
9 | 9 | } |
10 | 10 | |
11 | 11 | /** |
@@ -15,539 +15,539 @@ discard block |
||
15 | 15 | */ |
16 | 16 | class GetPaid_Invoice_Data_Store extends GetPaid_Data_Store_WP { |
17 | 17 | |
18 | - /** |
|
19 | - * Data stored in meta keys, but not considered "meta" for a discount. |
|
20 | - * |
|
21 | - * @since 1.0.19 |
|
22 | - * @var array |
|
23 | - */ |
|
24 | - protected $internal_meta_keys = array( |
|
25 | - '_wpinv_subscr_profile_id', |
|
26 | - '_wpinv_subscription_id', |
|
27 | - '_wpinv_taxes', |
|
28 | - '_wpinv_fees', |
|
29 | - '_wpinv_discounts', |
|
30 | - '_wpinv_submission_id', |
|
31 | - '_wpinv_payment_form', |
|
32 | - '_wpinv_is_viewed', |
|
33 | - '_wpinv_phone', |
|
34 | - 'wpinv_email_cc', |
|
35 | - 'wpinv_template', |
|
36 | - 'wpinv_created_via' |
|
37 | - ); |
|
38 | - |
|
39 | - /** |
|
40 | - * A map of meta keys to data props. |
|
41 | - * |
|
42 | - * @since 1.0.19 |
|
43 | - * |
|
44 | - * @var array |
|
45 | - */ |
|
46 | - protected $meta_key_to_props = array( |
|
47 | - '_wpinv_subscr_profile_id' => 'remote_subscription_id', |
|
48 | - '_wpinv_subscription_id' => 'subscription_id', |
|
49 | - '_wpinv_taxes' => 'taxes', |
|
50 | - '_wpinv_fees' => 'fees', |
|
51 | - '_wpinv_discounts' => 'discounts', |
|
52 | - '_wpinv_submission_id' => 'submission_id', |
|
53 | - '_wpinv_payment_form' => 'payment_form', |
|
54 | - '_wpinv_is_viewed' => 'is_viewed', |
|
55 | - 'wpinv_email_cc' => 'email_cc', |
|
56 | - 'wpinv_template' => 'template', |
|
57 | - 'wpinv_created_via' => 'created_via', |
|
58 | - '_wpinv_phone' => 'phone', |
|
59 | - ); |
|
60 | - |
|
61 | - /** |
|
62 | - * A map of database fields to data props. |
|
63 | - * |
|
64 | - * @since 1.0.19 |
|
65 | - * |
|
66 | - * @var array |
|
67 | - */ |
|
68 | - protected $database_fields_to_props = array( |
|
69 | - 'post_id' => 'id', |
|
70 | - 'number' => 'number', |
|
71 | - 'currency' => 'currency', |
|
72 | - 'key' => 'key', |
|
73 | - 'type' => 'type', |
|
74 | - 'mode' => 'mode', |
|
75 | - 'user_ip' => 'user_ip', |
|
76 | - 'first_name' => 'first_name', |
|
77 | - 'last_name' => 'last_name', |
|
78 | - 'address' => 'address', |
|
79 | - 'city' => 'city', |
|
80 | - 'state' => 'state', |
|
81 | - 'country' => 'country', |
|
82 | - 'zip' => 'zip', |
|
83 | - 'zip' => 'zip', |
|
84 | - 'adddress_confirmed' => 'address_confirmed', |
|
85 | - 'gateway' => 'gateway', |
|
86 | - 'transaction_id' => 'transaction_id', |
|
87 | - 'currency' => 'currency', |
|
88 | - 'subtotal' => 'subtotal', |
|
89 | - 'tax' => 'total_tax', |
|
90 | - 'fees_total' => 'total_fees', |
|
91 | - 'discount' => 'total_discount', |
|
92 | - 'total' => 'total', |
|
93 | - 'discount_code' => 'discount_code', |
|
94 | - 'disable_taxes' => 'disable_taxes', |
|
95 | - 'due_date' => 'due_date', |
|
96 | - 'completed_date' => 'completed_date', |
|
97 | - 'company' => 'company', |
|
98 | - 'vat_number' => 'vat_number', |
|
99 | - 'vat_rate' => 'vat_rate', |
|
100 | - ); |
|
101 | - |
|
102 | - /* |
|
18 | + /** |
|
19 | + * Data stored in meta keys, but not considered "meta" for a discount. |
|
20 | + * |
|
21 | + * @since 1.0.19 |
|
22 | + * @var array |
|
23 | + */ |
|
24 | + protected $internal_meta_keys = array( |
|
25 | + '_wpinv_subscr_profile_id', |
|
26 | + '_wpinv_subscription_id', |
|
27 | + '_wpinv_taxes', |
|
28 | + '_wpinv_fees', |
|
29 | + '_wpinv_discounts', |
|
30 | + '_wpinv_submission_id', |
|
31 | + '_wpinv_payment_form', |
|
32 | + '_wpinv_is_viewed', |
|
33 | + '_wpinv_phone', |
|
34 | + 'wpinv_email_cc', |
|
35 | + 'wpinv_template', |
|
36 | + 'wpinv_created_via' |
|
37 | + ); |
|
38 | + |
|
39 | + /** |
|
40 | + * A map of meta keys to data props. |
|
41 | + * |
|
42 | + * @since 1.0.19 |
|
43 | + * |
|
44 | + * @var array |
|
45 | + */ |
|
46 | + protected $meta_key_to_props = array( |
|
47 | + '_wpinv_subscr_profile_id' => 'remote_subscription_id', |
|
48 | + '_wpinv_subscription_id' => 'subscription_id', |
|
49 | + '_wpinv_taxes' => 'taxes', |
|
50 | + '_wpinv_fees' => 'fees', |
|
51 | + '_wpinv_discounts' => 'discounts', |
|
52 | + '_wpinv_submission_id' => 'submission_id', |
|
53 | + '_wpinv_payment_form' => 'payment_form', |
|
54 | + '_wpinv_is_viewed' => 'is_viewed', |
|
55 | + 'wpinv_email_cc' => 'email_cc', |
|
56 | + 'wpinv_template' => 'template', |
|
57 | + 'wpinv_created_via' => 'created_via', |
|
58 | + '_wpinv_phone' => 'phone', |
|
59 | + ); |
|
60 | + |
|
61 | + /** |
|
62 | + * A map of database fields to data props. |
|
63 | + * |
|
64 | + * @since 1.0.19 |
|
65 | + * |
|
66 | + * @var array |
|
67 | + */ |
|
68 | + protected $database_fields_to_props = array( |
|
69 | + 'post_id' => 'id', |
|
70 | + 'number' => 'number', |
|
71 | + 'currency' => 'currency', |
|
72 | + 'key' => 'key', |
|
73 | + 'type' => 'type', |
|
74 | + 'mode' => 'mode', |
|
75 | + 'user_ip' => 'user_ip', |
|
76 | + 'first_name' => 'first_name', |
|
77 | + 'last_name' => 'last_name', |
|
78 | + 'address' => 'address', |
|
79 | + 'city' => 'city', |
|
80 | + 'state' => 'state', |
|
81 | + 'country' => 'country', |
|
82 | + 'zip' => 'zip', |
|
83 | + 'zip' => 'zip', |
|
84 | + 'adddress_confirmed' => 'address_confirmed', |
|
85 | + 'gateway' => 'gateway', |
|
86 | + 'transaction_id' => 'transaction_id', |
|
87 | + 'currency' => 'currency', |
|
88 | + 'subtotal' => 'subtotal', |
|
89 | + 'tax' => 'total_tax', |
|
90 | + 'fees_total' => 'total_fees', |
|
91 | + 'discount' => 'total_discount', |
|
92 | + 'total' => 'total', |
|
93 | + 'discount_code' => 'discount_code', |
|
94 | + 'disable_taxes' => 'disable_taxes', |
|
95 | + 'due_date' => 'due_date', |
|
96 | + 'completed_date' => 'completed_date', |
|
97 | + 'company' => 'company', |
|
98 | + 'vat_number' => 'vat_number', |
|
99 | + 'vat_rate' => 'vat_rate', |
|
100 | + ); |
|
101 | + |
|
102 | + /* |
|
103 | 103 | |-------------------------------------------------------------------------- |
104 | 104 | | CRUD Methods |
105 | 105 | |-------------------------------------------------------------------------- |
106 | 106 | */ |
107 | 107 | |
108 | - /** |
|
109 | - * Method to create a new invoice in the database. |
|
110 | - * |
|
111 | - * @param WPInv_Invoice $invoice Invoice object. |
|
112 | - */ |
|
113 | - public function create( &$invoice ) { |
|
114 | - $invoice->set_version( WPINV_VERSION ); |
|
115 | - $invoice->set_date_created( current_time('mysql') ); |
|
116 | - |
|
117 | - // Create a new post. |
|
118 | - $id = wp_insert_post( |
|
119 | - apply_filters( |
|
120 | - 'getpaid_new_invoice_data', |
|
121 | - array( |
|
122 | - 'post_date' => $invoice->get_date_created( 'edit' ), |
|
123 | - 'post_type' => $invoice->get_post_type( 'edit' ), |
|
124 | - 'post_status' => $this->get_post_status( $invoice ), |
|
125 | - 'ping_status' => 'closed', |
|
126 | - 'post_author' => $invoice->get_user_id( 'edit' ), |
|
127 | - 'post_title' => $invoice->get_title( 'edit' ), |
|
128 | - 'post_excerpt' => $invoice->get_description( 'edit' ), |
|
129 | - 'post_parent' => $invoice->get_parent_id( 'edit' ), |
|
130 | - ) |
|
131 | - ), |
|
132 | - true |
|
133 | - ); |
|
134 | - |
|
135 | - if ( $id && ! is_wp_error( $id ) ) { |
|
136 | - |
|
137 | - // Update the new id and regenerate a title. |
|
138 | - $invoice->set_id( $id ); |
|
139 | - |
|
140 | - $invoice->maybe_set_number(); |
|
141 | - |
|
142 | - wp_update_post( |
|
143 | - array( |
|
144 | - 'ID' => $invoice->get_id(), |
|
145 | - 'post_title' => $invoice->get_number( 'edit' ), |
|
146 | - 'post_name' => $invoice->get_path( 'edit' ) |
|
147 | - ) |
|
148 | - ); |
|
149 | - |
|
150 | - // Save special fields and items. |
|
151 | - $this->save_special_fields( $invoice ); |
|
152 | - $this->save_items( $invoice ); |
|
153 | - |
|
154 | - // Update meta data. |
|
155 | - $this->update_post_meta( $invoice ); |
|
156 | - $invoice->save_meta_data(); |
|
157 | - |
|
158 | - // Apply changes. |
|
159 | - $invoice->apply_changes(); |
|
160 | - $this->clear_caches( $invoice ); |
|
161 | - |
|
162 | - // Fires after a new invoice is created. |
|
163 | - do_action( 'getpaid_new_invoice', $invoice ); |
|
164 | - return true; |
|
165 | - } |
|
166 | - |
|
167 | - if ( is_wp_error( $id ) ) { |
|
168 | - $invoice->last_error = $id->get_error_message(); |
|
169 | - } |
|
170 | - |
|
171 | - return false; |
|
172 | - } |
|
173 | - |
|
174 | - /** |
|
175 | - * Method to read an invoice from the database. |
|
176 | - * |
|
177 | - * @param WPInv_Invoice $invoice Invoice object. |
|
178 | - * |
|
179 | - */ |
|
180 | - public function read( &$invoice ) { |
|
181 | - |
|
182 | - $invoice->set_defaults(); |
|
183 | - $invoice_object = get_post( $invoice->get_id() ); |
|
184 | - |
|
185 | - if ( ! $invoice->get_id() || ! $invoice_object || ! getpaid_is_invoice_post_type( $invoice_object->post_type ) ) { |
|
186 | - $invoice->last_error = __( 'Invalid invoice.', 'invoicing' ); |
|
187 | - $invoice->set_id( 0 ); |
|
188 | - return false; |
|
189 | - } |
|
190 | - |
|
191 | - $invoice->set_props( |
|
192 | - array( |
|
193 | - 'date_created' => 0 < $invoice_object->post_date ? $invoice_object->post_date : null, |
|
194 | - 'date_modified' => 0 < $invoice_object->post_modified ? $invoice_object->post_modified : null, |
|
195 | - 'status' => $invoice_object->post_status, |
|
196 | - 'author' => $invoice_object->post_author, |
|
197 | - 'description' => $invoice_object->post_excerpt, |
|
198 | - 'parent_id' => $invoice_object->post_parent, |
|
199 | - 'name' => $invoice_object->post_title, |
|
200 | - 'path' => $invoice_object->post_name, |
|
201 | - 'post_type' => $invoice_object->post_type, |
|
202 | - ) |
|
203 | - ); |
|
204 | - |
|
205 | - $invoice->set_type( $invoice_object->post_type ); |
|
206 | - |
|
207 | - $this->read_object_data( $invoice, $invoice_object ); |
|
208 | - $this->add_special_fields( $invoice ); |
|
209 | - $this->add_items( $invoice ); |
|
210 | - $invoice->read_meta_data(); |
|
211 | - $invoice->set_object_read( true ); |
|
212 | - do_action( 'getpaid_read_invoice', $invoice ); |
|
213 | - |
|
214 | - } |
|
215 | - |
|
216 | - /** |
|
217 | - * Method to update an invoice in the database. |
|
218 | - * |
|
219 | - * @param WPInv_Invoice $invoice Invoice object. |
|
220 | - */ |
|
221 | - public function update( &$invoice ) { |
|
222 | - $invoice->save_meta_data(); |
|
223 | - $invoice->set_version( WPINV_VERSION ); |
|
224 | - |
|
225 | - if ( null === $invoice->get_date_created( 'edit' ) ) { |
|
226 | - $invoice->set_date_created( current_time('mysql') ); |
|
227 | - } |
|
228 | - |
|
229 | - // Ensure both the key and number are set. |
|
230 | - $invoice->get_path(); |
|
231 | - |
|
232 | - // Grab the current status so we can compare. |
|
233 | - $previous_status = get_post_status( $invoice->get_id() ); |
|
234 | - |
|
235 | - $changes = $invoice->get_changes(); |
|
236 | - |
|
237 | - // Only update the post when the post data changes. |
|
238 | - if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'description', 'parent_id', 'post_excerpt', 'path' ), array_keys( $changes ) ) ) { |
|
239 | - $post_data = array( |
|
240 | - 'post_date' => $invoice->get_date_created( 'edit' ), |
|
241 | - 'post_date_gmt' => $invoice->get_date_created_gmt( 'edit' ), |
|
242 | - 'post_status' => $invoice->get_status( 'edit' ), |
|
243 | - 'post_title' => $invoice->get_name( 'edit' ), |
|
244 | - 'post_author' => $invoice->get_user_id( 'edit' ), |
|
245 | - 'post_modified' => $invoice->get_date_modified( 'edit' ), |
|
246 | - 'post_excerpt' => $invoice->get_description( 'edit' ), |
|
247 | - 'post_parent' => $invoice->get_parent_id( 'edit' ), |
|
248 | - 'post_name' => $invoice->get_path( 'edit' ), |
|
249 | - 'post_type' => $invoice->get_post_type( 'edit' ), |
|
250 | - ); |
|
251 | - |
|
252 | - /** |
|
253 | - * When updating this object, to prevent infinite loops, use $wpdb |
|
254 | - * to update data, since wp_update_post spawns more calls to the |
|
255 | - * save_post action. |
|
256 | - * |
|
257 | - * This ensures hooks are fired by either WP itself (admin screen save), |
|
258 | - * or an update purely from CRUD. |
|
259 | - */ |
|
260 | - if ( doing_action( 'save_post' ) ) { |
|
261 | - $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $invoice->get_id() ) ); |
|
262 | - clean_post_cache( $invoice->get_id() ); |
|
263 | - } else { |
|
264 | - wp_update_post( array_merge( array( 'ID' => $invoice->get_id() ), $post_data ) ); |
|
265 | - } |
|
266 | - $invoice->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
267 | - } |
|
268 | - |
|
269 | - // Update meta data. |
|
270 | - $this->update_post_meta( $invoice ); |
|
271 | - |
|
272 | - // Save special fields and items. |
|
273 | - $this->save_special_fields( $invoice ); |
|
274 | - $this->save_items( $invoice ); |
|
275 | - |
|
276 | - // Apply the changes. |
|
277 | - $invoice->apply_changes(); |
|
278 | - |
|
279 | - // Clear caches. |
|
280 | - $this->clear_caches( $invoice ); |
|
281 | - |
|
282 | - // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
|
283 | - $new_status = $invoice->get_status( 'edit' ); |
|
284 | - |
|
285 | - if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
286 | - do_action( 'getpaid_new_invoice', $invoice ); |
|
287 | - } else { |
|
288 | - do_action( 'getpaid_update_invoice', $invoice ); |
|
289 | - } |
|
290 | - |
|
291 | - } |
|
292 | - |
|
293 | - /* |
|
108 | + /** |
|
109 | + * Method to create a new invoice in the database. |
|
110 | + * |
|
111 | + * @param WPInv_Invoice $invoice Invoice object. |
|
112 | + */ |
|
113 | + public function create( &$invoice ) { |
|
114 | + $invoice->set_version( WPINV_VERSION ); |
|
115 | + $invoice->set_date_created( current_time('mysql') ); |
|
116 | + |
|
117 | + // Create a new post. |
|
118 | + $id = wp_insert_post( |
|
119 | + apply_filters( |
|
120 | + 'getpaid_new_invoice_data', |
|
121 | + array( |
|
122 | + 'post_date' => $invoice->get_date_created( 'edit' ), |
|
123 | + 'post_type' => $invoice->get_post_type( 'edit' ), |
|
124 | + 'post_status' => $this->get_post_status( $invoice ), |
|
125 | + 'ping_status' => 'closed', |
|
126 | + 'post_author' => $invoice->get_user_id( 'edit' ), |
|
127 | + 'post_title' => $invoice->get_title( 'edit' ), |
|
128 | + 'post_excerpt' => $invoice->get_description( 'edit' ), |
|
129 | + 'post_parent' => $invoice->get_parent_id( 'edit' ), |
|
130 | + ) |
|
131 | + ), |
|
132 | + true |
|
133 | + ); |
|
134 | + |
|
135 | + if ( $id && ! is_wp_error( $id ) ) { |
|
136 | + |
|
137 | + // Update the new id and regenerate a title. |
|
138 | + $invoice->set_id( $id ); |
|
139 | + |
|
140 | + $invoice->maybe_set_number(); |
|
141 | + |
|
142 | + wp_update_post( |
|
143 | + array( |
|
144 | + 'ID' => $invoice->get_id(), |
|
145 | + 'post_title' => $invoice->get_number( 'edit' ), |
|
146 | + 'post_name' => $invoice->get_path( 'edit' ) |
|
147 | + ) |
|
148 | + ); |
|
149 | + |
|
150 | + // Save special fields and items. |
|
151 | + $this->save_special_fields( $invoice ); |
|
152 | + $this->save_items( $invoice ); |
|
153 | + |
|
154 | + // Update meta data. |
|
155 | + $this->update_post_meta( $invoice ); |
|
156 | + $invoice->save_meta_data(); |
|
157 | + |
|
158 | + // Apply changes. |
|
159 | + $invoice->apply_changes(); |
|
160 | + $this->clear_caches( $invoice ); |
|
161 | + |
|
162 | + // Fires after a new invoice is created. |
|
163 | + do_action( 'getpaid_new_invoice', $invoice ); |
|
164 | + return true; |
|
165 | + } |
|
166 | + |
|
167 | + if ( is_wp_error( $id ) ) { |
|
168 | + $invoice->last_error = $id->get_error_message(); |
|
169 | + } |
|
170 | + |
|
171 | + return false; |
|
172 | + } |
|
173 | + |
|
174 | + /** |
|
175 | + * Method to read an invoice from the database. |
|
176 | + * |
|
177 | + * @param WPInv_Invoice $invoice Invoice object. |
|
178 | + * |
|
179 | + */ |
|
180 | + public function read( &$invoice ) { |
|
181 | + |
|
182 | + $invoice->set_defaults(); |
|
183 | + $invoice_object = get_post( $invoice->get_id() ); |
|
184 | + |
|
185 | + if ( ! $invoice->get_id() || ! $invoice_object || ! getpaid_is_invoice_post_type( $invoice_object->post_type ) ) { |
|
186 | + $invoice->last_error = __( 'Invalid invoice.', 'invoicing' ); |
|
187 | + $invoice->set_id( 0 ); |
|
188 | + return false; |
|
189 | + } |
|
190 | + |
|
191 | + $invoice->set_props( |
|
192 | + array( |
|
193 | + 'date_created' => 0 < $invoice_object->post_date ? $invoice_object->post_date : null, |
|
194 | + 'date_modified' => 0 < $invoice_object->post_modified ? $invoice_object->post_modified : null, |
|
195 | + 'status' => $invoice_object->post_status, |
|
196 | + 'author' => $invoice_object->post_author, |
|
197 | + 'description' => $invoice_object->post_excerpt, |
|
198 | + 'parent_id' => $invoice_object->post_parent, |
|
199 | + 'name' => $invoice_object->post_title, |
|
200 | + 'path' => $invoice_object->post_name, |
|
201 | + 'post_type' => $invoice_object->post_type, |
|
202 | + ) |
|
203 | + ); |
|
204 | + |
|
205 | + $invoice->set_type( $invoice_object->post_type ); |
|
206 | + |
|
207 | + $this->read_object_data( $invoice, $invoice_object ); |
|
208 | + $this->add_special_fields( $invoice ); |
|
209 | + $this->add_items( $invoice ); |
|
210 | + $invoice->read_meta_data(); |
|
211 | + $invoice->set_object_read( true ); |
|
212 | + do_action( 'getpaid_read_invoice', $invoice ); |
|
213 | + |
|
214 | + } |
|
215 | + |
|
216 | + /** |
|
217 | + * Method to update an invoice in the database. |
|
218 | + * |
|
219 | + * @param WPInv_Invoice $invoice Invoice object. |
|
220 | + */ |
|
221 | + public function update( &$invoice ) { |
|
222 | + $invoice->save_meta_data(); |
|
223 | + $invoice->set_version( WPINV_VERSION ); |
|
224 | + |
|
225 | + if ( null === $invoice->get_date_created( 'edit' ) ) { |
|
226 | + $invoice->set_date_created( current_time('mysql') ); |
|
227 | + } |
|
228 | + |
|
229 | + // Ensure both the key and number are set. |
|
230 | + $invoice->get_path(); |
|
231 | + |
|
232 | + // Grab the current status so we can compare. |
|
233 | + $previous_status = get_post_status( $invoice->get_id() ); |
|
234 | + |
|
235 | + $changes = $invoice->get_changes(); |
|
236 | + |
|
237 | + // Only update the post when the post data changes. |
|
238 | + if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'description', 'parent_id', 'post_excerpt', 'path' ), array_keys( $changes ) ) ) { |
|
239 | + $post_data = array( |
|
240 | + 'post_date' => $invoice->get_date_created( 'edit' ), |
|
241 | + 'post_date_gmt' => $invoice->get_date_created_gmt( 'edit' ), |
|
242 | + 'post_status' => $invoice->get_status( 'edit' ), |
|
243 | + 'post_title' => $invoice->get_name( 'edit' ), |
|
244 | + 'post_author' => $invoice->get_user_id( 'edit' ), |
|
245 | + 'post_modified' => $invoice->get_date_modified( 'edit' ), |
|
246 | + 'post_excerpt' => $invoice->get_description( 'edit' ), |
|
247 | + 'post_parent' => $invoice->get_parent_id( 'edit' ), |
|
248 | + 'post_name' => $invoice->get_path( 'edit' ), |
|
249 | + 'post_type' => $invoice->get_post_type( 'edit' ), |
|
250 | + ); |
|
251 | + |
|
252 | + /** |
|
253 | + * When updating this object, to prevent infinite loops, use $wpdb |
|
254 | + * to update data, since wp_update_post spawns more calls to the |
|
255 | + * save_post action. |
|
256 | + * |
|
257 | + * This ensures hooks are fired by either WP itself (admin screen save), |
|
258 | + * or an update purely from CRUD. |
|
259 | + */ |
|
260 | + if ( doing_action( 'save_post' ) ) { |
|
261 | + $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $invoice->get_id() ) ); |
|
262 | + clean_post_cache( $invoice->get_id() ); |
|
263 | + } else { |
|
264 | + wp_update_post( array_merge( array( 'ID' => $invoice->get_id() ), $post_data ) ); |
|
265 | + } |
|
266 | + $invoice->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
267 | + } |
|
268 | + |
|
269 | + // Update meta data. |
|
270 | + $this->update_post_meta( $invoice ); |
|
271 | + |
|
272 | + // Save special fields and items. |
|
273 | + $this->save_special_fields( $invoice ); |
|
274 | + $this->save_items( $invoice ); |
|
275 | + |
|
276 | + // Apply the changes. |
|
277 | + $invoice->apply_changes(); |
|
278 | + |
|
279 | + // Clear caches. |
|
280 | + $this->clear_caches( $invoice ); |
|
281 | + |
|
282 | + // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
|
283 | + $new_status = $invoice->get_status( 'edit' ); |
|
284 | + |
|
285 | + if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
286 | + do_action( 'getpaid_new_invoice', $invoice ); |
|
287 | + } else { |
|
288 | + do_action( 'getpaid_update_invoice', $invoice ); |
|
289 | + } |
|
290 | + |
|
291 | + } |
|
292 | + |
|
293 | + /* |
|
294 | 294 | |-------------------------------------------------------------------------- |
295 | 295 | | Additional Methods |
296 | 296 | |-------------------------------------------------------------------------- |
297 | 297 | */ |
298 | 298 | |
299 | - /** |
|
299 | + /** |
|
300 | 300 | * Retrieves special fields and adds to the invoice. |
301 | - * |
|
302 | - * @param WPInv_Invoice $invoice Invoice object. |
|
301 | + * |
|
302 | + * @param WPInv_Invoice $invoice Invoice object. |
|
303 | 303 | */ |
304 | 304 | public function add_special_fields( &$invoice ) { |
305 | - global $wpdb; |
|
305 | + global $wpdb; |
|
306 | 306 | |
307 | - // Maybe retrieve from the cache. |
|
308 | - $data = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_special_fields' ); |
|
307 | + // Maybe retrieve from the cache. |
|
308 | + $data = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_special_fields' ); |
|
309 | 309 | |
310 | - // If not found, retrieve from the db. |
|
311 | - if ( false === $data ) { |
|
312 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
310 | + // If not found, retrieve from the db. |
|
311 | + if ( false === $data ) { |
|
312 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
313 | 313 | |
314 | - $data = $wpdb->get_row( |
|
315 | - $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d LIMIT 1", $invoice->get_id() ), |
|
316 | - ARRAY_A |
|
317 | - ); |
|
314 | + $data = $wpdb->get_row( |
|
315 | + $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d LIMIT 1", $invoice->get_id() ), |
|
316 | + ARRAY_A |
|
317 | + ); |
|
318 | 318 | |
319 | - // Update the cache with our data |
|
320 | - wp_cache_set( $invoice->get_id(), $data, 'getpaid_invoice_special_fields' ); |
|
319 | + // Update the cache with our data |
|
320 | + wp_cache_set( $invoice->get_id(), $data, 'getpaid_invoice_special_fields' ); |
|
321 | 321 | |
322 | - } |
|
322 | + } |
|
323 | 323 | |
324 | - // Abort if the data does not exist. |
|
325 | - if ( empty( $data ) ) { |
|
326 | - $invoice->set_object_read( true ); |
|
327 | - $invoice->set_props( wpinv_get_user_address( $invoice->get_user_id() ) ); |
|
328 | - return; |
|
329 | - } |
|
324 | + // Abort if the data does not exist. |
|
325 | + if ( empty( $data ) ) { |
|
326 | + $invoice->set_object_read( true ); |
|
327 | + $invoice->set_props( wpinv_get_user_address( $invoice->get_user_id() ) ); |
|
328 | + return; |
|
329 | + } |
|
330 | 330 | |
331 | - $props = array(); |
|
331 | + $props = array(); |
|
332 | 332 | |
333 | - foreach ( $this->database_fields_to_props as $db_field => $prop ) { |
|
333 | + foreach ( $this->database_fields_to_props as $db_field => $prop ) { |
|
334 | 334 | |
335 | - if ( $db_field == 'post_id' ) { |
|
336 | - continue; |
|
337 | - } |
|
338 | - |
|
339 | - $props[ $prop ] = $data[ $db_field ]; |
|
340 | - } |
|
341 | - |
|
342 | - $invoice->set_props( $props ); |
|
343 | - |
|
344 | - } |
|
345 | - |
|
346 | - /** |
|
347 | - * Gets a list of special fields that need updated based on change state |
|
348 | - * or if they are present in the database or not. |
|
349 | - * |
|
350 | - * @param WPInv_Invoice $invoice The Invoice object. |
|
351 | - * @return array A mapping of field keys => prop names, filtered by ones that should be updated. |
|
352 | - */ |
|
353 | - protected function get_special_fields_to_update( $invoice ) { |
|
354 | - $fields_to_update = array(); |
|
355 | - $changed_props = $invoice->get_changes(); |
|
356 | - |
|
357 | - // Props should be updated if they are a part of the $changed array or don't exist yet. |
|
358 | - foreach ( $this->database_fields_to_props as $database_field => $prop ) { |
|
359 | - if ( array_key_exists( $prop, $changed_props ) ) { |
|
360 | - $fields_to_update[ $database_field ] = $prop; |
|
361 | - } |
|
362 | - } |
|
363 | - |
|
364 | - return $fields_to_update; |
|
365 | - } |
|
366 | - |
|
367 | - /** |
|
368 | - * Helper method that updates all the database fields for an invoice based on it's settings in the WPInv_Invoice class. |
|
369 | - * |
|
370 | - * @param WPInv_Invoice $invoice WPInv_Invoice object. |
|
371 | - * @since 1.0.19 |
|
372 | - */ |
|
373 | - protected function update_special_fields( &$invoice ) { |
|
374 | - global $wpdb; |
|
375 | - |
|
376 | - $updated_props = array(); |
|
377 | - $fields_to_update = $this->get_special_fields_to_update( $invoice ); |
|
378 | - |
|
379 | - foreach ( $fields_to_update as $database_field => $prop ) { |
|
380 | - $value = $invoice->{"get_$prop"}( 'edit' ); |
|
381 | - $value = is_string( $value ) ? wp_slash( $value ) : $value; |
|
382 | - $value = is_bool( $value ) ? ( int ) $value : $value; |
|
383 | - $updated_props[ $database_field ] = maybe_serialize( $value ); |
|
384 | - } |
|
385 | - |
|
386 | - if ( ! empty( $updated_props ) ) { |
|
387 | - |
|
388 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
389 | - $wpdb->update( $table, $updated_props, array( 'post_id' => $invoice->get_id() ) ); |
|
390 | - wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' ); |
|
391 | - do_action( "getpaid_invoice_update_database_fields", $invoice, $updated_props ); |
|
392 | - |
|
393 | - } |
|
394 | - |
|
395 | - } |
|
396 | - |
|
397 | - /** |
|
398 | - * Helper method that inserts special fields to the database. |
|
399 | - * |
|
400 | - * @param WPInv_Invoice $invoice WPInv_Invoice object. |
|
401 | - * @since 1.0.19 |
|
402 | - */ |
|
403 | - protected function insert_special_fields( &$invoice ) { |
|
404 | - global $wpdb; |
|
405 | - |
|
406 | - $updated_props = array(); |
|
407 | - |
|
408 | - foreach ( $this->database_fields_to_props as $database_field => $prop ) { |
|
409 | - $value = $invoice->{"get_$prop"}( 'edit' ); |
|
410 | - $value = is_string( $value ) ? wp_slash( $value ) : $value; |
|
411 | - $value = is_bool( $value ) ? ( int ) $value : $value; |
|
412 | - $updated_props[ $database_field ] = maybe_serialize( $value ); |
|
413 | - } |
|
414 | - |
|
415 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
416 | - $wpdb->insert( $table, $updated_props ); |
|
417 | - wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' ); |
|
418 | - do_action( "getpaid_invoice_insert_database_fields", $invoice, $updated_props ); |
|
419 | - |
|
420 | - } |
|
421 | - |
|
422 | - /** |
|
335 | + if ( $db_field == 'post_id' ) { |
|
336 | + continue; |
|
337 | + } |
|
338 | + |
|
339 | + $props[ $prop ] = $data[ $db_field ]; |
|
340 | + } |
|
341 | + |
|
342 | + $invoice->set_props( $props ); |
|
343 | + |
|
344 | + } |
|
345 | + |
|
346 | + /** |
|
347 | + * Gets a list of special fields that need updated based on change state |
|
348 | + * or if they are present in the database or not. |
|
349 | + * |
|
350 | + * @param WPInv_Invoice $invoice The Invoice object. |
|
351 | + * @return array A mapping of field keys => prop names, filtered by ones that should be updated. |
|
352 | + */ |
|
353 | + protected function get_special_fields_to_update( $invoice ) { |
|
354 | + $fields_to_update = array(); |
|
355 | + $changed_props = $invoice->get_changes(); |
|
356 | + |
|
357 | + // Props should be updated if they are a part of the $changed array or don't exist yet. |
|
358 | + foreach ( $this->database_fields_to_props as $database_field => $prop ) { |
|
359 | + if ( array_key_exists( $prop, $changed_props ) ) { |
|
360 | + $fields_to_update[ $database_field ] = $prop; |
|
361 | + } |
|
362 | + } |
|
363 | + |
|
364 | + return $fields_to_update; |
|
365 | + } |
|
366 | + |
|
367 | + /** |
|
368 | + * Helper method that updates all the database fields for an invoice based on it's settings in the WPInv_Invoice class. |
|
369 | + * |
|
370 | + * @param WPInv_Invoice $invoice WPInv_Invoice object. |
|
371 | + * @since 1.0.19 |
|
372 | + */ |
|
373 | + protected function update_special_fields( &$invoice ) { |
|
374 | + global $wpdb; |
|
375 | + |
|
376 | + $updated_props = array(); |
|
377 | + $fields_to_update = $this->get_special_fields_to_update( $invoice ); |
|
378 | + |
|
379 | + foreach ( $fields_to_update as $database_field => $prop ) { |
|
380 | + $value = $invoice->{"get_$prop"}( 'edit' ); |
|
381 | + $value = is_string( $value ) ? wp_slash( $value ) : $value; |
|
382 | + $value = is_bool( $value ) ? ( int ) $value : $value; |
|
383 | + $updated_props[ $database_field ] = maybe_serialize( $value ); |
|
384 | + } |
|
385 | + |
|
386 | + if ( ! empty( $updated_props ) ) { |
|
387 | + |
|
388 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
389 | + $wpdb->update( $table, $updated_props, array( 'post_id' => $invoice->get_id() ) ); |
|
390 | + wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' ); |
|
391 | + do_action( "getpaid_invoice_update_database_fields", $invoice, $updated_props ); |
|
392 | + |
|
393 | + } |
|
394 | + |
|
395 | + } |
|
396 | + |
|
397 | + /** |
|
398 | + * Helper method that inserts special fields to the database. |
|
399 | + * |
|
400 | + * @param WPInv_Invoice $invoice WPInv_Invoice object. |
|
401 | + * @since 1.0.19 |
|
402 | + */ |
|
403 | + protected function insert_special_fields( &$invoice ) { |
|
404 | + global $wpdb; |
|
405 | + |
|
406 | + $updated_props = array(); |
|
407 | + |
|
408 | + foreach ( $this->database_fields_to_props as $database_field => $prop ) { |
|
409 | + $value = $invoice->{"get_$prop"}( 'edit' ); |
|
410 | + $value = is_string( $value ) ? wp_slash( $value ) : $value; |
|
411 | + $value = is_bool( $value ) ? ( int ) $value : $value; |
|
412 | + $updated_props[ $database_field ] = maybe_serialize( $value ); |
|
413 | + } |
|
414 | + |
|
415 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
416 | + $wpdb->insert( $table, $updated_props ); |
|
417 | + wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' ); |
|
418 | + do_action( "getpaid_invoice_insert_database_fields", $invoice, $updated_props ); |
|
419 | + |
|
420 | + } |
|
421 | + |
|
422 | + /** |
|
423 | 423 | * Saves all special fields. |
424 | - * |
|
425 | - * @param WPInv_Invoice $invoice Invoice object. |
|
424 | + * |
|
425 | + * @param WPInv_Invoice $invoice Invoice object. |
|
426 | 426 | */ |
427 | 427 | public function save_special_fields( & $invoice ) { |
428 | - global $wpdb; |
|
428 | + global $wpdb; |
|
429 | 429 | |
430 | - // The invoices table. |
|
431 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
432 | - $id = (int) $invoice->get_id(); |
|
433 | - $invoice->maybe_set_key(); |
|
430 | + // The invoices table. |
|
431 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
432 | + $id = (int) $invoice->get_id(); |
|
433 | + $invoice->maybe_set_key(); |
|
434 | 434 | |
435 | - if ( $wpdb->get_var( "SELECT `post_id` FROM $table WHERE `post_id`= $id" ) ) { |
|
435 | + if ( $wpdb->get_var( "SELECT `post_id` FROM $table WHERE `post_id`= $id" ) ) { |
|
436 | 436 | |
437 | - $this->update_special_fields( $invoice ); |
|
437 | + $this->update_special_fields( $invoice ); |
|
438 | 438 | |
439 | - } else { |
|
439 | + } else { |
|
440 | 440 | |
441 | - $this->insert_special_fields( $invoice ); |
|
441 | + $this->insert_special_fields( $invoice ); |
|
442 | 442 | |
443 | - } |
|
443 | + } |
|
444 | 444 | |
445 | - } |
|
445 | + } |
|
446 | 446 | |
447 | - /** |
|
447 | + /** |
|
448 | 448 | * Set's up cart details. |
449 | - * |
|
450 | - * @param WPInv_Invoice $invoice Invoice object. |
|
449 | + * |
|
450 | + * @param WPInv_Invoice $invoice Invoice object. |
|
451 | 451 | */ |
452 | 452 | public function add_items( &$invoice ) { |
453 | - global $wpdb; |
|
453 | + global $wpdb; |
|
454 | 454 | |
455 | - // Maybe retrieve from the cache. |
|
456 | - $items = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_cart_details' ); |
|
455 | + // Maybe retrieve from the cache. |
|
456 | + $items = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_cart_details' ); |
|
457 | 457 | |
458 | - // If not found, retrieve from the db. |
|
459 | - if ( false === $items ) { |
|
460 | - $table = $wpdb->prefix . 'getpaid_invoice_items'; |
|
458 | + // If not found, retrieve from the db. |
|
459 | + if ( false === $items ) { |
|
460 | + $table = $wpdb->prefix . 'getpaid_invoice_items'; |
|
461 | 461 | |
462 | - $items = $wpdb->get_results( |
|
463 | - $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d", $invoice->get_id() ) |
|
464 | - ); |
|
462 | + $items = $wpdb->get_results( |
|
463 | + $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d", $invoice->get_id() ) |
|
464 | + ); |
|
465 | 465 | |
466 | - // Update the cache with our data |
|
467 | - wp_cache_set( $invoice->get_id(), $items, 'getpaid_invoice_cart_details' ); |
|
466 | + // Update the cache with our data |
|
467 | + wp_cache_set( $invoice->get_id(), $items, 'getpaid_invoice_cart_details' ); |
|
468 | 468 | |
469 | - } |
|
469 | + } |
|
470 | 470 | |
471 | - // Abort if no items found. |
|
471 | + // Abort if no items found. |
|
472 | 472 | if ( empty( $items ) ) { |
473 | 473 | return; |
474 | - } |
|
474 | + } |
|
475 | 475 | |
476 | - foreach ( $items as $item_data ) { |
|
477 | - $item = new GetPaid_Form_Item( $item_data->item_id ); |
|
476 | + foreach ( $items as $item_data ) { |
|
477 | + $item = new GetPaid_Form_Item( $item_data->item_id ); |
|
478 | 478 | |
479 | - // Set item data. |
|
480 | - $item->item_tax = wpinv_sanitize_amount( $item_data->tax ); |
|
481 | - $item->item_discount = wpinv_sanitize_amount( $item_data->discount ); |
|
482 | - $item->set_name( $item_data->item_name ); |
|
483 | - $item->set_description( $item_data->item_description ); |
|
484 | - $item->set_price( $item_data->item_price ); |
|
485 | - $item->set_quantity( $item_data->quantity ); |
|
486 | - $item->set_item_meta( $item_data->meta ); |
|
479 | + // Set item data. |
|
480 | + $item->item_tax = wpinv_sanitize_amount( $item_data->tax ); |
|
481 | + $item->item_discount = wpinv_sanitize_amount( $item_data->discount ); |
|
482 | + $item->set_name( $item_data->item_name ); |
|
483 | + $item->set_description( $item_data->item_description ); |
|
484 | + $item->set_price( $item_data->item_price ); |
|
485 | + $item->set_quantity( $item_data->quantity ); |
|
486 | + $item->set_item_meta( $item_data->meta ); |
|
487 | 487 | |
488 | - $invoice->add_item( $item ); |
|
489 | - } |
|
488 | + $invoice->add_item( $item ); |
|
489 | + } |
|
490 | 490 | |
491 | - } |
|
491 | + } |
|
492 | 492 | |
493 | - /** |
|
493 | + /** |
|
494 | 494 | * Saves cart details. |
495 | - * |
|
496 | - * @param WPInv_Invoice $invoice Invoice object. |
|
495 | + * |
|
496 | + * @param WPInv_Invoice $invoice Invoice object. |
|
497 | 497 | */ |
498 | 498 | public function save_items( $invoice ) { |
499 | 499 | |
500 | - // Delete previously existing items. |
|
501 | - $this->delete_items( $invoice ); |
|
500 | + // Delete previously existing items. |
|
501 | + $this->delete_items( $invoice ); |
|
502 | 502 | |
503 | - $table = $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items'; |
|
503 | + $table = $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items'; |
|
504 | 504 | |
505 | - foreach ( $invoice->get_cart_details() as $item_data ) { |
|
506 | - $item_data = array_map( 'maybe_serialize', $item_data ); |
|
507 | - $GLOBALS['wpdb']->insert( $table, $item_data ); |
|
508 | - } |
|
505 | + foreach ( $invoice->get_cart_details() as $item_data ) { |
|
506 | + $item_data = array_map( 'maybe_serialize', $item_data ); |
|
507 | + $GLOBALS['wpdb']->insert( $table, $item_data ); |
|
508 | + } |
|
509 | 509 | |
510 | - wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_cart_details' ); |
|
511 | - do_action( "getpaid_invoice_save_items", $invoice ); |
|
510 | + wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_cart_details' ); |
|
511 | + do_action( "getpaid_invoice_save_items", $invoice ); |
|
512 | 512 | |
513 | - } |
|
513 | + } |
|
514 | 514 | |
515 | - /** |
|
515 | + /** |
|
516 | 516 | * Deletes an invoice's cart details from the database. |
517 | - * |
|
518 | - * @param WPInv_Invoice $invoice Invoice object. |
|
517 | + * |
|
518 | + * @param WPInv_Invoice $invoice Invoice object. |
|
519 | 519 | */ |
520 | 520 | public function delete_items( $invoice ) { |
521 | - $table = $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items'; |
|
522 | - return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) ); |
|
523 | - } |
|
521 | + $table = $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items'; |
|
522 | + return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) ); |
|
523 | + } |
|
524 | 524 | |
525 | - /** |
|
525 | + /** |
|
526 | 526 | * Deletes an invoice's special fields from the database. |
527 | - * |
|
528 | - * @param WPInv_Invoice $invoice Invoice object. |
|
527 | + * |
|
528 | + * @param WPInv_Invoice $invoice Invoice object. |
|
529 | 529 | */ |
530 | 530 | public function delete_special_fields( $invoice ) { |
531 | - $table = $GLOBALS['wpdb']->prefix . 'getpaid_invoices'; |
|
532 | - return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) ); |
|
533 | - } |
|
531 | + $table = $GLOBALS['wpdb']->prefix . 'getpaid_invoices'; |
|
532 | + return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) ); |
|
533 | + } |
|
534 | 534 | |
535 | - /** |
|
536 | - * Get the status to save to the post object. |
|
537 | - * |
|
538 | - * |
|
539 | - * @since 1.0.19 |
|
540 | - * @param WPInv_Invoice $object GetPaid_Data object. |
|
541 | - * @return string |
|
542 | - */ |
|
543 | - protected function get_post_status( $object ) { |
|
544 | - $object_status = $object->get_status( 'edit' ); |
|
545 | - |
|
546 | - if ( ! $object_status ) { |
|
547 | - $object_status = $object->get_default_status(); |
|
548 | - } |
|
549 | - |
|
550 | - return $object_status; |
|
551 | - } |
|
535 | + /** |
|
536 | + * Get the status to save to the post object. |
|
537 | + * |
|
538 | + * |
|
539 | + * @since 1.0.19 |
|
540 | + * @param WPInv_Invoice $object GetPaid_Data object. |
|
541 | + * @return string |
|
542 | + */ |
|
543 | + protected function get_post_status( $object ) { |
|
544 | + $object_status = $object->get_status( 'edit' ); |
|
545 | + |
|
546 | + if ( ! $object_status ) { |
|
547 | + $object_status = $object->get_default_status(); |
|
548 | + } |
|
549 | + |
|
550 | + return $object_status; |
|
551 | + } |
|
552 | 552 | |
553 | 553 | } |
@@ -12,49 +12,49 @@ discard block |
||
12 | 12 | */ |
13 | 13 | class GetPaid_Reports { |
14 | 14 | |
15 | - /** |
|
16 | - * Class constructor. |
|
17 | - * |
|
18 | - */ |
|
19 | - public function __construct() { |
|
20 | - add_action( 'admin_menu', array( $this, 'register_reports_page' ), 20 ); |
|
21 | - add_action( 'wpinv_reports_tab_reports', array( $this, 'display_reports_tab' ) ); |
|
22 | - add_action( 'wpinv_reports_tab_export', array( $this, 'display_exports_tab' ) ); |
|
23 | - add_action( 'getpaid_authenticated_admin_action_download_graph', array( $this, 'download_graph' ) ); |
|
24 | - add_action( 'getpaid_authenticated_admin_action_export_invoices', array( $this, 'export_invoices' ) ); |
|
25 | - |
|
26 | - } |
|
27 | - |
|
28 | - /** |
|
29 | - * Registers the reports page. |
|
30 | - * |
|
31 | - */ |
|
32 | - public function register_reports_page() { |
|
33 | - |
|
34 | - add_submenu_page( |
|
15 | + /** |
|
16 | + * Class constructor. |
|
17 | + * |
|
18 | + */ |
|
19 | + public function __construct() { |
|
20 | + add_action( 'admin_menu', array( $this, 'register_reports_page' ), 20 ); |
|
21 | + add_action( 'wpinv_reports_tab_reports', array( $this, 'display_reports_tab' ) ); |
|
22 | + add_action( 'wpinv_reports_tab_export', array( $this, 'display_exports_tab' ) ); |
|
23 | + add_action( 'getpaid_authenticated_admin_action_download_graph', array( $this, 'download_graph' ) ); |
|
24 | + add_action( 'getpaid_authenticated_admin_action_export_invoices', array( $this, 'export_invoices' ) ); |
|
25 | + |
|
26 | + } |
|
27 | + |
|
28 | + /** |
|
29 | + * Registers the reports page. |
|
30 | + * |
|
31 | + */ |
|
32 | + public function register_reports_page() { |
|
33 | + |
|
34 | + add_submenu_page( |
|
35 | 35 | 'wpinv', |
36 | 36 | __( 'Reports', 'invoicing' ), |
37 | 37 | __( 'Reports', 'invoicing' ), |
38 | 38 | wpinv_get_capability(), |
39 | 39 | 'wpinv-reports', |
40 | 40 | array( $this, 'display_reports_page' ) |
41 | - ); |
|
41 | + ); |
|
42 | 42 | |
43 | - } |
|
43 | + } |
|
44 | 44 | |
45 | - /** |
|
46 | - * Displays the reports page. |
|
47 | - * |
|
48 | - */ |
|
49 | - public function display_reports_page() { |
|
45 | + /** |
|
46 | + * Displays the reports page. |
|
47 | + * |
|
48 | + */ |
|
49 | + public function display_reports_page() { |
|
50 | 50 | |
51 | - // Prepare variables. |
|
52 | - $tabs = $this->get_tabs(); |
|
53 | - $current_tab = isset( $_GET['tab'] ) ? sanitize_text_field( $_GET['tab'] ) : 'reports'; |
|
54 | - $current_tab = array_key_exists( $current_tab, $tabs ) ? $current_tab : 'reports'; |
|
51 | + // Prepare variables. |
|
52 | + $tabs = $this->get_tabs(); |
|
53 | + $current_tab = isset( $_GET['tab'] ) ? sanitize_text_field( $_GET['tab'] ) : 'reports'; |
|
54 | + $current_tab = array_key_exists( $current_tab, $tabs ) ? $current_tab : 'reports'; |
|
55 | 55 | |
56 | - // Display the current tab. |
|
57 | - ?> |
|
56 | + // Display the current tab. |
|
57 | + ?> |
|
58 | 58 | |
59 | 59 | <div class="wrap"> |
60 | 60 | |
@@ -63,19 +63,19 @@ discard block |
||
63 | 63 | <nav class="nav-tab-wrapper"> |
64 | 64 | |
65 | 65 | <?php |
66 | - foreach( $tabs as $key => $label ) { |
|
66 | + foreach( $tabs as $key => $label ) { |
|
67 | 67 | |
68 | - $key = sanitize_text_field( $key ); |
|
69 | - $label = sanitize_text_field( $label ); |
|
70 | - $class = $key == $current_tab ? 'nav-tab nav-tab-active' : 'nav-tab'; |
|
71 | - $url = esc_url( |
|
72 | - add_query_arg( 'tab', $key, admin_url( 'admin.php?page=wpinv-reports' ) ) |
|
73 | - ); |
|
68 | + $key = sanitize_text_field( $key ); |
|
69 | + $label = sanitize_text_field( $label ); |
|
70 | + $class = $key == $current_tab ? 'nav-tab nav-tab-active' : 'nav-tab'; |
|
71 | + $url = esc_url( |
|
72 | + add_query_arg( 'tab', $key, admin_url( 'admin.php?page=wpinv-reports' ) ) |
|
73 | + ); |
|
74 | 74 | |
75 | - echo "\n\t\t\t<a href='$url' class='$class'>$label</a>"; |
|
75 | + echo "\n\t\t\t<a href='$url' class='$class'>$label</a>"; |
|
76 | 76 | |
77 | - } |
|
78 | - ?> |
|
77 | + } |
|
78 | + ?> |
|
79 | 79 | |
80 | 80 | </nav> |
81 | 81 | |
@@ -86,77 +86,77 @@ discard block |
||
86 | 86 | </div> |
87 | 87 | <?php |
88 | 88 | |
89 | - // Wordfence loads an unsupported version of chart js on our page. |
|
90 | - wp_deregister_style( 'chart-js' ); |
|
91 | - wp_deregister_script( 'chart-js' ); |
|
92 | - wp_enqueue_script( 'chart-js', WPINV_PLUGIN_URL . 'assets/js/chart.bundle.min.js', array( 'jquery' ), '2.9.4', true ); |
|
93 | - wp_enqueue_style( 'chart-js', WPINV_PLUGIN_URL . 'assets/css/chart.min.css', array(), '2.9.4' ); |
|
94 | - |
|
95 | - } |
|
96 | - |
|
97 | - /** |
|
98 | - * Retrieves reports page tabs. |
|
99 | - * |
|
100 | - * @return array |
|
101 | - */ |
|
102 | - public function get_tabs() { |
|
103 | - |
|
104 | - $tabs = array( |
|
105 | - 'reports' => __( 'Reports', 'invoicing' ), |
|
106 | - 'export' => __( 'Export', 'invoicing' ), |
|
107 | - ); |
|
108 | - |
|
109 | - return apply_filters( 'getpaid_report_tabs', $tabs ); |
|
110 | - } |
|
111 | - |
|
112 | - /** |
|
113 | - * Displays the reports tab. |
|
114 | - * |
|
115 | - */ |
|
116 | - public function display_reports_tab() { |
|
117 | - |
|
118 | - $reports = new GetPaid_Reports_Report(); |
|
119 | - $reports->display(); |
|
120 | - |
|
121 | - } |
|
122 | - |
|
123 | - /** |
|
124 | - * Displays the exports tab. |
|
125 | - * |
|
126 | - */ |
|
127 | - public function display_exports_tab() { |
|
128 | - |
|
129 | - $exports = new GetPaid_Reports_Export(); |
|
130 | - $exports->display(); |
|
131 | - |
|
132 | - } |
|
133 | - |
|
134 | - /** |
|
135 | - * Donwnloads a graph. |
|
136 | - * |
|
137 | - * @param array $args |
|
138 | - */ |
|
139 | - public function download_graph( $args ) { |
|
140 | - |
|
141 | - if ( ! empty( $args['graph'] ) ) { |
|
142 | - $downloader = new GetPaid_Graph_Downloader(); |
|
143 | - $downloader->download( $args['graph'] ); |
|
144 | - } |
|
145 | - |
|
146 | - } |
|
147 | - |
|
148 | - /** |
|
149 | - * Exports invoices. |
|
150 | - * |
|
151 | - * @param array $args |
|
152 | - */ |
|
153 | - public function export_invoices( $args ) { |
|
154 | - |
|
155 | - if ( ! empty( $args['post_type'] ) ) { |
|
156 | - $downloader = new GetPaid_Invoice_Exporter(); |
|
157 | - $downloader->export( $args['post_type'], $args ); |
|
158 | - } |
|
159 | - |
|
160 | - } |
|
89 | + // Wordfence loads an unsupported version of chart js on our page. |
|
90 | + wp_deregister_style( 'chart-js' ); |
|
91 | + wp_deregister_script( 'chart-js' ); |
|
92 | + wp_enqueue_script( 'chart-js', WPINV_PLUGIN_URL . 'assets/js/chart.bundle.min.js', array( 'jquery' ), '2.9.4', true ); |
|
93 | + wp_enqueue_style( 'chart-js', WPINV_PLUGIN_URL . 'assets/css/chart.min.css', array(), '2.9.4' ); |
|
94 | + |
|
95 | + } |
|
96 | + |
|
97 | + /** |
|
98 | + * Retrieves reports page tabs. |
|
99 | + * |
|
100 | + * @return array |
|
101 | + */ |
|
102 | + public function get_tabs() { |
|
103 | + |
|
104 | + $tabs = array( |
|
105 | + 'reports' => __( 'Reports', 'invoicing' ), |
|
106 | + 'export' => __( 'Export', 'invoicing' ), |
|
107 | + ); |
|
108 | + |
|
109 | + return apply_filters( 'getpaid_report_tabs', $tabs ); |
|
110 | + } |
|
111 | + |
|
112 | + /** |
|
113 | + * Displays the reports tab. |
|
114 | + * |
|
115 | + */ |
|
116 | + public function display_reports_tab() { |
|
117 | + |
|
118 | + $reports = new GetPaid_Reports_Report(); |
|
119 | + $reports->display(); |
|
120 | + |
|
121 | + } |
|
122 | + |
|
123 | + /** |
|
124 | + * Displays the exports tab. |
|
125 | + * |
|
126 | + */ |
|
127 | + public function display_exports_tab() { |
|
128 | + |
|
129 | + $exports = new GetPaid_Reports_Export(); |
|
130 | + $exports->display(); |
|
131 | + |
|
132 | + } |
|
133 | + |
|
134 | + /** |
|
135 | + * Donwnloads a graph. |
|
136 | + * |
|
137 | + * @param array $args |
|
138 | + */ |
|
139 | + public function download_graph( $args ) { |
|
140 | + |
|
141 | + if ( ! empty( $args['graph'] ) ) { |
|
142 | + $downloader = new GetPaid_Graph_Downloader(); |
|
143 | + $downloader->download( $args['graph'] ); |
|
144 | + } |
|
145 | + |
|
146 | + } |
|
147 | + |
|
148 | + /** |
|
149 | + * Exports invoices. |
|
150 | + * |
|
151 | + * @param array $args |
|
152 | + */ |
|
153 | + public function export_invoices( $args ) { |
|
154 | + |
|
155 | + if ( ! empty( $args['post_type'] ) ) { |
|
156 | + $downloader = new GetPaid_Invoice_Exporter(); |
|
157 | + $downloader->export( $args['post_type'], $args ); |
|
158 | + } |
|
159 | + |
|
160 | + } |
|
161 | 161 | |
162 | 162 | } |
@@ -15,319 +15,319 @@ |
||
15 | 15 | class GetPaid_Post_Types { |
16 | 16 | |
17 | 17 | /** |
18 | - * Hook in methods. |
|
19 | - */ |
|
20 | - public function __construct() { |
|
21 | - add_action( 'init', array( __CLASS__, 'register_post_types' ), 1 ); |
|
22 | - add_action( 'init', array( __CLASS__, 'register_post_status' ), 4 ); |
|
23 | - add_action( 'getpaid_flush_rewrite_rules', array( __CLASS__, 'flush_rewrite_rules' ) ); |
|
24 | - add_action( 'getpaid_after_register_post_types', array( __CLASS__, 'maybe_flush_rewrite_rules' ) ); |
|
25 | - } |
|
18 | + * Hook in methods. |
|
19 | + */ |
|
20 | + public function __construct() { |
|
21 | + add_action( 'init', array( __CLASS__, 'register_post_types' ), 1 ); |
|
22 | + add_action( 'init', array( __CLASS__, 'register_post_status' ), 4 ); |
|
23 | + add_action( 'getpaid_flush_rewrite_rules', array( __CLASS__, 'flush_rewrite_rules' ) ); |
|
24 | + add_action( 'getpaid_after_register_post_types', array( __CLASS__, 'maybe_flush_rewrite_rules' ) ); |
|
25 | + } |
|
26 | 26 | |
27 | - /** |
|
28 | - * Register core post types. |
|
29 | - */ |
|
30 | - public static function register_post_types() { |
|
27 | + /** |
|
28 | + * Register core post types. |
|
29 | + */ |
|
30 | + public static function register_post_types() { |
|
31 | 31 | |
32 | - if ( ! is_blog_installed() || post_type_exists( 'wpi_item' ) ) { |
|
33 | - return; |
|
34 | - } |
|
32 | + if ( ! is_blog_installed() || post_type_exists( 'wpi_item' ) ) { |
|
33 | + return; |
|
34 | + } |
|
35 | 35 | |
36 | - // Fires before registering post types. |
|
37 | - do_action( 'getpaid_register_post_types' ); |
|
36 | + // Fires before registering post types. |
|
37 | + do_action( 'getpaid_register_post_types' ); |
|
38 | 38 | |
39 | - // Register item post type. |
|
40 | - register_post_type( |
|
41 | - 'wpi_item', |
|
42 | - apply_filters( |
|
43 | - 'wpinv_register_post_type_invoice_item', |
|
44 | - array( |
|
45 | - 'labels' => array( |
|
46 | - 'name' => _x( 'Items', 'post type general name', 'invoicing' ), |
|
47 | - 'singular_name' => _x( 'Item', 'post type singular name', 'invoicing' ), |
|
48 | - 'menu_name' => _x( 'Items', 'admin menu', 'invoicing' ), |
|
49 | - 'name_admin_bar' => _x( 'Item', 'add new on admin bar', 'invoicing' ), |
|
50 | - 'add_new' => _x( 'Add New', 'Item', 'invoicing' ), |
|
51 | - 'add_new_item' => __( 'Add New Item', 'invoicing' ), |
|
52 | - 'new_item' => __( 'New Item', 'invoicing' ), |
|
53 | - 'edit_item' => __( 'Edit Item', 'invoicing' ), |
|
54 | - 'view_item' => __( 'View Item', 'invoicing' ), |
|
55 | - 'all_items' => __( 'Items', 'invoicing' ), |
|
56 | - 'search_items' => __( 'Search items', 'invoicing' ), |
|
57 | - 'parent_item_colon' => __( 'Parent item:', 'invoicing' ), |
|
58 | - 'not_found' => __( 'No items found.', 'invoicing' ), |
|
59 | - 'not_found_in_trash' => __( 'No items found in trash.', 'invoicing' ) |
|
60 | - ), |
|
61 | - 'description' => __( 'This is where you can add new invoice items.', 'invoicing' ), |
|
62 | - 'public' => false, |
|
63 | - 'has_archive' => false, |
|
64 | - '_builtin' => false, |
|
65 | - 'show_ui' => true, |
|
66 | - 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false, |
|
67 | - 'show_in_nav_menus' => false, |
|
68 | - 'supports' => array( 'title', 'excerpt', 'thumbnail' ), |
|
69 | - 'rewrite' => false, |
|
70 | - 'query_var' => false, |
|
71 | - 'map_meta_cap' => true, |
|
72 | - 'show_in_admin_bar' => true, |
|
73 | - 'can_export' => true, |
|
74 | - ) |
|
75 | - ) |
|
76 | - ); |
|
39 | + // Register item post type. |
|
40 | + register_post_type( |
|
41 | + 'wpi_item', |
|
42 | + apply_filters( |
|
43 | + 'wpinv_register_post_type_invoice_item', |
|
44 | + array( |
|
45 | + 'labels' => array( |
|
46 | + 'name' => _x( 'Items', 'post type general name', 'invoicing' ), |
|
47 | + 'singular_name' => _x( 'Item', 'post type singular name', 'invoicing' ), |
|
48 | + 'menu_name' => _x( 'Items', 'admin menu', 'invoicing' ), |
|
49 | + 'name_admin_bar' => _x( 'Item', 'add new on admin bar', 'invoicing' ), |
|
50 | + 'add_new' => _x( 'Add New', 'Item', 'invoicing' ), |
|
51 | + 'add_new_item' => __( 'Add New Item', 'invoicing' ), |
|
52 | + 'new_item' => __( 'New Item', 'invoicing' ), |
|
53 | + 'edit_item' => __( 'Edit Item', 'invoicing' ), |
|
54 | + 'view_item' => __( 'View Item', 'invoicing' ), |
|
55 | + 'all_items' => __( 'Items', 'invoicing' ), |
|
56 | + 'search_items' => __( 'Search items', 'invoicing' ), |
|
57 | + 'parent_item_colon' => __( 'Parent item:', 'invoicing' ), |
|
58 | + 'not_found' => __( 'No items found.', 'invoicing' ), |
|
59 | + 'not_found_in_trash' => __( 'No items found in trash.', 'invoicing' ) |
|
60 | + ), |
|
61 | + 'description' => __( 'This is where you can add new invoice items.', 'invoicing' ), |
|
62 | + 'public' => false, |
|
63 | + 'has_archive' => false, |
|
64 | + '_builtin' => false, |
|
65 | + 'show_ui' => true, |
|
66 | + 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false, |
|
67 | + 'show_in_nav_menus' => false, |
|
68 | + 'supports' => array( 'title', 'excerpt', 'thumbnail' ), |
|
69 | + 'rewrite' => false, |
|
70 | + 'query_var' => false, |
|
71 | + 'map_meta_cap' => true, |
|
72 | + 'show_in_admin_bar' => true, |
|
73 | + 'can_export' => true, |
|
74 | + ) |
|
75 | + ) |
|
76 | + ); |
|
77 | 77 | |
78 | - // Register payment form post type. |
|
79 | - register_post_type( |
|
80 | - 'wpi_payment_form', |
|
81 | - apply_filters( |
|
82 | - 'wpinv_register_post_type_payment_form', |
|
83 | - array( |
|
84 | - 'labels' => array( |
|
85 | - 'name' => _x( 'Payment Forms', 'post type general name', 'invoicing' ), |
|
86 | - 'singular_name' => _x( 'Payment Form', 'post type singular name', 'invoicing' ), |
|
87 | - 'menu_name' => _x( 'Payment Forms', 'admin menu', 'invoicing' ), |
|
88 | - 'name_admin_bar' => _x( 'Payment Form', 'add new on admin bar', 'invoicing' ), |
|
89 | - 'add_new' => _x( 'Add New', 'Payment Form', 'invoicing' ), |
|
90 | - 'add_new_item' => __( 'Add New Payment Form', 'invoicing' ), |
|
91 | - 'new_item' => __( 'New Payment Form', 'invoicing' ), |
|
92 | - 'edit_item' => __( 'Edit Payment Form', 'invoicing' ), |
|
93 | - 'view_item' => __( 'View Payment Form', 'invoicing' ), |
|
94 | - 'all_items' => __( 'Payment Forms', 'invoicing' ), |
|
95 | - 'search_items' => __( 'Search Payment Forms', 'invoicing' ), |
|
96 | - 'parent_item_colon' => __( 'Parent Payment Forms:', 'invoicing' ), |
|
97 | - 'not_found' => __( 'No payment forms found.', 'invoicing' ), |
|
98 | - 'not_found_in_trash' => __( 'No payment forms found in trash.', 'invoicing' ) |
|
99 | - ), |
|
100 | - 'description' => __( 'Add new payment forms.', 'invoicing' ), |
|
101 | - 'public' => false, |
|
102 | - 'show_ui' => true, |
|
103 | - 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : true, |
|
104 | - 'show_in_nav_menus' => false, |
|
105 | - 'query_var' => false, |
|
106 | - 'rewrite' => true, |
|
107 | - 'map_meta_cap' => true, |
|
108 | - 'has_archive' => false, |
|
109 | - 'hierarchical' => false, |
|
110 | - 'menu_position' => null, |
|
111 | - 'supports' => array( 'title' ), |
|
112 | - 'menu_icon' => 'dashicons-media-form', |
|
113 | - ) |
|
114 | - ) |
|
115 | - ); |
|
78 | + // Register payment form post type. |
|
79 | + register_post_type( |
|
80 | + 'wpi_payment_form', |
|
81 | + apply_filters( |
|
82 | + 'wpinv_register_post_type_payment_form', |
|
83 | + array( |
|
84 | + 'labels' => array( |
|
85 | + 'name' => _x( 'Payment Forms', 'post type general name', 'invoicing' ), |
|
86 | + 'singular_name' => _x( 'Payment Form', 'post type singular name', 'invoicing' ), |
|
87 | + 'menu_name' => _x( 'Payment Forms', 'admin menu', 'invoicing' ), |
|
88 | + 'name_admin_bar' => _x( 'Payment Form', 'add new on admin bar', 'invoicing' ), |
|
89 | + 'add_new' => _x( 'Add New', 'Payment Form', 'invoicing' ), |
|
90 | + 'add_new_item' => __( 'Add New Payment Form', 'invoicing' ), |
|
91 | + 'new_item' => __( 'New Payment Form', 'invoicing' ), |
|
92 | + 'edit_item' => __( 'Edit Payment Form', 'invoicing' ), |
|
93 | + 'view_item' => __( 'View Payment Form', 'invoicing' ), |
|
94 | + 'all_items' => __( 'Payment Forms', 'invoicing' ), |
|
95 | + 'search_items' => __( 'Search Payment Forms', 'invoicing' ), |
|
96 | + 'parent_item_colon' => __( 'Parent Payment Forms:', 'invoicing' ), |
|
97 | + 'not_found' => __( 'No payment forms found.', 'invoicing' ), |
|
98 | + 'not_found_in_trash' => __( 'No payment forms found in trash.', 'invoicing' ) |
|
99 | + ), |
|
100 | + 'description' => __( 'Add new payment forms.', 'invoicing' ), |
|
101 | + 'public' => false, |
|
102 | + 'show_ui' => true, |
|
103 | + 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : true, |
|
104 | + 'show_in_nav_menus' => false, |
|
105 | + 'query_var' => false, |
|
106 | + 'rewrite' => true, |
|
107 | + 'map_meta_cap' => true, |
|
108 | + 'has_archive' => false, |
|
109 | + 'hierarchical' => false, |
|
110 | + 'menu_position' => null, |
|
111 | + 'supports' => array( 'title' ), |
|
112 | + 'menu_icon' => 'dashicons-media-form', |
|
113 | + ) |
|
114 | + ) |
|
115 | + ); |
|
116 | 116 | |
117 | - // Register invoice post type. |
|
118 | - register_post_type( |
|
119 | - 'wpi_invoice', |
|
120 | - apply_filters( |
|
121 | - 'wpinv_register_post_type_invoice', |
|
122 | - array( |
|
123 | - 'labels' => array( |
|
124 | - 'name' => __( 'Invoices', 'invoicing' ), |
|
125 | - 'singular_name' => __( 'Invoice', 'invoicing' ), |
|
126 | - 'all_items' => __( 'Invoices', 'invoicing' ), |
|
127 | - 'menu_name' => _x( 'Invoices', 'Admin menu name', 'invoicing' ), |
|
128 | - 'add_new' => __( 'Add New', 'invoicing' ), |
|
129 | - 'add_new_item' => __( 'Add new invoice', 'invoicing' ), |
|
130 | - 'edit' => __( 'Edit', 'invoicing' ), |
|
131 | - 'edit_item' => __( 'Edit invoice', 'invoicing' ), |
|
132 | - 'new_item' => __( 'New invoice', 'invoicing' ), |
|
133 | - 'view_item' => __( 'View invoice', 'invoicing' ), |
|
134 | - 'view_items' => __( 'View Invoices', 'invoicing' ), |
|
135 | - 'search_items' => __( 'Search invoices', 'invoicing' ), |
|
136 | - 'not_found' => __( 'No invoices found', 'invoicing' ), |
|
137 | - 'not_found_in_trash' => __( 'No invoices found in trash', 'invoicing' ), |
|
138 | - 'parent' => __( 'Parent invoice', 'invoicing' ), |
|
139 | - 'featured_image' => __( 'Invoice image', 'invoicing' ), |
|
140 | - 'set_featured_image' => __( 'Set invoice image', 'invoicing' ), |
|
141 | - 'remove_featured_image' => __( 'Remove invoice image', 'invoicing' ), |
|
142 | - 'use_featured_image' => __( 'Use as invoice image', 'invoicing' ), |
|
143 | - 'insert_into_item' => __( 'Insert into invoice', 'invoicing' ), |
|
144 | - 'uploaded_to_this_item' => __( 'Uploaded to this invoice', 'invoicing' ), |
|
145 | - 'filter_items_list' => __( 'Filter invoices', 'invoicing' ), |
|
146 | - 'items_list_navigation' => __( 'Invoices navigation', 'invoicing' ), |
|
147 | - 'items_list' => __( 'Invoices list', 'invoicing' ), |
|
148 | - ), |
|
149 | - 'description' => __( 'This is where invoices are stored.', 'invoicing' ), |
|
150 | - 'public' => true, |
|
151 | - 'has_archive' => false, |
|
152 | - 'publicly_queryable' => true, |
|
153 | - 'exclude_from_search' => true, |
|
154 | - 'show_ui' => true, |
|
155 | - 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false, |
|
156 | - 'show_in_nav_menus' => false, |
|
157 | - 'supports' => array( 'title', 'author', 'excerpt' ), |
|
158 | - 'rewrite' => array( |
|
159 | - 'slug' => 'invoice', |
|
160 | - 'with_front' => false, |
|
161 | - ), |
|
162 | - 'query_var' => false, |
|
163 | - 'map_meta_cap' => true, |
|
164 | - 'show_in_admin_bar' => true, |
|
165 | - 'can_export' => true, |
|
166 | - 'hierarchical' => false, |
|
167 | - 'menu_position' => null, |
|
168 | - 'menu_icon' => 'dashicons-media-spreadsheet', |
|
169 | - ) |
|
170 | - ) |
|
171 | - ); |
|
117 | + // Register invoice post type. |
|
118 | + register_post_type( |
|
119 | + 'wpi_invoice', |
|
120 | + apply_filters( |
|
121 | + 'wpinv_register_post_type_invoice', |
|
122 | + array( |
|
123 | + 'labels' => array( |
|
124 | + 'name' => __( 'Invoices', 'invoicing' ), |
|
125 | + 'singular_name' => __( 'Invoice', 'invoicing' ), |
|
126 | + 'all_items' => __( 'Invoices', 'invoicing' ), |
|
127 | + 'menu_name' => _x( 'Invoices', 'Admin menu name', 'invoicing' ), |
|
128 | + 'add_new' => __( 'Add New', 'invoicing' ), |
|
129 | + 'add_new_item' => __( 'Add new invoice', 'invoicing' ), |
|
130 | + 'edit' => __( 'Edit', 'invoicing' ), |
|
131 | + 'edit_item' => __( 'Edit invoice', 'invoicing' ), |
|
132 | + 'new_item' => __( 'New invoice', 'invoicing' ), |
|
133 | + 'view_item' => __( 'View invoice', 'invoicing' ), |
|
134 | + 'view_items' => __( 'View Invoices', 'invoicing' ), |
|
135 | + 'search_items' => __( 'Search invoices', 'invoicing' ), |
|
136 | + 'not_found' => __( 'No invoices found', 'invoicing' ), |
|
137 | + 'not_found_in_trash' => __( 'No invoices found in trash', 'invoicing' ), |
|
138 | + 'parent' => __( 'Parent invoice', 'invoicing' ), |
|
139 | + 'featured_image' => __( 'Invoice image', 'invoicing' ), |
|
140 | + 'set_featured_image' => __( 'Set invoice image', 'invoicing' ), |
|
141 | + 'remove_featured_image' => __( 'Remove invoice image', 'invoicing' ), |
|
142 | + 'use_featured_image' => __( 'Use as invoice image', 'invoicing' ), |
|
143 | + 'insert_into_item' => __( 'Insert into invoice', 'invoicing' ), |
|
144 | + 'uploaded_to_this_item' => __( 'Uploaded to this invoice', 'invoicing' ), |
|
145 | + 'filter_items_list' => __( 'Filter invoices', 'invoicing' ), |
|
146 | + 'items_list_navigation' => __( 'Invoices navigation', 'invoicing' ), |
|
147 | + 'items_list' => __( 'Invoices list', 'invoicing' ), |
|
148 | + ), |
|
149 | + 'description' => __( 'This is where invoices are stored.', 'invoicing' ), |
|
150 | + 'public' => true, |
|
151 | + 'has_archive' => false, |
|
152 | + 'publicly_queryable' => true, |
|
153 | + 'exclude_from_search' => true, |
|
154 | + 'show_ui' => true, |
|
155 | + 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false, |
|
156 | + 'show_in_nav_menus' => false, |
|
157 | + 'supports' => array( 'title', 'author', 'excerpt' ), |
|
158 | + 'rewrite' => array( |
|
159 | + 'slug' => 'invoice', |
|
160 | + 'with_front' => false, |
|
161 | + ), |
|
162 | + 'query_var' => false, |
|
163 | + 'map_meta_cap' => true, |
|
164 | + 'show_in_admin_bar' => true, |
|
165 | + 'can_export' => true, |
|
166 | + 'hierarchical' => false, |
|
167 | + 'menu_position' => null, |
|
168 | + 'menu_icon' => 'dashicons-media-spreadsheet', |
|
169 | + ) |
|
170 | + ) |
|
171 | + ); |
|
172 | 172 | |
173 | - // Register discount post type. |
|
174 | - register_post_type( |
|
175 | - 'wpi_discount', |
|
176 | - apply_filters( |
|
177 | - 'wpinv_register_post_type_discount', |
|
178 | - array( |
|
179 | - 'labels' => array( |
|
180 | - 'name' => __( 'Discounts', 'invoicing' ), |
|
181 | - 'singular_name' => __( 'Discount', 'invoicing' ), |
|
182 | - 'all_items' => __( 'Discounts', 'invoicing' ), |
|
183 | - 'menu_name' => _x( 'Discounts', 'Admin menu name', 'invoicing' ), |
|
184 | - 'add_new' => __( 'Add New', 'invoicing' ), |
|
185 | - 'add_new_item' => __( 'Add new discount', 'invoicing' ), |
|
186 | - 'edit' => __( 'Edit', 'invoicing' ), |
|
187 | - 'edit_item' => __( 'Edit discount', 'invoicing' ), |
|
188 | - 'new_item' => __( 'New discount', 'invoicing' ), |
|
189 | - 'view_item' => __( 'View discount', 'invoicing' ), |
|
190 | - 'view_items' => __( 'View Discounts', 'invoicing' ), |
|
191 | - 'search_items' => __( 'Search discounts', 'invoicing' ), |
|
192 | - 'not_found' => __( 'No discounts found', 'invoicing' ), |
|
193 | - 'not_found_in_trash' => __( 'No discounts found in trash', 'invoicing' ), |
|
194 | - 'parent' => __( 'Parent discount', 'invoicing' ), |
|
195 | - 'featured_image' => __( 'Discount image', 'invoicing' ), |
|
196 | - 'set_featured_image' => __( 'Set discount image', 'invoicing' ), |
|
197 | - 'remove_featured_image' => __( 'Remove discount image', 'invoicing' ), |
|
198 | - 'use_featured_image' => __( 'Use as discount image', 'invoicing' ), |
|
199 | - 'insert_into_item' => __( 'Insert into discount', 'invoicing' ), |
|
200 | - 'uploaded_to_this_item' => __( 'Uploaded to this discount', 'invoicing' ), |
|
201 | - 'filter_items_list' => __( 'Filter discounts', 'invoicing' ), |
|
202 | - 'items_list_navigation' => __( 'Discount navigation', 'invoicing' ), |
|
203 | - 'items_list' => __( 'Discounts list', 'invoicing' ), |
|
204 | - ), |
|
205 | - 'description' => __( 'This is where you can add new discounts that users can use in invoices.', 'invoicing' ), |
|
206 | - 'public' => false, |
|
207 | - 'can_export' => true, |
|
208 | - '_builtin' => false, |
|
209 | - 'publicly_queryable' => false, |
|
210 | - 'exclude_from_search'=> true, |
|
211 | - 'show_ui' => true, |
|
212 | - 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false, |
|
213 | - 'query_var' => false, |
|
214 | - 'rewrite' => false, |
|
215 | - 'map_meta_cap' => true, |
|
216 | - 'has_archive' => false, |
|
217 | - 'hierarchical' => false, |
|
218 | - 'supports' => array( 'title', 'excerpt' ), |
|
219 | - 'show_in_nav_menus' => false, |
|
220 | - 'show_in_admin_bar' => true, |
|
221 | - 'menu_position' => null, |
|
222 | - ) |
|
223 | - ) |
|
224 | - ); |
|
173 | + // Register discount post type. |
|
174 | + register_post_type( |
|
175 | + 'wpi_discount', |
|
176 | + apply_filters( |
|
177 | + 'wpinv_register_post_type_discount', |
|
178 | + array( |
|
179 | + 'labels' => array( |
|
180 | + 'name' => __( 'Discounts', 'invoicing' ), |
|
181 | + 'singular_name' => __( 'Discount', 'invoicing' ), |
|
182 | + 'all_items' => __( 'Discounts', 'invoicing' ), |
|
183 | + 'menu_name' => _x( 'Discounts', 'Admin menu name', 'invoicing' ), |
|
184 | + 'add_new' => __( 'Add New', 'invoicing' ), |
|
185 | + 'add_new_item' => __( 'Add new discount', 'invoicing' ), |
|
186 | + 'edit' => __( 'Edit', 'invoicing' ), |
|
187 | + 'edit_item' => __( 'Edit discount', 'invoicing' ), |
|
188 | + 'new_item' => __( 'New discount', 'invoicing' ), |
|
189 | + 'view_item' => __( 'View discount', 'invoicing' ), |
|
190 | + 'view_items' => __( 'View Discounts', 'invoicing' ), |
|
191 | + 'search_items' => __( 'Search discounts', 'invoicing' ), |
|
192 | + 'not_found' => __( 'No discounts found', 'invoicing' ), |
|
193 | + 'not_found_in_trash' => __( 'No discounts found in trash', 'invoicing' ), |
|
194 | + 'parent' => __( 'Parent discount', 'invoicing' ), |
|
195 | + 'featured_image' => __( 'Discount image', 'invoicing' ), |
|
196 | + 'set_featured_image' => __( 'Set discount image', 'invoicing' ), |
|
197 | + 'remove_featured_image' => __( 'Remove discount image', 'invoicing' ), |
|
198 | + 'use_featured_image' => __( 'Use as discount image', 'invoicing' ), |
|
199 | + 'insert_into_item' => __( 'Insert into discount', 'invoicing' ), |
|
200 | + 'uploaded_to_this_item' => __( 'Uploaded to this discount', 'invoicing' ), |
|
201 | + 'filter_items_list' => __( 'Filter discounts', 'invoicing' ), |
|
202 | + 'items_list_navigation' => __( 'Discount navigation', 'invoicing' ), |
|
203 | + 'items_list' => __( 'Discounts list', 'invoicing' ), |
|
204 | + ), |
|
205 | + 'description' => __( 'This is where you can add new discounts that users can use in invoices.', 'invoicing' ), |
|
206 | + 'public' => false, |
|
207 | + 'can_export' => true, |
|
208 | + '_builtin' => false, |
|
209 | + 'publicly_queryable' => false, |
|
210 | + 'exclude_from_search'=> true, |
|
211 | + 'show_ui' => true, |
|
212 | + 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false, |
|
213 | + 'query_var' => false, |
|
214 | + 'rewrite' => false, |
|
215 | + 'map_meta_cap' => true, |
|
216 | + 'has_archive' => false, |
|
217 | + 'hierarchical' => false, |
|
218 | + 'supports' => array( 'title', 'excerpt' ), |
|
219 | + 'show_in_nav_menus' => false, |
|
220 | + 'show_in_admin_bar' => true, |
|
221 | + 'menu_position' => null, |
|
222 | + ) |
|
223 | + ) |
|
224 | + ); |
|
225 | 225 | |
226 | - do_action( 'getpaid_after_register_post_types' ); |
|
227 | - } |
|
226 | + do_action( 'getpaid_after_register_post_types' ); |
|
227 | + } |
|
228 | 228 | |
229 | - /** |
|
230 | - * Register our custom post statuses. |
|
231 | - */ |
|
232 | - public static function register_post_status() { |
|
229 | + /** |
|
230 | + * Register our custom post statuses. |
|
231 | + */ |
|
232 | + public static function register_post_status() { |
|
233 | 233 | |
234 | - $invoice_statuses = apply_filters( |
|
235 | - 'getpaid_register_invoice_post_statuses', |
|
236 | - array( |
|
234 | + $invoice_statuses = apply_filters( |
|
235 | + 'getpaid_register_invoice_post_statuses', |
|
236 | + array( |
|
237 | 237 | |
238 | - 'wpi-pending' => array( |
|
239 | - 'label' => _x( 'Pending Payment', 'Invoice status', 'invoicing' ), |
|
240 | - 'public' => true, |
|
241 | - 'exclude_from_search' => true, |
|
242 | - 'show_in_admin_all_list' => true, |
|
243 | - 'show_in_admin_status_list' => true, |
|
244 | - /* translators: %s: number of invoices */ |
|
245 | - 'label_count' => _n_noop( 'Pending Payment <span class="count">(%s)</span>', 'Pending Payment <span class="count">(%s)</span>', 'invoicing' ) |
|
246 | - ), |
|
238 | + 'wpi-pending' => array( |
|
239 | + 'label' => _x( 'Pending Payment', 'Invoice status', 'invoicing' ), |
|
240 | + 'public' => true, |
|
241 | + 'exclude_from_search' => true, |
|
242 | + 'show_in_admin_all_list' => true, |
|
243 | + 'show_in_admin_status_list' => true, |
|
244 | + /* translators: %s: number of invoices */ |
|
245 | + 'label_count' => _n_noop( 'Pending Payment <span class="count">(%s)</span>', 'Pending Payment <span class="count">(%s)</span>', 'invoicing' ) |
|
246 | + ), |
|
247 | 247 | |
248 | - 'wpi-processing' => array( |
|
249 | - 'label' => _x( 'Processing', 'Invoice status', 'invoicing' ), |
|
250 | - 'public' => true, |
|
251 | - 'exclude_from_search' => true, |
|
252 | - 'show_in_admin_all_list' => true, |
|
253 | - 'show_in_admin_status_list' => true, |
|
254 | - /* translators: %s: number of invoices */ |
|
255 | - 'label_count' => _n_noop( 'Processing <span class="count">(%s)</span>', 'Processing <span class="count">(%s)</span>', 'invoicing' ) |
|
256 | - ), |
|
248 | + 'wpi-processing' => array( |
|
249 | + 'label' => _x( 'Processing', 'Invoice status', 'invoicing' ), |
|
250 | + 'public' => true, |
|
251 | + 'exclude_from_search' => true, |
|
252 | + 'show_in_admin_all_list' => true, |
|
253 | + 'show_in_admin_status_list' => true, |
|
254 | + /* translators: %s: number of invoices */ |
|
255 | + 'label_count' => _n_noop( 'Processing <span class="count">(%s)</span>', 'Processing <span class="count">(%s)</span>', 'invoicing' ) |
|
256 | + ), |
|
257 | 257 | |
258 | - 'wpi-onhold' => array( |
|
259 | - 'label' => _x( 'On Hold', 'Invoice status', 'invoicing' ), |
|
260 | - 'public' => true, |
|
261 | - 'exclude_from_search' => true, |
|
262 | - 'show_in_admin_all_list' => true, |
|
263 | - 'show_in_admin_status_list' => true, |
|
264 | - /* translators: %s: number of invoices */ |
|
265 | - 'label_count' => _n_noop( 'On Hold <span class="count">(%s)</span>', 'On Hold <span class="count">(%s)</span>', 'invoicing' ) |
|
266 | - ), |
|
258 | + 'wpi-onhold' => array( |
|
259 | + 'label' => _x( 'On Hold', 'Invoice status', 'invoicing' ), |
|
260 | + 'public' => true, |
|
261 | + 'exclude_from_search' => true, |
|
262 | + 'show_in_admin_all_list' => true, |
|
263 | + 'show_in_admin_status_list' => true, |
|
264 | + /* translators: %s: number of invoices */ |
|
265 | + 'label_count' => _n_noop( 'On Hold <span class="count">(%s)</span>', 'On Hold <span class="count">(%s)</span>', 'invoicing' ) |
|
266 | + ), |
|
267 | 267 | |
268 | - 'wpi-cancelled' => array( |
|
269 | - 'label' => _x( 'Cancelled', 'Invoice status', 'invoicing' ), |
|
270 | - 'public' => true, |
|
271 | - 'exclude_from_search' => true, |
|
272 | - 'show_in_admin_all_list' => true, |
|
273 | - 'show_in_admin_status_list' => true, |
|
274 | - /* translators: %s: number of invoices */ |
|
275 | - 'label_count' => _n_noop( 'Cancelled <span class="count">(%s)</span>', 'Cancelled <span class="count">(%s)</span>', 'invoicing' ) |
|
276 | - ), |
|
268 | + 'wpi-cancelled' => array( |
|
269 | + 'label' => _x( 'Cancelled', 'Invoice status', 'invoicing' ), |
|
270 | + 'public' => true, |
|
271 | + 'exclude_from_search' => true, |
|
272 | + 'show_in_admin_all_list' => true, |
|
273 | + 'show_in_admin_status_list' => true, |
|
274 | + /* translators: %s: number of invoices */ |
|
275 | + 'label_count' => _n_noop( 'Cancelled <span class="count">(%s)</span>', 'Cancelled <span class="count">(%s)</span>', 'invoicing' ) |
|
276 | + ), |
|
277 | 277 | |
278 | - 'wpi-refunded' => array( |
|
279 | - 'label' => _x( 'Refunded', 'Invoice status', 'invoicing' ), |
|
280 | - 'public' => true, |
|
281 | - 'exclude_from_search' => true, |
|
282 | - 'show_in_admin_all_list' => true, |
|
283 | - 'show_in_admin_status_list' => true, |
|
284 | - /* translators: %s: number of invoices */ |
|
285 | - 'label_count' => _n_noop( 'Refunded <span class="count">(%s)</span>', 'Refunded <span class="count">(%s)</span>', 'invoicing' ) |
|
286 | - ), |
|
278 | + 'wpi-refunded' => array( |
|
279 | + 'label' => _x( 'Refunded', 'Invoice status', 'invoicing' ), |
|
280 | + 'public' => true, |
|
281 | + 'exclude_from_search' => true, |
|
282 | + 'show_in_admin_all_list' => true, |
|
283 | + 'show_in_admin_status_list' => true, |
|
284 | + /* translators: %s: number of invoices */ |
|
285 | + 'label_count' => _n_noop( 'Refunded <span class="count">(%s)</span>', 'Refunded <span class="count">(%s)</span>', 'invoicing' ) |
|
286 | + ), |
|
287 | 287 | |
288 | - 'wpi-failed' => array( |
|
289 | - 'label' => _x( 'Failed', 'Invoice status', 'invoicing' ), |
|
290 | - 'public' => true, |
|
291 | - 'exclude_from_search' => true, |
|
292 | - 'show_in_admin_all_list' => true, |
|
293 | - 'show_in_admin_status_list' => true, |
|
294 | - /* translators: %s: number of invoices */ |
|
295 | - 'label_count' => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'invoicing' ) |
|
296 | - ), |
|
288 | + 'wpi-failed' => array( |
|
289 | + 'label' => _x( 'Failed', 'Invoice status', 'invoicing' ), |
|
290 | + 'public' => true, |
|
291 | + 'exclude_from_search' => true, |
|
292 | + 'show_in_admin_all_list' => true, |
|
293 | + 'show_in_admin_status_list' => true, |
|
294 | + /* translators: %s: number of invoices */ |
|
295 | + 'label_count' => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'invoicing' ) |
|
296 | + ), |
|
297 | 297 | |
298 | - 'wpi-renewal' => array( |
|
299 | - 'label' => _x( 'Renewal', 'Invoice status', 'invoicing' ), |
|
300 | - 'public' => true, |
|
301 | - 'exclude_from_search' => true, |
|
302 | - 'show_in_admin_all_list' => true, |
|
303 | - 'show_in_admin_status_list' => true, |
|
304 | - /* translators: %s: number of invoices */ |
|
305 | - 'label_count' => _n_noop( 'Renewal <span class="count">(%s)</span>', 'Renewal <span class="count">(%s)</span>', 'invoicing' ) |
|
306 | - ) |
|
307 | - ) |
|
308 | - ); |
|
298 | + 'wpi-renewal' => array( |
|
299 | + 'label' => _x( 'Renewal', 'Invoice status', 'invoicing' ), |
|
300 | + 'public' => true, |
|
301 | + 'exclude_from_search' => true, |
|
302 | + 'show_in_admin_all_list' => true, |
|
303 | + 'show_in_admin_status_list' => true, |
|
304 | + /* translators: %s: number of invoices */ |
|
305 | + 'label_count' => _n_noop( 'Renewal <span class="count">(%s)</span>', 'Renewal <span class="count">(%s)</span>', 'invoicing' ) |
|
306 | + ) |
|
307 | + ) |
|
308 | + ); |
|
309 | 309 | |
310 | - foreach ( $invoice_statuses as $invoice_statuse => $args ) { |
|
311 | - register_post_status( $invoice_statuse, $args ); |
|
312 | - } |
|
313 | - } |
|
310 | + foreach ( $invoice_statuses as $invoice_statuse => $args ) { |
|
311 | + register_post_status( $invoice_statuse, $args ); |
|
312 | + } |
|
313 | + } |
|
314 | 314 | |
315 | - /** |
|
316 | - * Flush rewrite rules. |
|
317 | - */ |
|
318 | - public static function flush_rewrite_rules() { |
|
319 | - flush_rewrite_rules(); |
|
320 | - } |
|
315 | + /** |
|
316 | + * Flush rewrite rules. |
|
317 | + */ |
|
318 | + public static function flush_rewrite_rules() { |
|
319 | + flush_rewrite_rules(); |
|
320 | + } |
|
321 | 321 | |
322 | - /** |
|
323 | - * Flush rules to prevent 404. |
|
324 | - * |
|
325 | - */ |
|
326 | - public static function maybe_flush_rewrite_rules() { |
|
327 | - if ( ! get_option( 'getpaid_flushed_rewrite_rules' ) ) { |
|
328 | - update_option( 'getpaid_flushed_rewrite_rules', '1' ); |
|
329 | - self::flush_rewrite_rules(); |
|
330 | - } |
|
331 | - } |
|
322 | + /** |
|
323 | + * Flush rules to prevent 404. |
|
324 | + * |
|
325 | + */ |
|
326 | + public static function maybe_flush_rewrite_rules() { |
|
327 | + if ( ! get_option( 'getpaid_flushed_rewrite_rules' ) ) { |
|
328 | + update_option( 'getpaid_flushed_rewrite_rules', '1' ); |
|
329 | + self::flush_rewrite_rules(); |
|
330 | + } |
|
331 | + } |
|
332 | 332 | |
333 | 333 | } |
@@ -12,267 +12,267 @@ |
||
12 | 12 | */ |
13 | 13 | class GetPaid_Metaboxes { |
14 | 14 | |
15 | - /** |
|
16 | - * Only save metaboxes once. |
|
17 | - * |
|
18 | - * @var boolean |
|
19 | - */ |
|
20 | - private static $saved_meta_boxes = false; |
|
21 | - |
|
22 | 15 | /** |
23 | - * Hook in methods. |
|
24 | - */ |
|
25 | - public static function init() { |
|
26 | - |
|
27 | - // Register metaboxes. |
|
28 | - add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::add_meta_boxes', 5, 2 ); |
|
29 | - |
|
30 | - // Remove metaboxes. |
|
31 | - add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::remove_meta_boxes', 30 ); |
|
32 | - |
|
33 | - // Rename metaboxes. |
|
34 | - add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::rename_meta_boxes', 45 ); |
|
35 | - |
|
36 | - // Save metaboxes. |
|
37 | - add_action( 'save_post', 'GetPaid_Metaboxes::save_meta_boxes', 1, 2 ); |
|
38 | - } |
|
16 | + * Only save metaboxes once. |
|
17 | + * |
|
18 | + * @var boolean |
|
19 | + */ |
|
20 | + private static $saved_meta_boxes = false; |
|
39 | 21 | |
40 | - /** |
|
41 | - * Register core metaboxes. |
|
42 | - */ |
|
43 | - public static function add_meta_boxes( $post_type, $post ) { |
|
44 | - |
|
45 | - // For invoices... |
|
46 | - self::add_invoice_meta_boxes( $post_type, $post ); |
|
22 | + /** |
|
23 | + * Hook in methods. |
|
24 | + */ |
|
25 | + public static function init() { |
|
47 | 26 | |
48 | - // For payment forms. |
|
49 | - self::add_payment_form_meta_boxes( $post_type ); |
|
27 | + // Register metaboxes. |
|
28 | + add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::add_meta_boxes', 5, 2 ); |
|
50 | 29 | |
51 | - // For invoice items. |
|
52 | - self::add_item_meta_boxes( $post_type ); |
|
30 | + // Remove metaboxes. |
|
31 | + add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::remove_meta_boxes', 30 ); |
|
53 | 32 | |
54 | - // For invoice discounts. |
|
55 | - if ( $post_type == 'wpi_discount' ) { |
|
56 | - add_meta_box( 'wpinv_discount_details', __( 'Discount Details', 'invoicing' ), 'GetPaid_Meta_Box_Discount_Details::output', 'wpi_discount', 'normal', 'high' ); |
|
57 | - } |
|
33 | + // Rename metaboxes. |
|
34 | + add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::rename_meta_boxes', 45 ); |
|
58 | 35 | |
59 | - } |
|
36 | + // Save metaboxes. |
|
37 | + add_action( 'save_post', 'GetPaid_Metaboxes::save_meta_boxes', 1, 2 ); |
|
38 | + } |
|
60 | 39 | |
61 | - /** |
|
62 | - * Register core metaboxes. |
|
63 | - */ |
|
64 | - protected static function add_payment_form_meta_boxes( $post_type ) { |
|
40 | + /** |
|
41 | + * Register core metaboxes. |
|
42 | + */ |
|
43 | + public static function add_meta_boxes( $post_type, $post ) { |
|
65 | 44 | |
66 | - // For payment forms. |
|
67 | - if ( $post_type == 'wpi_payment_form' ) { |
|
45 | + // For invoices... |
|
46 | + self::add_invoice_meta_boxes( $post_type, $post ); |
|
68 | 47 | |
69 | - // Design payment form. |
|
70 | - add_meta_box( 'wpinv-payment-form-design', __( 'Payment Form', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form::output', 'wpi_payment_form', 'normal' ); |
|
48 | + // For payment forms. |
|
49 | + self::add_payment_form_meta_boxes( $post_type ); |
|
71 | 50 | |
72 | - // Payment form information. |
|
73 | - add_meta_box( 'wpinv-payment-form-info', __( 'Details', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form_Info::output', 'wpi_payment_form', 'side' ); |
|
51 | + // For invoice items. |
|
52 | + self::add_item_meta_boxes( $post_type ); |
|
74 | 53 | |
75 | - } |
|
54 | + // For invoice discounts. |
|
55 | + if ( $post_type == 'wpi_discount' ) { |
|
56 | + add_meta_box( 'wpinv_discount_details', __( 'Discount Details', 'invoicing' ), 'GetPaid_Meta_Box_Discount_Details::output', 'wpi_discount', 'normal', 'high' ); |
|
57 | + } |
|
76 | 58 | |
77 | - } |
|
59 | + } |
|
78 | 60 | |
79 | - /** |
|
80 | - * Register core metaboxes. |
|
81 | - */ |
|
82 | - protected static function add_item_meta_boxes( $post_type ) { |
|
61 | + /** |
|
62 | + * Register core metaboxes. |
|
63 | + */ |
|
64 | + protected static function add_payment_form_meta_boxes( $post_type ) { |
|
83 | 65 | |
84 | - if ( $post_type == 'wpi_item' ) { |
|
66 | + // For payment forms. |
|
67 | + if ( $post_type == 'wpi_payment_form' ) { |
|
85 | 68 | |
86 | - // Item details. |
|
87 | - add_meta_box( 'wpinv_item_details', __( 'Item Details', 'invoicing' ), 'GetPaid_Meta_Box_Item_Details::output', 'wpi_item', 'normal', 'high' ); |
|
69 | + // Design payment form. |
|
70 | + add_meta_box( 'wpinv-payment-form-design', __( 'Payment Form', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form::output', 'wpi_payment_form', 'normal' ); |
|
88 | 71 | |
89 | - // If taxes are enabled, register the tax metabox. |
|
90 | - if ( wpinv_use_taxes() ) { |
|
91 | - add_meta_box( 'wpinv_item_vat', __( 'Tax', 'invoicing' ), 'GetPaid_Meta_Box_Item_VAT::output', 'wpi_item', 'normal', 'high' ); |
|
92 | - } |
|
72 | + // Payment form information. |
|
73 | + add_meta_box( 'wpinv-payment-form-info', __( 'Details', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form_Info::output', 'wpi_payment_form', 'side' ); |
|
93 | 74 | |
94 | - // Item info. |
|
95 | - add_meta_box( 'wpinv_field_item_info', __( 'Item info', 'invoicing' ), 'GetPaid_Meta_Box_Item_Info::output', 'wpi_item', 'side', 'core' ); |
|
75 | + } |
|
96 | 76 | |
97 | - } |
|
77 | + } |
|
98 | 78 | |
99 | - } |
|
79 | + /** |
|
80 | + * Register core metaboxes. |
|
81 | + */ |
|
82 | + protected static function add_item_meta_boxes( $post_type ) { |
|
100 | 83 | |
101 | - /** |
|
102 | - * Register invoice metaboxes. |
|
103 | - */ |
|
104 | - protected static function add_invoice_meta_boxes( $post_type, $post ) { |
|
84 | + if ( $post_type == 'wpi_item' ) { |
|
105 | 85 | |
106 | - // For invoices... |
|
107 | - if ( getpaid_is_invoice_post_type( $post_type ) ) { |
|
108 | - $invoice = new WPInv_Invoice( $post ); |
|
86 | + // Item details. |
|
87 | + add_meta_box( 'wpinv_item_details', __( 'Item Details', 'invoicing' ), 'GetPaid_Meta_Box_Item_Details::output', 'wpi_item', 'normal', 'high' ); |
|
109 | 88 | |
110 | - // Resend invoice. |
|
111 | - if ( ! $invoice->is_draft() ) { |
|
89 | + // If taxes are enabled, register the tax metabox. |
|
90 | + if ( wpinv_use_taxes() ) { |
|
91 | + add_meta_box( 'wpinv_item_vat', __( 'Tax', 'invoicing' ), 'GetPaid_Meta_Box_Item_VAT::output', 'wpi_item', 'normal', 'high' ); |
|
92 | + } |
|
112 | 93 | |
113 | - add_meta_box( |
|
114 | - 'wpinv-mb-resend-invoice', |
|
115 | - sprintf( |
|
116 | - __( 'Resend %s', 'invoicing' ), |
|
117 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
118 | - ), |
|
119 | - 'GetPaid_Meta_Box_Resend_Invoice::output', |
|
120 | - $post_type, |
|
121 | - 'side', |
|
122 | - 'low' |
|
123 | - ); |
|
94 | + // Item info. |
|
95 | + add_meta_box( 'wpinv_field_item_info', __( 'Item info', 'invoicing' ), 'GetPaid_Meta_Box_Item_Info::output', 'wpi_item', 'side', 'core' ); |
|
124 | 96 | |
125 | - } |
|
97 | + } |
|
126 | 98 | |
127 | - // Subscriptions. |
|
128 | - $subscription = getpaid_get_invoice_subscription( $invoice ); |
|
129 | - if ( ! empty( $subscription ) ) { |
|
130 | - add_meta_box( 'wpinv-mb-subscriptions', __( 'Subscription Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output', $post_type, 'advanced' ); |
|
131 | - add_meta_box( 'wpinv-mb-subscription-invoices', __( 'Related Payments', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_invoices', $post_type, 'advanced' ); |
|
132 | - } |
|
133 | - |
|
134 | - // Invoice details. |
|
135 | - add_meta_box( |
|
136 | - 'wpinv-details', |
|
137 | - sprintf( |
|
138 | - __( '%s Details', 'invoicing' ), |
|
139 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
140 | - ), |
|
141 | - 'GetPaid_Meta_Box_Invoice_Details::output', |
|
142 | - $post_type, |
|
143 | - 'side' |
|
144 | - ); |
|
145 | - |
|
146 | - // Payment details. |
|
147 | - if ( ! $invoice->is_draft() ) { |
|
148 | - add_meta_box( 'wpinv-payment-meta', __( 'Payment Meta', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Payment_Meta::output', $post_type, 'side', 'default' ); |
|
149 | - } |
|
99 | + } |
|
150 | 100 | |
151 | - // Billing details. |
|
152 | - add_meta_box( 'wpinv-address', __( 'Billing Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Address::output', $post_type, 'normal', 'high' ); |
|
101 | + /** |
|
102 | + * Register invoice metaboxes. |
|
103 | + */ |
|
104 | + protected static function add_invoice_meta_boxes( $post_type, $post ) { |
|
105 | + |
|
106 | + // For invoices... |
|
107 | + if ( getpaid_is_invoice_post_type( $post_type ) ) { |
|
108 | + $invoice = new WPInv_Invoice( $post ); |
|
109 | + |
|
110 | + // Resend invoice. |
|
111 | + if ( ! $invoice->is_draft() ) { |
|
112 | + |
|
113 | + add_meta_box( |
|
114 | + 'wpinv-mb-resend-invoice', |
|
115 | + sprintf( |
|
116 | + __( 'Resend %s', 'invoicing' ), |
|
117 | + ucfirst( $invoice->get_invoice_quote_type() ) |
|
118 | + ), |
|
119 | + 'GetPaid_Meta_Box_Resend_Invoice::output', |
|
120 | + $post_type, |
|
121 | + 'side', |
|
122 | + 'low' |
|
123 | + ); |
|
124 | + |
|
125 | + } |
|
126 | + |
|
127 | + // Subscriptions. |
|
128 | + $subscription = getpaid_get_invoice_subscription( $invoice ); |
|
129 | + if ( ! empty( $subscription ) ) { |
|
130 | + add_meta_box( 'wpinv-mb-subscriptions', __( 'Subscription Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output', $post_type, 'advanced' ); |
|
131 | + add_meta_box( 'wpinv-mb-subscription-invoices', __( 'Related Payments', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_invoices', $post_type, 'advanced' ); |
|
132 | + } |
|
133 | + |
|
134 | + // Invoice details. |
|
135 | + add_meta_box( |
|
136 | + 'wpinv-details', |
|
137 | + sprintf( |
|
138 | + __( '%s Details', 'invoicing' ), |
|
139 | + ucfirst( $invoice->get_invoice_quote_type() ) |
|
140 | + ), |
|
141 | + 'GetPaid_Meta_Box_Invoice_Details::output', |
|
142 | + $post_type, |
|
143 | + 'side' |
|
144 | + ); |
|
145 | + |
|
146 | + // Payment details. |
|
147 | + if ( ! $invoice->is_draft() ) { |
|
148 | + add_meta_box( 'wpinv-payment-meta', __( 'Payment Meta', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Payment_Meta::output', $post_type, 'side', 'default' ); |
|
149 | + } |
|
150 | + |
|
151 | + // Billing details. |
|
152 | + add_meta_box( 'wpinv-address', __( 'Billing Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Address::output', $post_type, 'normal', 'high' ); |
|
153 | 153 | |
154 | - // Invoice items. |
|
155 | - add_meta_box( |
|
156 | - 'wpinv-items', |
|
157 | - sprintf( |
|
158 | - __( '%s Items', 'invoicing' ), |
|
159 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
160 | - ), |
|
161 | - 'GetPaid_Meta_Box_Invoice_Items::output', |
|
162 | - $post_type, |
|
163 | - 'normal', |
|
164 | - 'high' |
|
165 | - ); |
|
154 | + // Invoice items. |
|
155 | + add_meta_box( |
|
156 | + 'wpinv-items', |
|
157 | + sprintf( |
|
158 | + __( '%s Items', 'invoicing' ), |
|
159 | + ucfirst( $invoice->get_invoice_quote_type() ) |
|
160 | + ), |
|
161 | + 'GetPaid_Meta_Box_Invoice_Items::output', |
|
162 | + $post_type, |
|
163 | + 'normal', |
|
164 | + 'high' |
|
165 | + ); |
|
166 | 166 | |
167 | - // Invoice notes. |
|
168 | - add_meta_box( |
|
169 | - 'wpinv-notes', |
|
170 | - sprintf( |
|
171 | - __( '%s Notes', 'invoicing' ), |
|
172 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
173 | - ), |
|
174 | - 'WPInv_Meta_Box_Notes::output', |
|
175 | - $post_type, |
|
176 | - 'side', |
|
177 | - 'low' |
|
178 | - ); |
|
179 | - |
|
180 | - // Shipping Address. |
|
181 | - if ( get_post_meta( $invoice->get_id(), 'shipping_address', true ) ) { |
|
182 | - add_meta_box( 'wpinv-invoice-shipping-details', __( 'Shipping Address', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Shipping_Address::output', $post_type, 'side', 'high' ); |
|
183 | - } |
|
184 | - |
|
185 | - // Payment form information. |
|
186 | - if ( get_post_meta( $invoice->get_id(), 'payment_form_data', true ) ) { |
|
187 | - add_meta_box( 'wpinv-invoice-payment-form-details', __( 'Payment Form Details', 'invoicing' ), 'WPInv_Meta_Box_Payment_Form::output_details', $post_type, 'side', 'high' ); |
|
188 | - } |
|
189 | - |
|
190 | - } |
|
191 | - |
|
192 | - } |
|
193 | - |
|
194 | - /** |
|
195 | - * Remove some metaboxes. |
|
196 | - */ |
|
197 | - public static function remove_meta_boxes() { |
|
198 | - remove_meta_box( 'wpseo_meta', 'wpi_invoice', 'normal' ); |
|
199 | - } |
|
200 | - |
|
201 | - /** |
|
202 | - * Rename other metaboxes. |
|
203 | - */ |
|
204 | - public static function rename_meta_boxes() { |
|
167 | + // Invoice notes. |
|
168 | + add_meta_box( |
|
169 | + 'wpinv-notes', |
|
170 | + sprintf( |
|
171 | + __( '%s Notes', 'invoicing' ), |
|
172 | + ucfirst( $invoice->get_invoice_quote_type() ) |
|
173 | + ), |
|
174 | + 'WPInv_Meta_Box_Notes::output', |
|
175 | + $post_type, |
|
176 | + 'side', |
|
177 | + 'low' |
|
178 | + ); |
|
179 | + |
|
180 | + // Shipping Address. |
|
181 | + if ( get_post_meta( $invoice->get_id(), 'shipping_address', true ) ) { |
|
182 | + add_meta_box( 'wpinv-invoice-shipping-details', __( 'Shipping Address', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Shipping_Address::output', $post_type, 'side', 'high' ); |
|
183 | + } |
|
184 | + |
|
185 | + // Payment form information. |
|
186 | + if ( get_post_meta( $invoice->get_id(), 'payment_form_data', true ) ) { |
|
187 | + add_meta_box( 'wpinv-invoice-payment-form-details', __( 'Payment Form Details', 'invoicing' ), 'WPInv_Meta_Box_Payment_Form::output_details', $post_type, 'side', 'high' ); |
|
188 | + } |
|
189 | + |
|
190 | + } |
|
191 | + |
|
192 | + } |
|
193 | + |
|
194 | + /** |
|
195 | + * Remove some metaboxes. |
|
196 | + */ |
|
197 | + public static function remove_meta_boxes() { |
|
198 | + remove_meta_box( 'wpseo_meta', 'wpi_invoice', 'normal' ); |
|
199 | + } |
|
200 | + |
|
201 | + /** |
|
202 | + * Rename other metaboxes. |
|
203 | + */ |
|
204 | + public static function rename_meta_boxes() { |
|
205 | 205 | |
206 | - } |
|
207 | - |
|
208 | - /** |
|
209 | - * Check if we're saving, then trigger an action based on the post type. |
|
210 | - * |
|
211 | - * @param int $post_id Post ID. |
|
212 | - * @param object $post Post object. |
|
213 | - */ |
|
214 | - public static function save_meta_boxes( $post_id, $post ) { |
|
215 | - $post_id = absint( $post_id ); |
|
216 | - $data = wp_unslash( $_POST ); |
|
217 | - |
|
218 | - // Do not save for ajax requests. |
|
219 | - if ( ( defined( 'DOING_AJAX') && DOING_AJAX ) || isset( $_REQUEST['bulk_edit'] ) ) { |
|
220 | - return; |
|
221 | - } |
|
222 | - |
|
223 | - // $post_id and $post are required |
|
224 | - if ( empty( $post_id ) || empty( $post ) || self::$saved_meta_boxes ) { |
|
225 | - return; |
|
226 | - } |
|
227 | - |
|
228 | - // Dont' save meta boxes for revisions or autosaves. |
|
229 | - if ( ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) || is_int( wp_is_post_revision( $post ) ) || is_int( wp_is_post_autosave( $post ) ) ) { |
|
230 | - return; |
|
231 | - } |
|
232 | - |
|
233 | - // Check the nonce. |
|
234 | - if ( empty( $data['getpaid_meta_nonce'] ) || ! wp_verify_nonce( $data['getpaid_meta_nonce'], 'getpaid_meta_nonce' ) ) { |
|
235 | - return; |
|
236 | - } |
|
237 | - |
|
238 | - // Check the post being saved == the $post_id to prevent triggering this call for other save_post events. |
|
239 | - if ( empty( $data['post_ID'] ) || absint( $data['post_ID'] ) !== $post_id ) { |
|
240 | - return; |
|
241 | - } |
|
242 | - |
|
243 | - // Check user has permission to edit. |
|
244 | - if ( ! current_user_can( 'edit_post', $post_id ) ) { |
|
245 | - return; |
|
246 | - } |
|
247 | - |
|
248 | - if ( getpaid_is_invoice_post_type( $post->post_type ) ) { |
|
249 | - |
|
250 | - // We need this save event to run once to avoid potential endless loops. |
|
251 | - self::$saved_meta_boxes = true; |
|
252 | - |
|
253 | - return GetPaid_Meta_Box_Invoice_Address::save( $post_id ); |
|
254 | - |
|
255 | - } |
|
256 | - |
|
257 | - // Ensure this is our post type. |
|
258 | - $post_types_map = array( |
|
259 | - 'wpi_item' => 'GetPaid_Meta_Box_Item_Details', |
|
260 | - 'wpi_payment_form' => 'GetPaid_Meta_Box_Payment_Form', |
|
261 | - 'wpi_discount' => 'GetPaid_Meta_Box_Discount_Details', |
|
262 | - ); |
|
263 | - |
|
264 | - // Is this our post type? |
|
265 | - if ( ! isset( $post_types_map[ $post->post_type ] ) ) { |
|
266 | - return; |
|
267 | - } |
|
268 | - |
|
269 | - // We need this save event to run once to avoid potential endless loops. |
|
270 | - self::$saved_meta_boxes = true; |
|
206 | + } |
|
207 | + |
|
208 | + /** |
|
209 | + * Check if we're saving, then trigger an action based on the post type. |
|
210 | + * |
|
211 | + * @param int $post_id Post ID. |
|
212 | + * @param object $post Post object. |
|
213 | + */ |
|
214 | + public static function save_meta_boxes( $post_id, $post ) { |
|
215 | + $post_id = absint( $post_id ); |
|
216 | + $data = wp_unslash( $_POST ); |
|
217 | + |
|
218 | + // Do not save for ajax requests. |
|
219 | + if ( ( defined( 'DOING_AJAX') && DOING_AJAX ) || isset( $_REQUEST['bulk_edit'] ) ) { |
|
220 | + return; |
|
221 | + } |
|
222 | + |
|
223 | + // $post_id and $post are required |
|
224 | + if ( empty( $post_id ) || empty( $post ) || self::$saved_meta_boxes ) { |
|
225 | + return; |
|
226 | + } |
|
227 | + |
|
228 | + // Dont' save meta boxes for revisions or autosaves. |
|
229 | + if ( ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) || is_int( wp_is_post_revision( $post ) ) || is_int( wp_is_post_autosave( $post ) ) ) { |
|
230 | + return; |
|
231 | + } |
|
232 | + |
|
233 | + // Check the nonce. |
|
234 | + if ( empty( $data['getpaid_meta_nonce'] ) || ! wp_verify_nonce( $data['getpaid_meta_nonce'], 'getpaid_meta_nonce' ) ) { |
|
235 | + return; |
|
236 | + } |
|
237 | + |
|
238 | + // Check the post being saved == the $post_id to prevent triggering this call for other save_post events. |
|
239 | + if ( empty( $data['post_ID'] ) || absint( $data['post_ID'] ) !== $post_id ) { |
|
240 | + return; |
|
241 | + } |
|
242 | + |
|
243 | + // Check user has permission to edit. |
|
244 | + if ( ! current_user_can( 'edit_post', $post_id ) ) { |
|
245 | + return; |
|
246 | + } |
|
247 | + |
|
248 | + if ( getpaid_is_invoice_post_type( $post->post_type ) ) { |
|
249 | + |
|
250 | + // We need this save event to run once to avoid potential endless loops. |
|
251 | + self::$saved_meta_boxes = true; |
|
252 | + |
|
253 | + return GetPaid_Meta_Box_Invoice_Address::save( $post_id ); |
|
254 | + |
|
255 | + } |
|
256 | + |
|
257 | + // Ensure this is our post type. |
|
258 | + $post_types_map = array( |
|
259 | + 'wpi_item' => 'GetPaid_Meta_Box_Item_Details', |
|
260 | + 'wpi_payment_form' => 'GetPaid_Meta_Box_Payment_Form', |
|
261 | + 'wpi_discount' => 'GetPaid_Meta_Box_Discount_Details', |
|
262 | + ); |
|
263 | + |
|
264 | + // Is this our post type? |
|
265 | + if ( ! isset( $post_types_map[ $post->post_type ] ) ) { |
|
266 | + return; |
|
267 | + } |
|
268 | + |
|
269 | + // We need this save event to run once to avoid potential endless loops. |
|
270 | + self::$saved_meta_boxes = true; |
|
271 | 271 | |
272 | - // Save the post. |
|
273 | - $class = $post_types_map[ $post->post_type ]; |
|
274 | - $class::save( $post_id, $_POST, $post ); |
|
272 | + // Save the post. |
|
273 | + $class = $post_types_map[ $post->post_type ]; |
|
274 | + $class::save( $post_id, $_POST, $post ); |
|
275 | 275 | |
276 | - } |
|
276 | + } |
|
277 | 277 | |
278 | 278 | } |
@@ -13,30 +13,30 @@ discard block |
||
13 | 13 | class GetPaid_Manual_Gateway extends GetPaid_Payment_Gateway { |
14 | 14 | |
15 | 15 | /** |
16 | - * Payment method id. |
|
17 | - * |
|
18 | - * @var string |
|
19 | - */ |
|
16 | + * Payment method id. |
|
17 | + * |
|
18 | + * @var string |
|
19 | + */ |
|
20 | 20 | public $id = 'manual'; |
21 | 21 | |
22 | 22 | /** |
23 | - * An array of features that this gateway supports. |
|
24 | - * |
|
25 | - * @var array |
|
26 | - */ |
|
23 | + * An array of features that this gateway supports. |
|
24 | + * |
|
25 | + * @var array |
|
26 | + */ |
|
27 | 27 | protected $supports = array( 'subscription', 'addons' ); |
28 | 28 | |
29 | 29 | /** |
30 | - * Payment method order. |
|
31 | - * |
|
32 | - * @var int |
|
33 | - */ |
|
34 | - public $order = 11; |
|
30 | + * Payment method order. |
|
31 | + * |
|
32 | + * @var int |
|
33 | + */ |
|
34 | + public $order = 11; |
|
35 | 35 | |
36 | 36 | /** |
37 | - * Class constructor. |
|
38 | - */ |
|
39 | - public function __construct() { |
|
37 | + * Class constructor. |
|
38 | + */ |
|
39 | + public function __construct() { |
|
40 | 40 | parent::__construct(); |
41 | 41 | |
42 | 42 | $this->title = __( 'Test Gateway', 'invoicing' ); |
@@ -46,15 +46,15 @@ discard block |
||
46 | 46 | } |
47 | 47 | |
48 | 48 | /** |
49 | - * Process Payment. |
|
50 | - * |
|
51 | - * |
|
52 | - * @param WPInv_Invoice $invoice Invoice. |
|
53 | - * @param array $submission_data Posted checkout fields. |
|
54 | - * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
55 | - * @return array |
|
56 | - */ |
|
57 | - public function process_payment( $invoice, $submission_data, $submission ) { |
|
49 | + * Process Payment. |
|
50 | + * |
|
51 | + * |
|
52 | + * @param WPInv_Invoice $invoice Invoice. |
|
53 | + * @param array $submission_data Posted checkout fields. |
|
54 | + * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
55 | + * @return array |
|
56 | + */ |
|
57 | + public function process_payment( $invoice, $submission_data, $submission ) { |
|
58 | 58 | |
59 | 59 | // Mark it as paid. |
60 | 60 | $invoice->mark_paid(); |
@@ -68,13 +68,13 @@ discard block |
||
68 | 68 | } |
69 | 69 | |
70 | 70 | /** |
71 | - * (Maybe) renews a manual subscription profile. |
|
72 | - * |
|
73 | - * |
|
74 | - * @param bool $should_expire |
|
71 | + * (Maybe) renews a manual subscription profile. |
|
72 | + * |
|
73 | + * |
|
74 | + * @param bool $should_expire |
|
75 | 75 | * @param WPInv_Subscription $subscription |
76 | - */ |
|
77 | - public function maybe_renew_subscription( $should_expire, $subscription ) { |
|
76 | + */ |
|
77 | + public function maybe_renew_subscription( $should_expire, $subscription ) { |
|
78 | 78 | |
79 | 79 | // Ensure its our subscription && it's active. |
80 | 80 | if ( 'manual' != $subscription->get_gateway() || ! $subscription->has_status( 'active trialling' ) ) { |
@@ -102,13 +102,13 @@ discard block |
||
102 | 102 | } |
103 | 103 | |
104 | 104 | /** |
105 | - * Processes invoice addons. |
|
106 | - * |
|
107 | - * @param WPInv_Invoice $invoice |
|
108 | - * @param GetPaid_Form_Item[] $items |
|
109 | - * @return WPInv_Invoice |
|
110 | - */ |
|
111 | - public function process_addons( $invoice, $items ) { |
|
105 | + * Processes invoice addons. |
|
106 | + * |
|
107 | + * @param WPInv_Invoice $invoice |
|
108 | + * @param GetPaid_Form_Item[] $items |
|
109 | + * @return WPInv_Invoice |
|
110 | + */ |
|
111 | + public function process_addons( $invoice, $items ) { |
|
112 | 112 | |
113 | 113 | foreach ( $items as $item ) { |
114 | 114 | $invoice->add_item( $item ); |
@@ -10,7 +10,7 @@ discard block |
||
10 | 10 | defined( 'ABSPATH' ) || exit; |
11 | 11 | |
12 | 12 | if ( empty( $fields ) ) { |
13 | - return; |
|
13 | + return; |
|
14 | 14 | } |
15 | 15 | |
16 | 16 | // A prefix for all ids (so that a form can be included in the same page multiple times). |
@@ -18,12 +18,12 @@ discard block |
||
18 | 18 | |
19 | 19 | // Prepare the user's country. |
20 | 20 | if ( ! empty( $form->invoice ) ) { |
21 | - $country = $form->invoice->get_country(); |
|
21 | + $country = $form->invoice->get_country(); |
|
22 | 22 | } |
23 | 23 | |
24 | 24 | if ( empty( $country ) ) { |
25 | - $country = empty( $country ) ? getpaid_get_ip_country() : $country; |
|
26 | - $country = empty( $country ) ? wpinv_get_default_country() : $country; |
|
25 | + $country = empty( $country ) ? getpaid_get_ip_country() : $country; |
|
26 | + $country = empty( $country ) ? wpinv_get_default_country() : $country; |
|
27 | 27 | } |
28 | 28 | |
29 | 29 | // A prefix for all ids (so that a form can be included in the same page multiple times). |
@@ -55,10 +55,10 @@ discard block |
||
55 | 55 | <!-- Start Billing Address --> |
56 | 56 | <div class="getpaid-billing-address-wrapper"> |
57 | 57 | <?php |
58 | - $field_type = 'billing'; |
|
59 | - include plugin_dir_path( __FILE__ ) . 'address-fields.php'; |
|
60 | - do_action( 'getpaid_after_payment_form_billing_fields', $form ); |
|
61 | - ?> |
|
58 | + $field_type = 'billing'; |
|
59 | + include plugin_dir_path( __FILE__ ) . 'address-fields.php'; |
|
60 | + do_action( 'getpaid_after_payment_form_billing_fields', $form ); |
|
61 | + ?> |
|
62 | 62 | </div> |
63 | 63 | <!-- End Billing Address --> |
64 | 64 | |
@@ -70,19 +70,19 @@ discard block |
||
70 | 70 | |
71 | 71 | <?php |
72 | 72 | |
73 | - echo aui()->input( |
|
74 | - array( |
|
75 | - 'type' => 'checkbox', |
|
76 | - 'name' => 'same-shipping-address', |
|
77 | - 'id' => "shipping-toggle$uniqid", |
|
78 | - 'required' => false, |
|
79 | - 'label' => wp_kses_post( $shipping_address_toggle ), |
|
80 | - 'value' => 1, |
|
81 | - 'checked' => true, |
|
82 | - ) |
|
83 | - ); |
|
73 | + echo aui()->input( |
|
74 | + array( |
|
75 | + 'type' => 'checkbox', |
|
76 | + 'name' => 'same-shipping-address', |
|
77 | + 'id' => "shipping-toggle$uniqid", |
|
78 | + 'required' => false, |
|
79 | + 'label' => wp_kses_post( $shipping_address_toggle ), |
|
80 | + 'value' => 1, |
|
81 | + 'checked' => true, |
|
82 | + ) |
|
83 | + ); |
|
84 | 84 | |
85 | - ?> |
|
85 | + ?> |
|
86 | 86 | |
87 | 87 | |
88 | 88 | <!-- Start Shipping Address Title --> |
@@ -101,10 +101,10 @@ discard block |
||
101 | 101 | <!-- Start Shipping Address --> |
102 | 102 | <div class="getpaid-shipping-address-wrapper"> |
103 | 103 | <?php |
104 | - $field_type = 'shipping'; |
|
105 | - include plugin_dir_path( __FILE__ ) . 'address-fields.php'; |
|
106 | - do_action( 'getpaid_after_payment_form_shipping_fields', $form ); |
|
107 | - ?> |
|
104 | + $field_type = 'shipping'; |
|
105 | + include plugin_dir_path( __FILE__ ) . 'address-fields.php'; |
|
106 | + do_action( 'getpaid_after_payment_form_shipping_fields', $form ); |
|
107 | + ?> |
|
108 | 108 | </div> |
109 | 109 | <!-- End Shipping Address --> |
110 | 110 |
@@ -13,264 +13,264 @@ |
||
13 | 13 | */ |
14 | 14 | class GetPaid_Geolocation { |
15 | 15 | |
16 | - /** |
|
17 | - * Holds the current user's IP Address. |
|
18 | - * |
|
19 | - * @var string |
|
20 | - */ |
|
21 | - public static $current_user_ip; |
|
22 | - |
|
23 | - /** |
|
24 | - * API endpoints for looking up a user IP address. |
|
25 | - * |
|
26 | - * For example, in case a user is on localhost. |
|
27 | - * |
|
28 | - * @var array |
|
29 | - */ |
|
30 | - protected static $ip_lookup_apis = array( |
|
31 | - 'ipify' => 'http://api.ipify.org/', |
|
32 | - 'ipecho' => 'http://ipecho.net/plain', |
|
33 | - 'ident' => 'http://ident.me', |
|
34 | - 'whatismyipaddress' => 'http://bot.whatismyipaddress.com', |
|
35 | - ); |
|
36 | - |
|
37 | - /** |
|
38 | - * API endpoints for geolocating an IP address |
|
39 | - * |
|
40 | - * @var array |
|
41 | - */ |
|
42 | - protected static $geoip_apis = array( |
|
43 | - 'ip-api.com' => 'http://ip-api.com/json/%s', |
|
44 | - 'ipinfo.io' => 'https://ipinfo.io/%s/json', |
|
45 | - ); |
|
46 | - |
|
47 | - /** |
|
48 | - * Get current user IP Address. |
|
49 | - * |
|
50 | - * @return string |
|
51 | - */ |
|
52 | - public static function get_ip_address() { |
|
53 | - return wpinv_get_ip(); |
|
54 | - } |
|
55 | - |
|
56 | - /** |
|
57 | - * Get user IP Address using an external service. |
|
58 | - * This can be used as a fallback for users on localhost where |
|
59 | - * get_ip_address() will be a local IP and non-geolocatable. |
|
60 | - * |
|
61 | - * @return string |
|
62 | - */ |
|
63 | - public static function get_external_ip_address() { |
|
64 | - |
|
65 | - $transient_name = 'external_ip_address_0.0.0.0'; |
|
66 | - |
|
67 | - if ( '' !== self::get_ip_address() ) { |
|
68 | - $transient_name = 'external_ip_address_' . self::get_ip_address(); |
|
69 | - } |
|
70 | - |
|
71 | - // Try retrieving from cache. |
|
72 | - $external_ip_address = get_transient( $transient_name ); |
|
73 | - |
|
74 | - if ( false === $external_ip_address ) { |
|
75 | - $external_ip_address = '0.0.0.0'; |
|
76 | - $ip_lookup_services = apply_filters( 'getpaid_geolocation_ip_lookup_apis', self::$ip_lookup_apis ); |
|
77 | - $ip_lookup_services_keys = array_keys( $ip_lookup_services ); |
|
78 | - shuffle( $ip_lookup_services_keys ); |
|
79 | - |
|
80 | - foreach ( $ip_lookup_services_keys as $service_name ) { |
|
81 | - $service_endpoint = $ip_lookup_services[ $service_name ]; |
|
82 | - $response = wp_safe_remote_get( $service_endpoint, array( 'timeout' => 2 ) ); |
|
83 | - |
|
84 | - if ( ! is_wp_error( $response ) && rest_is_ip_address( $response['body'] ) ) { |
|
85 | - $external_ip_address = apply_filters( 'getpaid_geolocation_ip_lookup_api_response', wpinv_clean( $response['body'] ), $service_name ); |
|
86 | - break; |
|
87 | - } |
|
88 | - |
|
89 | - } |
|
90 | - |
|
91 | - set_transient( $transient_name, $external_ip_address, WEEK_IN_SECONDS ); |
|
92 | - } |
|
93 | - |
|
94 | - return $external_ip_address; |
|
95 | - } |
|
96 | - |
|
97 | - /** |
|
98 | - * Geolocate an IP address. |
|
99 | - * |
|
100 | - * @param string $ip_address IP Address. |
|
101 | - * @param bool $fallback If true, fallbacks to alternative IP detection (can be slower). |
|
102 | - * @param bool $api_fallback If true, uses geolocation APIs if the database file doesn't exist (can be slower). |
|
103 | - * @return array |
|
104 | - */ |
|
105 | - public static function geolocate_ip( $ip_address = '', $fallback = false, $api_fallback = true ) { |
|
106 | - |
|
107 | - if ( empty( $ip_address ) ) { |
|
108 | - $ip_address = self::get_ip_address(); |
|
109 | - } |
|
110 | - |
|
111 | - // Update the current user's IP Address. |
|
112 | - self::$current_user_ip = $ip_address; |
|
113 | - |
|
114 | - // Filter to allow custom geolocation of the IP address. |
|
115 | - $country_code = apply_filters( 'getpaid_geolocate_ip', false, $ip_address, $fallback, $api_fallback ); |
|
116 | - |
|
117 | - if ( false !== $country_code ) { |
|
118 | - |
|
119 | - return array( |
|
120 | - 'country' => $country_code, |
|
121 | - 'state' => '', |
|
122 | - 'city' => '', |
|
123 | - 'postcode' => '', |
|
124 | - ); |
|
125 | - |
|
126 | - } |
|
127 | - |
|
128 | - $country_code = self::get_country_code_from_headers(); |
|
129 | - |
|
130 | - /** |
|
131 | - * Get geolocation filter. |
|
132 | - * |
|
133 | - * @since 1.0.19 |
|
134 | - * @param array $geolocation Geolocation data, including country, state, city, and postcode. |
|
135 | - * @param string $ip_address IP Address. |
|
136 | - */ |
|
137 | - $geolocation = apply_filters( |
|
138 | - 'getpaid_get_geolocation', |
|
139 | - array( |
|
140 | - 'country' => $country_code, |
|
141 | - 'state' => '', |
|
142 | - 'city' => '', |
|
143 | - 'postcode' => '', |
|
144 | - ), |
|
145 | - $ip_address |
|
146 | - ); |
|
147 | - |
|
148 | - // If we still haven't found a country code, let's consider doing an API lookup. |
|
149 | - if ( '' === $geolocation['country'] && $api_fallback ) { |
|
150 | - $geolocation['country'] = self::geolocate_via_api( $ip_address ); |
|
151 | - } |
|
152 | - |
|
153 | - // It's possible that we're in a local environment, in which case the geolocation needs to be done from the |
|
154 | - // external address. |
|
155 | - if ( '' === $geolocation['country'] && $fallback ) { |
|
156 | - $external_ip_address = self::get_external_ip_address(); |
|
157 | - |
|
158 | - // Only bother with this if the external IP differs. |
|
159 | - if ( '0.0.0.0' !== $external_ip_address && $external_ip_address !== $ip_address ) { |
|
160 | - return self::geolocate_ip( $external_ip_address, false, $api_fallback ); |
|
161 | - } |
|
162 | - |
|
163 | - } |
|
164 | - |
|
165 | - return array( |
|
166 | - 'country' => $geolocation['country'], |
|
167 | - 'state' => $geolocation['state'], |
|
168 | - 'city' => $geolocation['city'], |
|
169 | - 'postcode' => $geolocation['postcode'], |
|
170 | - ); |
|
171 | - |
|
172 | - } |
|
173 | - |
|
174 | - /** |
|
175 | - * Fetches the country code from the request headers, if one is available. |
|
176 | - * |
|
177 | - * @since 1.0.19 |
|
178 | - * @return string The country code pulled from the headers, or empty string if one was not found. |
|
179 | - */ |
|
180 | - protected static function get_country_code_from_headers() { |
|
181 | - $country_code = ''; |
|
182 | - |
|
183 | - $headers = array( |
|
184 | - 'MM_COUNTRY_CODE', |
|
185 | - 'GEOIP_COUNTRY_CODE', |
|
186 | - 'HTTP_CF_IPCOUNTRY', |
|
187 | - 'HTTP_X_COUNTRY_CODE', |
|
188 | - ); |
|
189 | - |
|
190 | - foreach ( $headers as $header ) { |
|
191 | - if ( empty( $_SERVER[ $header ] ) ) { |
|
192 | - continue; |
|
193 | - } |
|
194 | - |
|
195 | - $country_code = strtoupper( sanitize_text_field( wp_unslash( $_SERVER[ $header ] ) ) ); |
|
196 | - break; |
|
197 | - } |
|
198 | - |
|
199 | - return $country_code; |
|
200 | - } |
|
201 | - |
|
202 | - /** |
|
203 | - * Use APIs to Geolocate the user. |
|
204 | - * |
|
205 | - * Geolocation APIs can be added through the use of the getpaid_geolocation_geoip_apis filter. |
|
206 | - * Provide a name=>value pair for service-slug=>endpoint. |
|
207 | - * |
|
208 | - * If APIs are defined, one will be chosen at random to fulfil the request. After completing, the result |
|
209 | - * will be cached in a transient. |
|
210 | - * |
|
211 | - * @param string $ip_address IP address. |
|
212 | - * @return string |
|
213 | - */ |
|
214 | - protected static function geolocate_via_api( $ip_address ) { |
|
215 | - |
|
216 | - // Retrieve from cache... |
|
217 | - $country_code = get_transient( 'geoip_' . $ip_address ); |
|
218 | - |
|
219 | - // If missing, retrieve from the API. |
|
220 | - if ( false === $country_code ) { |
|
221 | - $geoip_services = apply_filters( 'getpaid_geolocation_geoip_apis', self::$geoip_apis ); |
|
222 | - |
|
223 | - if ( empty( $geoip_services ) ) { |
|
224 | - return ''; |
|
225 | - } |
|
226 | - |
|
227 | - $geoip_services_keys = array_keys( $geoip_services ); |
|
228 | - |
|
229 | - shuffle( $geoip_services_keys ); |
|
230 | - |
|
231 | - foreach ( $geoip_services_keys as $service_name ) { |
|
232 | - |
|
233 | - $service_endpoint = $geoip_services[ $service_name ]; |
|
234 | - $response = wp_safe_remote_get( sprintf( $service_endpoint, $ip_address ), array( 'timeout' => 2 ) ); |
|
235 | - $country_code = sanitize_text_field( strtoupper( self::handle_geolocation_response( $response, $service_name ) ) ); |
|
236 | - |
|
237 | - if ( ! empty( $country_code ) ) { |
|
238 | - break; |
|
239 | - } |
|
240 | - |
|
241 | - } |
|
242 | - |
|
243 | - set_transient( 'geoip_' . $ip_address, $country_code, WEEK_IN_SECONDS ); |
|
244 | - } |
|
245 | - |
|
246 | - return $country_code; |
|
247 | - } |
|
248 | - |
|
249 | - /** |
|
250 | - * Handles geolocation response |
|
251 | - * |
|
252 | - * @param WP_Error|String $geolocation_response |
|
253 | - * @param String $geolocation_service |
|
254 | - * @return string Country code |
|
255 | - */ |
|
256 | - protected static function handle_geolocation_response( $geolocation_response, $geolocation_service ) { |
|
257 | - |
|
258 | - if ( is_wp_error( $geolocation_response ) || empty( $geolocation_response['body'] ) ) { |
|
259 | - return ''; |
|
260 | - } |
|
261 | - |
|
262 | - if ( $geolocation_service === 'ipinfo.io' ) { |
|
263 | - $data = json_decode( $geolocation_response['body'] ); |
|
264 | - return empty( $data ) || empty( $data->country ) ? '' : $data->country; |
|
265 | - } |
|
266 | - |
|
267 | - if ( $geolocation_service === 'ip-api.com' ) { |
|
268 | - $data = json_decode( $geolocation_response['body'] ); |
|
269 | - return empty( $data ) || empty( $data->countryCode ) ? '' : $data->countryCode; |
|
270 | - } |
|
271 | - |
|
272 | - return apply_filters( 'getpaid_geolocation_geoip_response_' . $geolocation_service, '', $geolocation_response['body'] ); |
|
273 | - |
|
274 | - } |
|
16 | + /** |
|
17 | + * Holds the current user's IP Address. |
|
18 | + * |
|
19 | + * @var string |
|
20 | + */ |
|
21 | + public static $current_user_ip; |
|
22 | + |
|
23 | + /** |
|
24 | + * API endpoints for looking up a user IP address. |
|
25 | + * |
|
26 | + * For example, in case a user is on localhost. |
|
27 | + * |
|
28 | + * @var array |
|
29 | + */ |
|
30 | + protected static $ip_lookup_apis = array( |
|
31 | + 'ipify' => 'http://api.ipify.org/', |
|
32 | + 'ipecho' => 'http://ipecho.net/plain', |
|
33 | + 'ident' => 'http://ident.me', |
|
34 | + 'whatismyipaddress' => 'http://bot.whatismyipaddress.com', |
|
35 | + ); |
|
36 | + |
|
37 | + /** |
|
38 | + * API endpoints for geolocating an IP address |
|
39 | + * |
|
40 | + * @var array |
|
41 | + */ |
|
42 | + protected static $geoip_apis = array( |
|
43 | + 'ip-api.com' => 'http://ip-api.com/json/%s', |
|
44 | + 'ipinfo.io' => 'https://ipinfo.io/%s/json', |
|
45 | + ); |
|
46 | + |
|
47 | + /** |
|
48 | + * Get current user IP Address. |
|
49 | + * |
|
50 | + * @return string |
|
51 | + */ |
|
52 | + public static function get_ip_address() { |
|
53 | + return wpinv_get_ip(); |
|
54 | + } |
|
55 | + |
|
56 | + /** |
|
57 | + * Get user IP Address using an external service. |
|
58 | + * This can be used as a fallback for users on localhost where |
|
59 | + * get_ip_address() will be a local IP and non-geolocatable. |
|
60 | + * |
|
61 | + * @return string |
|
62 | + */ |
|
63 | + public static function get_external_ip_address() { |
|
64 | + |
|
65 | + $transient_name = 'external_ip_address_0.0.0.0'; |
|
66 | + |
|
67 | + if ( '' !== self::get_ip_address() ) { |
|
68 | + $transient_name = 'external_ip_address_' . self::get_ip_address(); |
|
69 | + } |
|
70 | + |
|
71 | + // Try retrieving from cache. |
|
72 | + $external_ip_address = get_transient( $transient_name ); |
|
73 | + |
|
74 | + if ( false === $external_ip_address ) { |
|
75 | + $external_ip_address = '0.0.0.0'; |
|
76 | + $ip_lookup_services = apply_filters( 'getpaid_geolocation_ip_lookup_apis', self::$ip_lookup_apis ); |
|
77 | + $ip_lookup_services_keys = array_keys( $ip_lookup_services ); |
|
78 | + shuffle( $ip_lookup_services_keys ); |
|
79 | + |
|
80 | + foreach ( $ip_lookup_services_keys as $service_name ) { |
|
81 | + $service_endpoint = $ip_lookup_services[ $service_name ]; |
|
82 | + $response = wp_safe_remote_get( $service_endpoint, array( 'timeout' => 2 ) ); |
|
83 | + |
|
84 | + if ( ! is_wp_error( $response ) && rest_is_ip_address( $response['body'] ) ) { |
|
85 | + $external_ip_address = apply_filters( 'getpaid_geolocation_ip_lookup_api_response', wpinv_clean( $response['body'] ), $service_name ); |
|
86 | + break; |
|
87 | + } |
|
88 | + |
|
89 | + } |
|
90 | + |
|
91 | + set_transient( $transient_name, $external_ip_address, WEEK_IN_SECONDS ); |
|
92 | + } |
|
93 | + |
|
94 | + return $external_ip_address; |
|
95 | + } |
|
96 | + |
|
97 | + /** |
|
98 | + * Geolocate an IP address. |
|
99 | + * |
|
100 | + * @param string $ip_address IP Address. |
|
101 | + * @param bool $fallback If true, fallbacks to alternative IP detection (can be slower). |
|
102 | + * @param bool $api_fallback If true, uses geolocation APIs if the database file doesn't exist (can be slower). |
|
103 | + * @return array |
|
104 | + */ |
|
105 | + public static function geolocate_ip( $ip_address = '', $fallback = false, $api_fallback = true ) { |
|
106 | + |
|
107 | + if ( empty( $ip_address ) ) { |
|
108 | + $ip_address = self::get_ip_address(); |
|
109 | + } |
|
110 | + |
|
111 | + // Update the current user's IP Address. |
|
112 | + self::$current_user_ip = $ip_address; |
|
113 | + |
|
114 | + // Filter to allow custom geolocation of the IP address. |
|
115 | + $country_code = apply_filters( 'getpaid_geolocate_ip', false, $ip_address, $fallback, $api_fallback ); |
|
116 | + |
|
117 | + if ( false !== $country_code ) { |
|
118 | + |
|
119 | + return array( |
|
120 | + 'country' => $country_code, |
|
121 | + 'state' => '', |
|
122 | + 'city' => '', |
|
123 | + 'postcode' => '', |
|
124 | + ); |
|
125 | + |
|
126 | + } |
|
127 | + |
|
128 | + $country_code = self::get_country_code_from_headers(); |
|
129 | + |
|
130 | + /** |
|
131 | + * Get geolocation filter. |
|
132 | + * |
|
133 | + * @since 1.0.19 |
|
134 | + * @param array $geolocation Geolocation data, including country, state, city, and postcode. |
|
135 | + * @param string $ip_address IP Address. |
|
136 | + */ |
|
137 | + $geolocation = apply_filters( |
|
138 | + 'getpaid_get_geolocation', |
|
139 | + array( |
|
140 | + 'country' => $country_code, |
|
141 | + 'state' => '', |
|
142 | + 'city' => '', |
|
143 | + 'postcode' => '', |
|
144 | + ), |
|
145 | + $ip_address |
|
146 | + ); |
|
147 | + |
|
148 | + // If we still haven't found a country code, let's consider doing an API lookup. |
|
149 | + if ( '' === $geolocation['country'] && $api_fallback ) { |
|
150 | + $geolocation['country'] = self::geolocate_via_api( $ip_address ); |
|
151 | + } |
|
152 | + |
|
153 | + // It's possible that we're in a local environment, in which case the geolocation needs to be done from the |
|
154 | + // external address. |
|
155 | + if ( '' === $geolocation['country'] && $fallback ) { |
|
156 | + $external_ip_address = self::get_external_ip_address(); |
|
157 | + |
|
158 | + // Only bother with this if the external IP differs. |
|
159 | + if ( '0.0.0.0' !== $external_ip_address && $external_ip_address !== $ip_address ) { |
|
160 | + return self::geolocate_ip( $external_ip_address, false, $api_fallback ); |
|
161 | + } |
|
162 | + |
|
163 | + } |
|
164 | + |
|
165 | + return array( |
|
166 | + 'country' => $geolocation['country'], |
|
167 | + 'state' => $geolocation['state'], |
|
168 | + 'city' => $geolocation['city'], |
|
169 | + 'postcode' => $geolocation['postcode'], |
|
170 | + ); |
|
171 | + |
|
172 | + } |
|
173 | + |
|
174 | + /** |
|
175 | + * Fetches the country code from the request headers, if one is available. |
|
176 | + * |
|
177 | + * @since 1.0.19 |
|
178 | + * @return string The country code pulled from the headers, or empty string if one was not found. |
|
179 | + */ |
|
180 | + protected static function get_country_code_from_headers() { |
|
181 | + $country_code = ''; |
|
182 | + |
|
183 | + $headers = array( |
|
184 | + 'MM_COUNTRY_CODE', |
|
185 | + 'GEOIP_COUNTRY_CODE', |
|
186 | + 'HTTP_CF_IPCOUNTRY', |
|
187 | + 'HTTP_X_COUNTRY_CODE', |
|
188 | + ); |
|
189 | + |
|
190 | + foreach ( $headers as $header ) { |
|
191 | + if ( empty( $_SERVER[ $header ] ) ) { |
|
192 | + continue; |
|
193 | + } |
|
194 | + |
|
195 | + $country_code = strtoupper( sanitize_text_field( wp_unslash( $_SERVER[ $header ] ) ) ); |
|
196 | + break; |
|
197 | + } |
|
198 | + |
|
199 | + return $country_code; |
|
200 | + } |
|
201 | + |
|
202 | + /** |
|
203 | + * Use APIs to Geolocate the user. |
|
204 | + * |
|
205 | + * Geolocation APIs can be added through the use of the getpaid_geolocation_geoip_apis filter. |
|
206 | + * Provide a name=>value pair for service-slug=>endpoint. |
|
207 | + * |
|
208 | + * If APIs are defined, one will be chosen at random to fulfil the request. After completing, the result |
|
209 | + * will be cached in a transient. |
|
210 | + * |
|
211 | + * @param string $ip_address IP address. |
|
212 | + * @return string |
|
213 | + */ |
|
214 | + protected static function geolocate_via_api( $ip_address ) { |
|
215 | + |
|
216 | + // Retrieve from cache... |
|
217 | + $country_code = get_transient( 'geoip_' . $ip_address ); |
|
218 | + |
|
219 | + // If missing, retrieve from the API. |
|
220 | + if ( false === $country_code ) { |
|
221 | + $geoip_services = apply_filters( 'getpaid_geolocation_geoip_apis', self::$geoip_apis ); |
|
222 | + |
|
223 | + if ( empty( $geoip_services ) ) { |
|
224 | + return ''; |
|
225 | + } |
|
226 | + |
|
227 | + $geoip_services_keys = array_keys( $geoip_services ); |
|
228 | + |
|
229 | + shuffle( $geoip_services_keys ); |
|
230 | + |
|
231 | + foreach ( $geoip_services_keys as $service_name ) { |
|
232 | + |
|
233 | + $service_endpoint = $geoip_services[ $service_name ]; |
|
234 | + $response = wp_safe_remote_get( sprintf( $service_endpoint, $ip_address ), array( 'timeout' => 2 ) ); |
|
235 | + $country_code = sanitize_text_field( strtoupper( self::handle_geolocation_response( $response, $service_name ) ) ); |
|
236 | + |
|
237 | + if ( ! empty( $country_code ) ) { |
|
238 | + break; |
|
239 | + } |
|
240 | + |
|
241 | + } |
|
242 | + |
|
243 | + set_transient( 'geoip_' . $ip_address, $country_code, WEEK_IN_SECONDS ); |
|
244 | + } |
|
245 | + |
|
246 | + return $country_code; |
|
247 | + } |
|
248 | + |
|
249 | + /** |
|
250 | + * Handles geolocation response |
|
251 | + * |
|
252 | + * @param WP_Error|String $geolocation_response |
|
253 | + * @param String $geolocation_service |
|
254 | + * @return string Country code |
|
255 | + */ |
|
256 | + protected static function handle_geolocation_response( $geolocation_response, $geolocation_service ) { |
|
257 | + |
|
258 | + if ( is_wp_error( $geolocation_response ) || empty( $geolocation_response['body'] ) ) { |
|
259 | + return ''; |
|
260 | + } |
|
261 | + |
|
262 | + if ( $geolocation_service === 'ipinfo.io' ) { |
|
263 | + $data = json_decode( $geolocation_response['body'] ); |
|
264 | + return empty( $data ) || empty( $data->country ) ? '' : $data->country; |
|
265 | + } |
|
266 | + |
|
267 | + if ( $geolocation_service === 'ip-api.com' ) { |
|
268 | + $data = json_decode( $geolocation_response['body'] ); |
|
269 | + return empty( $data ) || empty( $data->countryCode ) ? '' : $data->countryCode; |
|
270 | + } |
|
271 | + |
|
272 | + return apply_filters( 'getpaid_geolocation_geoip_response_' . $geolocation_service, '', $geolocation_response['body'] ); |
|
273 | + |
|
274 | + } |
|
275 | 275 | |
276 | 276 | } |
@@ -12,125 +12,125 @@ discard block |
||
12 | 12 | */ |
13 | 13 | class WPInv_Session_Handler extends WPInv_Session { |
14 | 14 | |
15 | - /** |
|
16 | - * Cookie name used for the session. |
|
17 | - * |
|
18 | - * @var string cookie name |
|
19 | - */ |
|
20 | - protected $_cookie; |
|
21 | - |
|
22 | - /** |
|
23 | - * Stores session expiry. |
|
24 | - * |
|
25 | - * @var int session due to expire timestamp |
|
26 | - */ |
|
27 | - protected $_session_expiring; |
|
28 | - |
|
29 | - /** |
|
30 | - * Stores session due to expire timestamp. |
|
31 | - * |
|
32 | - * @var string session expiration timestamp |
|
33 | - */ |
|
34 | - protected $_session_expiration; |
|
35 | - |
|
36 | - /** |
|
37 | - * True when the cookie exists. |
|
38 | - * |
|
39 | - * @var bool Based on whether a cookie exists. |
|
40 | - */ |
|
41 | - protected $_has_cookie = false; |
|
42 | - |
|
43 | - /** |
|
44 | - * Table name for session data. |
|
45 | - * |
|
46 | - * @var string Custom session table name |
|
47 | - */ |
|
48 | - protected $_table; |
|
49 | - |
|
50 | - /** |
|
51 | - * Constructor for the session class. |
|
52 | - */ |
|
53 | - public function __construct() { |
|
54 | - |
|
55 | - $this->_cookie = apply_filters( 'wpinv_cookie', 'wpinv_session_' . COOKIEHASH ); |
|
15 | + /** |
|
16 | + * Cookie name used for the session. |
|
17 | + * |
|
18 | + * @var string cookie name |
|
19 | + */ |
|
20 | + protected $_cookie; |
|
21 | + |
|
22 | + /** |
|
23 | + * Stores session expiry. |
|
24 | + * |
|
25 | + * @var int session due to expire timestamp |
|
26 | + */ |
|
27 | + protected $_session_expiring; |
|
28 | + |
|
29 | + /** |
|
30 | + * Stores session due to expire timestamp. |
|
31 | + * |
|
32 | + * @var string session expiration timestamp |
|
33 | + */ |
|
34 | + protected $_session_expiration; |
|
35 | + |
|
36 | + /** |
|
37 | + * True when the cookie exists. |
|
38 | + * |
|
39 | + * @var bool Based on whether a cookie exists. |
|
40 | + */ |
|
41 | + protected $_has_cookie = false; |
|
42 | + |
|
43 | + /** |
|
44 | + * Table name for session data. |
|
45 | + * |
|
46 | + * @var string Custom session table name |
|
47 | + */ |
|
48 | + protected $_table; |
|
49 | + |
|
50 | + /** |
|
51 | + * Constructor for the session class. |
|
52 | + */ |
|
53 | + public function __construct() { |
|
54 | + |
|
55 | + $this->_cookie = apply_filters( 'wpinv_cookie', 'wpinv_session_' . COOKIEHASH ); |
|
56 | 56 | add_action( 'init', array( $this, 'init' ), -1 ); |
57 | - add_action( 'wp_logout', array( $this, 'destroy_session' ) ); |
|
58 | - add_action( 'wp', array( $this, 'set_customer_session_cookie' ), 10 ); |
|
59 | - add_action( 'shutdown', array( $this, 'save_data' ), 20 ); |
|
60 | - |
|
61 | - } |
|
62 | - |
|
63 | - /** |
|
64 | - * Init hooks and session data. |
|
65 | - * |
|
66 | - * @since 3.3.0 |
|
67 | - */ |
|
68 | - public function init() { |
|
69 | - $this->init_session_cookie(); |
|
70 | - |
|
71 | - if ( ! is_user_logged_in() ) { |
|
72 | - add_filter( 'nonce_user_logged_out', array( $this, 'nonce_user_logged_out' ), 10, 2 ); |
|
73 | - } |
|
74 | - } |
|
75 | - |
|
76 | - /** |
|
77 | - * Setup cookie and customer ID. |
|
78 | - * |
|
79 | - * @since 3.6.0 |
|
80 | - */ |
|
81 | - public function init_session_cookie() { |
|
82 | - $cookie = $this->get_session_cookie(); |
|
83 | - |
|
84 | - if ( $cookie ) { |
|
85 | - $this->_customer_id = $cookie[0]; |
|
86 | - $this->_session_expiration = $cookie[1]; |
|
87 | - $this->_session_expiring = $cookie[2]; |
|
88 | - $this->_has_cookie = true; |
|
89 | - $this->_data = $this->get_session_data(); |
|
90 | - |
|
91 | - // If the user logs in, update session. |
|
92 | - if ( is_user_logged_in() && get_current_user_id() != $this->_customer_id ) { |
|
93 | - $this->_customer_id = get_current_user_id(); |
|
94 | - $this->_dirty = true; |
|
95 | - $this->save_data(); |
|
96 | - $this->set_customer_session_cookie( true ); |
|
97 | - } |
|
98 | - |
|
99 | - // Update session if its close to expiring. |
|
100 | - if ( time() > $this->_session_expiring ) { |
|
101 | - $this->set_session_expiration(); |
|
102 | - $this->update_session_timestamp( $this->_customer_id, $this->_session_expiration ); |
|
103 | - } |
|
104 | - } else { |
|
105 | - $this->set_session_expiration(); |
|
106 | - $this->_customer_id = $this->generate_customer_id(); |
|
107 | - $this->_data = $this->get_session_data(); |
|
108 | - } |
|
109 | - } |
|
110 | - |
|
111 | - /** |
|
112 | - * Sets the session cookie on-demand (usually after adding an item to the cart). |
|
113 | - * |
|
114 | - * Since the cookie name (as of 2.1) is prepended with wp, cache systems like batcache will not cache pages when set. |
|
115 | - * |
|
116 | - * Warning: Cookies will only be set if this is called before the headers are sent. |
|
117 | - * |
|
118 | - * @param bool $set Should the session cookie be set. |
|
119 | - */ |
|
120 | - public function set_customer_session_cookie( $set ) { |
|
121 | - if ( $set ) { |
|
122 | - $to_hash = $this->_customer_id . '|' . $this->_session_expiration; |
|
123 | - $cookie_hash = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) ); |
|
124 | - $cookie_value = $this->_customer_id . '||' . $this->_session_expiration . '||' . $this->_session_expiring . '||' . $cookie_hash; |
|
125 | - $this->_has_cookie = true; |
|
126 | - |
|
127 | - if ( ! isset( $_COOKIE[ $this->_cookie ] ) || $_COOKIE[ $this->_cookie ] !== $cookie_value ) { |
|
128 | - $this->setcookie( $this->_cookie, $cookie_value, $this->_session_expiration, $this->use_secure_cookie(), true ); |
|
129 | - } |
|
130 | - } |
|
131 | - } |
|
132 | - |
|
133 | - public function setcookie($name, $value, $expire = 0, $secure = false, $httponly = false){ |
|
57 | + add_action( 'wp_logout', array( $this, 'destroy_session' ) ); |
|
58 | + add_action( 'wp', array( $this, 'set_customer_session_cookie' ), 10 ); |
|
59 | + add_action( 'shutdown', array( $this, 'save_data' ), 20 ); |
|
60 | + |
|
61 | + } |
|
62 | + |
|
63 | + /** |
|
64 | + * Init hooks and session data. |
|
65 | + * |
|
66 | + * @since 3.3.0 |
|
67 | + */ |
|
68 | + public function init() { |
|
69 | + $this->init_session_cookie(); |
|
70 | + |
|
71 | + if ( ! is_user_logged_in() ) { |
|
72 | + add_filter( 'nonce_user_logged_out', array( $this, 'nonce_user_logged_out' ), 10, 2 ); |
|
73 | + } |
|
74 | + } |
|
75 | + |
|
76 | + /** |
|
77 | + * Setup cookie and customer ID. |
|
78 | + * |
|
79 | + * @since 3.6.0 |
|
80 | + */ |
|
81 | + public function init_session_cookie() { |
|
82 | + $cookie = $this->get_session_cookie(); |
|
83 | + |
|
84 | + if ( $cookie ) { |
|
85 | + $this->_customer_id = $cookie[0]; |
|
86 | + $this->_session_expiration = $cookie[1]; |
|
87 | + $this->_session_expiring = $cookie[2]; |
|
88 | + $this->_has_cookie = true; |
|
89 | + $this->_data = $this->get_session_data(); |
|
90 | + |
|
91 | + // If the user logs in, update session. |
|
92 | + if ( is_user_logged_in() && get_current_user_id() != $this->_customer_id ) { |
|
93 | + $this->_customer_id = get_current_user_id(); |
|
94 | + $this->_dirty = true; |
|
95 | + $this->save_data(); |
|
96 | + $this->set_customer_session_cookie( true ); |
|
97 | + } |
|
98 | + |
|
99 | + // Update session if its close to expiring. |
|
100 | + if ( time() > $this->_session_expiring ) { |
|
101 | + $this->set_session_expiration(); |
|
102 | + $this->update_session_timestamp( $this->_customer_id, $this->_session_expiration ); |
|
103 | + } |
|
104 | + } else { |
|
105 | + $this->set_session_expiration(); |
|
106 | + $this->_customer_id = $this->generate_customer_id(); |
|
107 | + $this->_data = $this->get_session_data(); |
|
108 | + } |
|
109 | + } |
|
110 | + |
|
111 | + /** |
|
112 | + * Sets the session cookie on-demand (usually after adding an item to the cart). |
|
113 | + * |
|
114 | + * Since the cookie name (as of 2.1) is prepended with wp, cache systems like batcache will not cache pages when set. |
|
115 | + * |
|
116 | + * Warning: Cookies will only be set if this is called before the headers are sent. |
|
117 | + * |
|
118 | + * @param bool $set Should the session cookie be set. |
|
119 | + */ |
|
120 | + public function set_customer_session_cookie( $set ) { |
|
121 | + if ( $set ) { |
|
122 | + $to_hash = $this->_customer_id . '|' . $this->_session_expiration; |
|
123 | + $cookie_hash = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) ); |
|
124 | + $cookie_value = $this->_customer_id . '||' . $this->_session_expiration . '||' . $this->_session_expiring . '||' . $cookie_hash; |
|
125 | + $this->_has_cookie = true; |
|
126 | + |
|
127 | + if ( ! isset( $_COOKIE[ $this->_cookie ] ) || $_COOKIE[ $this->_cookie ] !== $cookie_value ) { |
|
128 | + $this->setcookie( $this->_cookie, $cookie_value, $this->_session_expiration, $this->use_secure_cookie(), true ); |
|
129 | + } |
|
130 | + } |
|
131 | + } |
|
132 | + |
|
133 | + public function setcookie($name, $value, $expire = 0, $secure = false, $httponly = false){ |
|
134 | 134 | if ( ! headers_sent() ) { |
135 | 135 | setcookie( $name, $value, $expire, COOKIEPATH ? COOKIEPATH : '/', COOKIE_DOMAIN, $secure, apply_filters( 'wpinv_cookie_httponly', $httponly, $name, $value, $expire, $secure ) ); |
136 | 136 | } elseif ( defined( 'WP_DEBUG' ) && WP_DEBUG ) { |
@@ -139,86 +139,86 @@ discard block |
||
139 | 139 | } |
140 | 140 | } |
141 | 141 | |
142 | - /** |
|
143 | - * Should the session cookie be secure? |
|
144 | - * |
|
145 | - * @since 3.6.0 |
|
146 | - * @return bool |
|
147 | - */ |
|
148 | - protected function use_secure_cookie() { |
|
142 | + /** |
|
143 | + * Should the session cookie be secure? |
|
144 | + * |
|
145 | + * @since 3.6.0 |
|
146 | + * @return bool |
|
147 | + */ |
|
148 | + protected function use_secure_cookie() { |
|
149 | 149 | $is_https = false !== strstr( get_option( 'home' ), 'https:' ); |
150 | - return apply_filters( 'wpinv_session_use_secure_cookie', $is_https && is_ssl() ); |
|
151 | - } |
|
152 | - |
|
153 | - /** |
|
154 | - * Return true if the current user has an active session, i.e. a cookie to retrieve values. |
|
155 | - * |
|
156 | - * @return bool |
|
157 | - */ |
|
158 | - public function has_session() { |
|
159 | - return isset( $_COOKIE[ $this->_cookie ] ) || $this->_has_cookie || is_user_logged_in(); // @codingStandardsIgnoreLine. |
|
160 | - } |
|
161 | - |
|
162 | - /** |
|
163 | - * Set session expiration. |
|
164 | - */ |
|
165 | - public function set_session_expiration() { |
|
166 | - $this->_session_expiring = time() + intval( apply_filters( 'wpinv_session_expiring', 60 * 60 * 47 ) ); // 47 Hours. |
|
167 | - $this->_session_expiration = time() + intval( apply_filters( 'wpinv_session_expiration', 60 * 60 * 48 ) ); // 48 Hours. |
|
168 | - } |
|
169 | - |
|
170 | - /** |
|
171 | - * Generates session ids. |
|
172 | - * |
|
173 | - * @return string |
|
174 | - */ |
|
175 | - public function generate_customer_id() { |
|
176 | - require_once ABSPATH . 'wp-includes/class-phpass.php'; |
|
177 | - $hasher = new PasswordHash( 8, false ); |
|
178 | - return md5( $hasher->get_random_bytes( 32 ) ); |
|
179 | - } |
|
180 | - |
|
181 | - /** |
|
182 | - * Get the session cookie, if set. Otherwise return false. |
|
183 | - * |
|
184 | - * Session cookies without a customer ID are invalid. |
|
185 | - * |
|
186 | - * @return bool|array |
|
187 | - */ |
|
188 | - public function get_session_cookie() { |
|
189 | - $cookie_value = isset( $_COOKIE[ $this->_cookie ] ) ? wp_unslash( $_COOKIE[ $this->_cookie ] ) : false; // @codingStandardsIgnoreLine. |
|
190 | - |
|
191 | - if ( empty( $cookie_value ) || ! is_string( $cookie_value ) ) { |
|
192 | - return false; |
|
193 | - } |
|
194 | - |
|
195 | - list( $customer_id, $session_expiration, $session_expiring, $cookie_hash ) = explode( '||', $cookie_value ); |
|
196 | - |
|
197 | - if ( empty( $customer_id ) ) { |
|
198 | - return false; |
|
199 | - } |
|
200 | - |
|
201 | - // Validate hash. |
|
202 | - $to_hash = $customer_id . '|' . $session_expiration; |
|
203 | - $hash = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) ); |
|
204 | - |
|
205 | - if ( empty( $cookie_hash ) || ! hash_equals( $hash, $cookie_hash ) ) { |
|
206 | - return false; |
|
207 | - } |
|
208 | - |
|
209 | - return array( $customer_id, $session_expiration, $session_expiring, $cookie_hash ); |
|
210 | - } |
|
211 | - |
|
212 | - /** |
|
213 | - * Get session data. |
|
214 | - * |
|
215 | - * @return array |
|
216 | - */ |
|
217 | - public function get_session_data() { |
|
218 | - return $this->has_session() ? (array) $this->get_session( $this->_customer_id ) : array(); |
|
219 | - } |
|
220 | - |
|
221 | - public function generate_key($customer_id){ |
|
150 | + return apply_filters( 'wpinv_session_use_secure_cookie', $is_https && is_ssl() ); |
|
151 | + } |
|
152 | + |
|
153 | + /** |
|
154 | + * Return true if the current user has an active session, i.e. a cookie to retrieve values. |
|
155 | + * |
|
156 | + * @return bool |
|
157 | + */ |
|
158 | + public function has_session() { |
|
159 | + return isset( $_COOKIE[ $this->_cookie ] ) || $this->_has_cookie || is_user_logged_in(); // @codingStandardsIgnoreLine. |
|
160 | + } |
|
161 | + |
|
162 | + /** |
|
163 | + * Set session expiration. |
|
164 | + */ |
|
165 | + public function set_session_expiration() { |
|
166 | + $this->_session_expiring = time() + intval( apply_filters( 'wpinv_session_expiring', 60 * 60 * 47 ) ); // 47 Hours. |
|
167 | + $this->_session_expiration = time() + intval( apply_filters( 'wpinv_session_expiration', 60 * 60 * 48 ) ); // 48 Hours. |
|
168 | + } |
|
169 | + |
|
170 | + /** |
|
171 | + * Generates session ids. |
|
172 | + * |
|
173 | + * @return string |
|
174 | + */ |
|
175 | + public function generate_customer_id() { |
|
176 | + require_once ABSPATH . 'wp-includes/class-phpass.php'; |
|
177 | + $hasher = new PasswordHash( 8, false ); |
|
178 | + return md5( $hasher->get_random_bytes( 32 ) ); |
|
179 | + } |
|
180 | + |
|
181 | + /** |
|
182 | + * Get the session cookie, if set. Otherwise return false. |
|
183 | + * |
|
184 | + * Session cookies without a customer ID are invalid. |
|
185 | + * |
|
186 | + * @return bool|array |
|
187 | + */ |
|
188 | + public function get_session_cookie() { |
|
189 | + $cookie_value = isset( $_COOKIE[ $this->_cookie ] ) ? wp_unslash( $_COOKIE[ $this->_cookie ] ) : false; // @codingStandardsIgnoreLine. |
|
190 | + |
|
191 | + if ( empty( $cookie_value ) || ! is_string( $cookie_value ) ) { |
|
192 | + return false; |
|
193 | + } |
|
194 | + |
|
195 | + list( $customer_id, $session_expiration, $session_expiring, $cookie_hash ) = explode( '||', $cookie_value ); |
|
196 | + |
|
197 | + if ( empty( $customer_id ) ) { |
|
198 | + return false; |
|
199 | + } |
|
200 | + |
|
201 | + // Validate hash. |
|
202 | + $to_hash = $customer_id . '|' . $session_expiration; |
|
203 | + $hash = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) ); |
|
204 | + |
|
205 | + if ( empty( $cookie_hash ) || ! hash_equals( $hash, $cookie_hash ) ) { |
|
206 | + return false; |
|
207 | + } |
|
208 | + |
|
209 | + return array( $customer_id, $session_expiration, $session_expiring, $cookie_hash ); |
|
210 | + } |
|
211 | + |
|
212 | + /** |
|
213 | + * Get session data. |
|
214 | + * |
|
215 | + * @return array |
|
216 | + */ |
|
217 | + public function get_session_data() { |
|
218 | + return $this->has_session() ? (array) $this->get_session( $this->_customer_id ) : array(); |
|
219 | + } |
|
220 | + |
|
221 | + public function generate_key($customer_id){ |
|
222 | 222 | if(!$customer_id){ |
223 | 223 | return; |
224 | 224 | } |
@@ -226,68 +226,68 @@ discard block |
||
226 | 226 | return 'wpi_trans_'.$customer_id; |
227 | 227 | } |
228 | 228 | |
229 | - /** |
|
230 | - * Save data. |
|
231 | - */ |
|
232 | - public function save_data() { |
|
233 | - // Dirty if something changed - prevents saving nothing new. |
|
234 | - if ( $this->_dirty && $this->has_session() ) { |
|
229 | + /** |
|
230 | + * Save data. |
|
231 | + */ |
|
232 | + public function save_data() { |
|
233 | + // Dirty if something changed - prevents saving nothing new. |
|
234 | + if ( $this->_dirty && $this->has_session() ) { |
|
235 | 235 | |
236 | 236 | set_transient( $this->generate_key($this->_customer_id), $this->_data, $this->_session_expiration); |
237 | 237 | |
238 | - $this->_dirty = false; |
|
239 | - } |
|
240 | - } |
|
241 | - |
|
242 | - /** |
|
243 | - * Destroy all session data. |
|
244 | - */ |
|
245 | - public function destroy_session() { |
|
246 | - $this->delete_session( $this->_customer_id ); |
|
247 | - $this->forget_session(); |
|
248 | - } |
|
249 | - |
|
250 | - /** |
|
251 | - * Forget all session data without destroying it. |
|
252 | - */ |
|
253 | - public function forget_session() { |
|
254 | - $this->setcookie( $this->_cookie, '', time() - YEAR_IN_SECONDS, $this->use_secure_cookie(), true ); |
|
255 | - |
|
256 | - wpinv_empty_cart(); |
|
257 | - |
|
258 | - $this->_data = array(); |
|
259 | - $this->_dirty = false; |
|
260 | - $this->_customer_id = $this->generate_customer_id(); |
|
261 | - } |
|
262 | - |
|
263 | - /** |
|
264 | - * When a user is logged out, ensure they have a unique nonce by using the customer/session ID. |
|
265 | - * |
|
266 | - * @param int $uid User ID. |
|
267 | - * @return string |
|
268 | - */ |
|
269 | - public function nonce_user_logged_out( $uid ) { |
|
270 | - |
|
271 | - // Check if one of our nonces. |
|
272 | - if ( substr( $uid, 0, 5 ) === 'wpinv' || substr( $uid, 0, 7 ) === 'getpaid' ) { |
|
273 | - return $this->has_session() && $this->_customer_id ? $this->_customer_id : $uid; |
|
274 | - } |
|
275 | - |
|
276 | - return $uid; |
|
277 | - } |
|
278 | - |
|
279 | - /** |
|
280 | - * Returns the session. |
|
281 | - * |
|
282 | - * @param string $customer_id Customer ID. |
|
283 | - * @param mixed $default Default session value. |
|
284 | - * @return string|array |
|
285 | - */ |
|
286 | - public function get_session( $customer_id, $default = false ) { |
|
287 | - |
|
288 | - if ( defined( 'WP_SETUP_CONFIG' ) ) { |
|
289 | - return array(); |
|
290 | - } |
|
238 | + $this->_dirty = false; |
|
239 | + } |
|
240 | + } |
|
241 | + |
|
242 | + /** |
|
243 | + * Destroy all session data. |
|
244 | + */ |
|
245 | + public function destroy_session() { |
|
246 | + $this->delete_session( $this->_customer_id ); |
|
247 | + $this->forget_session(); |
|
248 | + } |
|
249 | + |
|
250 | + /** |
|
251 | + * Forget all session data without destroying it. |
|
252 | + */ |
|
253 | + public function forget_session() { |
|
254 | + $this->setcookie( $this->_cookie, '', time() - YEAR_IN_SECONDS, $this->use_secure_cookie(), true ); |
|
255 | + |
|
256 | + wpinv_empty_cart(); |
|
257 | + |
|
258 | + $this->_data = array(); |
|
259 | + $this->_dirty = false; |
|
260 | + $this->_customer_id = $this->generate_customer_id(); |
|
261 | + } |
|
262 | + |
|
263 | + /** |
|
264 | + * When a user is logged out, ensure they have a unique nonce by using the customer/session ID. |
|
265 | + * |
|
266 | + * @param int $uid User ID. |
|
267 | + * @return string |
|
268 | + */ |
|
269 | + public function nonce_user_logged_out( $uid ) { |
|
270 | + |
|
271 | + // Check if one of our nonces. |
|
272 | + if ( substr( $uid, 0, 5 ) === 'wpinv' || substr( $uid, 0, 7 ) === 'getpaid' ) { |
|
273 | + return $this->has_session() && $this->_customer_id ? $this->_customer_id : $uid; |
|
274 | + } |
|
275 | + |
|
276 | + return $uid; |
|
277 | + } |
|
278 | + |
|
279 | + /** |
|
280 | + * Returns the session. |
|
281 | + * |
|
282 | + * @param string $customer_id Customer ID. |
|
283 | + * @param mixed $default Default session value. |
|
284 | + * @return string|array |
|
285 | + */ |
|
286 | + public function get_session( $customer_id, $default = false ) { |
|
287 | + |
|
288 | + if ( defined( 'WP_SETUP_CONFIG' ) ) { |
|
289 | + return array(); |
|
290 | + } |
|
291 | 291 | |
292 | 292 | $key = $this->generate_key($customer_id); |
293 | 293 | $value = get_transient($key); |
@@ -296,30 +296,30 @@ discard block |
||
296 | 296 | $value = $default; |
297 | 297 | } |
298 | 298 | |
299 | - return maybe_unserialize( $value ); |
|
300 | - } |
|
299 | + return maybe_unserialize( $value ); |
|
300 | + } |
|
301 | 301 | |
302 | - /** |
|
303 | - * Delete the session from the cache and database. |
|
304 | - * |
|
305 | - * @param int $customer_id Customer ID. |
|
306 | - */ |
|
307 | - public function delete_session( $customer_id ) { |
|
302 | + /** |
|
303 | + * Delete the session from the cache and database. |
|
304 | + * |
|
305 | + * @param int $customer_id Customer ID. |
|
306 | + */ |
|
307 | + public function delete_session( $customer_id ) { |
|
308 | 308 | |
309 | 309 | $key = $this->generate_key($customer_id); |
310 | 310 | |
311 | - delete_transient($key); |
|
312 | - } |
|
311 | + delete_transient($key); |
|
312 | + } |
|
313 | 313 | |
314 | - /** |
|
315 | - * Update the session expiry timestamp. |
|
316 | - * |
|
317 | - * @param string $customer_id Customer ID. |
|
318 | - * @param int $timestamp Timestamp to expire the cookie. |
|
319 | - */ |
|
320 | - public function update_session_timestamp( $customer_id, $timestamp ) { |
|
314 | + /** |
|
315 | + * Update the session expiry timestamp. |
|
316 | + * |
|
317 | + * @param string $customer_id Customer ID. |
|
318 | + * @param int $timestamp Timestamp to expire the cookie. |
|
319 | + */ |
|
320 | + public function update_session_timestamp( $customer_id, $timestamp ) { |
|
321 | 321 | |
322 | 322 | set_transient( $this->generate_key($customer_id), maybe_serialize( $this->_data ), $timestamp); |
323 | 323 | |
324 | - } |
|
324 | + } |
|
325 | 325 | } |