Request::is_rest() - Code Metrics - Inspection of "Allow partial entries to be fetched on NULL joins" - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 8d114d...308b87 )

by Gennady

created 2018-12-07 19:07 UTC

Request::is_rest() A

↳ Parent: Request

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php

namespace GV;

/** If this file is called directly, abort. */
if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
	die();
}

/**
 * The Request abstract class.
 *
 * Knows more about the request than anyone else.
 */
abstract class Request {
	public function __construct() {
	}

	/**
	 * Check if WordPress is_admin(), and make sure not DOING_AJAX.
	 *
	 * @return boolean
	 */
	public static function is_admin() {
		$doing_ajax = defined( 'DOING_AJAX' ) ? DOING_AJAX : false;
		$load_scripts_styles = preg_match( '#^/wp-admin/load-(scripts|styles).php$#', Utils::_SERVER( 'SCRIPT_NAME' ) );

		return is_admin() && ! ( $doing_ajax || $load_scripts_styles );
	}

	/**
	 * This is the frontend.
	 *
	 * @return boolean True or false.
	 */
	public static function is_frontend() {
		return ! is_admin();
	}

	/**
	 * Is this the Add Media / From URL preview request?
	 *
	 * Will not work in WordPress 4.8+
	 *
	 * @return boolean
	 */
	public static function is_add_oembed_preview() {
		/** The preview request is a parse-embed AJAX call without a type set. */
		return ( self::is_ajax() && ! empty( $_POST['action'] ) && $_POST['action'] == 'parse-embed' && ! isset( $_POST['type'] ) );

	}

	/**
	 * Is this an AJAX call in progress?
	 *
	 * @return boolean
	 */
	public static function is_ajax() {
		return defined( 'DOING_AJAX' ) && DOING_AJAX;
	}

	/**
	 * Is this a REST request? Call after parse_request.
	 *
	 * @return boolean
	 */
	public static function is_rest() {
		return ! empty( $GLOBALS['wp']->query_vars['rest_route'] );
	}

	/**
	 * The current $post is a View, no?
	 *
	 * @api
	 * @since 2.0
	 * @todo tests
	 *
	 * @return \GV\View|false The view requested or false
	 */
	public function is_view() {
		global $post;
function myFunction($a, $b) {
    // Do something
}
		if ( $post && get_post_type( $post ) == 'gravityview' ) {

			return \GV\View::from_post( $post );
		}
		return false;
	}

