AyeCode / invoicing

includes/api/class-getpaid-rest-report-top-earners-controller.php

Indentation +42 added lines, -42 removed lines

@@ -18,50 +18,50 @@
  */
 class GetPaid_REST_Report_Top_Earners_Controller extends GetPaid_REST_Report_Top_Sellers_Controller {
 
-	/**
-	 * Route base.
-	 *
-	 * @var string
-	 */
-	protected $rest_base = 'reports/top_earners';
+    /**
+     * Route base.
+     *
+     * @var string
+     */
+    protected $rest_base = 'reports/top_earners';
 
-	/**
-	 * Get all data needed for this report and store in the class.
-	 */
-	protected function query_report_data() {
+    /**
+     * Get all data needed for this report and store in the class.
+     */
+    protected function query_report_data() {
 
-		$this->report_data = GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'              => array(
-					'quantity'      => array(
-						'type'            => 'invoice_item',
-						'function'        => 'SUM',
-						'name'            => 'invoice_item_qty',
-					),
-					'item_id'             => array(
-						'type'            => 'invoice_item',
-						'function'        => '',
-						'name'            => 'invoice_item_id',
-					),
-					'item_name'           => array(
-						'type'            => 'invoice_item',
-						'function'        => '',
-						'name'            => 'invoice_item_name',
-					),
-					'price'               => array(
-						'type'            => 'invoice_item',
-						'function'        => 'SUM',
-						'name'            => 'invoice_item_price',
-					),
-				),
-				'group_by'       => 'invoice_item_id',
-				'order_by'       => 'invoice_item_price DESC',
-				'query_type'     => 'get_results',
-				'limit'          => 10,
-				'filter_range'   => $this->report_range,
-			)
-		);
+        $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'              => array(
+                    'quantity'      => array(
+                        'type'            => 'invoice_item',
+                        'function'        => 'SUM',
+                        'name'            => 'invoice_item_qty',
+                    ),
+                    'item_id'             => array(
+                        'type'            => 'invoice_item',
+                        'function'        => '',
+                        'name'            => 'invoice_item_id',
+                    ),
+                    'item_name'           => array(
+                        'type'            => 'invoice_item',
+                        'function'        => '',
+                        'name'            => 'invoice_item_name',
+                    ),
+                    'price'               => array(
+                        'type'            => 'invoice_item',
+                        'function'        => 'SUM',
+                        'name'            => 'invoice_item_price',
+                    ),
+                ),
+                'group_by'       => 'invoice_item_id',
+                'order_by'       => 'invoice_item_price DESC',
+                'query_type'     => 'get_results',
+                'limit'          => 10,
+                'filter_range'   => $this->report_range,
+            )
+        );
 
-	}
+    }
 
 }

includes/api/class-getpaid-rest-report-invoice-counts-controller.php

Indentation +98 added lines, -98 removed lines

