Automattic\WooCommerce\Admin\API\Reports\Categories

Controller{} │ WC 1.0

REST API Reports categories controller class.

Usage

$Controller = new Controller();
// use class methods

Methods

1. ERROR: no method name found on line `$args['category_includes'] = (array) $request['categories'];`
2. ERROR: no method name found on line `$args['per_page'] = $request['per_page'];`
3. public prepare_response_for_collection( $item )
4. ERROR: no method name found on line `$args['order'] = $request['order'];`
5. ERROR: no method name found on line `* @return array`
6. ERROR: no method name found on line `$args['page'] = $request['page'];`
7. public array()
8. ERROR: no method name found on line `'default' => 'category_id',`
9. public get_context_param( array( 'default' => 'view' ) )
10. ERROR: no method name found on line `'day',`
11. public get_collection_params()
12. ERROR: no method name found on line `);`
13. ERROR: no method name found on line `);`
14. ERROR: no method name found on line `'hour',`
15. public __( 'Category name.', 'woocommerce' )
16. ERROR: no method name found on line `'default' => 1,`
17. ERROR: no method name found on line ``
18. ERROR: no method name found on line `/**`
19. ERROR: no method name found on line `'sanitize_callback' => 'wp_validate_boolean',`
20. ERROR: no method name found on line `* Get the column names for export.`
21. ERROR: no method name found on line `'category',`
22. ERROR: no method name found on line `'type' => 'integer',`
23. ERROR: no method name found on line `'validate_callback' => 'rest_validate_request_arg',`
24. ERROR: no method name found on line `/**`
25. ERROR: no method name found on line ``
26. ERROR: no method name found on line `'validate_callback' => 'rest_validate_request_arg',`
27. ERROR: no method name found on line `),`
28. ERROR: no method name found on line ``
29. ERROR: no method name found on line ``
30. ERROR: no method name found on line `'maximum' => 100,`
31. ERROR: no method name found on line `),`
32. ERROR: no method name found on line `'validate_callback' => 'rest_validate_request_arg',`
33. ERROR: no method name found on line `),`
34. ERROR: no method name found on line `'validate_callback' => 'rest_validate_request_arg',`
35. ERROR: no method name found on line `);`
36. ERROR: no method name found on line ``
37. ERROR: no method name found on line ``
38. ERROR: no method name found on line ``
39. public get_export_columns()
40. ERROR: no method name found on line ``
41. ERROR: no method name found on line ``
42. ERROR: no method name found on line ``
43. ERROR: no method name found on line ``
44. ERROR: no method name found on line ``
45. ERROR: no method name found on line `'type' => 'string',`
46. public rest_ensure_response( $data )
47. ERROR: no method name found on line ``
48. ERROR: no method name found on line `* @return array`
49. ERROR: no method name found on line `'readonly' => true,`
50. ERROR: no method name found on line `'validate_callback' => 'rest_validate_request_arg',`
51. ERROR: no method name found on line `),`
52. ERROR: no method name found on line `'default' => false,`
53. ERROR: no method name found on line `*`
54. ERROR: no method name found on line `return $links;`
55. ERROR: no method name found on line `'$schema' => 'http://json-schema.org/draft-04/schema#',`
56. ERROR: no method name found on line `* Get the Report's schema, conforming to JSON Schema.`
57. ERROR: no method name found on line `* Prepare links for the request.`
58. ERROR: no method name found on line `* Prepare links for the request.`
59. public get_item_schema()
60. ERROR: no method name found on line `),`
61. ERROR: no method name found on line `),`
62. ERROR: no method name found on line `(int) $report_data->pages`
63. ERROR: no method name found on line `$export_item,`
64. ERROR: no method name found on line `);`
65. ERROR: no method name found on line `),`
66. ERROR: no method name found on line `'default' => 1,`
67. ERROR: no method name found on line ``
68. ERROR: no method name found on line `'type' => 'integer',`
69. ERROR: no method name found on line `* @return array`
70. ERROR: no method name found on line `* @return array`
71. ERROR: no method name found on line `* @return array`
72. ERROR: no method name found on line `* Get the query params for collections.`
73. public rest_url( sprintf( '/%s/products/categories/%d', $this->namespace, $object['category_id'] ) )
74. public get_items( $request )
75. ERROR: no method name found on line `}`
76. ERROR: no method name found on line `*`
77. ERROR: no method name found on line ``
78. ERROR: no method name found on line `$args['interval'] = $request['interval'];`
79. ERROR: no method name found on line `}`
80. ERROR: no method name found on line ``
81. ERROR: no method name found on line `(int) $report_data->page_no,`
82. ERROR: no method name found on line `* @param WP_REST_Request $request Request object.`
83. ERROR: no method name found on line ``
84. ERROR: no method name found on line `/**`
85. ERROR: no method name found on line `return $args;`
86. ERROR: no method name found on line `}`
87. protected prepare_reports_query( $request )
88. public Query( $query_args )
89. ERROR: no method name found on line `* @return array|WP_Error`
90. ERROR: no method name found on line `protected $rest_base = 'reports/categories';`
91. ERROR: no method name found on line `*`
92. public get_data()
93. ERROR: no method name found on line `}`
94. ERROR: no method name found on line `);`
95. ERROR: no method name found on line ``
96. ERROR: no method name found on line `*`
97. ERROR: no method name found on line ``
98. ERROR: no method name found on line `$item`
99. ERROR: no method name found on line ``
100. ERROR: no method name found on line `),`
101. ERROR: no method name found on line ``
102. ERROR: no method name found on line ``
103. ERROR: no method name found on line `}`
104. ERROR: no method name found on line `'readonly' => true,`
105. ERROR: no method name found on line `),`
106. public apply_filters( 'woocommerce_rest_prepare_report_categories', $response, $report, $request )
107. ERROR: no method name found on line `// Wrap the data in a response object.`
108. ERROR: no method name found on line `'minimum' => 1,`
109. ERROR: no method name found on line `'validate_callback' => 'rest_validate_request_arg',`
110. ERROR: no method name found on line `),`
111. public prepare_item_for_export( $item )
112. ERROR: no method name found on line ``
113. ERROR: no method name found on line `*`
114. ERROR: no method name found on line ``
115. ERROR: no method name found on line `* @return array Key value pair of Column ID => Label.`
116. ERROR: no method name found on line ``
117. ERROR: no method name found on line ``
118. ERROR: no method name found on line ``
119. ERROR: no method name found on line `),`
120. ERROR: no method name found on line `'hour',`
121. public prepare_item_for_response( $report, $request )
122. ERROR: no method name found on line `* @param object $report The original report object.`
123. ERROR: no method name found on line `// Wrap the data in a response object.`
124. ERROR: no method name found on line `*`
125. ERROR: no method name found on line `* @param stdClass $report Report data.`
126. ERROR: no method name found on line `*`
127. ERROR: no method name found on line `'sanitize_callback' => 'wp_parse_id_list',`
128. ERROR: no method name found on line `*`
129. ERROR: no method name found on line ``
130. ERROR: no method name found on line `'type' => 'integer',`
131. ERROR: no method name found on line ``
132. ERROR: no method name found on line `*/`
133. public filter_response_by_context( $data, $context )
134. ERROR: no method name found on line ``
135. ERROR: no method name found on line `}`
136. ERROR: no method name found on line `$data = $report;`
137. ERROR: no method name found on line `);`
138. ERROR: no method name found on line `* Get the query params for collections.`
139. ERROR: no method name found on line `* @param \Automattic\WooCommerce\Admin\API\Reports\Query $object Object data.`
140. ERROR: no method name found on line `*`
141. protected prepare_links( $object )
142. ERROR: no method name found on line `return $links;`
143. ERROR: no method name found on line `* @param WP_REST_Request $request Request used to generate the response.`
144. ERROR: no method name found on line `/**`
145. ERROR: no method name found on line ``
146. ERROR: no method name found on line `);`
147. ERROR: no method name found on line `* @param \Automattic\WooCommerce\Admin\API\Reports\Query $object Object data.`
148. ERROR: no method name found on line `* Filter a report returned from the API.`
149. ERROR: no method name found on line `* @param object $report The original report object.`
150. ERROR: no method name found on line `'type' => 'object',`
151. ERROR: no method name found on line `*/`
152. ERROR: no method name found on line `}`
153. ERROR: no method name found on line `$args['extended_info'] = $request['extended_info'];`
154. ERROR: no method name found on line `$args['page'] = $request['page'];`
155. ERROR: no method name found on line `$args['per_page'] = $request['per_page'];`
156. ERROR: no method name found on line `* Filter a report returned from the API.`
157. ERROR: no method name found on line `$args['after'] = $request['after'];`
158. ERROR: no method name found on line `$args['before'] = $request['before'];`
159. ERROR: no method name found on line ``
160. ERROR: no method name found on line `$args['orderby'] = $request['orderby'];`
161. ERROR: no method name found on line `(int) $report_data->page_no,`
162. ERROR: no method name found on line `*`
163. ERROR: no method name found on line `* @return array`
164. ERROR: no method name found on line `*`
165. ERROR: no method name found on line `}`
166. ERROR: no method name found on line `* Get the query params for collections.`
167. ERROR: no method name found on line `$args['extended_info'] = $request['extended_info'];`
168. ERROR: no method name found on line `* @return array Key value pair of Column ID => Label.`

