Completed
Push — develop ( 15bf3f...b9d547 )
by Gennady
37:35
created

View::from_post()   B

Complexity

Conditions 6
Paths 4

Size

Total Lines 101

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 24
CRAP Score 6.0493

Importance

Changes 0
Metric Value
cc 6
nc 4
nop 1
dl 0
loc 101
ccs 24
cts 27
cp 0.8889
crap 6.0493
rs 7.3777
c 0
b 0
f 0

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 17 and the first side effect is on line 6.

The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.

The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.

To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.

Loading history...
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 future
75
	 */
76
	public $joins = array();
77
78
	/**
79
	 * The constructor.
80
	 */
81 84
	public function __construct() {
82 84
		$this->settings = new View_Settings();
83 84
		$this->fields = new Field_Collection();
84 84
		$this->widgets = new Widget_Collection();
85 84
	}
86
87
	/**
88
	 * Register the gravityview WordPress Custom Post Type.
89
	 *
90
	 * @internal
91
	 * @return void
92
	 */
93
	public static function register_post_type() {
94
95
		/** Register only once */
96
		if ( post_type_exists( 'gravityview' ) ) {
97
			return;
98
		}
99
100
		/**
101
		 * @filter `gravityview_is_hierarchical` Make GravityView Views hierarchical by returning TRUE
102
		 * This will allow for Views to be nested with Parents and also allows for menu order to be set in the Page Attributes metabox
103
		 * @since 1.13
104
		 * @param boolean $is_hierarchical Default: false
105
		 */
106
		$is_hierarchical = (bool)apply_filters( 'gravityview_is_hierarchical', false );
0 ignored issues
show
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
107
108
		$supports = array( 'title', 'revisions' );
109
110
		if ( $is_hierarchical ) {
111
			$supports[] = 'page-attributes';
112
		}
113
114
		/**
115
		 * @filter  `gravityview_post_type_supports` Modify post type support values for `gravityview` post type
116
		 * @see add_post_type_support()
117
		 * @since 1.15.2
118
		 * @param array $supports Array of features associated with a functional area of the edit screen. Default: 'title', 'revisions'. If $is_hierarchical, also 'page-attributes'
119
		 * @param[in] boolean $is_hierarchical Do Views support parent/child relationships? See `gravityview_is_hierarchical` filter.
120
		 */
121
		$supports = apply_filters( 'gravityview_post_type_support', $supports, $is_hierarchical );
122
123
		/** Register Custom Post Type - gravityview */
124
		$labels = array(
125
			'name'                => _x( 'Views', 'Post Type General Name', 'gravityview' ),
126
			'singular_name'       => _x( 'View', 'Post Type Singular Name', 'gravityview' ),
127
			'menu_name'           => _x( 'Views', 'Menu name', 'gravityview' ),
128
			'parent_item_colon'   => __( 'Parent View:', 'gravityview' ),
129
			'all_items'           => __( 'All Views', 'gravityview' ),
130
			'view_item'           => _x( 'View', 'View Item', 'gravityview' ),
131
			'add_new_item'        => __( 'Add New View', 'gravityview' ),
132
			'add_new'             => __( 'New View', 'gravityview' ),
133
			'edit_item'           => __( 'Edit View', 'gravityview' ),
134
			'update_item'         => __( 'Update View', 'gravityview' ),
135
			'search_items'        => __( 'Search Views', 'gravityview' ),
136
			'not_found'           => \GravityView_Admin::no_views_text(),
137
			'not_found_in_trash'  => __( 'No Views found in Trash', 'gravityview' ),
138
			'filter_items_list'     => __( 'Filter Views list', 'gravityview' ),
139
			'items_list_navigation' => __( 'Views list navigation', 'gravityview' ),
140
			'items_list'            => __( 'Views list', 'gravityview' ),
141
			'view_items'            => __( 'See Views', 'gravityview' ),
142
			'attributes'            => __( 'View Attributes', 'gravityview' ),
143
		);
144
		$args = array(
145
			'label'               => __( 'view', 'gravityview' ),
146
			'description'         => __( 'Create views based on a Gravity Forms form', 'gravityview' ),
147
			'labels'              => $labels,
148
			'supports'            => $supports,
149
			'hierarchical'        => $is_hierarchical,
150
			/**
151
			 * @filter `gravityview_direct_access` Should Views be directly accessible, or only visible using the shortcode?
152
			 * @see https://codex.wordpress.org/Function_Reference/register_post_type#public
153
			 * @since 1.15.2
154
			 * @param[in,out] boolean `true`: allow Views to be accessible directly. `false`: Only allow Views to be embedded via shortcode. Default: `true`
155
			 * @param int $view_id The ID of the View currently being requested. `0` for general setting
156
			 */
157
			'public'              => apply_filters( 'gravityview_direct_access', gravityview()->plugin->is_compatible(), 0 ),
158
			'show_ui'             => gravityview()->plugin->is_compatible(),
159
			'show_in_menu'        => gravityview()->plugin->is_compatible(),
160
			'show_in_nav_menus'   => true,
161
			'show_in_admin_bar'   => true,
162
			'menu_position'       => 17,
163
			'menu_icon'           => '',
164
			'can_export'          => true,
165
			/**
166
			 * @filter `gravityview_has_archive` Enable Custom Post Type archive?
167
			 * @since 1.7.3
168
			 * @param boolean False: don't have frontend archive; True: yes, have archive. Default: false
169
			 */
170
			'has_archive'         => apply_filters( 'gravityview_has_archive', false ),
171
			'exclude_from_search' => true,
172
			'rewrite'             => array(
173
				/**
174
				 * @filter `gravityview_slug` Modify the url part for a View.
175
				 * @see https://docs.gravityview.co/article/62-changing-the-view-slug
176
				 * @param string $slug The slug shown in the URL
177
				 */
178
				'slug' => apply_filters( 'gravityview_slug', 'view' ),
179
180
				/**
181
				 * @filter `gravityview/post_type/with_front` Should the permalink structure
182
				 *  be prepended with the front base.
183
				 *  (example: if your permalink structure is /blog/, then your links will be: false->/view/, true->/blog/view/).
184
				 *  Defaults to true.
185
				 * @see https://codex.wordpress.org/Function_Reference/register_post_type
186
				 * @since 2.0
187
				 * @param bool $with_front
188
				 */
189
				'with_front' => apply_filters( 'gravityview/post_type/with_front', true ),
190
			),
191
			'capability_type'     => 'gravityview',
192
			'map_meta_cap'        => true,
193
		);
194
195
		register_post_type( 'gravityview', $args );
196
	}