@@ -18,102 +18,102 @@
  */
 class GetPaid_REST_Report_Invoice_Counts_Controller extends GetPaid_REST_Reports_Controller {
 
-	/**
-	 * Route base.
-	 *
-	 * @var string
-	 */
-	protected $rest_base = 'reports/invoices/counts';
-
-	/**
-	 * Prepare a report object for serialization.
-	 *
-	 * @param  stdClass        $report Report data.
-	 * @param  WP_REST_Request $request Request object.
-	 * @return WP_REST_Response $response Response data.
-	 */
-	public function prepare_item_for_response( $report, $request ) {
-
-		$data    = (array) $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(
-			array(
-				'about' => array(
-					'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
-				),
-			)
-		);
-
-		return apply_filters( 'getpaid_rest_prepare_report_invoices_count', $response, $report, $request );
-	}
-
-	/**
-	 * Get reports list.
-	 *
-	 * @since 2.0.0
-	 * @return array
-	 */
-	protected function get_reports() {
-
-		$counts = wp_count_posts( 'wpi_invoice' );
-		$data   = array();
-
-		foreach ( wpinv_get_invoice_statuses() as $slug => $name ) {
-
-			if ( ! isset( $counts->$slug ) ) {
-				continue;
-			}
-
-			$data[] = array(
-				'slug'  => $slug,
-				'name'  => $name,
-				'count' => (int) $counts->$slug,
-			);
-
-		}
-
-		return $data;
-
-	}
-
-	/**
-	 * 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_invoice_counts',
-			'type'       => 'object',
-			'properties' => array(
-				'slug'  => array(
-					'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'name'  => array(
-					'description' => __( 'Invoice status name.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'count' => array(
-					'description' => __( 'Number of invoices.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-			),
-		);
-
-		return $this->add_additional_fields_schema( $schema );
-	}
+    /**
+     * Route base.
+     *
+     * @var string
+     */
+    protected $rest_base = 'reports/invoices/counts';
+
+    /**
+     * Prepare a report object for serialization.
+     *
+     * @param  stdClass        $report Report data.
+     * @param  WP_REST_Request $request Request object.
+     * @return WP_REST_Response $response Response data.
+     */
+    public function prepare_item_for_response( $report, $request ) {
+
+        $data    = (array) $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(
+            array(
+                'about' => array(
+                    'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
+                ),
+            )
+        );
+
+        return apply_filters( 'getpaid_rest_prepare_report_invoices_count', $response, $report, $request );
+    }
+
+    /**
+     * Get reports list.
+     *
+     * @since 2.0.0
+     * @return array
+     */
+    protected function get_reports() {
+
+        $counts = wp_count_posts( 'wpi_invoice' );
+        $data   = array();
+
+        foreach ( wpinv_get_invoice_statuses() as $slug => $name ) {
+
+            if ( ! isset( $counts->$slug ) ) {
+                continue;
+            }
+
+            $data[] = array(
+                'slug'  => $slug,
+                'name'  => $name,
+                'count' => (int) $counts->$slug,
+            );
+
+        }
+
+        return $data;
+
+    }
+
+    /**
+     * 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_invoice_counts',
+            'type'       => 'object',
+            'properties' => array(
+                'slug'  => array(
+                    'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'name'  => array(
+                    'description' => __( 'Invoice status name.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'count' => array(
+                    'description' => __( 'Number of invoices.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+            ),
+        );
+
+        return $this->add_additional_fields_schema( $schema );
+    }
 }

includes/api/class-getpaid-rest-reports-controller.php

Indentation +172 added lines, -172 removed lines

@@ -18,176 +18,176 @@
  */
 class GetPaid_REST_Reports_Controller extends GetPaid_REST_Controller {
 
-	/**
-	 * Route base.
-	 *
-	 * @var string
-	 */
-	protected $rest_base = 'reports';
-
-	/**
-	 * Registers the routes for the objects of the controller.
-	 *
-	 * @since 2.0.0
-	 *
-	 * @see register_rest_route()
-	 */
-	public function register_namespace_routes( $namespace ) {
-
-		// List all available reports.
-		register_rest_route(
-			$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' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Makes sure the current user has access to READ the report APIs.
-	 *
-	 * @since  2.0.0
-	 * @param WP_REST_Request $request Full data about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function get_items_permissions_check( $request ) {
-
-		if ( ! wpinv_current_user_can_manage_invoicing() ) {
-			return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-		}
-
-		return true;
-	}
-
-	/**
-	 * Get reports list.
-	 *
-	 * @since 2.0.0
-	 * @return array
-	 */
-	protected function get_reports() {
-
-		$reports = array(
-			array(
-				'slug'        => 'sales',
-				'description' => __( 'List of sales reports.', 'invoicing' ),
-			),
-			array(
-				'slug'        => 'top_sellers',
-				'description' => __( 'List of top selling items.', 'invoicing' ),
-			),
-			array(
-				'slug'        => 'top_earners',
-				'description' => __( 'List of top earning items.', 'invoicing' ),
-			),
-			array(
-				'slug'        => 'invoices/counts',
-				'description' => __( 'Invoice counts.', 'invoicing' ),
-			),
-		);
-
-		return apply_filters( 'getpaid_available_api_reports', $reports );
-
-	}
-
-	/**
-	 * Get all reports.
-	 *
-	 * @since 2.0.0
-	 * @param WP_REST_Request $request
-	 * @return array|WP_Error
-	 */
-	public function get_items( $request ) {
-		$data    = array();
-		$reports = $this->get_reports();
-
-		foreach ( $reports as $report ) {
-			$item   = $this->prepare_item_for_response( (object) $report, $request );
-			$data[] = $this->prepare_response_for_collection( $item );
-		}
-
-		return rest_ensure_response( $data );
-	}
-
-	/**
-	 * Prepare a report object for serialization.
-	 *
-	 * @since 2.0.0
-	 * @param stdClass $report Report data.
-	 * @param WP_REST_Request $request Request object.
-	 * @return WP_REST_Response $response Response data.
-	 */
-	public function prepare_item_for_response( $report, $request ) {
-		$data = array(
-			'slug'        => $report->slug,
-			'description' => $report->description,
-		);
-
-		$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( array(
-			'self' => array(
-				'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ),
-			),
-			'collection' => array(
-				'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),
-			),
-		) );
-
-		return apply_filters( 'getpaid_rest_prepare_report', $response, $report, $request );
-	}
-
-	/**
-	 * Get the Report's schema, conforming to JSON Schema.
-	 *
-	 * @since 2.0.0
-	 * @return array
-	 */
-	public function get_item_schema() {
-		$schema = array(
-			'$schema'    => 'http://json-schema.org/draft-04/schema#',
-			'title'      => 'report',
-			'type'       => 'object',
-			'properties' => array(
-				'slug' => array(
-					'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'description' => array(
-					'description' => __( 'A human-readable description of the resource.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-			),
-		);
-
-		return $this->add_additional_fields_schema( $schema );
-	}
-
-	/**
-	 * Get the query params for collections.
-	 *
-	 * @since 2.0.0
-	 * @return array
-	 */
-	public function get_collection_params() {
-		return array(
-			'context' => $this->get_context_param( array( 'default' => 'view' ) ),
-		);
-	}
+    /**
+     * Route base.
+     *
+     * @var string
+     */
+    protected $rest_base = 'reports';
+
+    /**
+     * Registers the routes for the objects of the controller.
+     *
+     * @since 2.0.0
+     *
+     * @see register_rest_route()
+     */
+    public function register_namespace_routes( $namespace ) {
+
+        // List all available reports.
+        register_rest_route(
+            $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' ),
+            )
+        );
+
+    }
+
+    /**
+     * Makes sure the current user has access to READ the report APIs.
+     *
+     * @since  2.0.0
+     * @param WP_REST_Request $request Full data about the request.
+     * @return WP_Error|boolean
+     */
+    public function get_items_permissions_check( $request ) {
+
+        if ( ! wpinv_current_user_can_manage_invoicing() ) {
+            return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Get reports list.
+     *
+     * @since 2.0.0
+     * @return array
+     */
+    protected function get_reports() {
+
+        $reports = array(
+            array(
+                'slug'        => 'sales',
+                'description' => __( 'List of sales reports.', 'invoicing' ),
+            ),
+            array(
+                'slug'        => 'top_sellers',
+                'description' => __( 'List of top selling items.', 'invoicing' ),
+            ),
+            array(
+                'slug'        => 'top_earners',
+                'description' => __( 'List of top earning items.', 'invoicing' ),
+            ),
+            array(
+                'slug'        => 'invoices/counts',
+                'description' => __( 'Invoice counts.', 'invoicing' ),
+            ),
+        );
+
+        return apply_filters( 'getpaid_available_api_reports', $reports );
+
+    }
+
+    /**
+     * Get all reports.
+     *
+     * @since 2.0.0
+     * @param WP_REST_Request $request
+     * @return array|WP_Error
+     */
+    public function get_items( $request ) {
+        $data    = array();
+        $reports = $this->get_reports();
+
+        foreach ( $reports as $report ) {
+            $item   = $this->prepare_item_for_response( (object) $report, $request );
+            $data[] = $this->prepare_response_for_collection( $item );
+        }
+
+        return rest_ensure_response( $data );
+    }
+
+    /**
+     * Prepare a report object for serialization.
+     *
+     * @since 2.0.0
+     * @param stdClass $report Report data.
+     * @param WP_REST_Request $request Request object.
+     * @return WP_REST_Response $response Response data.
+     */
+    public function prepare_item_for_response( $report, $request ) {
+        $data = array(
+            'slug'        => $report->slug,
+            'description' => $report->description,
+        );
+
+        $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( array(
+            'self' => array(
+                'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ),
+            ),
+            'collection' => array(
+                'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),
+            ),
+        ) );
+
+        return apply_filters( 'getpaid_rest_prepare_report', $response, $report, $request );
+    }
+
+    /**
+     * Get the Report's schema, conforming to JSON Schema.
+     *
+     * @since 2.0.0
+     * @return array
+     */
+    public function get_item_schema() {
+        $schema = array(
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
+            'title'      => 'report',
+            'type'       => 'object',
+            'properties' => array(
+                'slug' => array(
+                    'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'description' => array(
+                    'description' => __( 'A human-readable description of the resource.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+            ),
+        );
+
+        return $this->add_additional_fields_schema( $schema );
+    }
+
+    /**
+     * Get the query params for collections.
+     *
+     * @since 2.0.0
+     * @return array
+     */
+    public function get_collection_params() {
+        return array(
+            'context' => $this->get_context_param( array( 'default' => 'view' ) ),
+        );
+    }
 }

includes/reports/class-getpaid-reports-report-earnings.php

Indentation +133 added lines, -133 removed lines

@@ -12,43 +12,43 @@ 
  */
 class GetPaid_Reports_Report_Earnings extends GetPaid_Reports_Abstract_Report {
 
-	/**
-	 * Retrieves the earning graphs.
-	 *
-	 */
-	public function get_graphs() {
+    /**
+     * Retrieves the earning graphs.
+     *
+     */
+    public function get_graphs() {
 
-		$graphs = array(
+        $graphs = array(
 
             'total'      => __( 'Earnings', 'invoicing' ),
             'discount'   => __( 'Discount', 'invoicing' ),
-			'fees_total' => __( 'Fees', 'invoicing' ),
-			'tax'        => __( 'Tax', 'invoicing' ),
+            'fees_total' => __( 'Fees', 'invoicing' ),
+            'tax'        => __( 'Tax', 'invoicing' ),
 
-		);
+        );
 
-		return apply_filters( 'getpaid_earning_graphs', $graphs );
+        return apply_filters( 'getpaid_earning_graphs', $graphs );
 
-	}
+    }
 
-	/**
-	 * Retrieves the earning sql.
-	 *
-	 */
-	public function get_sql( $range ) {
-		global $wpdb;
+    /**
+     * Retrieves the earning sql.
+     *
+     */
+    public function get_sql( $range ) {
+        global $wpdb;
 
-		$table      = $wpdb->prefix . 'getpaid_invoices';
-		$clauses    = $this->get_range_sql( $range );
-		$graphs     = array_keys( $this->get_graphs() );
-		$graphs_sql = array();
+        $table      = $wpdb->prefix . 'getpaid_invoices';
+        $clauses    = $this->get_range_sql( $range );
+        $graphs     = array_keys( $this->get_graphs() );
+        $graphs_sql = array();
 
-		foreach ( $graphs as $graph ) {
-			$graphs_sql[] = "SUM( meta.$graph ) AS $graph";
-		}
+        foreach ( $graphs as $graph ) {
+            $graphs_sql[] = "SUM( meta.$graph ) AS $graph";
+        }
 
-		$graphs_sql = implode( ', ', $graphs_sql );
-		$sql        = "SELECT {$clauses[0]} AS completed_date, $graphs_sql
+        $graphs_sql = implode( ', ', $graphs_sql );
+        $sql        = "SELECT {$clauses[0]} AS completed_date, $graphs_sql
             FROM $wpdb->posts
             LEFT JOIN $table as meta ON meta.post_id = $wpdb->posts.ID
             WHERE meta.post_id IS NOT NULL
@@ -58,94 +58,94 @@ 
             GROUP BY {$clauses[0]}
         ";
 
-		return apply_filters( 'getpaid_earning_graphs_get_sql', $sql, $range );
-
-	}
-
-	/**
-	 * Prepares the report stats.
-	 *
-	 */
-	public function prepare_stats() {
-		global $wpdb;
-		$this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) );
-	}
-
-	/**
-	 * Retrieves report labels.
-	 *
-	 */
-	public function get_labels( $range ) {
-
-		$labels = array(
-			'today'     => $this->get_hours_in_a_day(),
-			'yesterday' => $this->get_hours_in_a_day(),
-			'7_days'    => $this->get_days_in_period( 7 ),
-			'30_days'   => $this->get_days_in_period( 30 ),
-			'60_days'   => $this->get_days_in_period( 60 ),
-			'90_days'   => $this->get_weeks_in_period( 90 ),
-			'180_days'  => $this->get_weeks_in_period( 180 ),
-			'360_days'  => $this->get_weeks_in_period( 360 ),
-		);
-
-		$label = isset( $labels[ $range ] ) ? $labels[ $range ] : $labels[ '7_days' ];
-		return apply_filters( 'getpaid_earning_graphs_get_labels', $label, $range );
-	}
-
-	/**
-	 * Retrieves report datasets.
-	 *
-	 */
-	public function get_datasets( $labels ) {
-
-		$datasets = array();
-
-		foreach ( $this->get_graphs() as $key => $label ) {
-			$datasets[ $key ] = array(
-				'label' => $label,
-				'data'  => $this->get_data( $key, $labels )
-			);
-		}
-
-		return apply_filters( 'getpaid_earning_graphs_get_datasets', $datasets, $labels );
-	}
-
-	/**
-	 * Retrieves report data.
-	 *
-	 */
-	public function get_data( $key, $labels ) {
-
-		$data     = wp_list_pluck( $this->stats, $key, 'completed_date' );
-		$prepared = array();
-
-		foreach ( $labels as $label ) {
-
-			$value = 0;
-			if ( isset( $data[ $label ] ) ) {
-				$value = wpinv_round_amount( wpinv_sanitize_amount( $data[ $label ] ) );
-			}
-
-			$prepared[] = $value;
-		}
-
-		return apply_filters( 'getpaid_earning_graphs_get_data', $prepared, $key, $labels );
-
-	}
-
-	/**
-	 * Displays the report card.
-	 *
-	 */
-	public function display() {
-
-		$labels     = $this->get_labels( $this->get_range() );
-		$chart_data = array(
-			'labels'   => array_values( $labels ),
-			'datasets' => $this->get_datasets( array_keys( $labels ) ),
-		);
-
-		?>
+        return apply_filters( 'getpaid_earning_graphs_get_sql', $sql, $range );
+
+    }
+
+    /**
+     * Prepares the report stats.
+     *
+     */
+    public function prepare_stats() {
+        global $wpdb;
+        $this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) );
+    }
+
+    /**
+     * Retrieves report labels.
+     *
+     */
+    public function get_labels( $range ) {
+
+        $labels = array(
+            'today'     => $this->get_hours_in_a_day(),
+            'yesterday' => $this->get_hours_in_a_day(),
+            '7_days'    => $this->get_days_in_period( 7 ),
+            '30_days'   => $this->get_days_in_period( 30 ),
+            '60_days'   => $this->get_days_in_period( 60 ),
+            '90_days'   => $this->get_weeks_in_period( 90 ),
+            '180_days'  => $this->get_weeks_in_period( 180 ),
+            '360_days'  => $this->get_weeks_in_period( 360 ),
+        );
+
+        $label = isset( $labels[ $range ] ) ? $labels[ $range ] : $labels[ '7_days' ];
+        return apply_filters( 'getpaid_earning_graphs_get_labels', $label, $range );
+    }
+
+    /**
+     * Retrieves report datasets.
+     *
+     */
+    public function get_datasets( $labels ) {
+
+        $datasets = array();
+
+        foreach ( $this->get_graphs() as $key => $label ) {
+            $datasets[ $key ] = array(
+                'label' => $label,
+                'data'  => $this->get_data( $key, $labels )
+            );
+        }
+
+        return apply_filters( 'getpaid_earning_graphs_get_datasets', $datasets, $labels );
+    }
+
+    /**
+     * Retrieves report data.
+     *
+     */
+    public function get_data( $key, $labels ) {
+
+        $data     = wp_list_pluck( $this->stats, $key, 'completed_date' );
+        $prepared = array();
+
+        foreach ( $labels as $label ) {
+
+            $value = 0;
+            if ( isset( $data[ $label ] ) ) {
+                $value = wpinv_round_amount( wpinv_sanitize_amount( $data[ $label ] ) );
+            }
+
+            $prepared[] = $value;
+        }
+
+        return apply_filters( 'getpaid_earning_graphs_get_data', $prepared, $key, $labels );
+
+    }
+
+    /**
+     * Displays the report card.
+     *
+     */
+    public function display() {
+
+        $labels     = $this->get_labels( $this->get_range() );
+        $chart_data = array(
+            'labels'   => array_values( $labels ),
+            'datasets' => $this->get_datasets( array_keys( $labels ) ),
+        );
+
+        ?>
 
 			<?php foreach ( $chart_data['datasets'] as $key => $dataset ) : ?>
 				<div class="row mb-4">
@@ -165,15 +165,15 @@ 
 
 		<?php
 
-	}
+    }
 
-	/**
-	 * Displays the actual report.
-	 *
-	 */
-	public function display_graph( $key, $dataset, $labels ) {
+    /**
+     * Displays the actual report.
+     *
+     */
+    public function display_graph( $key, $dataset, $labels ) {
 
-		?>
+        ?>
 
 		<canvas id="getpaid-chartjs-earnings-<?php echo sanitize_key( $key ); ?>"></canvas>
 
@@ -223,20 +223,20 @@ 
 		</script>
 
 		<?php
-	}
+    }
 
-	/**
-	 * Displays the actual report.
-	 *
-	 */
-	public function display_stats() {}
+    /**
+     * Displays the actual report.
+     *
+     */
+    public function display_stats() {}
 
-	/**
-	 * Displays the range selector.
-	 *
-	 */
-	public function display_range_selector() {
+    /**
+     * Displays the range selector.
+     *
+     */
+    public function display_range_selector() {
 
-	}
+    }
 
 }

includes/api/class-getpaid-rest-report-sales-controller.php

Indentation +659 added lines, -659 removed lines

@@ -18,664 +18,664 @@
  */
 class GetPaid_REST_Report_Sales_Controller extends GetPaid_REST_Date_Based_Controller {
 
-	/**
-	 * Route base.
-	 *
-	 * @var string
-	 */
-	protected $rest_base = 'reports/sales';
-
-	/**
-	 * The report data.
-	 *
-	 * @var stdClass
-	 */
-	protected $report_data;
-
-	/**
-	 * The report range.
-	 *
-	 * @var array
-	 */
-	protected $report_range;
-
-	/**
-	 * Registers the routes for the objects of the controller.
-	 *
-	 * @since 2.0.0
-	 *
-	 * @see register_rest_route()
-	 */
-	public function register_namespace_routes( $namespace ) {
-
-		// Get sales report.
-		register_rest_route(
-			$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' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Makes sure the current user has access to READ the report APIs.
-	 *
-	 * @since  2.0.0
-	 * @param WP_REST_Request $request Full data about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function get_items_permissions_check( $request ) {
-
-		if ( ! wpinv_current_user_can_manage_invoicing() ) {
-			return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), 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 report range.
-		$this->report_range = $this->get_date_range( $request );
-
-		$report_data     = $this->get_report_data();
-		$period_totals   = array();
-
-		// Setup period totals by ensuring each period in the interval has data.
-		$start_date      = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS;
-
-		if ( 'month' === $this->groupby ) {
-			$start_date      = strtotime( date( 'Y-m-01', $start_date ) );
-		}
-
-		for ( $i = 0; $i < $this->interval; $i++ ) {
-
-			switch ( $this->groupby ) {
-				case 'day' :
-					$time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) );
-					break;
-				default :
-					$time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) );
-					break;
-			}
-
-			// Set the defaults for each period.
-			$period_totals[ $time ] = array(
-				'sales'             => wpinv_round_amount( 0.00 ),
-				'invoices'          => 0,
-				'refunds'           => wpinv_round_amount( 0.00 ),
-				'items'             => 0,
-				'refunded_items'    => 0,
-				'tax'               => wpinv_round_amount( 0.00 ),
-				'refunded_tax'      => wpinv_round_amount( 0.00 ),
-				'subtotal'          => wpinv_round_amount( 0.00 ),
-				'refunded_subtotal' => wpinv_round_amount( 0.00 ),
-				'fees'              => wpinv_round_amount( 0.00 ),
-				'refunded_fees'     => wpinv_round_amount( 0.00 ),
-				'discount'          => wpinv_round_amount( 0.00 ),
-			);
-
-		}
-
-		// add total sales, total invoice count, total tax for each period
-		$date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m';
-		foreach ( $report_data->invoices as $invoice ) {
-			$time = date( $date_format, strtotime( $invoice->post_date ) );
-
-			if ( ! isset( $period_totals[ $time ] ) ) {
-				continue;
-			}
-
-			$period_totals[ $time ]['sales']    = wpinv_round_amount( $invoice->total_sales );
-			$period_totals[ $time ]['tax']      = wpinv_round_amount( $invoice->total_tax );
-			$period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal );
-			$period_totals[ $time ]['fees']     = wpinv_round_amount( $invoice->total_fees );
-
-		}
-
-		foreach ( $report_data->refunds as $invoice ) {
-			$time = date( $date_format, strtotime( $invoice->post_date ) );
-
-			if ( ! isset( $period_totals[ $time ] ) ) {
-				continue;
-			}
-
-			$period_totals[ $time ]['refunds']           = wpinv_round_amount( $invoice->total_sales );
-			$period_totals[ $time ]['refunded_tax']      = wpinv_round_amount( $invoice->total_tax );
-			$period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal );
-			$period_totals[ $time ]['refunded_fees']     = wpinv_round_amount( $invoice->total_fees );
-
-		}
-
-		foreach ( $report_data->invoice_counts as $invoice ) {
-			$time = date( $date_format, strtotime( $invoice->post_date ) );
-
-			if ( isset( $period_totals[ $time ] ) ) {
-				$period_totals[ $time ]['invoices']   = (int) $invoice->count;
-			}
-
-		}
-
-		// Add total invoice items for each period.
-		foreach ( $report_data->invoice_items as $invoice_item ) {
-			$time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) );
-
-			if ( isset( $period_totals[ $time ] ) ) {
-				$period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count;
-			}
-
-		}
-
-		// Add total discount for each period.
-		foreach ( $report_data->coupons as $discount ) {
-			$time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) );
-
-			if ( isset( $period_totals[ $time ] ) ) {
-				$period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount );
-			}
-
-		}
-
-		$report_data->totals            = $period_totals;
-		$report_data->grouped_by        = $this->groupby;
-		$report_data->interval          = max( $this->interval, 1 );
-		$report_data->currency          = wpinv_get_currency();
-		$report_data->currency_symbol   = wpinv_currency_symbol();
-		$report_data->currency_position = wpinv_currency_position();
-		$report_data->decimal_places    = wpinv_decimals();
-		$report_data->thousands_sep     = wpinv_thousands_separator();
-		$report_data->decimals_sep      = wpinv_decimal_separator();
-		$report_data->start_date        = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS );
-		$report_data->end_date          = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS );
-		$report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) );
-		$report_data->end_date_locale   = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) );
-		$report_data->decimals_sep      = wpinv_decimal_separator();
-
-		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
-		$data    = $report_data;
-		unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items );
-		$data    = $this->add_additional_fields_to_object( (array) $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 ) ),
-			),
-		) );
-
-		return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request );
-	}
-
-	/**
-	 * Get report data.
-	 *
-	 * @return stdClass
-	 */
-	public function get_report_data() {
-		if ( empty( $this->report_data ) ) {
-			$this->query_report_data();
-		}
-		return $this->report_data;
-	}
-
-	/**
-	 * Get all data needed for this report and store in the class.
-	 */
-	protected function query_report_data() {
-
-		// Prepare reports.
-		$this->report_data = (object) array(
-			'invoice_counts' => $this->query_invoice_counts(),//count, post_date
-			'coupons'        => $this->query_coupon_counts(), // discount_amount, post_date
-			'invoice_items'  => $this->query_item_counts(), // invoice_item_count, post_date
-			'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date
-			'invoices'       => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date
-			'refunds'        => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date
-			'previous_range' => $this->previous_range,
-		);
-
-		// Calculated totals.
-		$this->report_data->total_tax          = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) );
-		$this->report_data->total_sales        = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) );
-		$this->report_data->total_discount     = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) );
-		$this->report_data->total_fees         = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) );
-		$this->report_data->subtotal           = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) );
-		$this->report_data->net_sales          = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) );
-		$this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) );
-		$this->report_data->total_refunds      = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) );
-		$this->report_data->refunded_discount  = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) );
-		$this->report_data->refunded_fees      = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) );
-		$this->report_data->refunded_subtotal  = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) );
-		$this->report_data->net_refunds        = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) );
-
-
-		// Calculate average based on net.
-		$this->report_data->average_sales       = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 );
-		$this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 );
-
-		// Total invoices in this period, even if refunded.
-		$this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) );
-
-		// Items invoiced in this period, even if refunded.
-		$this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) );
-
-		// 3rd party filtering of report data
-		$this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data );
-	}
-
-	/**
-	 * Prepares invoice counts.
-	 *
-	 * @return array.
-	 */
-	protected function query_invoice_counts() {
-
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'         => array(
-					'ID'        => array(
-						'type'     => 'post_data',
-						'function' => 'COUNT',
-						'name'     => 'count',
-						'distinct' => true,
-					),
-					'post_date' => array(
-						'type'     => 'post_data',
-						'function' => '',
-						'name'     => 'post_date',
-					),
-				),
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
-				'order_by'       => 'post_date ASC',
-				'query_type'     => 'get_results',
-				'filter_range'   => $this->report_range,
-				'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Prepares coupon counts.
-	 *
-	 * @return array.
-	 */
-	protected function query_coupon_counts() {
-
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'         => array(
-					'discount' => array(
-						'type'     => 'invoice_data',
-						'function' => 'SUM',
-						'name'     => 'discount_amount',
-					),
-					'post_date'       => array(
-						'type'     => 'post_data',
-						'function' => '',
-						'name'     => 'post_date',
-					),
-				),
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
-				'order_by'       => 'post_date ASC',
-				'query_type'     => 'get_results',
-				'filter_range'   => $this->report_range,
-				'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Prepares item counts.
-	 *
-	 * @return array.
-	 */
-	protected function query_item_counts() {
-
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'         => array(
-					'quantity'      => array(
-						'type'            => 'invoice_item',
-						'function'        => 'SUM',
-						'name'            => 'invoice_item_count',
-					),
-					'post_date' => array(
-						'type'     => 'post_data',
-						'function' => '',
-						'name'     => 'post_date',
-					),
-				),
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
-				'order_by'       => 'post_date ASC',
-				'query_type'     => 'get_results',
-				'filter_range'   => $this->report_range,
-				'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Prepares refunded item counts.
-	 *
-	 * @return array.
-	 */
-	protected function count_refunded_items() {
-
-		return (int) GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'         => array(
-					'quantity'      => array(
-						'type'            => 'invoice_item',
-						'function'        => 'SUM',
-						'name'            => 'invoice_item_count',
-					),
-				),
-				'query_type'     => 'get_var',
-				'filter_range'   => $this->report_range,
-				'invoice_status' => array( 'wpi-refunded' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Prepares daily invoice totals.
-	 *
-	 * @return array.
-	 */
-	protected function query_invoice_totals() {
-
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'         => array(
-					'total'      => array(
-						'type'            => 'invoice_data',
-						'function'        => 'SUM',
-						'name'            => 'total_sales',
-					),
-					'tax'      => array(
-						'type'            => 'invoice_data',
-						'function'        => 'SUM',
-						'name'            => 'total_tax',
-					),
-					'discount'      => array(
-						'type'            => 'invoice_data',
-						'function'        => 'SUM',
-						'name'            => 'total_discount',
-					),
-					'fees_total'      => array(
-						'type'            => 'invoice_data',
-						'function'        => 'SUM',
-						'name'            => 'total_fees',
-					),
-					'subtotal'      => array(
-						'type'            => 'invoice_data',
-						'function'        => 'SUM',
-						'name'            => 'subtotal',
-					),
-					'post_date' => array(
-						'type'     => 'post_data',
-						'function' => '',
-						'name'     => 'post_date',
-					),
-				),
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
-				'order_by'       => 'post_date ASC',
-				'query_type'     => 'get_results',
-				'filter_range'   => $this->report_range,
-				'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Prepares daily invoice totals.
-	 *
-	 * @return array.
-	 */
-	protected function query_refunded_totals() {
-
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'         => array(
-					'total'      => array(
-						'type'            => 'invoice_data',
-						'function'        => 'SUM',
-						'name'            => 'total_sales',
-					),
-					'tax'      => array(
-						'type'            => 'invoice_data',
-						'function'        => 'SUM',
-						'name'            => 'total_tax',
-					),
-					'discount'      => array(
-						'type'            => 'invoice_data',
-						'function'        => 'SUM',
-						'name'            => 'total_discount',
-					),
-					'fees_total'      => array(
-						'type'            => 'invoice_data',
-						'function'        => 'SUM',
-						'name'            => 'total_fees',
-					),
-					'subtotal'      => array(
-						'type'            => 'invoice_data',
-						'function'        => 'SUM',
-						'name'            => 'subtotal',
-					),
-					'post_date' => array(
-						'type'     => 'post_data',
-						'function' => '',
-						'name'     => 'post_date',
-					),
-				),
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
-				'order_by'       => 'post_date ASC',
-				'query_type'     => 'get_results',
-				'filter_range'   => $this->report_range,
-				'invoice_status' => array( 'wpi-refunded' ),
-			)
-		);
-
-	}
-
-	/**
-	 * 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.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'net_sales' => array(
-					'description' => __( 'Net sales in the period.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'average_sales' => array(
-					'description' => __( 'Average net daily sales.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'average_total_sales' => array(
-					'description' => __( 'Average gross daily sales.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'total_invoices'  => array(
-					'description' => __( 'Number of paid invoices.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'total_items' => array(
-					'description' => __( 'Number of items purchased.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'refunded_items' => array(
-					'description' => __( 'Number of items refunded.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'total_tax' => array(
-					'description' => __( 'Total charged for taxes.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'total_refunded_tax' => array(
-					'description' => __( 'Total refunded for taxes.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'total_fees' => array(
-					'description' => __( 'Total fees charged.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'total_refunds' => array(
-					'description' => __( 'Total of refunded invoices.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'net_refunds' => array(
-					'description' => __( 'Net of refunded invoices.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'total_discount' => array(
-					'description' => __( 'Total of discounts used.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'totals' => array(
-					'description' => __( 'Totals.', 'invoicing' ),
-					'type'        => 'array',
-					'items'       => array(
-						'type'    => 'array',
-					),
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'interval' => array(
-					'description' => __( 'Number of months/days in the report period.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'previous_range'  => array(
-					'description' => __( 'The previous report period.', 'invoicing' ),
-					'type'        => 'array',
-					'items'       => array(
-						'type'    => 'string',
-					),
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'grouped_by' => array(
-					'description' => __( 'The period used to group the totals.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'enum'        => array( 'day', 'month' ),
-					'readonly'    => true,
-				),
-				'currency' => array(
-					'description' => __( 'The default store currency.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'currency_symbol' => array(
-					'description' => __( 'The default store currency symbol.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'currency_position' => array(
-					'description' => __( 'The default store currency position.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'decimal_places' => array(
-					'description' => __( 'The default store decimal places.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'thousands_sep' => array(
-					'description' => __( 'The default store thousands separator.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'decimals_sep' => array(
-					'description' => __( 'The default store decimals separator.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-			),
-		);
-
-		return $this->add_additional_fields_schema( $schema );
-
-	}
+    /**
+     * Route base.
+     *
+     * @var string
+     */
+    protected $rest_base = 'reports/sales';
+
+    /**
+     * The report data.
+     *
+     * @var stdClass
+     */
+    protected $report_data;
+
+    /**
+     * The report range.
+     *
+     * @var array
+     */
+    protected $report_range;
+
+    /**
+     * Registers the routes for the objects of the controller.
+     *
+     * @since 2.0.0
+     *
+     * @see register_rest_route()
+     */
+    public function register_namespace_routes( $namespace ) {
+
+        // Get sales report.
+        register_rest_route(
+            $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' ),
+            )
+        );
+
+    }
+
+    /**
+     * Makes sure the current user has access to READ the report APIs.
+     *
+     * @since  2.0.0
+     * @param WP_REST_Request $request Full data about the request.
+     * @return WP_Error|boolean
+     */
+    public function get_items_permissions_check( $request ) {
+
+        if ( ! wpinv_current_user_can_manage_invoicing() ) {
+            return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), 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 report range.
+        $this->report_range = $this->get_date_range( $request );
+
+        $report_data     = $this->get_report_data();
+        $period_totals   = array();
+
+        // Setup period totals by ensuring each period in the interval has data.
+        $start_date      = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS;
+
+        if ( 'month' === $this->groupby ) {
+            $start_date      = strtotime( date( 'Y-m-01', $start_date ) );
+        }
+
+        for ( $i = 0; $i < $this->interval; $i++ ) {
+
+            switch ( $this->groupby ) {
+                case 'day' :
+                    $time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) );
+                    break;
+                default :
+                    $time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) );
+                    break;
+            }
+
+            // Set the defaults for each period.
+            $period_totals[ $time ] = array(
+                'sales'             => wpinv_round_amount( 0.00 ),
+                'invoices'          => 0,
+                'refunds'           => wpinv_round_amount( 0.00 ),
+                'items'             => 0,
+                'refunded_items'    => 0,
+                'tax'               => wpinv_round_amount( 0.00 ),
+                'refunded_tax'      => wpinv_round_amount( 0.00 ),
+                'subtotal'          => wpinv_round_amount( 0.00 ),
+                'refunded_subtotal' => wpinv_round_amount( 0.00 ),
+                'fees'              => wpinv_round_amount( 0.00 ),
+                'refunded_fees'     => wpinv_round_amount( 0.00 ),
+                'discount'          => wpinv_round_amount( 0.00 ),
+            );
+
+        }
+
+        // add total sales, total invoice count, total tax for each period
+        $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m';
+        foreach ( $report_data->invoices as $invoice ) {
+            $time = date( $date_format, strtotime( $invoice->post_date ) );
+
+            if ( ! isset( $period_totals[ $time ] ) ) {
+                continue;
+            }
+
+            $period_totals[ $time ]['sales']    = wpinv_round_amount( $invoice->total_sales );
+            $period_totals[ $time ]['tax']      = wpinv_round_amount( $invoice->total_tax );
+            $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal );
+            $period_totals[ $time ]['fees']     = wpinv_round_amount( $invoice->total_fees );
+
+        }
+
+        foreach ( $report_data->refunds as $invoice ) {
+            $time = date( $date_format, strtotime( $invoice->post_date ) );
+
+            if ( ! isset( $period_totals[ $time ] ) ) {
+                continue;
+            }
+
+            $period_totals[ $time ]['refunds']           = wpinv_round_amount( $invoice->total_sales );
+            $period_totals[ $time ]['refunded_tax']      = wpinv_round_amount( $invoice->total_tax );
+            $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal );
+            $period_totals[ $time ]['refunded_fees']     = wpinv_round_amount( $invoice->total_fees );
+
+        }
+
+        foreach ( $report_data->invoice_counts as $invoice ) {
+            $time = date( $date_format, strtotime( $invoice->post_date ) );
+
+            if ( isset( $period_totals[ $time ] ) ) {
+                $period_totals[ $time ]['invoices']   = (int) $invoice->count;
+            }
+
+        }
+
+        // Add total invoice items for each period.
+        foreach ( $report_data->invoice_items as $invoice_item ) {
+            $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) );
+
+            if ( isset( $period_totals[ $time ] ) ) {
+                $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count;
+            }
+
+        }
+
+        // Add total discount for each period.
+        foreach ( $report_data->coupons as $discount ) {
+            $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) );
+
+            if ( isset( $period_totals[ $time ] ) ) {
+                $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount );
+            }
+
+        }
+
+        $report_data->totals            = $period_totals;
+        $report_data->grouped_by        = $this->groupby;
+        $report_data->interval          = max( $this->interval, 1 );
+        $report_data->currency          = wpinv_get_currency();
+        $report_data->currency_symbol   = wpinv_currency_symbol();
+        $report_data->currency_position = wpinv_currency_position();
+        $report_data->decimal_places    = wpinv_decimals();
+        $report_data->thousands_sep     = wpinv_thousands_separator();
+        $report_data->decimals_sep      = wpinv_decimal_separator();
+        $report_data->start_date        = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS );
+        $report_data->end_date          = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS );
+        $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) );
+        $report_data->end_date_locale   = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) );
+        $report_data->decimals_sep      = wpinv_decimal_separator();
+
+        $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
+        $data    = $report_data;
+        unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items );
+        $data    = $this->add_additional_fields_to_object( (array) $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 ) ),
+            ),
+        ) );
+
+        return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request );
+    }
+
+    /**
+     * Get report data.
+     *
+     * @return stdClass
+     */
+    public function get_report_data() {
+        if ( empty( $this->report_data ) ) {
+            $this->query_report_data();
+        }
+        return $this->report_data;
+    }
+
+    /**
+     * Get all data needed for this report and store in the class.
+     */
+    protected function query_report_data() {
+
+        // Prepare reports.
+        $this->report_data = (object) array(
+            'invoice_counts' => $this->query_invoice_counts(),//count, post_date
+            'coupons'        => $this->query_coupon_counts(), // discount_amount, post_date
+            'invoice_items'  => $this->query_item_counts(), // invoice_item_count, post_date
+            'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date
+            'invoices'       => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date
+            'refunds'        => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date
+            'previous_range' => $this->previous_range,
+        );
+
+        // Calculated totals.
+        $this->report_data->total_tax          = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) );
+        $this->report_data->total_sales        = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) );
+        $this->report_data->total_discount     = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) );
+        $this->report_data->total_fees         = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) );
+        $this->report_data->subtotal           = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) );
+        $this->report_data->net_sales          = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) );
+        $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) );
+        $this->report_data->total_refunds      = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) );
+        $this->report_data->refunded_discount  = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) );
+        $this->report_data->refunded_fees      = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) );
+        $this->report_data->refunded_subtotal  = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) );
+        $this->report_data->net_refunds        = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) );
+
+
+        // Calculate average based on net.
+        $this->report_data->average_sales       = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 );
+        $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 );
+
+        // Total invoices in this period, even if refunded.
+        $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) );
+
+        // Items invoiced in this period, even if refunded.
+        $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) );
+
+        // 3rd party filtering of report data
+        $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data );
+    }
+
+    /**
+     * Prepares invoice counts.
+     *
+     * @return array.
+     */
+    protected function query_invoice_counts() {
+
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'         => array(
+                    'ID'        => array(
+                        'type'     => 'post_data',
+                        'function' => 'COUNT',
+                        'name'     => 'count',
+                        'distinct' => true,
+                    ),
+                    'post_date' => array(
+                        'type'     => 'post_data',
+                        'function' => '',
+                        'name'     => 'post_date',
+                    ),
+                ),
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
+                'order_by'       => 'post_date ASC',
+                'query_type'     => 'get_results',
+                'filter_range'   => $this->report_range,
+                'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
+            )
+        );
+
+    }
+
+    /**
+     * Prepares coupon counts.
+     *
+     * @return array.
+     */
+    protected function query_coupon_counts() {
+
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'         => array(
+                    'discount' => array(
+                        'type'     => 'invoice_data',
+                        'function' => 'SUM',
+                        'name'     => 'discount_amount',
+                    ),
+                    'post_date'       => array(
+                        'type'     => 'post_data',
+                        'function' => '',
+                        'name'     => 'post_date',
+                    ),
+                ),
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
+                'order_by'       => 'post_date ASC',
+                'query_type'     => 'get_results',
+                'filter_range'   => $this->report_range,
+                'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
+            )
+        );
+
+    }
+
+    /**
+     * Prepares item counts.
+     *
+     * @return array.
+     */
+    protected function query_item_counts() {
+
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'         => array(
+                    'quantity'      => array(
+                        'type'            => 'invoice_item',
+                        'function'        => 'SUM',
+                        'name'            => 'invoice_item_count',
+                    ),
+                    'post_date' => array(
+                        'type'     => 'post_data',
+                        'function' => '',
+                        'name'     => 'post_date',
+                    ),
+                ),
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
+                'order_by'       => 'post_date ASC',
+                'query_type'     => 'get_results',
+                'filter_range'   => $this->report_range,
+                'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
+            )
+        );
+
+    }
+
+    /**
+     * Prepares refunded item counts.
+     *
+     * @return array.
+     */
+    protected function count_refunded_items() {
+
+        return (int) GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'         => array(
+                    'quantity'      => array(
+                        'type'            => 'invoice_item',
+                        'function'        => 'SUM',
+                        'name'            => 'invoice_item_count',
+                    ),
+                ),
+                'query_type'     => 'get_var',
+                'filter_range'   => $this->report_range,
+                'invoice_status' => array( 'wpi-refunded' ),
+            )
+        );
+
+    }
+
+    /**
+     * Prepares daily invoice totals.
+     *
+     * @return array.
+     */
+    protected function query_invoice_totals() {
+
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'         => array(
+                    'total'      => array(
+                        'type'            => 'invoice_data',
+                        'function'        => 'SUM',
+                        'name'            => 'total_sales',
+                    ),
+                    'tax'      => array(
+                        'type'            => 'invoice_data',
+                        'function'        => 'SUM',
+                        'name'            => 'total_tax',
+                    ),
+                    'discount'      => array(
+                        'type'            => 'invoice_data',
+                        'function'        => 'SUM',
+                        'name'            => 'total_discount',
+                    ),
+                    'fees_total'      => array(
+                        'type'            => 'invoice_data',
+                        'function'        => 'SUM',
+                        'name'            => 'total_fees',
+                    ),
+                    'subtotal'      => array(
+                        'type'            => 'invoice_data',
+                        'function'        => 'SUM',
+                        'name'            => 'subtotal',
+                    ),
+                    'post_date' => array(
+                        'type'     => 'post_data',
+                        'function' => '',
+                        'name'     => 'post_date',
+                    ),
+                ),
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
+                'order_by'       => 'post_date ASC',
+                'query_type'     => 'get_results',
+                'filter_range'   => $this->report_range,
+                'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ),
+            )
+        );
+
+    }
+
+    /**
+     * Prepares daily invoice totals.
+     *
+     * @return array.
+     */
+    protected function query_refunded_totals() {
+
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'         => array(
+                    'total'      => array(
+                        'type'            => 'invoice_data',
+                        'function'        => 'SUM',
+                        'name'            => 'total_sales',
+                    ),
+                    'tax'      => array(
+                        'type'            => 'invoice_data',
+                        'function'        => 'SUM',
+                        'name'            => 'total_tax',
+                    ),
+                    'discount'      => array(
+                        'type'            => 'invoice_data',
+                        'function'        => 'SUM',
+                        'name'            => 'total_discount',
+                    ),
+                    'fees_total'      => array(
+                        'type'            => 'invoice_data',
+                        'function'        => 'SUM',
+                        'name'            => 'total_fees',
+                    ),
+                    'subtotal'      => array(
+                        'type'            => 'invoice_data',
+                        'function'        => 'SUM',
+                        'name'            => 'subtotal',
+                    ),
+                    'post_date' => array(
+                        'type'     => 'post_data',
+                        'function' => '',
+                        'name'     => 'post_date',
+                    ),
+                ),
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
+                'order_by'       => 'post_date ASC',
+                'query_type'     => 'get_results',
+                'filter_range'   => $this->report_range,
+                'invoice_status' => array( 'wpi-refunded' ),
+            )
+        );
+
+    }
+
+    /**
+     * 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.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'net_sales' => array(
+                    'description' => __( 'Net sales in the period.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'average_sales' => array(
+                    'description' => __( 'Average net daily sales.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'average_total_sales' => array(
+                    'description' => __( 'Average gross daily sales.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'total_invoices'  => array(
+                    'description' => __( 'Number of paid invoices.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'total_items' => array(
+                    'description' => __( 'Number of items purchased.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'refunded_items' => array(
+                    'description' => __( 'Number of items refunded.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'total_tax' => array(
+                    'description' => __( 'Total charged for taxes.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'total_refunded_tax' => array(
+                    'description' => __( 'Total refunded for taxes.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'total_fees' => array(
+                    'description' => __( 'Total fees charged.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'total_refunds' => array(
+                    'description' => __( 'Total of refunded invoices.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'net_refunds' => array(
+                    'description' => __( 'Net of refunded invoices.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'total_discount' => array(
+                    'description' => __( 'Total of discounts used.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'totals' => array(
+                    'description' => __( 'Totals.', 'invoicing' ),
+                    'type'        => 'array',
+                    'items'       => array(
+                        'type'    => 'array',
+                    ),
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'interval' => array(
+                    'description' => __( 'Number of months/days in the report period.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'previous_range'  => array(
+                    'description' => __( 'The previous report period.', 'invoicing' ),
+                    'type'        => 'array',
+                    'items'       => array(
+                        'type'    => 'string',
+                    ),
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'grouped_by' => array(
+                    'description' => __( 'The period used to group the totals.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'enum'        => array( 'day', 'month' ),
+                    'readonly'    => true,
+                ),
+                'currency' => array(
+                    'description' => __( 'The default store currency.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'currency_symbol' => array(
+                    'description' => __( 'The default store currency symbol.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'currency_position' => array(
+                    'description' => __( 'The default store currency position.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'decimal_places' => array(
+                    'description' => __( 'The default store decimal places.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'thousands_sep' => array(
+                    'description' => __( 'The default store thousands separator.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'decimals_sep' => array(
+                    'description' => __( 'The default store decimals separator.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+            ),
+        );
+
+        return $this->add_additional_fields_schema( $schema );
+
+    }
 
 }

includes/api/class-getpaid-rest-date-based-controller.php

Indentation +573 added lines, -573 removed lines

@@ -16,577 +16,577 @@
  */
 class GetPaid_REST_Date_Based_Controller extends GetPaid_REST_Controller {
 
-	/**
-	 * Group response items by day or month.
-	 *
-	 * @var string
-	 */
-	public $groupby = 'day';
-
-	/**
-	 * Returns an array with arguments to request the previous report.
-	 *
-	 * @var array
-	 */
-	public $previous_range = array();
-
-	/**
-	 * The period interval.
-	 *
-	 * @var int
-	 */
-	public $interval;
-
-	/**
-	 * Retrieves the before and after dates.
-	 *
-	 * @param WP_REST_Request $request Request object.
-	 * @return array The appropriate date range.
-	 */
-	public function get_date_range( $request ) {
-
-		// If not supported, assume all time.
-		if ( ! in_array( $request['period'], array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year' ) ) ) {
-			$request['period'] = '7_days';
-		}
-
-		$date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request );
-		$this->prepare_interval( $date_range );
-
-		return $date_range;
-
-	}
-
-	/**
-	 * Groups by month or days.
-	 *
-	 * @param array $range Date range.
-	 * @return array The appropriate date range.
-	 */
-	public function prepare_interval( $range ) {
-
-		$before = strtotime( $range['before'] ) - DAY_IN_SECONDS;
-		$after  = strtotime( $range['after'] ) + DAY_IN_SECONDS;
-		if ( 'day' === $this->groupby ) {
-			$difference     = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0;
-			$this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) );
-			return;
-		}
-
-		$this->interval = 0;
-		$min_date       = strtotime( date( 'Y-m-01', $after ) );
-
-		while ( $min_date <= $before ) {
-			$this->interval ++;
-			$min_date = strtotime( '+1 MONTH', $min_date );
-		}
-
-		$this->interval = max( 1, $this->interval );
-
-	}
-
-	/**
-	 * Retrieves a custom date range.
-	 *
-	 * @param WP_REST_Request $request Request object.
-	 * @return array The appropriate date range.
-	 */
-	public function get_custom_date_range( $request ) {
-
-		$after  = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) );
-		$before = strtotime( '+1 day', current_time( 'timestamp' ) );
-
-		if ( ! empty( $request['before'] ) ) {
-			$before  = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) );
-		}
-
-		// 3 months max for day view
-		if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 3 ) {
-			$this->groupby = 'month';
-		}
-
-		// Set the previous date range.
-		$difference           = $before - $after;
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', $before - $difference ),
-			'after'  => date( 'Y-m-d', $after - $difference ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', $before ),
-			'after' => date( 'Y-m-d', $after ),
-		);
-
-	}
-
-	/**
-	 * Retrieves todays date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_today_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'yesterday',
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves yesterdays date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_yesterday_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-3 days', current_time( 'timestamp' ) ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-2 days', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves this week's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_week_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_week',
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' )  ) + 8 * DAY_IN_SECONDS ),
-			'after'  => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' )  ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last week's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_week_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' )  ) ),
-			'after'  => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' )  ) - 8 * DAY_IN_SECONDS ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', strtotime( 'monday this week', current_time( 'timestamp' )  ) ),
-			'after'  => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' )  ) - DAY_IN_SECONDS ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last 7 days date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_7_days_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-15 days', current_time( 'timestamp' ) ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last 30 days date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_30_days_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-31 days', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last 90 days date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_90_days_date_range() {
-
-		$this->groupby = 'month';
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-91 days', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last 180 days date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_180_days_date_range() {
-
-		$this->groupby = 'month';
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-361 days', current_time( 'timestamp' ) ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last 60 days date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_60_days_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-121 days', current_time( 'timestamp' ) ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves this month date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_month_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_month',
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-01', strtotime( 'next month', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last month's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_month_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-1', strtotime( 'last month', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-t', strtotime( "-3 months", current_time( 'timestamp' ) ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-1', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-t', strtotime( "-2 months", current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves this quarter date range.
-	 *
-	 * @return array The available quarters.
-	 */
-	public function get_quarters() {
-
-		$last_year = (int) date('Y') - 1;
-		$next_year = (int) date('Y') + 1;
-		$year      = (int) date('Y');
-		return array(
-
-			array(
-				'after'  => "$last_year-06-30",
-				'before' => "$last_year-10-01",
-			),
-
-			array(
-				'before' => "$year-01-01",
-				'after'  => "$last_year-09-30",
-			),
-
-			array(
-				'before' => "$year-04-01",
-				'after'  => "$last_year-12-31",
-			),
-
-			array(
-				'before' => "$year-07-01",
-				'after'  => "$year-03-31",
-			),
-
-			array(
-				'after'  => "$year-06-30",
-				'before' => "$year-10-01",
-			),
-
-			array(
-				'before' => "$next_year-01-01",
-				'after'  => "$year-09-30",
-			)
-
-		);
-
-	}
-
-	/**
-	 * Retrieves the current quater.
-	 *
-	 * @return int The current quarter.
-	 */
-	public function get_quarter() {
-
-		$month    = (int) date( 'n', current_time( 'timestamp' ) );
-		$quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 );
-		return $quarters[ $month - 1 ];
-
-	}
-
-	/**
-	 * Retrieves this quarter date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_quarter_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_quarter',
-		);
-
-		// Generate the report.
-		$quarters = $this->get_quarters();
-		return $quarters[ $this->get_quarter() + 1 ];
-
-	}
-
-	/**
-	 * Retrieves last quarter's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_quarter_date_range() {
-
-		$quarters = $this->get_quarters();
-		$quarter  = $this->get_quarter();
-
-		// Set the previous date range.
-		$this->previous_range = array_merge(
-			$quarters[ $quarter - 1 ],
-			array( 'period' => 'custom' )
-		);
-
-		// Generate the report.
-		return $quarters[ $quarter ];
-
-	}
-
-	/**
-	 * Retrieves this year date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_year_date_range() {
-
-		$this->groupby = 'month';
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_year',
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', strtotime( 'next year January 1st', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last year date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_year_date_range() {
-
-		$this->groupby = 'month';
-
-		// Set the previous date range.
-		$year          = (int) date('Y') - 3;
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ),
-			'after'  => "$year-12-31",
-		);
-
-		// Generate the report.
-		$year          = (int) date('Y') - 2;
-		return array(
-			'after'  => "$year-12-31",
-			'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Prepare a the request date for SQL usage.
-	 *
-	 * @param WP_REST_Request $request Request object.
-	 * @param string $date_field The date field.
-	 * @return string The appropriate SQL.
-	 */
-	public function get_date_range_sql( $request, $date_field ) {
-		global $wpdb;
-
-		$sql = '1=1';
-		$range = $this->get_date_range( $request );
-
-		if ( ! empty( $range['after'] ) ) {
-			$sql .= ' AND ' .  $wpdb->prepare(
-				"$date_field > %s",
-				$range['after']
-			);
-		}
-
-		if ( ! empty( $range['before'] ) ) {
-			$sql .= ' AND ' .  $wpdb->prepare(
-				"$date_field < %s",
-				$range['before']
-			);
-		}
-
-		return $sql;
-
-	}
-
-	/**
-	 * Prepares a group by query.
-	 *
-	 * @param string $date_field The date field.
-	 * @return string The appropriate SQL.
-	 */
-	public function get_group_by_sql( $date_field ) {
-
-		if ( 'day' === $this->groupby ) {
-			return "YEAR($date_field), MONTH($date_field), DAY($date_field)";
-		}
-
-		return "YEAR($date_field), MONTH($date_field)";
-	}
-
-	/**
-	 * 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'       => __( 'Limit to results of a specific period.', 'invoicing' ),
-				'type'              => 'string',
-				'enum'              => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days' , '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ),
-				'validate_callback' => 'rest_validate_request_arg',
-				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => '7_days',
-			),
-			'after' => array(
-				/* translators: %s: date format */
-				'description'       => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
-				'type'              => 'string',
-				'format'            => 'date',
-				'validate_callback' => 'rest_validate_request_arg',
-				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ),
-			),
-			'before' => array(
-				/* translators: %s: date format */
-				'description'       => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
-				'type'              => 'string',
-				'format'            => 'date',
-				'validate_callback' => 'rest_validate_request_arg',
-				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			),
-		);
-	}
+    /**
+     * Group response items by day or month.
+     *
+     * @var string
+     */
+    public $groupby = 'day';
+
+    /**
+     * Returns an array with arguments to request the previous report.
+     *
+     * @var array
+     */
+    public $previous_range = array();
+
+    /**
+     * The period interval.
+     *
+     * @var int
+     */
+    public $interval;
+
+    /**
+     * Retrieves the before and after dates.
+     *
+     * @param WP_REST_Request $request Request object.
+     * @return array The appropriate date range.
+     */
+    public function get_date_range( $request ) {
+
+        // If not supported, assume all time.
+        if ( ! in_array( $request['period'], array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year' ) ) ) {
+            $request['period'] = '7_days';
+        }
+
+        $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request );
+        $this->prepare_interval( $date_range );
+
+        return $date_range;
+
+    }
+
+    /**
+     * Groups by month or days.
+     *
+     * @param array $range Date range.
+     * @return array The appropriate date range.
+     */
+    public function prepare_interval( $range ) {
+
+        $before = strtotime( $range['before'] ) - DAY_IN_SECONDS;
+        $after  = strtotime( $range['after'] ) + DAY_IN_SECONDS;
+        if ( 'day' === $this->groupby ) {
+            $difference     = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0;
+            $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) );
+            return;
+        }
+
+        $this->interval = 0;
+        $min_date       = strtotime( date( 'Y-m-01', $after ) );
+
+        while ( $min_date <= $before ) {
+            $this->interval ++;
+            $min_date = strtotime( '+1 MONTH', $min_date );
+        }
+
+        $this->interval = max( 1, $this->interval );
+
+    }
+
+    /**
+     * Retrieves a custom date range.
+     *
+     * @param WP_REST_Request $request Request object.
+     * @return array The appropriate date range.
+     */
+    public function get_custom_date_range( $request ) {
+
+        $after  = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) );
+        $before = strtotime( '+1 day', current_time( 'timestamp' ) );
+
+        if ( ! empty( $request['before'] ) ) {
+            $before  = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) );
+        }
+
+        // 3 months max for day view
+        if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 3 ) {
+            $this->groupby = 'month';
+        }
+
+        // Set the previous date range.
+        $difference           = $before - $after;
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', $before - $difference ),
+            'after'  => date( 'Y-m-d', $after - $difference ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', $before ),
+            'after' => date( 'Y-m-d', $after ),
+        );
+
+    }
+
+    /**
+     * Retrieves todays date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_today_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'yesterday',
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves yesterdays date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_yesterday_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-3 days', current_time( 'timestamp' ) ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-2 days', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves this week's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_week_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_week',
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' )  ) + 8 * DAY_IN_SECONDS ),
+            'after'  => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' )  ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves last week's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_week_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' )  ) ),
+            'after'  => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' )  ) - 8 * DAY_IN_SECONDS ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', strtotime( 'monday this week', current_time( 'timestamp' )  ) ),
+            'after'  => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' )  ) - DAY_IN_SECONDS ),
+        );
+
+    }
+
+    /**
+     * Retrieves last 7 days date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_7_days_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-15 days', current_time( 'timestamp' ) ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves last 30 days date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_30_days_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-31 days', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves last 90 days date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_90_days_date_range() {
+
+        $this->groupby = 'month';
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-91 days', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves last 180 days date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_180_days_date_range() {
+
+        $this->groupby = 'month';
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-361 days', current_time( 'timestamp' ) ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves last 60 days date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_60_days_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-121 days', current_time( 'timestamp' ) ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves this month date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_month_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_month',
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-01', strtotime( 'next month', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves last month's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_month_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-1', strtotime( 'last month', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-t', strtotime( "-3 months", current_time( 'timestamp' ) ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-1', current_time( 'timestamp' ) ),
+            'after'  => date( 'Y-m-t', strtotime( "-2 months", current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves this quarter date range.
+     *
+     * @return array The available quarters.
+     */
+    public function get_quarters() {
+
+        $last_year = (int) date('Y') - 1;
+        $next_year = (int) date('Y') + 1;
+        $year      = (int) date('Y');
+        return array(
+
+            array(
+                'after'  => "$last_year-06-30",
+                'before' => "$last_year-10-01",
+            ),
+
+            array(
+                'before' => "$year-01-01",
+                'after'  => "$last_year-09-30",
+            ),
+
+            array(
+                'before' => "$year-04-01",
+                'after'  => "$last_year-12-31",
+            ),
+
+            array(
+                'before' => "$year-07-01",
+                'after'  => "$year-03-31",
+            ),
+
+            array(
+                'after'  => "$year-06-30",
+                'before' => "$year-10-01",
+            ),
+
+            array(
+                'before' => "$next_year-01-01",
+                'after'  => "$year-09-30",
+            )
+
+        );
+
+    }
+
+    /**
+     * Retrieves the current quater.
+     *
+     * @return int The current quarter.
+     */
+    public function get_quarter() {
+
+        $month    = (int) date( 'n', current_time( 'timestamp' ) );
+        $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 );
+        return $quarters[ $month - 1 ];
+
+    }
+
+    /**
+     * Retrieves this quarter date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_quarter_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_quarter',
+        );
+
+        // Generate the report.
+        $quarters = $this->get_quarters();
+        return $quarters[ $this->get_quarter() + 1 ];
+
+    }
+
+    /**
+     * Retrieves last quarter's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_quarter_date_range() {
+
+        $quarters = $this->get_quarters();
+        $quarter  = $this->get_quarter();
+
+        // Set the previous date range.
+        $this->previous_range = array_merge(
+            $quarters[ $quarter - 1 ],
+            array( 'period' => 'custom' )
+        );
+
+        // Generate the report.
+        return $quarters[ $quarter ];
+
+    }
+
+    /**
+     * Retrieves this year date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_year_date_range() {
+
+        $this->groupby = 'month';
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_year',
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', strtotime( 'next year January 1st', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves last year date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_year_date_range() {
+
+        $this->groupby = 'month';
+
+        // Set the previous date range.
+        $year          = (int) date('Y') - 3;
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ),
+            'after'  => "$year-12-31",
+        );
+
+        // Generate the report.
+        $year          = (int) date('Y') - 2;
+        return array(
+            'after'  => "$year-12-31",
+            'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Prepare a the request date for SQL usage.
+     *
+     * @param WP_REST_Request $request Request object.
+     * @param string $date_field The date field.
+     * @return string The appropriate SQL.
+     */
+    public function get_date_range_sql( $request, $date_field ) {
+        global $wpdb;
+
+        $sql = '1=1';
+        $range = $this->get_date_range( $request );
+
+        if ( ! empty( $range['after'] ) ) {
+            $sql .= ' AND ' .  $wpdb->prepare(
+                "$date_field > %s",
+                $range['after']
+            );
+        }
+
+        if ( ! empty( $range['before'] ) ) {
+            $sql .= ' AND ' .  $wpdb->prepare(
+                "$date_field < %s",
+                $range['before']
+            );
+        }
+
+        return $sql;
+
+    }
+
+    /**
+     * Prepares a group by query.
+     *
+     * @param string $date_field The date field.
+     * @return string The appropriate SQL.
+     */
+    public function get_group_by_sql( $date_field ) {
+
+        if ( 'day' === $this->groupby ) {
+            return "YEAR($date_field), MONTH($date_field), DAY($date_field)";
+        }
+
+        return "YEAR($date_field), MONTH($date_field)";
+    }
+
+    /**
+     * 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'       => __( 'Limit to results of a specific period.', 'invoicing' ),
+                'type'              => 'string',
+                'enum'              => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days' , '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ),
+                'validate_callback' => 'rest_validate_request_arg',
+                'sanitize_callback' => 'sanitize_text_field',
+                'default'           => '7_days',
+            ),
+            'after' => array(
+                /* translators: %s: date format */
+                'description'       => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
+                'type'              => 'string',
+                'format'            => 'date',
+                'validate_callback' => 'rest_validate_request_arg',
+                'sanitize_callback' => 'sanitize_text_field',
+                'default'           => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ),
+            ),
+            'before' => array(
+                /* translators: %s: date format */
+                'description'       => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
+                'type'              => 'string',
+                'format'            => 'date',
+                'validate_callback' => 'rest_validate_request_arg',
+                'sanitize_callback' => 'sanitize_text_field',
+                'default'           => date( 'Y-m-d', current_time( 'timestamp' ) ),
+            ),
+        );
+    }
 }

