AyeCode / invoicing

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

Indentation +210 added lines, -210 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -14,228 +14,228 @@ 
  */
 class GetPaid_Item_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for an item.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'_wpinv_price',
-		'_wpinv_vat_rule',
-		'_wpinv_vat_class',
-		'_wpinv_type',
-		'_wpinv_custom_id',
-		'_wpinv_custom_name',
-		'_wpinv_custom_singular_name',
-		'_wpinv_editable',
-		'_wpinv_dynamic_pricing',
-		'_minimum_price',
-		'_wpinv_is_recurring',
-		'_wpinv_recurring_period',
-		'_wpinv_recurring_interval',
-		'_wpinv_recurring_limit',
-		'_wpinv_free_trial',
-		'_wpinv_trial_period',
-		'_wpinv_trial_interval',
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'_wpinv_price'                => 'price',
-		'_wpinv_vat_rule'             => 'vat_rule',
-		'_wpinv_vat_class'            => 'vat_class',
-		'_wpinv_type'                 => 'type',
-		'_wpinv_custom_id'            => 'custom_id',
-		'_wpinv_custom_name'          => 'custom_name',
-		'_wpinv_custom_singular_name' => 'custom_singular_name',
-		'_wpinv_editable'             => 'is_editable',
-		'_wpinv_dynamic_pricing'      => 'is_dynamic_pricing',
-		'_minimum_price'              => 'minimum_price',
-		'_wpinv_custom_name'          => 'custom_name',
-		'_wpinv_is_recurring'         => 'is_recurring',
-		'_wpinv_recurring_period'     => 'recurring_period',
-		'_wpinv_recurring_interval'   => 'recurring_interval',
-		'_wpinv_recurring_limit'      => 'recurring_limit',
-		'_wpinv_free_trial'           => 'is_free_trial',
-		'_wpinv_trial_period'         => 'trial_period',
-		'_wpinv_trial_interval'       => 'trial_interval',
-		'_wpinv_version'              => 'version',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for an item.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        '_wpinv_price',
+        '_wpinv_vat_rule',
+        '_wpinv_vat_class',
+        '_wpinv_type',
+        '_wpinv_custom_id',
+        '_wpinv_custom_name',
+        '_wpinv_custom_singular_name',
+        '_wpinv_editable',
+        '_wpinv_dynamic_pricing',
+        '_minimum_price',
+        '_wpinv_is_recurring',
+        '_wpinv_recurring_period',
+        '_wpinv_recurring_interval',
+        '_wpinv_recurring_limit',
+        '_wpinv_free_trial',
+        '_wpinv_trial_period',
+        '_wpinv_trial_interval',
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        '_wpinv_price'                => 'price',
+        '_wpinv_vat_rule'             => 'vat_rule',
+        '_wpinv_vat_class'            => 'vat_class',
+        '_wpinv_type'                 => 'type',
+        '_wpinv_custom_id'            => 'custom_id',
+        '_wpinv_custom_name'          => 'custom_name',
+        '_wpinv_custom_singular_name' => 'custom_singular_name',
+        '_wpinv_editable'             => 'is_editable',
+        '_wpinv_dynamic_pricing'      => 'is_dynamic_pricing',
+        '_minimum_price'              => 'minimum_price',
+        '_wpinv_custom_name'          => 'custom_name',
+        '_wpinv_is_recurring'         => 'is_recurring',
+        '_wpinv_recurring_period'     => 'recurring_period',
+        '_wpinv_recurring_interval'   => 'recurring_interval',
+        '_wpinv_recurring_limit'      => 'recurring_limit',
+        '_wpinv_free_trial'           => 'is_free_trial',
+        '_wpinv_trial_period'         => 'trial_period',
+        '_wpinv_trial_interval'       => 'trial_interval',
+        '_wpinv_version'              => 'version',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new item in the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 */
-	public function create( &$item ) {
-		$item->set_version( WPINV_VERSION );
-		$item->set_date_created( current_time( 'mysql' ) );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_item_data',
-				array(
-					'post_date'    => $item->get_date_created( 'edit' ),
-					'post_type'    => 'wpi_item',
-					'post_status'  => $this->get_post_status( $item ),
-					'ping_status'  => 'closed',
-					'post_author'  => $item->get_author( 'edit' ),
-					'post_title'   => $item->get_name( 'edit' ),
-					'post_parent'  => $item->get_parent_id(),
-					'post_excerpt' => $item->get_description( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$item->set_id( $id );
-			$this->update_post_meta( $item );
-			$item->save_meta_data();
-			$item->apply_changes();
-			$this->clear_caches( $item );
-			do_action( 'getpaid_new_item', $item );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$item->last_error = $id->get_error_message();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read an item from the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 *
-	 */
-	public function read( &$item ) {
-
-		$item->set_defaults();
-		$item_object = get_post( $item->get_id() );
-
-		if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) {
-			$item->last_error = __( 'Invalid item.', 'invoicing' );
-			$item->set_id( 0 );
-			return false;
-		}
-
-		$item->set_props(
-			array(
-				'parent_id'     => $item_object->post_parent,
-				'date_created'  => 0 < $item_object->post_date ? $item_object->post_date : null,
-				'date_modified' => 0 < $item_object->post_modified ? $item_object->post_modified : null,
-				'status'        => $item_object->post_status,
-				'name'          => $item_object->post_title,
-				'description'   => $item_object->post_excerpt,
-				'author'        => $item_object->post_author,
-			)
-		);
-
-		$this->read_object_data( $item, $item_object );
-		$item->read_meta_data();
-		$item->set_object_read( true );
-		do_action( 'getpaid_read_item', $item );
-
-	}
-
-	/**
-	 * Method to update an item in the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 */
-	public function update( &$item ) {
-		$item->save_meta_data();
-		$item->set_version( WPINV_VERSION );
-
-		if ( null === $item->get_date_created( 'edit' ) ) {
-			$item->set_date_created( current_time( 'mysql' ) );
-		}
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $item->get_id() );
-
-		$changes = $item->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'description', 'name', 'author' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'     => $item->get_date_created( 'edit' ),
-				'post_status'   => $item->get_status( 'edit' ),
-				'post_parent'   => $item->get_parent_id( 'edit' ),
-				'post_excerpt'  => $item->get_description( 'edit' ),
-				'post_modified' => $item->get_date_modified( 'edit' ),
-				'post_title'    => $item->get_name( 'edit' ),
-				'post_author'   => $item->get_author( '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' => $item->get_id() ) );
-				clean_post_cache( $item->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) );
-			}
-			$item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $item );
-		$item->apply_changes();
-		$this->clear_caches( $item );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $item->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_item', $item );
-		} else {
-			do_action( 'getpaid_update_item', $item );
-		}
-
-	}
-
-	/*
+    /**
+     * Method to create a new item in the database.
+     *
+     * @param WPInv_Item $item Item object.
+     */
+    public function create( &$item ) {
+        $item->set_version( WPINV_VERSION );
+        $item->set_date_created( current_time( 'mysql' ) );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_item_data',
+                array(
+                    'post_date'    => $item->get_date_created( 'edit' ),
+                    'post_type'    => 'wpi_item',
+                    'post_status'  => $this->get_post_status( $item ),
+                    'ping_status'  => 'closed',
+                    'post_author'  => $item->get_author( 'edit' ),
+                    'post_title'   => $item->get_name( 'edit' ),
+                    'post_parent'  => $item->get_parent_id(),
+                    'post_excerpt' => $item->get_description( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $item->set_id( $id );
+            $this->update_post_meta( $item );
+            $item->save_meta_data();
+            $item->apply_changes();
+            $this->clear_caches( $item );
+            do_action( 'getpaid_new_item', $item );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $item->last_error = $id->get_error_message();
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read an item from the database.
+     *
+     * @param WPInv_Item $item Item object.
+     *
+     */
+    public function read( &$item ) {
+
+        $item->set_defaults();
+        $item_object = get_post( $item->get_id() );
+
+        if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) {
+            $item->last_error = __( 'Invalid item.', 'invoicing' );
+            $item->set_id( 0 );
+            return false;
+        }
+
+        $item->set_props(
+            array(
+                'parent_id'     => $item_object->post_parent,
+                'date_created'  => 0 < $item_object->post_date ? $item_object->post_date : null,
+                'date_modified' => 0 < $item_object->post_modified ? $item_object->post_modified : null,
+                'status'        => $item_object->post_status,
+                'name'          => $item_object->post_title,
+                'description'   => $item_object->post_excerpt,
+                'author'        => $item_object->post_author,
+            )
+        );
+
+        $this->read_object_data( $item, $item_object );
+        $item->read_meta_data();
+        $item->set_object_read( true );
+        do_action( 'getpaid_read_item', $item );
+
+    }
+
+    /**
+     * Method to update an item in the database.
+     *
+     * @param WPInv_Item $item Item object.
+     */
+    public function update( &$item ) {
+        $item->save_meta_data();
+        $item->set_version( WPINV_VERSION );
+
+        if ( null === $item->get_date_created( 'edit' ) ) {
+            $item->set_date_created( current_time( 'mysql' ) );
+        }
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $item->get_id() );
+
+        $changes = $item->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'description', 'name', 'author' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'     => $item->get_date_created( 'edit' ),
+                'post_status'   => $item->get_status( 'edit' ),
+                'post_parent'   => $item->get_parent_id( 'edit' ),
+                'post_excerpt'  => $item->get_description( 'edit' ),
+                'post_modified' => $item->get_date_modified( 'edit' ),
+                'post_title'    => $item->get_name( 'edit' ),
+                'post_author'   => $item->get_author( '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' => $item->get_id() ) );
+                clean_post_cache( $item->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) );
+            }
+            $item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $item );
+        $item->apply_changes();
+        $this->clear_caches( $item );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $item->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_item', $item );
+        } else {
+            do_action( 'getpaid_update_item', $item );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class.
-	 *
-	 * @param WPInv_Item $item WPInv_Item object.
-	 * @since 1.0.19
-	 */
-	protected function update_post_meta( &$item ) {
+    /**
+     * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class.
+     *
+     * @param WPInv_Item $item WPInv_Item object.
+     * @since 1.0.19
+     */
+    protected function update_post_meta( &$item ) {
 
-		// Ensure that we have a custom id.
+        // Ensure that we have a custom id.
         if ( ! $item->get_custom_id() ) {
             $item->set_custom_id( $item->get_id() );
-		}
+        }
 
-		parent::update_post_meta( $item );
-	}
+        parent::update_post_meta( $item );
+    }
 
 }

