AyeCode / invoicing

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

Indentation +659 added lines, -659 removed lines

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

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

Indentation +573 added lines, -573 removed lines

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

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

Indentation +189 added lines, -189 removed lines

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

includes/admin/subscriptions.php

Indentation +203 added lines, -203 removed lines

@@ -14,7 +14,7 @@ 
  */
 function wpinv_subscriptions_page() {
 
-	?>
+    ?>
 
 	<div class="wrap">
 		<h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
@@ -22,27 +22,27 @@ 
 
 			<?php
 
-				// Verify user permissions.
-				if ( ! wpinv_current_user_can_manage_invoicing() ) {
+                // Verify user permissions.
+                if ( ! wpinv_current_user_can_manage_invoicing() ) {
 
-					echo aui()->alert(
-						array(
-							'type'    => 'danger',
-							'content' => __( 'You are not permitted to view this page.', 'invoicing' ),
-						)
-					);
+                    echo aui()->alert(
+                        array(
+                            'type'    => 'danger',
+                            'content' => __( 'You are not permitted to view this page.', 'invoicing' ),
+                        )
+                    );
 
-				} else if ( ! empty( $_GET['id'] ) && is_numeric( $_GET['id'] ) ) {
+                } else if ( ! empty( $_GET['id'] ) && is_numeric( $_GET['id'] ) ) {
 
-					// Display a single subscription.
-					wpinv_recurring_subscription_details();
-				} else {
+                    // Display a single subscription.
+                    wpinv_recurring_subscription_details();
+                } else {
 
-					// Display a list of available subscriptions.
-					getpaid_print_subscriptions_list();
-				}
+                    // Display a list of available subscriptions.
+                    getpaid_print_subscriptions_list();
+                }
 
-			?>
+            ?>
 
 		</div>
 	</div>
@@ -59,10 +59,10 @@ 
  */
 function getpaid_print_subscriptions_list() {
 
-	$subscribers_table = new WPInv_Subscriptions_List_Table();
-	$subscribers_table->prepare_items();
+    $subscribers_table = new WPInv_Subscriptions_List_Table();
+    $subscribers_table->prepare_items();
 
-	?>
+    ?>
 	<form id="subscribers-filter" class="bsui" method="get">
 		<input type="hidden" name="page" value="wpinv-subscriptions" />
 		<?php $subscribers_table->views(); ?>
@@ -80,27 +80,27 @@ 
  */
 function wpinv_recurring_subscription_details() {
 
-	// Fetch the subscription.
-	$sub = new WPInv_Subscription( (int) $_GET['id'] );
-	if ( ! $sub->get_id() ) {
+    // Fetch the subscription.
+    $sub = new WPInv_Subscription( (int) $_GET['id'] );
+    if ( ! $sub->get_id() ) {
 
-		echo aui()->alert(
-			array(
-				'type'    => 'danger',
-				'content' => __( 'Subscription not found.', 'invoicing' ),
-			)
-		);
+        echo aui()->alert(
+            array(
+                'type'    => 'danger',
+                'content' => __( 'Subscription not found.', 'invoicing' ),
+            )
+        );
 
-		return;
-	}
+        return;
+    }
 
-	// Use metaboxes to display the subscription details.
-	add_meta_box( 'getpaid_admin_subscription_details_metabox', __( 'Subscription Details', 'invoicing' ), 'getpaid_admin_subscription_details_metabox', get_current_screen(), 'normal' );
-	add_meta_box( 'getpaid_admin_subscription_update_metabox', __( 'Change Status', 'invoicing' ), 'getpaid_admin_subscription_update_metabox', get_current_screen(), 'side' );
-	add_meta_box( 'getpaid_admin_subscription_invoice_details_metabox', __( 'Invoices', 'invoicing' ), 'getpaid_admin_subscription_invoice_details_metabox', get_current_screen(), 'advanced' );
-	do_action( 'getpaid_admin_single_subscription_register_metabox', $sub );
+    // Use metaboxes to display the subscription details.
+    add_meta_box( 'getpaid_admin_subscription_details_metabox', __( 'Subscription Details', 'invoicing' ), 'getpaid_admin_subscription_details_metabox', get_current_screen(), 'normal' );
+    add_meta_box( 'getpaid_admin_subscription_update_metabox', __( 'Change Status', 'invoicing' ), 'getpaid_admin_subscription_update_metabox', get_current_screen(), 'side' );
+    add_meta_box( 'getpaid_admin_subscription_invoice_details_metabox', __( 'Invoices', 'invoicing' ), 'getpaid_admin_subscription_invoice_details_metabox', get_current_screen(), 'advanced' );
+    do_action( 'getpaid_admin_single_subscription_register_metabox', $sub );
 
-	?>
+    ?>
 
 		<form method="post" action="<?php echo admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $sub->get_id() ) ); ?>">
 
@@ -140,41 +140,41 @@ 
  */
 function getpaid_admin_subscription_details_metabox( $sub ) {
 
-	// Prepare subscription detail columns.
-	$fields = apply_filters(
-		'getpaid_subscription_admin_page_fields',
-		array(
-			'subscription'   => __( 'Subscription', 'invoicing' ),
-			'customer'       => __( 'Customer', 'invoicing' ),
-			'amount'         => __( 'Amount', 'invoicing' ),
-			'start_date'     => __( 'Start Date', 'invoicing' ),
-			'renews_on'      => __( 'Next Payment', 'invoicing' ),
-			'renewals'       => __( 'Payments', 'invoicing' ),
-			'item'           => __( 'Item', 'invoicing' ),
-			'gateway'        => __( 'Payment Method', 'invoicing' ),
-			'profile_id'     => __( 'Profile ID', 'invoicing' ),
-			'status'         => __( 'Status', 'invoicing' ),
-		)
-	);
-
-	if ( ! $sub->is_active() ) {
-
-		if ( isset( $fields['renews_on'] ) ) {
-			unset( $fields['renews_on'] );
-		}
-
-		if ( isset( $fields['gateway'] ) ) {
-			unset( $fields['gateway'] );
-		}
+    // Prepare subscription detail columns.
+    $fields = apply_filters(
+        'getpaid_subscription_admin_page_fields',
+        array(
+            'subscription'   => __( 'Subscription', 'invoicing' ),
+            'customer'       => __( 'Customer', 'invoicing' ),
+            'amount'         => __( 'Amount', 'invoicing' ),
+            'start_date'     => __( 'Start Date', 'invoicing' ),
+            'renews_on'      => __( 'Next Payment', 'invoicing' ),
+            'renewals'       => __( 'Payments', 'invoicing' ),
+            'item'           => __( 'Item', 'invoicing' ),
+            'gateway'        => __( 'Payment Method', 'invoicing' ),
+            'profile_id'     => __( 'Profile ID', 'invoicing' ),
+            'status'         => __( 'Status', 'invoicing' ),
+        )
+    );
+
+    if ( ! $sub->is_active() ) {
+
+        if ( isset( $fields['renews_on'] ) ) {
+            unset( $fields['renews_on'] );
+        }
+
+        if ( isset( $fields['gateway'] ) ) {
+            unset( $fields['gateway'] );
+        }
 		
-	}
+    }
 
-	$profile_id = $sub->get_profile_id();
-	if ( empty( $profile_id ) && isset( $fields['profile_id'] ) ) {
-		unset( $fields['profile_id'] );
-	}
+    $profile_id = $sub->get_profile_id();
+    if ( empty( $profile_id ) && isset( $fields['profile_id'] ) ) {
+        unset( $fields['profile_id'] );
+    }
 
-	?>
+    ?>
 
 		<table class="table table-borderless" style="font-size: 14px;">
 			<tbody>
@@ -208,20 +208,20 @@ 
  */
 function getpaid_admin_subscription_metabox_display_customer( $subscription ) {
 
-	$username = __( '(Missing User)', 'invoicing' );
+    $username = __( '(Missing User)', 'invoicing' );
 
-	$user = get_userdata( $subscription->get_customer_id() );
-	if ( $user ) {
+    $user = get_userdata( $subscription->get_customer_id() );
+    if ( $user ) {
 
-		$username = sprintf(
-			'<a href="user-edit.php?user_id=%s">%s</a>',
-			absint( $user->ID ),
-			! empty( $user->display_name ) ? sanitize_text_field( $user->display_name ) : sanitize_email( $user->user_email )
-		);
+        $username = sprintf(
+            '<a href="user-edit.php?user_id=%s">%s</a>',
+            absint( $user->ID ),
+            ! empty( $user->display_name ) ? sanitize_text_field( $user->display_name ) : sanitize_email( $user->user_email )
+        );
 
-	}
+    }
 
-	echo  $username;
+    echo  $username;
 }
 add_action( 'getpaid_subscription_admin_display_customer', 'getpaid_admin_subscription_metabox_display_customer' );
 
@@ -231,8 +231,8 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_amount( $subscription ) {
-	$amount    = sanitize_text_field( getpaid_get_formatted_subscription_amount( $subscription ) );
-	echo "<span>$amount</span>";
+    $amount    = sanitize_text_field( getpaid_get_formatted_subscription_amount( $subscription ) );
+    echo "<span>$amount</span>";
 }
 add_action( 'getpaid_subscription_admin_display_amount', 'getpaid_admin_subscription_metabox_display_amount' );
 
@@ -242,7 +242,7 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_id( $subscription ) {
-	echo  '#' . absint( $subscription->get_id() );
+    echo  '#' . absint( $subscription->get_id() );
 }
 add_action( 'getpaid_subscription_admin_display_subscription', 'getpaid_admin_subscription_metabox_display_id' );
 
@@ -252,7 +252,7 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_start_date( $subscription ) {
-	echo getpaid_format_date_value( $subscription->get_date_created() );
+    echo getpaid_format_date_value( $subscription->get_date_created() );
 }
 add_action( 'getpaid_subscription_admin_display_start_date', 'getpaid_admin_subscription_metabox_display_start_date' );
 
@@ -262,7 +262,7 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_renews_on( $subscription ) {
-	echo getpaid_format_date_value( $subscription->get_expiration() );
+    echo getpaid_format_date_value( $subscription->get_expiration() );
 }
 add_action( 'getpaid_subscription_admin_display_renews_on', 'getpaid_admin_subscription_metabox_display_renews_on' );
 
@@ -272,8 +272,8 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_renewals( $subscription ) {
-	$max_bills = $subscription->get_bill_times();
-	echo $subscription->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "&infin;" : $max_bills );
+    $max_bills = $subscription->get_bill_times();
+    echo $subscription->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "&infin;" : $max_bills );
 }
 add_action( 'getpaid_subscription_admin_display_renewals', 'getpaid_admin_subscription_metabox_display_renewals' );
 /**
@@ -283,16 +283,16 @@ 
  */
 function getpaid_admin_subscription_metabox_display_item( $subscription ) {
 
-	$item = get_post( $subscription->get_product_id() );
+    $item = get_post( $subscription->get_product_id() );
 
-	if ( ! empty( $item ) ) {
-		$link = get_edit_post_link( $item );
-		$link = esc_url( $link );
-		$name = esc_html( get_the_title( $item ) );
-		echo "<a href='$link'>$name</a>";
-	} else {
-		echo sprintf( __( 'Item #%s', 'invoicing' ), $subscription->get_product_id() );
-	}
+    if ( ! empty( $item ) ) {
+        $link = get_edit_post_link( $item );
+        $link = esc_url( $link );
+        $name = esc_html( get_the_title( $item ) );
+        echo "<a href='$link'>$name</a>";
+    } else {
+        echo sprintf( __( 'Item #%s', 'invoicing' ), $subscription->get_product_id() );
+    }
 
 }
 add_action( 'getpaid_subscription_admin_display_item', 'getpaid_admin_subscription_metabox_display_item' );
@@ -304,13 +304,13 @@ 
  */
 function getpaid_admin_subscription_metabox_display_gateway( $subscription ) {
 
-	$gateway = $subscription->get_gateway();
+    $gateway = $subscription->get_gateway();
 
-	if ( ! empty( $gateway ) ) {
-		echo sanitize_text_field( wpinv_get_gateway_admin_label( $gateway ) );
-	} else {
-		echo "&mdash;";
-	}
+    if ( ! empty( $gateway ) ) {
+        echo sanitize_text_field( wpinv_get_gateway_admin_label( $gateway ) );
+    } else {
+        echo "&mdash;";
+    }
 
 }
 add_action( 'getpaid_subscription_admin_display_gateway', 'getpaid_admin_subscription_metabox_display_gateway' );
@@ -321,7 +321,7 @@ 
  * @param WPInv_Subscription $subscription
  */
 function getpaid_admin_subscription_metabox_display_status( $subscription ) {
-	echo $subscription->get_status_label_html();
+    echo $subscription->get_status_label_html();
 }
 add_action( 'getpaid_subscription_admin_display_status', 'getpaid_admin_subscription_metabox_display_status' );
 
@@ -332,14 +332,14 @@ 
  */
 function getpaid_admin_subscription_metabox_display_profile_id( $subscription ) {
 
-	$profile_id = $subscription->get_profile_id();
+    $profile_id = $subscription->get_profile_id();
 
-	if ( ! empty( $profile_id ) ) {
-		$profile_id = sanitize_text_field( $profile_id );
-		echo apply_filters( 'getpaid_subscription_profile_id_display', $profile_id, $subscription );
-	} else {
-		echo "&mdash;";
-	}
+    if ( ! empty( $profile_id ) ) {
+        $profile_id = sanitize_text_field( $profile_id );
+        echo apply_filters( 'getpaid_subscription_profile_id_display', $profile_id, $subscription );
+    } else {
+        echo "&mdash;";
+    }
 
 }
 add_action( 'getpaid_subscription_admin_display_profile_id', 'getpaid_admin_subscription_metabox_display_profile_id' );
@@ -351,39 +351,39 @@ 
  */
 function getpaid_admin_subscription_update_metabox( $subscription ) {
 
-	?>
+    ?>
 	<div class="mt-3">
 
 		<?php
-			echo aui()->select(
-				array(
-					'options'          => getpaid_get_subscription_statuses(),
-					'name'             => 'subscription_status',
-					'id'               => 'subscription_status_update_select',
-					'required'         => true,
-					'no_wrap'          => false,
-					'label'            => __( 'Subscription Status', 'invoicing' ),
-					'help_text'        => __( 'Updating the status will trigger related actions and hooks', 'invoicing' ),
-					'select2'          => true,
-					'value'            => $subscription->get_status( 'edit' ),
-				)
-			);
-		?>
+            echo aui()->select(
+                array(
+                    'options'          => getpaid_get_subscription_statuses(),
+                    'name'             => 'subscription_status',
+                    'id'               => 'subscription_status_update_select',
+                    'required'         => true,
+                    'no_wrap'          => false,
+                    'label'            => __( 'Subscription Status', 'invoicing' ),
+                    'help_text'        => __( 'Updating the status will trigger related actions and hooks', 'invoicing' ),
+                    'select2'          => true,
+                    'value'            => $subscription->get_status( 'edit' ),
+                )
+            );
+        ?>
 
 		<div class="mt-2 px-3 py-2 bg-light border-top" style="margin: -12px;">
 	
 		<?php
-			submit_button( __( 'Update', 'invoicing' ), 'primary', 'submit', false );
+            submit_button( __( 'Update', 'invoicing' ), 'primary', 'submit', false );
 
-			$url    = esc_url( wp_nonce_url( add_query_arg( 'getpaid-admin-action', 'subscription_manual_renew' ), 'getpaid-nonce', 'getpaid-nonce' ) );
-			$anchor = __( 'Renew Subscription', 'invoicing' );
-			$title  = esc_attr__( 'Are you sure you want to extend the subscription and generate a new invoice that will be automatically marked as paid?', 'invoicing' );
+            $url    = esc_url( wp_nonce_url( add_query_arg( 'getpaid-admin-action', 'subscription_manual_renew' ), 'getpaid-nonce', 'getpaid-nonce' ) );
+            $anchor = __( 'Renew Subscription', 'invoicing' );
+            $title  = esc_attr__( 'Are you sure you want to extend the subscription and generate a new invoice that will be automatically marked as paid?', 'invoicing' );
 
-			if ( $subscription->is_active() ) {
-				echo "<a href='$url' class='float-right text-muted' onclick='return confirm(\"$title\")'>$anchor</a>";
-			}
+            if ( $subscription->is_active() ) {
+                echo "<a href='$url' class='float-right text-muted' onclick='return confirm(\"$title\")'>$anchor</a>";
+            }
 
-	echo '</div></div>';
+    echo '</div></div>';
 }
 
 /**
@@ -393,33 +393,33 @@ 
  */
 function getpaid_admin_subscription_invoice_details_metabox( $subscription ) {
 
-	$columns = apply_filters(
-		'getpaid_subscription_related_invoices_columns',
-		array(
-			'invoice'      => __( 'Invoice', 'invoicing' ),
-			'relationship' => __( 'Relationship', 'invoicing' ),
-			'date'         => __( 'Date', 'invoicing' ),
-			'status'       => __( 'Status', 'invoicing' ),
-			'total'        => __( 'Total', 'invoicing' ),
-		),
-		$subscription
-	);
-
-	// Prepare the invoices.
-	$payments = $subscription->get_child_payments( ! is_admin() );
-	$parent   = $subscription->get_parent_invoice();
-
-	if ( $parent->get_id() ) {
-		$payments = array_merge( array( $parent ), $payments );
-	}
+    $columns = apply_filters(
+        'getpaid_subscription_related_invoices_columns',
+        array(
+            'invoice'      => __( 'Invoice', 'invoicing' ),
+            'relationship' => __( 'Relationship', 'invoicing' ),
+            'date'         => __( 'Date', 'invoicing' ),
+            'status'       => __( 'Status', 'invoicing' ),
+            'total'        => __( 'Total', 'invoicing' ),
+        ),
+        $subscription
+    );
+
+    // Prepare the invoices.
+    $payments = $subscription->get_child_payments( ! is_admin() );
+    $parent   = $subscription->get_parent_invoice();
+
+    if ( $parent->get_id() ) {
+        $payments = array_merge( array( $parent ), $payments );
+    }
 	
-	$table_class = 'w-100 bg-white';
+    $table_class = 'w-100 bg-white';
 
-	if ( ! is_admin() ) {
-		$table_class = 'table table-bordered table-striped';
-	}
+    if ( ! is_admin() ) {
+        $table_class = 'table table-bordered table-striped';
+    }
 
-	?>
+    ?>
 		<div class="m-0" style="overflow: auto;">
 
 			<table class="<?php echo $table_class; ?>">
@@ -427,13 +427,13 @@ 
 				<thead>
 					<tr>
 						<?php
-							foreach ( $columns as $key => $label ) {
-								$key   = esc_attr( $key );
-								$label = sanitize_text_field( $label );
+                            foreach ( $columns as $key => $label ) {
+                                $key   = esc_attr( $key );
+                                $label = sanitize_text_field( $label );
 
-								echo "<th class='subscription-invoice-field-$key bg-light p-2 text-left color-dark font-weight-bold'>$label</th>";
-							}
-						?>
+                                echo "<th class='subscription-invoice-field-$key bg-light p-2 text-left color-dark font-weight-bold'>$label</th>";
+                            }
+                        ?>
 					</tr>
 				</thead>
 
@@ -449,66 +449,66 @@ 
 
 					<?php
 
-						foreach( $payments as $payment ) :
+                        foreach( $payments as $payment ) :
 
-							// Ensure that we have an invoice.
-							$payment = new WPInv_Invoice( $payment );
+                            // Ensure that we have an invoice.
+                            $payment = new WPInv_Invoice( $payment );
 
-							// Abort if the invoice is invalid.
-							if ( ! $payment->get_id() ) {
-								continue;
-							}
+                            // Abort if the invoice is invalid.
+                            if ( ! $payment->get_id() ) {
+                                continue;
+                            }
 
-							echo '<tr>';
+                            echo '<tr>';
 
-								foreach ( array_keys( $columns ) as $key ) {
+                                foreach ( array_keys( $columns ) as $key ) {
 
-									echo '<td class="p-2 text-left">';
+                                    echo '<td class="p-2 text-left">';
 
-										switch( $key ) {
+                                        switch( $key ) {
 
-											case 'total':
-												echo '<strong>' . wpinv_price( $payment->get_total(), $payment->get_currency() ) . '</strong>';
-												break;
+                                            case 'total':
+                                                echo '<strong>' . wpinv_price( $payment->get_total(), $payment->get_currency() ) . '</strong>';
+                                                break;
 
-											case 'relationship':
-												echo $payment->is_renewal() ? __( 'Renewal Invoice', 'invoicing' ) : __( 'Initial Invoice', 'invoicing' );
-												break;
+                                            case 'relationship':
+                                                echo $payment->is_renewal() ? __( 'Renewal Invoice', 'invoicing' ) : __( 'Initial Invoice', 'invoicing' );
+                                                break;
 
-											case 'date':
-												echo getpaid_format_date_value( $payment->get_date_created() );
-												break;
+                                            case 'date':
+                                                echo getpaid_format_date_value( $payment->get_date_created() );
+                                                break;
 
-											case 'status':
+                                            case 'status':
 
-												$status = $payment->get_status_nicename();
-												if ( is_admin() ) {
-													$status = $payment->get_status_label_html();
-												}
+                                                $status = $payment->get_status_nicename();
+                                                if ( is_admin() ) {
+                                                    $status = $payment->get_status_label_html();
+                                                }
 
-												echo $status;
-												break;
+                                                echo $status;
+                                                break;
 
-											case 'invoice':
-												$link    = esc_url( get_edit_post_link( $payment->get_id() ) );
+                                            case 'invoice':
+                                                $link    = esc_url( get_edit_post_link( $payment->get_id() ) );
 
-												if ( ! is_admin() ) {
-													$link = esc_url( $payment->get_view_url() );
-												}
+                                                if ( ! is_admin() ) {
+                                                    $link = esc_url( $payment->get_view_url() );
+                                                }
 
-												$invoice = sanitize_text_field( $payment->get_number() );
-												echo "<a href='$link'>$invoice</a>";
-												break;
-										}
+                                                $invoice = sanitize_text_field( $payment->get_number() );
+                                                echo "<a href='$link'>$invoice</a>";
+                                                break;
+                                        }
 
-									echo '</td>';
+                                    echo '</td>';
 
-								}
+                                }
 
-							echo '</tr>';
+                            echo '</tr>';
 
-						endforeach;
-					?>
+                        endforeach;
+                    ?>
 
 				</tbody>
 

includes/subscription-functions.php

Indentation +146 added lines, -146 removed lines

@@ -17,28 +17,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;
 }
 
 /**
@@ -48,18 +48,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' ),
+        )
+    );
 
 }
 
@@ -69,8 +69,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 ) );
 }
 
 /**
@@ -80,18 +80,18 @@ 
  */
 function getpaid_get_subscription_status_classes() {
 
-	return apply_filters(
-		'getpaid_get_subscription_status_classes',
-		array(
-			'pending'    => 'badge-dark',
-			'trialling'  => 'badge-info',
-			'active'     => 'badge-success',
-			'failing'    => 'badge-warning',
-			'expired'    => 'badge-danger',
-			'completed'  => 'badge-primary',
-			'cancelled'  => 'badge-secondary',
-		)
-	);
+    return apply_filters(
+        'getpaid_get_subscription_status_classes',
+        array(
+            'pending'    => 'badge-dark',
+            'trialling'  => 'badge-info',
+            'active'     => 'badge-success',
+            'failing'    => 'badge-warning',
+            'expired'    => 'badge-danger',
+            'completed'  => 'badge-primary',
+            'cancelled'  => 'badge-secondary',
+        )
+    );
 
 }
 
@@ -102,15 +102,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;
 
 }
 
@@ -121,32 +121,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' ),
+            ),
 