includes/reports/class-getpaid-reports-report.php

Indentation +189 added lines, -189 removed lines

@@ -12,88 +12,88 @@ 
  */
 class GetPaid_Reports_Report {
 
-	/**
-	 * @var array
-	 */
-	public $views;
+    /**
+     * @var array
+     */
+    public $views;
 
-	/**
-	 * Class constructor.
-	 *
-	 */
-	public function __construct() {
+    /**
+     * Class constructor.
+     *
+     */
+    public function __construct() {
 
-		$this->views        = array(
+        $this->views        = array(
 
             'items'     => array(
-				'label' => __( 'Items', 'invoicing' ),
-				'class' => 'GetPaid_Reports_Report_Items',
-			),
+                'label' => __( 'Items', 'invoicing' ),
+                'class' => 'GetPaid_Reports_Report_Items',
+            ),
 
-			'gateways'  => array(
-				'label' => __( 'Payment Methods', 'invoicing' ),
-				'class' => 'GetPaid_Reports_Report_Gateways',
-			),
+            'gateways'  => array(
+                'label' => __( 'Payment Methods', 'invoicing' ),
+                'class' => 'GetPaid_Reports_Report_Gateways',
+            ),
 
-			'discounts'  => array(
-				'label' => __( 'Discount Codes', 'invoicing' ),
-				'class' => 'GetPaid_Reports_Report_Discounts',
-			),
+            'discounts'  => array(
+                'label' => __( 'Discount Codes', 'invoicing' ),
+                'class' => 'GetPaid_Reports_Report_Discounts',
+            ),
 
         );
 
-		$this->views        = apply_filters( 'wpinv_report_views', $this->views );
-
-	}
-
-	/**
-	 * Retrieves the current range.
-	 *
-	 */
-	public function get_range() {
-		$valid_ranges = $this->get_periods();
-
-		if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) {
-			return sanitize_key( $_GET['date_range'] );
-		}
-
-		return '7_days';
-	}
-
-	/**
-	 * Returns an array of date ranges.
-	 *
-	 * @return array
-	 */
-	public function get_periods() {
-
-		$periods = array(
-			'today'        => __( 'Today', 'invoicing' ),
-			'yesterday'    => __( 'Yesterday', 'invoicing' ),
-			'week'         => __( 'This week', 'invoicing' ),
-			'last_week'    => __( 'Last week', 'invoicing' ),
-			'7_days'       => __( 'Last 7 days', 'invoicing' ),
-			'month'        => __( 'This month', 'invoicing' ),
-			'last_month'   => __( 'Last month', 'invoicing' ),
-			'30_days'      => __( 'Last 30 days', 'invoicing' ),
-			'quarter'      => __( 'This Quarter', 'invoicing' ),
-			'last_quarter' => __( 'Last Quarter', 'invoicing' ),
-			'year'         => __( 'This year', 'invoicing' ),
-			'last_year'    => __( 'Last Year', 'invoicing' ),
-			'custom'       => __( 'Custom Date Range', 'invoicing' ),
-		);
-
-		return apply_filters( 'getpaid_earning_periods', $periods );
-	}
-
-	/**
-	 * Displays the range selector.
-	 *
-	 */
-	public function display_range_selector() {
-
-		$range = $this->get_range();
-		?>
+        $this->views        = apply_filters( 'wpinv_report_views', $this->views );
+
+    }
+
+    /**
+     * Retrieves the current range.
+     *
+     */
+    public function get_range() {
+        $valid_ranges = $this->get_periods();
+
+        if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) {
+            return sanitize_key( $_GET['date_range'] );
+        }
+
+        return '7_days';
+    }
+
+    /**
+     * Returns an array of date ranges.
+     *
+     * @return array
+     */
+    public function get_periods() {
+
+        $periods = array(
+            'today'        => __( 'Today', 'invoicing' ),
+            'yesterday'    => __( 'Yesterday', 'invoicing' ),
+            'week'         => __( 'This week', 'invoicing' ),
+            'last_week'    => __( 'Last week', 'invoicing' ),
+            '7_days'       => __( 'Last 7 days', 'invoicing' ),
+            'month'        => __( 'This month', 'invoicing' ),
+            'last_month'   => __( 'Last month', 'invoicing' ),
+            '30_days'      => __( 'Last 30 days', 'invoicing' ),
+            'quarter'      => __( 'This Quarter', 'invoicing' ),
+            'last_quarter' => __( 'Last Quarter', 'invoicing' ),
+            'year'         => __( 'This year', 'invoicing' ),
+            'last_year'    => __( 'Last Year', 'invoicing' ),
+            'custom'       => __( 'Custom Date Range', 'invoicing' ),
+        );
+
+        return apply_filters( 'getpaid_earning_periods', $periods );
+    }
+
+    /**
+     * Displays the range selector.
+     *
+     */
+    public function display_range_selector() {
+
+        $range = $this->get_range();
+        ?>
 
 			<form method="get" class="getpaid-filter-earnings float-right">
 				<?php getpaid_hidden_field( 'page', 'wpinv-reports' );  ?>
@@ -115,14 +115,14 @@ 
 			</form>
 
 		<?php
-	}
+    }
 