197
198
	/**
199
	 * Add extra rewrite endpoints.
200
	 *
201
	 * @return void
202
	 */
203 1
	public static function add_rewrite_endpoint() {
204
		/**
205
		 * CSV.
206
		 */
207
		global $wp_rewrite;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
208
209
		$slug = apply_filters( 'gravityview_slug', 'view' );
210
		$rule = array( sprintf( '%s/([^/]+)/csv/?', $slug ), 'index.php?gravityview=$matches[1]&csv=1', 'top' );
211
212 1
		add_filter( 'query_vars', function( $query_vars ) { 
213 1
			$query_vars[] = 'csv';
214 1
			return $query_vars;
215
		} );
216
217
		if ( ! isset( $wp_rewrite->extra_rules_top[ $rule[0] ] ) ) {
218
			call_user_func_array( 'add_rewrite_rule', $rule );
219
		}
220
	}
221
222
	/**
223
	 * A renderer filter for the View post type content.
224
	 *
225
	 * @param string $content Should be empty, as we don't store anything there.
226
	 *
227
	 * @return string $content The view content as output by the renderers.
228
	 */
229 10
	public static function content( $content ) {
230 10
		$request = gravityview()->request;
231
232
		// Plugins may run through the content in the header. WP SEO does this for its OpenGraph functionality.
233 10
		if ( ! defined( 'DOING_GRAVITYVIEW_TESTS' ) ) {
234
			if ( ! did_action( 'loop_start' ) ) {
235
				gravityview()->log->debug( 'Not processing yet: loop_start hasn\'t run yet. Current action: {action}', array( 'action' => current_filter() ) );
236
				return $content;
237
			}
238
239
			//	We don't want this filter to run infinite loop on any post content fields
240
			remove_filter( 'the_content', array( __CLASS__, __METHOD__ ) );
241
		}
242
243
		/**
244
		 * This is not a View. Bail.
245
		 *
246
		 * Shortcodes and oEmbeds and whatnot will be handled
247
		 *  elsewhere.
248
		 */
249 10
		if ( ! $view = $request->is_view() ) {
250 5
			return $content;
251
		}
252
253
		/**
254
		 * Check permissions.
255
		 */
256 5
		while ( $error = $view->can_render( null, $request ) ) {
257 5
			if ( ! is_wp_error( $error ) )
0 ignored issues
show
Coding Style Best Practice introduced by
It is generally a best practice to always use braces with control structures.

Adding braces to control structures avoids accidental mistakes as your code changes:

// Without braces (not recommended)
if (true)
    doSomething();

// Recommended
if (true) {
    doSomething();
}
Loading history...
258 5
				break;
259
260 1
			switch ( str_replace( 'gravityview/', '', $error->get_error_code() ) ) {
261 1
				case 'post_password_required':
262 1
					return get_the_password_form( $view->ID );
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
263 1
				case 'no_form_attached':
264
265
					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() ) );
266
267
					/**
268
					 * This View has no data source. There's nothing to show really.
269
					 * ...apart from a nice message if the user can do anything about it.
270
					 */
271
					if ( \GVCommon::has_cap( array( 'edit_gravityviews', 'edit_gravityview' ), $view->ID ) ) {
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
272
						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' );
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'sprintf'
Loading history...
273
					}
274
					break;
275 1
				case 'no_direct_access':
276 1
				case 'embed_only':
277 1
				case 'not_public':
278
				default:
279 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() ) );
280 1
					return __( 'You are not allowed to view this content.', 'gravityview' );
281
			}
282
283
			return $content;
284
		}
285
286 5
		$is_admin_and_can_view = $view->settings->get( 'admin_show_all_statuses' ) && \GVCommon::has_cap('gravityview_moderate_entries', $view->ID );
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
287
288
		/**
289
		 * Editing a single entry.
290
		 */