-		)
-	);
+        )
+    );
 
 }
 
@@ -157,7 +157,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 );
 }
 
 /**
@@ -167,7 +167,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 ) );
 }
 
 /**
@@ -178,8 +178,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 ) );
 }
 
 /**
@@ -190,22 +190,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 '';
 }
 
 /**
@@ -217,22 +217,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 '';
 }
 
 /**
@@ -243,50 +243,50 @@ 
  */
 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(), '' );
+    $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(), '' );
 
-	// Trial periods.
-	if ( $subscription->has_trial_period() ) {
+    // 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() );
-		return sprintf(
+        $trial_period   = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() );
+        $trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() );
+        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
+            // 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
 
-		);
+        );
 
-	}
+    }
 
-	if ( $initial != $recurring ) {
+    if ( $initial != $recurring ) {
 
-		return sprintf(
+        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
+            // 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(
+    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
+        // 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
 
-	);
+    );
 
 }
 
@@ -297,7 +297,7 @@ 
  * @return WPInv_Subscription|bool
  */
 function getpaid_get_invoice_subscription( $invoice ) {
-	return getpaid_subscriptions()->get_invoice_subscription( $invoice );
+    return getpaid_subscriptions()->get_invoice_subscription( $invoice );
 }
 
 /**
@@ -306,10 +306,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();
+    }
 }
 
 /**
@@ -318,7 +318,7 @@ 
  * @return WPInv_Subscriptions
  */
 function getpaid_subscriptions() {
-	return getpaid()->get( 'subscriptions' );
+    return getpaid()->get( 'subscriptions' );
 }
 
 /**
@@ -336,14 +336,14 @@ 
         return false;
     }
 
-	// Fetch the invoiec subscription.
-	$subscription = getpaid_get_subscriptions(
-		array(
-			'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(),
-			'number'     => 1,
-		)
-	);
+    // Fetch the invoiec 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];
 
 }

includes/class-getpaid-subscription-notification-emails.php

Indentation +239 added lines, -239 removed lines

@@ -13,282 +13,282 @@
 class GetPaid_Subscription_Notification_Emails {
 
     /**
-	 * The array of subscription email actions.
-	 *
-	 * @param array
-	 */
-	public $subscription_actions;
+     * The array of subscription email actions.
+     *
+     * @param array
+     */
+    public $subscription_actions;
 
     /**
-	 * Class constructor
+     * Class constructor
      *
-	 */
-	public function __construct() {
-
-		$this->subscription_actions = apply_filters(
-			'getpaid_notification_email_subscription_triggers',
-			array(
-				'getpaid_subscription_trialling' => 'subscription_trial',
-				'getpaid_subscription_cancelled' => 'subscription_cancelled',
-				'getpaid_subscription_expired'   => 'subscription_expired',
-				'getpaid_subscription_completed' => 'subscription_complete',
-				'getpaid_daily_maintenance'      => 'renewal_reminder',
-			)
-		);
-
-		$this->init_hooks();
+     */
+    public function __construct() {
+
+        $this->subscription_actions = apply_filters(
+            'getpaid_notification_email_subscription_triggers',
+            array(
+                'getpaid_subscription_trialling' => 'subscription_trial',
+                'getpaid_subscription_cancelled' => 'subscription_cancelled',
+                'getpaid_subscription_expired'   => 'subscription_expired',
+                'getpaid_subscription_completed' => 'subscription_complete',
+                'getpaid_daily_maintenance'      => 'renewal_reminder',
+            )
+        );
+
+        $this->init_hooks();
 
     }
 
     /**
-	 * Registers email hooks.
-	 */
-	public function init_hooks() {
-
-		add_filter( 'getpaid_get_email_merge_tags', array( $this, 'subscription_merge_tags' ), 10, 2 );
-		foreach ( $this->subscription_actions as $hook => $email_type ) {
-
-			$email = new GetPaid_Notification_Email( $email_type );
-
-			if ( ! $email->is_active() ) {
-				continue;
-			}
-
-			if ( method_exists( $this, $email_type ) ) {
-				add_action( $hook, array( $this, $email_type ), 100, 2 );
-				continue;
-			}
-
-			do_action( 'getpaid_subscription_notification_email_register_hook', $email_type, $hook );
-
-		}
-
-	}
-
-	/**
-	 * Filters subscription merge tags.
-	 *
-	 * @param array $merge_tags
-	 * @param mixed|WPInv_Invoice|WPInv_Subscription $object
-	 */
-	public function subscription_merge_tags( $merge_tags, $object ) {
-
-		if ( is_a( $object, 'WPInv_Subscription' ) ) {
-			$merge_tags = array_merge(
-				$merge_tags,
-				$this->get_subscription_merge_tags( $object )
-			);
-		}
-
-		return $merge_tags;
-
-	}
-
-	/**
-	 * Generates subscription merge tags.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 * @return array
-	 */
-	public function get_subscription_merge_tags( $subscription ) {
-
-		// Abort if it does not exist.
-		if ( ! $subscription->get_id() ) {
-			return array();
-		}
-
-		$invoice    = $subscription->get_parent_invoice();
-		return array(
-			'{subscription_renewal_date}'     => getpaid_format_date_value( $subscription->get_next_renewal_date(), __( 'Never', 'invoicing' ) ),
-			'{subscription_created}'          => getpaid_format_date_value( $subscription->get_date_created() ),
-			'{subscription_status}'           => sanitize_text_field( $subscription->get_status_label() ),
-			'{subscription_profile_id}'       => sanitize_text_field( $subscription->get_profile_id() ),
-			'{subscription_id}'               => absint( $subscription->get_id() ),
-			'{subscription_recurring_amount}' => sanitize_text_field( wpinv_price( $subscription->get_recurring_amount(), $invoice->get_currency() ) ),
-			'{subscription_initial_amount}'   => sanitize_text_field( wpinv_price( $subscription->get_initial_amount(), $invoice->get_currency() ) ),
-			'{subscription_recurring_period}' => getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ),
-			'{subscription_bill_times}'       => $subscription->get_bill_times(),
-			'{subscription_url}'              => esc_url( $subscription->get_view_url() ),
-		);
-
-	}
-
-	/**
-	 * Checks if we should send a notification for a subscription.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @return bool
-	 */
-	public function should_send_notification( $invoice ) {
-		return 0 != $invoice->get_id();
-	}
-
-	/**
-	 * Returns notification recipients.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @return array
-	 */
-	public function get_recipients( $invoice ) {
-		$recipients = array( $invoice->get_email() );
-
-		$cc = $invoice->get_email_cc();
-
-		if ( ! empty( $cc ) ) {
-			$cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
-			$recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
-		}
-
-		return $recipients;
-	}
-
-	/**
-	 * Helper function to send an email.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 * @param GetPaid_Notification_Email $email
-	 * @param string $type
-	 * @param array $extra_args Extra template args.
-	 */
-	public function send_email( $subscription, $email, $type, $extra_args = array() ) {
-
-		// Abort in case the parent invoice does not exist.
-		$invoice = $subscription->get_parent_invoice();
-		if ( ! $this->should_send_notification( $invoice ) ) {
-			return;
-		}
-
-		do_action( 'getpaid_before_send_subscription_notification', $type, $subscription, $email );
-
-		$recipients  = $this->get_recipients( $invoice );
-		$mailer      = new GetPaid_Notification_Email_Sender();
-		$merge_tags  = $email->get_merge_tags();
-		$content     = $email->get_content( $merge_tags, $extra_args );
-		$subject     = $email->add_merge_tags( $email->get_subject(), $merge_tags );
-		$attachments = $email->get_attachments();
-
-		$result = $mailer->send(
-			apply_filters( 'getpaid_subscription_email_recipients', wpinv_parse_list( $recipients ), $email ),
-			$subject,
-			$content,
-			$attachments
-		);
-
-		// Maybe send a copy to the admin.
-		if ( $email->include_admin_bcc() ) {
-			$mailer->send(
-				wpinv_get_admin_email(),
-				$subject . __( ' - ADMIN BCC COPY', 'invoicing' ),
-				$content,
-				$attachments
-			);
-		}
-
-		if ( ! $result ) {
-			$subscription->get_parent_invoice()->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true );
-		}
-
-		do_action( 'getpaid_after_send_subscription_notification', $type, $subscription, $email );
-
-	}
+     * Registers email hooks.
+     */
+    public function init_hooks() {
+
+        add_filter( 'getpaid_get_email_merge_tags', array( $this, 'subscription_merge_tags' ), 10, 2 );
+        foreach ( $this->subscription_actions as $hook => $email_type ) {
+
+            $email = new GetPaid_Notification_Email( $email_type );
+
+            if ( ! $email->is_active() ) {
+                continue;
+            }
+
+            if ( method_exists( $this, $email_type ) ) {
+                add_action( $hook, array( $this, $email_type ), 100, 2 );
+                continue;
+            }
+
+            do_action( 'getpaid_subscription_notification_email_register_hook', $email_type, $hook );
+
+        }
+
+    }
 
     /**
-	 * Sends a new trial notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_trial( $subscription ) {
+     * Filters subscription merge tags.
+     *
+     * @param array $merge_tags
+     * @param mixed|WPInv_Invoice|WPInv_Subscription $object
+     */
+    public function subscription_merge_tags( $merge_tags, $object ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+        if ( is_a( $object, 'WPInv_Subscription' ) ) {
+            $merge_tags = array_merge(
+                $merge_tags,
+                $this->get_subscription_merge_tags( $object )
+            );
+        }
 
-	}
+        return $merge_tags;
 