-	/**
-	 * Displays the reports tab.
-	 *
-	 */
-	public function display() {
-		?>
+    /**
+     * Displays the reports tab.
+     *
+     */
+    public function display() {
+        ?>
 
 		<div class="mt-4" style="max-width: 1200px;">
 
@@ -202,24 +202,24 @@ 
 
 		<?php
 
-	}
-
-	/**
-	 * Displays the left side.
-	 *
-	 */
-	public function display_left() {
-		$graphs = array(
-			'sales'    => __( 'Earnings', 'invoicing' ),
-			'refunds'  => __( 'Refunds', 'invoicing' ),
-			'tax'      => __( 'Taxes', 'invoicing' ),
-			'fees'     => __( 'Fees', 'invoicing' ),
-			'discount' => __( 'Discounts', 'invoicing' ),
-			'invoices' => __( 'Invoices', 'invoicing' ),
-			'items'    => __( 'Purchased Items', 'invoicing' ),
-		);
-
-		?>
+    }
+
+    /**
+     * Displays the left side.
+     *
+     */
+    public function display_left() {
+        $graphs = array(
+            'sales'    => __( 'Earnings', 'invoicing' ),
+            'refunds'  => __( 'Refunds', 'invoicing' ),
+            'tax'      => __( 'Taxes', 'invoicing' ),
+            'fees'     => __( 'Fees', 'invoicing' ),
+            'discount' => __( 'Discounts', 'invoicing' ),
+            'invoices' => __( 'Invoices', 'invoicing' ),
+            'items'    => __( 'Purchased Items', 'invoicing' ),
+        );
+
+        ?>
 
 			<?php foreach ( $graphs as $key => $graph ) : ?>
 				<div class="row mb-4">
@@ -238,35 +238,35 @@ 
 
 		<?php
 
-	}
-
-	/**
-	 * Retrieves the download url.
-	 *
-	 */
-	public function get_download_url( $graph, $file_type ) {
-
-		return wp_nonce_url(
-			add_query_arg(
-				array(
-					'getpaid-admin-action' => 'download_graph',
-					'file_type'            => urlencode( $file_type ),
-					'graph'                => urlencode( $graph ),
-				)
-			),
-			'getpaid-nonce',
-			'getpaid-nonce'
-		);
+    }
+
+    /**
+     * Retrieves the download url.
+     *
+     */
+    public function get_download_url( $graph, $file_type ) {
+
+        return wp_nonce_url(
+            add_query_arg(
+                array(
+                    'getpaid-admin-action' => 'download_graph',
+                    'file_type'            => urlencode( $file_type ),
+                    'graph'                => urlencode( $graph ),
+                )
+            ),
+            'getpaid-nonce',
+            'getpaid-nonce'
+        );
 
-	}
+    }
 
