WC_REST_Controller - Code Metrics - Inspection of "Merge pull request #11882 from woothemes/settings-..." - woothemes/woocommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9a3784...c8ddca )

by Justin

created 2016-09-09 12:52 UTC

WC_REST_Controller B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	338
Duplicated Lines	18.93 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
dl	64
loc	338
rs	8.3673
c	1
b	0
f	1
wmc	45
lcom	1
cbo	1

12 Methods

Rating	Name	Duplication	Size	Complexity
A	get_normalized_rest_base()	0	3	1
B	check_batch_limit()	3	22	5
C	batch_items()	32	79	13
B	add_additional_fields_schema()	7	24	4
A	validate_setting_text_field()	0	5	2
A	validate_setting_select_field()	5	7	2
B	validate_setting_multiselect_field()	3	18	5
B	validate_setting_image_width_field()	3	17	5
A	validate_setting_radio_field()	0	3	1
A	validate_setting_checkbox_field()	0	10	4
A	validate_setting_textarea_field()	11	11	2
B	get_public_batch_schema()	0	26	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like WC_REST_Controller often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use WC_REST_Controller, and based on these observations, apply Extract Interface, too.

<?php

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Abstract Rest Controler Class
 *
 * @author   WooThemes
 * @category API
 * @package  WooCommerce/Abstracts
 * @extends  WP_REST_Controller
 * @version  2.6.0
 */
abstract class WC_REST_Controller extends WP_REST_Controller {

	/**
	 * Endpoint namespace.
	 *
	 * @var string
	 */
	protected $namespace = 'wc/v1';

	/**
	 * Route base.
	 *
	 * @var string
	 */
	protected $rest_base = '';

	/**
	 * Add the schema from additional fields to an schema array.
	 *
	 * The type of object is inferred from the passed schema.
	 *
	 * @param array $schema Schema array.
	 */
	protected function add_additional_fields_schema( $schema ) {
		if ( empty( $schema['title'] ) ) {
			return $schema;
		}

		/**
		 * Can't use $this->get_object_type otherwise we cause an inf loop.
		 */
		$object_type = $schema['title'];

		$additional_fields = $this->get_additional_fields( $object_type );

		foreach ( $additional_fields as $field_name => $field_options ) {

			if ( ! $field_options['schema'] ) {
				continue;
			}

			$schema['properties'][ $field_name ] = $field_options['schema'];
		}

		$schema['properties'] = apply_filters( 'woocommerce_rest_' . $object_type . '_schema', $schema['properties'] );

		return $schema;
	}

	/**
	 * Get normalized rest base.
	 *
	 * @return string
	 */
	protected function get_normalized_rest_base() {
		return preg_replace( '/\(.*\)\//i', '', $this->rest_base );
	}

	/**
	 * Check batch limit.
	 *
	 * @param array $items Request items.
	 * @return bool|WP_Error
	 */
	protected function check_batch_limit( $items ) {
		$limit = apply_filters( 'woocommerce_rest_batch_items_limit', 100, $this->get_normalized_rest_base() );
		$total = 0;

		if ( ! empty( $items['create'] ) ) {
			$total += count( $items['create'] );
		}

		if ( ! empty( $items['update'] ) ) {
			$total += count( $items['update'] );
		}

		if ( ! empty( $items['delete'] ) ) {
			$total += count( $items['delete'] );
		}

		if ( $total > $limit ) {

			return new WP_Error( 'woocommerce_rest_request_entity_too_large', sprintf( __( 'Unable to accept more than %s items for this request.', 'woocommerce' ), $limit ), array( 'status' => 413 ) );
		}

		return true;
	}

