AyeCode / invoicing

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

Indentation +679 added lines, -679 removed lines

@@ -18,688 +18,688 @@
  */
 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
-	 */
-	public $report_data;
-
-	/**
-	 * The report range.
-	 *
-	 * @var array
-	 */
-	public $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'] );
-
-		if ( 'month' === $this->groupby ) {
-			$start_date      = strtotime( gmdate( 'Y-m-01', $start_date ) );
-		}
-
-		for ( $i = 0; $i < $this->interval; $i++ ) {
-
-			switch ( $this->groupby ) {
-				case 'day':
-					$time = gmdate( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) );
-					break;
-				default:
-					$time = gmdate( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) );
-					break;
-			}
-
-			// Set the defaults for each period.
-			$period_totals[ $time ] = array(
-				'invoices'          => 0,
-				'items'             => 0,
-				'refunded_items'    => 0,
-				'refunded_tax'      => wpinv_round_amount( 0.00 ),
-				'subtotal'          => wpinv_round_amount( 0.00 ),
-				'refunded_subtotal' => wpinv_round_amount( 0.00 ),
-				'refunded_fees'     => wpinv_round_amount( 0.00 ),
-				'discount'          => wpinv_round_amount( 0.00 ),
-			);
-
-			foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) {
-				if ( ! isset( $period_totals[ $time ][ $key ] ) ) {
-					$period_totals[ $time ][ $key ] = 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 = gmdate( $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 = gmdate( $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 = gmdate( $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 ) ? gmdate( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : gmdate( '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 ) ? gmdate( 'Y-m-d', strtotime( $discount->post_date ) ) : gmdate( 'Y-m', strtotime( $discount->post_date ) );
-
-			if ( isset( $period_totals[ $time ] ) ) {
-				$period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount );
-			}
-		}
-
-		// Extra fields.
-		foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) {
-
-			// Abort unprepared.
-			if ( ! isset( $report_data->$key ) ) {
-				continue;
-			}
-
-			// Abort defaults.
-			if ( in_array( $key, array( 'sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items' ) ) ) {
-				continue;
-			}
-
-			// Set values.
-			foreach ( $report_data->$key as $item ) {
-				$time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $item->date ) ) : gmdate( 'Y-m', strtotime( $item->date ) );
-
-				if ( isset( $period_totals[ $time ] ) ) {
-					$period_totals[ $time ][ $key ] = wpinv_round_amount( $item->val );
-				}
-			}
-
-			unset( $report_data->$key );
-		}
-
-		$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        = gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) );
-		$report_data->end_date          = gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) );
-		$report_data->start_date_locale = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) ) );
-		$report_data->end_date_locale   = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) ) );
-		$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(
+    /**
+     * Route base.
+     *
+     * @var string
+     */
+    protected $rest_base = 'reports/sales';
+
+    /**
+     * The report data.
+     *
+     * @var stdClass
+     */
+    public $report_data;
+
+    /**
+     * The report range.
+     *
+     * @var array
+     */
+    public $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(
-				'about' => array(
-					'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
-				),
+                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' ),
             )
         );
 
