WC_REST_Report_Sales_Controller - Code Metrics - woothemes/woocommerce - Measure and Improve Code Quality continuously with Scrutinizer

WC_REST_Report_Sales_Controller A
last analyzed 2017-04-11 22:39 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	373
Duplicated Lines	28.42 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
dl	106
loc	373
rs	9
c	0
b	0
f	0
wmc	35
lcom	1
cbo	3

7 Methods

Rating	Name	Duplication	Size	Complexity
A	register_routes()	11	11	1
A	get_items_permissions_check()	7	7	2
A	get_items()	0	7	1
F	prepare_item_for_response()	0	143	22
B	get_collection_params()	0	26	1
C	setup_report()	11	35	7
B	get_item_schema()	77	77	1

How to fix Duplicated Code

<?php
/**
 * REST API Reports controller
 *
 * Handles requests to the reports/sales endpoint.
 *
 * @author   WooThemes
 * @category API
 * @package  WooCommerce/API
 * @since    2.6.0
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * REST API Report Sales controller class.
 *
 * @package WooCommerce/API
 * @extends WC_REST_Controller
 */
class WC_REST_Report_Sales_Controller extends WC_REST_Controller {

	/**
	 * Endpoint namespace.
	 *
	 * @var string
	 */
	protected $namespace = 'wc/v1';

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

	/**
	 * Report instance.
	 *
	 * @var WC_Admin_Report
	 */
	protected $report;

	/**
	 * Register the routes for sales reports.
	 */
	public function register_routes() {

		register_rest_route( $this->namespace, '/' . $this->rest_base, array(
			array(
				'methods'             => WP_REST_Server::READABLE,
				'callback'            => array( $this, 'get_items' ),
				'permission_callback' => array( $this, 'get_items_permissions_check' ),
				'args'                => $this->get_collection_params(),
			),
			'schema' => array( $this, 'get_public_item_schema' ),
		) );
	}

