woocommerce / woocommerce-rest-api

src/Controllers/Version4/AbstractObjectsController.php

Spacing +61 added lines, -61 removed lines

@@ -65,7 +65,7 @@ 
 	 * @return \WP_Error|\WP_REST_Response
 	 */
 	public function get_item( $request ) {
-		$object = $this->get_object( (int) $request['id'] );
+		$object = $this->get_object( (int) $request[ 'id' ] );
 
 		if ( ! $object || 0 === $object->get_id() ) {
 			return new \WP_Error( "woocommerce_rest_{$this->post_type}_invalid_id", __( 'Invalid ID.', 'woocommerce-rest-api' ), array( 'status' => 404 ) );
@@ -110,7 +110,7 @@ 
 	 * @return \WP_Error|\WP_REST_Response
 	 */
 	public function create_item( $request ) {
-		if ( ! empty( $request['id'] ) ) {
+		if ( ! empty( $request[ 'id' ] ) ) {
 			/* translators: %s: post type */
 			return new \WP_Error( "woocommerce_rest_{$this->post_type}_exists", sprintf( __( 'Cannot create existing %s.', 'woocommerce-rest-api' ), $this->post_type ), array( 'status' => 400 ) );
 		}
@@ -156,7 +156,7 @@ 
 	 * @return \WP_Error|\WP_REST_Response
 	 */
 	public function update_item( $request ) {
-		$object = $this->get_object( (int) $request['id'] );
+		$object = $this->get_object( (int) $request[ 'id' ] );
 
 		if ( ! $object || 0 === $object->get_id() ) {
 			return new \WP_Error( "woocommerce_rest_{$this->post_type}_invalid_id", __( 'Invalid ID.', 'woocommerce-rest-api' ), array( 'status' => 404 ) );
@@ -199,42 +199,42 @@ 
 	 */
 	protected function prepare_objects_query( $request ) {
 		$args                        = array();
-		$args['offset']              = $request['offset'];
-		$args['order']               = $request['order'];
-		$args['orderby']             = $request['orderby'];
-		$args['paged']               = $request['page'];
-		$args['post__in']            = $request['include'];
-		$args['post__not_in']        = $request['exclude'];
-		$args['posts_per_page']      = $request['per_page'];
-		$args['name']                = $request['slug'];
-		$args['post_parent__in']     = $request['parent'];
-		$args['post_parent__not_in'] = $request['parent_exclude'];
-		$args['s']                   = $request['search'];
-		$args['fields']              = 'ids';
-
-		if ( 'date' === $args['orderby'] ) {
-			$args['orderby'] = 'date ID';
+		$args[ 'offset' ]              = $request[ 'offset' ];
+		$args[ 'order' ]               = $request[ 'order' ];
+		$args[ 'orderby' ]             = $request[ 'orderby' ];
+		$args[ 'paged' ]               = $request[ 'page' ];
+		$args[ 'post__in' ]            = $request[ 'include' ];
+		$args[ 'post__not_in' ]        = $request[ 'exclude' ];
+		$args[ 'posts_per_page' ]      = $request[ 'per_page' ];
+		$args[ 'name' ]                = $request[ 'slug' ];
+		$args[ 'post_parent__in' ]     = $request[ 'parent' ];
+		$args[ 'post_parent__not_in' ] = $request[ 'parent_exclude' ];
+		$args[ 's' ]                   = $request[ 'search' ];
+		$args[ 'fields' ]              = 'ids';
+
+		if ( 'date' === $args[ 'orderby' ] ) {
+			$args[ 'orderby' ] = 'date ID';
 		}
 
-		$args['date_query'] = array();
+		$args[ 'date_query' ] = array();
 
 		// Set before into date query. Date query must be specified as an array of an array.
-		if ( isset( $request['before'] ) ) {
-			$args['date_query'][0]['before'] = $request['before'];
+		if ( isset( $request[ 'before' ] ) ) {
+			$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( $request['after'] ) ) {
-			$args['date_query'][0]['after'] = $request['after'];
+		if ( isset( $request[ 'after' ] ) ) {
+			$args[ 'date_query' ][ 0 ][ 'after' ] = $request[ 'after' ];
 		}
 
 		// Set date query colummn. Defaults to post_date.
-		if ( isset( $request['date_column'] ) && ! empty( $args['date_query'][0] ) ) {
-			$args['date_query'][0]['column'] = 'post_' . $request['date_column'];
+		if ( isset( $request[ 'date_column' ] ) && ! empty( $args[ 'date_query' ][ 0 ] ) ) {
+			$args[ 'date_query' ][ 0 ][ 'column' ] = 'post_' . $request[ 'date_column' ];
 		}
 
 		// Force the post_type argument, since it's not a user input variable.
-		$args['post_type'] = $this->post_type;
+		$args[ 'post_type' ] = $this->post_type;
 
 		/**
 		 * Filter the query arguments for a request.
@@ -264,7 +264,7 @@ 
 		$total_posts = $query->found_posts;
 		if ( $total_posts < 1 ) {
 			// Out-of-bounds, run the query again without LIMIT for total count.
-			unset( $query_args['paged'] );
+			unset( $query_args[ 'paged' ] );
 			$count_query = new \WP_Query();
 			$count_query->query( $query_args );
 			$total_posts = $count_query->found_posts;
@@ -273,7 +273,7 @@ 
 		return array(
 			'objects' => array_filter( array_map( array( $this, 'get_object' ), $result ) ),
 			'total'   => (int) $total_posts,
-			'pages'   => (int) ceil( $total_posts / (int) $query->query_vars['posts_per_page'] ),
+			'pages'   => (int) ceil( $total_posts / (int) $query->query_vars[ 'posts_per_page' ] ),
 		);
 	}
 
@@ -288,17 +288,17 @@ 
 		$query_results = $this->get_objects( $query_args );
 
 		$objects = array();
-		foreach ( $query_results['objects'] as $object ) {
+		foreach ( $query_results[ 'objects' ] as $object ) {
 			if ( ! Permissions::user_can_read( $this->post_type, $object->get_id() ) ) {
 				continue;
 			}
 
 			$data      = $this->prepare_item_for_response( $object, $request );
-			$objects[] = $this->prepare_response_for_collection( $data );
+			$objects[ ] = $this->prepare_response_for_collection( $data );
 		}
 
-		$total     = $query_results['total'];
-		$max_pages = $query_results['pages'];
+		$total     = $query_results[ 'total' ];
+		$max_pages = $query_results[ 'pages' ];
 
 		$response = rest_ensure_response( $objects );
 		$response = Pagination::add_pagination_headers( $response, $request, $total, $max_pages );
@@ -313,8 +313,8 @@ 
 	 * @return \WP_REST_Response|\WP_Error
 	 */
 	public function delete_item( $request ) {
-		$force  = (bool) $request['force'];
-		$object = $this->get_object( (int) $request['id'] );
+		$force  = (bool) $request[ 'force' ];
+		$object = $this->get_object( (int) $request[ 'id' ] );
 		$result = false;
 
 		if ( ! $object || 0 === $object->get_id() ) {
@@ -424,10 +424,10 @@ 
 	 */
 	public function get_collection_params() {
 		$params                       = array();
-		$params['context']            = $this->get_context_param();
-		$params['context']['default'] = 'view';
+		$params[ 'context' ]            = $this->get_context_param();
+		$params[ 'context' ][ 'default' ] = 'view';
 
-		$params['page'] = array(
+		$params[ 'page' ] = array(
 			'description'       => __( 'Current page of the collection.', 'woocommerce-rest-api' ),
 			'type'              => 'integer',
 			'default'           => 1,
@@ -436,7 +436,7 @@ 
 			'minimum'           => 1,
 		);
 
-		$params['per_page'] = array(
+		$params[ 'per_page' ] = array(
 			'description'       => __( 'Maximum number of items to be returned in result set.', 'woocommerce-rest-api' ),
 			'type'              => 'integer',
 			'default'           => 10,
@@ -446,28 +446,28 @@ 
 			'validate_callback' => 'rest_validate_request_arg',
 		);
 
-		$params['search'] = array(
+		$params[ 'search' ] = array(
 			'description'       => __( 'Limit results to those matching a string.', 'woocommerce-rest-api' ),
 			'type'              => 'string',
 			'sanitize_callback' => 'sanitize_text_field',
 			'validate_callback' => 'rest_validate_request_arg',
 		);
 
-		$params['after'] = array(
+		$params[ 'after' ] = array(
 			'description'       => __( 'Limit response to resources created after a given ISO8601 compliant date.', 'woocommerce-rest-api' ),
 			'type'              => 'string',
 			'format'            => 'date-time',
 			'validate_callback' => 'rest_validate_request_arg',
 		);
 
-		$params['before'] = array(
+		$params[ 'before' ] = array(
 			'description'       => __( 'Limit response to resources created before a given ISO8601 compliant date.', 'woocommerce-rest-api' ),
 			'type'              => 'string',
 			'format'            => 'date-time',
 			'validate_callback' => 'rest_validate_request_arg',
 		);
 
-		$params['date_column'] = array(
+		$params[ 'date_column' ] = array(
 			'description'       => __( 'When limiting response using after/before, which date column to compare against.', 'woocommerce-rest-api' ),
 			'type'              => 'string',
 			'default'           => 'date',
@@ -480,14 +480,14 @@ 
 			'validate_callback' => 'rest_validate_request_arg',
 		);
 
-		$params['modified_before'] = array(
+		$params[ 'modified_before' ] = array(
 			'description'       => __( 'Limit response to resources modified before a given ISO8601 compliant date.', 'woocommerce-rest-api' ),
 			'type'              => 'string',
 			'format'            => 'date-time',
 			'validate_callback' => 'rest_validate_request_arg',
 		);
 
-		$params['exclude'] = array(
+		$params[ 'exclude' ] = array(
 			'description'       => __( 'Ensure result set excludes specific IDs.', 'woocommerce-rest-api' ),
 			'type'              => 'array',
 			'items'             => array(
@@ -497,7 +497,7 @@ 
 			'sanitize_callback' => 'wp_parse_id_list',
 		);
 
-		$params['include'] = array(
+		$params[ 'include' ] = array(
 			'description'       => __( 'Limit result set to specific ids.', 'woocommerce-rest-api' ),
 			'type'              => 'array',
 			'items'             => array(
@@ -507,14 +507,14 @@ 
 			'sanitize_callback' => 'wp_parse_id_list',
 		);
 
-		$params['offset'] = array(
+		$params[ 'offset' ] = array(
 			'description'       => __( 'Offset the result set by a specific number of items.', 'woocommerce-rest-api' ),
 			'type'              => 'integer',
 			'sanitize_callback' => 'absint',
 			'validate_callback' => 'rest_validate_request_arg',
 		);
 
-		$params['order'] = array(
+		$params[ 'order' ] = array(
 			'description'       => __( 'Order sort attribute ascending or descending.', 'woocommerce-rest-api' ),
 			'type'              => 'string',
 			'default'           => 'desc',
@@ -522,7 +522,7 @@ 
 			'validate_callback' => 'rest_validate_request_arg',
 		);
 
-		$params['orderby'] = array(
+		$params[ 'orderby' ] = array(
 			'description'       => __( 'Sort collection by object attribute.', 'woocommerce-rest-api' ),
 			'type'              => 'string',
 			'default'           => 'date',
@@ -538,7 +538,7 @@ 
 		);
 
 		if ( $this->hierarchical ) {
-			$params['parent'] = array(
+			$params[ 'parent' ] = array(
 				'description'       => __( 'Limit result set to those of particular parent IDs.', 'woocommerce-rest-api' ),
 				'type'              => 'array',
 				'items'             => array(
@@ -548,7 +548,7 @@ 
 				'default'           => array(),
 			);
 
-			$params['parent_exclude'] = array(
+			$params[ 'parent_exclude' ] = array(
 				'description'       => __( 'Limit result set to all items except those of a particular parent ID.', 'woocommerce-rest-api' ),
 				'type'              => 'array',
 				'items'             => array(
@@ -599,14 +599,14 @@ 
 			}
 		}
 
-		$query_args['ignore_sticky_posts'] = true;
+		$query_args[ 'ignore_sticky_posts' ] = true;
 
-		if ( 'include' === $query_args['orderby'] ) {
-			$query_args['orderby'] = 'post__in';
-		} elseif ( 'id' === $query_args['orderby'] ) {
-			$query_args['orderby'] = 'ID'; // ID must be capitalized.
-		} elseif ( 'slug' === $query_args['orderby'] ) {
-			$query_args['orderby'] = 'name';
+		if ( 'include' === $query_args[ 'orderby' ] ) {
+			$query_args[ 'orderby' ] = 'post__in';
+		} elseif ( 'id' === $query_args[ 'orderby' ] ) {
+			$query_args[ 'orderby' ] = 'ID'; // ID must be capitalized.
+		} elseif ( 'slug' === $query_args[ 'orderby' ] ) {
+			$query_args[ 'orderby' ] = 'name';
 		}
 
 		return $query_args;
@@ -694,13 +694,13 @@ 
 	 * @return array
 	 */
 	protected function add_meta_query( $args, $meta_query ) {
-		if ( empty( $args['meta_query'] ) ) {
-			$args['meta_query'] = []; // phpcs:ignore
+		if ( empty( $args[ 'meta_query' ] ) ) {
+			$args[ 'meta_query' ] = [ ]; // phpcs:ignore
 		}
 
-		$args['meta_query'][] = $meta_query;
+		$args[ 'meta_query' ][ ] = $meta_query;
 
-		return $args['meta_query'];
+		return $args[ 'meta_query' ];
 	}
 
 	/**