291 5
		if ( $entry = $request->is_edit_entry() ) {
292
			if ( $entry['status'] != 'active' ) {
0 ignored issues
show
introduced by
Found "!= '". Use Yoda Condition checks, you must
Loading history...
293
				gravityview()->log->notice( 'Entry ID #{entry_id} is not active', array( 'entry_id' => $entry->ID ) );
294
				return __( 'You are not allowed to view this content.', 'gravityview' );
295
			}
296
297
			if ( apply_filters( 'gravityview_custom_entry_slug', false ) && $entry->slug != get_query_var( \GV\Entry::get_endpoint_name() ) ) {
298
				gravityview()->log->error( 'Entry ID #{entry_id} was accessed by a bad slug', array( 'entry_id' => $entry->ID ) );
299
				return __( 'You are not allowed to view this content.', 'gravityview' );
300
			}
301
302
			if ( $view->settings->get( 'show_only_approved' ) && ! $is_admin_and_can_view ) {
303
				if ( ! \GravityView_Entry_Approval_Status::is_approved( gform_get_meta( $entry->ID, \GravityView_Entry_Approval::meta_key ) )  ) {
304
					gravityview()->log->error( 'Entry ID #{entry_id} is not approved for viewing', array( 'entry_id' => $entry->ID ) );
305
					return __( 'You are not allowed to view this content.', 'gravityview' );
306
				}
307
			}
308
309
			$renderer = new Edit_Entry_Renderer();
310
			return $renderer->render( $entry, $view, $request );
311
312
		/**
313
		 * Viewing a single entry.
314
		 */
315 5
		} else if ( $entry = $request->is_entry() ) {
316 1
			if ( $entry['status'] != 'active' ) {
0 ignored issues
show
introduced by
Found "!= '". Use Yoda Condition checks, you must
Loading history...
317 1
				gravityview()->log->notice( 'Entry ID #{entry_id} is not active', array( 'entry_id' => $entry->ID ) );
318 1
				return __( 'You are not allowed to view this content.', 'gravityview' );
319
			}
320
321 1
			if ( apply_filters( 'gravityview_custom_entry_slug', false ) && $entry->slug != get_query_var( \GV\Entry::get_endpoint_name() ) ) {
322 1
				gravityview()->log->error( 'Entry ID #{entry_id} was accessed by a bad slug', array( 'entry_id' => $entry->ID ) );
323 1
				return __( 'You are not allowed to view this content.', 'gravityview' );
324
			}
325
326 1
			if ( $view->settings->get( 'show_only_approved' ) && ! $is_admin_and_can_view ) {
327 1
				if ( ! \GravityView_Entry_Approval_Status::is_approved( gform_get_meta( $entry->ID, \GravityView_Entry_Approval::meta_key ) )  ) {
328 1
					gravityview()->log->error( 'Entry ID #{entry_id} is not approved for viewing', array( 'entry_id' => $entry->ID ) );
329 1
					return __( 'You are not allowed to view this content.', 'gravityview' );
330
				}
331
			}
332
333 1
			$error = \GVCommon::check_entry_display( $entry->as_entry(), $view );
334
335 1
			if( is_wp_error( $error ) ) {
336
				gravityview()->log->error( 'Entry ID #{entry_id} is not approved for viewing: {message}', array( 'entry_id' => $entry->ID, 'message' => $error->get_error_message() ) );
337
				return __( 'You are not allowed to view this content.', 'gravityview' );
338
			}
339
340 1
			$renderer = new Entry_Renderer();
341 1
			return $renderer->render( $entry, $view, $request );
342
343
		/**
344
		 * Plain old View.
345
		 */
346
		} else {
347 4
			$renderer = new View_Renderer();
348 4
			return $renderer->render( $view, $request );
349
		}
350
351
		return $content;
0 ignored issues
show
Unused Code introduced by
return $content; does not seem to be reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
352
	}
353
354
	/**
355
	 * Checks whether this view can be accessed or not.
356
	 *
357
	 * @param string[]    $context The context we're asking for access from.
358
	 *                             Can any and as many of one of:
359
	 *                                 edit      An edit context.
360
	 *                                 single    A single context.
361
	 *                                 cpt       The custom post type single page acessed.
362
	 *                                 shortcode Embedded as a shortcode.
363
	 *                                 oembed    Embedded as an oEmbed.
364
	 *                                 rest      A REST call.
365
	 * @param \GV\Request $request The request
366
	 *
367
	 * @return bool|\WP_Error An error if this View shouldn't be rendered here.
368
	 */