	/**
	 * Check whether a given request has permission to read report.
	 *
	 * @param  WP_REST_Request $request Full details about the request.
	 * @return WP_Error|boolean
	 */
	public function get_items_permissions_check( $request ) {

		if ( ! wc_rest_check_manager_permissions( 'reports', 'read' ) ) {
			return new WP_Error( 'woocommerce_rest_cannot_view', __( 'Sorry, you cannot list resources.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );
		}

		return true;
	}

	/**
	 * Get sales reports.
	 *
	 * @param WP_REST_Request $request
	 * @return array|WP_Error
	 */
	public function get_items( $request ) {
		$data   = array();
		$item   = $this->prepare_item_for_response( null, $request );
		$data[] = $this->prepare_response_for_collection( $item );

		return rest_ensure_response( $data );
	}

	/**
	 * Prepare a report sales object for serialization.
	 *
	 * @param null $_
	 * @param WP_REST_Request $request Request object.
	 * @return WP_REST_Response $response Response data.
	 */
	public function prepare_item_for_response( $_, $request ) {
		// Set date filtering.
		$filter = array(
			'period'   => $request['period'],
			'date_min' => $request['date_min'],
			'date_max' => $request['date_max'],
		);
		$this->setup_report( $filter );

		// New customers.
		$users_query = new WP_User_Query(
			array(
				'fields' => array( 'user_registered' ),
				'role'   => 'customer',
			)
		);

		$customers = $users_query->get_results();

		foreach ( $customers as $key => $customer ) {
			if ( strtotime( $customer->user_registered ) < $this->report->start_date || strtotime( $customer->user_registered ) > $this->report->end_date ) {
				unset( $customers[ $key ] );
			}
		}

		$total_customers = count( $customers );
		$report_data     = $this->report->get_report_data();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
		$period_totals   = array();

		// Setup period totals by ensuring each period in the interval has data.
		for ( $i = 0; $i <= $this->report->chart_interval; $i++ ) {

			switch ( $this->report->chart_groupby ) {
				case 'day' :
					$time = date( 'Y-m-d', strtotime( "+{$i} DAY", $this->report->start_date ) );
					break;
				default :
					$time = date( 'Y-m', strtotime( "+{$i} MONTH", $this->report->start_date ) );
					break;
			}

			// Set the customer signups for each period.
			$customer_count = 0;
			foreach ( $customers as $customer ) {
				if ( date( ( 'day' == $this->report->chart_groupby ) ? 'Y-m-d' : 'Y-m', strtotime( $customer->user_registered ) ) == $time ) {
					$customer_count++;
				}
 			}

			$period_totals[ $time ] = array(
				'sales'     => wc_format_decimal( 0.00, 2 ),
				'orders'    => 0,
				'items'     => 0,
				'tax'       => wc_format_decimal( 0.00, 2 ),
				'shipping'  => wc_format_decimal( 0.00, 2 ),
				'discount'  => wc_format_decimal( 0.00, 2 ),
				'customers' => $customer_count,
			);
		}

		// add total sales, total order count, total tax and total shipping for each period
		foreach ( $report_data->orders as $order ) {
			$time = ( 'day' === $this->report->chart_groupby ) ? date( 'Y-m-d', strtotime( $order->post_date ) ) : date( 'Y-m', strtotime( $order->post_date ) );

			if ( ! isset( $period_totals[ $time ] ) ) {
				continue;
			}

			$period_totals[ $time ]['sales']    = wc_format_decimal( $order->total_sales, 2 );
			$period_totals[ $time ]['tax']      = wc_format_decimal( $order->total_tax + $order->total_shipping_tax, 2 );
			$period_totals[ $time ]['shipping'] = wc_format_decimal( $order->total_shipping, 2 );
		}

		foreach ( $report_data->order_counts as $order ) {
			$time = ( 'day' === $this->report->chart_groupby ) ? date( 'Y-m-d', strtotime( $order->post_date ) ) : date( 'Y-m', strtotime( $order->post_date ) );

			if ( ! isset( $period_totals[ $time ] ) ) {
				continue;
			}

			$period_totals[ $time ]['orders']   = (int) $order->count;
		}

		// Add total order items for each period.
		foreach ( $report_data->order_items as $order_item ) {
			$time = ( 'day' === $this->report->chart_groupby ) ? date( 'Y-m-d', strtotime( $order_item->post_date ) ) : date( 'Y-m', strtotime( $order_item->post_date ) );

			if ( ! isset( $period_totals[ $time ] ) ) {
				continue;
			}

			$period_totals[ $time ]['items'] = (int) $order_item->order_item_count;
		}

		// Add total discount for each period.
		foreach ( $report_data->coupons as $discount ) {
			$time = ( 'day' === $this->report->chart_groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) );

			if ( ! isset( $period_totals[ $time ] ) ) {
				continue;
			}

			$period_totals[ $time ]['discount'] = wc_format_decimal( $discount->discount_amount, 2 );
		}

		$sales_data = array(
			'total_sales'       => $report_data->total_sales,
			'net_sales'         => $report_data->net_sales,
			'average_sales'     => $report_data->average_sales,
			'total_orders'      => $report_data->total_orders,
			'total_items'       => $report_data->total_items,
			'total_tax'         => wc_format_decimal( $report_data->total_tax + $report_data->total_shipping_tax, 2 ),
			'total_shipping'    => $report_data->total_shipping,
			'total_refunds'     => $report_data->total_refunds,
			'total_discount'    => $report_data->total_coupons,
			'totals_grouped_by' => $this->report->chart_groupby,
			'totals'            => $period_totals,
			'total_customers'   => $total_customers,
		);

		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
		$data    = $this->add_additional_fields_to_object( $sales_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( array(
			'about' => array(
				'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
			),
		) );

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

	/**
	 * Setup the report object and parse any date filtering.
	 *
	 * @param array $filter date filtering
	 */
	protected function setup_report( $filter ) {
		include_once( WC()->plugin_path() . '/includes/admin/reports/class-wc-admin-report.php' );
		include_once( WC()->plugin_path() . '/includes/admin/reports/class-wc-report-sales-by-date.php' );

		$this->report = new WC_Report_Sales_By_Date();

		if ( empty( $filter['period'] ) ) {

			// Custom date range.
			$filter['period'] = 'custom';

			if ( ! empty( $filter['date_min'] ) || ! empty( $filter['date_max'] ) ) {


				// Overwrite _GET to make use of WC_Admin_Report::calculate_current_range() for custom date ranges.
				$_GET['start_date'] = $filter['date_min'];
				$_GET['end_date'] = isset( $filter['date_max'] ) ? $filter['date_max'] : null;

			} else {

				// Default custom range to today.
				$_GET['start_date'] = $_GET['end_date'] = date( 'Y-m-d', current_time( 'timestamp' ) );
			}

		} else {

			$filter['period'] = empty( $filter['period'] ) ? 'week' : $filter['period'];

			// Change "week" period to "7day".
			if ( 'week' === $filter['period'] ) {
				$filter['period'] = '7day';
			}
		}

		$this->report->calculate_current_range( $filter['period'] );
	}

	/**
	 * 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'      => 'sales_report',
			'type'       => 'object',
			'properties' => array(
				'total_sales' => array(
					'description' => __( 'Gross sales in the period.', 'woocommerce' ),
					'type'        => 'string',
					'context'     => array( 'view' ),
					'readonly'    => true,
				),
				'net_sales' => array(
					'description' => __( 'Net sales in the period.', 'woocommerce' ),
					'type'        => 'string',
					'context'     => array( 'view' ),
					'readonly'    => true,
				),
				'average_sales' => array(
					'description' => __( 'Average net daily sales.', 'woocommerce' ),
					'type'        => 'string',
					'context'     => array( 'view' ),
					'readonly'    => true,
				),
				'total_orders' => array(
					'description' => __( 'Total of orders placed.', 'woocommerce' ),
					'type'        => 'integer',
					'context'     => array( 'view' ),
					'readonly'    => true,
				),
				'total_items' => array(
					'description' => __( 'Total of items purchased.', 'woocommerce' ),
					'type'        => 'integer',
					'context'     => array( 'view' ),
					'readonly'    => true,
				),
				'total_tax' => array(
					'description' => __( 'Total charged for taxes.', 'woocommerce' ),
					'type'        => 'string',
					'context'     => array( 'view' ),
					'readonly'    => true,
				),
				'total_shipping' => array(
					'description' => __( 'Total charged for shipping.', 'woocommerce' ),
					'type'        => 'string',
					'context'     => array( 'view' ),
					'readonly'    => true,
				),
				'total_refunds' => array(
					'description' => __( 'Total of refunded orders.', 'woocommerce' ),
					'type'        => 'integer',
					'context'     => array( 'view' ),
					'readonly'    => true,
				),
				'total_discount' => array(
					'description' => __( 'Total of coupons used.', 'woocommerce' ),
					'type'        => 'integer',
					'context'     => array( 'view' ),
					'readonly'    => true,
				),
				'totals_grouped_by' => array(
					'description' => __( 'Group type.', 'woocommerce' ),
					'type'        => 'string',
					'context'     => array( 'view' ),
					'readonly'    => true,
				),
				'totals' => array(
					'description' => __( 'Totals.', 'woocommerce' ),
					'type'        => 'array',
					'context'     => array( 'view' ),
					'readonly'    => true,
				),
			),
		);

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

	/**
	 * Get the query params for collections.
	 *
	 * @return array
	 */
	public function get_collection_params() {
		return array(
			'context' => $this->get_context_param( array( 'default' => 'view' ) ),
			'period' => array(
				'description'       => __( 'Report period.', 'woocommerce' ),
				'type'              => 'string',
				'enum'              => array( 'week', 'month', 'last_month', 'year' ),
				'validate_callback' => 'rest_validate_request_arg',
				'sanitize_callback' => 'sanitize_text_field',
			),
			'date_min' => array(
				'description'       => sprintf( __( 'Return sales for a specific start date, the date need to be in the %s format.', 'woocommerce' ), 'YYYY-MM-AA' ),
				'type'              => 'string',
				'format'            => 'date',
				'validate_callback' => 'wc_rest_validate_reports_request_arg',
				'sanitize_callback' => 'sanitize_text_field',
			),
			'date_max' => array(
				'description'       => sprintf( __( 'Return sales for a specific end date, the date need to be in the %s format.', 'woocommerce' ), 'YYYY-MM-AA' ),
				'type'              => 'string',
				'format'            => 'date',
				'validate_callback' => 'wc_rest_validate_reports_request_arg',
				'sanitize_callback' => 'sanitize_text_field',
			),
		);
	}
}


1		<?php
2		/**
3		* REST API Reports controller
4		*
5		* Handles requests to the reports/sales endpoint.
6		*
7		* @author WooThemes
8		* @category API
9		* @package WooCommerce/API
10		* @since 2.6.0
11		*/
12
13		if ( ! defined( 'ABSPATH' ) ) {
14		exit;
15		}
16
17		/**
18		* REST API Report Sales controller class.
19		*
20		* @package WooCommerce/API
21		* @extends WC_REST_Controller
22		*/
23		class WC_REST_Report_Sales_Controller extends WC_REST_Controller {
24
25		/**
26		* Endpoint namespace.
27		*
28		* @var string
29		*/
30		protected $namespace = 'wc/v1';
31
32		/**
33		* Route base.
34		*
35		* @var string
36		*/
37		protected $rest_base = 'reports/sales';
38
39		/**
40		* Report instance.
41		*
42		* @var WC_Admin_Report
43		*/
44		protected $report;
45
46		/**
47		* Register the routes for sales reports.
48		*/
49	View Code Duplication	public function register_routes() {
		0 ignored issues – show Duplication introduced 2016-04-19 16:00 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
50		register_rest_route( $this->namespace, '/' . $this->rest_base, array(
51		array(
52		'methods' => WP_REST_Server::READABLE,
53		'callback' => array( $this, 'get_items' ),
54		'permission_callback' => array( $this, 'get_items_permissions_check' ),
55		'args' => $this->get_collection_params(),
56		),
57		'schema' => array( $this, 'get_public_item_schema' ),
58		) );
59		}
60
61		/**
62		* Check whether a given request has permission to read report.
63		*
64		* @param WP_REST_Request $request Full details about the request.
65		* @return WP_Error\|boolean
66		*/
67	View Code Duplication	public function get_items_permissions_check( $request ) {
		0 ignored issues – show Duplication introduced 2016-04-19 16:00 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
68		if ( ! wc_rest_check_manager_permissions( 'reports', 'read' ) ) {
69		return new WP_Error( 'woocommerce_rest_cannot_view', __( 'Sorry, you cannot list resources.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );
70		}
71
72		return true;
73		}
74
75		/**
76		* Get sales reports.
77		*
78		* @param WP_REST_Request $request
79		* @return array\|WP_Error
80		*/
81		public function get_items( $request ) {
82		$data = array();
83		$item = $this->prepare_item_for_response( null, $request );
84		$data[] = $this->prepare_response_for_collection( $item );
85
86		return rest_ensure_response( $data );
87		}
88
89		/**
90		* Prepare a report sales object for serialization.
91		*
92		* @param null $_
93		* @param WP_REST_Request $request Request object.
94		* @return WP_REST_Response $response Response data.
95		*/
96		public function prepare_item_for_response( $_, $request ) {
97		// Set date filtering.
98		$filter = array(
99		'period' => $request['period'],
100		'date_min' => $request['date_min'],
101		'date_max' => $request['date_max'],
102		);
103		$this->setup_report( $filter );
104
105		// New customers.
106		$users_query = new WP_User_Query(
107		array(
108		'fields' => array( 'user_registered' ),
109		'role' => 'customer',
110		)
111		);
112
113		$customers = $users_query->get_results();
114
115		foreach ( $customers as $key => $customer ) {
116		if ( strtotime( $customer->user_registered ) < $this->report->start_date \|\| strtotime( $customer->user_registered ) > $this->report->end_date ) {
117		unset( $customers[ $key ] );
118		}
119		}
120
121		$total_customers = count( $customers );
122		$report_data = $this->report->get_report_data();
		0 ignored issues – show Bug introduced 2016-04-19 16:00 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `WC_Admin_Report` as the method `get_report_data()` does only exist in the following sub-classes of `WC_Admin_Report`: `WC_Report_Sales_By_Date`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
123		$period_totals = array();
124
125		// Setup period totals by ensuring each period in the interval has data.
126		for ( $i = 0; $i <= $this->report->chart_interval; $i++ ) {
127
128		switch ( $this->report->chart_groupby ) {
129		case 'day' :
130		$time = date( 'Y-m-d', strtotime( "+{$i} DAY", $this->report->start_date ) );
131		break;
132		default :
133		$time = date( 'Y-m', strtotime( "+{$i} MONTH", $this->report->start_date ) );
134		break;
135		}
136
137		// Set the customer signups for each period.
138		$customer_count = 0;
139		foreach ( $customers as $customer ) {
140		if ( date( ( 'day' == $this->report->chart_groupby ) ? 'Y-m-d' : 'Y-m', strtotime( $customer->user_registered ) ) == $time ) {
141		$customer_count++;
142		}
143		}
144
145		$period_totals[ $time ] = array(
146		'sales' => wc_format_decimal( 0.00, 2 ),
147		'orders' => 0,
148		'items' => 0,
149		'tax' => wc_format_decimal( 0.00, 2 ),
150		'shipping' => wc_format_decimal( 0.00, 2 ),
151		'discount' => wc_format_decimal( 0.00, 2 ),
152		'customers' => $customer_count,
153		);
154		}
155
156		// add total sales, total order count, total tax and total shipping for each period
157		foreach ( $report_data->orders as $order ) {
158		$time = ( 'day' === $this->report->chart_groupby ) ? date( 'Y-m-d', strtotime( $order->post_date ) ) : date( 'Y-m', strtotime( $order->post_date ) );
159
160		if ( ! isset( $period_totals[ $time ] ) ) {
161		continue;
162		}
163
164		$period_totals[ $time ]['sales'] = wc_format_decimal( $order->total_sales, 2 );
165		$period_totals[ $time ]['tax'] = wc_format_decimal( $order->total_tax + $order->total_shipping_tax, 2 );
166		$period_totals[ $time ]['shipping'] = wc_format_decimal( $order->total_shipping, 2 );
167		}
168
169		foreach ( $report_data->order_counts as $order ) {
170		$time = ( 'day' === $this->report->chart_groupby ) ? date( 'Y-m-d', strtotime( $order->post_date ) ) : date( 'Y-m', strtotime( $order->post_date ) );
171
172		if ( ! isset( $period_totals[ $time ] ) ) {
173		continue;
174		}
175
176		$period_totals[ $time ]['orders'] = (int) $order->count;
177		}
178
179		// Add total order items for each period.
180		foreach ( $report_data->order_items as $order_item ) {
181		$time = ( 'day' === $this->report->chart_groupby ) ? date( 'Y-m-d', strtotime( $order_item->post_date ) ) : date( 'Y-m', strtotime( $order_item->post_date ) );
182
183		if ( ! isset( $period_totals[ $time ] ) ) {
184		continue;
185		}
186
187		$period_totals[ $time ]['items'] = (int) $order_item->order_item_count;
188		}
189
190		// Add total discount for each period.
191		foreach ( $report_data->coupons as $discount ) {
192		$time = ( 'day' === $this->report->chart_groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) );
193
194		if ( ! isset( $period_totals[ $time ] ) ) {
195		continue;
196		}
197
198		$period_totals[ $time ]['discount'] = wc_format_decimal( $discount->discount_amount, 2 );
199		}
200
201		$sales_data = array(
202		'total_sales' => $report_data->total_sales,
203		'net_sales' => $report_data->net_sales,
204		'average_sales' => $report_data->average_sales,
205		'total_orders' => $report_data->total_orders,
206		'total_items' => $report_data->total_items,
207		'total_tax' => wc_format_decimal( $report_data->total_tax + $report_data->total_shipping_tax, 2 ),
208		'total_shipping' => $report_data->total_shipping,
209		'total_refunds' => $report_data->total_refunds,
210		'total_discount' => $report_data->total_coupons,
211		'totals_grouped_by' => $this->report->chart_groupby,
212		'totals' => $period_totals,
213		'total_customers' => $total_customers,
214		);
215
216		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
217		$data = $this->add_additional_fields_to_object( $sales_data, $request );
218		$data = $this->filter_response_by_context( $data, $context );
219
220		// Wrap the data in a response object.
221		$response = rest_ensure_response( $data );
222		$response->add_links( array(
223		'about' => array(
224		'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
225		),
226		) );
227
228		/**
229		* Filter a report sales returned from the API.
230		*
231		* Allows modification of the report sales data right before it is returned.
232		*
233		* @param WP_REST_Response $response The response object.
234		* @param stdClass $data The original report object.
235		* @param WP_REST_Request $request Request used to generate the response.
236		*/
237		return apply_filters( 'woocommerce_rest_prepare_report_sales', $response, (object) $sales_data, $request );
238		}
239
240		/**
241		* Setup the report object and parse any date filtering.
242		*
243		* @param array $filter date filtering
244		*/
245		protected function setup_report( $filter ) {
246		include_once( WC()->plugin_path() . '/includes/admin/reports/class-wc-admin-report.php' );
247		include_once( WC()->plugin_path() . '/includes/admin/reports/class-wc-report-sales-by-date.php' );
248
249		$this->report = new WC_Report_Sales_By_Date();
250
251		if ( empty( $filter['period'] ) ) {
252
253		// Custom date range.
254		$filter['period'] = 'custom';
255
256	View Code Duplication	if ( ! empty( $filter['date_min'] ) \|\| ! empty( $filter['date_max'] ) ) {
		0 ignored issues – show Duplication introduced 2017-04-11 22:39 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
257
258		// Overwrite _GET to make use of WC_Admin_Report::calculate_current_range() for custom date ranges.
259		$_GET['start_date'] = $filter['date_min'];
260		$_GET['end_date'] = isset( $filter['date_max'] ) ? $filter['date_max'] : null;
261
262		} else {
263
264		// Default custom range to today.
265		$_GET['start_date'] = $_GET['end_date'] = date( 'Y-m-d', current_time( 'timestamp' ) );
266		}
267
268		} else {
269
270		$filter['period'] = empty( $filter['period'] ) ? 'week' : $filter['period'];
271
272		// Change "week" period to "7day".
273		if ( 'week' === $filter['period'] ) {
274		$filter['period'] = '7day';
275		}
276		}
277
278		$this->report->calculate_current_range( $filter['period'] );
279		}
280
281		/**
282		* Get the Report's schema, conforming to JSON Schema.
283		*
284		* @return array
285		*/
286	View Code Duplication	public function get_item_schema() {
		0 ignored issues – show Duplication introduced 2016-04-19 16:00 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
287		$schema = array(
288		'$schema' => 'http://json-schema.org/draft-04/schema#',
289		'title' => 'sales_report',
290		'type' => 'object',
291		'properties' => array(
292		'total_sales' => array(
293		'description' => __( 'Gross sales in the period.', 'woocommerce' ),
294		'type' => 'string',
295		'context' => array( 'view' ),
296		'readonly' => true,
297		),
298		'net_sales' => array(
299		'description' => __( 'Net sales in the period.', 'woocommerce' ),
300		'type' => 'string',
301		'context' => array( 'view' ),
302		'readonly' => true,
303		),
304		'average_sales' => array(
305		'description' => __( 'Average net daily sales.', 'woocommerce' ),
306		'type' => 'string',
307		'context' => array( 'view' ),
308		'readonly' => true,
309		),
310		'total_orders' => array(
311		'description' => __( 'Total of orders placed.', 'woocommerce' ),
312		'type' => 'integer',
313		'context' => array( 'view' ),
314		'readonly' => true,
315		),
316		'total_items' => array(
317		'description' => __( 'Total of items purchased.', 'woocommerce' ),
318		'type' => 'integer',
319		'context' => array( 'view' ),
320		'readonly' => true,
321		),
322		'total_tax' => array(
323		'description' => __( 'Total charged for taxes.', 'woocommerce' ),
324		'type' => 'string',
325		'context' => array( 'view' ),
326		'readonly' => true,
327		),
328		'total_shipping' => array(
329		'description' => __( 'Total charged for shipping.', 'woocommerce' ),
330		'type' => 'string',
331		'context' => array( 'view' ),
332		'readonly' => true,
333		),
334		'total_refunds' => array(
335		'description' => __( 'Total of refunded orders.', 'woocommerce' ),
336		'type' => 'integer',
337		'context' => array( 'view' ),
338		'readonly' => true,
339		),
340		'total_discount' => array(
341		'description' => __( 'Total of coupons used.', 'woocommerce' ),
342		'type' => 'integer',
343		'context' => array( 'view' ),
344		'readonly' => true,
345		),
346		'totals_grouped_by' => array(
347		'description' => __( 'Group type.', 'woocommerce' ),
348		'type' => 'string',
349		'context' => array( 'view' ),
350		'readonly' => true,
351		),
352		'totals' => array(
353		'description' => __( 'Totals.', 'woocommerce' ),
354		'type' => 'array',
355		'context' => array( 'view' ),
356		'readonly' => true,
357		),
358		),
359		);
360
361		return $this->add_additional_fields_schema( $schema );
362		}
363
364		/**
365		* Get the query params for collections.
366		*
367		* @return array
368		*/
369		public function get_collection_params() {
370		return array(
371		'context' => $this->get_context_param( array( 'default' => 'view' ) ),
372		'period' => array(
373		'description' => __( 'Report period.', 'woocommerce' ),
374		'type' => 'string',
375		'enum' => array( 'week', 'month', 'last_month', 'year' ),
376		'validate_callback' => 'rest_validate_request_arg',
377		'sanitize_callback' => 'sanitize_text_field',
378		),
379		'date_min' => array(
380		'description' => sprintf( __( 'Return sales for a specific start date, the date need to be in the %s format.', 'woocommerce' ), 'YYYY-MM-AA' ),
381		'type' => 'string',
382		'format' => 'date',
383		'validate_callback' => 'wc_rest_validate_reports_request_arg',
384		'sanitize_callback' => 'sanitize_text_field',
385		),
386		'date_max' => array(
387		'description' => sprintf( __( 'Return sales for a specific end date, the date need to be in the %s format.', 'woocommerce' ), 'YYYY-MM-AA' ),
388		'type' => 'string',
389		'format' => 'date',
390		'validate_callback' => 'wc_rest_validate_reports_request_arg',
391		'sanitize_callback' => 'sanitize_text_field',
392		),
393		);
394		}
395		}
396

woothemes / woocommerce

WC_REST_Report_Sales_Controller A last analyzed 2017-04-11 22:39 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like

WC_REST_Report_Sales_Controller A
last analyzed 2017-04-11 22:39 UTC