WebDevStudios / CMB2

includes/CMB2_REST_Controller.php

Doc Comments +1 added lines, -3 removed lines

@@ -142,7 +142,6 @@ 
 	 *
 	 * @since 2.2.4
 	 *
-	 * @param  mixed $data
 	 * @return array $data
 	 */
 	public function prepare_item( $post ) {
@@ -155,7 +154,7 @@ 
 	 * @since  2.2.4
 	 *
 	 * @param  mixed $cb Callable function/method.
-	 * @return mixed     Results of output buffer after calling function/method.
+	 * @return string     Results of output buffer after calling function/method.
 	 */
 	public function get_cb_results( $cb ) {
 		$args = func_get_args();
@@ -171,7 +170,6 @@ 
 	 *
 	 * @since 2.2.4
 	 *
-	 * @param  mixed            $item     WordPress representation of the item.
 	 * @param  WP_REST_Request  $request  Request object.
 	 * @return WP_REST_Response $response
 	 */

Spacing +7 added lines, -7 removed lines

@@ -226,7 +226,7 @@ 
 	 * @return WP_REST_Response $response
 	 */
 	public function prepare_item_for_response( $data, $request = null ) {
-		$data = $this->filter_response_by_context( $data, $this->request['context'] );
+		$data = $this->filter_response_by_context( $data, $this->request[ 'context' ] );
 
 		/**
 		 * Filter the prepared CMB2 item response.
@@ -297,12 +297,12 @@ 
 
 		} else {
 
-			if ( isset( $this->request['object_id'] ) ) {
-				$this->rest_box->cmb->object_id( sanitize_text_field( $this->request['object_id'] ) );
+			if ( isset( $this->request[ 'object_id' ] ) ) {
+				$this->rest_box->cmb->object_id( sanitize_text_field( $this->request[ 'object_id' ] ) );
 			}
 
-			if ( isset( $this->request['object_type'] ) ) {
-				$this->rest_box->cmb->object_type( sanitize_text_field( $this->request['object_type'] ) );
+			if ( isset( $this->request[ 'object_type' ] ) ) {
+				$this->rest_box->cmb->object_type( sanitize_text_field( $this->request[ 'object_type' ] ) );
 			}
 		}
 	}
@@ -320,8 +320,8 @@ 
 	public function initiate_request( $request, $request_type ) {
 		$this->request = $request;
 
-		if ( ! isset( $this->request['context'] ) || empty( $this->request['context'] ) ) {
-			$this->request['context'] = 'view';
+		if ( ! isset( $this->request[ 'context' ] ) || empty( $this->request[ 'context' ] ) ) {
+			$this->request[ 'context' ] = 'view';
 		}
 
 		if ( ! self::$request_type ) {

includes/shim/WP_REST_Controller.php

Spacing +37 added lines, -37 removed lines

@@ -166,7 +166,7 @@ 
 		}
 
 		if ( ! empty( $links ) ) {
-			$data['_links'] = $links;
+			$data[ '_links' ] = $links;
 		}
 
 		return $data;
@@ -183,21 +183,21 @@ 
 
 		$schema = $this->get_item_schema();
 		foreach ( $data as $key => $value ) {
-			if ( empty( $schema['properties'][ $key ] ) || empty( $schema['properties'][ $key ]['context'] ) ) {
+			if ( empty( $schema[ 'properties' ][ $key ] ) || empty( $schema[ 'properties' ][ $key ][ 'context' ] ) ) {
 				continue;
 			}
 
-			if ( ! in_array( $context, $schema['properties'][ $key ]['context'] ) ) {
+			if ( ! in_array( $context, $schema[ 'properties' ][ $key ][ 'context' ] ) ) {
 				unset( $data[ $key ] );
 				continue;
 			}
 
-			if ( 'object' === $schema['properties'][ $key ]['type'] && ! empty( $schema['properties'][ $key ]['properties'] ) ) {
-				foreach ( $schema['properties'][ $key ]['properties'] as $attribute => $details ) {
-					if ( empty( $details['context'] ) ) {
+			if ( 'object' === $schema[ 'properties' ][ $key ][ 'type' ] && ! empty( $schema[ 'properties' ][ $key ][ 'properties' ] ) ) {
+				foreach ( $schema[ 'properties' ][ $key ][ 'properties' ] as $attribute => $details ) {
+					if ( empty( $details[ 'context' ] ) ) {
 						continue;
 					}
-					if ( ! in_array( $context, $details['context'] ) ) {
+					if ( ! in_array( $context, $details[ 'context' ] ) ) {
 						if ( isset( $data[ $key ][ $attribute ] ) ) {
 							unset( $data[ $key ][ $attribute ] );
 						}
@@ -227,9 +227,9 @@ 
 
 		$schema = $this->get_item_schema();
 
-		foreach ( $schema['properties'] as &$property ) {
-			if ( isset( $property['arg_options'] ) ) {
-				unset( $property['arg_options'] );
+		foreach ( $schema[ 'properties' ] as &$property ) {
+			if ( isset( $property[ 'arg_options' ] ) ) {
+				unset( $property[ 'arg_options' ] );
 			}
 		}
 
@@ -286,18 +286,18 @@ 
 			'validate_callback'  => 'rest_validate_request_arg',
 		);
 		$schema = $this->get_item_schema();
-		if ( empty( $schema['properties'] ) ) {
+		if ( empty( $schema[ 'properties' ] ) ) {
 			return array_merge( $param_details, $args );
 		}
 		$contexts = array();
-		foreach ( $schema['properties'] as $attributes ) {
-			if ( ! empty( $attributes['context'] ) ) {
-				$contexts = array_merge( $contexts, $attributes['context'] );
+		foreach ( $schema[ 'properties' ] as $attributes ) {
+			if ( ! empty( $attributes[ 'context' ] ) ) {
+				$contexts = array_merge( $contexts, $attributes[ 'context' ] );
 			}
 		}
 		if ( ! empty( $contexts ) ) {
-			$param_details['enum'] = array_unique( $contexts );
-			rsort( $param_details['enum'] );
+			$param_details[ 'enum' ] = array_unique( $contexts );
+			rsort( $param_details[ 'enum' ] );
 		}
 		return array_merge( $param_details, $args );
 	}
@@ -315,11 +315,11 @@ 
 
 		foreach ( $additional_fields as $field_name => $field_options ) {
 
-			if ( ! $field_options['get_callback'] ) {
+			if ( ! $field_options[ 'get_callback' ] ) {
 				continue;
 			}
 
-			$object[ $field_name ] = call_user_func( $field_options['get_callback'], $object, $field_name, $request, $this->get_object_type() );
+			$object[ $field_name ] = call_user_func( $field_options[ 'get_callback' ], $object, $field_name, $request, $this->get_object_type() );
 		}
 
 		return $object;
@@ -337,7 +337,7 @@ 
 
 		foreach ( $additional_fields as $field_name => $field_options ) {
 
-			if ( ! $field_options['update_callback'] ) {
+			if ( ! $field_options[ 'update_callback' ] ) {
 				continue;
 			}
 
@@ -346,7 +346,7 @@ 
 				continue;
 			}
 
-			call_user_func( $field_options['update_callback'], $request[ $field_name ], $object, $field_name, $request, $this->get_object_type() );
+			call_user_func( $field_options[ 'update_callback' ], $request[ $field_name ], $object, $field_name, $request, $this->get_object_type() );
 		}
 	}
 
@@ -358,23 +358,23 @@ 
 	 * @param array $schema Schema array.
 	 */
 	protected function add_additional_fields_schema( $schema ) {
-		if ( empty( $schema['title'] ) ) {
+		if ( empty( $schema[ 'title' ] ) ) {
 			return $schema;
 		}
 
 		/**
 		 * Can't use $this->get_object_type otherwise we cause an inf loop.
 		 */
-		$object_type = $schema['title'];
+		$object_type = $schema[ 'title' ];
 
 		$additional_fields = $this->get_additional_fields( $object_type );
 
 		foreach ( $additional_fields as $field_name => $field_options ) {
-			if ( ! $field_options['schema'] ) {
+			if ( ! $field_options[ 'schema' ] ) {
 				continue;
 			}
 
-			$schema['properties'][ $field_name ] = $field_options['schema'];
+			$schema[ 'properties' ][ $field_name ] = $field_options[ 'schema' ];
 		}
 
 		return $schema;
@@ -413,11 +413,11 @@ 
 	protected function get_object_type() {
 		$schema = $this->get_item_schema();
 
-		if ( ! $schema || ! isset( $schema['title'] ) ) {
+		if ( ! $schema || ! isset( $schema[ 'title' ] ) ) {
 			return null;
 		}
 
-		return $schema['title'];
+		return $schema[ 'title' ];
 	}
 
 	/**
@@ -433,13 +433,13 @@ 
 	public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CREATABLE ) {
 
 		$schema                = $this->get_item_schema();
-		$schema_properties     = ! empty( $schema['properties'] ) ? $schema['properties'] : array();
+		$schema_properties     = ! empty( $schema[ 'properties' ] ) ? $schema[ 'properties' ] : array();
 		$endpoint_args = array();
 
 		foreach ( $schema_properties as $field_id => $params ) {
 
 			// Arguments specified as `readonly` are not allowed to be set.
-			if ( ! empty( $params['readonly'] ) ) {
+			if ( ! empty( $params[ 'readonly' ] ) ) {
 				continue;
 			}
 
@@ -448,16 +448,16 @@ 
 				'sanitize_callback' => 'rest_sanitize_request_arg',
 			);
 
-			if ( isset( $params['description'] ) ) {
-				$endpoint_args[ $field_id ]['description'] = $params['description'];
+			if ( isset( $params[ 'description' ] ) ) {
+				$endpoint_args[ $field_id ][ 'description' ] = $params[ 'description' ];
 			}
 
-			if ( WP_REST_Server::CREATABLE === $method && isset( $params['default'] ) ) {
-				$endpoint_args[ $field_id ]['default'] = $params['default'];
+			if ( WP_REST_Server::CREATABLE === $method && isset( $params[ 'default' ] ) ) {
+				$endpoint_args[ $field_id ][ 'default' ] = $params[ 'default' ];
 			}
 
-			if ( WP_REST_Server::CREATABLE === $method && ! empty( $params['required'] ) ) {
-				$endpoint_args[ $field_id ]['required'] = true;
+			if ( WP_REST_Server::CREATABLE === $method && ! empty( $params[ 'required' ] ) ) {
+				$endpoint_args[ $field_id ][ 'required' ] = true;
 			}
 
 			foreach ( array( 'type', 'format', 'enum' ) as $schema_prop ) {
@@ -467,14 +467,14 @@ 
 			}
 
 			// Merge in any options provided by the schema property.
-			if ( isset( $params['arg_options'] ) ) {
+			if ( isset( $params[ 'arg_options' ] ) ) {
 
 				// Only use required / default from arg_options on CREATABLE endpoints.
 				if ( WP_REST_Server::CREATABLE !== $method ) {
-					$params['arg_options'] = array_diff_key( $params['arg_options'], array( 'required' => '', 'default' => '' ) );
+					$params[ 'arg_options' ] = array_diff_key( $params[ 'arg_options' ], array( 'required' => '', 'default' => '' ) );
 				}
 
-				$endpoint_args[ $field_id ] = array_merge( $endpoint_args[ $field_id ], $params['arg_options'] );
+				$endpoint_args[ $field_id ] = array_merge( $endpoint_args[ $field_id ], $params[ 'arg_options' ] );
 			}
 		}
 

includes/CMB2_REST_Controller_Boxes.php

Spacing +8 added lines, -8 removed lines

@@ -87,7 +87,7 @@ 
 		foreach ( CMB2_REST::$boxes as $this->rest_box ) {
 			if ( $this->rest_box->rest_read ) {
 				$rest_box = $this->get_rest_box();
-				$boxes_data[ $this->rest_box->cmb->cmb_id ] = $this->server->response_to_data( $rest_box, isset( $this->request['_embed'] ) );
+				$boxes_data[ $this->rest_box->cmb->cmb_id ] = $this->server->response_to_data( $rest_box, isset( $this->request[ '_embed' ] ) );
 			}
 		}
 
@@ -124,9 +124,9 @@ 
 
 		$boxes_data = $cmb->meta_box;
 
-		if ( isset( $this->request['_rendered'] ) && $this->namespace_base !== CMB2_REST_Controller::get_intial_route() ) {
-			$boxes_data['form_open'] = $this->get_cb_results( array( $cmb, 'render_form_open' ) );
-			$boxes_data['form_close'] = $this->get_cb_results( array( $cmb, 'render_form_close' ) );
+		if ( isset( $this->request[ '_rendered' ] ) && $this->namespace_base !== CMB2_REST_Controller::get_intial_route() ) {
+			$boxes_data[ 'form_open' ] = $this->get_cb_results( array( $cmb, 'render_form_open' ) );
+			$boxes_data[ 'form_close' ] = $this->get_cb_results( array( $cmb, 'render_form_close' ) );
 
 			global $wp_scripts, $wp_styles;
 			$before_css = $wp_styles->queue;
@@ -134,15 +134,15 @@ 
 
 			CMB2_JS::enqueue();
 
-			$boxes_data['js_dependencies'] = array_values( array_diff( $wp_scripts->queue, $before_js ) );
-			$boxes_data['css_dependencies'] = array_values( array_diff( $wp_styles->queue, $before_css ) );
+			$boxes_data[ 'js_dependencies' ] = array_values( array_diff( $wp_scripts->queue, $before_js ) );
+			$boxes_data[ 'css_dependencies' ] = array_values( array_diff( $wp_styles->queue, $before_css ) );
 		}
 
 		// TODO: look into 'embed' parameter.
 		// http://demo.wp-api.org/wp-json/wp/v2/posts?_embed
-		unset( $boxes_data['fields'] );
+		unset( $boxes_data[ 'fields' ] );
 		// Handle callable properties.
-		unset( $boxes_data['show_on_cb'] );
+		unset( $boxes_data[ 'show_on_cb' ] );
 
 		$response = rest_ensure_response( $boxes_data );
 

includes/CMB2_REST_Controller_Fields.php

Spacing +14 added lines, -14 removed lines

@@ -72,11 +72,11 @@ 
 
 		$fields = array();
 		foreach ( $this->rest_box->cmb->prop( 'fields', array() ) as $field ) {
-			$field_id = $field['id'];
+			$field_id = $field[ 'id' ];
 			$rest_field = $this->get_rest_field( $field_id );
 
 			if ( ! is_wp_error( $rest_field ) ) {
-				$fields[ $field_id ] = $this->server->response_to_data( $rest_field, isset( $this->request['_embed'] ) );
+				$fields[ $field_id ] = $this->server->response_to_data( $rest_field, isset( $this->request[ '_embed' ] ) );
 			} else {
 				$fields[ $field_id ] = array( 'error' => $rest_field->get_error_message() );
 			}
@@ -120,7 +120,7 @@ 
 	public function update_field_value( $request ) {
 		$this->initiate_rest_read_box( $request, 'field_value_update' );
 
-		if ( ! $this->request['value'] ) {
+		if ( ! $this->request[ 'value' ] ) {
 			return new WP_Error( 'cmb2_rest_update_field_error', __( 'CMB2 Field value cannot be updated without the value parameter specified.', 'cmb2' ), array( 'status' => 400 ) );
 		}
 
@@ -156,7 +156,7 @@ 
 	 */
 	public function modify_field_value( $activity, $field ) {
 
-		if ( ! $this->request['object_id'] || ! $this->request['object_type'] ) {
+		if ( ! $this->request[ 'object_id' ] || ! $this->request[ 'object_type' ] ) {
 			return new WP_Error( 'cmb2_rest_modify_field_value_error', __( 'CMB2 Field value cannot be modified without the object_id and object_type parameters specified.', 'cmb2' ), array( 'status' => 400 ) );
 		}
 
@@ -168,13 +168,13 @@ 
 			return new WP_Error( 'cmb2_rest_no_field_by_id_error', __( 'No field found by that id.', 'cmb2' ), array( 'status' => 403 ) );
 		}
 
-		$field->args["value_{$activity}"] = (bool) 'deleted' === $activity
+		$field->args[ "value_{$activity}" ] = (bool) 'deleted' === $activity
 			? $field->remove_data()
-			: $field->save_field( $this->request['value'] );
+			: $field->save_field( $this->request[ 'value' ] );
 
 		// If options page, save the $activity options
-		if ( 'options-page' == $this->request['object_type'] ) {
-			$field->args["value_{$activity}"] = cmb2_options( $this->request['object_id'] )->set();
+		if ( 'options-page' == $this->request[ 'object_type' ] ) {
+			$field->args[ "value_{$activity}" ] = cmb2_options( $this->request[ 'object_id' ] )->set();
 		}
 
 		$field_data = $this->get_rest_field( $field );
@@ -243,13 +243,13 @@ 
 				$value = $field->options();
 			} elseif ( in_array( $key, CMB2_Field::$callable_fields, true ) ) {
 
-				if ( isset( $this->request['_rendered'] ) ) {
+				if ( isset( $this->request[ '_rendered' ] ) ) {
 					$value = $key === 'render_row_cb' ? $rendered : $field->get_param_callback_result( $key );
 				} elseif ( is_array( $value ) ) {
 					// We need to rewrite callbacks as string as they will cause
 					// JSON recursion errors.
-					$class = is_string( $value[0] ) ? $value[0] : get_class( $value[0] );
-					$value = $class . '::' . $value[1];
+					$class = is_string( $value[ 0 ] ) ? $value[ 0 ] : get_class( $value[ 0 ] );
+					$value = $class . '::' . $value[ 1 ];
 				}
 			}
 
@@ -262,8 +262,8 @@ 
 			}
 		}
 
-		if ( $this->request['object_id'] && $this->request['object_type'] ) {
-			$field_data['value'] = $field->get_data();
+		if ( $this->request[ 'object_id' ] && $this->request[ 'object_type' ] ) {
+			$field_data[ 'value' ] = $field->get_data();
 		}
 
 		return $field_data;
@@ -296,7 +296,7 @@ 
 
 		// Don't embed boxes when looking at boxes route.
 		if ( '/cmb2/v1/boxes' !== CMB2_REST_Controller::get_intial_route() ) {
-			$links['up']['embeddable'] = true;
+			$links[ 'up' ][ 'embeddable' ] = true;
 		}
 
 		return $links;

includes/CMB2_REST.php

Doc Comments +6 added lines, -5 removed lines

@@ -186,6 +186,7 @@ 
 	 * @param string|array $object_types Object(s) the field is being registered
 	 *                                   to, "post"|"term"|"comment" etc.
 	 * @param string $object_types       Canonical object type for callbacks.
+	 * @param string $object_type
 	 *
 	 * @return void
 	 */
@@ -383,7 +384,7 @@ 
 	 *
 	 * @since  2.2.4
 	 *
-	 * @param  mixed           $value       The value of the field
+	 * @param  mixed           $values       The value of the field
 	 * @param  object          $object      The object from the response
 	 * @param  string          $field_name  Name of field
 	 * @param  WP_REST_Request $request     Current request
@@ -402,7 +403,7 @@ 
 	 *
 	 * @since  2.2.4
 	 *
-	 * @param  mixed           $value       The value of the field
+	 * @param  mixed           $values       The value of the field
 	 * @param  object          $object      The object from the response
 	 * @param  string          $field_name  Name of field
 	 * @param  WP_REST_Request $request     Current request
@@ -421,7 +422,7 @@ 
 	 *
 	 * @since  2.2.4
 	 *
-	 * @param  mixed           $value       The value of the field
+	 * @param  mixed           $values       The value of the field
 	 * @param  object          $object      The object from the response
 	 * @param  string          $field_name  Name of field
 	 * @param  WP_REST_Request $request     Current request
@@ -440,7 +441,7 @@ 
 	 *
 	 * @since  2.2.4
 	 *
-	 * @param  mixed           $value       The value of the field
+	 * @param  mixed           $values       The value of the field
 	 * @param  object          $object      The object from the response
 	 * @param  string          $field_name  Name of field
 	 * @param  WP_REST_Request $request     Current request
@@ -459,7 +460,7 @@ 
 	 *
 	 * @since  2.2.4
 	 *
-	 * @param  mixed           $value            The value of the field
+	 * @param  mixed           $values            The value of the field
 	 * @param  object          $object           The object from the response
 	 * @param  WP_REST_Request $request          Current request
 	 * @param  string          $object_type      The request object type

Spacing +16 added lines, -16 removed lines

@@ -133,18 +133,18 @@ 
 		foreach ( self::$boxes as $cmb_id => $rest_box ) {
 			$types = array_flip( $rest_box->cmb->box_types() );
 
-			if ( isset( $types['user'] ) ) {
-				unset( $types['user'] );
+			if ( isset( $types[ 'user' ] ) ) {
+				unset( $types[ 'user' ] );
 				$has_user = true;
 			}
 
-			if ( isset( $types['comment'] ) ) {
-				unset( $types['comment'] );
+			if ( isset( $types[ 'comment' ] ) ) {
+				unset( $types[ 'comment' ] );
 				$has_comment = true;
 			}
 
-			if ( isset( $types['term'] ) ) {
-				unset( $types['term'] );
+			if ( isset( $types[ 'term' ] ) ) {
+				unset( $types[ 'term' ] );
 
 				$taxonomies = array_merge(
 					$taxonomies,
@@ -206,18 +206,18 @@ 
 	 */
 	protected function declare_read_edit_fields() {
 		foreach ( $this->cmb->prop( 'fields' ) as $field ) {
-			$show_in_rest = isset( $field['show_in_rest'] ) ? $field['show_in_rest'] : null;
+			$show_in_rest = isset( $field[ 'show_in_rest' ] ) ? $field[ 'show_in_rest' ] : null;
 
 			if ( false === $show_in_rest ) {
 				continue;
 			}
 
 			if ( $this->can_read( $show_in_rest ) ) {
-				$this->read_fields[] = $field['id'];
+				$this->read_fields[ ] = $field[ 'id' ];
 			}
 
 			if ( $this->can_edit( $show_in_rest ) ) {
-				$this->edit_fields[] = $field['id'];
+				$this->edit_fields[ ] = $field[ 'id' ];
 			}
 
 		}
@@ -348,7 +348,7 @@ 
 	 * @return mixed
 	 */
 	protected static function get_rest_values( $object, $request, $object_type, $main_object_type = 'post' ) {
-		if ( ! isset( $object['id'] ) ) {
+		if ( ! isset( $object[ 'id' ] ) ) {
 			return;
 		}
 
@@ -363,12 +363,12 @@ 
 			}
 
 			foreach ( $rest_box->read_fields as $field_id ) {
-				$rest_box->cmb->object_id( $object['id'] );
+				$rest_box->cmb->object_id( $object[ 'id' ] );
 				$rest_box->cmb->object_type( $main_object_type );
 
 				$field = $rest_box->cmb->get_field( $field_id );
 
-				$field->object_id( $object['id'] );
+				$field->object_id( $object[ 'id' ] );
 				$field->object_type( $main_object_type );
 
 				$values[ $cmb_id ][ $field->id( true ) ] = $field->get_data();
@@ -486,8 +486,8 @@ 
 				continue;
 			}
 
-			$rest_box->cmb->object_id( $data['object_id'] );
-			$rest_box->cmb->object_type( $data['object_type'] );
+			$rest_box->cmb->object_id( $data[ 'object_id' ] );
+			$rest_box->cmb->object_type( $data[ 'object_type' ] );
 
 			// TODO: Test since refactor.
 			$updated[ $cmb_id ] = $rest_box->sanitize_box_values( $values );
@@ -595,8 +595,8 @@ 
 		} elseif ( isset( $object->comment_ID ) ) {
 			$object_id   = intval( $object->comment_ID );
 			$object_type = 'comment';
-		} elseif ( is_array( $object ) && isset( $object['term_id'] ) ) {
-			$object_id   = intval( $object['term_id'] );
+		} elseif ( is_array( $object ) && isset( $object[ 'term_id' ] ) ) {
+			$object_id   = intval( $object[ 'term_id' ] );
 			$object_type = 'term';
 		} elseif ( isset( $object->term_id ) ) {
 			$object_id   = intval( $object->term_id );