-		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, $this );
-	}
-
-	/**
-	 * 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' => 'MIN',
-						'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' => 'MIN',
-						'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' => 'MIN',
-						'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 );
-
-	}
+    }
+
+    /**
+     * 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'] );
+
+        if ( 'month' === $this->groupby ) {
+            $start_date      = strtotime( gmdate( 'Y-m-01', $start_date ) );
+        }
+
+        for ( $i = 0; $i < $this->interval; $i++ ) {
+
+            switch ( $this->groupby ) {
+                case 'day':
+                    $time = gmdate( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) );
+                    break;
+                default:
+                    $time = gmdate( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) );
+                    break;
+            }
+
+            // Set the defaults for each period.
+            $period_totals[ $time ] = array(
+                'invoices'          => 0,
+                'items'             => 0,
+                'refunded_items'    => 0,
+                'refunded_tax'      => wpinv_round_amount( 0.00 ),
+                'subtotal'          => wpinv_round_amount( 0.00 ),
+                'refunded_subtotal' => wpinv_round_amount( 0.00 ),
+                'refunded_fees'     => wpinv_round_amount( 0.00 ),
+                'discount'          => wpinv_round_amount( 0.00 ),
+            );
+
+            foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) {
+                if ( ! isset( $period_totals[ $time ][ $key ] ) ) {
+                    $period_totals[ $time ][ $key ] = 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 = gmdate( $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 = gmdate( $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 = gmdate( $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 ) ? gmdate( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : gmdate( '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 ) ? gmdate( 'Y-m-d', strtotime( $discount->post_date ) ) : gmdate( 'Y-m', strtotime( $discount->post_date ) );
+
+            if ( isset( $period_totals[ $time ] ) ) {
+                $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount );
+            }
+        }
+
+        // Extra fields.
+        foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) {
+
+            // Abort unprepared.
+            if ( ! isset( $report_data->$key ) ) {
+                continue;
+            }
+
+            // Abort defaults.
+            if ( in_array( $key, array( 'sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items' ) ) ) {
+                continue;
+            }
+
+            // Set values.
+            foreach ( $report_data->$key as $item ) {
+                $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $item->date ) ) : gmdate( 'Y-m', strtotime( $item->date ) );
+
+                if ( isset( $period_totals[ $time ] ) ) {
+                    $period_totals[ $time ][ $key ] = wpinv_round_amount( $item->val );
+                }
+            }
+
+            unset( $report_data->$key );
+        }
+
+        $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        = gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) );
+        $report_data->end_date          = gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) );
+        $report_data->start_date_locale = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) ) );
+        $report_data->end_date_locale   = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) ) );
+        $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, $this );
+    }
+
+    /**
+     * 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' => 'MIN',
+                        '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' => 'MIN',
+                        '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' => 'MIN',
+                        '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 +492 added lines, -492 removed lines

@@ -16,496 +16,496 @@
  */
 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 ) {
-
-		// Check if the period is x_days.
-		if ( preg_match( '/^(\d+)_days$/', $request['period'], $matches ) ) {
-			$date_range = $this->get_x_days_date_range( absint( $matches[1] ) );
-		} elseif ( is_callable( array( $this, 'get_' . $request['period'] . '_date_range' ) ) ) {
-			$date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request );
-		} else {
-			$request['period'] = '7_days';
-			$date_range        = $this->get_x_days_date_range();
-		}
-
-		// 3 months max for day view.
-		$before = strtotime( $date_range['before'] );
-		$after  = strtotime( $date_range['after'] );
-		if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 2 ) {
-			$this->groupby = 'month';
-		}
-
-		$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'] );
-		$after  = strtotime( $range['after'] );
-		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( gmdate( '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 = gmdate( 'Y-m-d' );
-
-		if ( ! empty( $request['before'] ) ) {
-			$before  = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) );
-		}
-
-		// Set the previous date range.
-		$difference           = $before - $after;
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => gmdate( 'Y-m-d', $before - $difference - DAY_IN_SECONDS ),
-			'after'  => gmdate( 'Y-m-d', $after - $difference - DAY_IN_SECONDS ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => gmdate( 'Y-m-d', $before ),
-			'after'  => gmdate( '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' => gmdate( 'Y-m-d' ),
-			'after'  => gmdate( 'Y-m-d' ),
-		);
-
-	}
-
-	/**
-	 * 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' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ),
-			'after'  => gmdate( 'Y-m-d', strtotime( '-2 days' ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ),
-			'after'  => gmdate( 'Y-m-d', strtotime( '-1 day' ) ),
-		);
-
-	}
-
-	/**
-	 * 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.
-		$week_starts = absint( get_option( 'start_of_week' ) );
-		return array(
-			'before' => gmdate( 'Y-m-d' ),
-			'after'  => gmdate( 'Y-m-d', strtotime( 'next Sunday -' . ( 7 - $week_starts ) . ' days' ) ),
-		);
-	}
-
-	/**
-	 * Retrieves last week's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_week_date_range() {
-
-		$week_starts = absint( get_option( 'start_of_week' ) );
-		$week_starts = strtotime( 'last Sunday -' . ( 7 - $week_starts ) . ' days' );
-		$date_range  = array(
-			'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ),
-			'after'  => gmdate( 'Y-m-d', $week_starts ),
-		);
-
-		// Set the previous date range.
-		$week_starts          = $week_starts - 7 * DAY_IN_SECONDS;
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ),
-			'after'  => gmdate( 'Y-m-d', $week_starts ),
-		);
-
-		// Generate the report.
-		return $date_range;
-	}
-
-	/**
-	 * Retrieves last x days date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_x_days_date_range( $days = 7 ) {
-
-		$days--;
-
-		$date_range  = array(
-			'before' => gmdate( 'Y-m-d' ),
-			'after'  => gmdate( 'Y-m-d', strtotime( "-$days days" ) ),
-		);
-
-		$days++;
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => gmdate( 'Y-m-d', strtotime( $date_range['before'] ) - $days * DAY_IN_SECONDS ),
-			'after'  => gmdate( 'Y-m-d', strtotime( $date_range['after'] ) - $days * DAY_IN_SECONDS ),
-		);
-
-		// Generate the report.
-		return $date_range;
-	}
-
-	/**
-	 * 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(
-			'after'  => gmdate( 'Y-m-01' ),
-			'before' => gmdate( 'Y-m-t' ),
-		);
-
-	}
-
-	/**
-	 * 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',
-			'after'  => gmdate( 'Y-m-01', strtotime( '-2 months' ) ),
-			'before' => gmdate( 'Y-m-t', strtotime( '-2 months' ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'after'  => gmdate( 'Y-m-01', strtotime( 'last month' ) ),
-			'before' => gmdate( 'Y-m-t', strtotime( 'last month' ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves this quarter date range.
-	 *
-	 * @return array The available quarters.
-	 */
-	public function get_quarters() {
-
-		$year      = (int) gmdate( 'Y' );
-		$last_year = (int) $year - 1;
-		return array(
-
-			// Third quarter of previous year: July 1st to September 30th
-			array(
-				'before' => "{$last_year}-09-30",
-				'after'  => "{$last_year}-07-01",
-			),
-
-			// Last quarter of previous year: October 1st to December 31st
-			array(
-				'before' => "{$last_year}-12-31",
-        		'after'  => "{$last_year}-10-01",
-			),
-
-			// First quarter: January 1st to March 31st
-			array(
-				'before' => "{$year}-03-31",
-				'after'  => "{$year}-01-01",
-			),
-
-			// Second quarter: April 1st to June 30th
-			array(
-				'before' => "{$year}-06-30",
-				'after'  => "{$year}-04-01",
-			),
-
-			// Third quarter: July 1st to September 30th
-			array(
-				'before' => "{$year}-09-30",
-				'after'  => "{$year}-07-01",
-			),
-
-			// Fourth quarter: October 1st to December 31st
-			array(
-				'before' => "{$year}-12-31",
-				'after'  => "{$year}-10-01",
-			),
-		);
-	}
-
-	/**
-	 * Retrieves the current quater.
-	 *
-	 * @return int The current quarter.
-	 */
-	public function get_quarter() {
-
-		$month    = (int) gmdate( 'n' );
-		$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.
-		$quarter  = $this->get_quarter();
-		$quarters = $this->get_quarters();
-		return $quarters[ $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() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_year',
-		);
-
-		// Generate the report.
-		return array(
-			'after'  => gmdate( 'Y-01-01' ),
-			'before' => gmdate( 'Y-12-31' ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last year date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_year_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'after'  => gmdate( 'Y-01-01', strtotime( '-2 years' ) ),
-			'before' => gmdate( 'Y-12-31', strtotime( '-2 years' ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'after'  => gmdate( 'Y-01-01', strtotime( 'last year' ) ),
-			'before' => gmdate( 'Y-12-31', strtotime( 'last year' ) ),
-		);
-
-	}
-
-	/**
-	 * 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',
-				'validate_callback' => 'rest_validate_request_arg',
-				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => gmdate( 'Y-m-d', strtotime( '-7 days' ) ),
-			),
-			'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',
-				'validate_callback' => 'rest_validate_request_arg',
-				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => gmdate( 'Y-m-d' ),
-			),
-		);
-	}
+    /**
+     * 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 ) {
+
+        // Check if the period is x_days.
+        if ( preg_match( '/^(\d+)_days$/', $request['period'], $matches ) ) {
+            $date_range = $this->get_x_days_date_range( absint( $matches[1] ) );
+        } elseif ( is_callable( array( $this, 'get_' . $request['period'] . '_date_range' ) ) ) {
+            $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request );
+        } else {
+            $request['period'] = '7_days';
+            $date_range        = $this->get_x_days_date_range();
+        }
+
+        // 3 months max for day view.
+        $before = strtotime( $date_range['before'] );
+        $after  = strtotime( $date_range['after'] );
+        if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 2 ) {
+            $this->groupby = 'month';
+        }
+
+        $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'] );
+        $after  = strtotime( $range['after'] );
+        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( gmdate( '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 = gmdate( 'Y-m-d' );
+
+        if ( ! empty( $request['before'] ) ) {
+            $before  = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) );
+        }
+
+        // Set the previous date range.
+        $difference           = $before - $after;
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => gmdate( 'Y-m-d', $before - $difference - DAY_IN_SECONDS ),
+            'after'  => gmdate( 'Y-m-d', $after - $difference - DAY_IN_SECONDS ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => gmdate( 'Y-m-d', $before ),
+            'after'  => gmdate( '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' => gmdate( 'Y-m-d' ),
+            'after'  => gmdate( 'Y-m-d' ),
+        );
+
+    }
+
+    /**
+     * 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' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ),
+            'after'  => gmdate( 'Y-m-d', strtotime( '-2 days' ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ),
+            'after'  => gmdate( 'Y-m-d', strtotime( '-1 day' ) ),
+        );
+
+    }
+
+    /**
+     * 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.
+        $week_starts = absint( get_option( 'start_of_week' ) );
+        return array(
+            'before' => gmdate( 'Y-m-d' ),
+            'after'  => gmdate( 'Y-m-d', strtotime( 'next Sunday -' . ( 7 - $week_starts ) . ' days' ) ),
+        );
+    }
+
+    /**
+     * Retrieves last week's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_week_date_range() {
+
+        $week_starts = absint( get_option( 'start_of_week' ) );
+        $week_starts = strtotime( 'last Sunday -' . ( 7 - $week_starts ) . ' days' );
+        $date_range  = array(
+            'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ),
+            'after'  => gmdate( 'Y-m-d', $week_starts ),
+        );
+
+        // Set the previous date range.
+        $week_starts          = $week_starts - 7 * DAY_IN_SECONDS;
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ),
+            'after'  => gmdate( 'Y-m-d', $week_starts ),
+        );
+
+        // Generate the report.
+        return $date_range;
+    }
+
+    /**
+     * Retrieves last x days date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_x_days_date_range( $days = 7 ) {
+
+        $days--;
+
+        $date_range  = array(
+            'before' => gmdate( 'Y-m-d' ),
+            'after'  => gmdate( 'Y-m-d', strtotime( "-$days days" ) ),
+        );
+
+        $days++;
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => gmdate( 'Y-m-d', strtotime( $date_range['before'] ) - $days * DAY_IN_SECONDS ),
+            'after'  => gmdate( 'Y-m-d', strtotime( $date_range['after'] ) - $days * DAY_IN_SECONDS ),
+        );
+
+        // Generate the report.
+        return $date_range;
+    }
+
+    /**
+     * 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(
+            'after'  => gmdate( 'Y-m-01' ),
+            'before' => gmdate( 'Y-m-t' ),
+        );
+
+    }
+
+    /**
+     * 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',
+            'after'  => gmdate( 'Y-m-01', strtotime( '-2 months' ) ),
+            'before' => gmdate( 'Y-m-t', strtotime( '-2 months' ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'after'  => gmdate( 'Y-m-01', strtotime( 'last month' ) ),
+            'before' => gmdate( 'Y-m-t', strtotime( 'last month' ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves this quarter date range.
+     *
+     * @return array The available quarters.
+     */
+    public function get_quarters() {
+
+        $year      = (int) gmdate( 'Y' );
+        $last_year = (int) $year - 1;
+        return array(
+
+            // Third quarter of previous year: July 1st to September 30th
+            array(
+                'before' => "{$last_year}-09-30",
+                'after'  => "{$last_year}-07-01",
+            ),
+
+            // Last quarter of previous year: October 1st to December 31st
+            array(
+                'before' => "{$last_year}-12-31",
+                'after'  => "{$last_year}-10-01",
+            ),
+
+            // First quarter: January 1st to March 31st
+            array(
+                'before' => "{$year}-03-31",
+                'after'  => "{$year}-01-01",
+            ),
+
+            // Second quarter: April 1st to June 30th
+            array(
+                'before' => "{$year}-06-30",
+                'after'  => "{$year}-04-01",
+            ),
+
+            // Third quarter: July 1st to September 30th
+            array(
+                'before' => "{$year}-09-30",
+                'after'  => "{$year}-07-01",
+            ),
+
+            // Fourth quarter: October 1st to December 31st
+            array(
+                'before' => "{$year}-12-31",
+                'after'  => "{$year}-10-01",
+            ),
+        );
+    }
+
+    /**
+     * Retrieves the current quater.
+     *
+     * @return int The current quarter.
+     */
+    public function get_quarter() {
+
+        $month    = (int) gmdate( 'n' );
+        $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.
+        $quarter  = $this->get_quarter();
+        $quarters = $this->get_quarters();
+        return $quarters[ $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() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_year',
+        );
+
+        // Generate the report.
+        return array(
+            'after'  => gmdate( 'Y-01-01' ),
+            'before' => gmdate( 'Y-12-31' ),
+        );
+
+    }
+
+    /**
+     * Retrieves last year date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_year_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'after'  => gmdate( 'Y-01-01', strtotime( '-2 years' ) ),
+            'before' => gmdate( 'Y-12-31', strtotime( '-2 years' ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'after'  => gmdate( 'Y-01-01', strtotime( 'last year' ) ),
+            'before' => gmdate( 'Y-12-31', strtotime( 'last year' ) ),
+        );
+
+    }
+
+    /**
+     * 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',
+                'validate_callback' => 'rest_validate_request_arg',
+                'sanitize_callback' => 'sanitize_text_field',
+                'default'           => gmdate( 'Y-m-d', strtotime( '-7 days' ) ),
+            ),
+            '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',
+                'validate_callback' => 'rest_validate_request_arg',
+                'sanitize_callback' => 'sanitize_text_field',
+                'default'           => gmdate( 'Y-m-d' ),
+            ),
+        );
+    }
 }

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

Indentation +276 added lines, -276 removed lines

@@ -12,294 +12,294 @@
  */
 class GetPaid_Reports_Helper {
 
-	/**
-	 * Get report totals such as invoice totals and discount amounts.
-	 *
-	 * Data example:
-	 *
-	 * 'subtotal' => array(
-	 *     'type'     => 'invoice_data',
-	 *     'function' => 'SUM',
-	 *     'name'     => 'subtotal'
-	 * )
-	 *
-	 * @param  array $args
-	 * @return mixed depending on query_type
-	 */
-	public static function get_invoice_report_data( $args = array() ) {
-		global $wpdb;
-
-		$default_args = array(
-			'data'                  => array(), // The data to retrieve.
-			'where'                 => array(), // An array of where queries.
-			'query_type'            => 'get_row', // wpdb query to run.
-			'group_by'              => '', // What to group results by.
-			'order_by'              => '', // What to order by.
-			'limit'                 => '', // Results limit.
-			'filter_range'          => array(), // An array of before and after dates to limit results by.
-			'invoice_types'         => array( 'wpi_invoice' ), // An array of post types to retrieve.
-			'invoice_status'        => array( 'publish', 'wpi-processing', 'wpi-onhold' ),
-			'parent_invoice_status' => false, // Optionally filter by parent invoice status.
-		);
-
-		$args         = apply_filters( 'getpaid_reports_get_invoice_report_data_args', $args );
-		$args         = wp_parse_args( $args, $default_args );
-
-		extract( $args );
-
-		if ( empty( $data ) ) {
-			return '';
-		}
-
-		$query           = array();
-		$query['select'] = 'SELECT ' . implode( ',', self::prepare_invoice_data( $data ) );
-		$query['from']   = "FROM {$wpdb->posts} AS posts";
-		$query['join']   = implode( ' ', self::prepare_invoice_joins( $data + $where, ! empty( $parent_invoice_status ) ) );
-
-		$query['where']  = "
+    /**
+     * Get report totals such as invoice totals and discount amounts.
+     *
+     * Data example:
+     *
+     * 'subtotal' => array(
+     *     'type'     => 'invoice_data',
+     *     'function' => 'SUM',
+     *     'name'     => 'subtotal'
+     * )
+     *
+     * @param  array $args
+     * @return mixed depending on query_type
+     */
+    public static function get_invoice_report_data( $args = array() ) {
+        global $wpdb;
+
+        $default_args = array(
+            'data'                  => array(), // The data to retrieve.
+            'where'                 => array(), // An array of where queries.
+            'query_type'            => 'get_row', // wpdb query to run.
+            'group_by'              => '', // What to group results by.
+            'order_by'              => '', // What to order by.
+            'limit'                 => '', // Results limit.
+            'filter_range'          => array(), // An array of before and after dates to limit results by.
+            'invoice_types'         => array( 'wpi_invoice' ), // An array of post types to retrieve.
+            'invoice_status'        => array( 'publish', 'wpi-processing', 'wpi-onhold' ),
+            'parent_invoice_status' => false, // Optionally filter by parent invoice status.
+        );
+
+        $args         = apply_filters( 'getpaid_reports_get_invoice_report_data_args', $args );
+        $args         = wp_parse_args( $args, $default_args );
+
+        extract( $args );
+
+        if ( empty( $data ) ) {
+            return '';
+        }
+
+        $query           = array();
+        $query['select'] = 'SELECT ' . implode( ',', self::prepare_invoice_data( $data ) );
+        $query['from']   = "FROM {$wpdb->posts} AS posts";
+        $query['join']   = implode( ' ', self::prepare_invoice_joins( $data + $where, ! empty( $parent_invoice_status ) ) );
+
+        $query['where']  = "
 			WHERE 	posts.post_type 	IN ( '" . implode( "','", $invoice_types ) . "' )
 			";
 
-		if ( ! empty( $invoice_status ) ) {
-			$query['where'] .= "
+        if ( ! empty( $invoice_status ) ) {
+            $query['where'] .= "
 				AND 	posts.post_status 	IN ( '" . implode( "','", $invoice_status ) . "' )
 			";
-		}
-
-		if ( ! empty( $parent_invoice_status ) ) {
-			if ( ! empty( $invoice_status ) ) {
-				$query['where'] .= " AND ( parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) OR parent.ID IS NULL ) ";
-			} else {
-				$query['where'] .= " AND parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) ";
-			}
-		}
-
-		if ( ! empty( $filter_range['before'] ) ) {
-			$query['where'] .= "
+        }
+
+        if ( ! empty( $parent_invoice_status ) ) {
+            if ( ! empty( $invoice_status ) ) {
+                $query['where'] .= " AND ( parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) OR parent.ID IS NULL ) ";
+            } else {
+                $query['where'] .= " AND parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) ";
+            }
+        }
+
+        if ( ! empty( $filter_range['before'] ) ) {
+            $query['where'] .= "
 				AND 	posts.post_date <= '" . gmdate( 'Y-m-d 23:59:59', strtotime( $filter_range['before'] ) ) . "'
 			";
-		}
+        }
 
-		if ( ! empty( $filter_range['after'] ) ) {
-			$query['where'] .= "
+        if ( ! empty( $filter_range['after'] ) ) {
+            $query['where'] .= "
 				AND 	posts.post_date >= '" . gmdate( 'Y-m-d 00:00:00', strtotime( $filter_range['after'] ) ) . "'
 			";
-		}
+        }
 
-		if ( ! empty( $where ) ) {
+        if ( ! empty( $where ) ) {
 
-			foreach ( $where as $value ) {
+            foreach ( $where as $value ) {
 
-				if ( strtolower( $value['operator'] ) === 'in' || strtolower( $value['operator'] ) === 'not in' ) {
-
-					if ( is_array( $value['value'] ) ) {
-						$value['value'] = implode( "','", $value['value'] );
-					}
-
-					if ( ! empty( $value['value'] ) ) {
-						$where_value = "{$value['operator']} ('{$value['value']}')";
-					}
-				} else {
-					$where_value = "{$value['operator']} '{$value['value']}'";
-				}
-
-				if ( ! empty( $where_value ) ) {
-					$query['where'] .= " AND {$value['key']} {$where_value}";
-				}
-			}
-		}
-
-		if ( $group_by ) {
-			$query['group_by'] = "GROUP BY {$group_by}";
-		}
-
-		if ( $order_by ) {
-			$query['order_by'] = "ORDER BY {$order_by}";
-		}
-
-		if ( $limit ) {
-			$query['limit'] = "LIMIT {$limit}";
-		}
-
-		$query = apply_filters( 'getpaid_reports_get_invoice_report_query', $query, $data );
-		$query = implode( ' ', $query );
-
-		return self::execute( $query_type, $query );
-
-	}
-
-	/**
-	 * Prepares the data to select.
-	 *
-	 *
-	 * @param  array $data
-	 * @return array
-	 */
-	public static function prepare_invoice_data( $data ) {
-
-		$prepared = array();
-
-		foreach ( $data as $raw_key => $value ) {
-			$key      = sanitize_key( $raw_key );
-			$distinct = '';
-
-			if ( isset( $value['distinct'] ) ) {
-				$distinct = 'DISTINCT';
-			}
-
-			$get_key = self::get_invoice_table_key( $key, $value['type'] );
-
-			if ( false === $get_key ) {
-				// Skip to the next foreach iteration else the query will be invalid.
-				continue;
-			}
-
-			if ( ! empty( $value['function'] ) ) {
-				$get = "{$value['function']}({$distinct} {$get_key})";
-			} else {
-				$get = "{$distinct} {$get_key}";
-			}
-
-			$prepared[] = "{$get} as {$value['name']}";
-		}
-
-		return $prepared;
-
-	}
-
-	/**
-	 * Prepares the joins to use.
-	 *
-	 *
-	 * @param  array $data
-	 * @param  bool $with_parent
-	 * @return array
-	 */
-	public static function prepare_invoice_joins( $data, $with_parent ) {
-		global $wpdb;
-
-		$prepared = array();
-
-		foreach ( $data as $raw_key => $value ) {
-			$join_type = isset( $value['join_type'] ) ? $value['join_type'] : 'INNER';
-			$type      = isset( $value['type'] ) ? $value['type'] : false;
-			$key       = sanitize_key( $raw_key );
-
-			switch ( $type ) {
-				case 'meta':
-					$prepared[ "meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS meta_{$key} ON ( posts.ID = meta_{$key}.post_id AND meta_{$key}.meta_key = '{$raw_key}' )";
-					break;
-				case 'parent_meta':
-					$prepared[ "parent_meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS parent_meta_{$key} ON (posts.post_parent = parent_meta_{$key}.post_id) AND (parent_meta_{$key}.meta_key = '{$raw_key}')";
-					break;
-				case 'invoice_data':
-					$prepared['invoices'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoices AS invoices ON posts.ID = invoices.post_id";
-					break;
-				case 'invoice_item':
-					$prepared['invoice_items'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoice_items AS invoice_items ON posts.ID = invoice_items.post_id";
-					break;
-			}
-		}
-
-		if ( $with_parent ) {
-			$prepared['parent'] = "LEFT JOIN {$wpdb->posts} AS parent ON posts.post_parent = parent.ID";
-		}
-
-		return $prepared;
-
-	}
-
-	/**
-	 * Retrieves the appropriate table key to use.
-	 *
-	 *
-	 * @param  string $key
-	 * @param  string $table
-	 * @return string|false
-	 */
-	public static function get_invoice_table_key( $key, $table ) {
-
-		$keys = array(
-			'meta'         => "meta_{$key}.meta_value",
-			'parent_meta'  => "parent_meta_{$key}.meta_value",
-			'post_data'    => "posts.{$key}",
-			'invoice_data' => "invoices.{$key}",
-			'invoice_item' => "invoice_items.{$key}",
-		);
-
-		return isset( $keys[ $table ] ) ? $keys[ $table ] : false;
-
-	}
-
-	/**
-	 * Executes a query and caches the result for a minute.
-	 *
-	 *
-	 * @param  string $query_type
-	 * @param  string $query
-	 * @return mixed depending on query_type
-	 */
-	public static function execute( $query_type, $query ) {
-		global $wpdb;
-
-		$query_hash = md5( $query_type . $query );
-		$result     = self::get_cached_query( $query_hash );
-		if ( $result === false ) {
-			self::enable_big_selects();
-
-			$result = $wpdb->$query_type( $query );
-			self::set_cached_query( $query_hash, $result );
-		}
-
-		return $result;
-
-	}
-
-	/**
-	 * Enables big mysql selects for reports, just once for this session.
-	 */
-	protected static function enable_big_selects() {
-		static $big_selects = false;
-
-		global $wpdb;
-
-		if ( ! $big_selects ) {
-			$wpdb->query( 'SET SESSION SQL_BIG_SELECTS=1' );
-			$big_selects = true;
-		}
-	}
-
-	/**
-	 * Get the cached query result or null if it's not in the cache.
-	 *
-	 * @param string $query_hash The query hash.
-	 *
-	 * @return mixed|false The cache contents on success, false on failure to retrieve contents.
-	 */
-	protected static function get_cached_query( $query_hash ) {
-
-		return wp_cache_get(
-			$query_hash,
-			strtolower( __CLASS__ )
-		);
-
-	}
-
-	/**
-	 * Set the cached query result.
-	 *
-	 * @param string $query_hash The query hash.
-	 * @param mixed  $data The data to cache.
-	 */
-	protected static function set_cached_query( $query_hash, $data ) {
-
-		wp_cache_set(
-			$query_hash,
-			$data,
-			strtolower( __CLASS__ ),
-			MINUTE_IN_SECONDS
-		);
-
-	}
+                if ( strtolower( $value['operator'] ) === 'in' || strtolower( $value['operator'] ) === 'not in' ) {
+
+                    if ( is_array( $value['value'] ) ) {
+                        $value['value'] = implode( "','", $value['value'] );
+                    }
+
+                    if ( ! empty( $value['value'] ) ) {
+                        $where_value = "{$value['operator']} ('{$value['value']}')";
+                    }
+                } else {
+                    $where_value = "{$value['operator']} '{$value['value']}'";
+                }
+
+                if ( ! empty( $where_value ) ) {
+                    $query['where'] .= " AND {$value['key']} {$where_value}";
+                }
+            }
+        }
+
+        if ( $group_by ) {
+            $query['group_by'] = "GROUP BY {$group_by}";
+        }
+
+        if ( $order_by ) {
+            $query['order_by'] = "ORDER BY {$order_by}";
+        }
+
+        if ( $limit ) {
+            $query['limit'] = "LIMIT {$limit}";
+        }
+
+        $query = apply_filters( 'getpaid_reports_get_invoice_report_query', $query, $data );
+        $query = implode( ' ', $query );
+
+        return self::execute( $query_type, $query );
+
+    }
+
+    /**
+     * Prepares the data to select.
+     *
+     *
+     * @param  array $data
+     * @return array
+     */
+    public static function prepare_invoice_data( $data ) {
+
+        $prepared = array();
+
+        foreach ( $data as $raw_key => $value ) {
+            $key      = sanitize_key( $raw_key );
+            $distinct = '';
+
+            if ( isset( $value['distinct'] ) ) {
+                $distinct = 'DISTINCT';
+            }
+
+            $get_key = self::get_invoice_table_key( $key, $value['type'] );
+
+            if ( false === $get_key ) {
+                // Skip to the next foreach iteration else the query will be invalid.
+                continue;
+            }
+
+            if ( ! empty( $value['function'] ) ) {
+                $get = "{$value['function']}({$distinct} {$get_key})";
+            } else {
+                $get = "{$distinct} {$get_key}";
+            }
+
+            $prepared[] = "{$get} as {$value['name']}";
+        }
+
+        return $prepared;
+
+    }
+
+    /**
+     * Prepares the joins to use.
+     *
+     *
+     * @param  array $data
+     * @param  bool $with_parent
+     * @return array
+     */
+    public static function prepare_invoice_joins( $data, $with_parent ) {
+        global $wpdb;
+
+        $prepared = array();
+
+        foreach ( $data as $raw_key => $value ) {
+            $join_type = isset( $value['join_type'] ) ? $value['join_type'] : 'INNER';
+            $type      = isset( $value['type'] ) ? $value['type'] : false;
+            $key       = sanitize_key( $raw_key );
+
+            switch ( $type ) {
+                case 'meta':
+                    $prepared[ "meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS meta_{$key} ON ( posts.ID = meta_{$key}.post_id AND meta_{$key}.meta_key = '{$raw_key}' )";
+                    break;
+                case 'parent_meta':
+                    $prepared[ "parent_meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS parent_meta_{$key} ON (posts.post_parent = parent_meta_{$key}.post_id) AND (parent_meta_{$key}.meta_key = '{$raw_key}')";
+                    break;
+                case 'invoice_data':
+                    $prepared['invoices'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoices AS invoices ON posts.ID = invoices.post_id";
+                    break;
+                case 'invoice_item':
+                    $prepared['invoice_items'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoice_items AS invoice_items ON posts.ID = invoice_items.post_id";
+                    break;
+            }
+        }
+
+        if ( $with_parent ) {
+            $prepared['parent'] = "LEFT JOIN {$wpdb->posts} AS parent ON posts.post_parent = parent.ID";
+        }
+
+        return $prepared;
+
+    }
+
+    /**
+     * Retrieves the appropriate table key to use.
+     *
+     *
+     * @param  string $key
+     * @param  string $table
+     * @return string|false
+     */
+    public static function get_invoice_table_key( $key, $table ) {
+
+        $keys = array(
+            'meta'         => "meta_{$key}.meta_value",
+            'parent_meta'  => "parent_meta_{$key}.meta_value",
+            'post_data'    => "posts.{$key}",
+            'invoice_data' => "invoices.{$key}",
+            'invoice_item' => "invoice_items.{$key}",
+        );
+
+        return isset( $keys[ $table ] ) ? $keys[ $table ] : false;
+
+    }
+
+    /**
+     * Executes a query and caches the result for a minute.
+     *
+     *
+     * @param  string $query_type
+     * @param  string $query
+     * @return mixed depending on query_type
+     */
+    public static function execute( $query_type, $query ) {
+        global $wpdb;
+
+        $query_hash = md5( $query_type . $query );
+        $result     = self::get_cached_query( $query_hash );
+        if ( $result === false ) {
+            self::enable_big_selects();
+
+            $result = $wpdb->$query_type( $query );
+            self::set_cached_query( $query_hash, $result );
+        }
+
+        return $result;
+
+    }
+
+    /**
+     * Enables big mysql selects for reports, just once for this session.
+     */
+    protected static function enable_big_selects() {
+        static $big_selects = false;
+
+        global $wpdb;
+
+        if ( ! $big_selects ) {
+            $wpdb->query( 'SET SESSION SQL_BIG_SELECTS=1' );
+            $big_selects = true;
+        }
+    }
+
+    /**
+     * Get the cached query result or null if it's not in the cache.
+     *
+     * @param string $query_hash The query hash.
+     *
+     * @return mixed|false The cache contents on success, false on failure to retrieve contents.
+     */
+    protected static function get_cached_query( $query_hash ) {
+
+        return wp_cache_get(
+            $query_hash,
+            strtolower( __CLASS__ )
+        );
+
+    }
+
+    /**
+     * Set the cached query result.
+     *
+     * @param string $query_hash The query hash.
+     * @param mixed  $data The data to cache.
+     */
+    protected static function set_cached_query( $query_hash, $data ) {
+
+        wp_cache_set(
+            $query_hash,
+            $data,
+            strtolower( __CLASS__ ),
+            MINUTE_IN_SECONDS
+        );
+
+    }
 
 }

includes/subscription-functions.php

Indentation +323 added lines, -323 removed lines

@@ -50,7 +50,7 @@ 
  */
 function getpaid_get_invoice_subscription_group( $invoice_id, $subscription_id ) {
     $subscription_groups = getpaid_get_invoice_subscription_groups( $invoice_id );
-	$matching_group      = wp_list_filter( $subscription_groups, compact( 'subscription_id' ) );
+    $matching_group      = wp_list_filter( $subscription_groups, compact( 'subscription_id' ) );
     return reset( $matching_group );
 }
 
@@ -63,11 +63,11 @@ 
  */
 function getpaid_get_subscription( $subscription ) {
 
-	if ( ! is_a( $subscription, 'WPInv_Subscription' ) ) {
-		$subscription = new WPInv_Subscription( $subscription );
-	}
+    if ( ! is_a( $subscription, 'WPInv_Subscription' ) ) {
+        $subscription = new WPInv_Subscription( $subscription );
+    }
 
-	return $subscription->exists() ? $subscription : false;
+    return $subscription->exists() ? $subscription : false;
 }
 
 /**
@@ -81,28 +81,28 @@ 
  */
 function getpaid_get_subscriptions( $args = array(), $return = 'results' ) {
 
-	// Do not retrieve all fields if we just want the count.
-	if ( 'count' == $return ) {
-		$args['fields'] = 'id';
-		$args['number'] = 1;
-	}
+    // Do not retrieve all fields if we just want the count.
+    if ( 'count' == $return ) {
+        $args['fields'] = 'id';
+        $args['number'] = 1;
+    }
 
-	// Do not count all matches if we just want the results.
-	if ( 'results' == $return ) {
-		$args['count_total'] = false;
-	}
+    // Do not count all matches if we just want the results.
+    if ( 'results' == $return ) {
+        $args['count_total'] = false;
+    }
 
-	$query = new GetPaid_Subscriptions_Query( $args );
+    $query = new GetPaid_Subscriptions_Query( $args );
 
-	if ( 'results' == $return ) {
-		return $query->get_results();
-	}
+    if ( 'results' == $return ) {
+        return $query->get_results();
+    }
 
-	if ( 'count' == $return ) {
-		return $query->get_total();
-	}
+    if ( 'count' == $return ) {
+        return $query->get_total();
+    }
 
-	return $query;
+    return $query;
 }
 
 /**
@@ -112,18 +112,18 @@ 
  */
 function getpaid_get_subscription_statuses() {
 
-	return apply_filters(
-		'getpaid_get_subscription_statuses',
-		array(
-			'pending'   => __( 'Pending', 'invoicing' ),
-			'trialling' => __( 'Trialing', 'invoicing' ),
-			'active'    => __( 'Active', 'invoicing' ),
-			'failing'   => __( 'Failing', 'invoicing' ),
-			'expired'   => __( 'Expired', 'invoicing' ),
-			'completed' => __( 'Complete', 'invoicing' ),
-			'cancelled' => __( 'Cancelled', 'invoicing' ),
-		)
-	);
+    return apply_filters(
+        'getpaid_get_subscription_statuses',
+        array(
+            'pending'   => __( 'Pending', 'invoicing' ),
+            'trialling' => __( 'Trialing', 'invoicing' ),
+            'active'    => __( 'Active', 'invoicing' ),
+            'failing'   => __( 'Failing', 'invoicing' ),
+            'expired'   => __( 'Expired', 'invoicing' ),
+            'completed' => __( 'Complete', 'invoicing' ),
+            'cancelled' => __( 'Cancelled', 'invoicing' ),
+        )
+    );
 
 }
 
@@ -133,8 +133,8 @@ 
  * @return string
  */
 function getpaid_get_subscription_status_label( $status ) {
-	$statuses = getpaid_get_subscription_statuses();
-	return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) );
+    $statuses = getpaid_get_subscription_statuses();
+    return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) );
 }
 
 /**
@@ -144,18 +144,18 @@ 
  */
 function getpaid_get_subscription_status_classes() {
 
-	return apply_filters(
-		'getpaid_get_subscription_status_classes',
-		array(
-			'pending'   => 'bg-dark',
-			'trialling' => 'bg-info',
-			'active'    => 'bg-success',
-			'failing'   => 'bg-warning text-dark',
-			'expired'   => 'bg-danger',
-			'completed' => 'bg-primary',
-			'cancelled' => 'bg-secondary',
-		)
-	);
+    return apply_filters(
+        'getpaid_get_subscription_status_classes',
+        array(
+            'pending'   => 'bg-dark',
+            'trialling' => 'bg-info',
+            'active'    => 'bg-success',
+            'failing'   => 'bg-warning text-dark',
+            'expired'   => 'bg-danger',
+            'completed' => 'bg-primary',
+            'cancelled' => 'bg-secondary',
+        )
+    );
 
 }
 
@@ -166,15 +166,15 @@ 
  */
 function getpaid_get_subscription_status_counts( $args = array() ) {
 
-	$statuses = array_keys( getpaid_get_subscription_statuses() );
-	$counts   = array();
+    $statuses = array_keys( getpaid_get_subscription_statuses() );
+    $counts   = array();
 
-	foreach ( $statuses as $status ) {
-		$_args             = wp_parse_args( "status=$status", $args );
-		$counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' );
-	}
+    foreach ( $statuses as $status ) {
+        $_args             = wp_parse_args( "status=$status", $args );
+        $counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' );
+    }
 
-	return $counts;
+    return $counts;
 
 }
 
@@ -185,32 +185,32 @@ 
  */
 function getpaid_get_subscription_periods() {
 
-	return apply_filters(
-		'getpaid_get_subscription_periods',
-		array(
+    return apply_filters(
+        'getpaid_get_subscription_periods',
+        array(
 
-			'day'   => array(
-				'singular' => __( '%s day', 'invoicing' ),
-				'plural'   => __( '%d days', 'invoicing' ),
-			),
+            'day'   => array(
+                'singular' => __( '%s day', 'invoicing' ),
+                'plural'   => __( '%d days', 'invoicing' ),
+            ),
 
-			'week'  => array(
-				'singular' => __( '%s week', 'invoicing' ),
-				'plural'   => __( '%d weeks', 'invoicing' ),
-			),
+            'week'  => array(
+                'singular' => __( '%s week', 'invoicing' ),
+                'plural'   => __( '%d weeks', 'invoicing' ),
+            ),
 
-			'month' => array(
-				'singular' => __( '%s month', 'invoicing' ),
-				'plural'   => __( '%d months', 'invoicing' ),
-			),
+            'month' => array(
+                'singular' => __( '%s month', 'invoicing' ),
+                'plural'   => __( '%d months', 'invoicing' ),
+            ),
 
-			'year'  => array(
-				'singular' => __( '%s year', 'invoicing' ),
-				'plural'   => __( '%d years', 'invoicing' ),
-			),
+            'year'  => array(
+                'singular' => __( '%s year', 'invoicing' ),
+                'plural'   => __( '%d years', 'invoicing' ),
+            ),
 
-		)
-	);
+        )
+    );
 
 }
 
@@ -221,7 +221,7 @@ 
  * @return int
  */
 function getpaid_get_subscription_trial_period_interval( $trial_period ) {
-	return (int) preg_replace( '/[^0-9]/', '', $trial_period );
+    return (int) preg_replace( '/[^0-9]/', '', $trial_period );
 }
 
 /**
@@ -231,7 +231,7 @@ 
  * @return string
  */
 function getpaid_get_subscription_trial_period_period( $trial_period ) {
-	return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) );
+    return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) );
 }
 
 /**
@@ -242,8 +242,8 @@ 
  * @return string
  */
 function getpaid_get_subscription_period_label( $period, $interval = 1, $singular_prefix = '1' ) {
-	$label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label( $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix );
-	return strtolower( sanitize_text_field( $label ) );
+    $label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label( $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix );
+    return strtolower( sanitize_text_field( $label ) );
 }
 
 /**
@@ -254,22 +254,22 @@ 
  */
 function getpaid_get_singular_subscription_period_label( $period, $singular_prefix = '1' ) {
 
-	$periods = getpaid_get_subscription_periods();
-	$period  = strtolower( $period );
+    $periods = getpaid_get_subscription_periods();
+    $period  = strtolower( $period );
 
-	if ( isset( $periods[ $period ] ) ) {
-		return sprintf( $periods[ $period ]['singular'], $singular_prefix );
-	}
+    if ( isset( $periods[ $period ] ) ) {
+        return sprintf( $periods[ $period ]['singular'], $singular_prefix );
+    }
 
-	// Backwards compatibility.
-	foreach ( $periods as $key => $data ) {
-		if ( strpos( $key, $period ) === 0 ) {
-			return sprintf( $data['singular'], $singular_prefix );
-		}
-	}
+    // Backwards compatibility.
+    foreach ( $periods as $key => $data ) {
+        if ( strpos( $key, $period ) === 0 ) {
+            return sprintf( $data['singular'], $singular_prefix );
+        }
+    }
 
-	// Invalid string.
-	return '';
+    // Invalid string.
+    return '';
 }
 
 /**
@@ -281,22 +281,22 @@ 
  */
 function getpaid_get_plural_subscription_period_label( $period, $interval ) {
 
-	$periods = getpaid_get_subscription_periods();
-	$period  = strtolower( $period );
+    $periods = getpaid_get_subscription_periods();
+    $period  = strtolower( $period );
 
-	if ( isset( $periods[ $period ] ) ) {
-		return sprintf( $periods[ $period ]['plural'], $interval );
-	}
+    if ( isset( $periods[ $period ] ) ) {
+        return sprintf( $periods[ $period ]['plural'], $interval );
+    }
 
-	// Backwards compatibility.
-	foreach ( $periods as $key => $data ) {
-		if ( strpos( $key, $period ) === 0 ) {
-			return sprintf( $data['plural'], $interval );
-		}
-	}
+    // Backwards compatibility.
+    foreach ( $periods as $key => $data ) {
+        if ( strpos( $key, $period ) === 0 ) {
+            return sprintf( $data['plural'], $interval );
+        }
+    }
 
-	// Invalid string.
-	return '';
+    // Invalid string.
+    return '';
 }
 
 /**
@@ -307,92 +307,92 @@ 
  */
 function getpaid_get_formatted_subscription_amount( $subscription ) {
 
-	$initial    = wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() );
-	$recurring  = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() );
-	$period     = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
-	$bill_times = $subscription->get_bill_times();
-	$bill_times_less = $bill_times - 1;
-
-	if ( ! empty( $bill_times ) ) {
-		$bill_times = $subscription->get_frequency() * $bill_times;
-		$bill_times_less = getpaid_get_subscription_period_label( $subscription->get_frequency(), $bill_times - $subscription->get_frequency() );
-		$bill_times = getpaid_get_subscription_period_label( $subscription->get_period(), $bill_times );
-	}
-
-	// Trial periods.
-	if ( $subscription->has_trial_period() ) {
-
-		$trial_period   = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() );
-		$trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() );
-
-		if ( empty( $bill_times ) ) {
-
-			return sprintf(
-				// translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period
-				_x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ),
-				$initial,
-				getpaid_get_subscription_period_label( $trial_period, $trial_interval ),
-				$recurring,
-				$period
-			);
-
-		}
-
-		return sprintf(
-			// translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period, $5: is the bill times
-			_x( '%1$s trial for %2$s then %3$s / %4$s for %5$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year for 4 years)', 'invoicing' ),
-			$initial,
-			getpaid_get_subscription_period_label( $trial_period, $trial_interval ),
-			$recurring,
-			$period,
-			$bill_times
-		);
-
-	}
-
-	if ( $initial != $recurring ) {
-
-		if ( empty( $bill_times ) ) {
-
-			return sprintf(
-				// translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period
-				_x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ),
-				$initial,
-				$recurring,
-				$period
-			);
-
-		}
-
-		return sprintf(
-			// translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period, $4: is the bill times
-			_x( 'Initial payment of %1$s which renews at %2$s / %3$s for %4$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year for 5 years)', 'invoicing' ),
-			$initial,
-			$recurring,
-			$period,
-			$bill_times_less
-		);
-
-	}
-
-	if ( empty( $bill_times ) ) {
-
-		return sprintf(
-			// translators: $1: is the recurring amount, $2: is the recurring period
-			_x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ),
-			$initial,
-			$period
-		);
-
-	}
-
-	return sprintf(
-		// translators: $1: is the bill times, $2: is the recurring amount, $3: is the recurring period
-		_x( '%2$s / %3$s for %1$s', 'Subscription amount. (e.g.: $120 / year for 5 years)', 'invoicing' ),
-		$bill_times,
-		$initial,
-		$period
-	);
+    $initial    = wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() );
+    $recurring  = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() );
+    $period     = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
+    $bill_times = $subscription->get_bill_times();
+    $bill_times_less = $bill_times - 1;
+
+    if ( ! empty( $bill_times ) ) {
+        $bill_times = $subscription->get_frequency() * $bill_times;
+        $bill_times_less = getpaid_get_subscription_period_label( $subscription->get_frequency(), $bill_times - $subscription->get_frequency() );
+        $bill_times = getpaid_get_subscription_period_label( $subscription->get_period(), $bill_times );
+    }
+
+    // Trial periods.
+    if ( $subscription->has_trial_period() ) {
+
+        $trial_period   = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() );
+        $trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() );
+
+        if ( empty( $bill_times ) ) {
+
+            return sprintf(
+                // translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period
+                _x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ),
+                $initial,
+                getpaid_get_subscription_period_label( $trial_period, $trial_interval ),
+                $recurring,
+                $period
+            );
+
+        }
+
+        return sprintf(
+            // translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period, $5: is the bill times
+            _x( '%1$s trial for %2$s then %3$s / %4$s for %5$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year for 4 years)', 'invoicing' ),
+            $initial,
+            getpaid_get_subscription_period_label( $trial_period, $trial_interval ),
+            $recurring,
+            $period,
+            $bill_times
+        );
+
+    }
+
+    if ( $initial != $recurring ) {
+
+        if ( empty( $bill_times ) ) {
+
+            return sprintf(
+                // translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period
+                _x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ),
+                $initial,
+                $recurring,
+                $period
+            );
+
+        }
+
+        return sprintf(
+            // translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period, $4: is the bill times
+            _x( 'Initial payment of %1$s which renews at %2$s / %3$s for %4$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year for 5 years)', 'invoicing' ),
+            $initial,
+            $recurring,
+            $period,
+            $bill_times_less
+        );
+
+    }
+
+    if ( empty( $bill_times ) ) {
+
+        return sprintf(
+            // translators: $1: is the recurring amount, $2: is the recurring period
+            _x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ),
+            $initial,
+            $period
+        );
+
+    }
+
+    return sprintf(
+        // translators: $1: is the bill times, $2: is the recurring amount, $3: is the recurring period
+        _x( '%2$s / %3$s for %1$s', 'Subscription amount. (e.g.: $120 / year for 5 years)', 'invoicing' ),
+        $bill_times,
+        $initial,
+        $period
+    );
 
 }
 