Controller{} Controller{} code ^{WC 8.7.0}

class Controller extends ReportsController implements ExportableInterface {

	/**
	 * Route base.
	 *
	 * @var string
	 */
	protected $rest_base = 'reports/categories';

	/**
	 * Maps query arguments from the REST request.
	 *
	 * @param array $request Request array.
	 * @return array
	 */
	protected function prepare_reports_query( $request ) {
		$args                        = array();
		$args['before']              = $request['before'];
		$args['after']               = $request['after'];
		$args['interval']            = $request['interval'];
		$args['page']                = $request['page'];
		$args['per_page']            = $request['per_page'];
		$args['orderby']             = $request['orderby'];
		$args['order']               = $request['order'];
		$args['extended_info']       = $request['extended_info'];
		$args['category_includes']   = (array) $request['categories'];
		$args['status_is']           = (array) $request['status_is'];
		$args['status_is_not']       = (array) $request['status_is_not'];
		$args['force_cache_refresh'] = $request['force_cache_refresh'];

		return $args;
	}

	/**
	 * Get all reports.
	 *
	 * @param WP_REST_Request $request Request data.
	 * @return array|WP_Error
	 */
	public function get_items( $request ) {
		$query_args       = $this->prepare_reports_query( $request );
		$categories_query = new Query( $query_args );
		$report_data      = $categories_query->get_data();

		if ( is_wp_error( $report_data ) ) {
			return $report_data;
		}

		if ( ! isset( $report_data->data ) || ! isset( $report_data->page_no ) || ! isset( $report_data->pages ) ) {
			return new \WP_Error( 'woocommerce_rest_reports_categories_invalid_response', __( 'Invalid response from data store.', 'woocommerce' ), array( 'status' => 500 ) );
		}

		$out_data = array();

		foreach ( $report_data->data as $datum ) {
			$item       = $this->prepare_item_for_response( $datum, $request );
			$out_data[] = $this->prepare_response_for_collection( $item );
		}

		return $this->add_pagination_headers(
			$request,
			$out_data,
			(int) $report_data->total,
			(int) $report_data->page_no,
			(int) $report_data->pages
		);
	}