includes/payments/class-getpaid-payment-form-submission.php

Indentation +878 added lines, -878 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,199 +10,199 @@ 
 class GetPaid_Payment_Form_Submission {
 
     /**
-	 * Submission ID
-	 *
-	 * @var string
-	 */
-	public $id = null;
-
-	/**
-	 * The raw submission data.
-	 *
-	 * @var array
-	 */
-	protected $data = null;
-
-	/**
-	 * Submission totals
-	 *
-	 * @var array
-	 */
-	protected $totals = array(
-
-		'subtotal' => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'discount' => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'fees'     => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'taxes'    => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'shipping' => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-	);
-
-	/**
-	 * Sets the associated payment form.
-	 *
-	 * @var GetPaid_Payment_Form
-	 */
+     * Submission ID
+     *
+     * @var string
+     */
+    public $id = null;
+
+    /**
+     * The raw submission data.
+     *
+     * @var array
+     */
+    protected $data = null;
+
+    /**
+     * Submission totals
+     *
+     * @var array
+     */
+    protected $totals = array(
+
+        'subtotal' => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'discount' => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'fees'     => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'taxes'    => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'shipping' => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+    );
+
+    /**
+     * Sets the associated payment form.
+     *
+     * @var GetPaid_Payment_Form
+     */
     protected $payment_form = null;
 
     /**
-	 * The country for the submission.
-	 *
-	 * @var string
-	 */
-	public $country = null;
-
-    /**
-	 * The state for the submission.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $state = null;
-
-	/**
-	 * The invoice associated with the submission.
-	 *
-	 * @var WPInv_Invoice
-	 */
-	protected $invoice = null;
-
-	/**
-	 * The recurring item for the submission.
-	 *
-	 * @var int
-	 */
-	public $has_recurring = 0;
-
-	/**
-	 * An array of fees for the submission.
-	 *
-	 * @var array
-	 */
-	protected $fees = array();
-
-	/**
-	 * An array of discounts for the submission.
-	 *
-	 * @var array
-	 */
-	protected $discounts = array();
-
-	/**
-	 * An array of taxes for the submission.
-	 *
-	 * @var array
-	 */
-	protected $taxes = array();
-
-	/**
-	 * An array of items for the submission.
-	 *
-	 * @var GetPaid_Form_Item[]
-	 */
-	protected $items = array();
-
-	/**
-	 * The last error.
-	 *
-	 * @var string
-	 */
-	public $last_error = null;
-
-	/**
-	 * The last error code.
-	 *
-	 * @var string
-	 */
-	public $last_error_code = null;
-
-    /**
-	 * Class constructor.
-	 *
-	 */
-	public function __construct() {
-
-		// Set the state and country to the default state and country.
-		$this->country = wpinv_default_billing_country();
-		$this->state   = wpinv_get_default_state();
-
-		// Do we have an actual submission?
-		if ( isset( $_POST['getpaid_payment_form_submission'] ) ) {
-			$this->load_data( wp_kses_post_deep( wp_unslash( $_POST ) ) );
-		}
-
-	}
-
-	/**
-	 * Loads submission data.
-	 *
-	 * @param array $data
-	 */
-	public function load_data( $data ) {
-
-		// Allow plugins to filter the data.
-		$data       = apply_filters( 'getpaid_submission_data', $data, $this );
-
-		// Cache it...
-		$this->data = $data;
-
-		// Then generate a unique id from the data.
-		$this->id   = md5( wp_json_encode( $data ) );
-
-		// Finally, process the submission.
-		try {
-
-			// Each process is passed an instance of the class (with reference)
-			// and should throw an Exception whenever it encounters one.
-			$processors = apply_filters(
-				'getpaid_payment_form_submission_processors',
-				array(
-					array( $this, 'process_payment_form' ),
-					array( $this, 'process_invoice' ),
-					array( $this, 'process_fees' ),
-					array( $this, 'process_items' ),
-					array( $this, 'process_discount' ),
-					array( $this, 'process_taxes' ),
-				),
-				$this
-			);
-
-			foreach ( $processors as $processor ) {
-				call_user_func_array( $processor, array( &$this ) );
-			}
-		} catch ( GetPaid_Payment_Exception $e ) {
-			$this->last_error      = $e->getMessage();
-			$this->last_error_code = $e->getErrorCode();
-		} catch ( Exception $e ) {
-			$this->last_error      = $e->getMessage();
-			$this->last_error_code = $e->getCode();
-		}
-
-		// Fired when we are done processing a submission.
-		do_action_ref_array( 'getpaid_process_submission', array( &$this ) );
-
-	}
-
-	/*
+     * The country for the submission.
+     *
+     * @var string
+     */
+    public $country = null;
+
+    /**
+     * The state for the submission.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $state = null;
+
+    /**
+     * The invoice associated with the submission.
+     *
+     * @var WPInv_Invoice
+     */
+    protected $invoice = null;
+
+    /**
+     * The recurring item for the submission.
+     *
+     * @var int
+     */
+    public $has_recurring = 0;
+
+    /**
+     * An array of fees for the submission.
+     *
+     * @var array
+     */
+    protected $fees = array();
+
+    /**
+     * An array of discounts for the submission.
+     *
+     * @var array
+     */
+    protected $discounts = array();
+
+    /**
+     * An array of taxes for the submission.
+     *
+     * @var array
+     */
+    protected $taxes = array();
+
+    /**
+     * An array of items for the submission.
+     *
+     * @var GetPaid_Form_Item[]
+     */
+    protected $items = array();
+
+    /**
+     * The last error.
+     *
+     * @var string
+     */
+    public $last_error = null;
+
+    /**
+     * The last error code.
+     *
+     * @var string
+     */
+    public $last_error_code = null;
+
+    /**
+     * Class constructor.
+     *
+     */
+    public function __construct() {
+
+        // Set the state and country to the default state and country.
+        $this->country = wpinv_default_billing_country();
+        $this->state   = wpinv_get_default_state();
+
+        // Do we have an actual submission?
+        if ( isset( $_POST['getpaid_payment_form_submission'] ) ) {
+            $this->load_data( wp_kses_post_deep( wp_unslash( $_POST ) ) );
+        }
+
+    }
+
+    /**
+     * Loads submission data.
+     *
+     * @param array $data
+     */
+    public function load_data( $data ) {
+
+        // Allow plugins to filter the data.
+        $data       = apply_filters( 'getpaid_submission_data', $data, $this );
+
+        // Cache it...
+        $this->data = $data;
+
+        // Then generate a unique id from the data.
+        $this->id   = md5( wp_json_encode( $data ) );
+
+        // Finally, process the submission.
+        try {
+
+            // Each process is passed an instance of the class (with reference)
+            // and should throw an Exception whenever it encounters one.
+            $processors = apply_filters(
+                'getpaid_payment_form_submission_processors',
+                array(
+                    array( $this, 'process_payment_form' ),
+                    array( $this, 'process_invoice' ),
+                    array( $this, 'process_fees' ),
+                    array( $this, 'process_items' ),
+                    array( $this, 'process_discount' ),
+                    array( $this, 'process_taxes' ),
+                ),
+                $this
+            );
+
+            foreach ( $processors as $processor ) {
+                call_user_func_array( $processor, array( &$this ) );
+            }
+        } catch ( GetPaid_Payment_Exception $e ) {
+            $this->last_error      = $e->getMessage();
+            $this->last_error_code = $e->getErrorCode();
+        } catch ( Exception $e ) {
+            $this->last_error      = $e->getMessage();
+            $this->last_error_code = $e->getCode();
+        }
+
+        // Fired when we are done processing a submission.
+        do_action_ref_array( 'getpaid_process_submission', array( &$this ) );
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Payment Forms.
 	|--------------------------------------------------------------------------
@@ -211,39 +211,39 @@ 
 	| submission has an active payment form etc.
     */
 
-	/**
-	 * Prepares the submission's payment form.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_payment_form() {
+    /**
+     * Prepares the submission's payment form.
+     *
+     * @since 1.0.19
+     */
+    public function process_payment_form() {
 
-		// Every submission needs an active payment form.
-		if ( empty( $this->data['form_id'] ) ) {
-			throw new Exception( __( 'Missing payment form', 'invoicing' ) );
-		}
+        // Every submission needs an active payment form.
+        if ( empty( $this->data['form_id'] ) ) {
+            throw new Exception( __( 'Missing payment form', 'invoicing' ) );
+        }
 
-		// Fetch the payment form.
-		$this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] );
+        // Fetch the payment form.
+        $this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] );
 