-	/**
-	 * Displays the right side.
-	 *
-	 */
-	public function display_right() {
+    /**
+     * Displays the right side.
+     *
+     */
+    public function display_right() {
 
-		?>
+        ?>
 
 			<?php foreach ( $this->views as $key => $view ) : ?>
 				<div class="row mb-4">
@@ -295,10 +295,10 @@ 
 							</div>
 							<div class="card-body">
 								<?php
-									$class = $view['class'];
-									$class = new $class();
-									$class->display_stats();
-								?>
+                                    $class = $view['class'];
+                                    $class = new $class();
+                                    $class->display_stats();
+                                ?>
 							</div>
 						</div>
 					</div>
@@ -307,67 +307,67 @@ 
 
 		<?php
 
-	}
-
-	/**
-	 * Returns a list of report cards.
-	 *
-	 */
-	public function get_cards() {
-
-		$cards = array(
-			'total_sales' => array(
-				'description' => __( 'Gross sales in the period.', 'invoicing' ),
-				'label'       => __( 'Gross Revenue', 'invoicing' ),
-			),
-			'net_sales' => array(
-				'description' => __( 'Net sales in the period.', 'invoicing' ),
-				'label'       => __( 'Net Revenue', 'invoicing' ),
-			),
-			'average_sales' => array(
-				'description' => __( 'Average net daily/monthly sales.', 'invoicing' ),
-				'label'       => __( 'Avg. Net Sales', 'invoicing' ),
-			),
-			'average_total_sales' => array(
-				'description' => __( 'Average gross daily/monthly sales.', 'invoicing' ),
-				'label'       => __( 'Avg. Gross Sales', 'invoicing' ),
-			),
-			'total_invoices'  => array(
-				'description' => __( 'Number of paid invoices.', 'invoicing' ),
-				'label'       => __( 'Paid Invoices', 'invoicing' ),
-			),
-			'total_items' => array(
-				'description' => __( 'Number of items purchased.', 'invoicing' ),
-				'label'       => __( 'Purchased Items', 'invoicing' ),
-			),
-			'refunded_items' => array(
-				'description' => __( 'Number of items refunded.', 'invoicing' ),
-				'label'       => __( 'Refunded Items', 'invoicing' ),
-			),
-			'total_tax' => array(
-				'description' => __( 'Total charged for taxes.', 'invoicing' ),
-				'label'       => __( 'Tax', 'invoicing' ),
-			),
-			'total_refunded_tax' => array(
-				'description' => __( 'Total refunded for taxes.', 'invoicing' ),
-				'label'       => __( 'Refunded Tax', 'invoicing' ),
-			),
-			'total_fees' => array(
-				'description' => __( 'Total fees charged.', 'invoicing' ),
-				'label'       => __( 'Fees', 'invoicing' ),
-			),
-			'total_refunds' => array(
-				'description' => __( 'Total of refunded invoices.', 'invoicing' ),
-				'label'       => __( 'Refunded', 'invoicing' ),
-			),
-			'total_discount'  => array(
-				'description' => __( 'Total of discounts used.', 'invoicing' ),
-				'label'       => __( 'Discounted', 'invoicing' ),
-			),
-		);
-
-		return apply_filters( 'wpinv_report_cards', $cards );
-	}
+    }
+
+    /**
+     * Returns a list of report cards.
+     *
+     */
+    public function get_cards() {
+
+        $cards = array(
+            'total_sales' => array(
+                'description' => __( 'Gross sales in the period.', 'invoicing' ),
+                'label'       => __( 'Gross Revenue', 'invoicing' ),
+            ),
+            'net_sales' => array(
+                'description' => __( 'Net sales in the period.', 'invoicing' ),
+                'label'       => __( 'Net Revenue', 'invoicing' ),
+            ),
+            'average_sales' => array(
+                'description' => __( 'Average net daily/monthly sales.', 'invoicing' ),
+                'label'       => __( 'Avg. Net Sales', 'invoicing' ),
+            ),
+            'average_total_sales' => array(
+                'description' => __( 'Average gross daily/monthly sales.', 'invoicing' ),
+                'label'       => __( 'Avg. Gross Sales', 'invoicing' ),
+            ),
+            'total_invoices'  => array(
+                'description' => __( 'Number of paid invoices.', 'invoicing' ),
+                'label'       => __( 'Paid Invoices', 'invoicing' ),
+            ),
+            'total_items' => array(
+                'description' => __( 'Number of items purchased.', 'invoicing' ),
+                'label'       => __( 'Purchased Items', 'invoicing' ),
+            ),
+            'refunded_items' => array(
+                'description' => __( 'Number of items refunded.', 'invoicing' ),
+                'label'       => __( 'Refunded Items', 'invoicing' ),
+            ),
+            'total_tax' => array(
+                'description' => __( 'Total charged for taxes.', 'invoicing' ),
+                'label'       => __( 'Tax', 'invoicing' ),
+            ),
+            'total_refunded_tax' => array(
+                'description' => __( 'Total refunded for taxes.', 'invoicing' ),
+                'label'       => __( 'Refunded Tax', 'invoicing' ),
+            ),
+            'total_fees' => array(
+                'description' => __( 'Total fees charged.', 'invoicing' ),
+                'label'       => __( 'Fees', 'invoicing' ),
+            ),
+            'total_refunds' => array(
+                'description' => __( 'Total of refunded invoices.', 'invoicing' ),
+                'label'       => __( 'Refunded', 'invoicing' ),
+            ),
+            'total_discount'  => array(
+                'description' => __( 'Total of discounts used.', 'invoicing' ),
+                'label'       => __( 'Discounted', 'invoicing' ),
+            ),
+        );
+
+        return apply_filters( 'wpinv_report_cards', $cards );
+    }
 
 	
 