-	/**
-	 * Sends a cancelled subscription notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_cancelled( $subscription ) {
+    }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+    /**
+     * Generates subscription merge tags.
+     *
+     * @param WPInv_Subscription $subscription
+     * @return array
+     */
+    public function get_subscription_merge_tags( $subscription ) {
+
+        // Abort if it does not exist.
+        if ( ! $subscription->get_id() ) {
+            return array();
+        }
+
+        $invoice    = $subscription->get_parent_invoice();
+        return array(
+            '{subscription_renewal_date}'     => getpaid_format_date_value( $subscription->get_next_renewal_date(), __( 'Never', 'invoicing' ) ),
+            '{subscription_created}'          => getpaid_format_date_value( $subscription->get_date_created() ),
+            '{subscription_status}'           => sanitize_text_field( $subscription->get_status_label() ),
+            '{subscription_profile_id}'       => sanitize_text_field( $subscription->get_profile_id() ),
+            '{subscription_id}'               => absint( $subscription->get_id() ),
+            '{subscription_recurring_amount}' => sanitize_text_field( wpinv_price( $subscription->get_recurring_amount(), $invoice->get_currency() ) ),
+            '{subscription_initial_amount}'   => sanitize_text_field( wpinv_price( $subscription->get_initial_amount(), $invoice->get_currency() ) ),
+            '{subscription_recurring_period}' => getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ),
+            '{subscription_bill_times}'       => $subscription->get_bill_times(),
+            '{subscription_url}'              => esc_url( $subscription->get_view_url() ),
+        );
 
-	}
+    }
 
-	/**
-	 * Sends a subscription expired notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_expired( $subscription ) {
+    /**
+     * Checks if we should send a notification for a subscription.
+     *
+     * @param WPInv_Invoice $invoice
+     * @return bool
+     */
+    public function should_send_notification( $invoice ) {
+        return 0 != $invoice->get_id();
+    }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+    /**
+     * Returns notification recipients.
+     *
+     * @param WPInv_Invoice $invoice
+     * @return array
+     */
+    public function get_recipients( $invoice ) {
+        $recipients = array( $invoice->get_email() );
 
-	}
+        $cc = $invoice->get_email_cc();
 
-	/**
-	 * Sends a completed subscription notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_complete( $subscription ) {
+        if ( ! empty( $cc ) ) {
+            $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
+            $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
+        }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+        return $recipients;
+    }
 
-	}
+    /**
+     * Helper function to send an email.
+     *
+     * @param WPInv_Subscription $subscription
+     * @param GetPaid_Notification_Email $email
+     * @param string $type
+     * @param array $extra_args Extra template args.
+     */
+    public function send_email( $subscription, $email, $type, $extra_args = array() ) {
+
+        // Abort in case the parent invoice does not exist.
+        $invoice = $subscription->get_parent_invoice();
+        if ( ! $this->should_send_notification( $invoice ) ) {
+            return;
+        }
+
+        do_action( 'getpaid_before_send_subscription_notification', $type, $subscription, $email );
+
+        $recipients  = $this->get_recipients( $invoice );
+        $mailer      = new GetPaid_Notification_Email_Sender();
+        $merge_tags  = $email->get_merge_tags();
+        $content     = $email->get_content( $merge_tags, $extra_args );
+        $subject     = $email->add_merge_tags( $email->get_subject(), $merge_tags );
+        $attachments = $email->get_attachments();
+
+        $result = $mailer->send(
+            apply_filters( 'getpaid_subscription_email_recipients', wpinv_parse_list( $recipients ), $email ),
+            $subject,
+            $content,
+            $attachments
+        );
+
+        // Maybe send a copy to the admin.
+        if ( $email->include_admin_bcc() ) {
+            $mailer->send(
+                wpinv_get_admin_email(),
+                $subject . __( ' - ADMIN BCC COPY', 'invoicing' ),
+                $content,
+                $attachments
+            );
+        }
+
+        if ( ! $result ) {
+            $subscription->get_parent_invoice()->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true );
+        }
+
+        do_action( 'getpaid_after_send_subscription_notification', $type, $subscription, $email );
 
-	/**
-	 * Sends a subscription renewal reminder notification.
-	 *
-	 */
-	public function renewal_reminder() {
+    }
 
-		$email = new GetPaid_Notification_Email( __FUNCTION__ );
+    /**
+     * Sends a new trial notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_trial( $subscription ) {
 
-		// Fetch reminder days.
-		$reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) );
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
 
-		// Abort if non is set.
-		if ( empty( $reminder_days ) ) {
-			return;
-		}
+    }
 
-		// Fetch matching subscriptions.
+    /**
+     * Sends a cancelled subscription notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_cancelled( $subscription ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
+
+    }
+
+    /**
+     * Sends a subscription expired notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_expired( $subscription ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
+
+    }
+
+    /**
+     * Sends a completed subscription notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_complete( $subscription ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
+
+    }
+
+    /**
+     * Sends a subscription renewal reminder notification.
+     *
+     */
+    public function renewal_reminder() {
+
+        $email = new GetPaid_Notification_Email( __FUNCTION__ );
+
+        // Fetch reminder days.
+        $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) );
+
+        // Abort if non is set.
+        if ( empty( $reminder_days ) ) {
+            return;
+        }
+
+        // Fetch matching subscriptions.
         $args  = array(
             'number'             => -1,
-			'count_total'        => false,
-			'status'             => 'trialling active',
+            'count_total'        => false,
+            'status'             => 'trialling active',
             'date_expires_query' => array(
-				'relation'  => 'OR'
+                'relation'  => 'OR'
             ),
-		);
+        );
 
-		foreach ( $reminder_days as $days ) {
-			$date = date_parse( date( 'Y-m-d', strtotime( "+$days days", current_time( 'timestamp' ) ) ) );
+        foreach ( $reminder_days as $days ) {
+            $date = date_parse( date( 'Y-m-d', strtotime( "+$days days", current_time( 'timestamp' ) ) ) );
 
-			$args['date_expires_query'][] = array(
-				'year'  => $date['year'],
-				'month' => $date['month'],
-				'day'   => $date['day'],
-			);
+            $args['date_expires_query'][] = array(
+                'year'  => $date['year'],
+                'month' => $date['month'],
+                'day'   => $date['day'],
+            );
 
-		}
+        }
 
-		$subscriptions = new GetPaid_Subscriptions_Query( $args );
+        $subscriptions = new GetPaid_Subscriptions_Query( $args );
 
         foreach ( $subscriptions as $subscription ) {
 
-			// Skip packages.
-			if ( get_post_meta( $subscription->get_product_id(), '_wpinv_type', true ) != 'package' ) {
-				$email->object = $subscription;
-            	$this->send_email( $subscription, $email, __FUNCTION__ );
-			}
+            // Skip packages.
+            if ( get_post_meta( $subscription->get_product_id(), '_wpinv_type', true ) != 'package' ) {
+                $email->object = $subscription;
+                $this->send_email( $subscription, $email, __FUNCTION__ );
+            }
 
-		}
+        }
 
-	}
+    }
 
 }

includes/data-stores/class-getpaid-subscription-data-store.php