-		if ( ! $this->payment_form->is_active() ) {
-			throw new Exception( __( 'Payment form not active', 'invoicing' ) );
-		}
+        if ( ! $this->payment_form->is_active() ) {
+            throw new Exception( __( 'Payment form not active', 'invoicing' ) );
+        }
 
-		do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) );
-	}
+        do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) );
+    }
 
     /**
-	 * Returns the payment form.
-	 *
-	 * @since 1.0.19
-	 * @return GetPaid_Payment_Form
-	 */
-	public function get_payment_form() {
-		return $this->payment_form;
-	}
+     * Returns the payment form.
+     *
+     * @since 1.0.19
+     * @return GetPaid_Payment_Form
+     */
+    public function get_payment_form() {
+        return $this->payment_form;
+    }
 
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| Invoices.
 	|--------------------------------------------------------------------------
@@ -252,95 +252,95 @@ 
 	| might be for an existing invoice.
 	*/
 
-	/**
-	 * Prepares the submission's invoice.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_invoice() {
-
-		// Abort if there is no invoice.
-		if ( empty( $this->data['invoice_id'] ) ) {
-
-			// Check if we are resuming a payment.
-			if ( empty( $this->data['maybe_use_invoice'] ) ) {
-				return;
-			}
-
-			$invoice = wpinv_get_invoice( $this->data['maybe_use_invoice'] );
-			if ( empty( $invoice ) || ! $invoice->has_status( 'draft, auto-draft, wpi-pending' ) ) {
-				return;
-			}
-		}
-
-		// If the submission is for an existing invoice, ensure that it exists
-		// and that it is not paid for.
-		if ( empty( $invoice ) ) {
-			$invoice = wpinv_get_invoice( $this->data['invoice_id'] );
-		}
+    /**
+     * Prepares the submission's invoice.
+     *
+     * @since 1.0.19
+     */
+    public function process_invoice() {
+
+        // Abort if there is no invoice.
+        if ( empty( $this->data['invoice_id'] ) ) {
+
+            // Check if we are resuming a payment.
+            if ( empty( $this->data['maybe_use_invoice'] ) ) {
+                return;
+            }
+
+            $invoice = wpinv_get_invoice( $this->data['maybe_use_invoice'] );
+            if ( empty( $invoice ) || ! $invoice->has_status( 'draft, auto-draft, wpi-pending' ) ) {
+                return;
+            }
+        }
+
+        // If the submission is for an existing invoice, ensure that it exists
+        // and that it is not paid for.
+        if ( empty( $invoice ) ) {
+            $invoice = wpinv_get_invoice( $this->data['invoice_id'] );
+        }
 
         if ( empty( $invoice ) ) {
-			throw new Exception( __( 'Invalid invoice', 'invoicing' ) );
-		}
-
-		if ( $invoice->is_paid() ) {
-			throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) );
-		}
-
-		$this->payment_form->invoice = $invoice;
-		if ( ! $this->payment_form->is_default() ) {
-
-			$items    = array();
-			$item_ids = array();
-
-			foreach ( $invoice->get_items() as $item ) {
-				if ( ! in_array( $item->get_id(), $item_ids ) ) {
-					$item_ids[] = $item->get_id();
-					$items[]    = $item;
-				}
-			}
-
-			foreach ( $this->payment_form->get_items() as $item ) {
-				if ( ! in_array( $item->get_id(), $item_ids ) ) {
-					$item_ids[] = $item->get_id();
-					$items[]    = $item;
-				}
-			}
-
-			$this->payment_form->set_items( $items );
-
-		} else {
-			$this->payment_form->set_items( $invoice->get_items() );
-		}
-
-		$this->country = $invoice->get_country();
-		$this->state   = $invoice->get_state();
-		$this->invoice = $invoice;
-
-		do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) );
-	}
-
-	/**
-	 * Returns the associated invoice.
-	 *
-	 * @since 1.0.19
-	 * @return WPInv_Invoice
-	 */
-	public function get_invoice() {
-		return $this->invoice;
-	}
-
-	/**
-	 * Checks whether there is an invoice associated with this submission.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function has_invoice() {
-		return ! empty( $this->invoice );
-	}
-
-	/*
+            throw new Exception( __( 'Invalid invoice', 'invoicing' ) );
+        }
+
+        if ( $invoice->is_paid() ) {
+            throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) );
+        }
+
+        $this->payment_form->invoice = $invoice;
+        if ( ! $this->payment_form->is_default() ) {
+
+            $items    = array();
+            $item_ids = array();
+
+            foreach ( $invoice->get_items() as $item ) {
+                if ( ! in_array( $item->get_id(), $item_ids ) ) {
+                    $item_ids[] = $item->get_id();
+                    $items[]    = $item;
+                }
+            }
+
+            foreach ( $this->payment_form->get_items() as $item ) {
+                if ( ! in_array( $item->get_id(), $item_ids ) ) {
+                    $item_ids[] = $item->get_id();
+                    $items[]    = $item;
+                }
+            }
+
+            $this->payment_form->set_items( $items );
+
+        } else {
+            $this->payment_form->set_items( $invoice->get_items() );
+        }
+
+        $this->country = $invoice->get_country();
+        $this->state   = $invoice->get_state();
+        $this->invoice = $invoice;
+
+        do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) );
+    }
+
+    /**
+     * Returns the associated invoice.
+     *
+     * @since 1.0.19
+     * @return WPInv_Invoice
+     */
+    public function get_invoice() {
+        return $this->invoice;
+    }
+
+    /**
+     * Checks whether there is an invoice associated with this submission.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function has_invoice() {
+        return ! empty( $this->invoice );
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Items.
 	|--------------------------------------------------------------------------
@@ -349,129 +349,129 @@ 
 	| recurring item. But can have an unlimited number of non-recurring items.
 	*/
 