369 19
	public function can_render( $context = null, $request = null ) {
370 19
		if ( ! $request ) {
371 1
			$request = gravityview()->request;
372
		}
373
374 19
		if ( ! is_array( $context ) ) {
375 5
			$context = array();
376
		}
377
378
		/**
379
		 * @filter `gravityview/view/can_render` Whether the view can be rendered or not.
380
		 * @param bool|\WP_Error $result  The result. Default: null.
381
		 * @param \GV\View       $view	The view.
382
		 * @param string[]       $context See \GV\View::can_render
383
		 * @param \GV\Request    $request The request.
384
		 */
385 19
		if ( ! is_null( $result = apply_filters( 'gravityview/view/can_render', null, $this, $context, $request ) ) ) {
386
			return $result;
387
		}
388
389 19
		if ( in_array( 'rest', $context ) ) {
390
			// REST
391 6
			if ( gravityview()->plugin->settings->get( 'rest_api' ) === '1' && $this->settings->get( 'rest_disable' ) === '1' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
392 1
				return new \WP_Error( 'gravityview/rest_disabled' );
393 6
			} elseif ( gravityview()->plugin->settings->get( 'rest_api' ) !== '1' && $this->settings->get( 'rest_enable' ) !== '1' ) {
0 ignored issues
show
introduced by
Found "!== '". Use Yoda Condition checks, you must
Loading history...
394 1
				return new \WP_Error( 'gravityview/rest_disabled' );
395
			}
396
		}
397
398 19
		if ( in_array( 'csv', $context ) ) {
399 1
			if ( $this->settings->get( 'csv_enable' ) !== '1' ) {
0 ignored issues
show
introduced by
Found "!== '". Use Yoda Condition checks, you must
Loading history...
400 1
				return new \WP_Error( 'gravityview/csv_disabled', 'The CSV endpoint is not enabled for this View' );
401
			}
402
		}
403
404
		/**
405
		 * This View is password protected. Nothing to do here.
406
		 */
407 19
		if ( post_password_required( $this->ID ) ) {
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
408 3
			gravityview()->log->notice( 'Post password is required for View #{view_id}', array( 'view_id' => $this->ID ) );
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
409 3
			return new \WP_Error( 'gravityview/post_password_required' );
410
		}
411
412 19
		if ( ! $this->form ) {
413
			gravityview()->log->notice( 'View #{id} has no form attached to it.', array( 'id' => $this->ID ) );
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
414
			return new \WP_Error( 'gravityview/no_form_attached' );
415
		}
416
417 19
		if ( ! in_array( 'shortcode', $context ) ) {
418
			/**
419
			 * Is this View directly accessible via a post URL?
420
			 *
421
			 * @see https://codex.wordpress.org/Function_Reference/register_post_type#public
422
			 */
423
424
			/**
425
			 * @filter `gravityview_direct_access` Should Views be directly accessible, or only visible using the shortcode?
426
			 * @deprecated
427
			 * @param[in,out] boolean `true`: allow Views to be accessible directly. `false`: Only allow Views to be embedded. Default: `true`
428
			 * @param int $view_id The ID of the View currently being requested. `0` for general setting
429
			 */
430 12
			$direct_access = apply_filters( 'gravityview_direct_access', true, $this->ID );
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
431
432
			/**
433
			 * @filter `gravityview/request/output/direct` Should this View be directly accessbile?
434
			 * @since 2.0
435
			 * @param[in,out] boolean Accessible or not. Default: accessbile.
436
			 * @param \GV\View $view The View we're trying to directly render here.
437
			 * @param \GV\Request $request The current request.
438
			 */
439 12
			if ( ! apply_filters( 'gravityview/view/output/direct', $direct_access, $this, $request ) ) {
440
				return new \WP_Error( 'gravityview/no_direct_access' );
441
			}
442
443
			/**
444
			 * Is this View an embed-only View? If so, don't allow rendering here,
445
			 *  as this is a direct request.
446
			 */
447 12
			if ( $this->settings->get( 'embed_only' ) && ! \GVCommon::has_cap( 'read_private_gravityviews' ) ) {
448 1
				return new \WP_Error( 'gravityview/embed_only' );
449
			}
450
		}
451
452
		/** Private, pending, draft, etc. */
453 19
		$public_states = get_post_stati( array( 'public' => true ) );
454 19
		if ( ! in_array( $this->post_status, $public_states ) && ! \GVCommon::has_cap( 'read_gravityview', $this->ID ) ) {
0 ignored issues
show
Documentation introduced by
The property post_status does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
455 3
			gravityview()->log->notice( 'The current user cannot access this View #{view_id}', array( 'view_id' => $this->ID ) );
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
456 3
			return new \WP_Error( 'gravityview/not_public' );
457
		}
458
459 19
		return true;
460
	}
461
462
	/**
463
	 * Get joins associated with a view
464
	 *
465
	 * @param \WP_Post $post GravityView CPT to get joins for
466
	 *
467
	 * @since 2.0.11
468
	 *
469
	 * @return \GV\Join[] Array of \GV\Join instances
470
	 */
471 84
	public static function get_joins( $post ) {
472
473 84
		if ( ! gravityview()->plugin->supports( Plugin::FEATURE_JOINS ) ) {
474
			gravityview()->log->error( 'Cannot get joined forms; joins feature not supported.' );
475
			return array();
476
		}
477
478 84
		if ( ! $post || 'gravityview' !== get_post_type( $post ) ) {
479
			gravityview()->log->error( 'Only "gravityview" post types can be \GV\View instances.' );
480
			return array();
481
		}
482
483 84
		$joins_meta = get_post_meta( $post->ID, '_gravityview_form_joins', true );
484
485 84
		if ( empty( $joins_meta ) ) {
486 80
			return array();
487
		}
488
489 4
		$joins = array();
490
491 4
		foreach ( $joins_meta as $meta ) {
492 4
			if ( ! is_array( $meta ) || count( $meta ) != 4 ) {
0 ignored issues
show
introduced by
Found "!= 4". Use Yoda Condition checks, you must
Loading history...
493
				continue;
494
			}
495
496 4
			list( $join, $join_column, $join_on, $join_on_column ) = $meta;
497
498 4
			$join    = GF_Form::by_id( $join );
499 4
			$join_on = GF_Form::by_id( $join_on );
500
501 4
			$join_column    = is_numeric( $join_column ) ? GF_Field::by_id( $join, $join_column ) : Internal_Field( $join_column );
502 4
			$join_on_column = is_numeric( $join_on_column ) ? GF_Field::by_id( $join_on, $join_on_column ) : Internal_Field( $join_on_column );
503
504 4
			$joins [] = new Join( $join, $join_column, $join_on, $join_on_column );
505
		}
506
507 4
		return $joins;
508
	}
509
510
	/**
511
	 * Get joined forms associated with a view
512
	 *
513
	 * @since 2.0.11
514
	 *
515
	 * @param int $post_id ID of the View
516
	 *
517
	 * @return \GV\GF_Form[] Array of \GV\GF_Form instances
518
	 */
