Automattic\WooCommerce\Admin

ReportCSVExporter::map_report_controller │ protected │ WC 1.0

Get a REST controller instance for the report type.

Method of the class: ReportCSVExporter{}

Returns

true|false|WC_REST_Reports_Controller. Report controller instance or boolean false on error.

Usage

// protected - for code of main (parent) or child class
$result = $this->map_report_controller();

ReportCSVExporter::map_report_controller() ReportCSVExporter::map report controller code ^{WC 10.5.0}

protected function map_report_controller() {
	/**
	 * Used to add custom report controllers.
	 *
	 * @since x.x.x
	 *
	 * @params array $controller_map A report type to report controller class map.
	 *
	 * @returns array Report type to report controller class map.
	 */
	$controller_map = apply_filters(
		'woocommerce_export_report_controller_map',
		array(
			'products'   => 'Automattic\WooCommerce\Admin\API\Reports\Products\Controller',
			'variations' => 'Automattic\WooCommerce\Admin\API\Reports\Variations\Controller',
			'orders'     => 'Automattic\WooCommerce\Admin\API\Reports\Orders\Controller',
			'categories' => 'Automattic\WooCommerce\Admin\API\Reports\Categories\Controller',
			'taxes'      => 'Automattic\WooCommerce\Admin\API\Reports\Taxes\Controller',
			'coupons'    => 'Automattic\WooCommerce\Admin\API\Reports\Coupons\Controller',
			'stock'      => 'Automattic\WooCommerce\Admin\API\Reports\Stock\Controller',
			'downloads'  => 'Automattic\WooCommerce\Admin\API\Reports\Downloads\Controller',
			'customers'  => 'Automattic\WooCommerce\Admin\API\Reports\Customers\Controller',
			'revenue'    => 'Automattic\WooCommerce\Admin\API\Reports\Revenue\Stats\Controller',
		)
	);

	if ( isset( $controller_map[ $this->report_type ] ) ) {
		// Load the controllers if accessing outside the REST API.
		return new $controller_map[ $this->report_type ]();
	}

	// Should this do something else?
	return false;
}