Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Dont fetch optional fields unless asked to improve performance

This commit is contained in:
vedanshujain 2020-06-08 23:24:32 +05:30
parent 56f7fef831
commit e0e19cac30
1 changed files with 97 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

154
includes/rest-api/Controllers/Version2/class-wc-rest-orders-v2-controller.php
View File

@ -203,16 +203,62 @@ class WC_REST_Orders_V2_Controller extends WC_REST_CRUD_Controller {
/** /**
* Get formatted item data. * Get formatted item data.
* *
* @since 3.0.0 * @since 3.0.0
* @param WC_Data $object WC_Data instance. * @param WC_Order $order WC_Data instance.
*
* @return array * @return array
*/ */
protected function get_formatted_item_data( $object ) { protected function get_formatted_item_data( $order ) {
$data = $object->get_data(); $extra_fields = array( 'meta_data', 'line_items', 'tax_lines', 'shipping_lines', 'fee_lines', 'coupon_lines', 'refunds' );
$format_decimal = array( 'discount_total', 'discount_tax', 'shipping_total', 'shipping_tax', 'shipping_total', 'shipping_tax', 'cart_tax', 'total', 'total_tax' ); $format_decimal = array( 'discount_total', 'discount_tax', 'shipping_total', 'shipping_tax', 'shipping_total', 'shipping_tax', 'cart_tax', 'total', 'total_tax' );
$format_date = array( 'date_created', 'date_modified', 'date_completed', 'date_paid' ); $format_date = array( 'date_created', 'date_modified', 'date_completed', 'date_paid' );
$format_line_items = array( 'line_items', 'tax_lines', 'shipping_lines', 'fee_lines', 'coupon_lines' ); $format_line_items = array( 'line_items', 'tax_lines', 'shipping_lines', 'fee_lines', 'coupon_lines' );
// Only fetch fields that we need.
$request = func_get_arg( 1 );
if ( $request ) {
$fields = $this->get_fields_for_response( $request );
$extra_fields = array_intersect( $extra_fields, $fields );
$format_decimal = array_intersect( $format_decimal, $fields );
$format_date = array_intersect( $format_date, $fields );
$format_line_items = array_intersect( $format_line_items, $fields );
}
$data = $order->get_base_data();
// Add extra data as necessary.
foreach ( $extra_fields as $field ) {
switch ( $field ) {
case 'meta_data':
$data['meta_data'] = $order->get_meta_data();
break;
case 'line_items':
$data['line_items'] = $order->get_items( 'line_item');
break;
case 'tax_lines':
$data['tax_lines'] = $order->get_items( 'tax' );
break;
case 'shipping_lines':
$data['shipping_lines'] = $order->get_items( 'shipping' );
break;
case 'fee_lines':
$data['fee_lines'] = $order->get_items( 'fee' );
break;
case 'coupon_lines':
$data['coupon_lines'] = $order->get_items( 'coupon' );
break;
case 'refunds':
foreach ( $order->get_refunds() as $refund ) {
$data['refunds'][] = array(
'id' => $refund->get_id(),
'reason' => $refund->get_reason() ? $refund->get_reason() : '',
'total' => '-' . wc_format_decimal( $refund->get_amount(), $this->request['dp'] ),
);
}
break;
}
}
// Format decimal values. // Format decimal values.
foreach ( $format_decimal as $key ) { foreach ( $format_decimal as $key ) {
$data[ $key ] = wc_format_decimal( $data[ $key ], $this->request['dp'] ); $data[ $key ] = wc_format_decimal( $data[ $key ], $this->request['dp'] );
@ -233,59 +279,53 @@ class WC_REST_Orders_V2_Controller extends WC_REST_CRUD_Controller {
$data[ $key ] = array_values( array_map( array( $this, 'get_order_item_data' ), $data[ $key ] ) ); $data[ $key ] = array_values( array_map( array( $this, 'get_order_item_data' ), $data[ $key ] ) );
} }
// Refunds. $allowed_fields = array(
$data['refunds'] = array(); 'id',
foreach ( $object->get_refunds() as $refund ) { 'parent_id',
$data['refunds'][] = array( 'number',
'id' => $refund->get_id(), 'order_key',
'reason' => $refund->get_reason() ? $refund->get_reason() : '', 'created_via',
'total' => '-' . wc_format_decimal( $refund->get_amount(), $this->request['dp'] ), 'version',
); 'status',
} 'currency',
'date_created',
return array( 'date_created_gmt',
'id' => $object->get_id(), 'date_modified',
'parent_id' => $data['parent_id'], 'date_modified_gmt',
'number' => $data['number'], 'discount_total',
'order_key' => $data['order_key'], 'discount_tax',
'created_via' => $data['created_via'], 'shipping_total',
'version' => $data['version'], 'shipping_tax',
'status' => $data['status'], 'cart_tax',
'currency' => $data['currency'], 'total',
'date_created' => $data['date_created'], 'total_tax',
'date_created_gmt' => $data['date_created_gmt'], 'prices_include_tax',
'date_modified' => $data['date_modified'], 'customer_id',
'date_modified_gmt' => $data['date_modified_gmt'], 'customer_ip_address',
'discount_total' => $data['discount_total'], 'customer_user_agent',
'discount_tax' => $data['discount_tax'], 'customer_note',
'shipping_total' => $data['shipping_total'], 'billing',
'shipping_tax' => $data['shipping_tax'], 'shipping',
'cart_tax' => $data['cart_tax'], 'payment_method',
'total' => $data['total'], 'payment_method_title',
'total_tax' => $data['total_tax'], 'transaction_id',
'prices_include_tax' => $data['prices_include_tax'], 'date_paid',
'customer_id' => $data['customer_id'], 'date_paid_gmt',
'customer_ip_address' => $data['customer_ip_address'], 'date_completed',
'customer_user_agent' => $data['customer_user_agent'], 'date_completed_gmt',
'customer_note' => $data['customer_note'], 'cart_hash',
'billing' => $data['billing'], 'meta_data',
'shipping' => $data['shipping'], 'line_items',
'payment_method' => $data['payment_method'], 'tax_lines',
'payment_method_title' => $data['payment_method_title'], 'shipping_lines',
'transaction_id' => $data['transaction_id'], 'fee_lines',
'date_paid' => $data['date_paid'], 'coupon_lines',
'date_paid_gmt' => $data['date_paid_gmt'], 'refunds',
'date_completed' => $data['date_completed'],
'date_completed_gmt' => $data['date_completed_gmt'],
'cart_hash' => $data['cart_hash'],
'meta_data' => $data['meta_data'],
'line_items' => $data['line_items'],
'tax_lines' => $data['tax_lines'],
'shipping_lines' => $data['shipping_lines'],
'fee_lines' => $data['fee_lines'],
'coupon_lines' => $data['coupon_lines'],
'refunds' => $data['refunds'],
); );
$data = array_intersect_key( $data, array_flip( $allowed_fields ) );
return $data;
} }
/** /**
@ -299,7 +339,7 @@ class WC_REST_Orders_V2_Controller extends WC_REST_CRUD_Controller {
public function prepare_object_for_response( $object, $request ) { public function prepare_object_for_response( $object, $request ) {
$this->request = $request; $this->request = $request;
$this->request['dp'] = is_null( $this->request['dp'] ) ? wc_get_price_decimals() : absint( $this->request['dp'] ); $this->request['dp'] = is_null( $this->request['dp'] ) ? wc_get_price_decimals() : absint( $this->request['dp'] );
$data = $this->get_formatted_item_data( $object ); $data = $this->get_formatted_item_data( $object, $request );
$context = ! empty( $request['context'] ) ? $request['context'] : 'view'; $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
$data = $this->add_additional_fields_to_object( $data, $request ); $data = $this->add_additional_fields_to_object( $data, $request );
$data = $this->filter_response_by_context( $data, $context ); $data = $this->filter_response_by_context( $data, $context );