@@ -403,7 +403,7 @@ 
  * @return WPInv_Subscription|false
  */
 function getpaid_get_invoice_subscription( $invoice ) {
-	return getpaid_subscriptions()->get_invoice_subscription( $invoice );
+    return getpaid_subscriptions()->get_invoice_subscription( $invoice );
 }
 
 /**
@@ -412,10 +412,10 @@ 
  * @param WPInv_Invoice $invoice
  */
 function getpaid_activate_invoice_subscription( $invoice ) {
-	$subscription = getpaid_get_invoice_subscription( $invoice );
-	if ( is_a( $subscription, 'WPInv_Subscription' ) ) {
-		$subscription->activate();
-	}
+    $subscription = getpaid_get_invoice_subscription( $invoice );
+    if ( is_a( $subscription, 'WPInv_Subscription' ) ) {
+        $subscription->activate();
+    }
 }
 
 /**
@@ -424,7 +424,7 @@ 
  * @return WPInv_Subscriptions
  */
 function getpaid_subscriptions() {
-	return getpaid()->get( 'subscriptions' );
+    return getpaid()->get( 'subscriptions' );
 }
 
 /**
@@ -443,15 +443,15 @@ 
         return false;
     }
 
-	// Fetch the invoice subscription.
-	$subscription = getpaid_get_subscriptions(
-		array(
-			'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(),
-			'number'     => 1,
-		)
-	);
+    // Fetch the invoice subscription.
+    $subscription = getpaid_get_subscriptions(
+        array(
+            'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(),
+            'number'     => 1,
+        )
+    );
 
-	return empty( $subscription ) ? false : $subscription[0];
+    return empty( $subscription ) ? false : $subscription[0];
 
 }
 
@@ -468,48 +468,48 @@ 
  */
 function getpaid_get_recurring_item_key( $cart_item ) {
 
-	$cart_key     = 'renews_';
-	$interval     = $cart_item->get_recurring_interval();
-	$period       = $cart_item->get_recurring_period( true );
-	$length       = $cart_item->get_recurring_limit() * $interval;
-	$trial_period = $cart_item->get_trial_period( true );
-	$trial_length = $cart_item->get_trial_interval();
-
-	// First start with the billing interval and period
-	switch ( $interval ) {
-		case 1:
-			if ( 'day' == $period ) {
-				$cart_key .= 'daily';
-			} else {
-				$cart_key .= sprintf( '%sly', $period );
-			}
-			break;
-		case 2:
-			$cart_key .= sprintf( 'every_2nd_%s', $period );
-			break;
-		case 3:
-			$cart_key .= sprintf( 'every_3rd_%s', $period );
-		    break;
-		default:
-			$cart_key .= sprintf( 'every_%dth_%s', $interval, $period );
-			break;
-	}
-
-	// Maybe add the optional maximum billing periods...
-	if ( $length > 0 ) {
-		$cart_key .= '_for_';
-		$cart_key .= sprintf( '%d_%s', $length, $period );
-		if ( $length > 1 ) {
-			$cart_key .= 's';
-		}
-	}
-
-	// And an optional free trial.
-	if ( $cart_item->has_free_trial() ) {
-		$cart_key .= sprintf( '_after_a_%d_%s_trial', $trial_length, $trial_period );
-	}
-
-	return apply_filters( 'getpaid_get_recurring_item_key', $cart_key, $cart_item );
+    $cart_key     = 'renews_';
+    $interval     = $cart_item->get_recurring_interval();
+    $period       = $cart_item->get_recurring_period( true );
+    $length       = $cart_item->get_recurring_limit() * $interval;
+    $trial_period = $cart_item->get_trial_period( true );
+    $trial_length = $cart_item->get_trial_interval();
+
+    // First start with the billing interval and period
+    switch ( $interval ) {
+        case 1:
+            if ( 'day' == $period ) {
+                $cart_key .= 'daily';
+            } else {
+                $cart_key .= sprintf( '%sly', $period );
+            }
+            break;
+        case 2:
+            $cart_key .= sprintf( 'every_2nd_%s', $period );
+            break;
+        case 3:
+            $cart_key .= sprintf( 'every_3rd_%s', $period );
+            break;
+        default:
+            $cart_key .= sprintf( 'every_%dth_%s', $interval, $period );
+            break;
+    }
+
+    // Maybe add the optional maximum billing periods...
+    if ( $length > 0 ) {
+        $cart_key .= '_for_';
+        $cart_key .= sprintf( '%d_%s', $length, $period );
+        if ( $length > 1 ) {
+            $cart_key .= 's';
+        }
+    }
+
+    // And an optional free trial.
+    if ( $cart_item->has_free_trial() ) {
+        $cart_key .= sprintf( '_after_a_%d_%s_trial', $trial_length, $trial_period );
+    }
+
+    return apply_filters( 'getpaid_get_recurring_item_key', $cart_key, $cart_item );
 }
 
 /**
@@ -520,16 +520,16 @@ 
  */
 function getpaid_get_subscription_groups( $invoice ) {
 
-	// Generate subscription groups.
-	$subscription_groups = array();
-	foreach ( $invoice->get_items() as $item ) {
+    // Generate subscription groups.
+    $subscription_groups = array();
+    foreach ( $invoice->get_items() as $item ) {
 
-		if ( $item->is_recurring() ) {
-			$subscription_groups[ getpaid_get_recurring_item_key( $item ) ][] = $item;
-		}
+        if ( $item->is_recurring() ) {
+            $subscription_groups[ getpaid_get_recurring_item_key( $item ) ][] = $item;
+        }
 }
 
-	return $subscription_groups;
+    return $subscription_groups;
 }
 
 /**
@@ -543,56 +543,56 @@ 
  */
 function getpaid_calculate_subscription_totals( $invoice ) {
 
-	// Generate subscription groups.
-	$subscription_groups = getpaid_get_subscription_groups( $invoice );
+    // Generate subscription groups.
+    $subscription_groups = getpaid_get_subscription_groups( $invoice );
 
-	// Now let's calculate the totals for each group of subscriptions
-	$subscription_totals = array();
+    // Now let's calculate the totals for each group of subscriptions
+    $subscription_totals = array();
 
-	foreach ( $subscription_groups as $subscription_key => $items ) {
+    foreach ( $subscription_groups as $subscription_key => $items ) {
 
-		if ( empty( $subscription_totals[ $subscription_key ] ) ) {
+        if ( empty( $subscription_totals[ $subscription_key ] ) ) {
 
-			$subscription_totals[ $subscription_key ] = array(
-				'initial_total'   => 0,
-				'recurring_total' => 0,
-				'items'           => array(),
-				'trialling'       => false,
-			);
+            $subscription_totals[ $subscription_key ] = array(
+                'initial_total'   => 0,
+                'recurring_total' => 0,
+                'items'           => array(),
+                'trialling'       => false,
+            );
 
-		}
+        }
 
-		/**
-		 * Get the totals of the group.
-		 * @var GetPaid_Form_Item $item
-		 */
-		foreach ( $items as $item ) {
+        /**
+         * Get the totals of the group.
+         * @var GetPaid_Form_Item $item
+         */
+        foreach ( $items as $item ) {
 
-			$subscription_totals[ $subscription_key ]['items'][ $item->get_id() ]  = $item->prepare_data_for_saving();
-			$subscription_totals[ $subscription_key ]['item_id']                 = $item->get_id();
-			$subscription_totals[ $subscription_key ]['period']                  = $item->get_recurring_period( true );
-			$subscription_totals[ $subscription_key ]['interval']                = $item->get_recurring_interval();
-			$subscription_totals[ $subscription_key ]['initial_total']          += $item->get_sub_total() + $item->item_tax - $item->item_discount;
-			$subscription_totals[ $subscription_key ]['recurring_total']        += $item->get_recurring_sub_total() + $item->item_tax - $item->recurring_item_discount;
-			$subscription_totals[ $subscription_key ]['recurring_limit']         = $item->get_recurring_limit();
+            $subscription_totals[ $subscription_key ]['items'][ $item->get_id() ]  = $item->prepare_data_for_saving();
+            $subscription_totals[ $subscription_key ]['item_id']                 = $item->get_id();
+            $subscription_totals[ $subscription_key ]['period']                  = $item->get_recurring_period( true );
+            $subscription_totals[ $subscription_key ]['interval']                = $item->get_recurring_interval();
+            $subscription_totals[ $subscription_key ]['initial_total']          += $item->get_sub_total() + $item->item_tax - $item->item_discount;
+            $subscription_totals[ $subscription_key ]['recurring_total']        += $item->get_recurring_sub_total() + $item->item_tax - $item->recurring_item_discount;
+            $subscription_totals[ $subscription_key ]['recurring_limit']         = $item->get_recurring_limit();
 
-			// Calculate the next renewal date.
-			$period       = $item->get_recurring_period( true );
-			$interval     = $item->get_recurring_interval();
+            // Calculate the next renewal date.
+            $period       = $item->get_recurring_period( true );
+            $interval     = $item->get_recurring_interval();
 
-			// If the subscription item has a trial period...
-			if ( $item->has_free_trial() ) {
-				$period   = $item->get_trial_period( true );
-				$interval = $item->get_trial_interval();
-				$subscription_totals[ $subscription_key ]['trialling'] = $interval . ' ' . $period;
-			}
+            // If the subscription item has a trial period...
+            if ( $item->has_free_trial() ) {
+                $period   = $item->get_trial_period( true );
+                $interval = $item->get_trial_interval();
+                $subscription_totals[ $subscription_key ]['trialling'] = $interval . ' ' . $period;
+            }
 
-			$subscription_totals[ $subscription_key ]['renews_on'] = date( 'Y-m-d H:i:s', strtotime( "+$interval $period", current_time( 'timestamp' ) ) );
+            $subscription_totals[ $subscription_key ]['renews_on'] = date( 'Y-m-d H:i:s', strtotime( "+$interval $period", current_time( 'timestamp' ) ) );
 
-		}
+        }
 }
 
-	return apply_filters( 'getpaid_calculate_subscription_totals', $subscription_totals, $invoice );
+    return apply_filters( 'getpaid_calculate_subscription_totals', $subscription_totals, $invoice );
 }
 
 /**
@@ -603,16 +603,16 @@ 
  */
 function getpaid_should_group_subscriptions( $invoice ) {
 
-	$recurring_items = 0;
+    $recurring_items = 0;
 
-	foreach ( $invoice->get_items() as $item ) {
+    foreach ( $invoice->get_items() as $item ) {
 
-		if ( $item->is_recurring() ) {
-			$recurring_items ++;
-		}
+        if ( $item->is_recurring() ) {
+            $recurring_items ++;
+        }
 }
 
-	return apply_filters( 'getpaid_should_group_subscriptions', $recurring_items > 1, $invoice );
+    return apply_filters( 'getpaid_should_group_subscriptions', $recurring_items > 1, $invoice );
 }
 
 /**
@@ -623,39 +623,39 @@ 
  * @return int
  */
 function getpaid_count_subscription_invoices( $parent_invoice_id, $subscription_id = false ) {
-	global $wpdb;
+    global $wpdb;
 
-	$parent_invoice_id = (int) $parent_invoice_id;
+    $parent_invoice_id = (int) $parent_invoice_id;
 
-	if ( false === $subscription_id || ! (bool) get_post_meta( $parent_invoice_id, '_wpinv_subscription_id', true ) ) {
+    if ( false === $subscription_id || ! (bool) get_post_meta( $parent_invoice_id, '_wpinv_subscription_id', true ) ) {
 
-		return (int) $wpdb->get_var(
-			$wpdb->prepare(
-				"SELECT COUNT(ID) FROM $wpdb->posts WHERE ( post_parent=%d OR ID=%d ) AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )",
-				$parent_invoice_id,
-				$parent_invoice_id
-			)
-		);
+        return (int) $wpdb->get_var(
+            $wpdb->prepare(
+                "SELECT COUNT(ID) FROM $wpdb->posts WHERE ( post_parent=%d OR ID=%d ) AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )",
+                $parent_invoice_id,
+                $parent_invoice_id
+            )
+        );
 
-	}
+    }
 
-	$invoice_ids = $wpdb->get_col(
-		$wpdb->prepare(
-			"SELECT ID FROM $wpdb->posts WHERE ( post_parent=%d OR ID=%d ) AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )",
-			$parent_invoice_id,
-			$parent_invoice_id
-		)
-	);
+    $invoice_ids = $wpdb->get_col(
+        $wpdb->prepare(
+            "SELECT ID FROM $wpdb->posts WHERE ( post_parent=%d OR ID=%d ) AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )",
+            $parent_invoice_id,
+            $parent_invoice_id
+        )
+    );
 
-	$count = 0;
+    $count = 0;
 
-	foreach ( wp_parse_id_list( $invoice_ids ) as $invoice_id ) {
+    foreach ( wp_parse_id_list( $invoice_ids ) as $invoice_id ) {
 
-		if ( $invoice_id == $parent_invoice_id || $subscription_id == (int) get_post_meta( $invoice_id, '_wpinv_subscription_id', true ) ) {
-			$count ++;
-			continue;
-		}
+        if ( $invoice_id == $parent_invoice_id || $subscription_id == (int) get_post_meta( $invoice_id, '_wpinv_subscription_id', true ) ) {
+            $count ++;
+            continue;
+        }
 }
 
-	return $count;
+    return $count;
 }

includes/invoice-functions.php

Indentation +37 added lines, -37 removed lines

@@ -67,7 +67,7 @@ 
  * Checks if the current user cna view an invoice receipt.
  */
 function wpinv_can_view_receipt( $invoice ) {
-	return (bool) apply_filters( 'wpinv_can_view_receipt', wpinv_user_can_view_invoice( $invoice ), $invoice );
+    return (bool) apply_filters( 'wpinv_can_view_receipt', wpinv_user_can_view_invoice( $invoice ), $invoice );
 }
 
 /**
@@ -556,37 +556,37 @@ 
     $label   = empty( $label ) ? __( 'Invoice', 'invoicing' ) : sanitize_text_field( $label );
     $columns = array(
 
-		'invoice-number'  => array(
-			'title' => $label,
-			'class' => 'text-left',
-		),
+        'invoice-number'  => array(
+            'title' => $label,
+            'class' => 'text-left',
+        ),
 
-		'created-date'    => array(
-			'title' => __( 'Created Date', 'invoicing' ),
-			'class' => 'text-left',
-		),
+        'created-date'    => array(
+            'title' => __( 'Created Date', 'invoicing' ),
+            'class' => 'text-left',
+        ),
 
-		'payment-date'    => array(
-			'title' => __( 'Payment Date', 'invoicing' ),
-			'class' => 'text-left',
-		),
+        'payment-date'    => array(
+            'title' => __( 'Payment Date', 'invoicing' ),
+            'class' => 'text-left',
+        ),
 
-		'invoice-status'  => array(
-			'title' => __( 'Status', 'invoicing' ),
-			'class' => 'text-center',
-		),
+        'invoice-status'  => array(
+            'title' => __( 'Status', 'invoicing' ),
+            'class' => 'text-center',
+        ),
 
-		'invoice-total'   => array(
-			'title' => __( 'Total', 'invoicing' ),
-			'class' => 'text-right',
-		),
+        'invoice-total'   => array(
+            'title' => __( 'Total', 'invoicing' ),
+            'class' => 'text-right',
+        ),
 
-		'invoice-actions' => array(
-			'title' => ' ',
-			'class' => 'text-center',
-		),
+        'invoice-actions' => array(
+            'title' => ' ',
+            'class' => 'text-center',
+        ),
 
-	);
+    );
 
     return apply_filters( 'wpinv_user_invoices_columns', $columns, $post_type );
 }
@@ -1274,22 +1274,22 @@ 
  */
 function getpaid_get_invoice_status_classes() {
 
-	return apply_filters(
-		'getpaid_get_invoice_status_classes',
-		array(
+    return apply_filters(
+        'getpaid_get_invoice_status_classes',
+        array(
             'wpi-quote-declined' => 'bg-danger',
             'wpi-failed'         => 'bg-danger',
-			'wpi-processing'     => 'bg-info',
-			'wpi-onhold'         => 'bg-warning text-dark',
-			'wpi-quote-accepted' => 'bg-success',
-			'publish'            => 'bg-success',
-			'wpi-renewal'        => 'bg-primary',
+            'wpi-processing'     => 'bg-info',
+            'wpi-onhold'         => 'bg-warning text-dark',
+            'wpi-quote-accepted' => 'bg-success',
+            'publish'            => 'bg-success',
+            'wpi-renewal'        => 'bg-primary',
             'wpi-cancelled'      => 'bg-secondary',
             'wpi-pending'        => 'bg-dark',
             'wpi-quote-pending'  => 'bg-dark',
             'wpi-refunded'       => 'bg-secondary',
-		)
-	);
+        )
+    );
 
 }
 
@@ -1303,7 +1303,7 @@ 
 function getpaid_get_invoice_tax_rate( $invoice, $item ) {
 
     $rates   = getpaid_get_item_tax_rates( $item, $invoice->get_country(), $invoice->get_state() );
-	$rates   = getpaid_filter_item_tax_rates( $item, $rates );
+    $rates   = getpaid_filter_item_tax_rates( $item, $rates );
     $rates   = wp_list_pluck( $rates, 'rate' );
 
     return array_sum( $rates );

includes/class-getpaid-daily-maintenance.php

Indentation +139 added lines, -139 removed lines

@@ -12,144 +12,144 @@
  */
 class GetPaid_Daily_Maintenance {
 
-	/**
-	 * Class constructor.
-	 */
-	public function __construct() {
-
-		// Clear deprecated events.
-		add_action( 'wp', array( $this, 'maybe_clear_deprecated_events' ) );
-
-		// (Maybe) schedule a cron that runs daily.
-		add_action( 'wp', array( $this, 'maybe_create_scheduled_event' ) );
-
-		// Fired everyday at 7 a.m (this might vary for sites with few visitors)
-		add_action( 'getpaid_daily_maintenance', array( $this, 'log_cron_run' ) );
-		add_action( 'getpaid_daily_maintenance', array( $this, 'backwards_compat' ) );
-		add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_expire_subscriptions' ) );
-		add_action( 'getpaid_daily_maintenance', array( $this, 'check_renewing_subscriptions' ) );
-		add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_update_geoip_databases' ) );
-
-	}
-
-	/**
-	 * Schedules a cron to run every day at 7 a.m
-	 *
-	 */
-	public function maybe_create_scheduled_event() {
-
-		if ( ! wp_next_scheduled( 'getpaid_daily_maintenance' ) ) {
-			$timestamp = strtotime( 'tomorrow 07:00:00', current_time( 'timestamp' ) );
-			wp_schedule_event( $timestamp, 'daily', 'getpaid_daily_maintenance' );
-		}
-
-	}
-
-	/**
-	 * Clears deprecated events.
-	 *
-	 */
-	public function maybe_clear_deprecated_events() {
-
-		if ( ! get_option( 'wpinv_cleared_old_events' ) ) {
-			wp_clear_scheduled_hook( 'wpinv_register_schedule_event_twicedaily' );
-			wp_clear_scheduled_hook( 'wpinv_register_schedule_event_daily' );
-			update_option( 'wpinv_cleared_old_events', 1 );
-		}
-
-	}
-
-	/**
-	 * Fires the old hook for backwards compatibility.
-	 *
-	 */
-	public function backwards_compat() {
-		do_action( 'wpinv_register_schedule_event_daily' );
-	}
-
-	/**
-	 * Checks for subscriptions that are scheduled to renew.
-	 *
-	 */
-	public function check_renewing_subscriptions() {
-
-		// Fetch subscriptions that expire today.
-		$args  = array(
-			'number'             => -1,
-			'count_total'        => false,
-			'status'             => 'trialling active',
-			'date_expires_query' => array(
-				array(
-					'year'    => gmdate( 'Y' ),
-					'month'   => gmdate( 'n' ),
-					'day'     => gmdate( 'j' ),
-					'compare' => '=',
-				),
-			),
-		);
-
-		$subscriptions = new GetPaid_Subscriptions_Query( $args );
-
-		foreach ( $subscriptions->get_results() as $subscription ) {
-
-			/** @var WPInv_Subscription $subscription */
-			if ( $subscription->is_last_renewal() ) {
-				$subscription->complete();
-			} else {
-				do_action( 'getpaid_should_renew_subscription', $subscription );
-			}
-		}
-
-	}
-
-	/**
-	 * Expires expired subscriptions.
-	 *
-	 */
-	public function maybe_expire_subscriptions() {
-
-		// Fetch expired subscriptions (skips those that expire today).
-		$args  = array(
-			'number'             => -1,
-			'count_total'        => false,
-			'status'             => 'trialling active failing cancelled',
-			'date_expires_query' => array(
-				'before'    => 'yesterday',
-				'inclusive' => false,
-			),
-		);
-
-		$subscriptions = new GetPaid_Subscriptions_Query( $args );
-
-		foreach ( $subscriptions->get_results() as $subscription ) {
-			if ( apply_filters( 'getpaid_daily_maintenance_should_expire_subscription', false, $subscription ) ) {
-				$subscription->set_status( 'expired' );
-				$subscription->save();
-			}
-		}
-
-	}
-
-	/**
-	 * Logs cron runs.
-	 *
-	 */
-	public function log_cron_run() {
-		wpinv_error_log( 'GetPaid Daily Cron', false );
-	}
-
-	/**
-	 * Updates GeoIP databases.
-	 *
-	 */
-	public function maybe_update_geoip_databases() {
-		$updated = get_transient( 'getpaid_updated_geoip_databases' );
-
-		if ( false === $updated ) {
-			set_transient( 'getpaid_updated_geoip_databases', 1, 15 * DAY_IN_SECONDS );
-			do_action( 'getpaid_update_geoip_databases' );
-		}
-
-	}
+    /**
+     * Class constructor.
+     */
+    public function __construct() {
+
+        // Clear deprecated events.
+        add_action( 'wp', array( $this, 'maybe_clear_deprecated_events' ) );
+
+        // (Maybe) schedule a cron that runs daily.
+        add_action( 'wp', array( $this, 'maybe_create_scheduled_event' ) );
+
+        // Fired everyday at 7 a.m (this might vary for sites with few visitors)
+        add_action( 'getpaid_daily_maintenance', array( $this, 'log_cron_run' ) );
+        add_action( 'getpaid_daily_maintenance', array( $this, 'backwards_compat' ) );
+        add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_expire_subscriptions' ) );
+        add_action( 'getpaid_daily_maintenance', array( $this, 'check_renewing_subscriptions' ) );
+        add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_update_geoip_databases' ) );
+
+    }
+
+    /**
+     * Schedules a cron to run every day at 7 a.m
+     *
+     */
+    public function maybe_create_scheduled_event() {
+
+        if ( ! wp_next_scheduled( 'getpaid_daily_maintenance' ) ) {
+            $timestamp = strtotime( 'tomorrow 07:00:00', current_time( 'timestamp' ) );
+            wp_schedule_event( $timestamp, 'daily', 'getpaid_daily_maintenance' );
+        }
+
+    }
+
+    /**
+     * Clears deprecated events.
+     *
+     */
+    public function maybe_clear_deprecated_events() {
+
+        if ( ! get_option( 'wpinv_cleared_old_events' ) ) {
+            wp_clear_scheduled_hook( 'wpinv_register_schedule_event_twicedaily' );
+            wp_clear_scheduled_hook( 'wpinv_register_schedule_event_daily' );
+            update_option( 'wpinv_cleared_old_events', 1 );
+        }
+
+    }
+
+    /**
+     * Fires the old hook for backwards compatibility.
+     *
+     */
+    public function backwards_compat() {
+        do_action( 'wpinv_register_schedule_event_daily' );
+    }
+
+    /**
+     * Checks for subscriptions that are scheduled to renew.
+     *
+     */
+    public function check_renewing_subscriptions() {
+
+        // Fetch subscriptions that expire today.
+        $args  = array(
+            'number'             => -1,
+            'count_total'        => false,
+            'status'             => 'trialling active',
+            'date_expires_query' => array(
+                array(
+                    'year'    => gmdate( 'Y' ),
+                    'month'   => gmdate( 'n' ),
+                    'day'     => gmdate( 'j' ),
+                    'compare' => '=',
+                ),
+            ),
+        );
+
+        $subscriptions = new GetPaid_Subscriptions_Query( $args );
+
+        foreach ( $subscriptions->get_results() as $subscription ) {
+
+            /** @var WPInv_Subscription $subscription */
+            if ( $subscription->is_last_renewal() ) {
+                $subscription->complete();
+            } else {
+                do_action( 'getpaid_should_renew_subscription', $subscription );
+            }
+        }
+
+    }
+
+    /**
+     * Expires expired subscriptions.
+     *
+     */
+    public function maybe_expire_subscriptions() {
+
+        // Fetch expired subscriptions (skips those that expire today).
+        $args  = array(
+            'number'             => -1,
+            'count_total'        => false,
+            'status'             => 'trialling active failing cancelled',
+            'date_expires_query' => array(
+                'before'    => 'yesterday',
+                'inclusive' => false,
+            ),
+        );
+
+        $subscriptions = new GetPaid_Subscriptions_Query( $args );
+
+        foreach ( $subscriptions->get_results() as $subscription ) {
+            if ( apply_filters( 'getpaid_daily_maintenance_should_expire_subscription', false, $subscription ) ) {
+                $subscription->set_status( 'expired' );
+                $subscription->save();
+            }
+        }
+
+    }
+
+    /**
+     * Logs cron runs.
+     *
+     */
+    public function log_cron_run() {
+        wpinv_error_log( 'GetPaid Daily Cron', false );
+    }
+
+    /**
+     * Updates GeoIP databases.
+     *
+     */
+    public function maybe_update_geoip_databases() {
+        $updated = get_transient( 'getpaid_updated_geoip_databases' );
+
+        if ( false === $updated ) {
+            set_transient( 'getpaid_updated_geoip_databases', 1, 15 * DAY_IN_SECONDS );
+            do_action( 'getpaid_update_geoip_databases' );
+        }
+
+    }
 
 }

templates/subscriptions/subscription-details.php

Indentation +46 added lines, -46 removed lines

@@ -39,62 +39,62 @@ 
 				<td style="width: 65%">
 					<?php
 
-						switch ( $key ) {
+                        switch ( $key ) {
 
-						case 'status':
-							echo esc_html( $subscription->get_status_label() );
-							break;
+                        case 'status':
+                            echo esc_html( $subscription->get_status_label() );
+                            break;
 
-						case 'start_date':
-							echo esc_html( getpaid_format_date_value( $subscription->get_date_created() ) );
-							break;
+                        case 'start_date':
+                            echo esc_html( getpaid_format_date_value( $subscription->get_date_created() ) );
+                            break;
 
-						case 'expiry_date':
-							echo esc_html( getpaid_format_date_value( $subscription->get_next_renewal_date() ) );
-							break;
+                        case 'expiry_date':
+                            echo esc_html( getpaid_format_date_value( $subscription->get_next_renewal_date() ) );
+                            break;
 
-						case 'initial_amount':
-							echo wp_kses_post( wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() ) );
+                        case 'initial_amount':
+                            echo wp_kses_post( wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() ) );
 
-							if ( $subscription->has_trial_period() ) {
+                            if ( $subscription->has_trial_period() ) {
 
-								echo "<small class='text-muted'>&nbsp;";
-								printf(
-									esc_html_x( '( %1$s trial )', 'Subscription trial period. (e.g.: 1 month trial)', 'invoicing' ),
-									esc_html( $subscription->get_trial_period() )
-								);
-								echo '</small>';
+                                echo "<small class='text-muted'>&nbsp;";
+                                printf(
+                                    esc_html_x( '( %1$s trial )', 'Subscription trial period. (e.g.: 1 month trial)', 'invoicing' ),
+                                    esc_html( $subscription->get_trial_period() )
+                                );
+                                echo '</small>';
 
-							}
+                            }
 
-							break;
+                            break;
 
-						case 'recurring_amount':
-							$frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
-							$amount    = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() );
-							echo wp_kses_post( strtolower( "<strong style='font-weight: 500;'>$amount</strong> / <span class='getpaid-item-recurring-period'>$frequency</span>" ) );
-							break;
+                        case 'recurring_amount':
+                            $frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
+                            $amount    = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() );
+                            echo wp_kses_post( strtolower( "<strong style='font-weight: 500;'>$amount</strong> / <span class='getpaid-item-recurring-period'>$frequency</span>" ) );
+                            break;
 
-						case 'item':
-							if ( empty( $subscription_group ) ) {
-								echo wp_kses_post( WPInv_Subscriptions_List_Table::generate_item_markup( $subscription->get_product_id() ) );
-							} else {
-								$markup = array_map( array( 'WPInv_Subscriptions_List_Table', 'generate_item_markup' ), array_keys( $subscription_group['items'] ) );
-								echo wp_kses_post( implode( ' | ', $markup ) );
-							}
+                        case 'item':
+                            if ( empty( $subscription_group ) ) {
+                                echo wp_kses_post( WPInv_Subscriptions_List_Table::generate_item_markup( $subscription->get_product_id() ) );
+                            } else {
+                                $markup = array_map( array( 'WPInv_Subscriptions_List_Table', 'generate_item_markup' ), array_keys( $subscription_group['items'] ) );
+                                echo wp_kses_post( implode( ' | ', $markup ) );
+                            }
 
-							break;
+                            break;
 
-						case 'payments':
-							$max_activations = (int) $subscription->get_bill_times();
-							echo ( (int) $subscription->get_times_billed() ) . ' / ' . ( empty( $max_activations ) ? '&infin;' : (int) $max_activations );
+                        case 'payments':
+                            $max_activations = (int) $subscription->get_bill_times();
+                            echo ( (int) $subscription->get_times_billed() ) . ' / ' . ( empty( $max_activations ) ? '&infin;' : (int) $max_activations );
 
-							break;
+                            break;
 
-						}
-						do_action( "getpaid_render_single_subscription_column_$key", $subscription );
+                        }
+                        do_action( "getpaid_render_single_subscription_column_$key", $subscription );
 
-					?>
+                    ?>
 				</td>
 
 			</tr>
@@ -121,17 +121,17 @@ 
 <span class="form-text">
 
 	<?php
-		if ( $subscription->can_cancel() ) {
-		printf(
+        if ( $subscription->can_cancel() ) {
+        printf(
             '<a href="%s" class="btn btn-danger btn-sm" onclick="return confirm(\'%s\')">%s</a>&nbsp;&nbsp;',
             esc_url( $subscription->get_cancel_url() ),
             esc_attr__( 'Are you sure you want to cancel this subscription?', 'invoicing' ),
             esc_html__( 'Cancel Subscription', 'invoicing' )
         );
-		}
+        }
 
-		do_action( 'getpaid-single-subscription-page-actions', $subscription );
-	?>
+        do_action( 'getpaid-single-subscription-page-actions', $subscription );
+    ?>
 
 	<a href="<?php echo esc_url( getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ) ); ?>" class="btn btn-secondary btn-sm"><?php esc_html_e( 'Go Back', 'invoicing' ); ?></a>
 </span>

includes/gateways/class-getpaid-paypal-gateway-ipn-handler.php

Indentation +396 added lines, -396 removed lines

@@ -12,478 +12,478 @@
  */
 class GetPaid_Paypal_Gateway_IPN_Handler {
 
-	/**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
-	protected $id = 'paypal';
-
-	/**
-	 * Payment method object.
-	 *
-	 * @var GetPaid_Paypal_Gateway
-	 */
-	protected $gateway;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @param GetPaid_Paypal_Gateway $gateway
-	 */
-	public function __construct( $gateway ) {
-		$this->gateway = $gateway;
-		$this->verify_ipn();
-	}
-
-	/**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
-
-		wpinv_error_log( 'GetPaid PayPal IPN Handler', false );
-
-		// Validate the IPN.
-		if ( empty( $_POST ) || ! $this->validate_ipn() ) {
-			wp_die( 'PayPal IPN Request Failure', 500 );
-		}
-
-		// Process the IPN.
-		$posted  = wp_unslash( $_POST );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		// Abort if it was not paid by our gateway.
-		if ( $this->id != $invoice->get_gateway() ) {
-			wpinv_error_log( 'Aborting, Invoice was not paid via PayPal', false );
-			wp_die( 'Invoice not paid via PayPal', 200 );
-		}
-
-		$posted['payment_status'] = isset( $posted['payment_status'] ) ? sanitize_key( strtolower( $posted['payment_status'] ) ) : '';
-		$posted['txn_type']       = sanitize_key( strtolower( $posted['txn_type'] ) );
-
-		wpinv_error_log( 'Payment status:' . $posted['payment_status'], false );
-		wpinv_error_log( 'IPN Type:' . $posted['txn_type'], false );
-
-		if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
-			call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
-			wpinv_error_log( 'Done processing IPN', false );
-			wp_die( 'Processed', 200 );
-		}
-
-		wpinv_error_log( 'Aborting, Unsupported IPN type:' . $posted['txn_type'], false );
-		wp_die( 'Unsupported IPN type', 200 );
-
-	}
-
-	/**
-	 * Retrieves IPN Invoice.
-	 *
-	 * @param array $posted
-	 * @return WPInv_Invoice
-	 */
-	protected function get_ipn_invoice( $posted ) {
-
-		wpinv_error_log( 'Retrieving PayPal IPN Response Invoice', false );
-
-		if ( ! empty( $posted['custom'] ) ) {
-			$invoice = new WPInv_Invoice( $posted['custom'] );
-
-			if ( $invoice->exists() ) {
-				wpinv_error_log( 'Found invoice #' . $invoice->get_number(), false );
-				return $invoice;
-			}
-		}
-
-		wpinv_error_log( 'Could not retrieve the associated invoice.', false );
-		wp_die( 'Could not retrieve the associated invoice.', 200 );
-	}
-
-	/**
-	 * Check PayPal IPN validity.
-	 */
-	protected function validate_ipn() {
-
-		wpinv_error_log( 'Validating PayPal IPN response', false );
-
-		// Retrieve the associated invoice.
-		$posted  = wp_unslash( $_POST );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		if ( $this->gateway->is_sandbox( $invoice ) ) {
-			wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data', false );
-		}
-
-		// Validate the IPN.
-		$posted['cmd'] = '_notify-validate';
-
-		// Send back post vars to paypal.
-		$params = array(
-			'body'        => $posted,
-			'timeout'     => 60,
-			'httpversion' => '1.1',
-			'compress'    => false,
-			'decompress'  => false,
-			'user-agent'  => 'GetPaid/' . WPINV_VERSION,
-		);
-
-		// Post back to get a response.
-		$response = wp_safe_remote_post( $this->gateway->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
-
-		// Check to see if the request was valid.
-		if ( ! is_wp_error( $response ) && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
-			$invoice->add_note( 'Received valid response from PayPal IPN: ' . $response['body'], false, false, true );
-			wpinv_error_log( 'Received valid response from PayPal IPN: ' . $response['body'], false );
-			return true;
-		}
-
-		$invoice->add_note( 'IPN message:' . wp_json_encode( $posted ), false, false, true );
-
-		if ( is_wp_error( $response ) ) {
-			$invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response->get_error_message(), false, false, true );
-			wpinv_error_log( $response->get_error_message(), 'Received invalid response from PayPal IPN' );
-			return false;
-		}
-
-		$invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response['body'], false, false, true );
-		wpinv_error_log( $response['body'], 'Received invalid response from PayPal IPN' );
-		return false;
-
-	}
-
-	/**
-	 * Check currency from IPN matches the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param string   $currency currency to validate.
-	 */
-	protected function validate_ipn_currency( $invoice, $currency ) {
+    /**
+     * Payment method id.
+     *
+     * @var string
+     */
+    protected $id = 'paypal';
+
+    /**
+     * Payment method object.
+     *
+     * @var GetPaid_Paypal_Gateway
+     */
+    protected $gateway;
+
+    /**
+     * Class constructor.
+     *
+     * @param GetPaid_Paypal_Gateway $gateway
+     */
+    public function __construct( $gateway ) {
+        $this->gateway = $gateway;
+        $this->verify_ipn();
+    }
+
+    /**
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
+
+        wpinv_error_log( 'GetPaid PayPal IPN Handler', false );
+
+        // Validate the IPN.
+        if ( empty( $_POST ) || ! $this->validate_ipn() ) {
+            wp_die( 'PayPal IPN Request Failure', 500 );
+        }
+
+        // Process the IPN.
+        $posted  = wp_unslash( $_POST );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        // Abort if it was not paid by our gateway.
+        if ( $this->id != $invoice->get_gateway() ) {
+            wpinv_error_log( 'Aborting, Invoice was not paid via PayPal', false );
+            wp_die( 'Invoice not paid via PayPal', 200 );
+        }
+
+        $posted['payment_status'] = isset( $posted['payment_status'] ) ? sanitize_key( strtolower( $posted['payment_status'] ) ) : '';
+        $posted['txn_type']       = sanitize_key( strtolower( $posted['txn_type'] ) );
+
+        wpinv_error_log( 'Payment status:' . $posted['payment_status'], false );
+        wpinv_error_log( 'IPN Type:' . $posted['txn_type'], false );
+
+        if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
+            call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
+            wpinv_error_log( 'Done processing IPN', false );
+            wp_die( 'Processed', 200 );
+        }
+
+        wpinv_error_log( 'Aborting, Unsupported IPN type:' . $posted['txn_type'], false );
+        wp_die( 'Unsupported IPN type', 200 );
+
+    }
+
+    /**
+     * Retrieves IPN Invoice.
+     *
+     * @param array $posted
+     * @return WPInv_Invoice
+     */
+    protected function get_ipn_invoice( $posted ) {
+
+        wpinv_error_log( 'Retrieving PayPal IPN Response Invoice', false );
+
+        if ( ! empty( $posted['custom'] ) ) {
+            $invoice = new WPInv_Invoice( $posted['custom'] );
+
+            if ( $invoice->exists() ) {
+                wpinv_error_log( 'Found invoice #' . $invoice->get_number(), false );
+                return $invoice;
+            }
+        }
+
+        wpinv_error_log( 'Could not retrieve the associated invoice.', false );
+        wp_die( 'Could not retrieve the associated invoice.', 200 );
+    }
+
+    /**
+     * Check PayPal IPN validity.
+     */
+    protected function validate_ipn() {
+
+        wpinv_error_log( 'Validating PayPal IPN response', false );
+
+        // Retrieve the associated invoice.
+        $posted  = wp_unslash( $_POST );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        if ( $this->gateway->is_sandbox( $invoice ) ) {
+            wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data', false );
+        }
+
+        // Validate the IPN.
+        $posted['cmd'] = '_notify-validate';
+
+        // Send back post vars to paypal.
+        $params = array(
+            'body'        => $posted,
+            'timeout'     => 60,
+            'httpversion' => '1.1',
+            'compress'    => false,
+            'decompress'  => false,
+            'user-agent'  => 'GetPaid/' . WPINV_VERSION,
+        );
+
+        // Post back to get a response.
+        $response = wp_safe_remote_post( $this->gateway->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
+
+        // Check to see if the request was valid.
+        if ( ! is_wp_error( $response ) && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
+            $invoice->add_note( 'Received valid response from PayPal IPN: ' . $response['body'], false, false, true );
+            wpinv_error_log( 'Received valid response from PayPal IPN: ' . $response['body'], false );
+            return true;
+        }
+
+        $invoice->add_note( 'IPN message:' . wp_json_encode( $posted ), false, false, true );
+
+        if ( is_wp_error( $response ) ) {
+            $invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response->get_error_message(), false, false, true );
+            wpinv_error_log( $response->get_error_message(), 'Received invalid response from PayPal IPN' );
+            return false;
+        }
+
+        $invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response['body'], false, false, true );
+        wpinv_error_log( $response['body'], 'Received invalid response from PayPal IPN' );
+        return false;
+
+    }
+
+    /**
+     * Check currency from IPN matches the invoice.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param string   $currency currency to validate.
+     */
+    protected function validate_ipn_currency( $invoice, $currency ) {
 
-		if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) {
+        if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) {
 
-			/* translators: %s: currency code. */
-			$invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
+            /* translators: %s: currency code. */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
 
-			wpinv_error_log( "Currencies do not match: {$currency} instead of {$invoice->get_currency()}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            wpinv_error_log( "Currencies do not match: {$currency} instead of {$invoice->get_currency()}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( $currency, 'Validated IPN Currency', false );
-	}
+        wpinv_error_log( $currency, 'Validated IPN Currency', false );
+    }
 
-	/**
-	 * Check payment amount from IPN matches the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param float   $amount amount to validate.
-	 */
-	protected function validate_ipn_amount( $invoice, $amount ) {
-		if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) {
+    /**
+     * Check payment amount from IPN matches the invoice.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param float   $amount amount to validate.
+     */
+    protected function validate_ipn_amount( $invoice, $amount ) {
+        if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) {
 
-			/* translators: %s: Amount. */
-			$invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
+            /* translators: %s: Amount. */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
 
-			wpinv_error_log( "Amounts do not match: {$amount} instead of {$invoice->get_total()}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            wpinv_error_log( "Amounts do not match: {$amount} instead of {$invoice->get_total()}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( $amount, 'Validated IPN Amount', false );
-	}
+        wpinv_error_log( $amount, 'Validated IPN Amount', false );
+    }
 
-	/**
-	 * Verify receiver email from PayPal.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param string   $receiver_email Email to validate.
-	 */
-	protected function validate_ipn_receiver_email( $invoice, $receiver_email ) {
-		$paypal_email = wpinv_get_option( 'paypal_email' );
+    /**
+     * Verify receiver email from PayPal.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param string   $receiver_email Email to validate.
+     */
+    protected function validate_ipn_receiver_email( $invoice, $receiver_email ) {
+        $paypal_email = wpinv_get_option( 'paypal_email' );
 
-		if ( $receiver_email && strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) {
-			wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}" );
+        if ( $receiver_email && strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) {
+            wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}" );
 
-			/* translators: %s: email address . */
-			$invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s).', 'invoicing' ), $receiver_email ) );
+            /* translators: %s: email address . */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s).', 'invoicing' ), $receiver_email ) );
 
-			return wpinv_error_log( "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            return wpinv_error_log( "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( 'Validated PayPal Email', false );
-	}
+        wpinv_error_log( 'Validated PayPal Email', false );
+    }
 
-	/**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_web_accept( $invoice, $posted ) {
+    /**
+     * Handles one time payments.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_web_accept( $invoice, $posted ) {
 
-		// Collect payment details
-		$payment_status = strtolower( $posted['payment_status'] );
-		$business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
+        // Collect payment details
+        $payment_status = strtolower( $posted['payment_status'] );
+        $business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
 
-		$this->validate_ipn_receiver_email( $invoice, $business_email );
-		$this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
 
-		// Update the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
-			$invoice->save();
-		}
+        // Update the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
+            $invoice->save();
+        }
 
-		$invoice->add_system_note( __( 'Processing invoice IPN', 'invoicing' ) );
+        $invoice->add_system_note( __( 'Processing invoice IPN', 'invoicing' ) );
 
-		// Process a refund.
-		if ( 'refunded' === $payment_status || 'reversed' === $payment_status ) {
+        // Process a refund.
+        if ( 'refunded' === $payment_status || 'reversed' === $payment_status ) {
 
-			update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
+            update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
 
-			if ( ! $invoice->is_refunded() ) {
-				$invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
-			}
+            if ( ! $invoice->is_refunded() ) {
+                $invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
+            }
 
-			return wpinv_error_log( $posted['reason_code'], false );
-		}
+            return wpinv_error_log( $posted['reason_code'], false );
+        }
 
-		// Process payments.
-		if ( 'completed' === $payment_status ) {
+        // Process payments.
+        if ( 'completed' === $payment_status ) {
 
-			if ( $invoice->is_paid() && 'wpi_processing' != $invoice->get_status() ) {
-				return wpinv_error_log( 'Aborting, Invoice #' . $invoice->get_number() . ' is already paid.', false );
-			}
+            if ( $invoice->is_paid() && 'wpi_processing' != $invoice->get_status() ) {
+                return wpinv_error_log( 'Aborting, Invoice #' . $invoice->get_number() . ' is already paid.', false );
+            }
 
-			$this->validate_ipn_amount( $invoice, $posted['mc_gross'] );
+            $this->validate_ipn_amount( $invoice, $posted['mc_gross'] );
 
-			$note = '';
+            $note = '';
 
-			if ( ! empty( $posted['mc_fee'] ) ) {
-				$note = sprintf( __( 'PayPal Transaction Fee %s.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
-			}
+            if ( ! empty( $posted['mc_fee'] ) ) {
+                $note = sprintf( __( 'PayPal Transaction Fee %s.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
+            }
 
-			if ( ! empty( $posted['payer_status'] ) ) {
-				$note = ' ' . sprintf( __( 'Buyer status %s.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
-			}
+            if ( ! empty( $posted['payer_status'] ) ) {
+                $note = ' ' . sprintf( __( 'Buyer status %s.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
+            }
 
-			$invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
-			return wpinv_error_log( 'Invoice marked as paid.', false );
+            $invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
+            return wpinv_error_log( 'Invoice marked as paid.', false );
 
-		}
+        }
 
-		// Pending payments.
-		if ( 'pending' === $payment_status ) {
+        // Pending payments.
+        if ( 'pending' === $payment_status ) {
 
-			/* translators: %s: pending reason. */
-			$invoice->update_status( 'wpi-onhold', sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ) );
+            /* translators: %s: pending reason. */
+            $invoice->update_status( 'wpi-onhold', sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ) );
 