	/**
	 * Prepare a report object for serialization.
	 *
	 * @param stdClass        $report  Report data.
	 * @param WP_REST_Request $request Request object.
	 * @return WP_REST_Response
	 */
	public function prepare_item_for_response( $report, $request ) {
		$data = $report;

		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
		$data    = $this->add_additional_fields_to_object( $data, $request );
		$data    = $this->filter_response_by_context( $data, $context );

		// Wrap the data in a response object.
		$response = rest_ensure_response( $data );
		$response->add_links( $this->prepare_links( $report ) );

		/**
		 * Filter a report returned from the API.
		 *
		 * Allows modification of the report data right before it is returned.
		 *
		 * @param WP_REST_Response $response The response object.
		 * @param object           $report   The original report object.
		 * @param WP_REST_Request  $request  Request used to generate the response.
		 */
		return apply_filters( 'woocommerce_rest_prepare_report_categories', $response, $report, $request );
	}

	/**
	 * Prepare links for the request.
	 *
	 * @param \Automattic\WooCommerce\Admin\API\Reports\Query $object Object data.
	 * @return array
	 */
	protected function prepare_links( $object ) {
		$links = array(
			'category' => array(
				'href' => rest_url( sprintf( '/%s/products/categories/%d', $this->namespace, $object['category_id'] ) ),
			),
		);

		return $links;
	}