519
	public static function get_joined_forms( $post_id = 0 ) {
520
521
		if ( ! gravityview()->plugin->supports( Plugin::FEATURE_JOINS ) ) {
522
			gravityview()->log->error( 'Cannot get joined forms; joins feature not supported.' );
523
			return array();
524
		}
525
526
		if ( empty( $post_id ) ) {
527
			gravityview()->log->error( 'Cannot get joined forms; $post_id was empty' );
528
			return array();
529
		}
530
531
		$joins_meta = get_post_meta( $post_id, '_gravityview_form_joins', true );
532
533
		if ( empty( $joins_meta ) ) {
534
			return array();
535
		}
536
537
		$forms_ids = array();
538
539
		foreach ( $joins_meta  as $meta ) {
540
			if ( ! is_array( $meta ) || count( $meta ) != 4 ) {
0 ignored issues
show
introduced by
Found "!= 4". Use Yoda Condition checks, you must
Loading history...
541
				continue;
542
			}
543
544
			list( $join, $join_column, $join_on, $join_on_column ) = $meta;
545
546
			$forms_ids [] = GF_Form::by_id( $join_on );
547
		}
548
549
		return ( !empty( $forms_ids) ) ? $forms_ids : null;
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
550
	}
551
552
	/**
553
	 * Construct a \GV\View instance from a \WP_Post.
554
	 *
555
	 * @param \WP_Post $post The \WP_Post instance to wrap.
556
	 *
557
	 * @api
558
	 * @since 2.0
559
	 * @return \GV\View|null An instance around this \WP_Post if valid, null otherwise.
560
	 */
561 85
	public static function from_post( $post ) {
562
563 85
		if ( ! $post || 'gravityview' !== get_post_type( $post ) ) {
564 2
			gravityview()->log->error( 'Only gravityview post types can be \GV\View instances.' );
565 2
			return null;
566
		}
567
568 85
		if ( $view = Utils::get( self::$cache, "View::from_post:{$post->ID}" ) ) {
569
			/**
570
			 * @filter `gravityview/view/get` Override View.
571
			 * @param \GV\View $view The View instance pointer.
572
			 * @since 2.1
573
			 */
574 43
			do_action_ref_array( 'gravityview/view/get', array( &$view ) );
575
576 43
			return $view;
577
		}
578
579 85
		$view = new self();
580 85
		$view->post = $post;
581
582
		/** Get connected form. */
583 85
		$view->form = GF_Form::by_id( $view->_gravityview_form_id );
0 ignored issues
show
Documentation introduced by
The property _gravityview_form_id does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
584 85
		if ( ! $view->form ) {
585
			gravityview()->log->error( 'View #{view_id} tried attaching non-existent Form #{form_id} to it.', array(
586
				'view_id' => $view->ID,
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
587
				'form_id' => $view->_gravityview_form_id ? : 0,
0 ignored issues
show
Documentation introduced by
The property _gravityview_form_id does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
588
			) );
589
		}
590
591 85
		$view->joins = $view->get_joins( $post );
592
593
		/**
594
		 * @filter `gravityview/configuration/fields` Filter the View fields' configuration array.
595
		 * @since 1.6.5
596
		 *
597
		 * @deprecated Use `gravityview/view/configuration/fields` or `gravityview/view/fields` filters.
598
		 *
599
		 * @param $fields array Multi-array of fields with first level being the field zones.
600
		 * @param $view_id int The View the fields are being pulled for.
601
		 */
602 85
		$configuration = apply_filters( 'gravityview/configuration/fields', (array)$view->_gravityview_directory_fields, $view->ID );
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
603
604
		/**
605
		 * @filter `gravityview/view/configuration/fields` Filter the View fields' configuration array.
606
		 * @since 2.0
607
		 *
608
		 * @param array $fields Multi-array of fields with first level being the field zones.
609
		 * @param \GV\View $view The View the fields are being pulled for.
610
		 */
611 85
		$configuration = apply_filters( 'gravityview/view/configuration/fields', $configuration, $view );
612
613
		/**
614
		 * @filter `gravityview/view/fields` Filter the Field Collection for this View.
615
		 * @since 2.0
616
		 *
617
		 * @param \GV\Field_Collection $fields A collection of fields.
618
		 * @param \GV\View $view The View the fields are being pulled for.
619
		 */
620 85
		$view->fields = apply_filters( 'gravityview/view/fields', Field_Collection::from_configuration( $configuration ), $view );
621
622
		/**
623
		 * @filter `gravityview/view/configuration/widgets` Filter the View widgets' configuration array.
624
		 * @since 2.0
625
		 *
626
		 * @param array $fields Multi-array of widgets with first level being the field zones.
627
		 * @param \GV\View $view The View the widgets are being pulled for.
628
		 */
629 85
		$configuration = apply_filters( 'gravityview/view/configuration/widgets', (array)$view->_gravityview_directory_widgets, $view );
0 ignored issues
show
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
630
631
		/**
632
		 * @filter `gravityview/view/widgets` Filter the Widget Collection for this View.
633
		 * @since 2.0
634
		 *
635
		 * @param \GV\Widget_Collection $widgets A collection of widgets.
636
		 * @param \GV\View $view The View the widgets are being pulled for.
637
		 */
638 85
		$view->widgets = apply_filters( 'gravityview/view/widgets', Widget_Collection::from_configuration( $configuration ), $view );
639
640
		/** View configuration. */
641 85
		$view->settings->update( gravityview_get_template_settings( $view->ID ) );
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
642
643
		/** Add the template name into the settings. */
644 85
		$view->settings->update( array( 'template' => gravityview_get_template_id( $view->ID ) ) );
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
645
646
		/** View basics. */
647 85
		$view->settings->update( array(
648 85
			'id' => $view->ID,
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
649
		) );
650
651 85
		self::$cache[ "View::from_post:{$post->ID}" ] = &$view;
652
653
		/**
654
		 * @filter `gravityview/view/get` Override View.
655
		 * @param \GV\View $view The View instance pointer.
656
		 * @since 2.1
657
		 */
658 85
		do_action_ref_array( 'gravityview/view/get', array( &$view ) );
659
660 85
		return $view;
661
	}