Indentation +181 added lines, -181 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -15,197 +15,197 @@ 
  */
 class GetPaid_Subscription_Data_Store {
 
-	/**
-	 * A map of database fields to data types.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $database_fields_to_data_type = array(
-		'id'                => '%d',
-		'customer_id'       => '%d',
-		'frequency'         => '%d',
-		'period'            => '%s',
-		'initial_amount'    => '%s',
-		'recurring_amount'  => '%s',
-		'bill_times'        => '%d',
-		'transaction_id'    => '%s',
-		'parent_payment_id' => '%d',
-		'product_id'        => '%d',
-		'created'           => '%s',
-		'expiration'        => '%s',
-		'trial_period'      => '%s',
-		'status'            => '%s',
-		'profile_id'        => '%s',
-	);
-
-	/*
+    /**
+     * A map of database fields to data types.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $database_fields_to_data_type = array(
+        'id'                => '%d',
+        'customer_id'       => '%d',
+        'frequency'         => '%d',
+        'period'            => '%s',
+        'initial_amount'    => '%s',
+        'recurring_amount'  => '%s',
+        'bill_times'        => '%d',
+        'transaction_id'    => '%s',
+        'parent_payment_id' => '%d',
+        'product_id'        => '%d',
+        'created'           => '%s',
+        'expiration'        => '%s',
+        'trial_period'      => '%s',
+        'status'            => '%s',
+        'profile_id'        => '%s',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new subscription in the database.
-	 *
-	 * @param WPInv_Subscription $subscription Subscription object.
-	 */
-	public function create( &$subscription ) {
-		global $wpdb;
-
-		$values  = array();
-		$formats = array();
-
-		$fields = $this->database_fields_to_data_type;
-		unset( $fields['id'] );
-
-		foreach ( $fields as $key => $format ) {
-			$method       = "get_$key";
-			$values[$key] = $subscription->$method( 'edit' );
-			$formats[]    = $format;
-		}
-
-		$result = $wpdb->insert( $wpdb->prefix . 'wpinv_subscriptions', $values, $formats );
-
-		if ( $result ) {
-			$subscription->set_id( $wpdb->insert_id );
-			$subscription->apply_changes();
-			$subscription->clear_cache();
-			update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() );
-			do_action( 'getpaid_new_subscription', $subscription );
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read a subscription from the database.
-	 *
-	 * @param WPInv_Subscription $subscription Subscription object.
-	 *
-	 */
-	public function read( &$subscription ) {
-		global $wpdb;
-
-		$subscription->set_defaults();
-
-		if ( ! $subscription->get_id() ) {
-			$subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' );
-			$subscription->set_id( 0 );
-			return false;
-		}
-
-		// Maybe retrieve from the cache.
-		$raw_subscription = wp_cache_get( $subscription->get_id(), 'getpaid_subscriptions' );
-
-		// If not found, retrieve from the db.
-		if ( false === $raw_subscription ) {
-
-			$raw_subscription = $wpdb->get_row(
-				$wpdb->prepare(
-					"SELECT * FROM {$wpdb->prefix}wpinv_subscriptions WHERE id = %d",
-					$subscription->get_id()
-				)
-			);
-
-			// Update the cache with our data
-			wp_cache_set( $subscription->get_id(), $raw_subscription, 'getpaid_subscriptions' );
-
-		}
-
-		if ( ! $raw_subscription ) {
-			$subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' );
-			return false;
-		}
-
-		foreach ( array_keys( $this->database_fields_to_data_type ) as $key ) {
-			$method     = "set_$key";
-			$subscription->$method( $raw_subscription->$key );
-		}
-
-		$subscription->set_object_read( true );
-		do_action( 'getpaid_read_subscription', $subscription );
-
-	}
-
-	/**
-	 * Method to update a subscription in the database.
-	 *
-	 * @param WPInv_Subscription $subscription Subscription object.
-	 */
-	public function update( &$subscription ) {
-		global $wpdb;
-
-		$changes = $subscription->get_changes();
-		$values  = array();
-		$formats = array();
-
-		foreach ( $this->database_fields_to_data_type as $key => $format ) {
-			if ( array_key_exists( $key, $changes ) ) {
-				$method       = "get_$key";
-				$values[$key] = $subscription->$method( 'edit' );
-				$formats[]    = $format;
-			}
-		}
-
-		if ( empty( $values ) ) {
-			return;
-		}
-
-		$wpdb->update(
-			$wpdb->prefix . 'wpinv_subscriptions',
-			$values,
-			array(
-				'id' => $subscription->get_id(),
-			),
-			$formats,
-			'%d'
-		);
-
-		// Apply the changes.
-		$subscription->apply_changes();
-
-		// Delete cache.
-		$subscription->clear_cache();
-
-		update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id', $subscription->get_profile_id() );
-		update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() );
-
-		// Fire a hook.
-		do_action( 'getpaid_update_subscription', $subscription );
-
-	}
-
-	/**
-	 * Method to delete a subscription from the database.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function delete( &$subscription ) {
-		global $wpdb;
-
-		$wpdb->query(
-			$wpdb->prepare(
-				"DELETE FROM {$wpdb->prefix}wpinv_subscriptions
+    /**
+     * Method to create a new subscription in the database.
+     *
+     * @param WPInv_Subscription $subscription Subscription object.
+     */
+    public function create( &$subscription ) {
+        global $wpdb;
+
+        $values  = array();
+        $formats = array();
+
+        $fields = $this->database_fields_to_data_type;
+        unset( $fields['id'] );
+
+        foreach ( $fields as $key => $format ) {
+            $method       = "get_$key";
+            $values[$key] = $subscription->$method( 'edit' );
+            $formats[]    = $format;
+        }
+
+        $result = $wpdb->insert( $wpdb->prefix . 'wpinv_subscriptions', $values, $formats );
+
+        if ( $result ) {
+            $subscription->set_id( $wpdb->insert_id );
+            $subscription->apply_changes();
+            $subscription->clear_cache();
+            update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() );
+            do_action( 'getpaid_new_subscription', $subscription );
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read a subscription from the database.
+     *
+     * @param WPInv_Subscription $subscription Subscription object.
+     *
+     */
+    public function read( &$subscription ) {
+        global $wpdb;
+
+        $subscription->set_defaults();
+
+        if ( ! $subscription->get_id() ) {
+            $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' );
+            $subscription->set_id( 0 );
+            return false;
+        }
+
+        // Maybe retrieve from the cache.
+        $raw_subscription = wp_cache_get( $subscription->get_id(), 'getpaid_subscriptions' );
+
+        // If not found, retrieve from the db.
+        if ( false === $raw_subscription ) {
+
+            $raw_subscription = $wpdb->get_row(
+                $wpdb->prepare(
+                    "SELECT * FROM {$wpdb->prefix}wpinv_subscriptions WHERE id = %d",
+                    $subscription->get_id()
+                )
+            );
+
+            // Update the cache with our data
+            wp_cache_set( $subscription->get_id(), $raw_subscription, 'getpaid_subscriptions' );
+
+        }
+
+        if ( ! $raw_subscription ) {
+            $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' );
+            return false;
+        }
+
+        foreach ( array_keys( $this->database_fields_to_data_type ) as $key ) {
+            $method     = "set_$key";
+            $subscription->$method( $raw_subscription->$key );
+        }
+
+        $subscription->set_object_read( true );
+        do_action( 'getpaid_read_subscription', $subscription );
+
+    }
+
+    /**
+     * Method to update a subscription in the database.
+     *
+     * @param WPInv_Subscription $subscription Subscription object.
+     */
+    public function update( &$subscription ) {
+        global $wpdb;
+
+        $changes = $subscription->get_changes();
+        $values  = array();
+        $formats = array();
+
+        foreach ( $this->database_fields_to_data_type as $key => $format ) {
+            if ( array_key_exists( $key, $changes ) ) {
+                $method       = "get_$key";
+                $values[$key] = $subscription->$method( 'edit' );
+                $formats[]    = $format;
+            }
+        }
+
+        if ( empty( $values ) ) {
+            return;
+        }
+
+        $wpdb->update(
+            $wpdb->prefix . 'wpinv_subscriptions',
+            $values,
+            array(
+                'id' => $subscription->get_id(),
+            ),
+            $formats,
+            '%d'
+        );
+
+        // Apply the changes.
+        $subscription->apply_changes();
+
+        // Delete cache.
+        $subscription->clear_cache();
+
+        update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id', $subscription->get_profile_id() );
+        update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() );
+
+        // Fire a hook.
+        do_action( 'getpaid_update_subscription', $subscription );
+
+    }
+
+    /**
+     * Method to delete a subscription from the database.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function delete( &$subscription ) {
+        global $wpdb;
+
+        $wpdb->query(
+            $wpdb->prepare(
+                "DELETE FROM {$wpdb->prefix}wpinv_subscriptions
 				WHERE id = %d",
-				$subscription->get_id()
-			)
-		);
+                $subscription->get_id()
+            )
+        );
 
-		delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id' );
-		delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id' );
+        delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id' );
+        delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id' );
 
-		// Delete cache.
-		$subscription->clear_cache();
+        // Delete cache.
+        $subscription->clear_cache();
 
-		// Fire a hook.
-		do_action( 'getpaid_delete_subscription', $subscription );
+        // Fire a hook.
+        do_action( 'getpaid_delete_subscription', $subscription );
 
-		$subscription->set_id( 0 );
-	}
+        $subscription->set_id( 0 );
+    }
 
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------

includes/data-stores/class-getpaid-data.php

Indentation +860 added lines, -860 removed lines

@@ -9,7 +9,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -21,356 +21,356 @@ 
  */
 abstract class GetPaid_Data {
 
-	/**
-	 * ID for this object.
-	 *
-	 * @since 1.0.19
-	 * @var int
-	 */
-	protected $id = 0;
-
-	/**
-	 * Core data for this object. Name value pairs (name + default value).
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array();
-
-	/**
-	 * Core data changes for this object.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $changes = array();
-
-	/**
-	 * This is false until the object is read from the DB.
-	 *
-	 * @since 1.0.19
-	 * @var bool
-	 */
-	protected $object_read = false;
-
-	/**
-	 * This is the name of this object type.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	protected $object_type = 'data';
-
-	/**
-	 * Extra data for this object. Name value pairs (name + default value).
-	 * Used as a standard way for sub classes (like item types) to add
-	 * additional information to an inherited class.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $extra_data = array();
-
-	/**
-	 * Set to _data on construct so we can track and reset data if needed.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $default_data = array();
-
-	/**
-	 * Contains a reference to the data store for this class.
-	 *
-	 * @since 1.0.19
-	 * @var GetPaid_Data_Store
-	 */
-	protected $data_store;
-
-	/**
-	 * Stores meta in cache for future reads.
-	 * A group must be set to to enable caching.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	protected $cache_group = '';
-
-	/**
-	 * Stores the last error.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $last_error = '';
-
-	/**
-	 * Stores additional meta data.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $meta_data = null;
-
-	/**
-	 * Default constructor.
-	 *
-	 * @param int|object|array|string $read ID to load from the DB (optional) or already queried data.
-	 */
-	public function __construct( $read = 0 ) {
-		$this->data         = array_merge( $this->data, $this->extra_data );
-		$this->default_data = $this->data;
-	}
-
-	/**
-	 * Only store the object ID to avoid serializing the data object instance.
-	 *
-	 * @return array
-	 */
-	public function __sleep() {
-		return array( 'id' );
-	}
-
-	/**
-	 * Re-run the constructor with the object ID.
-	 *
-	 * If the object no longer exists, remove the ID.
-	 */
-	public function __wakeup() {
-		$this->__construct( absint( $this->id ) );
-
-		if ( ! empty( $this->last_error ) ) {
-			$this->set_id( 0 );
-		}
-
-	}
-
-	/**
-	 * When the object is cloned, make sure meta is duplicated correctly.
-	 *
-	 * @since 1.0.19
-	 */
-	public function __clone() {
-		$this->maybe_read_meta_data();
-		if ( ! empty( $this->meta_data ) ) {
-			foreach ( $this->meta_data as $array_key => $meta ) {
-				$this->meta_data[ $array_key ] = clone $meta;
-				if ( ! empty( $meta->id ) ) {
-					$this->meta_data[ $array_key ]->id = null;
-				}
-			}
-		}
-	}
-
-	/**
-	 * Get the data store.
-	 *
-	 * @since  1.0.19
-	 * @return object
-	 */
-	public function get_data_store() {
-		return $this->data_store;
-	}
-
-	/**
-	 * Get the object type.
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	public function get_object_type() {
-		return $this->object_type;
-	}
-
-	/**
-	 * Returns the unique ID for this object.
-	 *
-	 * @since  1.0.19
-	 * @return int
-	 */
-	public function get_id() {
-		return $this->id;
-	}
-
-	/**
-	 * Get form status.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_status( $context = 'view' ) {
-		return $this->get_prop( 'status', $context );
-    }
-
-	/**
-	 * Delete an object, set the ID to 0, and return result.
-	 *
-	 * @since  1.0.19
-	 * @param  bool $force_delete Should the data be deleted permanently.
-	 * @return bool result
-	 */
-	public function delete( $force_delete = false ) {
-		if ( $this->data_store && $this->exists() ) {
-			$this->data_store->delete( $this, array( 'force_delete' => $force_delete ) );
-			$this->set_id( 0 );
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * Save should create or update based on object existence.
-	 *
-	 * @since  1.0.19
-	 * @return int
-	 */
-	public function save() {
-		if ( ! $this->data_store ) {
-			return $this->get_id();
-		}
-
-		/**
-		 * Trigger action before saving to the DB. Allows you to adjust object props before save.
-		 *
-		 * @param GetPaid_Data          $this The object being saved.
-		 * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
-		 */
-		do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store );
-
-		if ( $this->get_id() ) {
-			$this->data_store->update( $this );
-		} else {
-			$this->data_store->create( $this );
-		}
-
-		/**
-		 * Trigger action after saving to the DB.
-		 *
-		 * @param GetPaid_Data          $this The object being saved.
-		 * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
-		 */
-		do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store );
-
-		return $this->get_id();
-	}
-
-	/**
-	 * Change data to JSON format.
-	 *
-	 * @since  1.0.19
-	 * @return string Data in JSON format.
-	 */
-	public function __toString() {
-		return wp_json_encode( $this->get_data() );
-	}
-
-	/**
-	 * Returns all data for this object.
-	 *
-	 * @since  1.0.19
-	 * @return array
-	 */
-	public function get_data() {
-		return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) );
-	}
-
-	/**
-	 * Returns array of expected data keys for this object.
-	 *
-	 * @since   1.0.19
-	 * @return array
-	 */
-	public function get_data_keys() {
-		return array_keys( $this->data );
-	}
-
-	/**
-	 * Returns all "extra" data keys for an object (for sub objects like item types).
-	 *
-	 * @since  1.0.19
-	 * @return array
-	 */
-	public function get_extra_data_keys() {
-		return array_keys( $this->extra_data );
-	}
-
-	/**
-	 * Filter null meta values from array.
-	 *
-	 * @since  1.0.19
-	 * @param mixed $meta Meta value to check.
-	 * @return bool
-	 */
-	protected function filter_null_meta( $meta ) {
-		return ! is_null( $meta->value );
-	}
-
-	/**
-	 * Get All Meta Data.
-	 *
-	 * @since 1.0.19
-	 * @return array of objects.
-	 */
-	public function get_meta_data() {
-		$this->maybe_read_meta_data();
-		return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) );
-	}
-
-	/**
-	 * Check if the key is an internal one.
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Key to check.
-	 * @return bool   true if it's an internal key, false otherwise
-	 */
-	protected function is_internal_meta_key( $key ) {
-		$internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true );
-
-		if ( ! $internal_meta_key ) {
-			return false;
-		}
-
-		$has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) );
-
-		if ( ! $has_setter_or_getter ) {
-			return false;
-		}
-
-		/* translators: %s: $key Key to check */
-		getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
-
-		return true;
-	}
-
-	/**
-	 * Magic method for setting data fields.
-	 *
-	 * This method does not update custom fields in the database.
-	 *
-	 * @since 1.0.19
-	 * @access public
-	 *
-	 */
-	public function __set( $key, $value ) {
-
-		if ( 'id' == strtolower( $key ) ) {
-			return $this->set_id( $value );
-		}
-
-		if ( method_exists( $this, "set_$key") ) {
-
-			/* translators: %s: $key Key to set */
-			getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
-
-			call_user_func( array( $this, "set_$key" ), $value );
-		} else {
-			$this->set_prop( $key, $value );
-		}
-
-	}
-
-	/**
+    /**
+     * ID for this object.
+     *
+     * @since 1.0.19
+     * @var int
+     */
+    protected $id = 0;
+
+    /**
+     * Core data for this object. Name value pairs (name + default value).
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array();
+
+    /**
+     * Core data changes for this object.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $changes = array();
+
+    /**
+     * This is false until the object is read from the DB.
+     *
+     * @since 1.0.19
+     * @var bool
+     */
+    protected $object_read = false;
+
+    /**
+     * This is the name of this object type.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    protected $object_type = 'data';
+
+    /**
+     * Extra data for this object. Name value pairs (name + default value).
+     * Used as a standard way for sub classes (like item types) to add
+     * additional information to an inherited class.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $extra_data = array();
+
+    /**
+     * Set to _data on construct so we can track and reset data if needed.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $default_data = array();
+
+    /**
+     * Contains a reference to the data store for this class.
+     *
+     * @since 1.0.19
+     * @var GetPaid_Data_Store
+     */
+    protected $data_store;
+
+    /**
+     * Stores meta in cache for future reads.
+     * A group must be set to to enable caching.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    protected $cache_group = '';
+
+    /**
+     * Stores the last error.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $last_error = '';
+
+    /**
+     * Stores additional meta data.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $meta_data = null;
+
+    /**
+     * Default constructor.
+     *
+     * @param int|object|array|string $read ID to load from the DB (optional) or already queried data.
+     */
+    public function __construct( $read = 0 ) {
+        $this->data         = array_merge( $this->data, $this->extra_data );
+        $this->default_data = $this->data;
+    }
+
+    /**
+     * Only store the object ID to avoid serializing the data object instance.
+     *
+     * @return array
+     */
+    public function __sleep() {
+        return array( 'id' );
+    }
+
+    /**
+     * Re-run the constructor with the object ID.
+     *
+     * If the object no longer exists, remove the ID.
+     */
+    public function __wakeup() {
+        $this->__construct( absint( $this->id ) );
+
+        if ( ! empty( $this->last_error ) ) {
+            $this->set_id( 0 );
+        }
+
+    }
+
+    /**
+     * When the object is cloned, make sure meta is duplicated correctly.
+     *
+     * @since 1.0.19
+     */
+    public function __clone() {
+        $this->maybe_read_meta_data();
+        if ( ! empty( $this->meta_data ) ) {
+            foreach ( $this->meta_data as $array_key => $meta ) {
+                $this->meta_data[ $array_key ] = clone $meta;
+                if ( ! empty( $meta->id ) ) {
+                    $this->meta_data[ $array_key ]->id = null;
+                }
+            }
+        }
+    }
+
+    /**
+     * Get the data store.
+     *
+     * @since  1.0.19
+     * @return object
+     */
+    public function get_data_store() {
+        return $this->data_store;
+    }
+
+    /**
+     * Get the object type.
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    public function get_object_type() {
+        return $this->object_type;
+    }
+
+    /**
+     * Returns the unique ID for this object.
+     *
+     * @since  1.0.19
+     * @return int
+     */
+    public function get_id() {
+        return $this->id;
+    }
+
+    /**
+     * Get form status.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_status( $context = 'view' ) {
+        return $this->get_prop( 'status', $context );
+    }
+
+    /**
+     * Delete an object, set the ID to 0, and return result.
+     *
+     * @since  1.0.19
+     * @param  bool $force_delete Should the data be deleted permanently.
+     * @return bool result
+     */
+    public function delete( $force_delete = false ) {
+        if ( $this->data_store && $this->exists() ) {
+            $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) );
+            $this->set_id( 0 );
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Save should create or update based on object existence.
+     *
+     * @since  1.0.19
+     * @return int
+     */
+    public function save() {
+        if ( ! $this->data_store ) {
+            return $this->get_id();
+        }
+
+        /**
+         * Trigger action before saving to the DB. Allows you to adjust object props before save.
+         *
+         * @param GetPaid_Data          $this The object being saved.
+         * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
+         */
+        do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store );
+
+        if ( $this->get_id() ) {
+            $this->data_store->update( $this );
+        } else {
+            $this->data_store->create( $this );
+        }
+
+        /**
+         * Trigger action after saving to the DB.
+         *
+         * @param GetPaid_Data          $this The object being saved.
+         * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
+         */
+        do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store );
+
+        return $this->get_id();
+    }
+
+    /**
+     * Change data to JSON format.
+     *
+     * @since  1.0.19
+     * @return string Data in JSON format.
+     */
+    public function __toString() {
+        return wp_json_encode( $this->get_data() );
+    }
+
+    /**
+     * Returns all data for this object.
+     *
+     * @since  1.0.19
+     * @return array
+     */
+    public function get_data() {
+        return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) );
+    }
+
+    /**
+     * Returns array of expected data keys for this object.
+     *
+     * @since   1.0.19
+     * @return array
+     */
+    public function get_data_keys() {
+        return array_keys( $this->data );
+    }
+
+    /**
+     * Returns all "extra" data keys for an object (for sub objects like item types).
+     *
+     * @since  1.0.19
+     * @return array
+     */
+    public function get_extra_data_keys() {
+        return array_keys( $this->extra_data );
+    }
+
+    /**
+     * Filter null meta values from array.
+     *
+     * @since  1.0.19
+     * @param mixed $meta Meta value to check.
+     * @return bool
+     */
+    protected function filter_null_meta( $meta ) {
+        return ! is_null( $meta->value );
+    }
+
+    /**
+     * Get All Meta Data.
+     *
+     * @since 1.0.19
+     * @return array of objects.
+     */
+    public function get_meta_data() {
+        $this->maybe_read_meta_data();
+        return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) );
+    }
+
+    /**
+     * Check if the key is an internal one.
+     *
+     * @since  1.0.19
+     * @param  string $key Key to check.
+     * @return bool   true if it's an internal key, false otherwise
+     */
+    protected function is_internal_meta_key( $key ) {
+        $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true );
+
+        if ( ! $internal_meta_key ) {
+            return false;
+        }
+
+        $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) );
+
+        if ( ! $has_setter_or_getter ) {
+            return false;
+        }
+
+        /* translators: %s: $key Key to check */
+        getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
+
+        return true;
+    }
+
+    /**
+     * Magic method for setting data fields.
+     *
+     * This method does not update custom fields in the database.
+     *
+     * @since 1.0.19
+     * @access public
+     *
+     */
+    public function __set( $key, $value ) {
+
+        if ( 'id' == strtolower( $key ) ) {
+            return $this->set_id( $value );
+        }
+
+        if ( method_exists( $this, "set_$key") ) {
+
+            /* translators: %s: $key Key to set */
+            getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
+
+            call_user_func( array( $this, "set_$key" ), $value );
+        } else {
+            $this->set_prop( $key, $value );
+        }
+
+    }
+
+    /**
      * Margic method for retrieving a property.
      */
     public function __get( $key ) {
@@ -378,10 +378,10 @@ 
         // Check if we have a helper method for that.
         if ( method_exists( $this, 'get_' . $key ) ) {
 
-			if ( 'post_type' != $key ) {
-				/* translators: %s: $key Key to set */
-				getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
-			}
+            if ( 'post_type' != $key ) {
+                /* translators: %s: $key Key to set */
+                getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
+            }
 
             return call_user_func( array( $this, 'get_' . $key ) );
         }
@@ -391,512 +391,512 @@ 
             return $this->post->$key;
         }
 