	/**
	 * Get the Report's schema, conforming to JSON Schema.
	 *
	 * @return array
	 */
	public function get_item_schema() {
		$schema = array(
			'$schema'    => 'http://json-schema.org/draft-04/schema#',
			'title'      => 'report_categories',
			'type'       => 'object',
			'properties' => array(
				'category_id'    => array(
					'description' => __( 'Category ID.', 'woocommerce' ),
					'type'        => 'integer',
					'context'     => array( 'view', 'edit' ),
					'readonly'    => true,
				),
				'items_sold'     => array(
					'description' => __( 'Amount of items sold.', 'woocommerce' ),
					'type'        => 'integer',
					'context'     => array( 'view', 'edit' ),
					'readonly'    => true,
				),
				'net_revenue'    => array(
					'description' => __( 'Total sales.', 'woocommerce' ),
					'type'        => 'number',
					'context'     => array( 'view', 'edit' ),
					'readonly'    => true,
				),
				'orders_count'   => array(
					'description' => __( 'Number of orders.', 'woocommerce' ),
					'type'        => 'integer',
					'context'     => array( 'view', 'edit' ),
					'readonly'    => true,
				),
				'products_count' => array(
					'description' => __( 'Amount of products.', 'woocommerce' ),
					'type'        => 'integer',
					'context'     => array( 'view', 'edit' ),
					'readonly'    => true,
				),
				'extended_info'  => array(
					'name' => array(
						'type'        => 'string',
						'readonly'    => true,
						'context'     => array( 'view', 'edit' ),
						'description' => __( 'Category name.', 'woocommerce' ),
					),
				),
			),
		);

		return $this->add_additional_fields_schema( $schema );
	}