-	/**
-	 * Prepares the submission's items.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_items() {
-
-		$processor = new GetPaid_Payment_Form_Submission_Items( $this );
-
-		foreach ( $processor->items as $item ) {
-			$this->add_item( $item );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) );
-	}
-
-	/**
-	 * Adds an item to the submission.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Form_Item $item
-	 */
-	public function add_item( $item ) {
-
-		// Make sure that it is available for purchase.
-		if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) {
-			return;
-		}
-
-		// Each submission can only contain one recurring item.
-		if ( $item->is_recurring() ) {
-			$this->has_recurring = $item->get_id();
-		}
-
-		// Update the items and totals.
-		$this->items[ $item->get_id() ]         = $item;
-		$this->totals['subtotal']['initial']   += $item->get_sub_total();
-		$this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total();
-
-	}
-
-	/**
-	 * Removes a specific item.
-	 *
-	 * You should not call this method after the discounts and taxes
-	 * have been calculated.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_item( $item_id ) {
-
-		if ( isset( $this->items[ $item_id ] ) ) {
-			$this->totals['subtotal']['initial']   -= $this->items[ $item_id ]->get_sub_total();
-			$this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total();
-
-			if ( $this->items[ $item_id ]->is_recurring() ) {
-				$this->has_recurring = 0;
-			}
-
-			unset( $this->items[ $item_id ] );
-		}
-
-	}
-
-	/**
-	 * Returns the subtotal.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_subtotal() {
-
-		if ( wpinv_prices_include_tax() ) {
-			return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial'];
-		}
-
-		return $this->totals['subtotal']['initial'];
-	}
-
-	/**
-	 * Returns the recurring subtotal.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_subtotal() {
-
-		if ( wpinv_prices_include_tax() ) {
-			return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring'];
-		}
-
-		return $this->totals['subtotal']['recurring'];
-	}
-
-	/**
-	 * Returns all items.
-	 *
-	 * @since 1.0.19
-	 * @return GetPaid_Form_Item[]
-	 */
-	public function get_items() {
-		return $this->items;
-	}
-
-	/**
-	 * Checks if there's a single subscription group in the submission.
-	 *
-	 * @since 2.3.0
-	 * @return bool
-	 */
-	public function has_subscription_group() {
-		return $this->has_recurring && getpaid_should_group_subscriptions( $this ) && 1 == count( getpaid_get_subscription_groups( $this ) );
-	}
-
-	/**
-	 * Checks if there are multipe subscription groups in the submission.
-	 *
-	 * @since 2.3.0
-	 * @return bool
-	 */
-	public function has_multiple_subscription_groups() {
-		return $this->has_recurring && 1 < count( getpaid_get_subscription_groups( $this ) );
-	}
-
-	/*
+    /**
+     * Prepares the submission's items.
+     *
+     * @since 1.0.19
+     */
+    public function process_items() {
+
+        $processor = new GetPaid_Payment_Form_Submission_Items( $this );
+
+        foreach ( $processor->items as $item ) {
+            $this->add_item( $item );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) );
+    }
+
+    /**
+     * Adds an item to the submission.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Form_Item $item
+     */
+    public function add_item( $item ) {
+
+        // Make sure that it is available for purchase.
+        if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) {
+            return;
+        }
+
+        // Each submission can only contain one recurring item.
+        if ( $item->is_recurring() ) {
+            $this->has_recurring = $item->get_id();
+        }
+
+        // Update the items and totals.
+        $this->items[ $item->get_id() ]         = $item;
+        $this->totals['subtotal']['initial']   += $item->get_sub_total();
+        $this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total();
+
+    }
+
+    /**
+     * Removes a specific item.
+     *
+     * You should not call this method after the discounts and taxes
+     * have been calculated.
+     *
+     * @since 1.0.19
+     */
+    public function remove_item( $item_id ) {
+
+        if ( isset( $this->items[ $item_id ] ) ) {
+            $this->totals['subtotal']['initial']   -= $this->items[ $item_id ]->get_sub_total();
+            $this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total();
+
+            if ( $this->items[ $item_id ]->is_recurring() ) {
+                $this->has_recurring = 0;
+            }
+
+            unset( $this->items[ $item_id ] );
+        }
+
+    }
+
+    /**
+     * Returns the subtotal.
+     *
+     * @since 1.0.19
+     */
+    public function get_subtotal() {
+
+        if ( wpinv_prices_include_tax() ) {
+            return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial'];
+        }
+
+        return $this->totals['subtotal']['initial'];
+    }
+
+    /**
+     * Returns the recurring subtotal.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_subtotal() {
+
+        if ( wpinv_prices_include_tax() ) {
+            return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring'];
+        }
+
+        return $this->totals['subtotal']['recurring'];
+    }
+
+    /**
+     * Returns all items.
+     *
+     * @since 1.0.19
+     * @return GetPaid_Form_Item[]
+     */
+    public function get_items() {
+        return $this->items;
+    }
+
+    /**
+     * Checks if there's a single subscription group in the submission.
+     *
+     * @since 2.3.0
+     * @return bool
+     */
+    public function has_subscription_group() {
+        return $this->has_recurring && getpaid_should_group_subscriptions( $this ) && 1 == count( getpaid_get_subscription_groups( $this ) );
+    }
+
+    /**
+     * Checks if there are multipe subscription groups in the submission.
+     *
+     * @since 2.3.0
+     * @return bool
+     */
+    public function has_multiple_subscription_groups() {
+        return $this->has_recurring && 1 < count( getpaid_get_subscription_groups( $this ) );
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Taxes
 	|--------------------------------------------------------------------------
@@ -480,128 +480,128 @@ 
 	| or only one-time.
     */
 
-	/**
-	 * Prepares the submission's taxes.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_taxes() {
-
-		// Abort if we're not using taxes.
-		if ( ! $this->use_taxes() ) {
-			return;
-		}
-
-		// If a custom country && state has been passed in, use it to calculate taxes.
-		$country = $this->get_field( 'wpinv_country', 'billing' );
-		if ( ! empty( $country ) ) {
-			$this->country = $country;
-		}
-
-		$state = $this->get_field( 'wpinv_state', 'billing' );
-		if ( ! empty( $state ) ) {
-			$this->state = $state;
-		}
-
-		// Confirm if the provided country and the ip country are similar.
-		$address_confirmed = $this->get_field( 'confirm-address' );
-		if ( isset( $_POST['billing']['country'] ) && wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) {
-			throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) );
-		}
-
-		// Abort if the country is not taxable.
-		if ( ! wpinv_is_country_taxable( $this->country ) ) {
-			return;
-		}
-
-		$processor = new GetPaid_Payment_Form_Submission_Taxes( $this );
-
-		foreach ( $processor->taxes as $tax ) {
-			$this->add_tax( $tax );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) );
-	}
-
-	/**
-	 * Adds a tax to the submission.
-	 *
-	 * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required.
-	 * @since 1.0.19
-	 */
-	public function add_tax( $tax ) {
-
-		if ( wpinv_round_tax_per_tax_rate() ) {
-			$tax['initial_tax']   = wpinv_round_amount( $tax['initial_tax'] );
-			$tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] );
-		}
-
-		$this->taxes[ $tax['name'] ]         = $tax;
-		$this->totals['taxes']['initial']   += wpinv_sanitize_amount( $tax['initial_tax'] );
-		$this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] );
-
-	}
-
-	/**
-	 * Removes a specific tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_tax( $tax_name ) {
-
-		if ( isset( $this->taxes[ $tax_name ] ) ) {
-			$this->totals['taxes']['initial']   -= $this->taxes[ $tax_name ]['initial_tax'];
-			$this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax'];
-			unset( $this->taxes[ $tax_name ] );
-		}
-
-	}
-
-	/**
-	 * Whether or not we'll use taxes for the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function use_taxes() {
-
-		$use_taxes = wpinv_use_taxes();
-
-		if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) {
-			$use_taxes = false;
-		}
-
-		return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this );
-
-	}
-
-	/**
-	 * Returns the tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_tax() {
-		return $this->totals['taxes']['initial'];
-	}
-
-	/**
-	 * Returns the recurring tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_tax() {
-		return $this->totals['taxes']['recurring'];
-	}
-
-	/**
-	 * Returns all taxes.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_taxes() {
-		return $this->taxes;
-	}
-
-	/*
+    /**
+     * Prepares the submission's taxes.
+     *
+     * @since 1.0.19
+     */
+    public function process_taxes() {
+
+        // Abort if we're not using taxes.
+        if ( ! $this->use_taxes() ) {
+            return;
+        }
+
+        // If a custom country && state has been passed in, use it to calculate taxes.
+        $country = $this->get_field( 'wpinv_country', 'billing' );
+        if ( ! empty( $country ) ) {
+            $this->country = $country;
+        }
+
+        $state = $this->get_field( 'wpinv_state', 'billing' );
+        if ( ! empty( $state ) ) {
+            $this->state = $state;
+        }
+
+        // Confirm if the provided country and the ip country are similar.
+        $address_confirmed = $this->get_field( 'confirm-address' );
+        if ( isset( $_POST['billing']['country'] ) && wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) {
+            throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) );
+        }
+
+        // Abort if the country is not taxable.
+        if ( ! wpinv_is_country_taxable( $this->country ) ) {
+            return;
+        }
+
+        $processor = new GetPaid_Payment_Form_Submission_Taxes( $this );
+
+        foreach ( $processor->taxes as $tax ) {
+            $this->add_tax( $tax );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) );
+    }
+
+    /**
+     * Adds a tax to the submission.
+     *
+     * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required.
+     * @since 1.0.19
+     */
+    public function add_tax( $tax ) {
+
+        if ( wpinv_round_tax_per_tax_rate() ) {
+            $tax['initial_tax']   = wpinv_round_amount( $tax['initial_tax'] );
+            $tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] );
+        }
+
+        $this->taxes[ $tax['name'] ]         = $tax;
+        $this->totals['taxes']['initial']   += wpinv_sanitize_amount( $tax['initial_tax'] );
+        $this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] );
+
+    }
+
+    /**
+     * Removes a specific tax.
+     *
+     * @since 1.0.19
+     */
+    public function remove_tax( $tax_name ) {
+
+        if ( isset( $this->taxes[ $tax_name ] ) ) {
+            $this->totals['taxes']['initial']   -= $this->taxes[ $tax_name ]['initial_tax'];
+            $this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax'];
+            unset( $this->taxes[ $tax_name ] );
+        }
+
+    }
+
+    /**
+     * Whether or not we'll use taxes for the submission.
+     *
+     * @since 1.0.19
+     */
+    public function use_taxes() {
+
+        $use_taxes = wpinv_use_taxes();
+
+        if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) {
+            $use_taxes = false;
+        }
+
+        return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this );
+
+    }
+
+    /**
+     * Returns the tax.
+     *
+     * @since 1.0.19
+     */
+    public function get_tax() {
+        return $this->totals['taxes']['initial'];
+    }
+
+    /**
+     * Returns the recurring tax.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_tax() {
+        return $this->totals['taxes']['recurring'];
+    }
+
+    /**
+     * Returns all taxes.
+     *
+     * @since 1.0.19
+     */
+    public function get_taxes() {
+        return $this->taxes;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Discounts
 	|--------------------------------------------------------------------------
@@ -610,99 +610,99 @@ 
 	| or only one-time. They also do not have to come from a discount code.
     */
 
-	/**
-	 * Prepares the submission's discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_discount() {
-
-		$initial_total    = $this->get_subtotal() + $this->get_fee() + $this->get_tax();
-		$recurring_total  = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax();
-		$processor        = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total );
-
-		foreach ( $processor->discounts as $discount ) {
-			$this->add_discount( $discount );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) );
-	}
-
-	/**
-	 * Adds a discount to the submission.
-	 *
-	 * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code.
-	 * @since 1.0.19
-	 */
-	public function add_discount( $discount ) {
-		$this->discounts[ $discount['name'] ]   = $discount;
-		$this->totals['discount']['initial']   += wpinv_sanitize_amount( $discount['initial_discount'] );
-		$this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] );
-	}
-
-	/**
-	 * Removes a discount from the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_discount( $name ) {
-
-		if ( isset( $this->discounts[ $name ] ) ) {
-			$this->totals['discount']['initial']   -= $this->discounts[ $name ]['initial_discount'];
-			$this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount'];
-			unset( $this->discounts[ $name ] );
-		}
-
-	}
-
-	/**
-	 * Checks whether there is a discount code associated with this submission.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function has_discount_code() {
-		return ! empty( $this->discounts['discount_code'] );
-	}
-
-	/**
-	 * Returns the discount code.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_discount_code() {
-		return $this->has_discount_code() ? $this->discounts['discount_code']['discount_code'] : '';
-	}
-
-	/**
-	 * Returns the discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_discount() {
-		return $this->totals['discount']['initial'];
-	}
-
-	/**
-	 * Returns the recurring discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_discount() {
-		return $this->totals['discount']['recurring'];
-	}
-
-	/**
-	 * Returns all discounts.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_discounts() {
-		return $this->discounts;
-	}
-
-	/*
+    /**
+     * Prepares the submission's discount.
+     *
+     * @since 1.0.19
+     */
+    public function process_discount() {
+
+        $initial_total    = $this->get_subtotal() + $this->get_fee() + $this->get_tax();
+        $recurring_total  = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax();
+        $processor        = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total );
+
+        foreach ( $processor->discounts as $discount ) {
+            $this->add_discount( $discount );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) );
+    }
+
+    /**
+     * Adds a discount to the submission.
+     *
+     * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code.
+     * @since 1.0.19
+     */
+    public function add_discount( $discount ) {
+        $this->discounts[ $discount['name'] ]   = $discount;
+        $this->totals['discount']['initial']   += wpinv_sanitize_amount( $discount['initial_discount'] );
+        $this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] );
+    }
+
+    /**
+     * Removes a discount from the submission.
+     *
+     * @since 1.0.19
+     */
+    public function remove_discount( $name ) {
+
+        if ( isset( $this->discounts[ $name ] ) ) {
+            $this->totals['discount']['initial']   -= $this->discounts[ $name ]['initial_discount'];
+            $this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount'];
+            unset( $this->discounts[ $name ] );
+        }
+
+    }
+
+    /**
+     * Checks whether there is a discount code associated with this submission.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function has_discount_code() {
+        return ! empty( $this->discounts['discount_code'] );
+    }
+
+    /**
+     * Returns the discount code.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_discount_code() {
+        return $this->has_discount_code() ? $this->discounts['discount_code']['discount_code'] : '';
+    }
+
+    /**
+     * Returns the discount.
+     *
+     * @since 1.0.19
+     */
+    public function get_discount() {
+        return $this->totals['discount']['initial'];
+    }
+
+    /**
+     * Returns the recurring discount.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_discount() {
+        return $this->totals['discount']['recurring'];
+    }
+
+    /**
+     * Returns all discounts.
+     *
+     * @since 1.0.19
+     */
+    public function get_discounts() {
+        return $this->discounts;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Fees
 	|--------------------------------------------------------------------------
@@ -712,100 +712,100 @@ 
 	| fees.
     */
 
-	/**
-	 * Prepares the submission's fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_fees() {
-
-		$fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this );
-
-		foreach ( $fees_processor->fees as $fee ) {
-			$this->add_fee( $fee );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) );
-	}
-
-	/**
-	 * Adds a fee to the submission.
-	 *
-	 * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required.
-	 * @since 1.0.19
-	 */
-	public function add_fee( $fee ) {
-
-		if ( $fee['name'] == 'shipping' ) {
-			$this->totals['shipping']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
-			$this->totals['shipping']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
-			return;
-		}
-
-		$this->fees[ $fee['name'] ]         = $fee;
-		$this->totals['fees']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
-		$this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
-
-	}
-
-	/**
-	 * Removes a fee from the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_fee( $name ) {
-
-		if ( isset( $this->fees[ $name ] ) ) {
-			$this->totals['fees']['initial']   -= $this->fees[ $name ]['initial_fee'];
-			$this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee'];
-			unset( $this->fees[ $name ] );
-		}
-
-		if ( 'shipping' == $name ) {
-			$this->totals['shipping']['initial']   = 0;
-			$this->totals['shipping']['recurring'] = 0;
-		}
-
-	}
-
-	/**
-	 * Returns the fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_fee() {
-		return $this->totals['fees']['initial'];
-	}
-
-	/**
-	 * Returns the recurring fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_fee() {
-		return $this->totals['fees']['recurring'];
-	}
-
-	/**
-	 * Returns all fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_fees() {
-		return $this->fees;
-	}
-
-	/**
-	 * Checks if there are any fees for the form.
-	 *
-	 * @return bool
-	 * @since 1.0.19
-	 */
-	public function has_fees() {
-		return count( $this->fees ) !== 0;
-	}
-
-	/*
+    /**
+     * Prepares the submission's fees.
+     *
+     * @since 1.0.19
+     */
+    public function process_fees() {
+
+        $fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this );
+
+        foreach ( $fees_processor->fees as $fee ) {
+            $this->add_fee( $fee );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) );
+    }
+
+    /**
+     * Adds a fee to the submission.
+     *
+     * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required.
+     * @since 1.0.19
+     */
+    public function add_fee( $fee ) {
+
+        if ( $fee['name'] == 'shipping' ) {
+            $this->totals['shipping']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
+            $this->totals['shipping']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
+            return;
+        }
+
+        $this->fees[ $fee['name'] ]         = $fee;
+        $this->totals['fees']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
+        $this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
+
+    }
+
+    /**
+     * Removes a fee from the submission.
+     *
+     * @since 1.0.19
+     */
+    public function remove_fee( $name ) {
+
+        if ( isset( $this->fees[ $name ] ) ) {
+            $this->totals['fees']['initial']   -= $this->fees[ $name ]['initial_fee'];
+            $this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee'];
+            unset( $this->fees[ $name ] );
+        }
+
+        if ( 'shipping' == $name ) {
+            $this->totals['shipping']['initial']   = 0;
+            $this->totals['shipping']['recurring'] = 0;
+        }
+
+    }
+
+    /**
+     * Returns the fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_fee() {
+        return $this->totals['fees']['initial'];
+    }
+
+    /**
+     * Returns the recurring fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_fee() {
+        return $this->totals['fees']['recurring'];
+    }
+
+    /**
+     * Returns all fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_fees() {
+        return $this->fees;
+    }
+
+    /**
+     * Checks if there are any fees for the form.
+     *
+     * @return bool
+     * @since 1.0.19
+     */
+    public function has_fees() {
+        return count( $this->fees ) !== 0;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| MISC
 	|--------------------------------------------------------------------------
@@ -813,147 +813,147 @@ 
 	| Extra submission functions.
     */
 
-	/**
-	 * Returns the shipping amount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_shipping() {
-		return $this->totals['shipping']['initial'];
-	}
-
-	/**
-	 * Returns the recurring shipping.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_shipping() {
-		return $this->totals['shipping']['recurring'];
-	}
-
-	/**
-	 * Checks if there are any shipping fees for the form.
-	 *
-	 * @return bool
-	 * @since 1.0.19
-	 */
-	public function has_shipping() {
-		return apply_filters( 'getpaid_payment_form_has_shipping', false, $this );
-	}
-
-	/**
-	 * Checks if this is the initial fetch.
-	 *
-	 * @return bool
-	 * @since 1.0.19
-	 */
-	public function is_initial_fetch() {
-		return isset( $this->data['initial_state'] ) && empty( $this->data['initial_state'] );
-	}
-
-	/**
-	 * Returns the total amount to collect for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_total() {
-		$total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() + $this->get_shipping() - $this->get_discount();
-		return max( $total, 0 );
-	}
-
-	/**
-	 * Returns the recurring total amount to collect for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_total() {
-		$total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() + $this->get_recurring_shipping() - $this->get_recurring_discount();
-		return max( $total, 0 );
-	}
-
-	/**
-	 * Whether payment details should be collected for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function should_collect_payment_details() {
-		$initial   = $this->get_total();
-		$recurring = $this->get_recurring_total();
-
-		if ( $this->has_recurring == 0 ) {
-			$recurring = 0;
-		}
-
-		$collect = $initial > 0 || $recurring > 0;
-		return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this );
-	}
-
-	/**
-	 * Returns the billing email of the user.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_billing_email() {
-		return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this );
-	}
-
-	/**
-	 * Checks if the submitter has a billing email.
-	 *
-	 * @since 1.0.19
-	 */
-	public function has_billing_email() {
-		$billing_email = $this->get_billing_email();
-		return ! empty( $billing_email ) && is_email( $billing_email );
-	}
-
-	/**
-	 * Returns the appropriate currency for the submission.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_currency() {
-		return $this->has_invoice() ? $this->invoice->get_currency() : wpinv_get_currency();
-    }
-
-    /**
-	 * Returns the raw submission data.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_data() {
-		return $this->data;
-	}
-
-	/**
-	 * Returns a field from the submission data
-	 *
-	 * @param string $field
-	 * @since 1.0.19
-	 * @return mixed|null
-	 */
-	public function get_field( $field, $sub_array_key = null ) {
-		return getpaid_get_array_field( $this->data, $field, $sub_array_key );
-	}
-
-	/**
-	 * Checks if a required field is set.
-	 *
-	 * @since 1.0.19
-	 */
-	public function is_required_field_set( $field ) {
-		return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] );
-	}
-
-	/**
-	 * Formats an amount
-	 *
-	 * @since 1.0.19
-	 */
-	public function format_amount( $amount ) {
-		return wpinv_price( $amount, $this->get_currency() );
-	}
+    /**
+     * Returns the shipping amount.
+     *
+     * @since 1.0.19
+     */
+    public function get_shipping() {
+        return $this->totals['shipping']['initial'];
+    }
+
+    /**
+     * Returns the recurring shipping.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_shipping() {
+        return $this->totals['shipping']['recurring'];
+    }
+
+    /**
+     * Checks if there are any shipping fees for the form.
+     *
+     * @return bool
+     * @since 1.0.19
+     */
+    public function has_shipping() {
+        return apply_filters( 'getpaid_payment_form_has_shipping', false, $this );
+    }
+
+    /**
+     * Checks if this is the initial fetch.
+     *
+     * @return bool
+     * @since 1.0.19
+     */
+    public function is_initial_fetch() {
+        return isset( $this->data['initial_state'] ) && empty( $this->data['initial_state'] );
+    }
+
+    /**
+     * Returns the total amount to collect for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function get_total() {
+        $total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() + $this->get_shipping() - $this->get_discount();
+        return max( $total, 0 );
+    }
+
+    /**
+     * Returns the recurring total amount to collect for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_total() {
+        $total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() + $this->get_recurring_shipping() - $this->get_recurring_discount();
+        return max( $total, 0 );
+    }
+
+    /**
+     * Whether payment details should be collected for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function should_collect_payment_details() {
+        $initial   = $this->get_total();
+        $recurring = $this->get_recurring_total();
+
+        if ( $this->has_recurring == 0 ) {
+            $recurring = 0;
+        }
+
+        $collect = $initial > 0 || $recurring > 0;
+        return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this );
+    }
+
+    /**
+     * Returns the billing email of the user.
+     *
+     * @since 1.0.19
+     */
+    public function get_billing_email() {
+        return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this );
+    }
+
+    /**
+     * Checks if the submitter has a billing email.
+     *
+     * @since 1.0.19
+     */
+    public function has_billing_email() {
+        $billing_email = $this->get_billing_email();
+        return ! empty( $billing_email ) && is_email( $billing_email );
+    }
+
+    /**
+     * Returns the appropriate currency for the submission.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_currency() {
+        return $this->has_invoice() ? $this->invoice->get_currency() : wpinv_get_currency();
+    }
+
+    /**
+     * Returns the raw submission data.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_data() {
+        return $this->data;
+    }
+
+    /**
+     * Returns a field from the submission data
+     *
+     * @param string $field
+     * @since 1.0.19
+     * @return mixed|null
+     */
+    public function get_field( $field, $sub_array_key = null ) {
+        return getpaid_get_array_field( $this->data, $field, $sub_array_key );
+    }
+
+    /**
+     * Checks if a required field is set.
+     *
+     * @since 1.0.19
+     */
+    public function is_required_field_set( $field ) {
+        return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] );
+    }
+
+    /**
+     * Formats an amount
+     *
+     * @since 1.0.19
+     */
+    public function format_amount( $amount ) {
+        return wpinv_price( $amount, $this->get_currency() );
+    }
 
 }

