woocommerce / woocommerce-rest-api

src/Controllers/Version4/Utilities/BatchTrait.php

<?php
/**
 * Batch trait.
 *
 * @package Automattic/WooCommerce/RestApi
 */

namespace Automattic\WooCommerce\RestApi\Controllers\Version4\Utilities;

/**
 * BatchTrait.
 */
trait BatchTrait {

	/**
	 * 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 ) {
		$items = $request->get_params();
		$limit = $this->check_batch_limit( $items );
		if ( is_wp_error( $limit ) ) {
			return $limit;
		}

		$batches  = [ 'create', 'update', 'delete' ];
		$response = [];

		foreach ( $batches as $batch ) {
			$response[ $batch ] = $this->{"batch_$batch"}( $this->get_batch_of_items_from_request( $request, $batch ) );
		}

		return array_filter( $response );
	}

	/**
	 * Get batch of items from requst.
	 *
	 * @param \WP_REST_Request $request Full details about the request.
	 * @param string           $batch_type Batch type; one of create, update, delete.
	 * @return array
	 */
	protected function get_batch_of_items_from_request( $request, $batch_type ) {
		$params = $request->get_params();

		if ( ! isset( $params[ $batch_type ] ) ) {
			return array();
		}

		return array_filter( $params[ $batch_type ] );
	}

	/**
	 * Check if a given request has access batch create, update and delete items.
	 *
	 * @param  \WP_REST_Request $request Full details about the request.
	 * @return boolean|\WP_Error
	 */
	public function batch_items_permissions_check( $request ) {
		return update_item_permissions_check( $request );
	}

	/**
	 * Register route for batch requests.
	 */
	protected function register_batch_route() {
		register_rest_route(
			$this->namespace,
			'/' . $this->rest_base . '/batch',
			array(
				array(
					'methods'             => \WP_REST_Server::EDITABLE,
					'callback'            => array( $this, 'batch_items' ),
					'permission_callback' => array( $this, 'batch_items_permissions_check' ),
					'args'                => $this->get_endpoint_args_for_item_schema( \WP_REST_Server::EDITABLE ),
				),
				'schema' => array( $this, 'get_public_batch_schema' ),
			),
			true
		);
	}

	/**
	 * Get the batch schema, conforming to JSON Schema.
	 *
	 * @return array
	 */
	protected 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' ),
					'items'       => array(
						'type' => 'object',
					),
				),
				'update' => array(
					'description' => __( 'List of updated resources.', 'woocommerce' ),
					'type'        => 'array',
					'context'     => array( 'view', 'edit' ),
					'items'       => array(
						'type' => 'object',
					),
				),
				'delete' => array(
					'description' => __( 'List of delete resources.', 'woocommerce' ),
					'type'        => 'array',
					'context'     => array( 'view', 'edit' ),
					'items'       => array(
						'type' => 'integer',
					),
				),
			),
		);

		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;
		$batches = [ 'create', 'update', 'delete' ];

		foreach ( $batches as $batch ) {
			if ( ! isset( $items[ $batch ] ) ) {
				continue;
			}
			$total = $total + count( $items[ $batch ] );
		}

		if ( $total > $limit ) {
			/* translators: %s: items 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;
	}

	/**
	 * Get default params from schema.
	 *
	 * @return array
	 */
	protected function get_default_params() {
		$defaults = [];
		$schema   = $this->get_public_item_schema();

The method get_public_item_schema() does not exist on Automattic\WooCommerce\RestApi\Controllers\Version4\Utilities\BatchTrait. Did you maybe mean get_public_batch_schema()?

		foreach ( $schema['properties'] as $arg => $options ) {
			if ( isset( $options['default'] ) ) {
				$defaults[ $arg ] = $options['default'];
			}
		}
		return $defaults;
	}

	/**
	 * Batch create items.
	 *
	 * @param array $items Array of items.
	 * @return array Response data.
	 */
	protected function batch_create( $items ) {
		$batch_response = [];

		foreach ( $items as $item ) {
			$request = new \WP_REST_Request( 'POST' );
			$request->set_default_params( $this->get_default_params() );
			$request->set_body_params( $item );

			$response         = $this->create_item( $request );
			$batch_response[] = $this->format_response( 0, $response );
		}

		return $batch_response;
	}

	/**
	 * Batch update items.
	 *
	 * @param array $items Array of items.
	 * @return array Response data.
	 */
	protected function batch_update( $items ) {
		$batch_response = [];

		foreach ( $items as $item ) {
			$request = new \WP_REST_Request( 'PUT' );
			$request->set_body_params( $item );

			$response         = $this->update_item( $request );
			$batch_response[] = $this->format_response( $item['id'], $response );
		}

		return $batch_response;
	}

	/**
	 * Batch delete items.
	 *
	 * @param array $items Array of item ids.
	 * @return array Response data.
	 */
	protected function batch_delete( $items ) {
		$batch_response = [];
		$items          = wp_parse_id_list( $items );

		foreach ( $items as $id ) {
			$request = new \WP_REST_Request( 'DELETE' );
			$request->set_query_params(
				[
					'id'    => $id,
					'force' => true,
				]
			);
			$response         = $this->delete_item( $request );
			$batch_response[] = $this->format_response( $id, $response );
		}

		return $batch_response;
	}

	/**
	 * Format response data.
	 *
	 * @param int                         $id ID of item being updated.
	 * @param \WP_REST_Response|\WP_Error $response Response object.
	 * @return array
	 */
	protected function format_response( $id, $response ) {
		/**
		 * REST Server
		 *
		 * @var \WP_REST_Server $wp_rest_server
		 */
		global $wp_rest_server;

		if ( ! is_wp_error( $response ) ) {
			return $wp_rest_server->response_to_data( $response, '' );
		} else {
			return array(
				'id'    => $id,
				'error' => $this->format_error_response( $response ),

It seems like $response can also be of type WP_REST_Response; however, parameter $error of Automattic\WooCommerce\RestApi\Controllers\Version4\Utilities\BatchTrait::format_error_response() does only seem to accept WP_Error, maybe add an additional type check?

			);
		}
	}

	/**
	 * Format WP Error to response data.
	 *
	 * @param \WP_Error $error Error object.
	 * @return array
	 */
	protected function format_error_response( $error ) {
		return array(
			'code'    => $error->get_error_code(),
			'message' => $error->get_error_message(),
			'data'    => $error->get_error_data(),
		);
	}
}