662
663
	/**
664
	 * Flush the view cache.
665
	 *
666
	 * @param int $view_id The View to reset cache for. Optional. Default: resets everything.
667
	 *
668
	 * @internal
669
	 */
670 95
	public static function _flush_cache( $view_id = null ) {
671 95
		if ( $view_id ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $view_id of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
672 89
			unset( self::$cache[ "View::from_post:$view_id" ] );
673 89
			return;
674
		}
675 73
		self::$cache = array();
676 73
	}
677
678
	/**
679
	 * Construct a \GV\View instance from a post ID.
680
	 *
681
	 * @param int|string $post_id The post ID.
682
	 *
683
	 * @api
684
	 * @since 2.0
685
	 * @return \GV\View|null An instance around this \WP_Post or null if not found.
686
	 */
687 44
	public static function by_id( $post_id ) {
688 44
		if ( ! $post_id || ! $post = get_post( $post_id ) ) {
689 3
			return null;
690
		}
691 44
		return self::from_post( $post );
692
	}
693
694
	/**
695
	 * Determines if a view exists to begin with.
696
	 *
697
	 * @param int|\WP_Post|null $view The WordPress post ID, a \WP_Post object or null for global $post;
698
	 *
699
	 * @api
700
	 * @since 2.0
701
	 * @return bool Whether the post exists or not.
702
	 */
703 6
	public static function exists( $view ) {
704 6
		return get_post_type( $view ) == 'gravityview';
705
	}
706
707
	/**
708
	 * ArrayAccess compatibility layer with GravityView_View_Data::$views
709
	 *
710
	 * @internal
711
	 * @deprecated
712
	 * @since 2.0
713
	 * @return bool Whether the offset exists or not, limited to GravityView_View_Data::$views element keys.
714
	 */
715 13
	public function offsetExists( $offset ) {
0 ignored issues
show
Coding Style introduced by
The function name offsetExists is in camel caps, but expected offset_exists instead as per the coding standard.
Loading history...
716 13
		$data_keys = array( 'id', 'view_id', 'form_id', 'template_id', 'atts', 'fields', 'widgets', 'form' );
717 13
		return in_array( $offset, $data_keys );
718
	}
719
720
	/**
721
	 * ArrayAccess compatibility layer with GravityView_View_Data::$views
722
	 *
723
	 * Maps the old keys to the new data;
724
	 *
725
	 * @internal
726
	 * @deprecated
727
	 * @since 2.0
728
	 *
729
	 * @return mixed The value of the requested view data key limited to GravityView_View_Data::$views element keys.
730
	 */
731 13
	public function offsetGet( $offset ) {
0 ignored issues
show
Coding Style introduced by
The function name offsetGet is in camel caps, but expected offset_get instead as per the coding standard.
Loading history...
732
733 13
		gravityview()->log->notice( 'This is a \GV\View object should not be accessed as an array.' );
734
735 13
		if ( ! isset( $this[ $offset ] ) ) {
736
			return null;
737
		}
738
739 13
		switch ( $offset ) {
740 13
			case 'id':
741 13
			case 'view_id':
742 1
				return $this->ID;
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
743 13
			case 'form':
744 13
				return $this->form;
745 1
			case 'form_id':
746 1
				return $this->form ? $this->form->ID : null;
747 1
			case 'atts':
748
				return $this->settings->as_atts();
0 ignored issues
show
Deprecated Code introduced by
The method GV\View_Settings::as_atts() has been deprecated.

This method has been deprecated.

Loading history...
749 1
			case 'template_id':
750 1
				return $this->settings->get( 'template' );
751
			case 'widgets':
752
				return $this->widgets->as_configuration();
753
		}
754
	}
755
756
	/**
757
	 * ArrayAccess compatibility layer with GravityView_View_Data::$views
758
	 *
759
	 * @internal
760
	 * @deprecated
761
	 * @since 2.0
762
	 *
763
	 * @return void
764
	 */
765 1
	public function offsetSet( $offset, $value ) {
0 ignored issues
show
Coding Style introduced by
The function name offsetSet is in camel caps, but expected offset_set instead as per the coding standard.
Loading history...
766 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.' );
767 1
	}
768
769
	/**
770
	 * ArrayAccess compatibility layer with GravityView_View_Data::$views
771
	 *
772
	 * @internal
773
	 * @deprecated
774
	 * @since 2.0
775
	 * @return void
776
	 */
777 1
	public function offsetUnset( $offset ) {
0 ignored issues
show
Coding Style introduced by
The function name offsetUnset is in camel caps, but expected offset_unset instead as per the coding standard.
Loading history...
778 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.' );
779 1
	}
780
781
	/**
782
	 * Be compatible with the old data object.
783
	 *
784
	 * Some external code expects an array (doing things like foreach on this, or array_keys)
785
	 *  so let's return an array in the old format for such cases. Do not use unless using
786
	 *  for back-compatibility.
787
	 *
788
	 * @internal
789
	 * @deprecated
790
	 * @since 2.0
791
	 * @return array
792
	 */
793 9
	public function as_data() {
794
		return array(
795 9
			'id' => $this->ID,
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
796 9
			'view_id' => $this->ID,
0 ignored issues
show
Documentation introduced by
The property ID does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
797 9
			'form_id' => $this->form ? $this->form->ID : null,
798 9
			'form' => $this->form ? gravityview_get_form( $this->form->ID ) : null,
799 9
			'atts' => $this->settings->as_atts(),
0 ignored issues
show
Deprecated Code introduced by
The method GV\View_Settings::as_atts() has been deprecated.

This method has been deprecated.

Loading history...
800 9
			'fields' => $this->fields->by_visible()->as_configuration(),
801 9
			'template_id' => $this->settings->get( 'template' ),
802 9
			'widgets' => $this->widgets->as_configuration(),
803
		);
804
	}
