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 ``
2. public get_data()
3. ERROR: no method name found on line `*/`
4. ERROR: no method name found on line `* Get data from `'categories'` GenericQuery.`
5. ERROR: no method name found on line `$args['extended_info'] = $request['extended_info'];`
6. ERROR: no method name found on line `/**`
7. ERROR: no method name found on line ``
8. ERROR: no method name found on line `'type' => 'string',`
9. ERROR: no method name found on line `* Get the column names for export.`
10. public __( 'Items sold', 'woocommerce' )
11. ERROR: no method name found on line `* @since 1.6.0`
12. public get_order_statuses()
13. ERROR: no method name found on line `'validate_callback' => 'rest_validate_request_arg',`
14. ERROR: no method name found on line ``
15. ERROR: no method name found on line `);`
16. ERROR: no method name found on line `* Filter to add or remove column names from the categories report for`
17. ERROR: no method name found on line `),`
18. ERROR: no method name found on line `)`
19. ERROR: no method name found on line ``
20. public array(
21. ERROR: no method name found on line `'sanitize_callback' => 'wp_parse_slug_list',`
22. ERROR: no method name found on line ``
23. ERROR: no method name found on line ``
24. ERROR: no method name found on line `$params['orderby']['default'] = 'category_id';`
25. ERROR: no method name found on line `* @param array $item Single report item/row.`
26. ERROR: no method name found on line `'title' => 'report_categories',`
27. ERROR: no method name found on line ``
28. ERROR: no method name found on line ``
29. public get_collection_params()
30. ERROR: no method name found on line `);`
31. ERROR: no method name found on line `'validate_callback' => 'rest_validate_request_arg',`
32. ERROR: no method name found on line ``
33. ERROR: no method name found on line `'type' => 'integer',`
34. ERROR: no method name found on line ``
35. ERROR: no method name found on line ``
36. ERROR: no method name found on line `'sanitize_callback' => 'wp_parse_slug_list',`
37. ERROR: no method name found on line `);`
38. ERROR: no method name found on line `'type' => 'array',`
39. ERROR: no method name found on line `);`
40. ERROR: no method name found on line `'default' => 'week',`
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. protected get_datastore_data( $query_args = array() )
45. ERROR: no method name found on line `*/`
46. ERROR: no method name found on line `*/`
47. ERROR: no method name found on line `$args['page'] = $request['page'];`
48. ERROR: no method name found on line `*/`
49. ERROR: no method name found on line `}`
50. ERROR: no method name found on line `$args['after'] = $request['after'];`
51. ERROR: no method name found on line `$args['orderby'] = $request['orderby'];`
52. ERROR: no method name found on line ``
53. ERROR: no method name found on line `$args['status_is'] = (array) $request['status_is'];`
54. ERROR: no method name found on line `*/`
55. ERROR: no method name found on line ``
56. ERROR: no method name found on line ``
57. ERROR: no method name found on line `return $args;`
58. public get_export_columns()
59. ERROR: no method name found on line ``
60. ERROR: no method name found on line ``
61. ERROR: no method name found on line ``
62. ERROR: no method name found on line `'category' => $item['extended_info']['name'],`
63. ERROR: no method name found on line ``
64. ERROR: no method name found on line ``
65. ERROR: no method name found on line ``
66. ERROR: no method name found on line `'type' => 'array',`
67. ERROR: no method name found on line ``
68. ERROR: no method name found on line `* @param WP_REST_Response $response The response object.`
69. ERROR: no method name found on line `'orders_count',`
70. ERROR: no method name found on line `* Filter to prepare extra columns in the export item for the`
71. ERROR: no method name found on line ``
72. ERROR: no method name found on line `);`
73. ERROR: no method name found on line `'title' => 'report_categories',`
74. ERROR: no method name found on line `'type' => 'object',`
75. ERROR: no method name found on line `'readonly' => true,`
76. ERROR: no method name found on line `* @return array`
77. public get_item_schema()
78. ERROR: no method name found on line `'type' => 'integer',`
79. ERROR: no method name found on line `*`
80. ERROR: no method name found on line ``
81. ERROR: no method name found on line `'type' => 'string',`
82. ERROR: no method name found on line ``
83. ERROR: no method name found on line `'readonly' => true,`
84. ERROR: no method name found on line ``
85. ERROR: no method name found on line `'week',`
86. ERROR: no method name found on line `'$schema' => 'http://json-schema.org/draft-04/schema#',`
87. ERROR: no method name found on line `* @return mixed Results from the data store.`
88. ERROR: no method name found on line `'title' => 'report_categories',`
89. ERROR: no method name found on line `* Allows modification of the report data right before it is returned.`
90. ERROR: no method name found on line ``
91. ERROR: no method name found on line `*/`
92. public apply_filters( 'woocommerce_rest_prepare_report_categories', $response, $report, $request )
93. ERROR: no method name found on line `'type' => 'integer',`
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 ``
99. ERROR: no method name found on line `}`
100. ERROR: no method name found on line ``
101. ERROR: no method name found on line `* @param mixed $report Report data item as returned from Data Store.`
102. ERROR: no method name found on line `return $links;`
103. ERROR: no method name found on line `'hour',`
104. ERROR: no method name found on line `'type' => 'boolean',`
105. ERROR: no method name found on line `* Maps query arguments from the REST request.`
106. ERROR: no method name found on line `/**`
107. public prepare_item_for_export( $item )
108. ERROR: no method name found on line ``
109. ERROR: no method name found on line ``
110. ERROR: no method name found on line ``
111. ERROR: no method name found on line ``
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. public prepare_item_for_response( $report, $request )
116. ERROR: no method name found on line `* Prepare links for the request.`
117. ERROR: no method name found on line `* @param WP_REST_Request $request Request used to generate the response.`
118. protected prepare_links( $object )
119. ERROR: no method name found on line `$args['status_is'] = (array) $request['status_is'];`
120. ERROR: no method name found on line `$args['after'] = $request['after'];`
121. ERROR: no method name found on line `$export_item,`
122. ERROR: no method name found on line `* @return array`
123. public rest_url( sprintf( '/%s/products/categories/%d', $this->namespace, $object['category_id'] ) )
124. ERROR: no method name found on line `),`
125. ERROR: no method name found on line ``
126. ERROR: no method name found on line `),`
127. ERROR: no method name found on line `* Prepare a report data item for serialization.`
128. ERROR: no method name found on line ``
129. ERROR: no method name found on line `* @return \WP_REST_Response`
130. ERROR: no method name found on line `*`
131. ERROR: no method name found on line `),`
132. ERROR: no method name found on line `);`
133. ERROR: no method name found on line `*/`
134. ERROR: no method name found on line `* @return array`
135. ERROR: no method name found on line ``
136. ERROR: no method name found on line `/**`
137. ERROR: no method name found on line ``
138. ERROR: no method name found on line `'readonly' => true,`
139. ERROR: no method name found on line `* @return array`
140. ERROR: no method name found on line `/**`
141. ERROR: no method name found on line `'readonly' => true,`
142. protected prepare_reports_query( $request )
143. ERROR: no method name found on line `*/`
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. public GenericQuery( $query_args, 'categories' )
148. ERROR: no method name found on line `$args['before'] = $request['before'];`
149. ERROR: no method name found on line `return $links;`
150. ERROR: no method name found on line ``
151. ERROR: no method name found on line `* @param \Automattic\WooCommerce\Admin\API\Reports\GenericQuery $object Object data.`
152. ERROR: no method name found on line `*`
153. ERROR: no method name found on line `* @param array $query_args Query arguments.`
154. ERROR: no method name found on line `*/`
155. ERROR: no method name found on line `}`
156. ERROR: no method name found on line `$args['interval'] = $request['interval'];`
157. ERROR: no method name found on line ``
158. ERROR: no method name found on line `* Filter a report returned from the API.`
159. ERROR: no method name found on line `protected $rest_base = 'reports/categories';`
160. ERROR: no method name found on line `/**`
161. ERROR: no method name found on line `'month',`
162. ERROR: no method name found on line `'net_revenue',`
163. ERROR: no method name found on line `'category',`
164. ERROR: no method name found on line ``
165. ERROR: no method name found on line ``
166. ERROR: no method name found on line `'category' => $item['extended_info']['name'],`

Controller{} Controller{} code ^{WC 9.8.1}

class Controller extends GenericController implements ExportableInterface {

	use OrderAwareControllerTrait;

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

	/**
	 * Get data from `'categories'` GenericQuery.
	 *
	 * @override GenericController::get_datastore_data()
	 *
	 * @param array $query_args Query arguments.
	 * @return mixed Results from the data store.
	 */
	protected function get_datastore_data( $query_args = array() ) {
		$query = new GenericQuery( $query_args, 'categories' );
		return $query->get_data();
	}

	/**
	 * 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;
	}

	/**
	 * Prepare a report data item for serialization.
	 *
	 * @param mixed            $report  Report data item as returned from Data Store.
	 * @param \WP_REST_Request $request Request object.
	 * @return \WP_REST_Response
	 */
	public function prepare_item_for_response( $report, $request ) {
		// Wrap the data in a response object.
		$response = parent::prepare_item_for_response( $report, $request );
		$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\GenericQuery $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                       = parent::get_collection_params();
		$params['orderby']['default'] = 'category_id';
		$params['orderby']['enum']    = $this->apply_custom_orderby_filters(
			array(
				'category_id',
				'items_sold',
				'net_revenue',
				'orders_count',
				'products_count',
				'category',
			)
		);
		$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',
		);

		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
		);
	}
}