woocommerce / woocommerce-rest-api

src/Controllers/Version4/ProductReviews.php

Spacing +60 added lines, -60 removed lines

@@ -176,29 +176,29 @@ 
 			}
 		}
 
-		if ( isset( $registered['orderby'] ) ) {
-			$prepared_args['orderby'] = $this->normalize_query_param( $request['orderby'] );
+		if ( isset( $registered[ 'orderby' ] ) ) {
+			$prepared_args[ 'orderby' ] = $this->normalize_query_param( $request[ 'orderby' ] );
 		}
 
-		if ( isset( $prepared_args['status'] ) ) {
-			$prepared_args['status'] = 'approved' === $prepared_args['status'] ? 'approve' : $prepared_args['status'];
+		if ( isset( $prepared_args[ 'status' ] ) ) {
+			$prepared_args[ 'status' ] = 'approved' === $prepared_args[ 'status' ] ? 'approve' : $prepared_args[ 'status' ];
 		}
 
-		$prepared_args['no_found_rows'] = false;
-		$prepared_args['date_query']    = array();
+		$prepared_args[ 'no_found_rows' ] = false;
+		$prepared_args[ 'date_query' ]    = array();
 
 		// Set before into date query. Date query must be specified as an array of an array.
-		if ( isset( $registered['before'], $request['before'] ) ) {
-			$prepared_args['date_query'][0]['before'] = $request['before'];
+		if ( isset( $registered[ 'before' ], $request[ 'before' ] ) ) {
+			$prepared_args[ 'date_query' ][ 0 ][ 'before' ] = $request[ 'before' ];
 		}
 
 		// Set after into date query. Date query must be specified as an array of an array.
-		if ( isset( $registered['after'], $request['after'] ) ) {
-			$prepared_args['date_query'][0]['after'] = $request['after'];
+		if ( isset( $registered[ 'after' ], $request[ 'after' ] ) ) {
+			$prepared_args[ 'date_query' ][ 0 ][ 'after' ] = $request[ 'after' ];
 		}
 
-		if ( isset( $registered['page'] ) && empty( $request['offset'] ) ) {
-			$prepared_args['offset'] = $prepared_args['number'] * ( absint( $request['page'] ) - 1 );
+		if ( isset( $registered[ 'page' ] ) && empty( $request[ 'offset' ] ) ) {
+			$prepared_args[ 'offset' ] = $prepared_args[ 'number' ] * ( absint( $request[ 'page' ] ) - 1 );
 		}
 
 		/**
@@ -212,7 +212,7 @@ 
 		$prepared_args = apply_filters( 'woocommerce_rest_product_review_query', $prepared_args, $request );
 
 		// Make sure that returns only reviews.
-		$prepared_args['type'] = 'review';
+		$prepared_args[ 'type' ] = 'review';
 
 		// Query reviews.
 		$query        = new \WP_Comment_Query();
@@ -225,7 +225,7 @@ 
 			}
 
 			$data      = $this->prepare_item_for_response( $review, $request );
-			$reviews[] = $this->prepare_response_for_collection( $data );
+			$reviews[ ] = $this->prepare_response_for_collection( $data );
 		}
 
 		$total_reviews = (int) $query->found_comments;
@@ -233,13 +233,13 @@ 
 
 		if ( $total_reviews < 1 ) {
 			// Out-of-bounds, run the query again without LIMIT for total count.
-			unset( $prepared_args['number'], $prepared_args['offset'] );
+			unset( $prepared_args[ 'number' ], $prepared_args[ 'offset' ] );
 
 			$query                  = new \WP_Comment_Query();
-			$prepared_args['count'] = true;
+			$prepared_args[ 'count' ] = true;
 
 			$total_reviews = $query->query( $prepared_args );
-			$max_pages     = ceil( $total_reviews / $request['per_page'] );
+			$max_pages     = ceil( $total_reviews / $request[ 'per_page' ] );
 		}
 
 		$response = rest_ensure_response( $reviews );
@@ -256,7 +256,7 @@ 
 	 */
 	public function create_item( $request ) {
 		try {
-			if ( ! empty( $request['id'] ) ) {
+			if ( ! empty( $request[ 'id' ] ) ) {
 				return new \WP_Error( 'woocommerce_rest_review_exists', __( 'Cannot create existing product review.', 'woocommerce-rest-api' ), array( 'status' => 400 ) );
 			}
 
@@ -312,11 +312,11 @@ 
 				throw new \WC_REST_Exception( 'woocommerce_rest_review_failed_create', __( 'Creating product review failed.', 'woocommerce-rest-api' ), 500 );
 			}
 
-			if ( isset( $request['status'] ) ) {
-				$this->handle_status_param( $request['status'], $review_id );
+			if ( isset( $request[ 'status' ] ) ) {
+				$this->handle_status_param( $request[ 'status' ], $review_id );
 			}
 
-			update_comment_meta( $review_id, 'rating', ! empty( $request['rating'] ) ? $request['rating'] : '0' );
+			update_comment_meta( $review_id, 'rating', ! empty( $request[ 'rating' ] ) ? $request[ 'rating' ] : '0' );
 		} catch ( \WC_REST_Exception $e ) {
 			return new \WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
 		}
@@ -358,12 +358,12 @@ 
 	 * @return array
 	 */
 	protected function validate_review( $prepared_review, $creating = false ) {
-		if ( empty( $prepared_review['comment_content'] ) ) {
+		if ( empty( $prepared_review[ 'comment_content' ] ) ) {
 			throw new \WC_REST_Exception( 'woocommerce_rest_review_content_invalid', __( 'Invalid review content.', 'woocommerce-rest-api' ), 400 );
 		}
 
-		if ( ! empty( $prepared_review['comment_post_ID'] ) ) {
-			if ( 'product' !== get_post_type( $prepared_review['comment_post_ID'] ) ) {
+		if ( ! empty( $prepared_review[ 'comment_post_ID' ] ) ) {
+			if ( 'product' !== get_post_type( $prepared_review[ 'comment_post_ID' ] ) ) {
 				throw new \WC_REST_Exception( 'woocommerce_rest_product_invalid_id', __( 'Invalid product ID.', 'woocommerce-rest-api' ), 404 );
 			}
 		}
@@ -376,7 +376,7 @@ 
 		}
 
 		if ( $creating ) {
-			$prepared_review['comment_approved'] = $this->get_comment_approved( $prepared_review );
+			$prepared_review[ 'comment_approved' ] = $this->get_comment_approved( $prepared_review );
 		}
 
 		return $prepared_review;
@@ -388,8 +388,8 @@ 
 	 * @return string
 	 */
 	protected function get_comment_author_ip() {
-		if ( ! empty( $_SERVER['REMOTE_ADDR'] ) && rest_is_ip_address( wp_unslash( $_SERVER['REMOTE_ADDR'] ) ) ) { // WPCS: input var ok, sanitization ok.
-			return wc_clean( wp_unslash( $_SERVER['REMOTE_ADDR'] ) ); // WPCS: input var ok.
+		if ( ! empty( $_SERVER[ 'REMOTE_ADDR' ] ) && rest_is_ip_address( wp_unslash( $_SERVER[ 'REMOTE_ADDR' ] ) ) ) { // WPCS: input var ok, sanitization ok.
+			return wc_clean( wp_unslash( $_SERVER[ 'REMOTE_ADDR' ] ) ); // WPCS: input var ok.
 		} else {
 			return '127.0.0.1';
 		}
@@ -402,8 +402,8 @@ 
 	 * @return string
 	 */
 	protected function get_comment_agent( $request ) {
-		if ( ! empty( $request['author_user_agent'] ) ) {
-			return $request['author_user_agent'];
+		if ( ! empty( $request[ 'author_user_agent' ] ) ) {
+			return $request[ 'author_user_agent' ];
 		} elseif ( $request->get_header( 'user_agent' ) ) {
 			return $request->get_header( 'user_agent' );
 		} else {
@@ -444,7 +444,7 @@ 
 	 * @return \WP_Error|\WP_REST_Response
 	 */
 	public function get_item( $request ) {
-		$review = $this->get_review( $request['id'] );
+		$review = $this->get_review( $request[ 'id' ] );
 		if ( is_wp_error( $review ) ) {
 			return $review;
 		}
@@ -460,7 +460,7 @@ 
 	 */
 	public function update_item( $request ) {
 		try {
-			$review = $this->get_review( $request['id'] );
+			$review = $this->get_review( $request[ 'id' ] );
 
 			if ( is_wp_error( $review ) ) {
 				return $review;
@@ -468,7 +468,7 @@ 
 
 			$review_id = (int) $review->comment_ID;
 
-			if ( isset( $request['type'] ) && 'review' !== get_comment_type( $review_id ) ) {
+			if ( isset( $request[ 'type' ] ) && 'review' !== get_comment_type( $review_id ) ) {
 				return new \WP_Error( 'woocommerce_rest_review_invalid_type', __( 'Sorry, you are not allowed to change the comment type.', 'woocommerce-rest-api' ), array( 'status' => 404 ) );
 			}
 
@@ -493,12 +493,12 @@ 
 
 			wp_update_comment( wp_slash( $prepared_review ) );
 
-			if ( isset( $request['status'] ) ) {
-				$this->handle_status_param( $request['status'], $review_id );
+			if ( isset( $request[ 'status' ] ) ) {
+				$this->handle_status_param( $request[ 'status' ], $review_id );
 			}
 
-			if ( ! empty( $request['rating'] ) ) {
-				update_comment_meta( $review_id, 'rating', $request['rating'] );
+			if ( ! empty( $request[ 'rating' ] ) ) {
+				update_comment_meta( $review_id, 'rating', $request[ 'rating' ] );
 			}
 		} catch ( \WC_REST_Exception $e ) {
 			return new \WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
@@ -533,12 +533,12 @@ 
 	 * @return \WP_Error|\WP_REST_Response Response object on success, or error object on failure.
 	 */
 	public function delete_item( $request ) {
-		$review = $this->get_review( $request['id'] );
+		$review = $this->get_review( $request[ 'id' ] );
 		if ( is_wp_error( $review ) ) {
 			return $review;
 		}
 
-		$force = isset( $request['force'] ) ? (bool) $request['force'] : false;
+		$force = isset( $request[ 'force' ] ) ? (bool) $request[ 'force' ] : false;
 
 		/**
 		 * Filters whether a review can be trashed.
@@ -634,17 +634,17 @@ 
 			$prepared_review[ $key ] = $request[ $value ];
 		}
 
-		if ( ! empty( $request['date_created'] ) ) {
-			$date_data = rest_get_date_with_gmt( $request['date_created'] );
+		if ( ! empty( $request[ 'date_created' ] ) ) {
+			$date_data = rest_get_date_with_gmt( $request[ 'date_created' ] );
 
 			if ( ! empty( $date_data ) ) {
-				list( $prepared_review['comment_date'], $prepared_review['comment_date_gmt'] ) = $date_data;
+				list( $prepared_review[ 'comment_date' ], $prepared_review[ 'comment_date_gmt' ] ) = $date_data;
 			}
-		} elseif ( ! empty( $request['date_created_gmt'] ) ) {
-			$date_data = rest_get_date_with_gmt( $request['date_created_gmt'], true );
+		} elseif ( ! empty( $request[ 'date_created_gmt' ] ) ) {
+			$date_data = rest_get_date_with_gmt( $request[ 'date_created_gmt' ], true );
 
 			if ( ! empty( $date_data ) ) {
-				list( $prepared_review['comment_date'], $prepared_review['comment_date_gmt'] ) = $date_data;
+				list( $prepared_review[ 'comment_date' ], $prepared_review[ 'comment_date_gmt' ] ) = $date_data;
 			}
 		}
 
@@ -668,13 +668,13 @@ 
 			),
 		);
 		if ( 0 !== (int) $item->comment_post_ID ) {
-			$links['up'] = array(
+			$links[ 'up' ] = array(
 				'href'       => rest_url( sprintf( '/%s/products/%d', $this->namespace, $item->comment_post_ID ) ),
 				'embeddable' => true,
 			);
 		}
 		if ( 0 !== (int) $item->user_id ) {
-			$links['reviewer'] = array(
+			$links[ 'reviewer' ] = array(
 				'href'       => rest_url( 'wp/v2/users/' . $item->user_id ),
 				'embeddable' => true,
 			);
@@ -769,7 +769,7 @@ 
 					'context'     => array( 'embed', 'view', 'edit' ),
 				);
 			}
-			$schema['properties']['reviewer_avatar_urls'] = array(
+			$schema[ 'properties' ][ 'reviewer_avatar_urls' ] = array(
 				'description' => __( 'Avatar URLs for the object reviewer.', 'woocommerce-rest-api' ),
 				'type'        => 'object',
 				'context'     => array( 'view', 'edit' ),
@@ -789,19 +789,19 @@ 
 	public function get_collection_params() {
 		$params = parent::get_collection_params();
 
-		$params['context']['default'] = 'view';
+		$params[ 'context' ][ 'default' ] = 'view';
 
-		$params['after']            = array(
+		$params[ 'after' ] = array(
 			'description' => __( 'Limit response to resources published after a given ISO8601 compliant date.', 'woocommerce-rest-api' ),
 			'type'        => 'string',
 			'format'      => 'date-time',
 		);
-		$params['before']           = array(
+		$params[ 'before' ] = array(
 			'description' => __( 'Limit response to reviews published before a given ISO8601 compliant date.', 'woocommerce-rest-api' ),
 			'type'        => 'string',
 			'format'      => 'date-time',
 		);
-		$params['exclude']          = array(
+		$params[ 'exclude' ] = array(
 			'description' => __( 'Ensure result set excludes specific IDs.', 'woocommerce-rest-api' ),
 			'type'        => 'array',
 			'items'       => array(
@@ -809,7 +809,7 @@ 
 			),
 			'default'     => array(),
 		);
-		$params['include']          = array(
+		$params[ 'include' ] = array(
 			'description' => __( 'Limit result set to specific IDs.', 'woocommerce-rest-api' ),
 			'type'        => 'array',
 			'items'       => array(
@@ -817,11 +817,11 @@ 
 			),
 			'default'     => array(),
 		);
-		$params['offset']           = array(
+		$params[ 'offset' ] = array(
 			'description' => __( 'Offset the result set by a specific number of items.', 'woocommerce-rest-api' ),
 			'type'        => 'integer',
 		);
-		$params['order']            = array(
+		$params[ 'order' ] = array(
 			'description' => __( 'Order sort attribute ascending or descending.', 'woocommerce-rest-api' ),
 			'type'        => 'string',
 			'default'     => 'desc',
@@ -830,7 +830,7 @@ 
 				'desc',
 			),
 		);
-		$params['orderby']          = array(
+		$params[ 'orderby' ] = array(
 			'description' => __( 'Sort collection by object attribute.', 'woocommerce-rest-api' ),
 			'type'        => 'string',
 			'default'     => 'date_gmt',
@@ -842,27 +842,27 @@ 
 				'product',
 			),
 		);
-		$params['reviewer']         = array(
+		$params[ 'reviewer' ] = array(
 			'description' => __( 'Limit result set to reviews assigned to specific user IDs.', 'woocommerce-rest-api' ),
 			'type'        => 'array',
 			'items'       => array(
 				'type' => 'integer',
 			),
 		);
-		$params['reviewer_exclude'] = array(
+		$params[ 'reviewer_exclude' ] = array(
 			'description' => __( 'Ensure result set excludes reviews assigned to specific user IDs.', 'woocommerce-rest-api' ),
 			'type'        => 'array',
 			'items'       => array(
 				'type' => 'integer',
 			),
 		);
-		$params['reviewer_email']   = array(
+		$params[ 'reviewer_email' ] = array(
 			'default'     => null,
 			'description' => __( 'Limit result set to that from a specific author email.', 'woocommerce-rest-api' ),
 			'format'      => 'email',
 			'type'        => 'string',
 		);
-		$params['product']          = array(
+		$params[ 'product' ] = array(
 			'default'     => array(),
 			'description' => __( 'Limit result set to reviews assigned to specific product IDs.', 'woocommerce-rest-api' ),
 			'type'        => 'array',
@@ -870,7 +870,7 @@ 
 				'type' => 'integer',
 			),
 		);
-		$params['status']           = array(
+		$params[ 'status' ] = array(
 			'default'           => 'approved',
 			'description'       => __( 'Limit result set to reviews assigned a specific status.', 'woocommerce-rest-api' ),
 			'sanitize_callback' => 'sanitize_key',