	/**
	 * Bulk create, update and delete items.
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return array Of WP_Error or WP_REST_Response.
	 */
	public function batch_items( $request ) {
		/** @var WP_REST_Server $wp_rest_server */
		global $wp_rest_server;

		// Get the request params.
		$items    = array_filter( $request->get_params() );
		$response = array();

		// Check batch limit.
		$limit = $this->check_batch_limit( $items );
		if ( is_wp_error( $limit ) ) {
			return $limit;
		}

		if ( ! empty( $items['create'] ) ) {
			foreach ( $items['create'] as $item ) {
				$_item = new WP_REST_Request( 'POST' );

				// Default parameters.
				$defaults = array();
				$schema   = $this->get_public_item_schema();
				foreach ( $schema['properties'] as $arg => $options ) {
					if ( isset( $options['default'] ) ) {
						$defaults[ $arg ] = $options['default'];
					}
				}
				$_item->set_default_params( $defaults );

				// Set request parameters.
				$_item->set_body_params( $item );
				$_response = $this->create_item( $_item );

				if ( is_wp_error( $_response ) ) {
					$response['create'][] = array(
						'id'    => 0,
						'error' => array( 'code' => $_response->get_error_code(), 'message' => $_response->get_error_message(), 'data' => $_response->get_error_data() ),
					);
				} else {
					$response['create'][] = $wp_rest_server->response_to_data( $_response, '' );
				}
			}
		}

		if ( ! empty( $items['update'] ) ) {

			foreach ( $items['update'] as $item ) {
				$_item = new WP_REST_Request( 'PUT' );
				$_item->set_body_params( $item );
				$_response = $this->update_item( $_item );

				if ( is_wp_error( $_response ) ) {
					$response['update'][] = array(
						'id'    => $item['id'],
						'error' => array( 'code' => $_response->get_error_code(), 'message' => $_response->get_error_message(), 'data' => $_response->get_error_data() ),
					);
				} else {
					$response['update'][] = $wp_rest_server->response_to_data( $_response, '' );
				}
			}
		}

		if ( ! empty( $items['delete'] ) ) {

			foreach ( $items['delete'] as $id ) {
				$_item = new WP_REST_Request( 'DELETE' );
				$_item->set_query_params( array( 'id' => $id, 'force' => true ) );
				$_response = $this->delete_item( $_item );

				if ( is_wp_error( $_response ) ) {
					$response['delete'][] = array(
						'id'    => $id,
						'error' => array( 'code' => $_response->get_error_code(), 'message' => $_response->get_error_message(), 'data' => $_response->get_error_data() ),
					);
				} else {
					$response['delete'][] = $wp_rest_server->response_to_data( $_response, '' );
				}
			}
		}

		return $response;
	}

	/**
	 * Validate a text value for a text based setting.
	 *
	 * @since 2.7.0
	 * @param string $value
	 * @param array  $setting
	 * @return string
	 */
	public function validate_setting_text_field( $value, $setting ) {

		$value = is_null( $value ) ? '' : $value;
		return wp_kses_post( trim( stripslashes( $value ) ) );
		return $value;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
	}

	/**
	 * Validate select based settings.
	 *
	 * @since 2.7.0
	 * @param string $value
	 * @param array  $setting
	 * @return string|WP_Error
	 */
	public function validate_setting_select_field( $value, $setting ) {
		if ( array_key_exists( $value, $setting['options'] ) ) {

			return $value;
		} else {
			return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'woocommerce' ), array( 'status' => 400 ) );
		}
	}

	/**
	 * Validate multiselect based settings.
	 *
	 * @since 2.7.0
	 * @param array $values
	 * @param array  $setting
	 * @return string|WP_Error
	 */
	public function validate_setting_multiselect_field( $values, $setting ) {
		if ( empty( $values ) ) {
			return array();
		}

		if ( ! is_array( $values ) ) {

			return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'woocommerce' ), array( 'status' => 400 ) );
		}

		$final_values = array();
		foreach ( $values as $value ) {
			if ( array_key_exists( $value, $setting['options'] ) ) {
				$final_values[] = $value;
			}
		}

		return $final_values;
	}

	/**
	 * Validate image_width based settings.
	 *
	 * @since 2.7.0
	 * @param array $value
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param array $setting
	 * @return string|WP_Error
	 */
	public function validate_setting_image_width_field( $values, $setting ) {
		if ( ! is_array( $values ) ) {

			return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'woocommerce' ), array( 'status' => 400 ) );
		}

		$current = $setting['value'];
		if ( isset( $values['width'] ) ) {
			$current['width'] = intval( $values['width'] );
		}
		if ( isset( $values['height'] ) ) {
			$current['height'] = intval( $values['height'] );
		}
		if ( isset( $values['crop'] ) ) {
			$current['crop'] = (bool) $values['crop'];
		}
		return $current;
	}

	/**
	 * Validate radio based settings.
	 *
	 * @since 2.7.0
	 * @param string $value
	 * @param array  $setting
	 * @return string|WP_Error
	 */
	public function validate_setting_radio_field( $value, $setting ) {
		return $this->validate_setting_select_field( $value, $setting );
	}

	/**
	 * Validate checkbox based settings.
	 *
	 * @since 2.7.0
	 * @param string $value
	 * @param array  $setting
	 * @return string|WP_Error
	 */
	public function validate_setting_checkbox_field( $value, $setting ) {
		if ( in_array( $value, array( 'yes', 'no' ) ) ) {
			return $value;
		} elseif ( empty( $value ) ) {
			$value = isset( $setting['default'] ) ? $setting['default'] : 'no';
			return $value;
		} else {
			return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'woocommerce' ), array( 'status' => 400 ) );
		}
	}

	/**
	 * Validate textarea based settings.
	 *
	 * @since 2.7.0
	 * @param string $value
	 * @param array  $setting
	 * @return string
	 */
	public function validate_setting_textarea_field( $value, $setting ) {

		$value = is_null( $value ) ? '' : $value;
		return wp_kses( trim( stripslashes( $value ) ),
			array_merge(
				array(
					'iframe' => array( 'src' => true, 'style' => true, 'id' => true, 'class' => true ),
				),
				wp_kses_allowed_html( 'post' )
			)
		);
	}

	/**
	 * Get the batch schema, conforming to JSON Schema.
	 *
	 * @return array
	 */
	public function get_public_batch_schema() {
		$schema = array(
			'$schema'    => 'http://json-schema.org/draft-04/schema#',
			'title'      => 'batch',
			'type'       => 'object',
			'properties' => array(
				'create' => array(
					'description' => __( 'List of created resources.', 'woocommerce' ),
					'type'        => 'array',
					'context'     => array( 'view', 'edit' ),
				),
				'update' => array(
					'description' => __( 'List of updated resources.', 'woocommerce' ),
					'type'        => 'array',
					'context'     => array( 'view', 'edit' ),
				),
				'delete' => array(
					'description' => __( 'List of delete resources.', 'woocommerce' ),
					'type'        => 'array',
					'context'     => array( 'view', 'edit' ),
				),
			),
		);

		return $schema;
	}
}