templates/invoice/line-totals.php

Indentation +5 added lines, -5 removed lines

@@ -52,27 +52,27 @@
 
                                 // Total Fee.
                                 if ( 'fee' === $key ) {
-								wpinv_the_price( $invoice->get_total_fees(), $invoice->get_currency() );
+                                wpinv_the_price( $invoice->get_total_fees(), $invoice->get_currency() );
                                 }
 
                                 // Total discount.
                                 if ( 'discount' === $key ) {
-								wpinv_the_price( $invoice->get_total_discount(), $invoice->get_currency() );
+                                wpinv_the_price( $invoice->get_total_discount(), $invoice->get_currency() );
                                 }
 
                                 // Shipping.
                                 if ( 'shipping' === $key ) {
-								wpinv_the_price( $invoice->get_shipping(), $invoice->get_currency() );
+                                wpinv_the_price( $invoice->get_shipping(), $invoice->get_currency() );
                                 }
 
                                 // Sub total.
                                 if ( 'subtotal' === $key ) {
-								wpinv_the_price( $invoice->get_subtotal(), $invoice->get_currency() );
+                                wpinv_the_price( $invoice->get_subtotal(), $invoice->get_currency() );
                                 }
 
                                 // Total.
                                 if ( 'total' === $key ) {
-								wpinv_the_price( $invoice->get_total(), $invoice->get_currency() );
+                                wpinv_the_price( $invoice->get_total(), $invoice->get_currency() );
                                 }
 
                                 // Fires when printing a cart total.

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

