-
Notifications
You must be signed in to change notification settings - Fork 22
/
query.php
531 lines (451 loc) · 17.9 KB
/
query.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
<?php
/**
* This file contains the DustPress Query class.
*/
namespace DustPress;
use WP_Query;
/**
* Class Query
*
* This class gives an api for simplified post queries for getting meta
* data and ACF fields with a single function call.
*/
class Query {
private static $post;
private static $posts;
private static $query;
/**
* This function will query single post and its meta.
* The wanted meta keys should be in an array as strings.
* A string 'all' returns all the meta keys and values in an associative array.
* If 'single' is set to true then the functions returns only the first value of the specified meta_key.
*
* @date 2015-03-20
* @since 0.0.1
*
* @param int $id Post ID.
* @param array $args Query arguments.
*
* @return array|object|null Type corresponding to output type on success or null on failure.
* @throws \Exception Prerequisites missing.
*/
public static function get_post( $id = null, $args = [] ) {
global $post;
$defaults = [
'meta_keys' => 'null',
'single' => false,
'output' => 'OBJECT',
];
$options = array_merge( $defaults, $args );
extract( $options );
// Throw error if we have no post to fetch
if ( empty( $post ) && empty( $id ) ) {
throw new \Exception(
'DustPress\Query::get_post() requires either global post object existence or defined $id parameter.'
);
}
// Get the post from $id parameter if it's different from the global post
// object or the global object does not exist.
$current_post = empty( $post ) || $post->ID !== $id
? get_post( $id )
: $post;
if ( ! isset( $current_post ) || ! is_object( $current_post ) ) {
return $post; // Null, most likely.
}
self::get_post_meta( $current_post, $meta_keys, $single );
$current_post->permalink = get_permalink( $current_post->ID );
$current_post->image_id = get_post_thumbnail_id( $current_post->ID );
// Cast the post and return.
return self::cast_post_to_type( $current_post, $output );
}
/**
* This function will query a single post and its meta.
*
* If the args has a key 'recursive' with the value 'true', relational
* post objects are loaded recursively to get the full object.
* Meta data is handled the same way as in get_post.
*
* @date 2015-03-20
* @since 0.0.1
*
* @param int $id Post ID.
* @param array $args Post query arguments.
*
* @return array|object|null Type corresponding to output type on success or null on failure.
* @throws \Exception Prerequisites missing.
*/
public static function get_acf_post( $id = null, $args = [] ) {
global $post;
$defaults = [
'meta_keys' => null,
'single' => false,
'whole_fields' => false,
'max_recursion_level' => 0,
'current_recursion_level' => 0,
'output' => 'OBJECT',
];
$options = array_merge( $defaults, $args );
// FIXME -> WP func.
extract( $options );
// Throw error if we have no post to fetch
if ( empty( $post ) && empty( $id ) ) {
throw new \Exception(
'DustPress\Query::get_acf_post() requires either global post object existence or defined $id parameter.'
);
}
// Get the post from $id parameter if it's different from the global
// post object or the global object does not exist.
$acfpost = empty( $post ) || $post->ID !== $id
? get_post( $id )
: $post;
// No post was found with the given id or the global post is empty.
if ( $acfpost === null || ! is_object( $acfpost ) ) {
return null;
}
if ( function_exists( 'get_fields' ) ) {
$acfpost->fields = get_fields( $acfpost->ID );
}
// Get fields with relational post data as a whole acf object
if ( $current_recursion_level < $max_recursion_level ) {
// Let's avoid infinite loops by default by stopping recursion
// after one level. You may dig deeper in your view model.
$options['current_recursion_level'] = apply_filters(
'dustpress/query/current_recursion_level',
++ $current_recursion_level
);
if ( ! empty( $acfpost->fields ) && is_array( $acfpost->fields ) ) {
foreach ( $acfpost->fields as &$field ) {
$field = self::handle_field( $field, $options );
}
}
} elseif ( true == $whole_fields ) {
if ( ! empty( $acfpost->fields ) && is_array( $acfpost->fields ) ) {
foreach ( $acfpost->fields as $name => &$field ) {
$field = get_field_object( $name, $acfpost->ID, true );
}
}
}
self::get_post_meta( $acfpost, $meta_keys, $single );
$acfpost->permalink = get_permalink( $acfpost->ID );
// Get ACF image object.
if ( function_exists( 'acf_get_attachment' ) ) {
$attachment_id = get_post_thumbnail_id( $acfpost->ID );
if ( $attachment_id ) {
$acfpost->image = acf_get_attachment( $attachment_id );
}
}
return self::cast_post_to_type( $acfpost, $output );
}
/**
* This is a recursive function that handles nested repeaters etc. in co-operation
* with the get_acf_post function.
*
* @date 2016-08-16
* @since 1.1.5
*
* @param array|object $field The current ACF field object.
* @param array|object $options Recursion options.
*
* @return mixed Returns the same type it is given, possibly extended.
* @throws \Exception Thrown from get_acf_post().
*/
private static function handle_field( $field, $options ) {
// No recursion for these post types
$ignored_types = [
'attachment',
'nav_menu_item',
'acf-field-group',
'acf-field',
];
$ignored_types = apply_filters(
'dustpress/query/ignore_on_recursion',
$ignored_types
);
// A direct relation field
if (
is_object( $field ) &&
isset( $field->post_type ) &&
! in_array( $field->post_type, $ignored_types, true )
) {
$field = self::get_acf_post( $field->ID, $options );
}
// A repeater field has relational posts
if ( is_array( $field ) && count( $field ) > 0 ) {
// Follows the nested structure of a repeater
foreach ( $field as $idx => &$row ) {
$is_acf_field = (
is_object( $row ) &&
isset( $row->post_type ) &&
! in_array( $row->post_type, $ignored_types, true )
);
$is_obj_or_arr = ( is_object( $row ) || is_array( $row ) );
// Post in a repeater
if ( $is_acf_field ) {
$row = self::get_acf_post( $row->ID, $options );
continue;
}
if ( $is_obj_or_arr ) {
$row = self::handle_field( $row, $options );
}
}
}
return $field;
}
/**
* This function will query all posts and its meta based on given arguments.
* If you want the whole query object, set 'query_object' to 'true'.
* If you are using pagination, set 'no_found_rows' to 'false'. This also makes the function to return the whole
* query object. The wanted meta keys should be in an array as strings. A string 'all' returns all the meta keys
* and values in an associative array.
*
* @date 2015-03-20
* @since 0.0.1
*
* @param array $args Arguments to override the defaults defined in get_wp_query_defaults.
*
* @return array|object|\WP_Query|false Array of post object with meta data.
*/
public static function get_posts( $args ) {
$defaults = self::get_wp_query_defaults();
$options = array_merge( $defaults, $args );
// FIXME -> WP function
extract( $options );
self::$query = new WP_Query( $options );
// Extend the basic post data with the permalink
// and the featured image id if it exists.
if (
is_array( self::$query->posts ) &&
self::$query->query_vars['fields'] !== 'ids' &&
count( self::$query->posts ) > 0
) {
foreach ( self::$query->posts as &$p ) {
$p->permalink = get_permalink( $p->ID );
$p->image_id = get_post_thumbnail_id( $p->ID );
}
}
// Get meta for posts
if ( count( self::$query->posts ) ) {
self::get_meta_for_posts( self::$query->posts, $meta_keys, $single );
// Reset the global post data just in case
wp_reset_postdata();
// Return in the desired format.
return self::query_return_value_format( self::$query, $query_object, $no_found_rows );
}
return false;
}
/**
* This function queries multiple posts and returns also all the Advanced Custom Fields data set saved in the posts
* meta. Meta data is handled the same way as in the get_posts-function.
*
* @date 2015-03-20
* @since 0.0.1
*
* @param array $args Arguments to override the defaults defined in get_wp_query_defaults.
*
* @return array|boolean Array of posts as an associative array with acf fields and meta data
*/
public static function get_acf_posts( $args ) {
// Some redundancy, but we need these.
$defaults = self::get_wp_query_defaults();
$defaults['max_recursion_level'] = 0;
$defaults['current_recursion_level'] = 0;
$options = array_merge( $defaults, $args );
extract( $options );
// Perform the basic query first
self::get_posts( $options );
// Temporarily set 'query_object' to 'true' for self::get_posts.
// The original value is still stored in $query_object.
$args['query_object'] = true;
self::get_posts( $args );
// Extend the posts with acf data
if ( ! is_array( self::$query->posts ) ) {
return false;
}
// loop through posts and get all acf fields
foreach ( self::$query->posts as &$p ) {
$p->fields = get_fields( $p->ID );
// Get fields with relational post data as a whole acf object
if ( $current_recursion_level < $max_recursion_level ) {
// Let's avoid infinite loops by default by stopping recursion
// after one level. You may dig deeper in your view model.
$options['current_recursion_level'] = apply_filters(
'dustpress/query/current_recursion_level',
++ $current_recursion_level
);
if ( is_array( $p->fields ) && count( $p->fields ) > 0 ) {
foreach ( $p->fields as &$field ) {
try {
$field = self::handle_field( $field, $options );
}
catch ( \Exception $e ) {
error_log( $e->getMessage );
}
}
}
} elseif ( true == $whole_fields ) {
if ( is_array( $p->fields ) && count( $p->fields ) > 0 ) {
foreach ( $p->fields as $name => &$field ) {
$field = get_field_object( $name, $id, true );
}
}
}
// Add attachment image to post
if ( function_exists( 'acf_get_attachment' ) ) {
$attachment_id = get_post_thumbnail_id( $p->ID );
if ( $attachment_id ) {
$p->image = acf_get_attachment( $attachment_id );
}
}
}
// Return in the desired format.
return self::query_return_value_format( self::$query, $query_object, $no_found_rows );
}
/**
* A wrapper for posts query function return value formatting.
*
* @param \WP_Query $query The WP_Query object.
* @param boolean $query_object Do we want the whole query object?
* @param boolean $no_found_rows Was the query paginated?
*
* @return \WP_Query|array|object
*/
private static function query_return_value_format( $query, $query_object, $no_found_rows ) {
// Maybe return the whole query object
if ( $query_object || false === $no_found_rows ) {
// Return the whole query object, if wanted or the query wants data for pagination.
return self::parse_query_object( self::$query );
}
// Return only the posts
return self::$query->posts;
}
/**
* Wraps the WP_Query data into a clean object for DustPHP parsing.
*
* @date 2017-02-17
* @since 1.5.7
*
* @param object $query The WP_Query object.
*
* @return object
*/
private static function parse_query_object( $query ) {
$object = (object) [
'posts' => $query->posts,
'post_count' => $query->post_count,
'found_posts' => $query->found_posts,
'max_num_pages' => $query->max_num_pages,
'comment_count' => $query->comment_count,
];
// If the debugger is enabled, return debug data.
if ( class_exists( __NAMESPACE__ . '\Debugger' ) && Debugger::use_debugger() ) {
$object->query = $query->query;
$object->query_vars = $query->query_vars;
$object->tax_query = $query->tax_query;
$object->meta_query = $query->meta_query;
$object->date_query = $query->date_query;
$object->request = $query->request;
}
// Return the data through possible custom filters.
return apply_filters(
'dustpress/query/object',
$object,
$query
);
}
/**
* Get meta data for a single post.
*
* @date 2015-03-20
* @since 0.0.1
*
* @param \WP_Post $post The queried post.
* @param array|string $meta_keys Wanted meta keys or string 'ALL' to fetch all.
* @param bool $single If true, return only the first value of the specified meta_key.
*/
private static function get_post_meta( &$post, $meta_keys = null, $single = false ) {
// Get all metadata.
if ( $meta_keys === 'all' ) {
$post->meta = get_metadata( 'post', $post->ID, '', $single );
return;
}
$meta = [];
if ( is_array( $meta_keys ) ) {
// Get the wanted metadata by defined keys.
foreach ( $meta_keys as $key ) {
$meta[ $key ] = get_metadata( 'post', $post->ID, $key, $single );
}
}
$post->meta = $meta;
}
/**
* Get meta data for multiple posts.
*
* @date 20/3/2015
* @since 0.0.1
*
* @param array $posts The queried post.
* @param array|string $meta_keys Wanted meta keys or string 'ALL' to fetch all.
* @param boolean $single If true, return only the first value of the specified meta_key.
*/
private static function get_meta_for_posts( &$posts = [], $meta_keys = null, $single = false ) {
if ( $meta_keys === 'all' ) {
// Loop through posts and get the meta values
foreach ( $posts as &$post ) {
$post->meta = get_metadata( 'post', $post->ID, '', $single );
}
return;
}
if ( is_array( $meta_keys ) ) {
// Loop through selected meta keys
foreach ( $meta_keys as $key ) {
// Loop through posts and get the meta values
foreach ( $posts as &$post ) {
// Maybe init meta
if ( ! isset( $post->meta ) ) {
$post->meta = [];
}
// Get meta by key and options
$post->meta[ $key ] = get_metadata( 'post', $post->ID, $key, $single );
}
}
}
}
/**
* Used to cast posts to a desired type.
* Defaults to standard WordPress object.
*
* @date 2016-01-26
* @since 0.3.0
*
* @param array|\WP_Post $post WP post object as an array.
* @param string $type The desired type.
*
* @return array|object
*/
private static function cast_post_to_type( $post, $type ) {
switch ( $type ) {
case 'ARRAY_A':
return $post->to_array();
case 'ARRAY_N':
return array_values( $post->to_array() );
default:
return $post;
}
}
/**
* Wrapper for wp queries' defaults.
*
* @return array
*/
private static function get_wp_query_defaults() {
return [
'meta_keys' => null, // Desired keys in an array or 'all' to fetch all
'single' => true, // Return only the first value for a meta key
'whole_fields' => false, // Return the entire field object for ACF fields
'query_object' => false, // Do not return the whole WP_Query object
'no_found_rows' => true, // No pagination needed
'update_post_meta_cache' => false, // No post meta utilized
'update_post_term_cache' => false, // No taxonomy terms utilized
];
}
}