1		<?php
2
3		if ( ! defined( 'ABSPATH' ) ) {
4		exit;
5		}
6
7		/**
8		* Abstract Rest Controler Class
9		*
10		* @author WooThemes
11		* @category API
12		* @package WooCommerce/Abstracts
13		* @extends WP_REST_Controller
14		* @version 2.6.0
15		*/
16		abstract class WC_REST_Controller extends WP_REST_Controller {
17
18		/**
19		* Endpoint namespace.
20		*
21		* @var string
22		*/
23		protected $namespace = 'wc/v1';
24
25		/**
26		* Route base.
27		*
28		* @var string
29		*/
30		protected $rest_base = '';
31
32		/**
33		* Add the schema from additional fields to an schema array.
34		*
35		* The type of object is inferred from the passed schema.
36		*
37		* @param array $schema Schema array.
38		*/
39		protected function add_additional_fields_schema( $schema ) {
40		if ( empty( $schema['title'] ) ) {
41		return $schema;
42		}
43
44		/**
45		* Can't use $this->get_object_type otherwise we cause an inf loop.
46		*/
47		$object_type = $schema['title'];
48
49		$additional_fields = $this->get_additional_fields( $object_type );
50
51	View Code Duplication	foreach ( $additional_fields as $field_name => $field_options ) {
		0 ignored issues – show Duplication introduced 2016-06-03 18:04 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
52		if ( ! $field_options['schema'] ) {
53		continue;
54		}
55
56		$schema['properties'][ $field_name ] = $field_options['schema'];
57		}
58
59		$schema['properties'] = apply_filters( 'woocommerce_rest_' . $object_type . '_schema', $schema['properties'] );
60
61		return $schema;
62		}
63
64		/**
65		* Get normalized rest base.
66		*
67		* @return string
68		*/
69		protected function get_normalized_rest_base() {
70		return preg_replace( '/\(.*\)\//i', '', $this->rest_base );
71		}
72
73		/**
74		* Check batch limit.
75		*
76		* @param array $items Request items.
77		* @return bool\|WP_Error
78		*/
79		protected function check_batch_limit( $items ) {
80		$limit = apply_filters( 'woocommerce_rest_batch_items_limit', 100, $this->get_normalized_rest_base() );
81		$total = 0;
82
83		if ( ! empty( $items['create'] ) ) {
84		$total += count( $items['create'] );
85		}
86
87		if ( ! empty( $items['update'] ) ) {
88		$total += count( $items['update'] );
89		}
90
91		if ( ! empty( $items['delete'] ) ) {
92		$total += count( $items['delete'] );
93		}
94
95	View Code Duplication	if ( $total > $limit ) {
		0 ignored issues – show Duplication introduced 2016-05-09 21:29 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
96		return new WP_Error( 'woocommerce_rest_request_entity_too_large', sprintf( __( 'Unable to accept more than %s items for this request.', 'woocommerce' ), $limit ), array( 'status' => 413 ) );
97		}
98
99		return true;
100		}
101
102		/**
103		* Bulk create, update and delete items.
104		*
105		* @param WP_REST_Request $request Full details about the request.
106		* @return array Of WP_Error or WP_REST_Response.
107		*/
108		public function batch_items( $request ) {
109		/** @var WP_REST_Server $wp_rest_server */
110		global $wp_rest_server;
111
112		// Get the request params.
113		$items = array_filter( $request->get_params() );
114		$response = array();
115
116		// Check batch limit.
117		$limit = $this->check_batch_limit( $items );
118		if ( is_wp_error( $limit ) ) {
119		return $limit;
120		}
121
122		if ( ! empty( $items['create'] ) ) {
123		foreach ( $items['create'] as $item ) {
124		$_item = new WP_REST_Request( 'POST' );
125
126		// Default parameters.
127		$defaults = array();
128		$schema = $this->get_public_item_schema();
129		foreach ( $schema['properties'] as $arg => $options ) {
130		if ( isset( $options['default'] ) ) {
131		$defaults[ $arg ] = $options['default'];
132		}
133		}
134		$_item->set_default_params( $defaults );
135
136		// Set request parameters.
137		$_item->set_body_params( $item );
138		$_response = $this->create_item( $_item );
139
140		if ( is_wp_error( $_response ) ) {
141		$response['create'][] = array(
142		'id' => 0,
143		'error' => array( 'code' => $_response->get_error_code(), 'message' => $_response->get_error_message(), 'data' => $_response->get_error_data() ),
144		);
145		} else {
146		$response['create'][] = $wp_rest_server->response_to_data( $_response, '' );
147		}
148		}
149		}
150
151	View Code Duplication	if ( ! empty( $items['update'] ) ) {
		0 ignored issues – show Duplication introduced 2016-05-09 21:29 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
152		foreach ( $items['update'] as $item ) {
153		$_item = new WP_REST_Request( 'PUT' );
154		$_item->set_body_params( $item );
155		$_response = $this->update_item( $_item );
156
157		if ( is_wp_error( $_response ) ) {
158		$response['update'][] = array(
159		'id' => $item['id'],
160		'error' => array( 'code' => $_response->get_error_code(), 'message' => $_response->get_error_message(), 'data' => $_response->get_error_data() ),
161		);
162		} else {
163		$response['update'][] = $wp_rest_server->response_to_data( $_response, '' );
164		}
165		}
166		}
167
168	View Code Duplication	if ( ! empty( $items['delete'] ) ) {
		0 ignored issues – show Duplication introduced 2016-05-09 21:29 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
169		foreach ( $items['delete'] as $id ) {
170		$_item = new WP_REST_Request( 'DELETE' );
171		$_item->set_query_params( array( 'id' => $id, 'force' => true ) );
172		$_response = $this->delete_item( $_item );
173
174		if ( is_wp_error( $_response ) ) {
175		$response['delete'][] = array(
176		'id' => $id,
177		'error' => array( 'code' => $_response->get_error_code(), 'message' => $_response->get_error_message(), 'data' => $_response->get_error_data() ),
178		);
179		} else {
180		$response['delete'][] = $wp_rest_server->response_to_data( $_response, '' );
181		}
182		}
183		}
184
185		return $response;
186		}
187
188		/**
189		* Validate a text value for a text based setting.
190		*
191		* @since 2.7.0
192		* @param string $value
193		* @param array $setting
194		* @return string
195		*/
196		public function validate_setting_text_field( $value, $setting ) {
		0 ignored issues – show Unused Code introduced 2016-09-08 22:55 UTC by Report Bug Copy Issue Report The parameter `$setting` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
197		$value = is_null( $value ) ? '' : $value;
198		return wp_kses_post( trim( stripslashes( $value ) ) );
199		return $value;
		0 ignored issues – show Unused Code introduced 2016-09-08 22:55 UTC by Report Bug Copy Issue Report `return $value;` 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...
200		}
201
202		/**
203		* Validate select based settings.
204		*
205		* @since 2.7.0
206		* @param string $value
207		* @param array $setting
208		* @return string\|WP_Error
209		*/
210		public function validate_setting_select_field( $value, $setting ) {
211	View Code Duplication	if ( array_key_exists( $value, $setting['options'] ) ) {
		0 ignored issues – show Duplication introduced 2016-09-08 22:55 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
212		return $value;
213		} else {
214		return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'woocommerce' ), array( 'status' => 400 ) );
215		}
216		}
217
218		/**
219		* Validate multiselect based settings.
220		*
221		* @since 2.7.0
222		* @param array $values
223		* @param array $setting
224		* @return string\|WP_Error
225		*/
226		public function validate_setting_multiselect_field( $values, $setting ) {
227		if ( empty( $values ) ) {
228		return array();
229		}
230
231	View Code Duplication	if ( ! is_array( $values ) ) {
		0 ignored issues – show Duplication introduced 2016-09-08 22:55 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
232		return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'woocommerce' ), array( 'status' => 400 ) );
233		}
234
235		$final_values = array();
236		foreach ( $values as $value ) {
237		if ( array_key_exists( $value, $setting['options'] ) ) {
238		$final_values[] = $value;
239		}
240		}
241
242		return $final_values;
243		}
244
245		/**
246		* Validate image_width based settings.
247		*
248		* @since 2.7.0
249		* @param array $value
		0 ignored issues – show Documentation introduced 2016-09-08 22:55 UTC by Report Bug Copy Issue Report There is no parameter named `$value`. Did you maybe mean `$values`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
250		* @param array $setting
251		* @return string\|WP_Error
252		*/
253		public function validate_setting_image_width_field( $values, $setting ) {
254	View Code Duplication	if ( ! is_array( $values ) ) {
		0 ignored issues – show Duplication introduced 2016-09-08 22:55 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
255		return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'woocommerce' ), array( 'status' => 400 ) );
256		}
257
258		$current = $setting['value'];
259		if ( isset( $values['width'] ) ) {
260		$current['width'] = intval( $values['width'] );
261		}
262		if ( isset( $values['height'] ) ) {
263		$current['height'] = intval( $values['height'] );
264		}
265		if ( isset( $values['crop'] ) ) {
266		$current['crop'] = (bool) $values['crop'];
267		}
268		return $current;
269		}
270
271		/**
272		* Validate radio based settings.
273		*
274		* @since 2.7.0
275		* @param string $value
276		* @param array $setting
277		* @return string\|WP_Error
278		*/
279		public function validate_setting_radio_field( $value, $setting ) {
280		return $this->validate_setting_select_field( $value, $setting );
281		}
282
283		/**
284		* Validate checkbox based settings.
285		*
286		* @since 2.7.0
287		* @param string $value
288		* @param array $setting
289		* @return string\|WP_Error
290		*/
291		public function validate_setting_checkbox_field( $value, $setting ) {
292		if ( in_array( $value, array( 'yes', 'no' ) ) ) {
293		return $value;
294		} elseif ( empty( $value ) ) {
295		$value = isset( $setting['default'] ) ? $setting['default'] : 'no';
296		return $value;
297		} else {
298		return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'woocommerce' ), array( 'status' => 400 ) );
299		}
300		}
301
302		/**
303		* Validate textarea based settings.
304		*
305		* @since 2.7.0
306		* @param string $value
307		* @param array $setting
308		* @return string
309		*/
310	View Code Duplication	public function validate_setting_textarea_field( $value, $setting ) {
		0 ignored issues – show Unused Code introduced 2016-09-08 22:55 UTC by Report Bug Copy Issue Report The parameter `$setting` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Duplication introduced 2016-09-08 22:55 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
311		$value = is_null( $value ) ? '' : $value;
312		return wp_kses( trim( stripslashes( $value ) ),
313		array_merge(
314		array(
315		'iframe' => array( 'src' => true, 'style' => true, 'id' => true, 'class' => true ),
316		),
317		wp_kses_allowed_html( 'post' )
318		)
319		);
320		}
321
322		/**
323		* Get the batch schema, conforming to JSON Schema.
324		*
325		* @return array
326		*/
327		public function get_public_batch_schema() {
328		$schema = array(
329		'$schema' => 'http://json-schema.org/draft-04/schema#',
330		'title' => 'batch',
331		'type' => 'object',
332		'properties' => array(
333		'create' => array(
334		'description' => __( 'List of created resources.', 'woocommerce' ),
335		'type' => 'array',
336		'context' => array( 'view', 'edit' ),
337		),
338		'update' => array(
339		'description' => __( 'List of updated resources.', 'woocommerce' ),
340		'type' => 'array',
341		'context' => array( 'view', 'edit' ),
342		),
343		'delete' => array(
344		'description' => __( 'List of delete resources.', 'woocommerce' ),
345		'type' => 'array',
346		'context' => array( 'view', 'edit' ),
347		),
348		),
349		);
350
351		return $schema;
352		}
353		}
354

woothemes / woocommerce