Indentation +679 added lines, -679 removed lines

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

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

Indentation +492 added lines, -492 removed lines

@@ -16,496 +16,496 @@
  */
 class GetPaid_REST_Date_Based_Controller extends GetPaid_REST_Controller {
 
-	/**
-	 * Group response items by day or month.
-	 *
-	 * @var string
-	 */
-	public $groupby = 'day';
-
-	/**
-	 * Returns an array with arguments to request the previous report.
-	 *
-	 * @var array
-	 */
-	public $previous_range = array();
-
-	/**
-	 * The period interval.
-	 *
-	 * @var int
-	 */
-	public $interval;
-
-	/**
-	 * Retrieves the before and after dates.
-	 *
-	 * @param WP_REST_Request $request Request object.
-	 * @return array The appropriate date range.
-	 */
-	public function get_date_range( $request ) {
-
-		// Check if the period is x_days.
-		if ( preg_match( '/^(\d+)_days$/', $request['period'], $matches ) ) {
-			$date_range = $this->get_x_days_date_range( absint( $matches[1] ) );
-		} elseif ( is_callable( array( $this, 'get_' . $request['period'] . '_date_range' ) ) ) {
-			$date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request );
-		} else {
-			$request['period'] = '7_days';
-			$date_range        = $this->get_x_days_date_range();
-		}
-
-		// 3 months max for day view.
-		$before = strtotime( $date_range['before'] );
-		$after  = strtotime( $date_range['after'] );
-		if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 2 ) {
-			$this->groupby = 'month';
-		}
-
-		$this->prepare_interval( $date_range );
-
-		return $date_range;
-
-	}
-
-	/**
-	 * Groups by month or days.
-	 *
-	 * @param array $range Date range.
-	 * @return array The appropriate date range.
-	 */
-	public function prepare_interval( $range ) {
-
-		$before = strtotime( $range['before'] );
-		$after  = strtotime( $range['after'] );
-		if ( 'day' === $this->groupby ) {
-			$difference     = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0;
-			$this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) );
-			return;
-		}
-
-		$this->interval = 0;
-		$min_date       = strtotime( gmdate( 'Y-m-01', $after ) );
-
-		while ( $min_date <= $before ) {
-			$this->interval ++;
-			$min_date = strtotime( '+1 MONTH', $min_date );
-		}
-
-		$this->interval = max( 1, $this->interval );
-
-	}
-
-	/**
-	 * Retrieves a custom date range.
-	 *
-	 * @param WP_REST_Request $request Request object.
-	 * @return array The appropriate date range.
-	 */
-	public function get_custom_date_range( $request ) {
-
-		$after  = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) );
-		$before = gmdate( 'Y-m-d' );
-
-		if ( ! empty( $request['before'] ) ) {
-			$before  = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) );
-		}
-
-		// Set the previous date range.
-		$difference           = $before - $after;
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => gmdate( 'Y-m-d', $before - $difference - DAY_IN_SECONDS ),
-			'after'  => gmdate( 'Y-m-d', $after - $difference - DAY_IN_SECONDS ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => gmdate( 'Y-m-d', $before ),
-			'after'  => gmdate( 'Y-m-d', $after ),
-		);
-
-	}
-
-	/**
-	 * Retrieves todays date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_today_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'yesterday',
-		);
-
-		// Generate the report.
-		return array(
-			'before' => gmdate( 'Y-m-d' ),
-			'after'  => gmdate( 'Y-m-d' ),
-		);
-
-	}
-
-	/**
-	 * Retrieves yesterdays date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_yesterday_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ),
-			'after'  => gmdate( 'Y-m-d', strtotime( '-2 days' ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ),
-			'after'  => gmdate( 'Y-m-d', strtotime( '-1 day' ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves this week's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_week_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_week',
-		);
-
-		// Generate the report.
-		$week_starts = absint( get_option( 'start_of_week' ) );
-		return array(
-			'before' => gmdate( 'Y-m-d' ),
-			'after'  => gmdate( 'Y-m-d', strtotime( 'next Sunday -' . ( 7 - $week_starts ) . ' days' ) ),
-		);
-	}
-
-	/**
-	 * Retrieves last week's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_week_date_range() {
-
-		$week_starts = absint( get_option( 'start_of_week' ) );
-		$week_starts = strtotime( 'last Sunday -' . ( 7 - $week_starts ) . ' days' );
-		$date_range  = array(
-			'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ),
-			'after'  => gmdate( 'Y-m-d', $week_starts ),
-		);
-
-		// Set the previous date range.
-		$week_starts          = $week_starts - 7 * DAY_IN_SECONDS;
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ),
-			'after'  => gmdate( 'Y-m-d', $week_starts ),
-		);
-
-		// Generate the report.
-		return $date_range;
-	}
-
-	/**
-	 * Retrieves last x days date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_x_days_date_range( $days = 7 ) {
-
-		$days--;
-
-		$date_range  = array(
-			'before' => gmdate( 'Y-m-d' ),
-			'after'  => gmdate( 'Y-m-d', strtotime( "-$days days" ) ),
-		);
-
-		$days++;
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => gmdate( 'Y-m-d', strtotime( $date_range['before'] ) - $days * DAY_IN_SECONDS ),
-			'after'  => gmdate( 'Y-m-d', strtotime( $date_range['after'] ) - $days * DAY_IN_SECONDS ),
-		);
-
-		// Generate the report.
-		return $date_range;
-	}
-
-	/**
-	 * Retrieves this month date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_month_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_month',
-		);
-
-		// Generate the report.
-		return array(
-			'after'  => gmdate( 'Y-m-01' ),
-			'before' => gmdate( 'Y-m-t' ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last month's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_month_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'after'  => gmdate( 'Y-m-01', strtotime( '-2 months' ) ),
-			'before' => gmdate( 'Y-m-t', strtotime( '-2 months' ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'after'  => gmdate( 'Y-m-01', strtotime( 'last month' ) ),
-			'before' => gmdate( 'Y-m-t', strtotime( 'last month' ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves this quarter date range.
-	 *
-	 * @return array The available quarters.
-	 */
-	public function get_quarters() {
-
-		$year      = (int) gmdate( 'Y' );
-		$last_year = (int) $year - 1;
-		return array(
-
-			// Third quarter of previous year: July 1st to September 30th
-			array(
-				'before' => "{$last_year}-09-30",
-				'after'  => "{$last_year}-07-01",
-			),
-
-			// Last quarter of previous year: October 1st to December 31st
-			array(
-				'before' => "{$last_year}-12-31",
-        		'after'  => "{$last_year}-10-01",
-			),
-
-			// First quarter: January 1st to March 31st
-			array(
-				'before' => "{$year}-03-31",
-				'after'  => "{$year}-01-01",
-			),
-
-			// Second quarter: April 1st to June 30th
-			array(
-				'before' => "{$year}-06-30",
-				'after'  => "{$year}-04-01",
-			),
-
-			// Third quarter: July 1st to September 30th
-			array(
-				'before' => "{$year}-09-30",
-				'after'  => "{$year}-07-01",
-			),
-
-			// Fourth quarter: October 1st to December 31st
-			array(
-				'before' => "{$year}-12-31",
-				'after'  => "{$year}-10-01",
-			),
-		);
-	}
-
-	/**
-	 * Retrieves the current quater.
-	 *
-	 * @return int The current quarter.
-	 */
-	public function get_quarter() {
-
-		$month    = (int) gmdate( 'n' );
-		$quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 );
-		return $quarters[ $month - 1 ];
-
-	}
-
-	/**
-	 * Retrieves this quarter date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_quarter_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_quarter',
-		);
-
-		// Generate the report.
-		$quarter  = $this->get_quarter();
-		$quarters = $this->get_quarters();
-		return $quarters[ $quarter + 1 ];
-
-	}
-
-	/**
-	 * Retrieves last quarter's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_quarter_date_range() {
-
-		$quarters = $this->get_quarters();
-		$quarter  = $this->get_quarter();
-
-		// Set the previous date range.
-		$this->previous_range = array_merge(
-			$quarters[ $quarter - 1 ],
-			array( 'period' => 'custom' )
-		);
-
-		// Generate the report.
-		return $quarters[ $quarter ];
-
-	}
-
-	/**
-	 * Retrieves this year date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_year_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_year',
-		);
-
-		// Generate the report.
-		return array(
-			'after'  => gmdate( 'Y-01-01' ),
-			'before' => gmdate( 'Y-12-31' ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last year date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_year_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'after'  => gmdate( 'Y-01-01', strtotime( '-2 years' ) ),
-			'before' => gmdate( 'Y-12-31', strtotime( '-2 years' ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'after'  => gmdate( 'Y-01-01', strtotime( 'last year' ) ),
-			'before' => gmdate( 'Y-12-31', strtotime( 'last year' ) ),
-		);
-
-	}
-
-	/**
-	 * Prepare a the request date for SQL usage.
-	 *
-	 * @param WP_REST_Request $request Request object.
-	 * @param string $date_field The date field.
-	 * @return string The appropriate SQL.
-	 */
-	public function get_date_range_sql( $request, $date_field ) {
-		global $wpdb;
-
-		$sql = '1=1';
-		$range = $this->get_date_range( $request );
-
-		if ( ! empty( $range['after'] ) ) {
-			$sql .= ' AND ' . $wpdb->prepare(
-				"$date_field >= %s",
-				$range['after']
-			);
-		}
-
-		if ( ! empty( $range['before'] ) ) {
-			$sql .= ' AND ' . $wpdb->prepare(
-				"$date_field <= %s",
-				$range['before']
-			);
-		}
-
-		return $sql;
-
-	}
-
-	/**
-	 * Prepares a group by query.
-	 *
-	 * @param string $date_field The date field.
-	 * @return string The appropriate SQL.
-	 */
-	public function get_group_by_sql( $date_field ) {
-
-		if ( 'day' === $this->groupby ) {
-			return "YEAR($date_field), MONTH($date_field), DAY($date_field)";
-		}
-
-		return "YEAR($date_field), MONTH($date_field)";
-	}
-
-	/**
-	 * Get the query params for collections.
-	 *
-	 * @return array
-	 */
-	public function get_collection_params() {
-		return array(
-			'context' => $this->get_context_param( array( 'default' => 'view' ) ),
-			'period'  => array(
-				'description'       => __( 'Limit to results of a specific period.', 'invoicing' ),
-				'type'              => 'string',
-				'enum'              => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ),
-				'validate_callback' => 'rest_validate_request_arg',
-				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => '7_days',
-			),
-			'after'   => array(
-				/* translators: %s: date format */
-				'description'       => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
-				'type'              => 'string',
-				'validate_callback' => 'rest_validate_request_arg',
-				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => gmdate( 'Y-m-d', strtotime( '-7 days' ) ),
-			),
-			'before'  => array(
-				/* translators: %s: date format */
-				'description'       => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
-				'type'              => 'string',
-				'validate_callback' => 'rest_validate_request_arg',
-				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => gmdate( 'Y-m-d' ),
-			),
-		);
-	}
+    /**
+     * Group response items by day or month.
+     *
+     * @var string
+     */
+    public $groupby = 'day';
+
+    /**
+     * Returns an array with arguments to request the previous report.
+     *
+     * @var array
+     */
+    public $previous_range = array();
+
+    /**
+     * The period interval.
+     *
+     * @var int
+     */
+    public $interval;
+
+    /**
+     * Retrieves the before and after dates.
+     *
+     * @param WP_REST_Request $request Request object.
+     * @return array The appropriate date range.
+     */
+    public function get_date_range( $request ) {
+
+        // Check if the period is x_days.
+        if ( preg_match( '/^(\d+)_days$/', $request['period'], $matches ) ) {
+            $date_range = $this->get_x_days_date_range( absint( $matches[1] ) );
+        } elseif ( is_callable( array( $this, 'get_' . $request['period'] . '_date_range' ) ) ) {
+            $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request );
+        } else {
+            $request['period'] = '7_days';
+            $date_range        = $this->get_x_days_date_range();
+        }
+
+        // 3 months max for day view.
+        $before = strtotime( $date_range['before'] );
+        $after  = strtotime( $date_range['after'] );
+        if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 2 ) {
+            $this->groupby = 'month';
+        }
+
+        $this->prepare_interval( $date_range );
+
+        return $date_range;
+
+    }
+
+    /**
+     * Groups by month or days.
+     *
+     * @param array $range Date range.
+     * @return array The appropriate date range.
+     */
+    public function prepare_interval( $range ) {
+
+        $before = strtotime( $range['before'] );
+        $after  = strtotime( $range['after'] );
+        if ( 'day' === $this->groupby ) {
+            $difference     = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0;
+            $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) );
+            return;
+        }
+
+        $this->interval = 0;
+        $min_date       = strtotime( gmdate( 'Y-m-01', $after ) );
+
+        while ( $min_date <= $before ) {
+            $this->interval ++;
+            $min_date = strtotime( '+1 MONTH', $min_date );
+        }
+
+        $this->interval = max( 1, $this->interval );
+
+    }
+
+    /**
+     * Retrieves a custom date range.
+     *
+     * @param WP_REST_Request $request Request object.
+     * @return array The appropriate date range.
+     */
+    public function get_custom_date_range( $request ) {
+
+        $after  = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) );
+        $before = gmdate( 'Y-m-d' );
+
+        if ( ! empty( $request['before'] ) ) {
+            $before  = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) );
+        }
+
+        // Set the previous date range.
+        $difference           = $before - $after;
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => gmdate( 'Y-m-d', $before - $difference - DAY_IN_SECONDS ),
+            'after'  => gmdate( 'Y-m-d', $after - $difference - DAY_IN_SECONDS ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => gmdate( 'Y-m-d', $before ),
+            'after'  => gmdate( 'Y-m-d', $after ),
+        );
+
+    }
+
+    /**
+     * Retrieves todays date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_today_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'yesterday',
+        );
+
+        // Generate the report.
+        return array(
+            'before' => gmdate( 'Y-m-d' ),
+            'after'  => gmdate( 'Y-m-d' ),
+        );
+
+    }
+
+    /**
+     * Retrieves yesterdays date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_yesterday_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ),
+            'after'  => gmdate( 'Y-m-d', strtotime( '-2 days' ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ),
+            'after'  => gmdate( 'Y-m-d', strtotime( '-1 day' ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves this week's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_week_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_week',
+        );
+
+        // Generate the report.
+        $week_starts = absint( get_option( 'start_of_week' ) );
+        return array(
+            'before' => gmdate( 'Y-m-d' ),
+            'after'  => gmdate( 'Y-m-d', strtotime( 'next Sunday -' . ( 7 - $week_starts ) . ' days' ) ),
+        );
+    }
+
+    /**
+     * Retrieves last week's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_week_date_range() {
+
+        $week_starts = absint( get_option( 'start_of_week' ) );
+        $week_starts = strtotime( 'last Sunday -' . ( 7 - $week_starts ) . ' days' );
+        $date_range  = array(
+            'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ),
+            'after'  => gmdate( 'Y-m-d', $week_starts ),
+        );
+
+        // Set the previous date range.
+        $week_starts          = $week_starts - 7 * DAY_IN_SECONDS;
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ),
+            'after'  => gmdate( 'Y-m-d', $week_starts ),
+        );
+
+        // Generate the report.
+        return $date_range;
+    }
+
+    /**
+     * Retrieves last x days date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_x_days_date_range( $days = 7 ) {
+
+        $days--;
+
+        $date_range  = array(
+            'before' => gmdate( 'Y-m-d' ),
+            'after'  => gmdate( 'Y-m-d', strtotime( "-$days days" ) ),
+        );
+
+        $days++;
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => gmdate( 'Y-m-d', strtotime( $date_range['before'] ) - $days * DAY_IN_SECONDS ),
+            'after'  => gmdate( 'Y-m-d', strtotime( $date_range['after'] ) - $days * DAY_IN_SECONDS ),
+        );
+
+        // Generate the report.
+        return $date_range;
+    }
+
+    /**
+     * Retrieves this month date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_month_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_month',
+        );
+
+        // Generate the report.
+        return array(
+            'after'  => gmdate( 'Y-m-01' ),
+            'before' => gmdate( 'Y-m-t' ),
+        );
+
+    }
+
+    /**
+     * Retrieves last month's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_month_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'after'  => gmdate( 'Y-m-01', strtotime( '-2 months' ) ),
+            'before' => gmdate( 'Y-m-t', strtotime( '-2 months' ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'after'  => gmdate( 'Y-m-01', strtotime( 'last month' ) ),
+            'before' => gmdate( 'Y-m-t', strtotime( 'last month' ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves this quarter date range.
+     *
+     * @return array The available quarters.
+     */
+    public function get_quarters() {
+
+        $year      = (int) gmdate( 'Y' );
+        $last_year = (int) $year - 1;
+        return array(
+
+            // Third quarter of previous year: July 1st to September 30th
+            array(
+                'before' => "{$last_year}-09-30",
+                'after'  => "{$last_year}-07-01",
+            ),
+
+            // Last quarter of previous year: October 1st to December 31st
+            array(
+                'before' => "{$last_year}-12-31",
+                'after'  => "{$last_year}-10-01",
+            ),
+
+            // First quarter: January 1st to March 31st
+            array(
+                'before' => "{$year}-03-31",
+                'after'  => "{$year}-01-01",
+            ),
+
+            // Second quarter: April 1st to June 30th
+            array(
+                'before' => "{$year}-06-30",
+                'after'  => "{$year}-04-01",
+            ),
+
+            // Third quarter: July 1st to September 30th
+            array(
+                'before' => "{$year}-09-30",
+                'after'  => "{$year}-07-01",
+            ),
+
+            // Fourth quarter: October 1st to December 31st
+            array(
+                'before' => "{$year}-12-31",
+                'after'  => "{$year}-10-01",
+            ),
+        );
+    }
+
+    /**
+     * Retrieves the current quater.
+     *
+     * @return int The current quarter.
+     */
+    public function get_quarter() {
+
+        $month    = (int) gmdate( 'n' );
+        $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 );
+        return $quarters[ $month - 1 ];
+
+    }
+
+    /**
+     * Retrieves this quarter date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_quarter_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_quarter',
+        );
+
+        // Generate the report.
+        $quarter  = $this->get_quarter();
+        $quarters = $this->get_quarters();
+        return $quarters[ $quarter + 1 ];
+
+    }
+
+    /**
+     * Retrieves last quarter's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_quarter_date_range() {
+
+        $quarters = $this->get_quarters();
+        $quarter  = $this->get_quarter();
+
+        // Set the previous date range.
+        $this->previous_range = array_merge(
+            $quarters[ $quarter - 1 ],
+            array( 'period' => 'custom' )
+        );
+
+        // Generate the report.
+        return $quarters[ $quarter ];
+
+    }
+
+    /**
+     * Retrieves this year date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_year_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_year',
+        );
+
+        // Generate the report.
+        return array(
+            'after'  => gmdate( 'Y-01-01' ),
+            'before' => gmdate( 'Y-12-31' ),
+        );
+
+    }
+
+    /**
+     * Retrieves last year date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_year_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'after'  => gmdate( 'Y-01-01', strtotime( '-2 years' ) ),
+            'before' => gmdate( 'Y-12-31', strtotime( '-2 years' ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'after'  => gmdate( 'Y-01-01', strtotime( 'last year' ) ),
+            'before' => gmdate( 'Y-12-31', strtotime( 'last year' ) ),
+        );
+
+    }
+
+    /**
+     * Prepare a the request date for SQL usage.
+     *
+     * @param WP_REST_Request $request Request object.
+     * @param string $date_field The date field.
+     * @return string The appropriate SQL.
+     */
+    public function get_date_range_sql( $request, $date_field ) {
+        global $wpdb;
+
+        $sql = '1=1';
+        $range = $this->get_date_range( $request );
+
+        if ( ! empty( $range['after'] ) ) {
+            $sql .= ' AND ' . $wpdb->prepare(
+                "$date_field >= %s",
+                $range['after']
+            );
+        }
+
+        if ( ! empty( $range['before'] ) ) {
+            $sql .= ' AND ' . $wpdb->prepare(
+                "$date_field <= %s",
+                $range['before']
+            );
+        }
+
+        return $sql;
+
+    }
+
+    /**
+     * Prepares a group by query.
+     *
+     * @param string $date_field The date field.
+     * @return string The appropriate SQL.
+     */
+    public function get_group_by_sql( $date_field ) {
+
+        if ( 'day' === $this->groupby ) {
+            return "YEAR($date_field), MONTH($date_field), DAY($date_field)";
+        }
+
+        return "YEAR($date_field), MONTH($date_field)";
+    }
+
+    /**
+     * Get the query params for collections.
+     *
+     * @return array
+     */
+    public function get_collection_params() {
+        return array(
+            'context' => $this->get_context_param( array( 'default' => 'view' ) ),
+            'period'  => array(
+                'description'       => __( 'Limit to results of a specific period.', 'invoicing' ),
+                'type'              => 'string',
+                'enum'              => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ),
+                'validate_callback' => 'rest_validate_request_arg',
+                'sanitize_callback' => 'sanitize_text_field',
+                'default'           => '7_days',
+            ),
+            'after'   => array(
+                /* translators: %s: date format */
+                'description'       => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
+                'type'              => 'string',
+                'validate_callback' => 'rest_validate_request_arg',
+                'sanitize_callback' => 'sanitize_text_field',
+                'default'           => gmdate( 'Y-m-d', strtotime( '-7 days' ) ),
+            ),
+            'before'  => array(
+                /* translators: %s: date format */
+                'description'       => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
+                'type'              => 'string',
+                'validate_callback' => 'rest_validate_request_arg',
+                'sanitize_callback' => 'sanitize_text_field',
+                'default'           => gmdate( 'Y-m-d' ),
+            ),
+        );
+    }
 }

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

Indentation +276 added lines, -276 removed lines

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

includes/subscription-functions.php

Indentation +323 added lines, -323 removed lines

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

includes/invoice-functions.php

Indentation +37 added lines, -37 removed lines

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

includes/class-getpaid-daily-maintenance.php

Indentation +139 added lines, -139 removed lines

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