1
|
|
|
<?php |
2
|
|
|
namespace GV; |
3
|
|
|
|
4
|
|
|
/** If this file is called directly, abort. */ |
5
|
|
|
if ( ! defined( 'GRAVITYVIEW_DIR' ) ) { |
6
|
|
|
die(); |
7
|
|
|
} |
8
|
|
|
|
9
|
|
|
/** |
10
|
|
|
* The default GravityView View class. |
11
|
|
|
* |
12
|
|
|
* Houses all base View functionality. |
13
|
|
|
* |
14
|
|
|
* Can be accessed as an array for old compatibility's sake |
15
|
|
|
* in line with the elements inside the \GravityView_View_Data::$views array. |
16
|
|
|
*/ |
17
|
|
|
class View implements \ArrayAccess { |
18
|
|
|
|
19
|
|
|
/** |
20
|
|
|
* @var \WP_Post The backing post instance. |
21
|
|
|
*/ |
22
|
|
|
private $post; |
23
|
|
|
|
24
|
|
|
/** |
25
|
|
|
* @var \GV\View_Settings The settings. |
26
|
|
|
* |
27
|
|
|
* @api |
28
|
|
|
* @since 2.0 |
29
|
|
|
*/ |
30
|
|
|
public $settings; |
31
|
|
|
|
32
|
|
|
/** |
33
|
|
|
* @var \GV\Widget_Collection The widets attached here. |
34
|
|
|
* |
35
|
|
|
* @api |
36
|
|
|
* @since 2.0 |
37
|
|
|
*/ |
38
|
|
|
public $widgets; |
39
|
|
|
|
40
|
|
|
/** |
41
|
|
|
* @var \GV\GF_Form|\GV\Form The backing form for this view. |
42
|
|
|
* |
43
|
|
|
* Contains the form that is sourced for entries in this view. |
44
|
|
|
* |
45
|
|
|
* @api |
46
|
|
|
* @since 2.0 |
47
|
|
|
*/ |
48
|
|
|
public $form; |
49
|
|
|
|
50
|
|
|
/** |
51
|
|
|
* @var \GV\Field_Collection The fields for this view. |
52
|
|
|
* |
53
|
|
|
* Contains all the fields that are attached to this view. |
54
|
|
|
* |
55
|
|
|
* @api |
56
|
|
|
* @since 2.0 |
57
|
|
|
*/ |
58
|
|
|
public $fields; |
59
|
|
|
|
60
|
|
|
/** |
61
|
|
|
* @var array |
62
|
|
|
* |
63
|
|
|
* Internal static cache for gets, and whatnot. |
64
|
|
|
* This is not persistent, resets across requests. |
65
|
|
|
|
66
|
|
|
* @internal |
67
|
|
|
*/ |
68
|
|
|
private static $cache = array(); |
69
|
|
|
|
70
|
|
|
/** |
71
|
|
|
* @var \GV\Join[] The joins for all sources in this view. |
72
|
|
|
* |
73
|
|
|
* @api |
74
|
|
|
* @since 2.0.1 |
75
|
|
|
*/ |
76
|
|
|
public $joins = array(); |
77
|
|
|
|
78
|
|
|
/** |
79
|
|
|
* @var \GV\Field[][] The unions for all sources in this view. |
80
|
|
|
* An array of fields grouped by form_id keyed by |
81
|
|
|
* main field_id: |
82
|
|
|
* |
83
|
|
|
* array( |
84
|
|
|
* $form_id => array( |
85
|
|
|
* $field_id => $field, |
86
|
|
|
* $field_id => $field, |
87
|
|
|
* ) |
88
|
|
|
* ) |
89
|
|
|
* |
90
|
|
|
* @api |
91
|
|
|
* @since 2.2.2 |
92
|
|
|
*/ |
93
|
|
|
public $unions = array(); |
94
|
|
|
|
95
|
|
|
/** |
96
|
|
|
* The constructor. |
97
|
|
|
*/ |
98
|
180 |
|
public function __construct() { |
99
|
180 |
|
$this->settings = new View_Settings(); |
100
|
180 |
|
$this->fields = new Field_Collection(); |
101
|
180 |
|
$this->widgets = new Widget_Collection(); |
102
|
180 |
|
} |
103
|
|
|
|
104
|
|
|
/** |
105
|
|
|
* Register the gravityview WordPress Custom Post Type. |
106
|
|
|
* |
107
|
|
|
* @internal |
108
|
|
|
* @return void |
109
|
|
|
*/ |
110
|
|
|
public static function register_post_type() { |
111
|
|
|
|
112
|
|
|
/** Register only once */ |
113
|
|
|
if ( post_type_exists( 'gravityview' ) ) { |
114
|
|
|
return; |
115
|
|
|
} |
116
|
|
|
|
117
|
|
|
/** |
118
|
|
|
* @filter `gravityview_is_hierarchical` Make GravityView Views hierarchical by returning TRUE |
119
|
|
|
* This will allow for Views to be nested with Parents and also allows for menu order to be set in the Page Attributes metabox |
120
|
|
|
* @since 1.13 |
121
|
|
|
* @param boolean $is_hierarchical Default: false |
122
|
|
|
*/ |
123
|
|
|
$is_hierarchical = (bool)apply_filters( 'gravityview_is_hierarchical', false ); |
124
|
|
|
|
125
|
|
|
$supports = array( 'title', 'revisions' ); |
126
|
|
|
|
127
|
|
|
if ( $is_hierarchical ) { |
128
|
|
|
$supports[] = 'page-attributes'; |
129
|
|
|
} |
130
|
|
|
|
131
|
|
|
/** |
132
|
|
|
* @filter `gravityview_post_type_supports` Modify post type support values for `gravityview` post type |
133
|
|
|
* @see add_post_type_support() |
134
|
|
|
* @since 1.15.2 |
135
|
|
|
* @param array $supports Array of features associated with a functional area of the edit screen. Default: 'title', 'revisions'. If $is_hierarchical, also 'page-attributes' |
136
|
|
|
* @param[in] boolean $is_hierarchical Do Views support parent/child relationships? See `gravityview_is_hierarchical` filter. |
137
|
|
|
*/ |
138
|
|
|
$supports = apply_filters( 'gravityview_post_type_support', $supports, $is_hierarchical ); |
139
|
|
|
|
140
|
|
|
/** Register Custom Post Type - gravityview */ |
141
|
|
|
$labels = array( |
142
|
|
|
'name' => _x( 'Views', 'Post Type General Name', 'gravityview' ), |
143
|
|
|
'singular_name' => _x( 'View', 'Post Type Singular Name', 'gravityview' ), |
144
|
|
|
'menu_name' => _x( 'Views', 'Menu name', 'gravityview' ), |
145
|
|
|
'parent_item_colon' => __( 'Parent View:', 'gravityview' ), |
146
|
|
|
'all_items' => __( 'All Views', 'gravityview' ), |
147
|
|
|
'view_item' => _x( 'View', 'View Item', 'gravityview' ), |
148
|
|
|
'add_new_item' => __( 'Add New View', 'gravityview' ), |
149
|
|
|
'add_new' => __( 'New View', 'gravityview' ), |
150
|
|
|
'edit_item' => __( 'Edit View', 'gravityview' ), |
151
|
|
|
'update_item' => __( 'Update View', 'gravityview' ), |
152
|
|
|
'search_items' => __( 'Search Views', 'gravityview' ), |
153
|
|
|
'not_found' => \GravityView_Admin::no_views_text(), |
154
|
|
|
'not_found_in_trash' => __( 'No Views found in Trash', 'gravityview' ), |
155
|
|
|
'filter_items_list' => __( 'Filter Views list', 'gravityview' ), |
156
|
|
|
'items_list_navigation' => __( 'Views list navigation', 'gravityview' ), |
157
|
|
|
'items_list' => __( 'Views list', 'gravityview' ), |
158
|
|
|
'view_items' => __( 'See Views', 'gravityview' ), |
159
|
|
|
'attributes' => __( 'View Attributes', 'gravityview' ), |
160
|
|
|
); |
161
|
|
|
$args = array( |
162
|
|
|
'label' => __( 'view', 'gravityview' ), |
163
|
|
|
'description' => __( 'Create views based on a Gravity Forms form', 'gravityview' ), |
164
|
|
|
'labels' => $labels, |
165
|
|
|
'supports' => $supports, |
166
|
|
|
'hierarchical' => $is_hierarchical, |
167
|
|
|
/** |
168
|
|
|
* @filter `gravityview_direct_access` Should Views be directly accessible, or only visible using the shortcode? |
169
|
|
|
* @see https://codex.wordpress.org/Function_Reference/register_post_type#public |
170
|
|
|
* @since 1.15.2 |
171
|
|
|
* @param[in,out] boolean `true`: allow Views to be accessible directly. `false`: Only allow Views to be embedded via shortcode. Default: `true` |
172
|
|
|
* @param int $view_id The ID of the View currently being requested. `0` for general setting |
173
|
|
|
*/ |
174
|
|
|
'public' => apply_filters( 'gravityview_direct_access', gravityview()->plugin->is_compatible(), 0 ), |
175
|
|
|
'show_ui' => gravityview()->plugin->is_compatible(), |
176
|
|
|
'show_in_menu' => gravityview()->plugin->is_compatible(), |
177
|
|
|
'show_in_nav_menus' => true, |
178
|
|
|
'show_in_admin_bar' => true, |
179
|
|
|
'menu_position' => 17, |
180
|
|
|
'menu_icon' => '', |
181
|
|
|
'can_export' => true, |
182
|
|
|
/** |
183
|
|
|
* @filter `gravityview_has_archive` Enable Custom Post Type archive? |
184
|
|
|
* @since 1.7.3 |
185
|
|
|
* @param boolean False: don't have frontend archive; True: yes, have archive. Default: false |
186
|
|
|
*/ |
187
|
|
|
'has_archive' => apply_filters( 'gravityview_has_archive', false ), |
188
|
|
|
'exclude_from_search' => true, |
189
|
|
|
'rewrite' => array( |
190
|
|
|
/** |
191
|
|
|
* @filter `gravityview_slug` Modify the url part for a View. |
192
|
|
|
* @see https://docs.gravityview.co/article/62-changing-the-view-slug |
193
|
|
|
* @param string $slug The slug shown in the URL |
194
|
|
|
*/ |
195
|
|
|
'slug' => apply_filters( 'gravityview_slug', 'view' ), |
196
|
|
|
|
197
|
|
|
/** |
198
|
|
|
* @filter `gravityview/post_type/with_front` Should the permalink structure |
199
|
|
|
* be prepended with the front base. |
200
|
|
|
* (example: if your permalink structure is /blog/, then your links will be: false->/view/, true->/blog/view/). |
201
|
|
|
* Defaults to true. |
202
|
|
|
* @see https://codex.wordpress.org/Function_Reference/register_post_type |
203
|
|
|
* @since 2.0 |
204
|
|
|
* @param bool $with_front |
205
|
|
|
*/ |
206
|
|
|
'with_front' => apply_filters( 'gravityview/post_type/with_front', true ), |
207
|
|
|
), |
208
|
|
|
'capability_type' => 'gravityview', |
209
|
|
|
'map_meta_cap' => true, |
210
|
|
|
); |
211
|
|
|
|
212
|
|
|
register_post_type( 'gravityview', $args ); |
213
|
|
|
} |
214
|
|
|
|
215
|
|
|
/** |
216
|
|
|
* Add extra rewrite endpoints. |
217
|
|
|
* |
218
|
|
|
* @return void |
219
|
|
|
*/ |
220
|
2 |
|
public static function add_rewrite_endpoint() { |
221
|
|
|
/** |
222
|
|
|
* CSV. |
223
|
|
|
*/ |
224
|
|
|
global $wp_rewrite; |
225
|
|
|
|
226
|
|
|
$slug = apply_filters( 'gravityview_slug', 'view' ); |
227
|
|
|
$rule = array( sprintf( '%s/([^/]+)/csv/?', $slug ), 'index.php?gravityview=$matches[1]&csv=1', 'top' ); |
228
|
|
|
|
229
|
2 |
|
add_filter( 'query_vars', function( $query_vars ) { |
230
|
2 |
|
$query_vars[] = 'csv'; |
231
|
2 |
|
return $query_vars; |
232
|
|
|
} ); |
233
|
|
|
|
234
|
|
|
if ( ! isset( $wp_rewrite->extra_rules_top[ $rule[0] ] ) ) { |
235
|
|
|
call_user_func_array( 'add_rewrite_rule', $rule ); |
236
|
|
|
} |
237
|
|
|
} |
238
|
|
|
|
239
|
|
|
/** |
240
|
|
|
* A renderer filter for the View post type content. |
241
|
|
|
* |
242
|
|
|
* @param string $content Should be empty, as we don't store anything there. |
243
|
|
|
* |
244
|
|
|
* @return string $content The view content as output by the renderers. |
245
|
|
|
*/ |
246
|
12 |
|
public static function content( $content ) { |
247
|
12 |
|
$request = gravityview()->request; |
248
|
|
|
|
249
|
|
|
// Plugins may run through the content in the header. WP SEO does this for its OpenGraph functionality. |
250
|
12 |
|
if ( ! defined( 'DOING_GRAVITYVIEW_TESTS' ) ) { |
251
|
|
|
if ( ! did_action( 'loop_start' ) ) { |
252
|
|
|
gravityview()->log->debug( 'Not processing yet: loop_start hasn\'t run yet. Current action: {action}', array( 'action' => current_filter() ) ); |
253
|
|
|
return $content; |
254
|
|
|
} |
255
|
|
|
|
256
|
|
|
// We don't want this filter to run infinite loop on any post content fields |
257
|
|
|
remove_filter( 'the_content', array( __CLASS__, __METHOD__ ) ); |
258
|
|
|
} |
259
|
|
|
|
260
|
|
|
/** |
261
|
|
|
* This is not a View. Bail. |
262
|
|
|
* |
263
|
|
|
* Shortcodes and oEmbeds and whatnot will be handled |
264
|
|
|
* elsewhere. |
265
|
|
|
*/ |
266
|
12 |
|
if ( ! $view = $request->is_view() ) { |
267
|
6 |
|
return $content; |
268
|
|
|
} |
269
|
|
|
|
270
|
|
|
/** |
271
|
|
|
* Check permissions. |
272
|
|
|
*/ |
273
|
6 |
|
while ( $error = $view->can_render( null, $request ) ) { |
274
|
6 |
|
if ( ! is_wp_error( $error ) ) |
275
|
6 |
|
break; |
276
|
|
|
|
277
|
1 |
|
switch ( str_replace( 'gravityview/', '', $error->get_error_code() ) ) { |
278
|
1 |
|
case 'post_password_required': |
279
|
1 |
|
return get_the_password_form( $view->ID ); |
280
|
1 |
|
case 'no_form_attached': |
281
|
|
|
|
282
|
|
|
gravityview()->log->error( 'View #{view_id} cannot render: {error_code} {error_message}', array( 'error_code' => $error->get_error_code(), 'error_message' => $error->get_error_message() ) ); |
283
|
|
|
|
284
|
|
|
/** |
285
|
|
|
* This View has no data source. There's nothing to show really. |
286
|
|
|
* ...apart from a nice message if the user can do anything about it. |
287
|
|
|
*/ |
288
|
|
|
if ( \GVCommon::has_cap( array( 'edit_gravityviews', 'edit_gravityview' ), $view->ID ) ) { |
289
|
|
|
return __( sprintf( 'This View is not configured properly. Start by <a href="%s">selecting a form</a>.', esc_url( get_edit_post_link( $view->ID, false ) ) ), 'gravityview' ); |
290
|
|
|
} |
291
|
|
|
break; |
292
|
1 |
|
case 'in_trash': |
293
|
|
|
|
294
|
|
|
if ( \GVCommon::has_cap( array( 'edit_gravityviews', 'edit_gravityview' ), $view->ID ) ) { |
295
|
|
|
return __( sprintf( 'This View is in the Trash. You can <a href="%s">restore the View here</a>.', esc_url( get_edit_post_link( $view->ID, false ) ) ), 'gravityview' ); |
296
|
|
|
} |
297
|
|
|
|
298
|
|
|
return ''; // Do not show |
299
|
|
|
break; |
|
|
|
|
300
|
1 |
|
case 'no_direct_access': |
301
|
1 |
|
case 'embed_only': |
302
|
1 |
|
case 'not_public': |
303
|
|
|
default: |
304
|
1 |
|
gravityview()->log->notice( 'View #{view_id} cannot render: {error_code} {error_message}', array( 'error_code' => $error->get_error_code(), 'error_message' => $error->get_error_message() ) ); |
305
|
1 |
|
return __( 'You are not allowed to view this content.', 'gravityview' ); |
306
|
|
|
} |
307
|
|
|
|
308
|
|
|
return $content; |
309
|
|
|
} |
310
|
|
|
|
311
|
6 |
|
$is_admin_and_can_view = $view->settings->get( 'admin_show_all_statuses' ) && \GVCommon::has_cap('gravityview_moderate_entries', $view->ID ); |
312
|
|
|
|
313
|
|
|
/** |
314
|
|
|
* Editing a single entry. |
315
|
|
|
*/ |
316
|
6 |
|
if ( $entry = $request->is_edit_entry( $view->form ? $view->form->ID : 0 ) ) { |
317
|
|
|
if ( $entry['status'] != 'active' ) { |
318
|
|
|
gravityview()->log->notice( 'Entry ID #{entry_id} is not active', array( 'entry_id' => $entry->ID ) ); |
319
|
|
|
return __( 'You are not allowed to view this content.', 'gravityview' ); |
320
|
|
|
} |
321
|
|
|
|
322
|
|
|
if ( apply_filters( 'gravityview_custom_entry_slug', false ) && $entry->slug != get_query_var( \GV\Entry::get_endpoint_name() ) ) { |
323
|
|
|
gravityview()->log->error( 'Entry ID #{entry_id} was accessed by a bad slug', array( 'entry_id' => $entry->ID ) ); |
324
|
|
|
return __( 'You are not allowed to view this content.', 'gravityview' ); |
325
|
|
|
} |
326
|
|
|
|
327
|
|
|
if ( $view->settings->get( 'show_only_approved' ) && ! $is_admin_and_can_view ) { |
328
|
|
|
if ( ! \GravityView_Entry_Approval_Status::is_approved( gform_get_meta( $entry->ID, \GravityView_Entry_Approval::meta_key ) ) ) { |
329
|
|
|
gravityview()->log->error( 'Entry ID #{entry_id} is not approved for viewing', array( 'entry_id' => $entry->ID ) ); |
330
|
|
|
return __( 'You are not allowed to view this content.', 'gravityview' ); |
331
|
|
|
} |
332
|
|
|
} |
333
|
|
|
|
334
|
|
|
$renderer = new Edit_Entry_Renderer(); |
335
|
|
|
return $renderer->render( $entry, $view, $request ); |
336
|
|
|
|
337
|
|
|
/** |
338
|
|
|
* Viewing a single entry. |
339
|
|
|
*/ |
340
|
6 |
|
} else if ( $entry = $request->is_entry( $view->form ? $view->form->ID : 0 ) ) { |
341
|
|
|
|
342
|
2 |
|
$entryset = $entry->is_multi() ? $entry->entries : array( $entry ); |
343
|
|
|
|
344
|
2 |
|
$custom_slug = apply_filters( 'gravityview_custom_entry_slug', false ); |
345
|
2 |
|
$ids = explode( ',', get_query_var( \GV\Entry::get_endpoint_name() ) ); |
346
|
|
|
|
347
|
2 |
|
$show_only_approved = $view->settings->get( 'show_only_approved' ); |
348
|
|
|
|
349
|
2 |
|
foreach ( $entryset as $e ) { |
350
|
|
|
|
351
|
2 |
|
if ( 'active' !== $e['status'] ) { |
352
|
1 |
|
gravityview()->log->notice( 'Entry ID #{entry_id} is not active', array( 'entry_id' => $e->ID ) ); |
353
|
1 |
|
return __( 'You are not allowed to view this content.', 'gravityview' ); |
354
|
|
|
} |
355
|
|
|
|
356
|
2 |
|
if ( $custom_slug && ! in_array( $e->slug, $ids ) ) { |
357
|
1 |
|
gravityview()->log->error( 'Entry ID #{entry_id} was accessed by a bad slug', array( 'entry_id' => $e->ID ) ); |
358
|
1 |
|
return __( 'You are not allowed to view this content.', 'gravityview' ); |
359
|
|
|
} |
360
|
|
|
|
361
|
2 |
|
if ( $show_only_approved && ! $is_admin_and_can_view ) { |
362
|
1 |
|
if ( ! \GravityView_Entry_Approval_Status::is_approved( gform_get_meta( $e->ID, \GravityView_Entry_Approval::meta_key ) ) ) { |
363
|
1 |
|
gravityview()->log->error( 'Entry ID #{entry_id} is not approved for viewing', array( 'entry_id' => $e->ID ) ); |
364
|
1 |
|
return __( 'You are not allowed to view this content.', 'gravityview' ); |
365
|
|
|
} |
366
|
|
|
} |
367
|
|
|
|
368
|
2 |
|
$error = \GVCommon::check_entry_display( $e->as_entry(), $view ); |
369
|
|
|
|
370
|
2 |
|
if ( is_wp_error( $error ) ) { |
371
|
1 |
|
gravityview()->log->error( 'Entry ID #{entry_id} is not approved for viewing: {message}', array( 'entry_id' => $e->ID, 'message' => $error->get_error_message() ) ); |
372
|
1 |
|
return __( 'You are not allowed to view this content.', 'gravityview' ); |
373
|
|
|
} |
374
|
|
|
} |
375
|
|
|
|
376
|
2 |
|
$renderer = new Entry_Renderer(); |
377
|
2 |
|
return $renderer->render( $entry, $view, $request ); |
378
|
|
|
} |
379
|
|
|
|
380
|
|
|
/** |
381
|
|
|
* Plain old View. |
382
|
|
|
*/ |
383
|
5 |
|
$renderer = new View_Renderer(); |
384
|
5 |
|
return $renderer->render( $view, $request ); |
385
|
|
|
} |
386
|
|
|
|
387
|
|
|
/** |
388
|
|
|
* Checks whether this view can be accessed or not. |
389
|
|
|
* |
390
|
|
|
* @param string[] $context The context we're asking for access from. |
391
|
|
|
* Can any and as many of one of: |
392
|
|
|
* edit An edit context. |
393
|
|
|
* single A single context. |
394
|
|
|
* cpt The custom post type single page acessed. |
395
|
|
|
* shortcode Embedded as a shortcode. |
396
|
|
|
* oembed Embedded as an oEmbed. |
397
|
|
|
* rest A REST call. |
398
|
|
|
* @param \GV\Request $request The request |
399
|
|
|
* |
400
|
|
|
* @return bool|\WP_Error An error if this View shouldn't be rendered here. |
401
|
|
|
*/ |
402
|
30 |
|
public function can_render( $context = null, $request = null ) { |
403
|
30 |
|
if ( ! $request ) { |
404
|
7 |
|
$request = gravityview()->request; |
405
|
|
|
} |
406
|
|
|
|
407
|
30 |
|
if ( ! is_array( $context ) ) { |
408
|
6 |
|
$context = array(); |
409
|
|
|
} |
410
|
|
|
|
411
|
|
|
/** |
412
|
|
|
* @filter `gravityview/view/can_render` Whether the view can be rendered or not. |
413
|
|
|
* @param bool|\WP_Error $result The result. Default: null. |
414
|
|
|
* @param \GV\View $view The view. |
415
|
|
|
* @param string[] $context See \GV\View::can_render |
416
|
|
|
* @param \GV\Request $request The request. |
417
|
|
|
*/ |
418
|
30 |
|
if ( ! is_null( $result = apply_filters( 'gravityview/view/can_render', null, $this, $context, $request ) ) ) { |
419
|
|
|
return $result; |
420
|
|
|
} |
421
|
|
|
|
422
|
30 |
|
if ( in_array( 'rest', $context ) ) { |
423
|
|
|
// REST |
424
|
8 |
|
if ( gravityview()->plugin->settings->get( 'rest_api' ) === '1' && $this->settings->get( 'rest_disable' ) === '1' ) { |
425
|
1 |
|
return new \WP_Error( 'gravityview/rest_disabled' ); |
426
|
8 |
|
} elseif ( gravityview()->plugin->settings->get( 'rest_api' ) !== '1' && $this->settings->get( 'rest_enable' ) !== '1' ) { |
427
|
1 |
|
return new \WP_Error( 'gravityview/rest_disabled' ); |
428
|
|
|
} |
429
|
|
|
} |
430
|
|
|
|
431
|
30 |
|
if ( in_array( 'csv', $context ) ) { |
432
|
7 |
|
if ( $this->settings->get( 'csv_enable' ) !== '1' ) { |
433
|
1 |
|
return new \WP_Error( 'gravityview/csv_disabled', 'The CSV endpoint is not enabled for this View' ); |
434
|
|
|
} |
435
|
|
|
} |
436
|
|
|
|
437
|
|
|
/** |
438
|
|
|
* This View is password protected. Nothing to do here. |
439
|
|
|
*/ |
440
|
30 |
|
if ( post_password_required( $this->ID ) ) { |
|
|
|
|
441
|
3 |
|
gravityview()->log->notice( 'Post password is required for View #{view_id}', array( 'view_id' => $this->ID ) ); |
|
|
|
|
442
|
3 |
|
return new \WP_Error( 'gravityview/post_password_required' ); |
443
|
|
|
} |
444
|
|
|
|
445
|
30 |
|
if ( ! $this->form ) { |
446
|
|
|
gravityview()->log->notice( 'View #{id} has no form attached to it.', array( 'id' => $this->ID ) ); |
|
|
|
|
447
|
|
|
return new \WP_Error( 'gravityview/no_form_attached' ); |
448
|
|
|
} |
449
|
|
|
|
450
|
30 |
|
if ( ! in_array( 'shortcode', $context ) ) { |
451
|
|
|
/** |
452
|
|
|
* Is this View directly accessible via a post URL? |
453
|
|
|
* |
454
|
|
|
* @see https://codex.wordpress.org/Function_Reference/register_post_type#public |
455
|
|
|
*/ |
456
|
|
|
|
457
|
|
|
/** |
458
|
|
|
* @filter `gravityview_direct_access` Should Views be directly accessible, or only visible using the shortcode? |
459
|
|
|
* @deprecated |
460
|
|
|
* @param[in,out] boolean `true`: allow Views to be accessible directly. `false`: Only allow Views to be embedded. Default: `true` |
461
|
|
|
* @param int $view_id The ID of the View currently being requested. `0` for general setting |
462
|
|
|
*/ |
463
|
21 |
|
$direct_access = apply_filters( 'gravityview_direct_access', true, $this->ID ); |
|
|
|
|
464
|
|
|
|
465
|
|
|
/** |
466
|
|
|
* @filter `gravityview/request/output/direct` Should this View be directly accessbile? |
467
|
|
|
* @since 2.0 |
468
|
|
|
* @param[in,out] boolean Accessible or not. Default: accessbile. |
469
|
|
|
* @param \GV\View $view The View we're trying to directly render here. |
470
|
|
|
* @param \GV\Request $request The current request. |
471
|
|
|
*/ |
472
|
21 |
|
if ( ! apply_filters( 'gravityview/view/output/direct', $direct_access, $this, $request ) ) { |
473
|
|
|
return new \WP_Error( 'gravityview/no_direct_access' ); |
474
|
|
|
} |
475
|
|
|
|
476
|
|
|
/** |
477
|
|
|
* Is this View an embed-only View? If so, don't allow rendering here, |
478
|
|
|
* as this is a direct request. |
479
|
|
|
*/ |
480
|
21 |
|
if ( $this->settings->get( 'embed_only' ) && ! \GVCommon::has_cap( 'read_private_gravityviews' ) ) { |
481
|
1 |
|
return new \WP_Error( 'gravityview/embed_only' ); |
482
|
|
|
} |
483
|
|
|
} |
484
|
|
|
|
485
|
|
|
/** Private, pending, draft, etc. */ |
486
|
30 |
|
$public_states = get_post_stati( array( 'public' => true ) ); |
487
|
30 |
|
if ( ! in_array( $this->post_status, $public_states ) && ! \GVCommon::has_cap( 'read_gravityview', $this->ID ) ) { |
|
|
|
|
488
|
3 |
|
gravityview()->log->notice( 'The current user cannot access this View #{view_id}', array( 'view_id' => $this->ID ) ); |
|
|
|
|
489
|
3 |
|
return new \WP_Error( 'gravityview/not_public' ); |
490
|
|
|
} |
491
|
|
|
|
492
|
30 |
|
return true; |
493
|
|
|
} |
494
|
|
|
|
495
|
|
|
/** |
496
|
|
|
* Get joins associated with a view |
497
|
|
|
* |
498
|
|
|
* @param \WP_Post $post GravityView CPT to get joins for |
499
|
|
|
* |
500
|
|
|
* @api |
501
|
|
|
* @since 2.0.11 |
502
|
|
|
* |
503
|
|
|
* @return \GV\Join[] Array of \GV\Join instances |
504
|
|
|
*/ |
505
|
180 |
|
public static function get_joins( $post ) { |
506
|
180 |
|
$joins = array(); |
507
|
|
|
|
508
|
180 |
|
if ( ! gravityview()->plugin->supports( Plugin::FEATURE_JOINS ) ) { |
509
|
|
|
gravityview()->log->error( 'Cannot get joined forms; joins feature not supported.' ); |
510
|
|
|
return $joins; |
511
|
|
|
} |
512
|
|
|
|
513
|
180 |
|
if ( ! $post || 'gravityview' !== get_post_type( $post ) ) { |
514
|
|
|
gravityview()->log->error( 'Only "gravityview" post types can be \GV\View instances.' ); |
515
|
|
|
return $joins; |
516
|
|
|
} |
517
|
|
|
|
518
|
180 |
|
$joins_meta = get_post_meta( $post->ID, '_gravityview_form_joins', true ); |
519
|
|
|
|
520
|
180 |
|
if ( empty( $joins_meta ) ) { |
521
|
168 |
|
return $joins; |
522
|
|
|
} |
523
|
|
|
|
524
|
12 |
|
foreach ( $joins_meta as $meta ) { |
525
|
12 |
|
if ( ! is_array( $meta ) || count( $meta ) != 4 ) { |
526
|
|
|
continue; |
527
|
|
|
} |
528
|
|
|
|
529
|
12 |
|
list( $join, $join_column, $join_on, $join_on_column ) = $meta; |
530
|
|
|
|
531
|
12 |
|
$join = GF_Form::by_id( $join ); |
532
|
12 |
|
$join_on = GF_Form::by_id( $join_on ); |
533
|
|
|
|
534
|
12 |
|
$join_column = is_numeric( $join_column ) ? GF_Field::by_id( $join, $join_column ) : Internal_Field::by_id( $join_column ); |
535
|
12 |
|
$join_on_column = is_numeric( $join_on_column ) ? GF_Field::by_id( $join_on, $join_on_column ) : Internal_Field::by_id( $join_on_column ); |
536
|
|
|
|
537
|
12 |
|
$joins [] = new Join( $join, $join_column, $join_on, $join_on_column ); |
538
|
|
|
} |
539
|
|
|
|
540
|
12 |
|
return $joins; |
541
|
|
|
} |
542
|
|
|
|
543
|
|
|
/** |
544
|
|
|
* Get joined forms associated with a view |
545
|
|
|
* In no particular order. |
546
|
|
|
* |
547
|
|
|
* @since 2.0.11 |
548
|
|
|
* |
549
|
|
|
* @api |
550
|
|
|
* @since 2.0 |
551
|
|
|
* @param int $post_id ID of the View |
552
|
|
|
* |
553
|
|
|
* @return \GV\GF_Form[] Array of \GV\GF_Form instances |
554
|
|
|
*/ |
555
|
2 |
|
public static function get_joined_forms( $post_id ) { |
556
|
2 |
|
$forms = array(); |
557
|
|
|
|
558
|
2 |
|
if ( ! gravityview()->plugin->supports( Plugin::FEATURE_JOINS ) ) { |
559
|
|
|
gravityview()->log->error( 'Cannot get joined forms; joins feature not supported.' ); |
560
|
|
|
return $forms; |
561
|
|
|
} |
562
|
|
|
|
563
|
2 |
|
if ( ! $post_id || ! gravityview()->plugin->supports( Plugin::FEATURE_JOINS ) ) { |
564
|
|
|
return $forms; |
565
|
|
|
} |
566
|
|
|
|
567
|
2 |
|
if ( empty( $post_id ) ) { |
568
|
|
|
gravityview()->log->error( 'Cannot get joined forms; $post_id was empty' ); |
569
|
|
|
return $forms; |
570
|
|
|
} |
571
|
|
|
|
572
|
2 |
|
$joins_meta = get_post_meta( $post_id, '_gravityview_form_joins', true ); |
573
|
|
|
|
574
|
2 |
|
if ( empty( $joins_meta ) ) { |
575
|
|
|
return $forms; |
576
|
|
|
} |
577
|
|
|
|
578
|
2 |
|
foreach ( $joins_meta as $meta ) { |
579
|
2 |
|
if ( ! is_array( $meta ) || count( $meta ) != 4 ) { |
580
|
|
|
continue; |
581
|
|
|
} |
582
|
|
|
|
583
|
2 |
|
list( $join, $join_column, $join_on, $join_on_column ) = $meta; |
584
|
|
|
|
585
|
2 |
|
if ( $form = GF_Form::by_id( $join_on ) ) { |
586
|
2 |
|
$forms[ $join_on ] = $form; |
587
|
|
|
} |
588
|
|
|
|
589
|
2 |
|
if ( $form = GF_Form::by_id( $join ) ) { |
590
|
2 |
|
$forms[ $join ] = $form; |
591
|
|
|
} |
592
|
|
|
} |
593
|
|
|
|
594
|
2 |
|
return $forms; |
595
|
|
|
} |
596
|
|
|
|
597
|
|
|
/** |
598
|
|
|
* Get unions associated with a view |
599
|
|
|
* |
600
|
|
|
* @param \WP_Post $post GravityView CPT to get unions for |
601
|
|
|
* |
602
|
|
|
* @api |
603
|
|
|
* @since 2.2.2 |
604
|
|
|
* |
605
|
|
|
* @return \GV\Field[][] Array of unions (see self::$unions) |
606
|
|
|
*/ |
607
|
180 |
|
public static function get_unions( $post ) { |
608
|
180 |
|
$unions = array(); |
609
|
|
|
|
610
|
180 |
|
if ( ! $post || 'gravityview' !== get_post_type( $post ) ) { |
611
|
|
|
gravityview()->log->error( 'Only "gravityview" post types can be \GV\View instances.' ); |
612
|
|
|
return $unions; |
613
|
|
|
} |
614
|
|
|
|
615
|
180 |
|
$fields = get_post_meta( $post->ID, '_gravityview_directory_fields', true ); |
616
|
|
|
|
617
|
180 |
|
if ( empty( $fields ) ) { |
618
|
1 |
|
return $unions; |
619
|
|
|
} |
620
|
|
|
|
621
|
179 |
|
foreach ( $fields as $location => $_fields ) { |
622
|
179 |
|
if ( strpos( $location, 'directory_' ) !== 0 ) { |
623
|
51 |
|
continue; |
624
|
|
|
} |
625
|
|
|
|
626
|
130 |
|
foreach ( $_fields as $field ) { |
627
|
130 |
|
if ( ! empty( $field['unions'] ) ) { |
628
|
1 |
|
foreach ( $field['unions'] as $form_id => $field_id ) { |
629
|
1 |
|
if ( ! isset( $unions[ $form_id ] ) ) { |
630
|
1 |
|
$unions[ $form_id ] = array(); |
631
|
|
|
} |
632
|
|
|
|
633
|
1 |
|
$unions[ $form_id ][ $field['id'] ] = |
634
|
1 |
|
is_numeric( $field_id ) ? \GV\GF_Field::by_id( \GV\GF_Form::by_id( $form_id ), $field_id ) : \GV\Internal_Field::by_id( $field_id ); |
635
|
|
|
} |
636
|
|
|
} |
637
|
|
|
} |
638
|
|
|
|
639
|
130 |
|
break; |
640
|
|
|
} |
641
|
|
|
|
642
|
179 |
|
if ( $unions ) { |
|
|
|
|
643
|
1 |
|
if ( ! gravityview()->plugin->supports( Plugin::FEATURE_UNIONS ) ) { |
644
|
|
|
gravityview()->log->error( 'Cannot get unions; unions feature not supported.' ); |
645
|
|
|
} |
646
|
|
|
} |
647
|
|
|
|
648
|
|
|
// @todo We'll probably need to backfill null unions |
649
|
|
|
|
650
|
179 |
|
return $unions; |
651
|
|
|
} |
652
|
|
|
|
653
|
|
|
/** |
654
|
|
|
* Construct a \GV\View instance from a \WP_Post. |
655
|
|
|
* |
656
|
|
|
* @param \WP_Post $post The \WP_Post instance to wrap. |
657
|
|
|
* |
658
|
|
|
* @api |
659
|
|
|
* @since 2.0 |
660
|
|
|
* @return \GV\View|null An instance around this \WP_Post if valid, null otherwise. |
661
|
|
|
*/ |
662
|
181 |
|
public static function from_post( $post ) { |
663
|
|
|
|
664
|
181 |
|
if ( ! $post || 'gravityview' !== get_post_type( $post ) ) { |
665
|
2 |
|
gravityview()->log->error( 'Only gravityview post types can be \GV\View instances.' ); |
666
|
2 |
|
return null; |
667
|
|
|
} |
668
|
|
|
|
669
|
181 |
|
if ( $view = Utils::get( self::$cache, "View::from_post:{$post->ID}" ) ) { |
670
|
|
|
/** |
671
|
|
|
* @filter `gravityview/view/get` Override View. |
672
|
|
|
* @param \GV\View $view The View instance pointer. |
673
|
|
|
* @since 2.1 |
674
|
|
|
*/ |
675
|
107 |
|
do_action_ref_array( 'gravityview/view/get', array( &$view ) ); |
676
|
|
|
|
677
|
107 |
|
return $view; |
678
|
|
|
} |
679
|
|
|
|
680
|
181 |
|
$view = new self(); |
681
|
181 |
|
$view->post = $post; |
682
|
|
|
|
683
|
|
|
/** Get connected form. */ |
684
|
181 |
|
$view->form = GF_Form::by_id( $view->_gravityview_form_id ); |
|
|
|
|
685
|
181 |
|
if ( ! $view->form ) { |
686
|
|
|
gravityview()->log->error( 'View #{view_id} tried attaching non-existent Form #{form_id} to it.', array( |
687
|
|
|
'view_id' => $view->ID, |
|
|
|
|
688
|
|
|
'form_id' => $view->_gravityview_form_id ? : 0, |
|
|
|
|
689
|
|
|
) ); |
690
|
|
|
} |
691
|
|
|
|
692
|
181 |
|
$view->joins = $view::get_joins( $post ); |
693
|
|
|
|
694
|
181 |
|
$view->unions = $view::get_unions( $post ); |
695
|
|
|
|
696
|
|
|
/** |
697
|
|
|
* @filter `gravityview/configuration/fields` Filter the View fields' configuration array. |
698
|
|
|
* @since 1.6.5 |
699
|
|
|
* |
700
|
|
|
* @deprecated Use `gravityview/view/configuration/fields` or `gravityview/view/fields` filters. |
701
|
|
|
* |
702
|
|
|
* @param $fields array Multi-array of fields with first level being the field zones. |
703
|
|
|
* @param $view_id int The View the fields are being pulled for. |
704
|
|
|
*/ |
705
|
181 |
|
$configuration = apply_filters( 'gravityview/configuration/fields', (array)$view->_gravityview_directory_fields, $view->ID ); |
|
|
|
|
706
|
|
|
|
707
|
|
|
/** |
708
|
|
|
* @filter `gravityview/view/configuration/fields` Filter the View fields' configuration array. |
709
|
|
|
* @since 2.0 |
710
|
|
|
* |
711
|
|
|
* @param array $fields Multi-array of fields with first level being the field zones. |
712
|
|
|
* @param \GV\View $view The View the fields are being pulled for. |
713
|
|
|
*/ |
714
|
181 |
|
$configuration = apply_filters( 'gravityview/view/configuration/fields', $configuration, $view ); |
715
|
|
|
|
716
|
|
|
/** |
717
|
|
|
* @filter `gravityview/view/fields` Filter the Field Collection for this View. |
718
|
|
|
* @since 2.0 |
719
|
|
|
* |
720
|
|
|
* @param \GV\Field_Collection $fields A collection of fields. |
721
|
|
|
* @param \GV\View $view The View the fields are being pulled for. |
722
|
|
|
*/ |
723
|
181 |
|
$view->fields = apply_filters( 'gravityview/view/fields', Field_Collection::from_configuration( $configuration ), $view ); |
724
|
|
|
|
725
|
|
|
/** |
726
|
|
|
* @filter `gravityview/view/configuration/widgets` Filter the View widgets' configuration array. |
727
|
|
|
* @since 2.0 |
728
|
|
|
* |
729
|
|
|
* @param array $fields Multi-array of widgets with first level being the field zones. |
730
|
|
|
* @param \GV\View $view The View the widgets are being pulled for. |
731
|
|
|
*/ |
732
|
181 |
|
$configuration = apply_filters( 'gravityview/view/configuration/widgets', (array)$view->_gravityview_directory_widgets, $view ); |
733
|
|
|
|
734
|
|
|
/** |
735
|
|
|
* @filter `gravityview/view/widgets` Filter the Widget Collection for this View. |
736
|
|
|
* @since 2.0 |
737
|
|
|
* |
738
|
|
|
* @param \GV\Widget_Collection $widgets A collection of widgets. |
739
|
|
|
* @param \GV\View $view The View the widgets are being pulled for. |
740
|
|
|
*/ |
741
|
181 |
|
$view->widgets = apply_filters( 'gravityview/view/widgets', Widget_Collection::from_configuration( $configuration ), $view ); |
742
|
|
|
|
743
|
|
|
/** View configuration. */ |
744
|
181 |
|
$view->settings->update( gravityview_get_template_settings( $view->ID ) ); |
|
|
|
|
745
|
|
|
|
746
|
|
|
/** Add the template name into the settings. */ |
747
|
181 |
|
$view->settings->update( array( 'template' => gravityview_get_template_id( $view->ID ) ) ); |
|
|
|
|
748
|
|
|
|
749
|
|
|
/** View basics. */ |
750
|
181 |
|
$view->settings->update( array( |
751
|
181 |
|
'id' => $view->ID, |
|
|
|
|
752
|
|
|
) ); |
753
|
|
|
|
754
|
181 |
|
self::$cache[ "View::from_post:{$post->ID}" ] = &$view; |
755
|
|
|
|
756
|
|
|
/** |
757
|
|
|
* @filter `gravityview/view/get` Override View. |
758
|
|
|
* @param \GV\View $view The View instance pointer. |
759
|
|
|
* @since 2.1 |
760
|
|
|
*/ |
761
|
181 |
|
do_action_ref_array( 'gravityview/view/get', array( &$view ) ); |
762
|
|
|
|
763
|
181 |
|
return $view; |
764
|
|
|
} |
765
|
|
|
|
766
|
|
|
/** |
767
|
|
|
* Flush the view cache. |
768
|
|
|
* |
769
|
|
|
* @param int $view_id The View to reset cache for. Optional. Default: resets everything. |
770
|
|
|
* |
771
|
|
|
* @internal |
772
|
|
|
*/ |
773
|
192 |
|
public static function _flush_cache( $view_id = null ) { |
774
|
192 |
|
if ( $view_id ) { |
|
|
|
|
775
|
186 |
|
unset( self::$cache[ "View::from_post:$view_id" ] ); |
776
|
186 |
|
return; |
777
|
|
|
} |
778
|
97 |
|
self::$cache = array(); |
779
|
97 |
|
} |
780
|
|
|
|
781
|
|
|
/** |
782
|
|
|
* Construct a \GV\View instance from a post ID. |
783
|
|
|
* |
784
|
|
|
* @param int|string $post_id The post ID. |
785
|
|
|
* |
786
|
|
|
* @api |
787
|
|
|
* @since 2.0 |
788
|
|
|
* @return \GV\View|null An instance around this \WP_Post or null if not found. |
789
|
|
|
*/ |
790
|
121 |
|
public static function by_id( $post_id ) { |
791
|
121 |
|
if ( ! $post_id || ! $post = get_post( $post_id ) ) { |
792
|
3 |
|
return null; |
793
|
|
|
} |
794
|
121 |
|
return self::from_post( $post ); |
795
|
|
|
} |
796
|
|
|
|
797
|
|
|
/** |
798
|
|
|
* Determines if a view exists to begin with. |
799
|
|
|
* |
800
|
|
|
* @param int|\WP_Post|null $view The WordPress post ID, a \WP_Post object or null for global $post; |
801
|
|
|
* |
802
|
|
|
* @api |
803
|
|
|
* @since 2.0 |
804
|
|
|
* @return bool Whether the post exists or not. |
805
|
|
|
*/ |
806
|
25 |
|
public static function exists( $view ) { |
807
|
25 |
|
return get_post_type( $view ) == 'gravityview'; |
808
|
|
|
} |
809
|
|
|
|
810
|
|
|
/** |
811
|
|
|
* ArrayAccess compatibility layer with GravityView_View_Data::$views |
812
|
|
|
* |
813
|
|
|
* @internal |
814
|
|
|
* @deprecated |
815
|
|
|
* @since 2.0 |
816
|
|
|
* @return bool Whether the offset exists or not, limited to GravityView_View_Data::$views element keys. |
817
|
|
|
*/ |
818
|
15 |
|
public function offsetExists( $offset ) { |
819
|
15 |
|
$data_keys = array( 'id', 'view_id', 'form_id', 'template_id', 'atts', 'fields', 'widgets', 'form' ); |
820
|
15 |
|
return in_array( $offset, $data_keys ); |
821
|
|
|
} |
822
|
|
|
|
823
|
|
|
/** |
824
|
|
|
* ArrayAccess compatibility layer with GravityView_View_Data::$views |
825
|
|
|
* |
826
|
|
|
* Maps the old keys to the new data; |
827
|
|
|
* |
828
|
|
|
* @internal |
829
|
|
|
* @deprecated |
830
|
|
|
* @since 2.0 |
831
|
|
|
* |
832
|
|
|
* @return mixed The value of the requested view data key limited to GravityView_View_Data::$views element keys. If offset not found, return null. |
833
|
|
|
*/ |
834
|
15 |
|
public function offsetGet( $offset ) { |
835
|
|
|
|
836
|
15 |
|
gravityview()->log->notice( 'This is a \GV\View object should not be accessed as an array.' ); |
837
|
|
|
|
838
|
15 |
|
if ( ! isset( $this[ $offset ] ) ) { |
839
|
|
|
return null; |
840
|
|
|
} |
841
|
|
|
|
842
|
15 |
|
switch ( $offset ) { |
843
|
15 |
|
case 'id': |
844
|
15 |
|
case 'view_id': |
845
|
1 |
|
return $this->ID; |
|
|
|
|
846
|
15 |
|
case 'form': |
847
|
15 |
|
return $this->form; |
848
|
1 |
|
case 'form_id': |
849
|
1 |
|
return $this->form ? $this->form->ID : null; |
850
|
1 |
|
case 'atts': |
851
|
|
|
return $this->settings->as_atts(); |
|
|
|
|
852
|
1 |
|
case 'template_id': |
853
|
1 |
|
return $this->settings->get( 'template' ); |
854
|
|
|
case 'widgets': |
855
|
|
|
return $this->widgets->as_configuration(); |
856
|
|
|
} |
857
|
|
|
|
858
|
|
|
return null; |
859
|
|
|
} |
860
|
|
|
|
861
|
|
|
/** |
862
|
|
|
* ArrayAccess compatibility layer with GravityView_View_Data::$views |
863
|
|
|
* |
864
|
|
|
* @internal |
865
|
|
|
* @deprecated |
866
|
|
|
* @since 2.0 |
867
|
|
|
* |
868
|
|
|
* @return void |
869
|
|
|
*/ |
870
|
1 |
|
public function offsetSet( $offset, $value ) { |
871
|
1 |
|
gravityview()->log->error( 'The old view data is no longer mutable. This is a \GV\View object should not be accessed as an array.' ); |
872
|
1 |
|
} |
873
|
|
|
|
874
|
|
|
/** |
875
|
|
|
* ArrayAccess compatibility layer with GravityView_View_Data::$views |
876
|
|
|
* |
877
|
|
|
* @internal |
878
|
|
|
* @deprecated |
879
|
|
|
* @since 2.0 |
880
|
|
|
* @return void |
881
|
|
|
*/ |
882
|
1 |
|
public function offsetUnset( $offset ) { |
883
|
1 |
|
gravityview()->log->error( 'The old view data is no longer mutable. This is a \GV\View object should not be accessed as an array.' ); |
884
|
1 |
|
} |
885
|
|
|
|
886
|
|
|
/** |
887
|
|
|
* Be compatible with the old data object. |
888
|
|
|
* |
889
|
|
|
* Some external code expects an array (doing things like foreach on this, or array_keys) |
890
|
|
|
* so let's return an array in the old format for such cases. Do not use unless using |
891
|
|
|
* for back-compatibility. |
892
|
|
|
* |
893
|
|
|
* @internal |
894
|
|
|
* @deprecated |
895
|
|
|
* @since 2.0 |
896
|
|
|
* @return array |
897
|
|
|
*/ |
898
|
28 |
|
public function as_data() { |
899
|
|
|
return array( |
900
|
28 |
|
'id' => $this->ID, |
|
|
|
|
901
|
28 |
|
'view_id' => $this->ID, |
|
|
|
|
902
|
28 |
|
'form_id' => $this->form ? $this->form->ID : null, |
903
|
28 |
|
'form' => $this->form ? gravityview_get_form( $this->form->ID ) : null, |
904
|
28 |
|
'atts' => $this->settings->as_atts(), |
|
|
|
|
905
|
28 |
|
'fields' => $this->fields->by_visible( $this )->as_configuration(), |
906
|
28 |
|
'template_id' => $this->settings->get( 'template' ), |
907
|
28 |
|
'widgets' => $this->widgets->as_configuration(), |
908
|
|
|
); |
909
|
|
|
} |
910
|
|
|
|
911
|
|
|
/** |
912
|
|
|
* Retrieve the entries for the current view and request. |
913
|
|
|
* |
914
|
|
|
* @param \GV\Request The request. Unused for now. |
915
|
|
|
* |
916
|
|
|
* @return \GV\Entry_Collection The entries. |
917
|
|
|
*/ |
918
|
72 |
|
public function get_entries( $request = null ) { |
919
|
72 |
|
$entries = new \GV\Entry_Collection(); |
920
|
|
|
|
921
|
72 |
|
if ( $this->form ) { |
922
|
72 |
|
$parameters = $this->settings->as_atts(); |
|
|
|
|
923
|
|
|
|
924
|
|
|
/** |
925
|
|
|
* Remove multiple sorting before calling legacy filters. |
926
|
|
|
* This allows us to fake it till we make it. |
927
|
|
|
*/ |
928
|
72 |
|
if ( ! empty( $parameters['sort_field'] ) && is_array( $parameters['sort_field'] ) ) { |
929
|
2 |
|
$parameters['sort_field'] = reset( $parameters['sort_field'] ); |
930
|
2 |
|
if ( ! empty( $parameters['sort_direction'] ) && is_array( $parameters['sort_direction'] ) ) { |
931
|
2 |
|
$parameters['sort_direction'] = reset( $parameters['sort_direction'] ); |
932
|
|
|
} |
933
|
|
|
} |
934
|
|
|
|
935
|
|
|
/** |
936
|
|
|
* @todo: Stop using _frontend and use something like $request->get_search_criteria() instead |
937
|
|
|
*/ |
938
|
72 |
|
$parameters = \GravityView_frontend::get_view_entries_parameters( $parameters, $this->form->ID ); |
939
|
|
|
|
940
|
72 |
|
$parameters['context_view_id'] = $this->ID; |
|
|
|
|
941
|
72 |
|
$parameters = \GVCommon::calculate_get_entries_criteria( $parameters, $this->form->ID ); |
942
|
|
|
|
943
|
72 |
|
if ( ! is_array( $parameters ) ) { |
944
|
|
|
$parameters = array(); |
945
|
|
|
} |
946
|
|
|
|
947
|
72 |
|
if ( ! is_array( $parameters['search_criteria'] ) ) { |
948
|
|
|
$parameters['search_criteria'] = array(); |
949
|
|
|
} |
950
|
|
|
|
951
|
72 |
|
if ( ( ! isset( $parameters['search_criteria']['field_filters'] ) ) || ( ! is_array( $parameters['search_criteria']['field_filters'] ) ) ) { |
952
|
|
|
$parameters['search_criteria']['field_filters'] = array(); |
953
|
|
|
} |
954
|
|
|
|
955
|
72 |
|
if ( $request instanceof REST\Request ) { |
956
|
6 |
|
$atts = $this->settings->as_atts(); |
|
|
|
|
957
|
6 |
|
$paging_parameters = wp_parse_args( $request->get_paging(), array( |
958
|
6 |
|
'paging' => array( 'page_size' => $atts['page_size'] ), |
959
|
|
|
) ); |
960
|
6 |
|
$parameters['paging'] = $paging_parameters['paging']; |
961
|
|
|
} |
962
|
|
|
|
963
|
72 |
|
$page = Utils::get( $parameters['paging'], 'current_page' ) ? |
964
|
72 |
|
: ( ( ( $parameters['paging']['offset'] - $this->settings->get( 'offset' ) ) / \GV\Utils::get( $parameters, 'paging/page_size', 25 ) ) + 1 ); |
965
|
|
|
|
966
|
|
|
/** |
967
|
|
|
* Cleanup duplicate field_filter parameters to simplify the query. |
968
|
|
|
*/ |
969
|
72 |
|
$unique_field_filters = array(); |
970
|
72 |
|
foreach ( Utils::get( $parameters, 'search_criteria/field_filters', array() ) as $key => $filter ) { |
971
|
15 |
|
if ( 'mode' === $key ) { |
972
|
14 |
|
$unique_field_filters['mode'] = $filter; |
973
|
15 |
|
} else if ( ! in_array( $filter, $unique_field_filters ) ) { |
974
|
15 |
|
$unique_field_filters[] = $filter; |
975
|
|
|
} |
976
|
|
|
} |
977
|
72 |
|
$parameters['search_criteria']['field_filters'] = $unique_field_filters; |
978
|
|
|
|
979
|
72 |
|
if ( ! empty( $parameters['search_criteria']['field_filters'] ) ) { |
980
|
15 |
|
gravityview()->log->notice( 'search_criteria/field_filters is not empty, third-party code may be using legacy search_criteria filters.' ); |
981
|
|
|
} |
982
|
|
|
|
983
|
72 |
|
$entries = $this->form->get_entries( $this ) |
984
|
72 |
|
->filter( \GV\GF_Entry_Filter::from_search_criteria( $parameters['search_criteria'] ) ) |
985
|
72 |
|
->offset( $this->settings->get( 'offset' ) ) |
986
|
72 |
|
->limit( $parameters['paging']['page_size'] ) |
987
|
72 |
|
->page( $page ); |
988
|
|
|
|
989
|
|
|
|
990
|
72 |
|
if ( ! empty( $parameters['sorting'] ) && ! empty( $parameters['sorting']['key'] ) ) { |
991
|
8 |
|
$field = new \GV\Field(); |
992
|
8 |
|
$field->ID = $parameters['sorting']['key']; |
993
|
8 |
|
$direction = strtolower( $parameters['sorting']['direction'] ) == 'asc' ? \GV\Entry_Sort::ASC : \GV\Entry_Sort::DESC; |
994
|
8 |
|
$entries = $entries->sort( new \GV\Entry_Sort( $field, $direction ) ); |
995
|
|
|
} |
996
|
|
|
} |
997
|
|
|
|
998
|
|
|
/** |
999
|
|
|
* @filter `gravityview/view/entries` Modify the entry fetching filters, sorts, offsets, limits. |
1000
|
|
|
* @param \GV\Entry_Collection $entries The entries for this view. |
1001
|
|
|
* @param \GV\View $view The view. |
1002
|
|
|
* @param \GV\Request $request The request. |
1003
|
|
|
*/ |
1004
|
72 |
|
return apply_filters( 'gravityview/view/entries', $entries, $this, $request ); |
1005
|
|
|
} |
1006
|
|
|
|
1007
|
|
|
/** |
1008
|
|
|
* Last chance to configure the output. |
1009
|
|
|
* |
1010
|
|
|
* Used for CSV output, for example. |
1011
|
|
|
* |
1012
|
|
|
* @return void |
1013
|
|
|
*/ |
1014
|
7 |
|
public static function template_redirect() { |
1015
|
|
|
/** |
1016
|
|
|
* CSV output. |
1017
|
|
|
*/ |
1018
|
7 |
|
if ( ! get_query_var( 'csv' ) ) { |
1019
|
1 |
|
return; |
1020
|
|
|
} |
1021
|
|
|
|
1022
|
7 |
|
if ( ! $view = gravityview()->request->is_view() ) { |
1023
|
1 |
|
return; |
1024
|
|
|
} |
1025
|
|
|
|
1026
|
7 |
|
if ( is_wp_error( $error = $view->can_render( array( 'csv' ) ) ) ) { |
1027
|
1 |
|
gravityview()->log->error( 'Not rendering CSV: ' . $error->get_error_message() ); |
1028
|
1 |
|
return; |
1029
|
|
|
} |
1030
|
|
|
|
1031
|
|
|
/** |
1032
|
|
|
* Modify the name of the generated CSV file. Name will be sanitized using sanitize_file_name() before output. |
1033
|
|
|
* @see sanitize_file_name() |
1034
|
|
|
* @since 2.1 |
1035
|
|
|
* @param string $filename File name used when downloading a CSV. Default is "{View title}.csv" |
1036
|
|
|
* @param \GV\View $view Current View being rendered |
1037
|
|
|
*/ |
1038
|
7 |
|
$filename = apply_filters( 'gravityview/output/csv/filename', get_the_title( $view->post ), $view ); |
1039
|
|
|
|
1040
|
7 |
|
if ( ! defined( 'DOING_GRAVITYVIEW_TESTS' ) ) { |
1041
|
|
|
header( sprintf( 'Content-Disposition: attachment;filename="%s.csv"', sanitize_file_name( $filename ) ) ); |
1042
|
|
|
header( 'Content-Transfer-Encoding: binary' ); |
1043
|
|
|
header( 'Content-Type: text/csv' ); |
1044
|
|
|
} |
1045
|
|
|
|
1046
|
7 |
|
ob_start(); |
1047
|
7 |
|
$csv = fopen( 'php://output', 'w' ); |
1048
|
|
|
|
1049
|
|
|
/** |
1050
|
|
|
* Add da' BOM if GF uses it |
1051
|
|
|
* @see GFExport::start_export() |
1052
|
|
|
*/ |
1053
|
7 |
|
if ( apply_filters( 'gform_include_bom_export_entries', true, $view->form ? $view->form->form : null ) ) { |
1054
|
|
|
fputs( $csv, "\xef\xbb\xbf" ); |
1055
|
|
|
} |
1056
|
|
|
|
1057
|
7 |
|
if ( $view->settings->get( 'csv_nolimit' ) ) { |
1058
|
1 |
|
$view->settings->update( array( 'page_size' => -1 ) ); |
1059
|
|
|
} |
1060
|
|
|
|
1061
|
7 |
|
$entries = $view->get_entries(); |
1062
|
|
|
|
1063
|
7 |
|
$headers_done = false; |
1064
|
7 |
|
$allowed = $headers = array(); |
1065
|
|
|
|
1066
|
7 |
|
foreach ( $view->fields->by_position( "directory_*" )->by_visible( $view )->all() as $id => $field ) { |
1067
|
7 |
|
$allowed[] = $field; |
1068
|
|
|
} |
1069
|
|
|
|
1070
|
7 |
|
$renderer = new Field_Renderer(); |
1071
|
|
|
|
1072
|
7 |
|
foreach ( $entries->all() as $entry ) { |
1073
|
|
|
|
1074
|
7 |
|
$return = array(); |
1075
|
|
|
|
1076
|
|
|
/** |
1077
|
|
|
* @filter `gravityview/csv/entry/fields` Whitelist more entry fields by ID that are output in CSV requests. |
1078
|
|
|
* @param[in,out] array $allowed The allowed ones, default by_visible, by_position( "context_*" ), i.e. as set in the View. |
1079
|
|
|
* @param \GV\View $view The view. |
1080
|
|
|
* @param \GV\Entry $entry WordPress representation of the item. |
1081
|
|
|
*/ |
1082
|
7 |
|
$allowed_field_ids = apply_filters( 'gravityview/csv/entry/fields', wp_list_pluck( $allowed, 'ID' ), $view, $entry ); |
1083
|
|
|
|
1084
|
7 |
|
$allowed = array_filter( $allowed, function( $field ) use ( $allowed_field_ids ) { |
1085
|
7 |
|
return in_array( $field->ID, $allowed_field_ids, true ); |
1086
|
7 |
|
} ); |
1087
|
|
|
|
1088
|
7 |
|
foreach ( array_diff( $allowed_field_ids, wp_list_pluck( $allowed, 'ID' ) ) as $field_id ) { |
1089
|
|
|
$allowed[] = is_numeric( $field_id ) ? \GV\GF_Field::by_id( $view->form, $field_id ) : \GV\Internal_Field::by_id( $field_id ); |
1090
|
|
|
} |
1091
|
|
|
|
1092
|
7 |
|
foreach ( $allowed as $field ) { |
1093
|
7 |
|
$source = is_numeric( $field->ID ) ? $view->form : new \GV\Internal_Source(); |
1094
|
|
|
|
1095
|
7 |
|
$return[] = $renderer->render( $field, $view, $source, $entry, gravityview()->request, '\GV\Field_CSV_Template' ); |
1096
|
|
|
|
1097
|
7 |
|
if ( ! $headers_done ) { |
|
|
|
|
1098
|
7 |
|
$label = $field->get_label( $view, $source, $entry ); |
1099
|
7 |
|
$headers[] = $label ? $label : $field->ID; |
1100
|
|
|
} |
1101
|
|
|
} |
1102
|
|
|
|
1103
|
7 |
|
if ( ! $headers_done ) { |
|
|
|
|
1104
|
7 |
|
$headers_done = fputcsv( $csv, array_map( array( '\GV\Utils', 'strip_excel_formulas' ), array_values( $headers ) ) ); |
1105
|
|
|
} |
1106
|
|
|
|
1107
|
7 |
|
fputcsv( $csv, array_map( array( '\GV\Utils', 'strip_excel_formulas' ), $return ) ); |
1108
|
|
|
} |
1109
|
|
|
|
1110
|
7 |
|
fflush( $csv ); |
1111
|
|
|
|
1112
|
7 |
|
echo rtrim( ob_get_clean() ); |
1113
|
|
|
|
1114
|
7 |
|
if ( ! defined( 'DOING_GRAVITYVIEW_TESTS' ) ) { |
1115
|
|
|
exit; |
1116
|
|
|
} |
1117
|
7 |
|
} |
1118
|
|
|
|
1119
|
|
|
/** |
1120
|
|
|
* Restrict View access to specific capabilities. |
1121
|
|
|
* |
1122
|
|
|
* Hooked into `map_meta_cap` WordPress filter. |
1123
|
|
|
* |
1124
|
|
|
* @since develop |
1125
|
|
|
* |
1126
|
|
|
* @param $caps array The output capabilities. |
1127
|
|
|
* @param $cap string The cap that is being checked. |
1128
|
|
|
* @param $user_id int The User ID. |
1129
|
|
|
* @param $args array Additional arguments to the capability. |
1130
|
|
|
* |
1131
|
|
|
* @return array The resulting capabilities. |
1132
|
|
|
*/ |
1133
|
61 |
|
public static function restrict( $caps, $cap, $user_id, $args ) { |
1134
|
|
|
/** |
1135
|
|
|
* @filter `gravityview/security/require_unfiltered_html` Bypass restrictions on Views that require `unfiltered_html`. |
1136
|
|
|
* @param[in,out] boolean |
1137
|
|
|
* |
1138
|
|
|
* @since develop |
1139
|
|
|
* @param string $cap The capability requested. |
1140
|
|
|
* @param int $user_id The user ID. |
1141
|
|
|
* @param array $args Any additional args to map_meta_cap |
1142
|
|
|
*/ |
1143
|
61 |
|
if ( ! apply_filters( 'gravityview/security/require_unfiltered_html', true, $cap, $user_id ) ) { |
1144
|
1 |
|
return $caps; |
1145
|
|
|
} |
1146
|
|
|
|
1147
|
61 |
|
switch ( $cap ): |
1148
|
61 |
|
case 'edit_gravityview': |
1149
|
61 |
|
case 'edit_gravityviews': |
1150
|
61 |
|
case 'edit_others_gravityviews': |
1151
|
61 |
|
case 'edit_private_gravityviews': |
1152
|
61 |
|
case 'edit_published_gravityviews': |
1153
|
8 |
|
if ( ! user_can( $user_id, 'unfiltered_html' ) ) { |
1154
|
5 |
|
if ( ! user_can( $user_id, 'gravityview_full_access' ) ) { |
1155
|
5 |
|
return array( 'do_not_allow' ); |
1156
|
|
|
} |
1157
|
|
|
} |
1158
|
|
|
|
1159
|
8 |
|
return $caps; |
1160
|
61 |
|
case 'edit_post': |
1161
|
8 |
|
if ( get_post_type( array_pop( $args ) ) == 'gravityview' ) { |
1162
|
7 |
|
return self::restrict( $caps, 'edit_gravityview', $user_id, $args ); |
1163
|
|
|
} |
1164
|
|
|
endswitch; |
1165
|
|
|
|
1166
|
61 |
|
return $caps; |
1167
|
|
|
} |
1168
|
|
|
|
1169
|
180 |
|
public function __get( $key ) { |
1170
|
180 |
|
if ( $this->post ) { |
1171
|
180 |
|
$raw_post = $this->post->filter( 'raw' ); |
1172
|
180 |
|
return $raw_post->{$key}; |
1173
|
|
|
} |
1174
|
|
|
return isset( $this->{$key} ) ? $this->{$key} : null; |
1175
|
|
|
} |
1176
|
|
|
} |
1177
|
|
|
|
The break statement is not necessary if it is preceded for example by a return statement:
If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.