	/**
	 * Checks whether this is a single entry request
	 *
	 * @api
	 * @since 2.0
	 * @todo tests
	 *
	 * @param int $form_id The form ID, since slugs can be non-unique. Default: 0.
	 *
	 * @return \GV\GF_Entry|false The entry requested or false.
	 */
	public function is_entry( $form_id = 0 ) {
		$entry = false;

		if ( $id = get_query_var( Entry::get_endpoint_name() ) ) {

			static $entries = array();

			if ( isset( $entries[ "$form_id:$id" ] ) ) {
				return $entries[ "$form_id:$id" ];
			}

			if ( ! $view = $this->is_view() ) {
				/**
				 * A shortcode probably.
				 */
				$view = gravityview()->views->get();
<?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.");
        }
    }

}
			}

			/**
			 * A joined request.
			 */
			if ( $view && ( $joins = $view->joins ) ) {
				$forms = array_merge( wp_list_pluck( $joins, 'join' ), wp_list_pluck( $joins, 'join_on' ) );
				$valid_forms = array_unique( wp_list_pluck( $forms, 'ID' ) );

				$multientry = array();
				foreach ( $ids = explode( ',', $id ) as $i => $id ) {
					if ( ! $e = GF_Entry::by_id( $id, $valid_forms[ $i ] ) ) {
						return false;
					}

					if ( ! in_array( $e['form_id'], $valid_forms ) ) {
						return false;
					}

					array_push( $multientry, $e );
				}

				// Allow Edit Entry to only edit a single entry on a multi-entry
				$is_edit_entry = apply_filters( 'gravityview_is_edit_entry', false );

				// Edit entry links are single-entry based
				if ( $is_edit_entry && 1 !== count( $multientry ) ) {
					return false;
				}

				$entry = Multi_Entry::from_entries( array_filter( $multientry ) );
			}  else {
				/**
				 * A regular one.
				 */
				$entry = GF_Entry::by_id( $id, $form_id );
			}

			$entries[ "$form_id:$id" ] = $entry;
		}

		return $entry;
	}

	/**
	 * Checks whether this an edit entry request.
	 *
	 * @api
	 * @since 2.0
	 * @todo tests
	 *
	 * @param int $form_id The form ID, since slugs can be non-unique. Default: 0.
	 *
	 * @return \GV\Entry|false The entry requested or false.
	 */
	public function is_edit_entry( $form_id = 0 ) {
		/**
		* @filter `gravityview_is_edit_entry` Whether we're currently on the Edit Entry screen \n
		* The Edit Entry functionality overrides this value.
		* @param boolean $is_edit_entry
		*/
		if ( ( $entry = $this->is_entry( $form_id ) ) && apply_filters( 'gravityview_is_edit_entry', false ) ) {
			return $entry;
		}
		return false;
	}

	/**
	 * Checks whether this an entry search request.
	 *
	 * @api
	 * @since 2.0
	 * @todo implementation
	 *
	 * @return boolean True if this is a search request.
	 */
	public function is_search() {

		$search_method = apply_filters( 'gravityview/search/method', 'get' );

		if ( 'post' === $search_method ) {
			$get = $_POST;

		} else {
			$get = $_GET;

		}

		unset( $get['mode'] );

		$get = array_filter( $get, 'gravityview_is_not_empty_string' );

		if( $has_field_key = $this->_has_field_key( $get ) ) {
			return true;
		}

		return isset( $get['gv_search'] ) || isset( $get['gv_start'] ) || isset( $get['gv_end'] ) || isset( $get['gv_by'] ) || isset( $get['gv_id'] );
	}

	/**
	 * Calculate whether the $_REQUEST has a GravityView field
	 *
	 * @internal
	 * @todo Roll into the future Search refactor
	 *
	 * @since 2.0.7
	 *
	 * @param array $get $_POST or $_GET array
	 *
	 * @return bool True: GravityView-formatted field detected; False: not detected
	 */
	private function _has_field_key( $get ) {

		$has_field_key = false;

		$fields = \GravityView_Fields::get_all();

		$meta = array();
		foreach ( $fields as $field ) {
			if( empty( $field->_gf_field_class_name ) ) {
				$meta[] = preg_quote( $field->name );
			}
		}

		foreach ( $get as $key => $value ) {
			if ( preg_match('/^filter_(([0-9_]+)|'. implode( '|', $meta ) .')$/sm', $key ) ) {

				$has_field_key = true;
				break;
			}
		}

		return $has_field_key;
	}
}

/** Load implementations. */
require gravityview()->plugin->dir( 'future/includes/class-gv-request-frontend.php' );
require gravityview()->plugin->dir( 'future/includes/class-gv-request-admin.php' );
require gravityview()->plugin->dir( 'future/includes/rest/class-gv-request-rest.php' );
require gravityview()->plugin->dir( 'future/includes/class-gv-request-mock.php' );


Push — develop ( 8d114d...308b87 )