-		return $this->get_prop( $key );
-
-    }
-
-	/**
-	 * Get Meta Data by Key.
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Meta Key.
-	 * @param  bool   $single return first found meta with key, or all with $key.
-	 * @param  string $context What the value is for. Valid values are view and edit.
-	 * @return mixed
-	 */
-	public function get_meta( $key = '', $single = true, $context = 'view' ) {
-
-		// Check if this is an internal meta key.
-		$_key = str_replace( '_wpinv', '', $key );
-		$_key = str_replace( 'wpinv', '', $_key );
-		if ( $this->is_internal_meta_key( $_key ) ) {
-			$function = 'get_' . $_key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}();
-			}
-		}
-
-		// Read the meta data if not yet read.
-		$this->maybe_read_meta_data();
-		$meta_data  = $this->get_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true );
-		$value      = $single ? '' : array();
-
-		if ( ! empty( $array_keys ) ) {
-			// We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()).
-			if ( $single ) {
-				$value = $meta_data[ current( $array_keys ) ]->value;
-			} else {
-				$value = array_intersect_key( $meta_data, array_flip( $array_keys ) );
-			}
-		}
-
-		if ( 'view' === $context ) {
-			$value = apply_filters( $this->get_hook_prefix() . $key, $value, $this );
-		}
-
-		return $value;
-	}
-
-	/**
-	 * See if meta data exists, since get_meta always returns a '' or array().
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Meta Key.
-	 * @return boolean
-	 */
-	public function meta_exists( $key = '' ) {
-		$this->maybe_read_meta_data();
-		$array_keys = wp_list_pluck( $this->get_meta_data(), 'key' );
-		return in_array( $key, $array_keys, true );
-	}
-
-	/**
-	 * Set all meta data from array.
-	 *
-	 * @since 1.0.19
-	 * @param array $data Key/Value pairs.
-	 */
-	public function set_meta_data( $data ) {
-		if ( ! empty( $data ) && is_array( $data ) ) {
-			$this->maybe_read_meta_data();
-			foreach ( $data as $meta ) {
-				$meta = (array) $meta;
-				if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) {
-					$this->meta_data[] = new GetPaid_Meta_Data(
-						array(
-							'id'    => $meta['id'],
-							'key'   => $meta['key'],
-							'value' => $meta['value'],
-						)
-					);
-				}
-			}
-		}
-	}
-
-	/**
-	 * Add meta data.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string       $key Meta key.
-	 * @param string|array $value Meta value.
-	 * @param bool         $unique Should this be a unique key?.
-	 */
-	public function add_meta_data( $key, $value, $unique = false ) {
-		if ( $this->is_internal_meta_key( $key ) ) {
-			$function = 'set_' . $key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}( $value );
-			}
-		}
-
-		$this->maybe_read_meta_data();
-		if ( $unique ) {
-			$this->delete_meta_data( $key );
-		}
-		$this->meta_data[] = new GetPaid_Meta_Data(
-			array(
-				'key'   => $key,
-				'value' => $value,
-			)
-		);
-	}
-
-	/**
-	 * Update meta data by key or ID, if provided.
-	 *
-	 * @since  1.0.19
-	 *
-	 * @param  string       $key Meta key.
-	 * @param  string|array $value Meta value.
-	 * @param  int          $meta_id Meta ID.
-	 */
-	public function update_meta_data( $key, $value, $meta_id = 0 ) {
-		if ( $this->is_internal_meta_key( $key ) ) {
-			$function = 'set_' . $key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}( $value );
-			}
-		}
-
-		$this->maybe_read_meta_data();
-
-		$array_key = false;
-
-		if ( $meta_id ) {
-			$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true );
-			$array_key  = $array_keys ? current( $array_keys ) : false;
-		} else {
-			// Find matches by key.
-			$matches = array();
-			foreach ( $this->meta_data as $meta_data_array_key => $meta ) {
-				if ( $meta->key === $key ) {
-					$matches[] = $meta_data_array_key;
-				}
-			}
-
-			if ( ! empty( $matches ) ) {
-				// Set matches to null so only one key gets the new value.
-				foreach ( $matches as $meta_data_array_key ) {
-					$this->meta_data[ $meta_data_array_key ]->value = null;
-				}
-				$array_key = current( $matches );
-			}
-		}
-
-		if ( false !== $array_key ) {
-			$meta        = $this->meta_data[ $array_key ];
-			$meta->key   = $key;
-			$meta->value = $value;
-		} else {
-			$this->add_meta_data( $key, $value, true );
-		}
-	}
-
-	/**
-	 * Delete meta data.
-	 *
-	 * @since 1.0.19
-	 * @param string $key Meta key.
-	 */
-	public function delete_meta_data( $key ) {
-		$this->maybe_read_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true );
-
-		if ( $array_keys ) {
-			foreach ( $array_keys as $array_key ) {
-				$this->meta_data[ $array_key ]->value = null;
-			}
-		}
-	}
-
-	/**
-	 * Delete meta data.
-	 *
-	 * @since 1.0.19
-	 * @param int $mid Meta ID.
-	 */
-	public function delete_meta_data_by_mid( $mid ) {
-		$this->maybe_read_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true );
-
-		if ( $array_keys ) {
-			foreach ( $array_keys as $array_key ) {
-				$this->meta_data[ $array_key ]->value = null;
-			}
-		}
-	}
-
-	/**
-	 * Read meta data if null.
-	 *
-	 * @since 1.0.19
-	 */
-	protected function maybe_read_meta_data() {
-		if ( is_null( $this->meta_data ) ) {
-			$this->read_meta_data();
-		}
-	}
-
-	/**
-	 * Read Meta Data from the database. Ignore any internal properties.
-	 * Uses it's own caches because get_metadata does not provide meta_ids.
-	 *
-	 * @since 1.0.19
-	 * @param bool $force_read True to force a new DB read (and update cache).
-	 */
-	public function read_meta_data( $force_read = false ) {
-
-		// Reset meta data.
-		$this->meta_data = array();
-
-		// Maybe abort early.
-		if ( ! $this->get_id() || ! $this->data_store ) {
-			return;
-		}
-
-		// Only read from cache if the cache key is set.
-		$cache_key = null;
-		if ( ! $force_read && ! empty( $this->cache_group ) ) {
-			$cache_key     = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
-			$raw_meta_data = wp_cache_get( $cache_key, $this->cache_group );
-		}
-
-		// Should we force read?
-		if ( empty( $raw_meta_data ) ) {
-			$raw_meta_data = $this->data_store->read_meta( $this );
-
-			if ( ! empty( $cache_key ) ) {
-				wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
-			}
-
-		}
-
-		// Set meta data.
-		if ( is_array( $raw_meta_data ) ) {
-
-			foreach ( $raw_meta_data as $meta ) {
-				$this->meta_data[] = new GetPaid_Meta_Data(
-					array(
-						'id'    => (int) $meta->meta_id,
-						'key'   => $meta->meta_key,
-						'value' => maybe_unserialize( $meta->meta_value ),
-					)
-				);
-			}
-
-		}
-
-	}
-
-	/**
-	 * Update Meta Data in the database.
-	 *
-	 * @since 1.0.19
-	 */
-	public function save_meta_data() {
-		if ( ! $this->data_store || is_null( $this->meta_data ) ) {
-			return;
-		}
-		foreach ( $this->meta_data as $array_key => $meta ) {
-			if ( is_null( $meta->value ) ) {
-				if ( ! empty( $meta->id ) ) {
-					$this->data_store->delete_meta( $this, $meta );
-					unset( $this->meta_data[ $array_key ] );
-				}
-			} elseif ( empty( $meta->id ) ) {
-				$meta->id = $this->data_store->add_meta( $this, $meta );
-				$meta->apply_changes();
-			} else {
-				if ( $meta->get_changes() ) {
-					$this->data_store->update_meta( $this, $meta );
-					$meta->apply_changes();
-				}
-			}
-		}
-		if ( ! empty( $this->cache_group ) ) {
-			$cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
-			wp_cache_delete( $cache_key, $this->cache_group );
-		}
-	}
-
-	/**
-	 * Set ID.
-	 *
-	 * @since 1.0.19
-	 * @param int $id ID.
-	 */
-	public function set_id( $id ) {
-		$this->id = absint( $id );
-	}
-
-	/**
-	 * Sets item status.
-	 *
-	 * @since 1.0.19
-	 * @param string $status New status.
-	 * @return array details of change.
-	 */
-	public function set_status( $status ) {
+        return $this->get_prop( $key );
+
+    }
+
+    /**
+     * Get Meta Data by Key.
+     *
+     * @since  1.0.19
+     * @param  string $key Meta Key.
+     * @param  bool   $single return first found meta with key, or all with $key.
+     * @param  string $context What the value is for. Valid values are view and edit.
+     * @return mixed
+     */
+    public function get_meta( $key = '', $single = true, $context = 'view' ) {
+
+        // Check if this is an internal meta key.
+        $_key = str_replace( '_wpinv', '', $key );
+        $_key = str_replace( 'wpinv', '', $_key );
+        if ( $this->is_internal_meta_key( $_key ) ) {
+            $function = 'get_' . $_key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}();
+            }
+        }
+
+        // Read the meta data if not yet read.
+        $this->maybe_read_meta_data();
+        $meta_data  = $this->get_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true );
+        $value      = $single ? '' : array();
+
+        if ( ! empty( $array_keys ) ) {
+            // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()).
+            if ( $single ) {
+                $value = $meta_data[ current( $array_keys ) ]->value;
+            } else {
+                $value = array_intersect_key( $meta_data, array_flip( $array_keys ) );
+            }
+        }
+
+        if ( 'view' === $context ) {
+            $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this );
+        }
+
+        return $value;
+    }
+
+    /**
+     * See if meta data exists, since get_meta always returns a '' or array().
+     *
+     * @since  1.0.19
+     * @param  string $key Meta Key.
+     * @return boolean
+     */
+    public function meta_exists( $key = '' ) {
+        $this->maybe_read_meta_data();
+        $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' );
+        return in_array( $key, $array_keys, true );
+    }
+
+    /**
+     * Set all meta data from array.
+     *
+     * @since 1.0.19
+     * @param array $data Key/Value pairs.
+     */
+    public function set_meta_data( $data ) {
+        if ( ! empty( $data ) && is_array( $data ) ) {
+            $this->maybe_read_meta_data();
+            foreach ( $data as $meta ) {
+                $meta = (array) $meta;
+                if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) {
+                    $this->meta_data[] = new GetPaid_Meta_Data(
+                        array(
+                            'id'    => $meta['id'],
+                            'key'   => $meta['key'],
+                            'value' => $meta['value'],
+                        )
+                    );
+                }
+            }
+        }
+    }
+
+    /**
+     * Add meta data.
+     *
+     * @since 1.0.19
+     *
+     * @param string       $key Meta key.
+     * @param string|array $value Meta value.
+     * @param bool         $unique Should this be a unique key?.
+     */
+    public function add_meta_data( $key, $value, $unique = false ) {
+        if ( $this->is_internal_meta_key( $key ) ) {
+            $function = 'set_' . $key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}( $value );
+            }
+        }
+
+        $this->maybe_read_meta_data();
+        if ( $unique ) {
+            $this->delete_meta_data( $key );
+        }
+        $this->meta_data[] = new GetPaid_Meta_Data(
+            array(
+                'key'   => $key,
+                'value' => $value,
+            )
+        );
+    }
+
+    /**
+     * Update meta data by key or ID, if provided.
+     *
+     * @since  1.0.19
+     *
+     * @param  string       $key Meta key.
+     * @param  string|array $value Meta value.
+     * @param  int          $meta_id Meta ID.
+     */
+    public function update_meta_data( $key, $value, $meta_id = 0 ) {
+        if ( $this->is_internal_meta_key( $key ) ) {
+            $function = 'set_' . $key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}( $value );
+            }
+        }
+
+        $this->maybe_read_meta_data();
+
+        $array_key = false;
+
+        if ( $meta_id ) {
+            $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true );
+            $array_key  = $array_keys ? current( $array_keys ) : false;
+        } else {
+            // Find matches by key.
+            $matches = array();
+            foreach ( $this->meta_data as $meta_data_array_key => $meta ) {
+                if ( $meta->key === $key ) {
+                    $matches[] = $meta_data_array_key;
+                }
+            }
+
+            if ( ! empty( $matches ) ) {
+                // Set matches to null so only one key gets the new value.
+                foreach ( $matches as $meta_data_array_key ) {
+                    $this->meta_data[ $meta_data_array_key ]->value = null;
+                }
+                $array_key = current( $matches );
+            }
+        }
+
+        if ( false !== $array_key ) {
+            $meta        = $this->meta_data[ $array_key ];
+            $meta->key   = $key;
+            $meta->value = $value;
+        } else {
+            $this->add_meta_data( $key, $value, true );
+        }
+    }
+
+    /**
+     * Delete meta data.
+     *
+     * @since 1.0.19
+     * @param string $key Meta key.
+     */
+    public function delete_meta_data( $key ) {
+        $this->maybe_read_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true );
+
+        if ( $array_keys ) {
+            foreach ( $array_keys as $array_key ) {
+                $this->meta_data[ $array_key ]->value = null;
+            }
+        }
+    }
+
+    /**
+     * Delete meta data.
+     *
+     * @since 1.0.19
+     * @param int $mid Meta ID.
+     */
+    public function delete_meta_data_by_mid( $mid ) {
+        $this->maybe_read_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true );
+
+        if ( $array_keys ) {
+            foreach ( $array_keys as $array_key ) {
+                $this->meta_data[ $array_key ]->value = null;
+            }
+        }
+    }
+
+    /**
+     * Read meta data if null.
+     *
+     * @since 1.0.19
+     */
+    protected function maybe_read_meta_data() {
+        if ( is_null( $this->meta_data ) ) {
+            $this->read_meta_data();
+        }
+    }
+
+    /**
+     * Read Meta Data from the database. Ignore any internal properties.
+     * Uses it's own caches because get_metadata does not provide meta_ids.
+     *
+     * @since 1.0.19
+     * @param bool $force_read True to force a new DB read (and update cache).
+     */
+    public function read_meta_data( $force_read = false ) {
+
+        // Reset meta data.
+        $this->meta_data = array();
+
+        // Maybe abort early.
+        if ( ! $this->get_id() || ! $this->data_store ) {
+            return;
+        }
+
+        // Only read from cache if the cache key is set.
+        $cache_key = null;
+        if ( ! $force_read && ! empty( $this->cache_group ) ) {
+            $cache_key     = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
+            $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group );
+        }
+
+        // Should we force read?
+        if ( empty( $raw_meta_data ) ) {
+            $raw_meta_data = $this->data_store->read_meta( $this );
+
+            if ( ! empty( $cache_key ) ) {
+                wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
+            }
+
+        }
+
+        // Set meta data.
+        if ( is_array( $raw_meta_data ) ) {
+
+            foreach ( $raw_meta_data as $meta ) {
+                $this->meta_data[] = new GetPaid_Meta_Data(
+                    array(
+                        'id'    => (int) $meta->meta_id,
+                        'key'   => $meta->meta_key,
+                        'value' => maybe_unserialize( $meta->meta_value ),
+                    )
+                );
+            }
+
+        }
+
+    }
+
+    /**
+     * Update Meta Data in the database.
+     *
+     * @since 1.0.19
+     */
+    public function save_meta_data() {
+        if ( ! $this->data_store || is_null( $this->meta_data ) ) {
+            return;
+        }
+        foreach ( $this->meta_data as $array_key => $meta ) {
+            if ( is_null( $meta->value ) ) {
+                if ( ! empty( $meta->id ) ) {
+                    $this->data_store->delete_meta( $this, $meta );
+                    unset( $this->meta_data[ $array_key ] );
+                }
+            } elseif ( empty( $meta->id ) ) {
+                $meta->id = $this->data_store->add_meta( $this, $meta );
+                $meta->apply_changes();
+            } else {
+                if ( $meta->get_changes() ) {
+                    $this->data_store->update_meta( $this, $meta );
+                    $meta->apply_changes();
+                }
+            }
+        }
+        if ( ! empty( $this->cache_group ) ) {
+            $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
+            wp_cache_delete( $cache_key, $this->cache_group );
+        }
+    }
+
+    /**
+     * Set ID.
+     *
+     * @since 1.0.19
+     * @param int $id ID.
+     */
+    public function set_id( $id ) {
+        $this->id = absint( $id );
+    }
+
+    /**
+     * Sets item status.
+     *
+     * @since 1.0.19
+     * @param string $status New status.
+     * @return array details of change.
+     */
+    public function set_status( $status ) {
         $old_status = $this->get_status();
 
-		$this->set_prop( 'status', $status );
-
-		return array(
-			'from' => $old_status,
-			'to'   => $status,
-		);
-    }
-
-	/**
-	 * Set all props to default values.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_defaults() {
-		$this->data    = $this->default_data;
-		$this->changes = array();
-		$this->set_object_read( false );
-	}
-
-	/**
-	 * Set object read property.
-	 *
-	 * @since 1.0.19
-	 * @param boolean $read Should read?.
-	 */
-	public function set_object_read( $read = true ) {
-		$this->object_read = (bool) $read;
-	}
-
-	/**
-	 * Get object read property.
-	 *
-	 * @since  1.0.19
-	 * @return boolean
-	 */
-	public function get_object_read() {
-		return (bool) $this->object_read;
-	}
-
-	/**
-	 * Set a collection of props in one go, collect any errors, and return the result.
-	 * Only sets using public methods.
-	 *
-	 * @since  1.0.19
-	 *
-	 * @param array  $props Key value pairs to set. Key is the prop and should map to a setter function name.
-	 * @param string $context In what context to run this.
-	 *
-	 * @return bool|WP_Error
-	 */
-	public function set_props( $props, $context = 'set' ) {
-		$errors = false;
-
-		foreach ( $props as $prop => $value ) {
-			try {
-				/**
-				 * Checks if the prop being set is allowed, and the value is not null.
-				 */
-				if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) {
-					continue;
-				}
-				$setter = "set_$prop";
-
-				if ( is_callable( array( $this, $setter ) ) ) {
-					$this->{$setter}( $value );
-				}
-			} catch ( Exception $e ) {
-				if ( ! $errors ) {
-					$errors = new WP_Error();
-				}
-				$errors->add( $e->getCode(), $e->getMessage() );
-				$this->last_error = $e->getMessage();
-			}
-		}
-
-		return $errors && count( $errors->get_error_codes() ) ? $errors : true;
-	}
-
-	/**
-	 * Sets a prop for a setter method.
-	 *
-	 * This stores changes in a special array so we can track what needs saving
-	 * the the DB later.
-	 *
-	 * @since 1.0.19
-	 * @param string $prop Name of prop to set.
-	 * @param mixed  $value Value of the prop.
-	 */
-	protected function set_prop( $prop, $value ) {
-		if ( array_key_exists( $prop, $this->data ) ) {
-			if ( true === $this->object_read ) {
-				if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) {
-					$this->changes[ $prop ] = $value;
-				}
-			} else {
-				$this->data[ $prop ] = $value;
-			}
-		}
-	}
-
-	/**
-	 * Return data changes only.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_changes() {
-		return $this->changes;
-	}
-
-	/**
-	 * Merge changes with data and clear.
-	 *
-	 * @since 1.0.19
-	 */
-	public function apply_changes() {
-		$this->data    = array_replace_recursive( $this->data, $this->changes );
-		$this->changes = array();
-	}
-
-	/**
-	 * Prefix for action and filter hooks on data.
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	protected function get_hook_prefix() {
-		return 'wpinv_get_' . $this->object_type . '_';
-	}
-
-	/**
-	 * Gets a prop for a getter method.
-	 *
-	 * Gets the value from either current pending changes, or the data itself.
-	 * Context controls what happens to the value before it's returned.
-	 *
-	 * @since  1.0.19
-	 * @param  string $prop Name of prop to get.
-	 * @param  string $context What the value is for. Valid values are view and edit.
-	 * @return mixed
-	 */
-	protected function get_prop( $prop, $context = 'view' ) {
-		$value = null;
-
-		if ( array_key_exists( $prop, $this->data ) ) {
-			$value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ];
-
-			if ( 'view' === $context ) {
-				$value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this );
-			}
-		}
-
-		return $value;
-	}
-
-	/**
-	 * Sets a date prop whilst handling formatting and datetime objects.
-	 *
-	 * @since 1.0.19
-	 * @param string         $prop Name of prop to set.
-	 * @param string|integer $value Value of the prop.
-	 */
-	protected function set_date_prop( $prop, $value ) {
-
-		if ( empty( $value ) ) {
-			$this->set_prop( $prop, null );
-			return;
-		}
-		$this->set_prop( $prop, $value );
-
-	}
-
-	/**
-	 * When invalid data is found, throw an exception unless reading from the DB.
-	 *
-	 * @since 1.0.19
-	 * @param string $code             Error code.
-	 * @param string $message          Error message.
-	 */
-	protected function error( $code, $message ) {
-		$this->last_error = $message;
-	}
-
-	/**
-	 * Checks if the object is saved in the database
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function exists() {
-		$id = $this->get_id();
-		return ! empty( $id );
-	}
+        $this->set_prop( 'status', $status );
+
+        return array(
+            'from' => $old_status,
+            'to'   => $status,
+        );
+    }
+
+    /**
+     * Set all props to default values.
+     *
+     * @since 1.0.19
+     */
+    public function set_defaults() {
+        $this->data    = $this->default_data;
+        $this->changes = array();
+        $this->set_object_read( false );
+    }
+
+    /**
+     * Set object read property.
+     *
+     * @since 1.0.19
+     * @param boolean $read Should read?.
+     */
+    public function set_object_read( $read = true ) {
+        $this->object_read = (bool) $read;
+    }
+
+    /**
+     * Get object read property.
+     *
+     * @since  1.0.19
+     * @return boolean
+     */
+    public function get_object_read() {
+        return (bool) $this->object_read;
+    }
+
+    /**
+     * Set a collection of props in one go, collect any errors, and return the result.
+     * Only sets using public methods.
+     *
+     * @since  1.0.19
+     *
+     * @param array  $props Key value pairs to set. Key is the prop and should map to a setter function name.
+     * @param string $context In what context to run this.
+     *
+     * @return bool|WP_Error
+     */
+    public function set_props( $props, $context = 'set' ) {
+        $errors = false;
+
+        foreach ( $props as $prop => $value ) {
+            try {
+                /**
+                 * Checks if the prop being set is allowed, and the value is not null.
+                 */
+                if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) {
+                    continue;
+                }
+                $setter = "set_$prop";
+
+                if ( is_callable( array( $this, $setter ) ) ) {
+                    $this->{$setter}( $value );
+                }
+            } catch ( Exception $e ) {
+                if ( ! $errors ) {
+                    $errors = new WP_Error();
+                }
+                $errors->add( $e->getCode(), $e->getMessage() );
+                $this->last_error = $e->getMessage();
+            }
+        }
+
+        return $errors && count( $errors->get_error_codes() ) ? $errors : true;
+    }
+
+    /**
+     * Sets a prop for a setter method.
+     *
+     * This stores changes in a special array so we can track what needs saving
+     * the the DB later.
+     *
+     * @since 1.0.19
+     * @param string $prop Name of prop to set.
+     * @param mixed  $value Value of the prop.
+     */
+    protected function set_prop( $prop, $value ) {
+        if ( array_key_exists( $prop, $this->data ) ) {
+            if ( true === $this->object_read ) {
+                if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) {
+                    $this->changes[ $prop ] = $value;
+                }
+            } else {
+                $this->data[ $prop ] = $value;
+            }
+        }
+    }
+
+    /**
+     * Return data changes only.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_changes() {
+        return $this->changes;
+    }
+
+    /**
+     * Merge changes with data and clear.
+     *
+     * @since 1.0.19
+     */
+    public function apply_changes() {
+        $this->data    = array_replace_recursive( $this->data, $this->changes );
+        $this->changes = array();
+    }
+
+    /**
+     * Prefix for action and filter hooks on data.
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    protected function get_hook_prefix() {
+        return 'wpinv_get_' . $this->object_type . '_';
+    }
+
+    /**
+     * Gets a prop for a getter method.
+     *
+     * Gets the value from either current pending changes, or the data itself.
+     * Context controls what happens to the value before it's returned.
+     *
+     * @since  1.0.19
+     * @param  string $prop Name of prop to get.
+     * @param  string $context What the value is for. Valid values are view and edit.
+     * @return mixed
+     */
+    protected function get_prop( $prop, $context = 'view' ) {
+        $value = null;
+
+        if ( array_key_exists( $prop, $this->data ) ) {
+            $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ];
+
+            if ( 'view' === $context ) {
+                $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this );
+            }
+        }
+
+        return $value;
+    }
+
+    /**
+     * Sets a date prop whilst handling formatting and datetime objects.
+     *
+     * @since 1.0.19
+     * @param string         $prop Name of prop to set.
+     * @param string|integer $value Value of the prop.
+     */
+    protected function set_date_prop( $prop, $value ) {
+
+        if ( empty( $value ) ) {
+            $this->set_prop( $prop, null );
+            return;
+        }
+        $this->set_prop( $prop, $value );
+
+    }
+
+    /**
+     * When invalid data is found, throw an exception unless reading from the DB.
+     *
+     * @since 1.0.19
+     * @param string $code             Error code.
+     * @param string $message          Error message.
+     */
+    protected function error( $code, $message ) {
+        $this->last_error = $message;
+    }
+
+    /**
+     * Checks if the object is saved in the database
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function exists() {
+        $id = $this->get_id();
+        return ! empty( $id );
+    }
 
 }

includes/data-stores/class-getpaid-invoice-data-store.php

Indentation +469 added lines, -469 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -15,539 +15,539 @@ 
  */
 class GetPaid_Invoice_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for a discount.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'_wpinv_subscr_profile_id',