	/**
	 * Get the query params for collections.
	 *
	 * @return array
	 */
	public function get_collection_params() {
		$params                        = array();
		$params['context']             = $this->get_context_param( array( 'default' => 'view' ) );
		$params['page']                = array(
			'description'       => __( 'Current page of the collection.', 'woocommerce' ),
			'type'              => 'integer',
			'default'           => 1,
			'sanitize_callback' => 'absint',
			'validate_callback' => 'rest_validate_request_arg',
			'minimum'           => 1,
		);
		$params['per_page']            = array(
			'description'       => __( 'Maximum number of items to be returned in result set.', 'woocommerce' ),
			'type'              => 'integer',
			'default'           => 10,
			'minimum'           => 1,
			'maximum'           => 100,
			'sanitize_callback' => 'absint',
			'validate_callback' => 'rest_validate_request_arg',
		);
		$params['after']               = array(
			'description'       => __( 'Limit response to resources published after a given ISO8601 compliant date.', 'woocommerce' ),
			'type'              => 'string',
			'format'            => 'date-time',
			'validate_callback' => 'rest_validate_request_arg',
		);
		$params['before']              = array(
			'description'       => __( 'Limit response to resources published before a given ISO8601 compliant date.', 'woocommerce' ),
			'type'              => 'string',
			'format'            => 'date-time',
			'validate_callback' => 'rest_validate_request_arg',
		);
		$params['order']               = array(
			'description'       => __( 'Order sort attribute ascending or descending.', 'woocommerce' ),
			'type'              => 'string',
			'default'           => 'desc',
			'enum'              => array( 'asc', 'desc' ),
			'validate_callback' => 'rest_validate_request_arg',
		);
		$params['orderby']             = array(
			'description'       => __( 'Sort collection by object attribute.', 'woocommerce' ),
			'type'              => 'string',
			'default'           => 'category_id',
			'enum'              => array(
				'category_id',
				'items_sold',
				'net_revenue',
				'orders_count',
				'products_count',
				'category',
			),
			'validate_callback' => 'rest_validate_request_arg',
		);
		$params['interval']            = array(
			'description'       => __( 'Time interval to use for buckets in the returned data.', 'woocommerce' ),
			'type'              => 'string',
			'default'           => 'week',
			'enum'              => array(
				'hour',
				'day',
				'week',
				'month',
				'quarter',
				'year',
			),
			'validate_callback' => 'rest_validate_request_arg',
		);
		$params['status_is']           = array(
			'description'       => __( 'Limit result set to items that have the specified order status.', 'woocommerce' ),
			'type'              => 'array',
			'sanitize_callback' => 'wp_parse_slug_list',
			'validate_callback' => 'rest_validate_request_arg',
			'items'             => array(
				'enum' => self::get_order_statuses(),
				'type' => 'string',
			),
		);
		$params['status_is_not']       = array(
			'description'       => __( 'Limit result set to items that don\'t have the specified order status.', 'woocommerce' ),
			'type'              => 'array',
			'sanitize_callback' => 'wp_parse_slug_list',
			'validate_callback' => 'rest_validate_request_arg',
			'items'             => array(
				'enum' => self::get_order_statuses(),
				'type' => 'string',
			),
		);
		$params['categories']          = array(
			'description'       => __( 'Limit result set to all items that have the specified term assigned in the categories taxonomy.', 'woocommerce' ),
			'type'              => 'array',
			'sanitize_callback' => 'wp_parse_id_list',
			'validate_callback' => 'rest_validate_request_arg',
			'items'             => array(
				'type' => 'integer',
			),
		);
		$params['extended_info']       = array(
			'description'       => __( 'Add additional piece of info about each category to the report.', 'woocommerce' ),
			'type'              => 'boolean',
			'default'           => false,
			'sanitize_callback' => 'wc_string_to_bool',
			'validate_callback' => 'rest_validate_request_arg',
		);
		$params['force_cache_refresh'] = array(
			'description'       => __( 'Force retrieval of fresh data instead of from the cache.', 'woocommerce' ),
			'type'              => 'boolean',
			'sanitize_callback' => 'wp_validate_boolean',
			'validate_callback' => 'rest_validate_request_arg',
		);

		return $params;
	}

	/**
	 * Get the column names for export.
	 *
	 * @return array Key value pair of Column ID => Label.
	 */
	public function get_export_columns() {
		$export_columns = array(
			'category'       => __( 'Category', 'woocommerce' ),
			'items_sold'     => __( 'Items sold', 'woocommerce' ),
			'net_revenue'    => __( 'Net Revenue', 'woocommerce' ),
			'products_count' => __( 'Products', 'woocommerce' ),
			'orders_count'   => __( 'Orders', 'woocommerce' ),
		);

		/**
		 * Filter to add or remove column names from the categories report for
		 * export.
		 *
		 * @since 1.6.0
		 */
		return apply_filters(
			'woocommerce_report_categories_export_columns',
			$export_columns
		);
	}

	/**
	 * Get the column values for export.
	 *
	 * @param array $item Single report item/row.
	 * @return array Key value pair of Column ID => Row Value.
	 */
	public function prepare_item_for_export( $item ) {
		$export_item = array(
			'category'       => $item['extended_info']['name'],
			'items_sold'     => $item['items_sold'],
			'net_revenue'    => $item['net_revenue'],
			'products_count' => $item['products_count'],
			'orders_count'   => $item['orders_count'],
		);

		/**
		 * Filter to prepare extra columns in the export item for the
		 * categories export.
		 *
		 * @since 1.6.0
		 */
		return apply_filters(
			'woocommerce_report_categories_prepare_export_item',
			$export_item,
			$item
		);
	}
}