1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* Give DB Meta |
4
|
|
|
* |
5
|
|
|
* @package Give |
6
|
|
|
* @subpackage Classes/Give_DB_Meta |
7
|
|
|
* @copyright Copyright (c) 2017, WordImpress |
8
|
|
|
* @license https://opensource.org/licenses/gpl-license GNU Public License |
9
|
|
|
* @since 2.0 |
10
|
|
|
*/ |
11
|
|
|
|
12
|
|
|
// Exit if accessed directly. |
13
|
|
|
if ( ! defined( 'ABSPATH' ) ) { |
14
|
|
|
exit; |
15
|
|
|
} |
16
|
|
|
|
17
|
|
|
class Give_DB_Meta extends Give_DB { |
18
|
|
|
/** |
19
|
|
|
* Post type |
20
|
|
|
* |
21
|
|
|
* @since 2.0 |
22
|
|
|
* @access protected |
23
|
|
|
* @var bool |
24
|
|
|
*/ |
25
|
|
|
protected $post_type = ''; |
26
|
|
|
|
27
|
|
|
/** |
28
|
|
|
* Meta type |
29
|
|
|
* |
30
|
|
|
* @since 2.0 |
31
|
|
|
* @access protected |
32
|
|
|
* @var bool |
33
|
|
|
*/ |
34
|
|
|
protected $meta_type = ''; |
35
|
|
|
|
36
|
|
|
/** |
37
|
|
|
* Flag to handle result type |
38
|
|
|
* |
39
|
|
|
* @since 2.0 |
40
|
|
|
* @access protected |
41
|
|
|
*/ |
42
|
|
|
protected $raw_result = false; |
43
|
|
|
|
44
|
|
|
/** |
45
|
|
|
* Flag for short circuit of meta function |
46
|
|
|
* |
47
|
|
|
* @since 2.0 |
48
|
|
|
* @access protected |
49
|
|
|
*/ |
50
|
|
|
protected $check = false; |
51
|
|
|
|
52
|
|
|
|
53
|
|
|
/** |
54
|
|
|
* Meta supports. |
55
|
|
|
* |
56
|
|
|
* @since 2.0 |
57
|
|
|
* @access protected |
58
|
|
|
* @var array |
59
|
|
|
*/ |
60
|
|
|
protected $supports = array( |
61
|
|
|
'add_post_metadata', |
62
|
|
|
'get_post_metadata', |
63
|
|
|
'update_post_metadata', |
64
|
|
|
'delete_post_metadata', |
65
|
|
|
'posts_where', |
66
|
|
|
'posts_join', |
67
|
|
|
'posts_groupby', |
68
|
|
|
'posts_orderby' |
|
|
|
|
69
|
|
|
); |
70
|
|
|
|
71
|
|
|
/** |
72
|
|
|
* Give_DB_Meta constructor. |
73
|
|
|
* |
74
|
|
|
* @since 2.0 |
75
|
|
|
*/ |
76
|
|
|
function __construct() { |
|
|
|
|
77
|
|
|
// Bailout. |
78
|
|
|
if ( empty( $this->supports ) || ! $this->is_custom_meta_table_active() ) { |
79
|
|
|
return; |
80
|
|
|
} |
81
|
|
|
|
82
|
|
|
if ( in_array( 'add_post_metadata', $this->supports ) ) { |
83
|
|
|
add_filter( 'add_post_metadata', array( $this, '__add_meta' ), 0, 5 ); |
84
|
|
|
} |
85
|
|
|
|
86
|
|
|
if ( in_array( 'get_post_metadata', $this->supports ) ) { |
87
|
|
|
add_filter( 'get_post_metadata', array( $this, '__get_meta' ), 0, 4 ); |
88
|
|
|
} |
89
|
|
|
|
90
|
|
|
if ( in_array( 'update_post_metadata', $this->supports ) ) { |
91
|
|
|
add_filter( 'update_post_metadata', array( $this, '__update_meta' ), 0, 5 ); |
92
|
|
|
} |
93
|
|
|
|
94
|
|
|
if ( in_array( 'delete_post_metadata', $this->supports ) ) { |
95
|
|
|
add_filter( 'delete_post_metadata', array( $this, '__delete_meta' ), 0, 5 ); |
96
|
|
|
} |
97
|
|
|
|
98
|
|
View Code Duplication |
if ( in_array( 'posts_where', $this->supports ) ) { |
|
|
|
|
99
|
|
|
add_filter( 'posts_where', array( $this, '__rename_meta_table_name_in_query' ), 99999, 2 ); |
100
|
|
|
} |
101
|
|
|
|
102
|
|
View Code Duplication |
if ( in_array( 'posts_join', $this->supports ) ) { |
|
|
|
|
103
|
|
|
add_filter( 'posts_join', array( $this, '__rename_meta_table_name_in_query' ), 99999, 2 ); |
104
|
|
|
} |
105
|
|
|
|
106
|
|
View Code Duplication |
if ( in_array( 'posts_groupby', $this->supports ) ) { |
|
|
|
|
107
|
|
|
add_filter( 'posts_groupby', array( $this, '__rename_meta_table_name_in_query' ), 99999, 2 ); |
108
|
|
|
} |
109
|
|
|
|
110
|
|
View Code Duplication |
if ( in_array( 'posts_orderby', $this->supports ) ) { |
|
|
|
|
111
|
|
|
add_filter( 'posts_orderby', array( $this, '__rename_meta_table_name_in_query' ), 99999, 2 ); |
112
|
|
|
} |
113
|
|
|
} |
114
|
|
|
|
115
|
|
|
|
116
|
|
|
/** |
117
|
|
|
* Retrieve payment meta field for a payment. |
118
|
|
|
* |
119
|
|
|
* @access public |
120
|
|
|
* @since 2.0 |
121
|
|
|
* |
122
|
|
|
* @param int $id Pst Type ID. |
123
|
|
|
* @param string $meta_key The meta key to retrieve. |
124
|
|
|
* @param bool $single Whether to return a single value. |
125
|
|
|
* |
126
|
|
|
* @return mixed Will be an array if $single is false. Will be value of meta data field if $single |
127
|
|
|
* is true. |
128
|
|
|
*/ |
129
|
|
|
public function get_meta( $id = 0, $meta_key = '', $single = false ) { |
130
|
|
|
$id = $this->sanitize_id( $id ); |
131
|
|
|
|
132
|
|
|
// Bailout. |
133
|
|
|
if ( ! $this->is_valid_post_type( $id ) ) { |
134
|
|
|
return $this->check; |
135
|
|
|
} |
136
|
|
|
|
137
|
|
|
if ( $this->raw_result ) { |
138
|
|
|
if ( ! ( $value = get_metadata( $this->meta_type, $id, $meta_key, false ) ) ) { |
139
|
|
|
$value = ''; |
140
|
|
|
} |
141
|
|
|
|
142
|
|
|
// Reset flag. |
143
|
|
|
$this->raw_result = false; |
144
|
|
|
|
145
|
|
|
} else { |
146
|
|
|
$value = get_metadata( $this->meta_type, $id, $meta_key, $single ); |
147
|
|
|
} |
148
|
|
|
|
149
|
|
|
return $value; |
150
|
|
|
} |
151
|
|
|
|
152
|
|
|
|
153
|
|
|
/** |
154
|
|
|
* Add meta data field to a payment. |
155
|
|
|
* |
156
|
|
|
* For internal use only. Use Give_Payment->add_meta() for public usage. |
157
|
|
|
* |
158
|
|
|
* @access private |
159
|
|
|
* @since 2.0 |
160
|
|
|
* |
161
|
|
|
* @param int $id Post Type ID. |
162
|
|
|
* @param string $meta_key Metadata name. |
163
|
|
|
* @param mixed $meta_value Metadata value. |
164
|
|
|
* @param bool $unique Optional, default is false. Whether the same key should not be added. |
165
|
|
|
* |
166
|
|
|
* @return int|bool False for failure. True for success. |
167
|
|
|
*/ |
168
|
|
View Code Duplication |
public function add_meta( $id = 0, $meta_key = '', $meta_value, $unique = false ) { |
|
|
|
|
169
|
|
|
$id = $this->sanitize_id( $id ); |
170
|
|
|
|
171
|
|
|
// Bailout. |
172
|
|
|
if ( ! $this->is_valid_post_type( $id ) ) { |
173
|
|
|
return $this->check; |
174
|
|
|
} |
175
|
|
|
|
176
|
|
|
$meta_id = add_metadata( $this->meta_type, $id, $meta_key, $meta_value, $unique ); |
177
|
|
|
|
178
|
|
|
if ( $meta_id ) { |
179
|
|
|
$this->delete_cache( $id ); |
|
|
|
|
180
|
|
|
} |
181
|
|
|
|
182
|
|
|
return $meta_id; |
183
|
|
|
} |
184
|
|
|
|
185
|
|
|
/** |
186
|
|
|
* Update payment meta field based on Post Type ID. |
187
|
|
|
* |
188
|
|
|
* For internal use only. Use Give_Payment->update_meta() for public usage. |
189
|
|
|
* |
190
|
|
|
* Use the $prev_value parameter to differentiate between meta fields with the |
191
|
|
|
* same key and Post Type ID. |
192
|
|
|
* |
193
|
|
|
* If the meta field for the payment does not exist, it will be added. |
194
|
|
|
* |
195
|
|
|
* @access public |
196
|
|
|
* @since 2.0 |
197
|
|
|
* |
198
|
|
|
* @param int $id Post Type ID. |
199
|
|
|
* @param string $meta_key Metadata key. |
200
|
|
|
* @param mixed $meta_value Metadata value. |
201
|
|
|
* @param mixed $prev_value Optional. Previous value to check before removing. |
202
|
|
|
* |
203
|
|
|
* @return int|bool False on failure, true if success. |
204
|
|
|
*/ |
205
|
|
View Code Duplication |
public function update_meta( $id = 0, $meta_key = '', $meta_value, $prev_value = '' ) { |
|
|
|
|
206
|
|
|
$id = $this->sanitize_id( $id ); |
207
|
|
|
|
208
|
|
|
// Bailout. |
209
|
|
|
if ( ! $this->is_valid_post_type( $id ) ) { |
210
|
|
|
return $this->check; |
211
|
|
|
} |
212
|
|
|
|
213
|
|
|
$meta_id = update_metadata( $this->meta_type, $id, $meta_key, $meta_value, $prev_value ); |
214
|
|
|
|
215
|
|
|
if ( $meta_id ) { |
216
|
|
|
$this->delete_cache( $id ); |
|
|
|
|
217
|
|
|
} |
218
|
|
|
|
219
|
|
|
return $meta_id; |
220
|
|
|
} |
221
|
|
|
|
222
|
|
|
/** |
223
|
|
|
* Remove metadata matching criteria from a payment. |
224
|
|
|
* |
225
|
|
|
* You can match based on the key, or key and value. Removing based on key and |
226
|
|
|
* value, will keep from removing duplicate metadata with the same key. It also |
227
|
|
|
* allows removing all metadata matching key, if needed. |
228
|
|
|
* |
229
|
|
|
* @access public |
230
|
|
|
* @since 2.0 |
231
|
|
|
* |
232
|
|
|
* @param int $id Post Type ID. |
233
|
|
|
* @param string $meta_key Metadata name. |
234
|
|
|
* @param mixed $meta_value Optional. Metadata value. |
235
|
|
|
* @param mixed $delete_all Optional. |
236
|
|
|
* |
237
|
|
|
* @return bool False for failure. True for success. |
238
|
|
|
*/ |
239
|
|
View Code Duplication |
public function delete_meta( $id = 0, $meta_key = '', $meta_value = '', $delete_all = '' ) { |
|
|
|
|
240
|
|
|
$id = $this->sanitize_id( $id ); |
241
|
|
|
|
242
|
|
|
// Bailout. |
243
|
|
|
if ( ! $this->is_valid_post_type( $id ) ) { |
244
|
|
|
return $this->check; |
245
|
|
|
} |
246
|
|
|
|
247
|
|
|
$is_meta_deleted = delete_metadata( $this->meta_type, $id, $meta_key, $meta_value, $delete_all ); |
248
|
|
|
|
249
|
|
|
if ( $is_meta_deleted ) { |
250
|
|
|
$this->delete_cache( $id ); |
|
|
|
|
251
|
|
|
} |
252
|
|
|
|
253
|
|
|
return $is_meta_deleted; |
254
|
|
|
} |
255
|
|
|
|
256
|
|
|
/** |
257
|
|
|
* Rename query clauses of every query for new meta table |
258
|
|
|
* |
259
|
|
|
* @since 2.0 |
260
|
|
|
* @access public |
261
|
|
|
* |
262
|
|
|
* @param string $clause |
263
|
|
|
* @param WP_Query $wp_query |
264
|
|
|
* |
265
|
|
|
* @return string |
266
|
|
|
*/ |
267
|
|
|
public function __rename_meta_table_name_in_query( $clause, $wp_query ) { |
|
|
|
|
268
|
|
|
global $wpdb; |
269
|
|
|
|
270
|
|
|
// Add new table to sql query. |
271
|
|
|
if ( $this->is_post_type_query( $wp_query ) && ! empty( $wp_query->meta_query->queries ) ) { |
272
|
|
|
$clause = str_replace( "{$wpdb->postmeta}.post_id", "{$this->table_name}.{$this->meta_type}_id", $clause ); |
273
|
|
|
$clause = str_replace( $wpdb->postmeta, $this->table_name, $clause ); |
274
|
|
|
|
275
|
|
|
switch( current_filter() ) { |
|
|
|
|
276
|
|
|
case 'posts_join': |
277
|
|
|
$joins = array( 'INNER JOIN', 'LEFT JOIN' ); |
278
|
|
|
|
279
|
|
|
foreach ( $joins as $join ) { |
280
|
|
|
if( false !== strpos( $clause, $join ) ) { |
|
|
|
|
281
|
|
|
$clause = explode( $join, $clause ); |
282
|
|
|
|
283
|
|
|
foreach ( $clause as $key => $clause_part ) { |
284
|
|
|
if( empty( $clause_part ) ) { |
|
|
|
|
285
|
|
|
continue; |
286
|
|
|
} |
287
|
|
|
|
288
|
|
|
preg_match( '/wp_give_paymentmeta AS (.*) ON/', $clause_part, $alias_table_name ); |
289
|
|
|
|
290
|
|
|
if( isset( $alias_table_name[1] ) ) { |
|
|
|
|
291
|
|
|
$clause[$key] = str_replace( "{$alias_table_name[1]}.post_id", "{$alias_table_name[1]}.{$this->meta_type}_id", $clause_part ); |
|
|
|
|
292
|
|
|
} |
293
|
|
|
} |
294
|
|
|
|
295
|
|
|
$clause = implode( "{$join} ", $clause ); |
296
|
|
|
} |
297
|
|
|
} |
298
|
|
|
break; |
299
|
|
|
|
300
|
|
|
case 'posts_where': |
301
|
|
|
$clause = str_replace( array( 'mt2.post_id', 'mt1.post_id' ), array( "mt2.{$this->meta_type}_id", "mt1.{$this->meta_type}_id" ), $clause ); |
302
|
|
|
break; |
303
|
|
|
} |
304
|
|
|
} |
305
|
|
|
|
306
|
|
|
return $clause; |
307
|
|
|
} |
308
|
|
|
|
309
|
|
|
|
310
|
|
|
/** |
311
|
|
|
* Check if current query for post type or not. |
312
|
|
|
* |
313
|
|
|
* @since 2.0 |
314
|
|
|
* @access protected |
315
|
|
|
* |
316
|
|
|
* @param WP_Query $wp_query |
317
|
|
|
* |
318
|
|
|
* @return bool |
319
|
|
|
*/ |
320
|
|
|
protected function is_post_type_query( $wp_query ) { |
321
|
|
|
$status = false; |
322
|
|
|
|
323
|
|
|
// Check if it is payment query. |
324
|
|
|
if ( ! empty( $wp_query->query['post_type'] ) ) { |
325
|
|
|
if ( |
326
|
|
|
is_string( $wp_query->query['post_type'] ) && |
327
|
|
|
$this->post_type === $wp_query->query['post_type'] |
328
|
|
|
) { |
329
|
|
|
$status = true; |
330
|
|
|
} elseif ( |
331
|
|
|
is_array( $wp_query->query['post_type'] ) && |
332
|
|
|
in_array( $this->post_type, $wp_query->query['post_type'] ) |
333
|
|
|
) { |
334
|
|
|
$status = true; |
335
|
|
|
} |
336
|
|
|
} |
337
|
|
|
|
338
|
|
|
return $status; |
339
|
|
|
} |
340
|
|
|
|
341
|
|
|
/** |
342
|
|
|
* Check if current id of post type or not |
343
|
|
|
* |
344
|
|
|
* @since 2.0 |
345
|
|
|
* @access protected |
346
|
|
|
* |
347
|
|
|
* @param $ID |
348
|
|
|
* |
349
|
|
|
* @return bool |
350
|
|
|
*/ |
351
|
|
|
protected function is_valid_post_type( $ID ) { |
352
|
|
|
return $ID && ( $this->post_type === get_post_type( $ID ) ); |
353
|
|
|
} |
354
|
|
|
|
355
|
|
|
/** |
356
|
|
|
* check if custom meta table enabled or not. |
357
|
|
|
* |
358
|
|
|
* @since 2.0 |
359
|
|
|
* @access protected |
360
|
|
|
* @return bool |
361
|
|
|
*/ |
362
|
|
|
protected function is_custom_meta_table_active() { |
363
|
|
|
return false; |
364
|
|
|
} |
365
|
|
|
|
366
|
|
|
|
367
|
|
|
/** |
368
|
|
|
* Update last_changed key |
369
|
|
|
* |
370
|
|
|
* @since 2.0 |
371
|
|
|
* @access private |
372
|
|
|
* |
373
|
|
|
* @param int $id |
374
|
|
|
* @param string $meta_type |
375
|
|
|
* |
376
|
|
|
* @return void |
377
|
|
|
*/ |
378
|
|
|
private function delete_cache( $id, $meta_type = '' ) { |
379
|
|
|
$meta_type = empty( $meta_type ) ? $this->meta_type : $meta_type; |
380
|
|
|
|
381
|
|
|
$group = array( |
382
|
|
|
// 'form' => 'give-forms', |
383
|
|
|
'payment' => 'give-donations', |
384
|
|
|
'donor' => 'give-donors', |
385
|
|
|
'customer' => 'give-donors', // Backward compatibility for pre upgrade in 2.0 |
386
|
|
|
// 'log' => 'give-logs', |
387
|
|
|
); |
388
|
|
|
|
389
|
|
|
if ( array_key_exists( $meta_type, $group ) ) { |
390
|
|
|
Give_Cache::delete_group( $id, $group[ $meta_type ] ); |
391
|
|
|
} |
392
|
|
|
} |
393
|
|
|
|
394
|
|
|
/** |
395
|
|
|
* Add support for hidden functions. |
396
|
|
|
* |
397
|
|
|
* @since 2.0 |
398
|
|
|
* @access public |
399
|
|
|
* |
400
|
|
|
* @param $name |
401
|
|
|
* @param $arguments |
402
|
|
|
* |
403
|
|
|
* @return mixed |
404
|
|
|
*/ |
405
|
|
|
public function __call( $name, $arguments ) { |
406
|
|
|
switch ( $name ) { |
407
|
|
View Code Duplication |
case '__add_meta': |
|
|
|
|
408
|
|
|
$this->check = $arguments[0]; |
409
|
|
|
$id = $arguments[1]; |
410
|
|
|
$meta_key = $arguments[2]; |
411
|
|
|
$meta_value = $arguments[3]; |
412
|
|
|
$unique = $arguments[4]; |
413
|
|
|
|
414
|
|
|
// Bailout. |
415
|
|
|
if ( ! $this->is_valid_post_type( $id ) ) { |
416
|
|
|
return $this->check; |
417
|
|
|
} |
418
|
|
|
|
419
|
|
|
return $this->add_meta( $id, $meta_key, $meta_value, $unique ); |
420
|
|
|
|
421
|
|
|
case '__get_meta': |
422
|
|
|
$this->check = $arguments[0]; |
423
|
|
|
$id = $arguments[1]; |
424
|
|
|
$meta_key = $arguments[2]; |
425
|
|
|
$single = $arguments[3]; |
426
|
|
|
|
427
|
|
|
// Bailout. |
428
|
|
|
if ( ! $this->is_valid_post_type( $id ) ) { |
429
|
|
|
return $this->check; |
430
|
|
|
} |
431
|
|
|
|
432
|
|
|
$this->raw_result = true; |
433
|
|
|
|
434
|
|
|
return $this->get_meta( $id, $meta_key, $single ); |
435
|
|
|
|
436
|
|
|
case '__update_meta': |
437
|
|
|
$this->check = $arguments[0]; |
438
|
|
|
$id = $arguments[1]; |
439
|
|
|
$meta_key = $arguments[2]; |
440
|
|
|
$meta_value = $arguments[3]; |
441
|
|
|
|
442
|
|
|
// Bailout. |
443
|
|
|
if ( ! $this->is_valid_post_type( $id ) ) { |
444
|
|
|
return $this->check; |
445
|
|
|
} |
446
|
|
|
|
447
|
|
|
return $this->update_meta( $id, $meta_key, $meta_value ); |
448
|
|
|
|
449
|
|
View Code Duplication |
case '__delete_meta': |
|
|
|
|
450
|
|
|
$this->check = $arguments[0]; |
451
|
|
|
$id = $arguments[1]; |
452
|
|
|
$meta_key = $arguments[2]; |
453
|
|
|
$meta_value = $arguments[3]; |
454
|
|
|
$delete_all = $arguments[3]; |
455
|
|
|
|
456
|
|
|
// Bailout. |
457
|
|
|
if ( ! $this->is_valid_post_type( $id ) ) { |
458
|
|
|
return $this->check; |
459
|
|
|
} |
460
|
|
|
|
461
|
|
|
return $this->delete_meta( $id, $meta_key, $meta_value, $delete_all ); |
462
|
|
|
} |
463
|
|
|
} |
464
|
|
|
} |