class-wc-rest-network-orders-v2-controller.php — WooCommerce 10.9.3

woocommerce / includes / rest-api / Controllers / Version2 / class-wc-rest-network-orders-v2-controller.php

woocommerce / includes / rest-api / Controllers / Version2 Last commit date

class-wc-rest-network-orders-v2-controller.php

177 lines

1	<?php
2	/**
3	* REST API Network Orders controller
4	*
5	* Handles requests to the /orders/network endpoint
6	*
7	* @package WooCommerce\RestApi
8	* @since 3.4.0
9	*/
10
11	use Automattic\WooCommerce\Enums\OrderInternalStatus;
12
13	defined( 'ABSPATH' ) \|\| exit;
14
15	/**
16	* REST API Network Orders controller class.
17	*
18	* @package WooCommerce\RestApi
19	* @extends WC_REST_Orders_V2_Controller
20	*/
21	class WC_REST_Network_Orders_V2_Controller extends WC_REST_Orders_V2_Controller {
22
23	/**
24	* Endpoint namespace.
25	*
26	* @var string
27	*/
28	protected $namespace = 'wc/v2';
29
30	/**
31	* Register the routes for network orders.
32	*/
33	public function register_routes() {
34	if ( is_multisite() ) {
35	register_rest_route(
36	$this->namespace,
37	'/' . $this->rest_base . '/network',
38	array(
39	array(
40	'methods' => WP_REST_Server::READABLE,
41	'callback' => array( $this, 'network_orders' ),
42	'permission_callback' => array( $this, 'network_orders_permissions_check' ),
43	'args' => $this->get_collection_params(),
44	),
45	'schema' => array( $this, 'get_public_item_schema' ),
46	)
47	);
48	}
49	}
50
51	/**
52	* Retrieves the item's schema for display / public consumption purposes.
53	*
54	* @return array Public item schema data.
55	*/
56	public function get_public_item_schema() {
57	$schema = parent::get_public_item_schema();
58
59	$schema['properties']['blog'] = array(
60	'description' => __( 'Blog id of the record on the multisite.', 'woocommerce' ),
61	'type' => 'integer',
62	'context' => array( 'view' ),
63	'readonly' => true,
64	);
65	$schema['properties']['edit_url'] = array(
66	'description' => __( 'URL to edit the order', 'woocommerce' ),
67	'type' => 'string',
68	'context' => array( 'view' ),
69	'readonly' => true,
70	);
71	$schema['properties']['customer'][] = array(
72	'description' => __( 'Name of the customer for the order', 'woocommerce' ),
73	'type' => 'string',
74	'context' => array( 'view' ),
75	'readonly' => true,
76	);
77	$schema['properties']['status_name'][] = array(
78	'description' => __( 'Order Status', 'woocommerce' ),
79	'type' => 'string',
80	'context' => array( 'view' ),
81	'readonly' => true,
82	);
83	$schema['properties']['formatted_total'][] = array(
84	'description' => __( 'Order total formatted for locale', 'woocommerce' ),
85	'type' => 'string',
86	'context' => array( 'view' ),
87	'readonly' => true,
88	);
89
90	return $schema;
91	}
92
93	/**
94	* Does a permissions check for the proper requested blog
95	*
96	* @param WP_REST_Request $request Full details about the request.
97	*
98	* @return bool $permission
99	*/
100	public function network_orders_permissions_check( $request ) {
101	$blog_id = $request->get_param( 'blog_id' );
102	$blog_id = ! empty( $blog_id ) ? $blog_id : get_current_blog_id();
103
104	switch_to_blog( $blog_id );
105
106	$permission = $this->get_items_permissions_check( $request );
107
108	restore_current_blog();
109
110	return $permission;
111	}
112
113	/**
114	* Get a collection of orders from the requested blog id
115	*
116	* @param WP_REST_Request $request Full details about the request.
117	*
118	* @return WP_REST_Response
119	*/
120	public function network_orders( $request ) {
121	$blog_id = $request->get_param( 'blog_id' );
122	$blog_id = ! empty( $blog_id ) ? $blog_id : get_current_blog_id();
123	$active_plugins = get_blog_option( $blog_id, 'active_plugins', array() );
124	$network_active_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
125
126	$plugins = array_merge( $active_plugins, $network_active_plugins );
127	$wc_active = false;
128	foreach ( $plugins as $plugin ) {
129	if ( substr_compare( $plugin, '/woocommerce.php', strlen( $plugin ) - strlen( '/woocommerce.php' ), strlen( '/woocommerce.php' ) ) === 0 ) {
130	$wc_active = true;
131	}
132	}
133
134	// If WooCommerce not active for site, return an empty response.
135	if ( ! $wc_active ) {
136	$response = rest_ensure_response( array() );
137	return $response;
138	}
139
140	switch_to_blog( $blog_id );
141	add_filter( 'woocommerce_rest_orders_prepare_object_query', array( $this, 'network_orders_filter_args' ) );
142	$items = $this->get_items( $request );
143	remove_filter( 'woocommerce_rest_orders_prepare_object_query', array( $this, 'network_orders_filter_args' ) );
144
145	foreach ( $items->data as &$current_order ) {
146	$order = wc_get_order( $current_order['id'] );
147
148	$current_order['blog'] = get_blog_details( get_current_blog_id() );
149	$current_order['edit_url'] = get_admin_url( $blog_id, 'post.php?post=' . absint( $order->get_id() ) . '&action=edit' );
150	/* translators: 1: first name 2: last name */
151	$current_order['customer'] = trim( sprintf( _x( '%1$s %2$s', 'full name', 'woocommerce' ), $order->get_billing_first_name(), $order->get_billing_last_name() ) );
152	$current_order['status_name'] = wc_get_order_status_name( $order->get_status() );
153	$current_order['formatted_total'] = $order->get_formatted_order_total();
154	}
155
156	restore_current_blog();
157
158	return $items;
159	}
160
161	/**
162	* Filters the post statuses to on hold and processing for the network order query.
163	*
164	* @param array $args Query args.
165	*
166	* @return array
167	*/
168	public function network_orders_filter_args( $args ) {
169	$args['post_status'] = array(
170	OrderInternalStatus::ON_HOLD,
171	OrderInternalStatus::PROCESSING,
172	);
173
174	return $args;
175	}
176	}
177