-			return wpinv_error_log( 'Invoice marked as "payment held".', false );
-		}
+            return wpinv_error_log( 'Invoice marked as "payment held".', false );
+        }
 
-		/* translators: %s: payment status. */
-		$invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), sanitize_text_field( $posted['payment_status'] ) ) );
+        /* translators: %s: payment status. */
+        $invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), sanitize_text_field( $posted['payment_status'] ) ) );
 
-	}
+    }
 
-	/**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_cart( $invoice, $posted ) {
-		$this->ipn_txn_web_accept( $invoice, $posted );
-	}
+    /**
+     * Handles one time payments.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_cart( $invoice, $posted ) {
+        $this->ipn_txn_web_accept( $invoice, $posted );
+    }
 
-	/**
-	 * Handles subscription sign ups.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_signup( $invoice, $posted ) {
+    /**
+     * Handles subscription sign ups.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_signup( $invoice, $posted ) {
 
-		wpinv_error_log( 'Processing subscription signup', false );
+        wpinv_error_log( 'Processing subscription signup', false );
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
+        wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
 
-		// Validate the IPN.
-		$business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
-		$this->validate_ipn_receiver_email( $invoice, $business_email );
-		$this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+        // Validate the IPN.
+        $business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
 
-		// Activate the subscription.
-		$duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
-		$subscription->set_date_created( current_time( 'mysql' ) );
-		$subscription->set_expiration( date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ) );
-		$subscription->set_profile_id( sanitize_text_field( $posted['subscr_id'] ) );
-		$subscription->activate();
+        // Activate the subscription.
+        $duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
+        $subscription->set_date_created( current_time( 'mysql' ) );
+        $subscription->set_expiration( date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ) );
+        $subscription->set_profile_id( sanitize_text_field( $posted['subscr_id'] ) );
+        $subscription->activate();
 
-		// Set the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->add_note( sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
-			$invoice->set_transaction_id( $posted['txn_id'] );
-		}
+        // Set the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->add_note( sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
+            $invoice->set_transaction_id( $posted['txn_id'] );
+        }
 
-		// Update the payment status.
-		$invoice->mark_paid();
+        // Update the payment status.
+        $invoice->mark_paid();
 
-		$invoice->add_note( sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
+        $invoice->add_note( sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
 
-		wpinv_error_log( 'Subscription started.', false );
-	}
+        wpinv_error_log( 'Subscription started.', false );
+    }
 
-	/**
-	 * Handles subscription renewals.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_payment( $invoice, $posted ) {
+    /**
+     * Handles subscription renewals.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_payment( $invoice, $posted ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
+        wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
 
-		// PayPal sends a subscr_payment for the first payment too.
-		$date_completed = getpaid_format_date( $invoice->get_date_completed() );
-		$date_created   = getpaid_format_date( $invoice->get_date_created() );
-		$today_date     = getpaid_format_date( current_time( 'mysql' ) );
-		$payment_date   = getpaid_format_date( $posted['payment_date'] );
-		$subscribe_date = getpaid_format_date( $subscription->get_date_created() );
-		$dates          = array_filter( compact( 'date_completed', 'date_created', 'subscribe_date' ) );
+        // PayPal sends a subscr_payment for the first payment too.
+        $date_completed = getpaid_format_date( $invoice->get_date_completed() );
+        $date_created   = getpaid_format_date( $invoice->get_date_created() );
+        $today_date     = getpaid_format_date( current_time( 'mysql' ) );
+        $payment_date   = getpaid_format_date( $posted['payment_date'] );
+        $subscribe_date = getpaid_format_date( $subscription->get_date_created() );
+        $dates          = array_filter( compact( 'date_completed', 'date_created', 'subscribe_date' ) );
 
-		foreach ( $dates as $date ) {
+        foreach ( $dates as $date ) {
 
-			if ( $date !== $today_date && $date !== $payment_date ) {
-				continue;
-			}
+            if ( $date !== $today_date && $date !== $payment_date ) {
+                continue;
+            }
 
-			if ( ! empty( $posted['txn_id'] ) ) {
-				$invoice->set_transaction_id( sanitize_text_field( $posted['txn_id'] ) );
-				$invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), sanitize_text_field( $posted['txn_id'] ) ), false, false, true );
-			}
+            if ( ! empty( $posted['txn_id'] ) ) {
+                $invoice->set_transaction_id( sanitize_text_field( $posted['txn_id'] ) );
+                $invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), sanitize_text_field( $posted['txn_id'] ) ), false, false, true );
+            }
 
-			return $invoice->mark_paid();
-
-		}
+            return $invoice->mark_paid();
+
+        }
 
-		wpinv_error_log( 'Processing subscription renewal payment for the invoice ' . $invoice->get_id(), false );
-
-		// Abort if the payment is already recorded.
-		if ( wpinv_get_id_by_transaction_id( $posted['txn_id'] ) ) {
-			return wpinv_error_log( 'Aborting, Transaction ' . $posted['txn_id'] . ' has already been processed', false );
-		}
-
-		$args = array(
-			'transaction_id' => $posted['txn_id'],
-			'gateway'        => $this->id,
-		);
-
-		$invoice = wpinv_get_invoice( $subscription->add_payment( $args ) );
+        wpinv_error_log( 'Processing subscription renewal payment for the invoice ' . $invoice->get_id(), false );
+
+        // Abort if the payment is already recorded.
+        if ( wpinv_get_id_by_transaction_id( $posted['txn_id'] ) ) {
+            return wpinv_error_log( 'Aborting, Transaction ' . $posted['txn_id'] . ' has already been processed', false );
+        }
+
+        $args = array(
+            'transaction_id' => $posted['txn_id'],
+            'gateway'        => $this->id,
+        );
+
+        $invoice = wpinv_get_invoice( $subscription->add_payment( $args ) );
 
-		if ( empty( $invoice ) ) {
-			return;
-		}
+        if ( empty( $invoice ) ) {
+            return;
+        }
 
-		$invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
-		$invoice->add_note( wp_sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
+        $invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
+        $invoice->add_note( wp_sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
 
-		$subscription->renew();
-		wpinv_error_log( 'Subscription renewed.', false );
+        $subscription->renew();
+        wpinv_error_log( 'Subscription renewed.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription cancelations.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 */
-	protected function ipn_txn_subscr_cancel( $invoice ) {
+    /**
+     * Handles subscription cancelations.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     */
+    protected function ipn_txn_subscr_cancel( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
-
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
-
-		wpinv_error_log( 'Processing subscription cancellation for the invoice ' . $invoice->get_id(), false );
-		$subscription->cancel();
-		wpinv_error_log( 'Subscription cancelled.', false );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
+
+        wpinv_error_log( 'Processing subscription cancellation for the invoice ' . $invoice->get_id(), false );
+        $subscription->cancel();
+        wpinv_error_log( 'Subscription cancelled.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription completions.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_eot( $invoice ) {
+    /**
+     * Handles subscription completions.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_eot( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Processing subscription end of life for the invoice ' . $invoice->get_id(), false );
-		$subscription->complete();
-		wpinv_error_log( 'Subscription completed.', false );
+        wpinv_error_log( 'Processing subscription end of life for the invoice ' . $invoice->get_id(), false );
+        $subscription->complete();
+        wpinv_error_log( 'Subscription completed.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription fails.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_failed( $invoice ) {
+    /**
+     * Handles subscription fails.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_failed( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Processing subscription payment failure for the invoice ' . $invoice->get_id(), false );
-		$subscription->failing();
-		wpinv_error_log( 'Subscription marked as failing.', false );
+        wpinv_error_log( 'Processing subscription payment failure for the invoice ' . $invoice->get_id(), false );
+        $subscription->failing();
+        wpinv_error_log( 'Subscription marked as failing.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription suspensions.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_recurring_payment_suspended_due_to_max_failed_payment( $invoice ) {
+    /**
+     * Handles subscription suspensions.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_recurring_payment_suspended_due_to_max_failed_payment( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
-
-		wpinv_error_log( 'Processing subscription cancellation due to max failed payment for the invoice ' . $invoice->get_id(), false );
-		$subscription->cancel();
-		wpinv_error_log( 'Subscription cancelled.', false );
-	}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
+
+        wpinv_error_log( 'Processing subscription cancellation due to max failed payment for the invoice ' . $invoice->get_id(), false );
+        $subscription->cancel();
+        wpinv_error_log( 'Subscription cancelled.', false );
+    }
 
 }

includes/admin/meta-boxes/class-getpaid-meta-box-invoice-address.php

Indentation +277 added lines, -277 removed lines

@@ -8,7 +8,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -16,85 +16,85 @@ 
  */
 class GetPaid_Meta_Box_Invoice_Address {
 
-	/**
-	 * Output the metabox.
-	 *
-	 * @param WP_Post $post
-	 */
-	public static function output( $post ) {
-
-		// Prepare the invoice.
-		$invoice  = new WPInv_Invoice( $post );
-		$customer = $invoice->exists() ? $invoice->get_user_id( 'edit' ) : get_current_user_id();
-		$customer = new WP_User( $customer );
-		$display  = sprintf( _x( '%1$s (%2$s)', 'user dropdown', 'invoicing' ), $customer->display_name, $customer->user_email );
-		wp_nonce_field( 'getpaid_meta_nonce', 'getpaid_meta_nonce' );
-
-		// Address fields.
-		$address_fields = array(
-			'first_name' => array(
-				'label' => __( 'First Name', 'invoicing' ),
-				'type'  => 'text',
-			),
-			'last_name'  => array(
-				'label' => __( 'Last Name', 'invoicing' ),
-				'type'  => 'text',
-			),
-			'company'    => array(
-				'label' => __( 'Company', 'invoicing' ),
-				'type'  => 'text',
-				'class' => 'getpaid-recalculate-prices-on-change',
-			),
-			'vat_number' => array(
-				'label' => __( 'VAT Number', 'invoicing' ),
-				'type'  => 'text',
-				'class' => 'getpaid-recalculate-prices-on-change',
-			),
-			'address'    => array(
-				'label' => __( 'Address', 'invoicing' ),
-				'type'  => 'text',
-			),
-			'city'       => array(
-				'label' => __( 'City', 'invoicing' ),
-				'type'  => 'text',
-			),
-			'country'    => array(
-				'label'       => __( 'Country', 'invoicing' ),
-				'type'        => 'select',
-				'class'       => 'getpaid-recalculate-prices-on-change',
-				'options'     => wpinv_get_country_list(),
-				'placeholder' => __( 'Choose a country', 'invoicing' ),
-			),
-			'state'      => array(
-				'label' => __( 'State', 'invoicing' ),
-				'type'  => 'text',
-				'class' => 'getpaid-recalculate-prices-on-change',
-			),
-			'zip'        => array(
-				'label' => __( 'Zip', 'invoicing' ),
-				'type'  => 'text',
-			),
-			'phone'      => array(
-				'label' => __( 'Phone', 'invoicing' ),
-				'type'  => 'text',
-			),
-		);
-
-		$states = wpinv_get_country_states( $invoice->get_country( 'edit' ) );
-
-		if ( ! empty( $states ) ) {
-			$address_fields['state']['type']        = 'select';
-			$address_fields['state']['options']     = $states;
-			$address_fields['state']['placeholder'] = __( 'Choose a state', 'invoicing' );
-		}
-
-		// Maybe remove the VAT field.
-		if ( ! wpinv_use_taxes() ) {
-			unset( $address_fields['vat_number'] );
-		}
-
-		$address_fields = apply_filters( 'getpaid_admin_edit_invoice_address_fields', $address_fields, $invoice );
-		?>
+    /**
+     * Output the metabox.
+     *
+     * @param WP_Post $post
+     */
+    public static function output( $post ) {
+
+        // Prepare the invoice.
+        $invoice  = new WPInv_Invoice( $post );
+        $customer = $invoice->exists() ? $invoice->get_user_id( 'edit' ) : get_current_user_id();
+        $customer = new WP_User( $customer );
+        $display  = sprintf( _x( '%1$s (%2$s)', 'user dropdown', 'invoicing' ), $customer->display_name, $customer->user_email );
+        wp_nonce_field( 'getpaid_meta_nonce', 'getpaid_meta_nonce' );
+
+        // Address fields.
+        $address_fields = array(
+            'first_name' => array(
+                'label' => __( 'First Name', 'invoicing' ),
+                'type'  => 'text',
+            ),
+            'last_name'  => array(
+                'label' => __( 'Last Name', 'invoicing' ),
+                'type'  => 'text',
+            ),
+            'company'    => array(
+                'label' => __( 'Company', 'invoicing' ),
+                'type'  => 'text',
+                'class' => 'getpaid-recalculate-prices-on-change',
+            ),
+            'vat_number' => array(
+                'label' => __( 'VAT Number', 'invoicing' ),
+                'type'  => 'text',
+                'class' => 'getpaid-recalculate-prices-on-change',
+            ),
+            'address'    => array(
+                'label' => __( 'Address', 'invoicing' ),
+                'type'  => 'text',
+            ),
+            'city'       => array(
+                'label' => __( 'City', 'invoicing' ),
+                'type'  => 'text',
+            ),
+            'country'    => array(
+                'label'       => __( 'Country', 'invoicing' ),
+                'type'        => 'select',
+                'class'       => 'getpaid-recalculate-prices-on-change',
+                'options'     => wpinv_get_country_list(),
+                'placeholder' => __( 'Choose a country', 'invoicing' ),
+            ),
+            'state'      => array(
+                'label' => __( 'State', 'invoicing' ),
+                'type'  => 'text',
+                'class' => 'getpaid-recalculate-prices-on-change',
+            ),
+            'zip'        => array(
+                'label' => __( 'Zip', 'invoicing' ),
+                'type'  => 'text',
+            ),
+            'phone'      => array(
+                'label' => __( 'Phone', 'invoicing' ),
+                'type'  => 'text',
+            ),
+        );
+
+        $states = wpinv_get_country_states( $invoice->get_country( 'edit' ) );
+
+        if ( ! empty( $states ) ) {
+            $address_fields['state']['type']        = 'select';
+            $address_fields['state']['options']     = $states;
+            $address_fields['state']['placeholder'] = __( 'Choose a state', 'invoicing' );
+        }
+
+        // Maybe remove the VAT field.
+        if ( ! wpinv_use_taxes() ) {
+            unset( $address_fields['vat_number'] );
+        }
+
+        $address_fields = apply_filters( 'getpaid_admin_edit_invoice_address_fields', $address_fields, $invoice );
+        ?>
 
 		<style>
 			#wpinv-address label {
@@ -119,19 +119,19 @@ 
 							<div id="getpaid-invoice-email-wrapper" class="d-none">
 								<input type="hidden" id="getpaid-invoice-create-new-user" name="wpinv_new_user" value="" />
 								<?php
-									aui()->input(
-										array(
-											'type'        => 'text',
-											'id'          => 'getpaid-invoice-new-user-email',
-											'name'        => 'wpinv_email',
-											'label'       => __( 'Email', 'invoicing' ) . '<span class="required">*</span>',
-											'label_type'  => 'vertical',
-											'placeholder' => 'john@doe.com',
-											'class'       => 'form-control-sm',
-										),
-										true
-									);
-								?>
+                                    aui()->input(
+                                        array(
+                                            'type'        => 'text',
+                                            'id'          => 'getpaid-invoice-new-user-email',
+                                            'name'        => 'wpinv_email',
+                                            'label'       => __( 'Email', 'invoicing' ) . '<span class="required">*</span>',
+                                            'label_type'  => 'vertical',
+                                            'placeholder' => 'john@doe.com',
+                                            'class'       => 'form-control-sm',
+                                        ),
+                                        true
+                                    );
+                                ?>
 							</div>
 						</div>
 						<div class="col-12 col-sm-6 form-group mb-3 mt-sm-4">
@@ -155,39 +155,39 @@ 
 							<div class="col-12 col-sm-6 getpaid-invoice-address-field__<?php echo esc_attr( $key ); ?>--wrapper">
 								<?php
 
-									if ( 'select' === $field['type'] ) {
-										aui()->select(
-											array(
-												'id'               => 'wpinv_' . $key,
-												'name'             => 'wpinv_' . $key,
-												'label'            => $field['label'],
-												'label_type'       => 'vertical',
-												'placeholder'      => isset( $field['placeholder'] ) ? $field['placeholder'] : '',
-												'class'            => 'form-control-sm ' . ( isset( $field['class'] ) ? $field['class'] : '' ),
-												'value'            => $invoice->get( $key, 'edit' ),
-												'options'          => $field['options'],
-												'data-allow-clear' => 'false',
-												'select2'          => true,
-											),
-											true
-										);
-									} else {
-										aui()->input(
-											array(
-												'type'        => $field['type'],
-												'id'          => 'wpinv_' . $key,
-												'name'        => 'wpinv_' . $key,
-												'label'       => $field['label'],
-												'label_type'  => 'vertical',
-												'placeholder' => isset( $field['placeholder'] ) ? $field['placeholder'] : '',
-												'class'       => 'form-control-sm ' . ( isset( $field['class'] ) ? $field['class'] : '' ),
-												'value'       => $invoice->get( $key, 'edit' ),
-											),
-											true
-										);
-									}
-
-								?>
+                                    if ( 'select' === $field['type'] ) {
+                                        aui()->select(
+                                            array(
+                                                'id'               => 'wpinv_' . $key,
+                                                'name'             => 'wpinv_' . $key,
+                                                'label'            => $field['label'],
+                                                'label_type'       => 'vertical',
+                                                'placeholder'      => isset( $field['placeholder'] ) ? $field['placeholder'] : '',
+                                                'class'            => 'form-control-sm ' . ( isset( $field['class'] ) ? $field['class'] : '' ),
+                                                'value'            => $invoice->get( $key, 'edit' ),
+                                                'options'          => $field['options'],
+                                                'data-allow-clear' => 'false',
+                                                'select2'          => true,
+                                            ),
+                                            true
+                                        );
+                                    } else {
+                                        aui()->input(
+                                            array(
+                                                'type'        => $field['type'],
+                                                'id'          => 'wpinv_' . $key,
+                                                'name'        => 'wpinv_' . $key,
+                                                'label'       => $field['label'],
+                                                'label_type'  => 'vertical',
+                                                'placeholder' => isset( $field['placeholder'] ) ? $field['placeholder'] : '',
+                                                'class'       => 'form-control-sm ' . ( isset( $field['class'] ) ? $field['class'] : '' ),
+                                                'value'       => $invoice->get( $key, 'edit' ),
+                                            ),
+                                            true
+                                        );
+                                    }
+
+                                ?>
 							</div>
 						<?php endforeach; ?>
 					</div>
@@ -198,48 +198,48 @@ 
 						<div class="row">
 							<div class="col-12 col-sm-6">
 								<?php
-									aui()->select(
-										array(
-											'id'          => 'wpinv_template',
-											'name'        => 'wpinv_template',
-											'label'       => __( 'Template', 'invoicing' ),
-											'label_type'  => 'vertical',
-											'placeholder' => __( 'Choose a template', 'invoicing' ),
-											'class'       => 'form-control-sm',
-											'value'       => $invoice->get_template( 'edit' ),
-											'options'     => array(
-												'quantity' => __( 'Quantity', 'invoicing' ),
-												'hours'    => __( 'Hours', 'invoicing' ),
-											),
-											'data-allow-clear' => 'false',
-											'select2'     => true,
-										),
-										true
-									);
-								?>
+                                    aui()->select(
+                                        array(
+                                            'id'          => 'wpinv_template',
+                                            'name'        => 'wpinv_template',
+                                            'label'       => __( 'Template', 'invoicing' ),
+                                            'label_type'  => 'vertical',
+                                            'placeholder' => __( 'Choose a template', 'invoicing' ),
+                                            'class'       => 'form-control-sm',
+                                            'value'       => $invoice->get_template( 'edit' ),
+                                            'options'     => array(
+                                                'quantity' => __( 'Quantity', 'invoicing' ),
+                                                'hours'    => __( 'Hours', 'invoicing' ),
+                                            ),
+                                            'data-allow-clear' => 'false',
+                                            'select2'     => true,
+                                        ),
+                                        true
+                                    );
+                                ?>
 							</div>
 							<div class="col-12 col-sm-6">
 								<?php
 
-									// Set currency.
-									aui()->select(
-										array(
-											'id'          => 'wpinv_currency',
-											'name'        => 'wpinv_currency',
-											'label'       => __( 'Currency', 'invoicing' ),
-											'label_type'  => 'vertical',
-											'placeholder' => __( 'Select Invoice Currency', 'invoicing' ),
-											'class'       => 'form-control-sm getpaid-recalculate-prices-on-change',
-											'value'       => $invoice->get_currency( 'edit' ),
-											'required'    => false,
-											'data-allow-clear' => 'false',
-											'select2'     => true,
-											'options'     => wpinv_get_currencies(),
-										),
-										true
-									);
-
-								?>
+                                    // Set currency.
+                                    aui()->select(
+                                        array(
+                                            'id'          => 'wpinv_currency',
+                                            'name'        => 'wpinv_currency',
+                                            'label'       => __( 'Currency', 'invoicing' ),
+                                            'label_type'  => 'vertical',
+                                            'placeholder' => __( 'Select Invoice Currency', 'invoicing' ),
+                                            'class'       => 'form-control-sm getpaid-recalculate-prices-on-change',
+                                            'value'       => $invoice->get_currency( 'edit' ),
+                                            'required'    => false,
+                                            'data-allow-clear' => 'false',
+                                            'select2'     => true,
+                                            'options'     => wpinv_get_currencies(),
+                                        ),
+                                        true
+                                    );
+
+                                ?>
 							</div>
 						</div>
 
@@ -249,123 +249,123 @@ 
 					<div class="row">
 						<div class="col-12 col-sm-6">
 							<?php
-								aui()->input(
-									array(
-										'type'        => 'text',
-										'id'          => 'wpinv_company_id',
-										'name'        => 'wpinv_company_id',
-										'label'       => __( 'Company ID', 'invoicing' ),
-										'label_type'  => 'vertical',
-										'placeholder' => '',
-										'class'       => 'form-control-sm',
-										'value'       => $invoice->get_company_id( 'edit' ),
-									),
-									true
-								);
-							?>
+                                aui()->input(
+                                    array(
+                                        'type'        => 'text',
+                                        'id'          => 'wpinv_company_id',
+                                        'name'        => 'wpinv_company_id',
+                                        'label'       => __( 'Company ID', 'invoicing' ),
+                                        'label_type'  => 'vertical',
+                                        'placeholder' => '',
+                                        'class'       => 'form-control-sm',
+                                        'value'       => $invoice->get_company_id( 'edit' ),
+                                    ),
+                                    true
+                                );
+                            ?>
 						</div>
 					</div>
 
 					<?php do_action( 'getpaid_after_metabox_invoice_address', $invoice ); ?>
 			</div>
 		<?php
-	}
-
-	/**
-	 * Save meta box data.
-	 *
-	 * @param int $post_id
-	 * @param array $posted the posted data.
-	 */
-	public static function save( $post_id, $posted ) {
-
-		// Prepare the invoice.
-		$invoice = new WPInv_Invoice( $post_id );
-
-		// Load new data.
-		$invoice->set_props(
-			array(
-				'template'       => isset( $posted['wpinv_template'] ) ? wpinv_clean( $posted['wpinv_template'] ) : null,
-				'email_cc'       => isset( $posted['wpinv_cc'] ) ? wpinv_clean( $posted['wpinv_cc'] ) : null,
-				'disable_taxes'  => ! empty( $posted['disable_taxes'] ),
-				'currency'       => isset( $posted['wpinv_currency'] ) ? wpinv_clean( $posted['wpinv_currency'] ) : null,
-				'gateway'        => ( $invoice->needs_payment() && isset( $posted['wpinv_gateway'] ) ) ? wpinv_clean( $posted['wpinv_gateway'] ) : null,
-				'address'        => isset( $posted['wpinv_address'] ) ? wpinv_clean( $posted['wpinv_address'] ) : null,
-				'vat_number'     => isset( $posted['wpinv_vat_number'] ) ? wpinv_clean( $posted['wpinv_vat_number'] ) : null,
-				'company'        => isset( $posted['wpinv_company'] ) ? wpinv_clean( $posted['wpinv_company'] ) : null,
-				'company_id'     => isset( $posted['wpinv_company_id'] ) ? wpinv_clean( $posted['wpinv_company_id'] ) : null,
-				'zip'            => isset( $posted['wpinv_zip'] ) ? wpinv_clean( $posted['wpinv_zip'] ) : null,
-				'state'          => isset( $posted['wpinv_state'] ) ? wpinv_clean( $posted['wpinv_state'] ) : null,
-				'city'           => isset( $posted['wpinv_city'] ) ? wpinv_clean( $posted['wpinv_city'] ) : null,
-				'country'        => isset( $posted['wpinv_country'] ) ? wpinv_clean( $posted['wpinv_country'] ) : null,
-				'phone'          => isset( $posted['wpinv_phone'] ) ? wpinv_clean( $posted['wpinv_phone'] ) : null,
-				'first_name'     => isset( $posted['wpinv_first_name'] ) ? wpinv_clean( $posted['wpinv_first_name'] ) : null,
-				'last_name'      => isset( $posted['wpinv_last_name'] ) ? wpinv_clean( $posted['wpinv_last_name'] ) : null,
-				'author'         => isset( $posted['post_author_override'] ) ? wpinv_clean( $posted['post_author_override'] ) : null,
-				'date_created'   => isset( $posted['date_created'] ) ? wpinv_clean( $posted['date_created'] ) : null,
-				'date_completed' => isset( $posted['wpinv_date_completed'] ) ? wpinv_clean( $posted['wpinv_date_completed'] ) : null,
-				'due_date'       => isset( $posted['wpinv_due_date'] ) ? wpinv_clean( $posted['wpinv_due_date'] ) : null,
-				'number'         => isset( $posted['wpinv_number'] ) ? wpinv_clean( $posted['wpinv_number'] ) : null,
-				'status'         => isset( $posted['wpinv_status'] ) ? wpinv_clean( $posted['wpinv_status'] ) : null,
-			)
-		);
-
-		// Discount code.
-		if ( ! $invoice->is_paid() && ! $invoice->is_refunded() ) {
-
-			if ( isset( $posted['wpinv_discount_code'] ) ) {
-				$invoice->set_discount_code( wpinv_clean( $posted['wpinv_discount_code'] ) );
-			}
-
-			$discount = new WPInv_Discount( $invoice->get_discount_code() );
-			if ( $discount->exists() ) {
-				$invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) );
-			} else {
-				$invoice->remove_discount( 'discount_code' );
-			}
-
-			// Recalculate totals.
-			$invoice->recalculate_total();
-
-		}
-
-		// If we're creating a new user...
-		if ( ! empty( $posted['wpinv_new_user'] ) && is_email( stripslashes( $posted['wpinv_email'] ) ) ) {
-
-			// Attempt to create the user.
-			$user = wpinv_create_user( sanitize_email( stripslashes( $posted['wpinv_email'] ) ), $invoice->get_first_name() . $invoice->get_last_name() );
-
-			// If successful, update the invoice author.
-			if ( is_numeric( $user ) ) {
-				$invoice->set_author( $user );
-			} else {
-				wpinv_error_log( $user->get_error_message(), __( 'Invoice add new user', 'invoicing' ), __FILE__, __LINE__ );
-			}
-		}
-
-		// Do not send new invoice notifications.
-		$GLOBALS['wpinv_skip_invoice_notification'] = true;
-
-		// Save the invoice.
-		$invoice->save();
-
-		// Save the user address.
-		getpaid_save_invoice_user_address( $invoice );
-
-		// Undo do not send new invoice notifications.
-		$GLOBALS['wpinv_skip_invoice_notification'] = false;
-
-		// (Maybe) send new user notification.
-		$should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
-		if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ) ) ) {
-			wp_send_new_user_notifications( $user, 'user' );
-		}
-
-		if ( ! empty( $posted['send_to_customer'] ) && ! $invoice->is_draft() ) {
-			getpaid()->get( 'invoice_emails' )->user_invoice( $invoice, true );
-		}
-
-		// Fires after an invoice is saved.
-		do_action( 'wpinv_invoice_metabox_saved', $invoice );
-	}
+    }
+
+    /**
+     * Save meta box data.
+     *
+     * @param int $post_id
+     * @param array $posted the posted data.
+     */
+    public static function save( $post_id, $posted ) {
+
+        // Prepare the invoice.
+        $invoice = new WPInv_Invoice( $post_id );
+
+        // Load new data.
+        $invoice->set_props(
+            array(
+                'template'       => isset( $posted['wpinv_template'] ) ? wpinv_clean( $posted['wpinv_template'] ) : null,
+                'email_cc'       => isset( $posted['wpinv_cc'] ) ? wpinv_clean( $posted['wpinv_cc'] ) : null,
+                'disable_taxes'  => ! empty( $posted['disable_taxes'] ),
+                'currency'       => isset( $posted['wpinv_currency'] ) ? wpinv_clean( $posted['wpinv_currency'] ) : null,
+                'gateway'        => ( $invoice->needs_payment() && isset( $posted['wpinv_gateway'] ) ) ? wpinv_clean( $posted['wpinv_gateway'] ) : null,
+                'address'        => isset( $posted['wpinv_address'] ) ? wpinv_clean( $posted['wpinv_address'] ) : null,
+                'vat_number'     => isset( $posted['wpinv_vat_number'] ) ? wpinv_clean( $posted['wpinv_vat_number'] ) : null,
+                'company'        => isset( $posted['wpinv_company'] ) ? wpinv_clean( $posted['wpinv_company'] ) : null,
+                'company_id'     => isset( $posted['wpinv_company_id'] ) ? wpinv_clean( $posted['wpinv_company_id'] ) : null,
+                'zip'            => isset( $posted['wpinv_zip'] ) ? wpinv_clean( $posted['wpinv_zip'] ) : null,
+                'state'          => isset( $posted['wpinv_state'] ) ? wpinv_clean( $posted['wpinv_state'] ) : null,
+                'city'           => isset( $posted['wpinv_city'] ) ? wpinv_clean( $posted['wpinv_city'] ) : null,
+                'country'        => isset( $posted['wpinv_country'] ) ? wpinv_clean( $posted['wpinv_country'] ) : null,
+                'phone'          => isset( $posted['wpinv_phone'] ) ? wpinv_clean( $posted['wpinv_phone'] ) : null,
+                'first_name'     => isset( $posted['wpinv_first_name'] ) ? wpinv_clean( $posted['wpinv_first_name'] ) : null,
+                'last_name'      => isset( $posted['wpinv_last_name'] ) ? wpinv_clean( $posted['wpinv_last_name'] ) : null,
+                'author'         => isset( $posted['post_author_override'] ) ? wpinv_clean( $posted['post_author_override'] ) : null,
+                'date_created'   => isset( $posted['date_created'] ) ? wpinv_clean( $posted['date_created'] ) : null,
+                'date_completed' => isset( $posted['wpinv_date_completed'] ) ? wpinv_clean( $posted['wpinv_date_completed'] ) : null,
+                'due_date'       => isset( $posted['wpinv_due_date'] ) ? wpinv_clean( $posted['wpinv_due_date'] ) : null,
+                'number'         => isset( $posted['wpinv_number'] ) ? wpinv_clean( $posted['wpinv_number'] ) : null,
+                'status'         => isset( $posted['wpinv_status'] ) ? wpinv_clean( $posted['wpinv_status'] ) : null,
+            )
+        );
+
+        // Discount code.
+        if ( ! $invoice->is_paid() && ! $invoice->is_refunded() ) {
+
+            if ( isset( $posted['wpinv_discount_code'] ) ) {
+                $invoice->set_discount_code( wpinv_clean( $posted['wpinv_discount_code'] ) );
+            }
+
+            $discount = new WPInv_Discount( $invoice->get_discount_code() );
+            if ( $discount->exists() ) {
+                $invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) );
+            } else {
+                $invoice->remove_discount( 'discount_code' );
+            }
+
+            // Recalculate totals.
+            $invoice->recalculate_total();
+
+        }
+
+        // If we're creating a new user...
+        if ( ! empty( $posted['wpinv_new_user'] ) && is_email( stripslashes( $posted['wpinv_email'] ) ) ) {
+
+            // Attempt to create the user.
+            $user = wpinv_create_user( sanitize_email( stripslashes( $posted['wpinv_email'] ) ), $invoice->get_first_name() . $invoice->get_last_name() );
+
+            // If successful, update the invoice author.
+            if ( is_numeric( $user ) ) {
+                $invoice->set_author( $user );
+            } else {
+                wpinv_error_log( $user->get_error_message(), __( 'Invoice add new user', 'invoicing' ), __FILE__, __LINE__ );
+            }
+        }
+
+        // Do not send new invoice notifications.
+        $GLOBALS['wpinv_skip_invoice_notification'] = true;
+
+        // Save the invoice.
+        $invoice->save();
+
+        // Save the user address.
+        getpaid_save_invoice_user_address( $invoice );
+
+        // Undo do not send new invoice notifications.
+        $GLOBALS['wpinv_skip_invoice_notification'] = false;
+
+        // (Maybe) send new user notification.
+        $should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
+        if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ) ) ) {
+            wp_send_new_user_notifications( $user, 'user' );
+        }
+
+        if ( ! empty( $posted['send_to_customer'] ) && ! $invoice->is_draft() ) {
+            getpaid()->get( 'invoice_emails' )->user_invoice( $invoice, true );
+        }
+
+        // Fires after an invoice is saved.
+        do_action( 'wpinv_invoice_metabox_saved', $invoice );
+    }
 }