includes/geolocation/class-getpaid-geolocation.php

Indentation +259 added lines, -259 removed lines

@@ -13,264 +13,264 @@
  */
 class GetPaid_Geolocation {
 
-	/**
-	 * Holds the current user's IP Address.
-	 *
-	 * @var string
-	 */
-	public static $current_user_ip;
-
-	/**
-	 * API endpoints for looking up a user IP address.
-	 *
-	 * For example, in case a user is on localhost.
-	 *
-	 * @var array
-	 */
-	protected static $ip_lookup_apis = array(
-		'ipify'             => 'http://api.ipify.org/',
-		'ipecho'            => 'http://ipecho.net/plain',
-		'ident'             => 'http://ident.me',
-		'whatismyipaddress' => 'http://bot.whatismyipaddress.com',
-	);
-
-	/**
-	 * API endpoints for geolocating an IP address
-	 *
-	 * @var array
-	 */
-	protected static $geoip_apis = array(
-		'ip-api.com' => 'http://ip-api.com/json/%s',
-		'ipinfo.io'  => 'https://ipinfo.io/%s/json',
-	);
-
-	/**
-	 * Get current user IP Address.
-	 *
-	 * @return string
-	 */
-	public static function get_ip_address() {
-		return wpinv_get_ip();
-	}
-
-	/**
-	 * Get user IP Address using an external service.
-	 * This can be used as a fallback for users on localhost where
-	 * get_ip_address() will be a local IP and non-geolocatable.
-	 *
-	 * @return string
-	 */
-	public static function get_external_ip_address() {
-
-		$transient_name = 'external_ip_address_0.0.0.0';
-
-		if ( '' !== self::get_ip_address() ) {
-			$transient_name      = 'external_ip_address_' . self::get_ip_address();
-		}
-
-		// Try retrieving from cache.
-		$external_ip_address = get_transient( $transient_name );
-
-		if ( false === $external_ip_address ) {
-			$external_ip_address     = '0.0.0.0';
-			$ip_lookup_services      = apply_filters( 'getpaid_geolocation_ip_lookup_apis', self::$ip_lookup_apis );
-			$ip_lookup_services_keys = array_keys( $ip_lookup_services );
-			shuffle( $ip_lookup_services_keys );
-
-			foreach ( $ip_lookup_services_keys as $service_name ) {
-				$service_endpoint = $ip_lookup_services[ $service_name ];
-				$response         = wp_safe_remote_get( $service_endpoint, array( 'timeout' => 2 ) );
-
-				if ( ! is_wp_error( $response ) && rest_is_ip_address( $response['body'] ) ) {
-					$external_ip_address = apply_filters( 'getpaid_geolocation_ip_lookup_api_response', wpinv_clean( $response['body'] ), $service_name );
-					break;
-				}
-
-			}
-
-			set_transient( $transient_name, $external_ip_address, WEEK_IN_SECONDS );
-		}
-
-		return $external_ip_address;
-	}
-
-	/**
-	 * Geolocate an IP address.
-	 *
-	 * @param  string $ip_address   IP Address.
-	 * @param  bool   $fallback     If true, fallbacks to alternative IP detection (can be slower).
-	 * @param  bool   $api_fallback If true, uses geolocation APIs if the database file doesn't exist (can be slower).
-	 * @return array
-	 */
-	public static function geolocate_ip( $ip_address = '', $fallback = false, $api_fallback = true ) {
-
-		if ( empty( $ip_address ) ) {
-			$ip_address = self::get_ip_address();
-		}
-
-		// Update the current user's IP Address.
-		self::$current_user_ip = $ip_address;
-
-		// Filter to allow custom geolocation of the IP address.
-		$country_code = apply_filters( 'getpaid_geolocate_ip', false, $ip_address, $fallback, $api_fallback );
-
-		if ( false !== $country_code ) {
-
-			return array(
-				'country'  => $country_code,
-				'state'    => '',
-				'city'     => '',
-				'postcode' => '',
-			);
-
-		}
-
-		$country_code = self::get_country_code_from_headers();
-
-		/**
-		 * Get geolocation filter.
-		 *
-		 * @since 1.0.19
-		 * @param array  $geolocation Geolocation data, including country, state, city, and postcode.
-		 * @param string $ip_address  IP Address.
-		 */
-		$geolocation  = apply_filters(
-			'getpaid_get_geolocation',
-			array(
-				'country'  => $country_code,
-				'state'    => '',
-				'city'     => '',
-				'postcode' => '',
-			),
-			$ip_address
-		);
-
-		// If we still haven't found a country code, let's consider doing an API lookup.
-		if ( '' === $geolocation['country'] && $api_fallback ) {
-			$geolocation['country'] = self::geolocate_via_api( $ip_address );
-		}
-
-		// It's possible that we're in a local environment, in which case the geolocation needs to be done from the
-		// external address.
-		if ( '' === $geolocation['country'] && $fallback ) {
-			$external_ip_address = self::get_external_ip_address();
-
-			// Only bother with this if the external IP differs.
-			if ( '0.0.0.0' !== $external_ip_address && $external_ip_address !== $ip_address ) {
-				return self::geolocate_ip( $external_ip_address, false, $api_fallback );
-			}
-
-		}
-
-		return array(
-			'country'  => $geolocation['country'],
-			'state'    => $geolocation['state'],
-			'city'     => $geolocation['city'],
-			'postcode' => $geolocation['postcode'],
-		);
-
-	}
-
-	/**
-	 * Fetches the country code from the request headers, if one is available.
-	 *
-	 * @since 1.0.19
-	 * @return string The country code pulled from the headers, or empty string if one was not found.
-	 */
-	protected static function get_country_code_from_headers() {
-		$country_code = '';
-
-		$headers = array(
-			'MM_COUNTRY_CODE',
-			'GEOIP_COUNTRY_CODE',
-			'HTTP_CF_IPCOUNTRY',
-			'HTTP_X_COUNTRY_CODE',
-		);
-
-		foreach ( $headers as $header ) {
-			if ( empty( $_SERVER[ $header ] ) ) {
-				continue;
-			}
-
-			$country_code = strtoupper( sanitize_text_field( wp_unslash( $_SERVER[ $header ] ) ) );
-			break;
-		}
-
-		return $country_code;
-	}
-
-	/**
-	 * Use APIs to Geolocate the user.
-	 *
-	 * Geolocation APIs can be added through the use of the getpaid_geolocation_geoip_apis filter.
-	 * Provide a name=>value pair for service-slug=>endpoint.
-	 *
-	 * If APIs are defined, one will be chosen at random to fulfil the request. After completing, the result
-	 * will be cached in a transient.
-	 *
-	 * @param  string $ip_address IP address.
-	 * @return string
-	 */
-	protected static function geolocate_via_api( $ip_address ) {
-
-		// Retrieve from cache...
-		$country_code = get_transient( 'geoip_' . $ip_address );
-
-		// If missing, retrieve from the API.
-		if ( false === $country_code ) {
-			$geoip_services = apply_filters( 'getpaid_geolocation_geoip_apis', self::$geoip_apis );
-
-			if ( empty( $geoip_services ) ) {
-				return '';
-			}
-
-			$geoip_services_keys = array_keys( $geoip_services );
-
-			shuffle( $geoip_services_keys );
-
-			foreach ( $geoip_services_keys as $service_name ) {
-
-				$service_endpoint = $geoip_services[ $service_name ];
-				$response         = wp_safe_remote_get( sprintf( $service_endpoint, $ip_address ), array( 'timeout' => 2 ) );
-				$country_code     = sanitize_text_field( strtoupper( self::handle_geolocation_response( $response, $service_name ) ) );
-
-				if ( ! empty( $country_code ) ) {
-					break;
-				}
-
-			}
-
-			set_transient( 'geoip_' . $ip_address, $country_code, WEEK_IN_SECONDS );
-		}
-
-		return $country_code;
-	}
-
-	/**
-	 * Handles geolocation response
-	 *
-	 * @param  WP_Error|String $geolocation_response
-	 * @param  String $geolocation_service
-	 * @return string Country code
-	 */
-	protected static function handle_geolocation_response( $geolocation_response, $geolocation_service ) {
-
-		if ( is_wp_error( $geolocation_response ) || empty( $geolocation_response['body'] ) ) {
-			return '';
-		}
-
-		if ( $geolocation_service === 'ipinfo.io' ) {
-			$data = json_decode( $geolocation_response['body'] );
-			return empty( $data ) || empty( $data->country ) ? '' : $data->country;
-		}
-
-		if ( $geolocation_service === 'ip-api.com' ) {
-			$data = json_decode( $geolocation_response['body'] );
-			return empty( $data ) || empty( $data->countryCode ) ? '' : $data->countryCode;
-		}
-
-		return apply_filters( 'getpaid_geolocation_geoip_response_' . $geolocation_service, '', $geolocation_response['body'] );
-
-	}
+    /**
+     * Holds the current user's IP Address.
+     *
+     * @var string
+     */
+    public static $current_user_ip;
+
+    /**
+     * API endpoints for looking up a user IP address.
+     *
+     * For example, in case a user is on localhost.
+     *
+     * @var array
+     */
+    protected static $ip_lookup_apis = array(
+        'ipify'             => 'http://api.ipify.org/',
+        'ipecho'            => 'http://ipecho.net/plain',
+        'ident'             => 'http://ident.me',
+        'whatismyipaddress' => 'http://bot.whatismyipaddress.com',
+    );
+
+    /**
+     * API endpoints for geolocating an IP address
+     *
+     * @var array
+     */
+    protected static $geoip_apis = array(
+        'ip-api.com' => 'http://ip-api.com/json/%s',
+        'ipinfo.io'  => 'https://ipinfo.io/%s/json',
+    );
+
+    /**
+     * Get current user IP Address.
+     *
+     * @return string
+     */
+    public static function get_ip_address() {
+        return wpinv_get_ip();
+    }
+
+    /**
+     * Get user IP Address using an external service.
+     * This can be used as a fallback for users on localhost where
+     * get_ip_address() will be a local IP and non-geolocatable.
+     *
+     * @return string
+     */
+    public static function get_external_ip_address() {
+
+        $transient_name = 'external_ip_address_0.0.0.0';
+
+        if ( '' !== self::get_ip_address() ) {
+            $transient_name      = 'external_ip_address_' . self::get_ip_address();
+        }
+
+        // Try retrieving from cache.
+        $external_ip_address = get_transient( $transient_name );
+
+        if ( false === $external_ip_address ) {
+            $external_ip_address     = '0.0.0.0';
+            $ip_lookup_services      = apply_filters( 'getpaid_geolocation_ip_lookup_apis', self::$ip_lookup_apis );
+            $ip_lookup_services_keys = array_keys( $ip_lookup_services );
+            shuffle( $ip_lookup_services_keys );
+
+            foreach ( $ip_lookup_services_keys as $service_name ) {
+                $service_endpoint = $ip_lookup_services[ $service_name ];
+                $response         = wp_safe_remote_get( $service_endpoint, array( 'timeout' => 2 ) );
+
+                if ( ! is_wp_error( $response ) && rest_is_ip_address( $response['body'] ) ) {
+                    $external_ip_address = apply_filters( 'getpaid_geolocation_ip_lookup_api_response', wpinv_clean( $response['body'] ), $service_name );
+                    break;
+                }
+
+            }
+
+            set_transient( $transient_name, $external_ip_address, WEEK_IN_SECONDS );
+        }
+
+        return $external_ip_address;
+    }
+
+    /**
+     * Geolocate an IP address.
+     *
+     * @param  string $ip_address   IP Address.
+     * @param  bool   $fallback     If true, fallbacks to alternative IP detection (can be slower).
+     * @param  bool   $api_fallback If true, uses geolocation APIs if the database file doesn't exist (can be slower).
+     * @return array
+     */
+    public static function geolocate_ip( $ip_address = '', $fallback = false, $api_fallback = true ) {
+
+        if ( empty( $ip_address ) ) {
+            $ip_address = self::get_ip_address();
+        }
+
+        // Update the current user's IP Address.
+        self::$current_user_ip = $ip_address;
+
+        // Filter to allow custom geolocation of the IP address.
+        $country_code = apply_filters( 'getpaid_geolocate_ip', false, $ip_address, $fallback, $api_fallback );
+
+        if ( false !== $country_code ) {
+
+            return array(
+                'country'  => $country_code,
+                'state'    => '',
+                'city'     => '',
+                'postcode' => '',
+            );
+
+        }
+
+        $country_code = self::get_country_code_from_headers();
+
+        /**
+         * Get geolocation filter.
+         *
+         * @since 1.0.19
+         * @param array  $geolocation Geolocation data, including country, state, city, and postcode.
+         * @param string $ip_address  IP Address.
+         */
+        $geolocation  = apply_filters(
+            'getpaid_get_geolocation',
+            array(
+                'country'  => $country_code,
+                'state'    => '',
+                'city'     => '',
+                'postcode' => '',
+            ),
+            $ip_address
+        );
+
+        // If we still haven't found a country code, let's consider doing an API lookup.
+        if ( '' === $geolocation['country'] && $api_fallback ) {
+            $geolocation['country'] = self::geolocate_via_api( $ip_address );
+        }
+
+        // It's possible that we're in a local environment, in which case the geolocation needs to be done from the
+        // external address.
+        if ( '' === $geolocation['country'] && $fallback ) {
+            $external_ip_address = self::get_external_ip_address();
+
+            // Only bother with this if the external IP differs.
+            if ( '0.0.0.0' !== $external_ip_address && $external_ip_address !== $ip_address ) {
+                return self::geolocate_ip( $external_ip_address, false, $api_fallback );
+            }
+
+        }
+
+        return array(
+            'country'  => $geolocation['country'],
+            'state'    => $geolocation['state'],
+            'city'     => $geolocation['city'],
+            'postcode' => $geolocation['postcode'],
+        );
+
+    }
+
+    /**
+     * Fetches the country code from the request headers, if one is available.
+     *
+     * @since 1.0.19
+     * @return string The country code pulled from the headers, or empty string if one was not found.
+     */
+    protected static function get_country_code_from_headers() {
+        $country_code = '';
+
+        $headers = array(
+            'MM_COUNTRY_CODE',
+            'GEOIP_COUNTRY_CODE',
+            'HTTP_CF_IPCOUNTRY',
+            'HTTP_X_COUNTRY_CODE',
+        );
+
+        foreach ( $headers as $header ) {
+            if ( empty( $_SERVER[ $header ] ) ) {
+                continue;
+            }
+
+            $country_code = strtoupper( sanitize_text_field( wp_unslash( $_SERVER[ $header ] ) ) );
+            break;
+        }
+
+        return $country_code;
+    }
+
+    /**
+     * Use APIs to Geolocate the user.
+     *
+     * Geolocation APIs can be added through the use of the getpaid_geolocation_geoip_apis filter.
+     * Provide a name=>value pair for service-slug=>endpoint.
+     *
+     * If APIs are defined, one will be chosen at random to fulfil the request. After completing, the result
+     * will be cached in a transient.
+     *
+     * @param  string $ip_address IP address.
+     * @return string
+     */
+    protected static function geolocate_via_api( $ip_address ) {
+
+        // Retrieve from cache...
+        $country_code = get_transient( 'geoip_' . $ip_address );
+
+        // If missing, retrieve from the API.
+        if ( false === $country_code ) {
+            $geoip_services = apply_filters( 'getpaid_geolocation_geoip_apis', self::$geoip_apis );
+
+            if ( empty( $geoip_services ) ) {
+                return '';
+            }
+
+            $geoip_services_keys = array_keys( $geoip_services );
+
+            shuffle( $geoip_services_keys );
+
+            foreach ( $geoip_services_keys as $service_name ) {
+
+                $service_endpoint = $geoip_services[ $service_name ];
+                $response         = wp_safe_remote_get( sprintf( $service_endpoint, $ip_address ), array( 'timeout' => 2 ) );
+                $country_code     = sanitize_text_field( strtoupper( self::handle_geolocation_response( $response, $service_name ) ) );
+
+                if ( ! empty( $country_code ) ) {
+                    break;
+                }
+
+            }
+
+            set_transient( 'geoip_' . $ip_address, $country_code, WEEK_IN_SECONDS );
+        }
+
+        return $country_code;
+    }
+
+    /**
+     * Handles geolocation response
+     *
+     * @param  WP_Error|String $geolocation_response
+     * @param  String $geolocation_service
+     * @return string Country code
+     */
+    protected static function handle_geolocation_response( $geolocation_response, $geolocation_service ) {
+
+        if ( is_wp_error( $geolocation_response ) || empty( $geolocation_response['body'] ) ) {
+            return '';
+        }
+
+        if ( $geolocation_service === 'ipinfo.io' ) {
+            $data = json_decode( $geolocation_response['body'] );
+            return empty( $data ) || empty( $data->country ) ? '' : $data->country;
+        }
+
+        if ( $geolocation_service === 'ip-api.com' ) {
+            $data = json_decode( $geolocation_response['body'] );
+            return empty( $data ) || empty( $data->countryCode ) ? '' : $data->countryCode;
+        }
+
+        return apply_filters( 'getpaid_geolocation_geoip_response_' . $geolocation_service, '', $geolocation_response['body'] );
+
+    }
 
 }