805
806
	/**
807
	 * Retrieve the entries for the current view and request.
808
	 *
809
	 * @param \GV\Request The request. Unused for now.
810
	 *
811
	 * @return \GV\Entry_Collection The entries.
812
	 */
813 28
	public function get_entries( $request = null ) {
814 28
		$entries = new \GV\Entry_Collection();
815 28
		if ( $this->form ) {
816
			/**
817
			 * @todo: Stop using _frontend and use something like $request->get_search_criteria() instead
818
			 */
819 28
			$parameters = \GravityView_frontend::get_view_entries_parameters( $this->settings->as_atts(), $this->form->ID );
0 ignored issues
show
Deprecated Code introduced by
The method GV\View_Settings::as_atts() has been deprecated.

This method has been deprecated.

Loading history...
820 28
			$parameters['context_view_id'] = $this->ID;
0 ignored issues
show
Bug introduced by
The property ID does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
821 28
			$parameters = \GVCommon::calculate_get_entries_criteria( $parameters, $this->form->ID );
822
823 28
			if ( $request instanceof REST\Request ) {
824 4
				$atts = $this->settings->as_atts();
0 ignored issues
show
Deprecated Code introduced by
The method GV\View_Settings::as_atts() has been deprecated.

This method has been deprecated.

Loading history...
825 4
				$paging_parameters = wp_parse_args( $request->get_paging(), array(
826 4
						'paging' => array( 'page_size' => $atts['page_size'] ),
827
					) );
0 ignored issues
show
Coding Style introduced by
This line of the multi-line function call does not seem to be indented correctly. Expected 16 spaces, but found 20.
Loading history...
828 4
				$parameters['paging'] = $paging_parameters['paging'];
829
			}
830
831 28
			$page = Utils::get( $parameters['paging'], 'current_page' ) ?
832 28
				: ( ( ( $parameters['paging']['offset'] - $this->settings->get( 'offset' ) ) / $parameters['paging']['page_size'] ) + 1 );
833
834 28
			if ( gravityview()->plugin->supports( Plugin::FEATURE_GFQUERY ) ) {
835
				/**
836
				 * New \GF_Query stuff :)
837
				 */
838 28
				$query = new \GF_Query( $this->form->ID, $parameters['search_criteria'], $parameters['sorting'] );
839
840 28
				$query->limit( $parameters['paging']['page_size'] )
841 28
					->offset( ( ( $page - 1 ) * $parameters['paging']['page_size'] ) + $this->settings->get( 'offset' ) );
842
843
				/**
844
				 * Any joins?
845
				 */
846 28
				if ( Plugin::FEATURE_JOINS && count( $this->joins ) ) {
847 4
					foreach ( $this->joins as $join ) {
848 4
						$query = $join->as_query_join( $query );
849
					}
850
				}
851
852
				/**
853
				 * @action `gravityview/view/query` Override the \GF_Query before the get() call.
854
				 * @param \GF_Query $query The current query object reference
855
				 * @param \GV\View $this The current view object
856
				 * @param \GV\Request $request The request object
857
				 */
858 28
				do_action_ref_array( 'gravityview/view/query', array( &$query, $this, $request ) );
859
860
				/**
861
				 * Map from Gravity Forms entries arrays to an Entry_Collection.
862
				 */
863 28
				if ( count( $this->joins ) ) {
864 4
					foreach ( $query->get() as $entry ) {
865 4
						$entries->add(
866 4
							Multi_Entry::from_entries( array_map( '\GV\GF_Entry::from_entry', $entry ) )
867
						);
868
					}
869
				} else {
870 24
					array_map( array( $entries, 'add' ), array_map( '\GV\GF_Entry::from_entry', $query->get() ) );
871
				}
872
873
				/**
874
				 * Add total count callback.
875
				 */
876 28
				$entries->add_count_callback( function() use ( $query ) {
877 23
					return $query->total_found;
878 28
				} );
879
			} else {
880
				$entries = $this->form->entries
0 ignored issues
show
Documentation introduced by
The property entries does not exist on object<GV\Form>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
881
					->filter( \GV\GF_Entry_Filter::from_search_criteria( $parameters['search_criteria'] ) )
882
					->offset( $this->settings->get( 'offset' ) )
883
					->limit( $parameters['paging']['page_size'] )
884
					->page( $page );
885
886
				if ( ! empty( $parameters['sorting'] ) && ! empty( $parameters['sorting']['key'] ) ) {
887
					$field = new \GV\Field();
888
					$field->ID = $parameters['sorting']['key'];
889
					$direction = strtolower( $parameters['sorting']['direction'] ) == 'asc' ? \GV\Entry_Sort::ASC : \GV\Entry_Sort::DESC;
890
					$entries = $entries->sort( new \GV\Entry_Sort( $field, $direction ) );
891
				}
892
			}
893
		}
894
895
		/**
896
		 * @filter `gravityview/view/entries` Modify the entry fetching filters, sorts, offsets, limits.
897
		 * @param \GV\Entry_Collection $entries The entries for this view.
898
		 * @param \GV\View $view The view.
899
		 * @param \GV\Request $request The request.
900
		 */
901 28
		return apply_filters( 'gravityview/view/entries', $entries, $this, $request );
902
	}