-		'_wpinv_subscription_id',
-		'_wpinv_taxes',
-		'_wpinv_fees',
-		'_wpinv_discounts',
-		'_wpinv_submission_id',
-		'_wpinv_payment_form',
-		'_wpinv_is_viewed',
-		'_wpinv_phone',
-		'wpinv_email_cc',
-		'wpinv_template',
-		'wpinv_created_via'
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'_wpinv_subscr_profile_id' => 'remote_subscription_id',
-		'_wpinv_subscription_id'   => 'subscription_id',
-		'_wpinv_taxes'             => 'taxes',
-		'_wpinv_fees'              => 'fees',
-		'_wpinv_discounts'         => 'discounts',
-		'_wpinv_submission_id'     => 'submission_id',
-		'_wpinv_payment_form'      => 'payment_form',
-		'_wpinv_is_viewed'         => 'is_viewed',
-		'wpinv_email_cc'           => 'email_cc',
-		'wpinv_template'           => 'template',
-		'wpinv_created_via'        => 'created_via',
-		'_wpinv_phone'             => 'phone',
-	);
-
-	/**
-	 * A map of database fields to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $database_fields_to_props = array(
-		'post_id'            => 'id',
-		'number'             => 'number',
-		'currency'           => 'currency',
-		'key'                => 'key',
-		'type'               => 'type',
-		'mode'               => 'mode',
-		'user_ip'            => 'user_ip',
-		'first_name'         => 'first_name',
-		'last_name'          => 'last_name',
-		'address'            => 'address',
-		'city'               => 'city',
-		'state'              => 'state',
-		'country'            => 'country',
-		'zip'                => 'zip',
-		'zip'                => 'zip',
-		'adddress_confirmed' => 'address_confirmed',
-		'gateway'            => 'gateway',
-		'transaction_id'     => 'transaction_id',
-		'currency'           => 'currency',
-		'subtotal'           => 'subtotal',
-		'tax'                => 'total_tax',
-		'fees_total'         => 'total_fees',
-		'discount'           => 'total_discount',
-		'total'              => 'total',
-		'discount_code'      => 'discount_code',
-		'disable_taxes'      => 'disable_taxes',
-		'due_date'           => 'due_date',
-		'completed_date'     => 'completed_date',
-		'company'            => 'company',
-		'vat_number'         => 'vat_number',
-		'vat_rate'           => 'vat_rate',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for a discount.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        '_wpinv_subscr_profile_id',
+        '_wpinv_subscription_id',
+        '_wpinv_taxes',
+        '_wpinv_fees',
+        '_wpinv_discounts',
+        '_wpinv_submission_id',
+        '_wpinv_payment_form',
+        '_wpinv_is_viewed',
+        '_wpinv_phone',
+        'wpinv_email_cc',
+        'wpinv_template',
+        'wpinv_created_via'
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        '_wpinv_subscr_profile_id' => 'remote_subscription_id',
+        '_wpinv_subscription_id'   => 'subscription_id',
+        '_wpinv_taxes'             => 'taxes',
+        '_wpinv_fees'              => 'fees',
+        '_wpinv_discounts'         => 'discounts',
+        '_wpinv_submission_id'     => 'submission_id',
+        '_wpinv_payment_form'      => 'payment_form',
+        '_wpinv_is_viewed'         => 'is_viewed',
+        'wpinv_email_cc'           => 'email_cc',
+        'wpinv_template'           => 'template',
+        'wpinv_created_via'        => 'created_via',
+        '_wpinv_phone'             => 'phone',
+    );
+
+    /**
+     * A map of database fields to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $database_fields_to_props = array(
+        'post_id'            => 'id',
+        'number'             => 'number',
+        'currency'           => 'currency',
+        'key'                => 'key',
+        'type'               => 'type',
+        'mode'               => 'mode',
+        'user_ip'            => 'user_ip',
+        'first_name'         => 'first_name',
+        'last_name'          => 'last_name',
+        'address'            => 'address',
+        'city'               => 'city',
+        'state'              => 'state',
+        'country'            => 'country',
+        'zip'                => 'zip',
+        'zip'                => 'zip',
+        'adddress_confirmed' => 'address_confirmed',
+        'gateway'            => 'gateway',
+        'transaction_id'     => 'transaction_id',
+        'currency'           => 'currency',
+        'subtotal'           => 'subtotal',
+        'tax'                => 'total_tax',
+        'fees_total'         => 'total_fees',
+        'discount'           => 'total_discount',
+        'total'              => 'total',
+        'discount_code'      => 'discount_code',
+        'disable_taxes'      => 'disable_taxes',
+        'due_date'           => 'due_date',
+        'completed_date'     => 'completed_date',
+        'company'            => 'company',
+        'vat_number'         => 'vat_number',
+        'vat_rate'           => 'vat_rate',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new invoice in the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 */
-	public function create( &$invoice ) {
-		$invoice->set_version( WPINV_VERSION );
-		$invoice->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_invoice_data',
-				array(
-					'post_date'     => $invoice->get_date_created( 'edit' ),
-					'post_type'     => $invoice->get_post_type( 'edit' ),
-					'post_status'   => $this->get_post_status( $invoice ),
-					'ping_status'   => 'closed',
-					'post_author'   => $invoice->get_user_id( 'edit' ),
-					'post_title'    => $invoice->get_title( 'edit' ),
-					'post_excerpt'  => $invoice->get_description( 'edit' ),
-					'post_parent'   => $invoice->get_parent_id( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-
-			// Update the new id and regenerate a title.
-			$invoice->set_id( $id );
-
-			$invoice->maybe_set_number();
-
-			wp_update_post(
-				array(
-					'ID'         => $invoice->get_id(),
-					'post_title' => $invoice->get_number( 'edit' ),
-					'post_name'  => $invoice->get_path( 'edit' )
-				)
-			);
-
-			// Save special fields and items.
-			$this->save_special_fields( $invoice );
-			$this->save_items( $invoice );
-
-			// Update meta data.
-			$this->update_post_meta( $invoice );
-			$invoice->save_meta_data();
-
-			// Apply changes.
-			$invoice->apply_changes();
-			$this->clear_caches( $invoice );
-
-			// Fires after a new invoice is created.
-			do_action( 'getpaid_new_invoice', $invoice );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$invoice->last_error = $id->get_error_message();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read an invoice from the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 *
-	 */
-	public function read( &$invoice ) {
-
-		$invoice->set_defaults();
-		$invoice_object = get_post( $invoice->get_id() );
-
-		if ( ! $invoice->get_id() || ! $invoice_object || ! getpaid_is_invoice_post_type( $invoice_object->post_type ) ) {
-			$invoice->last_error = __( 'Invalid invoice.', 'invoicing' );
-			$invoice->set_id( 0 );
-			return false;
-		}
-
-		$invoice->set_props(
-			array(
-				'date_created'  => 0 < $invoice_object->post_date ? $invoice_object->post_date : null,
-				'date_modified' => 0 < $invoice_object->post_modified ? $invoice_object->post_modified : null,
-				'status'        => $invoice_object->post_status,
-				'author'        => $invoice_object->post_author,
-				'description'   => $invoice_object->post_excerpt,
-				'parent_id'     => $invoice_object->post_parent,
-				'name'          => $invoice_object->post_title,
-				'path'          => $invoice_object->post_name,
-				'post_type'     => $invoice_object->post_type,
-			)
-		);
-
-		$invoice->set_type( $invoice_object->post_type );
-
-		$this->read_object_data( $invoice, $invoice_object );
-		$this->add_special_fields( $invoice );
-		$this->add_items( $invoice );
-		$invoice->read_meta_data();
-		$invoice->set_object_read( true );
-		do_action( 'getpaid_read_invoice', $invoice );
-
-	}
-
-	/**
-	 * Method to update an invoice in the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 */
-	public function update( &$invoice ) {
-		$invoice->save_meta_data();
-		$invoice->set_version( WPINV_VERSION );
-
-		if ( null === $invoice->get_date_created( 'edit' ) ) {
-			$invoice->set_date_created(  current_time('mysql') );
-		}
-
-		// Ensure both the key and number are set.
-		$invoice->get_path();
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $invoice->get_id() );
-
-		$changes = $invoice->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'description', 'parent_id', 'post_excerpt', 'path' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $invoice->get_date_created( 'edit' ),
-				'post_date_gmt'     => $invoice->get_date_created_gmt( 'edit' ),
-				'post_status'       => $invoice->get_status( 'edit' ),
-				'post_title'        => $invoice->get_name( 'edit' ),
-				'post_author'       => $invoice->get_user_id( 'edit' ),
-				'post_modified'     => $invoice->get_date_modified( 'edit' ),
-				'post_excerpt'      => $invoice->get_description( 'edit' ),
-				'post_parent'       => $invoice->get_parent_id( 'edit' ),
-				'post_name'         => $invoice->get_path( 'edit' ),
-				'post_type'         => $invoice->get_post_type( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $invoice->get_id() ) );
-				clean_post_cache( $invoice->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $invoice->get_id() ), $post_data ) );
-			}
-			$invoice->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-
-		// Update meta data.
-		$this->update_post_meta( $invoice );
-
-		// Save special fields and items.
-		$this->save_special_fields( $invoice );
-		$this->save_items( $invoice );
-
-		// Apply the changes.
-		$invoice->apply_changes();
-
-		// Clear caches.
-		$this->clear_caches( $invoice );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $invoice->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_invoice', $invoice );
-		} else {
-			do_action( 'getpaid_update_invoice', $invoice );
-		}
-
-	}
-
-	/*
+    /**
+     * Method to create a new invoice in the database.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     */
+    public function create( &$invoice ) {
+        $invoice->set_version( WPINV_VERSION );
+        $invoice->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_invoice_data',
+                array(
+                    'post_date'     => $invoice->get_date_created( 'edit' ),
+                    'post_type'     => $invoice->get_post_type( 'edit' ),
+                    'post_status'   => $this->get_post_status( $invoice ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $invoice->get_user_id( 'edit' ),
+                    'post_title'    => $invoice->get_title( 'edit' ),
+                    'post_excerpt'  => $invoice->get_description( 'edit' ),
+                    'post_parent'   => $invoice->get_parent_id( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+
+            // Update the new id and regenerate a title.
+            $invoice->set_id( $id );
+
+            $invoice->maybe_set_number();
+
+            wp_update_post(
+                array(
+                    'ID'         => $invoice->get_id(),
+                    'post_title' => $invoice->get_number( 'edit' ),
+                    'post_name'  => $invoice->get_path( 'edit' )
+                )
+            );
+
+            // Save special fields and items.
+            $this->save_special_fields( $invoice );
+            $this->save_items( $invoice );
+
+            // Update meta data.
+            $this->update_post_meta( $invoice );
+            $invoice->save_meta_data();
+
+            // Apply changes.
+            $invoice->apply_changes();
+            $this->clear_caches( $invoice );
+
+            // Fires after a new invoice is created.
+            do_action( 'getpaid_new_invoice', $invoice );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $invoice->last_error = $id->get_error_message();
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read an invoice from the database.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     *
+     */
+    public function read( &$invoice ) {
+
+        $invoice->set_defaults();
+        $invoice_object = get_post( $invoice->get_id() );
+
+        if ( ! $invoice->get_id() || ! $invoice_object || ! getpaid_is_invoice_post_type( $invoice_object->post_type ) ) {
+            $invoice->last_error = __( 'Invalid invoice.', 'invoicing' );
+            $invoice->set_id( 0 );
+            return false;
+        }
+
+        $invoice->set_props(
+            array(
+                'date_created'  => 0 < $invoice_object->post_date ? $invoice_object->post_date : null,
+                'date_modified' => 0 < $invoice_object->post_modified ? $invoice_object->post_modified : null,
+                'status'        => $invoice_object->post_status,
+                'author'        => $invoice_object->post_author,
+                'description'   => $invoice_object->post_excerpt,
+                'parent_id'     => $invoice_object->post_parent,
+                'name'          => $invoice_object->post_title,
+                'path'          => $invoice_object->post_name,
+                'post_type'     => $invoice_object->post_type,
+            )
+        );
+
+        $invoice->set_type( $invoice_object->post_type );
+
+        $this->read_object_data( $invoice, $invoice_object );
+        $this->add_special_fields( $invoice );
+        $this->add_items( $invoice );
+        $invoice->read_meta_data();
+        $invoice->set_object_read( true );
+        do_action( 'getpaid_read_invoice', $invoice );
+
+    }
+
+    /**
+     * Method to update an invoice in the database.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     */
+    public function update( &$invoice ) {
+        $invoice->save_meta_data();
+        $invoice->set_version( WPINV_VERSION );
+
+        if ( null === $invoice->get_date_created( 'edit' ) ) {
+            $invoice->set_date_created(  current_time('mysql') );
+        }
+
+        // Ensure both the key and number are set.
+        $invoice->get_path();
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $invoice->get_id() );
+
+        $changes = $invoice->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'description', 'parent_id', 'post_excerpt', 'path' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $invoice->get_date_created( 'edit' ),
+                'post_date_gmt'     => $invoice->get_date_created_gmt( 'edit' ),
+                'post_status'       => $invoice->get_status( 'edit' ),
+                'post_title'        => $invoice->get_name( 'edit' ),
+                'post_author'       => $invoice->get_user_id( 'edit' ),
+                'post_modified'     => $invoice->get_date_modified( 'edit' ),
+                'post_excerpt'      => $invoice->get_description( 'edit' ),
+                'post_parent'       => $invoice->get_parent_id( 'edit' ),
+                'post_name'         => $invoice->get_path( 'edit' ),
+                'post_type'         => $invoice->get_post_type( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $invoice->get_id() ) );
+                clean_post_cache( $invoice->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $invoice->get_id() ), $post_data ) );
+            }
+            $invoice->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+
+        // Update meta data.
+        $this->update_post_meta( $invoice );
+
+        // Save special fields and items.
+        $this->save_special_fields( $invoice );
+        $this->save_items( $invoice );
+
+        // Apply the changes.
+        $invoice->apply_changes();
+
+        // Clear caches.
+        $this->clear_caches( $invoice );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $invoice->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_invoice', $invoice );
+        } else {
+            do_action( 'getpaid_update_invoice', $invoice );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
+    /**
      * Retrieves special fields and adds to the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function add_special_fields( &$invoice ) {
-		global $wpdb;
+        global $wpdb;
 
-		// Maybe retrieve from the cache.
-		$data   = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_special_fields' );
+        // Maybe retrieve from the cache.
+        $data   = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_special_fields' );
 
-		// If not found, retrieve from the db.
-		if ( false === $data ) {
-			$table =  $wpdb->prefix . 'getpaid_invoices';
+        // If not found, retrieve from the db.
+        if ( false === $data ) {
+            $table =  $wpdb->prefix . 'getpaid_invoices';
 
-			$data  = $wpdb->get_row(
-				$wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d LIMIT 1", $invoice->get_id() ),
-				ARRAY_A
-			);
+            $data  = $wpdb->get_row(
+                $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d LIMIT 1", $invoice->get_id() ),
+                ARRAY_A
+            );
 
-			// Update the cache with our data
-			wp_cache_set( $invoice->get_id(), $data, 'getpaid_invoice_special_fields' );
+            // Update the cache with our data
+            wp_cache_set( $invoice->get_id(), $data, 'getpaid_invoice_special_fields' );
 
-		}
+        }
 
-		// Abort if the data does not exist.
-		if ( empty( $data ) ) {
-			$invoice->set_object_read( true );
-			$invoice->set_props( wpinv_get_user_address( $invoice->get_user_id() ) );
-			return;
-		}
+        // Abort if the data does not exist.
+        if ( empty( $data ) ) {
+            $invoice->set_object_read( true );
+            $invoice->set_props( wpinv_get_user_address( $invoice->get_user_id() ) );
+            return;
+        }
 
-		$props = array();
+        $props = array();
 
-		foreach ( $this->database_fields_to_props as $db_field => $prop ) {
+        foreach ( $this->database_fields_to_props as $db_field => $prop ) {
 			
-			if ( $db_field == 'post_id' ) {
-				continue;
-			}
-
-			$props[ $prop ] = $data[ $db_field ];
-		}
-
-		$invoice->set_props( $props );
-
-	}
-
-	/**
-	 * Gets a list of special fields that need updated based on change state
-	 * or if they are present in the database or not.
-	 *
-	 * @param  WPInv_Invoice $invoice       The Invoice object.
-	 * @return array                        A mapping of field keys => prop names, filtered by ones that should be updated.
-	 */
-	protected function get_special_fields_to_update( $invoice ) {
-		$fields_to_update = array();
-		$changed_props   = $invoice->get_changes();
-
-		// Props should be updated if they are a part of the $changed array or don't exist yet.
-		foreach ( $this->database_fields_to_props as $database_field => $prop ) {
-			if ( array_key_exists( $prop, $changed_props ) ) {
-				$fields_to_update[ $database_field ] = $prop;
-			}
-		}
-
-		return $fields_to_update;
-	}
-
-	/**
-	 * Helper method that updates all the database fields for an invoice based on it's settings in the WPInv_Invoice class.
-	 *
-	 * @param WPInv_Invoice $invoice WPInv_Invoice object.
-	 * @since 1.0.19
-	 */
-	protected function update_special_fields( &$invoice ) {
-		global $wpdb;
-
-		$updated_props    = array();
-		$fields_to_update = $this->get_special_fields_to_update( $invoice );
-
-		foreach ( $fields_to_update as $database_field => $prop ) {
-			$value = $invoice->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
-			$value = is_bool( $value ) ? ( int ) $value : $value;
-			$updated_props[ $database_field ] = maybe_serialize( $value );
-		}
-
-		if ( ! empty( $updated_props ) ) {
-
-			$table = $wpdb->prefix . 'getpaid_invoices';
-			$wpdb->update( $table, $updated_props, array( 'post_id' => $invoice->get_id() ) );
-			wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
-			do_action( "getpaid_invoice_update_database_fields", $invoice, $updated_props );
-
-		}
-
-	}
-
-	/**
-	 * Helper method that inserts special fields to the database.
-	 *
-	 * @param WPInv_Invoice $invoice WPInv_Invoice object.
-	 * @since 1.0.19
-	 */
-	protected function insert_special_fields( &$invoice ) {
-		global $wpdb;
-
-		$updated_props   = array();
-
-		foreach ( $this->database_fields_to_props as $database_field => $prop ) {
-			$value = $invoice->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
-			$value = is_bool( $value ) ? ( int ) $value : $value;
-			$updated_props[ $database_field ] = maybe_serialize( $value );
-		}
-
-		$table = $wpdb->prefix . 'getpaid_invoices';
-		$wpdb->insert( $table, $updated_props );
-		wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
-		do_action( "getpaid_invoice_insert_database_fields", $invoice, $updated_props );
-
-	}
-
-	/**
+            if ( $db_field == 'post_id' ) {
+                continue;
+            }
+
+            $props[ $prop ] = $data[ $db_field ];
+        }
+
+        $invoice->set_props( $props );
+
+    }
+
+    /**
+     * Gets a list of special fields that need updated based on change state
+     * or if they are present in the database or not.
+     *
+     * @param  WPInv_Invoice $invoice       The Invoice object.
+     * @return array                        A mapping of field keys => prop names, filtered by ones that should be updated.
+     */
+    protected function get_special_fields_to_update( $invoice ) {
+        $fields_to_update = array();
+        $changed_props   = $invoice->get_changes();
+
+        // Props should be updated if they are a part of the $changed array or don't exist yet.
+        foreach ( $this->database_fields_to_props as $database_field => $prop ) {
+            if ( array_key_exists( $prop, $changed_props ) ) {
+                $fields_to_update[ $database_field ] = $prop;
+            }
+        }
+
+        return $fields_to_update;
+    }
+
+    /**
+     * Helper method that updates all the database fields for an invoice based on it's settings in the WPInv_Invoice class.
+     *
+     * @param WPInv_Invoice $invoice WPInv_Invoice object.
+     * @since 1.0.19
+     */
+    protected function update_special_fields( &$invoice ) {
+        global $wpdb;
+
+        $updated_props    = array();
+        $fields_to_update = $this->get_special_fields_to_update( $invoice );
+
+        foreach ( $fields_to_update as $database_field => $prop ) {
+            $value = $invoice->{"get_$prop"}( 'edit' );
+            $value = is_string( $value ) ? wp_slash( $value ) : $value;
+            $value = is_bool( $value ) ? ( int ) $value : $value;
+            $updated_props[ $database_field ] = maybe_serialize( $value );
+        }
+
+        if ( ! empty( $updated_props ) ) {
+
+            $table = $wpdb->prefix . 'getpaid_invoices';
+            $wpdb->update( $table, $updated_props, array( 'post_id' => $invoice->get_id() ) );
+            wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
+            do_action( "getpaid_invoice_update_database_fields", $invoice, $updated_props );
+
+        }
+
+    }
+
+    /**
+     * Helper method that inserts special fields to the database.
+     *
+     * @param WPInv_Invoice $invoice WPInv_Invoice object.
+     * @since 1.0.19
+     */
+    protected function insert_special_fields( &$invoice ) {
+        global $wpdb;
+
+        $updated_props   = array();
+
+        foreach ( $this->database_fields_to_props as $database_field => $prop ) {
+            $value = $invoice->{"get_$prop"}( 'edit' );
+            $value = is_string( $value ) ? wp_slash( $value ) : $value;
+            $value = is_bool( $value ) ? ( int ) $value : $value;
+            $updated_props[ $database_field ] = maybe_serialize( $value );
+        }
+
+        $table = $wpdb->prefix . 'getpaid_invoices';
+        $wpdb->insert( $table, $updated_props );
+        wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
+        do_action( "getpaid_invoice_insert_database_fields", $invoice, $updated_props );
+
+    }
+
+    /**
      * Saves all special fields.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function save_special_fields( & $invoice ) {
-		global $wpdb;
+        global $wpdb;
 
-		// The invoices table.
-		$table = $wpdb->prefix . 'getpaid_invoices';
-		$id    = (int) $invoice->get_id();
-		$invoice->maybe_set_key();
+        // The invoices table.
+        $table = $wpdb->prefix . 'getpaid_invoices';
+        $id    = (int) $invoice->get_id();
+        $invoice->maybe_set_key();
 
-		if ( $wpdb->get_var( "SELECT `post_id` FROM $table WHERE `post_id`= $id" ) ) {
+        if ( $wpdb->get_var( "SELECT `post_id` FROM $table WHERE `post_id`= $id" ) ) {
 
-			$this->update_special_fields( $invoice );
+            $this->update_special_fields( $invoice );
 
-		} else {
+        } else {
 
-			$this->insert_special_fields( $invoice );
+            $this->insert_special_fields( $invoice );
 
-		}
+        }
 
-	}
+    }
 
-	/**
+    /**
      * Set's up cart details.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function add_items( &$invoice ) {
-		global $wpdb;
+        global $wpdb;
 
-		// Maybe retrieve from the cache.
-		$items = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_cart_details' );
+        // Maybe retrieve from the cache.
+        $items = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_cart_details' );
 
-		// If not found, retrieve from the db.
-		if ( false === $items ) {
-			$table =  $wpdb->prefix . 'getpaid_invoice_items';
+        // If not found, retrieve from the db.
+        if ( false === $items ) {
+            $table =  $wpdb->prefix . 'getpaid_invoice_items';
 
-			$items = $wpdb->get_results(
-				$wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d", $invoice->get_id() )
-			);
+            $items = $wpdb->get_results(
+                $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d", $invoice->get_id() )
+            );
 
-			// Update the cache with our data
-			wp_cache_set( $invoice->get_id(), $items, 'getpaid_invoice_cart_details' );
+            // Update the cache with our data
+            wp_cache_set( $invoice->get_id(), $items, 'getpaid_invoice_cart_details' );
 
-		}
+        }
 
-		// Abort if no items found.
+        // Abort if no items found.
         if ( empty( $items ) ) {
             return;
-		}
+        }
 
-		foreach ( $items as $item_data ) {
-			$item = new GetPaid_Form_Item( $item_data->item_id );
+        foreach ( $items as $item_data ) {
+            $item = new GetPaid_Form_Item( $item_data->item_id );
 
-			// Set item data.
-			$item->item_tax      = wpinv_sanitize_amount( $item_data->tax );
-			$item->item_discount = wpinv_sanitize_amount( $item_data->discount );
-			$item->set_name( $item_data->item_name );
-			$item->set_description( $item_data->item_description );
-			$item->set_price( $item_data->item_price );
-			$item->set_quantity( $item_data->quantity );
-			$item->set_item_meta( $item_data->meta );
+            // Set item data.
+            $item->item_tax      = wpinv_sanitize_amount( $item_data->tax );
+            $item->item_discount = wpinv_sanitize_amount( $item_data->discount );
+            $item->set_name( $item_data->item_name );
+            $item->set_description( $item_data->item_description );
+            $item->set_price( $item_data->item_price );
+            $item->set_quantity( $item_data->quantity );
+            $item->set_item_meta( $item_data->meta );
 
-			$invoice->add_item( $item );
-		}
+            $invoice->add_item( $item );
+        }
 
-	}
+    }
 
-	/**
+    /**
      * Saves cart details.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function save_items( $invoice ) {
 
-		// Delete previously existing items.
-		$this->delete_items( $invoice );
+        // Delete previously existing items.
+        $this->delete_items( $invoice );
 
-		$table   =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
+        $table   =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
 
-		foreach ( $invoice->get_cart_details() as $item_data ) {
-			$item_data = array_map( 'maybe_serialize', $item_data );
-			$GLOBALS['wpdb']->insert( $table, $item_data );
-		}
+        foreach ( $invoice->get_cart_details() as $item_data ) {
+            $item_data = array_map( 'maybe_serialize', $item_data );
+            $GLOBALS['wpdb']->insert( $table, $item_data );
+        }
 
-		wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_cart_details' );
-		do_action( "getpaid_invoice_save_items", $invoice );
+        wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_cart_details' );
+        do_action( "getpaid_invoice_save_items", $invoice );
 
-	}
+    }
 
-	/**
+    /**
      * Deletes an invoice's cart details from the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function delete_items( $invoice ) {
-		$table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
-		return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
-	}
+        $table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
+        return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
+    }
 
-	/**
+    /**
      * Deletes an invoice's special fields from the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function delete_special_fields( $invoice ) {
-		$table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoices';
-		return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
-	}
+        $table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoices';
+        return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
+    }
 	
-	/**
-	 * Get the status to save to the post object.
-	 *
-	 *
-	 * @since 1.0.19
-	 * @param  WPInv_Invoice $object GetPaid_Data object.
-	 * @return string
-	 */
-	protected function get_post_status( $object ) {
-		$object_status = $object->get_status( 'edit' );
-
-		if ( ! $object_status ) {
-			$object_status = $object->get_default_status();
-		}
-
-		return $object_status;
-	}
+    /**
+     * Get the status to save to the post object.
+     *
+     *
+     * @since 1.0.19
+     * @param  WPInv_Invoice $object GetPaid_Data object.
+     * @return string
+     */
+    protected function get_post_status( $object ) {
+        $object_status = $object->get_status( 'edit' );
+
+        if ( ! $object_status ) {
+            $object_status = $object->get_default_status();
+        }
+
+        return $object_status;
+    }
 
 }