includes/class-wpinv-session-handler.php

Indentation +274 added lines, -274 removed lines

@@ -12,125 +12,125 @@ 
  */
 class WPInv_Session_Handler extends WPInv_Session {
 
-	/**
-	 * Cookie name used for the session.
-	 *
-	 * @var string cookie name
-	 */
-	protected $_cookie;
-
-	/**
-	 * Stores session expiry.
-	 *
-	 * @var int session due to expire timestamp
-	 */
-	protected $_session_expiring;
-
-	/**
-	 * Stores session due to expire timestamp.
-	 *
-	 * @var string session expiration timestamp
-	 */
-	protected $_session_expiration;
-
-	/**
-	 * True when the cookie exists.
-	 *
-	 * @var bool Based on whether a cookie exists.
-	 */
-	protected $_has_cookie = false;
-
-	/**
-	 * Table name for session data.
-	 *
-	 * @var string Custom session table name
-	 */
-	protected $_table;
-
-	/**
-	 * Constructor for the session class.
-	 */
-	public function __construct() {
-
-	    $this->_cookie = apply_filters( 'wpinv_cookie', 'wpinv_session_' . COOKIEHASH );
+    /**
+     * Cookie name used for the session.
+     *
+     * @var string cookie name
+     */
+    protected $_cookie;
+
+    /**
+     * Stores session expiry.
+     *
+     * @var int session due to expire timestamp
+     */
+    protected $_session_expiring;
+
+    /**
+     * Stores session due to expire timestamp.
+     *
+     * @var string session expiration timestamp
+     */
+    protected $_session_expiration;
+
+    /**
+     * True when the cookie exists.
+     *
+     * @var bool Based on whether a cookie exists.
+     */
+    protected $_has_cookie = false;
+
+    /**
+     * Table name for session data.
+     *
+     * @var string Custom session table name
+     */
+    protected $_table;
+
+    /**
+     * Constructor for the session class.
+     */
+    public function __construct() {
+
+        $this->_cookie = apply_filters( 'wpinv_cookie', 'wpinv_session_' . COOKIEHASH );
         add_action( 'init', array( $this, 'init' ), -1 );
-		add_action( 'wp_logout', array( $this, 'destroy_session' ) );
-		add_action( 'wp', array( $this, 'set_customer_session_cookie' ), 10 );
-		add_action( 'shutdown', array( $this, 'save_data' ), 20 );
-
-	}
-
-	/**
-	 * Init hooks and session data.
-	 *
-	 * @since 3.3.0
-	 */
-	public function init() {
-		$this->init_session_cookie();
-
-		if ( ! is_user_logged_in() ) {
-			add_filter( 'nonce_user_logged_out', array( $this, 'nonce_user_logged_out' ), 10, 2 );
-		}
-	}
-
-	/**
-	 * Setup cookie and customer ID.
-	 *
-	 * @since 3.6.0
-	 */
-	public function init_session_cookie() {
-		$cookie = $this->get_session_cookie();
-
-		if ( $cookie ) {
-			$this->_customer_id        = $cookie[0];
-			$this->_session_expiration = $cookie[1];
-			$this->_session_expiring   = $cookie[2];
-			$this->_has_cookie         = true;
-			$this->_data               = $this->get_session_data();
-
-			// If the user logs in, update session.
-			if ( is_user_logged_in() && get_current_user_id() != $this->_customer_id ) {
-				$this->_customer_id = get_current_user_id();
-				$this->_dirty       = true;
-				$this->save_data();
-				$this->set_customer_session_cookie( true );
-			}
-
-			// Update session if its close to expiring.
-			if ( time() > $this->_session_expiring ) {
-				$this->set_session_expiration();
-				$this->update_session_timestamp( $this->_customer_id, $this->_session_expiration );
-			}
-		} else {
-			$this->set_session_expiration();
-			$this->_customer_id = $this->generate_customer_id();
-			$this->_data        = $this->get_session_data();
-		}
-	}
-
-	/**
-	 * Sets the session cookie on-demand (usually after adding an item to the cart).
-	 *
-	 * Since the cookie name (as of 2.1) is prepended with wp, cache systems like batcache will not cache pages when set.
-	 *
-	 * Warning: Cookies will only be set if this is called before the headers are sent.
-	 *
-	 * @param bool $set Should the session cookie be set.
-	 */
-	public function set_customer_session_cookie( $set ) {
-		if ( $set ) {
-			$to_hash           = $this->_customer_id . '|' . $this->_session_expiration;
-			$cookie_hash       = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) );
-			$cookie_value      = $this->_customer_id . '||' . $this->_session_expiration . '||' . $this->_session_expiring . '||' . $cookie_hash;
-			$this->_has_cookie = true;
-
-			if ( ! isset( $_COOKIE[ $this->_cookie ] ) || $_COOKIE[ $this->_cookie ] !== $cookie_value ) {
-				$this->setcookie( $this->_cookie, $cookie_value, $this->_session_expiration, $this->use_secure_cookie(), true );
-			}
-		}
-	}
-
-	public function setcookie($name, $value, $expire = 0, $secure = false, $httponly = false){
+        add_action( 'wp_logout', array( $this, 'destroy_session' ) );
+        add_action( 'wp', array( $this, 'set_customer_session_cookie' ), 10 );
+        add_action( 'shutdown', array( $this, 'save_data' ), 20 );
+
+    }
+
+    /**
+     * Init hooks and session data.
+     *
+     * @since 3.3.0
+     */
+    public function init() {
+        $this->init_session_cookie();
+
+        if ( ! is_user_logged_in() ) {
+            add_filter( 'nonce_user_logged_out', array( $this, 'nonce_user_logged_out' ), 10, 2 );
+        }
+    }
+
+    /**
+     * Setup cookie and customer ID.
+     *
+     * @since 3.6.0
+     */
+    public function init_session_cookie() {
+        $cookie = $this->get_session_cookie();
+
+        if ( $cookie ) {
+            $this->_customer_id        = $cookie[0];
+            $this->_session_expiration = $cookie[1];
+            $this->_session_expiring   = $cookie[2];
+            $this->_has_cookie         = true;
+            $this->_data               = $this->get_session_data();
+
+            // If the user logs in, update session.
+            if ( is_user_logged_in() && get_current_user_id() != $this->_customer_id ) {
+                $this->_customer_id = get_current_user_id();
+                $this->_dirty       = true;
+                $this->save_data();
+                $this->set_customer_session_cookie( true );
+            }
+
+            // Update session if its close to expiring.
+            if ( time() > $this->_session_expiring ) {
+                $this->set_session_expiration();
+                $this->update_session_timestamp( $this->_customer_id, $this->_session_expiration );
+            }
+        } else {
+            $this->set_session_expiration();
+            $this->_customer_id = $this->generate_customer_id();
+            $this->_data        = $this->get_session_data();
+        }
+    }
+
+    /**
+     * Sets the session cookie on-demand (usually after adding an item to the cart).
+     *
+     * Since the cookie name (as of 2.1) is prepended with wp, cache systems like batcache will not cache pages when set.
+     *
+     * Warning: Cookies will only be set if this is called before the headers are sent.
+     *
+     * @param bool $set Should the session cookie be set.
+     */
+    public function set_customer_session_cookie( $set ) {
+        if ( $set ) {
+            $to_hash           = $this->_customer_id . '|' . $this->_session_expiration;
+            $cookie_hash       = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) );
+            $cookie_value      = $this->_customer_id . '||' . $this->_session_expiration . '||' . $this->_session_expiring . '||' . $cookie_hash;
+            $this->_has_cookie = true;
+
+            if ( ! isset( $_COOKIE[ $this->_cookie ] ) || $_COOKIE[ $this->_cookie ] !== $cookie_value ) {
+                $this->setcookie( $this->_cookie, $cookie_value, $this->_session_expiration, $this->use_secure_cookie(), true );
+            }
+        }
+    }
+
+    public function setcookie($name, $value, $expire = 0, $secure = false, $httponly = false){
         if ( ! headers_sent() ) {
             setcookie( $name, $value, $expire, COOKIEPATH ? COOKIEPATH : '/', COOKIE_DOMAIN, $secure, apply_filters( 'wpinv_cookie_httponly', $httponly, $name, $value, $expire, $secure ) );
         } elseif ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
@@ -139,86 +139,86 @@ 
         }
     }
 