903
904
	/**
905
	 * Last chance to configure the output.
906
	 *
907
	 * Used for CSV output, for example.
908
	 *
909
	 * @return void
910
	 */
911 1
	public static function template_redirect() {
912
		/**
913
		 * CSV output.
914
		 */
915 1
		if ( ! get_query_var( 'csv' ) ) {
916 1
			return;
917
		}
918
919 1
		if ( ! $view = gravityview()->request->is_view() ) {
920 1
			return;
921
		}
922
923 1
		if ( is_wp_error( $error = $view->can_render( array( 'csv' ) ) ) ) {
924 1
			gravityview()->log->error( 'Not rendering CSV: ' . $error->get_error_message() );
925 1
			return;
926
		}
927
928
		/**
929
		 * Modify the name of the generated CSV file. Name will be sanitized using sanitize_file_name() before output.
930
		 * @see sanitize_file_name()
931
		 * @since 2.1
932
		 * @param string   $filename File name used when downloading a CSV. Default is "{View title}.csv"
933
		 * @param \GV\View $view Current View being rendered
934
		 */
935 1
		$filename = apply_filters( 'gravityview/output/csv/filename', get_the_title( $view->post ), $view );
936
937 1
		if ( ! defined( 'DOING_GRAVITYVIEW_TESTS' ) ) {
938
			header( sprintf( 'Content-Disposition: attachment;filename="%s.csv"', sanitize_file_name( $filename ) ) );
939
			header( 'Content-Transfer-Encoding: binary' );
940
			header( 'Content-Type: text/csv' );
941
		}
942
943 1
		ob_start();
944 1
		$csv = fopen( 'php://output', 'w' );
945
946
		/**
947
		 * Add da' BOM if GF uses it
948
		 * @see GFExport::start_export()
949
		 */
950 1
		if ( apply_filters( 'gform_include_bom_export_entries', true, $view->form ? $view->form->form : null ) ) {
0 ignored issues
show
Documentation introduced by
The property $form is declared private in GV\Form. Since you implemented __get(), maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
951
			fputs( $csv, "\xef\xbb\xbf" );
0 ignored issues
show
introduced by
Filesystem writes are forbidden, you should not be using fputs()
Loading history...
952
		}
953
954 1
		$entries = $view->get_entries();
955
956 1
		$headers_done = false;
957 1
		$allowed = $headers = array();
958
959 1
		foreach ( $view->fields->by_position( "directory_*" )->by_visible()->all() as $field ) {
0 ignored issues
show
Coding Style Comprehensibility introduced by
The string literal directory_* does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
960 1
			$allowed[ $field->ID ] = $field;
961
		}
962
963 1
		$renderer = new Field_Renderer();
964
965 1
		foreach ( $entries->all() as $entry ) {
966
967 1
			$return = array();
968
969
			/**
970
			 * @filter `gravityview/csv/entry/fields` Whitelist more entry fields that are output in CSV requests.
971
			 * @param[in,out] array $allowed The allowed ones, default by_visible, by_position( "context_*" ), i.e. as set in the View.
972
			 * @param \GV\View $view The view.
973
			 * @param \GV\Entry $entry WordPress representation of the item.
974
			 */
975 1
			$allowed_field_ids = apply_filters( 'gravityview/csv/entry/fields', array_keys( $allowed ), $view, $entry );
976
977 1
			foreach ( $allowed_field_ids as $field_id ) {
978 1
				$source = is_numeric( $field_id ) ? $view->form : new \GV\Internal_Source();
979
980 1
				if ( isset( $allowed[ $field_id ] ) ) {
981 1
					$field = $allowed[ $field_id ];
982
				} else {
983
					$field = is_numeric( $field_id ) ? \GV\GF_Field::by_id( $view->form, $field_id ) : \GV\Internal_Field::by_id( $field_id );
984
				}
985
986 1
				$return[ $field->ID ] = $renderer->render( $field, $view, $source, $entry, gravityview()->request, '\GV\Field_CSV_Template' );
987
988 1
				if ( ! $headers_done ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $headers_done of type false|integer is loosely compared to false; this is ambiguous if the integer can be zero. You might want to explicitly use === null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
989 1
					$label = $field->get_label( $view, $source, $entry );
990 1
					$headers[ $field->ID ] = $label ? $label : $field->ID;
991
				}
992
			}
993
994 1
			if ( ! $headers_done ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $headers_done of type false|integer is loosely compared to false; this is ambiguous if the integer can be zero. You might want to explicitly use === null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
995 1
				$headers_done = fputcsv( $csv, array_map( array( '\GV\Utils', 'strip_excel_formulas' ), array_values( $headers ) ) );
0 ignored issues
show
introduced by
Filesystem writes are forbidden, you should not be using fputcsv()
Loading history...
996
			}
997
998 1
			fputcsv( $csv, array_map( array( '\GV\Utils', 'strip_excel_formulas' ), $return ) );
0 ignored issues
show
introduced by
Filesystem writes are forbidden, you should not be using fputcsv()
Loading history...
999
		}
1000
1001 1
		fflush( $csv );
1002
1003 1
		echo rtrim( ob_get_clean() );
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'rtrim'
Loading history...
1004
1005 1
		if ( ! defined( 'DOING_GRAVITYVIEW_TESTS' ) ) {
1006
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method template_redirect() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
1007
		}
1008 1
	}
1009
1010 84
	public function __get( $key ) {
1011 84
		if ( $this->post ) {
1012 84
			$raw_post = $this->post->filter( 'raw' );
1013 84
			return $raw_post->{$key};
1014
		}
1015
		return isset( $this->{$key} ) ? $this->{$key} : null;
1016
	}
1017
}
1018