WebDevStudios / CMB2

includes/CMB2_REST.php

Doc Comments +4 added lines, -1 removed lines

@@ -152,7 +152,7 @@ 
 	/**
 	 * Handler for updating custom field data.
 	 * @since  2.2.0
-	 * @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_id Name of field
 	 * @return bool|int
@@ -233,6 +233,9 @@ 
 		return $protected;
 	}
 
+	/**
+	 * @param string $field_id
+	 */
 	public function field_can_update( $field_id ) {
 
 		$field        = $this->cmb->get_field( $field_id );

Spacing +9 added lines, -9 removed lines

@@ -120,18 +120,18 @@ 
 
 	protected function declare_read_write_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_write( $show_in_rest ) ) {
-				$this->write_fields[] = $field['id'];
+				$this->write_fields[ ] = $field[ 'id' ];
 			}
 
 		}
@@ -159,14 +159,14 @@ 
 	 */
 	public static function get_restable_field_values( $object, $field_id, $request ) {
 		$values = array();
-		if ( ! isset( $object['id'] ) ) {
+		if ( ! isset( $object[ 'id' ] ) ) {
 			return;
 		}
 
 		foreach ( self::$boxes as $cmb_id => $rest_box ) {
 			foreach ( $rest_box->read_fields as $field_id ) {
 				$field = $rest_box->cmb->get_field( $field_id );
-				$field->object_id = $object['id'];
+				$field->object_id = $object[ 'id' ];
 
 				// TODO: test other object types (users, comments, etc)
 				if ( isset( $object->type ) ) {
@@ -205,8 +205,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 );
@@ -304,8 +304,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 );

includes/CMB2_REST_Controller.php

Doc Comments +4 added lines, -2 removed lines

@@ -94,7 +94,6 @@ 
 	 *
 	 * @since 2.2.0
 	 *
-	 * @param  mixed $data
 	 * @return array $data
 	 */
 	public function prepare_item( $post ) {
@@ -107,7 +106,7 @@ 
 	 * @since  2.2.0
 	 *
 	 * @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();
@@ -142,6 +141,9 @@ 
 		return apply_filters( 'cmb2_rest_prepare', rest_ensure_response( $data ), $this->request, $this );
 	}
 
+	/**
+	 * @param string $request_type
+	 */
 	protected function initiate_rest_read_box( $request, $request_type ) {
 		$this->initiate_rest_box( $request, $request_type );
 

Spacing +7 added lines, -7 removed lines

@@ -128,7 +128,7 @@ 
 	 * @return array $data
 	 */
 	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.
@@ -170,16 +170,16 @@ 
 
 	public function initiate_request( $request, $request_type ) {
 		$this->request = $request;
-		$this->request['context'] = isset( $this->request['context'] ) && ! empty( $this->request['context'] )
-			? $this->request['context']
+		$this->request[ 'context' ] = isset( $this->request[ 'context' ] ) && ! empty( $this->request[ 'context' ] )
+			? $this->request[ 'context' ]
 			: 'view';
 
-		if ( isset( $_REQUEST['object_id'] ) ) {
-			$this->object_id = absint( $_REQUEST['object_id'] );
+		if ( isset( $_REQUEST[ 'object_id' ] ) ) {
+			$this->object_id = absint( $_REQUEST[ 'object_id' ] );
 		}
 
-		if ( isset( $_REQUEST['object_type'] ) ) {
-			$this->object_type = absint( $_REQUEST['object_type'] );
+		if ( isset( $_REQUEST[ 'object_type' ] ) ) {
+			$this->object_type = absint( $_REQUEST[ 'object_type' ] );
 		}
 
 		self::$request_type = self::$request_type ? self::$request_type : $request_type;

includes/CMB2_REST_Controller_Boxes.php

Doc Comments -1 removed lines

@@ -100,7 +100,6 @@
 	 *
 	 * @since 2.2.0
 	 *
-	 * @param CMB2 $cmb
 	 * @return array
 	 */
 	public function get_rest_box() {

Spacing +8 added lines, -8 removed lines

@@ -70,7 +70,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( $_GET['_embed'] ) );
+				$boxes_data[ $this->rest_box->cmb->cmb_id ] = $this->server->response_to_data( $rest_box, isset( $_GET[ '_embed' ] ) );
 			}
 		}
 
@@ -110,9 +110,9 @@ 
 
 		$boxes_data = $cmb->meta_box;
 
-		if ( isset( $_REQUEST['_rendered'] ) && '/cmb2/v1/boxes' !== 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( $_REQUEST[ '_rendered' ] ) && '/cmb2/v1/boxes' !== 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;
@@ -120,15 +120,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 +9 added lines, -9 removed lines

@@ -67,11 +67,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( $_GET['_embed'] ) );
+				$fields[ $field_id ] = $this->server->response_to_data( $rest_field, isset( $_GET[ '_embed' ] ) );
 			} else {
 				$fields[ $field_id ] = array( 'error' => $rest_field->get_error_message() );
 			}
@@ -165,11 +165,11 @@ 
 			}
 		}
 
-		if ( isset( $_REQUEST['_rendered'] ) ) {
-			$field_data['rendered'] = $rendered;
+		if ( isset( $_REQUEST[ '_rendered' ] ) ) {
+			$field_data[ 'rendered' ] = $rendered;
 		}
 
-		$field_data['value'] = $field->get_data();
+		$field_data[ 'value' ] = $field->get_data();
 
 		return $field_data;
 	}
@@ -190,14 +190,14 @@ 
 		);
 
 		// TODO ?
-		error_log( '$this->request[context]: '. print_r( $this->request['context'], true ) );
-		error_log( 'CMB2_REST_Controller::get_intial_route(): '. print_r( CMB2_REST_Controller::get_intial_route(), true ) );
-		error_log( '$match: '. print_r( 'box_read' === CMB2_REST_Controller::get_intial_request_type(), true ) );
+		error_log( '$this->request[context]: ' . print_r( $this->request[ 'context' ], true ) );
+		error_log( 'CMB2_REST_Controller::get_intial_route(): ' . print_r( CMB2_REST_Controller::get_intial_route(), true ) );
+		error_log( '$match: ' . print_r( 'box_read' === CMB2_REST_Controller::get_intial_request_type(), true ) );
 
 
 		// 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;