-	/**
-	 * Should the session cookie be secure?
-	 *
-	 * @since 3.6.0
-	 * @return bool
-	 */
-	protected function use_secure_cookie() {
+    /**
+     * Should the session cookie be secure?
+     *
+     * @since 3.6.0
+     * @return bool
+     */
+    protected function use_secure_cookie() {
         $is_https = false !== strstr( get_option( 'home' ), 'https:' );
-		return apply_filters( 'wpinv_session_use_secure_cookie', $is_https && is_ssl() );
-	}
-
-	/**
-	 * Return true if the current user has an active session, i.e. a cookie to retrieve values.
-	 *
-	 * @return bool
-	 */
-	public function has_session() {
-		return isset( $_COOKIE[ $this->_cookie ] ) || $this->_has_cookie || is_user_logged_in(); // @codingStandardsIgnoreLine.
-	}
-
-	/**
-	 * Set session expiration.
-	 */
-	public function set_session_expiration() {
-		$this->_session_expiring   = time() + intval( apply_filters( 'wpinv_session_expiring', 60 * 60 * 47 ) ); // 47 Hours.
-		$this->_session_expiration = time() + intval( apply_filters( 'wpinv_session_expiration', 60 * 60 * 48 ) ); // 48 Hours.
-	}
-
-	/**
-	 * Generates session ids.
-	 *
-	 * @return string
-	 */
-	public function generate_customer_id() {
-		require_once ABSPATH . 'wp-includes/class-phpass.php';
-		$hasher      = new PasswordHash( 8, false );
-		return md5( $hasher->get_random_bytes( 32 ) );
-	}
-
-	/**
-	 * Get the session cookie, if set. Otherwise return false.
-	 *
-	 * Session cookies without a customer ID are invalid.
-	 *
-	 * @return bool|array
-	 */
-	public function get_session_cookie() {
-		$cookie_value = isset( $_COOKIE[ $this->_cookie ] ) ? wp_unslash( $_COOKIE[ $this->_cookie ] ) : false; // @codingStandardsIgnoreLine.
-
-		if ( empty( $cookie_value ) || ! is_string( $cookie_value ) ) {
-			return false;
-		}
-
-		list( $customer_id, $session_expiration, $session_expiring, $cookie_hash ) = explode( '||', $cookie_value );
-
-		if ( empty( $customer_id ) ) {
-			return false;
-		}
-
-		// Validate hash.
-		$to_hash = $customer_id . '|' . $session_expiration;
-		$hash    = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) );
-
-		if ( empty( $cookie_hash ) || ! hash_equals( $hash, $cookie_hash ) ) {
-			return false;
-		}
-
-		return array( $customer_id, $session_expiration, $session_expiring, $cookie_hash );
-	}
-
-	/**
-	 * Get session data.
-	 *
-	 * @return array
-	 */
-	public function get_session_data() {
-		return $this->has_session() ? (array) $this->get_session( $this->_customer_id ) : array();
-	}
-
-	public function generate_key($customer_id){
+        return apply_filters( 'wpinv_session_use_secure_cookie', $is_https && is_ssl() );
+    }
+
+    /**
+     * Return true if the current user has an active session, i.e. a cookie to retrieve values.
+     *
+     * @return bool
+     */
+    public function has_session() {
+        return isset( $_COOKIE[ $this->_cookie ] ) || $this->_has_cookie || is_user_logged_in(); // @codingStandardsIgnoreLine.
+    }
+
+    /**
+     * Set session expiration.
+     */
+    public function set_session_expiration() {
+        $this->_session_expiring   = time() + intval( apply_filters( 'wpinv_session_expiring', 60 * 60 * 47 ) ); // 47 Hours.
+        $this->_session_expiration = time() + intval( apply_filters( 'wpinv_session_expiration', 60 * 60 * 48 ) ); // 48 Hours.
+    }
+
+    /**
+     * Generates session ids.
+     *
+     * @return string
+     */
+    public function generate_customer_id() {
+        require_once ABSPATH . 'wp-includes/class-phpass.php';
+        $hasher      = new PasswordHash( 8, false );
+        return md5( $hasher->get_random_bytes( 32 ) );
+    }
+
+    /**
+     * Get the session cookie, if set. Otherwise return false.
+     *
+     * Session cookies without a customer ID are invalid.
+     *
+     * @return bool|array
+     */
+    public function get_session_cookie() {
+        $cookie_value = isset( $_COOKIE[ $this->_cookie ] ) ? wp_unslash( $_COOKIE[ $this->_cookie ] ) : false; // @codingStandardsIgnoreLine.
+
+        if ( empty( $cookie_value ) || ! is_string( $cookie_value ) ) {
+            return false;
+        }
+
+        list( $customer_id, $session_expiration, $session_expiring, $cookie_hash ) = explode( '||', $cookie_value );
+
+        if ( empty( $customer_id ) ) {
+            return false;
+        }
+
+        // Validate hash.
+        $to_hash = $customer_id . '|' . $session_expiration;
+        $hash    = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) );
+
+        if ( empty( $cookie_hash ) || ! hash_equals( $hash, $cookie_hash ) ) {
+            return false;
+        }
+
+        return array( $customer_id, $session_expiration, $session_expiring, $cookie_hash );
+    }
+
+    /**
+     * Get session data.
+     *
+     * @return array
+     */
+    public function get_session_data() {
+        return $this->has_session() ? (array) $this->get_session( $this->_customer_id ) : array();
+    }
+
+    public function generate_key($customer_id){
         if(!$customer_id){
             return;
         }
@@ -226,68 +226,68 @@ 
         return 'wpi_trans_'.$customer_id;
     }
 
-	/**
-	 * Save data.
-	 */
-	public function save_data() {
-		// Dirty if something changed - prevents saving nothing new.
-		if ( $this->_dirty && $this->has_session() ) {
+    /**
+     * Save data.
+     */
+    public function save_data() {
+        // Dirty if something changed - prevents saving nothing new.
+        if ( $this->_dirty && $this->has_session() ) {
 
             set_transient( $this->generate_key($this->_customer_id), $this->_data, $this->_session_expiration);
 
-			$this->_dirty = false;
-		}
-	}
-
-	/**
-	 * Destroy all session data.
-	 */
-	public function destroy_session() {
-		$this->delete_session( $this->_customer_id );
-		$this->forget_session();
-	}
-
-	/**
-	 * Forget all session data without destroying it.
-	 */
-	public function forget_session() {
-		$this->setcookie( $this->_cookie, '', time() - YEAR_IN_SECONDS, $this->use_secure_cookie(), true );
-
-		wpinv_empty_cart();
-
-		$this->_data        = array();
-		$this->_dirty       = false;
-		$this->_customer_id = $this->generate_customer_id();
-	}
-
-	/**
-	 * When a user is logged out, ensure they have a unique nonce by using the customer/session ID.
-	 *
-	 * @param int $uid User ID.
-	 * @return string
-	 */
-	public function nonce_user_logged_out( $uid ) {
-
-		// Check if one of our nonces.
-		if ( substr( $uid, 0, 5 ) === 'wpinv' || substr( $uid, 0, 7 ) === 'getpaid' ) {
-			return $this->has_session() && $this->_customer_id ? $this->_customer_id : $uid;
-		}
-
-		return $uid;
-	}
-
-	/**
-	 * Returns the session.
-	 *
-	 * @param string $customer_id Customer ID.
-	 * @param mixed  $default Default session value.
-	 * @return string|array
-	 */
-	public function get_session( $customer_id, $default = false ) {
-
-		if ( defined( 'WP_SETUP_CONFIG' ) ) {
-			return array();
-		}
+            $this->_dirty = false;
+        }
+    }
+
+    /**
+     * Destroy all session data.
+     */
+    public function destroy_session() {
+        $this->delete_session( $this->_customer_id );
+        $this->forget_session();
+    }
+
+    /**
+     * Forget all session data without destroying it.
+     */
+    public function forget_session() {
+        $this->setcookie( $this->_cookie, '', time() - YEAR_IN_SECONDS, $this->use_secure_cookie(), true );
+
+        wpinv_empty_cart();
+
+        $this->_data        = array();
+        $this->_dirty       = false;
+        $this->_customer_id = $this->generate_customer_id();
+    }
+
+    /**
+     * When a user is logged out, ensure they have a unique nonce by using the customer/session ID.
+     *
+     * @param int $uid User ID.
+     * @return string
+     */
+    public function nonce_user_logged_out( $uid ) {
+
+        // Check if one of our nonces.
+        if ( substr( $uid, 0, 5 ) === 'wpinv' || substr( $uid, 0, 7 ) === 'getpaid' ) {
+            return $this->has_session() && $this->_customer_id ? $this->_customer_id : $uid;
+        }
+
+        return $uid;
+    }
+
+    /**
+     * Returns the session.
+     *
+     * @param string $customer_id Customer ID.
+     * @param mixed  $default Default session value.
+     * @return string|array
+     */
+    public function get_session( $customer_id, $default = false ) {
+
+        if ( defined( 'WP_SETUP_CONFIG' ) ) {
+            return array();
+        }
 
         $key = $this->generate_key($customer_id);
         $value = get_transient($key);
@@ -296,30 +296,30 @@ 
             $value = $default;
         }
 
-		return maybe_unserialize( $value );
-	}
+        return maybe_unserialize( $value );
+    }
 
-	/**
-	 * Delete the session from the cache and database.
-	 *
-	 * @param int $customer_id Customer ID.
-	 */
-	public function delete_session( $customer_id ) {
+    /**
+     * Delete the session from the cache and database.
+     *
+     * @param int $customer_id Customer ID.
+     */
+    public function delete_session( $customer_id ) {
 
         $key = $this->generate_key($customer_id);
 
-		delete_transient($key);
-	}
+        delete_transient($key);
+    }
 
-	/**
-	 * Update the session expiry timestamp.
-	 *
-	 * @param string $customer_id Customer ID.
-	 * @param int    $timestamp Timestamp to expire the cookie.
-	 */
-	public function update_session_timestamp( $customer_id, $timestamp ) {
+    /**
+     * Update the session expiry timestamp.
+     *
+     * @param string $customer_id Customer ID.
+     * @param int    $timestamp Timestamp to expire the cookie.
+     */
+    public function update_session_timestamp( $customer_id, $timestamp ) {
 
         set_transient( $this->generate_key($customer_id), maybe_serialize( $this->_data ), $timestamp);
 
-	}
+    }
 }