Request::is_rest() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2017-01-29 18:22 UTC by Report Bug Copy Issue Report 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 14 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 Request abstract class.
11		*
12		* Knows more about the request than anyone else.
13		*/
14		abstract class Request {
15	77	public function __construct() {
16	77	}
17
18		/**
19		* Check if WordPress is_admin(), and make sure not DOING_AJAX.
20		*
21		* @return boolean
22		*/
23	19	public static function is_admin() {
24	19	$doing_ajax = defined( 'DOING_AJAX' ) ? DOING_AJAX : false;
25	19	$load_scripts_styles = preg_match( '#^/wp-admin/load-(scripts\|styles).php$#', Utils::_SERVER( 'SCRIPT_NAME' ) );
26
27	19	return is_admin() && ! ( $doing_ajax \|\| $load_scripts_styles );
28		}
29
30		/**
31		* This is the frontend.
32		*
33		* @return boolean True or false.
34		*/
35		public static function is_frontend() {
36		return ! is_admin();
37		}
38
39		/**
40		* Is this the Add Media / From URL preview request?
41		*
42		* Will not work in WordPress 4.8+
43		*
44		* @return boolean
45		*/
46	2	public static function is_add_oembed_preview() {
47		/** The preview request is a parse-embed AJAX call without a type set. */
48	2	return ( self::is_ajax() && ! empty( $_POST['action'] ) && $_POST['action'] == 'parse-embed' && ! isset( $_POST['type'] ) );
		0 ignored issues – show introduced 2018-05-08 22:40 UTC by Report Bug Copy Issue Report Detected access of super global var $_POST, probably need manual inspection. Loading history... introduced 2018-05-08 22:40 UTC by Report Bug Copy Issue Report Detected usage of a non-sanitized input variable: $_POST Loading history...
49		}
50
51		/**
52		* Is this an AJAX call in progress?
53		*
54		* @return boolean
55		*/
56	2	public static function is_ajax() {
57	2	return defined( 'DOING_AJAX' ) && DOING_AJAX;
58		}
59
60		/**
61		* Is this a REST request? Call after parse_request.
62		*
63		* @return boolean
64		*/
65		public static function is_rest() {
66		return ! empty( $GLOBALS['wp']->query_vars['rest_route'] );
67		}
68
69		/**
70		* The current $post is a View, no?
71		*
72		* @api
73		* @since 2.0
74		* @todo tests
75		*
76		* @return \GV\View\|false The view requested or false
77		*/
78	64	public function is_view() {
79	64	global $post;
		0 ignored issues – show Compatibility Best Practice introduced 2018-05-08 22:40 UTC by Report Bug Copy Issue Report 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...
80	64	if ( $post && get_post_type( $post ) == 'gravityview' ) {
		0 ignored issues – show introduced 2018-05-08 22:40 UTC by Report Bug Copy Issue Report Found "== '". Use Yoda Condition checks, you must Loading history...
81	6	return \GV\View::from_post( $post );
82		}
83	60	return false;
84		}
85
86		/**
87		* Checks whether this is a single entry request
88		*
89		* @api
90		* @since 2.0
91		* @todo tests
92		*
93		* @param int $form_id The form ID, since slugs can be non-unique. Default: 0.
94		*
95		* @return \GV\GF_Entry\|false The entry requested or false.
96		*/
97	15	public function is_entry( $form_id = 0 ) {
98	15	$entry = false;
99
100	15	if ( $id = get_query_var( Entry::get_endpoint_name() ) ) {
101
102	1	static $entries = array();
103
104	1	if ( isset( $entries[ "$form_id:$id" ] ) ) {
105	1	return $entries[ "$form_id:$id" ];
106		}
107
108	1	if ( ! $view = $this->is_view() ) {
109		/**
110		* A shortcode probably.
111		*/
112	1	$view = gravityview()->views->get();
		0 ignored issues – show Documentation introduced 2017-03-29 06:38 UTC by Report Bug Copy Issue Report The property `views` does not exist on `object<GV\Core>`. 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...
113		}
114
115		/**
116		* A joined request.
117		*/
118	1	if ( $view && ( $joins = $view->joins ) ) {
119		$forms = array_merge( wp_list_pluck( $joins, 'join' ), wp_list_pluck( $joins, 'join_on' ) );
120		$valid_forms = array_unique( wp_list_pluck( $forms, 'ID' ) );
121
122		$multientry = array();
123		foreach ( $ids = explode( ',', $id ) as $i => $id ) {
124		if ( ! $e = GF_Entry::by_id( $id, $valid_forms[ $i ] ) ) {
125		return false;
126		}
127
128		if ( ! in_array( $e['form_id'], $valid_forms ) ) {
129		return false;
130		}
131
132		array_push( $multientry, $e );
133		}
134
135		// Allow Edit Entry to only edit a single entry on a multi-entry
136		$is_edit_entry = apply_filters( 'gravityview_is_edit_entry', false );
137
138		// Edit entry links are single-entry based
139		if ( $is_edit_entry && 1 !== count( $multientry ) ) {
140		return false;
141		}
142
143		$entry = Multi_Entry::from_entries( array_filter( $multientry ) );
144		} else {
145		/**
146		* A regular one.
147		*/
148		$entry = GF_Entry::by_id( $id, $form_id );
149		}
150
151		$entries[ "$form_id:$id" ] = $entry;
152		}
153
154		return $entry;
155		}
156
157		/**
158		* Checks whether this an edit entry request.
159		*
160		* @api
161		* @since 2.0
162	1	* @todo tests
163		*
164		* @param int $form_id The form ID, since slugs can be non-unique. Default: 0.
165	1	*
166		* @return \GV\Entry\|false The entry requested or false.
167		*/
168	15	public function is_edit_entry( $form_id = 0 ) {
169		/**
170		* @filter `gravityview_is_edit_entry` Whether we're currently on the Edit Entry screen \n
171		* The Edit Entry functionality overrides this value.
172		* @param boolean $is_edit_entry
173		*/
174		if ( ( $entry = $this->is_entry( $form_id ) ) && apply_filters( 'gravityview_is_edit_entry', false ) ) {
175		return $entry;
176		}
177		return false;
178		}
179
180		/**
181		* Checks whether this an entry search request.
182	10	*
183		* @api
184		* @since 2.0
185		* @todo implementation
186		*
187		* @return boolean True if this is a search request.
188	10	*/
189		public function is_search() {
190
191	10	$search_method = apply_filters( 'gravityview/search/method', 'get' );
192
193		if ( 'post' === $search_method ) {
194		$get = $_POST;
		0 ignored issues – show introduced 2018-05-08 22:40 UTC by Report Bug Copy Issue Report Detected access of super global var $_POST, probably need manual inspection. Loading history... introduced 2018-05-08 22:40 UTC by Report Bug Copy Issue Report Detected usage of a non-sanitized input variable: $_POST Loading history...
195		} else {
196		$get = $_GET;
		0 ignored issues – show introduced 2018-05-24 07:40 UTC by Report Bug Copy Issue Report Detected access of super global var $_GET, probably need manual inspection. Loading history... introduced 2018-05-24 07:40 UTC by Report Bug Copy Issue Report Detected usage of a non-sanitized input variable: $_GET Loading history...
197		}
198
199		unset( $get['mode'] );
200
201		$get = array_filter( $get, 'gravityview_is_not_empty_string' );
202
203	12	if( $has_field_key = $this->_has_field_key( $get ) ) {
204		return true;
205	12	}
206
207	12	return isset( $get['gv_search'] ) \|\| isset( $get['gv_start'] ) \|\| isset( $get['gv_end'] ) \|\| isset( $get['gv_by'] ) \|\| isset( $get['gv_id'] );
208	1	}
209
210	12	/**
211		* Calculate whether the $_REQUEST has a GravityView field
212		*
213	12	* @internal
214		* @todo Roll into the future Search refactor
215	12	*
216		* @since 2.0.7
217	12	*
218	1	* @param array $get $_POST or $_GET array
219		*
220		* @return bool True: GravityView-formatted field detected; False: not detected
221	12	*/
222		private function _has_field_key( $get ) {
223
224		$has_field_key = false;
225
226		$fields = \GravityView_Fields::get_all();
227
228		$meta = array();
229		foreach ( $fields as $field ) {
230		if( empty( $field->_gf_field_class_name ) ) {
231		$meta[] = preg_quote( $field->name );
232		}
233		}
234
235		foreach ( $get as $key => $value ) {
236	11	if ( preg_match('/^filter_(([0-9_]+)\|'. implode( '\|', $meta ) .')$/sm', $key ) ) {
		0 ignored issues – show Coding Style introduced 2018-05-21 18:06 UTC by Report Bug Copy Issue Report Expected 1 spaces after opening bracket; 0 found Loading history...
237		$has_field_key = true;
238	11	break;
239		}
240	11	}
241
242	11	return $has_field_key;
243	11	}
244	11	}
245	11
246		/** Load implementations. */
247		require gravityview()->plugin->dir( 'future/includes/class-gv-request-frontend.php' );
248		require gravityview()->plugin->dir( 'future/includes/class-gv-request-admin.php' );
249	11	require gravityview()->plugin->dir( 'future/includes/rest/class-gv-request-rest.php' );
250		require gravityview()->plugin->dir( 'future/includes/class-gv-request-mock.php' );
251

gravityview / GravityView

Push — develop ( 8d114d...308b87 )

Request::is_rest() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like